docs/dyn/youtubereporting_v1.jobs.html

<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="youtubereporting_v1.html">YouTube Reporting API</a> . <a href="youtubereporting_v1.jobs.html">jobs</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="youtubereporting_v1.jobs.reports.html">reports()</a></code>
</p>
<p class="firstline">Returns the reports Resource.</p>

<p class="toc_element">
  <code><a href="#create">create(body, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a job and returns it.</p>
<p class="toc_element">
  <code><a href="#delete">delete(jobId, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a job.</p>
<p class="toc_element">
  <code><a href="#get">get(jobId, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a job.</p>
<p class="toc_element">
  <code><a href="#list">list(onBehalfOfContentOwner=None, pageSize=None, pageToken=None, x__xgafv=None, includeSystemManaged=None)</a></code></p>
<p class="firstline">Lists jobs.</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="create">create(body, onBehalfOfContentOwner=None, x__xgafv=None)</code>
  <pre>Creates a job and returns it.

Args:
  body: object, The request body. (required)
    The object takes the form of:

{ # A job creating reports of a specific type.
    "name": "A String", # The name of the job (max. 100 characters).
    "id": "A String", # The server-generated ID of the job (max. 40 characters).
    "expireTime": "A String", # The date/time when this job will expire/expired. After a job expired, no
        # new reports are generated.
    "reportTypeId": "A String", # The type of reports this job creates. Corresponds to the ID of a
        # ReportType.
    "systemManaged": True or False, # True if this a system-managed job that cannot be modified by the user;
        # otherwise false.
    "createTime": "A String", # The creation date/time of the job.
  }

  onBehalfOfContentOwner: string, The content owner's external ID on which behalf the user is acting on. If
not set, the user is acting for himself (his own channel).
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A job creating reports of a specific type.
      "name": "A String", # The name of the job (max. 100 characters).
      "id": "A String", # The server-generated ID of the job (max. 40 characters).
      "expireTime": "A String", # The date/time when this job will expire/expired. After a job expired, no
          # new reports are generated.
      "reportTypeId": "A String", # The type of reports this job creates. Corresponds to the ID of a
          # ReportType.
      "systemManaged": True or False, # True if this a system-managed job that cannot be modified by the user;
          # otherwise false.
      "createTime": "A String", # The creation date/time of the job.
    }</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(jobId, onBehalfOfContentOwner=None, x__xgafv=None)</code>
  <pre>Deletes a job.

Args:
  jobId: string, The ID of the job to delete. (required)
  onBehalfOfContentOwner: string, The content owner's external ID on which behalf the user is acting on. If
not set, the user is acting for himself (his own channel).
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }</pre>
</div>

<div class="method">
    <code class="details" id="get">get(jobId, onBehalfOfContentOwner=None, x__xgafv=None)</code>
  <pre>Gets a job.

Args:
  jobId: string, The ID of the job to retrieve. (required)
  onBehalfOfContentOwner: string, The content owner's external ID on which behalf the user is acting on. If
not set, the user is acting for himself (his own channel).
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A job creating reports of a specific type.
      "name": "A String", # The name of the job (max. 100 characters).
      "id": "A String", # The server-generated ID of the job (max. 40 characters).
      "expireTime": "A String", # The date/time when this job will expire/expired. After a job expired, no
          # new reports are generated.
      "reportTypeId": "A String", # The type of reports this job creates. Corresponds to the ID of a
          # ReportType.
      "systemManaged": True or False, # True if this a system-managed job that cannot be modified by the user;
          # otherwise false.
      "createTime": "A String", # The creation date/time of the job.
    }</pre>
</div>

<div class="method">
    <code class="details" id="list">list(onBehalfOfContentOwner=None, pageSize=None, pageToken=None, x__xgafv=None, includeSystemManaged=None)</code>
  <pre>Lists jobs.

Args:
  onBehalfOfContentOwner: string, The content owner's external ID on which behalf the user is acting on. If
not set, the user is acting for himself (his own channel).
  pageSize: integer, Requested page size. Server may return fewer jobs than requested.
If unspecified, server will pick an appropriate default.
  pageToken: string, A token identifying a page of results the server should return. Typically,
this is the value of
ListReportTypesResponse.next_page_token
returned in response to the previous call to the `ListJobs` method.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
  includeSystemManaged: boolean, If set to true, also system-managed jobs will be returned; otherwise only
user-created jobs will be returned. System-managed jobs can neither be
modified nor deleted.

Returns:
  An object of the form:

    { # Response message for ReportingService.ListJobs.
    "nextPageToken": "A String", # A token to retrieve next page of results.
        # Pass this value in the
        # ListJobsRequest.page_token
        # field in the subsequent call to `ListJobs` method to retrieve the next
        # page of results.
    "jobs": [ # The list of jobs.
      { # A job creating reports of a specific type.
          "name": "A String", # The name of the job (max. 100 characters).
          "id": "A String", # The server-generated ID of the job (max. 40 characters).
          "expireTime": "A String", # The date/time when this job will expire/expired. After a job expired, no
              # new reports are generated.
          "reportTypeId": "A String", # The type of reports this job creates. Corresponds to the ID of a
              # ReportType.
          "systemManaged": True or False, # True if this a system-managed job that cannot be modified by the user;
              # otherwise false.
          "createTime": "A String", # The creation date/time of the job.
        },
    ],
  }</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>