...

Package gamesconfiguration

import "google.golang.org/api/gamesconfiguration/v1configuration"
Overview
Index

Overview ▾

Package gamesconfiguration provides access to the Google Play Game Services Publishing API.

For product documentation, see: https://developers.google.com/games/

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example:

import "google.golang.org/api/gamesconfiguration/v1configuration"
...
ctx := context.Background()
gamesconfigurationService, err := gamesconfiguration.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey:

gamesconfigurationService, err := gamesconfiguration.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
gamesconfigurationService, err := gamesconfiguration.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See google.golang.org/api/option.ClientOption for details on options.

Index ▾

Constants
type AchievementConfiguration
    func (s *AchievementConfiguration) MarshalJSON() ([]byte, error)
type AchievementConfigurationDetail
    func (s *AchievementConfigurationDetail) MarshalJSON() ([]byte, error)
type AchievementConfigurationListResponse
    func (s *AchievementConfigurationListResponse) MarshalJSON() ([]byte, error)
type AchievementConfigurationsDeleteCall
    func (c *AchievementConfigurationsDeleteCall) Context(ctx context.Context) *AchievementConfigurationsDeleteCall
    func (c *AchievementConfigurationsDeleteCall) Do(opts ...googleapi.CallOption) error
    func (c *AchievementConfigurationsDeleteCall) Fields(s ...googleapi.Field) *AchievementConfigurationsDeleteCall
    func (c *AchievementConfigurationsDeleteCall) Header() http.Header
type AchievementConfigurationsGetCall
    func (c *AchievementConfigurationsGetCall) Context(ctx context.Context) *AchievementConfigurationsGetCall
    func (c *AchievementConfigurationsGetCall) Do(opts ...googleapi.CallOption) (*AchievementConfiguration, error)
    func (c *AchievementConfigurationsGetCall) Fields(s ...googleapi.Field) *AchievementConfigurationsGetCall
    func (c *AchievementConfigurationsGetCall) Header() http.Header
    func (c *AchievementConfigurationsGetCall) IfNoneMatch(entityTag string) *AchievementConfigurationsGetCall
type AchievementConfigurationsInsertCall
    func (c *AchievementConfigurationsInsertCall) Context(ctx context.Context) *AchievementConfigurationsInsertCall
    func (c *AchievementConfigurationsInsertCall) Do(opts ...googleapi.CallOption) (*AchievementConfiguration, error)
    func (c *AchievementConfigurationsInsertCall) Fields(s ...googleapi.Field) *AchievementConfigurationsInsertCall
    func (c *AchievementConfigurationsInsertCall) Header() http.Header
type AchievementConfigurationsListCall
    func (c *AchievementConfigurationsListCall) Context(ctx context.Context) *AchievementConfigurationsListCall
    func (c *AchievementConfigurationsListCall) Do(opts ...googleapi.CallOption) (*AchievementConfigurationListResponse, error)
    func (c *AchievementConfigurationsListCall) Fields(s ...googleapi.Field) *AchievementConfigurationsListCall
    func (c *AchievementConfigurationsListCall) Header() http.Header
    func (c *AchievementConfigurationsListCall) IfNoneMatch(entityTag string) *AchievementConfigurationsListCall
    func (c *AchievementConfigurationsListCall) MaxResults(maxResults int64) *AchievementConfigurationsListCall
    func (c *AchievementConfigurationsListCall) PageToken(pageToken string) *AchievementConfigurationsListCall
    func (c *AchievementConfigurationsListCall) Pages(ctx context.Context, f func(*AchievementConfigurationListResponse) error) error
type AchievementConfigurationsService
    func NewAchievementConfigurationsService(s *Service) *AchievementConfigurationsService
    func (r *AchievementConfigurationsService) Delete(achievementId string) *AchievementConfigurationsDeleteCall
    func (r *AchievementConfigurationsService) Get(achievementId string) *AchievementConfigurationsGetCall
    func (r *AchievementConfigurationsService) Insert(applicationId string, achievementconfiguration *AchievementConfiguration) *AchievementConfigurationsInsertCall
    func (r *AchievementConfigurationsService) List(applicationId string) *AchievementConfigurationsListCall
    func (r *AchievementConfigurationsService) Update(achievementId string, achievementconfiguration *AchievementConfiguration) *AchievementConfigurationsUpdateCall
type AchievementConfigurationsUpdateCall
    func (c *AchievementConfigurationsUpdateCall) Context(ctx context.Context) *AchievementConfigurationsUpdateCall
    func (c *AchievementConfigurationsUpdateCall) Do(opts ...googleapi.CallOption) (*AchievementConfiguration, error)
    func (c *AchievementConfigurationsUpdateCall) Fields(s ...googleapi.Field) *AchievementConfigurationsUpdateCall
    func (c *AchievementConfigurationsUpdateCall) Header() http.Header
