AndroidPublisher.Purchases.Products.Consume (Google Play Android Developer API v3-rev20240516-2.0.0)

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<Void>
        
        com.google.api.services.androidpublisher.AndroidPublisher.Purchases.Products.Consume

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

AndroidPublisher.Purchases.Products
```
public class AndroidPublisher.Purchases.Products.Consume
extends AndroidPublisherRequest<Void>
```

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 Consume(String packageName, String productId, String token)
Consumes a purchase for an inapp item.

Constructors
Modifier	Constructor and Description
`protected`	`Consume(String packageName, String productId, String token)` Consumes a purchase for an inapp item.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getPackageName()` The package name of the application the inapp product was sold in (for example, 'com.some.thing').
`String`	`getProductId()` The inapp product SKU (for example, 'com.some.thing.inapp1').
`String`	`getToken()` The token provided to the user's device when the inapp product was purchased.
`AndroidPublisher.Purchases.Products.Consume`	`set(String parameterName, Object value)`
`AndroidPublisher.Purchases.Products.Consume`	`set$Xgafv(String $Xgafv)` V1 error format.
`AndroidPublisher.Purchases.Products.Consume`	`setAccessToken(String accessToken)` OAuth access token.
`AndroidPublisher.Purchases.Products.Consume`	`setAlt(String alt)` Data format for response.
`AndroidPublisher.Purchases.Products.Consume`	`setCallback(String callback)` JSONP
`AndroidPublisher.Purchases.Products.Consume`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`AndroidPublisher.Purchases.Products.Consume`	`setKey(String key)` API key.
`AndroidPublisher.Purchases.Products.Consume`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`AndroidPublisher.Purchases.Products.Consume`	`setPackageName(String packageName)` The package name of the application the inapp product was sold in (for example, 'com.some.thing').
`AndroidPublisher.Purchases.Products.Consume`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`AndroidPublisher.Purchases.Products.Consume`	`setProductId(String productId)` The inapp product SKU (for example, 'com.some.thing.inapp1').
`AndroidPublisher.Purchases.Products.Consume`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`AndroidPublisher.Purchases.Products.Consume`	`setToken(String token)` The token provided to the user's device when the inapp product was purchased.
`AndroidPublisher.Purchases.Products.Consume`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`AndroidPublisher.Purchases.Products.Consume`	`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, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, 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
  - Consume
```
protected Consume(String packageName,
                  String productId,
                  String token)
```
    Consumes a purchase for an inapp item. Create a request for the method "products.consume". 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 - The package name of the application the inapp product was sold in (for example, 'com.some.thing').
    
    productId - The inapp product SKU (for example, 'com.some.thing.inapp1').
    
    token - The token provided to the user's device when the inapp product was purchased.
    
    Since:
    
    1.13
- Method Detail
  - set$Xgafv
```
public AndroidPublisher.Purchases.Products.Consume set$Xgafv(String $Xgafv)
```
    Description copied from class: AndroidPublisherRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class AndroidPublisherRequest<Void>
  - setAccessToken
```
public AndroidPublisher.Purchases.Products.Consume setAccessToken(String accessToken)
```
    Description copied from class: AndroidPublisherRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class AndroidPublisherRequest<Void>
  - setAlt
```
public AndroidPublisher.Purchases.Products.Consume setAlt(String alt)
```
    Description copied from class: AndroidPublisherRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class AndroidPublisherRequest<Void>
  - setCallback
```
public AndroidPublisher.Purchases.Products.Consume setCallback(String callback)
```
    Description copied from class: AndroidPublisherRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class AndroidPublisherRequest<Void>
  - setFields
```
public AndroidPublisher.Purchases.Products.Consume setFields(String fields)
```
    Description copied from class: AndroidPublisherRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class AndroidPublisherRequest<Void>
  - setKey
```
public AndroidPublisher.Purchases.Products.Consume 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<Void>
  - setOauthToken
```
public AndroidPublisher.Purchases.Products.Consume setOauthToken(String oauthToken)
```
    Description copied from class: AndroidPublisherRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class AndroidPublisherRequest<Void>
  - setPrettyPrint
```
public AndroidPublisher.Purchases.Products.Consume setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: AndroidPublisherRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class AndroidPublisherRequest<Void>
  - setQuotaUser
```
public AndroidPublisher.Purchases.Products.Consume 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<Void>
  - setUploadType
```
public AndroidPublisher.Purchases.Products.Consume setUploadType(String uploadType)
```
    Description copied from class: AndroidPublisherRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class AndroidPublisherRequest<Void>
  - setUploadProtocol
```
public AndroidPublisher.Purchases.Products.Consume setUploadProtocol(String uploadProtocol)
```
    Description copied from class: AndroidPublisherRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class AndroidPublisherRequest<Void>
  - getPackageName
```
public String getPackageName()
```
    The package name of the application the inapp product was sold in (for example, 'com.some.thing').
  - setPackageName
```
public AndroidPublisher.Purchases.Products.Consume setPackageName(String packageName)
```
    The package name of the application the inapp product was sold in (for example, 'com.some.thing').
  - getProductId
```
public String getProductId()
```
    The inapp product SKU (for example, 'com.some.thing.inapp1').
  - setProductId
```
public AndroidPublisher.Purchases.Products.Consume setProductId(String productId)
```
    The inapp product SKU (for example, 'com.some.thing.inapp1').
  - getToken
```
public String getToken()
```
    The token provided to the user's device when the inapp product was purchased.
  - setToken
```
public AndroidPublisher.Purchases.Products.Consume setToken(String token)
```
    The token provided to the user's device when the inapp product was purchased.
  - set
```
public AndroidPublisher.Purchases.Products.Consume set(String parameterName,
                                                       Object value)
```
    Overrides:
    
    set in class AndroidPublisherRequest<Void>

Class AndroidPublisher.Purchases.Products.Consume

Nested Class Summary

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

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

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

Field Summary

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

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Consume

Method Detail

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getPackageName

setPackageName

getProductId

setProductId

getToken

setToken

set