games

package
v0.196.2 Latest Latest
Warning

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

Go to latest
Published: Sep 10, 2024 License: BSD-3-Clause Imports: 16 Imported by: 0

Documentation

Overview

Package games provides access to the Google Play Game Services.

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

Library status

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

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

Creating a client

Usage example:

import "google.golang.org/api/games/v1"
...
ctx := context.Background()
gamesService, err := games.NewService(ctx)

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

Other authentication options

By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use google.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 API keys), use google.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 OAuth flow, use google.golang.org/api/option.WithTokenSource:

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

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

Index

Constants

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

	// See, create, and delete its own configuration data in your Google Drive
	DriveAppdataScope = "https://www.googleapis.com/auth/drive.appdata"

	// Create, edit, and delete your Google Play Games activity
	GamesScope = "https://www.googleapis.com/auth/games"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccesstokensGeneratePlayGroupingApiTokenCall

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

func (*AccesstokensGeneratePlayGroupingApiTokenCall) Context

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

func (*AccesstokensGeneratePlayGroupingApiTokenCall) Do

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 a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AccesstokensGeneratePlayGroupingApiTokenCall) Fields

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

func (*AccesstokensGeneratePlayGroupingApiTokenCall) Header

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

func (*AccesstokensGeneratePlayGroupingApiTokenCall) PackageName

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

func (*AccesstokensGeneratePlayGroupingApiTokenCall) Persona

Persona sets the optional parameter "persona": Required. Persona to associate with the token. Persona is a developer-provided stable identifier of 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.

type AccesstokensGenerateRecallPlayGroupingApiTokenCall

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

func (*AccesstokensGenerateRecallPlayGroupingApiTokenCall) Context

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

func (*AccesstokensGenerateRecallPlayGroupingApiTokenCall) Do

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 a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AccesstokensGenerateRecallPlayGroupingApiTokenCall) Fields

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

func (*AccesstokensGenerateRecallPlayGroupingApiTokenCall) Header

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

func (*AccesstokensGenerateRecallPlayGroupingApiTokenCall) PackageName

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

func (*AccesstokensGenerateRecallPlayGroupingApiTokenCall) Persona

Persona sets the optional parameter "persona": Required. Persona to associate with the token. Persona is a developer-provided stable identifier of 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) RecallSessionId

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

type AccesstokensService

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

func NewAccesstokensService

func NewAccesstokensService(s *Service) *AccesstokensService

func (*AccesstokensService) GeneratePlayGroupingApiToken

func (r *AccesstokensService) GeneratePlayGroupingApiToken() *AccesstokensGeneratePlayGroupingApiTokenCall

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

func (*AccesstokensService) GenerateRecallPlayGroupingApiToken

func (r *AccesstokensService) GenerateRecallPlayGroupingApiToken() *AccesstokensGenerateRecallPlayGroupingApiTokenCall

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

type AchievementDefinition

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

type AchievementDefinitionsListCall

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 response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AchievementDefinitionsListCall) Fields

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

func (*AchievementDefinitionsListCall) Header

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

func (*AchievementDefinitionsListCall) IfNoneMatch

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

func (*AchievementDefinitionsListCall) Language

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

func (*AchievementDefinitionsListCall) MaxResults

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

func (*AchievementDefinitionsListCall) PageToken

PageToken sets the optional parameter "pageToken": The token returned by the previous 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.

type AchievementDefinitionsListResponse

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`.
	Kind string `json:"kind,omitempty"`
	// NextPageToken: Token corresponding to the next page of results.
	NextPageToken string `json:"nextPageToken,omitempty"`

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

AchievementDefinitionsListResponse: A list of achievement definition objects.

func (AchievementDefinitionsListResponse) MarshalJSON

func (s AchievementDefinitionsListResponse) MarshalJSON() ([]byte, error)

type AchievementDefinitionsService

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

func NewAchievementDefinitionsService

func NewAchievementDefinitionsService(s *Service) *AchievementDefinitionsService

func (*AchievementDefinitionsService) List

List: Lists all the achievement definitions for your application.

type AchievementIncrementResponse

type AchievementIncrementResponse struct {
	// CurrentSteps: The current steps recorded for this incremental achievement.
	CurrentSteps int64 `json:"currentSteps,omitempty"`
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#achievementIncrementResponse`.
	Kind string `json:"kind,omitempty"`
	// NewlyUnlocked: Whether the current steps for the achievement has reached the
	// number of steps required to unlock.
	NewlyUnlocked bool `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 (s AchievementIncrementResponse) MarshalJSON() ([]byte, error)

type AchievementRevealResponse

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.
	CurrentState string `json:"currentState,omitempty"`
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#achievementRevealResponse`.
	Kind string `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 (s AchievementRevealResponse) MarshalJSON() ([]byte, error)

type AchievementSetStepsAtLeastResponse

type AchievementSetStepsAtLeastResponse struct {
	// CurrentSteps: The current steps recorded for this incremental achievement.
	CurrentSteps int64 `json:"currentSteps,omitempty"`
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#achievementSetStepsAtLeastResponse`.
	Kind string `json:"kind,omitempty"`
	// NewlyUnlocked: Whether the current steps for the achievement has reached the
	// number of steps required to unlock.
	NewlyUnlocked bool `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 least response.

func (AchievementSetStepsAtLeastResponse) MarshalJSON

func (s AchievementSetStepsAtLeastResponse) MarshalJSON() ([]byte, error)

type AchievementUnlockResponse

type AchievementUnlockResponse struct {
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#achievementUnlockResponse`.
	Kind string `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).
	NewlyUnlocked bool `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 (s AchievementUnlockResponse) MarshalJSON() ([]byte, error)

type AchievementUpdateMultipleRequest

type AchievementUpdateMultipleRequest struct {
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#achievementUpdateMultipleRequest`.
	Kind string `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 (s AchievementUpdateMultipleRequest) MarshalJSON() ([]byte, error)

type AchievementUpdateMultipleResponse

type AchievementUpdateMultipleResponse struct {
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#achievementUpdateMultipleResponse`.
	Kind string `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 for UpdateMultipleAchievements rpc.

func (AchievementUpdateMultipleResponse) MarshalJSON

func (s AchievementUpdateMultipleResponse) MarshalJSON() ([]byte, error)

type AchievementUpdateRequest

type AchievementUpdateRequest struct {
	// AchievementId: The achievement this update is being applied to.
	AchievementId string `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`.
	Kind string `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.
	UpdateType string `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 (s AchievementUpdateRequest) MarshalJSON() ([]byte, error)

type AchievementUpdateResponse

type AchievementUpdateResponse struct {
	// AchievementId: The achievement this update is was applied to.
	AchievementId string `json:"achievementId,omitempty"`
	// CurrentState: The current state of the achievement.
	//
	// Possible values:
	//   "HIDDEN" - Achievement is hidden.
	//   "REVEALED" - Achievement is revealed.
	//   "UNLOCKED" - Achievement is unlocked.
	CurrentState string `json:"currentState,omitempty"`
	// CurrentSteps: The current steps recorded for this achievement if it is
	// incremental.
	CurrentSteps int64 `json:"currentSteps,omitempty"`
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#achievementUpdateResponse`.
	Kind string `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).
	NewlyUnlocked bool `json:"newlyUnlocked,omitempty"`
	// UpdateOccurred: Whether the requested updates actually affected the
	// achievement.
	UpdateOccurred bool `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 (s AchievementUpdateResponse) MarshalJSON() ([]byte, error)

type AchievementsIncrementCall

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 was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AchievementsIncrementCall) Fields

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