type GamesNumberAffixConfiguration
    func (s *GamesNumberAffixConfiguration) MarshalJSON() ([]byte, error)
type GamesNumberFormatConfiguration
    func (s *GamesNumberFormatConfiguration) MarshalJSON() ([]byte, error)
type LeaderboardConfiguration
    func (s *LeaderboardConfiguration) MarshalJSON() ([]byte, error)
type LeaderboardConfigurationDetail
    func (s *LeaderboardConfigurationDetail) MarshalJSON() ([]byte, error)
type LeaderboardConfigurationListResponse
    func (s *LeaderboardConfigurationListResponse) MarshalJSON() ([]byte, error)
type LeaderboardConfigurationsDeleteCall
    func (c *LeaderboardConfigurationsDeleteCall) Context(ctx context.Context) *LeaderboardConfigurationsDeleteCall
    func (c *LeaderboardConfigurationsDeleteCall) Do(opts ...googleapi.CallOption) error
    func (c *LeaderboardConfigurationsDeleteCall) Fields(s ...googleapi.Field) *LeaderboardConfigurationsDeleteCall
    func (c *LeaderboardConfigurationsDeleteCall) Header() http.Header
type LeaderboardConfigurationsGetCall
    func (c *LeaderboardConfigurationsGetCall) Context(ctx context.Context) *LeaderboardConfigurationsGetCall
    func (c *LeaderboardConfigurationsGetCall) Do(opts ...googleapi.CallOption) (*LeaderboardConfiguration, error)
    func (c *LeaderboardConfigurationsGetCall) Fields(s ...googleapi.Field) *LeaderboardConfigurationsGetCall
    func (c *LeaderboardConfigurationsGetCall) Header() http.Header
    func (c *LeaderboardConfigurationsGetCall) IfNoneMatch(entityTag string) *LeaderboardConfigurationsGetCall
type LeaderboardConfigurationsInsertCall
    func (c *LeaderboardConfigurationsInsertCall) Context(ctx context.Context) *LeaderboardConfigurationsInsertCall
    func (c *LeaderboardConfigurationsInsertCall) Do(opts ...googleapi.CallOption) (*LeaderboardConfiguration, error)
    func (c *LeaderboardConfigurationsInsertCall) Fields(s ...googleapi.Field) *LeaderboardConfigurationsInsertCall
    func (c *LeaderboardConfigurationsInsertCall) Header() http.Header
type LeaderboardConfigurationsListCall
    func (c *LeaderboardConfigurationsListCall) Context(ctx context.Context) *LeaderboardConfigurationsListCall
    func (c *LeaderboardConfigurationsListCall) Do(opts ...googleapi.CallOption) (*LeaderboardConfigurationListResponse, error)
    func (c *LeaderboardConfigurationsListCall) Fields(s ...googleapi.Field) *LeaderboardConfigurationsListCall
    func (c *LeaderboardConfigurationsListCall) Header() http.Header
    func (c *LeaderboardConfigurationsListCall) IfNoneMatch(entityTag string) *LeaderboardConfigurationsListCall
    func (c *LeaderboardConfigurationsListCall) MaxResults(maxResults int64) *LeaderboardConfigurationsListCall
    func (c *LeaderboardConfigurationsListCall) PageToken(pageToken string) *LeaderboardConfigurationsListCall
    func (c *LeaderboardConfigurationsListCall) Pages(ctx context.Context, f func(*LeaderboardConfigurationListResponse) error) error
type LeaderboardConfigurationsService
    func NewLeaderboardConfigurationsService(s *Service) *LeaderboardConfigurationsService
    func (r *LeaderboardConfigurationsService) Delete(leaderboardId string) *LeaderboardConfigurationsDeleteCall
    func (r *LeaderboardConfigurationsService) Get(leaderboardId string) *LeaderboardConfigurationsGetCall
    func (r *LeaderboardConfigurationsService) Insert(applicationId string, leaderboardconfiguration *LeaderboardConfiguration) *LeaderboardConfigurationsInsertCall
    func (r *LeaderboardConfigurationsService) List(applicationId string) *LeaderboardConfigurationsListCall
    func (r *LeaderboardConfigurationsService) Update(leaderboardId string, leaderboardconfiguration *LeaderboardConfiguration) *LeaderboardConfigurationsUpdateCall
