Package games
Overview ▹
Index ▹
Constants
OAuth2 scopes used by this API.
const ( // View and manage its own configuration data in your Google Drive DriveAppdataScope = "https://www.googleapis.com/auth/drive.appdata" // Share your Google+ profile information and view and manage your game // activity GamesScope = "https://www.googleapis.com/auth/games" // Know the list of people in your circles, your age range, and language PlusLoginScope = "https://www.googleapis.com/auth/plus.login" )
type AchievementDefinition ¶
AchievementDefinition: This is a JSON template for an achievement definition object.
type AchievementDefinition struct { // AchievementType: The type of the achievement. // Possible values are: // - "STANDARD" - Achievement is either locked or unlocked. // - "INCREMENTAL" - Achievement is incremental. AchievementType string `json:"achievementType,omitempty"` // 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 are: // - "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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AchievementType") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*AchievementDefinition) MarshalJSON ¶
func (s *AchievementDefinition) MarshalJSON() ([]byte, error)
type AchievementDefinitionsListCall ¶
type AchievementDefinitionsListCall struct {
// contains filtered or unexported fields
}
func (*AchievementDefinitionsListCall) ConsistencyToken ¶
func (c *AchievementDefinitionsListCall) ConsistencyToken(consistencyToken int64) *AchievementDefinitionsListCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*AchievementDefinitionsListCall) Context ¶
func (c *AchievementDefinitionsListCall) Context(ctx context.Context) *AchievementDefinitionsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*AchievementDefinitionsListCall) Do ¶
func (c *AchievementDefinitionsListCall) Do(opts ...googleapi.CallOption) (*AchievementDefinitionsListResponse, error)
Do executes the "games.achievementDefinitions.list" call. Exactly one of *AchievementDefinitionsListResponse or error will be non-nil. 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 ¶
func (c *AchievementDefinitionsListCall) Fields(s ...googleapi.Field) *AchievementDefinitionsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*AchievementDefinitionsListCall) Header ¶
func (c *AchievementDefinitionsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*AchievementDefinitionsListCall) IfNoneMatch ¶
func (c *AchievementDefinitionsListCall) IfNoneMatch(entityTag string) *AchievementDefinitionsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*AchievementDefinitionsListCall) Language ¶
func (c *AchievementDefinitionsListCall) Language(language string) *AchievementDefinitionsListCall
Language sets the optional parameter "language": The preferred language to use for strings returned by this method.
func (*AchievementDefinitionsListCall) MaxResults ¶
func (c *AchievementDefinitionsListCall) MaxResults(maxResults int64) *AchievementDefinitionsListCall
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 ¶
func (c *AchievementDefinitionsListCall) PageToken(pageToken string) *AchievementDefinitionsListCall
PageToken sets the optional parameter "pageToken": The token returned by the previous request.
func (*AchievementDefinitionsListCall) Pages ¶
func (c *AchievementDefinitionsListCall) Pages(ctx context.Context, f func(*AchievementDefinitionsListResponse) 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 AchievementDefinitionsListResponse ¶
AchievementDefinitionsListResponse: This is a JSON template for a list of achievement definition objects.
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Items") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
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 ¶
func (r *AchievementDefinitionsService) List() *AchievementDefinitionsListCall
List: Lists all the achievement definitions for your application.
type AchievementIncrementResponse ¶
AchievementIncrementResponse: This is a JSON template for an achievement increment response
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CurrentSteps") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*AchievementIncrementResponse) MarshalJSON ¶
func (s *AchievementIncrementResponse) MarshalJSON() ([]byte, error)
type AchievementRevealResponse ¶
AchievementRevealResponse: This is a JSON template for an achievement reveal response
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 are: // - "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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CurrentState") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*AchievementRevealResponse) MarshalJSON ¶
func (s *AchievementRevealResponse) MarshalJSON() ([]byte, error)
type AchievementSetStepsAtLeastResponse ¶
AchievementSetStepsAtLeastResponse: This is a JSON template for an achievement set steps at least response.
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 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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CurrentSteps") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*AchievementSetStepsAtLeastResponse) MarshalJSON ¶
func (s *AchievementSetStepsAtLeastResponse) MarshalJSON() ([]byte, error)
type AchievementUnlockResponse ¶
AchievementUnlockResponse: This is a JSON template for an achievement unlock response
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Kind") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*AchievementUnlockResponse) MarshalJSON ¶
func (s *AchievementUnlockResponse) MarshalJSON() ([]byte, error)
type AchievementUpdateMultipleRequest ¶
AchievementUpdateMultipleRequest: This is a JSON template for a list of achievement update requests.
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Kind") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*AchievementUpdateMultipleRequest) MarshalJSON ¶
func (s *AchievementUpdateMultipleRequest) MarshalJSON() ([]byte, error)
type AchievementUpdateMultipleResponse ¶
AchievementUpdateMultipleResponse: This is a JSON template for an achievement unlock response.
type AchievementUpdateMultipleResponse struct { // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#achievementUpdateListResponse. 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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Kind") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*AchievementUpdateMultipleResponse) MarshalJSON ¶
func (s *AchievementUpdateMultipleResponse) MarshalJSON() ([]byte, error)
type AchievementUpdateRequest ¶
AchievementUpdateRequest: This is a JSON template for a request to update an achievement.
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 are: // - "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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AchievementId") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*AchievementUpdateRequest) MarshalJSON ¶
func (s *AchievementUpdateRequest) MarshalJSON() ([]byte, error)
type AchievementUpdateResponse ¶
AchievementUpdateResponse: This is a JSON template for an achievement update response.
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 are: // - "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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AchievementId") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*AchievementUpdateResponse) MarshalJSON ¶
func (s *AchievementUpdateResponse) MarshalJSON() ([]byte, error)
type AchievementsIncrementCall ¶
type AchievementsIncrementCall struct {
// contains filtered or unexported fields
}
func (*AchievementsIncrementCall) ConsistencyToken ¶
func (c *AchievementsIncrementCall) ConsistencyToken(consistencyToken int64) *AchievementsIncrementCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*AchievementsIncrementCall) Context ¶
func (c *AchievementsIncrementCall) Context(ctx context.Context) *AchievementsIncrementCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*AchievementsIncrementCall) Do ¶
func (c *AchievementsIncrementCall) Do(opts ...googleapi.CallOption) (*AchievementIncrementResponse, error)
Do executes the "games.achievements.increment" call. Exactly one of *AchievementIncrementResponse or error will be non-nil. 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 ¶
func (c *AchievementsIncrementCall) Fields(s ...googleapi.Field) *AchievementsIncrementCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*AchievementsIncrementCall) Header ¶
func (c *AchievementsIncrementCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*AchievementsIncrementCall) RequestId ¶
func (c *AchievementsIncrementCall) RequestId(requestId int64) *AchievementsIncrementCall
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) ConsistencyToken ¶
func (c *AchievementsListCall) ConsistencyToken(consistencyToken int64) *AchievementsListCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*AchievementsListCall) Context ¶
func (c *AchievementsListCall) Context(ctx context.Context) *AchievementsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*AchievementsListCall) Do ¶
func (c *AchievementsListCall) Do(opts ...googleapi.CallOption) (*PlayerAchievementListResponse, error)
Do executes the "games.achievements.list" call. Exactly one of *PlayerAchievementListResponse or error will be non-nil. 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 ¶
func (c *AchievementsListCall) Fields(s ...googleapi.Field) *AchievementsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*AchievementsListCall) Header ¶
func (c *AchievementsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*AchievementsListCall) IfNoneMatch ¶
func (c *AchievementsListCall) IfNoneMatch(entityTag string) *AchievementsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*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 ¶
func (c *AchievementsListCall) Pages(ctx context.Context, f func(*PlayerAchievementListResponse) 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.
func (*AchievementsListCall) State ¶
func (c *AchievementsListCall) State(state string) *AchievementsListCall
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) ConsistencyToken ¶
func (c *AchievementsRevealCall) ConsistencyToken(consistencyToken int64) *AchievementsRevealCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*AchievementsRevealCall) Context ¶
func (c *AchievementsRevealCall) Context(ctx context.Context) *AchievementsRevealCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*AchievementsRevealCall) Do ¶
func (c *AchievementsRevealCall) Do(opts ...googleapi.CallOption) (*AchievementRevealResponse, error)
Do executes the "games.achievements.reveal" call. Exactly one of *AchievementRevealResponse or error will be non-nil. 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 ¶
func (c *AchievementsRevealCall) Fields(s ...googleapi.Field) *AchievementsRevealCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*AchievementsRevealCall) Header ¶
func (c *AchievementsRevealCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP 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.
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.
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.
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.
func (*AchievementsService) Unlock ¶
func (r *AchievementsService) Unlock(achievementId string) *AchievementsUnlockCall
Unlock: Unlocks this achievement for the currently authenticated player.
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) ConsistencyToken ¶
func (c *AchievementsSetStepsAtLeastCall) ConsistencyToken(consistencyToken int64) *AchievementsSetStepsAtLeastCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*AchievementsSetStepsAtLeastCall) Context ¶
func (c *AchievementsSetStepsAtLeastCall) Context(ctx context.Context) *AchievementsSetStepsAtLeastCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*AchievementsSetStepsAtLeastCall) Do ¶
func (c *AchievementsSetStepsAtLeastCall) Do(opts ...googleapi.CallOption) (*AchievementSetStepsAtLeastResponse, error)
Do executes the "games.achievements.setStepsAtLeast" call. Exactly one of *AchievementSetStepsAtLeastResponse or error will be non-nil. 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 ¶
func (c *AchievementsSetStepsAtLeastCall) Fields(s ...googleapi.Field) *AchievementsSetStepsAtLeastCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*AchievementsSetStepsAtLeastCall) Header ¶
func (c *AchievementsSetStepsAtLeastCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type AchievementsUnlockCall ¶
type AchievementsUnlockCall struct {
// contains filtered or unexported fields
}
func (*AchievementsUnlockCall) ConsistencyToken ¶
func (c *AchievementsUnlockCall) ConsistencyToken(consistencyToken int64) *AchievementsUnlockCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*AchievementsUnlockCall) Context ¶
func (c *AchievementsUnlockCall) Context(ctx context.Context) *AchievementsUnlockCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*AchievementsUnlockCall) Do ¶
func (c *AchievementsUnlockCall) Do(opts ...googleapi.CallOption) (*AchievementUnlockResponse, error)
Do executes the "games.achievements.unlock" call. Exactly one of *AchievementUnlockResponse or error will be non-nil. 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 ¶
func (c *AchievementsUnlockCall) Fields(s ...googleapi.Field) *AchievementsUnlockCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*AchievementsUnlockCall) Header ¶
func (c *AchievementsUnlockCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type AchievementsUpdateMultipleCall ¶
type AchievementsUpdateMultipleCall struct {
// contains filtered or unexported fields
}
func (*AchievementsUpdateMultipleCall) ConsistencyToken ¶
func (c *AchievementsUpdateMultipleCall) ConsistencyToken(consistencyToken int64) *AchievementsUpdateMultipleCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*AchievementsUpdateMultipleCall) Context ¶
func (c *AchievementsUpdateMultipleCall) Context(ctx context.Context) *AchievementsUpdateMultipleCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*AchievementsUpdateMultipleCall) Do ¶
func (c *AchievementsUpdateMultipleCall) Do(opts ...googleapi.CallOption) (*AchievementUpdateMultipleResponse, error)
Do executes the "games.achievements.updateMultiple" call. Exactly one of *AchievementUpdateMultipleResponse or error will be non-nil. 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 ¶
func (c *AchievementsUpdateMultipleCall) Fields(s ...googleapi.Field) *AchievementsUpdateMultipleCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*AchievementsUpdateMultipleCall) Header ¶
func (c *AchievementsUpdateMultipleCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type AggregateStats ¶
AggregateStats: This is a JSON template for aggregate stats.
type AggregateStats struct { // Count: The number of messages sent between a pair of peers. Count int64 `json:"count,omitempty,string"` // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#aggregateStats. Kind string `json:"kind,omitempty"` // Max: The maximum amount. Max int64 `json:"max,omitempty,string"` // Min: The minimum amount. Min int64 `json:"min,omitempty,string"` // Sum: The total number of bytes sent for messages between a pair of // peers. Sum int64 `json:"sum,omitempty,string"` // ForceSendFields is a list of field names (e.g. "Count") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Count") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*AggregateStats) MarshalJSON ¶
func (s *AggregateStats) MarshalJSON() ([]byte, error)
type AnonymousPlayer ¶
AnonymousPlayer: This is a JSON template for an anonymous player
type AnonymousPlayer struct { // AvatarImageUrl: The base URL for the image to display for the // anonymous player. AvatarImageUrl string `json:"avatarImageUrl,omitempty"` // DisplayName: The name to display for the anonymous player. DisplayName string `json:"displayName,omitempty"` // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#anonymousPlayer. Kind string `json:"kind,omitempty"` // ForceSendFields is a list of field names (e.g. "AvatarImageUrl") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AvatarImageUrl") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*AnonymousPlayer) MarshalJSON ¶
func (s *AnonymousPlayer) MarshalJSON() ([]byte, error)
type Application ¶
Application: This is a JSON template for the Application resource.
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 are: // - "SNAPSHOTS" - Snapshots has been enabled 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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AchievementCount") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*Application) MarshalJSON ¶
func (s *Application) MarshalJSON() ([]byte, error)
type ApplicationCategory ¶
ApplicationCategory: This is a JSON template for an application category object.
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Kind") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*ApplicationCategory) MarshalJSON ¶
func (s *ApplicationCategory) MarshalJSON() ([]byte, error)
type ApplicationVerifyResponse ¶
ApplicationVerifyResponse: This is a JSON template for a third party application verification response resource.
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AlternatePlayerId") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*ApplicationVerifyResponse) MarshalJSON ¶
func (s *ApplicationVerifyResponse) MarshalJSON() ([]byte, error)
type ApplicationsGetCall ¶
type ApplicationsGetCall struct {
// contains filtered or unexported fields
}
func (*ApplicationsGetCall) ConsistencyToken ¶
func (c *ApplicationsGetCall) ConsistencyToken(consistencyToken int64) *ApplicationsGetCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*ApplicationsGetCall) Context ¶
func (c *ApplicationsGetCall) Context(ctx context.Context) *ApplicationsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ApplicationsGetCall) Do ¶
func (c *ApplicationsGetCall) Do(opts ...googleapi.CallOption) (*Application, error)
Do executes the "games.applications.get" call. Exactly one of *Application or error will be non-nil. 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 ¶
func (c *ApplicationsGetCall) Fields(s ...googleapi.Field) *ApplicationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ApplicationsGetCall) Header ¶
func (c *ApplicationsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ApplicationsGetCall) IfNoneMatch ¶
func (c *ApplicationsGetCall) IfNoneMatch(entityTag string) *ApplicationsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*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 ApplicationsPlayedCall ¶
type ApplicationsPlayedCall struct {
// contains filtered or unexported fields
}
func (*ApplicationsPlayedCall) ConsistencyToken ¶
func (c *ApplicationsPlayedCall) ConsistencyToken(consistencyToken int64) *ApplicationsPlayedCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*ApplicationsPlayedCall) Context ¶
func (c *ApplicationsPlayedCall) Context(ctx context.Context) *ApplicationsPlayedCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ApplicationsPlayedCall) Do ¶
func (c *ApplicationsPlayedCall) Do(opts ...googleapi.CallOption) error
Do executes the "games.applications.played" call.
func (*ApplicationsPlayedCall) Fields ¶
func (c *ApplicationsPlayedCall) Fields(s ...googleapi.Field) *ApplicationsPlayedCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ApplicationsPlayedCall) Header ¶
func (c *ApplicationsPlayedCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP 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.
func (*ApplicationsService) Played ¶
func (r *ApplicationsService) Played() *ApplicationsPlayedCall
Played: Indicate that the 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.
type ApplicationsVerifyCall ¶
type ApplicationsVerifyCall struct {
// contains filtered or unexported fields
}
func (*ApplicationsVerifyCall) ConsistencyToken ¶
func (c *ApplicationsVerifyCall) ConsistencyToken(consistencyToken int64) *ApplicationsVerifyCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*ApplicationsVerifyCall) Context ¶
func (c *ApplicationsVerifyCall) Context(ctx context.Context) *ApplicationsVerifyCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ApplicationsVerifyCall) Do ¶
func (c *ApplicationsVerifyCall) Do(opts ...googleapi.CallOption) (*ApplicationVerifyResponse, error)
Do executes the "games.applications.verify" call. Exactly one of *ApplicationVerifyResponse or error will be non-nil. 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 ¶
func (c *ApplicationsVerifyCall) Fields(s ...googleapi.Field) *ApplicationsVerifyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ApplicationsVerifyCall) Header ¶
func (c *ApplicationsVerifyCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ApplicationsVerifyCall) IfNoneMatch ¶
func (c *ApplicationsVerifyCall) IfNoneMatch(entityTag string) *ApplicationsVerifyCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type Category ¶
Category: This is a JSON template for data related to individual game categories.
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Category") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*Category) MarshalJSON ¶
func (s *Category) MarshalJSON() ([]byte, error)
type CategoryListResponse ¶
CategoryListResponse: This is a JSON template for a list of category data objects.
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Items") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*CategoryListResponse) MarshalJSON ¶
func (s *CategoryListResponse) MarshalJSON() ([]byte, error)
type EventBatchRecordFailure ¶
EventBatchRecordFailure: This is a JSON template for a batch update failure resource.
type EventBatchRecordFailure struct { // FailureCause: The cause for the update failure. // Possible values are: // - "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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "FailureCause") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*EventBatchRecordFailure) MarshalJSON ¶
func (s *EventBatchRecordFailure) MarshalJSON() ([]byte, error)
type EventChild ¶
EventChild: This is a JSON template for an event child relationship resource.
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ChildId") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*EventChild) MarshalJSON ¶
func (s *EventChild) MarshalJSON() ([]byte, error)
type EventDefinition ¶
EventDefinition: This is a JSON template for an event definition resource.
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 are: // - "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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ChildEvents") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*EventDefinition) MarshalJSON ¶
func (s *EventDefinition) MarshalJSON() ([]byte, error)
type EventDefinitionListResponse ¶
EventDefinitionListResponse: This is a JSON template for a ListDefinitions response.
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Items") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*EventDefinitionListResponse) MarshalJSON ¶
func (s *EventDefinitionListResponse) MarshalJSON() ([]byte, error)
type EventPeriodRange ¶
EventPeriodRange: This is a JSON template for an event period time range.
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Kind") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*EventPeriodRange) MarshalJSON ¶
func (s *EventPeriodRange) MarshalJSON() ([]byte, error)
type EventPeriodUpdate ¶
EventPeriodUpdate: This is a JSON template for an event period update resource.
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Kind") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*EventPeriodUpdate) MarshalJSON ¶
func (s *EventPeriodUpdate) MarshalJSON() ([]byte, error)
type EventRecordFailure ¶
EventRecordFailure: This is a JSON template for an event update failure resource.
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 are: // - "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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "EventId") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*EventRecordFailure) MarshalJSON ¶
func (s *EventRecordFailure) MarshalJSON() ([]byte, error)
type EventRecordRequest ¶
EventRecordRequest: This is a JSON template for an event period update resource.
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CurrentTimeMillis") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*EventRecordRequest) MarshalJSON ¶
func (s *EventRecordRequest) MarshalJSON() ([]byte, error)
type EventUpdateRequest ¶
EventUpdateRequest: This is a JSON template for an event period update resource.
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DefinitionId") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*EventUpdateRequest) MarshalJSON ¶
func (s *EventUpdateRequest) MarshalJSON() ([]byte, error)
type EventUpdateResponse ¶
EventUpdateResponse: This is a JSON template for an event period update resource.
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "BatchFailures") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*EventUpdateResponse) MarshalJSON ¶
func (s *EventUpdateResponse) MarshalJSON() ([]byte, error)
type EventsListByPlayerCall ¶
type EventsListByPlayerCall struct {
// contains filtered or unexported fields
}
func (*EventsListByPlayerCall) ConsistencyToken ¶
func (c *EventsListByPlayerCall) ConsistencyToken(consistencyToken int64) *EventsListByPlayerCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*EventsListByPlayerCall) Context ¶
func (c *EventsListByPlayerCall) Context(ctx context.Context) *EventsListByPlayerCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*EventsListByPlayerCall) Do ¶
func (c *EventsListByPlayerCall) Do(opts ...googleapi.CallOption) (*PlayerEventListResponse, error)
Do executes the "games.events.listByPlayer" call. Exactly one of *PlayerEventListResponse or error will be non-nil. 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 ¶
func (c *EventsListByPlayerCall) Fields(s ...googleapi.Field) *EventsListByPlayerCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*EventsListByPlayerCall) Header ¶
func (c *EventsListByPlayerCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*EventsListByPlayerCall) IfNoneMatch ¶
func (c *EventsListByPlayerCall) IfNoneMatch(entityTag string) *EventsListByPlayerCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*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 ¶
func (c *EventsListByPlayerCall) Pages(ctx context.Context, f func(*PlayerEventListResponse) 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 EventsListDefinitionsCall ¶
type EventsListDefinitionsCall struct {
// contains filtered or unexported fields
}
func (*EventsListDefinitionsCall) ConsistencyToken ¶
func (c *EventsListDefinitionsCall) ConsistencyToken(consistencyToken int64) *EventsListDefinitionsCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*EventsListDefinitionsCall) Context ¶
func (c *EventsListDefinitionsCall) Context(ctx context.Context) *EventsListDefinitionsCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*EventsListDefinitionsCall) Do ¶
func (c *EventsListDefinitionsCall) Do(opts ...googleapi.CallOption) (*EventDefinitionListResponse, error)
Do executes the "games.events.listDefinitions" call. Exactly one of *EventDefinitionListResponse or error will be non-nil. 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 ¶
func (c *EventsListDefinitionsCall) Fields(s ...googleapi.Field) *EventsListDefinitionsCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*EventsListDefinitionsCall) Header ¶
func (c *EventsListDefinitionsCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*EventsListDefinitionsCall) IfNoneMatch ¶
func (c *EventsListDefinitionsCall) IfNoneMatch(entityTag string) *EventsListDefinitionsCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*EventsListDefinitionsCall) Language ¶
func (c *EventsListDefinitionsCall) Language(language string) *EventsListDefinitionsCall
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 ¶
func (c *EventsListDefinitionsCall) PageToken(pageToken string) *EventsListDefinitionsCall
PageToken sets the optional parameter "pageToken": The token returned by the previous request.
func (*EventsListDefinitionsCall) Pages ¶
func (c *EventsListDefinitionsCall) Pages(ctx context.Context, f func(*EventDefinitionListResponse) 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 EventsRecordCall ¶
type EventsRecordCall struct {
// contains filtered or unexported fields
}
func (*EventsRecordCall) ConsistencyToken ¶
func (c *EventsRecordCall) ConsistencyToken(consistencyToken int64) *EventsRecordCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*EventsRecordCall) Context ¶
func (c *EventsRecordCall) Context(ctx context.Context) *EventsRecordCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*EventsRecordCall) Do ¶
func (c *EventsRecordCall) Do(opts ...googleapi.CallOption) (*EventUpdateResponse, error)
Do executes the "games.events.record" call. Exactly one of *EventUpdateResponse or error will be non-nil. 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 ¶
func (c *EventsRecordCall) Fields(s ...googleapi.Field) *EventsRecordCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*EventsRecordCall) Header ¶
func (c *EventsRecordCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP 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 GamesAchievementIncrement ¶
GamesAchievementIncrement: This is a JSON template for the payload to request to increment an achievement.
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Kind") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*GamesAchievementIncrement) MarshalJSON ¶
func (s *GamesAchievementIncrement) MarshalJSON() ([]byte, error)
type GamesAchievementSetStepsAtLeast ¶
GamesAchievementSetStepsAtLeast: This is a JSON template for the payload to request to increment an achievement.
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Kind") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*GamesAchievementSetStepsAtLeast) MarshalJSON ¶
func (s *GamesAchievementSetStepsAtLeast) MarshalJSON() ([]byte, error)
type ImageAsset ¶
ImageAsset: This is a JSON template for an image asset object.
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Height") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*ImageAsset) MarshalJSON ¶
func (s *ImageAsset) MarshalJSON() ([]byte, error)
type Instance ¶
Instance: This is a JSON template for the Instance resource.
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 are: // - "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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AcquisitionUri") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*Instance) MarshalJSON ¶
func (s *Instance) MarshalJSON() ([]byte, error)
type InstanceAndroidDetails ¶
InstanceAndroidDetails: This is a JSON template for the Android instance details resource.
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "EnablePiracyCheck") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*InstanceAndroidDetails) MarshalJSON ¶
func (s *InstanceAndroidDetails) MarshalJSON() ([]byte, error)
type InstanceIosDetails ¶
InstanceIosDetails: This is a JSON template for the iOS details resource.
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "BundleIdentifier") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*InstanceIosDetails) MarshalJSON ¶
func (s *InstanceIosDetails) MarshalJSON() ([]byte, error)
type InstanceWebDetails ¶
InstanceWebDetails: This is a JSON template for the Web details resource.
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Kind") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*InstanceWebDetails) MarshalJSON ¶
func (s *InstanceWebDetails) MarshalJSON() ([]byte, error)
type Leaderboard ¶
Leaderboard: This is a JSON template for the Leaderboard resource.
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 are: // - "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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "IconUrl") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*Leaderboard) MarshalJSON ¶
func (s *Leaderboard) MarshalJSON() ([]byte, error)
type LeaderboardEntry ¶
LeaderboardEntry: This is a JSON template for the Leaderboard Entry resource.
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 are: // - "ALL_TIME" - The score is an all-time high score. // - "WEEKLY" - The score is a weekly high score. // - "DAILY" - The score is a daily high 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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "FormattedScore") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*LeaderboardEntry) MarshalJSON ¶
func (s *LeaderboardEntry) MarshalJSON() ([]byte, error)
type LeaderboardListResponse ¶
LeaderboardListResponse: This is a JSON template for a list of leaderboard objects.
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Items") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*LeaderboardListResponse) MarshalJSON ¶
func (s *LeaderboardListResponse) MarshalJSON() ([]byte, error)
type LeaderboardScoreRank ¶
LeaderboardScoreRank: This is a JSON template for a score rank in a leaderboard.
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "FormattedNumScores") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*LeaderboardScoreRank) MarshalJSON ¶
func (s *LeaderboardScoreRank) MarshalJSON() ([]byte, error)
type LeaderboardScores ¶
LeaderboardScores: This is a JSON template for a ListScores response.
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Items") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*LeaderboardScores) MarshalJSON ¶
func (s *LeaderboardScores) MarshalJSON() ([]byte, error)
type LeaderboardsGetCall ¶
type LeaderboardsGetCall struct {
// contains filtered or unexported fields
}
func (*LeaderboardsGetCall) ConsistencyToken ¶
func (c *LeaderboardsGetCall) ConsistencyToken(consistencyToken int64) *LeaderboardsGetCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*LeaderboardsGetCall) Context ¶
func (c *LeaderboardsGetCall) Context(ctx context.Context) *LeaderboardsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*LeaderboardsGetCall) Do ¶
func (c *LeaderboardsGetCall) Do(opts ...googleapi.CallOption) (*Leaderboard, error)
Do executes the "games.leaderboards.get" call. Exactly one of *Leaderboard or error will be non-nil. 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 ¶
func (c *LeaderboardsGetCall) Fields(s ...googleapi.Field) *LeaderboardsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*LeaderboardsGetCall) Header ¶
func (c *LeaderboardsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*LeaderboardsGetCall) IfNoneMatch ¶
func (c *LeaderboardsGetCall) IfNoneMatch(entityTag string) *LeaderboardsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*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) ConsistencyToken ¶
func (c *LeaderboardsListCall) ConsistencyToken(consistencyToken int64) *LeaderboardsListCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*LeaderboardsListCall) Context ¶
func (c *LeaderboardsListCall) Context(ctx context.Context) *LeaderboardsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*LeaderboardsListCall) Do ¶
func (c *LeaderboardsListCall) Do(opts ...googleapi.CallOption) (*LeaderboardListResponse, error)
Do executes the "games.leaderboards.list" call. Exactly one of *LeaderboardListResponse or error will be non-nil. 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 ¶
func (c *LeaderboardsListCall) Fields(s ...googleapi.Field) *LeaderboardsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*LeaderboardsListCall) Header ¶
func (c *LeaderboardsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*LeaderboardsListCall) IfNoneMatch ¶
func (c *LeaderboardsListCall) IfNoneMatch(entityTag string) *LeaderboardsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*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 ¶
func (c *LeaderboardsListCall) Pages(ctx context.Context, f func(*LeaderboardListResponse) 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 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.
func (*LeaderboardsService) List ¶
func (r *LeaderboardsService) List() *LeaderboardsListCall
List: Lists all the leaderboard metadata for your application.
type MetagameConfig ¶
MetagameConfig: This is a JSON template for the metagame config resource
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CurrentVersion") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*MetagameConfig) MarshalJSON ¶
func (s *MetagameConfig) MarshalJSON() ([]byte, error)
type MetagameGetMetagameConfigCall ¶
type MetagameGetMetagameConfigCall struct {
// contains filtered or unexported fields
}
func (*MetagameGetMetagameConfigCall) ConsistencyToken ¶
func (c *MetagameGetMetagameConfigCall) ConsistencyToken(consistencyToken int64) *MetagameGetMetagameConfigCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*MetagameGetMetagameConfigCall) Context ¶
func (c *MetagameGetMetagameConfigCall) Context(ctx context.Context) *MetagameGetMetagameConfigCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*MetagameGetMetagameConfigCall) Do ¶
func (c *MetagameGetMetagameConfigCall) Do(opts ...googleapi.CallOption) (*MetagameConfig, error)
Do executes the "games.metagame.getMetagameConfig" call. Exactly one of *MetagameConfig or error will be non-nil. 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 ¶
func (c *MetagameGetMetagameConfigCall) Fields(s ...googleapi.Field) *MetagameGetMetagameConfigCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*MetagameGetMetagameConfigCall) Header ¶
func (c *MetagameGetMetagameConfigCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*MetagameGetMetagameConfigCall) IfNoneMatch ¶
func (c *MetagameGetMetagameConfigCall) IfNoneMatch(entityTag string) *MetagameGetMetagameConfigCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type MetagameListCategoriesByPlayerCall ¶
type MetagameListCategoriesByPlayerCall struct {
// contains filtered or unexported fields
}
func (*MetagameListCategoriesByPlayerCall) ConsistencyToken ¶
func (c *MetagameListCategoriesByPlayerCall) ConsistencyToken(consistencyToken int64) *MetagameListCategoriesByPlayerCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*MetagameListCategoriesByPlayerCall) Context ¶
func (c *MetagameListCategoriesByPlayerCall) Context(ctx context.Context) *MetagameListCategoriesByPlayerCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*MetagameListCategoriesByPlayerCall) Do ¶
func (c *MetagameListCategoriesByPlayerCall) Do(opts ...googleapi.CallOption) (*CategoryListResponse, error)
Do executes the "games.metagame.listCategoriesByPlayer" call. Exactly one of *CategoryListResponse or error will be non-nil. 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 ¶
func (c *MetagameListCategoriesByPlayerCall) Fields(s ...googleapi.Field) *MetagameListCategoriesByPlayerCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*MetagameListCategoriesByPlayerCall) Header ¶
func (c *MetagameListCategoriesByPlayerCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*MetagameListCategoriesByPlayerCall) IfNoneMatch ¶
func (c *MetagameListCategoriesByPlayerCall) IfNoneMatch(entityTag string) *MetagameListCategoriesByPlayerCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*MetagameListCategoriesByPlayerCall) Language ¶
func (c *MetagameListCategoriesByPlayerCall) Language(language string) *MetagameListCategoriesByPlayerCall
Language sets the optional parameter "language": The preferred language to use for strings returned by this method.
func (*MetagameListCategoriesByPlayerCall) MaxResults ¶
func (c *MetagameListCategoriesByPlayerCall) MaxResults(maxResults int64) *MetagameListCategoriesByPlayerCall
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 ¶
func (c *MetagameListCategoriesByPlayerCall) PageToken(pageToken string) *MetagameListCategoriesByPlayerCall
PageToken sets the optional parameter "pageToken": The token returned by the previous request.
func (*MetagameListCategoriesByPlayerCall) Pages ¶
func (c *MetagameListCategoriesByPlayerCall) Pages(ctx context.Context, f func(*CategoryListResponse) 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 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.
type NetworkDiagnostics ¶
NetworkDiagnostics: This is a JSON template for network diagnostics reported for a client.
type NetworkDiagnostics struct { // AndroidNetworkSubtype: The Android network subtype. AndroidNetworkSubtype int64 `json:"androidNetworkSubtype,omitempty"` // AndroidNetworkType: The Android network type. AndroidNetworkType int64 `json:"androidNetworkType,omitempty"` // IosNetworkType: iOS network type as defined in Reachability.h. IosNetworkType int64 `json:"iosNetworkType,omitempty"` // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#networkDiagnostics. Kind string `json:"kind,omitempty"` // NetworkOperatorCode: The MCC+MNC code for the client's network // connection. On Android: // http://developer.android.com/reference/android/telephony/TelephonyManager.html#getNetworkOperator() On iOS, see: // https://developer.apple.com/library/ios/documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html NetworkOperatorCode string `json:"networkOperatorCode,omitempty"` // NetworkOperatorName: The name of the carrier of the client's network // connection. On Android: // http://developer.android.com/reference/android/telephony/TelephonyManager.html#getNetworkOperatorName() On iOS: // https://developer.apple.com/library/ios/documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html#//apple_ref/occ/instp/CTCarrier/carrierName NetworkOperatorName string `json:"networkOperatorName,omitempty"` // RegistrationLatencyMillis: The amount of time in milliseconds it took // for the client to establish a connection with the XMPP server. RegistrationLatencyMillis int64 `json:"registrationLatencyMillis,omitempty"` // ForceSendFields is a list of field names (e.g. // "AndroidNetworkSubtype") to unconditionally include in API requests. // By default, fields with empty values are omitted from API requests. // However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AndroidNetworkSubtype") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*NetworkDiagnostics) MarshalJSON ¶
func (s *NetworkDiagnostics) MarshalJSON() ([]byte, error)
type ParticipantResult ¶
ParticipantResult: This is a JSON template for a result for a match participant.
type ParticipantResult struct { // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#participantResult. Kind string `json:"kind,omitempty"` // ParticipantId: The ID of the participant. ParticipantId string `json:"participantId,omitempty"` // Placing: The placement or ranking of the participant in the match // results; a number from one to the number of participants in the // match. Multiple participants may have the same placing value in case // of a type. Placing int64 `json:"placing,omitempty"` // Result: The result of the participant for this match. // Possible values are: // - "MATCH_RESULT_WIN" - The participant won the match. // - "MATCH_RESULT_LOSS" - The participant lost the match. // - "MATCH_RESULT_TIE" - The participant tied the match. // - "MATCH_RESULT_NONE" - There was no winner for the match (nobody // wins or loses this kind of game.) // - "MATCH_RESULT_DISCONNECT" - The participant disconnected / left // during the match. // - "MATCH_RESULT_DISAGREED" - Different clients reported different // results for this participant. Result string `json:"result,omitempty"` // ForceSendFields is a list of field names (e.g. "Kind") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Kind") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*ParticipantResult) MarshalJSON ¶
func (s *ParticipantResult) MarshalJSON() ([]byte, error)
type PeerChannelDiagnostics ¶
PeerChannelDiagnostics: This is a JSON template for peer channel diagnostics.
type PeerChannelDiagnostics struct { // BytesReceived: Number of bytes received. BytesReceived *AggregateStats `json:"bytesReceived,omitempty"` // BytesSent: Number of bytes sent. BytesSent *AggregateStats `json:"bytesSent,omitempty"` // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#peerChannelDiagnostics. Kind string `json:"kind,omitempty"` // NumMessagesLost: Number of messages lost. NumMessagesLost int64 `json:"numMessagesLost,omitempty"` // NumMessagesReceived: Number of messages received. NumMessagesReceived int64 `json:"numMessagesReceived,omitempty"` // NumMessagesSent: Number of messages sent. NumMessagesSent int64 `json:"numMessagesSent,omitempty"` // NumSendFailures: Number of send failures. NumSendFailures int64 `json:"numSendFailures,omitempty"` // RoundtripLatencyMillis: Roundtrip latency stats in milliseconds. RoundtripLatencyMillis *AggregateStats `json:"roundtripLatencyMillis,omitempty"` // ForceSendFields is a list of field names (e.g. "BytesReceived") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "BytesReceived") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*PeerChannelDiagnostics) MarshalJSON ¶
func (s *PeerChannelDiagnostics) MarshalJSON() ([]byte, error)
type PeerSessionDiagnostics ¶
PeerSessionDiagnostics: This is a JSON template for peer session diagnostics.
type PeerSessionDiagnostics struct { // ConnectedTimestampMillis: Connected time in milliseconds. ConnectedTimestampMillis int64 `json:"connectedTimestampMillis,omitempty,string"` // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#peerSessionDiagnostics. Kind string `json:"kind,omitempty"` // ParticipantId: The participant ID of the peer. ParticipantId string `json:"participantId,omitempty"` // ReliableChannel: Reliable channel diagnostics. ReliableChannel *PeerChannelDiagnostics `json:"reliableChannel,omitempty"` // UnreliableChannel: Unreliable channel diagnostics. UnreliableChannel *PeerChannelDiagnostics `json:"unreliableChannel,omitempty"` // ForceSendFields is a list of field names (e.g. // "ConnectedTimestampMillis") to unconditionally include in API // requests. By default, fields with empty values are omitted from API // requests. However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ConnectedTimestampMillis") // to include in API requests with the JSON null value. By default, // fields with empty values are omitted from API requests. However, any // field with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*PeerSessionDiagnostics) MarshalJSON ¶
func (s *PeerSessionDiagnostics) MarshalJSON() ([]byte, error)
type Played ¶
Played: This is a JSON template for metadata about a player playing a game with the currently authenticated user.
type Played struct { // AutoMatched: True if the player was auto-matched with the currently // authenticated user. AutoMatched bool `json:"autoMatched,omitempty"` // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#played. Kind string `json:"kind,omitempty"` // TimeMillis: The last time the player played the game in milliseconds // since the epoch in UTC. TimeMillis int64 `json:"timeMillis,omitempty,string"` // ForceSendFields is a list of field names (e.g. "AutoMatched") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AutoMatched") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*Played) MarshalJSON ¶
func (s *Played) MarshalJSON() ([]byte, error)
type Player ¶
Player: This is a JSON template for a Player resource.
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"` // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#player. Kind string `json:"kind,omitempty"` // LastPlayedWith: Details about the last time this player played a // multiplayer game with the currently authenticated player. Populated // for PLAYED_WITH player collection members. LastPlayedWith *Played `json:"lastPlayedWith,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"` // 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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AvatarImageUrl") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*Player) MarshalJSON ¶
func (s *Player) MarshalJSON() ([]byte, error)
type PlayerAchievement ¶
PlayerAchievement: This is a JSON template for an achievement object.
type PlayerAchievement struct { // AchievementState: The state of the achievement. // Possible values are: // - "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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AchievementState") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*PlayerAchievement) MarshalJSON ¶
func (s *PlayerAchievement) MarshalJSON() ([]byte, error)
type PlayerAchievementListResponse ¶
PlayerAchievementListResponse: This is a JSON template for a list of achievement objects.
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Items") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*PlayerAchievementListResponse) MarshalJSON ¶
func (s *PlayerAchievementListResponse) MarshalJSON() ([]byte, error)
type PlayerEvent ¶
PlayerEvent: This is a JSON template for an event status resource.
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DefinitionId") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*PlayerEvent) MarshalJSON ¶
func (s *PlayerEvent) MarshalJSON() ([]byte, error)
type PlayerEventListResponse ¶
PlayerEventListResponse: This is a JSON template for a ListByPlayer response.
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Items") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*PlayerEventListResponse) MarshalJSON ¶
func (s *PlayerEventListResponse) MarshalJSON() ([]byte, error)
type PlayerExperienceInfo ¶
PlayerExperienceInfo: This is a JSON template for 1P/3P metadata about the player's experience.
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 values are omitted from API // requests. However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CurrentExperiencePoints") // to include in API requests with the JSON null value. By default, // fields with empty values are omitted from API requests. However, any // field with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*PlayerExperienceInfo) MarshalJSON ¶
func (s *PlayerExperienceInfo) MarshalJSON() ([]byte, error)
type PlayerLeaderboardScore ¶
PlayerLeaderboardScore: This is a JSON template for a player leaderboard score object.
type PlayerLeaderboardScore struct { // 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 are: // - "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. "Kind") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Kind") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*PlayerLeaderboardScore) MarshalJSON ¶
func (s *PlayerLeaderboardScore) MarshalJSON() ([]byte, error)
type PlayerLeaderboardScoreListResponse ¶
PlayerLeaderboardScoreListResponse: This is a JSON template for a list of player leaderboard scores.
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Items") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*PlayerLeaderboardScoreListResponse) MarshalJSON ¶
func (s *PlayerLeaderboardScoreListResponse) MarshalJSON() ([]byte, error)
type PlayerLevel ¶
PlayerLevel: This is a JSON template for 1P/3P metadata about a user's level.
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Kind") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*PlayerLevel) MarshalJSON ¶
func (s *PlayerLevel) MarshalJSON() ([]byte, error)
type PlayerListResponse ¶
PlayerListResponse: This is a JSON template for a third party player list response.
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Items") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*PlayerListResponse) MarshalJSON ¶
func (s *PlayerListResponse) MarshalJSON() ([]byte, error)
type PlayerName ¶
PlayerName: An object representation of the individual components of the player's name. For some players, these fields may not be present.
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "FamilyName") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*PlayerName) MarshalJSON ¶
func (s *PlayerName) MarshalJSON() ([]byte, error)
type PlayerScore ¶
PlayerScore: This is a JSON template for a player score.
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 are: // - "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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "FormattedScore") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*PlayerScore) MarshalJSON ¶
func (s *PlayerScore) MarshalJSON() ([]byte, error)
type PlayerScoreListResponse ¶
PlayerScoreListResponse: This is a JSON template for a list of score submission statuses.
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Kind") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*PlayerScoreListResponse) MarshalJSON ¶
func (s *PlayerScoreListResponse) MarshalJSON() ([]byte, error)
type PlayerScoreResponse ¶
PlayerScoreResponse: This is a JSON template for a list of leaderboard entry resources.
type PlayerScoreResponse struct { // BeatenScoreTimeSpans: The time spans where the submitted score is // better than the existing score for that time span. // 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. 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 values are omitted from API requests. // However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "BeatenScoreTimeSpans") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*PlayerScoreResponse) MarshalJSON ¶
func (s *PlayerScoreResponse) MarshalJSON() ([]byte, error)
type PlayerScoreSubmissionList ¶
PlayerScoreSubmissionList: This is a JSON template for a list of score submission requests
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Kind") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*PlayerScoreSubmissionList) MarshalJSON ¶
func (s *PlayerScoreSubmissionList) MarshalJSON() ([]byte, error)
type PlayersGetCall ¶
type PlayersGetCall struct {
// contains filtered or unexported fields
}
func (*PlayersGetCall) ConsistencyToken ¶
func (c *PlayersGetCall) ConsistencyToken(consistencyToken int64) *PlayersGetCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*PlayersGetCall) Context ¶
func (c *PlayersGetCall) Context(ctx context.Context) *PlayersGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*PlayersGetCall) Do ¶
func (c *PlayersGetCall) Do(opts ...googleapi.CallOption) (*Player, error)
Do executes the "games.players.get" call. Exactly one of *Player or error will be non-nil. 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 information.
func (*PlayersGetCall) Header ¶
func (c *PlayersGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*PlayersGetCall) IfNoneMatch ¶
func (c *PlayersGetCall) IfNoneMatch(entityTag string) *PlayersGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*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.
type PlayersListCall ¶
type PlayersListCall struct {
// contains filtered or unexported fields
}
func (*PlayersListCall) ConsistencyToken ¶
func (c *PlayersListCall) ConsistencyToken(consistencyToken int64) *PlayersListCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*PlayersListCall) Context ¶
func (c *PlayersListCall) Context(ctx context.Context) *PlayersListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*PlayersListCall) Do ¶
func (c *PlayersListCall) Do(opts ...googleapi.CallOption) (*PlayerListResponse, error)
Do executes the "games.players.list" call. Exactly one of *PlayerListResponse or error will be non-nil. 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 ¶
func (c *PlayersListCall) Fields(s ...googleapi.Field) *PlayersListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*PlayersListCall) Header ¶
func (c *PlayersListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*PlayersListCall) IfNoneMatch ¶
func (c *PlayersListCall) IfNoneMatch(entityTag string) *PlayersListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*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.
func (*PlayersService) List ¶
func (r *PlayersService) List(collection string) *PlayersListCall
List: Get the collection of players for the currently authenticated user.
type ProfileSettings ¶
ProfileSettings: This is a JSON template for profile settings
type ProfileSettings struct { // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#profileSettings. Kind string `json:"kind,omitempty"` // ProfileVisible: The player's current profile visibility. This field // is visible to both 1P and 3P APIs. 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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Kind") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*ProfileSettings) MarshalJSON ¶
func (s *ProfileSettings) MarshalJSON() ([]byte, error)
type PushToken ¶
PushToken: This is a JSON template for a push token resource.
type PushToken struct { // ClientRevision: The revision of the client SDK used by your // application, in the same format that's used by revisions.check. Used // to send backward compatible messages. Format: // [PLATFORM_TYPE]:[VERSION_NUMBER]. Possible values of PLATFORM_TYPE // are: // - IOS - Push token is for iOS ClientRevision string `json:"clientRevision,omitempty"` // Id: Unique identifier for this push token. Id *PushTokenId `json:"id,omitempty"` // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#pushToken. Kind string `json:"kind,omitempty"` // Language: The preferred language for notifications that are sent // using this token. Language string `json:"language,omitempty"` // ForceSendFields is a list of field names (e.g. "ClientRevision") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ClientRevision") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*PushToken) MarshalJSON ¶
func (s *PushToken) MarshalJSON() ([]byte, error)
type PushTokenId ¶
PushTokenId: This is a JSON template for a push token ID resource.
type PushTokenId struct { // Ios: A push token ID for iOS devices. Ios *PushTokenIdIos `json:"ios,omitempty"` // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#pushTokenId. Kind string `json:"kind,omitempty"` // ForceSendFields is a list of field names (e.g. "Ios") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Ios") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*PushTokenId) MarshalJSON ¶
func (s *PushTokenId) MarshalJSON() ([]byte, error)
type PushTokenIdIos ¶
PushTokenIdIos: A push token ID for iOS devices.
type PushTokenIdIos struct { // ApnsDeviceToken: Device token supplied by an iOS system call to // register for remote notifications. Encode this field as web-safe // base64. ApnsDeviceToken string `json:"apns_device_token,omitempty"` // ApnsEnvironment: Indicates whether this token should be used for the // production or sandbox APNS server. ApnsEnvironment string `json:"apns_environment,omitempty"` // ForceSendFields is a list of field names (e.g. "ApnsDeviceToken") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ApnsDeviceToken") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*PushTokenIdIos) MarshalJSON ¶
func (s *PushTokenIdIos) MarshalJSON() ([]byte, error)
type PushtokensRemoveCall ¶
type PushtokensRemoveCall struct {
// contains filtered or unexported fields
}
func (*PushtokensRemoveCall) ConsistencyToken ¶
func (c *PushtokensRemoveCall) ConsistencyToken(consistencyToken int64) *PushtokensRemoveCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*PushtokensRemoveCall) Context ¶
func (c *PushtokensRemoveCall) Context(ctx context.Context) *PushtokensRemoveCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*PushtokensRemoveCall) Do ¶
func (c *PushtokensRemoveCall) Do(opts ...googleapi.CallOption) error
Do executes the "games.pushtokens.remove" call.
func (*PushtokensRemoveCall) Fields ¶
func (c *PushtokensRemoveCall) Fields(s ...googleapi.Field) *PushtokensRemoveCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*PushtokensRemoveCall) Header ¶
func (c *PushtokensRemoveCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type PushtokensService ¶
type PushtokensService struct {
// contains filtered or unexported fields
}
func NewPushtokensService ¶
func NewPushtokensService(s *Service) *PushtokensService
func (*PushtokensService) Remove ¶
func (r *PushtokensService) Remove(pushtokenid *PushTokenId) *PushtokensRemoveCall
Remove: Removes a push token for the current user and application. Removing a non-existent push token will report success.
func (*PushtokensService) Update ¶
func (r *PushtokensService) Update(pushtoken *PushToken) *PushtokensUpdateCall
Update: Registers a push token for the current user and application.
type PushtokensUpdateCall ¶
type PushtokensUpdateCall struct {
// contains filtered or unexported fields
}
func (*PushtokensUpdateCall) ConsistencyToken ¶
func (c *PushtokensUpdateCall) ConsistencyToken(consistencyToken int64) *PushtokensUpdateCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*PushtokensUpdateCall) Context ¶
func (c *PushtokensUpdateCall) Context(ctx context.Context) *PushtokensUpdateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*PushtokensUpdateCall) Do ¶
func (c *PushtokensUpdateCall) Do(opts ...googleapi.CallOption) error
Do executes the "games.pushtokens.update" call.
func (*PushtokensUpdateCall) Fields ¶
func (c *PushtokensUpdateCall) Fields(s ...googleapi.Field) *PushtokensUpdateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*PushtokensUpdateCall) Header ¶
func (c *PushtokensUpdateCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type Quest ¶
Quest: This is a JSON template for a Quest resource.
type Quest struct { // AcceptedTimestampMillis: The timestamp at which the user accepted the // quest in milliseconds since the epoch in UTC. Only present if the // player has accepted the quest. AcceptedTimestampMillis int64 `json:"acceptedTimestampMillis,omitempty,string"` // ApplicationId: The ID of the application this quest is part of. ApplicationId string `json:"applicationId,omitempty"` // BannerUrl: The banner image URL for the quest. BannerUrl string `json:"bannerUrl,omitempty"` // Description: The description of the quest. Description string `json:"description,omitempty"` // EndTimestampMillis: The timestamp at which the quest ceases to be // active in milliseconds since the epoch in UTC. EndTimestampMillis int64 `json:"endTimestampMillis,omitempty,string"` // IconUrl: The icon image URL for the quest. IconUrl string `json:"iconUrl,omitempty"` // Id: The ID of the quest. Id string `json:"id,omitempty"` // IsDefaultBannerUrl: Indicates whether the banner image being returned // is a default image, or is game-provided. IsDefaultBannerUrl bool `json:"isDefaultBannerUrl,omitempty"` // IsDefaultIconUrl: Indicates whether the icon image being returned is // a default image, or is game-provided. IsDefaultIconUrl bool `json:"isDefaultIconUrl,omitempty"` // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#quest. Kind string `json:"kind,omitempty"` // LastUpdatedTimestampMillis: The timestamp at which the quest was last // updated by the user in milliseconds since the epoch in UTC. Only // present if the player has accepted the quest. LastUpdatedTimestampMillis int64 `json:"lastUpdatedTimestampMillis,omitempty,string"` // Milestones: The quest milestones. Milestones []*QuestMilestone `json:"milestones,omitempty"` // Name: The name of the quest. Name string `json:"name,omitempty"` // NotifyTimestampMillis: The timestamp at which the user should be // notified that the quest will end soon in milliseconds since the epoch // in UTC. NotifyTimestampMillis int64 `json:"notifyTimestampMillis,omitempty,string"` // StartTimestampMillis: The timestamp at which the quest becomes active // in milliseconds since the epoch in UTC. StartTimestampMillis int64 `json:"startTimestampMillis,omitempty,string"` // State: The state of the quest. // Possible values are: // - "UPCOMING": The quest is upcoming. The user can see the quest, but // cannot accept it until it is open. // - "OPEN": The quest is currently open and may be accepted at this // time. // - "ACCEPTED": The user is currently participating in this quest. // - "COMPLETED": The user has completed the quest. // - "FAILED": The quest was attempted but was not completed before the // deadline expired. // - "EXPIRED": The quest has expired and was not accepted. // - "DELETED": The quest should be deleted from the local database. 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. // "AcceptedTimestampMillis") to unconditionally include in API // requests. By default, fields with empty values are omitted from API // requests. However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AcceptedTimestampMillis") // to include in API requests with the JSON null value. By default, // fields with empty values are omitted from API requests. However, any // field with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*Quest) MarshalJSON ¶
func (s *Quest) MarshalJSON() ([]byte, error)
type QuestContribution ¶
QuestContribution: This is a JSON template for a Quest Criterion Contribution resource.
type QuestContribution struct { // FormattedValue: The formatted value of the contribution as a string. // Format depends on the configuration for the associated event // definition in the Play Games Developer Console. FormattedValue string `json:"formattedValue,omitempty"` // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#questContribution. Kind string `json:"kind,omitempty"` // Value: The value of the contribution. Value int64 `json:"value,omitempty,string"` // ForceSendFields is a list of field names (e.g. "FormattedValue") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "FormattedValue") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*QuestContribution) MarshalJSON ¶
func (s *QuestContribution) MarshalJSON() ([]byte, error)
type QuestCriterion ¶
QuestCriterion: This is a JSON template for a Quest Criterion resource.
type QuestCriterion struct { // CompletionContribution: The total number of times the associated // event must be incremented for the player to complete this quest. CompletionContribution *QuestContribution `json:"completionContribution,omitempty"` // CurrentContribution: The number of increments the player has made // toward the completion count event increments required to complete the // quest. This value will not exceed the completion contribution. // There will be no currentContribution until the player has accepted // the quest. CurrentContribution *QuestContribution `json:"currentContribution,omitempty"` // EventId: The ID of the event the criterion corresponds to. EventId string `json:"eventId,omitempty"` // InitialPlayerProgress: The value of the event associated with this // quest at the time that the quest was accepted. This value may change // if event increments that took place before the start of quest are // uploaded after the quest starts. // There will be no initialPlayerProgress until the player has accepted // the quest. InitialPlayerProgress *QuestContribution `json:"initialPlayerProgress,omitempty"` // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#questCriterion. Kind string `json:"kind,omitempty"` // ForceSendFields is a list of field names (e.g. // "CompletionContribution") to unconditionally include in API requests. // By default, fields with empty values are omitted from API requests. // However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CompletionContribution") // to include in API requests with the JSON null value. By default, // fields with empty values are omitted from API requests. However, any // field with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*QuestCriterion) MarshalJSON ¶
func (s *QuestCriterion) MarshalJSON() ([]byte, error)
type QuestListResponse ¶
QuestListResponse: This is a JSON template for a list of quest objects.
type QuestListResponse struct { // Items: The quests. Items []*Quest `json:"items,omitempty"` // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#questListResponse. 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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Items") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*QuestListResponse) MarshalJSON ¶
func (s *QuestListResponse) MarshalJSON() ([]byte, error)
type QuestMilestone ¶
QuestMilestone: This is a JSON template for a Quest Milestone resource.
type QuestMilestone struct { // CompletionRewardData: The completion reward data of the milestone, // represented as a Base64-encoded string. This is a developer-specified // binary blob with size between 0 and 2 KB before encoding. CompletionRewardData string `json:"completionRewardData,omitempty"` // Criteria: The criteria of the milestone. Criteria []*QuestCriterion `json:"criteria,omitempty"` // Id: The milestone ID. Id string `json:"id,omitempty"` // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#questMilestone. Kind string `json:"kind,omitempty"` // State: The current state of the milestone. // Possible values are: // - "COMPLETED_NOT_CLAIMED" - The milestone is complete, but has not // yet been claimed. // - "CLAIMED" - The milestone is complete and has been claimed. // - "NOT_COMPLETED" - The milestone has not yet been completed. // - "NOT_STARTED" - The milestone is for a quest that has not yet been // accepted. State string `json:"state,omitempty"` // ForceSendFields is a list of field names (e.g. // "CompletionRewardData") to unconditionally include in API requests. // By default, fields with empty values are omitted from API requests. // However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CompletionRewardData") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*QuestMilestone) MarshalJSON ¶
func (s *QuestMilestone) MarshalJSON() ([]byte, error)
type QuestMilestonesClaimCall ¶
type QuestMilestonesClaimCall struct {
// contains filtered or unexported fields
}
func (*QuestMilestonesClaimCall) ConsistencyToken ¶
func (c *QuestMilestonesClaimCall) ConsistencyToken(consistencyToken int64) *QuestMilestonesClaimCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*QuestMilestonesClaimCall) Context ¶
func (c *QuestMilestonesClaimCall) Context(ctx context.Context) *QuestMilestonesClaimCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*QuestMilestonesClaimCall) Do ¶
func (c *QuestMilestonesClaimCall) Do(opts ...googleapi.CallOption) error
Do executes the "games.questMilestones.claim" call.
func (*QuestMilestonesClaimCall) Fields ¶
func (c *QuestMilestonesClaimCall) Fields(s ...googleapi.Field) *QuestMilestonesClaimCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*QuestMilestonesClaimCall) Header ¶
func (c *QuestMilestonesClaimCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type QuestMilestonesService ¶
type QuestMilestonesService struct {
// contains filtered or unexported fields
}
func NewQuestMilestonesService ¶
func NewQuestMilestonesService(s *Service) *QuestMilestonesService
func (*QuestMilestonesService) Claim ¶
func (r *QuestMilestonesService) Claim(questId string, milestoneId string, requestId int64) *QuestMilestonesClaimCall
Claim: Report that a reward for the milestone corresponding to milestoneId for the quest corresponding to questId has been claimed by the currently authorized user.
type QuestsAcceptCall ¶
type QuestsAcceptCall struct {
// contains filtered or unexported fields
}
func (*QuestsAcceptCall) ConsistencyToken ¶
func (c *QuestsAcceptCall) ConsistencyToken(consistencyToken int64) *QuestsAcceptCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*QuestsAcceptCall) Context ¶
func (c *QuestsAcceptCall) Context(ctx context.Context) *QuestsAcceptCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*QuestsAcceptCall) Do ¶
func (c *QuestsAcceptCall) Do(opts ...googleapi.CallOption) (*Quest, error)
Do executes the "games.quests.accept" call. Exactly one of *Quest or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Quest.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 (*QuestsAcceptCall) Fields ¶
func (c *QuestsAcceptCall) Fields(s ...googleapi.Field) *QuestsAcceptCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*QuestsAcceptCall) Header ¶
func (c *QuestsAcceptCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*QuestsAcceptCall) Language ¶
func (c *QuestsAcceptCall) Language(language string) *QuestsAcceptCall
Language sets the optional parameter "language": The preferred language to use for strings returned by this method.
type QuestsListCall ¶
type QuestsListCall struct {
// contains filtered or unexported fields
}
func (*QuestsListCall) ConsistencyToken ¶
func (c *QuestsListCall) ConsistencyToken(consistencyToken int64) *QuestsListCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*QuestsListCall) Context ¶
func (c *QuestsListCall) Context(ctx context.Context) *QuestsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*QuestsListCall) Do ¶
func (c *QuestsListCall) Do(opts ...googleapi.CallOption) (*QuestListResponse, error)
Do executes the "games.quests.list" call. Exactly one of *QuestListResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *QuestListResponse.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 (*QuestsListCall) Fields ¶
func (c *QuestsListCall) Fields(s ...googleapi.Field) *QuestsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*QuestsListCall) Header ¶
func (c *QuestsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*QuestsListCall) IfNoneMatch ¶
func (c *QuestsListCall) IfNoneMatch(entityTag string) *QuestsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*QuestsListCall) Language ¶
func (c *QuestsListCall) Language(language string) *QuestsListCall
Language sets the optional parameter "language": The preferred language to use for strings returned by this method.
func (*QuestsListCall) MaxResults ¶
func (c *QuestsListCall) MaxResults(maxResults int64) *QuestsListCall
MaxResults sets the optional parameter "maxResults": The maximum number of quest resources to return in the response, used for paging. For any response, the actual number of quest resources returned may be less than the specified maxResults. Acceptable values are 1 to 50, inclusive. (Default: 50).
func (*QuestsListCall) PageToken ¶
func (c *QuestsListCall) PageToken(pageToken string) *QuestsListCall
PageToken sets the optional parameter "pageToken": The token returned by the previous request.
func (*QuestsListCall) Pages ¶
func (c *QuestsListCall) Pages(ctx context.Context, f func(*QuestListResponse) 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 QuestsService ¶
type QuestsService struct {
// contains filtered or unexported fields
}
func NewQuestsService ¶
func NewQuestsService(s *Service) *QuestsService
func (*QuestsService) Accept ¶
func (r *QuestsService) Accept(questId string) *QuestsAcceptCall
Accept: Indicates that the currently authorized user will participate in the quest.
func (*QuestsService) List ¶
func (r *QuestsService) List(playerId string) *QuestsListCall
List: Get a list of quests for your application and the currently authenticated player.
type RevisionCheckResponse ¶
RevisionCheckResponse: This is a JSON template for the result of checking a revision.
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 are: // - "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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ApiVersion") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*RevisionCheckResponse) MarshalJSON ¶
func (s *RevisionCheckResponse) MarshalJSON() ([]byte, error)
type RevisionsCheckCall ¶
type RevisionsCheckCall struct {
// contains filtered or unexported fields
}
func (*RevisionsCheckCall) ConsistencyToken ¶
func (c *RevisionsCheckCall) ConsistencyToken(consistencyToken int64) *RevisionsCheckCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*RevisionsCheckCall) Context ¶
func (c *RevisionsCheckCall) Context(ctx context.Context) *RevisionsCheckCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*RevisionsCheckCall) Do ¶
func (c *RevisionsCheckCall) Do(opts ...googleapi.CallOption) (*RevisionCheckResponse, error)
Do executes the "games.revisions.check" call. Exactly one of *RevisionCheckResponse or error will be non-nil. 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 ¶
func (c *RevisionsCheckCall) Fields(s ...googleapi.Field) *RevisionsCheckCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*RevisionsCheckCall) Header ¶
func (c *RevisionsCheckCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*RevisionsCheckCall) IfNoneMatch ¶
func (c *RevisionsCheckCall) IfNoneMatch(entityTag string) *RevisionsCheckCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
type 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.
type Room ¶
Room: This is a JSON template for a room resource object.
type Room struct { // ApplicationId: The ID of the application being played. ApplicationId string `json:"applicationId,omitempty"` // AutoMatchingCriteria: Criteria for auto-matching players into this // room. AutoMatchingCriteria *RoomAutoMatchingCriteria `json:"autoMatchingCriteria,omitempty"` // AutoMatchingStatus: Auto-matching status for this room. Not set if // the room is not currently in the auto-matching queue. AutoMatchingStatus *RoomAutoMatchStatus `json:"autoMatchingStatus,omitempty"` // CreationDetails: Details about the room creation. CreationDetails *RoomModification `json:"creationDetails,omitempty"` // Description: This short description is generated by our servers and // worded relative to the player requesting the room. It is intended to // be displayed when the room is shown in a list (that is, an invitation // to a room.) Description string `json:"description,omitempty"` // InviterId: The ID of the participant that invited the user to the // room. Not set if the user was not invited to the room. InviterId string `json:"inviterId,omitempty"` // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#room. Kind string `json:"kind,omitempty"` // LastUpdateDetails: Details about the last update to the room. LastUpdateDetails *RoomModification `json:"lastUpdateDetails,omitempty"` // Participants: The participants involved in the room, along with their // statuses. Includes participants who have left or declined // invitations. Participants []*RoomParticipant `json:"participants,omitempty"` // RoomId: Globally unique ID for a room. RoomId string `json:"roomId,omitempty"` // RoomStatusVersion: The version of the room status: an increasing // counter, used by the client to ignore out-of-order updates to room // status. RoomStatusVersion int64 `json:"roomStatusVersion,omitempty"` // Status: The status of the room. // Possible values are: // - "ROOM_INVITING" - One or more players have been invited and not // responded. // - "ROOM_AUTO_MATCHING" - One or more slots need to be filled by // auto-matching. // - "ROOM_CONNECTING" - Players have joined and are connecting to each // other (either before or after auto-matching). // - "ROOM_ACTIVE" - All players have joined and connected to each // other. // - "ROOM_DELETED" - The room should no longer be shown on the client. // Returned in sync calls when a player joins a room (as a tombstone), // or for rooms where all joined participants have left. Status string `json:"status,omitempty"` // Variant: The variant / mode of the application being played; can be // any integer value, or left blank. Variant int64 `json:"variant,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "ApplicationId") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ApplicationId") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*Room) MarshalJSON ¶
func (s *Room) MarshalJSON() ([]byte, error)
type RoomAutoMatchStatus ¶
RoomAutoMatchStatus: This is a JSON template for status of room automatching that is in progress.
type RoomAutoMatchStatus struct { // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#roomAutoMatchStatus. Kind string `json:"kind,omitempty"` // WaitEstimateSeconds: An estimate for the amount of time (in seconds) // that auto-matching is expected to take to complete. WaitEstimateSeconds int64 `json:"waitEstimateSeconds,omitempty"` // ForceSendFields is a list of field names (e.g. "Kind") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Kind") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*RoomAutoMatchStatus) MarshalJSON ¶
func (s *RoomAutoMatchStatus) MarshalJSON() ([]byte, error)
type RoomAutoMatchingCriteria ¶
RoomAutoMatchingCriteria: This is a JSON template for a room auto-match criteria object.
type RoomAutoMatchingCriteria struct { // ExclusiveBitmask: A bitmask indicating when auto-matches are valid. // When ANDed with other exclusive bitmasks, the result must be zero. // Can be used to support exclusive roles within a game. ExclusiveBitmask int64 `json:"exclusiveBitmask,omitempty,string"` // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#roomAutoMatchingCriteria. Kind string `json:"kind,omitempty"` // MaxAutoMatchingPlayers: The maximum number of players that should be // added to the room by auto-matching. MaxAutoMatchingPlayers int64 `json:"maxAutoMatchingPlayers,omitempty"` // MinAutoMatchingPlayers: The minimum number of players that should be // added to the room by auto-matching. MinAutoMatchingPlayers int64 `json:"minAutoMatchingPlayers,omitempty"` // ForceSendFields is a list of field names (e.g. "ExclusiveBitmask") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ExclusiveBitmask") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*RoomAutoMatchingCriteria) MarshalJSON ¶
func (s *RoomAutoMatchingCriteria) MarshalJSON() ([]byte, error)
type RoomClientAddress ¶
RoomClientAddress: This is a JSON template for the client address when setting up a room.
type RoomClientAddress struct { // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#roomClientAddress. Kind string `json:"kind,omitempty"` // XmppAddress: The XMPP address of the client on the Google Games XMPP // network. XmppAddress string `json:"xmppAddress,omitempty"` // ForceSendFields is a list of field names (e.g. "Kind") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Kind") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*RoomClientAddress) MarshalJSON ¶
func (s *RoomClientAddress) MarshalJSON() ([]byte, error)
type RoomCreateRequest ¶
RoomCreateRequest: This is a JSON template for a room creation request.
type RoomCreateRequest struct { // AutoMatchingCriteria: Criteria for auto-matching players into this // room. AutoMatchingCriteria *RoomAutoMatchingCriteria `json:"autoMatchingCriteria,omitempty"` // Capabilities: The capabilities that this client supports for realtime // communication. Capabilities []string `json:"capabilities,omitempty"` // ClientAddress: Client address for the player creating the room. ClientAddress *RoomClientAddress `json:"clientAddress,omitempty"` // InvitedPlayerIds: The player IDs to invite to the room. InvitedPlayerIds []string `json:"invitedPlayerIds,omitempty"` // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#roomCreateRequest. Kind string `json:"kind,omitempty"` // NetworkDiagnostics: Network diagnostics for the client creating the // room. NetworkDiagnostics *NetworkDiagnostics `json:"networkDiagnostics,omitempty"` // RequestId: A randomly generated numeric ID. This number is used at // the server to ensure that the request is handled correctly across // retries. RequestId int64 `json:"requestId,omitempty,string"` // Variant: The variant / mode of the application to be played. This can // be any integer value, or left blank. You should use a small number of // variants to keep the auto-matching pool as large as possible. Variant int64 `json:"variant,omitempty"` // ForceSendFields is a list of field names (e.g. // "AutoMatchingCriteria") to unconditionally include in API requests. // By default, fields with empty values are omitted from API requests. // However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AutoMatchingCriteria") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*RoomCreateRequest) MarshalJSON ¶
func (s *RoomCreateRequest) MarshalJSON() ([]byte, error)
type RoomJoinRequest ¶
RoomJoinRequest: This is a JSON template for a join room request.
type RoomJoinRequest struct { // Capabilities: The capabilities that this client supports for realtime // communication. Capabilities []string `json:"capabilities,omitempty"` // ClientAddress: Client address for the player joining the room. ClientAddress *RoomClientAddress `json:"clientAddress,omitempty"` // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#roomJoinRequest. Kind string `json:"kind,omitempty"` // NetworkDiagnostics: Network diagnostics for the client joining the // room. NetworkDiagnostics *NetworkDiagnostics `json:"networkDiagnostics,omitempty"` // ForceSendFields is a list of field names (e.g. "Capabilities") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Capabilities") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*RoomJoinRequest) MarshalJSON ¶
func (s *RoomJoinRequest) MarshalJSON() ([]byte, error)
type RoomLeaveDiagnostics ¶
RoomLeaveDiagnostics: This is a JSON template for room leave diagnostics.
type RoomLeaveDiagnostics struct { // AndroidNetworkSubtype: Android network subtype. // http://developer.android.com/reference/android/net/NetworkInfo.html#getSubtype() AndroidNetworkSubtype int64 `json:"androidNetworkSubtype,omitempty"` // AndroidNetworkType: Android network type. // http://developer.android.com/reference/android/net/NetworkInfo.html#getType() AndroidNetworkType int64 `json:"androidNetworkType,omitempty"` // IosNetworkType: iOS network type as defined in Reachability.h. IosNetworkType int64 `json:"iosNetworkType,omitempty"` // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#roomLeaveDiagnostics. Kind string `json:"kind,omitempty"` // NetworkOperatorCode: The MCC+MNC code for the client's network // connection. On Android: // http://developer.android.com/reference/android/telephony/TelephonyManager.html#getNetworkOperator() On iOS, see: // https://developer.apple.com/library/ios/documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html NetworkOperatorCode string `json:"networkOperatorCode,omitempty"` // NetworkOperatorName: The name of the carrier of the client's network // connection. On Android: // http://developer.android.com/reference/android/telephony/TelephonyManager.html#getNetworkOperatorName() On iOS: // https://developer.apple.com/library/ios/documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html#//apple_ref/occ/instp/CTCarrier/carrierName NetworkOperatorName string `json:"networkOperatorName,omitempty"` // PeerSession: Diagnostics about all peer sessions. PeerSession []*PeerSessionDiagnostics `json:"peerSession,omitempty"` // SocketsUsed: Whether or not sockets were used. SocketsUsed bool `json:"socketsUsed,omitempty"` // ForceSendFields is a list of field names (e.g. // "AndroidNetworkSubtype") to unconditionally include in API requests. // By default, fields with empty values are omitted from API requests. // However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AndroidNetworkSubtype") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*RoomLeaveDiagnostics) MarshalJSON ¶
func (s *RoomLeaveDiagnostics) MarshalJSON() ([]byte, error)
type RoomLeaveRequest ¶
RoomLeaveRequest: This is a JSON template for a leave room request.
type RoomLeaveRequest struct { // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#roomLeaveRequest. Kind string `json:"kind,omitempty"` // LeaveDiagnostics: Diagnostics for a player leaving the room. LeaveDiagnostics *RoomLeaveDiagnostics `json:"leaveDiagnostics,omitempty"` // Reason: Reason for leaving the match. // Possible values are: // - "PLAYER_LEFT" - The player chose to leave the room.. // - "GAME_LEFT" - The game chose to remove the player from the room. // - "REALTIME_ABANDONED" - The player switched to another application // and abandoned the room. // - "REALTIME_PEER_CONNECTION_FAILURE" - The client was unable to // establish a connection to other peer(s). // - "REALTIME_SERVER_CONNECTION_FAILURE" - The client was unable to // communicate with the server. // - "REALTIME_SERVER_ERROR" - The client received an error response // when it tried to communicate with the server. // - "REALTIME_TIMEOUT" - The client timed out while waiting for a room. // // - "REALTIME_CLIENT_DISCONNECTING" - The client disconnects without // first calling Leave. // - "REALTIME_SIGN_OUT" - The user signed out of G+ while in the room. // // - "REALTIME_GAME_CRASHED" - The game crashed. // - "REALTIME_ROOM_SERVICE_CRASHED" - RoomAndroidService crashed. // - "REALTIME_DIFFERENT_CLIENT_ROOM_OPERATION" - Another client is // trying to enter a room. // - "REALTIME_SAME_CLIENT_ROOM_OPERATION" - The same client is trying // to enter a new room. Reason string `json:"reason,omitempty"` // ForceSendFields is a list of field names (e.g. "Kind") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Kind") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*RoomLeaveRequest) MarshalJSON ¶
func (s *RoomLeaveRequest) MarshalJSON() ([]byte, error)
type RoomList ¶
RoomList: This is a JSON template for a list of rooms.
type RoomList struct { // Items: The rooms. Items []*Room `json:"items,omitempty"` // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#roomList. Kind string `json:"kind,omitempty"` // NextPageToken: The pagination token for the next page of results. NextPageToken string `json:"nextPageToken,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Items") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Items") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*RoomList) MarshalJSON ¶
func (s *RoomList) MarshalJSON() ([]byte, error)
type RoomModification ¶
RoomModification: This is a JSON template for room modification metadata.
type RoomModification struct { // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#roomModification. Kind string `json:"kind,omitempty"` // ModifiedTimestampMillis: The timestamp at which they modified the // room, in milliseconds since the epoch in UTC. ModifiedTimestampMillis int64 `json:"modifiedTimestampMillis,omitempty,string"` // ParticipantId: The ID of the participant that modified the room. ParticipantId string `json:"participantId,omitempty"` // ForceSendFields is a list of field names (e.g. "Kind") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Kind") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*RoomModification) MarshalJSON ¶
func (s *RoomModification) MarshalJSON() ([]byte, error)
type RoomP2PStatus ¶
RoomP2PStatus: This is a JSON template for an update on the status of a peer in a room.
type RoomP2PStatus struct { // ConnectionSetupLatencyMillis: The amount of time in milliseconds it // took to establish connections with this peer. ConnectionSetupLatencyMillis int64 `json:"connectionSetupLatencyMillis,omitempty"` // Error: The error code in event of a failure. // Possible values are: // - "P2P_FAILED" - The client failed to establish a P2P connection with // the peer. // - "PRESENCE_FAILED" - The client failed to register to receive P2P // connections. // - "RELAY_SERVER_FAILED" - The client received an error when trying to // use the relay server to establish a P2P connection with the peer. Error string `json:"error,omitempty"` // ErrorReason: More detailed diagnostic message returned in event of a // failure. ErrorReason string `json:"error_reason,omitempty"` // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#roomP2PStatus. Kind string `json:"kind,omitempty"` // ParticipantId: The ID of the participant. ParticipantId string `json:"participantId,omitempty"` // Status: The status of the peer in the room. // Possible values are: // - "CONNECTION_ESTABLISHED" - The client established a P2P connection // with the peer. // - "CONNECTION_FAILED" - The client failed to establish directed // presence with the peer. Status string `json:"status,omitempty"` // UnreliableRoundtripLatencyMillis: The amount of time in milliseconds // it took to send packets back and forth on the unreliable channel with // this peer. UnreliableRoundtripLatencyMillis int64 `json:"unreliableRoundtripLatencyMillis,omitempty"` // ForceSendFields is a list of field names (e.g. // "ConnectionSetupLatencyMillis") to unconditionally include in API // requests. By default, fields with empty values are omitted from API // requests. However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. // "ConnectionSetupLatencyMillis") to include in API requests with the // JSON null value. By default, fields with empty values are omitted // from API requests. However, any field with an empty value appearing // in NullFields will be sent to the server as null. It is an error if a // field in this list has a non-empty value. This may be used to include // null fields in Patch requests. NullFields []string `json:"-"` }
func (*RoomP2PStatus) MarshalJSON ¶
func (s *RoomP2PStatus) MarshalJSON() ([]byte, error)
type RoomP2PStatuses ¶
RoomP2PStatuses: This is a JSON template for an update on the status of peers in a room.
type RoomP2PStatuses struct { // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#roomP2PStatuses. Kind string `json:"kind,omitempty"` // Updates: The updates for the peers. Updates []*RoomP2PStatus `json:"updates,omitempty"` // ForceSendFields is a list of field names (e.g. "Kind") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Kind") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*RoomP2PStatuses) MarshalJSON ¶
func (s *RoomP2PStatuses) MarshalJSON() ([]byte, error)
type RoomParticipant ¶
RoomParticipant: This is a JSON template for a participant in a room.
type RoomParticipant struct { // AutoMatched: True if this participant was auto-matched with the // requesting player. AutoMatched bool `json:"autoMatched,omitempty"` // AutoMatchedPlayer: Information about a player that has been // anonymously auto-matched against the requesting player. (Either // player or autoMatchedPlayer will be set.) AutoMatchedPlayer *AnonymousPlayer `json:"autoMatchedPlayer,omitempty"` // Capabilities: The capabilities which can be used when communicating // with this participant. Capabilities []string `json:"capabilities,omitempty"` // ClientAddress: Client address for the participant. ClientAddress *RoomClientAddress `json:"clientAddress,omitempty"` // Connected: True if this participant is in the fully connected set of // peers in the room. Connected bool `json:"connected,omitempty"` // Id: An identifier for the participant in the scope of the room. // Cannot be used to identify a player across rooms or in other // contexts. Id string `json:"id,omitempty"` // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#roomParticipant. Kind string `json:"kind,omitempty"` // LeaveReason: The reason the participant left the room; populated if // the participant status is PARTICIPANT_LEFT. // Possible values are: // - "PLAYER_LEFT" - The player explicitly chose to leave the room. // - "GAME_LEFT" - The game chose to remove the player from the room. // - "ABANDONED" - The player switched to another application and // abandoned the room. // - "PEER_CONNECTION_FAILURE" - The client was unable to establish or // maintain a connection to other peer(s) in the room. // - "SERVER_ERROR" - The client received an error response when it // tried to communicate with the server. // - "TIMEOUT" - The client timed out while waiting for players to join // and connect. // - "PRESENCE_FAILURE" - The client's XMPP connection ended abruptly. LeaveReason string `json:"leaveReason,omitempty"` // Player: Information about the player. Not populated if this player // was anonymously auto-matched against the requesting player. (Either // player or autoMatchedPlayer will be set.) Player *Player `json:"player,omitempty"` // Status: The status of the participant with respect to the // room. // Possible values are: // - "PARTICIPANT_INVITED" - The participant has been invited to join // the room, but has not yet responded. // - "PARTICIPANT_JOINED" - The participant has joined the room (either // after creating it or accepting an invitation.) // - "PARTICIPANT_DECLINED" - The participant declined an invitation to // join the room. // - "PARTICIPANT_LEFT" - The participant joined the room and then left // it. Status string `json:"status,omitempty"` // ForceSendFields is a list of field names (e.g. "AutoMatched") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AutoMatched") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*RoomParticipant) MarshalJSON ¶
func (s *RoomParticipant) MarshalJSON() ([]byte, error)
type RoomStatus ¶
RoomStatus: This is a JSON template for the status of a room that the player has joined.
type RoomStatus struct { // AutoMatchingStatus: Auto-matching status for this room. Not set if // the room is not currently in the automatching queue. AutoMatchingStatus *RoomAutoMatchStatus `json:"autoMatchingStatus,omitempty"` // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#roomStatus. Kind string `json:"kind,omitempty"` // Participants: The participants involved in the room, along with their // statuses. Includes participants who have left or declined // invitations. Participants []*RoomParticipant `json:"participants,omitempty"` // RoomId: Globally unique ID for a room. RoomId string `json:"roomId,omitempty"` // Status: The status of the room. // Possible values are: // - "ROOM_INVITING" - One or more players have been invited and not // responded. // - "ROOM_AUTO_MATCHING" - One or more slots need to be filled by // auto-matching. // - "ROOM_CONNECTING" - Players have joined are connecting to each // other (either before or after auto-matching). // - "ROOM_ACTIVE" - All players have joined and connected to each // other. // - "ROOM_DELETED" - All joined players have left. Status string `json:"status,omitempty"` // StatusVersion: The version of the status for the room: an increasing // counter, used by the client to ignore out-of-order updates to room // status. StatusVersion int64 `json:"statusVersion,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "AutoMatchingStatus") // to unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AutoMatchingStatus") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*RoomStatus) MarshalJSON ¶
func (s *RoomStatus) MarshalJSON() ([]byte, error)
type RoomsCreateCall ¶
type RoomsCreateCall struct {
// contains filtered or unexported fields
}
func (*RoomsCreateCall) ConsistencyToken ¶
func (c *RoomsCreateCall) ConsistencyToken(consistencyToken int64) *RoomsCreateCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*RoomsCreateCall) Context ¶
func (c *RoomsCreateCall) Context(ctx context.Context) *RoomsCreateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*RoomsCreateCall) Do ¶
func (c *RoomsCreateCall) Do(opts ...googleapi.CallOption) (*Room, error)
Do executes the "games.rooms.create" call. Exactly one of *Room or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Room.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 (*RoomsCreateCall) Fields ¶
func (c *RoomsCreateCall) Fields(s ...googleapi.Field) *RoomsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*RoomsCreateCall) Header ¶
func (c *RoomsCreateCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*RoomsCreateCall) Language ¶
func (c *RoomsCreateCall) Language(language string) *RoomsCreateCall
Language sets the optional parameter "language": The preferred language to use for strings returned by this method.
type RoomsDeclineCall ¶
type RoomsDeclineCall struct {
// contains filtered or unexported fields
}
func (*RoomsDeclineCall) ConsistencyToken ¶
func (c *RoomsDeclineCall) ConsistencyToken(consistencyToken int64) *RoomsDeclineCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*RoomsDeclineCall) Context ¶
func (c *RoomsDeclineCall) Context(ctx context.Context) *RoomsDeclineCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*RoomsDeclineCall) Do ¶
func (c *RoomsDeclineCall) Do(opts ...googleapi.CallOption) (*Room, error)
Do executes the "games.rooms.decline" call. Exactly one of *Room or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Room.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 (*RoomsDeclineCall) Fields ¶
func (c *RoomsDeclineCall) Fields(s ...googleapi.Field) *RoomsDeclineCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*RoomsDeclineCall) Header ¶
func (c *RoomsDeclineCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*RoomsDeclineCall) Language ¶
func (c *RoomsDeclineCall) Language(language string) *RoomsDeclineCall
Language sets the optional parameter "language": The preferred language to use for strings returned by this method.
type RoomsDismissCall ¶
type RoomsDismissCall struct {
// contains filtered or unexported fields
}
func (*RoomsDismissCall) ConsistencyToken ¶
func (c *RoomsDismissCall) ConsistencyToken(consistencyToken int64) *RoomsDismissCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*RoomsDismissCall) Context ¶
func (c *RoomsDismissCall) Context(ctx context.Context) *RoomsDismissCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*RoomsDismissCall) Do ¶
func (c *RoomsDismissCall) Do(opts ...googleapi.CallOption) error
Do executes the "games.rooms.dismiss" call.
func (*RoomsDismissCall) Fields ¶
func (c *RoomsDismissCall) Fields(s ...googleapi.Field) *RoomsDismissCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*RoomsDismissCall) Header ¶
func (c *RoomsDismissCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type RoomsGetCall ¶
type RoomsGetCall struct {
// contains filtered or unexported fields
}
func (*RoomsGetCall) ConsistencyToken ¶
func (c *RoomsGetCall) ConsistencyToken(consistencyToken int64) *RoomsGetCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*RoomsGetCall) Context ¶
func (c *RoomsGetCall) Context(ctx context.Context) *RoomsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*RoomsGetCall) Do ¶
func (c *RoomsGetCall) Do(opts ...googleapi.CallOption) (*Room, error)
Do executes the "games.rooms.get" call. Exactly one of *Room or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Room.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 (*RoomsGetCall) Fields ¶
func (c *RoomsGetCall) Fields(s ...googleapi.Field) *RoomsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*RoomsGetCall) Header ¶
func (c *RoomsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*RoomsGetCall) IfNoneMatch ¶
func (c *RoomsGetCall) IfNoneMatch(entityTag string) *RoomsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*RoomsGetCall) Language ¶
func (c *RoomsGetCall) Language(language string) *RoomsGetCall
Language sets the optional parameter "language": The preferred language to use for strings returned by this method.
type RoomsJoinCall ¶
type RoomsJoinCall struct {
// contains filtered or unexported fields
}
func (*RoomsJoinCall) ConsistencyToken ¶
func (c *RoomsJoinCall) ConsistencyToken(consistencyToken int64) *RoomsJoinCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*RoomsJoinCall) Context ¶
func (c *RoomsJoinCall) Context(ctx context.Context) *RoomsJoinCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*RoomsJoinCall) Do ¶
func (c *RoomsJoinCall) Do(opts ...googleapi.CallOption) (*Room, error)
Do executes the "games.rooms.join" call. Exactly one of *Room or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Room.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 (*RoomsJoinCall) Fields ¶
func (c *RoomsJoinCall) Fields(s ...googleapi.Field) *RoomsJoinCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*RoomsJoinCall) Header ¶
func (c *RoomsJoinCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*RoomsJoinCall) Language ¶
func (c *RoomsJoinCall) Language(language string) *RoomsJoinCall
Language sets the optional parameter "language": The preferred language to use for strings returned by this method.
type RoomsLeaveCall ¶
type RoomsLeaveCall struct {
// contains filtered or unexported fields
}
func (*RoomsLeaveCall) ConsistencyToken ¶
func (c *RoomsLeaveCall) ConsistencyToken(consistencyToken int64) *RoomsLeaveCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*RoomsLeaveCall) Context ¶
func (c *RoomsLeaveCall) Context(ctx context.Context) *RoomsLeaveCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*RoomsLeaveCall) Do ¶
func (c *RoomsLeaveCall) Do(opts ...googleapi.CallOption) (*Room, error)
Do executes the "games.rooms.leave" call. Exactly one of *Room or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Room.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 (*RoomsLeaveCall) Fields ¶
func (c *RoomsLeaveCall) Fields(s ...googleapi.Field) *RoomsLeaveCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*RoomsLeaveCall) Header ¶
func (c *RoomsLeaveCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*RoomsLeaveCall) Language ¶
func (c *RoomsLeaveCall) Language(language string) *RoomsLeaveCall
Language sets the optional parameter "language": The preferred language to use for strings returned by this method.
type RoomsListCall ¶
type RoomsListCall struct {
// contains filtered or unexported fields
}
func (*RoomsListCall) ConsistencyToken ¶
func (c *RoomsListCall) ConsistencyToken(consistencyToken int64) *RoomsListCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*RoomsListCall) Context ¶
func (c *RoomsListCall) Context(ctx context.Context) *RoomsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*RoomsListCall) Do ¶
func (c *RoomsListCall) Do(opts ...googleapi.CallOption) (*RoomList, error)
Do executes the "games.rooms.list" call. Exactly one of *RoomList or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *RoomList.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 (*RoomsListCall) Fields ¶
func (c *RoomsListCall) Fields(s ...googleapi.Field) *RoomsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*RoomsListCall) Header ¶
func (c *RoomsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*RoomsListCall) IfNoneMatch ¶
func (c *RoomsListCall) IfNoneMatch(entityTag string) *RoomsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*RoomsListCall) Language ¶
func (c *RoomsListCall) Language(language string) *RoomsListCall
Language sets the optional parameter "language": The preferred language to use for strings returned by this method.
func (*RoomsListCall) MaxResults ¶
func (c *RoomsListCall) MaxResults(maxResults int64) *RoomsListCall
MaxResults sets the optional parameter "maxResults": The maximum number of rooms to return in the response, used for paging. For any response, the actual number of rooms to return may be less than the specified maxResults.
func (*RoomsListCall) PageToken ¶
func (c *RoomsListCall) PageToken(pageToken string) *RoomsListCall
PageToken sets the optional parameter "pageToken": The token returned by the previous request.
func (*RoomsListCall) Pages ¶
func (c *RoomsListCall) Pages(ctx context.Context, f func(*RoomList) 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 RoomsReportStatusCall ¶
type RoomsReportStatusCall struct {
// contains filtered or unexported fields
}
func (*RoomsReportStatusCall) ConsistencyToken ¶
func (c *RoomsReportStatusCall) ConsistencyToken(consistencyToken int64) *RoomsReportStatusCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*RoomsReportStatusCall) Context ¶
func (c *RoomsReportStatusCall) Context(ctx context.Context) *RoomsReportStatusCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*RoomsReportStatusCall) Do ¶
func (c *RoomsReportStatusCall) Do(opts ...googleapi.CallOption) (*RoomStatus, error)
Do executes the "games.rooms.reportStatus" call. Exactly one of *RoomStatus or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *RoomStatus.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 (*RoomsReportStatusCall) Fields ¶
func (c *RoomsReportStatusCall) Fields(s ...googleapi.Field) *RoomsReportStatusCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*RoomsReportStatusCall) Header ¶
func (c *RoomsReportStatusCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*RoomsReportStatusCall) Language ¶
func (c *RoomsReportStatusCall) Language(language string) *RoomsReportStatusCall
Language sets the optional parameter "language": The preferred language to use for strings returned by this method.
type RoomsService ¶
type RoomsService struct {
// contains filtered or unexported fields
}
func NewRoomsService ¶
func NewRoomsService(s *Service) *RoomsService
func (*RoomsService) Create ¶
func (r *RoomsService) Create(roomcreaterequest *RoomCreateRequest) *RoomsCreateCall
Create: Create a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
func (*RoomsService) Decline ¶
func (r *RoomsService) Decline(roomId string) *RoomsDeclineCall
Decline: Decline an invitation to join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
func (*RoomsService) Dismiss ¶
func (r *RoomsService) Dismiss(roomId string) *RoomsDismissCall
Dismiss: Dismiss an invitation to join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
func (*RoomsService) Get ¶
func (r *RoomsService) Get(roomId string) *RoomsGetCall
Get: Get the data for a room.
func (*RoomsService) Join ¶
func (r *RoomsService) Join(roomId string, roomjoinrequest *RoomJoinRequest) *RoomsJoinCall
Join: Join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
func (*RoomsService) Leave ¶
func (r *RoomsService) Leave(roomId string, roomleaverequest *RoomLeaveRequest) *RoomsLeaveCall
Leave: Leave a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
func (*RoomsService) List ¶
func (r *RoomsService) List() *RoomsListCall
List: Returns invitations to join rooms.
func (*RoomsService) ReportStatus ¶
func (r *RoomsService) ReportStatus(roomId string, roomp2pstatuses *RoomP2PStatuses) *RoomsReportStatusCall
ReportStatus: Updates sent by a client reporting the status of peers in a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
type ScoreSubmission ¶
ScoreSubmission: This is a JSON template for a request to submit a score to leaderboards.
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Kind") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*ScoreSubmission) MarshalJSON ¶
func (s *ScoreSubmission) MarshalJSON() ([]byte, error)
type ScoresGetCall ¶
type ScoresGetCall struct {
// contains filtered or unexported fields
}
func (*ScoresGetCall) ConsistencyToken ¶
func (c *ScoresGetCall) ConsistencyToken(consistencyToken int64) *ScoresGetCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*ScoresGetCall) Context ¶
func (c *ScoresGetCall) Context(ctx context.Context) *ScoresGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ScoresGetCall) Do ¶
func (c *ScoresGetCall) Do(opts ...googleapi.CallOption) (*PlayerLeaderboardScoreListResponse, error)
Do executes the "games.scores.get" call. Exactly one of *PlayerLeaderboardScoreListResponse or error will be non-nil. 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 information.
func (*ScoresGetCall) Header ¶
func (c *ScoresGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ScoresGetCall) IfNoneMatch ¶
func (c *ScoresGetCall) IfNoneMatch(entityTag string) *ScoresGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*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 public and social ranks. "PUBLIC" - Retrieve public ranks, if the player is sharing their
gameplay activity publicly.
"SOCIAL" - Retrieve the social rank.
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 ¶
func (c *ScoresGetCall) Pages(ctx context.Context, f func(*PlayerLeaderboardScoreListResponse) 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 ScoresListCall ¶
type ScoresListCall struct {
// contains filtered or unexported fields
}
func (*ScoresListCall) ConsistencyToken ¶
func (c *ScoresListCall) ConsistencyToken(consistencyToken int64) *ScoresListCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*ScoresListCall) Context ¶
func (c *ScoresListCall) Context(ctx context.Context) *ScoresListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ScoresListCall) Do ¶
func (c *ScoresListCall) Do(opts ...googleapi.CallOption) (*LeaderboardScores, error)
Do executes the "games.scores.list" call. Exactly one of *LeaderboardScores or error will be non-nil. 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 information.
func (*ScoresListCall) Header ¶
func (c *ScoresListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ScoresListCall) IfNoneMatch ¶
func (c *ScoresListCall) IfNoneMatch(entityTag string) *ScoresListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*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) ConsistencyToken ¶
func (c *ScoresListWindowCall) ConsistencyToken(consistencyToken int64) *ScoresListWindowCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*ScoresListWindowCall) Context ¶
func (c *ScoresListWindowCall) Context(ctx context.Context) *ScoresListWindowCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ScoresListWindowCall) Do ¶
func (c *ScoresListWindowCall) Do(opts ...googleapi.CallOption) (*LeaderboardScores, error)
Do executes the "games.scores.listWindow" call. Exactly one of *LeaderboardScores or error will be non-nil. 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 ¶
func (c *ScoresListWindowCall) Fields(s ...googleapi.Field) *ScoresListWindowCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ScoresListWindowCall) Header ¶
func (c *ScoresListWindowCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ScoresListWindowCall) IfNoneMatch ¶
func (c *ScoresListWindowCall) IfNoneMatch(entityTag string) *ScoresListWindowCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*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 ¶
func (c *ScoresListWindowCall) 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.
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'.
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.
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.
func (*ScoresService) Submit ¶
func (r *ScoresService) Submit(leaderboardId string, score int64) *ScoresSubmitCall
Submit: Submits a score to the specified leaderboard.
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) ConsistencyToken ¶
func (c *ScoresSubmitCall) ConsistencyToken(consistencyToken int64) *ScoresSubmitCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*ScoresSubmitCall) Context ¶
func (c *ScoresSubmitCall) Context(ctx context.Context) *ScoresSubmitCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ScoresSubmitCall) Do ¶
func (c *ScoresSubmitCall) Do(opts ...googleapi.CallOption) (*PlayerScoreResponse, error)
Do executes the "games.scores.submit" call. Exactly one of *PlayerScoreResponse or error will be non-nil. 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 ¶
func (c *ScoresSubmitCall) Fields(s ...googleapi.Field) *ScoresSubmitCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ScoresSubmitCall) Header ¶
func (c *ScoresSubmitCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP 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) ConsistencyToken ¶
func (c *ScoresSubmitMultipleCall) ConsistencyToken(consistencyToken int64) *ScoresSubmitMultipleCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*ScoresSubmitMultipleCall) Context ¶
func (c *ScoresSubmitMultipleCall) Context(ctx context.Context) *ScoresSubmitMultipleCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ScoresSubmitMultipleCall) Do ¶
func (c *ScoresSubmitMultipleCall) Do(opts ...googleapi.CallOption) (*PlayerScoreListResponse, error)
Do executes the "games.scores.submitMultiple" call. Exactly one of *PlayerScoreListResponse or error will be non-nil. 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 ¶
func (c *ScoresSubmitMultipleCall) Fields(s ...googleapi.Field) *ScoresSubmitMultipleCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ScoresSubmitMultipleCall) Header ¶
func (c *ScoresSubmitMultipleCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ScoresSubmitMultipleCall) Language ¶
func (c *ScoresSubmitMultipleCall) Language(language string) *ScoresSubmitMultipleCall
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 AchievementDefinitions *AchievementDefinitionsService Achievements *AchievementsService Applications *ApplicationsService Events *EventsService Leaderboards *LeaderboardsService Metagame *MetagameService Players *PlayersService Pushtokens *PushtokensService QuestMilestones *QuestMilestonesService Quests *QuestsService Revisions *RevisionsService Rooms *RoomsService Scores *ScoresService Snapshots *SnapshotsService TurnBasedMatches *TurnBasedMatchesService // contains filtered or unexported fields }
func New ¶
func New(client *http.Client) (*Service, error)
type Snapshot ¶
Snapshot: This is a JSON template for an snapshot object.
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 are: // - "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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CoverImage") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*Snapshot) MarshalJSON ¶
func (s *Snapshot) MarshalJSON() ([]byte, error)
type SnapshotImage ¶
SnapshotImage: This is a JSON template for an image of a snapshot.
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Height") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*SnapshotImage) MarshalJSON ¶
func (s *SnapshotImage) MarshalJSON() ([]byte, error)
type SnapshotListResponse ¶
SnapshotListResponse: This is a JSON template for a list of snapshot objects.
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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Items") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*SnapshotListResponse) MarshalJSON ¶
func (s *SnapshotListResponse) MarshalJSON() ([]byte, error)
type SnapshotsGetCall ¶
type SnapshotsGetCall struct {
// contains filtered or unexported fields
}
func (*SnapshotsGetCall) ConsistencyToken ¶
func (c *SnapshotsGetCall) ConsistencyToken(consistencyToken int64) *SnapshotsGetCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*SnapshotsGetCall) Context ¶
func (c *SnapshotsGetCall) Context(ctx context.Context) *SnapshotsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*SnapshotsGetCall) Do ¶
func (c *SnapshotsGetCall) Do(opts ...googleapi.CallOption) (*Snapshot, error)
Do executes the "games.snapshots.get" call. Exactly one of *Snapshot or error will be non-nil. 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 ¶
func (c *SnapshotsGetCall) Fields(s ...googleapi.Field) *SnapshotsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*SnapshotsGetCall) Header ¶
func (c *SnapshotsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*SnapshotsGetCall) IfNoneMatch ¶
func (c *SnapshotsGetCall) IfNoneMatch(entityTag string) *SnapshotsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*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) ConsistencyToken ¶
func (c *SnapshotsListCall) ConsistencyToken(consistencyToken int64) *SnapshotsListCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*SnapshotsListCall) Context ¶
func (c *SnapshotsListCall) Context(ctx context.Context) *SnapshotsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*SnapshotsListCall) Do ¶
func (c *SnapshotsListCall) Do(opts ...googleapi.CallOption) (*SnapshotListResponse, error)
Do executes the "games.snapshots.list" call. Exactly one of *SnapshotListResponse or error will be non-nil. 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 ¶
func (c *SnapshotsListCall) Fields(s ...googleapi.Field) *SnapshotsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*SnapshotsListCall) Header ¶
func (c *SnapshotsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*SnapshotsListCall) IfNoneMatch ¶
func (c *SnapshotsListCall) IfNoneMatch(entityTag string) *SnapshotsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*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 ¶
func (c *SnapshotsListCall) Pages(ctx context.Context, f func(*SnapshotListResponse) 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 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.
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.
type TurnBasedAutoMatchingCriteria ¶
TurnBasedAutoMatchingCriteria: This is a JSON template for an turn-based auto-match criteria object.
type TurnBasedAutoMatchingCriteria struct { // ExclusiveBitmask: A bitmask indicating when auto-matches are valid. // When ANDed with other exclusive bitmasks, the result must be zero. // Can be used to support exclusive roles within a game. ExclusiveBitmask int64 `json:"exclusiveBitmask,omitempty,string"` // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#turnBasedAutoMatchingCriteria. Kind string `json:"kind,omitempty"` // MaxAutoMatchingPlayers: The maximum number of players that should be // added to the match by auto-matching. MaxAutoMatchingPlayers int64 `json:"maxAutoMatchingPlayers,omitempty"` // MinAutoMatchingPlayers: The minimum number of players that should be // added to the match by auto-matching. MinAutoMatchingPlayers int64 `json:"minAutoMatchingPlayers,omitempty"` // ForceSendFields is a list of field names (e.g. "ExclusiveBitmask") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ExclusiveBitmask") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*TurnBasedAutoMatchingCriteria) MarshalJSON ¶
func (s *TurnBasedAutoMatchingCriteria) MarshalJSON() ([]byte, error)
type TurnBasedMatch ¶
TurnBasedMatch: This is a JSON template for a turn-based match resource object.
type TurnBasedMatch struct { // ApplicationId: The ID of the application being played. ApplicationId string `json:"applicationId,omitempty"` // AutoMatchingCriteria: Criteria for auto-matching players into this // match. AutoMatchingCriteria *TurnBasedAutoMatchingCriteria `json:"autoMatchingCriteria,omitempty"` // CreationDetails: Details about the match creation. CreationDetails *TurnBasedMatchModification `json:"creationDetails,omitempty"` // Data: The data / game state for this match. Data *TurnBasedMatchData `json:"data,omitempty"` // Description: This short description is generated by our servers based // on turn state and is localized and worded relative to the player // requesting the match. It is intended to be displayed when the match // is shown in a list. Description string `json:"description,omitempty"` // InviterId: The ID of the participant that invited the user to the // match. Not set if the user was not invited to the match. InviterId string `json:"inviterId,omitempty"` // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#turnBasedMatch. Kind string `json:"kind,omitempty"` // LastUpdateDetails: Details about the last update to the match. LastUpdateDetails *TurnBasedMatchModification `json:"lastUpdateDetails,omitempty"` // MatchId: Globally unique ID for a turn-based match. MatchId string `json:"matchId,omitempty"` // MatchNumber: The number of the match in a chain of rematches. Will be // set to 1 for the first match and incremented by 1 for each rematch. MatchNumber int64 `json:"matchNumber,omitempty"` // MatchVersion: The version of this match: an increasing counter, used // to avoid out-of-date updates to the match. MatchVersion int64 `json:"matchVersion,omitempty"` // Participants: The participants involved in the match, along with // their statuses. Includes participants who have left or declined // invitations. Participants []*TurnBasedMatchParticipant `json:"participants,omitempty"` // PendingParticipantId: The ID of the participant that is taking a // turn. PendingParticipantId string `json:"pendingParticipantId,omitempty"` // PreviousMatchData: The data / game state for the previous match; set // for the first turn of rematches only. PreviousMatchData *TurnBasedMatchData `json:"previousMatchData,omitempty"` // RematchId: The ID of a rematch of this match. Only set for completed // matches that have been rematched. RematchId string `json:"rematchId,omitempty"` // Results: The results reported for this match. Results []*ParticipantResult `json:"results,omitempty"` // Status: The status of the match. // Possible values are: // - "MATCH_AUTO_MATCHING" - One or more slots need to be filled by // auto-matching; the match cannot be established until they are filled. // // - "MATCH_ACTIVE" - The match has started. // - "MATCH_COMPLETE" - The match has finished. // - "MATCH_CANCELED" - The match was canceled. // - "MATCH_EXPIRED" - The match expired due to inactivity. // - "MATCH_DELETED" - The match should no longer be shown on the // client. Returned only for tombstones for matches when sync is called. Status string `json:"status,omitempty"` // UserMatchStatus: The status of the current user in the match. Derived // from the match type, match status, the user's participant status, and // the pending participant for the match. // Possible values are: // - "USER_INVITED" - The user has been invited to join the match and // has not responded yet. // - "USER_AWAITING_TURN" - The user is waiting for their turn. // - "USER_TURN" - The user has an action to take in the match. // - "USER_MATCH_COMPLETED" - The match has ended (it is completed, // canceled, or expired.) UserMatchStatus string `json:"userMatchStatus,omitempty"` // Variant: The variant / mode of the application being played; can be // any integer value, or left blank. Variant int64 `json:"variant,omitempty"` // WithParticipantId: The ID of another participant in the match that // can be used when describing the participants the user is playing // with. WithParticipantId string `json:"withParticipantId,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "ApplicationId") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ApplicationId") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*TurnBasedMatch) MarshalJSON ¶
func (s *TurnBasedMatch) MarshalJSON() ([]byte, error)
type TurnBasedMatchCreateRequest ¶
TurnBasedMatchCreateRequest: This is a JSON template for a turn-based match creation request.
type TurnBasedMatchCreateRequest struct { // AutoMatchingCriteria: Criteria for auto-matching players into this // match. AutoMatchingCriteria *TurnBasedAutoMatchingCriteria `json:"autoMatchingCriteria,omitempty"` // InvitedPlayerIds: The player ids to invite to the match. InvitedPlayerIds []string `json:"invitedPlayerIds,omitempty"` // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#turnBasedMatchCreateRequest. Kind string `json:"kind,omitempty"` // RequestId: A randomly generated numeric ID. This number is used at // the server to ensure that the request is handled correctly across // retries. RequestId int64 `json:"requestId,omitempty,string"` // Variant: The variant / mode of the application to be played. This can // be any integer value, or left blank. You should use a small number of // variants to keep the auto-matching pool as large as possible. Variant int64 `json:"variant,omitempty"` // ForceSendFields is a list of field names (e.g. // "AutoMatchingCriteria") to unconditionally include in API requests. // By default, fields with empty values are omitted from API requests. // However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AutoMatchingCriteria") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
func (*TurnBasedMatchCreateRequest) MarshalJSON ¶
func (s *TurnBasedMatchCreateRequest) MarshalJSON() ([]byte, error)
type TurnBasedMatchData ¶
TurnBasedMatchData: This is a JSON template for a turn-based match data object.
type TurnBasedMatchData struct { // Data: The byte representation of the data (limited to 128 kB), as a // Base64-encoded string with the URL_SAFE encoding option. Data string `json:"data,omitempty"` // DataAvailable: True if this match has data available but it wasn't // returned in a list response; fetching the match individually will // retrieve this data. DataAvailable bool `json:"dataAvailable,omitempty"` // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#turnBasedMatchData. Kind string `json:"kind,omitempty"` // ForceSendFields is a list of field names (e.g. "Data") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Data") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*TurnBasedMatchData) MarshalJSON ¶
func (s *TurnBasedMatchData) MarshalJSON() ([]byte, error)
type TurnBasedMatchDataRequest ¶
TurnBasedMatchDataRequest: This is a JSON template for sending a turn-based match data object.
type TurnBasedMatchDataRequest struct { // Data: The byte representation of the data (limited to 128 kB), as a // Base64-encoded string with the URL_SAFE encoding option. Data string `json:"data,omitempty"` // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#turnBasedMatchDataRequest. Kind string `json:"kind,omitempty"` // ForceSendFields is a list of field names (e.g. "Data") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Data") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*TurnBasedMatchDataRequest) MarshalJSON ¶
func (s *TurnBasedMatchDataRequest) MarshalJSON() ([]byte, error)
type TurnBasedMatchList ¶
TurnBasedMatchList: This is a JSON template for a list of turn-based matches.
type TurnBasedMatchList struct { // Items: The matches. Items []*TurnBasedMatch `json:"items,omitempty"` // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#turnBasedMatchList. Kind string `json:"kind,omitempty"` // NextPageToken: The pagination token for the next page of results. NextPageToken string `json:"nextPageToken,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Items") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Items") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*TurnBasedMatchList) MarshalJSON ¶
func (s *TurnBasedMatchList) MarshalJSON() ([]byte, error)
type TurnBasedMatchModification ¶
TurnBasedMatchModification: This is a JSON template for turn-based match modification metadata.
type TurnBasedMatchModification struct { // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#turnBasedMatchModification. Kind string `json:"kind,omitempty"` // ModifiedTimestampMillis: The timestamp at which they modified the // match, in milliseconds since the epoch in UTC. ModifiedTimestampMillis int64 `json:"modifiedTimestampMillis,omitempty,string"` // ParticipantId: The ID of the participant that modified the match. ParticipantId string `json:"participantId,omitempty"` // ForceSendFields is a list of field names (e.g. "Kind") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Kind") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*TurnBasedMatchModification) MarshalJSON ¶
func (s *TurnBasedMatchModification) MarshalJSON() ([]byte, error)
type TurnBasedMatchParticipant ¶
TurnBasedMatchParticipant: This is a JSON template for a participant in a turn-based match.
type TurnBasedMatchParticipant struct { // AutoMatched: True if this participant was auto-matched with the // requesting player. AutoMatched bool `json:"autoMatched,omitempty"` // AutoMatchedPlayer: Information about a player that has been // anonymously auto-matched against the requesting player. (Either // player or autoMatchedPlayer will be set.) AutoMatchedPlayer *AnonymousPlayer `json:"autoMatchedPlayer,omitempty"` // Id: An identifier for the participant in the scope of the match. // Cannot be used to identify a player across matches or in other // contexts. Id string `json:"id,omitempty"` // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#turnBasedMatchParticipant. Kind string `json:"kind,omitempty"` // Player: Information about the player. Not populated if this player // was anonymously auto-matched against the requesting player. (Either // player or autoMatchedPlayer will be set.) Player *Player `json:"player,omitempty"` // Status: The status of the participant with respect to the // match. // Possible values are: // - "PARTICIPANT_NOT_INVITED_YET" - The participant is slated to be // invited to the match, but the invitation has not been sent; the // invite will be sent when it becomes their turn. // - "PARTICIPANT_INVITED" - The participant has been invited to join // the match, but has not yet responded. // - "PARTICIPANT_JOINED" - The participant has joined the match (either // after creating it or accepting an invitation.) // - "PARTICIPANT_DECLINED" - The participant declined an invitation to // join the match. // - "PARTICIPANT_LEFT" - The participant joined the match and then left // it. // - "PARTICIPANT_FINISHED" - The participant finished playing in the // match. // - "PARTICIPANT_UNRESPONSIVE" - The participant did not take their // turn in the allotted time. Status string `json:"status,omitempty"` // ForceSendFields is a list of field names (e.g. "AutoMatched") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AutoMatched") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*TurnBasedMatchParticipant) MarshalJSON ¶
func (s *TurnBasedMatchParticipant) MarshalJSON() ([]byte, error)
type TurnBasedMatchRematch ¶
TurnBasedMatchRematch: This is a JSON template for a rematch response.
type TurnBasedMatchRematch struct { // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#turnBasedMatchRematch. Kind string `json:"kind,omitempty"` // PreviousMatch: The old match that the rematch was created from; will // be updated such that the rematchId field will point at the new match. PreviousMatch *TurnBasedMatch `json:"previousMatch,omitempty"` // Rematch: The newly created match; a rematch of the old match with the // same participants. Rematch *TurnBasedMatch `json:"rematch,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 values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Kind") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*TurnBasedMatchRematch) MarshalJSON ¶
func (s *TurnBasedMatchRematch) MarshalJSON() ([]byte, error)
type TurnBasedMatchResults ¶
TurnBasedMatchResults: This is a JSON template for a turn-based match results object.
type TurnBasedMatchResults struct { // Data: The final match data. Data *TurnBasedMatchDataRequest `json:"data,omitempty"` // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#turnBasedMatchResults. Kind string `json:"kind,omitempty"` // MatchVersion: The version of the match being updated. MatchVersion int64 `json:"matchVersion,omitempty"` // Results: The match results for the participants in the match. Results []*ParticipantResult `json:"results,omitempty"` // ForceSendFields is a list of field names (e.g. "Data") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Data") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*TurnBasedMatchResults) MarshalJSON ¶
func (s *TurnBasedMatchResults) MarshalJSON() ([]byte, error)
type TurnBasedMatchSync ¶
TurnBasedMatchSync: This is a JSON template for a list of turn-based matches returned from a sync.
type TurnBasedMatchSync struct { // Items: The matches. Items []*TurnBasedMatch `json:"items,omitempty"` // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#turnBasedMatchSync. Kind string `json:"kind,omitempty"` // MoreAvailable: True if there were more matches available to fetch at // the time the response was generated (which were not returned due to // page size limits.) MoreAvailable bool `json:"moreAvailable,omitempty"` // NextPageToken: The pagination token for the next page of results. NextPageToken string `json:"nextPageToken,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Items") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Items") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*TurnBasedMatchSync) MarshalJSON ¶
func (s *TurnBasedMatchSync) MarshalJSON() ([]byte, error)
type TurnBasedMatchTurn ¶
TurnBasedMatchTurn: This is a JSON template for the object representing a turn.
type TurnBasedMatchTurn struct { // Data: The shared game state data after the turn is over. Data *TurnBasedMatchDataRequest `json:"data,omitempty"` // Kind: Uniquely identifies the type of this resource. Value is always // the fixed string games#turnBasedMatchTurn. Kind string `json:"kind,omitempty"` // MatchVersion: The version of this match: an increasing counter, used // to avoid out-of-date updates to the match. MatchVersion int64 `json:"matchVersion,omitempty"` // PendingParticipantId: The ID of the participant who should take their // turn next. May be set to the current player's participant ID to // update match state without changing the turn. If not set, the match // will wait for other player(s) to join via automatching; this is only // valid if automatch criteria is set on the match with remaining slots // for automatched players. PendingParticipantId string `json:"pendingParticipantId,omitempty"` // Results: The match results for the participants in the match. Results []*ParticipantResult `json:"results,omitempty"` // ForceSendFields is a list of field names (e.g. "Data") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Data") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*TurnBasedMatchTurn) MarshalJSON ¶
func (s *TurnBasedMatchTurn) MarshalJSON() ([]byte, error)
type TurnBasedMatchesCancelCall ¶
type TurnBasedMatchesCancelCall struct {
// contains filtered or unexported fields
}
func (*TurnBasedMatchesCancelCall) ConsistencyToken ¶
func (c *TurnBasedMatchesCancelCall) ConsistencyToken(consistencyToken int64) *TurnBasedMatchesCancelCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*TurnBasedMatchesCancelCall) Context ¶
func (c *TurnBasedMatchesCancelCall) Context(ctx context.Context) *TurnBasedMatchesCancelCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*TurnBasedMatchesCancelCall) Do ¶
func (c *TurnBasedMatchesCancelCall) Do(opts ...googleapi.CallOption) error
Do executes the "games.turnBasedMatches.cancel" call.
func (*TurnBasedMatchesCancelCall) Fields ¶
func (c *TurnBasedMatchesCancelCall) Fields(s ...googleapi.Field) *TurnBasedMatchesCancelCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*TurnBasedMatchesCancelCall) Header ¶
func (c *TurnBasedMatchesCancelCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type TurnBasedMatchesCreateCall ¶
type TurnBasedMatchesCreateCall struct {
// contains filtered or unexported fields
}
func (*TurnBasedMatchesCreateCall) ConsistencyToken ¶
func (c *TurnBasedMatchesCreateCall) ConsistencyToken(consistencyToken int64) *TurnBasedMatchesCreateCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*TurnBasedMatchesCreateCall) Context ¶
func (c *TurnBasedMatchesCreateCall) Context(ctx context.Context) *TurnBasedMatchesCreateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*TurnBasedMatchesCreateCall) Do ¶
func (c *TurnBasedMatchesCreateCall) Do(opts ...googleapi.CallOption) (*TurnBasedMatch, error)
Do executes the "games.turnBasedMatches.create" call. Exactly one of *TurnBasedMatch or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TurnBasedMatch.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 (*TurnBasedMatchesCreateCall) Fields ¶
func (c *TurnBasedMatchesCreateCall) Fields(s ...googleapi.Field) *TurnBasedMatchesCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*TurnBasedMatchesCreateCall) Header ¶
func (c *TurnBasedMatchesCreateCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*TurnBasedMatchesCreateCall) Language ¶
func (c *TurnBasedMatchesCreateCall) Language(language string) *TurnBasedMatchesCreateCall
Language sets the optional parameter "language": The preferred language to use for strings returned by this method.
type TurnBasedMatchesDeclineCall ¶
type TurnBasedMatchesDeclineCall struct {
// contains filtered or unexported fields
}
func (*TurnBasedMatchesDeclineCall) ConsistencyToken ¶
func (c *TurnBasedMatchesDeclineCall) ConsistencyToken(consistencyToken int64) *TurnBasedMatchesDeclineCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*TurnBasedMatchesDeclineCall) Context ¶
func (c *TurnBasedMatchesDeclineCall) Context(ctx context.Context) *TurnBasedMatchesDeclineCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*TurnBasedMatchesDeclineCall) Do ¶
func (c *TurnBasedMatchesDeclineCall) Do(opts ...googleapi.CallOption) (*TurnBasedMatch, error)
Do executes the "games.turnBasedMatches.decline" call. Exactly one of *TurnBasedMatch or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TurnBasedMatch.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 (*TurnBasedMatchesDeclineCall) Fields ¶
func (c *TurnBasedMatchesDeclineCall) Fields(s ...googleapi.Field) *TurnBasedMatchesDeclineCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*TurnBasedMatchesDeclineCall) Header ¶
func (c *TurnBasedMatchesDeclineCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*TurnBasedMatchesDeclineCall) Language ¶
func (c *TurnBasedMatchesDeclineCall) Language(language string) *TurnBasedMatchesDeclineCall
Language sets the optional parameter "language": The preferred language to use for strings returned by this method.
type TurnBasedMatchesDismissCall ¶
type TurnBasedMatchesDismissCall struct {
// contains filtered or unexported fields
}
func (*TurnBasedMatchesDismissCall) ConsistencyToken ¶
func (c *TurnBasedMatchesDismissCall) ConsistencyToken(consistencyToken int64) *TurnBasedMatchesDismissCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*TurnBasedMatchesDismissCall) Context ¶
func (c *TurnBasedMatchesDismissCall) Context(ctx context.Context) *TurnBasedMatchesDismissCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*TurnBasedMatchesDismissCall) Do ¶
func (c *TurnBasedMatchesDismissCall) Do(opts ...googleapi.CallOption) error
Do executes the "games.turnBasedMatches.dismiss" call.
func (*TurnBasedMatchesDismissCall) Fields ¶
func (c *TurnBasedMatchesDismissCall) Fields(s ...googleapi.Field) *TurnBasedMatchesDismissCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*TurnBasedMatchesDismissCall) Header ¶
func (c *TurnBasedMatchesDismissCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type TurnBasedMatchesFinishCall ¶
type TurnBasedMatchesFinishCall struct {
// contains filtered or unexported fields
}
func (*TurnBasedMatchesFinishCall) ConsistencyToken ¶
func (c *TurnBasedMatchesFinishCall) ConsistencyToken(consistencyToken int64) *TurnBasedMatchesFinishCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*TurnBasedMatchesFinishCall) Context ¶
func (c *TurnBasedMatchesFinishCall) Context(ctx context.Context) *TurnBasedMatchesFinishCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*TurnBasedMatchesFinishCall) Do ¶
func (c *TurnBasedMatchesFinishCall) Do(opts ...googleapi.CallOption) (*TurnBasedMatch, error)
Do executes the "games.turnBasedMatches.finish" call. Exactly one of *TurnBasedMatch or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TurnBasedMatch.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 (*TurnBasedMatchesFinishCall) Fields ¶
func (c *TurnBasedMatchesFinishCall) Fields(s ...googleapi.Field) *TurnBasedMatchesFinishCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*TurnBasedMatchesFinishCall) Header ¶
func (c *TurnBasedMatchesFinishCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*TurnBasedMatchesFinishCall) Language ¶
func (c *TurnBasedMatchesFinishCall) Language(language string) *TurnBasedMatchesFinishCall
Language sets the optional parameter "language": The preferred language to use for strings returned by this method.
type TurnBasedMatchesGetCall ¶
type TurnBasedMatchesGetCall struct {
// contains filtered or unexported fields
}
func (*TurnBasedMatchesGetCall) ConsistencyToken ¶
func (c *TurnBasedMatchesGetCall) ConsistencyToken(consistencyToken int64) *TurnBasedMatchesGetCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*TurnBasedMatchesGetCall) Context ¶
func (c *TurnBasedMatchesGetCall) Context(ctx context.Context) *TurnBasedMatchesGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*TurnBasedMatchesGetCall) Do ¶
func (c *TurnBasedMatchesGetCall) Do(opts ...googleapi.CallOption) (*TurnBasedMatch, error)
Do executes the "games.turnBasedMatches.get" call. Exactly one of *TurnBasedMatch or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TurnBasedMatch.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 (*TurnBasedMatchesGetCall) Fields ¶
func (c *TurnBasedMatchesGetCall) Fields(s ...googleapi.Field) *TurnBasedMatchesGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*TurnBasedMatchesGetCall) Header ¶
func (c *TurnBasedMatchesGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*TurnBasedMatchesGetCall) IfNoneMatch ¶
func (c *TurnBasedMatchesGetCall) IfNoneMatch(entityTag string) *TurnBasedMatchesGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*TurnBasedMatchesGetCall) IncludeMatchData ¶
func (c *TurnBasedMatchesGetCall) IncludeMatchData(includeMatchData bool) *TurnBasedMatchesGetCall
IncludeMatchData sets the optional parameter "includeMatchData": Get match data along with metadata.
func (*TurnBasedMatchesGetCall) Language ¶
func (c *TurnBasedMatchesGetCall) Language(language string) *TurnBasedMatchesGetCall
Language sets the optional parameter "language": The preferred language to use for strings returned by this method.
type TurnBasedMatchesJoinCall ¶
type TurnBasedMatchesJoinCall struct {
// contains filtered or unexported fields
}
func (*TurnBasedMatchesJoinCall) ConsistencyToken ¶
func (c *TurnBasedMatchesJoinCall) ConsistencyToken(consistencyToken int64) *TurnBasedMatchesJoinCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*TurnBasedMatchesJoinCall) Context ¶
func (c *TurnBasedMatchesJoinCall) Context(ctx context.Context) *TurnBasedMatchesJoinCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*TurnBasedMatchesJoinCall) Do ¶
func (c *TurnBasedMatchesJoinCall) Do(opts ...googleapi.CallOption) (*TurnBasedMatch, error)
Do executes the "games.turnBasedMatches.join" call. Exactly one of *TurnBasedMatch or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TurnBasedMatch.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 (*TurnBasedMatchesJoinCall) Fields ¶
func (c *TurnBasedMatchesJoinCall) Fields(s ...googleapi.Field) *TurnBasedMatchesJoinCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*TurnBasedMatchesJoinCall) Header ¶
func (c *TurnBasedMatchesJoinCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*TurnBasedMatchesJoinCall) Language ¶
func (c *TurnBasedMatchesJoinCall) Language(language string) *TurnBasedMatchesJoinCall
Language sets the optional parameter "language": The preferred language to use for strings returned by this method.
type TurnBasedMatchesLeaveCall ¶
type TurnBasedMatchesLeaveCall struct {
// contains filtered or unexported fields
}
func (*TurnBasedMatchesLeaveCall) ConsistencyToken ¶
func (c *TurnBasedMatchesLeaveCall) ConsistencyToken(consistencyToken int64) *TurnBasedMatchesLeaveCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*TurnBasedMatchesLeaveCall) Context ¶
func (c *TurnBasedMatchesLeaveCall) Context(ctx context.Context) *TurnBasedMatchesLeaveCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*TurnBasedMatchesLeaveCall) Do ¶
func (c *TurnBasedMatchesLeaveCall) Do(opts ...googleapi.CallOption) (*TurnBasedMatch, error)
Do executes the "games.turnBasedMatches.leave" call. Exactly one of *TurnBasedMatch or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TurnBasedMatch.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 (*TurnBasedMatchesLeaveCall) Fields ¶
func (c *TurnBasedMatchesLeaveCall) Fields(s ...googleapi.Field) *TurnBasedMatchesLeaveCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*TurnBasedMatchesLeaveCall) Header ¶
func (c *TurnBasedMatchesLeaveCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*TurnBasedMatchesLeaveCall) Language ¶
func (c *TurnBasedMatchesLeaveCall) Language(language string) *TurnBasedMatchesLeaveCall
Language sets the optional parameter "language": The preferred language to use for strings returned by this method.
type TurnBasedMatchesLeaveTurnCall ¶
type TurnBasedMatchesLeaveTurnCall struct {
// contains filtered or unexported fields
}
func (*TurnBasedMatchesLeaveTurnCall) ConsistencyToken ¶
func (c *TurnBasedMatchesLeaveTurnCall) ConsistencyToken(consistencyToken int64) *TurnBasedMatchesLeaveTurnCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*TurnBasedMatchesLeaveTurnCall) Context ¶
func (c *TurnBasedMatchesLeaveTurnCall) Context(ctx context.Context) *TurnBasedMatchesLeaveTurnCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*TurnBasedMatchesLeaveTurnCall) Do ¶
func (c *TurnBasedMatchesLeaveTurnCall) Do(opts ...googleapi.CallOption) (*TurnBasedMatch, error)
Do executes the "games.turnBasedMatches.leaveTurn" call. Exactly one of *TurnBasedMatch or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TurnBasedMatch.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 (*TurnBasedMatchesLeaveTurnCall) Fields ¶
func (c *TurnBasedMatchesLeaveTurnCall) Fields(s ...googleapi.Field) *TurnBasedMatchesLeaveTurnCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*TurnBasedMatchesLeaveTurnCall) Header ¶
func (c *TurnBasedMatchesLeaveTurnCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*TurnBasedMatchesLeaveTurnCall) Language ¶
func (c *TurnBasedMatchesLeaveTurnCall) Language(language string) *TurnBasedMatchesLeaveTurnCall
Language sets the optional parameter "language": The preferred language to use for strings returned by this method.
func (*TurnBasedMatchesLeaveTurnCall) PendingParticipantId ¶
func (c *TurnBasedMatchesLeaveTurnCall) PendingParticipantId(pendingParticipantId string) *TurnBasedMatchesLeaveTurnCall
PendingParticipantId sets the optional parameter "pendingParticipantId": The ID of another participant who should take their turn next. If not set, the match will wait for other player(s) to join via automatching; this is only valid if automatch criteria is set on the match with remaining slots for automatched players.
type TurnBasedMatchesListCall ¶
type TurnBasedMatchesListCall struct {
// contains filtered or unexported fields
}
func (*TurnBasedMatchesListCall) ConsistencyToken ¶
func (c *TurnBasedMatchesListCall) ConsistencyToken(consistencyToken int64) *TurnBasedMatchesListCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*TurnBasedMatchesListCall) Context ¶
func (c *TurnBasedMatchesListCall) Context(ctx context.Context) *TurnBasedMatchesListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*TurnBasedMatchesListCall) Do ¶
func (c *TurnBasedMatchesListCall) Do(opts ...googleapi.CallOption) (*TurnBasedMatchList, error)
Do executes the "games.turnBasedMatches.list" call. Exactly one of *TurnBasedMatchList or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TurnBasedMatchList.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 (*TurnBasedMatchesListCall) Fields ¶
func (c *TurnBasedMatchesListCall) Fields(s ...googleapi.Field) *TurnBasedMatchesListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*TurnBasedMatchesListCall) Header ¶
func (c *TurnBasedMatchesListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*TurnBasedMatchesListCall) IfNoneMatch ¶
func (c *TurnBasedMatchesListCall) IfNoneMatch(entityTag string) *TurnBasedMatchesListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*TurnBasedMatchesListCall) IncludeMatchData ¶
func (c *TurnBasedMatchesListCall) IncludeMatchData(includeMatchData bool) *TurnBasedMatchesListCall
IncludeMatchData sets the optional parameter "includeMatchData": True if match data should be returned in the response. Note that not all data will necessarily be returned if include_match_data is true; the server may decide to only return data for some of the matches to limit download size for the client. The remainder of the data for these matches will be retrievable on request.
func (*TurnBasedMatchesListCall) Language ¶
func (c *TurnBasedMatchesListCall) Language(language string) *TurnBasedMatchesListCall
Language sets the optional parameter "language": The preferred language to use for strings returned by this method.
func (*TurnBasedMatchesListCall) MaxCompletedMatches ¶
func (c *TurnBasedMatchesListCall) MaxCompletedMatches(maxCompletedMatches int64) *TurnBasedMatchesListCall
MaxCompletedMatches sets the optional parameter "maxCompletedMatches": The maximum number of completed or canceled matches to return in the response. If not set, all matches returned could be completed or canceled.
func (*TurnBasedMatchesListCall) MaxResults ¶
func (c *TurnBasedMatchesListCall) MaxResults(maxResults int64) *TurnBasedMatchesListCall
MaxResults sets the optional parameter "maxResults": The maximum number of matches to return in the response, used for paging. For any response, the actual number of matches to return may be less than the specified maxResults.
func (*TurnBasedMatchesListCall) PageToken ¶
func (c *TurnBasedMatchesListCall) PageToken(pageToken string) *TurnBasedMatchesListCall
PageToken sets the optional parameter "pageToken": The token returned by the previous request.
func (*TurnBasedMatchesListCall) Pages ¶
func (c *TurnBasedMatchesListCall) Pages(ctx context.Context, f func(*TurnBasedMatchList) 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 TurnBasedMatchesRematchCall ¶
type TurnBasedMatchesRematchCall struct {
// contains filtered or unexported fields
}
func (*TurnBasedMatchesRematchCall) ConsistencyToken ¶
func (c *TurnBasedMatchesRematchCall) ConsistencyToken(consistencyToken int64) *TurnBasedMatchesRematchCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*TurnBasedMatchesRematchCall) Context ¶
func (c *TurnBasedMatchesRematchCall) Context(ctx context.Context) *TurnBasedMatchesRematchCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*TurnBasedMatchesRematchCall) Do ¶
func (c *TurnBasedMatchesRematchCall) Do(opts ...googleapi.CallOption) (*TurnBasedMatchRematch, error)
Do executes the "games.turnBasedMatches.rematch" call. Exactly one of *TurnBasedMatchRematch or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TurnBasedMatchRematch.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 (*TurnBasedMatchesRematchCall) Fields ¶
func (c *TurnBasedMatchesRematchCall) Fields(s ...googleapi.Field) *TurnBasedMatchesRematchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*TurnBasedMatchesRematchCall) Header ¶
func (c *TurnBasedMatchesRematchCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*TurnBasedMatchesRematchCall) Language ¶
func (c *TurnBasedMatchesRematchCall) Language(language string) *TurnBasedMatchesRematchCall
Language sets the optional parameter "language": The preferred language to use for strings returned by this method.
func (*TurnBasedMatchesRematchCall) RequestId ¶
func (c *TurnBasedMatchesRematchCall) RequestId(requestId int64) *TurnBasedMatchesRematchCall
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 TurnBasedMatchesService ¶
type TurnBasedMatchesService struct {
// contains filtered or unexported fields
}
func NewTurnBasedMatchesService ¶
func NewTurnBasedMatchesService(s *Service) *TurnBasedMatchesService
func (*TurnBasedMatchesService) Cancel ¶
func (r *TurnBasedMatchesService) Cancel(matchId string) *TurnBasedMatchesCancelCall
Cancel: Cancel a turn-based match.
func (*TurnBasedMatchesService) Create ¶
func (r *TurnBasedMatchesService) Create(turnbasedmatchcreaterequest *TurnBasedMatchCreateRequest) *TurnBasedMatchesCreateCall
Create: Create a turn-based match.
func (*TurnBasedMatchesService) Decline ¶
func (r *TurnBasedMatchesService) Decline(matchId string) *TurnBasedMatchesDeclineCall
Decline: Decline an invitation to play a turn-based match.
func (*TurnBasedMatchesService) Dismiss ¶
func (r *TurnBasedMatchesService) Dismiss(matchId string) *TurnBasedMatchesDismissCall
Dismiss: Dismiss a turn-based match from the match list. The match will no longer show up in the list and will not generate notifications.
func (*TurnBasedMatchesService) Finish ¶
func (r *TurnBasedMatchesService) Finish(matchId string, turnbasedmatchresults *TurnBasedMatchResults) *TurnBasedMatchesFinishCall
Finish: Finish a turn-based match. Each player should make this call once, after all results are in. Only the player whose turn it is may make the first call to Finish, and can pass in the final match state.
func (*TurnBasedMatchesService) Get ¶
func (r *TurnBasedMatchesService) Get(matchId string) *TurnBasedMatchesGetCall
Get: Get the data for a turn-based match.
func (*TurnBasedMatchesService) Join ¶
func (r *TurnBasedMatchesService) Join(matchId string) *TurnBasedMatchesJoinCall
Join: Join a turn-based match.
func (*TurnBasedMatchesService) Leave ¶
func (r *TurnBasedMatchesService) Leave(matchId string) *TurnBasedMatchesLeaveCall
Leave: Leave a turn-based match when it is not the current player's turn, without canceling the match.
func (*TurnBasedMatchesService) LeaveTurn ¶
func (r *TurnBasedMatchesService) LeaveTurn(matchId string, matchVersion int64) *TurnBasedMatchesLeaveTurnCall
LeaveTurn: Leave a turn-based match during the current player's turn, without canceling the match.
func (*TurnBasedMatchesService) List ¶
func (r *TurnBasedMatchesService) List() *TurnBasedMatchesListCall
List: Returns turn-based matches the player is or was involved in.
func (*TurnBasedMatchesService) Rematch ¶
func (r *TurnBasedMatchesService) Rematch(matchId string) *TurnBasedMatchesRematchCall
Rematch: Create a rematch of a match that was previously completed, with the same participants. This can be called by only one player on a match still in their list; the player must have called Finish first. Returns the newly created match; it will be the caller's turn.
func (*TurnBasedMatchesService) Sync ¶
func (r *TurnBasedMatchesService) Sync() *TurnBasedMatchesSyncCall
Sync: Returns turn-based matches the player is or was involved in that changed since the last sync call, with the least recent changes coming first. Matches that should be removed from the local cache will have a status of MATCH_DELETED.
func (*TurnBasedMatchesService) TakeTurn ¶
func (r *TurnBasedMatchesService) TakeTurn(matchId string, turnbasedmatchturn *TurnBasedMatchTurn) *TurnBasedMatchesTakeTurnCall
TakeTurn: Commit the results of a player turn.
type TurnBasedMatchesSyncCall ¶
type TurnBasedMatchesSyncCall struct {
// contains filtered or unexported fields
}
func (*TurnBasedMatchesSyncCall) ConsistencyToken ¶
func (c *TurnBasedMatchesSyncCall) ConsistencyToken(consistencyToken int64) *TurnBasedMatchesSyncCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*TurnBasedMatchesSyncCall) Context ¶
func (c *TurnBasedMatchesSyncCall) Context(ctx context.Context) *TurnBasedMatchesSyncCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*TurnBasedMatchesSyncCall) Do ¶
func (c *TurnBasedMatchesSyncCall) Do(opts ...googleapi.CallOption) (*TurnBasedMatchSync, error)
Do executes the "games.turnBasedMatches.sync" call. Exactly one of *TurnBasedMatchSync or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TurnBasedMatchSync.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 (*TurnBasedMatchesSyncCall) Fields ¶
func (c *TurnBasedMatchesSyncCall) Fields(s ...googleapi.Field) *TurnBasedMatchesSyncCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*TurnBasedMatchesSyncCall) Header ¶
func (c *TurnBasedMatchesSyncCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*TurnBasedMatchesSyncCall) IfNoneMatch ¶
func (c *TurnBasedMatchesSyncCall) IfNoneMatch(entityTag string) *TurnBasedMatchesSyncCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*TurnBasedMatchesSyncCall) IncludeMatchData ¶
func (c *TurnBasedMatchesSyncCall) IncludeMatchData(includeMatchData bool) *TurnBasedMatchesSyncCall
IncludeMatchData sets the optional parameter "includeMatchData": True if match data should be returned in the response. Note that not all data will necessarily be returned if include_match_data is true; the server may decide to only return data for some of the matches to limit download size for the client. The remainder of the data for these matches will be retrievable on request.
func (*TurnBasedMatchesSyncCall) Language ¶
func (c *TurnBasedMatchesSyncCall) Language(language string) *TurnBasedMatchesSyncCall
Language sets the optional parameter "language": The preferred language to use for strings returned by this method.
func (*TurnBasedMatchesSyncCall) MaxCompletedMatches ¶
func (c *TurnBasedMatchesSyncCall) MaxCompletedMatches(maxCompletedMatches int64) *TurnBasedMatchesSyncCall
MaxCompletedMatches sets the optional parameter "maxCompletedMatches": The maximum number of completed or canceled matches to return in the response. If not set, all matches returned could be completed or canceled.
func (*TurnBasedMatchesSyncCall) MaxResults ¶
func (c *TurnBasedMatchesSyncCall) MaxResults(maxResults int64) *TurnBasedMatchesSyncCall
MaxResults sets the optional parameter "maxResults": The maximum number of matches to return in the response, used for paging. For any response, the actual number of matches to return may be less than the specified maxResults.
func (*TurnBasedMatchesSyncCall) PageToken ¶
func (c *TurnBasedMatchesSyncCall) PageToken(pageToken string) *TurnBasedMatchesSyncCall
PageToken sets the optional parameter "pageToken": The token returned by the previous request.
func (*TurnBasedMatchesSyncCall) Pages ¶
func (c *TurnBasedMatchesSyncCall) Pages(ctx context.Context, f func(*TurnBasedMatchSync) 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 TurnBasedMatchesTakeTurnCall ¶
type TurnBasedMatchesTakeTurnCall struct {
// contains filtered or unexported fields
}
func (*TurnBasedMatchesTakeTurnCall) ConsistencyToken ¶
func (c *TurnBasedMatchesTakeTurnCall) ConsistencyToken(consistencyToken int64) *TurnBasedMatchesTakeTurnCall
ConsistencyToken sets the optional parameter "consistencyToken": The last-seen mutation timestamp.
func (*TurnBasedMatchesTakeTurnCall) Context ¶
func (c *TurnBasedMatchesTakeTurnCall) Context(ctx context.Context) *TurnBasedMatchesTakeTurnCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*TurnBasedMatchesTakeTurnCall) Do ¶
func (c *TurnBasedMatchesTakeTurnCall) Do(opts ...googleapi.CallOption) (*TurnBasedMatch, error)
Do executes the "games.turnBasedMatches.takeTurn" call. Exactly one of *TurnBasedMatch or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TurnBasedMatch.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 (*TurnBasedMatchesTakeTurnCall) Fields ¶
func (c *TurnBasedMatchesTakeTurnCall) Fields(s ...googleapi.Field) *TurnBasedMatchesTakeTurnCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*TurnBasedMatchesTakeTurnCall) Header ¶
func (c *TurnBasedMatchesTakeTurnCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*TurnBasedMatchesTakeTurnCall) Language ¶
func (c *TurnBasedMatchesTakeTurnCall) Language(language string) *TurnBasedMatchesTakeTurnCall
Language sets the optional parameter "language": The preferred language to use for strings returned by this method.