androidpublisher

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/v1"
...
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
• type PurchasesCancelCall
  • func (c *PurchasesCancelCall) Context(ctx context.Context) *PurchasesCancelCall
  • func (c *PurchasesCancelCall) Do(opts ...googleapi.CallOption) error
  • func (c *PurchasesCancelCall) Fields(s ...googleapi.Field) *PurchasesCancelCall
  • func (c *PurchasesCancelCall) Header() http.Header
• type PurchasesGetCall
  • func (c *PurchasesGetCall) Context(ctx context.Context) *PurchasesGetCall
  • func (c *PurchasesGetCall) Do(opts ...googleapi.CallOption) (*SubscriptionPurchase, error)
  • func (c *PurchasesGetCall) Fields(s ...googleapi.Field) *PurchasesGetCall
  • func (c *PurchasesGetCall) Header() http.Header
  • func (c *PurchasesGetCall) IfNoneMatch(entityTag string) *PurchasesGetCall
• type PurchasesService
  • func NewPurchasesService(s *Service) *PurchasesService
  • func (r *PurchasesService) Cancel(packageName string, subscriptionId string, token string) *PurchasesCancelCall
  • func (r *PurchasesService) Get(packageName string, subscriptionId string, token string) *PurchasesGetCall
• type Service
  • func New(client *http.Client) (*Service, error)
  • func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)
• type SubscriptionPurchase
  • func (s *SubscriptionPurchase) MarshalJSON() ([]byte, error)

Constants

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

OAuth2 scopes used by this API.

Types

type PurchasesCancelCall

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

func (*PurchasesCancelCall) Context

func (c *PurchasesCancelCall) Context(ctx context.Context) *PurchasesCancelCall

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

func (c *PurchasesCancelCall) Do(opts ...googleapi.CallOption) error

Do executes the "androidpublisher.purchases.cancel" call.

func (*PurchasesCancelCall) Fields

func (c *PurchasesCancelCall) Fields(s ...googleapi.Field) *PurchasesCancelCall

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

func (*PurchasesCancelCall) Header

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

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

type PurchasesGetCall

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

func (*PurchasesGetCall) Context

func (c *PurchasesGetCall) Context(ctx context.Context) *PurchasesGetCall

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

func (c *PurchasesGetCall) Do(opts ...googleapi.CallOption) (*SubscriptionPurchase, error)

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

func (c *PurchasesGetCall) Fields(s ...googleapi.Field) *PurchasesGetCall

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

func (*PurchasesGetCall) Header

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

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

func (*PurchasesGetCall) IfNoneMatch

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

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 PurchasesService

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

func NewPurchasesService

func NewPurchasesService(s *Service) *PurchasesService

func (*PurchasesService) Cancel

func (r *PurchasesService) Cancel(packageName string, subscriptionId string, token string) *PurchasesCancelCall

Cancel: Cancels a user's subscription purchase. The subscription remains valid until its expiration time.

func (*PurchasesService) Get

func (r *PurchasesService) Get(packageName string, subscriptionId string, token string) *PurchasesGetCall

Get: Checks whether a user's subscription purchase is valid and returns its expiry time.

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 SubscriptionPurchase

type SubscriptionPurchase struct {
	// AutoRenewing: Whether the subscription will automatically be renewed
	// when it reaches its current expiry time.
	AutoRenewing bool `json:"autoRenewing,omitempty"`

	// InitiationTimestampMsec: Time at which the subscription was granted,
	// in milliseconds since the Epoch.
	InitiationTimestampMsec int64 `json:"initiationTimestampMsec,omitempty,string"`

	// Kind: This kind represents a subscriptionPurchase object in the
	// androidpublisher service.
	Kind string `json:"kind,omitempty"`

	// ValidUntilTimestampMsec: Time at which the subscription will expire,
	// in milliseconds since the Epoch.
	ValidUntilTimestampMsec int64 `json:"validUntilTimestampMsec,omitempty,string"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "AutoRenewing") 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. "AutoRenewing") 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:"-"`
}

SubscriptionPurchase: A SubscriptionPurchase resource indicates the status of a user's subscription purchase.

func (*SubscriptionPurchase) MarshalJSON

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