type LeaderboardConfigurationsUpdateCall
    func (c *LeaderboardConfigurationsUpdateCall) Context(ctx context.Context) *LeaderboardConfigurationsUpdateCall
    func (c *LeaderboardConfigurationsUpdateCall) Do(opts ...googleapi.CallOption) (*LeaderboardConfiguration, error)
    func (c *LeaderboardConfigurationsUpdateCall) Fields(s ...googleapi.Field) *LeaderboardConfigurationsUpdateCall
    func (c *LeaderboardConfigurationsUpdateCall) Header() http.Header
type LocalizedString
    func (s *LocalizedString) MarshalJSON() ([]byte, error)
type LocalizedStringBundle
    func (s *LocalizedStringBundle) MarshalJSON() ([]byte, error)
type Service
    func New(client *http.Client) (*Service, error)
    func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

Package files

gamesconfiguration-gen.go

Constants

OAuth2 scopes used by this API.

const (
    // View and manage your Google Play Developer account
    AndroidpublisherScope = "https://www.googleapis.com/auth/androidpublisher"
)

type AchievementConfiguration

AchievementConfiguration: An achievement configuration resource.

type AchievementConfiguration struct {
    // AchievementType: The type of the achievement.
    //
    // Possible values:
    //   "ACHIEVEMENT_TYPE_UNSPECIFIED" - Default value. This value is unused.
    //   "STANDARD" - Achievement is either locked or unlocked.
    //   "INCREMENTAL" - Achievement is incremental.
    AchievementType string `json:"achievementType,omitempty"`
    // Draft: The draft data of the achievement.
    Draft *AchievementConfigurationDetail `json:"draft,omitempty"`
    // Id: The ID of the achievement.
    Id string `json:"id,omitempty"`
    // InitialState: The initial state of the achievement.
    //
    // Possible values:
    //   "INITIAL_STATE_UNSPECIFIED" - Default value. This value is unused.
    //   "HIDDEN" - Achievement is hidden.
    //   "REVEALED" - Achievement is revealed.
    InitialState string `json:"initialState,omitempty"`
    // Kind: Uniquely identifies the type of this resource. Value is always the
    // fixed string `gamesConfiguration#achievementConfiguration`.
    Kind string `json:"kind,omitempty"`
    // Published: The read-only published data of the achievement.
    Published *AchievementConfigurationDetail `json:"published,omitempty"`
    // StepsToUnlock: Steps to unlock. Only applicable to incremental achievements.
    StepsToUnlock int64 `json:"stepsToUnlock,omitempty"`
    // Token: The token for this resource.
    Token string `json:"token,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "AchievementType") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "AchievementType") to include in
    // API requests with the JSON null value. By default, fields with empty values
    // are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*AchievementConfiguration) MarshalJSON

func (s *AchievementConfiguration) MarshalJSON() ([]byte, error)

type AchievementConfigurationDetail

AchievementConfigurationDetail: An achievement configuration detail.

type AchievementConfigurationDetail struct {
    // Description: Localized strings for the achievement description.
    Description *LocalizedStringBundle `json:"description,omitempty"`
    // IconUrl: The icon url of this achievement. Writes to this field are ignored.
    IconUrl string `json:"iconUrl,omitempty"`
    // Kind: Uniquely identifies the type of this resource. Value is always the
    // fixed string `gamesConfiguration#achievementConfigurationDetail`.
    Kind string `json:"kind,omitempty"`
    // Name: Localized strings for the achievement name.
    Name *LocalizedStringBundle `json:"name,omitempty"`
    // PointValue: Point value for the achievement.
    PointValue int64 `json:"pointValue,omitempty"`
    // SortRank: The sort rank of this achievement. Writes to this field are
    // ignored.
    SortRank int64 `json:"sortRank,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Description") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Description") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*AchievementConfigurationDetail) MarshalJSON

func (s *AchievementConfigurationDetail) MarshalJSON() ([]byte, error)

type AchievementConfigurationListResponse

AchievementConfigurationListResponse: A ListConfigurations response.

type AchievementConfigurationListResponse struct {
    // Items: The achievement configurations.
    Items []*AchievementConfiguration `json:"items,omitempty"`
    // Kind: Uniquely identifies the type of this resource. Value is always the
    // fixed string `gamesConfiguration#achievementConfigurationListResponse`.
    Kind string `json:"kind,omitempty"`
    // NextPageToken: The pagination token for the next page of results.
    NextPageToken string `json:"nextPageToken,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "Items") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Items") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*AchievementConfigurationListResponse) MarshalJSON

func (s *AchievementConfigurationListResponse) MarshalJSON() ([]byte, error)

type AchievementConfigurationsDeleteCall

type AchievementConfigurationsDeleteCall struct {
    // contains filtered or unexported fields
}

func (*AchievementConfigurationsDeleteCall) Context

func (c *AchievementConfigurationsDeleteCall) Context(ctx context.Context) *AchievementConfigurationsDeleteCall

Context sets the context to be used in this call's Do method.

func (*AchievementConfigurationsDeleteCall) Do

func (c *AchievementConfigurationsDeleteCall) Do(opts ...googleapi.CallOption) error

Do executes the "gamesConfiguration.achievementConfigurations.delete" call.

func (*AchievementConfigurationsDeleteCall) Fields

func (c *AchievementConfigurationsDeleteCall) Fields(s ...googleapi.Field) *AchievementConfigurationsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*AchievementConfigurationsDeleteCall) Header

func (c *AchievementConfigurationsDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type AchievementConfigurationsGetCall

type AchievementConfigurationsGetCall struct {
    // contains filtered or unexported fields
}

func (*AchievementConfigurationsGetCall) Context

func (c *AchievementConfigurationsGetCall) Context(ctx context.Context) *AchievementConfigurationsGetCall

Context sets the context to be used in this call's Do method.

func (*AchievementConfigurationsGetCall) Do

func (c *AchievementConfigurationsGetCall) Do(opts ...googleapi.CallOption) (*AchievementConfiguration, error)

Do executes the "gamesConfiguration.achievementConfigurations.get" call. Any non-2xx status code is an error. Response headers are in either *AchievementConfiguration.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AchievementConfigurationsGetCall) Fields

func (c *AchievementConfigurationsGetCall) Fields(s ...googleapi.Field) *AchievementConfigurationsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*AchievementConfigurationsGetCall) Header

func (c *AchievementConfigurationsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*AchievementConfigurationsGetCall) IfNoneMatch

func (c *AchievementConfigurationsGetCall) IfNoneMatch(entityTag string) *AchievementConfigurationsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type AchievementConfigurationsInsertCall

type AchievementConfigurationsInsertCall struct {
    // contains filtered or unexported fields
}

func (*AchievementConfigurationsInsertCall) Context

func (c *AchievementConfigurationsInsertCall) Context(ctx context.Context) *AchievementConfigurationsInsertCall

Context sets the context to be used in this call's Do method.

func (*AchievementConfigurationsInsertCall) Do

func (c *AchievementConfigurationsInsertCall) Do(opts ...googleapi.CallOption) (*AchievementConfiguration, error)

Do executes the "gamesConfiguration.achievementConfigurations.insert" call. Any non-2xx status code is an error. Response headers are in either *AchievementConfiguration.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AchievementConfigurationsInsertCall) Fields

func (c *AchievementConfigurationsInsertCall) Fields(s ...googleapi.Field) *AchievementConfigurationsInsertCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*AchievementConfigurationsInsertCall) Header

func (c *AchievementConfigurationsInsertCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type AchievementConfigurationsListCall

type AchievementConfigurationsListCall struct {
    // contains filtered or unexported fields
}

func (*AchievementConfigurationsListCall) Context

func (c *AchievementConfigurationsListCall) Context(ctx context.Context) *AchievementConfigurationsListCall

Context sets the context to be used in this call's Do method.

func (*AchievementConfigurationsListCall) Do

func (c *AchievementConfigurationsListCall) Do(opts ...googleapi.CallOption) (*AchievementConfigurationListResponse, error)

Do executes the "gamesConfiguration.achievementConfigurations.list" call. Any non-2xx status code is an error. Response headers are in either *AchievementConfigurationListResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AchievementConfigurationsListCall) Fields

func (c *AchievementConfigurationsListCall) Fields(s ...googleapi.Field) *AchievementConfigurationsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*AchievementConfigurationsListCall) Header

func (c *AchievementConfigurationsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*AchievementConfigurationsListCall) IfNoneMatch

func (c *AchievementConfigurationsListCall) IfNoneMatch(entityTag string) *AchievementConfigurationsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*AchievementConfigurationsListCall) MaxResults

func (c *AchievementConfigurationsListCall) MaxResults(maxResults int64) *AchievementConfigurationsListCall

MaxResults sets the optional parameter "maxResults": The maximum number of resource configurations to return in the response, used for paging. For any response, the actual number of resources returned may be less than the specified `maxResults`.

func (*AchievementConfigurationsListCall) PageToken

func (c *AchievementConfigurationsListCall) PageToken(pageToken string) *AchievementConfigurationsListCall

PageToken sets the optional parameter "pageToken": The token returned by the previous request.

func (*AchievementConfigurationsListCall) Pages

func (c *AchievementConfigurationsListCall) Pages(ctx context.Context, f func(*AchievementConfigurationListResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type AchievementConfigurationsService

type AchievementConfigurationsService struct {
    // contains filtered or unexported fields
}

func NewAchievementConfigurationsService

func NewAchievementConfigurationsService(s *Service) *AchievementConfigurationsService

func (*AchievementConfigurationsService) Delete

func (r *AchievementConfigurationsService) Delete(achievementId string) *AchievementConfigurationsDeleteCall

Delete: Delete the achievement configuration with the given ID.

- achievementId: The ID of the achievement used by this method.

func (*AchievementConfigurationsService) Get

func (r *AchievementConfigurationsService) Get(achievementId string) *AchievementConfigurationsGetCall

Get: Retrieves the metadata of the achievement configuration with the given ID.

- achievementId: The ID of the achievement used by this method.

func (*AchievementConfigurationsService) Insert

func (r *AchievementConfigurationsService) Insert(applicationId string, achievementconfiguration *AchievementConfiguration) *AchievementConfigurationsInsertCall

Insert: Insert a new achievement configuration in this application.

- applicationId: The application ID from the Google Play developer console.

func (*AchievementConfigurationsService) List

func (r *AchievementConfigurationsService) List(applicationId string) *AchievementConfigurationsListCall

List: Returns a list of the achievement configurations in this application.

- applicationId: The application ID from the Google Play developer console.

func (*AchievementConfigurationsService) Update

func (r *AchievementConfigurationsService) Update(achievementId string, achievementconfiguration *AchievementConfiguration) *AchievementConfigurationsUpdateCall

Update: Update the metadata of the achievement configuration with the given ID.

- achievementId: The ID of the achievement used by this method.

type AchievementConfigurationsUpdateCall

type AchievementConfigurationsUpdateCall struct {
    // contains filtered or unexported fields
}

func (*AchievementConfigurationsUpdateCall) Context

func (c *AchievementConfigurationsUpdateCall) Context(ctx context.Context) *AchievementConfigurationsUpdateCall

Context sets the context to be used in this call's Do method.

func (*AchievementConfigurationsUpdateCall) Do

func (c *AchievementConfigurationsUpdateCall) Do(opts ...googleapi.CallOption) (*AchievementConfiguration, error)

Do executes the "gamesConfiguration.achievementConfigurations.update" call. Any non-2xx status code is an error. Response headers are in either *AchievementConfiguration.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AchievementConfigurationsUpdateCall) Fields

func (c *AchievementConfigurationsUpdateCall) Fields(s ...googleapi.Field) *AchievementConfigurationsUpdateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*AchievementConfigurationsUpdateCall) Header

func (c *AchievementConfigurationsUpdateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type GamesNumberAffixConfiguration

GamesNumberAffixConfiguration: A number affix resource.

type GamesNumberAffixConfiguration struct {
    // Few: When the language requires special treatment of "small" numbers (as
    // with 2, 3, and 4 in Czech; or numbers ending 2, 3, or 4 but not 12, 13, or
    // 14 in Polish).
    Few *LocalizedStringBundle `json:"few,omitempty"`
    // Many: When the language requires special treatment of "large" numbers (as
    // with numbers ending 11-99 in Maltese).
    Many *LocalizedStringBundle `json:"many,omitempty"`
    // One: When the language requires special treatment of numbers like one (as
    // with the number 1 in English and most other languages; in Russian, any
    // number ending in 1 but not ending in 11 is in this class).
    One *LocalizedStringBundle `json:"one,omitempty"`
    // Other: When the language does not require special treatment of the given
    // quantity (as with all numbers in Chinese, or 42 in English).
    Other *LocalizedStringBundle `json:"other,omitempty"`
    // Two: When the language requires special treatment of numbers like two (as
    // with 2 in Welsh, or 102 in Slovenian).
    Two *LocalizedStringBundle `json:"two,omitempty"`
    // Zero: When the language requires special treatment of the number 0 (as in
    // Arabic).
    Zero *LocalizedStringBundle `json:"zero,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Few") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Few") to include in API requests
    // with the JSON null value. By default, fields with empty values are omitted
    // from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*GamesNumberAffixConfiguration) MarshalJSON

