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="youtubereporting_v1.html">YouTube Reporting API</a> . <a href="youtubereporting_v1.jobs.html">jobs</a></h1>
     76 <h2>Instance Methods</h2>
     77 <p class="toc_element">
     78   <code><a href="youtubereporting_v1.jobs.reports.html">reports()</a></code>
     79 </p>
     80 <p class="firstline">Returns the reports Resource.</p>
     81 
     82 <p class="toc_element">
     83   <code><a href="#create">create(body, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
     84 <p class="firstline">Creates a job and returns it.</p>
     85 <p class="toc_element">
     86   <code><a href="#delete">delete(jobId, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
     87 <p class="firstline">Deletes a job.</p>
     88 <p class="toc_element">
     89   <code><a href="#get">get(jobId, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
     90 <p class="firstline">Gets a job.</p>
     91 <p class="toc_element">
     92   <code><a href="#list">list(onBehalfOfContentOwner=None, pageSize=None, pageToken=None, x__xgafv=None, includeSystemManaged=None)</a></code></p>
     93 <p class="firstline">Lists jobs.</p>
     94 <p class="toc_element">
     95   <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
     96 <p class="firstline">Retrieves the next page of results.</p>
     97 <h3>Method Details</h3>
     98 <div class="method">
     99     <code class="details" id="create">create(body, onBehalfOfContentOwner=None, x__xgafv=None)</code>
    100   <pre>Creates a job and returns it.
    101 
    102 Args:
    103   body: object, The request body. (required)
    104     The object takes the form of:
    105 
    106 { # A job creating reports of a specific type.
    107     "name": "A String", # The name of the job (max. 100 characters).
    108     "id": "A String", # The server-generated ID of the job (max. 40 characters).
    109     "expireTime": "A String", # The date/time when this job will expire/expired. After a job expired, no
    110         # new reports are generated.
    111     "reportTypeId": "A String", # The type of reports this job creates. Corresponds to the ID of a
    112         # ReportType.
    113     "systemManaged": True or False, # True if this a system-managed job that cannot be modified by the user;
    114         # otherwise false.
    115     "createTime": "A String", # The creation date/time of the job.
    116   }
    117 
    118   onBehalfOfContentOwner: string, The content owner's external ID on which behalf the user is acting on. If
    119 not set, the user is acting for himself (his own channel).
    120   x__xgafv: string, V1 error format.
    121     Allowed values
    122       1 - v1 error format
    123       2 - v2 error format
    124 
    125 Returns:
    126   An object of the form:
    127 
    128     { # A job creating reports of a specific type.
    129       "name": "A String", # The name of the job (max. 100 characters).
    130       "id": "A String", # The server-generated ID of the job (max. 40 characters).
    131       "expireTime": "A String", # The date/time when this job will expire/expired. After a job expired, no
    132           # new reports are generated.
    133       "reportTypeId": "A String", # The type of reports this job creates. Corresponds to the ID of a
    134           # ReportType.
    135       "systemManaged": True or False, # True if this a system-managed job that cannot be modified by the user;
    136           # otherwise false.
    137       "createTime": "A String", # The creation date/time of the job.
    138     }</pre>
    139 </div>
    140 
    141 <div class="method">
    142     <code class="details" id="delete">delete(jobId, onBehalfOfContentOwner=None, x__xgafv=None)</code>
    143   <pre>Deletes a job.
    144 
    145 Args:
    146   jobId: string, The ID of the job to delete. (required)
    147   onBehalfOfContentOwner: string, The content owner's external ID on which behalf the user is acting on. If
    148 not set, the user is acting for himself (his own channel).
    149   x__xgafv: string, V1 error format.
    150     Allowed values
    151       1 - v1 error format
    152       2 - v2 error format
    153 
    154 Returns:
    155   An object of the form:
    156 
    157     { # A generic empty message that you can re-use to avoid defining duplicated
    158       # empty messages in your APIs. A typical example is to use it as the request
    159       # or the response type of an API method. For instance:
    160       #
    161       #     service Foo {
    162       #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
    163       #     }
    164       #
    165       # The JSON representation for `Empty` is empty JSON object `{}`.
    166   }</pre>
    167 </div>
    168 
    169 <div class="method">
    170     <code class="details" id="get">get(jobId, onBehalfOfContentOwner=None, x__xgafv=None)</code>
    171   <pre>Gets a job.
    172 
    173 Args:
    174   jobId: string, The ID of the job to retrieve. (required)
    175   onBehalfOfContentOwner: string, The content owner's external ID on which behalf the user is acting on. If
    176 not set, the user is acting for himself (his own channel).
    177   x__xgafv: string, V1 error format.
    178     Allowed values
    179       1 - v1 error format
    180       2 - v2 error format
    181 
    182 Returns:
    183   An object of the form:
    184 
    185     { # A job creating reports of a specific type.
    186       "name": "A String", # The name of the job (max. 100 characters).
    187       "id": "A String", # The server-generated ID of the job (max. 40 characters).
    188       "expireTime": "A String", # The date/time when this job will expire/expired. After a job expired, no
    189           # new reports are generated.
    190       "reportTypeId": "A String", # The type of reports this job creates. Corresponds to the ID of a
    191           # ReportType.
    192       "systemManaged": True or False, # True if this a system-managed job that cannot be modified by the user;
    193           # otherwise false.
    194       "createTime": "A String", # The creation date/time of the job.
    195     }</pre>
    196 </div>
    197 
    198 <div class="method">
    199     <code class="details" id="list">list(onBehalfOfContentOwner=None, pageSize=None, pageToken=None, x__xgafv=None, includeSystemManaged=None)</code>
    200   <pre>Lists jobs.
    201 
    202 Args:
    203   onBehalfOfContentOwner: string, The content owner's external ID on which behalf the user is acting on. If
    204 not set, the user is acting for himself (his own channel).
    205   pageSize: integer, Requested page size. Server may return fewer jobs than requested.
    206 If unspecified, server will pick an appropriate default.
    207   pageToken: string, A token identifying a page of results the server should return. Typically,
    208 this is the value of
    209 ListReportTypesResponse.next_page_token
    210 returned in response to the previous call to the `ListJobs` method.
    211   x__xgafv: string, V1 error format.
    212     Allowed values
    213       1 - v1 error format
    214       2 - v2 error format
    215   includeSystemManaged: boolean, If set to true, also system-managed jobs will be returned; otherwise only
    216 user-created jobs will be returned. System-managed jobs can neither be
    217 modified nor deleted.
    218 
    219 Returns:
    220   An object of the form:
    221 
    222     { # Response message for ReportingService.ListJobs.
    223     "nextPageToken": "A String", # A token to retrieve next page of results.
    224         # Pass this value in the
    225         # ListJobsRequest.page_token
    226         # field in the subsequent call to `ListJobs` method to retrieve the next
    227         # page of results.
    228     "jobs": [ # The list of jobs.
    229       { # A job creating reports of a specific type.
    230           "name": "A String", # The name of the job (max. 100 characters).
    231           "id": "A String", # The server-generated ID of the job (max. 40 characters).
    232           "expireTime": "A String", # The date/time when this job will expire/expired. After a job expired, no
    233               # new reports are generated.
    234           "reportTypeId": "A String", # The type of reports this job creates. Corresponds to the ID of a
    235               # ReportType.
    236           "systemManaged": True or False, # True if this a system-managed job that cannot be modified by the user;
    237               # otherwise false.
    238           "createTime": "A String", # The creation date/time of the job.
    239         },
    240     ],
    241   }</pre>
    242 </div>
    243 
    244 <div class="method">
    245     <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
    246   <pre>Retrieves the next page of results.
    247 
    248 Args:
    249   previous_request: The request for the previous page. (required)
    250   previous_response: The response from the request for the previous page. (required)
    251 
    252 Returns:
    253   A request object that you can call 'execute()' on to request the next
    254   page. Returns None if there are no more items in the collection.
    255     </pre>
    256 </div>
    257 
    258 </body></html>