func (*AchievementsIncrementCall) Header

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

func (*AchievementsIncrementCall) RequestId

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

type AchievementsListCall

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 was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AchievementsListCall) Fields

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

func (*AchievementsListCall) Header

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

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

func (*AchievementsListCall) IfNoneMatch

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

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

func (*AchievementsListCall) Language

func (c *AchievementsListCall) Language(language string) *AchievementsListCall

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

func (*AchievementsListCall) MaxResults

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

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

func (*AchievementsListCall) PageToken

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

PageToken sets the optional parameter "pageToken": The token returned by the previous 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 only achievements 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.

type AchievementsRevealCall

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 was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AchievementsRevealCall) Fields

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

func (*AchievementsRevealCall) Header

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

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

type AchievementsService

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

func NewAchievementsService

func NewAchievementsService(s *Service) *AchievementsService

func (*AchievementsService) Increment

func (r *AchievementsService) Increment(achievementId string, stepsToIncrement int64) *AchievementsIncrementCall

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

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

func (*AchievementsService) List

func (r *AchievementsService) List(playerId string) *AchievementsListCall

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

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

func (*AchievementsService) Reveal

func (r *AchievementsService) Reveal(achievementId string) *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(achievementId string, steps int64) *AchievementsSetStepsAtLeastCall

SetStepsAtLeast: Sets the steps for the currently authenticated player towards unlocking an achievement. If the steps parameter is less than the current 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(achievementId string) *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 currently authenticated player.

type AchievementsSetStepsAtLeastCall

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 response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AchievementsSetStepsAtLeastCall) Fields

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

func (*AchievementsSetStepsAtLeastCall) Header

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

type AchievementsUnlockCall

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 was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AchievementsUnlockCall) Fields

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

func (*AchievementsUnlockCall) Header

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

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

type AchievementsUpdateMultipleCall

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 response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AchievementsUpdateMultipleCall) Fields

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

func (*AchievementsUpdateMultipleCall) Header

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

type Application

type Application struct {
	// AchievementCount: The number of achievements visible to the currently
	// authenticated player.
	AchievementCount int64 `json:"achievement_count,omitempty"`
	// Assets: The assets of the application.
	Assets []*ImageAsset `json:"assets,omitempty"`
	// Author: The author of the application.
	Author string `json:"author,omitempty"`
	// Category: The category of the application.
	Category *ApplicationCategory `json:"category,omitempty"`
	// Description: The description of the application.
	Description string `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.
	Id string `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`.
	Kind string `json:"kind,omitempty"`
	// LastUpdatedTimestamp: The last updated timestamp of the application.
	LastUpdatedTimestamp int64 `json:"lastUpdatedTimestamp,omitempty,string"`
	// LeaderboardCount: The number of leaderboards visible to the currently
	// authenticated player.
	LeaderboardCount int64 `json:"leaderboard_count,omitempty"`
	// Name: The name of the application.
	Name string `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").
	ThemeColor string `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 (s Application) MarshalJSON() ([]byte, error)

type ApplicationCategory

type ApplicationCategory struct {
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#applicationCategory`.
	Kind string `json:"kind,omitempty"`
	// Primary: The primary category.
	Primary string `json:"primary,omitempty"`
	// Secondary: The secondary category.
	Secondary string `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 (s ApplicationCategory) MarshalJSON() ([]byte, error)

type ApplicationPlayerId

type ApplicationPlayerId struct {
	// ApplicationId: The application that this player identifier is for.
	ApplicationId string `json:"applicationId,omitempty"`
	// PlayerId: The player identifier for the application.
	PlayerId string `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) MarshalJSON

func (s ApplicationPlayerId) MarshalJSON() ([]byte, error)

type ApplicationVerifyResponse

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.)
	AlternatePlayerId string `json:"alternate_player_id,omitempty"`
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#applicationVerifyResponse`.
	Kind string `json:"kind,omitempty"`
	// PlayerId: The ID of the player that was issued the auth token used in this
	// request.
	PlayerId string `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 response resource.

func (ApplicationVerifyResponse) MarshalJSON

func (s ApplicationVerifyResponse) MarshalJSON() ([]byte, error)

type ApplicationsGetCall

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ApplicationsGetCall) Fields

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

func (*ApplicationsGetCall) Header

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

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

func (*ApplicationsGetCall) IfNoneMatch

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

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

func (*ApplicationsGetCall) Language

func (c *ApplicationsGetCall) Language(language string) *ApplicationsGetCall

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

func (*ApplicationsGetCall) PlatformType

func (c *ApplicationsGetCall) PlatformType(platformType string) *ApplicationsGetCall

PlatformType sets the optional parameter "platformType": Restrict application 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.

type ApplicationsGetEndPointCall

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

func (*ApplicationsGetEndPointCall) ApplicationId

func (c *ApplicationsGetEndPointCall) ApplicationId(applicationId string) *ApplicationsGetEndPointCall

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

func (*ApplicationsGetEndPointCall) Context

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

func (*ApplicationsGetEndPointCall) Do

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ApplicationsGetEndPointCall) EndPointType

func (c *ApplicationsGetEndPointCall) EndPointType(endPointType string) *ApplicationsGetEndPointCall

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

Possible values:

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

func (*ApplicationsGetEndPointCall) Fields

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

func (*ApplicationsGetEndPointCall) Header

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

type ApplicationsPlayedCall

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. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ApplicationsPlayedCall) Header

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

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

type ApplicationsService

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

func NewApplicationsService

func NewApplicationsService(s *Service) *ApplicationsService

func (*ApplicationsService) Get

func (r *ApplicationsService) Get(applicationId string) *ApplicationsGetCall

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

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

func (*ApplicationsService) GetEndPoint

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

func (*ApplicationsService) Played

Played: Indicate that the currently authenticated user is playing your application.

func (*ApplicationsService) Verify

func (r *ApplicationsService) Verify(applicationId string) *ApplicationsVerifyCall

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

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

type ApplicationsVerifyCall

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 was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ApplicationsVerifyCall) Fields

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

func (*ApplicationsVerifyCall) Header

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

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

func (*ApplicationsVerifyCall) IfNoneMatch

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

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

type Category

type Category struct {
	// Category: The category name.
	Category string `json:"category,omitempty"`
	// ExperiencePoints: Experience points earned in this category.
	ExperiencePoints int64 `json:"experiencePoints,omitempty,string"`
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#category`.
	Kind string `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 (s Category) MarshalJSON() ([]byte, error)

type CategoryListResponse

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`.
	Kind string `json:"kind,omitempty"`
	// NextPageToken: Token corresponding to the next page of results.
	NextPageToken string `json:"nextPageToken,omitempty"`

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

CategoryListResponse: A third party list metagame categories response.

func (CategoryListResponse) MarshalJSON

func (s CategoryListResponse) MarshalJSON() ([]byte, error)

type EndPoint