func (s *GamesNumberAffixConfiguration) MarshalJSON() ([]byte, error)

type GamesNumberFormatConfiguration

GamesNumberFormatConfiguration: A number format resource.

type GamesNumberFormatConfiguration struct {
    // CurrencyCode: The curreny code string. Only used for CURRENCY format type.
    CurrencyCode string `json:"currencyCode,omitempty"`
    // NumDecimalPlaces: The number of decimal places for number. Only used for
    // NUMERIC format type.
    NumDecimalPlaces int64 `json:"numDecimalPlaces,omitempty"`
    // NumberFormatType: The formatting for the number.
    //
    // Possible values:
    //   "NUMBER_FORMAT_TYPE_UNSPECIFIED" - Default value. This value is unused.
    //   "NUMERIC" - Numbers are formatted to have no digits or fixed number of
    // digits after the decimal point according to locale. An optional custom unit
    // can be added.
    //   "TIME_DURATION" - Numbers are formatted to hours, minutes and seconds.
    //   "CURRENCY" - Numbers are formatted to currency according to locale.
    NumberFormatType string `json:"numberFormatType,omitempty"`
    // Suffix: An optional suffix for the NUMERIC format type. These strings follow
    // the same plural rules as all Android string resources.
    Suffix *GamesNumberAffixConfiguration `json:"suffix,omitempty"`
    // ForceSendFields is a list of field names (e.g. "CurrencyCode") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "CurrencyCode") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*GamesNumberFormatConfiguration) MarshalJSON

func (s *GamesNumberFormatConfiguration) MarshalJSON() ([]byte, error)

type LeaderboardConfiguration

LeaderboardConfiguration: An leaderboard configuration resource.

type LeaderboardConfiguration struct {
    // Draft: The draft data of the leaderboard.
    Draft *LeaderboardConfigurationDetail `json:"draft,omitempty"`
    // Id: The ID of the leaderboard.
    Id string `json:"id,omitempty"`
    // Kind: Uniquely identifies the type of this resource. Value is always the
    // fixed string `gamesConfiguration#leaderboardConfiguration`.
    Kind string `json:"kind,omitempty"`
    // Published: The read-only published data of the leaderboard.
    Published *LeaderboardConfigurationDetail `json:"published,omitempty"`
    // ScoreMax: Maximum score that can be posted to this leaderboard.
    ScoreMax int64 `json:"scoreMax,omitempty,string"`
    // ScoreMin: Minimum score that can be posted to this leaderboard.
    ScoreMin int64 `json:"scoreMin,omitempty,string"`
    // Possible values:
    //   "SCORE_ORDER_UNSPECIFIED" - Default value. This value is unused.
    //   "LARGER_IS_BETTER" - Larger scores posted are ranked higher.
    //   "SMALLER_IS_BETTER" - Smaller scores posted are ranked higher.
    ScoreOrder string `json:"scoreOrder,omitempty"`
    // Token: The token for this resource.
    Token string `json:"token,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "Draft") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Draft") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*LeaderboardConfiguration) MarshalJSON

func (s *LeaderboardConfiguration) MarshalJSON() ([]byte, error)

type LeaderboardConfigurationDetail

LeaderboardConfigurationDetail: A leaderboard configuration detail.

type LeaderboardConfigurationDetail struct {
    // IconUrl: The icon url of this leaderboard. Writes to this field are ignored.
    IconUrl string `json:"iconUrl,omitempty"`
    // Kind: Uniquely identifies the type of this resource. Value is always the
    // fixed string `gamesConfiguration#leaderboardConfigurationDetail`.
    Kind string `json:"kind,omitempty"`
    // Name: Localized strings for the leaderboard name.
    Name *LocalizedStringBundle `json:"name,omitempty"`
    // ScoreFormat: The score formatting for the leaderboard.
    ScoreFormat *GamesNumberFormatConfiguration `json:"scoreFormat,omitempty"`
    // SortRank: The sort rank of this leaderboard. Writes to this field are
    // ignored.
    SortRank int64 `json:"sortRank,omitempty"`
    // ForceSendFields is a list of field names (e.g. "IconUrl") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "IconUrl") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*LeaderboardConfigurationDetail) MarshalJSON

func (s *LeaderboardConfigurationDetail) MarshalJSON() ([]byte, error)

type LeaderboardConfigurationListResponse

LeaderboardConfigurationListResponse: A ListConfigurations response.

type LeaderboardConfigurationListResponse struct {
    // Items: The leaderboard configurations.
    Items []*LeaderboardConfiguration `json:"items,omitempty"`
    // Kind: Uniquely identifies the type of this resource. Value is always the
    // fixed string `gamesConfiguration#leaderboardConfigurationListResponse`.
    Kind string `json:"kind,omitempty"`
    // NextPageToken: The pagination token for the next page of results.
    NextPageToken string `json:"nextPageToken,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "Items") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Items") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*LeaderboardConfigurationListResponse) MarshalJSON

func (s *LeaderboardConfigurationListResponse) MarshalJSON() ([]byte, error)

type LeaderboardConfigurationsDeleteCall

type LeaderboardConfigurationsDeleteCall struct {
    // contains filtered or unexported fields
}

func (*LeaderboardConfigurationsDeleteCall) Context

func (c *LeaderboardConfigurationsDeleteCall) Context(ctx context.Context) *LeaderboardConfigurationsDeleteCall

Context sets the context to be used in this call's Do method.

func (*LeaderboardConfigurationsDeleteCall) Do

func (c *LeaderboardConfigurationsDeleteCall) Do(opts ...googleapi.CallOption) error

Do executes the "gamesConfiguration.leaderboardConfigurations.delete" call.

func (*LeaderboardConfigurationsDeleteCall) Fields

func (c *LeaderboardConfigurationsDeleteCall) Fields(s ...googleapi.Field) *LeaderboardConfigurationsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*LeaderboardConfigurationsDeleteCall) Header

func (c *LeaderboardConfigurationsDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type LeaderboardConfigurationsGetCall

type LeaderboardConfigurationsGetCall struct {
    // contains filtered or unexported fields
}

func (*LeaderboardConfigurationsGetCall) Context

func (c *LeaderboardConfigurationsGetCall) Context(ctx context.Context) *LeaderboardConfigurationsGetCall

Context sets the context to be used in this call's Do method.

func (*LeaderboardConfigurationsGetCall) Do

func (c *LeaderboardConfigurationsGetCall) Do(opts ...googleapi.CallOption) (*LeaderboardConfiguration, error)

Do executes the "gamesConfiguration.leaderboardConfigurations.get" call. Any non-2xx status code is an error. Response headers are in either *LeaderboardConfiguration.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*LeaderboardConfigurationsGetCall) Fields

func (c *LeaderboardConfigurationsGetCall) Fields(s ...googleapi.Field) *LeaderboardConfigurationsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*LeaderboardConfigurationsGetCall) Header

func (c *LeaderboardConfigurationsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*LeaderboardConfigurationsGetCall) IfNoneMatch

func (c *LeaderboardConfigurationsGetCall) IfNoneMatch(entityTag string) *LeaderboardConfigurationsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type LeaderboardConfigurationsInsertCall

type LeaderboardConfigurationsInsertCall struct {
    // contains filtered or unexported fields
}

func (*LeaderboardConfigurationsInsertCall) Context

func (c *LeaderboardConfigurationsInsertCall) Context(ctx context.Context) *LeaderboardConfigurationsInsertCall

Context sets the context to be used in this call's Do method.

func (*LeaderboardConfigurationsInsertCall) Do

func (c *LeaderboardConfigurationsInsertCall) Do(opts ...googleapi.CallOption) (*LeaderboardConfiguration, error)

Do executes the "gamesConfiguration.leaderboardConfigurations.insert" call. Any non-2xx status code is an error. Response headers are in either *LeaderboardConfiguration.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*LeaderboardConfigurationsInsertCall) Fields

func (c *LeaderboardConfigurationsInsertCall) Fields(s ...googleapi.Field) *LeaderboardConfigurationsInsertCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*LeaderboardConfigurationsInsertCall) Header

func (c *LeaderboardConfigurationsInsertCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type LeaderboardConfigurationsListCall

type LeaderboardConfigurationsListCall struct {
    // contains filtered or unexported fields
}

func (*LeaderboardConfigurationsListCall) Context

func (c *LeaderboardConfigurationsListCall) Context(ctx context.Context) *LeaderboardConfigurationsListCall

Context sets the context to be used in this call's Do method.

func (*LeaderboardConfigurationsListCall) Do

func (c *LeaderboardConfigurationsListCall) Do(opts ...googleapi.CallOption) (*LeaderboardConfigurationListResponse, error)

Do executes the "gamesConfiguration.leaderboardConfigurations.list" call. Any non-2xx status code is an error. Response headers are in either *LeaderboardConfigurationListResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*LeaderboardConfigurationsListCall) Fields

func (c *LeaderboardConfigurationsListCall) Fields(s ...googleapi.Field) *LeaderboardConfigurationsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*LeaderboardConfigurationsListCall) Header

func (c *LeaderboardConfigurationsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*LeaderboardConfigurationsListCall) IfNoneMatch

func (c *LeaderboardConfigurationsListCall) IfNoneMatch(entityTag string) *LeaderboardConfigurationsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*LeaderboardConfigurationsListCall) MaxResults

func (c *LeaderboardConfigurationsListCall) MaxResults(maxResults int64) *LeaderboardConfigurationsListCall

MaxResults sets the optional parameter "maxResults": The maximum number of resource configurations to return in the response, used for paging. For any response, the actual number of resources returned may be less than the specified `maxResults`.

func (*LeaderboardConfigurationsListCall) PageToken

func (c *LeaderboardConfigurationsListCall) PageToken(pageToken string) *LeaderboardConfigurationsListCall

PageToken sets the optional parameter "pageToken": The token returned by the previous request.

func (*LeaderboardConfigurationsListCall) Pages

func (c *LeaderboardConfigurationsListCall) Pages(ctx context.Context, f func(*LeaderboardConfigurationListResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type LeaderboardConfigurationsService

type LeaderboardConfigurationsService struct {
    // contains filtered or unexported fields
}

func NewLeaderboardConfigurationsService

func NewLeaderboardConfigurationsService(s *Service) *LeaderboardConfigurationsService

func (*LeaderboardConfigurationsService) Delete

func (r *LeaderboardConfigurationsService) Delete(leaderboardId string) *LeaderboardConfigurationsDeleteCall

Delete: Delete the leaderboard configuration with the given ID.

- leaderboardId: The ID of the leaderboard.

func (*LeaderboardConfigurationsService) Get

func (r *LeaderboardConfigurationsService) Get(leaderboardId string) *LeaderboardConfigurationsGetCall

Get: Retrieves the metadata of the leaderboard configuration with the given ID.

- leaderboardId: The ID of the leaderboard.

func (*LeaderboardConfigurationsService) Insert

func (r *LeaderboardConfigurationsService) Insert(applicationId string, leaderboardconfiguration *LeaderboardConfiguration) *LeaderboardConfigurationsInsertCall

Insert: Insert a new leaderboard configuration in this application.

- applicationId: The application ID from the Google Play developer console.

func (*LeaderboardConfigurationsService) List

func (r *LeaderboardConfigurationsService) List(applicationId string) *LeaderboardConfigurationsListCall

List: Returns a list of the leaderboard configurations in this application.

- applicationId: The application ID from the Google Play developer console.

func (*LeaderboardConfigurationsService) Update

func (r *LeaderboardConfigurationsService) Update(leaderboardId string, leaderboardconfiguration *LeaderboardConfiguration) *LeaderboardConfigurationsUpdateCall

Update: Update the metadata of the leaderboard configuration with the given ID.

- leaderboardId: The ID of the leaderboard.

type LeaderboardConfigurationsUpdateCall

type LeaderboardConfigurationsUpdateCall struct {
    // contains filtered or unexported fields
}

func (*LeaderboardConfigurationsUpdateCall) Context

func (c *LeaderboardConfigurationsUpdateCall) Context(ctx context.Context) *LeaderboardConfigurationsUpdateCall

Context sets the context to be used in this call's Do method.

func (*LeaderboardConfigurationsUpdateCall) Do

func (c *LeaderboardConfigurationsUpdateCall) Do(opts ...googleapi.CallOption) (*LeaderboardConfiguration, error)

Do executes the "gamesConfiguration.leaderboardConfigurations.update" call. Any non-2xx status code is an error. Response headers are in either *LeaderboardConfiguration.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*LeaderboardConfigurationsUpdateCall) Fields

func (c *LeaderboardConfigurationsUpdateCall) Fields(s ...googleapi.Field) *LeaderboardConfigurationsUpdateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*LeaderboardConfigurationsUpdateCall) Header

func (c *LeaderboardConfigurationsUpdateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type LocalizedString

LocalizedString: A localized string resource.

type LocalizedString struct {
    // Kind: Uniquely identifies the type of this resource. Value is always the
    // fixed string `gamesConfiguration#localizedString`.
    Kind string `json:"kind,omitempty"`
    // Locale: The locale string.
    Locale string `json:"locale,omitempty"`
    // Value: The string value.
    Value string `json:"value,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Kind") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Kind") to include in API requests
    // with the JSON null value. By default, fields with empty values are omitted
    // from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*LocalizedString) MarshalJSON

func (s *LocalizedString) MarshalJSON() ([]byte, error)

type LocalizedStringBundle

LocalizedStringBundle: A localized string bundle resource.

type LocalizedStringBundle struct {
    // Kind: Uniquely identifies the type of this resource. Value is always the
    // fixed string `gamesConfiguration#localizedStringBundle`.
    Kind string `json:"kind,omitempty"`
    // Translations: The locale strings.
    Translations []*LocalizedString `json:"translations,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Kind") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Kind") to include in API requests
    // with the JSON null value. By default, fields with empty values are omitted
    // from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*LocalizedStringBundle) MarshalJSON

func (s *LocalizedStringBundle) MarshalJSON() ([]byte, error)

type Service

type Service struct {
    BasePath  string // API endpoint base URL
    UserAgent string // optional additional User-Agent fragment

    AchievementConfigurations *AchievementConfigurationsService

    LeaderboardConfigurations *LeaderboardConfigurationsService
    // contains filtered or unexported fields
}

func New

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.