Movatterモバイル変換


[0]ホーム

URL:


games

package
v0.257.0Latest Latest
Warning

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

Go to latest
Published: Dec 2, 2025 License:BSD-3-ClauseImports:18Imported by:1

Details

Repository

github.com/googleapis/google-api-go-client

Links

Documentation

Overview

Package games provides access to the Google Play Games Services API.

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

Library status

These client libraries are officially supported by Google. However, thislibrary is considered complete and is in maintenance mode. This meansthat we will address critical bugs and security issues but will not addany 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/games/v1"...ctx := context.Background()gamesService, err := games.NewService(ctx)

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

Other authentication options

By default, all available scopes (see "Constants") are used to authenticate.To restrict scopes, usegoogle.golang.org/api/option.WithScopes:

gamesService, err := games.NewService(ctx, option.WithScopes(games.GamesScope))

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

gamesService, err := games.NewService(ctx, option.WithAPIKey("AIza..."))

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

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

Seegoogle.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source
const (// View and manage your Google Play Developer accountAndroidpublisherScope = "https://www.googleapis.com/auth/androidpublisher"// See, create, and delete its own configuration data in your Google DriveDriveAppdataScope = "https://www.googleapis.com/auth/drive.appdata"// Create, edit, and delete your Google Play Games activityGamesScope = "https://www.googleapis.com/auth/games")

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

typeAccesstokensGeneratePlayGroupingApiTokenCalladded inv0.186.0

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

func (*AccesstokensGeneratePlayGroupingApiTokenCall)Contextadded inv0.186.0

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

func (*AccesstokensGeneratePlayGroupingApiTokenCall)Doadded inv0.186.0

Do executes the "games.accesstokens.generatePlayGroupingApiToken" call.Any non-2xx status code is an error. Response headers are in either*GeneratePlayGroupingApiTokenResponse.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*AccesstokensGeneratePlayGroupingApiTokenCall)Fieldsadded inv0.186.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AccesstokensGeneratePlayGroupingApiTokenCall)Headeradded inv0.186.0

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

func (*AccesstokensGeneratePlayGroupingApiTokenCall)PackageNameadded inv0.186.0

PackageName sets the optional parameter "packageName": Required. App packagename to generate the token for (e.g. com.example.mygame).

func (*AccesstokensGeneratePlayGroupingApiTokenCall)Personaadded inv0.186.0

Persona sets the optional parameter "persona": Required. Persona toassociate with the token. Persona is a developer-provided stable identifierof the user. Must be deterministically generated (e.g. as a one-way hash)from the user account ID and user profile ID (if the app has the concept),according to the developer's own user identity system.

typeAccesstokensGenerateRecallPlayGroupingApiTokenCalladded inv0.186.0

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

func (*AccesstokensGenerateRecallPlayGroupingApiTokenCall)Contextadded inv0.186.0

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

func (*AccesstokensGenerateRecallPlayGroupingApiTokenCall)Doadded inv0.186.0

Do executes the "games.accesstokens.generateRecallPlayGroupingApiToken" call.Any non-2xx status code is an error. Response headers are in either*GenerateRecallPlayGroupingApiTokenResponse.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*AccesstokensGenerateRecallPlayGroupingApiTokenCall)Fieldsadded inv0.186.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AccesstokensGenerateRecallPlayGroupingApiTokenCall)Headeradded inv0.186.0

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

func (*AccesstokensGenerateRecallPlayGroupingApiTokenCall)PackageNameadded inv0.186.0

PackageName sets the optional parameter "packageName": Required. App packagename to generate the token for (e.g. com.example.mygame).

func (*AccesstokensGenerateRecallPlayGroupingApiTokenCall)Personaadded inv0.186.0

Persona sets the optional parameter "persona": Required. Persona toassociate with the token. Persona is a developer-provided stable identifierof the user. Must be deterministically generated (e.g. as a one-way hash)from the user account ID and user profile ID (if the app has the concept),according to the developer's own user identity system.

func (*AccesstokensGenerateRecallPlayGroupingApiTokenCall)RecallSessionIdadded inv0.186.0

RecallSessionId sets the optional parameter "recallSessionId": Required.Opaque server-generated string that encodes all the necessary information toidentify the PGS player / Google user and application. Seehttps://developer.android.com/games/pgs/recall/recall-setup on how tointegrate with Recall and get session ID.

typeAccesstokensServiceadded inv0.186.0

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

funcNewAccesstokensServiceadded inv0.186.0

func NewAccesstokensService(s *Service) *AccesstokensService

func (*AccesstokensService)GeneratePlayGroupingApiTokenadded inv0.186.0

func (r *AccesstokensService) GeneratePlayGroupingApiToken() *AccesstokensGeneratePlayGroupingApiTokenCall

GeneratePlayGroupingApiToken: Generates a Play Grouping API token for thePGS user identified by the attached credential.

func (*AccesstokensService)GenerateRecallPlayGroupingApiTokenadded inv0.186.0

func (r *AccesstokensService) GenerateRecallPlayGroupingApiToken() *AccesstokensGenerateRecallPlayGroupingApiTokenCall

GenerateRecallPlayGroupingApiToken: Generates a Play Grouping API token forthe PGS user identified by the Recall session ID provided in the request.

typeAchievementDefinition

