gamesmanagement

package
v0.211.0 Latest Latest
Warning

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

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

Documentation

Overview

Package gamesmanagement provides access to the Google Play Game Management.

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/gamesmanagement/v1management"
...
ctx := context.Background()
gamesmanagementService, err := gamesmanagement.NewService(ctx)

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

Other authentication options

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

gamesmanagementService, err := gamesmanagement.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, ...)
gamesmanagementService, err := gamesmanagement.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

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

Index

Constants

View Source 
const (
	// 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 AchievementResetAllResponse 

type AchievementResetAllResponse struct {
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `gamesManagement#achievementResetAllResponse`.
	Kind string `json:"kind,omitempty"`
	// Results: The achievement reset results.
	Results []*AchievementResetResponse `json:"results,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:"-"`
}

AchievementResetAllResponse: Achievement reset all response.

func (AchievementResetAllResponse) MarshalJSON 

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

type AchievementResetMultipleForAllRequest 

type AchievementResetMultipleForAllRequest struct {
	// AchievementIds: The IDs of achievements to reset.
	AchievementIds []string `json:"achievement_ids,omitempty"`
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `gamesManagement#achievementResetMultipleForAllRequest`.
	Kind string `json:"kind,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AchievementIds") 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. "AchievementIds") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (AchievementResetMultipleForAllRequest) MarshalJSON 

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

type AchievementResetResponse 

type AchievementResetResponse struct {
	// CurrentState: The current state of the achievement. This is the same as the
	// initial state of the achievement. Possible values are: - "HIDDEN"-
	// Achievement is hidden. - "REVEALED" - Achievement is revealed. -
	// "UNLOCKED" - Achievement is unlocked.
	CurrentState string `json:"currentState,omitempty"`
	// DefinitionId: The ID of an achievement for which player state has been
	// updated.
	DefinitionId string `json:"definitionId,omitempty"`
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `gamesManagement#achievementResetResponse`.
	Kind string `json:"kind,omitempty"`
	// UpdateOccurred: Flag to indicate if the requested update actually occurred.
	UpdateOccurred bool `json:"updateOccurred,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:"-"`
}

AchievementResetResponse: An achievement reset response.

func (AchievementResetResponse) MarshalJSON 

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

type AchievementsResetAllCall 

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

func (*AchievementsResetAllCall) Context 

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

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

func (*AchievementsResetAllCall) Do 

func (c *AchievementsResetAllCall) Do(opts ...googleapi.CallOption) (*AchievementResetAllResponse, error)

Do executes the "gamesManagement.achievements.resetAll" call. Any non-2xx status code is an error. Response headers are in either *AchievementResetAllResponse.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 (*AchievementsResetAllCall) Fields 

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

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

func (*AchievementsResetAllCall) Header 

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

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

type AchievementsResetAllForAllPlayersCall 

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

func (*AchievementsResetAllForAllPlayersCall) Context 

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

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

func (*AchievementsResetAllForAllPlayersCall) Do 

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

Do executes the "gamesManagement.achievements.resetAllForAllPlayers" call.

func (*AchievementsResetAllForAllPlayersCall) Fields 

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

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

func (*AchievementsResetAllForAllPlayersCall) Header 

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

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

type AchievementsResetCall 

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

func (*AchievementsResetCall) Context 

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

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

func (*AchievementsResetCall) Do 

func (c *AchievementsResetCall) Do(opts ...googleapi.CallOption) (*AchievementResetResponse, error)

Do executes the "gamesManagement.achievements.reset" call. Any non-2xx status code is an error. Response headers are in either *AchievementResetResponse.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 (*AchievementsResetCall) Fields 

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

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

func (*AchievementsResetCall) Header 

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

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

type AchievementsResetForAllPlayersCall 

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

func (*AchievementsResetForAllPlayersCall) Context 

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

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

func (*AchievementsResetForAllPlayersCall) Do 

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

Do executes the "gamesManagement.achievements.resetForAllPlayers" call.

func (*AchievementsResetForAllPlayersCall) Fields 

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

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

func (*AchievementsResetForAllPlayersCall) Header 

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

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

type AchievementsResetMultipleForAllPlayersCall 

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

func (*AchievementsResetMultipleForAllPlayersCall) Context 

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

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

func (*AchievementsResetMultipleForAllPlayersCall) Do 

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

Do executes the "gamesManagement.achievements.resetMultipleForAllPlayers" call.

func (*AchievementsResetMultipleForAllPlayersCall) Fields 

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

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

func (*AchievementsResetMultipleForAllPlayersCall) Header 

func (c *AchievementsResetMultipleForAllPlayersCall) 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) Reset 

