com.google.api.services.games

Class Games.Metagame.ListCategoriesByPlayer

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.games.GamesRequest<CategoryListResponse>

com.google.api.services.games.Games.Metagame.ListCategoriesByPlayer

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

Games.Metagame

public class Games.Metagame.ListCategoriesByPlayer
extends GamesRequest<CategoryListResponse>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Games.Metagame.ListCategoriesByPlayer(java.lang.String playerId, java.lang.String collection) List play data aggregated per category for the player corresponding to playerId.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
java.lang.String	getCollection() The collection of categories for which data will be returned.
java.lang.Long	getConsistencyToken() The last-seen mutation timestamp.
java.lang.String	getLanguage() The preferred language to use for strings returned by this method.
java.lang.Integer	getMaxResults() The maximum number of category resources to return in the response, used for paging.
java.lang.String	getPageToken() The token returned by the previous request.
java.lang.String	getPlayerId() A player ID.
Games.Metagame.ListCategoriesByPlayer	set(java.lang.String parameterName, java.lang.Object value)
Games.Metagame.ListCategoriesByPlayer	setAlt(java.lang.String alt) Data format for the response.
Games.Metagame.ListCategoriesByPlayer	setCollection(java.lang.String collection) The collection of categories for which data will be returned.
Games.Metagame.ListCategoriesByPlayer	setConsistencyToken(java.lang.Long consistencyToken) The last-seen mutation timestamp.
Games.Metagame.ListCategoriesByPlayer	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
Games.Metagame.ListCategoriesByPlayer	setKey(java.lang.String key) API key.
Games.Metagame.ListCategoriesByPlayer	setLanguage(java.lang.String language) The preferred language to use for strings returned by this method.
Games.Metagame.ListCategoriesByPlayer	setMaxResults(java.lang.Integer maxResults) The maximum number of category resources to return in the response, used for paging.
Games.Metagame.ListCategoriesByPlayer	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
Games.Metagame.ListCategoriesByPlayer	setPageToken(java.lang.String pageToken) The token returned by the previous request.
Games.Metagame.ListCategoriesByPlayer	setPlayerId(java.lang.String playerId) A player ID.
Games.Metagame.ListCategoriesByPlayer	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
Games.Metagame.ListCategoriesByPlayer	setQuotaUser(java.lang.String quotaUser) Available to use for quota purposes for server-side applications.
Games.Metagame.ListCategoriesByPlayer	setUserIp(java.lang.String userIp) IP address of the site where the request originates.

Methods inherited from class com.google.api.services.games.GamesRequest

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Games.Metagame.ListCategoriesByPlayer

protected Games.Metagame.ListCategoriesByPlayer(java.lang.String playerId,
                                     java.lang.String collection)

List play data aggregated per category for the player corresponding to playerId. Create a request for the method "metagame.listCategoriesByPlayer". This request holds the parameters needed by the the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

ListCategoriesByPlayer#initialize(com.google.api.client.googleapis.servic es.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

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

collection - The collection of categories for which data will be returned.

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws java.io.IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<CategoryListResponse>

Throws:

java.io.IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws java.io.IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<CategoryListResponse>

Throws:

java.io.IOException

setAlt

public Games.Metagame.ListCategoriesByPlayer setAlt(java.lang.String alt)

Description copied from class: GamesRequest

Data format for the response.

Overrides:

setAlt in class GamesRequest<CategoryListResponse>

setFields

public Games.Metagame.ListCategoriesByPlayer setFields(java.lang.String fields)

Description copied from class: GamesRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class GamesRequest<CategoryListResponse>

setKey

public Games.Metagame.ListCategoriesByPlayer setKey(java.lang.String key)

Description copied from class: GamesRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class GamesRequest<CategoryListResponse>

setOauthToken

public Games.Metagame.ListCategoriesByPlayer setOauthToken(java.lang.String oauthToken)

Description copied from class: GamesRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class GamesRequest<CategoryListResponse>

setPrettyPrint

public Games.Metagame.ListCategoriesByPlayer setPrettyPrint(java.lang.Boolean prettyPrint)

Description copied from class: GamesRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class GamesRequest<CategoryListResponse>

setQuotaUser

public Games.Metagame.ListCategoriesByPlayer setQuotaUser(java.lang.String quotaUser)

Description copied from class: GamesRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

Overrides:

setQuotaUser in class GamesRequest<CategoryListResponse>

setUserIp

public Games.Metagame.ListCategoriesByPlayer setUserIp(java.lang.String userIp)

Description copied from class: GamesRequest

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Overrides:

setUserIp in class GamesRequest<CategoryListResponse>

getPlayerId

public java.lang.String getPlayerId()

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

setPlayerId

public Games.Metagame.ListCategoriesByPlayer setPlayerId(java.lang.String playerId)

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

getCollection

public java.lang.String getCollection()

The collection of categories for which data will be returned.

setCollection

public Games.Metagame.ListCategoriesByPlayer setCollection(java.lang.String collection)

The collection of categories for which data will be returned.

getConsistencyToken

public java.lang.Long getConsistencyToken()

The last-seen mutation timestamp.

setConsistencyToken

public Games.Metagame.ListCategoriesByPlayer setConsistencyToken(java.lang.Long consistencyToken)

The last-seen mutation timestamp.

getLanguage

public java.lang.String getLanguage()

The preferred language to use for strings returned by this method.

setLanguage

public Games.Metagame.ListCategoriesByPlayer setLanguage(java.lang.String language)

The preferred language to use for strings returned by this method.

getMaxResults

public java.lang.Integer getMaxResults()

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. [minimum: 1] [maximum: 100]

setMaxResults

public Games.Metagame.ListCategoriesByPlayer setMaxResults(java.lang.Integer 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.

getPageToken

public java.lang.String getPageToken()

The token returned by the previous request.

setPageToken

public Games.Metagame.ListCategoriesByPlayer setPageToken(java.lang.String pageToken)

The token returned by the previous request.

set

public Games.Metagame.ListCategoriesByPlayer set(java.lang.String parameterName,
                                        java.lang.Object value)

Overrides:

set in class GamesRequest<CategoryListResponse>