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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
|
<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_v2.html">YouTube Analytics API</a> . <a href="youtubeAnalytics_v2.groups.html">groups</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#delete">delete(id=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a group.</p>
<p class="toc_element">
<code><a href="#insert">insert(body=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a group.</p>
<p class="toc_element">
<code><a href="#list">list(id=None, mine=None, onBehalfOfContentOwner=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a collection of groups that match the API request parameters. For example, you can retrieve all groups that the authenticated user owns, or you can retrieve one or more groups by their unique IDs.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#update">update(body=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
<p class="firstline">Modifies a group. For example, you could change a group's title.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(id=None, onBehalfOfContentOwner=None, x__xgafv=None)</code>
<pre>Deletes a group.
Args:
id: string, The `id` parameter specifies the YouTube group ID of the group that is being deleted.
onBehalfOfContentOwner: string, This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Empty response.
"errors": { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details
"code": "A String", # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead.
"error": [ # Specific error description and codes
{ # Describes one specific error.
"argument": [ # Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments.
"A String",
],
"code": "A String", # Error code in the error domain. This should correspond to a value of the enum type whose name is in domain. See the core error domain in error_domain.proto.
"debugInfo": "A String", # Debugging information, which should not be shared externally.
"domain": "A String", # Error domain. RoSy services can define their own domain and error codes. This should normally be the name of an enum type, such as: gdata.CoreErrorDomain
"externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google. Please set domain, code and arguments whenever possible instead of this error message so that external APIs can build safe error messages themselves. External messages built in a RoSy interface will most likely refer to information and concepts that are not available externally and should not be exposed. It is safer if external APIs can understand the errors and decide what the error message should look like.
"location": "A String", # Location of the error, as specified by the location type. If location_type is PATH, this should be a path to a field that's relative to the request, using FieldPath notation (net/proto2/util/public/field_path.h). Examples: authenticated_user.gaia_id resource.address[2].country
"locationType": "A String",
},
],
"requestId": "A String", # Request identifier generated by the service, which can be used to identify the error in the logs
},
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(body=None, onBehalfOfContentOwner=None, x__xgafv=None)</code>
<pre>Creates a group.
Args:
body: object, The request body.
The object takes the form of:
{ # A group.
"contentDetails": { # A group's content details. # The `contentDetails` object contains additional information about the group, such as the number and type of items that it contains.
"itemCount": "A String", # The number of items in the group.
"itemType": "A String", # The type of resources that the group contains. Valid values for this property are: * `youtube#channel` * `youtube#playlist` * `youtube#video` * `youtubePartner#asset`
},
"errors": { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details
"code": "A String", # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead.
"error": [ # Specific error description and codes
{ # Describes one specific error.
"argument": [ # Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments.
"A String",
],
"code": "A String", # Error code in the error domain. This should correspond to a value of the enum type whose name is in domain. See the core error domain in error_domain.proto.
"debugInfo": "A String", # Debugging information, which should not be shared externally.
"domain": "A String", # Error domain. RoSy services can define their own domain and error codes. This should normally be the name of an enum type, such as: gdata.CoreErrorDomain
"externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google. Please set domain, code and arguments whenever possible instead of this error message so that external APIs can build safe error messages themselves. External messages built in a RoSy interface will most likely refer to information and concepts that are not available externally and should not be exposed. It is safer if external APIs can understand the errors and decide what the error message should look like.
"location": "A String", # Location of the error, as specified by the location type. If location_type is PATH, this should be a path to a field that's relative to the request, using FieldPath notation (net/proto2/util/public/field_path.h). Examples: authenticated_user.gaia_id resource.address[2].country
"locationType": "A String",
},
],
"requestId": "A String", # Request identifier generated by the service, which can be used to identify the error in the logs
},
"etag": "A String", # The Etag of this resource.
"id": "A String", # The ID that YouTube uses to uniquely identify the group.
"kind": "A String", # Identifies the API resource's type. The value will be `youtube#group`.
"snippet": { # A group snippet. # The `snippet` object contains basic information about the group, including its creation date and name.
"publishedAt": "A String", # The date and time that the group was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"title": "A String", # The group name. The value must be a non-empty string.
},
}
onBehalfOfContentOwner: string, This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A group.
"contentDetails": { # A group's content details. # The `contentDetails` object contains additional information about the group, such as the number and type of items that it contains.
"itemCount": "A String", # The number of items in the group.
"itemType": "A String", # The type of resources that the group contains. Valid values for this property are: * `youtube#channel` * `youtube#playlist` * `youtube#video` * `youtubePartner#asset`
},
"errors": { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details
"code": "A String", # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead.
"error": [ # Specific error description and codes
{ # Describes one specific error.
"argument": [ # Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments.
"A String",
],
"code": "A String", # Error code in the error domain. This should correspond to a value of the enum type whose name is in domain. See the core error domain in error_domain.proto.
"debugInfo": "A String", # Debugging information, which should not be shared externally.
"domain": "A String", # Error domain. RoSy services can define their own domain and error codes. This should normally be the name of an enum type, such as: gdata.CoreErrorDomain
"externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google. Please set domain, code and arguments whenever possible instead of this error message so that external APIs can build safe error messages themselves. External messages built in a RoSy interface will most likely refer to information and concepts that are not available externally and should not be exposed. It is safer if external APIs can understand the errors and decide what the error message should look like.
"location": "A String", # Location of the error, as specified by the location type. If location_type is PATH, this should be a path to a field that's relative to the request, using FieldPath notation (net/proto2/util/public/field_path.h). Examples: authenticated_user.gaia_id resource.address[2].country
"locationType": "A String",
},
],
"requestId": "A String", # Request identifier generated by the service, which can be used to identify the error in the logs
},
"etag": "A String", # The Etag of this resource.
"id": "A String", # The ID that YouTube uses to uniquely identify the group.
"kind": "A String", # Identifies the API resource's type. The value will be `youtube#group`.
"snippet": { # A group snippet. # The `snippet` object contains basic information about the group, including its creation date and name.
"publishedAt": "A String", # The date and time that the group was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"title": "A String", # The group name. The value must be a non-empty string.
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(id=None, mine=None, onBehalfOfContentOwner=None, pageToken=None, x__xgafv=None)</code>
<pre>Returns a collection of groups that match the API request parameters. For example, you can retrieve all groups that the authenticated user owns, or you can retrieve one or more groups by their unique IDs.
Args:
id: string, The `id` parameter specifies a comma-separated list of the YouTube group ID(s) for the resource(s) that are being retrieved. Each group must be owned by the authenticated user. In a `group` resource, the `id` property specifies the group's YouTube group ID. Note that if you do not specify a value for the `id` parameter, then you must set the `mine` parameter to `true`.
mine: boolean, This parameter can only be used in a properly authorized request. Set this parameter's value to true to retrieve all groups owned by the authenticated user.
onBehalfOfContentOwner: string, This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner.
pageToken: string, The `pageToken` parameter identifies a specific page in the result set that should be returned. In an API response, the `nextPageToken` property identifies the next page that can be retrieved.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for GroupsService.ListGroups.
"errors": { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details
"code": "A String", # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead.
"error": [ # Specific error description and codes
{ # Describes one specific error.
"argument": [ # Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments.
"A String",
],
"code": "A String", # Error code in the error domain. This should correspond to a value of the enum type whose name is in domain. See the core error domain in error_domain.proto.
"debugInfo": "A String", # Debugging information, which should not be shared externally.
"domain": "A String", # Error domain. RoSy services can define their own domain and error codes. This should normally be the name of an enum type, such as: gdata.CoreErrorDomain
"externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google. Please set domain, code and arguments whenever possible instead of this error message so that external APIs can build safe error messages themselves. External messages built in a RoSy interface will most likely refer to information and concepts that are not available externally and should not be exposed. It is safer if external APIs can understand the errors and decide what the error message should look like.
"location": "A String", # Location of the error, as specified by the location type. If location_type is PATH, this should be a path to a field that's relative to the request, using FieldPath notation (net/proto2/util/public/field_path.h). Examples: authenticated_user.gaia_id resource.address[2].country
"locationType": "A String",
},
],
"requestId": "A String", # Request identifier generated by the service, which can be used to identify the error in the logs
},
"etag": "A String", # The Etag of this resource.
"items": [ # A list of groups that match the API request parameters. Each item in the list represents a `group` resource.
{ # A group.
"contentDetails": { # A group's content details. # The `contentDetails` object contains additional information about the group, such as the number and type of items that it contains.
"itemCount": "A String", # The number of items in the group.
"itemType": "A String", # The type of resources that the group contains. Valid values for this property are: * `youtube#channel` * `youtube#playlist` * `youtube#video` * `youtubePartner#asset`
},
"errors": { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details
"code": "A String", # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead.
"error": [ # Specific error description and codes
{ # Describes one specific error.
"argument": [ # Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments.
"A String",
],
"code": "A String", # Error code in the error domain. This should correspond to a value of the enum type whose name is in domain. See the core error domain in error_domain.proto.
"debugInfo": "A String", # Debugging information, which should not be shared externally.
"domain": "A String", # Error domain. RoSy services can define their own domain and error codes. This should normally be the name of an enum type, such as: gdata.CoreErrorDomain
"externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google. Please set domain, code and arguments whenever possible instead of this error message so that external APIs can build safe error messages themselves. External messages built in a RoSy interface will most likely refer to information and concepts that are not available externally and should not be exposed. It is safer if external APIs can understand the errors and decide what the error message should look like.
"location": "A String", # Location of the error, as specified by the location type. If location_type is PATH, this should be a path to a field that's relative to the request, using FieldPath notation (net/proto2/util/public/field_path.h). Examples: authenticated_user.gaia_id resource.address[2].country
"locationType": "A String",
},
],
"requestId": "A String", # Request identifier generated by the service, which can be used to identify the error in the logs
},
"etag": "A String", # The Etag of this resource.
"id": "A String", # The ID that YouTube uses to uniquely identify the group.
"kind": "A String", # Identifies the API resource's type. The value will be `youtube#group`.
"snippet": { # A group snippet. # The `snippet` object contains basic information about the group, including its creation date and name.
"publishedAt": "A String", # The date and time that the group was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"title": "A String", # The group name. The value must be a non-empty string.
},
},
],
"kind": "A String", # Identifies the API resource's type. The value will be `youtube#groupListResponse`.
"nextPageToken": "A String", # The token that can be used as the value of the `pageToken` parameter to retrieve the next page in the result set.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</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>
<div class="method">
<code class="details" id="update">update(body=None, onBehalfOfContentOwner=None, x__xgafv=None)</code>
<pre>Modifies a group. For example, you could change a group's title.
Args:
body: object, The request body.
The object takes the form of:
{ # A group.
"contentDetails": { # A group's content details. # The `contentDetails` object contains additional information about the group, such as the number and type of items that it contains.
"itemCount": "A String", # The number of items in the group.
"itemType": "A String", # The type of resources that the group contains. Valid values for this property are: * `youtube#channel` * `youtube#playlist` * `youtube#video` * `youtubePartner#asset`
},
"errors": { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details
"code": "A String", # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead.
"error": [ # Specific error description and codes
{ # Describes one specific error.
"argument": [ # Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments.
"A String",
],
"code": "A String", # Error code in the error domain. This should correspond to a value of the enum type whose name is in domain. See the core error domain in error_domain.proto.
"debugInfo": "A String", # Debugging information, which should not be shared externally.
"domain": "A String", # Error domain. RoSy services can define their own domain and error codes. This should normally be the name of an enum type, such as: gdata.CoreErrorDomain
"externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google. Please set domain, code and arguments whenever possible instead of this error message so that external APIs can build safe error messages themselves. External messages built in a RoSy interface will most likely refer to information and concepts that are not available externally and should not be exposed. It is safer if external APIs can understand the errors and decide what the error message should look like.
"location": "A String", # Location of the error, as specified by the location type. If location_type is PATH, this should be a path to a field that's relative to the request, using FieldPath notation (net/proto2/util/public/field_path.h). Examples: authenticated_user.gaia_id resource.address[2].country
"locationType": "A String",
},
],
"requestId": "A String", # Request identifier generated by the service, which can be used to identify the error in the logs
},
"etag": "A String", # The Etag of this resource.
"id": "A String", # The ID that YouTube uses to uniquely identify the group.
"kind": "A String", # Identifies the API resource's type. The value will be `youtube#group`.
"snippet": { # A group snippet. # The `snippet` object contains basic information about the group, including its creation date and name.
"publishedAt": "A String", # The date and time that the group was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"title": "A String", # The group name. The value must be a non-empty string.
},
}
onBehalfOfContentOwner: string, This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A group.
"contentDetails": { # A group's content details. # The `contentDetails` object contains additional information about the group, such as the number and type of items that it contains.
"itemCount": "A String", # The number of items in the group.
"itemType": "A String", # The type of resources that the group contains. Valid values for this property are: * `youtube#channel` * `youtube#playlist` * `youtube#video` * `youtubePartner#asset`
},
"errors": { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details
"code": "A String", # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead.
"error": [ # Specific error description and codes
{ # Describes one specific error.
"argument": [ # Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments.
"A String",
],
"code": "A String", # Error code in the error domain. This should correspond to a value of the enum type whose name is in domain. See the core error domain in error_domain.proto.
"debugInfo": "A String", # Debugging information, which should not be shared externally.
"domain": "A String", # Error domain. RoSy services can define their own domain and error codes. This should normally be the name of an enum type, such as: gdata.CoreErrorDomain
"externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google. Please set domain, code and arguments whenever possible instead of this error message so that external APIs can build safe error messages themselves. External messages built in a RoSy interface will most likely refer to information and concepts that are not available externally and should not be exposed. It is safer if external APIs can understand the errors and decide what the error message should look like.
"location": "A String", # Location of the error, as specified by the location type. If location_type is PATH, this should be a path to a field that's relative to the request, using FieldPath notation (net/proto2/util/public/field_path.h). Examples: authenticated_user.gaia_id resource.address[2].country
"locationType": "A String",
},
],
"requestId": "A String", # Request identifier generated by the service, which can be used to identify the error in the logs
},
"etag": "A String", # The Etag of this resource.
"id": "A String", # The ID that YouTube uses to uniquely identify the group.
"kind": "A String", # Identifies the API resource's type. The value will be `youtube#group`.
"snippet": { # A group snippet. # The `snippet` object contains basic information about the group, including its creation date and name.
"publishedAt": "A String", # The date and time that the group was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
"title": "A String", # The group name. The value must be a non-empty string.
},
}</pre>
</div>
</body></html>
|
