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.groupItems.html">groupItems</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">Removes an item from a group.</p> 80<p class="toc_element"> 81 <code><a href="#insert">insert(body, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Creates a group item.</p> 83<p class="toc_element"> 84 <code><a href="#list">list(onBehalfOfContentOwner=None, groupId=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Returns a collection of group items that match the API request parameters.</p> 86<h3>Method Details</h3> 87<div class="method"> 88 <code class="details" id="delete">delete(onBehalfOfContentOwner=None, id=None, x__xgafv=None)</code> 89 <pre>Removes an item from a group. 90 91Args: 92 onBehalfOfContentOwner: string, This parameter can only be used in a properly authorized request. **Note:** 93This parameter is intended exclusively for YouTube content partners that 94own and manage many different YouTube channels. 95 96The `onBehalfOfContentOwner` parameter indicates that the request's 97authorization credentials identify a YouTube user who is acting on behalf 98of the content owner specified in the parameter value. It allows content 99owners to authenticate once and get access to all their video and channel 100data, without having to provide authentication credentials for each 101individual channel. The account that the user authenticates with must be 102linked to the specified YouTube content owner. 103 id: string, The `id` parameter specifies the YouTube group item ID of the group item 104that is being deleted. 105 x__xgafv: string, V1 error format. 106 Allowed values 107 1 - v1 error format 108 2 - v2 error format 109 110Returns: 111 An object of the form: 112 113 { # Empty response. 114 "errors": { # Request Error information. # Apiary error details 115 # 116 # The presence of an error field signals that the operation 117 # has failed. 118 "code": "A String", # Global error code. Deprecated and ignored. 119 # Set custom error codes in ErrorProto.domain and ErrorProto.code 120 # instead. 121 "requestId": "A String", # Request identifier generated by the service, which can be 122 # used to identify the error in the logs 123 "error": [ # Specific error description and codes 124 { # Describes one specific error. 125 "domain": "A String", # Error domain. RoSy services can define their own 126 # domain and error codes. This should normally be 127 # the name of an enum type, such as: gdata.CoreErrorDomain 128 "code": "A String", # Error code in the error domain. This should correspond to 129 # a value of the enum type whose name is in domain. See 130 # the core error domain in error_domain.proto. 131 "externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google. 132 # 133 # Please set domain, code and arguments whenever possible instead of this 134 # error message so that external APIs can build safe error messages 135 # themselves. 136 # 137 # External messages built in a RoSy interface will most likely refer to 138 # information and concepts that are not available externally and should not 139 # be exposed. It is safer if external APIs can understand the errors and 140 # decide what the error message should look like. 141 "debugInfo": "A String", # Debugging information, which should not be 142 # shared externally. 143 "locationType": "A String", 144 "argument": [ # Error arguments, to be used when building user-friendly error messages 145 # given the error domain and code. Different error codes require different 146 # arguments. 147 "A String", 148 ], 149 "location": "A String", # Location of the error, as specified by the location type. 150 # 151 # If location_type is PATH, this should be a path to a field that's 152 # relative to the request, using FieldPath notation 153 # (net/proto2/util/public/field_path.h). 154 # 155 # Examples: 156 # authenticated_user.gaia_id 157 # resource.address[2].country 158 }, 159 ], 160 }, 161 }</pre> 162</div> 163 164<div class="method"> 165 <code class="details" id="insert">insert(body, onBehalfOfContentOwner=None, x__xgafv=None)</code> 166 <pre>Creates a group item. 167 168Args: 169 body: object, The request body. (required) 170 The object takes the form of: 171 172{ # A group item. 173 "kind": "A String", # Identifies the API resource's type. The value will be `youtube#groupItem`. 174 "errors": { # Request Error information. # Apiary error details 175 # 176 # The presence of an error field signals that the operation 177 # has failed. 178 "code": "A String", # Global error code. Deprecated and ignored. 179 # Set custom error codes in ErrorProto.domain and ErrorProto.code 180 # instead. 181 "requestId": "A String", # Request identifier generated by the service, which can be 182 # used to identify the error in the logs 183 "error": [ # Specific error description and codes 184 { # Describes one specific error. 185 "domain": "A String", # Error domain. RoSy services can define their own 186 # domain and error codes. This should normally be 187 # the name of an enum type, such as: gdata.CoreErrorDomain 188 "code": "A String", # Error code in the error domain. This should correspond to 189 # a value of the enum type whose name is in domain. See 190 # the core error domain in error_domain.proto. 191 "externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google. 192 # 193 # Please set domain, code and arguments whenever possible instead of this 194 # error message so that external APIs can build safe error messages 195 # themselves. 196 # 197 # External messages built in a RoSy interface will most likely refer to 198 # information and concepts that are not available externally and should not 199 # be exposed. It is safer if external APIs can understand the errors and 200 # decide what the error message should look like. 201 "debugInfo": "A String", # Debugging information, which should not be 202 # shared externally. 203 "locationType": "A String", 204 "argument": [ # Error arguments, to be used when building user-friendly error messages 205 # given the error domain and code. Different error codes require different 206 # arguments. 207 "A String", 208 ], 209 "location": "A String", # Location of the error, as specified by the location type. 210 # 211 # If location_type is PATH, this should be a path to a field that's 212 # relative to the request, using FieldPath notation 213 # (net/proto2/util/public/field_path.h). 214 # 215 # Examples: 216 # authenticated_user.gaia_id 217 # resource.address[2].country 218 }, 219 ], 220 }, 221 "resource": { # The `resource` object contains information that identifies the item being 222 # added to the group. 223 "kind": "A String", # Identifies the type of resource being added to the group. 224 # 225 # Valid values for this property are: 226 # * `youtube#channel` 227 # * `youtube#playlist` 228 # * `youtube#video` 229 # * `youtubePartner#asset` 230 "id": "A String", # The channel, video, playlist, or asset ID that YouTube uses to uniquely 231 # identify the item that is being added to the group. 232 }, 233 "groupId": "A String", # The ID that YouTube uses to uniquely identify the group that contains the 234 # item. 235 "etag": "A String", # The Etag of this resource. 236 "id": "A String", # The ID that YouTube uses to uniquely identify the `channel`, `video`, 237 # `playlist`, or `asset` resource that is included in the group. Note that 238 # this ID refers specifically to the inclusion of that resource in a 239 # particular group and is different than the channel ID, video ID, 240 # playlist ID, or asset ID that uniquely identifies the resource itself. 241 # The `resource.id` property's value specifies the unique channel, video, 242 # playlist, or asset ID. 243 } 244 245 onBehalfOfContentOwner: string, This parameter can only be used in a properly authorized request. **Note:** 246This parameter is intended exclusively for YouTube content partners that 247own and manage many different YouTube channels. 248 249The `onBehalfOfContentOwner` parameter indicates that the request's 250authorization credentials identify a YouTube user who is acting on behalf 251of the content owner specified in the parameter value. It allows content 252owners to authenticate once and get access to all their video and channel 253data, without having to provide authentication credentials for each 254individual channel. The account that the user authenticates with must be 255linked to the specified YouTube content owner. 256 x__xgafv: string, V1 error format. 257 Allowed values 258 1 - v1 error format 259 2 - v2 error format 260 261Returns: 262 An object of the form: 263 264 { # A group item. 265 "kind": "A String", # Identifies the API resource's type. The value will be `youtube#groupItem`. 266 "errors": { # Request Error information. # Apiary error details 267 # 268 # The presence of an error field signals that the operation 269 # has failed. 270 "code": "A String", # Global error code. Deprecated and ignored. 271 # Set custom error codes in ErrorProto.domain and ErrorProto.code 272 # instead. 273 "requestId": "A String", # Request identifier generated by the service, which can be 274 # used to identify the error in the logs 275 "error": [ # Specific error description and codes 276 { # Describes one specific error. 277 "domain": "A String", # Error domain. RoSy services can define their own 278 # domain and error codes. This should normally be 279 # the name of an enum type, such as: gdata.CoreErrorDomain 280 "code": "A String", # Error code in the error domain. This should correspond to 281 # a value of the enum type whose name is in domain. See 282 # the core error domain in error_domain.proto. 283 "externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google. 284 # 285 # Please set domain, code and arguments whenever possible instead of this 286 # error message so that external APIs can build safe error messages 287 # themselves. 288 # 289 # External messages built in a RoSy interface will most likely refer to 290 # information and concepts that are not available externally and should not 291 # be exposed. It is safer if external APIs can understand the errors and 292 # decide what the error message should look like. 293 "debugInfo": "A String", # Debugging information, which should not be 294 # shared externally. 295 "locationType": "A String", 296 "argument": [ # Error arguments, to be used when building user-friendly error messages 297 # given the error domain and code. Different error codes require different 298 # arguments. 299 "A String", 300 ], 301 "location": "A String", # Location of the error, as specified by the location type. 302 # 303 # If location_type is PATH, this should be a path to a field that's 304 # relative to the request, using FieldPath notation 305 # (net/proto2/util/public/field_path.h). 306 # 307 # Examples: 308 # authenticated_user.gaia_id 309 # resource.address[2].country 310 }, 311 ], 312 }, 313 "resource": { # The `resource` object contains information that identifies the item being 314 # added to the group. 315 "kind": "A String", # Identifies the type of resource being added to the group. 316 # 317 # Valid values for this property are: 318 # * `youtube#channel` 319 # * `youtube#playlist` 320 # * `youtube#video` 321 # * `youtubePartner#asset` 322 "id": "A String", # The channel, video, playlist, or asset ID that YouTube uses to uniquely 323 # identify the item that is being added to the group. 324 }, 325 "groupId": "A String", # The ID that YouTube uses to uniquely identify the group that contains the 326 # item. 327 "etag": "A String", # The Etag of this resource. 328 "id": "A String", # The ID that YouTube uses to uniquely identify the `channel`, `video`, 329 # `playlist`, or `asset` resource that is included in the group. Note that 330 # this ID refers specifically to the inclusion of that resource in a 331 # particular group and is different than the channel ID, video ID, 332 # playlist ID, or asset ID that uniquely identifies the resource itself. 333 # The `resource.id` property's value specifies the unique channel, video, 334 # playlist, or asset ID. 335 }</pre> 336</div> 337 338<div class="method"> 339 <code class="details" id="list">list(onBehalfOfContentOwner=None, groupId=None, x__xgafv=None)</code> 340 <pre>Returns a collection of group items that match the API request parameters. 341 342Args: 343 onBehalfOfContentOwner: string, This parameter can only be used in a properly authorized request. **Note:** 344This parameter is intended exclusively for YouTube content partners that 345own and manage many different YouTube channels. 346 347The `onBehalfOfContentOwner` parameter indicates that the request's 348authorization credentials identify a YouTube user who is acting on behalf 349of the content owner specified in the parameter value. It allows content 350owners to authenticate once and get access to all their video and channel 351data, without having to provide authentication credentials for each 352individual channel. The account that the user authenticates with must be 353linked to the specified YouTube content owner. 354 groupId: string, The `groupId` parameter specifies the unique ID of the group for which you 355want to retrieve group items. 356 x__xgafv: string, V1 error format. 357 Allowed values 358 1 - v1 error format 359 2 - v2 error format 360 361Returns: 362 An object of the form: 363 364 { # Response message for GroupsService.ListGroupItems. 365 "items": [ # A list of groups that match the API request parameters. Each item in the 366 # list represents a `groupItem` resource. 367 { # A group item. 368 "kind": "A String", # Identifies the API resource's type. The value will be `youtube#groupItem`. 369 "errors": { # Request Error information. # Apiary error details 370 # 371 # The presence of an error field signals that the operation 372 # has failed. 373 "code": "A String", # Global error code. Deprecated and ignored. 374 # Set custom error codes in ErrorProto.domain and ErrorProto.code 375 # instead. 376 "requestId": "A String", # Request identifier generated by the service, which can be 377 # used to identify the error in the logs 378 "error": [ # Specific error description and codes 379 { # Describes one specific error. 380 "domain": "A String", # Error domain. RoSy services can define their own 381 # domain and error codes. This should normally be 382 # the name of an enum type, such as: gdata.CoreErrorDomain 383 "code": "A String", # Error code in the error domain. This should correspond to 384 # a value of the enum type whose name is in domain. See 385 # the core error domain in error_domain.proto. 386 "externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google. 387 # 388 # Please set domain, code and arguments whenever possible instead of this 389 # error message so that external APIs can build safe error messages 390 # themselves. 391 # 392 # External messages built in a RoSy interface will most likely refer to 393 # information and concepts that are not available externally and should not 394 # be exposed. It is safer if external APIs can understand the errors and 395 # decide what the error message should look like. 396 "debugInfo": "A String", # Debugging information, which should not be 397 # shared externally. 398 "locationType": "A String", 399 "argument": [ # Error arguments, to be used when building user-friendly error messages 400 # given the error domain and code. Different error codes require different 401 # arguments. 402 "A String", 403 ], 404 "location": "A String", # Location of the error, as specified by the location type. 405 # 406 # If location_type is PATH, this should be a path to a field that's 407 # relative to the request, using FieldPath notation 408 # (net/proto2/util/public/field_path.h). 409 # 410 # Examples: 411 # authenticated_user.gaia_id 412 # resource.address[2].country 413 }, 414 ], 415 }, 416 "resource": { # The `resource` object contains information that identifies the item being 417 # added to the group. 418 "kind": "A String", # Identifies the type of resource being added to the group. 419 # 420 # Valid values for this property are: 421 # * `youtube#channel` 422 # * `youtube#playlist` 423 # * `youtube#video` 424 # * `youtubePartner#asset` 425 "id": "A String", # The channel, video, playlist, or asset ID that YouTube uses to uniquely 426 # identify the item that is being added to the group. 427 }, 428 "groupId": "A String", # The ID that YouTube uses to uniquely identify the group that contains the 429 # item. 430 "etag": "A String", # The Etag of this resource. 431 "id": "A String", # The ID that YouTube uses to uniquely identify the `channel`, `video`, 432 # `playlist`, or `asset` resource that is included in the group. Note that 433 # this ID refers specifically to the inclusion of that resource in a 434 # particular group and is different than the channel ID, video ID, 435 # playlist ID, or asset ID that uniquely identifies the resource itself. 436 # The `resource.id` property's value specifies the unique channel, video, 437 # playlist, or asset ID. 438 }, 439 ], 440 "kind": "A String", # Identifies the API resource's type. The value will be 441 # `youtube#groupItemListResponse`. 442 "etag": "A String", # The Etag of this resource. 443 "errors": { # Request Error information. # Apiary error details 444 # 445 # The presence of an error field signals that the operation 446 # has failed. 447 "code": "A String", # Global error code. Deprecated and ignored. 448 # Set custom error codes in ErrorProto.domain and ErrorProto.code 449 # instead. 450 "requestId": "A String", # Request identifier generated by the service, which can be 451 # used to identify the error in the logs 452 "error": [ # Specific error description and codes 453 { # Describes one specific error. 454 "domain": "A String", # Error domain. RoSy services can define their own 455 # domain and error codes. This should normally be 456 # the name of an enum type, such as: gdata.CoreErrorDomain 457 "code": "A String", # Error code in the error domain. This should correspond to 458 # a value of the enum type whose name is in domain. See 459 # the core error domain in error_domain.proto. 460 "externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google. 461 # 462 # Please set domain, code and arguments whenever possible instead of this 463 # error message so that external APIs can build safe error messages 464 # themselves. 465 # 466 # External messages built in a RoSy interface will most likely refer to 467 # information and concepts that are not available externally and should not 468 # be exposed. It is safer if external APIs can understand the errors and 469 # decide what the error message should look like. 470 "debugInfo": "A String", # Debugging information, which should not be 471 # shared externally. 472 "locationType": "A String", 473 "argument": [ # Error arguments, to be used when building user-friendly error messages 474 # given the error domain and code. Different error codes require different 475 # arguments. 476 "A String", 477 ], 478 "location": "A String", # Location of the error, as specified by the location type. 479 # 480 # If location_type is PATH, this should be a path to a field that's 481 # relative to the request, using FieldPath notation 482 # (net/proto2/util/public/field_path.h). 483 # 484 # Examples: 485 # authenticated_user.gaia_id 486 # resource.address[2].country 487 }, 488 ], 489 }, 490 }</pre> 491</div> 492 493</body></html>