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="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(id=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Removes an item from a group.</p> 83<p class="toc_element"> 84 <code><a href="#insert">insert(body=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Creates a group item.</p> 86<p class="toc_element"> 87 <code><a href="#list">list(groupId=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p> 88<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"> 91 <code class="details" id="close">close()</code> 92 <pre>Close httplib2 connections.</pre> 93</div> 94 95<div class="method"> 96 <code class="details" id="delete">delete(id=None, onBehalfOfContentOwner=None, x__xgafv=None)</code> 97 <pre>Removes an item from a group. 98 99Args: 100 id: string, The `id` parameter specifies the YouTube group item ID of the group item that is being deleted. 101 onBehalfOfContentOwner: string, This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner. 102 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. 111 "errors": { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details 112 "code": "A String", # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead. 113 "error": [ # Specific error description and codes 114 { # Describes one specific error. 115 "argument": [ # Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments. 116 "A String", 117 ], 118 "code": "A String", # Error code in the error domain. This should correspond to a value of the enum type whose name is in domain. See the core error domain in error_domain.proto. 119 "debugInfo": "A String", # Debugging information, which should not be shared externally. 120 "domain": "A String", # Error domain. RoSy services can define their own domain and error codes. This should normally be the name of an enum type, such as: gdata.CoreErrorDomain 121 "externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google. Please set domain, code and arguments whenever possible instead of this error message so that external APIs can build safe error messages themselves. External messages built in a RoSy interface will most likely refer to information and concepts that are not available externally and should not be exposed. It is safer if external APIs can understand the errors and decide what the error message should look like. 122 "location": "A String", # Location of the error, as specified by the location type. If location_type is PATH, this should be a path to a field that's relative to the request, using FieldPath notation (net/proto2/util/public/field_path.h). Examples: authenticated_user.gaia_id resource.address[2].country 123 "locationType": "A String", 124 }, 125 ], 126 "requestId": "A String", # Request identifier generated by the service, which can be used to identify the error in the logs 127 }, 128}</pre> 129</div> 130 131<div class="method"> 132 <code class="details" id="insert">insert(body=None, onBehalfOfContentOwner=None, x__xgafv=None)</code> 133 <pre>Creates a group item. 134 135Args: 136 body: object, The request body. 137 The object takes the form of: 138 139{ # A group item. 140 "errors": { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details 141 "code": "A String", # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead. 142 "error": [ # Specific error description and codes 143 { # Describes one specific error. 144 "argument": [ # Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments. 145 "A String", 146 ], 147 "code": "A String", # Error code in the error domain. This should correspond to a value of the enum type whose name is in domain. See the core error domain in error_domain.proto. 148 "debugInfo": "A String", # Debugging information, which should not be shared externally. 149 "domain": "A String", # Error domain. RoSy services can define their own domain and error codes. This should normally be the name of an enum type, such as: gdata.CoreErrorDomain 150 "externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google. Please set domain, code and arguments whenever possible instead of this error message so that external APIs can build safe error messages themselves. External messages built in a RoSy interface will most likely refer to information and concepts that are not available externally and should not be exposed. It is safer if external APIs can understand the errors and decide what the error message should look like. 151 "location": "A String", # Location of the error, as specified by the location type. If location_type is PATH, this should be a path to a field that's relative to the request, using FieldPath notation (net/proto2/util/public/field_path.h). Examples: authenticated_user.gaia_id resource.address[2].country 152 "locationType": "A String", 153 }, 154 ], 155 "requestId": "A String", # Request identifier generated by the service, which can be used to identify the error in the logs 156 }, 157 "etag": "A String", # The Etag of this resource. 158 "groupId": "A String", # The ID that YouTube uses to uniquely identify the group that contains the item. 159 "id": "A String", # The ID that YouTube uses to uniquely identify the `channel`, `video`, `playlist`, or `asset` resource that is included in the group. Note that this ID refers specifically to the inclusion of that resource in a particular group and is different than the channel ID, video ID, playlist ID, or asset ID that uniquely identifies the resource itself. The `resource.id` property's value specifies the unique channel, video, playlist, or asset ID. 160 "kind": "A String", # Identifies the API resource's type. The value will be `youtube#groupItem`. 161 "resource": { # The `resource` object contains information that identifies the item being added to the group. 162 "id": "A String", # The channel, video, playlist, or asset ID that YouTube uses to uniquely identify the item that is being added to the group. 163 "kind": "A String", # Identifies the type of resource being added to the group. Valid values for this property are: * `youtube#channel` * `youtube#playlist` * `youtube#video` * `youtubePartner#asset` 164 }, 165} 166 167 onBehalfOfContentOwner: string, This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner. 168 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. 177 "errors": { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details 178 "code": "A String", # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead. 179 "error": [ # Specific error description and codes 180 { # Describes one specific error. 181 "argument": [ # Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments. 182 "A String", 183 ], 184 "code": "A String", # Error code in the error domain. This should correspond to a value of the enum type whose name is in domain. See the core error domain in error_domain.proto. 185 "debugInfo": "A String", # Debugging information, which should not be shared externally. 186 "domain": "A String", # Error domain. RoSy services can define their own domain and error codes. This should normally be the name of an enum type, such as: gdata.CoreErrorDomain 187 "externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google. Please set domain, code and arguments whenever possible instead of this error message so that external APIs can build safe error messages themselves. External messages built in a RoSy interface will most likely refer to information and concepts that are not available externally and should not be exposed. It is safer if external APIs can understand the errors and decide what the error message should look like. 188 "location": "A String", # Location of the error, as specified by the location type. If location_type is PATH, this should be a path to a field that's relative to the request, using FieldPath notation (net/proto2/util/public/field_path.h). Examples: authenticated_user.gaia_id resource.address[2].country 189 "locationType": "A String", 190 }, 191 ], 192 "requestId": "A String", # Request identifier generated by the service, which can be used to identify the error in the logs 193 }, 194 "etag": "A String", # The Etag of this resource. 195 "groupId": "A String", # The ID that YouTube uses to uniquely identify the group that contains the item. 196 "id": "A String", # The ID that YouTube uses to uniquely identify the `channel`, `video`, `playlist`, or `asset` resource that is included in the group. Note that this ID refers specifically to the inclusion of that resource in a particular group and is different than the channel ID, video ID, playlist ID, or asset ID that uniquely identifies the resource itself. The `resource.id` property's value specifies the unique channel, video, playlist, or asset ID. 197 "kind": "A String", # Identifies the API resource's type. The value will be `youtube#groupItem`. 198 "resource": { # The `resource` object contains information that identifies the item being added to the group. 199 "id": "A String", # The channel, video, playlist, or asset ID that YouTube uses to uniquely identify the item that is being added to the group. 200 "kind": "A String", # Identifies the type of resource being added to the group. Valid values for this property are: * `youtube#channel` * `youtube#playlist` * `youtube#video` * `youtubePartner#asset` 201 }, 202}</pre> 203</div> 204 205<div class="method"> 206 <code class="details" id="list">list(groupId=None, onBehalfOfContentOwner=None, x__xgafv=None)</code> 207 <pre>Returns a collection of group items that match the API request parameters. 208 209Args: 210 groupId: string, The `groupId` parameter specifies the unique ID of the group for which you want to retrieve group items. 211 onBehalfOfContentOwner: string, This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner. 212 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. 221 "errors": { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details 222 "code": "A String", # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead. 223 "error": [ # Specific error description and codes 224 { # Describes one specific error. 225 "argument": [ # Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments. 226 "A String", 227 ], 228 "code": "A String", # Error code in the error domain. This should correspond to a value of the enum type whose name is in domain. See the core error domain in error_domain.proto. 229 "debugInfo": "A String", # Debugging information, which should not be shared externally. 230 "domain": "A String", # Error domain. RoSy services can define their own domain and error codes. This should normally be the name of an enum type, such as: gdata.CoreErrorDomain 231 "externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google. Please set domain, code and arguments whenever possible instead of this error message so that external APIs can build safe error messages themselves. External messages built in a RoSy interface will most likely refer to information and concepts that are not available externally and should not be exposed. It is safer if external APIs can understand the errors and decide what the error message should look like. 232 "location": "A String", # Location of the error, as specified by the location type. If location_type is PATH, this should be a path to a field that's relative to the request, using FieldPath notation (net/proto2/util/public/field_path.h). Examples: authenticated_user.gaia_id resource.address[2].country 233 "locationType": "A String", 234 }, 235 ], 236 "requestId": "A String", # Request identifier generated by the service, which can be used to identify the error in the logs 237 }, 238 "etag": "A String", # The Etag of this resource. 239 "items": [ # A list of groups that match the API request parameters. Each item in the list represents a `groupItem` resource. 240 { # A group item. 241 "errors": { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details 242 "code": "A String", # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead. 243 "error": [ # Specific error description and codes 244 { # Describes one specific error. 245 "argument": [ # Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments. 246 "A String", 247 ], 248 "code": "A String", # Error code in the error domain. This should correspond to a value of the enum type whose name is in domain. See the core error domain in error_domain.proto. 249 "debugInfo": "A String", # Debugging information, which should not be shared externally. 250 "domain": "A String", # Error domain. RoSy services can define their own domain and error codes. This should normally be the name of an enum type, such as: gdata.CoreErrorDomain 251 "externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google. Please set domain, code and arguments whenever possible instead of this error message so that external APIs can build safe error messages themselves. External messages built in a RoSy interface will most likely refer to information and concepts that are not available externally and should not be exposed. It is safer if external APIs can understand the errors and decide what the error message should look like. 252 "location": "A String", # Location of the error, as specified by the location type. If location_type is PATH, this should be a path to a field that's relative to the request, using FieldPath notation (net/proto2/util/public/field_path.h). Examples: authenticated_user.gaia_id resource.address[2].country 253 "locationType": "A String", 254 }, 255 ], 256 "requestId": "A String", # Request identifier generated by the service, which can be used to identify the error in the logs 257 }, 258 "etag": "A String", # The Etag of this resource. 259 "groupId": "A String", # The ID that YouTube uses to uniquely identify the group that contains the item. 260 "id": "A String", # The ID that YouTube uses to uniquely identify the `channel`, `video`, `playlist`, or `asset` resource that is included in the group. Note that this ID refers specifically to the inclusion of that resource in a particular group and is different than the channel ID, video ID, playlist ID, or asset ID that uniquely identifies the resource itself. The `resource.id` property's value specifies the unique channel, video, playlist, or asset ID. 261 "kind": "A String", # Identifies the API resource's type. The value will be `youtube#groupItem`. 262 "resource": { # The `resource` object contains information that identifies the item being added to the group. 263 "id": "A String", # The channel, video, playlist, or asset ID that YouTube uses to uniquely identify the item that is being added to the group. 264 "kind": "A String", # Identifies the type of resource being added to the group. Valid values for this property are: * `youtube#channel` * `youtube#playlist` * `youtube#video` * `youtubePartner#asset` 265 }, 266 }, 267 ], 268 "kind": "A String", # Identifies the API resource's type. The value will be `youtube#groupItemListResponse`. 269}</pre> 270</div> 271 272</body></html>