1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="youtubeAnalytics_v2.html">YouTube Analytics API</a> . <a href="youtubeAnalytics_v2.groups.html">groups</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#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">Deletes 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.</p> 86<p class="toc_element"> 87 <code><a href="#list">list(id=None, mine=None, onBehalfOfContentOwner=None, pageToken=None, x__xgafv=None)</a></code></p> 88<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> 89<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"> 93 <code><a href="#update">update(body=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p> 94<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"> 97 <code class="details" id="close">close()</code> 98 <pre>Close httplib2 connections.</pre> 99</div> 100 101<div class="method"> 102 <code class="details" id="delete">delete(id=None, onBehalfOfContentOwner=None, x__xgafv=None)</code> 103 <pre>Deletes a group. 104 105Args: 106 id: string, The `id` parameter specifies the YouTube group ID of the group that is being deleted. 107 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. 108 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. 117 "errors": { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details 118 "code": "A String", # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead. 119 "error": [ # Specific error description and codes 120 { # Describes one specific error. 121 "argument": [ # Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments. 122 "A String", 123 ], 124 "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. 125 "debugInfo": "A String", # Debugging information, which should not be shared externally. 126 "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 127 "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. 128 "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 129 "locationType": "A String", 130 }, 131 ], 132 "requestId": "A String", # Request identifier generated by the service, which can be used to identify the error in the logs 133 }, 134}</pre> 135</div> 136 137<div class="method"> 138 <code class="details" id="insert">insert(body=None, onBehalfOfContentOwner=None, x__xgafv=None)</code> 139 <pre>Creates a group. 140 141Args: 142 body: object, The request body. 143 The object takes the form of: 144 145{ # A group. 146 "contentDetails": { # A group's content details. # The `contentDetails` object contains additional information about the group, such as the number and type of items that it contains. 147 "itemCount": "A String", # The number of items in the group. 148 "itemType": "A String", # The type of resources that the group contains. Valid values for this property are: * `youtube#channel` * `youtube#playlist` * `youtube#video` * `youtubePartner#asset` 149 }, 150 "errors": { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details 151 "code": "A String", # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead. 152 "error": [ # Specific error description and codes 153 { # Describes one specific error. 154 "argument": [ # Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments. 155 "A String", 156 ], 157 "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. 158 "debugInfo": "A String", # Debugging information, which should not be shared externally. 159 "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 160 "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. 161 "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 162 "locationType": "A String", 163 }, 164 ], 165 "requestId": "A String", # Request identifier generated by the service, which can be used to identify the error in the logs 166 }, 167 "etag": "A String", # The Etag of this resource. 168 "id": "A String", # The ID that YouTube uses to uniquely identify the group. 169 "kind": "A String", # Identifies the API resource's type. The value will be `youtube#group`. 170 "snippet": { # A group snippet. # The `snippet` object contains basic information about the group, including its creation date and name. 171 "publishedAt": "A String", # The date and time that the group was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. 172 "title": "A String", # The group name. The value must be a non-empty string. 173 }, 174} 175 176 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. 177 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. 186 "contentDetails": { # A group's content details. # The `contentDetails` object contains additional information about the group, such as the number and type of items that it contains. 187 "itemCount": "A String", # The number of items in the group. 188 "itemType": "A String", # The type of resources that the group contains. Valid values for this property are: * `youtube#channel` * `youtube#playlist` * `youtube#video` * `youtubePartner#asset` 189 }, 190 "errors": { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details 191 "code": "A String", # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead. 192 "error": [ # Specific error description and codes 193 { # Describes one specific error. 194 "argument": [ # Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments. 195 "A String", 196 ], 197 "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. 198 "debugInfo": "A String", # Debugging information, which should not be shared externally. 199 "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 200 "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. 201 "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 202 "locationType": "A String", 203 }, 204 ], 205 "requestId": "A String", # Request identifier generated by the service, which can be used to identify the error in the logs 206 }, 207 "etag": "A String", # The Etag of this resource. 208 "id": "A String", # The ID that YouTube uses to uniquely identify the group. 209 "kind": "A String", # Identifies the API resource's type. The value will be `youtube#group`. 210 "snippet": { # A group snippet. # The `snippet` object contains basic information about the group, including its creation date and name. 211 "publishedAt": "A String", # The date and time that the group was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. 212 "title": "A String", # The group name. The value must be a non-empty string. 213 }, 214}</pre> 215</div> 216 217<div class="method"> 218 <code class="details" id="list">list(id=None, mine=None, onBehalfOfContentOwner=None, pageToken=None, x__xgafv=None)</code> 219 <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. 220 221Args: 222 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'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`. 223 mine: boolean, This parameter can only be used in a properly authorized request. Set this parameter's value to true to retrieve all groups owned by the authenticated user. 224 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. 225 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. 226 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. 235 "errors": { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details 236 "code": "A String", # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead. 237 "error": [ # Specific error description and codes 238 { # Describes one specific error. 239 "argument": [ # Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments. 240 "A String", 241 ], 242 "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. 243 "debugInfo": "A String", # Debugging information, which should not be shared externally. 244 "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 245 "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. 246 "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 247 "locationType": "A String", 248 }, 249 ], 250 "requestId": "A String", # Request identifier generated by the service, which can be used to identify the error in the logs 251 }, 252 "etag": "A String", # The Etag of this resource. 253 "items": [ # A list of groups that match the API request parameters. Each item in the list represents a `group` resource. 254 { # A group. 255 "contentDetails": { # A group's content details. # The `contentDetails` object contains additional information about the group, such as the number and type of items that it contains. 256 "itemCount": "A String", # The number of items in the group. 257 "itemType": "A String", # The type of resources that the group contains. Valid values for this property are: * `youtube#channel` * `youtube#playlist` * `youtube#video` * `youtubePartner#asset` 258 }, 259 "errors": { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details 260 "code": "A String", # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead. 261 "error": [ # Specific error description and codes 262 { # Describes one specific error. 263 "argument": [ # Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments. 264 "A String", 265 ], 266 "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. 267 "debugInfo": "A String", # Debugging information, which should not be shared externally. 268 "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 269 "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. 270 "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 271 "locationType": "A String", 272 }, 273 ], 274 "requestId": "A String", # Request identifier generated by the service, which can be used to identify the error in the logs 275 }, 276 "etag": "A String", # The Etag of this resource. 277 "id": "A String", # The ID that YouTube uses to uniquely identify the group. 278 "kind": "A String", # Identifies the API resource's type. The value will be `youtube#group`. 279 "snippet": { # A group snippet. # The `snippet` object contains basic information about the group, including its creation date and name. 280 "publishedAt": "A String", # The date and time that the group was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. 281 "title": "A String", # The group name. The value must be a non-empty string. 282 }, 283 }, 284 ], 285 "kind": "A String", # Identifies the API resource's type. The value will be `youtube#groupListResponse`. 286 "nextPageToken": "A String", # The token that can be used as the value of the `pageToken` parameter to retrieve the next page in the result set. 287}</pre> 288</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: 299 A request object that you can call 'execute()' on to request the next 300 page. Returns None if there are no more items in the collection. 301 </pre> 302</div> 303 304<div class="method"> 305 <code class="details" id="update">update(body=None, onBehalfOfContentOwner=None, x__xgafv=None)</code> 306 <pre>Modifies a group. For example, you could change a group's title. 307 308Args: 309 body: object, The request body. 310 The object takes the form of: 311 312{ # A group. 313 "contentDetails": { # A group's content details. # The `contentDetails` object contains additional information about the group, such as the number and type of items that it contains. 314 "itemCount": "A String", # The number of items in the group. 315 "itemType": "A String", # The type of resources that the group contains. Valid values for this property are: * `youtube#channel` * `youtube#playlist` * `youtube#video` * `youtubePartner#asset` 316 }, 317 "errors": { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details 318 "code": "A String", # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead. 319 "error": [ # Specific error description and codes 320 { # Describes one specific error. 321 "argument": [ # Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments. 322 "A String", 323 ], 324 "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. 325 "debugInfo": "A String", # Debugging information, which should not be shared externally. 326 "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 327 "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. 328 "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 329 "locationType": "A String", 330 }, 331 ], 332 "requestId": "A String", # Request identifier generated by the service, which can be used to identify the error in the logs 333 }, 334 "etag": "A String", # The Etag of this resource. 335 "id": "A String", # The ID that YouTube uses to uniquely identify the group. 336 "kind": "A String", # Identifies the API resource's type. The value will be `youtube#group`. 337 "snippet": { # A group snippet. # The `snippet` object contains basic information about the group, including its creation date and name. 338 "publishedAt": "A String", # The date and time that the group was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. 339 "title": "A String", # The group name. The value must be a non-empty string. 340 }, 341} 342 343 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. 344 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. 353 "contentDetails": { # A group's content details. # The `contentDetails` object contains additional information about the group, such as the number and type of items that it contains. 354 "itemCount": "A String", # The number of items in the group. 355 "itemType": "A String", # The type of resources that the group contains. Valid values for this property are: * `youtube#channel` * `youtube#playlist` * `youtube#video` * `youtubePartner#asset` 356 }, 357 "errors": { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details 358 "code": "A String", # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead. 359 "error": [ # Specific error description and codes 360 { # Describes one specific error. 361 "argument": [ # Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments. 362 "A String", 363 ], 364 "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. 365 "debugInfo": "A String", # Debugging information, which should not be shared externally. 366 "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 367 "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. 368 "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 369 "locationType": "A String", 370 }, 371 ], 372 "requestId": "A String", # Request identifier generated by the service, which can be used to identify the error in the logs 373 }, 374 "etag": "A String", # The Etag of this resource. 375 "id": "A String", # The ID that YouTube uses to uniquely identify the group. 376 "kind": "A String", # Identifies the API resource's type. The value will be `youtube#group`. 377 "snippet": { # A group snippet. # The `snippet` object contains basic information about the group, including its creation date and name. 378 "publishedAt": "A String", # The date and time that the group was created. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. 379 "title": "A String", # The group name. The value must be a non-empty string. 380 }, 381}</pre> 382</div> 383 384</body></html>