...

Package playgrouping

import "google.golang.org/api/playgrouping/v1alpha1"
Overview
Index

Overview ▾

Package playgrouping provides access to the Google Play Grouping API.

For product documentation, see: https://cloud.google.com/playgrouping/

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/playgrouping/v1alpha1"
...
ctx := context.Background()
playgroupingService, err := playgrouping.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:

playgroupingService, err := playgrouping.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, ...)
playgroupingService, err := playgrouping.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

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

Index ▾

type AppsService
    func NewAppsService(s *Service) *AppsService
type AppsTokensService
    func NewAppsTokensService(s *Service) *AppsTokensService
    func (r *AppsTokensService) Verify(appPackage string, token string, verifytokenrequest *VerifyTokenRequest) *AppsTokensVerifyCall
type AppsTokensTagsCreateOrUpdateCall
    func (c *AppsTokensTagsCreateOrUpdateCall) Context(ctx context.Context) *AppsTokensTagsCreateOrUpdateCall
    func (c *AppsTokensTagsCreateOrUpdateCall) Do(opts ...googleapi.CallOption) (*CreateOrUpdateTagsResponse, error)
    func (c *AppsTokensTagsCreateOrUpdateCall) Fields(s ...googleapi.Field) *AppsTokensTagsCreateOrUpdateCall
    func (c *AppsTokensTagsCreateOrUpdateCall) Header() http.Header
type AppsTokensTagsService
    func NewAppsTokensTagsService(s *Service) *AppsTokensTagsService
    func (r *AppsTokensTagsService) CreateOrUpdate(appPackage string, token string, createorupdatetagsrequest *CreateOrUpdateTagsRequest) *AppsTokensTagsCreateOrUpdateCall
type AppsTokensVerifyCall
    func (c *AppsTokensVerifyCall) Context(ctx context.Context) *AppsTokensVerifyCall
    func (c *AppsTokensVerifyCall) Do(opts ...googleapi.CallOption) (*VerifyTokenResponse, error)
    func (c *AppsTokensVerifyCall) Fields(s ...googleapi.Field) *AppsTokensVerifyCall
    func (c *AppsTokensVerifyCall) Header() http.Header
type CreateOrUpdateTagsRequest
    func (s *CreateOrUpdateTagsRequest) MarshalJSON() ([]byte, error)
type CreateOrUpdateTagsResponse
    func (s *CreateOrUpdateTagsResponse) MarshalJSON() ([]byte, error)
type Service
    func New(client *http.Client) (*Service, error)
    func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)
type Tag
    func (s *Tag) MarshalJSON() ([]byte, error)
type VerifyTokenRequest
    func (s *VerifyTokenRequest) MarshalJSON() ([]byte, error)
type VerifyTokenResponse

Package files

playgrouping-gen.go

type AppsService

type AppsService struct {
    Tokens *AppsTokensService
    // contains filtered or unexported fields
}

func NewAppsService

func NewAppsService(s *Service) *AppsService

type AppsTokensService

type AppsTokensService struct {
    Tags *AppsTokensTagsService
    // contains filtered or unexported fields
}

func NewAppsTokensService

func NewAppsTokensService(s *Service) *AppsTokensService

func (*AppsTokensService) Verify

func (r *AppsTokensService) Verify(appPackage string, token string, verifytokenrequest *VerifyTokenRequest) *AppsTokensVerifyCall

Verify: Verify an API token by asserting the app and persona it belongs to. The verification is a protection against client-side attacks and will fail if the contents of the token don't match the provided values. A token must be verified before it can be used to manipulate user tags.

- appPackage: App the token belongs to. Format: apps/{package_name}. - token: The token to be verified. Format: tokens/{token}.

type AppsTokensTagsCreateOrUpdateCall

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

func (*AppsTokensTagsCreateOrUpdateCall) Context

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

Context sets the context to be used in this call's Do method.

func (*AppsTokensTagsCreateOrUpdateCall) Do

func (c *AppsTokensTagsCreateOrUpdateCall) Do(opts ...googleapi.CallOption) (*CreateOrUpdateTagsResponse, error)

Do executes the "playgrouping.apps.tokens.tags.createOrUpdate" call. Any non-2xx status code is an error. Response headers are in either *CreateOrUpdateTagsResponse.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 (*AppsTokensTagsCreateOrUpdateCall) Fields

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

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

func (*AppsTokensTagsCreateOrUpdateCall) Header

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

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

type AppsTokensTagsService

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

func NewAppsTokensTagsService

func NewAppsTokensTagsService(s *Service) *AppsTokensTagsService

func (*AppsTokensTagsService) CreateOrUpdate

func (r *AppsTokensTagsService) CreateOrUpdate(appPackage string, token string, createorupdatetagsrequest *CreateOrUpdateTagsRequest) *AppsTokensTagsCreateOrUpdateCall

CreateOrUpdate: Create or update tags for the user and app that are represented by the given token.

type AppsTokensVerifyCall

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

func (*AppsTokensVerifyCall) Context

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

Context sets the context to be used in this call's Do method.

func (*AppsTokensVerifyCall) Do

func (c *AppsTokensVerifyCall) Do(opts ...googleapi.CallOption) (*VerifyTokenResponse, error)

Do executes the "playgrouping.apps.tokens.verify" call. Any non-2xx status code is an error. Response headers are in either *VerifyTokenResponse.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 (*AppsTokensVerifyCall) Fields

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

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

func (*AppsTokensVerifyCall) Header

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

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

type CreateOrUpdateTagsRequest

CreateOrUpdateTagsRequest: Request message for CreateOrUpdateTags. VerifyToken.

type CreateOrUpdateTagsRequest struct {
    // Tags: Tags to be inserted or updated.
    Tags []*Tag `json:"tags,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Tags") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Tags") to include in API requests
    // with the JSON null value. By default, fields with empty values are omitted
    // from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*CreateOrUpdateTagsRequest) MarshalJSON

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

type CreateOrUpdateTagsResponse

CreateOrUpdateTagsResponse: Response message for CreateOrUpdateTags.

type CreateOrUpdateTagsResponse struct {
    // Tags: All requested tags are returned, including pre-existing ones.
    Tags []*Tag `json:"tags,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // ForceSendFields is a list of field names (e.g. "Tags") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Tags") to include in API requests
    // with the JSON null value. By default, fields with empty values are omitted
    // from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*CreateOrUpdateTagsResponse) MarshalJSON

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

type Service

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

    Apps *AppsService
    // 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 Tag

Tag: A tag is associated with exactly one package name and user.

type Tag struct {
    // BooleanValue: A boolean value of the tag.
    BooleanValue bool `json:"booleanValue,omitempty"`
    // Int64Value: A signed 64-bit integer value of the tag.
    Int64Value int64 `json:"int64Value,omitempty,string"`
    // Key: Required. Key for the tag.
    Key string `json:"key,omitempty"`
    // StringValue: A string value of the tag.
    StringValue string `json:"stringValue,omitempty"`
    // TimeValue: A time value of the tag.
    TimeValue string `json:"timeValue,omitempty"`
    // ForceSendFields is a list of field names (e.g. "BooleanValue") to
    // unconditionally include in API requests. By default, fields with empty or
    // default values are omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "BooleanValue") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*Tag) MarshalJSON

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

type VerifyTokenRequest

VerifyTokenRequest: Request message for VerifyToken.

type VerifyTokenRequest struct {
    // Persona: Required. Persona represented by the token. Format:
    // personas/{persona}
    Persona string `json:"persona,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Persona") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Persona") to include in API
    // requests with the JSON null value. By default, fields with empty values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*VerifyTokenRequest) MarshalJSON

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

type VerifyTokenResponse

VerifyTokenResponse: Response message for VerifyToken.

type VerifyTokenResponse struct {
    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
}