blob: 05ac459ba4c8fbd50ac98e8ae1aff2c57a6d7db1 [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.components.html">components</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="playmoviespartner_v1.accounts.components.type.html">type()</a></code>
</p>
<p class="firstline">Returns the type Resource.</p>
<p class="toc_element">
<code><a href="#list">list(accountId, pphNames=None, pageSize=None, editLevelEidr=None, x__xgafv=None, playableSequenceId=None, studioNames=None, filename=None, pageToken=None, customId=None, status=None, titleLevelEidr=None, presentationId=None, inventoryId=None, altCutId=None, elId=None)</a></code></p>
<p class="firstline">List Components 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="list">list(accountId, pphNames=None, pageSize=None, editLevelEidr=None, x__xgafv=None, playableSequenceId=None, studioNames=None, filename=None, pageToken=None, customId=None, status=None, titleLevelEidr=None, presentationId=None, inventoryId=None, altCutId=None, elId=None)</code>
<pre>List Components 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 Components that match a given edit-level EIDR.
x__xgafv: string, V1 error format.
playableSequenceId: string, PlayableSequenceID available in Common Manifest.
studioNames: string, See _List methods rules_ for info about this field. (repeated)
filename: string, Filter Components that match a case-insensitive substring of the physical name of the delivered file.
pageToken: string, See _List methods rules_ for info about this field.
customId: string, Filter Components that match a case-insensitive partner-specific custom id.
status: string, Filter Components that match one of the given status. (repeated)
titleLevelEidr: string, Filter Components that match a given title-level EIDR.
presentationId: string, PresentationID available in Common Manifest.
inventoryId: string, InventoryID available in Common Manifest.
altCutId: string, Filter Components that match a case-insensitive, partner-specific Alternative Cut ID.
elId: string, Experience ID, as defined by Google.
Returns:
An object of the form:
{ # Response to the 'ListComponents' 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.
"components": [ # List of Components that match the request criteria.
{ # A Component is an element (audio, video, subtitle, artwork, trailer, etc...) that is used in a set of ExperienceLocales. A Component is owned by a Studio and managed either by the Studio itself or by one Post-Production House. Each Component is identified by a `component_id` and its `type`.
"altCutIds": [ # List of Alternative Cut IDs, sometimes available in lieu of the main Edit-level EIDR IDs. This is not an EIDR ID, but a Partner-provided ID. Example: "206346_79838".
"A String",
],
"processingErrors": [ # Processing errors during XML file parsing. Example: 'Invalid input file'
"A String",
],
"studioName": "A String", # Name of the studio that owns the Component.
"rejectionNote": "A String", # Notes explaining why a Component has been rejected.
"titleLevelEidrs": [ # List of Title-level EIDR IDs. Example: "10.5240/1489-49A2-3956-4B2D-FE16-5".
"A String",
],
"playableUnitType": "A String", # Type of the playable unit for which the Component is intended.
"receivedTime": "A String", # Timestamp when the Component was received.
"filename": "A String", # File name of the Component when delivered.
"priority": 3.14, # Component priority, as defined by Google. The higher the value, the higher the priority.
"editLevelEidrs": [ # List of Edit-level EIDR IDs. Example: "10.5240/1489-49A2-3956-4B2D-FE16-6".
"A String",
],
"type": "A String", # Type of the Component. Example: AUDIO_51
"componentId": "A String", # ID internally generated by Google to uniquely identify the Component. Example: 'wteyrc_647xc'
"status": "A String", # High-level status of the Component.
"statusDetail": "A String", # Detailed status of the Component
"approvedTime": "A String", # Timestamp when the Component was approved.
"elIds": [ # IDs internally generated by Google to uniquely identify the ExperienceLocales for which the Component is used. Example: 'KRZiVjY9h7t'
"A String",
],
"name": "A String", # Default Edit name, usually in the language of the country of origin. Example: "Googlers, The".
"language": "A String", # Language of the component, using the "BCP 47" format. Examples: "en", "en-US", "es", "es-419".
"componentDetailType": "A String", # Detail about the type of the Component.
"customIds": [ # List of custom IDs (defined by the partner) linked to the ExperienceLocale using this Component. Example: "R86241"
"A String",
],
"pphName": "A String", # Name of the post-production house that manages the Component.
"normalizedPriority": "A String", # A simpler representation of the priority.
},
],
}</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>