type EndPoint struct {
	// Url: A URL suitable for loading in a web browser for the requested endpoint.
	Url string `json:"url,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "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) MarshalJSON

func (s EndPoint) MarshalJSON() ([]byte, error)

type EventBatchRecordFailure

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.
	FailureCause string `json:"failureCause,omitempty"`
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#eventBatchRecordFailure`.
	Kind string `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 (s EventBatchRecordFailure) MarshalJSON() ([]byte, error)

type EventChild

type EventChild struct {
	// ChildId: The ID of the child event.
	ChildId string `json:"childId,omitempty"`
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#eventChild`.
	Kind string `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 (s EventChild) MarshalJSON() ([]byte, error)

type EventDefinition

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.
	Description string `json:"description,omitempty"`
	// DisplayName: The name to display for the event.
	DisplayName string `json:"displayName,omitempty"`
	// Id: The ID of the event.
	Id string `json:"id,omitempty"`
	// ImageUrl: The base URL for the image that represents the event.
	ImageUrl string `json:"imageUrl,omitempty"`
	// IsDefaultImageUrl: Indicates whether the icon image being returned is a
	// default image, or is game-provided.
	IsDefaultImageUrl bool `json:"isDefaultImageUrl,omitempty"`
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#eventDefinition`.
	Kind string `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.
	Visibility string `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 (s EventDefinition) MarshalJSON() ([]byte, error)

type EventDefinitionListResponse

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`.
	Kind string `json:"kind,omitempty"`
	// NextPageToken: The pagination token for the next page of results.
	NextPageToken string `json:"nextPageToken,omitempty"`

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

EventDefinitionListResponse: A ListDefinitions response.

func (EventDefinitionListResponse) MarshalJSON

func (s EventDefinitionListResponse) MarshalJSON() ([]byte, error)

type EventPeriodRange

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

type EventPeriodUpdate

type EventPeriodUpdate struct {
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#eventPeriodUpdate`.
	Kind string `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 (s EventPeriodUpdate) MarshalJSON() ([]byte, error)

type EventRecordFailure

type EventRecordFailure struct {
	// EventId: The ID of the event that was not updated.
	EventId string `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.
	FailureCause string `json:"failureCause,omitempty"`
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#eventRecordFailure`.
	Kind string `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 (s EventRecordFailure) MarshalJSON() ([]byte, error)

type EventRecordRequest

type EventRecordRequest struct {
	// CurrentTimeMillis: The current time when this update was sent, in
	// milliseconds, since 1970 UTC (Unix Epoch).
	CurrentTimeMillis int64 `json:"currentTimeMillis,omitempty,string"`
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#eventRecordRequest`.
	Kind string `json:"kind,omitempty"`
	// RequestId: The request ID used to identify this attempt to record events.
	RequestId int64 `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 (s EventRecordRequest) MarshalJSON() ([]byte, error)

type EventUpdateRequest

type EventUpdateRequest struct {
	// DefinitionId: The ID of the event being modified in this update.
	DefinitionId string `json:"definitionId,omitempty"`
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#eventUpdateRequest`.
	Kind string `json:"kind,omitempty"`
	// UpdateCount: The number of times this event occurred in this time period.
	UpdateCount int64 `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 (s EventUpdateRequest) MarshalJSON() ([]byte, error)

type EventUpdateResponse

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`.
	Kind string `json:"kind,omitempty"`
	// PlayerEvents: The current status of any updated events
	PlayerEvents []*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 (s EventUpdateResponse) MarshalJSON() ([]byte, error)

type EventsListByPlayerCall

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 was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*EventsListByPlayerCall) Fields

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

func (*EventsListByPlayerCall) Header

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

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

func (*EventsListByPlayerCall) IfNoneMatch

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

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

func (*EventsListByPlayerCall) Language

func (c *EventsListByPlayerCall) Language(language string) *EventsListByPlayerCall

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

func (*EventsListByPlayerCall) MaxResults

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

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

func (*EventsListByPlayerCall) PageToken

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

PageToken sets the optional parameter "pageToken": The token returned by the previous 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.

type EventsListDefinitionsCall

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 was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*EventsListDefinitionsCall) Fields

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

func (*EventsListDefinitionsCall) Header

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

func (*EventsListDefinitionsCall) IfNoneMatch

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

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

func (*EventsListDefinitionsCall) Language

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

func (*EventsListDefinitionsCall) MaxResults

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

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

func (*EventsListDefinitionsCall) PageToken

PageToken sets the optional parameter "pageToken": The token returned by the previous 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.

type EventsRecordCall

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 at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*EventsRecordCall) Fields

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

func (*EventsRecordCall) Header

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

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

func (*EventsRecordCall) Language

func (c *EventsRecordCall) Language(language string) *EventsRecordCall

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

type EventsService

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

func NewEventsService

func NewEventsService(s *Service) *EventsService

func (*EventsService) ListByPlayer

func (r *EventsService) ListByPlayer() *EventsListByPlayerCall

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

func (*EventsService) ListDefinitions

func (r *EventsService) ListDefinitions() *EventsListDefinitionsCall

ListDefinitions: Returns a list of the event definitions in this application.

func (*EventsService) Record

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

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

type GamePlayerToken

type GamePlayerToken struct {
	// ApplicationId: The application that this player identifier is for.
	ApplicationId string `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) MarshalJSON

func (s GamePlayerToken) MarshalJSON() ([]byte, error)

type GamesAchievementIncrement

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

func (GamesAchievementIncrement) MarshalJSON

func (s GamesAchievementIncrement) MarshalJSON() ([]byte, error)

type GamesAchievementSetStepsAtLeast

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

func (GamesAchievementSetStepsAtLeast) MarshalJSON

func (s GamesAchievementSetStepsAtLeast) MarshalJSON() ([]byte, error)

type GeneratePlayGroupingApiTokenResponse

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 the GeneratePlayGroupingApiToken RPC.

func (GeneratePlayGroupingApiTokenResponse) MarshalJSON

func (s GeneratePlayGroupingApiTokenResponse) MarshalJSON() ([]byte, error)

type GenerateRecallPlayGroupingApiTokenResponse

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 the GenerateRecallPlayGroupingApiToken RPC.

func (GenerateRecallPlayGroupingApiTokenResponse) MarshalJSON

type GetMultipleApplicationPlayerIdsResponse

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 for GetMultipleApplicationPlayerIds rpc.

func (GetMultipleApplicationPlayerIdsResponse) MarshalJSON

func (s GetMultipleApplicationPlayerIdsResponse) MarshalJSON() ([]byte, error)

type ImageAsset

type ImageAsset struct {
	// Height: The height of the asset.
	Height int64 `json:"height,omitempty"`
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#imageAsset`.
	Kind string `json:"kind,omitempty"`
	// Name: The name of the asset.
	Name string `json:"name,omitempty"`
	// Url: The URL of the asset.
	Url string `json:"url,omitempty"`
	// Width: The width of the asset.
	Width int64 `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 (s ImageAsset) MarshalJSON() ([]byte, error)

type Instance

type Instance struct {
	// AcquisitionUri: URI which shows where a user can acquire this instance.
	AcquisitionUri string `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`.
	Kind string `json:"kind,omitempty"`
	// Name: Localized display name.
	Name string `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.
	PlatformType string `json:"platformType,omitempty"`
	// RealtimePlay: Flag to show if this game instance supports realtime play.
	RealtimePlay bool `json:"realtimePlay,omitempty"`
	// TurnBasedPlay: Flag to show if this game instance supports turn based play.
	TurnBasedPlay bool `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 (s Instance) MarshalJSON() ([]byte, error)

type InstanceAndroidDetails

type InstanceAndroidDetails struct {
	// EnablePiracyCheck: Flag indicating whether the anti-piracy check is enabled.
	EnablePiracyCheck bool `json:"enablePiracyCheck,omitempty"`
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#instanceAndroidDetails`.
	Kind string `json:"kind,omitempty"`
	// PackageName: Android package name which maps to Google Play URL.
	PackageName string `json:"packageName,omitempty"`
	// Preferred: Indicates that this instance is the default for new
	// installations.
	Preferred bool `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 (s InstanceAndroidDetails) MarshalJSON() ([]byte, error)

type InstanceIosDetails

type InstanceIosDetails struct {
	// BundleIdentifier: Bundle identifier.
	BundleIdentifier string `json:"bundleIdentifier,omitempty"`
	// ItunesAppId: iTunes App ID.
	ItunesAppId string `json:"itunesAppId,omitempty"`
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#instanceIosDetails`.
	Kind string `json:"kind,omitempty"`
	// PreferredForIpad: Indicates that this instance is the default for new
	// installations on iPad devices.
	PreferredForIpad bool `json:"preferredForIpad,omitempty"`
	// PreferredForIphone: Indicates that this instance is the default for new
	// installations on iPhone devices.
	PreferredForIphone bool `json:"preferredForIphone,omitempty"`
	// SupportIpad: Flag to indicate if this instance supports iPad.
	SupportIpad bool `json:"supportIpad,omitempty"`
	// SupportIphone: Flag to indicate if this instance supports iPhone.
	SupportIphone bool `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 (s InstanceIosDetails) MarshalJSON() ([]byte, error)

type InstanceWebDetails

type InstanceWebDetails struct {
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#instanceWebDetails`.
	Kind string `json:"kind,omitempty"`
	// LaunchUrl: Launch URL for the game.
	LaunchUrl string `json:"launchUrl,omitempty"`
	// Preferred: Indicates that this instance is the default for new
	// installations.
	Preferred bool `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 (s InstanceWebDetails) MarshalJSON() ([]byte, error)

type Leaderboard

type Leaderboard struct {
	// IconUrl: The icon for the leaderboard.
	IconUrl string `json:"iconUrl,omitempty"`
	// Id: The leaderboard ID.
	Id string `json:"id,omitempty"`
	// IsIconUrlDefault: Indicates whether the icon image being returned is a
	// default image, or is game-provided.
	IsIconUrlDefault bool `json:"isIconUrlDefault,omitempty"`
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#leaderboard`.
	Kind string `json:"kind,omitempty"`
	// Name: The name of the leaderboard.
	Name string `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 order
	Order string `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 (s Leaderboard) MarshalJSON() ([]byte, error)

type LeaderboardEntry

type LeaderboardEntry struct {
	// FormattedScore: The localized string for the numerical value of this score.
	FormattedScore string `json:"formattedScore,omitempty"`
	// FormattedScoreRank: The localized string for the rank of this score for this
	// leaderboard.
	FormattedScoreRank string `json:"formattedScoreRank,omitempty"`
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#leaderboardEntry`.
	Kind string `json:"kind,omitempty"`
	// Player: The player who holds this score.
	Player *Player `json:"player,omitempty"`
	// ScoreRank: The rank of this score for this leaderboard.
	ScoreRank int64 `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 of RFC 3986.
	ScoreTag string `json:"scoreTag,omitempty"`
	// ScoreValue: The numerical value of this score.
	ScoreValue int64 `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.
	TimeSpan string `json:"timeSpan,omitempty"`
	// WriteTimestampMillis: The timestamp at which this score was recorded, in
	// milliseconds since the epoch in UTC.
	WriteTimestampMillis int64 `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 (s LeaderboardEntry) MarshalJSON() ([]byte, error)

type LeaderboardListResponse

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`.
	Kind string `json:"kind,omitempty"`
	// NextPageToken: Token corresponding to the next page of results.
	NextPageToken string `json:"nextPageToken,omitempty"`

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

LeaderboardListResponse: A list of leaderboard objects.

func (LeaderboardListResponse) MarshalJSON

func (s LeaderboardListResponse) MarshalJSON() ([]byte, error)

type LeaderboardScoreRank

type LeaderboardScoreRank struct {
	// FormattedNumScores: The number of scores in the leaderboard as a string.
	FormattedNumScores string `json:"formattedNumScores,omitempty"`
	// FormattedRank: The rank in the leaderboard as a string.
	FormattedRank string `json:"formattedRank,omitempty"`
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#leaderboardScoreRank`.
	Kind string `json:"kind,omitempty"`
	// NumScores: The number of scores in the leaderboard.
	NumScores int64 `json:"numScores,omitempty,string"`
	// Rank: The rank in the leaderboard.
	Rank int64 `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 (s LeaderboardScoreRank) MarshalJSON() ([]byte, error)

type LeaderboardScores

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`.
	Kind string `json:"kind,omitempty"`
	// NextPageToken: The pagination token for the next page of results.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// NumScores: The total number of scores in the leaderboard.
	NumScores int64 `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.
	PrevPageToken string `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 (s LeaderboardScores) MarshalJSON() ([]byte, error)

type LeaderboardsGetCall

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*LeaderboardsGetCall) Fields

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

func (*LeaderboardsGetCall) Header

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

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

func (*LeaderboardsGetCall) IfNoneMatch

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

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

func (*LeaderboardsGetCall) Language

func (c *LeaderboardsGetCall) Language(language string) *LeaderboardsGetCall

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

type LeaderboardsListCall

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 was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*LeaderboardsListCall) Fields

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

func (*LeaderboardsListCall) Header

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

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

func (*LeaderboardsListCall) IfNoneMatch

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

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

func (*LeaderboardsListCall) Language

func (c *LeaderboardsListCall) Language(language string) *LeaderboardsListCall

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

func (*LeaderboardsListCall) MaxResults

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

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

func (*LeaderboardsListCall) PageToken

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

PageToken sets the optional parameter "pageToken": The token returned by the previous 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.

type LeaderboardsService

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

func NewLeaderboardsService

func NewLeaderboardsService(s *Service) *LeaderboardsService

func (*LeaderboardsService) Get

func (r *LeaderboardsService) Get(leaderboardId string) *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.

type LinkPersonaRequest

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.
	CardinalityConstraint string `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.
	ConflictingLinksResolutionPolicy string `json:"conflictingLinksResolutionPolicy,omitempty"`
	// ExpireTime: Input only. Optional expiration time.
	ExpireTime string `json:"expireTime,omitempty"`
	// Persona: Required. Stable identifier of the in-game account. Please refrain
	// from re-using the same persona for different games.
	Persona string `json:"persona,omitempty"`
	// SessionId: Required. Opaque server-generated string that encodes all the
	// necessary information to identify the PGS player / Google user and
	// application.
	SessionId string `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).
	Token string `json:"token,omitempty"`
	// Ttl: Input only. Optional time-to-live.
	Ttl string `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) MarshalJSON

func (s LinkPersonaRequest) MarshalJSON() ([]byte, error)

type LinkPersonaResponse

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.
	State string `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) MarshalJSON

func (s LinkPersonaResponse) MarshalJSON() ([]byte, error)

type MetagameConfig

type MetagameConfig struct {
	// CurrentVersion: Current version of the metagame configuration data. When
	// this data is updated, the version number will be increased by one.
	CurrentVersion int64 `json:"currentVersion,omitempty"`
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#metagameConfig`.
	Kind string `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 (s MetagameConfig) MarshalJSON() ([]byte, error)

type MetagameGetMetagameConfigCall

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 check whether the returned error was because http.StatusNotModified was returned.

func (*MetagameGetMetagameConfigCall) Fields

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

func (*MetagameGetMetagameConfigCall) Header

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

func (*MetagameGetMetagameConfigCall) IfNoneMatch

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

type MetagameListCategoriesByPlayerCall

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 returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*MetagameListCategoriesByPlayerCall) Fields

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

func (*MetagameListCategoriesByPlayerCall) Header

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

func (*MetagameListCategoriesByPlayerCall) IfNoneMatch

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

func (*MetagameListCategoriesByPlayerCall) Language

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

func (*MetagameListCategoriesByPlayerCall) MaxResults

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

func (*MetagameListCategoriesByPlayerCall) PageToken

PageToken sets the optional parameter "pageToken": The token returned by the previous 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.

type MetagameService

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

func NewMetagameService

func NewMetagameService(s *Service) *MetagameService

func (*MetagameService) GetMetagameConfig

func (r *MetagameService) GetMetagameConfig() *MetagameGetMetagameConfigCall

GetMetagameConfig: Return the metagame configuration data for the calling application.

func (*MetagameService) ListCategoriesByPlayer

func (r *MetagameService) ListCategoriesByPlayer(playerId string, collection string) *MetagameListCategoriesByPlayerCall

ListCategoriesByPlayer: List play data aggregated per category for the player 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 the authenticated player's ID.

type PlayGroupingApiToken

type PlayGroupingApiToken struct {
	// TokenValue: Value of the token.
	TokenValue string `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 GeneratePlayGroupingApiToken RPC.

func (PlayGroupingApiToken) MarshalJSON

func (s PlayGroupingApiToken) MarshalJSON() ([]byte, error)

type Player

type Player struct {
	// AvatarImageUrl: The base URL for the image that represents the player.
	AvatarImageUrl string `json:"avatarImageUrl,omitempty"`
	// BannerUrlLandscape: The url to the landscape mode player banner image.
	BannerUrlLandscape string `json:"bannerUrlLandscape,omitempty"`
	// BannerUrlPortrait: The url to the portrait mode player banner image.
	BannerUrlPortrait string `json:"bannerUrlPortrait,omitempty"`
	// DisplayName: The name to display for the player.
	DisplayName string `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.
	FriendStatus string `json:"friendStatus,omitempty"`
	// GamePlayerId: Per-application unique player identifier.
	GamePlayerId string `json:"gamePlayerId,omitempty"`
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#player`
	Kind string `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.
	OriginalPlayerId string `json:"originalPlayerId,omitempty"`
	// PlayerId: The ID of the player.
	PlayerId string `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.
	Title string `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 (s Player) MarshalJSON() ([]byte, error)

type PlayerAchievement

type PlayerAchievement struct {
	// AchievementState: The state of the achievement.
	//
	// Possible values:
	//   "HIDDEN" - Achievement is hidden.
	//   "REVEALED" - Achievement is revealed.
	//   "UNLOCKED" - Achievement is unlocked.
	AchievementState string `json:"achievementState,omitempty"`
	// CurrentSteps: The current steps for an incremental achievement.
	CurrentSteps int64 `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.
	ExperiencePoints int64 `json:"experiencePoints,omitempty,string"`
	// FormattedCurrentStepsString: The current steps for an incremental
	// achievement as a string.
	FormattedCurrentStepsString string `json:"formattedCurrentStepsString,omitempty"`
	// Id: The ID of the achievement.
	Id string `json:"id,omitempty"`
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#playerAchievement`.
	Kind string `json:"kind,omitempty"`
	// LastUpdatedTimestamp: The timestamp of the last modification to this
	// achievement's state.
	LastUpdatedTimestamp int64 `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 (s PlayerAchievement) MarshalJSON() ([]byte, error)

type PlayerAchievementListResponse

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`.
	Kind string `json:"kind,omitempty"`
	// NextPageToken: Token corresponding to the next page of results.
	NextPageToken string `json:"nextPageToken,omitempty"`

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

PlayerAchievementListResponse: A list of achievement objects.

func (PlayerAchievementListResponse) MarshalJSON

func (s PlayerAchievementListResponse) MarshalJSON() ([]byte, error)

type PlayerEvent

type PlayerEvent struct {
	// DefinitionId: The ID of the event definition.
	DefinitionId string `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.
	FormattedNumEvents string `json:"formattedNumEvents,omitempty"`
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#playerEvent`.
	Kind string `json:"kind,omitempty"`
	// NumEvents: The current number of times this event has occurred.
	NumEvents int64 `json:"numEvents,omitempty,string"`
	// PlayerId: The ID of the player.
	PlayerId string `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 (s PlayerEvent) MarshalJSON() ([]byte, error)

type PlayerEventListResponse

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`.
	Kind string `json:"kind,omitempty"`
	// NextPageToken: The pagination token for the next page of results.
	NextPageToken string `json:"nextPageToken,omitempty"`

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

PlayerEventListResponse: A ListByPlayer response.

func (PlayerEventListResponse) MarshalJSON

func (s PlayerEventListResponse) MarshalJSON() ([]byte, error)

type PlayerExperienceInfo

type PlayerExperienceInfo struct {
	// CurrentExperiencePoints: The current number of experience points for the
	// player.
	CurrentExperiencePoints int64 `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`.
	Kind string `json:"kind,omitempty"`
	// LastLevelUpTimestampMillis: The timestamp when the player was leveled up, in
	// millis since Unix epoch UTC.
	LastLevelUpTimestampMillis int64 `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 (s PlayerExperienceInfo) MarshalJSON() ([]byte, error)

type PlayerLeaderboardScore

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`.
	Kind string `json:"kind,omitempty"`
	// LeaderboardId: The ID of the leaderboard this score is in.
	LeaderboardId string `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.
	ScoreString string `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 of RFC 3986.
	ScoreTag string `json:"scoreTag,omitempty"`
	// ScoreValue: The numerical value of this score.
	ScoreValue int64 `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.
	TimeSpan string `json:"timeSpan,omitempty"`
	// WriteTimestamp: The timestamp at which this score was recorded, in
	// milliseconds since the epoch in UTC.
	WriteTimestamp int64 `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 (s PlayerLeaderboardScore) MarshalJSON() ([]byte, error)

type PlayerLeaderboardScoreListResponse

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`.
	Kind string `json:"kind,omitempty"`
	// NextPageToken: The pagination token for the next page of results.
	NextPageToken string `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

func (s PlayerLeaderboardScoreListResponse) MarshalJSON() ([]byte, error)

type PlayerLevel

type PlayerLevel struct {
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#playerLevel`.
	Kind string `json:"kind,omitempty"`
	// Level: The level for the user.
	Level int64 `json:"level,omitempty"`
	// MaxExperiencePoints: The maximum experience points for this level.
	MaxExperiencePoints int64 `json:"maxExperiencePoints,omitempty,string"`
	// MinExperiencePoints: The minimum experience points for this level.
	MinExperiencePoints int64 `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 (s PlayerLevel) MarshalJSON() ([]byte, error)

type PlayerListResponse

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`.
	Kind string `json:"kind,omitempty"`
	// NextPageToken: Token corresponding to the next page of results.
	NextPageToken string `json:"nextPageToken,omitempty"`

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

PlayerListResponse: A third party player list response.

func (PlayerListResponse) MarshalJSON

func (s PlayerListResponse) MarshalJSON() ([]byte, error)

type PlayerName

type PlayerName struct {
	// FamilyName: The family name of this player. In some places, this is known as
	// the last name.
	FamilyName string `json:"familyName,omitempty"`
	// GivenName: The given name of this player. In some places, this is known as
	// the first name.
	GivenName string `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 (s PlayerName) MarshalJSON() ([]byte, error)

type PlayerScore

type PlayerScore struct {
	// FormattedScore: The formatted score for this player score.
	FormattedScore string `json:"formattedScore,omitempty"`
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#playerScore`.
	Kind string `json:"kind,omitempty"`
	// Score: The numerical value for this player score.
	Score int64 `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 of RFC 3986.
	ScoreTag string `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.
	TimeSpan string `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 (s PlayerScore) MarshalJSON() ([]byte, error)

type PlayerScoreListResponse

type PlayerScoreListResponse struct {
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#playerScoreListResponse`.
	Kind string `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 (s PlayerScoreListResponse) MarshalJSON() ([]byte, error)

type PlayerScoreResponse

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.
	FormattedScore string `json:"formattedScore,omitempty"`
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#playerScoreResponse`.
	Kind string `json:"kind,omitempty"`
	// LeaderboardId: The leaderboard ID that this score was submitted to.
	LeaderboardId string `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 of RFC 3986.
	ScoreTag string `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 (s PlayerScoreResponse) MarshalJSON() ([]byte, error)

type PlayerScoreSubmissionList

type PlayerScoreSubmissionList struct {
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#playerScoreSubmissionList`.
	Kind string `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 (s PlayerScoreSubmissionList) MarshalJSON() ([]byte, error)

type PlayersGetCall

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

func (*PlayersGetCall) Context

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

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

func (*PlayersGetCall) Do

func (c *PlayersGetCall) Do(opts ...googleapi.CallOption) (*Player, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*PlayersGetCall) Fields

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

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

func (*PlayersGetCall) Header

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

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

func (*PlayersGetCall) IfNoneMatch

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

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

func (*PlayersGetCall) Language

func (c *PlayersGetCall) Language(language string) *PlayersGetCall

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

func (*PlayersGetCall) PlayerIdConsistencyToken

func (c *PlayersGetCall) PlayerIdConsistencyToken(playerIdConsistencyToken string) *PlayersGetCall

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

type PlayersGetMultipleApplicationPlayerIdsCall

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

func (*PlayersGetMultipleApplicationPlayerIdsCall) ApplicationIds

ApplicationIds sets the optional parameter "applicationIds": Required. The application IDs from the Google Play developer console for the games to return scoped ids for.

func (*PlayersGetMultipleApplicationPlayerIdsCall) Context

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

func (*PlayersGetMultipleApplicationPlayerIdsCall) Do

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 a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*PlayersGetMultipleApplicationPlayerIdsCall) Fields

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

func (*PlayersGetMultipleApplicationPlayerIdsCall) Header

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

func (*PlayersGetMultipleApplicationPlayerIdsCall) IfNoneMatch

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

type PlayersGetScopedPlayerIdsCall

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

func (*PlayersGetScopedPlayerIdsCall) Context

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

func (*PlayersGetScopedPlayerIdsCall) Do

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 at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*PlayersGetScopedPlayerIdsCall) Fields

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

func (*PlayersGetScopedPlayerIdsCall) Header

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

func (*PlayersGetScopedPlayerIdsCall) IfNoneMatch

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

type PlayersListCall

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 at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*PlayersListCall) Fields

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

func (*PlayersListCall) Header

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

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

func (*PlayersListCall) IfNoneMatch

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

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

func (*PlayersListCall) Language

func (c *PlayersListCall) Language(language string) *PlayersListCall

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

func (*PlayersListCall) MaxResults

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

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

func (*PlayersListCall) PageToken

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

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

func (*PlayersListCall) Pages

func (c *PlayersListCall) Pages(ctx context.Context, f func(*PlayerListResponse) error) error

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

type PlayersService

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

func NewPlayersService

func NewPlayersService(s *Service) *PlayersService

func (*PlayersService) Get

func (r *PlayersService) Get(playerId string) *PlayersGetCall

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

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

func (*PlayersService) GetMultipleApplicationPlayerIds

func (r *PlayersService) GetMultipleApplicationPlayerIds() *PlayersGetMultipleApplicationPlayerIdsCall

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

func (*PlayersService) GetScopedPlayerIds

func (r *PlayersService) GetScopedPlayerIds() *PlayersGetScopedPlayerIdsCall

GetScopedPlayerIds: Retrieves scoped player identifiers for currently authenticated user.

func (*PlayersService) List

func (r *PlayersService) List(collection string) *PlayersListCall

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

- collection: Collection of players being retrieved.

type ProfileSettings

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.
	FriendsListVisibility string `json:"friendsListVisibility,omitempty"`
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#profileSettings`.
	Kind string `json:"kind,omitempty"`
	// ProfileVisible: Whether the player's profile is visible to the currently
	// signed in player.
	ProfileVisible bool `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 (s ProfileSettings) MarshalJSON() ([]byte, error)

type RecallGamesPlayerTokensCall

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

func (*RecallGamesPlayerTokensCall) ApplicationIds

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

ApplicationIds sets the optional parameter "applicationIds": Required. The application IDs from the Google Play developer console for the games to return scoped ids for.

func (*RecallGamesPlayerTokensCall) Context

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

func (*RecallGamesPlayerTokensCall) Do

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 response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*RecallGamesPlayerTokensCall) Fields

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

func (*RecallGamesPlayerTokensCall) Header

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

func (*RecallGamesPlayerTokensCall) IfNoneMatch

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

type RecallLastTokenFromAllDeveloperGamesCall

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

func (*RecallLastTokenFromAllDeveloperGamesCall) Context

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

func (*RecallLastTokenFromAllDeveloperGamesCall) Do

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

func (*RecallLastTokenFromAllDeveloperGamesCall) Fields

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

func (*RecallLastTokenFromAllDeveloperGamesCall) Header

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

func (*RecallLastTokenFromAllDeveloperGamesCall) IfNoneMatch

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

type RecallLinkPersonaCall

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

func (*RecallLinkPersonaCall) Context

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

func (*RecallLinkPersonaCall) Do

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 at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*RecallLinkPersonaCall) Fields

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

func (*RecallLinkPersonaCall) Header

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

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

type RecallResetPersonaCall

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

func (*RecallResetPersonaCall) Context

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

func (*RecallResetPersonaCall) Do

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 returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*RecallResetPersonaCall) Fields

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

func (*RecallResetPersonaCall) Header

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

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

type RecallRetrieveTokensCall

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

func (*RecallRetrieveTokensCall) Context

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

func (*RecallRetrieveTokensCall) Do

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 was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*RecallRetrieveTokensCall) Fields

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

func (*RecallRetrieveTokensCall) Header

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

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

func (*RecallRetrieveTokensCall) IfNoneMatch

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

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

type RecallService

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

func NewRecallService

func NewRecallService(s *Service) *RecallService

func (*RecallService) GamesPlayerTokens

func (r *RecallService) GamesPlayerTokens(sessionId string) *RecallGamesPlayerTokensCall

GamesPlayerTokens: Retrieve the Recall tokens from all requested games that is 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 necessary information to identify the PGS player / Google user and application.

func (*RecallService) LastTokenFromAllDeveloperGames

func (r *RecallService) LastTokenFromAllDeveloperGames(sessionId string) *RecallLastTokenFromAllDeveloperGamesCall

LastTokenFromAllDeveloperGames: Retrieve the last Recall token from all developer games that is associated with the PGS Player encoded in the provided recall session id. The API is only available for users that have active PGS Player profile.

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

func (*RecallService) LinkPersona

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

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

func (*RecallService) ResetPersona

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

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

func (*RecallService) RetrieveTokens

func (r *RecallService) RetrieveTokens(sessionId string) *RecallRetrieveTokensCall

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

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

func (*RecallService) UnlinkPersona

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

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

type RecallToken

type RecallToken struct {
	// ExpireTime: Optional. Optional expiration time of the token
	ExpireTime string `json:"expireTime,omitempty"`
	// MultiPlayerPersona: Required. Whether the persona identified by the token is
	// linked to multiple PGS Players
	MultiPlayerPersona bool `json:"multiPlayerPersona,omitempty"`
	// Token: Required. Value of the Recall token as it is provided by the client
	// via LinkPersona RPC
	Token string `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) MarshalJSON

func (s RecallToken) MarshalJSON() ([]byte, error)

type RecallUnlinkPersonaCall

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

func (*RecallUnlinkPersonaCall) Context

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

func (*RecallUnlinkPersonaCall) Do

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 returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*RecallUnlinkPersonaCall) Fields

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

func (*RecallUnlinkPersonaCall) Header

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

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

type ResetPersonaRequest

type ResetPersonaRequest struct {
	// Persona: Value of the 'persona' field as it was provided by the client in
	// LinkPersona RPC
	Persona string `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 a persona for an app.

func (ResetPersonaRequest) MarshalJSON

func (s ResetPersonaRequest) MarshalJSON() ([]byte, error)

type ResetPersonaResponse

type ResetPersonaResponse struct {
	// Unlinked: Required. Whether any tokens were unlinked as a result of this
	// request.
	Unlinked bool `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) MarshalJSON

func (s ResetPersonaResponse) MarshalJSON() ([]byte, error)

type RetrieveDeveloperGamesLastPlayerTokenResponse

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 returned from for the RetrieveDeveloperGamesLastPlayerToken RPC

func (RetrieveDeveloperGamesLastPlayerTokenResponse) MarshalJSON

type RetrieveGamesPlayerTokensResponse

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 from the RetrieveGamesPlayerTokens RPC

func (RetrieveGamesPlayerTokensResponse) MarshalJSON

func (s RetrieveGamesPlayerTokensResponse) MarshalJSON() ([]byte, error)

type RetrievePlayerTokensResponse

type RetrievePlayerTokensResponse struct {
	// Tokens: Required. Recall tokens associated with the requested PGS Player
	// principal
	Tokens []*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) MarshalJSON

func (s RetrievePlayerTokensResponse) MarshalJSON() ([]byte, error)

type RevisionCheckResponse

type RevisionCheckResponse struct {
	// ApiVersion: The version of the API this client revision should use when
	// calling API methods.
	ApiVersion string `json:"apiVersion,omitempty"`
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#revisionCheckResponse`.
	Kind string `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.
	RevisionStatus string `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 (s RevisionCheckResponse) MarshalJSON() ([]byte, error)

type RevisionsCheckCall

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 returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*RevisionsCheckCall) Fields

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

func (*RevisionsCheckCall) Header

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

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

func (*RevisionsCheckCall) IfNoneMatch

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

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

type RevisionsService

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

func NewRevisionsService

func NewRevisionsService(s *Service) *RevisionsService

func (*RevisionsService) Check

func (r *RevisionsService) Check(clientRevision string) *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 as a Web App.

type ScopedPlayerIds

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.
	DeveloperPlayerKey string `json:"developerPlayerKey,omitempty"`
	// GamePlayerId: Game-scoped player identifier. This is the same id that is
	// returned in GetPlayer game_player_id field.
	GamePlayerId string `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) MarshalJSON

func (s ScopedPlayerIds) MarshalJSON() ([]byte, error)

type ScoreSubmission

type ScoreSubmission struct {
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#scoreSubmission`.
	Kind string `json:"kind,omitempty"`
	// LeaderboardId: The leaderboard this score is being submitted to.
	LeaderboardId string `json:"leaderboardId,omitempty"`
	// Score: The new score being submitted.
	Score int64 `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 of RFC 3986.
	ScoreTag string `json:"scoreTag,omitempty"`
	// Signature: Signature Values will contain URI-safe characters as defined by
	// section 2.3 of RFC 3986.
	Signature string `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 (s ScoreSubmission) MarshalJSON() ([]byte, error)

type ScoresGetCall

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

func (*ScoresGetCall) Context

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

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 response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ScoresGetCall) Fields

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

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

func (*ScoresGetCall) Header

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

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

func (*ScoresGetCall) IfNoneMatch

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

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

func (*ScoresGetCall) IncludeRankType

func (c *ScoresGetCall) IncludeRankType(includeRankType string) *ScoresGetCall

IncludeRankType sets the optional parameter "includeRankType": The types of ranks 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(language string) *ScoresGetCall

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

func (*ScoresGetCall) MaxResults

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

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

func (*ScoresGetCall) PageToken

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

PageToken sets the optional parameter "pageToken": The token returned by the previous 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.

type ScoresListCall

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

func (*ScoresListCall) Context

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

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 at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ScoresListCall) Fields

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

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

func (*ScoresListCall) Header

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

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

func (*ScoresListCall) IfNoneMatch

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

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

func (*ScoresListCall) Language

func (c *ScoresListCall) Language(language string) *ScoresListCall

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

func (*ScoresListCall) MaxResults

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

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

func (*ScoresListCall) PageToken

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

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

func (*ScoresListCall) Pages

func (c *ScoresListCall) Pages(ctx context.Context, f func(*LeaderboardScores) error) error

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

type ScoresListWindowCall

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 at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ScoresListWindowCall) Fields

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

func (*ScoresListWindowCall) Header

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

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

func (*ScoresListWindowCall) IfNoneMatch

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

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

func (*ScoresListWindowCall) Language

func (c *ScoresListWindowCall) Language(language string) *ScoresListWindowCall

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

func (*ScoresListWindowCall) MaxResults

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

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

func (*ScoresListWindowCall) PageToken

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

PageToken sets the optional parameter "pageToken": The token returned by the previous 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(resultsAbove int64) *ScoresListWindowCall

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

func (*ScoresListWindowCall) ReturnTopIfAbsent

func (c *ScoresListWindowCall) ReturnTopIfAbsent(returnTopIfAbsent bool) *ScoresListWindowCall

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

type ScoresService

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

func NewScoresService

func NewScoresService(s *Service) *ScoresService

func (*ScoresService) Get

func (r *ScoresService) Get(playerId string, leaderboardId string, timeSpan string) *ScoresGetCall

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

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

func (*ScoresService) List

func (r *ScoresService) List(leaderboardId string, collection string, timeSpan string) *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(leaderboardId string, collection string, timeSpan string) *ScoresListWindowCall

ListWindow: Lists the scores in a leaderboard around (and including) a player'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(leaderboardId string, score int64) *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 it is worse than a previously submitted score, where worse depends on the leaderboard sort order. The meaning of the score value depends on the leaderboard format type. For fixed-point, the score represents the raw value. For time, the score represents elapsed time in milliseconds. For currency, the score represents a value in micro units.

func (*ScoresService) SubmitMultiple

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

SubmitMultiple: Submits multiple scores to leaderboards.

type ScoresSubmitCall

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 at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ScoresSubmitCall) Fields

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

func (*ScoresSubmitCall) Header

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

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

func (*ScoresSubmitCall) Language

func (c *ScoresSubmitCall) Language(language string) *ScoresSubmitCall

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

func (*ScoresSubmitCall) ScoreTag

func (c *ScoresSubmitCall) ScoreTag(scoreTag string) *ScoresSubmitCall

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

type ScoresSubmitMultipleCall

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 was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ScoresSubmitMultipleCall) Fields

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