func (r *AchievementsService) Reset(achievementId string) *AchievementsResetCall

Reset: Resets the achievement with the given ID for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application.

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

func (*AchievementsService) ResetAll 

func (r *AchievementsService) ResetAll() *AchievementsResetAllCall

ResetAll: Resets all achievements for the currently authenticated player for your application. This method is only accessible to whitelisted tester accounts for your application.

func (*AchievementsService) ResetAllForAllPlayers 

func (r *AchievementsService) ResetAllForAllPlayers() *AchievementsResetAllForAllPlayersCall

ResetAllForAllPlayers: Resets all draft achievements for all players. This method is only available to user accounts for your developer console.

func (*AchievementsService) ResetForAllPlayers 

func (r *AchievementsService) ResetForAllPlayers(achievementId string) *AchievementsResetForAllPlayersCall

ResetForAllPlayers: Resets the achievement with the given ID for all players. This method is only available to user accounts for your developer console. Only draft achievements can be reset.

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

func (*AchievementsService) ResetMultipleForAllPlayers 

func (r *AchievementsService) ResetMultipleForAllPlayers(achievementresetmultipleforallrequest *AchievementResetMultipleForAllRequest) *AchievementsResetMultipleForAllPlayersCall

ResetMultipleForAllPlayers: Resets achievements with the given IDs for all players. This method is only available to user accounts for your developer console. Only draft achievements may be reset.

type ApplicationsListHiddenCall 

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

func (*ApplicationsListHiddenCall) Context 

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

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

func (*ApplicationsListHiddenCall) Do 

func (c *ApplicationsListHiddenCall) Do(opts ...googleapi.CallOption) (*HiddenPlayerList, error)

Do executes the "gamesManagement.applications.listHidden" call. Any non-2xx status code is an error. Response headers are in either *HiddenPlayerList.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 (*ApplicationsListHiddenCall) Fields 

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

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

func (*ApplicationsListHiddenCall) Header 

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

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

func (*ApplicationsListHiddenCall) IfNoneMatch 

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

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 (*ApplicationsListHiddenCall) MaxResults 

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

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 (*ApplicationsListHiddenCall) PageToken 

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

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

func (*ApplicationsListHiddenCall) Pages 

