gamesconfiguration

package
Version: v0.19.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 25, 2020 License: BSD-3-Clause Imports: 14 Imported by: 0

Documentation

Overview

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

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

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 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 option.WithTokenSource:

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

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

Constants

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

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type AchievementConfiguration

type AchievementConfiguration struct {
	// AchievementType: The type of the achievement.
	// Possible values are:
	// - "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 are:
	// - "HIDDEN" - Achievement is hidden.
	// - "REVEALED" - Achievement is revealed.
	// - "UNLOCKED" - Achievement is unlocked.
	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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

AchievementConfiguration: This is a JSON template for an achievement configuration resource.

func (*AchievementConfiguration) MarshalJSON

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

type AchievementConfigurationDetail

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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

AchievementConfigurationDetail: This is a JSON template for an achievement configuration detail.

func (*AchievementConfigurationDetail) MarshalJSON

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

type AchievementConfigurationListResponse

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 games#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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

AchievementConfigurationListResponse: This is a JSON template for a ListConfigurations response.

func (*AchievementConfigurationListResponse) MarshalJSON

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

type AchievementConfigurationsDeleteCall

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

func (*AchievementConfigurationsDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AchievementConfigurationsDeleteCall) Do

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

func (*AchievementConfigurationsDeleteCall) Fields

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

func (*AchievementConfigurationsDeleteCall) Header

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

type AchievementConfigurationsGetCall

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

func (*AchievementConfigurationsGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AchievementConfigurationsGetCall) Do

Do executes the "gamesConfiguration.achievementConfigurations.get" call. Exactly one of *AchievementConfiguration or error will be non-nil. 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

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

func (*AchievementConfigurationsGetCall) Header

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

func (*AchievementConfigurationsGetCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type AchievementConfigurationsInsertCall

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

func (*AchievementConfigurationsInsertCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AchievementConfigurationsInsertCall) Do

Do executes the "gamesConfiguration.achievementConfigurations.insert" call. Exactly one of *AchievementConfiguration or error will be non-nil. 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

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

func (*AchievementConfigurationsInsertCall) Header

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

type AchievementConfigurationsListCall

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

func (*AchievementConfigurationsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AchievementConfigurationsListCall) Do

Do executes the "gamesConfiguration.achievementConfigurations.list" call. Exactly one of *AchievementConfigurationListResponse or error will be non-nil. 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

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

func (*AchievementConfigurationsListCall) Header

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

func (*AchievementConfigurationsListCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*AchievementConfigurationsListCall) MaxResults

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

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

func (*AchievementConfigurationsListCall) Pages

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 AchievementConfigurationsPatchCall

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

func (*AchievementConfigurationsPatchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AchievementConfigurationsPatchCall) Do

Do executes the "gamesConfiguration.achievementConfigurations.patch" call. Exactly one of *AchievementConfiguration or error will be non-nil. 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 (*AchievementConfigurationsPatchCall) Fields

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

func (*AchievementConfigurationsPatchCall) Header

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

type AchievementConfigurationsService

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

func NewAchievementConfigurationsService

func NewAchievementConfigurationsService(s *Service) *AchievementConfigurationsService

func (*AchievementConfigurationsService) Delete

Delete: Delete the achievement configuration with the given ID.

func (*AchievementConfigurationsService) Get

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

func (*AchievementConfigurationsService) Insert

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

Insert: Insert a new achievement configuration in this application.

func (*AchievementConfigurationsService) List

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

func (*AchievementConfigurationsService) Patch

func (r *AchievementConfigurationsService) Patch(achievementId string, achievementconfiguration *AchievementConfiguration) *AchievementConfigurationsPatchCall

Patch: Update the metadata of the achievement configuration with the given ID. This method supports patch semantics.

func (*AchievementConfigurationsService) Update

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

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

type AchievementConfigurationsUpdateCall

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

func (*AchievementConfigurationsUpdateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AchievementConfigurationsUpdateCall) Do

Do executes the "gamesConfiguration.achievementConfigurations.update" call. Exactly one of *AchievementConfiguration or error will be non-nil. 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

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

func (*AchievementConfigurationsUpdateCall) Header

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

type GamesNumberAffixConfiguration

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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GamesNumberAffixConfiguration: This is a JSON template for a number affix resource.

func (*GamesNumberAffixConfiguration) MarshalJSON

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

type GamesNumberFormatConfiguration

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 are:
	// - "NUMERIC" - Numbers are formatted to have no digits or a 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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GamesNumberFormatConfiguration: This is a JSON template for a number format resource.

func (*GamesNumberFormatConfiguration) MarshalJSON

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

type ImageConfiguration

type ImageConfiguration struct {
	// ImageType: The image type for the image.
	ImageType string `json:"imageType,omitempty"`

	// Kind: Uniquely identifies the type of this resource. Value is always
	// the fixed string gamesConfiguration#imageConfiguration.
	Kind string `json:"kind,omitempty"`

	// ResourceId: The resource ID of resource which the image belongs to.
	ResourceId string `json:"resourceId,omitempty"`

	// Url: The url for this image.
	Url string `json:"url,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "ImageType") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ImageType") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ImageConfiguration: This is a JSON template for an image configuration resource.

func (*ImageConfiguration) MarshalJSON

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

type ImageConfigurationsService

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

func NewImageConfigurationsService

func NewImageConfigurationsService(s *Service) *ImageConfigurationsService

func (*ImageConfigurationsService) Upload

func (r *ImageConfigurationsService) Upload(resourceId string, imageType string) *ImageConfigurationsUploadCall

Upload: Uploads an image for a resource with the given ID and image type.

type ImageConfigurationsUploadCall

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

func (*ImageConfigurationsUploadCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled. This context will supersede any context previously provided to the ResumableMedia method.

func (*ImageConfigurationsUploadCall) Do

Do executes the "gamesConfiguration.imageConfigurations.upload" call. Exactly one of *ImageConfiguration or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ImageConfiguration.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 (*ImageConfigurationsUploadCall) Fields

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

func (*ImageConfigurationsUploadCall) Header

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

func (*ImageConfigurationsUploadCall) Media

Media specifies the media to upload in one or more chunks. The chunk size may be controlled by supplying a MediaOption generated by googleapi.ChunkSize. The chunk size defaults to googleapi.DefaultUploadChunkSize.The Content-Type header used in the upload request will be determined by sniffing the contents of r, unless a MediaOption generated by googleapi.ContentType is supplied. At most one of Media and ResumableMedia may be set.

func (*ImageConfigurationsUploadCall) ProgressUpdater

ProgressUpdater provides a callback function that will be called after every chunk. It should be a low-latency function in order to not slow down the upload operation. This should only be called when using ResumableMedia (as opposed to Media).

func (*ImageConfigurationsUploadCall) ResumableMedia deprecated

This method has been deprecated.

ResumableMedia specifies the media to upload in chunks and can be canceled with ctx.

Deprecated: use Media instead.

At most one of Media and ResumableMedia may be set. mediaType identifies the MIME media type of the upload, such as "image/png". If mediaType is "", it will be auto-detected. The provided ctx will supersede any context previously provided to the Context method.

type LeaderboardConfiguration

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"`

	// ScoreOrder: The type of the leaderboard.
	// Possible values are:
	// - "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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

LeaderboardConfiguration: This is a JSON template for an leaderboard configuration resource.

func (*LeaderboardConfiguration) MarshalJSON

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

type LeaderboardConfigurationDetail

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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

LeaderboardConfigurationDetail: This is a JSON template for a leaderboard configuration detail.

func (*LeaderboardConfigurationDetail) MarshalJSON

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

type LeaderboardConfigurationListResponse

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 games#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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

LeaderboardConfigurationListResponse: This is a JSON template for a ListConfigurations response.

func (*LeaderboardConfigurationListResponse) MarshalJSON

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

type LeaderboardConfigurationsDeleteCall

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

func (*LeaderboardConfigurationsDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*LeaderboardConfigurationsDeleteCall) Do

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

func (*LeaderboardConfigurationsDeleteCall) Fields

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

func (*LeaderboardConfigurationsDeleteCall) Header

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

type LeaderboardConfigurationsGetCall

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

func (*LeaderboardConfigurationsGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*LeaderboardConfigurationsGetCall) Do

Do executes the "gamesConfiguration.leaderboardConfigurations.get" call. Exactly one of *LeaderboardConfiguration or error will be non-nil. 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

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

func (*LeaderboardConfigurationsGetCall) Header

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

func (*LeaderboardConfigurationsGetCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type LeaderboardConfigurationsInsertCall

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

func (*LeaderboardConfigurationsInsertCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*LeaderboardConfigurationsInsertCall) Do

Do executes the "gamesConfiguration.leaderboardConfigurations.insert" call. Exactly one of *LeaderboardConfiguration or error will be non-nil. 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

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

func (*LeaderboardConfigurationsInsertCall) Header

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

type LeaderboardConfigurationsListCall

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

func (*LeaderboardConfigurationsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*LeaderboardConfigurationsListCall) Do

Do executes the "gamesConfiguration.leaderboardConfigurations.list" call. Exactly one of *LeaderboardConfigurationListResponse or error will be non-nil. 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

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

func (*LeaderboardConfigurationsListCall) Header

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

func (*LeaderboardConfigurationsListCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*LeaderboardConfigurationsListCall) MaxResults

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

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

func (*LeaderboardConfigurationsListCall) Pages

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 LeaderboardConfigurationsPatchCall

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

func (*LeaderboardConfigurationsPatchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*LeaderboardConfigurationsPatchCall) Do

Do executes the "gamesConfiguration.leaderboardConfigurations.patch" call. Exactly one of *LeaderboardConfiguration or error will be non-nil. 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 (*LeaderboardConfigurationsPatchCall) Fields

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

func (*LeaderboardConfigurationsPatchCall) Header

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

type LeaderboardConfigurationsService

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

func NewLeaderboardConfigurationsService

func NewLeaderboardConfigurationsService(s *Service) *LeaderboardConfigurationsService

func (*LeaderboardConfigurationsService) Delete

Delete: Delete the leaderboard configuration with the given ID.

func (*LeaderboardConfigurationsService) Get

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

func (*LeaderboardConfigurationsService) Insert

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

Insert: Insert a new leaderboard configuration in this application.

func (*LeaderboardConfigurationsService) List

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

func (*LeaderboardConfigurationsService) Patch

func (r *LeaderboardConfigurationsService) Patch(leaderboardId string, leaderboardconfiguration *LeaderboardConfiguration) *LeaderboardConfigurationsPatchCall

Patch: Update the metadata of the leaderboard configuration with the given ID. This method supports patch semantics.

func (*LeaderboardConfigurationsService) Update

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

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

type LeaderboardConfigurationsUpdateCall

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

func (*LeaderboardConfigurationsUpdateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*LeaderboardConfigurationsUpdateCall) Do

Do executes the "gamesConfiguration.leaderboardConfigurations.update" call. Exactly one of *LeaderboardConfiguration or error will be non-nil. 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

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

func (*LeaderboardConfigurationsUpdateCall) Header

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

type LocalizedString

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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

LocalizedString: This is a JSON template for a localized string resource.

func (*LocalizedString) MarshalJSON

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

type LocalizedStringBundle

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 values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

LocalizedStringBundle: This is a JSON template for a localized string bundle resource.

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

	ImageConfigurations *ImageConfigurationsService

	LeaderboardConfigurations *LeaderboardConfigurationsService
	// contains filtered or unexported fields
}

func New deprecated

This function has been deprecated.
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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto