Class: Google::Apis::PlaymoviespartnerV1::PlayMoviesService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/playmoviespartner_v1/service.rb

Overview

Google Play Movies Partner API

Gets the delivery status of titles for Google Play Movies Partners.

Examples:

require 'google/apis/playmoviespartner_v1'

Playmoviespartner = Google::Apis::PlaymoviespartnerV1 # Alias the module
service = Playmoviespartner::PlayMoviesService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ PlayMoviesService

Returns a new instance of PlayMoviesService



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

def initialize
  super('https://playmoviespartner.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/playmoviespartner_v1/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/playmoviespartner_v1/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#get_account_avail(account_id, avail_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlaymoviespartnerV1::Avail

Get an Avail given its avail group id and avail id.

Parameters:

  • account_id (String) —

    REQUIRED. See General rules for more information about this field.

  • avail_id (String) —

    REQUIRED. Avail ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def (, avail_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/accounts/{accountId}/avails/{availId}', options)
  command.response_representation = Google::Apis::PlaymoviespartnerV1::Avail::Representation
  command.response_class = Google::Apis::PlaymoviespartnerV1::Avail
  command.params['accountId'] =  unless .nil?
  command.params['availId'] = avail_id unless avail_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_account_order(account_id, order_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlaymoviespartnerV1::Order

Get an Order given its id. See Authentication and Authorization rules and Get methods rules for more information about this method.

Parameters:

  • account_id (String) —

    REQUIRED. See General rules for more information about this field.

  • order_id (String) —

    REQUIRED. Order ID.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



173
174
175
176
177
178
179
180
181
182
 
# File 'generated/google/apis/playmoviespartner_v1/service.rb', line 173

def (, order_id, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/accounts/{accountId}/orders/{orderId}', options)
  command.response_representation = Google::Apis::PlaymoviespartnerV1::Order::Representation
  command.response_class = Google::Apis::PlaymoviespartnerV1::Order
  command.params['accountId'] =  unless .nil?
  command.params['orderId'] = order_id unless order_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_account_store_info_country(account_id, video_id, country, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlaymoviespartnerV1::StoreInfo

Get a StoreInfo given its video id and country. See Authentication and Authorization rules and Get methods rules for more information about this method.

Parameters:

  • account_id (String) —

    REQUIRED. See General rules for more information about this field.

  • video_id (String) —

    REQUIRED. Video ID.

  • country (String) —

    REQUIRED. Edit country.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



333
334
335
336
337
338
339
340
341
342
343
 
# File 'generated/google/apis/playmoviespartner_v1/service.rb', line 333

def (, video_id, country, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/accounts/{accountId}/storeInfos/{videoId}/country/{country}', options)
  command.response_representation = Google::Apis::PlaymoviespartnerV1::StoreInfo::Representation
  command.response_class = Google::Apis::PlaymoviespartnerV1::StoreInfo
  command.params['accountId'] =  unless .nil?
  command.params['videoId'] = video_id unless video_id.nil?
  command.params['country'] = country unless country.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_account_avails(account_id, alt_id: nil, alt_ids: nil, page_size: nil, page_token: nil, pph_names: nil, studio_names: nil, territories: nil, title: nil, video_ids: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlaymoviespartnerV1::ListAvailsResponse

List Avails owned or managed by the partner. See Authentication and Authorization rules and List methods rules for more information about this method.

Parameters:

  • account_id (String) —

    REQUIRED. See General rules for more information about this field.

  • alt_id (String) —

    Filter Avails that match a case-insensitive, partner-specific custom id. NOTE: this field is deprecated and will be removed on V2; alt_ids should be used instead.

  • alt_ids (Array<String>, String) —

    Filter Avails that match (case-insensitive) any of the given partner-specific custom ids.

  • page_size (Fixnum) —

    See List methods rules for info about this field.

  • page_token (String) —

    See List methods rules for info about this field.

  • pph_names (Array<String>, String) —

    See List methods rules for info about this field.

  • studio_names (Array<String>, String) —

    See List methods rules for info about this field.

  • territories (Array<String>, String) —

    Filter Avails that match (case-insensitive) any of the given country codes, using the "ISO 3166-1 alpha-2" format (examples: "US", "us", "Us").

  • title (String) —

    Filter that matches Avails with a title_internal_alias, series_title_internal_alias, season_title_internal_alias, or episode_title_internal_alias that contains the given case-insensitive title.

  • video_ids (Array<String>, String) —

    Filter Avails that match any of the given video_ids.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'generated/google/apis/playmoviespartner_v1/service.rb', line 130

def (, alt_id: nil, alt_ids: nil, page_size: nil, page_token: nil, pph_names: nil, studio_names: nil, territories: nil, title: nil, video_ids: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/accounts/{accountId}/avails', options)
  command.response_representation = Google::Apis::PlaymoviespartnerV1::ListAvailsResponse::Representation
  command.response_class = Google::Apis::PlaymoviespartnerV1::ListAvailsResponse
  command.params['accountId'] =  unless .nil?
  command.query['altId'] = alt_id unless alt_id.nil?
  command.query['altIds'] = alt_ids unless alt_ids.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['pphNames'] = pph_names unless pph_names.nil?
  command.query['studioNames'] = studio_names unless studio_names.nil?
  command.query['territories'] = territories unless territories.nil?
  command.query['title'] = title unless title.nil?
  command.query['videoIds'] = video_ids unless video_ids.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_account_orders(account_id, custom_id: nil, name: nil, page_size: nil, page_token: nil, pph_names: nil, status: nil, studio_names: nil, video_ids: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlaymoviespartnerV1::ListOrdersResponse

List Orders owned or managed by the partner. See Authentication and Authorization rules and List methods rules for more information about this method.

Parameters:

  • account_id (String) —

    REQUIRED. See General rules for more information about this field.

  • custom_id (String) —

    Filter Orders that match a case-insensitive, partner-specific custom id.

  • name (String) —

    Filter that matches Orders with a name, show, season or episode that contains the given case-insensitive name.

  • page_size (Fixnum) —

    See List methods rules for info about this field.

  • page_token (String) —

    See List methods rules for info about this field.

  • pph_names (Array<String>, String) —

    See List methods rules for info about this field.

  • status (Array<String>, String) —

    Filter Orders that match one of the given status.

  • studio_names (Array<String>, String) —

    See List methods rules for info about this field.

  • video_ids (Array<String>, String) —

    Filter Orders that match any of the given video_ids.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'generated/google/apis/playmoviespartner_v1/service.rb', line 223

def (, custom_id: nil, name: nil, page_size: nil, page_token: nil, pph_names: nil, status: nil, studio_names: nil, video_ids: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/accounts/{accountId}/orders', options)
  command.response_representation = Google::Apis::PlaymoviespartnerV1::ListOrdersResponse::Representation
  command.response_class = Google::Apis::PlaymoviespartnerV1::ListOrdersResponse
  command.params['accountId'] =  unless .nil?
  command.query['customId'] = custom_id unless custom_id.nil?
  command.query['name'] = name unless name.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['pphNames'] = pph_names unless pph_names.nil?
  command.query['status'] = status unless status.nil?
  command.query['studioNames'] = studio_names unless studio_names.nil?
  command.query['videoIds'] = video_ids unless video_ids.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_account_store_infos(account_id, countries: nil, mids: nil, name: nil, page_size: nil, page_token: nil, pph_names: nil, season_ids: nil, studio_names: nil, video_id: nil, video_ids: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PlaymoviespartnerV1::ListStoreInfosResponse

List StoreInfos owned or managed by the partner. See Authentication and Authorization rules and List methods rules for more information about this method.

Parameters:

  • account_id (String) —

    REQUIRED. See General rules for more information about this field.

  • countries (Array<String>, String) —

    Filter StoreInfos that match (case-insensitive) any of the given country codes, using the "ISO 3166-1 alpha-2" format (examples: "US", "us", "Us").

  • mids (Array<String>, String) —

    Filter StoreInfos that match any of the given mids.

  • name (String) —

    Filter that matches StoreInfos with a name or show_name that contains the given case-insensitive name.

  • page_size (Fixnum) —

    See List methods rules for info about this field.

  • page_token (String) —

    See List methods rules for info about this field.

  • pph_names (Array<String>, String) —

    See List methods rules for info about this field.

  • season_ids (Array<String>, String) —

    Filter StoreInfos that match any of the given season_ids.

  • studio_names (Array<String>, String) —

    See List methods rules for info about this field.

  • video_id (String) —

    Filter StoreInfos that match a given video_id. NOTE: this field is deprecated and will be removed on V2; video_ids should be used instead.

  • video_ids (Array<String>, String) —

    Filter StoreInfos that match any of the given video_ids.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'generated/google/apis/playmoviespartner_v1/service.rb', line 287

def (, countries: nil, mids: nil, name: nil, page_size: nil, page_token: nil, pph_names: nil, season_ids: nil, studio_names: nil, video_id: nil, video_ids: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/accounts/{accountId}/storeInfos', options)
  command.response_representation = Google::Apis::PlaymoviespartnerV1::ListStoreInfosResponse::Representation
  command.response_class = Google::Apis::PlaymoviespartnerV1::ListStoreInfosResponse
  command.params['accountId'] =  unless .nil?
  command.query['countries'] = countries unless countries.nil?
  command.query['mids'] = mids unless mids.nil?
  command.query['name'] = name unless name.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['pphNames'] = pph_names unless pph_names.nil?
  command.query['seasonIds'] = season_ids unless season_ids.nil?
  command.query['studioNames'] = studio_names unless studio_names.nil?
  command.query['videoId'] = video_id unless video_id.nil?
  command.query['videoIds'] = video_ids unless video_ids.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end