func (c *ApplicationsListHiddenCall) Pages(ctx context.Context, f func(*HiddenPlayerList) 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 ApplicationsService 

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

func NewApplicationsService 

func NewApplicationsService(s *Service) *ApplicationsService

func (*ApplicationsService) ListHidden 

func (r *ApplicationsService) ListHidden(applicationId string) *ApplicationsListHiddenCall

ListHidden: Get the list of players hidden from the given application. This method is only available to user accounts for your developer console.

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

type EventsResetAllCall 

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

func (*EventsResetAllCall) Context 

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

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

func (*EventsResetAllCall) Do 

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

Do executes the "gamesManagement.events.resetAll" call.

func (*EventsResetAllCall) Fields 

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

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

func (*EventsResetAllCall) Header 

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

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

type EventsResetAllForAllPlayersCall 

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

func (*EventsResetAllForAllPlayersCall) Context 

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

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

func (*EventsResetAllForAllPlayersCall) Do 

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

Do executes the "gamesManagement.events.resetAllForAllPlayers" call.

func (*EventsResetAllForAllPlayersCall) Fields 

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

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

func (*EventsResetAllForAllPlayersCall) Header 

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

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

type EventsResetCall 

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

func (*EventsResetCall) Context 

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

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

func (*EventsResetCall) Do 

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

Do executes the "gamesManagement.events.reset" call.

func (*EventsResetCall) Fields 

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

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

func (*EventsResetCall) Header 

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

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

type EventsResetForAllPlayersCall 

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

func (*EventsResetForAllPlayersCall) Context 

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

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

func (*EventsResetForAllPlayersCall) Do 

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

Do executes the "gamesManagement.events.resetForAllPlayers" call.

func (*EventsResetForAllPlayersCall) Fields 

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

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

func (*EventsResetForAllPlayersCall) Header 

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

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

type EventsResetMultipleForAllPlayersCall 

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

func (*EventsResetMultipleForAllPlayersCall) Context 

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

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

func (*EventsResetMultipleForAllPlayersCall) Do 

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

Do executes the "gamesManagement.events.resetMultipleForAllPlayers" call.

func (*EventsResetMultipleForAllPlayersCall) Fields 

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

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

func (*EventsResetMultipleForAllPlayersCall) Header 

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

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

type EventsResetMultipleForAllRequest 

type EventsResetMultipleForAllRequest struct {
	// EventIds: The IDs of events to reset.
	EventIds []string `json:"event_ids,omitempty"`
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `gamesManagement#eventsResetMultipleForAllRequest`.
	Kind string `json:"kind,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EventIds") 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. "EventIds") 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:"-"`
}

EventsResetMultipleForAllRequest: Multiple events reset all request.

func (EventsResetMultipleForAllRequest) MarshalJSON 

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

type EventsService 

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

func NewEventsService 

func NewEventsService(s *Service) *EventsService

func (*EventsService) Reset 

func (r *EventsService) Reset(eventId string) *EventsResetCall

Reset: Resets all player progress on the event with the given ID for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application.

- eventId: The ID of the event.

func (*EventsService) ResetAll 

func (r *EventsService) ResetAll() *EventsResetAllCall

ResetAll: Resets all player progress on all events for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application.

func (*EventsService) ResetAllForAllPlayers 

func (r *EventsService) ResetAllForAllPlayers() *EventsResetAllForAllPlayersCall

ResetAllForAllPlayers: Resets all draft events for all players. This method is only available to user accounts for your developer console.

func (*EventsService) ResetForAllPlayers 

func (r *EventsService) ResetForAllPlayers(eventId string) *EventsResetForAllPlayersCall

ResetForAllPlayers: Resets the event with the given ID for all players. This method is only available to user accounts for your developer console. Only draft events can be reset.

- eventId: The ID of the event.

func (*EventsService) ResetMultipleForAllPlayers 

func (r *EventsService) ResetMultipleForAllPlayers(eventsresetmultipleforallrequest *EventsResetMultipleForAllRequest) *EventsResetMultipleForAllPlayersCall

ResetMultipleForAllPlayers: Resets events with the given IDs for all players. This method is only available to user accounts for your developer console. Only draft events may be reset.

type GamesPlayerExperienceInfoResource 

type GamesPlayerExperienceInfoResource 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 *GamesPlayerLevelResource `json:"currentLevel,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 *GamesPlayerLevelResource `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:"-"`
}

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

func (GamesPlayerExperienceInfoResource) MarshalJSON 

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

type GamesPlayerLevelResource 

type GamesPlayerLevelResource struct {
	// 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. "Level") 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. "Level") 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:"-"`
}

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

func (GamesPlayerLevelResource) MarshalJSON 

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

type HiddenPlayer 

type HiddenPlayer struct {
	// HiddenTimeMillis: Output only. The time this player was hidden.
	HiddenTimeMillis int64 `json:"hiddenTimeMillis,omitempty,string"`
	// Kind: Output only. Uniquely identifies the type of this resource. Value is
	// always the fixed string `gamesManagement#hiddenPlayer`.
	Kind string `json:"kind,omitempty"`
	// Player: Output only. The player information.
	Player *Player `json:"player,omitempty"`
	// ForceSendFields is a list of field names (e.g. "HiddenTimeMillis") 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. "HiddenTimeMillis") 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:"-"`
}

HiddenPlayer: The HiddenPlayer resource.

func (HiddenPlayer) MarshalJSON 

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

type HiddenPlayerList 

