Home | History | Annotate | Download | only in dyn
      1 <html><body>
      2 <style>
      3 
      4 body, h1, h2, h3, div, span, p, pre, a {
      5   margin: 0;
      6   padding: 0;
      7   border: 0;
      8   font-weight: inherit;
      9   font-style: inherit;
     10   font-size: 100%;
     11   font-family: inherit;
     12   vertical-align: baseline;
     13 }
     14 
     15 body {
     16   font-size: 13px;
     17   padding: 1em;
     18 }
     19 
     20 h1 {
     21   font-size: 26px;
     22   margin-bottom: 1em;
     23 }
     24 
     25 h2 {
     26   font-size: 24px;
     27   margin-bottom: 1em;
     28 }
     29 
     30 h3 {
     31   font-size: 20px;
     32   margin-bottom: 1em;
     33   margin-top: 1em;
     34 }
     35 
     36 pre, code {
     37   line-height: 1.5;
     38   font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
     39 }
     40 
     41 pre {
     42   margin-top: 0.5em;
     43 }
     44 
     45 h1, h2, h3, p {
     46   font-family: Arial, sans serif;
     47 }
     48 
     49 h1, h2, h3 {
     50   border-bottom: solid #CCC 1px;
     51 }
     52 
     53 .toc_element {
     54   margin-top: 0.5em;
     55 }
     56 
     57 .firstline {
     58   margin-left: 2 em;
     59 }
     60 
     61 .method  {
     62   margin-top: 1em;
     63   border: solid 1px #CCC;
     64   padding: 1em;
     65   background: #EEE;
     66 }
     67 
     68 .details {
     69   font-weight: bold;
     70   font-size: 14px;
     71 }
     72 
     73 </style>
     74 
     75 <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.orders.html">orders</a></h1>
     76 <h2>Instance Methods</h2>
     77 <p class="toc_element">
     78   <code><a href="#get">get(accountId, orderId, x__xgafv=None)</a></code></p>
     79 <p class="firstline">Get an Order given its id.</p>
     80 <p class="toc_element">
     81   <code><a href="#list">list(accountId, pphNames=None, pageSize=None, x__xgafv=None, studioNames=None, pageToken=None, customId=None, status=None, videoIds=None, name=None)</a></code></p>
     82 <p class="firstline">List Orders owned or managed by the partner.</p>
     83 <p class="toc_element">
     84   <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
     85 <p class="firstline">Retrieves the next page of results.</p>
     86 <h3>Method Details</h3>
     87 <div class="method">
     88     <code class="details" id="get">get(accountId, orderId, x__xgafv=None)</code>
     89   <pre>Get an Order given its id.
     90 
     91 See _Authentication and Authorization rules_ and
     92 _Get methods rules_ for more information about this method.
     93 
     94 Args:
     95   accountId: string, REQUIRED. See _General rules_ for more information about this field. (required)
     96   orderId: string, REQUIRED. Order ID. (required)
     97   x__xgafv: string, V1 error format.
     98     Allowed values
     99       1 - v1 error format
    100       2 - v2 error format
    101 
    102 Returns:
    103   An object of the form:
    104 
    105     { # An Order tracks the fulfillment of an Edit when delivered using the
    106       # legacy, non-component-based delivery.
    107       #
    108       # Each Order is uniquely identified by an `order_id`, which is generated
    109       # by Google.
    110       #
    111       # Externally, Orders can also be identified by partners using its `custom_id`
    112       # (when provided).
    113     "status": "A String", # High-level status of the order.
    114     "channelId": "A String", # YouTube Channel ID that should be used to fulfill the Order.
    115         # Example: "UCRG64darCZhb".
    116     "studioName": "A String", # Name of the studio that owns the Edit ordered.
    117     "rejectionNote": "A String", # Field explaining why an Order has been rejected.
    118         # Example: "Trailer audio is 2ch mono, please re-deliver in stereo".
    119     "episodeName": "A String", # Default Episode name,
    120         # usually in the language of the country of origin.
    121         # Only available for TV Edits
    122         # Example: "Googlers, The - Pilot".
    123     "receivedTime": "A String", # Timestamp when the Order was fulfilled.
    124     "priority": 3.14, # Order priority, as defined by Google.
    125         # The higher the value, the higher the priority.
    126         # Example: 90
    127     "customId": "A String", # ID that can be used to externally identify an Order.
    128         # This ID is provided by partners when submitting the Avails.
    129         # Example: 'GOOGLER_2006'
    130     "channelName": "A String", # YouTube Channel Name that should be used to fulfill the Order.
    131         # Example: "Google_channel".
    132     "type": "A String", # Type of the Edit linked to the Order.
    133     "orderId": "A String", # ID internally generated by Google to uniquely identify an Order.
    134         # Example: 'abcde12_x'
    135     "videoId": "A String", # Google-generated ID identifying the video linked to this Order, once
    136         # delivered.
    137         # Example: 'gtry456_xc'.
    138     "statusDetail": "A String", # Detailed status of the order
    139     "approvedTime": "A String", # Timestamp when the Order was approved.
    140     "name": "A String", # Default Edit name,
    141         # usually in the language of the country of origin.
    142         # Example: "Googlers, The".
    143     "earliestAvailStartTime": "A String", # Timestamp of the earliest start date of the Avails
    144         # linked to this Order.
    145     "countries": [ # Countries where the Order is available,
    146         # using the "ISO 3166-1 alpha-2" format (example: "US").
    147       "A String",
    148     ],
    149     "normalizedPriority": "A String", # A simpler representation of the priority.
    150     "orderedTime": "A String", # Timestamp when the Order was created.
    151     "pphName": "A String", # Name of the post-production house that manages the Edit ordered.
    152     "seasonName": "A String", # Default Season name,
    153         # usually in the language of the country of origin.
    154         # Only available for TV Edits
    155         # Example: "Googlers, The - A Brave New World".
    156     "legacyPriority": "A String", # Legacy Order priority, as defined by Google.
    157         # Example: 'P0'
    158     "showName": "A String", # Default Show name,
    159         # usually in the language of the country of origin.
    160         # Only available for TV Edits
    161         # Example: "Googlers, The".
    162   }</pre>
    163 </div>
    164 
    165 <div class="method">
    166     <code class="details" id="list">list(accountId, pphNames=None, pageSize=None, x__xgafv=None, studioNames=None, pageToken=None, customId=None, status=None, videoIds=None, name=None)</code>
    167   <pre>List Orders owned or managed by the partner.
    168 
    169 See _Authentication and Authorization rules_ and
    170 _List methods rules_ for more information about this method.
    171 
    172 Args:
    173   accountId: string, REQUIRED. See _General rules_ for more information about this field. (required)
    174   pphNames: string, See _List methods rules_ for info about this field. (repeated)
    175   pageSize: integer, See _List methods rules_ for info about this field.
    176   x__xgafv: string, V1 error format.
    177     Allowed values
    178       1 - v1 error format
    179       2 - v2 error format
    180   studioNames: string, See _List methods rules_ for info about this field. (repeated)
    181   pageToken: string, See _List methods rules_ for info about this field.
    182   customId: string, Filter Orders that match a case-insensitive, partner-specific custom id.
    183   status: string, Filter Orders that match one of the given status. (repeated)
    184   videoIds: string, Filter Orders that match any of the given `video_id`s. (repeated)
    185   name: string, Filter that matches Orders with a `name`, `show`, `season` or `episode`
    186 that contains the given case-insensitive name.
    187 
    188 Returns:
    189   An object of the form:
    190 
    191     { # Response to the 'ListOrders' method.
    192     "totalSize": 42, # See _List methods rules_ for more information about this field.
    193     "nextPageToken": "A String", # See _List methods rules_ for info about this field.
    194     "orders": [ # List of Orders that match the request criteria.
    195       { # An Order tracks the fulfillment of an Edit when delivered using the
    196           # legacy, non-component-based delivery.
    197           #
    198           # Each Order is uniquely identified by an `order_id`, which is generated
    199           # by Google.
    200           #
    201           # Externally, Orders can also be identified by partners using its `custom_id`
    202           # (when provided).
    203         "status": "A String", # High-level status of the order.
    204         "channelId": "A String", # YouTube Channel ID that should be used to fulfill the Order.
    205             # Example: "UCRG64darCZhb".
    206         "studioName": "A String", # Name of the studio that owns the Edit ordered.
    207         "rejectionNote": "A String", # Field explaining why an Order has been rejected.
    208             # Example: "Trailer audio is 2ch mono, please re-deliver in stereo".
    209         "episodeName": "A String", # Default Episode name,
    210             # usually in the language of the country of origin.
    211             # Only available for TV Edits
    212             # Example: "Googlers, The - Pilot".
    213         "receivedTime": "A String", # Timestamp when the Order was fulfilled.
    214         "priority": 3.14, # Order priority, as defined by Google.
    215             # The higher the value, the higher the priority.
    216             # Example: 90
    217         "customId": "A String", # ID that can be used to externally identify an Order.
    218             # This ID is provided by partners when submitting the Avails.
    219             # Example: 'GOOGLER_2006'
    220         "channelName": "A String", # YouTube Channel Name that should be used to fulfill the Order.
    221             # Example: "Google_channel".
    222         "type": "A String", # Type of the Edit linked to the Order.
    223         "orderId": "A String", # ID internally generated by Google to uniquely identify an Order.
    224             # Example: 'abcde12_x'
    225         "videoId": "A String", # Google-generated ID identifying the video linked to this Order, once
    226             # delivered.
    227             # Example: 'gtry456_xc'.
    228         "statusDetail": "A String", # Detailed status of the order
    229         "approvedTime": "A String", # Timestamp when the Order was approved.
    230         "name": "A String", # Default Edit name,
    231             # usually in the language of the country of origin.
    232             # Example: "Googlers, The".
    233         "earliestAvailStartTime": "A String", # Timestamp of the earliest start date of the Avails
    234             # linked to this Order.
    235         "countries": [ # Countries where the Order is available,
    236             # using the "ISO 3166-1 alpha-2" format (example: "US").
    237           "A String",
    238         ],
    239         "normalizedPriority": "A String", # A simpler representation of the priority.
    240         "orderedTime": "A String", # Timestamp when the Order was created.
    241         "pphName": "A String", # Name of the post-production house that manages the Edit ordered.
    242         "seasonName": "A String", # Default Season name,
    243             # usually in the language of the country of origin.
    244             # Only available for TV Edits
    245             # Example: "Googlers, The - A Brave New World".
    246         "legacyPriority": "A String", # Legacy Order priority, as defined by Google.
    247             # Example: 'P0'
    248         "showName": "A String", # Default Show name,
    249             # usually in the language of the country of origin.
    250             # Only available for TV Edits
    251             # Example: "Googlers, The".
    252       },
    253     ],
    254   }</pre>
    255 </div>
    256 
    257 <div class="method">
    258     <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
    259   <pre>Retrieves the next page of results.
    260 
    261 Args:
    262   previous_request: The request for the previous page. (required)
    263   previous_response: The response from the request for the previous page. (required)
    264 
    265 Returns:
    266   A request object that you can call 'execute()' on to request the next
    267   page. Returns None if there are no more items in the collection.
    268     </pre>
    269 </div>
    270 
    271 </body></html>