func (*ScoresSubmitMultipleCall) Header

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

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

func (*ScoresSubmitMultipleCall) Language

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

type Service

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

	Accesstokens *AccesstokensService

	AchievementDefinitions *AchievementDefinitionsService

	Achievements *AchievementsService

	Applications *ApplicationsService

	Events *EventsService

	Leaderboards *LeaderboardsService

	Metagame *MetagameService

	Players *PlayersService

	Recall *RecallService

	Revisions *RevisionsService

	Scores *ScoresService

	Snapshots *SnapshotsService

	Stats *StatsService
	// contains filtered or unexported fields
}

func New deprecated

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

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

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

func NewService

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

NewService creates a new Service.

type Snapshot

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.
	Description string `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.
	DriveId string `json:"driveId,omitempty"`
	// DurationMillis: The duration associated with this snapshot, in millis.
	DurationMillis int64 `json:"durationMillis,omitempty,string"`
	// Id: The ID of the snapshot.
	Id string `json:"id,omitempty"`
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#snapshot`.
	Kind string `json:"kind,omitempty"`
	// LastModifiedMillis: The timestamp (in millis since Unix epoch) of the last
	// modification to this snapshot.
	LastModifiedMillis int64 `json:"lastModifiedMillis,omitempty,string"`
	// ProgressValue: The progress value (64-bit integer set by developer)
	// associated with this snapshot.
	ProgressValue int64 `json:"progressValue,omitempty,string"`
	// Title: The title of this snapshot.
	Title string `json:"title,omitempty"`
	// Type: The type of this snapshot.
	//
	// Possible values:
	//   "SAVE_GAME" - A snapshot representing a save game.
	Type string `json:"type,omitempty"`
	// UniqueName: The unique name provided when the snapshot was created.
	UniqueName string `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 (s Snapshot) MarshalJSON() ([]byte, error)

type SnapshotImage

type SnapshotImage struct {
	// Height: The height of the image.
	Height int64 `json:"height,omitempty"`
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#snapshotImage`.
	Kind string `json:"kind,omitempty"`
	// MimeType: The MIME type of the image.
	MimeType string `json:"mime_type,omitempty"`
	// Url: The URL of the image. This URL may be invalidated at any time and
	// should not be cached.
	Url string `json:"url,omitempty"`
	// Width: The width of the image.
	Width int64 `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 (s SnapshotImage) MarshalJSON() ([]byte, error)

type SnapshotListResponse

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`.
	Kind string `json:"kind,omitempty"`
	// NextPageToken: Token corresponding to the next page of results. If there are
	// no more results, the token is omitted.
	NextPageToken string `json:"nextPageToken,omitempty"`

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

