blob: 5da613e191618a4b97d5e94018db361981565ad7 [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.groupItems.html">groupItems</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 Botb6971b02020-11-26 17:16:03 -080081 <code><a href="#delete">delete(onBehalfOfContentOwner=None, id=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070082<p class="firstline">Removes an item from 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 item.</p>
86<p class="toc_element">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -080087 <code><a href="#list">list(onBehalfOfContentOwner=None, groupId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070088<p class="firstline">Returns a collection of group items that match the API request parameters.</p>
89<h3>Method Details</h3>
90<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070091 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93</div>
94
95<div class="method">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -080096 <code class="details" id="delete">delete(onBehalfOfContentOwner=None, id=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070097 <pre>Removes an item from a group.
98
99Args:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700100 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 -0800101 id: string, The `id` parameter specifies the YouTube group item ID of the group item that is being deleted.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700102 x__xgafv: string, V1 error format.
103 Allowed values
104 1 - v1 error format
105 2 - v2 error format
106
107Returns:
108 An object of the form:
109
110 { # Empty response.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700111 &quot;errors&quot;: { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800112 &quot;requestId&quot;: &quot;A String&quot;, # Request identifier generated by the service, which can be used to identify the error in the logs
Bu Sun Kim65020912020-05-20 12:08:20 -0700113 &quot;error&quot;: [ # Specific error description and codes
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700114 { # Describes one specific error.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800115 &quot;locationType&quot;: &quot;A String&quot;,
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800116 &quot;debugInfo&quot;: &quot;A String&quot;, # Debugging information, which should not be shared externally.
117 &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.
118 &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
119 &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
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700120 &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.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700121 &quot;A String&quot;,
122 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800123 &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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700124 },
125 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800126 &quot;code&quot;: &quot;A String&quot;, # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700127 },
128 }</pre>
129</div>
130
131<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700132 <code class="details" id="insert">insert(body=None, onBehalfOfContentOwner=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700133 <pre>Creates a group item.
134
135Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700136 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700137 The object takes the form of:
138
139{ # A group item.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800140 &quot;groupId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the group that contains the item.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800141 &quot;resource&quot;: { # The `resource` object contains information that identifies the item being added to the group.
142 &quot;kind&quot;: &quot;A String&quot;, # Identifies the type of resource being added to the group. Valid values for this property are: * `youtube#channel` * `youtube#playlist` * `youtube#video` * `youtubePartner#asset`
143 &quot;id&quot;: &quot;A String&quot;, # The channel, video, playlist, or asset ID that YouTube uses to uniquely identify the item that is being added to the group.
144 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800145 &quot;etag&quot;: &quot;A String&quot;, # The Etag of this resource.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800146 &quot;errors&quot;: { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details
147 &quot;requestId&quot;: &quot;A String&quot;, # Request identifier generated by the service, which can be used to identify the error in the logs
148 &quot;error&quot;: [ # Specific error description and codes
149 { # Describes one specific error.
150 &quot;locationType&quot;: &quot;A String&quot;,
151 &quot;debugInfo&quot;: &quot;A String&quot;, # Debugging information, which should not be shared externally.
152 &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.
153 &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
154 &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
155 &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.
156 &quot;A String&quot;,
157 ],
158 &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.
159 },
160 ],
161 &quot;code&quot;: &quot;A String&quot;, # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead.
162 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800163 &quot;kind&quot;: &quot;A String&quot;, # Identifies the API resource&#x27;s type. The value will be `youtube#groupItem`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800164 &quot;id&quot;: &quot;A String&quot;, # 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&#x27;s value specifies the unique channel, video, playlist, or asset ID.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800165 }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700166
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700167 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 -0700168 x__xgafv: string, V1 error format.
169 Allowed values
170 1 - v1 error format
171 2 - v2 error format
172
173Returns:
174 An object of the form:
175
176 { # A group item.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800177 &quot;groupId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the group that contains the item.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800178 &quot;resource&quot;: { # The `resource` object contains information that identifies the item being added to the group.
179 &quot;kind&quot;: &quot;A String&quot;, # Identifies the type of resource being added to the group. Valid values for this property are: * `youtube#channel` * `youtube#playlist` * `youtube#video` * `youtubePartner#asset`
180 &quot;id&quot;: &quot;A String&quot;, # The channel, video, playlist, or asset ID that YouTube uses to uniquely identify the item that is being added to the group.
181 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800182 &quot;etag&quot;: &quot;A String&quot;, # The Etag of this resource.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800183 &quot;errors&quot;: { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details
184 &quot;requestId&quot;: &quot;A String&quot;, # Request identifier generated by the service, which can be used to identify the error in the logs
185 &quot;error&quot;: [ # Specific error description and codes
186 { # Describes one specific error.
187 &quot;locationType&quot;: &quot;A String&quot;,
188 &quot;debugInfo&quot;: &quot;A String&quot;, # Debugging information, which should not be shared externally.
189 &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.
190 &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
191 &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
192 &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.
193 &quot;A String&quot;,
194 ],
195 &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.
196 },
197 ],
198 &quot;code&quot;: &quot;A String&quot;, # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead.
199 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800200 &quot;kind&quot;: &quot;A String&quot;, # Identifies the API resource&#x27;s type. The value will be `youtube#groupItem`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800201 &quot;id&quot;: &quot;A String&quot;, # 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&#x27;s value specifies the unique channel, video, playlist, or asset ID.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800202 }</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700203</div>
204
205<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800206 <code class="details" id="list">list(onBehalfOfContentOwner=None, groupId=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700207 <pre>Returns a collection of group items that match the API request parameters.
208
209Args:
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800210 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 Bot0bf565c2020-12-09 08:56:03 -0800211 groupId: string, The `groupId` parameter specifies the unique ID of the group for which you want to retrieve group items.
Bu Sun Kim65020912020-05-20 12:08:20 -0700212 x__xgafv: string, V1 error format.
213 Allowed values
214 1 - v1 error format
215 2 - v2 error format
216
217Returns:
218 An object of the form:
219
220 { # Response message for GroupsService.ListGroupItems.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800221 &quot;errors&quot;: { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details
222 &quot;requestId&quot;: &quot;A String&quot;, # Request identifier generated by the service, which can be used to identify the error in the logs
223 &quot;error&quot;: [ # Specific error description and codes
224 { # Describes one specific error.
225 &quot;locationType&quot;: &quot;A String&quot;,
226 &quot;debugInfo&quot;: &quot;A String&quot;, # Debugging information, which should not be shared externally.
227 &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.
228 &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
229 &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
230 &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.
231 &quot;A String&quot;,
232 ],
233 &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.
234 },
235 ],
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 },
238 &quot;etag&quot;: &quot;A String&quot;, # The Etag of this resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800239 &quot;items&quot;: [ # A list of groups that match the API request parameters. Each item in the list represents a `groupItem` resource.
240 { # A group item.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800241 &quot;groupId&quot;: &quot;A String&quot;, # The ID that YouTube uses to uniquely identify the group that contains the item.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800242 &quot;resource&quot;: { # The `resource` object contains information that identifies the item being added to the group.
243 &quot;kind&quot;: &quot;A String&quot;, # Identifies the type of resource being added to the group. Valid values for this property are: * `youtube#channel` * `youtube#playlist` * `youtube#video` * `youtubePartner#asset`
244 &quot;id&quot;: &quot;A String&quot;, # The channel, video, playlist, or asset ID that YouTube uses to uniquely identify the item that is being added to the group.
245 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800246 &quot;etag&quot;: &quot;A String&quot;, # The Etag of this resource.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800247 &quot;errors&quot;: { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details
248 &quot;requestId&quot;: &quot;A String&quot;, # Request identifier generated by the service, which can be used to identify the error in the logs
249 &quot;error&quot;: [ # Specific error description and codes
250 { # Describes one specific error.
251 &quot;locationType&quot;: &quot;A String&quot;,
252 &quot;debugInfo&quot;: &quot;A String&quot;, # Debugging information, which should not be shared externally.
253 &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.
254 &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
255 &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
256 &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.
257 &quot;A String&quot;,
258 ],
259 &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.
260 },
261 ],
262 &quot;code&quot;: &quot;A String&quot;, # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead.
263 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800264 &quot;kind&quot;: &quot;A String&quot;, # Identifies the API resource&#x27;s type. The value will be `youtube#groupItem`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800265 &quot;id&quot;: &quot;A String&quot;, # 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&#x27;s value specifies the unique channel, video, playlist, or asset ID.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800266 },
267 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700268 &quot;kind&quot;: &quot;A String&quot;, # Identifies the API resource&#x27;s type. The value will be `youtube#groupItemListResponse`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700269 }</pre>
270</div>
271
272</body></html>