Class: Google::Apis::PlaygroupingV1alpha1::PlayGroupingService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/playgrouping_v1alpha1/service.rb

Overview

Google Play Grouping API

playgrouping.googleapis.com API.

Examples:

require 'google/apis/playgrouping_v1alpha1'

Playgrouping = Google::Apis::PlaygroupingV1alpha1 # Alias the module
service = Playgrouping::PlayGroupingService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://playgrouping.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ PlayGroupingService

Returns a new instance of PlayGroupingService.



47
48
49
50
51
52
 
# File 'lib/google/apis/playgrouping_v1alpha1/service.rb', line 47

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-playgrouping_v1alpha1',
        client_version: Google::Apis::PlaygroupingV1alpha1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns 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.

Returns:

  • (String) —

    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.



40
41
42
 
# File 'lib/google/apis/playgrouping_v1alpha1/service.rb', line 40

def key
  @key
end

#quota_user ⇒ String

Returns 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.

Returns:

  • (String) —

    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.



45
46
47
 
# File 'lib/google/apis/playgrouping_v1alpha1/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#create_or_update_tags(app_package, token, create_or_update_tags_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlaygroupingV1alpha1::CreateOrUpdateTagsResponse

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

Parameters:

  • app_package (String) —

    Required. App whose tags are being manipulated. Format: apps/package_name

  • token (String) —

    Required. Token for which the tags are being inserted or updated. Format: tokens/token

  • create_or_update_tags_request_object (Google::Apis::PlaygroupingV1alpha1::CreateOrUpdateTagsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/google/apis/playgrouping_v1alpha1/service.rb', line 118

def create_or_update_tags(app_package, token, create_or_update_tags_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha1/{+appPackage}/{+token}/tags:createOrUpdate', options)
  command.request_representation = Google::Apis::PlaygroupingV1alpha1::CreateOrUpdateTagsRequest::Representation
  command.request_object = create_or_update_tags_request_object
  command.response_representation = Google::Apis::PlaygroupingV1alpha1::CreateOrUpdateTagsResponse::Representation
  command.response_class = Google::Apis::PlaygroupingV1alpha1::CreateOrUpdateTagsResponse
  command.params['appPackage'] = app_package unless app_package.nil?
  command.params['token'] = token unless token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#verify_token(app_package, token, verify_token_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlaygroupingV1alpha1::VerifyTokenResponse

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.

Parameters:

  • app_package (String) —

    Required. App the token belongs to. Format: apps/package_name

  • token (String) —

    Required. The token to be verified. Format: tokens/token

  • verify_token_request_object (Google::Apis::PlaygroupingV1alpha1::VerifyTokenRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/google/apis/playgrouping_v1alpha1/service.rb', line 80

def verify_token(app_package, token, verify_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha1/{+appPackage}/{+token}:verify', options)
  command.request_representation = Google::Apis::PlaygroupingV1alpha1::VerifyTokenRequest::Representation
  command.request_object = verify_token_request_object
  command.response_representation = Google::Apis::PlaygroupingV1alpha1::VerifyTokenResponse::Representation
  command.response_class = Google::Apis::PlaygroupingV1alpha1::VerifyTokenResponse
  command.params['appPackage'] = app_package unless app_package.nil?
  command.params['token'] = token unless token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end