blob: 351d3d1fb049e267eafcfc07662c6362c0e9f589 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -080081 <code><a href="#delete">delete(id=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070082<p class="firstline">Deletes a group.</p>
83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070084 <code><a href="#insert">insert(body=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070085<p class="firstline">Creates a group.</p>
86<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080087 <code><a href="#list">list(id=None, mine=None, onBehalfOfContentOwner=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070088<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>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070089<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070093 <code><a href="#update">update(body=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070094<p class="firstline">Modifies a group. For example, you could change a group's title.</p>
95<h3>Method Details</h3>
96<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070097 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99</div>
100
101<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800102 <code class="details" id="delete">delete(id=None, onBehalfOfContentOwner=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700103 <pre>Deletes a group.
104
105Args:
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800106 id: string, The `id` parameter specifies the YouTube group ID of the group that is being deleted.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800107 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&#x27;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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700108 x__xgafv: string, V1 error format.
109 Allowed values
110 1 - v1 error format
111 2 - v2 error format
112
113Returns:
114 An object of the form:
115
116 { # Empty response.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800117 &quot;errors&quot;: { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details
118 &quot;code&quot;: &quot;A String&quot;, # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead.
119 &quot;error&quot;: [ # Specific error description and codes
120 { # Describes one specific error.
121 &quot;argument&quot;: [ # Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments.
122 &quot;A String&quot;,
123 ],
124 &quot;code&quot;: &quot;A String&quot;, # 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.
125 &quot;debugInfo&quot;: &quot;A String&quot;, # Debugging information, which should not be shared externally.
126 &quot;domain&quot;: &quot;A String&quot;, # 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
127 &quot;externalErrorMessage&quot;: &quot;A String&quot;, # 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.
128 &quot;location&quot;: &quot;A String&quot;, # Location of the error, as specified by the location type. If location_type is PATH, this should be a path to a field that&#x27;s relative to the request, using FieldPath notation (net/proto2/util/public/field_path.h). Examples: authenticated_user.gaia_id resource.address[2].country
129 &quot;locationType&quot;: &quot;A String&quot;,
130 },
131 ],
132 &quot;requestId&quot;: &quot;A String&quot;, # Request identifier generated by the service, which can be used to identify the error in the logs
133 },
134}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700135</div>
136
137<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700138 <code class="details" id="insert">insert(body=None, onBehalfOfContentOwner=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700139 <pre>Creates a group.
140
141Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700142 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700143 The object takes the form of:
144
145{ # A group.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800146 &quot;contentDetails&quot;: { # A group&#x27;s content details. # The `contentDetails` object contains additional information about the group, such as the number and type of items that it contains.
147 &quot;itemCount&quot;: &quot;A String&quot;, # The number of items in the group.
148 &quot;itemType&quot;: &quot;A String&quot;, # The type of resources that the group contains. Valid values for this property are: * `youtube#channel` * `youtube#playlist` * `youtube#video` * `youtubePartner#asset`
149 },
150 &quot;errors&quot;: { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details
151 &quot;code&quot;: &quot;A String&quot;, # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead.
152 &quot;error&quot;: [ # Specific error description and codes
153 { # Describes one specific error.
154 &quot;argument&quot;: [ # Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments.
155 &quot;A String&quot;,
156 ],
157 &quot;code&quot;: &quot;A String&quot;, # 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.
158 &quot;debugInfo&quot;: &quot;A String&quot;, # Debugging information, which should not be shared externally.
159 &quot;domain&quot;: &quot;A String&quot;, # 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
160 &quot;externalErrorMessage&quot;: &quot;A String&quot;, # 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.
161 &quot;location&quot;: &quot;A String&quot;, # Location of the error, as specified by the location type. If location_type is PATH, this should be a path to a field that&#x27;s relative to the request, using FieldPath notation (net/proto2/util/public/field_path.h). Examples: authenticated_user.gaia_id resource.address[2].country
162 &quot;locationType&quot;: &quot;A String&quot;,
163 },
164 ],
165 &quot;requestId&quot;: &quot;A String&quot;, # Request identifier generated by the service, which can be used to identify the error in the logs
166 },
167 &quot;etag&quot;: &quot;A String&quot;, # The Etag of this resource.
168 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the group.
169 &quot;kind&quot;: &quot;A String&quot;, # Identifies the API resource&#x27;s type. The value will be `youtube#group`.
170 &quot;snippet&quot;: { # A group snippet. # The `snippet` object contains basic information about the group, including its creation date and name.
171 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time that the group was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
172 &quot;title&quot;: &quot;A String&quot;, # The group name. The value must be a non-empty string.
173 },
174}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700175
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700176 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&#x27;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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700177 x__xgafv: string, V1 error format.
178 Allowed values
179 1 - v1 error format
180 2 - v2 error format
181
182Returns:
183 An object of the form:
184
185 { # A group.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800186 &quot;contentDetails&quot;: { # A group&#x27;s content details. # The `contentDetails` object contains additional information about the group, such as the number and type of items that it contains.
187 &quot;itemCount&quot;: &quot;A String&quot;, # The number of items in the group.
188 &quot;itemType&quot;: &quot;A String&quot;, # The type of resources that the group contains. Valid values for this property are: * `youtube#channel` * `youtube#playlist` * `youtube#video` * `youtubePartner#asset`
189 },
190 &quot;errors&quot;: { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details
191 &quot;code&quot;: &quot;A String&quot;, # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead.
192 &quot;error&quot;: [ # Specific error description and codes
193 { # Describes one specific error.
194 &quot;argument&quot;: [ # Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments.
195 &quot;A String&quot;,
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800196 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800197 &quot;code&quot;: &quot;A String&quot;, # 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.
198 &quot;debugInfo&quot;: &quot;A String&quot;, # Debugging information, which should not be shared externally.
199 &quot;domain&quot;: &quot;A String&quot;, # 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
200 &quot;externalErrorMessage&quot;: &quot;A String&quot;, # 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.
201 &quot;location&quot;: &quot;A String&quot;, # Location of the error, as specified by the location type. If location_type is PATH, this should be a path to a field that&#x27;s relative to the request, using FieldPath notation (net/proto2/util/public/field_path.h). Examples: authenticated_user.gaia_id resource.address[2].country
202 &quot;locationType&quot;: &quot;A String&quot;,
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700203 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800204 ],
205 &quot;requestId&quot;: &quot;A String&quot;, # Request identifier generated by the service, which can be used to identify the error in the logs
206 },
207 &quot;etag&quot;: &quot;A String&quot;, # The Etag of this resource.
208 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the group.
209 &quot;kind&quot;: &quot;A String&quot;, # Identifies the API resource&#x27;s type. The value will be `youtube#group`.
210 &quot;snippet&quot;: { # A group snippet. # The `snippet` object contains basic information about the group, including its creation date and name.
211 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time that the group was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
212 &quot;title&quot;: &quot;A String&quot;, # The group name. The value must be a non-empty string.
213 },
214}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700215</div>
216
217<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800218 <code class="details" id="list">list(id=None, mine=None, onBehalfOfContentOwner=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700219 <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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700220
221Args:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700222 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&#x27;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`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800223 mine: boolean, This parameter can only be used in a properly authorized request. Set this parameter&#x27;s value to true to retrieve all groups owned by the authenticated user.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800224 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&#x27;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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800225 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700226 x__xgafv: string, V1 error format.
227 Allowed values
228 1 - v1 error format
229 2 - v2 error format
230
231Returns:
232 An object of the form:
233
234 { # Response message for GroupsService.ListGroups.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800235 &quot;errors&quot;: { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details
236 &quot;code&quot;: &quot;A String&quot;, # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead.
237 &quot;error&quot;: [ # Specific error description and codes
238 { # Describes one specific error.
239 &quot;argument&quot;: [ # Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments.
240 &quot;A String&quot;,
241 ],
242 &quot;code&quot;: &quot;A String&quot;, # 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.
243 &quot;debugInfo&quot;: &quot;A String&quot;, # Debugging information, which should not be shared externally.
244 &quot;domain&quot;: &quot;A String&quot;, # 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
245 &quot;externalErrorMessage&quot;: &quot;A String&quot;, # 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.
246 &quot;location&quot;: &quot;A String&quot;, # Location of the error, as specified by the location type. If location_type is PATH, this should be a path to a field that&#x27;s relative to the request, using FieldPath notation (net/proto2/util/public/field_path.h). Examples: authenticated_user.gaia_id resource.address[2].country
247 &quot;locationType&quot;: &quot;A String&quot;,
248 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700249 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800250 &quot;requestId&quot;: &quot;A String&quot;, # Request identifier generated by the service, which can be used to identify the error in the logs
251 },
252 &quot;etag&quot;: &quot;A String&quot;, # The Etag of this resource.
253 &quot;items&quot;: [ # A list of groups that match the API request parameters. Each item in the list represents a `group` resource.
254 { # A group.
255 &quot;contentDetails&quot;: { # A group&#x27;s content details. # The `contentDetails` object contains additional information about the group, such as the number and type of items that it contains.
256 &quot;itemCount&quot;: &quot;A String&quot;, # The number of items in the group.
257 &quot;itemType&quot;: &quot;A String&quot;, # The type of resources that the group contains. Valid values for this property are: * `youtube#channel` * `youtube#playlist` * `youtube#video` * `youtubePartner#asset`
258 },
259 &quot;errors&quot;: { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details
260 &quot;code&quot;: &quot;A String&quot;, # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead.
261 &quot;error&quot;: [ # Specific error description and codes
262 { # Describes one specific error.
263 &quot;argument&quot;: [ # Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments.
264 &quot;A String&quot;,
265 ],
266 &quot;code&quot;: &quot;A String&quot;, # 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.
267 &quot;debugInfo&quot;: &quot;A String&quot;, # Debugging information, which should not be shared externally.
268 &quot;domain&quot;: &quot;A String&quot;, # 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
269 &quot;externalErrorMessage&quot;: &quot;A String&quot;, # 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.
270 &quot;location&quot;: &quot;A String&quot;, # Location of the error, as specified by the location type. If location_type is PATH, this should be a path to a field that&#x27;s relative to the request, using FieldPath notation (net/proto2/util/public/field_path.h). Examples: authenticated_user.gaia_id resource.address[2].country
271 &quot;locationType&quot;: &quot;A String&quot;,
272 },
273 ],
274 &quot;requestId&quot;: &quot;A String&quot;, # Request identifier generated by the service, which can be used to identify the error in the logs
275 },
276 &quot;etag&quot;: &quot;A String&quot;, # The Etag of this resource.
277 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the group.
278 &quot;kind&quot;: &quot;A String&quot;, # Identifies the API resource&#x27;s type. The value will be `youtube#group`.
279 &quot;snippet&quot;: { # A group snippet. # The `snippet` object contains basic information about the group, including its creation date and name.
280 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time that the group was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
281 &quot;title&quot;: &quot;A String&quot;, # The group name. The value must be a non-empty string.
282 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700283 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800284 ],
285 &quot;kind&quot;: &quot;A String&quot;, # Identifies the API resource&#x27;s type. The value will be `youtube#groupListResponse`.
286 &quot;nextPageToken&quot;: &quot;A String&quot;, # The token that can be used as the value of the `pageToken` parameter to retrieve the next page in the result set.
287}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700288</div>
289
290<div class="method">
291 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
292 <pre>Retrieves the next page of results.
293
294Args:
295 previous_request: The request for the previous page. (required)
296 previous_response: The response from the request for the previous page. (required)
297
298Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700299 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700300 page. Returns None if there are no more items in the collection.
301 </pre>
302</div>
303
304<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700305 <code class="details" id="update">update(body=None, onBehalfOfContentOwner=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700306 <pre>Modifies a group. For example, you could change a group&#x27;s title.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700307
308Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700309 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700310 The object takes the form of:
311
312{ # A group.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800313 &quot;contentDetails&quot;: { # A group&#x27;s content details. # The `contentDetails` object contains additional information about the group, such as the number and type of items that it contains.
314 &quot;itemCount&quot;: &quot;A String&quot;, # The number of items in the group.
315 &quot;itemType&quot;: &quot;A String&quot;, # The type of resources that the group contains. Valid values for this property are: * `youtube#channel` * `youtube#playlist` * `youtube#video` * `youtubePartner#asset`
316 },
317 &quot;errors&quot;: { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details
318 &quot;code&quot;: &quot;A String&quot;, # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead.
319 &quot;error&quot;: [ # Specific error description and codes
320 { # Describes one specific error.
321 &quot;argument&quot;: [ # Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments.
322 &quot;A String&quot;,
323 ],
324 &quot;code&quot;: &quot;A String&quot;, # 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.
325 &quot;debugInfo&quot;: &quot;A String&quot;, # Debugging information, which should not be shared externally.
326 &quot;domain&quot;: &quot;A String&quot;, # 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
327 &quot;externalErrorMessage&quot;: &quot;A String&quot;, # 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.
328 &quot;location&quot;: &quot;A String&quot;, # Location of the error, as specified by the location type. If location_type is PATH, this should be a path to a field that&#x27;s relative to the request, using FieldPath notation (net/proto2/util/public/field_path.h). Examples: authenticated_user.gaia_id resource.address[2].country
329 &quot;locationType&quot;: &quot;A String&quot;,
330 },
331 ],
332 &quot;requestId&quot;: &quot;A String&quot;, # Request identifier generated by the service, which can be used to identify the error in the logs
333 },
334 &quot;etag&quot;: &quot;A String&quot;, # The Etag of this resource.
335 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the group.
336 &quot;kind&quot;: &quot;A String&quot;, # Identifies the API resource&#x27;s type. The value will be `youtube#group`.
337 &quot;snippet&quot;: { # A group snippet. # The `snippet` object contains basic information about the group, including its creation date and name.
338 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time that the group was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
339 &quot;title&quot;: &quot;A String&quot;, # The group name. The value must be a non-empty string.
340 },
341}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700342
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700343 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&#x27;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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700344 x__xgafv: string, V1 error format.
345 Allowed values
346 1 - v1 error format
347 2 - v2 error format
348
349Returns:
350 An object of the form:
351
352 { # A group.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800353 &quot;contentDetails&quot;: { # A group&#x27;s content details. # The `contentDetails` object contains additional information about the group, such as the number and type of items that it contains.
354 &quot;itemCount&quot;: &quot;A String&quot;, # The number of items in the group.
355 &quot;itemType&quot;: &quot;A String&quot;, # The type of resources that the group contains. Valid values for this property are: * `youtube#channel` * `youtube#playlist` * `youtube#video` * `youtubePartner#asset`
356 },
357 &quot;errors&quot;: { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details
358 &quot;code&quot;: &quot;A String&quot;, # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead.
359 &quot;error&quot;: [ # Specific error description and codes
360 { # Describes one specific error.
361 &quot;argument&quot;: [ # Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments.
362 &quot;A String&quot;,
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800363 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800364 &quot;code&quot;: &quot;A String&quot;, # 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.
365 &quot;debugInfo&quot;: &quot;A String&quot;, # Debugging information, which should not be shared externally.
366 &quot;domain&quot;: &quot;A String&quot;, # 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
367 &quot;externalErrorMessage&quot;: &quot;A String&quot;, # 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.
368 &quot;location&quot;: &quot;A String&quot;, # Location of the error, as specified by the location type. If location_type is PATH, this should be a path to a field that&#x27;s relative to the request, using FieldPath notation (net/proto2/util/public/field_path.h). Examples: authenticated_user.gaia_id resource.address[2].country
369 &quot;locationType&quot;: &quot;A String&quot;,
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700370 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800371 ],
372 &quot;requestId&quot;: &quot;A String&quot;, # Request identifier generated by the service, which can be used to identify the error in the logs
373 },
374 &quot;etag&quot;: &quot;A String&quot;, # The Etag of this resource.
375 &quot;id&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the group.
376 &quot;kind&quot;: &quot;A String&quot;, # Identifies the API resource&#x27;s type. The value will be `youtube#group`.
377 &quot;snippet&quot;: { # A group snippet. # The `snippet` object contains basic information about the group, including its creation date and name.
378 &quot;publishedAt&quot;: &quot;A String&quot;, # The date and time that the group was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
379 &quot;title&quot;: &quot;A String&quot;, # The group name. The value must be a non-empty string.
380 },
381}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700382</div>
383
384</body></html>