Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / youtubeAnalytics_v2.groups.html
blob: 163550407245cb195589f11f055b3765d6e948ac [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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="youtubeAnalytics_v2.html">YouTube Analytics API</a> . <a href="youtubeAnalytics_v2.groups.html">groups</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(onBehalfOfContentOwner=None, id=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Deletes a group.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]81 <code><a href="#insert">insert(body=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<p class="firstline">Creates a group.</p>
83<p class="toc_element">
84 <code><a href="#list">list(onBehalfOfContentOwner=None, mine=None, id=None, pageToken=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Returns a collection of groups that match the API request parameters. For</p>
86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]90 <code><a href="#update">update(body=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]91<p class="firstline">Modifies a group. For example, you could change a group's title.</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="delete">delete(onBehalfOfContentOwner=None, id=None, x__xgafv=None)</code>
95 <pre>Deletes a group.
96
97Args:
98 onBehalfOfContentOwner: string, This parameter can only be used in a properly authorized request. **Note:**
99This parameter is intended exclusively for YouTube content partners that
100own and manage many different YouTube channels.
101
102The `onBehalfOfContentOwner` parameter indicates that the request's
103authorization credentials identify a YouTube user who is acting on behalf
104of the content owner specified in the parameter value. It allows content
105owners to authenticate once and get access to all their video and channel
106data, without having to provide authentication credentials for each
107individual channel. The account that the user authenticates with must be
108linked to the specified YouTube content owner.
109 id: string, The `id` parameter specifies the YouTube group ID of the group that is
110being deleted.
111 x__xgafv: string, V1 error format.
112 Allowed values
113 1 - v1 error format
114 2 - v2 error format
115
116Returns:
117 An object of the form:
118
119 { # Empty response.
120 "errors": { # Request Error information. # Apiary error details
121 #
122 # The presence of an error field signals that the operation
123 # has failed.
124 "code": "A String", # Global error code. Deprecated and ignored.
125 # Set custom error codes in ErrorProto.domain and ErrorProto.code
126 # instead.
127 "requestId": "A String", # Request identifier generated by the service, which can be
128 # used to identify the error in the logs
129 "error": [ # Specific error description and codes
130 { # Describes one specific error.
131 "domain": "A String", # Error domain. RoSy services can define their own
132 # domain and error codes. This should normally be
133 # the name of an enum type, such as: gdata.CoreErrorDomain
134 "code": "A String", # Error code in the error domain. This should correspond to
135 # a value of the enum type whose name is in domain. See
136 # the core error domain in error_domain.proto.
137 "externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google.
138 #
139 # Please set domain, code and arguments whenever possible instead of this
140 # error message so that external APIs can build safe error messages
141 # themselves.
142 #
143 # External messages built in a RoSy interface will most likely refer to
144 # information and concepts that are not available externally and should not
145 # be exposed. It is safer if external APIs can understand the errors and
146 # decide what the error message should look like.
147 "debugInfo": "A String", # Debugging information, which should not be
148 # shared externally.
149 "locationType": "A String",
150 "argument": [ # Error arguments, to be used when building user-friendly error messages
151 # given the error domain and code. Different error codes require different
152 # arguments.
153 "A String",
154 ],
155 "location": "A String", # Location of the error, as specified by the location type.
156 #
157 # If location_type is PATH, this should be a path to a field that's
158 # relative to the request, using FieldPath notation
159 # (net/proto2/util/public/field_path.h).
160 #
161 # Examples:
162 # authenticated_user.gaia_id
163 # resource.address[2].country
164 },
165 ],
166 },
167 }</pre>
168</div>
169
170<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]171 <code class="details" id="insert">insert(body=None, onBehalfOfContentOwner=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]172 <pre>Creates a group.
173
174Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]175 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]176 The object takes the form of:
177
178{ # A group.
179 "kind": "A String", # Identifies the API resource's type. The value will be `youtube#group`.
180 "errors": { # Request Error information. # Apiary error details
181 #
182 # The presence of an error field signals that the operation
183 # has failed.
184 "code": "A String", # Global error code. Deprecated and ignored.
185 # Set custom error codes in ErrorProto.domain and ErrorProto.code
186 # instead.
187 "requestId": "A String", # Request identifier generated by the service, which can be
188 # used to identify the error in the logs
189 "error": [ # Specific error description and codes
190 { # Describes one specific error.
191 "domain": "A String", # Error domain. RoSy services can define their own
192 # domain and error codes. This should normally be
193 # the name of an enum type, such as: gdata.CoreErrorDomain
194 "code": "A String", # Error code in the error domain. This should correspond to
195 # a value of the enum type whose name is in domain. See
196 # the core error domain in error_domain.proto.
197 "externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google.
198 #
199 # Please set domain, code and arguments whenever possible instead of this
200 # error message so that external APIs can build safe error messages
201 # themselves.
202 #
203 # External messages built in a RoSy interface will most likely refer to
204 # information and concepts that are not available externally and should not
205 # be exposed. It is safer if external APIs can understand the errors and
206 # decide what the error message should look like.
207 "debugInfo": "A String", # Debugging information, which should not be
208 # shared externally.
209 "locationType": "A String",
210 "argument": [ # Error arguments, to be used when building user-friendly error messages
211 # given the error domain and code. Different error codes require different
212 # arguments.
213 "A String",
214 ],
215 "location": "A String", # Location of the error, as specified by the location type.
216 #
217 # If location_type is PATH, this should be a path to a field that's
218 # relative to the request, using FieldPath notation
219 # (net/proto2/util/public/field_path.h).
220 #
221 # Examples:
222 # authenticated_user.gaia_id
223 # resource.address[2].country
224 },
225 ],
226 },
227 "contentDetails": { # A group's content details. # The `contentDetails` object contains additional information about the
228 # group, such as the number and type of items that it contains.
229 "itemCount": "A String", # The number of items in the group.
230 "itemType": "A String", # The type of resources that the group contains.
231 #
232 # Valid values for this property are:
233 # * `youtube#channel`
234 # * `youtube#playlist`
235 # * `youtube#video`
236 # * `youtubePartner#asset`
237 },
238 "snippet": { # A group snippet. # The `snippet` object contains basic information about the group, including
239 # its creation date and name.
240 "publishedAt": "A String", # The date and time that the group was created. The value is specified in
241 # ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
242 "title": "A String", # The group name. The value must be a non-empty string.
243 },
244 "etag": "A String", # The Etag of this resource.
245 "id": "A String", # The ID that YouTube uses to uniquely identify the group.
246 }
247
248 onBehalfOfContentOwner: string, This parameter can only be used in a properly authorized request. **Note:**
249This parameter is intended exclusively for YouTube content partners that
250own and manage many different YouTube channels.
251
252The `onBehalfOfContentOwner` parameter indicates that the request's
253authorization credentials identify a YouTube user who is acting on behalf
254of the content owner specified in the parameter value. It allows content
255owners to authenticate once and get access to all their video and channel
256data, without having to provide authentication credentials for each
257individual channel. The account that the user authenticates with must be
258linked to the specified YouTube content owner.
259 x__xgafv: string, V1 error format.
260 Allowed values
261 1 - v1 error format
262 2 - v2 error format
263
264Returns:
265 An object of the form:
266
267 { # A group.
268 "kind": "A String", # Identifies the API resource's type. The value will be `youtube#group`.
269 "errors": { # Request Error information. # Apiary error details
270 #
271 # The presence of an error field signals that the operation
272 # has failed.
273 "code": "A String", # Global error code. Deprecated and ignored.
274 # Set custom error codes in ErrorProto.domain and ErrorProto.code
275 # instead.
276 "requestId": "A String", # Request identifier generated by the service, which can be
277 # used to identify the error in the logs
278 "error": [ # Specific error description and codes
279 { # Describes one specific error.
280 "domain": "A String", # Error domain. RoSy services can define their own
281 # domain and error codes. This should normally be
282 # the name of an enum type, such as: gdata.CoreErrorDomain
283 "code": "A String", # Error code in the error domain. This should correspond to
284 # a value of the enum type whose name is in domain. See
285 # the core error domain in error_domain.proto.
286 "externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google.
287 #
288 # Please set domain, code and arguments whenever possible instead of this
289 # error message so that external APIs can build safe error messages
290 # themselves.
291 #
292 # External messages built in a RoSy interface will most likely refer to
293 # information and concepts that are not available externally and should not
294 # be exposed. It is safer if external APIs can understand the errors and
295 # decide what the error message should look like.
296 "debugInfo": "A String", # Debugging information, which should not be
297 # shared externally.
298 "locationType": "A String",
299 "argument": [ # Error arguments, to be used when building user-friendly error messages
300 # given the error domain and code. Different error codes require different
301 # arguments.
302 "A String",
303 ],
304 "location": "A String", # Location of the error, as specified by the location type.
305 #
306 # If location_type is PATH, this should be a path to a field that's
307 # relative to the request, using FieldPath notation
308 # (net/proto2/util/public/field_path.h).
309 #
310 # Examples:
311 # authenticated_user.gaia_id
312 # resource.address[2].country
313 },
314 ],
315 },
316 "contentDetails": { # A group's content details. # The `contentDetails` object contains additional information about the
317 # group, such as the number and type of items that it contains.
318 "itemCount": "A String", # The number of items in the group.
319 "itemType": "A String", # The type of resources that the group contains.
320 #
321 # Valid values for this property are:
322 # * `youtube#channel`
323 # * `youtube#playlist`
324 # * `youtube#video`
325 # * `youtubePartner#asset`
326 },
327 "snippet": { # A group snippet. # The `snippet` object contains basic information about the group, including
328 # its creation date and name.
329 "publishedAt": "A String", # The date and time that the group was created. The value is specified in
330 # ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
331 "title": "A String", # The group name. The value must be a non-empty string.
332 },
333 "etag": "A String", # The Etag of this resource.
334 "id": "A String", # The ID that YouTube uses to uniquely identify the group.
335 }</pre>
336</div>
337
338<div class="method">
339 <code class="details" id="list">list(onBehalfOfContentOwner=None, mine=None, id=None, pageToken=None, x__xgafv=None)</code>
340 <pre>Returns a collection of groups that match the API request parameters. For
341example, you can retrieve all groups that the authenticated user owns,
342or you can retrieve one or more groups by their unique IDs.
343
344Args:
345 onBehalfOfContentOwner: string, This parameter can only be used in a properly authorized request. **Note:**
346This parameter is intended exclusively for YouTube content partners that
347own and manage many different YouTube channels.
348
349The `onBehalfOfContentOwner` parameter indicates that the request's
350authorization credentials identify a YouTube user who is acting on behalf
351of the content owner specified in the parameter value. It allows content
352owners to authenticate once and get access to all their video and channel
353data, without having to provide authentication credentials for each
354individual channel. The account that the user authenticates with must be
355linked to the specified YouTube content owner.
356 mine: boolean, This parameter can only be used in a properly authorized request. Set this
357parameter's value to true to retrieve all groups owned by the authenticated
358user.
359 id: string, The `id` parameter specifies a comma-separated list of the YouTube group
360ID(s) for the resource(s) that are being retrieved. Each group must be
361owned by the authenticated user. In a `group` resource, the `id` property
362specifies the group's YouTube group ID.
363
364Note that if you do not specify a value for the `id` parameter, then you
365must set the `mine` parameter to `true`.
366 pageToken: string, The `pageToken` parameter identifies a specific page in the result set that
367should be returned. In an API response, the `nextPageToken` property
368identifies the next page that can be retrieved.
369 x__xgafv: string, V1 error format.
370 Allowed values
371 1 - v1 error format
372 2 - v2 error format
373
374Returns:
375 An object of the form:
376
377 { # Response message for GroupsService.ListGroups.
378 "nextPageToken": "A String", # The token that can be used as the value of the `pageToken` parameter to
379 # retrieve the next page in the result set.
380 "items": [ # A list of groups that match the API request parameters. Each item in the
381 # list represents a `group` resource.
382 { # A group.
383 "kind": "A String", # Identifies the API resource's type. The value will be `youtube#group`.
384 "errors": { # Request Error information. # Apiary error details
385 #
386 # The presence of an error field signals that the operation
387 # has failed.
388 "code": "A String", # Global error code. Deprecated and ignored.
389 # Set custom error codes in ErrorProto.domain and ErrorProto.code
390 # instead.
391 "requestId": "A String", # Request identifier generated by the service, which can be
392 # used to identify the error in the logs
393 "error": [ # Specific error description and codes
394 { # Describes one specific error.
395 "domain": "A String", # Error domain. RoSy services can define their own
396 # domain and error codes. This should normally be
397 # the name of an enum type, such as: gdata.CoreErrorDomain
398 "code": "A String", # Error code in the error domain. This should correspond to
399 # a value of the enum type whose name is in domain. See
400 # the core error domain in error_domain.proto.
401 "externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google.
402 #
403 # Please set domain, code and arguments whenever possible instead of this
404 # error message so that external APIs can build safe error messages
405 # themselves.
406 #
407 # External messages built in a RoSy interface will most likely refer to
408 # information and concepts that are not available externally and should not
409 # be exposed. It is safer if external APIs can understand the errors and
410 # decide what the error message should look like.
411 "debugInfo": "A String", # Debugging information, which should not be
412 # shared externally.
413 "locationType": "A String",
414 "argument": [ # Error arguments, to be used when building user-friendly error messages
415 # given the error domain and code. Different error codes require different
416 # arguments.
417 "A String",
418 ],
419 "location": "A String", # Location of the error, as specified by the location type.
420 #
421 # If location_type is PATH, this should be a path to a field that's
422 # relative to the request, using FieldPath notation
423 # (net/proto2/util/public/field_path.h).
424 #
425 # Examples:
426 # authenticated_user.gaia_id
427 # resource.address[2].country
428 },
429 ],
430 },
431 "contentDetails": { # A group's content details. # The `contentDetails` object contains additional information about the
432 # group, such as the number and type of items that it contains.
433 "itemCount": "A String", # The number of items in the group.
434 "itemType": "A String", # The type of resources that the group contains.
435 #
436 # Valid values for this property are:
437 # * `youtube#channel`
438 # * `youtube#playlist`
439 # * `youtube#video`
440 # * `youtubePartner#asset`
441 },
442 "snippet": { # A group snippet. # The `snippet` object contains basic information about the group, including
443 # its creation date and name.
444 "publishedAt": "A String", # The date and time that the group was created. The value is specified in
445 # ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
446 "title": "A String", # The group name. The value must be a non-empty string.
447 },
448 "etag": "A String", # The Etag of this resource.
449 "id": "A String", # The ID that YouTube uses to uniquely identify the group.
450 },
451 ],
452 "kind": "A String", # Identifies the API resource's type. The value will be
453 # `youtube#groupListResponse`.
454 "errors": { # Request Error information. # Apiary error details
455 #
456 # The presence of an error field signals that the operation
457 # has failed.
458 "code": "A String", # Global error code. Deprecated and ignored.
459 # Set custom error codes in ErrorProto.domain and ErrorProto.code
460 # instead.
461 "requestId": "A String", # Request identifier generated by the service, which can be
462 # used to identify the error in the logs
463 "error": [ # Specific error description and codes
464 { # Describes one specific error.
465 "domain": "A String", # Error domain. RoSy services can define their own
466 # domain and error codes. This should normally be
467 # the name of an enum type, such as: gdata.CoreErrorDomain
468 "code": "A String", # Error code in the error domain. This should correspond to
469 # a value of the enum type whose name is in domain. See
470 # the core error domain in error_domain.proto.
471 "externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google.
472 #
473 # Please set domain, code and arguments whenever possible instead of this
474 # error message so that external APIs can build safe error messages
475 # themselves.
476 #
477 # External messages built in a RoSy interface will most likely refer to
478 # information and concepts that are not available externally and should not
479 # be exposed. It is safer if external APIs can understand the errors and
480 # decide what the error message should look like.
481 "debugInfo": "A String", # Debugging information, which should not be
482 # shared externally.
483 "locationType": "A String",
484 "argument": [ # Error arguments, to be used when building user-friendly error messages
485 # given the error domain and code. Different error codes require different
486 # arguments.
487 "A String",
488 ],
489 "location": "A String", # Location of the error, as specified by the location type.
490 #
491 # If location_type is PATH, this should be a path to a field that's
492 # relative to the request, using FieldPath notation
493 # (net/proto2/util/public/field_path.h).
494 #
495 # Examples:
496 # authenticated_user.gaia_id
497 # resource.address[2].country
498 },
499 ],
500 },
501 "etag": "A String", # The Etag of this resource.
502 }</pre>
503</div>
504
505<div class="method">
506 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
507 <pre>Retrieves the next page of results.
508
509Args:
510 previous_request: The request for the previous page. (required)
511 previous_response: The response from the request for the previous page. (required)
512
513Returns:
514 A request object that you can call 'execute()' on to request the next
515 page. Returns None if there are no more items in the collection.
516 </pre>
517</div>
518
519<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]520 <code class="details" id="update">update(body=None, onBehalfOfContentOwner=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]521 <pre>Modifies a group. For example, you could change a group's title.
522
523Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]524 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]525 The object takes the form of:
526
527{ # A group.
528 "kind": "A String", # Identifies the API resource's type. The value will be `youtube#group`.
529 "errors": { # Request Error information. # Apiary error details
530 #
531 # The presence of an error field signals that the operation
532 # has failed.
533 "code": "A String", # Global error code. Deprecated and ignored.
534 # Set custom error codes in ErrorProto.domain and ErrorProto.code
535 # instead.
536 "requestId": "A String", # Request identifier generated by the service, which can be
537 # used to identify the error in the logs
538 "error": [ # Specific error description and codes
539 { # Describes one specific error.
540 "domain": "A String", # Error domain. RoSy services can define their own
541 # domain and error codes. This should normally be
542 # the name of an enum type, such as: gdata.CoreErrorDomain
543 "code": "A String", # Error code in the error domain. This should correspond to
544 # a value of the enum type whose name is in domain. See
545 # the core error domain in error_domain.proto.
546 "externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google.
547 #
548 # Please set domain, code and arguments whenever possible instead of this
549 # error message so that external APIs can build safe error messages
550 # themselves.
551 #
552 # External messages built in a RoSy interface will most likely refer to
553 # information and concepts that are not available externally and should not
554 # be exposed. It is safer if external APIs can understand the errors and
555 # decide what the error message should look like.
556 "debugInfo": "A String", # Debugging information, which should not be
557 # shared externally.
558 "locationType": "A String",
559 "argument": [ # Error arguments, to be used when building user-friendly error messages
560 # given the error domain and code. Different error codes require different
561 # arguments.
562 "A String",
563 ],
564 "location": "A String", # Location of the error, as specified by the location type.
565 #
566 # If location_type is PATH, this should be a path to a field that's
567 # relative to the request, using FieldPath notation
568 # (net/proto2/util/public/field_path.h).
569 #
570 # Examples:
571 # authenticated_user.gaia_id
572 # resource.address[2].country
573 },
574 ],
575 },
576 "contentDetails": { # A group's content details. # The `contentDetails` object contains additional information about the
577 # group, such as the number and type of items that it contains.
578 "itemCount": "A String", # The number of items in the group.
579 "itemType": "A String", # The type of resources that the group contains.
580 #
581 # Valid values for this property are:
582 # * `youtube#channel`
583 # * `youtube#playlist`
584 # * `youtube#video`
585 # * `youtubePartner#asset`
586 },
587 "snippet": { # A group snippet. # The `snippet` object contains basic information about the group, including
588 # its creation date and name.
589 "publishedAt": "A String", # The date and time that the group was created. The value is specified in
590 # ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
591 "title": "A String", # The group name. The value must be a non-empty string.
592 },
593 "etag": "A String", # The Etag of this resource.
594 "id": "A String", # The ID that YouTube uses to uniquely identify the group.
595 }
596
597 onBehalfOfContentOwner: string, This parameter can only be used in a properly authorized request. **Note:**
598This parameter is intended exclusively for YouTube content partners that
599own and manage many different YouTube channels.
600
601The `onBehalfOfContentOwner` parameter indicates that the request's
602authorization credentials identify a YouTube user who is acting on behalf
603of the content owner specified in the parameter value. It allows content
604owners to authenticate once and get access to all their video and channel
605data, without having to provide authentication credentials for each
606individual channel. The account that the user authenticates with must be
607linked to the specified YouTube content owner.
608 x__xgafv: string, V1 error format.
609 Allowed values
610 1 - v1 error format
611 2 - v2 error format
612
613Returns:
614 An object of the form:
615
616 { # A group.
617 "kind": "A String", # Identifies the API resource's type. The value will be `youtube#group`.
618 "errors": { # Request Error information. # Apiary error details
619 #
620 # The presence of an error field signals that the operation
621 # has failed.
622 "code": "A String", # Global error code. Deprecated and ignored.
623 # Set custom error codes in ErrorProto.domain and ErrorProto.code
624 # instead.
625 "requestId": "A String", # Request identifier generated by the service, which can be
626 # used to identify the error in the logs
627 "error": [ # Specific error description and codes
628 { # Describes one specific error.
629 "domain": "A String", # Error domain. RoSy services can define their own
630 # domain and error codes. This should normally be
631 # the name of an enum type, such as: gdata.CoreErrorDomain
632 "code": "A String", # Error code in the error domain. This should correspond to
633 # a value of the enum type whose name is in domain. See
634 # the core error domain in error_domain.proto.
635 "externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google.
636 #
637 # Please set domain, code and arguments whenever possible instead of this
638 # error message so that external APIs can build safe error messages
639 # themselves.
640 #
641 # External messages built in a RoSy interface will most likely refer to
642 # information and concepts that are not available externally and should not
643 # be exposed. It is safer if external APIs can understand the errors and
644 # decide what the error message should look like.
645 "debugInfo": "A String", # Debugging information, which should not be
646 # shared externally.
647 "locationType": "A String",
648 "argument": [ # Error arguments, to be used when building user-friendly error messages
649 # given the error domain and code. Different error codes require different
650 # arguments.
651 "A String",
652 ],
653 "location": "A String", # Location of the error, as specified by the location type.
654 #
655 # If location_type is PATH, this should be a path to a field that's
656 # relative to the request, using FieldPath notation
657 # (net/proto2/util/public/field_path.h).
658 #
659 # Examples:
660 # authenticated_user.gaia_id
661 # resource.address[2].country
662 },
663 ],
664 },
665 "contentDetails": { # A group's content details. # The `contentDetails` object contains additional information about the
666 # group, such as the number and type of items that it contains.
667 "itemCount": "A String", # The number of items in the group.
668 "itemType": "A String", # The type of resources that the group contains.
669 #
670 # Valid values for this property are:
671 # * `youtube#channel`
672 # * `youtube#playlist`
673 # * `youtube#video`
674 # * `youtubePartner#asset`
675 },
676 "snippet": { # A group snippet. # The `snippet` object contains basic information about the group, including
677 # its creation date and name.
678 "publishedAt": "A String", # The date and time that the group was created. The value is specified in
679 # ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
680 "title": "A String", # The group name. The value must be a non-empty string.
681 },
682 "etag": "A String", # The Etag of this resource.
683 "id": "A String", # The ID that YouTube uses to uniquely identify the group.
684 }</pre>
685</div>
686
687</body></html>