Class: Google::Apis::PlaymoviespartnerV1::Avail

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/playmoviespartner_v1/classes.rb,
generated/google/apis/playmoviespartner_v1/representations.rb,
generated/google/apis/playmoviespartner_v1/representations.rb

Overview

An Avail describes the Availability Window of a specific Edit in a given country, which means the period Google is allowed to sell or rent the Edit. Avails are exposed in EMA format Version 1.6b (available at http://www.movielabs.com/md/avails/) Studios can see the Avails for the Titles they own. Post-production houses cannot see any Avails.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Avail

Returns a new instance of Avail



265
266
267
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 265

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#alt_id ⇒ String

Other identifier referring to the Edit, as defined by partner. Example: "GOOGLER_2006" Corresponds to the JSON property altId

Returns:

  • (String) 


38
39
40
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 38

def alt_id
  @alt_id
end

#avail_id ⇒ String

ID internally generated by Google to uniquely identify an Avail. Not part of EMA Specs. Corresponds to the JSON property availId

Returns:

  • (String) 


44
45
46
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 44

def avail_id
  @avail_id
end

#caption_exemption ⇒ String

Communicating an exempt category as defined by FCC regulations. It is not required for non-US Avails. Example: "1" Corresponds to the JSON property captionExemption

Returns:

  • (String) 


51
52
53
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 51

def caption_exemption
  @caption_exemption
end

#caption_included ⇒ Boolean Also known as: caption_included?

Communicating if caption file will be delivered. Corresponds to the JSON property captionIncluded

Returns:

  • (Boolean) 


56
57
58
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 56

def caption_included
  @caption_included
end

#content_id ⇒ String

Title Identifier. This should be the Title Level EIDR. Example: "10.5240/1489-49A2-3956-4B2D-FE16-5". Corresponds to the JSON property contentId

Returns:

  • (String) 


63
64
65
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 63

def content_id
  @content_id
end

#display_name ⇒ String

The name of the studio that owns the Edit referred in the Avail. This is the equivalent of studio_name in other resources, but it follows the EMA nomenclature. Example: "Google Films". Corresponds to the JSON property displayName

Returns:

  • (String) 


71
72
73
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 71

def display_name
  @display_name
end

#encode_id ⇒ String

Manifestation Identifier. This should be the Manifestation Level EIDR. Example: "10.2340/1489-49A2-3956-4B2D-FE16-7" Corresponds to the JSON property encodeId

Returns:

  • (String) 


78
79
80
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 78

def encode_id
  @encode_id
end

#end ⇒ String

End of term in YYYY-MM-DD format in the timezone of the country of the Avail. "Open" if no end date is available. Example: "2019-02-17" Corresponds to the JSON property end

Returns:

  • (String) 


86
87
88
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 86

def end
  @end
end

#episode_alt_id ⇒ String

Other identifier referring to the episode, as defined by partner. Only available on TV avails. Example: "rs_googlers_s1_3". Corresponds to the JSON property episodeAltId

Returns:

  • (String) 


93
94
95
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 93

def episode_alt_id
  @episode_alt_id
end

#episode_number ⇒ String

The number assigned to the episode within a season. Only available on TV Avails. Example: "3". Corresponds to the JSON property episodeNumber

Returns:

  • (String) 


100
101
102
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 100

def episode_number
  @episode_number
end

#episode_title_internal_alias ⇒ String

OPTIONAL.TV Only. Title used by involved parties to refer to this episode. Only available on TV Avails. Example: "Coding at Google". Corresponds to the JSON property episodeTitleInternalAlias

Returns:

  • (String) 


107
108
109
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 107

def episode_title_internal_alias
  @episode_title_internal_alias
end

#format_profile ⇒ String

Indicates the format profile covered by the transaction. Corresponds to the JSON property formatProfile

Returns:

  • (String) 


112
113
114
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 112

def format_profile
  @format_profile
end

#license_type ⇒ String

Type of transaction. Corresponds to the JSON property licenseType

Returns:

  • (String) 


117
118
119
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 117

def license_type
  @license_type
end

#pph_names ⇒ Array<String>

Name of the post-production houses that manage the Avail. Not part of EMA Specs. Corresponds to the JSON property pphNames

Returns:

  • (Array<String>) 


123
124
125
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 123

def pph_names
  @pph_names
end

#price_type ⇒ String

Type of pricing that should be applied to this Avail based on how the partner classify them. Example: "Tier", "WSP", "SRP", or "Category". Corresponds to the JSON property priceType

Returns:

  • (String) 


130
131
132
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 130

def price_type
  @price_type
end

#price_value ⇒ String

Value to be applied to the pricing type. Example: "4" or "2.99" Corresponds to the JSON property priceValue

Returns:

  • (String) 


136
137
138
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 136

def price_value
  @price_value
end

#product_id ⇒ String

Edit Identifier. This should be the Edit Level EIDR. Example: "10.2340/1489-49A2-3956-4B2D-FE16-6" Corresponds to the JSON property productId

Returns:

  • (String) 


142
143
144
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 142

def product_id
  @product_id
end

#rating_reason ⇒ String

Value representing the rating reason. Rating reasons should be formatted as per EMA ratings spec and comma-separated for inclusion of multiple reasons. Example: "L, S, V" Corresponds to the JSON property ratingReason

Returns:

  • (String) 


151
152
153
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 151

def rating_reason
  @rating_reason
end

#rating_system ⇒ String

Rating system applied to the version of title within territory of Avail. Rating systems should be formatted as per EMA ratings spec Example: "MPAA" Corresponds to the JSON property ratingSystem

Returns:

  • (String) 


160
161
162
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 160

def rating_system
  @rating_system
end

#rating_value ⇒ String

Value representing the rating. Ratings should be formatted as per http://www.movielabs.com/md/ratings/ Example: "PG" Corresponds to the JSON property ratingValue

Returns:

  • (String) 


167
168
169
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 167

def rating_value
  @rating_value
end

#release_date ⇒ String

Release date of the Title in earliest released territory. Typically it is just the year, but it is free-form as per EMA spec. Examples: "1979", "Oct 2014" Corresponds to the JSON property releaseDate

Returns:

  • (String) 


174
175
176
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 174

def release_date
  @release_date
end

#season_alt_id ⇒ String

Other identifier referring to the season, as defined by partner. Only available on TV avails. Example: "rs_googlers_s1". Corresponds to the JSON property seasonAltId

Returns:

  • (String) 


181
182
183
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 181

def season_alt_id
  @season_alt_id
end

#season_number ⇒ String

The number assigned to the season within a series. Only available on TV Avails. Example: "1". Corresponds to the JSON property seasonNumber

Returns:

  • (String) 


188
189
190
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 188

def season_number
  @season_number
end

#season_title_internal_alias ⇒ String

Title used by involved parties to refer to this season. Only available on TV Avails. Example: "Googlers, The". Corresponds to the JSON property seasonTitleInternalAlias

Returns:

  • (String) 


195
196
197
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 195

def season_title_internal_alias
  @season_title_internal_alias
end

#series_alt_id ⇒ String

Other identifier referring to the series, as defined by partner. Only available on TV avails. Example: "rs_googlers". Corresponds to the JSON property seriesAltId

Returns:

  • (String) 


202
203
204
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 202

def series_alt_id
  @series_alt_id
end

#series_title_internal_alias ⇒ String

Title used by involved parties to refer to this series. Only available on TV Avails. Example: "Googlers, The". Corresponds to the JSON property seriesTitleInternalAlias

Returns:

  • (String) 


209
210
211
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 209

def series_title_internal_alias
  @series_title_internal_alias
end

#start ⇒ String

Start of term in YYYY-MM-DD format in the timezone of the country of the Avail. Example: "2013-05-14". Corresponds to the JSON property start

Returns:

  • (String) 


216
217
218
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 216

def start
  @start
end

#store_language ⇒ String

Spoken language of the intended audience. Language shall be encoded in accordance with RFC 5646. Example: "fr". Corresponds to the JSON property storeLanguage

Returns:

  • (String) 


223
224
225
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 223

def store_language
  @store_language
end

#suppression_lift_date ⇒ String

First date an Edit could be publically announced as becoming available at a specific future date in territory of Avail. Not the Avail start date or pre-order start date. Format is YYYY-MM-DD. Only available for pre-orders. Example: "2012-12-10" Corresponds to the JSON property suppressionLiftDate

Returns:

  • (String) 


233
234
235
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 233

def suppression_lift_date
  @suppression_lift_date
end

#territory ⇒ String

ISO 3166-1 alpha-2 country code for the country or territory of this Avail. For Avails, we use Territory in lieu of Country to comply with EMA specifications. But please note that Territory and Country identify the same thing. Example: "US". Corresponds to the JSON property territory

Returns:

  • (String) 


243
244
245
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 243

def territory
  @territory
end

#title_internal_alias ⇒ String

Title used by involved parties to refer to this content. Example: "Googlers, The". Only available on Movie Avails. Corresponds to the JSON property titleInternalAlias

Returns:

  • (String) 


250
251
252
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 250

def title_internal_alias
  @title_internal_alias
end

#video_id ⇒ String

Google-generated ID identifying the video linked to this Avail, once delivered. Not part of EMA Specs. Example: 'gtry456_xc' Corresponds to the JSON property videoId

Returns:

  • (String) 


258
259
260
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 258

def video_id
  @video_id
end

#work_type ⇒ String

Work type as enumerated in EMA. Corresponds to the JSON property workType

Returns:

  • (String) 


263
264
265
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 263

def work_type
  @work_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'generated/google/apis/playmoviespartner_v1/classes.rb', line 270

def update!(**args)
  @alt_id = args[:alt_id] if args.key?(:alt_id)
  @avail_id = args[:avail_id] if args.key?(:avail_id)
  @caption_exemption = args[:caption_exemption] if args.key?(:caption_exemption)
  @caption_included = args[:caption_included] if args.key?(:caption_included)
  @content_id = args[:content_id] if args.key?(:content_id)
  @display_name = args[:display_name] if args.key?(:display_name)
  @encode_id = args[:encode_id] if args.key?(:encode_id)
  @end = args[:end] if args.key?(:end)
  @episode_alt_id = args[:episode_alt_id] if args.key?(:episode_alt_id)
  @episode_number = args[:episode_number] if args.key?(:episode_number)
  @episode_title_internal_alias = args[:episode_title_internal_alias] if args.key?(:episode_title_internal_alias)
  @format_profile = args[:format_profile] if args.key?(:format_profile)
  @license_type = args[:license_type] if args.key?(:license_type)
  @pph_names = args[:pph_names] if args.key?(:pph_names)
  @price_type = args[:price_type] if args.key?(:price_type)
  @price_value = args[:price_value] if args.key?(:price_value)
  @product_id = args[:product_id] if args.key?(:product_id)
  @rating_reason = args[:rating_reason] if args.key?(:rating_reason)
  @rating_system = args[:rating_system] if args.key?(:rating_system)
  @rating_value = args[:rating_value] if args.key?(:rating_value)
  @release_date = args[:release_date] if args.key?(:release_date)
  @season_alt_id = args[:season_alt_id] if args.key?(:season_alt_id)
  @season_number = args[:season_number] if args.key?(:season_number)
  @season_title_internal_alias = args[:season_title_internal_alias] if args.key?(:season_title_internal_alias)
  @series_alt_id = args[:series_alt_id] if args.key?(:series_alt_id)
  @series_title_internal_alias = args[:series_title_internal_alias] if args.key?(:series_title_internal_alias)
  @start = args[:start] if args.key?(:start)
  @store_language = args[:store_language] if args.key?(:store_language)
  @suppression_lift_date = args[:suppression_lift_date] if args.key?(:suppression_lift_date)
  @territory = args[:territory] if args.key?(:territory)
  @title_internal_alias = args[:title_internal_alias] if args.key?(:title_internal_alias)
  @video_id = args[:video_id] if args.key?(:video_id)
  @work_type = args[:work_type] if args.key?(:work_type)
end