blob: 2a13be1d38b50c81ca3348f9ab4aabb58cd47a81 [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="playmoviespartner_v1.html">Google Play Movies Partner API</a> . <a href="playmoviespartner_v1.accounts.html">accounts</a> . <a href="playmoviespartner_v1.accounts.experienceLocales.html">experienceLocales</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(accountId, elId, x__xgafv=None)</a></code></p>
<p class="firstline">Get an ExperienceLocale given its id. See _Authentication and Authorization rules_ and _Get methods rules_ for more information about this method.</p>
<p class="toc_element">
<code><a href="#list">list(accountId, pphNames=None, pageSize=None, editLevelEidr=None, x__xgafv=None, studioNames=None, pageToken=None, customId=None, status=None, titleLevelEidr=None, altCutId=None)</a></code></p>
<p class="firstline">List ExperienceLocales owned or managed by the partner. See _Authentication and Authorization rules_ and _List methods rules_ for more information about this method.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(accountId, elId, x__xgafv=None)</code>
<pre>Get an ExperienceLocale given its id. See _Authentication and Authorization rules_ and _Get methods rules_ for more information about this method.
Args:
accountId: string, REQUIRED. See _General rules_ for more information about this field. (required)
elId: string, REQUIRED. ExperienceLocale ID, as defined by Google. (required)
x__xgafv: string, V1 error format.
Returns:
An object of the form:
{ # An ExperienceLocale tracks the fulfillment of a Title in a country using a specific language, when delivered using component-based delivery. For example, a Title in Switzerland might have 3 ExperienceLocales: they both share the same country ("CH"), but each has different languages ("de", "fr", and "it"). Each ExperienceLocale is uniquely identified by an `el_id`, which is generated by Google. Externally, an ExperienceLocale can also be identified by partners using its EIDR IDs, AltCutID or `custom_id` (when provided).
"pphNames": [ # Name of the post-production houses that manage the ExperienceLocale.
"A String",
],
"channelId": "A String", # YouTube Channel ID linked to the ExperienceLocale. Example: "UCRG64darCZhb".
"studioName": "A String", # Name of the studio that owns the ExperienceLocale.
"editLevelEidr": "A String", # Edit-level EIDR ID. Example: "10.5240/1489-49A2-3956-4B2D-FE16-6".
"playableSequenceId": "A String", # PlayableSequenceID as defined in the EMA specs.
"presentationId": "A String", # PresentationID as defined in the EMA specs.
"priority": 3.14, # ExperienceLocale priority, as defined by Google. The higher the value, the higher the priority. Example: 90
"type": "A String", # Type of the Edit linked to the ExperienceLocale.
"status": "A String", # High-level status of the ExperienceLocale.
"titleLevelEidr": "A String", # Title-level EIDR ID. Example: "10.5240/1489-49A2-3956-4B2D-FE16-5".
"trailerId": "A String", # Trailer ID, as defined by Google, linked to the trailer video in the ExperienceLocale. Example: 'gtry457_tr'.
"videoId": "A String", # Video ID, as defined by Google, linked to the feature video in the ExperienceLocale. Example: 'gtry456_xc'.
"approvedTime": "A String", # Timestamp when the ExperienceLocale was approved.
"inventoryId": "A String", # InventoryID as defined in the EMA specs.
"altCutId": "A String", # Alternative Cut ID, sometimes available in lieu of the main Edit-level EIDR ID. This is not an EIDR ID, but a Partner-provided ID. Example: "206346_79838".
"earliestAvailStartTime": "A String", # Timestamp of the earliest start date of the Avails linked to this ExperienceLocale.
"elId": "A String", # ID internally generated by Google to uniquely identify a ExperienceLocale. Example: 'KRZiVjY9h7t'
"name": "A String", # Default Edit name, usually in the language of the country of origin. Example: "Googlers, The".
"language": "A String", # Language of the ExperienceLocale, using the "BCP 47" format. Examples: "en", "en-US", "es", "es-419".
"country": "A String", # Country where the ExperienceLocale is available, using the "ISO 3166-1 alpha-2" format. Example: "US".
"customIds": [ # List of custom IDs (defined by the partner) linked to this ExperienceLocale. Example: "R86241"
"A String",
],
"normalizedPriority": "A String", # A simpler representation of the priority.
"createdTime": "A String", # Timestamp when the ExperienceLocale was created.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(accountId, pphNames=None, pageSize=None, editLevelEidr=None, x__xgafv=None, studioNames=None, pageToken=None, customId=None, status=None, titleLevelEidr=None, altCutId=None)</code>
<pre>List ExperienceLocales owned or managed by the partner. See _Authentication and Authorization rules_ and _List methods rules_ for more information about this method.
Args:
accountId: string, REQUIRED. See _General rules_ for more information about this field. (required)
pphNames: string, See _List methods rules_ for info about this field. (repeated)
pageSize: integer, See _List methods rules_ for info about this field.
editLevelEidr: string, Filter ExperienceLocales that match a given edit-level EIDR.
x__xgafv: string, V1 error format.
studioNames: string, See _List methods rules_ for info about this field. (repeated)
pageToken: string, See _List methods rules_ for info about this field.
customId: string, Filter ExperienceLocales that match a case-insensitive, partner-specific custom id.
status: string, Filter ExperienceLocales that match one of the given status. (repeated)
titleLevelEidr: string, Filter ExperienceLocales that match a given title-level EIDR.
altCutId: string, Filter ExperienceLocales that match a case-insensitive, partner-specific Alternative Cut ID.
Returns:
An object of the form:
{ # Response to the 'ListExperienceLocales' method.
"nextPageToken": "A String", # See _List methods rules_ for info about this field.
"totalSize": 42, # See _List methods rules_ for more information about this field.
"experienceLocales": [ # List of ExperienceLocales that match the request criteria.
{ # An ExperienceLocale tracks the fulfillment of a Title in a country using a specific language, when delivered using component-based delivery. For example, a Title in Switzerland might have 3 ExperienceLocales: they both share the same country ("CH"), but each has different languages ("de", "fr", and "it"). Each ExperienceLocale is uniquely identified by an `el_id`, which is generated by Google. Externally, an ExperienceLocale can also be identified by partners using its EIDR IDs, AltCutID or `custom_id` (when provided).
"pphNames": [ # Name of the post-production houses that manage the ExperienceLocale.
"A String",
],
"channelId": "A String", # YouTube Channel ID linked to the ExperienceLocale. Example: "UCRG64darCZhb".
"studioName": "A String", # Name of the studio that owns the ExperienceLocale.
"editLevelEidr": "A String", # Edit-level EIDR ID. Example: "10.5240/1489-49A2-3956-4B2D-FE16-6".
"playableSequenceId": "A String", # PlayableSequenceID as defined in the EMA specs.
"presentationId": "A String", # PresentationID as defined in the EMA specs.
"priority": 3.14, # ExperienceLocale priority, as defined by Google. The higher the value, the higher the priority. Example: 90
"type": "A String", # Type of the Edit linked to the ExperienceLocale.
"status": "A String", # High-level status of the ExperienceLocale.
"titleLevelEidr": "A String", # Title-level EIDR ID. Example: "10.5240/1489-49A2-3956-4B2D-FE16-5".
"trailerId": "A String", # Trailer ID, as defined by Google, linked to the trailer video in the ExperienceLocale. Example: 'gtry457_tr'.
"videoId": "A String", # Video ID, as defined by Google, linked to the feature video in the ExperienceLocale. Example: 'gtry456_xc'.
"approvedTime": "A String", # Timestamp when the ExperienceLocale was approved.
"inventoryId": "A String", # InventoryID as defined in the EMA specs.
"altCutId": "A String", # Alternative Cut ID, sometimes available in lieu of the main Edit-level EIDR ID. This is not an EIDR ID, but a Partner-provided ID. Example: "206346_79838".
"earliestAvailStartTime": "A String", # Timestamp of the earliest start date of the Avails linked to this ExperienceLocale.
"elId": "A String", # ID internally generated by Google to uniquely identify a ExperienceLocale. Example: 'KRZiVjY9h7t'
"name": "A String", # Default Edit name, usually in the language of the country of origin. Example: "Googlers, The".
"language": "A String", # Language of the ExperienceLocale, using the "BCP 47" format. Examples: "en", "en-US", "es", "es-419".
"country": "A String", # Country where the ExperienceLocale is available, using the "ISO 3166-1 alpha-2" format. Example: "US".
"customIds": [ # List of custom IDs (defined by the partner) linked to this ExperienceLocale. Example: "R86241"
"A String",
],
"normalizedPriority": "A String", # A simpler representation of the priority.
"createdTime": "A String", # Timestamp when the ExperienceLocale was created.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>