SnapshotListResponse: A third party list snapshots response.

func (SnapshotListResponse) MarshalJSON

func (s SnapshotListResponse) MarshalJSON() ([]byte, error)

type SnapshotsGetCall

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

func (c *SnapshotsGetCall) Do(opts ...googleapi.CallOption) (*Snapshot, error)

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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*SnapshotsGetCall) Fields

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

func (*SnapshotsGetCall) Header

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

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

func (*SnapshotsGetCall) IfNoneMatch

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

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

func (*SnapshotsGetCall) Language

func (c *SnapshotsGetCall) Language(language string) *SnapshotsGetCall

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

type SnapshotsListCall

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 returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*SnapshotsListCall) Fields

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

func (*SnapshotsListCall) Header

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

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

func (*SnapshotsListCall) IfNoneMatch

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

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

func (*SnapshotsListCall) Language

func (c *SnapshotsListCall) Language(language string) *SnapshotsListCall

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

func (*SnapshotsListCall) MaxResults

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

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

func (*SnapshotsListCall) PageToken

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

PageToken sets the optional parameter "pageToken": The token returned by the previous 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.

type SnapshotsService

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

func NewSnapshotsService

func NewSnapshotsService(s *Service) *SnapshotsService

func (*SnapshotsService) Get

func (r *SnapshotsService) Get(snapshotId string) *SnapshotsGetCall