type HiddenPlayerList struct {
	// Items: The players.
	Items []*HiddenPlayer `json:"items,omitempty"`
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `gamesManagement#hiddenPlayerList`.
	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:"-"`
}

HiddenPlayerList: A list of hidden players.

func (HiddenPlayerList) MarshalJSON 

func (s HiddenPlayerList) 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 *GamesPlayerExperienceInfoResource `json:"experienceInfo,omitempty"`
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `gamesManagement#player`.
	Kind string `json:"kind,omitempty"`
	// Name: An object representation of the individual components of the player's
	// name. For some players, these fields may not be present.
	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"`
	// 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 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: An object representation of the individual components of the player's name. For some players, these fields may not be present.

func (PlayerName) MarshalJSON 

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

type PlayerScoreResetAllResponse 

type PlayerScoreResetAllResponse struct {
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `gamesManagement#playerScoreResetAllResponse`.
	Kind string `json:"kind,omitempty"`
	// Results: The leaderboard reset results.
	Results []*PlayerScoreResetResponse `json:"results,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:"-"`
}

PlayerScoreResetAllResponse: A list of leaderboard reset resources.

func (PlayerScoreResetAllResponse) MarshalJSON 

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

type PlayerScoreResetResponse 

type PlayerScoreResetResponse struct {
	// DefinitionId: The ID of an leaderboard for which player state has been
	// updated.
	DefinitionId string `json:"definitionId,omitempty"`
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `gamesManagement#playerScoreResetResponse`.
	Kind string `json:"kind,omitempty"`
	// ResetScoreTimeSpans: The time spans of the updated score. Possible values
	// are: - "ALL_TIME" - The score is an all-time score. - "WEEKLY" - The
	// score is a weekly score. - "DAILY" - The score is a daily score.
	ResetScoreTimeSpans []string `json:"resetScoreTimeSpans,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// 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:"-"`
}

PlayerScoreResetResponse: A list of reset leaderboard entry resources.

func (PlayerScoreResetResponse) MarshalJSON 

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

type PlayersHideCall 

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

func (*PlayersHideCall) Context 

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

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

func (*PlayersHideCall) Do 

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

Do executes the "gamesManagement.players.hide" call.

func (*PlayersHideCall) Fields 

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

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

func (*PlayersHideCall) Header 

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

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

type PlayersService 

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

func NewPlayersService 

func NewPlayersService(s *Service) *PlayersService

func (*PlayersService) Hide 

func (r *PlayersService) Hide(applicationId string, playerId string) *PlayersHideCall

Hide: Hide the given player's leaderboard scores from the given application. This method is only available to user accounts for your developer console.

  • applicationId: The application ID from the Google Play developer console.
  • playerId: A player ID. A value of `me` may be used in place of the authenticated player's ID.

func (*PlayersService) Unhide 

func (r *PlayersService) Unhide(applicationId string, playerId string) *PlayersUnhideCall

Unhide: Unhide the given player's leaderboard scores from the given application. This method is only available to user accounts for your developer console.

  • applicationId: The application ID from the Google Play developer console.
  • playerId: A player ID. A value of `me` may be used in place of the authenticated player's ID.

type PlayersUnhideCall 

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

func (*PlayersUnhideCall) Context 

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

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

func (*PlayersUnhideCall) Do 

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

Do executes the "gamesManagement.players.unhide" call.

func (*PlayersUnhideCall) Fields 

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

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

func (*PlayersUnhideCall) Header 

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

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

type ProfileSettings 

type ProfileSettings struct {
	// Kind: Uniquely identifies the type of this resource. Value is always the
	// fixed string `gamesManagement#profileSettings`.
	Kind           string `json:"kind,omitempty"`
	ProfileVisible bool   `json:"profileVisible,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:"-"`
}

ProfileSettings: Profile settings

func (ProfileSettings) MarshalJSON 

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

type ScoresResetAllCall 

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

func (*ScoresResetAllCall) Context 

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

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

func (*ScoresResetAllCall) Do 

func (c *ScoresResetAllCall) Do(opts ...googleapi.CallOption) (*PlayerScoreResetAllResponse, error)

Do executes the "gamesManagement.scores.resetAll" call. Any non-2xx status code is an error. Response headers are in either *PlayerScoreResetAllResponse.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 (*ScoresResetAllCall) Fields 

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

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

func (*ScoresResetAllCall) Header 

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

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

type ScoresResetAllForAllPlayersCall 

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

func (*ScoresResetAllForAllPlayersCall) Context 

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

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

func (*ScoresResetAllForAllPlayersCall) Do 

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

Do executes the "gamesManagement.scores.resetAllForAllPlayers" call.

func (*ScoresResetAllForAllPlayersCall) Fields 

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

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

func (*ScoresResetAllForAllPlayersCall) Header 

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

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

type ScoresResetCall 

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

func (*ScoresResetCall) Context 

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

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

func (*ScoresResetCall) Do 

func (c *ScoresResetCall) Do(opts ...googleapi.CallOption) (*PlayerScoreResetResponse, error)

Do executes the "gamesManagement.scores.reset" call. Any non-2xx status code is an error. Response headers are in either *PlayerScoreResetResponse.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 (*ScoresResetCall) Fields 

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

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

func (*ScoresResetCall) Header 

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

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

type ScoresResetForAllPlayersCall 

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

func (*ScoresResetForAllPlayersCall) Context 

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

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

func (*ScoresResetForAllPlayersCall) Do 

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

Do executes the "gamesManagement.scores.resetForAllPlayers" call.

func (*ScoresResetForAllPlayersCall) Fields 

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

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

func (*ScoresResetForAllPlayersCall) Header 

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

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

type ScoresResetMultipleForAllPlayersCall 

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

func (*ScoresResetMultipleForAllPlayersCall) Context 

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

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

func (*ScoresResetMultipleForAllPlayersCall) Do 

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

Do executes the "gamesManagement.scores.resetMultipleForAllPlayers" call.

func (*ScoresResetMultipleForAllPlayersCall) Fields 

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

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

func (*ScoresResetMultipleForAllPlayersCall) Header 

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

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

type ScoresResetMultipleForAllRequest 

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

func (ScoresResetMultipleForAllRequest) MarshalJSON 

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

type ScoresService 

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

func NewScoresService 

func NewScoresService(s *Service) *ScoresService

func (*ScoresService) Reset 

func (r *ScoresService) Reset(leaderboardId string) *ScoresResetCall

Reset: Resets scores for the leaderboard with the given ID for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application.

- leaderboardId: The ID of the leaderboard.

func (*ScoresService) ResetAll 

func (r *ScoresService) ResetAll() *ScoresResetAllCall

ResetAll: Resets all scores for all leaderboards for the currently authenticated players. This method is only accessible to whitelisted tester accounts for your application.

func (*ScoresService) ResetAllForAllPlayers 

func (r *ScoresService) ResetAllForAllPlayers() *ScoresResetAllForAllPlayersCall

ResetAllForAllPlayers: Resets scores for all draft leaderboards for all players. This method is only available to user accounts for your developer console.

func (*ScoresService) ResetForAllPlayers 

func (r *ScoresService) ResetForAllPlayers(leaderboardId string) *ScoresResetForAllPlayersCall

ResetForAllPlayers: Resets scores for the leaderboard with the given ID for all players. This method is only available to user accounts for your developer console. Only draft leaderboards can be reset.

- leaderboardId: The ID of the leaderboard.

func (*ScoresService) ResetMultipleForAllPlayers 

func (r *ScoresService) ResetMultipleForAllPlayers(scoresresetmultipleforallrequest *ScoresResetMultipleForAllRequest) *ScoresResetMultipleForAllPlayersCall

ResetMultipleForAllPlayers: Resets scores for the leaderboards with the given IDs for all players. This method is only available to user accounts for your developer console. Only draft leaderboards may be reset.

type Service 

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

	Achievements *AchievementsService

	Applications *ApplicationsService

	Events *EventsService

	Players *PlayersService

	Scores *ScoresService
	// 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 added in v0.3.0 

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

NewService creates a new Service.

Source Files

View all Source files

Jump to

Keyboard shortcuts

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