Documentation

Overview

Package androidpublisher provides access to the Google Play Developer API.

For product documentation, see: https://developers.google.com/android-publisher

Creating a client

Usage example:

import "google.golang.org/api/androidpublisher/v2"
...
ctx := context.Background()
androidpublisherService, err := androidpublisher.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication.

For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

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

androidpublisherService, err := androidpublisher.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
androidpublisherService, err := androidpublisher.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

Constants

View Source
const (
	// View and manage your Google Play Developer account
	AndroidpublisherScope = "https://www.googleapis.com/auth/androidpublisher"
)

    OAuth2 scopes used by this API.

    Variables

    This section is empty.

    Functions

    This section is empty.

    Types

    type PageInfo

    type PageInfo struct {
    	ResultPerPage int64 `json:"resultPerPage,omitempty"`
    
    	StartIndex int64 `json:"startIndex,omitempty"`
    
    	TotalResults int64 `json:"totalResults,omitempty"`
    
    	// ForceSendFields is a list of field names (e.g. "ResultPerPage") 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. "ResultPerPage") 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 (*PageInfo) MarshalJSON

    func (s *PageInfo) MarshalJSON() ([]byte, error)

    type ProductPurchase

    type ProductPurchase struct {
    	// ConsumptionState: The consumption state of the inapp product.
    	// Possible values are:
    	// - Yet to be consumed
    	// - Consumed
    	ConsumptionState int64 `json:"consumptionState,omitempty"`
    
    	// DeveloperPayload: A developer-specified string that contains
    	// supplemental information about an order.
    	DeveloperPayload string `json:"developerPayload,omitempty"`
    
    	// Kind: This kind represents an inappPurchase object in the
    	// androidpublisher service.
    	Kind string `json:"kind,omitempty"`
    
    	// OrderId: The order id associated with the purchase of the inapp
    	// product.
    	OrderId string `json:"orderId,omitempty"`
    
    	// PurchaseState: The purchase state of the order. Possible values are:
    	//
    	// - Purchased
    	// - Canceled
    	// - Pending
    	PurchaseState int64 `json:"purchaseState,omitempty"`
    
    	// PurchaseTimeMillis: The time the product was purchased, in
    	// milliseconds since the epoch (Jan 1, 1970).
    	PurchaseTimeMillis int64 `json:"purchaseTimeMillis,omitempty,string"`
    
    	// PurchaseType: The type of purchase of the inapp product. This field
    	// is only set if this purchase was not made using the standard in-app
    	// billing flow. Possible values are:
    	// - Test (i.e. purchased from a license testing account)
    	// - Promo (i.e. purchased using a promo code)
    	// - Rewarded (i.e. from watching a video ad instead of paying)
    	PurchaseType *int64 `json:"purchaseType,omitempty"`
    
    	// ServerResponse contains the HTTP response code and headers from the
    	// server.
    	googleapi.ServerResponse `json:"-"`
    
    	// ForceSendFields is a list of field names (e.g. "ConsumptionState") 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. "ConsumptionState") 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:"-"`
    }

      ProductPurchase: A ProductPurchase resource indicates the status of a user's inapp product purchase.

      func (*ProductPurchase) MarshalJSON

      func (s *ProductPurchase) MarshalJSON() ([]byte, error)

      type PurchasesProductsGetCall

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

      func (*PurchasesProductsGetCall) Context

        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 (*PurchasesProductsGetCall) Do

          Do executes the "androidpublisher.purchases.products.get" call. Exactly one of *ProductPurchase or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ProductPurchase.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 (*PurchasesProductsGetCall) Fields

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

            func (*PurchasesProductsGetCall) Header

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

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

              func (*PurchasesProductsGetCall) IfNoneMatch

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

                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 PurchasesProductsService

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

                func NewPurchasesProductsService

                func NewPurchasesProductsService(s *Service) *PurchasesProductsService

                func (*PurchasesProductsService) Get

                func (r *PurchasesProductsService) Get(packageName string, productId string, token string) *PurchasesProductsGetCall

                  Get: Checks the purchase and consumption status of an inapp item.

                  type PurchasesService

                  type PurchasesService struct {
                  	Products *PurchasesProductsService
                  
                  	Voidedpurchases *PurchasesVoidedpurchasesService
                  	// contains filtered or unexported fields
                  }

                  func NewPurchasesService

                  func NewPurchasesService(s *Service) *PurchasesService

                  type PurchasesVoidedpurchasesListCall

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

                  func (*PurchasesVoidedpurchasesListCall) Context

                    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 (*PurchasesVoidedpurchasesListCall) Do

                      Do executes the "androidpublisher.purchases.voidedpurchases.list" call. Exactly one of *VoidedPurchasesListResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *VoidedPurchasesListResponse.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 (*PurchasesVoidedpurchasesListCall) EndTime

                        EndTime sets the optional parameter "endTime": The time, in milliseconds since the Epoch, of the newest voided purchase that you want to see in the response. The value of this parameter cannot be greater than the current time and is ignored if a pagination token is set. Default value is current time. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response.

                        func (*PurchasesVoidedpurchasesListCall) Fields

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

                          func (*PurchasesVoidedpurchasesListCall) Header

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

                            func (*PurchasesVoidedpurchasesListCall) IfNoneMatch

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

                                MaxResults sets the optional parameter "maxResults":

                                func (*PurchasesVoidedpurchasesListCall) StartIndex

                                  StartIndex sets the optional parameter "startIndex":

                                  func (*PurchasesVoidedpurchasesListCall) StartTime

                                    StartTime sets the optional parameter "startTime": The time, in milliseconds since the Epoch, of the oldest voided purchase that you want to see in the response. The value of this parameter cannot be older than 30 days and is ignored if a pagination token is set. Default value is current time minus 30 days. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response.

                                    func (*PurchasesVoidedpurchasesListCall) Token

                                      Token sets the optional parameter "token":

                                      type PurchasesVoidedpurchasesService

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

                                      func NewPurchasesVoidedpurchasesService

                                      func NewPurchasesVoidedpurchasesService(s *Service) *PurchasesVoidedpurchasesService

                                      func (*PurchasesVoidedpurchasesService) List

                                        List: Lists the purchases that were canceled, refunded or charged-back.

                                        type Service

                                        type Service struct {
                                        	BasePath  string // API endpoint base URL
                                        	UserAgent string // optional additional User-Agent fragment
                                        
                                        	Purchases *PurchasesService
                                        	// contains filtered or unexported fields
                                        }

                                        func New

                                        func New(client *http.Client) (*Service, error)

                                          New creates a new Service. It uses the provided http.Client for requests.

                                          Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

                                          func NewService

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

                                            NewService creates a new Service.

                                            type TokenPagination

                                            type TokenPagination struct {
                                            	NextPageToken string `json:"nextPageToken,omitempty"`
                                            
                                            	PreviousPageToken string `json:"previousPageToken,omitempty"`
                                            
                                            	// ForceSendFields is a list of field names (e.g. "NextPageToken") 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. "NextPageToken") 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 (*TokenPagination) MarshalJSON

                                            func (s *TokenPagination) MarshalJSON() ([]byte, error)

                                            type VoidedPurchase

                                            type VoidedPurchase struct {
                                            	// Kind: This kind represents a voided purchase object in the
                                            	// androidpublisher service.
                                            	Kind string `json:"kind,omitempty"`
                                            
                                            	// PurchaseTimeMillis: The time at which the purchase was made, in
                                            	// milliseconds since the epoch (Jan 1, 1970).
                                            	PurchaseTimeMillis int64 `json:"purchaseTimeMillis,omitempty,string"`
                                            
                                            	// PurchaseToken: The token which uniquely identifies a one-time
                                            	// purchase or subscription. To uniquely identify subscription renewals
                                            	// use order_id (available starting from version 3 of the API).
                                            	PurchaseToken string `json:"purchaseToken,omitempty"`
                                            
                                            	// VoidedTimeMillis: The time at which the purchase was
                                            	// canceled/refunded/charged-back, in milliseconds since the epoch (Jan
                                            	// 1, 1970).
                                            	VoidedTimeMillis int64 `json:"voidedTimeMillis,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:"-"`
                                            }

                                              VoidedPurchase: A VoidedPurchase resource indicates a purchase that was either canceled/refunded/charged-back.

                                              func (*VoidedPurchase) MarshalJSON

                                              func (s *VoidedPurchase) MarshalJSON() ([]byte, error)

                                              type VoidedPurchasesListResponse

                                              type VoidedPurchasesListResponse struct {
                                              	PageInfo *PageInfo `json:"pageInfo,omitempty"`
                                              
                                              	TokenPagination *TokenPagination `json:"tokenPagination,omitempty"`
                                              
                                              	VoidedPurchases []*VoidedPurchase `json:"voidedPurchases,omitempty"`
                                              
                                              	// ServerResponse contains the HTTP response code and headers from the
                                              	// server.
                                              	googleapi.ServerResponse `json:"-"`
                                              
                                              	// ForceSendFields is a list of field names (e.g. "PageInfo") 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. "PageInfo") 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 (*VoidedPurchasesListResponse) MarshalJSON

                                              func (s *VoidedPurchasesListResponse) MarshalJSON() ([]byte, error)