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
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
|
<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.groupItems.html">groupItems</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(onBehalfOfContentOwner=None, id=None, x__xgafv=None)</a></code></p>
<p class="firstline">Removes an item from a group.</p>
<p class="toc_element">
<code><a href="#insert">insert(body, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a group item.</p>
<p class="toc_element">
<code><a href="#list">list(onBehalfOfContentOwner=None, groupId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a collection of group items that match the API request parameters.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(onBehalfOfContentOwner=None, id=None, x__xgafv=None)</code>
<pre>Removes an item from a group.
Args:
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.
id: string, The `id` parameter specifies the YouTube group item ID of the group item
that is being deleted.
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. # Apiary error details
#
# The presence of an error field signals that the operation
# has failed.
"code": "A String", # Global error code. Deprecated and ignored.
# Set custom error codes in ErrorProto.domain and ErrorProto.code
# instead.
"requestId": "A String", # Request identifier generated by the service, which can be
# used to identify the error in the logs
"error": [ # Specific error description and codes
{ # Describes one specific error.
"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
"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.
"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.
"debugInfo": "A String", # Debugging information, which should not be
# shared externally.
"locationType": "A String",
"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",
],
"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
},
],
},
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(body, onBehalfOfContentOwner=None, x__xgafv=None)</code>
<pre>Creates a group item.
Args:
body: object, The request body. (required)
The object takes the form of:
{ # A group item.
"kind": "A String", # Identifies the API resource's type. The value will be `youtube#groupItem`.
"errors": { # Request Error information. # Apiary error details
#
# The presence of an error field signals that the operation
# has failed.
"code": "A String", # Global error code. Deprecated and ignored.
# Set custom error codes in ErrorProto.domain and ErrorProto.code
# instead.
"requestId": "A String", # Request identifier generated by the service, which can be
# used to identify the error in the logs
"error": [ # Specific error description and codes
{ # Describes one specific error.
"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
"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.
"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.
"debugInfo": "A String", # Debugging information, which should not be
# shared externally.
"locationType": "A String",
"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",
],
"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
},
],
},
"resource": { # The `resource` object contains information that identifies the item being
# added to the group.
"kind": "A String", # Identifies the type of resource being added to the group.
#
# Valid values for this property are:
# * `youtube#channel`
# * `youtube#playlist`
# * `youtube#video`
# * `youtubePartner#asset`
"id": "A String", # The channel, video, playlist, or asset ID that YouTube uses to uniquely
# identify the item that is being added to the group.
},
"groupId": "A String", # The ID that YouTube uses to uniquely identify the group that contains the
# item.
"etag": "A String", # The Etag of this resource.
"id": "A String", # The ID that YouTube uses to uniquely identify the `channel`, `video`,
# `playlist`, or `asset` resource that is included in the group. Note that
# this ID refers specifically to the inclusion of that resource in a
# particular group and is different than the channel ID, video ID,
# playlist ID, or asset ID that uniquely identifies the resource itself.
# The `resource.id` property's value specifies the unique channel, video,
# playlist, or asset ID.
}
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 item.
"kind": "A String", # Identifies the API resource's type. The value will be `youtube#groupItem`.
"errors": { # Request Error information. # Apiary error details
#
# The presence of an error field signals that the operation
# has failed.
"code": "A String", # Global error code. Deprecated and ignored.
# Set custom error codes in ErrorProto.domain and ErrorProto.code
# instead.
"requestId": "A String", # Request identifier generated by the service, which can be
# used to identify the error in the logs
"error": [ # Specific error description and codes
{ # Describes one specific error.
"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
"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.
"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.
"debugInfo": "A String", # Debugging information, which should not be
# shared externally.
"locationType": "A String",
"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",
],
"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
},
],
},
"resource": { # The `resource` object contains information that identifies the item being
# added to the group.
"kind": "A String", # Identifies the type of resource being added to the group.
#
# Valid values for this property are:
# * `youtube#channel`
# * `youtube#playlist`
# * `youtube#video`
# * `youtubePartner#asset`
"id": "A String", # The channel, video, playlist, or asset ID that YouTube uses to uniquely
# identify the item that is being added to the group.
},
"groupId": "A String", # The ID that YouTube uses to uniquely identify the group that contains the
# item.
"etag": "A String", # The Etag of this resource.
"id": "A String", # The ID that YouTube uses to uniquely identify the `channel`, `video`,
# `playlist`, or `asset` resource that is included in the group. Note that
# this ID refers specifically to the inclusion of that resource in a
# particular group and is different than the channel ID, video ID,
# playlist ID, or asset ID that uniquely identifies the resource itself.
# The `resource.id` property's value specifies the unique channel, video,
# playlist, or asset ID.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(onBehalfOfContentOwner=None, groupId=None, x__xgafv=None)</code>
<pre>Returns a collection of group items that match the API request parameters.
Args:
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.
groupId: string, The `groupId` parameter specifies the unique ID of the group for which you
want to retrieve group items.
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.ListGroupItems.
"items": [ # A list of groups that match the API request parameters. Each item in the
# list represents a `groupItem` resource.
{ # A group item.
"kind": "A String", # Identifies the API resource's type. The value will be `youtube#groupItem`.
"errors": { # Request Error information. # Apiary error details
#
# The presence of an error field signals that the operation
# has failed.
"code": "A String", # Global error code. Deprecated and ignored.
# Set custom error codes in ErrorProto.domain and ErrorProto.code
# instead.
"requestId": "A String", # Request identifier generated by the service, which can be
# used to identify the error in the logs
"error": [ # Specific error description and codes
{ # Describes one specific error.
"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
"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.
"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.
"debugInfo": "A String", # Debugging information, which should not be
# shared externally.
"locationType": "A String",
"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",
],
"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
},
],
},
"resource": { # The `resource` object contains information that identifies the item being
# added to the group.
"kind": "A String", # Identifies the type of resource being added to the group.
#
# Valid values for this property are:
# * `youtube#channel`
# * `youtube#playlist`
# * `youtube#video`
# * `youtubePartner#asset`
"id": "A String", # The channel, video, playlist, or asset ID that YouTube uses to uniquely
# identify the item that is being added to the group.
},
"groupId": "A String", # The ID that YouTube uses to uniquely identify the group that contains the
# item.
"etag": "A String", # The Etag of this resource.
"id": "A String", # The ID that YouTube uses to uniquely identify the `channel`, `video`,
# `playlist`, or `asset` resource that is included in the group. Note that
# this ID refers specifically to the inclusion of that resource in a
# particular group and is different than the channel ID, video ID,
# playlist ID, or asset ID that uniquely identifies the resource itself.
# The `resource.id` property's value specifies the unique channel, video,
# playlist, or asset ID.
},
],
"kind": "A String", # Identifies the API resource's type. The value will be
# `youtube#groupItemListResponse`.
"etag": "A String", # The Etag of this resource.
"errors": { # Request Error information. # Apiary error details
#
# The presence of an error field signals that the operation
# has failed.
"code": "A String", # Global error code. Deprecated and ignored.
# Set custom error codes in ErrorProto.domain and ErrorProto.code
# instead.
"requestId": "A String", # Request identifier generated by the service, which can be
# used to identify the error in the logs
"error": [ # Specific error description and codes
{ # Describes one specific error.
"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
"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.
"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.
"debugInfo": "A String", # Debugging information, which should not be
# shared externally.
"locationType": "A String",
"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",
],
"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
},
],
},
}</pre>
</div>
</body></html>
|