type AchievementDefinition struct {// AchievementType: The type of the achievement.//// Possible values://   "STANDARD" - Achievement is either locked or unlocked.//   "INCREMENTAL" - Achievement is incremental.AchievementTypestring `json:"achievementType,omitempty"`// Description: The description of the achievement.Descriptionstring `json:"description,omitempty"`// ExperiencePoints: Experience points which will be earned when unlocking this// achievement.ExperiencePointsint64 `json:"experiencePoints,omitempty,string"`// FormattedTotalSteps: The total steps for an incremental achievement as a// string.FormattedTotalStepsstring `json:"formattedTotalSteps,omitempty"`// Id: The ID of the achievement.Idstring `json:"id,omitempty"`// InitialState: The initial state of the achievement.//// Possible values://   "HIDDEN" - Achievement is hidden.//   "REVEALED" - Achievement is revealed.//   "UNLOCKED" - Achievement is unlocked.InitialStatestring `json:"initialState,omitempty"`// IsRevealedIconUrlDefault: Indicates whether the revealed icon image being// returned is a default image, or is provided by the game.IsRevealedIconUrlDefaultbool `json:"isRevealedIconUrlDefault,omitempty"`// IsUnlockedIconUrlDefault: Indicates whether the unlocked icon image being// returned is a default image, or is game-provided.IsUnlockedIconUrlDefaultbool `json:"isUnlockedIconUrlDefault,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#achievementDefinition`.Kindstring `json:"kind,omitempty"`// Name: The name of the achievement.Namestring `json:"name,omitempty"`// RevealedIconUrl: The image URL for the revealed achievement icon.RevealedIconUrlstring `json:"revealedIconUrl,omitempty"`// TotalSteps: The total steps for an incremental achievement.TotalStepsint64 `json:"totalSteps,omitempty"`// UnlockedIconUrl: The image URL for the unlocked achievement icon.UnlockedIconUrlstring `json:"unlockedIconUrl,omitempty"`// 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:"-"`}

AchievementDefinition: An achievement definition object.

func (AchievementDefinition)MarshalJSON

func (sAchievementDefinition) MarshalJSON() ([]byte,error)

typeAchievementDefinitionsListCall

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

func (*AchievementDefinitionsListCall)Context

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

func (*AchievementDefinitionsListCall)Do

Do executes the "games.achievementDefinitions.list" call.Any non-2xx status code is an error. Response headers are in either*AchievementDefinitionsListResponse.ServerResponse.Header or (if a responsewas returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*AchievementDefinitionsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AchievementDefinitionsListCall)Header

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

func (*AchievementDefinitionsListCall)IfNoneMatch

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

func (*AchievementDefinitionsListCall)Language

Language sets the optional parameter "language": The preferred language touse for strings returned by this method.

func (*AchievementDefinitionsListCall)MaxResults

MaxResults sets the optional parameter "maxResults": The maximum number ofachievement resources to return in the response, used for paging. For anyresponse, the actual number of achievement resources returned may be lessthan the specified `maxResults`.

func (*AchievementDefinitionsListCall)PageToken

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

func (*AchievementDefinitionsListCall)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.

typeAchievementDefinitionsListResponse

type AchievementDefinitionsListResponse struct {// Items: The achievement definitions.Items []*AchievementDefinition `json:"items,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#achievementDefinitionsListResponse`.Kindstring `json:"kind,omitempty"`// NextPageToken: Token corresponding to the next page of results.NextPageTokenstring `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:"-"`}

AchievementDefinitionsListResponse: A list of achievement definitionobjects.

func (AchievementDefinitionsListResponse)MarshalJSON

typeAchievementDefinitionsService

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

funcNewAchievementDefinitionsService

func NewAchievementDefinitionsService(s *Service) *AchievementDefinitionsService

func (*AchievementDefinitionsService)List

List: Lists all the achievement definitions for your application.

typeAchievementIncrementResponse

type AchievementIncrementResponse struct {// CurrentSteps: The current steps recorded for this incremental achievement.CurrentStepsint64 `json:"currentSteps,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#achievementIncrementResponse`.Kindstring `json:"kind,omitempty"`// NewlyUnlocked: Whether the current steps for the achievement has reached the// number of steps required to unlock.NewlyUnlockedbool `json:"newlyUnlocked,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CurrentSteps") 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. "CurrentSteps") 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:"-"`}

AchievementIncrementResponse: An achievement increment response

func (AchievementIncrementResponse)MarshalJSON

func (sAchievementIncrementResponse) MarshalJSON() ([]byte,error)

typeAchievementRevealResponse

type AchievementRevealResponse struct {// CurrentState: The current state of the achievement for which a reveal was// attempted. This might be `UNLOCKED` if the achievement was already unlocked.//// Possible values://   "REVEALED" - Achievement is revealed.//   "UNLOCKED" - Achievement is unlocked.CurrentStatestring `json:"currentState,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#achievementRevealResponse`.Kindstring `json:"kind,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CurrentState") 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. "CurrentState") 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:"-"`}

AchievementRevealResponse: An achievement reveal response

func (AchievementRevealResponse)MarshalJSON

func (sAchievementRevealResponse) MarshalJSON() ([]byte,error)

typeAchievementSetStepsAtLeastResponse

type AchievementSetStepsAtLeastResponse struct {// CurrentSteps: The current steps recorded for this incremental achievement.CurrentStepsint64 `json:"currentSteps,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#achievementSetStepsAtLeastResponse`.Kindstring `json:"kind,omitempty"`// NewlyUnlocked: Whether the current steps for the achievement has reached the// number of steps required to unlock.NewlyUnlockedbool `json:"newlyUnlocked,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CurrentSteps") 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. "CurrentSteps") 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:"-"`}

AchievementSetStepsAtLeastResponse: An achievement set steps at leastresponse.

func (AchievementSetStepsAtLeastResponse)MarshalJSON

typeAchievementUnlockResponse

type AchievementUnlockResponse struct {// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#achievementUnlockResponse`.Kindstring `json:"kind,omitempty"`// NewlyUnlocked: Whether this achievement was newly unlocked (that is, whether// the unlock request for the achievement was the first for the player).NewlyUnlockedbool `json:"newlyUnlocked,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// 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:"-"`}

AchievementUnlockResponse: An achievement unlock response

func (AchievementUnlockResponse)MarshalJSON

func (sAchievementUnlockResponse) MarshalJSON() ([]byte,error)

typeAchievementUpdateMultipleRequest

type AchievementUpdateMultipleRequest struct {// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#achievementUpdateMultipleRequest`.Kindstring `json:"kind,omitempty"`// Updates: The individual achievement update requests.Updates []*AchievementUpdateRequest `json:"updates,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:"-"`}

AchievementUpdateMultipleRequest: A list of achievement update requests.

func (AchievementUpdateMultipleRequest)MarshalJSON

func (sAchievementUpdateMultipleRequest) MarshalJSON() ([]byte,error)

typeAchievementUpdateMultipleResponse

type AchievementUpdateMultipleResponse struct {// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#achievementUpdateMultipleResponse`.Kindstring `json:"kind,omitempty"`// UpdatedAchievements: The updated state of the achievements.UpdatedAchievements []*AchievementUpdateResponse `json:"updatedAchievements,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// 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:"-"`}

AchievementUpdateMultipleResponse: Response message forUpdateMultipleAchievements rpc.

func (AchievementUpdateMultipleResponse)MarshalJSON

func (sAchievementUpdateMultipleResponse) MarshalJSON() ([]byte,error)

typeAchievementUpdateRequest

type AchievementUpdateRequest struct {// AchievementId: The achievement this update is being applied to.AchievementIdstring `json:"achievementId,omitempty"`// IncrementPayload: The payload if an update of type `INCREMENT` was requested// for the achievement.IncrementPayload *GamesAchievementIncrement `json:"incrementPayload,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#achievementUpdateRequest`.Kindstring `json:"kind,omitempty"`// SetStepsAtLeastPayload: The payload if an update of type// `SET_STEPS_AT_LEAST` was requested for the achievement.SetStepsAtLeastPayload *GamesAchievementSetStepsAtLeast `json:"setStepsAtLeastPayload,omitempty"`// UpdateType: The type of update being applied.//// Possible values://   "REVEAL" - Achievement is revealed.//   "UNLOCK" - Achievement is unlocked.//   "INCREMENT" - Achievement is incremented.//   "SET_STEPS_AT_LEAST" - Achievement progress is set to at least the passed// value.UpdateTypestring `json:"updateType,omitempty"`// ForceSendFields is a list of field names (e.g. "AchievementId") 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. "AchievementId") 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:"-"`}

AchievementUpdateRequest: A request to update an achievement.

func (AchievementUpdateRequest)MarshalJSON

func (sAchievementUpdateRequest) MarshalJSON() ([]byte,error)

typeAchievementUpdateResponse

type AchievementUpdateResponse struct {// AchievementId: The achievement this update is was applied to.AchievementIdstring `json:"achievementId,omitempty"`// CurrentState: The current state of the achievement.//// Possible values://   "HIDDEN" - Achievement is hidden.//   "REVEALED" - Achievement is revealed.//   "UNLOCKED" - Achievement is unlocked.CurrentStatestring `json:"currentState,omitempty"`// CurrentSteps: The current steps recorded for this achievement if it is// incremental.CurrentStepsint64 `json:"currentSteps,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#achievementUpdateResponse`.Kindstring `json:"kind,omitempty"`// NewlyUnlocked: Whether this achievement was newly unlocked (that is, whether// the unlock request for the achievement was the first for the player).NewlyUnlockedbool `json:"newlyUnlocked,omitempty"`// UpdateOccurred: Whether the requested updates actually affected the// achievement.UpdateOccurredbool `json:"updateOccurred,omitempty"`// ForceSendFields is a list of field names (e.g. "AchievementId") 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. "AchievementId") 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:"-"`}

AchievementUpdateResponse: An updated achievement.

func (AchievementUpdateResponse)MarshalJSON

func (sAchievementUpdateResponse) MarshalJSON() ([]byte,error)

typeAchievementsIncrementCall

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

func (*AchievementsIncrementCall)Context

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

func (*AchievementsIncrementCall)Do

Do executes the "games.achievements.increment" call.Any non-2xx status code is an error. Response headers are in either*AchievementIncrementResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*AchievementsIncrementCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AchievementsIncrementCall)Header

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

func (*AchievementsIncrementCall)RequestId

RequestId sets the optional parameter "requestId": A randomly generatednumeric ID for each request specified by the caller. This number is used atthe server to ensure that the request is handled correctly across retries.

typeAchievementsListCall

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

func (*AchievementsListCall)Context

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

func (*AchievementsListCall)Do

Do executes the "games.achievements.list" call.Any non-2xx status code is an error. Response headers are in either*PlayerAchievementListResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*AchievementsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AchievementsListCall)Header

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

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

func (*AchievementsListCall)IfNoneMatch

func (c *AchievementsListCall) IfNoneMatch(entityTagstring) *AchievementsListCall

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

func (*AchievementsListCall)Language

func (c *AchievementsListCall) Language(languagestring) *AchievementsListCall

Language sets the optional parameter "language": The preferred language touse for strings returned by this method.

func (*AchievementsListCall)MaxResults

func (c *AchievementsListCall) MaxResults(maxResultsint64) *AchievementsListCall

MaxResults sets the optional parameter "maxResults": The maximum number ofachievement resources to return in the response, used for paging. For anyresponse, the actual number of achievement resources returned may be lessthan the specified `maxResults`.

func (*AchievementsListCall)PageToken

func (c *AchievementsListCall) PageToken(pageTokenstring) *AchievementsListCall

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

func (*AchievementsListCall)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.

func (*AchievementsListCall)State

State sets the optional parameter "state": Tells the server to return onlyachievements with the specified state. If this parameter isn't specified,all achievements are returned.

Possible values:

"ALL" - List all achievements. This is the default."HIDDEN" - List only hidden achievements."REVEALED" - List only revealed achievements."UNLOCKED" - List only unlocked achievements.

typeAchievementsRevealCall

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

func (*AchievementsRevealCall)Context

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

func (*AchievementsRevealCall)Do

Do executes the "games.achievements.reveal" call.Any non-2xx status code is an error. Response headers are in either*AchievementRevealResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*AchievementsRevealCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AchievementsRevealCall)Header

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

typeAchievementsService

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

funcNewAchievementsService

func NewAchievementsService(s *Service) *AchievementsService

func (*AchievementsService)Increment

func (r *AchievementsService) Increment(achievementIdstring, stepsToIncrementint64) *AchievementsIncrementCall

Increment: Increments the steps of the achievement with the given ID for thecurrently authenticated player.

- achievementId: The ID of the achievement used by this method.- stepsToIncrement: The number of steps to increment.

func (*AchievementsService)List

List: Lists the progress for all your application's achievements for thecurrently authenticated player.

  • playerId: A player ID. A value of `me` may be used in place of theauthenticated player's ID.

func (*AchievementsService)Reveal

func (r *AchievementsService) Reveal(achievementIdstring) *AchievementsRevealCall

Reveal: Sets the state of the achievement with the given ID to `REVEALED`for the currently authenticated player.

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

func (*AchievementsService)SetStepsAtLeast

func (r *AchievementsService) SetStepsAtLeast(achievementIdstring, stepsint64) *AchievementsSetStepsAtLeastCall

SetStepsAtLeast: Sets the steps for the currently authenticated playertowards unlocking an achievement. If the steps parameter is less than thecurrent number of steps that the player already gained for the achievement,the achievement is not modified.

- achievementId: The ID of the achievement used by this method.- steps: The minimum value to set the steps to.

func (*AchievementsService)Unlock

func (r *AchievementsService) Unlock(achievementIdstring) *AchievementsUnlockCall

Unlock: Unlocks this achievement for the currently authenticated player.

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

func (*AchievementsService)UpdateMultiple

func (r *AchievementsService) UpdateMultiple(achievementupdatemultiplerequest *AchievementUpdateMultipleRequest) *AchievementsUpdateMultipleCall

UpdateMultiple: Updates multiple achievements for the currentlyauthenticated player.

typeAchievementsSetStepsAtLeastCall

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

func (*AchievementsSetStepsAtLeastCall)Context

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

func (*AchievementsSetStepsAtLeastCall)Do

Do executes the "games.achievements.setStepsAtLeast" call.Any non-2xx status code is an error. Response headers are in either*AchievementSetStepsAtLeastResponse.ServerResponse.Header or (if a responsewas returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*AchievementsSetStepsAtLeastCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AchievementsSetStepsAtLeastCall)Header

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

typeAchievementsUnlockCall

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

func (*AchievementsUnlockCall)Context

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

func (*AchievementsUnlockCall)Do

Do executes the "games.achievements.unlock" call.Any non-2xx status code is an error. Response headers are in either*AchievementUnlockResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*AchievementsUnlockCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AchievementsUnlockCall)Header

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

typeAchievementsUpdateMultipleCall

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

func (*AchievementsUpdateMultipleCall)Context

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

func (*AchievementsUpdateMultipleCall)Do

Do executes the "games.achievements.updateMultiple" call.Any non-2xx status code is an error. Response headers are in either*AchievementUpdateMultipleResponse.ServerResponse.Header or (if a responsewas returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*AchievementsUpdateMultipleCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AchievementsUpdateMultipleCall)Header

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

typeApplication

type Application struct {// AchievementCount: The number of achievements visible to the currently// authenticated player.AchievementCountint64 `json:"achievement_count,omitempty"`// Assets: The assets of the application.Assets []*ImageAsset `json:"assets,omitempty"`// Author: The author of the application.Authorstring `json:"author,omitempty"`// Category: The category of the application.Category *ApplicationCategory `json:"category,omitempty"`// Description: The description of the application.Descriptionstring `json:"description,omitempty"`// EnabledFeatures: A list of features that have been enabled for the// application.//// Possible values://   "SNAPSHOTS" - Saved Games (snapshots).EnabledFeatures []string `json:"enabledFeatures,omitempty"`// Id: The ID of the application.Idstring `json:"id,omitempty"`// Instances: The instances of the application.Instances []*Instance `json:"instances,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#application`.Kindstring `json:"kind,omitempty"`// LastUpdatedTimestamp: The last updated timestamp of the application.LastUpdatedTimestampint64 `json:"lastUpdatedTimestamp,omitempty,string"`// LeaderboardCount: The number of leaderboards visible to the currently// authenticated player.LeaderboardCountint64 `json:"leaderboard_count,omitempty"`// Name: The name of the application.Namestring `json:"name,omitempty"`// ThemeColor: A hint to the client UI for what color to use as an app-themed// color. The color is given as an RGB triplet (e.g. "E0E0E0").ThemeColorstring `json:"themeColor,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AchievementCount") 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. "AchievementCount") 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:"-"`}

Application: The Application resource.

func (Application)MarshalJSON

func (sApplication) MarshalJSON() ([]byte,error)

typeApplicationCategory

type ApplicationCategory struct {// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#applicationCategory`.Kindstring `json:"kind,omitempty"`// Primary: The primary category.Primarystring `json:"primary,omitempty"`// Secondary: The secondary category.Secondarystring `json:"secondary,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:"-"`}

ApplicationCategory: An application category object.

func (ApplicationCategory)MarshalJSON

func (sApplicationCategory) MarshalJSON() ([]byte,error)

typeApplicationPlayerIdadded inv0.114.0

type ApplicationPlayerId struct {// ApplicationId: The application that this player identifier is for.ApplicationIdstring `json:"applicationId,omitempty"`// PlayerId: The player identifier for the application.PlayerIdstring `json:"playerId,omitempty"`// ForceSendFields is a list of field names (e.g. "ApplicationId") 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. "ApplicationId") 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:"-"`}

ApplicationPlayerId: Primary scoped player identifier for an application.

func (ApplicationPlayerId)MarshalJSONadded inv0.114.0

func (sApplicationPlayerId) MarshalJSON() ([]byte,error)

typeApplicationVerifyResponse

type ApplicationVerifyResponse struct {// AlternatePlayerId: An alternate ID that was once used for the player that// was issued the auth token used in this request. (This field is not normally// populated.)AlternatePlayerIdstring `json:"alternate_player_id,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#applicationVerifyResponse`.Kindstring `json:"kind,omitempty"`// PlayerId: The ID of the player that was issued the auth token used in this// request.PlayerIdstring `json:"player_id,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AlternatePlayerId") 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. "AlternatePlayerId") 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:"-"`}

ApplicationVerifyResponse: A third party application verification responseresource.

func (ApplicationVerifyResponse)MarshalJSON

func (sApplicationVerifyResponse) MarshalJSON() ([]byte,error)

typeApplicationsGetCall

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

func (*ApplicationsGetCall)Context

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

func (*ApplicationsGetCall)Do

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

func (*ApplicationsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ApplicationsGetCall)Header

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

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

func (*ApplicationsGetCall)IfNoneMatch

func (c *ApplicationsGetCall) IfNoneMatch(entityTagstring) *ApplicationsGetCall

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

func (*ApplicationsGetCall)Language

func (c *ApplicationsGetCall) Language(languagestring) *ApplicationsGetCall

Language sets the optional parameter "language": The preferred language touse for strings returned by this method.

func (*ApplicationsGetCall)PlatformType

func (c *ApplicationsGetCall) PlatformType(platformTypestring) *ApplicationsGetCall

PlatformType sets the optional parameter "platformType": Restrictapplication details returned to the specific platform.

Possible values:

"ANDROID" - Retrieve applications that can be played on Android."IOS" - Retrieve applications that can be played on iOS."WEB_APP" - Retrieve applications that can be played on desktop web.

typeApplicationsGetEndPointCalladded inv0.37.0

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

func (*ApplicationsGetEndPointCall)ApplicationIdadded inv0.37.0

func (c *ApplicationsGetEndPointCall) ApplicationId(applicationIdstring) *ApplicationsGetEndPointCall

ApplicationId sets the optional parameter "applicationId": The applicationID from the Google Play developer console.

func (*ApplicationsGetEndPointCall)Contextadded inv0.37.0

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

func (*ApplicationsGetEndPointCall)Doadded inv0.37.0

Do executes the "games.applications.getEndPoint" call.Any non-2xx status code is an error. Response headers are in either*EndPoint.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ApplicationsGetEndPointCall)EndPointTypeadded inv0.37.0

EndPointType sets the optional parameter "endPointType": Type of endpointbeing requested.

Possible values:

"PROFILE_CREATION" - Request a URL to create a new profile."PROFILE_SETTINGS" - Request a URL for the Settings view.

func (*ApplicationsGetEndPointCall)Fieldsadded inv0.37.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ApplicationsGetEndPointCall)Headeradded inv0.37.0

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

typeApplicationsPlayedCall

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

func (*ApplicationsPlayedCall)Context

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

func (*ApplicationsPlayedCall)Do

Do executes the "games.applications.played" call.

func (*ApplicationsPlayedCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ApplicationsPlayedCall)Header

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

typeApplicationsService

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

funcNewApplicationsService

func NewApplicationsService(s *Service) *ApplicationsService

func (*ApplicationsService)Get

func (r *ApplicationsService) Get(applicationIdstring) *ApplicationsGetCall

Get: Retrieves the metadata of the application with the given ID. If therequested application is not available for the specified `platformType`, thereturned response will not include any instance data.

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

func (*ApplicationsService)GetEndPointadded inv0.37.0

GetEndPoint: Returns a URL for the requested end point type.

func (*ApplicationsService)Played

Played: Indicate that the currently authenticated user is playing yourapplication.

func (*ApplicationsService)Verify

func (r *ApplicationsService) Verify(applicationIdstring) *ApplicationsVerifyCall

Verify: Verifies the auth token provided with this request is for theapplication with the specified ID, and returns the ID of the player it wasgranted for.

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

typeApplicationsVerifyCall

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

func (*ApplicationsVerifyCall)Context

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

func (*ApplicationsVerifyCall)Do

Do executes the "games.applications.verify" call.Any non-2xx status code is an error. Response headers are in either*ApplicationVerifyResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ApplicationsVerifyCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ApplicationsVerifyCall)Header

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

func (*ApplicationsVerifyCall)IfNoneMatch

func (c *ApplicationsVerifyCall) IfNoneMatch(entityTagstring) *ApplicationsVerifyCall

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

typeCategory

type Category struct {// Category: The category name.Categorystring `json:"category,omitempty"`// ExperiencePoints: Experience points earned in this category.ExperiencePointsint64 `json:"experiencePoints,omitempty,string"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#category`.Kindstring `json:"kind,omitempty"`// ForceSendFields is a list of field names (e.g. "Category") 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. "Category") 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:"-"`}

Category: Data related to individual game categories.

func (Category)MarshalJSON

func (sCategory) MarshalJSON() ([]byte,error)

typeCategoryListResponse

type CategoryListResponse struct {// Items: The list of categories with usage data.Items []*Category `json:"items,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#categoryListResponse`.Kindstring `json:"kind,omitempty"`// NextPageToken: Token corresponding to the next page of results.NextPageTokenstring `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:"-"`}

CategoryListResponse: A third party list metagame categories response.

func (CategoryListResponse)MarshalJSON

func (sCategoryListResponse) MarshalJSON() ([]byte,error)

typeEndPointadded inv0.37.0

type EndPoint struct {// Url: A URL suitable for loading in a web browser for the requested endpoint.Urlstring `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. "Url") 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. "Url") 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:"-"`}

EndPoint: Container for a URL end point of the requested type.

func (EndPoint)MarshalJSONadded inv0.37.0

func (sEndPoint) MarshalJSON() ([]byte,error)

typeEventBatchRecordFailure

type EventBatchRecordFailure struct {// FailureCause: The cause for the update failure.//// Possible values://   "TOO_LARGE" - A batch request was issued with more events than are allowed// in a single batch.//   "TIME_PERIOD_EXPIRED" - A batch was sent with data too far in the past to// record.//   "TIME_PERIOD_SHORT" - A batch was sent with a time range that was too// short.//   "TIME_PERIOD_LONG" - A batch was sent with a time range that was too long.//   "ALREADY_UPDATED" - An attempt was made to record a batch of data which// was already seen.//   "RECORD_RATE_HIGH" - An attempt was made to record data faster than the// server will apply updates.FailureCausestring `json:"failureCause,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#eventBatchRecordFailure`.Kindstring `json:"kind,omitempty"`// Range: The time range which was rejected; empty for a request-wide failure.Range *EventPeriodRange `json:"range,omitempty"`// ForceSendFields is a list of field names (e.g. "FailureCause") 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. "FailureCause") 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:"-"`}

EventBatchRecordFailure: A batch update failure resource.

func (EventBatchRecordFailure)MarshalJSON

func (sEventBatchRecordFailure) MarshalJSON() ([]byte,error)

typeEventChild

type EventChild struct {// ChildId: The ID of the child event.ChildIdstring `json:"childId,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#eventChild`.Kindstring `json:"kind,omitempty"`// ForceSendFields is a list of field names (e.g. "ChildId") 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. "ChildId") 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:"-"`}

EventChild: An event child relationship resource.

func (EventChild)MarshalJSON

func (sEventChild) MarshalJSON() ([]byte,error)

typeEventDefinition

type EventDefinition struct {// ChildEvents: A list of events that are a child of this event.ChildEvents []*EventChild `json:"childEvents,omitempty"`// Description: Description of what this event represents.Descriptionstring `json:"description,omitempty"`// DisplayName: The name to display for the event.DisplayNamestring `json:"displayName,omitempty"`// Id: The ID of the event.Idstring `json:"id,omitempty"`// ImageUrl: The base URL for the image that represents the event.ImageUrlstring `json:"imageUrl,omitempty"`// IsDefaultImageUrl: Indicates whether the icon image being returned is a// default image, or is game-provided.IsDefaultImageUrlbool `json:"isDefaultImageUrl,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#eventDefinition`.Kindstring `json:"kind,omitempty"`// Visibility: The visibility of event being tracked in this definition.//// Possible values://   "REVEALED" - This event should be visible to all users.//   "HIDDEN" - This event should only be shown to users that have recorded// this event at least once.Visibilitystring `json:"visibility,omitempty"`// ForceSendFields is a list of field names (e.g. "ChildEvents") 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. "ChildEvents") 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:"-"`}

EventDefinition: An event definition resource.

func (EventDefinition)MarshalJSON

func (sEventDefinition) MarshalJSON() ([]byte,error)

typeEventDefinitionListResponse

type EventDefinitionListResponse struct {// Items: The event definitions.Items []*EventDefinition `json:"items,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#eventDefinitionListResponse`.Kindstring `json:"kind,omitempty"`// NextPageToken: The pagination token for the next page of results.NextPageTokenstring `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:"-"`}

EventDefinitionListResponse: A ListDefinitions response.

func (EventDefinitionListResponse)MarshalJSON

func (sEventDefinitionListResponse) MarshalJSON() ([]byte,error)

typeEventPeriodRange

type EventPeriodRange struct {// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#eventPeriodRange`.Kindstring `json:"kind,omitempty"`// PeriodEndMillis: The time when this update period ends, in millis, since// 1970 UTC (Unix Epoch).PeriodEndMillisint64 `json:"periodEndMillis,omitempty,string"`// PeriodStartMillis: The time when this update period begins, in millis, since// 1970 UTC (Unix Epoch).PeriodStartMillisint64 `json:"periodStartMillis,omitempty,string"`// 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:"-"`}

EventPeriodRange: An event period time range.

func (EventPeriodRange)MarshalJSON

func (sEventPeriodRange) MarshalJSON() ([]byte,error)

typeEventPeriodUpdate

type EventPeriodUpdate struct {// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#eventPeriodUpdate`.Kindstring `json:"kind,omitempty"`// TimePeriod: The time period being covered by this update.TimePeriod *EventPeriodRange `json:"timePeriod,omitempty"`// Updates: The updates being made for this time period.Updates []*EventUpdateRequest `json:"updates,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:"-"`}

EventPeriodUpdate: An event period update resource.

func (EventPeriodUpdate)MarshalJSON

func (sEventPeriodUpdate) MarshalJSON() ([]byte,error)

typeEventRecordFailure

type EventRecordFailure struct {// EventId: The ID of the event that was not updated.EventIdstring `json:"eventId,omitempty"`// FailureCause: The cause for the update failure.//// Possible values://   "NOT_FOUND" - An attempt was made to set an event that was not defined.//   "INVALID_UPDATE_VALUE" - An attempt was made to increment an event by a// non-positive value.FailureCausestring `json:"failureCause,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#eventRecordFailure`.Kindstring `json:"kind,omitempty"`// ForceSendFields is a list of field names (e.g. "EventId") 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. "EventId") 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:"-"`}

EventRecordFailure: An event update failure resource.

func (EventRecordFailure)MarshalJSON

func (sEventRecordFailure) MarshalJSON() ([]byte,error)

typeEventRecordRequest

type EventRecordRequest struct {// CurrentTimeMillis: The current time when this update was sent, in// milliseconds, since 1970 UTC (Unix Epoch).CurrentTimeMillisint64 `json:"currentTimeMillis,omitempty,string"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#eventRecordRequest`.Kindstring `json:"kind,omitempty"`// RequestId: The request ID used to identify this attempt to record events.RequestIdint64 `json:"requestId,omitempty,string"`// TimePeriods: A list of the time period updates being made in this request.TimePeriods []*EventPeriodUpdate `json:"timePeriods,omitempty"`// ForceSendFields is a list of field names (e.g. "CurrentTimeMillis") 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. "CurrentTimeMillis") 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:"-"`}

EventRecordRequest: An event period update resource.

func (EventRecordRequest)MarshalJSON

func (sEventRecordRequest) MarshalJSON() ([]byte,error)

typeEventUpdateRequest

type EventUpdateRequest struct {// DefinitionId: The ID of the event being modified in this update.DefinitionIdstring `json:"definitionId,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#eventUpdateRequest`.Kindstring `json:"kind,omitempty"`// UpdateCount: The number of times this event occurred in this time period.UpdateCountint64 `json:"updateCount,omitempty,string"`// ForceSendFields is a list of field names (e.g. "DefinitionId") 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. "DefinitionId") 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:"-"`}

EventUpdateRequest: An event period update resource.

func (EventUpdateRequest)MarshalJSON

func (sEventUpdateRequest) MarshalJSON() ([]byte,error)

typeEventUpdateResponse

type EventUpdateResponse struct {// BatchFailures: Any batch-wide failures which occurred applying updates.BatchFailures []*EventBatchRecordFailure `json:"batchFailures,omitempty"`// EventFailures: Any failures updating a particular event.EventFailures []*EventRecordFailure `json:"eventFailures,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#eventUpdateResponse`.Kindstring `json:"kind,omitempty"`// PlayerEvents: The current status of any updated eventsPlayerEvents []*PlayerEvent `json:"playerEvents,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "BatchFailures") 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. "BatchFailures") 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:"-"`}

EventUpdateResponse: An event period update resource.

func (EventUpdateResponse)MarshalJSON

func (sEventUpdateResponse) MarshalJSON() ([]byte,error)

typeEventsListByPlayerCall

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

func (*EventsListByPlayerCall)Context

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

func (*EventsListByPlayerCall)Do

Do executes the "games.events.listByPlayer" call.Any non-2xx status code is an error. Response headers are in either*PlayerEventListResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*EventsListByPlayerCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*EventsListByPlayerCall)Header

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

func (*EventsListByPlayerCall)IfNoneMatch

func (c *EventsListByPlayerCall) IfNoneMatch(entityTagstring) *EventsListByPlayerCall

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

func (*EventsListByPlayerCall)Language

Language sets the optional parameter "language": The preferred language touse for strings returned by this method.

func (*EventsListByPlayerCall)MaxResults

func (c *EventsListByPlayerCall) MaxResults(maxResultsint64) *EventsListByPlayerCall

MaxResults sets the optional parameter "maxResults": The maximum number ofevents to return in the response, used for paging. For any response, theactual number of events to return may be less than the specified maxResults.

func (*EventsListByPlayerCall)PageToken

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

func (*EventsListByPlayerCall)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.

typeEventsListDefinitionsCall

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

func (*EventsListDefinitionsCall)Context

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

func (*EventsListDefinitionsCall)Do

Do executes the "games.events.listDefinitions" call.Any non-2xx status code is an error. Response headers are in either*EventDefinitionListResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*EventsListDefinitionsCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*EventsListDefinitionsCall)Header

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

func (*EventsListDefinitionsCall)IfNoneMatch

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

func (*EventsListDefinitionsCall)Language

Language sets the optional parameter "language": The preferred language touse for strings returned by this method.

func (*EventsListDefinitionsCall)MaxResults

MaxResults sets the optional parameter "maxResults": The maximum number ofevent definitions to return in the response, used for paging. For anyresponse, the actual number of event definitions to return may be less thanthe specified `maxResults`.

func (*EventsListDefinitionsCall)PageToken

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

func (*EventsListDefinitionsCall)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.

typeEventsRecordCall

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

func (*EventsRecordCall)Context

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

func (*EventsRecordCall)Do

Do executes the "games.events.record" call.Any non-2xx status code is an error. Response headers are in either*EventUpdateResponse.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*EventsRecordCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*EventsRecordCall)Header

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

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

func (*EventsRecordCall)Language

func (c *EventsRecordCall) Language(languagestring) *EventsRecordCall

Language sets the optional parameter "language": The preferred language touse for strings returned by this method.

typeEventsService

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

funcNewEventsService

func NewEventsService(s *Service) *EventsService

func (*EventsService)ListByPlayer

func (r *EventsService) ListByPlayer() *EventsListByPlayerCall

ListByPlayer: Returns a list showing the current progress on events in thisapplication for the currently authenticated user.

func (*EventsService)ListDefinitions

func (r *EventsService) ListDefinitions() *EventsListDefinitionsCall

ListDefinitions: Returns a list of the event definitions in thisapplication.

func (*EventsService)Record

func (r *EventsService) Record(eventrecordrequest *EventRecordRequest) *EventsRecordCall

Record: Records a batch of changes to the number of times events haveoccurred for the currently authenticated user of this application.

typeGamePlayerTokenadded inv0.184.0

type GamePlayerToken struct {// ApplicationId: The application that this player identifier is for.ApplicationIdstring `json:"applicationId,omitempty"`// RecallToken: Recall token data.RecallToken *RecallToken `json:"recallToken,omitempty"`// ForceSendFields is a list of field names (e.g. "ApplicationId") 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. "ApplicationId") 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:"-"`}

GamePlayerToken: Recall tokens for a game.

func (GamePlayerToken)MarshalJSONadded inv0.184.0

func (sGamePlayerToken) MarshalJSON() ([]byte,error)

typeGamesAchievementIncrement

type GamesAchievementIncrement struct {// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#GamesAchievementIncrement`.Kindstring `json:"kind,omitempty"`// RequestId: The requestId associated with an increment to an achievement.RequestIdint64 `json:"requestId,omitempty,string"`// Steps: The number of steps to be incremented.Stepsint64 `json:"steps,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:"-"`}

GamesAchievementIncrement: The payload to request to increment anachievement.

func (GamesAchievementIncrement)MarshalJSON

func (sGamesAchievementIncrement) MarshalJSON() ([]byte,error)

typeGamesAchievementSetStepsAtLeast

type GamesAchievementSetStepsAtLeast struct {// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#GamesAchievementSetStepsAtLeast`.Kindstring `json:"kind,omitempty"`// Steps: The minimum number of steps for the achievement to be set to.Stepsint64 `json:"steps,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:"-"`}

GamesAchievementSetStepsAtLeast: The payload to request to increment anachievement.

func (GamesAchievementSetStepsAtLeast)MarshalJSON

func (sGamesAchievementSetStepsAtLeast) MarshalJSON() ([]byte,error)

typeGeneratePlayGroupingApiTokenResponseadded inv0.186.0

type GeneratePlayGroupingApiTokenResponse struct {// Token: Token for accessing the Play Grouping API.Token *PlayGroupingApiToken `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. "Token") 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. "Token") 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:"-"`}

GeneratePlayGroupingApiTokenResponse: Response for theGeneratePlayGroupingApiToken RPC.

func (GeneratePlayGroupingApiTokenResponse)MarshalJSONadded inv0.186.0

typeGenerateRecallPlayGroupingApiTokenResponseadded inv0.186.0

type GenerateRecallPlayGroupingApiTokenResponse struct {// Token: Token for accessing the Play Grouping API.Token *PlayGroupingApiToken `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. "Token") 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. "Token") 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:"-"`}

GenerateRecallPlayGroupingApiTokenResponse: Response for theGenerateRecallPlayGroupingApiToken RPC.

func (GenerateRecallPlayGroupingApiTokenResponse)MarshalJSONadded inv0.186.0

typeGetMultipleApplicationPlayerIdsResponseadded inv0.114.0

type GetMultipleApplicationPlayerIdsResponse struct {// PlayerIds: Output only. The requested applications along with the scoped ids// for tha player, if that player has an id for the application. If not, the// application is not included in the response.PlayerIds []*ApplicationPlayerId `json:"playerIds,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "PlayerIds") 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. "PlayerIds") 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:"-"`}

GetMultipleApplicationPlayerIdsResponse: Response message forGetMultipleApplicationPlayerIds rpc.

func (GetMultipleApplicationPlayerIdsResponse)MarshalJSONadded inv0.114.0

typeImageAsset

type ImageAsset struct {// Height: The height of the asset.Heightint64 `json:"height,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#imageAsset`.Kindstring `json:"kind,omitempty"`// Name: The name of the asset.Namestring `json:"name,omitempty"`// Url: The URL of the asset.Urlstring `json:"url,omitempty"`// Width: The width of the asset.Widthint64 `json:"width,omitempty"`// ForceSendFields is a list of field names (e.g. "Height") 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. "Height") 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:"-"`}

ImageAsset: An image asset object.

func (ImageAsset)MarshalJSON

func (sImageAsset) MarshalJSON() ([]byte,error)

typeInstance

type Instance struct {// AcquisitionUri: URI which shows where a user can acquire this instance.AcquisitionUristring `json:"acquisitionUri,omitempty"`// AndroidInstance: Platform dependent details for Android.AndroidInstance *InstanceAndroidDetails `json:"androidInstance,omitempty"`// IosInstance: Platform dependent details for iOS.IosInstance *InstanceIosDetails `json:"iosInstance,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#instance`.Kindstring `json:"kind,omitempty"`// Name: Localized display name.Namestring `json:"name,omitempty"`// PlatformType: The platform type.//// Possible values://   "ANDROID" - Instance is for Android.//   "IOS" - Instance is for iOS.//   "WEB_APP" - Instance is for Web App.PlatformTypestring `json:"platformType,omitempty"`// RealtimePlay: Flag to show if this game instance supports realtime play.RealtimePlaybool `json:"realtimePlay,omitempty"`// TurnBasedPlay: Flag to show if this game instance supports turn based play.TurnBasedPlaybool `json:"turnBasedPlay,omitempty"`// WebInstance: Platform dependent details for Web.WebInstance *InstanceWebDetails `json:"webInstance,omitempty"`// ForceSendFields is a list of field names (e.g. "AcquisitionUri") 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. "AcquisitionUri") 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:"-"`}

Instance: The Instance resource.

func (Instance)MarshalJSON

func (sInstance) MarshalJSON() ([]byte,error)

typeInstanceAndroidDetails

type InstanceAndroidDetails struct {// EnablePiracyCheck: Flag indicating whether the anti-piracy check is enabled.EnablePiracyCheckbool `json:"enablePiracyCheck,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#instanceAndroidDetails`.Kindstring `json:"kind,omitempty"`// PackageName: Android package name which maps to Google Play URL.PackageNamestring `json:"packageName,omitempty"`// Preferred: Indicates that this instance is the default for new// installations.Preferredbool `json:"preferred,omitempty"`// ForceSendFields is a list of field names (e.g. "EnablePiracyCheck") 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. "EnablePiracyCheck") 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:"-"`}

InstanceAndroidDetails: The Android instance details resource.

func (InstanceAndroidDetails)MarshalJSON

func (sInstanceAndroidDetails) MarshalJSON() ([]byte,error)

typeInstanceIosDetails

type InstanceIosDetails struct {// BundleIdentifier: Bundle identifier.BundleIdentifierstring `json:"bundleIdentifier,omitempty"`// ItunesAppId: iTunes App ID.ItunesAppIdstring `json:"itunesAppId,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#instanceIosDetails`.Kindstring `json:"kind,omitempty"`// PreferredForIpad: Indicates that this instance is the default for new// installations on iPad devices.PreferredForIpadbool `json:"preferredForIpad,omitempty"`// PreferredForIphone: Indicates that this instance is the default for new// installations on iPhone devices.PreferredForIphonebool `json:"preferredForIphone,omitempty"`// SupportIpad: Flag to indicate if this instance supports iPad.SupportIpadbool `json:"supportIpad,omitempty"`// SupportIphone: Flag to indicate if this instance supports iPhone.SupportIphonebool `json:"supportIphone,omitempty"`// ForceSendFields is a list of field names (e.g. "BundleIdentifier") 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. "BundleIdentifier") 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:"-"`}

InstanceIosDetails: The iOS details resource.

func (InstanceIosDetails)MarshalJSON

func (sInstanceIosDetails) MarshalJSON() ([]byte,error)

typeInstanceWebDetails

type InstanceWebDetails struct {// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#instanceWebDetails`.Kindstring `json:"kind,omitempty"`// LaunchUrl: Launch URL for the game.LaunchUrlstring `json:"launchUrl,omitempty"`// Preferred: Indicates that this instance is the default for new// installations.Preferredbool `json:"preferred,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:"-"`}

InstanceWebDetails: The Web details resource.

func (InstanceWebDetails)MarshalJSON

func (sInstanceWebDetails) MarshalJSON() ([]byte,error)

typeLeaderboard

type Leaderboard struct {// IconUrl: The icon for the leaderboard.IconUrlstring `json:"iconUrl,omitempty"`// Id: The leaderboard ID.Idstring `json:"id,omitempty"`// IsIconUrlDefault: Indicates whether the icon image being returned is a// default image, or is game-provided.IsIconUrlDefaultbool `json:"isIconUrlDefault,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#leaderboard`.Kindstring `json:"kind,omitempty"`// Name: The name of the leaderboard.Namestring `json:"name,omitempty"`// Order: How scores are ordered.//// Possible values://   "LARGER_IS_BETTER" - Larger values are better; scores are sorted in// descending order//   "SMALLER_IS_BETTER" - Smaller values are better; scores are sorted in// ascending orderOrderstring `json:"order,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// 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:"-"`}

Leaderboard: The Leaderboard resource.

func (Leaderboard)MarshalJSON

func (sLeaderboard) MarshalJSON() ([]byte,error)

typeLeaderboardEntry

type LeaderboardEntry struct {// FormattedScore: The localized string for the numerical value of this score.FormattedScorestring `json:"formattedScore,omitempty"`// FormattedScoreRank: The localized string for the rank of this score for this// leaderboard.FormattedScoreRankstring `json:"formattedScoreRank,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#leaderboardEntry`.Kindstring `json:"kind,omitempty"`// Player: The player who holds this score.Player *Player `json:"player,omitempty"`// ScoreRank: The rank of this score for this leaderboard.ScoreRankint64 `json:"scoreRank,omitempty,string"`// ScoreTag: Additional information about the score. Values must contain no// more than 64 URI-safe characters as defined by section 2.3 ofRFC 3986.ScoreTagstring `json:"scoreTag,omitempty"`// ScoreValue: The numerical value of this score.ScoreValueint64 `json:"scoreValue,omitempty,string"`// TimeSpan: The time span of this high score.//// Possible values://   "ALL_TIME" - The score is an all-time score.//   "WEEKLY" - The score is a weekly score.//   "DAILY" - The score is a daily score.TimeSpanstring `json:"timeSpan,omitempty"`// WriteTimestampMillis: The timestamp at which this score was recorded, in// milliseconds since the epoch in UTC.WriteTimestampMillisint64 `json:"writeTimestampMillis,omitempty,string"`// ForceSendFields is a list of field names (e.g. "FormattedScore") 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. "FormattedScore") 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:"-"`}

LeaderboardEntry: The Leaderboard Entry resource.

func (LeaderboardEntry)MarshalJSON

func (sLeaderboardEntry) MarshalJSON() ([]byte,error)

typeLeaderboardListResponse

type LeaderboardListResponse struct {// Items: The leaderboards.Items []*Leaderboard `json:"items,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#leaderboardListResponse`.Kindstring `json:"kind,omitempty"`// NextPageToken: Token corresponding to the next page of results.NextPageTokenstring `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:"-"`}

LeaderboardListResponse: A list of leaderboard objects.

func (LeaderboardListResponse)MarshalJSON

func (sLeaderboardListResponse) MarshalJSON() ([]byte,error)

typeLeaderboardScoreRank

type LeaderboardScoreRank struct {// FormattedNumScores: The number of scores in the leaderboard as a string.FormattedNumScoresstring `json:"formattedNumScores,omitempty"`// FormattedRank: The rank in the leaderboard as a string.FormattedRankstring `json:"formattedRank,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#leaderboardScoreRank`.Kindstring `json:"kind,omitempty"`// NumScores: The number of scores in the leaderboard.NumScoresint64 `json:"numScores,omitempty,string"`// Rank: The rank in the leaderboard.Rankint64 `json:"rank,omitempty,string"`// ForceSendFields is a list of field names (e.g. "FormattedNumScores") 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. "FormattedNumScores") 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:"-"`}

LeaderboardScoreRank: A score rank in a leaderboard.

func (LeaderboardScoreRank)MarshalJSON

func (sLeaderboardScoreRank) MarshalJSON() ([]byte,error)

typeLeaderboardScores

type LeaderboardScores struct {// Items: The scores in the leaderboard.Items []*LeaderboardEntry `json:"items,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#leaderboardScores`.Kindstring `json:"kind,omitempty"`// NextPageToken: The pagination token for the next page of results.NextPageTokenstring `json:"nextPageToken,omitempty"`// NumScores: The total number of scores in the leaderboard.NumScoresint64 `json:"numScores,omitempty,string"`// PlayerScore: The score of the requesting player on the leaderboard. The// player's score may appear both here and in the list of scores above. If you// are viewing a public leaderboard and the player is not sharing their// gameplay information publicly, the `scoreRank`and `formattedScoreRank`// values will not be present.PlayerScore *LeaderboardEntry `json:"playerScore,omitempty"`// PrevPageToken: The pagination token for the previous page of results.PrevPageTokenstring `json:"prevPageToken,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:"-"`}

LeaderboardScores: A ListScores response.

func (LeaderboardScores)MarshalJSON

func (sLeaderboardScores) MarshalJSON() ([]byte,error)

typeLeaderboardsGetCall

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

func (*LeaderboardsGetCall)Context

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

func (*LeaderboardsGetCall)Do

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

func (*LeaderboardsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*LeaderboardsGetCall)Header

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

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

func (*LeaderboardsGetCall)IfNoneMatch

func (c *LeaderboardsGetCall) IfNoneMatch(entityTagstring) *LeaderboardsGetCall

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

func (*LeaderboardsGetCall)Language

func (c *LeaderboardsGetCall) Language(languagestring) *LeaderboardsGetCall

Language sets the optional parameter "language": The preferred language touse for strings returned by this method.

typeLeaderboardsListCall

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

func (*LeaderboardsListCall)Context

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

func (*LeaderboardsListCall)Do

Do executes the "games.leaderboards.list" call.Any non-2xx status code is an error. Response headers are in either*LeaderboardListResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*LeaderboardsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*LeaderboardsListCall)Header

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

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

func (*LeaderboardsListCall)IfNoneMatch

func (c *LeaderboardsListCall) IfNoneMatch(entityTagstring) *LeaderboardsListCall

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

func (*LeaderboardsListCall)Language

func (c *LeaderboardsListCall) Language(languagestring) *LeaderboardsListCall

Language sets the optional parameter "language": The preferred language touse for strings returned by this method.

func (*LeaderboardsListCall)MaxResults

func (c *LeaderboardsListCall) MaxResults(maxResultsint64) *LeaderboardsListCall

MaxResults sets the optional parameter "maxResults": The maximum number ofleaderboards to return in the response. For any response, the actual numberof leaderboards returned may be less than the specified `maxResults`.

func (*LeaderboardsListCall)PageToken

func (c *LeaderboardsListCall) PageToken(pageTokenstring) *LeaderboardsListCall

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

func (*LeaderboardsListCall)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.

typeLeaderboardsService

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

funcNewLeaderboardsService

func NewLeaderboardsService(s *Service) *LeaderboardsService

func (*LeaderboardsService)Get

func (r *LeaderboardsService) Get(leaderboardIdstring) *LeaderboardsGetCall

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

- leaderboardId: The ID of the leaderboard.

func (*LeaderboardsService)List

List: Lists all the leaderboard metadata for your application.

typeLinkPersonaRequestadded inv0.139.0

type LinkPersonaRequest struct {// CardinalityConstraint: Required. Cardinality constraint to observe when// linking a persona to a player in the scope of a game.//// Possible values://   "ONE_PERSONA_TO_ONE_PLAYER" - 1:1 cardinality between in-game personas and// Play Games Services players. By the end of the linking operation only one// entry for the player and the persona should remain in the scope of the// application. Whether a new link is created or not when this constraint is// specified is determined by the chosen `ConflictingLinksResolutionPolicy`: *// If `KEEP_EXISTING_LINKS` is specified and the provided persona is already// linked to a different player, or the player is already linked to a different// persona, no new link will be created and the already existing link(s) will// remain as is(are). * If `CREATE_NEW_LINK` is specified and the provided// persona is already linked to a different player, or the player is already// linked to another persona, the older link(s) will be removed in favour of// the new link being created.CardinalityConstraintstring `json:"cardinalityConstraint,omitempty"`// ConflictingLinksResolutionPolicy: Required. Resolution policy to apply when// the linking of a persona to a player would result in violating the specified// cardinality constraint.//// Possible values://   "KEEP_EXISTING_LINKS" - If link(s) between a player and persona already// exists which would result in violating the specified// `RecallTokensCardinalityConstraint` if the new link was created, keep the// already existing link(s). For example, if Persona1-Player1 is already linked// in the scope of application1 and a new link Persona1-Player2 is attempted to// be created in the scope of application1, then the old link will remain and// no new link will be added. Note that if the already existing links do// violate the specified policy (which could occur if not all `LinkPersona`// calls use the same `RecallTokensCardinalityConstraint`) this policy will// leave these violations unresolved; in order to resolve conflicts, the {@link// `CREATE_NEW_LINK` policy needs to be used to rewrite links resolving// conflicts.//   "CREATE_NEW_LINK" - If an existing link between a player and persona// already exists which would result in violating the specified// `RecallTokensCardinalityConstraint` if the new link was created, replace the// already existing link(s) with the new link. For example, if Persona1-Player1// is already linked in the scope of application1 and a new link// Persona1-Player2 is attempted to be created in the scope of application1,// then the old link will be removed and the new link will be added to replace// it.ConflictingLinksResolutionPolicystring `json:"conflictingLinksResolutionPolicy,omitempty"`// ExpireTime: Input only. Optional expiration time.ExpireTimestring `json:"expireTime,omitempty"`// Persona: Required. Stable identifier of the in-game account. Please refrain// from re-using the same persona for different games.Personastring `json:"persona,omitempty"`// SessionId: Required. Opaque server-generated string that encodes all the// necessary information to identify the PGS player / Google user and// application.SessionIdstring `json:"sessionId,omitempty"`// Token: Required. Value of the token to create. Opaque to Play Games and// assumed to be non-stable (encrypted with key rotation).Tokenstring `json:"token,omitempty"`// Ttl: Input only. Optional time-to-live.Ttlstring `json:"ttl,omitempty"`// ForceSendFields is a list of field names (e.g. "CardinalityConstraint") 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. "CardinalityConstraint") 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:"-"`}

LinkPersonaRequest: Request to link an in-game account with a PGS principal(encoded in the session id).

func (LinkPersonaRequest)MarshalJSONadded inv0.139.0

func (sLinkPersonaRequest) MarshalJSON() ([]byte,error)

typeLinkPersonaResponseadded inv0.139.0

type LinkPersonaResponse struct {// State: Output only. State of a persona linking attempt.//// Possible values://   "LINK_CREATED" - The link specified in the request was created.//   "PERSONA_OR_PLAYER_ALREADY_LINKED" - The link specified in the request was// not created because already existing links would result in the new link// violating the specified `RecallTokensCardinalityConstraint` if created.Statestring `json:"state,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "State") 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. "State") 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:"-"`}

LinkPersonaResponse: Outcome of a persona linking attempt.

func (LinkPersonaResponse)MarshalJSONadded inv0.139.0

func (sLinkPersonaResponse) MarshalJSON() ([]byte,error)

typeMetagameConfig

type MetagameConfig struct {// CurrentVersion: Current version of the metagame configuration data. When// this data is updated, the version number will be increased by one.CurrentVersionint64 `json:"currentVersion,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#metagameConfig`.Kindstring `json:"kind,omitempty"`// PlayerLevels: The list of player levels.PlayerLevels []*PlayerLevel `json:"playerLevels,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CurrentVersion") 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. "CurrentVersion") 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:"-"`}

MetagameConfig: The metagame config resource

func (MetagameConfig)MarshalJSON

func (sMetagameConfig) MarshalJSON() ([]byte,error)

typeMetagameGetMetagameConfigCall

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

func (*MetagameGetMetagameConfigCall)Context

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

func (*MetagameGetMetagameConfigCall)Do

Do executes the "games.metagame.getMetagameConfig" call.Any non-2xx status code is an error. Response headers are in either*MetagameConfig.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*MetagameGetMetagameConfigCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MetagameGetMetagameConfigCall)Header

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

func (*MetagameGetMetagameConfigCall)IfNoneMatch

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

typeMetagameListCategoriesByPlayerCall

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

func (*MetagameListCategoriesByPlayerCall)Context

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

func (*MetagameListCategoriesByPlayerCall)Do

Do executes the "games.metagame.listCategoriesByPlayer" call.Any non-2xx status code is an error. Response headers are in either*CategoryListResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*MetagameListCategoriesByPlayerCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*MetagameListCategoriesByPlayerCall)Header

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

func (*MetagameListCategoriesByPlayerCall)IfNoneMatch

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

func (*MetagameListCategoriesByPlayerCall)Language

Language sets the optional parameter "language": The preferred language touse for strings returned by this method.

func (*MetagameListCategoriesByPlayerCall)MaxResults

MaxResults sets the optional parameter "maxResults": The maximum number ofcategory resources to return in the response, used for paging. For anyresponse, the actual number of category resources returned may be less thanthe specified `maxResults`.

func (*MetagameListCategoriesByPlayerCall)PageToken

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

func (*MetagameListCategoriesByPlayerCall)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.

typeMetagameService

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

funcNewMetagameService

func NewMetagameService(s *Service) *MetagameService

func (*MetagameService)GetMetagameConfig

func (r *MetagameService) GetMetagameConfig() *MetagameGetMetagameConfigCall

GetMetagameConfig: Return the metagame configuration data for the callingapplication.

func (*MetagameService)ListCategoriesByPlayer

func (r *MetagameService) ListCategoriesByPlayer(playerIdstring, collectionstring) *MetagameListCategoriesByPlayerCall

ListCategoriesByPlayer: List play data aggregated per category for theplayer corresponding to `playerId`.

  • collection: The collection of categories for which data will be returned.
  • playerId: A player ID. A value of `me` may be used in place of theauthenticated player's ID.

typePlayGroupingApiTokenadded inv0.186.0

type PlayGroupingApiToken struct {// TokenValue: Value of the token.TokenValuestring `json:"tokenValue,omitempty"`// ForceSendFields is a list of field names (e.g. "TokenValue") 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. "TokenValue") 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:"-"`}

PlayGroupingApiToken: Token data returned from GeneratePlayGroupingApiTokenRPC.

func (PlayGroupingApiToken)MarshalJSONadded inv0.186.0

func (sPlayGroupingApiToken) MarshalJSON() ([]byte,error)

typePlayer

type Player struct {// AvatarImageUrl: The base URL for the image that represents the player.AvatarImageUrlstring `json:"avatarImageUrl,omitempty"`// BannerUrlLandscape: The url to the landscape mode player banner image.BannerUrlLandscapestring `json:"bannerUrlLandscape,omitempty"`// BannerUrlPortrait: The url to the portrait mode player banner image.BannerUrlPortraitstring `json:"bannerUrlPortrait,omitempty"`// DisplayName: The name to display for the player.DisplayNamestring `json:"displayName,omitempty"`// ExperienceInfo: An object to represent Play Game experience information for// the player.ExperienceInfo *PlayerExperienceInfo `json:"experienceInfo,omitempty"`// FriendStatus: The friend status of the given player, relative to the// requester. This is unset if the player is not sharing their friends list// with the game.//// Possible values://   "NO_RELATIONSHIP" - There is no relationship between the players.//   "FRIEND" - The player and requester are friends.FriendStatusstring `json:"friendStatus,omitempty"`// GamePlayerId: Per-application unique player identifier.GamePlayerIdstring `json:"gamePlayerId,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#player`Kindstring `json:"kind,omitempty"`// Name: A representation of the individual components of the name.Name *PlayerName `json:"name,omitempty"`// OriginalPlayerId: The player ID that was used for this player the first time// they signed into the game in question. This is only populated for calls to// player.get for the requesting player, only if the player ID has subsequently// changed, and only to clients that support remapping player IDs.OriginalPlayerIdstring `json:"originalPlayerId,omitempty"`// PlayerId: The ID of the player.PlayerIdstring `json:"playerId,omitempty"`// ProfileSettings: The player's profile settings. Controls whether or not the// player's profile is visible to other players.ProfileSettings *ProfileSettings `json:"profileSettings,omitempty"`// Title: The player's title rewarded for their game activities.Titlestring `json:"title,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AvatarImageUrl") 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. "AvatarImageUrl") 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:"-"`}

Player: A Player resource.

func (Player)MarshalJSON

func (sPlayer) MarshalJSON() ([]byte,error)

typePlayerAchievement

type PlayerAchievement struct {// AchievementState: The state of the achievement.//// Possible values://   "HIDDEN" - Achievement is hidden.//   "REVEALED" - Achievement is revealed.//   "UNLOCKED" - Achievement is unlocked.AchievementStatestring `json:"achievementState,omitempty"`// CurrentSteps: The current steps for an incremental achievement.CurrentStepsint64 `json:"currentSteps,omitempty"`// ExperiencePoints: Experience points earned for the achievement. This field// is absent for achievements that have not yet been unlocked and 0 for// achievements that have been unlocked by testers but that are unpublished.ExperiencePointsint64 `json:"experiencePoints,omitempty,string"`// FormattedCurrentStepsString: The current steps for an incremental// achievement as a string.FormattedCurrentStepsStringstring `json:"formattedCurrentStepsString,omitempty"`// Id: The ID of the achievement.Idstring `json:"id,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#playerAchievement`.Kindstring `json:"kind,omitempty"`// LastUpdatedTimestamp: The timestamp of the last modification to this// achievement's state.LastUpdatedTimestampint64 `json:"lastUpdatedTimestamp,omitempty,string"`// ForceSendFields is a list of field names (e.g. "AchievementState") 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. "AchievementState") 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:"-"`}

PlayerAchievement: An achievement object.

func (PlayerAchievement)MarshalJSON

func (sPlayerAchievement) MarshalJSON() ([]byte,error)

typePlayerAchievementListResponse

type PlayerAchievementListResponse struct {// Items: The achievements.Items []*PlayerAchievement `json:"items,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#playerAchievementListResponse`.Kindstring `json:"kind,omitempty"`// NextPageToken: Token corresponding to the next page of results.NextPageTokenstring `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:"-"`}

PlayerAchievementListResponse: A list of achievement objects.

func (PlayerAchievementListResponse)MarshalJSON

func (sPlayerAchievementListResponse) MarshalJSON() ([]byte,error)

typePlayerEvent

type PlayerEvent struct {// DefinitionId: The ID of the event definition.DefinitionIdstring `json:"definitionId,omitempty"`// FormattedNumEvents: The current number of times this event has occurred, as// a string. The formatting of this string depends on the configuration of your// event in the Play Games Developer Console.FormattedNumEventsstring `json:"formattedNumEvents,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#playerEvent`.Kindstring `json:"kind,omitempty"`// NumEvents: The current number of times this event has occurred.NumEventsint64 `json:"numEvents,omitempty,string"`// PlayerId: The ID of the player.PlayerIdstring `json:"playerId,omitempty"`// ForceSendFields is a list of field names (e.g. "DefinitionId") 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. "DefinitionId") 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:"-"`}

PlayerEvent: An event status resource.

func (PlayerEvent)MarshalJSON

func (sPlayerEvent) MarshalJSON() ([]byte,error)

typePlayerEventListResponse

type PlayerEventListResponse struct {// Items: The player events.Items []*PlayerEvent `json:"items,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#playerEventListResponse`.Kindstring `json:"kind,omitempty"`// NextPageToken: The pagination token for the next page of results.NextPageTokenstring `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:"-"`}

PlayerEventListResponse: A ListByPlayer response.

func (PlayerEventListResponse)MarshalJSON

func (sPlayerEventListResponse) MarshalJSON() ([]byte,error)

typePlayerExperienceInfo

type PlayerExperienceInfo struct {// CurrentExperiencePoints: The current number of experience points for the// player.CurrentExperiencePointsint64 `json:"currentExperiencePoints,omitempty,string"`// CurrentLevel: The current level of the player.CurrentLevel *PlayerLevel `json:"currentLevel,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#playerExperienceInfo`.Kindstring `json:"kind,omitempty"`// LastLevelUpTimestampMillis: The timestamp when the player was leveled up, in// millis since Unix epoch UTC.LastLevelUpTimestampMillisint64 `json:"lastLevelUpTimestampMillis,omitempty,string"`// NextLevel: The next level of the player. If the current level is the maximum// level, this should be same as the current level.NextLevel *PlayerLevel `json:"nextLevel,omitempty"`// ForceSendFields is a list of field names (e.g. "CurrentExperiencePoints") 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. "CurrentExperiencePoints") 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:"-"`}

PlayerExperienceInfo: 1P/3P metadata about the player's experience.

func (PlayerExperienceInfo)MarshalJSON

func (sPlayerExperienceInfo) MarshalJSON() ([]byte,error)

typePlayerLeaderboardScore

type PlayerLeaderboardScore struct {// FriendsRank: The rank of the score in the friends collection for this// leaderboard.FriendsRank *LeaderboardScoreRank `json:"friendsRank,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#playerLeaderboardScore`.Kindstring `json:"kind,omitempty"`// LeaderboardId: The ID of the leaderboard this score is in.LeaderboardIdstring `json:"leaderboard_id,omitempty"`// PublicRank: The public rank of the score in this leaderboard. This object// will not be present if the user is not sharing their scores publicly.PublicRank *LeaderboardScoreRank `json:"publicRank,omitempty"`// ScoreString: The formatted value of this score.ScoreStringstring `json:"scoreString,omitempty"`// ScoreTag: Additional information about the score. Values must contain no// more than 64 URI-safe characters as defined by section 2.3 ofRFC 3986.ScoreTagstring `json:"scoreTag,omitempty"`// ScoreValue: The numerical value of this score.ScoreValueint64 `json:"scoreValue,omitempty,string"`// SocialRank: The social rank of the score in this leaderboard.SocialRank *LeaderboardScoreRank `json:"socialRank,omitempty"`// TimeSpan: The time span of this score.//// Possible values://   "ALL_TIME" - The score is an all-time score.//   "WEEKLY" - The score is a weekly score.//   "DAILY" - The score is a daily score.TimeSpanstring `json:"timeSpan,omitempty"`// WriteTimestamp: The timestamp at which this score was recorded, in// milliseconds since the epoch in UTC.WriteTimestampint64 `json:"writeTimestamp,omitempty,string"`// ForceSendFields is a list of field names (e.g. "FriendsRank") 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. "FriendsRank") 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:"-"`}

PlayerLeaderboardScore: A player leaderboard score object.

func (PlayerLeaderboardScore)MarshalJSON

func (sPlayerLeaderboardScore) MarshalJSON() ([]byte,error)

typePlayerLeaderboardScoreListResponse

type PlayerLeaderboardScoreListResponse struct {// Items: The leaderboard scores.Items []*PlayerLeaderboardScore `json:"items,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#playerLeaderboardScoreListResponse`.Kindstring `json:"kind,omitempty"`// NextPageToken: The pagination token for the next page of results.NextPageTokenstring `json:"nextPageToken,omitempty"`// Player: The Player resources for the owner of this score.Player *Player `json:"player,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:"-"`}

PlayerLeaderboardScoreListResponse: A list of player leaderboard scores.

func (PlayerLeaderboardScoreListResponse)MarshalJSON

typePlayerLevel

type PlayerLevel struct {// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#playerLevel`.Kindstring `json:"kind,omitempty"`// Level: The level for the user.Levelint64 `json:"level,omitempty"`// MaxExperiencePoints: The maximum experience points for this level.MaxExperiencePointsint64 `json:"maxExperiencePoints,omitempty,string"`// MinExperiencePoints: The minimum experience points for this level.MinExperiencePointsint64 `json:"minExperiencePoints,omitempty,string"`// 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:"-"`}

PlayerLevel: 1P/3P metadata about a user's level.

func (PlayerLevel)MarshalJSON

func (sPlayerLevel) MarshalJSON() ([]byte,error)

typePlayerListResponse

type PlayerListResponse struct {// Items: The players.Items []*Player `json:"items,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#playerListResponse`.Kindstring `json:"kind,omitempty"`// NextPageToken: Token corresponding to the next page of results.NextPageTokenstring `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:"-"`}

PlayerListResponse: A third party player list response.

func (PlayerListResponse)MarshalJSON

func (sPlayerListResponse) MarshalJSON() ([]byte,error)

typePlayerName

type PlayerName struct {// FamilyName: The family name of this player. In some places, this is known as// the last name.FamilyNamestring `json:"familyName,omitempty"`// GivenName: The given name of this player. In some places, this is known as// the first name.GivenNamestring `json:"givenName,omitempty"`// ForceSendFields is a list of field names (e.g. "FamilyName") 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. "FamilyName") 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:"-"`}

PlayerName: A representation of the individual components of the name.

func (PlayerName)MarshalJSON

func (sPlayerName) MarshalJSON() ([]byte,error)

typePlayerScore

type PlayerScore struct {// FormattedScore: The formatted score for this player score.FormattedScorestring `json:"formattedScore,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#playerScore`.Kindstring `json:"kind,omitempty"`// Score: The numerical value for this player score.Scoreint64 `json:"score,omitempty,string"`// ScoreTag: Additional information about this score. Values will contain no// more than 64 URI-safe characters as defined by section 2.3 ofRFC 3986.ScoreTagstring `json:"scoreTag,omitempty"`// TimeSpan: The time span for this player score.//// Possible values://   "ALL_TIME" - The score is an all-time score.//   "WEEKLY" - The score is a weekly score.//   "DAILY" - The score is a daily score.TimeSpanstring `json:"timeSpan,omitempty"`// ForceSendFields is a list of field names (e.g. "FormattedScore") 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. "FormattedScore") 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:"-"`}

PlayerScore: A player score.

func (PlayerScore)MarshalJSON

func (sPlayerScore) MarshalJSON() ([]byte,error)

typePlayerScoreListResponse

type PlayerScoreListResponse struct {// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#playerScoreListResponse`.Kindstring `json:"kind,omitempty"`// SubmittedScores: The score submissions statuses.SubmittedScores []*PlayerScoreResponse `json:"submittedScores,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// 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:"-"`}

PlayerScoreListResponse: A list of score submission statuses.

func (PlayerScoreListResponse)MarshalJSON

func (sPlayerScoreListResponse) MarshalJSON() ([]byte,error)

typePlayerScoreResponse

type PlayerScoreResponse struct {// BeatenScoreTimeSpans: The time spans where the submitted score is better// than the existing score for that time span.//// Possible values://   "ALL_TIME" - The score is an all-time score.//   "WEEKLY" - The score is a weekly score.//   "DAILY" - The score is a daily score.BeatenScoreTimeSpans []string `json:"beatenScoreTimeSpans,omitempty"`// FormattedScore: The formatted value of the submitted score.FormattedScorestring `json:"formattedScore,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#playerScoreResponse`.Kindstring `json:"kind,omitempty"`// LeaderboardId: The leaderboard ID that this score was submitted to.LeaderboardIdstring `json:"leaderboardId,omitempty"`// ScoreTag: Additional information about this score. Values will contain no// more than 64 URI-safe characters as defined by section 2.3 ofRFC 3986.ScoreTagstring `json:"scoreTag,omitempty"`// UnbeatenScores: The scores in time spans that have not been beaten. As an// example, the submitted score may be better than the player's `DAILY` score,// but not better than the player's scores for the `WEEKLY` or `ALL_TIME` time// spans.UnbeatenScores []*PlayerScore `json:"unbeatenScores,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "BeatenScoreTimeSpans") 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. "BeatenScoreTimeSpans") 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:"-"`}

PlayerScoreResponse: A list of leaderboard entry resources.

func (PlayerScoreResponse)MarshalJSON

func (sPlayerScoreResponse) MarshalJSON() ([]byte,error)

typePlayerScoreSubmissionList

type PlayerScoreSubmissionList struct {// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#playerScoreSubmissionList`.Kindstring `json:"kind,omitempty"`// Scores: The score submissions.Scores []*ScoreSubmission `json:"scores,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:"-"`}

PlayerScoreSubmissionList: A list of score submission requests.

func (PlayerScoreSubmissionList)MarshalJSON

func (sPlayerScoreSubmissionList) MarshalJSON() ([]byte,error)

typePlayersGetCall

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

func (*PlayersGetCall)Context

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

func (*PlayersGetCall)Do

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

func (*PlayersGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*PlayersGetCall)Header

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

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

func (*PlayersGetCall)IfNoneMatch

func (c *PlayersGetCall) IfNoneMatch(entityTagstring) *PlayersGetCall

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

func (*PlayersGetCall)Language

func (c *PlayersGetCall) Language(languagestring) *PlayersGetCall

Language sets the optional parameter "language": The preferred language touse for strings returned by this method.

func (*PlayersGetCall)PlayerIdConsistencyTokenadded inv0.74.0

func (c *PlayersGetCall) PlayerIdConsistencyToken(playerIdConsistencyTokenstring) *PlayersGetCall

PlayerIdConsistencyToken sets the optional parameter"playerIdConsistencyToken": Consistency token of the player id. The callreturns a 'not found' result when the token is present and invalid. Emptyvalue is ignored. See also GlobalPlayerIdConsistencyTokenProto

typePlayersGetMultipleApplicationPlayerIdsCalladded inv0.114.0

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

func (*PlayersGetMultipleApplicationPlayerIdsCall)ApplicationIdsadded inv0.114.0

ApplicationIds sets the optional parameter "applicationIds": Required. Theapplication IDs from the Google Play developer console for the games toreturn scoped ids for.

func (*PlayersGetMultipleApplicationPlayerIdsCall)Contextadded inv0.114.0

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

func (*PlayersGetMultipleApplicationPlayerIdsCall)Doadded inv0.114.0

Do executes the "games.players.getMultipleApplicationPlayerIds" call.Any non-2xx status code is an error. Response headers are in either*GetMultipleApplicationPlayerIdsResponse.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*PlayersGetMultipleApplicationPlayerIdsCall)Fieldsadded inv0.114.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*PlayersGetMultipleApplicationPlayerIdsCall)Headeradded inv0.114.0

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

func (*PlayersGetMultipleApplicationPlayerIdsCall)IfNoneMatchadded inv0.114.0

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

typePlayersGetScopedPlayerIdsCalladded inv0.83.0

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

func (*PlayersGetScopedPlayerIdsCall)Contextadded inv0.83.0

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

func (*PlayersGetScopedPlayerIdsCall)Doadded inv0.83.0

Do executes the "games.players.getScopedPlayerIds" call.Any non-2xx status code is an error. Response headers are in either*ScopedPlayerIds.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*PlayersGetScopedPlayerIdsCall)Fieldsadded inv0.83.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*PlayersGetScopedPlayerIdsCall)Headeradded inv0.83.0

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

func (*PlayersGetScopedPlayerIdsCall)IfNoneMatchadded inv0.83.0

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

typePlayersListCall

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

func (*PlayersListCall)Context

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

func (*PlayersListCall)Do

Do executes the "games.players.list" call.Any non-2xx status code is an error. Response headers are in either*PlayerListResponse.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*PlayersListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*PlayersListCall)Header

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

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

func (*PlayersListCall)IfNoneMatch

func (c *PlayersListCall) IfNoneMatch(entityTagstring) *PlayersListCall

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

func (*PlayersListCall)Language

func (c *PlayersListCall) Language(languagestring) *PlayersListCall

Language sets the optional parameter "language": The preferred language touse for strings returned by this method.

func (*PlayersListCall)MaxResults

func (c *PlayersListCall) MaxResults(maxResultsint64) *PlayersListCall

MaxResults sets the optional parameter "maxResults": The maximum number ofplayer resources to return in the response, used for paging. For anyresponse, the actual number of player resources returned may be less thanthe specified `maxResults`.

func (*PlayersListCall)PageToken

func (c *PlayersListCall) PageToken(pageTokenstring) *PlayersListCall

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

func (*PlayersListCall)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.

typePlayersService

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

funcNewPlayersService

func NewPlayersService(s *Service) *PlayersService

func (*PlayersService)Get

func (r *PlayersService) Get(playerIdstring) *PlayersGetCall

Get: Retrieves the Player resource with the given ID. To retrieve the playerfor the currently authenticated user, set `playerId` to `me`.

  • playerId: A player ID. A value of `me` may be used in place of theauthenticated player's ID.

func (*PlayersService)GetMultipleApplicationPlayerIdsadded inv0.114.0

func (r *PlayersService) GetMultipleApplicationPlayerIds() *PlayersGetMultipleApplicationPlayerIdsCall

GetMultipleApplicationPlayerIds: Get the application player ids for thecurrently authenticated player across all requested games by the samedeveloper as the calling application. This will only return ids for playersthat actually have an id (scoped or otherwise) with that game.

func (*PlayersService)GetScopedPlayerIdsadded inv0.83.0

func (r *PlayersService) GetScopedPlayerIds() *PlayersGetScopedPlayerIdsCall

GetScopedPlayerIds: Retrieves scoped player identifiers for currentlyauthenticated user.

func (*PlayersService)List

func (r *PlayersService) List(collectionstring) *PlayersListCall

List: Get the collection of players for the currently authenticated user.

- collection: Collection of players being retrieved.

typeProfileSettings

type ProfileSettings struct {// Possible values://   "VISIBLE" - The friends list is currently visible to the game.//   "REQUEST_REQUIRED" - The developer does not have access to the friends// list, but can call the Android API to show a consent dialog.//   "UNAVAILABLE" - The friends list is currently unavailable for this user,// and it is not possible to request access at this time, either because the// user has permanently declined or the friends feature is not available to// them. In this state, any attempts to request access to the friends list will// be unsuccessful.FriendsListVisibilitystring `json:"friendsListVisibility,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#profileSettings`.Kindstring `json:"kind,omitempty"`// ProfileVisible: Whether the player's profile is visible to the currently// signed in player.ProfileVisiblebool `json:"profileVisible,omitempty"`// ForceSendFields is a list of field names (e.g. "FriendsListVisibility") 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. "FriendsListVisibility") 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:"-"`}

ProfileSettings: Profile settings

func (ProfileSettings)MarshalJSON

func (sProfileSettings) MarshalJSON() ([]byte,error)

typeRecallGamesPlayerTokensCalladded inv0.184.0

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

func (*RecallGamesPlayerTokensCall)ApplicationIdsadded inv0.184.0

func (c *RecallGamesPlayerTokensCall) ApplicationIds(applicationIds ...string) *RecallGamesPlayerTokensCall

ApplicationIds sets the optional parameter "applicationIds": Required. Theapplication IDs from the Google Play developer console for the games toreturn scoped ids for.

func (*RecallGamesPlayerTokensCall)Contextadded inv0.184.0

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

func (*RecallGamesPlayerTokensCall)Doadded inv0.184.0

Do executes the "games.recall.gamesPlayerTokens" call.Any non-2xx status code is an error. Response headers are in either*RetrieveGamesPlayerTokensResponse.ServerResponse.Header or (if a responsewas returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*RecallGamesPlayerTokensCall)Fieldsadded inv0.184.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*RecallGamesPlayerTokensCall)Headeradded inv0.184.0

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

func (*RecallGamesPlayerTokensCall)IfNoneMatchadded inv0.184.0

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

typeRecallLastTokenFromAllDeveloperGamesCalladded inv0.177.0

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

func (*RecallLastTokenFromAllDeveloperGamesCall)Contextadded inv0.177.0

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

func (*RecallLastTokenFromAllDeveloperGamesCall)Doadded inv0.177.0

Do executes the "games.recall.lastTokenFromAllDeveloperGames" call.Any non-2xx status code is an error. Response headers are in either*RetrieveDeveloperGamesLastPlayerTokenResponse.ServerResponse.Header or (ifa response was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*RecallLastTokenFromAllDeveloperGamesCall)Fieldsadded inv0.177.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*RecallLastTokenFromAllDeveloperGamesCall)Headeradded inv0.177.0

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

func (*RecallLastTokenFromAllDeveloperGamesCall)IfNoneMatchadded inv0.177.0

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

typeRecallLinkPersonaCalladded inv0.139.0

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

func (*RecallLinkPersonaCall)Contextadded inv0.139.0

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

func (*RecallLinkPersonaCall)Doadded inv0.139.0

Do executes the "games.recall.linkPersona" call.Any non-2xx status code is an error. Response headers are in either*LinkPersonaResponse.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*RecallLinkPersonaCall)Fieldsadded inv0.139.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*RecallLinkPersonaCall)Headeradded inv0.139.0

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

typeRecallResetPersonaCalladded inv0.139.0

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

func (*RecallResetPersonaCall)Contextadded inv0.139.0

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

func (*RecallResetPersonaCall)Doadded inv0.139.0

Do executes the "games.recall.resetPersona" call.Any non-2xx status code is an error. Response headers are in either*ResetPersonaResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*RecallResetPersonaCall)Fieldsadded inv0.139.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*RecallResetPersonaCall)Headeradded inv0.139.0

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

typeRecallRetrieveTokensCalladded inv0.139.0

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

func (*RecallRetrieveTokensCall)Contextadded inv0.139.0

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

func (*RecallRetrieveTokensCall)Doadded inv0.139.0

Do executes the "games.recall.retrieveTokens" call.Any non-2xx status code is an error. Response headers are in either*RetrievePlayerTokensResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*RecallRetrieveTokensCall)Fieldsadded inv0.139.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*RecallRetrieveTokensCall)Headeradded inv0.139.0

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

func (*RecallRetrieveTokensCall)IfNoneMatchadded inv0.139.0

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

typeRecallServiceadded inv0.139.0

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

funcNewRecallServiceadded inv0.139.0

func NewRecallService(s *Service) *RecallService

func (*RecallService)GamesPlayerTokensadded inv0.184.0

func (r *RecallService) GamesPlayerTokens(sessionIdstring) *RecallGamesPlayerTokensCall

GamesPlayerTokens: Retrieve the Recall tokens from all requested games thatis associated with the PGS Player encoded in the provided recall session id.The API is only available for users that have an active PGS Player profile.

  • sessionId: Opaque server-generated string that encodes all the necessaryinformation to identify the PGS player / Google user and application.

func (*RecallService)LastTokenFromAllDeveloperGamesadded inv0.177.0

func (r *RecallService) LastTokenFromAllDeveloperGames(sessionIdstring) *RecallLastTokenFromAllDeveloperGamesCall

LastTokenFromAllDeveloperGames: Retrieve the last Recall token from alldeveloper games that is associated with the PGS Player encoded in theprovided recall session id. The API is only available for users that haveactive PGS Player profile.

  • sessionId: Opaque server-generated string that encodes all the necessaryinformation to identify the PGS player / Google user and application.

func (*RecallService)LinkPersonaadded inv0.139.0

func (r *RecallService) LinkPersona(linkpersonarequest *LinkPersonaRequest) *RecallLinkPersonaCall

LinkPersona: Associate the PGS Player principal encoded in the providedrecall session id with an in-game account

func (*RecallService)ResetPersonaadded inv0.139.0

func (r *RecallService) ResetPersona(resetpersonarequest *ResetPersonaRequest) *RecallResetPersonaCall

ResetPersona: Delete all Recall tokens linking the given persona to anyplayer (with or without a profile).

func (*RecallService)RetrieveTokensadded inv0.139.0

func (r *RecallService) RetrieveTokens(sessionIdstring) *RecallRetrieveTokensCall

RetrieveTokens: Retrieve all Recall tokens associated with the PGS Playerencoded in the provided recall session id. The API is only available forusers that have active PGS Player profile.

  • sessionId: Opaque server-generated string that encodes all the necessaryinformation to identify the PGS player / Google user and application.

func (*RecallService)UnlinkPersonaadded inv0.139.0

func (r *RecallService) UnlinkPersona(unlinkpersonarequest *UnlinkPersonaRequest) *RecallUnlinkPersonaCall

UnlinkPersona: Delete a Recall token linking the PGS Player principalidentified by the Recall session and an in-game account identified either bythe 'persona' or by the token value.

typeRecallTokenadded inv0.139.0

type RecallToken struct {// ExpireTime: Optional. Optional expiration time of the tokenExpireTimestring `json:"expireTime,omitempty"`// MultiPlayerPersona: Required. Whether the persona identified by the token is// linked to multiple PGS PlayersMultiPlayerPersonabool `json:"multiPlayerPersona,omitempty"`// Token: Required. Value of the Recall token as it is provided by the client// via LinkPersona RPCTokenstring `json:"token,omitempty"`// ForceSendFields is a list of field names (e.g. "ExpireTime") 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. "ExpireTime") 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:"-"`}

RecallToken: Recall token data returned from RetrievePlayerTokens RPC

func (RecallToken)MarshalJSONadded inv0.139.0

func (sRecallToken) MarshalJSON() ([]byte,error)

typeRecallUnlinkPersonaCalladded inv0.139.0

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

func (*RecallUnlinkPersonaCall)Contextadded inv0.139.0

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

func (*RecallUnlinkPersonaCall)Doadded inv0.139.0

Do executes the "games.recall.unlinkPersona" call.Any non-2xx status code is an error. Response headers are in either*UnlinkPersonaResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*RecallUnlinkPersonaCall)Fieldsadded inv0.139.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*RecallUnlinkPersonaCall)Headeradded inv0.139.0

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

typeResetPersonaRequestadded inv0.139.0

type ResetPersonaRequest struct {// Persona: Value of the 'persona' field as it was provided by the client in// LinkPersona RPCPersonastring `json:"persona,omitempty"`// ForceSendFields is a list of field names (e.g. "Persona") 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. "Persona") 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:"-"`}

ResetPersonaRequest: Request to remove all Recall tokens associated with apersona for an app.

func (ResetPersonaRequest)MarshalJSONadded inv0.139.0

func (sResetPersonaRequest) MarshalJSON() ([]byte,error)

typeResetPersonaResponseadded inv0.139.0

type ResetPersonaResponse struct {// Unlinked: Required. Whether any tokens were unlinked as a result of this// request.Unlinkedbool `json:"unlinked,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Unlinked") 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. "Unlinked") 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:"-"`}

ResetPersonaResponse: Response for the ResetPersona RPC

func (ResetPersonaResponse)MarshalJSONadded inv0.139.0

func (sResetPersonaResponse) MarshalJSON() ([]byte,error)

typeRetrieveDeveloperGamesLastPlayerTokenResponseadded inv0.177.0

type RetrieveDeveloperGamesLastPlayerTokenResponse struct {// GamePlayerToken: The recall token associated with the requested PGS Player// principal. It can be unset if there is no recall token associated with the// requested principal.GamePlayerToken *GamePlayerToken `json:"gamePlayerToken,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "GamePlayerToken") 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. "GamePlayerToken") 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:"-"`}

RetrieveDeveloperGamesLastPlayerTokenResponse: Recall token data returnedfrom for the RetrieveDeveloperGamesLastPlayerToken RPC

func (RetrieveDeveloperGamesLastPlayerTokenResponse)MarshalJSONadded inv0.177.0

typeRetrieveGamesPlayerTokensResponseadded inv0.184.0

type RetrieveGamesPlayerTokensResponse struct {// GamePlayerTokens: The requested applications along with the recall tokens// for the player. If the player does not have recall tokens for an// application, that application is not included in the response.GamePlayerTokens []*GamePlayerToken `json:"gamePlayerTokens,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "GamePlayerTokens") 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. "GamePlayerTokens") 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:"-"`}

RetrieveGamesPlayerTokensResponse: A list of recall token data returned fromthe RetrieveGamesPlayerTokens RPC

func (RetrieveGamesPlayerTokensResponse)MarshalJSONadded inv0.184.0

func (sRetrieveGamesPlayerTokensResponse) MarshalJSON() ([]byte,error)

typeRetrievePlayerTokensResponseadded inv0.139.0

type RetrievePlayerTokensResponse struct {// Tokens: Required. Recall tokens associated with the requested PGS Player// principalTokens []*RecallToken `json:"tokens,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Tokens") 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. "Tokens") 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:"-"`}

RetrievePlayerTokensResponse: Response for the RetrievePlayerTokens RPC

func (RetrievePlayerTokensResponse)MarshalJSONadded inv0.139.0

func (sRetrievePlayerTokensResponse) MarshalJSON() ([]byte,error)

typeRevisionCheckResponse

type RevisionCheckResponse struct {// ApiVersion: The version of the API this client revision should use when// calling API methods.ApiVersionstring `json:"apiVersion,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#revisionCheckResponse`.Kindstring `json:"kind,omitempty"`// RevisionStatus: The result of the revision check.//// Possible values://   "OK" - The revision being used is current.//   "DEPRECATED" - There is currently a newer version available, but the// revision being used still works.//   "INVALID" - The revision being used is not supported in any released// version.RevisionStatusstring `json:"revisionStatus,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "ApiVersion") 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. "ApiVersion") 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:"-"`}

RevisionCheckResponse: A third party checking a revision response.

func (RevisionCheckResponse)MarshalJSON

func (sRevisionCheckResponse) MarshalJSON() ([]byte,error)

typeRevisionsCheckCall

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

func (*RevisionsCheckCall)Context

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

func (*RevisionsCheckCall)Do

Do executes the "games.revisions.check" call.Any non-2xx status code is an error. Response headers are in either*RevisionCheckResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*RevisionsCheckCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*RevisionsCheckCall)Header

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

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

func (*RevisionsCheckCall)IfNoneMatch

func (c *RevisionsCheckCall) IfNoneMatch(entityTagstring) *RevisionsCheckCall

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

typeRevisionsService

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

funcNewRevisionsService

func NewRevisionsService(s *Service) *RevisionsService

func (*RevisionsService)Check

func (r *RevisionsService) Check(clientRevisionstring) *RevisionsCheckCall

Check: Checks whether the games client is out of date.

  • clientRevision: The revision of the client SDK used by your application.Format: `[PLATFORM_TYPE]:[VERSION_NUMBER]`. Possible values of`PLATFORM_TYPE` are: * `ANDROID` - Client is running the Android SDK. *`IOS` - Client is running the iOS SDK. * `WEB_APP` - Client is running asa Web App.

typeScopedPlayerIdsadded inv0.83.0

type ScopedPlayerIds struct {// DeveloperPlayerKey: Identifier of the player across all games of the given// developer. Every player has the same developer_player_key in all games of// one developer. Developer player key changes for the game if the game is// transferred to another developer. Note that game_player_id will stay// unchanged.DeveloperPlayerKeystring `json:"developerPlayerKey,omitempty"`// GamePlayerId: Game-scoped player identifier. This is the same id that is// returned in GetPlayer game_player_id field.GamePlayerIdstring `json:"gamePlayerId,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "DeveloperPlayerKey") 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. "DeveloperPlayerKey") 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:"-"`}

ScopedPlayerIds: Scoped player identifiers.

func (ScopedPlayerIds)MarshalJSONadded inv0.83.0

func (sScopedPlayerIds) MarshalJSON() ([]byte,error)

typeScoreSubmission

type ScoreSubmission struct {// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#scoreSubmission`.Kindstring `json:"kind,omitempty"`// LeaderboardId: The leaderboard this score is being submitted to.LeaderboardIdstring `json:"leaderboardId,omitempty"`// Score: The new score being submitted.Scoreint64 `json:"score,omitempty,string"`// ScoreTag: Additional information about this score. Values will contain no// more than 64 URI-safe characters as defined by section 2.3 ofRFC 3986.ScoreTagstring `json:"scoreTag,omitempty"`// Signature: Signature Values will contain URI-safe characters as defined by// section 2.3 ofRFC 3986.Signaturestring `json:"signature,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:"-"`}

ScoreSubmission: A request to submit a score to leaderboards.

func (ScoreSubmission)MarshalJSON

func (sScoreSubmission) MarshalJSON() ([]byte,error)

typeScoresGetCall

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

func (*ScoresGetCall)Context

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

func (*ScoresGetCall)Do

Do executes the "games.scores.get" call.Any non-2xx status code is an error. Response headers are in either*PlayerLeaderboardScoreListResponse.ServerResponse.Header or (if a responsewas returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ScoresGetCall)Fields

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ScoresGetCall)Header

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

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

func (*ScoresGetCall)IfNoneMatch

func (c *ScoresGetCall) IfNoneMatch(entityTagstring) *ScoresGetCall

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

func (*ScoresGetCall)IncludeRankType

func (c *ScoresGetCall) IncludeRankType(includeRankTypestring) *ScoresGetCall

IncludeRankType sets the optional parameter "includeRankType": The types ofranks to return. If the parameter is omitted, no ranks will be returned.

Possible values:

"ALL" - Retrieve all supported ranks. In HTTP, this parameter value can

also be specified as `ALL`.

"PUBLIC" - Retrieve public ranks, if the player is sharing their gameplay

activity publicly.

"SOCIAL" - (Obsolete) Retrieve the social rank."FRIENDS" - Retrieve the rank on the friends collection.

func (*ScoresGetCall)Language

func (c *ScoresGetCall) Language(languagestring) *ScoresGetCall

Language sets the optional parameter "language": The preferred language touse for strings returned by this method.

func (*ScoresGetCall)MaxResults

func (c *ScoresGetCall) MaxResults(maxResultsint64) *ScoresGetCall

MaxResults sets the optional parameter "maxResults": The maximum number ofleaderboard scores to return in the response. For any response, the actualnumber of leaderboard scores returned may be less than the specified`maxResults`.

func (*ScoresGetCall)PageToken

func (c *ScoresGetCall) PageToken(pageTokenstring) *ScoresGetCall

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

func (*ScoresGetCall)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.

typeScoresListCall

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

func (*ScoresListCall)Context

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

func (*ScoresListCall)Do

Do executes the "games.scores.list" call.Any non-2xx status code is an error. Response headers are in either*LeaderboardScores.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ScoresListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ScoresListCall)Header

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

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

func (*ScoresListCall)IfNoneMatch

func (c *ScoresListCall) IfNoneMatch(entityTagstring) *ScoresListCall

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

func (*ScoresListCall)Language

func (c *ScoresListCall) Language(languagestring) *ScoresListCall

Language sets the optional parameter "language": The preferred language touse for strings returned by this method.

func (*ScoresListCall)MaxResults

func (c *ScoresListCall) MaxResults(maxResultsint64) *ScoresListCall

MaxResults sets the optional parameter "maxResults": The maximum number ofleaderboard scores to return in the response. For any response, the actualnumber of leaderboard scores returned may be less than the specified`maxResults`.

func (*ScoresListCall)PageToken

func (c *ScoresListCall) PageToken(pageTokenstring) *ScoresListCall

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

func (*ScoresListCall)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.

typeScoresListWindowCall

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

func (*ScoresListWindowCall)Context

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

func (*ScoresListWindowCall)Do

Do executes the "games.scores.listWindow" call.Any non-2xx status code is an error. Response headers are in either*LeaderboardScores.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ScoresListWindowCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ScoresListWindowCall)Header

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

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

func (*ScoresListWindowCall)IfNoneMatch

func (c *ScoresListWindowCall) IfNoneMatch(entityTagstring) *ScoresListWindowCall

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

func (*ScoresListWindowCall)Language

func (c *ScoresListWindowCall) Language(languagestring) *ScoresListWindowCall

Language sets the optional parameter "language": The preferred language touse for strings returned by this method.

func (*ScoresListWindowCall)MaxResults

func (c *ScoresListWindowCall) MaxResults(maxResultsint64) *ScoresListWindowCall

MaxResults sets the optional parameter "maxResults": The maximum number ofleaderboard scores to return in the response. For any response, the actualnumber of leaderboard scores returned may be less than the specified`maxResults`.

func (*ScoresListWindowCall)PageToken

func (c *ScoresListWindowCall) PageToken(pageTokenstring) *ScoresListWindowCall

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

func (*ScoresListWindowCall)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.

func (*ScoresListWindowCall)ResultsAbove

func (c *ScoresListWindowCall) ResultsAbove(resultsAboveint64) *ScoresListWindowCall

ResultsAbove sets the optional parameter "resultsAbove": The preferrednumber of scores to return above the player's score. More scores may bereturned if the player is at the bottom of the leaderboard; fewer may bereturned if the player is at the top. Must be less than or equal tomaxResults.

func (*ScoresListWindowCall)ReturnTopIfAbsent

func (c *ScoresListWindowCall) ReturnTopIfAbsent(returnTopIfAbsentbool) *ScoresListWindowCall

ReturnTopIfAbsent sets the optional parameter "returnTopIfAbsent": True ifthe top scores should be returned when the player is not in the leaderboard.Defaults to true.

typeScoresService

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

funcNewScoresService

func NewScoresService(s *Service) *ScoresService

func (*ScoresService)Get

func (r *ScoresService) Get(playerIdstring, leaderboardIdstring, timeSpanstring) *ScoresGetCall

Get: Get high scores, and optionally ranks, in leaderboards for thecurrently authenticated player. For a specific time span, `leaderboardId`can be set to `ALL` to retrieve data for all leaderboards in a given timespan. `NOTE: You cannot ask for 'ALL' leaderboards and 'ALL' timeSpans inthe same request; only one parameter may be set to 'ALL'.

  • leaderboardId: The ID of the leaderboard. Can be set to 'ALL' to retrievedata for all leaderboards for this application.
  • playerId: A player ID. A value of `me` may be used in place of theauthenticated player's ID.
  • timeSpan: The time span for the scores and ranks you're requesting.

func (*ScoresService)List

func (r *ScoresService) List(leaderboardIdstring, collectionstring, timeSpanstring) *ScoresListCall

List: Lists the scores in a leaderboard, starting from the top.

- collection: The collection of scores you're requesting.- leaderboardId: The ID of the leaderboard.- timeSpan: The time span for the scores and ranks you're requesting.

func (*ScoresService)ListWindow

func (r *ScoresService) ListWindow(leaderboardIdstring, collectionstring, timeSpanstring) *ScoresListWindowCall

ListWindow: Lists the scores in a leaderboard around (and including) aplayer's score.

- collection: The collection of scores you're requesting.- leaderboardId: The ID of the leaderboard.- timeSpan: The time span for the scores and ranks you're requesting.

func (*ScoresService)Submit

func (r *ScoresService) Submit(leaderboardIdstring, scoreint64) *ScoresSubmitCall

Submit: Submits a score to the specified leaderboard.

  • leaderboardId: The ID of the leaderboard.
  • score: The score you're submitting. The submitted score is ignored if itis worse than a previously submitted score, where worse depends on theleaderboard sort order. The meaning of the score value depends on theleaderboard format type. For fixed-point, the score represents the rawvalue. For time, the score represents elapsed time in milliseconds. Forcurrency, the score represents a value in micro units.

func (*ScoresService)SubmitMultiple

func (r *ScoresService) SubmitMultiple(playerscoresubmissionlist *PlayerScoreSubmissionList) *ScoresSubmitMultipleCall

SubmitMultiple: Submits multiple scores to leaderboards.

typeScoresSubmitCall

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

func (*ScoresSubmitCall)Context

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

func (*ScoresSubmitCall)Do

Do executes the "games.scores.submit" call.Any non-2xx status code is an error. Response headers are in either*PlayerScoreResponse.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ScoresSubmitCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ScoresSubmitCall)Header

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

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

func (*ScoresSubmitCall)Language

func (c *ScoresSubmitCall) Language(languagestring) *ScoresSubmitCall

Language sets the optional parameter "language": The preferred language touse for strings returned by this method.

func (*ScoresSubmitCall)ScoreTag

func (c *ScoresSubmitCall) ScoreTag(scoreTagstring) *ScoresSubmitCall

ScoreTag sets the optional parameter "scoreTag": Additional informationabout the score you're submitting. Values must contain no more than 64URI-safe characters as defined by section 2.3 ofRFC 3986.

typeScoresSubmitMultipleCall

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

func (*ScoresSubmitMultipleCall)Context

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

func (*ScoresSubmitMultipleCall)Do

Do executes the "games.scores.submitMultiple" call.Any non-2xx status code is an error. Response headers are in either*PlayerScoreListResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ScoresSubmitMultipleCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ScoresSubmitMultipleCall)Header

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

func (*ScoresSubmitMultipleCall)Language

Language sets the optional parameter "language": The preferred language touse for strings returned by this method.

typeService

type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentAccesstokens *AccesstokensServiceAchievementDefinitions *AchievementDefinitionsServiceAchievements *AchievementsServiceApplications *ApplicationsServiceEvents *EventsServiceLeaderboards *LeaderboardsServiceMetagame *MetagameServicePlayers *PlayersServiceRecall *RecallServiceRevisions *RevisionsServiceScores *ScoresServiceSnapshots *SnapshotsServiceStats *StatsService// contains filtered or unexported fields}

funcNewdeprecated

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.

funcNewServiceadded inv0.3.0

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

NewService creates a new Service.

typeSnapshot

type Snapshot struct {// CoverImage: The cover image of this snapshot. May be absent if there is no// image.CoverImage *SnapshotImage `json:"coverImage,omitempty"`// Description: The description of this snapshot.Descriptionstring `json:"description,omitempty"`// DriveId: The ID of the file underlying this snapshot in the Drive API. Only// present if the snapshot is a view on a Drive file and the file is owned by// the caller.DriveIdstring `json:"driveId,omitempty"`// DurationMillis: The duration associated with this snapshot, in millis.DurationMillisint64 `json:"durationMillis,omitempty,string"`// Id: The ID of the snapshot.Idstring `json:"id,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#snapshot`.Kindstring `json:"kind,omitempty"`// LastModifiedMillis: The timestamp (in millis since Unix epoch) of the last// modification to this snapshot.LastModifiedMillisint64 `json:"lastModifiedMillis,omitempty,string"`// ProgressValue: The progress value (64-bit integer set by developer)// associated with this snapshot.ProgressValueint64 `json:"progressValue,omitempty,string"`// Title: The title of this snapshot.Titlestring `json:"title,omitempty"`// Type: The type of this snapshot.//// Possible values://   "SAVE_GAME" - A snapshot representing a save game.Typestring `json:"type,omitempty"`// UniqueName: The unique name provided when the snapshot was created.UniqueNamestring `json:"uniqueName,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CoverImage") 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. "CoverImage") 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:"-"`}

Snapshot: An snapshot object.

func (Snapshot)MarshalJSON

func (sSnapshot) MarshalJSON() ([]byte,error)

typeSnapshotImage

type SnapshotImage struct {// Height: The height of the image.Heightint64 `json:"height,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#snapshotImage`.Kindstring `json:"kind,omitempty"`// MimeType: The MIME type of the image.MimeTypestring `json:"mime_type,omitempty"`// Url: The URL of the image. This URL may be invalidated at any time and// should not be cached.Urlstring `json:"url,omitempty"`// Width: The width of the image.Widthint64 `json:"width,omitempty"`// ForceSendFields is a list of field names (e.g. "Height") 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. "Height") 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:"-"`}

SnapshotImage: An image of a snapshot.

func (SnapshotImage)MarshalJSON

func (sSnapshotImage) MarshalJSON() ([]byte,error)

typeSnapshotListResponse

type SnapshotListResponse struct {// Items: The snapshots.Items []*Snapshot `json:"items,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#snapshotListResponse`.Kindstring `json:"kind,omitempty"`// NextPageToken: Token corresponding to the next page of results. If there are// no more results, the token is omitted.NextPageTokenstring `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:"-"`}

SnapshotListResponse: A third party list snapshots response.

func (SnapshotListResponse)MarshalJSON

func (sSnapshotListResponse) MarshalJSON() ([]byte,error)

typeSnapshotsGetCall

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

func (*SnapshotsGetCall)Context

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

func (*SnapshotsGetCall)Do

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

func (*SnapshotsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SnapshotsGetCall)Header

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

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

func (*SnapshotsGetCall)IfNoneMatch

func (c *SnapshotsGetCall) IfNoneMatch(entityTagstring) *SnapshotsGetCall

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

func (*SnapshotsGetCall)Language

func (c *SnapshotsGetCall) Language(languagestring) *SnapshotsGetCall

Language sets the optional parameter "language": The preferred language touse for strings returned by this method.

typeSnapshotsListCall

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

func (*SnapshotsListCall)Context

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

func (*SnapshotsListCall)Do

Do executes the "games.snapshots.list" call.Any non-2xx status code is an error. Response headers are in either*SnapshotListResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*SnapshotsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SnapshotsListCall)Header

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

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

func (*SnapshotsListCall)IfNoneMatch

func (c *SnapshotsListCall) IfNoneMatch(entityTagstring) *SnapshotsListCall

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

func (*SnapshotsListCall)Language

func (c *SnapshotsListCall) Language(languagestring) *SnapshotsListCall

Language sets the optional parameter "language": The preferred language touse for strings returned by this method.

func (*SnapshotsListCall)MaxResults

func (c *SnapshotsListCall) MaxResults(maxResultsint64) *SnapshotsListCall

MaxResults sets the optional parameter "maxResults": The maximum number ofsnapshot resources to return in the response, used for paging. For anyresponse, the actual number of snapshot resources returned may be less thanthe specified `maxResults`.

func (*SnapshotsListCall)PageToken

func (c *SnapshotsListCall) PageToken(pageTokenstring) *SnapshotsListCall

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

func (*SnapshotsListCall)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.

typeSnapshotsService

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

funcNewSnapshotsService

func NewSnapshotsService(s *Service) *SnapshotsService

func (*SnapshotsService)Get

func (r *SnapshotsService) Get(snapshotIdstring) *SnapshotsGetCall

Get: Retrieves the metadata for a given snapshot ID.

- snapshotId: The ID of the snapshot.

func (*SnapshotsService)List

func (r *SnapshotsService) List(playerIdstring) *SnapshotsListCall

List: Retrieves a list of snapshots created by your application for theplayer corresponding to the player ID.

  • playerId: A player ID. A value of `me` may be used in place of theauthenticated player's ID.

typeStatsGetCalladded inv0.29.0

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

func (*StatsGetCall)Contextadded inv0.29.0

func (c *StatsGetCall) Context(ctxcontext.Context) *StatsGetCall

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

func (*StatsGetCall)Doadded inv0.29.0

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

func (*StatsGetCall)Fieldsadded inv0.29.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*StatsGetCall)Headeradded inv0.29.0

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

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

func (*StatsGetCall)IfNoneMatchadded inv0.29.0

func (c *StatsGetCall) IfNoneMatch(entityTagstring) *StatsGetCall

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

typeStatsResponseadded inv0.29.0

type StatsResponse struct {// AvgSessionLengthMinutes: Average session length in minutes of the player.// E.g., 1, 30, 60, ... . Not populated if there is not enough information.AvgSessionLengthMinutesfloat64 `json:"avg_session_length_minutes,omitempty"`// ChurnProbability: The probability of the player not returning to play the// game in the next day. E.g., 0, 0.1, 0.5, ..., 1.0. Not populated if there is// not enough information.ChurnProbabilityfloat64 `json:"churn_probability,omitempty"`// DaysSinceLastPlayed: Number of days since the player last played this game.// E.g., 0, 1, 5, 10, ... . Not populated if there is not enough information.DaysSinceLastPlayedint64 `json:"days_since_last_played,omitempty"`// HighSpenderProbability: The probability of the player going to spend beyond// a threshold amount of money. E.g., 0, 0.25, 0.50, 0.75. Not populated if// there is not enough information.HighSpenderProbabilityfloat64 `json:"high_spender_probability,omitempty"`// Kind: Uniquely identifies the type of this resource. Value is always the// fixed string `games#statsResponse`.Kindstring `json:"kind,omitempty"`// NumPurchases: Number of in-app purchases made by the player in this game.// E.g., 0, 1, 5, 10, ... . Not populated if there is not enough information.NumPurchasesint64 `json:"num_purchases,omitempty"`// NumSessions: The approximate number of sessions of the player within the// last 28 days, where a session begins when the player is connected to Play// Games Services and ends when they are disconnected. E.g., 0, 1, 5, 10, ... .// Not populated if there is not enough information.NumSessionsint64 `json:"num_sessions,omitempty"`// NumSessionsPercentile: The approximation of the sessions percentile of the// player within the last 30 days, where a session begins when the player is// connected to Play Games Services and ends when they are disconnected. E.g.,// 0, 0.25, 0.5, 0.75. Not populated if there is not enough information.NumSessionsPercentilefloat64 `json:"num_sessions_percentile,omitempty"`// SpendPercentile: The approximate spend percentile of the player in this// game. E.g., 0, 0.25, 0.5, 0.75. Not populated if there is not enough// information.SpendPercentilefloat64 `json:"spend_percentile,omitempty"`// SpendProbability: The probability of the player going to spend the game in// the next seven days. E.g., 0, 0.25, 0.50, 0.75. Not populated if there is// not enough information.SpendProbabilityfloat64 `json:"spend_probability,omitempty"`// TotalSpendNext28Days: The predicted amount of money that the player going to// spend in the next 28 days. E.g., 1, 30, 60, ... . Not populated if there is// not enough information.TotalSpendNext28Daysfloat64 `json:"total_spend_next_28_days,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AvgSessionLengthMinutes") 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. "AvgSessionLengthMinutes") 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:"-"`}

StatsResponse: A third party stats resource.

func (StatsResponse)MarshalJSONadded inv0.29.0

func (sStatsResponse) MarshalJSON() ([]byte,error)

func (*StatsResponse)UnmarshalJSONadded inv0.29.0

func (s *StatsResponse) UnmarshalJSON(data []byte)error

typeStatsServiceadded inv0.29.0

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

funcNewStatsServiceadded inv0.29.0

func NewStatsService(s *Service) *StatsService

func (*StatsService)Getadded inv0.29.0

func (r *StatsService) Get() *StatsGetCall

Get: Returns engagement and spend statistics in this application for thecurrently authenticated user.

typeUnlinkPersonaRequestadded inv0.139.0

type UnlinkPersonaRequest struct {// Persona: Value of the 'persona' field as it was provided by the client in// LinkPersona RPCPersonastring `json:"persona,omitempty"`// SessionId: Required. Opaque server-generated string that encodes all the// necessary information to identify the PGS player / Google user and// application.SessionIdstring `json:"sessionId,omitempty"`// Token: Value of the Recall token as it was provided by the client in// LinkPersona RPCTokenstring `json:"token,omitempty"`// ForceSendFields is a list of field names (e.g. "Persona") 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. "Persona") 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:"-"`}

UnlinkPersonaRequest: Request to remove a Recall token linking PGS principaland an in-game account

func (UnlinkPersonaRequest)MarshalJSONadded inv0.139.0

func (sUnlinkPersonaRequest) MarshalJSON() ([]byte,error)

typeUnlinkPersonaResponseadded inv0.139.0

type UnlinkPersonaResponse struct {// Unlinked: Required. Whether a Recall token specified by the request was// deleted. Can be 'false' when there were no Recall tokens satisfied the// criteria from the request.Unlinkedbool `json:"unlinked,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Unlinked") 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. "Unlinked") 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:"-"`}

UnlinkPersonaResponse: Response for the UnlinkPersona RPC

func (UnlinkPersonaResponse)MarshalJSONadded inv0.139.0

func (sUnlinkPersonaResponse) MarshalJSON() ([]byte,error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f orF : Jump to
y orY : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic.Learn more.

[8]ページ先頭

©2009-2025 Movatter.jp