playcustomapp

Documentation

Overview

Package playcustomapp provides access to the Google Play Custom App Publishing API.

For product documentation, see: https://developers.google.com/android/work/play/custom-app-api/

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example:

import "google.golang.org/api/playcustomapp/v1"
...
ctx := context.Background()
playcustomappService, err := playcustomapp.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 google.golang.org/api/option.WithAPIKey:

playcustomappService, err := playcustomapp.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource:

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

See google.golang.org/api/option.ClientOption for details on options.

Index

• Constants
• type AccountsCustomAppsCreateCall
  • func (c *AccountsCustomAppsCreateCall) Context(ctx context.Context) *AccountsCustomAppsCreateCall
  • func (c *AccountsCustomAppsCreateCall) Do(opts ...googleapi.CallOption) (*CustomApp, error)
  • func (c *AccountsCustomAppsCreateCall) Fields(s ...googleapi.Field) *AccountsCustomAppsCreateCall
  • func (c *AccountsCustomAppsCreateCall) Header() http.Header
  • func (c *AccountsCustomAppsCreateCall) Media(r io.Reader, options ...googleapi.MediaOption) *AccountsCustomAppsCreateCall
  • func (c *AccountsCustomAppsCreateCall) ProgressUpdater(pu googleapi.ProgressUpdater) *AccountsCustomAppsCreateCall
  • func (c *AccountsCustomAppsCreateCall) ResumableMedia(ctx context.Context, r io.ReaderAt, size int64, mediaType string) *AccountsCustomAppsCreateCall
• type AccountsCustomAppsService
  • func NewAccountsCustomAppsService(s *Service) *AccountsCustomAppsService
  • func (r *AccountsCustomAppsService) Create(account int64, customapp *CustomApp) *AccountsCustomAppsCreateCall
• type AccountsService
  • func NewAccountsService(s *Service) *AccountsService
• type CustomApp
  • func (s *CustomApp) MarshalJSON() ([]byte, error)
• type Organization
  • func (s *Organization) MarshalJSON() ([]byte, error)
• type Service
  • func New(client *http.Client) (*Service, error)
  • func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, 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 AccountsCustomAppsCreateCall

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

func (*AccountsCustomAppsCreateCall) Context

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

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. This context will supersede any context previously provided to the ResumableMedia method.

func (*AccountsCustomAppsCreateCall) Do

func (c *AccountsCustomAppsCreateCall) Do(opts ...googleapi.CallOption) (*CustomApp, error)

Do executes the "playcustomapp.accounts.customApps.create" call. Exactly one of *CustomApp or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *CustomApp.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 (*AccountsCustomAppsCreateCall) Fields

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

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

func (*AccountsCustomAppsCreateCall) Header

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

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

func (*AccountsCustomAppsCreateCall) Media

func (c *AccountsCustomAppsCreateCall) Media(r io.Reader, options ...googleapi.MediaOption) *AccountsCustomAppsCreateCall

Media specifies the media to upload in one or more chunks. The chunk size may be controlled by supplying a MediaOption generated by googleapi.ChunkSize. The chunk size defaults to googleapi.DefaultUploadChunkSize.The Content-Type header used in the upload request will be determined by sniffing the contents of r, unless a MediaOption generated by googleapi.ContentType is supplied. At most one of Media and ResumableMedia may be set.

func (*AccountsCustomAppsCreateCall) ProgressUpdater

func (c *AccountsCustomAppsCreateCall) ProgressUpdater(pu googleapi.ProgressUpdater) *AccountsCustomAppsCreateCall

ProgressUpdater provides a callback function that will be called after every chunk. It should be a low-latency function in order to not slow down the upload operation. This should only be called when using ResumableMedia (as opposed to Media).

func (*AccountsCustomAppsCreateCall) ResumableMedia

func (c *AccountsCustomAppsCreateCall) ResumableMedia(ctx context.Context, r io.ReaderAt, size int64, mediaType string) *AccountsCustomAppsCreateCall

ResumableMedia specifies the media to upload in chunks and can be canceled with ctx.

Deprecated: use Media instead.

At most one of Media and ResumableMedia may be set. mediaType identifies the MIME media type of the upload, such as "image/png". If mediaType is "", it will be auto-detected. The provided ctx will supersede any context previously provided to the Context method.

type AccountsCustomAppsService

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

func NewAccountsCustomAppsService

func NewAccountsCustomAppsService(s *Service) *AccountsCustomAppsService

func (*AccountsCustomAppsService) Create

func (r *AccountsCustomAppsService) Create(account int64, customapp *CustomApp) *AccountsCustomAppsCreateCall

Create: Creates a new custom app.

- account: Developer account ID.

type AccountsService

type AccountsService struct {
	CustomApps *AccountsCustomAppsService
	// contains filtered or unexported fields
}

func NewAccountsService

func NewAccountsService(s *Service) *AccountsService

type CustomApp

type CustomApp struct {
	// LanguageCode: Default listing language in BCP 47 format.
	LanguageCode string `json:"languageCode,omitempty"`

	// Organizations: Organizations to which the custom app should be made
	// available. If the request contains any organizations, then the app
	// will be restricted to only these organizations. To support the
	// organization linked to the developer account, the organization ID
	// should be provided explicitly together with other organizations. If
	// no organizations are provided, then the app is only available to the
	// organization linked to the developer account.
	Organizations []*Organization `json:"organizations,omitempty"`

	// PackageName: Output only. Package name of the created Android app.
	// Only present in the API response.
	PackageName string `json:"packageName,omitempty"`

	// Title: Title for the Android app.
	Title string `json:"title,omitempty"`

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

	// ForceSendFields is a list of field names (e.g. "LanguageCode") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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. "LanguageCode") 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:"-"`
}

CustomApp: This resource represents a custom app.

func (*CustomApp) MarshalJSON

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

type Organization

type Organization struct {
	// OrganizationId: Required. ID of the organization.
	OrganizationId string `json:"organizationId,omitempty"`

	// OrganizationName: Optional. A human-readable name of the
	// organization, to help recognize the organization.
	OrganizationName string `json:"organizationName,omitempty"`

	// ForceSendFields is a list of field names (e.g. "OrganizationId") to
	// unconditionally include in API requests. By default, fields with
	// empty or default 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. "OrganizationId") 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:"-"`
}

Organization: Represents an organization that can access a custom app.

func (*Organization) MarshalJSON

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

type Service

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Accounts *AccountsService
	// 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.