Get: Retrieves the metadata for a given snapshot ID.

- snapshotId: The ID of the snapshot.

func (*SnapshotsService) List

func (r *SnapshotsService) List(playerId string) *SnapshotsListCall

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

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

type StatsGetCall

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

func (*StatsGetCall) Context

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

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

func (*StatsGetCall) Do

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 check whether the returned error was because http.StatusNotModified was returned.

func (*StatsGetCall) Fields

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

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

func (*StatsGetCall) Header

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

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

func (*StatsGetCall) IfNoneMatch

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

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

type StatsResponse

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.
	AvgSessionLengthMinutes float64 `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.
	ChurnProbability float64 `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.
	DaysSinceLastPlayed int64 `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.
	HighSpenderProbability float64 `json:"high_spender_probability,omitempty"`
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `games#statsResponse`.
	Kind string `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.
	NumPurchases int64 `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.
	NumSessions int64 `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.
	NumSessionsPercentile float64 `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.
	SpendPercentile float64 `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.
	SpendProbability float64 `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.
	TotalSpendNext28Days float64 `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) MarshalJSON

func (s StatsResponse) MarshalJSON() ([]byte, error)

func (*StatsResponse) UnmarshalJSON

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

type StatsService

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

func NewStatsService

func NewStatsService(s *Service) *StatsService

func (*StatsService) Get

func (r *StatsService) Get() *StatsGetCall

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

type UnlinkPersonaRequest

type UnlinkPersonaRequest struct {
	// Persona: Value of the 'persona' field as it was provided by the client in
	// LinkPersona RPC
	Persona string `json:"persona,omitempty"`
	// SessionId: Required. Opaque server-generated string that encodes all the
	// necessary information to identify the PGS player / Google user and
	// application.
	SessionId string `json:"sessionId,omitempty"`
	// Token: Value of the Recall token as it was provided by the client in
	// LinkPersona RPC
	Token string `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 principal and an in-game account

func (UnlinkPersonaRequest) MarshalJSON

func (s UnlinkPersonaRequest) MarshalJSON() ([]byte, error)

type UnlinkPersonaResponse

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.
	Unlinked bool `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) MarshalJSON

func (s UnlinkPersonaResponse) MarshalJSON() ([]byte, error)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL