Class: Google::Apis::PlayablelocationsV3::PlayableLocationsService

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

Overview

Playable Locations API

Examples:

require 'google/apis/playablelocations_v3'

Playablelocations = Google::Apis::PlayablelocationsV3 # Alias the module
service = Playablelocations::PlayableLocationsService.new

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ PlayableLocationsService

Returns a new instance of PlayableLocationsService.



45
46
47
48
 
# File 'generated/google/apis/playablelocations_v3/service.rb', line 45

def initialize
  super('https://playablelocations.googleapis.com/', '')
  @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.



38
39
40
 
# File 'generated/google/apis/playablelocations_v3/service.rb', line 38

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.



43
44
45
 
# File 'generated/google/apis/playablelocations_v3/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#log_impressions(google_maps_playablelocations_v3_log_impressions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3LogImpressionsResponse

Logs new events when playable locations are displayed, and when they are interacted with. Impressions are not partially saved; either all impressions are saved and this request succeeds, or no impressions are saved, and this request fails.

Parameters:

  • google_maps_playablelocations_v3_log_impressions_request_object (Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3LogImpressionsRequest) (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



72
73
74
75
76
77
78
79
80
81
 
# File 'generated/google/apis/playablelocations_v3/service.rb', line 72

def log_impressions(google_maps_playablelocations_v3_log_impressions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3:logImpressions', options)
  command.request_representation = Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3LogImpressionsRequest::Representation
  command.request_object = google_maps_playablelocations_v3_log_impressions_request_object
  command.response_representation = Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3LogImpressionsResponse::Representation
  command.response_class = Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3LogImpressionsResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#log_player_reports(google_maps_playablelocations_v3_log_player_reports_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3LogPlayerReportsResponse

Logs bad playable location reports submitted by players. Reports are not partially saved; either all reports are saved and this request succeeds, or no reports are saved, and this request fails.

Parameters:

  • google_maps_playablelocations_v3_log_player_reports_request_object (Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3LogPlayerReportsRequest) (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



104
105
106
107
108
109
110
111
112
113
 
# File 'generated/google/apis/playablelocations_v3/service.rb', line 104

def log_player_reports(google_maps_playablelocations_v3_log_player_reports_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3:logPlayerReports', options)
  command.request_representation = Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3LogPlayerReportsRequest::Representation
  command.request_object = google_maps_playablelocations_v3_log_player_reports_request_object
  command.response_representation = Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3LogPlayerReportsResponse::Representation
  command.response_class = Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3LogPlayerReportsResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#sample_playable_locations(google_maps_playablelocations_v3_sample_playable_locations_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SamplePlayableLocationsResponse

Returns a set of playable locations that lie within a specified area, that satisfy optional filter criteria. Note: Identical SamplePlayableLocations requests can return different results as the state of the world changes over time.

Parameters:

  • google_maps_playablelocations_v3_sample_playable_locations_request_object (Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SamplePlayableLocationsRequest) (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



137
138
139
140
141
142
143
144
145
146
 
# File 'generated/google/apis/playablelocations_v3/service.rb', line 137

def sample_playable_locations(google_maps_playablelocations_v3_sample_playable_locations_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v3:samplePlayableLocations', options)
  command.request_representation = Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SamplePlayableLocationsRequest::Representation
  command.request_object = google_maps_playablelocations_v3_sample_playable_locations_request_object
  command.response_representation = Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SamplePlayableLocationsResponse::Representation
  command.response_class = Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SamplePlayableLocationsResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end