File: youtubeAnalytics_v1.batchReports.html

package info (click to toggle)
python-googleapi 1.5.5-1
  • links: PTS
  • area: main
  • in suites: buster, stretch
  • size: 39,832 kB
  • ctags: 5,921
  • sloc: python: 7,176; makefile: 64; sh: 53; xml: 5
file content (116 lines) | stat: -rw-r--r-- 3,478 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
<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="youtubeAnalytics_v1.html">YouTube Analytics API</a> . <a href="youtubeAnalytics_v1.batchReports.html">batchReports</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#list">list(batchReportDefinitionId, onBehalfOfContentOwner)</a></code></p>
<p class="firstline">Retrieves a list of processed batch reports.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="list">list(batchReportDefinitionId, onBehalfOfContentOwner)</code>
  <pre>Retrieves a list of processed batch reports.

Args:
  batchReportDefinitionId: string, The batchReportDefinitionId parameter specifies the ID of the batch reportort definition for which you are retrieving reports. (required)
  onBehalfOfContentOwner: string, The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of. (required)

Returns:
  An object of the form:

    { # A paginated list of batchReport resources returned in response to a youtubeAnalytics.batchReport.list request.
    "items": [ # A list of batchReport resources that match the request criteria.
      { # Contains single batchReport resource.
        "kind": "youtubeAnalytics#batchReport", # This value specifies the type of data of this item. For batch report the kind property value is youtubeAnalytics#batchReport.
        "timeSpan": { # Period included in the report. For reports containing all entities endTime is not set. Both startTime and endTime are inclusive.
          "endTime": "A String", # End of the period included in the report. Inclusive. For reports containing all entities endTime is not set.
          "startTime": "A String", # Start of the period included in the report. Inclusive.
        },
        "outputs": [ # Report outputs.
          {
            "downloadUrl": "A String", # Cloud storage URL to download this report. This URL is valid for 30 minutes.
            "type": "cloudStorageOutput", # Type of the output.
            "format": "A String", # Format of the output.
          },
        ],
        "reportId": "A String", # The ID of the the report definition.
        "timeUpdated": "A String", # The time when the report was updated.
        "id": "A String", # The ID that YouTube assigns and uses to uniquely identify the report.
      },
    ],
    "kind": "youtubeAnalytics#batchReportList", # This value specifies the type of data included in the API response. For the list method, the kind property value is youtubeAnalytics#batchReportList.
  }</pre>
</div>

</body></html>