com.google.api.services.androidpublisher

Class AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List

java.lang.Object

java.util.AbstractMap<String,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.androidpublisher.AndroidPublisherRequest<ListSubscriptionOffersResponse>

com.google.api.services.androidpublisher.AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers

public class AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List
extends AndroidPublisherRequest<ListSubscriptionOffersResponse>

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

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

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

Map.Entry<K,V>

Field Summary

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

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	List(String packageName, String productId, String basePlanId) Lists all offers under a given subscription.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getBasePlanId() Required.
String	getPackageName() Required.
Integer	getPageSize() The maximum number of subscriptions to return.
String	getPageToken() A page token, received from a previous `ListSubscriptionsOffers` call.
String	getProductId() Required.
AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List	set(String parameterName, Object value)
AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List	set$Xgafv(String $Xgafv) V1 error format.
AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List	setAccessToken(String accessToken) OAuth access token.
AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List	setAlt(String alt) Data format for response.
AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List	setBasePlanId(String basePlanId) Required.
AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List	setCallback(String callback) JSONP
AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List	setFields(String fields) Selector specifying which fields to include in a partial response.
AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List	setKey(String key) API key.
AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List	setPackageName(String packageName) Required.
AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List	setPageSize(Integer pageSize) The maximum number of subscriptions to return.
AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List	setPageToken(String pageToken) A page token, received from a previous `ListSubscriptionsOffers` call.
AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List	setProductId(String productId) Required.
AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.androidpublisher.AndroidPublisherRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, 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, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

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

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

List

protected List(String packageName,
               String productId,
               String basePlanId)

Lists all offers under a given subscription. Create a request for the method "offers.list". This request holds the parameters needed by the the androidpublisher server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

AndroidPublisher.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

packageName - Required. The parent app (package name) for which the subscriptions should be read.

productId - Required. The parent subscription (ID) for which the offers should be read. May be specified as '-' to read all offers under an app.

basePlanId - Required. The parent base plan (ID) for which the offers should be read. May be specified as '-' to read all offers under a subscription or an app. Must be specified as '-' if product_id is specified as '-'.

Since:

1.13

Method Detail

executeUsingHead

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

Overrides:

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

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

set$Xgafv

public AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List set$Xgafv(String $Xgafv)

Description copied from class: AndroidPublisherRequest

V1 error format.

Overrides:

set$Xgafv in class AndroidPublisherRequest<ListSubscriptionOffersResponse>

setAccessToken

public AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List setAccessToken(String accessToken)

Description copied from class: AndroidPublisherRequest

OAuth access token.

Overrides:

setAccessToken in class AndroidPublisherRequest<ListSubscriptionOffersResponse>

setAlt

public AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List setAlt(String alt)

Description copied from class: AndroidPublisherRequest

Data format for response.

Overrides:

setAlt in class AndroidPublisherRequest<ListSubscriptionOffersResponse>

setCallback

public AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List setCallback(String callback)

Description copied from class: AndroidPublisherRequest

JSONP

Overrides:

setCallback in class AndroidPublisherRequest<ListSubscriptionOffersResponse>

setFields

public AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List setFields(String fields)

Description copied from class: AndroidPublisherRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class AndroidPublisherRequest<ListSubscriptionOffersResponse>

setKey

public AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List setKey(String key)

Description copied from class: AndroidPublisherRequest

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 AndroidPublisherRequest<ListSubscriptionOffersResponse>

setOauthToken

public AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List setOauthToken(String oauthToken)

Description copied from class: AndroidPublisherRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class AndroidPublisherRequest<ListSubscriptionOffersResponse>

setPrettyPrint

public AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: AndroidPublisherRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class AndroidPublisherRequest<ListSubscriptionOffersResponse>

setQuotaUser

public AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List setQuotaUser(String quotaUser)

Description copied from class: AndroidPublisherRequest

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:

setQuotaUser in class AndroidPublisherRequest<ListSubscriptionOffersResponse>

setUploadType

public AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List setUploadType(String uploadType)

Description copied from class: AndroidPublisherRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class AndroidPublisherRequest<ListSubscriptionOffersResponse>

setUploadProtocol

public AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List setUploadProtocol(String uploadProtocol)

Description copied from class: AndroidPublisherRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class AndroidPublisherRequest<ListSubscriptionOffersResponse>

getPackageName

public String getPackageName()

Required. The parent app (package name) for which the subscriptions should be read.

setPackageName

public AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List setPackageName(String packageName)

Required. The parent app (package name) for which the subscriptions should be read.

getProductId

public String getProductId()

Required. The parent subscription (ID) for which the offers should be read. May be specified as '-' to read all offers under an app.

setProductId

public AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List setProductId(String productId)

Required. The parent subscription (ID) for which the offers should be read. May be specified as '-' to read all offers under an app.

getBasePlanId

public String getBasePlanId()

Required. The parent base plan (ID) for which the offers should be read. May be specified as '-' to read all offers under a subscription or an app. Must be specified as '-' if product_id is specified as '-'.

setBasePlanId

public AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List setBasePlanId(String basePlanId)

Required. The parent base plan (ID) for which the offers should be read. May be specified as '-' to read all offers under a subscription or an app. Must be specified as '-' if product_id is specified as '-'.

getPageSize

public Integer getPageSize()

The maximum number of subscriptions to return. The service may return fewer than this value. If unspecified, at most 50 subscriptions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

setPageSize

public AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List setPageSize(Integer pageSize)

The maximum number of subscriptions to return. The service may return fewer than this value. If unspecified, at most 50 subscriptions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

getPageToken

public String getPageToken()

A page token, received from a previous `ListSubscriptionsOffers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscriptionOffers` must match the call that provided the page token.

setPageToken

public AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List setPageToken(String pageToken)

A page token, received from a previous `ListSubscriptionsOffers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscriptionOffers` must match the call that provided the page token.

set

public AndroidPublisher.Monetization.Subscriptions.BasePlans.Offers.List set(String parameterName,
                                                                             Object value)

Overrides:

set in class AndroidPublisherRequest<ListSubscriptionOffersResponse>