| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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"> |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 78 | <code><a href="#delete">delete(onBehalfOfContentOwner=None, id=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 79 | <p class="firstline">Deletes a group.</p> |
| 80 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 81 | <code><a href="#insert">insert(body=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 82 | <p class="firstline">Creates a group.</p> |
| 83 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 84 | <code><a href="#list">list(id=None, onBehalfOfContentOwner=None, pageToken=None, mine=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 85 | <p class="firstline">Returns a collection of groups that match the API request parameters. For</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 88 | <p class="firstline">Retrieves the next page of results.</p> |
| 89 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 90 | <code><a href="#update">update(body=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 91 | <p class="firstline">Modifies a group. For example, you could change a group's title.</p> |
| 92 | <h3>Method Details</h3> |
| 93 | <div class="method"> |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 94 | <code class="details" id="delete">delete(onBehalfOfContentOwner=None, id=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 95 | <pre>Deletes a group. |
| 96 | |
| 97 | Args: |
| 98 | onBehalfOfContentOwner: string, This parameter can only be used in a properly authorized request. **Note:** |
| 99 | This parameter is intended exclusively for YouTube content partners that |
| 100 | own and manage many different YouTube channels. |
| 101 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 102 | The `onBehalfOfContentOwner` parameter indicates that the request's |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 103 | authorization credentials identify a YouTube user who is acting on behalf |
| 104 | of the content owner specified in the parameter value. It allows content |
| 105 | owners to authenticate once and get access to all their video and channel |
| 106 | data, without having to provide authentication credentials for each |
| 107 | individual channel. The account that the user authenticates with must be |
| 108 | linked to the specified YouTube content owner. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 109 | id: string, The `id` parameter specifies the YouTube group ID of the group that is |
| 110 | being deleted. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 111 | x__xgafv: string, V1 error format. |
| 112 | Allowed values |
| 113 | 1 - v1 error format |
| 114 | 2 - v2 error format |
| 115 | |
| 116 | Returns: |
| 117 | An object of the form: |
| 118 | |
| 119 | { # Empty response. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 120 | "errors": { # Request Error information. # Apiary error details |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 121 | # |
| 122 | # The presence of an error field signals that the operation |
| 123 | # has failed. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 124 | "requestId": "A String", # Request identifier generated by the service, which can be |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 125 | # used to identify the error in the logs |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 126 | "error": [ # Specific error description and codes |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 127 | { # Describes one specific error. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 128 | "argument": [ # Error arguments, to be used when building user-friendly error messages |
| 129 | # given the error domain and code. Different error codes require different |
| 130 | # arguments. |
| 131 | "A String", |
| 132 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 133 | "code": "A String", # Error code in the error domain. This should correspond to |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 134 | # a value of the enum type whose name is in domain. See |
| 135 | # the core error domain in error_domain.proto. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 136 | "location": "A String", # Location of the error, as specified by the location type. |
| 137 | # |
| 138 | # If location_type is PATH, this should be a path to a field that's |
| 139 | # relative to the request, using FieldPath notation |
| 140 | # (net/proto2/util/public/field_path.h). |
| 141 | # |
| 142 | # Examples: |
| 143 | # authenticated_user.gaia_id |
| 144 | # resource.address[2].country |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 145 | "externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 146 | # |
| 147 | # Please set domain, code and arguments whenever possible instead of this |
| 148 | # error message so that external APIs can build safe error messages |
| 149 | # themselves. |
| 150 | # |
| 151 | # External messages built in a RoSy interface will most likely refer to |
| 152 | # information and concepts that are not available externally and should not |
| 153 | # be exposed. It is safer if external APIs can understand the errors and |
| 154 | # decide what the error message should look like. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 155 | "locationType": "A String", |
| 156 | "debugInfo": "A String", # Debugging information, which should not be |
| 157 | # shared externally. |
| 158 | "domain": "A String", # Error domain. RoSy services can define their own |
| 159 | # domain and error codes. This should normally be |
| 160 | # the name of an enum type, such as: gdata.CoreErrorDomain |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 161 | }, |
| 162 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 163 | "code": "A String", # Global error code. Deprecated and ignored. |
| 164 | # Set custom error codes in ErrorProto.domain and ErrorProto.code |
| 165 | # instead. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 166 | }, |
| 167 | }</pre> |
| 168 | </div> |
| 169 | |
| 170 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 171 | <code class="details" id="insert">insert(body=None, onBehalfOfContentOwner=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 172 | <pre>Creates a group. |
| 173 | |
| 174 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 175 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 176 | The object takes the form of: |
| 177 | |
| 178 | { # A group. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 179 | "contentDetails": { # A group's content details. # The `contentDetails` object contains additional information about the |
| 180 | # group, such as the number and type of items that it contains. |
| 181 | "itemCount": "A String", # The number of items in the group. |
| 182 | "itemType": "A String", # The type of resources that the group contains. |
| 183 | # |
| 184 | # Valid values for this property are: |
| 185 | # * `youtube#channel` |
| 186 | # * `youtube#playlist` |
| 187 | # * `youtube#video` |
| 188 | # * `youtubePartner#asset` |
| 189 | }, |
| 190 | "snippet": { # A group snippet. # The `snippet` object contains basic information about the group, including |
| 191 | # its creation date and name. |
| 192 | "publishedAt": "A String", # The date and time that the group was created. The value is specified in |
| 193 | # ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. |
| 194 | "title": "A String", # The group name. The value must be a non-empty string. |
| 195 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 196 | "errors": { # Request Error information. # Apiary error details |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 197 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 198 | # The presence of an error field signals that the operation |
| 199 | # has failed. |
| 200 | "requestId": "A String", # Request identifier generated by the service, which can be |
| 201 | # used to identify the error in the logs |
| 202 | "error": [ # Specific error description and codes |
| 203 | { # Describes one specific error. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 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 | "code": "A String", # Error code in the error domain. This should correspond to |
| 210 | # a value of the enum type whose name is in domain. See |
| 211 | # the core error domain in error_domain.proto. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 212 | "location": "A String", # Location of the error, as specified by the location type. |
| 213 | # |
| 214 | # If location_type is PATH, this should be a path to a field that's |
| 215 | # relative to the request, using FieldPath notation |
| 216 | # (net/proto2/util/public/field_path.h). |
| 217 | # |
| 218 | # Examples: |
| 219 | # authenticated_user.gaia_id |
| 220 | # resource.address[2].country |
| 221 | "externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google. |
| 222 | # |
| 223 | # Please set domain, code and arguments whenever possible instead of this |
| 224 | # error message so that external APIs can build safe error messages |
| 225 | # themselves. |
| 226 | # |
| 227 | # External messages built in a RoSy interface will most likely refer to |
| 228 | # information and concepts that are not available externally and should not |
| 229 | # be exposed. It is safer if external APIs can understand the errors and |
| 230 | # decide what the error message should look like. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 231 | "locationType": "A String", |
| 232 | "debugInfo": "A String", # Debugging information, which should not be |
| 233 | # shared externally. |
| 234 | "domain": "A String", # Error domain. RoSy services can define their own |
| 235 | # domain and error codes. This should normally be |
| 236 | # the name of an enum type, such as: gdata.CoreErrorDomain |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 237 | }, |
| 238 | ], |
| 239 | "code": "A String", # Global error code. Deprecated and ignored. |
| 240 | # Set custom error codes in ErrorProto.domain and ErrorProto.code |
| 241 | # instead. |
| 242 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 243 | "etag": "A String", # The Etag of this resource. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 244 | "kind": "A String", # Identifies the API resource's type. The value will be `youtube#group`. |
| 245 | "id": "A String", # The ID that YouTube uses to uniquely identify the group. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 246 | } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 247 | |
| 248 | onBehalfOfContentOwner: string, This parameter can only be used in a properly authorized request. **Note:** |
| 249 | This parameter is intended exclusively for YouTube content partners that |
| 250 | own and manage many different YouTube channels. |
| 251 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 252 | The `onBehalfOfContentOwner` parameter indicates that the request's |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 253 | authorization credentials identify a YouTube user who is acting on behalf |
| 254 | of the content owner specified in the parameter value. It allows content |
| 255 | owners to authenticate once and get access to all their video and channel |
| 256 | data, without having to provide authentication credentials for each |
| 257 | individual channel. The account that the user authenticates with must be |
| 258 | linked to the specified YouTube content owner. |
| 259 | x__xgafv: string, V1 error format. |
| 260 | Allowed values |
| 261 | 1 - v1 error format |
| 262 | 2 - v2 error format |
| 263 | |
| 264 | Returns: |
| 265 | An object of the form: |
| 266 | |
| 267 | { # A group. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 268 | "contentDetails": { # A group's content details. # The `contentDetails` object contains additional information about the |
| 269 | # group, such as the number and type of items that it contains. |
| 270 | "itemCount": "A String", # The number of items in the group. |
| 271 | "itemType": "A String", # The type of resources that the group contains. |
| 272 | # |
| 273 | # Valid values for this property are: |
| 274 | # * `youtube#channel` |
| 275 | # * `youtube#playlist` |
| 276 | # * `youtube#video` |
| 277 | # * `youtubePartner#asset` |
| 278 | }, |
| 279 | "snippet": { # A group snippet. # The `snippet` object contains basic information about the group, including |
| 280 | # its creation date and name. |
| 281 | "publishedAt": "A String", # The date and time that the group was created. The value is specified in |
| 282 | # ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. |
| 283 | "title": "A String", # The group name. The value must be a non-empty string. |
| 284 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 285 | "errors": { # Request Error information. # Apiary error details |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 286 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 287 | # The presence of an error field signals that the operation |
| 288 | # has failed. |
| 289 | "requestId": "A String", # Request identifier generated by the service, which can be |
| 290 | # used to identify the error in the logs |
| 291 | "error": [ # Specific error description and codes |
| 292 | { # Describes one specific error. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 293 | "argument": [ # Error arguments, to be used when building user-friendly error messages |
| 294 | # given the error domain and code. Different error codes require different |
| 295 | # arguments. |
| 296 | "A String", |
| 297 | ], |
| 298 | "code": "A String", # Error code in the error domain. This should correspond to |
| 299 | # a value of the enum type whose name is in domain. See |
| 300 | # the core error domain in error_domain.proto. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 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 | "externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google. |
| 311 | # |
| 312 | # Please set domain, code and arguments whenever possible instead of this |
| 313 | # error message so that external APIs can build safe error messages |
| 314 | # themselves. |
| 315 | # |
| 316 | # External messages built in a RoSy interface will most likely refer to |
| 317 | # information and concepts that are not available externally and should not |
| 318 | # be exposed. It is safer if external APIs can understand the errors and |
| 319 | # decide what the error message should look like. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 320 | "locationType": "A String", |
| 321 | "debugInfo": "A String", # Debugging information, which should not be |
| 322 | # shared externally. |
| 323 | "domain": "A String", # Error domain. RoSy services can define their own |
| 324 | # domain and error codes. This should normally be |
| 325 | # the name of an enum type, such as: gdata.CoreErrorDomain |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 326 | }, |
| 327 | ], |
| 328 | "code": "A String", # Global error code. Deprecated and ignored. |
| 329 | # Set custom error codes in ErrorProto.domain and ErrorProto.code |
| 330 | # instead. |
| 331 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 332 | "etag": "A String", # The Etag of this resource. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 333 | "kind": "A String", # Identifies the API resource's type. The value will be `youtube#group`. |
| 334 | "id": "A String", # The ID that YouTube uses to uniquely identify the group. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 335 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 336 | </div> |
| 337 | |
| 338 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 339 | <code class="details" id="list">list(id=None, onBehalfOfContentOwner=None, pageToken=None, mine=None, x__xgafv=None)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 340 | <pre>Returns a collection of groups that match the API request parameters. For |
| 341 | example, you can retrieve all groups that the authenticated user owns, |
| 342 | or you can retrieve one or more groups by their unique IDs. |
| 343 | |
| 344 | Args: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 345 | id: string, The `id` parameter specifies a comma-separated list of the YouTube group |
| 346 | ID(s) for the resource(s) that are being retrieved. Each group must be |
| 347 | owned by the authenticated user. In a `group` resource, the `id` property |
| 348 | specifies the group's YouTube group ID. |
| 349 | |
| 350 | Note that if you do not specify a value for the `id` parameter, then you |
| 351 | must set the `mine` parameter to `true`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 352 | onBehalfOfContentOwner: string, This parameter can only be used in a properly authorized request. **Note:** |
| 353 | This parameter is intended exclusively for YouTube content partners that |
| 354 | own and manage many different YouTube channels. |
| 355 | |
| 356 | The `onBehalfOfContentOwner` parameter indicates that the request's |
| 357 | authorization credentials identify a YouTube user who is acting on behalf |
| 358 | of the content owner specified in the parameter value. It allows content |
| 359 | owners to authenticate once and get access to all their video and channel |
| 360 | data, without having to provide authentication credentials for each |
| 361 | individual channel. The account that the user authenticates with must be |
| 362 | linked to the specified YouTube content owner. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 363 | pageToken: string, The `pageToken` parameter identifies a specific page in the result set that |
| 364 | should be returned. In an API response, the `nextPageToken` property |
| 365 | identifies the next page that can be retrieved. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 366 | mine: boolean, This parameter can only be used in a properly authorized request. Set this |
| 367 | parameter's value to true to retrieve all groups owned by the authenticated |
| 368 | user. |
| 369 | x__xgafv: string, V1 error format. |
| 370 | Allowed values |
| 371 | 1 - v1 error format |
| 372 | 2 - v2 error format |
| 373 | |
| 374 | Returns: |
| 375 | An object of the form: |
| 376 | |
| 377 | { # Response message for GroupsService.ListGroups. |
| 378 | "etag": "A String", # The Etag of this resource. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 379 | "kind": "A String", # Identifies the API resource's type. The value will be |
| 380 | # `youtube#groupListResponse`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 381 | "errors": { # Request Error information. # Apiary error details |
| 382 | # |
| 383 | # The presence of an error field signals that the operation |
| 384 | # has failed. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 385 | "requestId": "A String", # Request identifier generated by the service, which can be |
| 386 | # used to identify the error in the logs |
| 387 | "error": [ # Specific error description and codes |
| 388 | { # Describes one specific error. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 389 | "argument": [ # Error arguments, to be used when building user-friendly error messages |
| 390 | # given the error domain and code. Different error codes require different |
| 391 | # arguments. |
| 392 | "A String", |
| 393 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 394 | "code": "A String", # Error code in the error domain. This should correspond to |
| 395 | # a value of the enum type whose name is in domain. See |
| 396 | # the core error domain in error_domain.proto. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 397 | "location": "A String", # Location of the error, as specified by the location type. |
| 398 | # |
| 399 | # If location_type is PATH, this should be a path to a field that's |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 400 | # relative to the request, using FieldPath notation |
| 401 | # (net/proto2/util/public/field_path.h). |
| 402 | # |
| 403 | # Examples: |
| 404 | # authenticated_user.gaia_id |
| 405 | # resource.address[2].country |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 406 | "externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google. |
| 407 | # |
| 408 | # Please set domain, code and arguments whenever possible instead of this |
| 409 | # error message so that external APIs can build safe error messages |
| 410 | # themselves. |
| 411 | # |
| 412 | # External messages built in a RoSy interface will most likely refer to |
| 413 | # information and concepts that are not available externally and should not |
| 414 | # be exposed. It is safer if external APIs can understand the errors and |
| 415 | # decide what the error message should look like. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 416 | "locationType": "A String", |
| 417 | "debugInfo": "A String", # Debugging information, which should not be |
| 418 | # shared externally. |
| 419 | "domain": "A String", # Error domain. RoSy services can define their own |
| 420 | # domain and error codes. This should normally be |
| 421 | # the name of an enum type, such as: gdata.CoreErrorDomain |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 422 | }, |
| 423 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 424 | "code": "A String", # Global error code. Deprecated and ignored. |
| 425 | # Set custom error codes in ErrorProto.domain and ErrorProto.code |
| 426 | # instead. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 427 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 428 | "items": [ # A list of groups that match the API request parameters. Each item in the |
| 429 | # list represents a `group` resource. |
| 430 | { # A group. |
| 431 | "contentDetails": { # A group's content details. # The `contentDetails` object contains additional information about the |
| 432 | # group, such as the number and type of items that it contains. |
| 433 | "itemCount": "A String", # The number of items in the group. |
| 434 | "itemType": "A String", # The type of resources that the group contains. |
| 435 | # |
| 436 | # Valid values for this property are: |
| 437 | # * `youtube#channel` |
| 438 | # * `youtube#playlist` |
| 439 | # * `youtube#video` |
| 440 | # * `youtubePartner#asset` |
| 441 | }, |
| 442 | "snippet": { # A group snippet. # The `snippet` object contains basic information about the group, including |
| 443 | # its creation date and name. |
| 444 | "publishedAt": "A String", # The date and time that the group was created. The value is specified in |
| 445 | # ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. |
| 446 | "title": "A String", # The group name. The value must be a non-empty string. |
| 447 | }, |
| 448 | "errors": { # Request Error information. # Apiary error details |
| 449 | # |
| 450 | # The presence of an error field signals that the operation |
| 451 | # has failed. |
| 452 | "requestId": "A String", # Request identifier generated by the service, which can be |
| 453 | # used to identify the error in the logs |
| 454 | "error": [ # Specific error description and codes |
| 455 | { # Describes one specific error. |
| 456 | "argument": [ # Error arguments, to be used when building user-friendly error messages |
| 457 | # given the error domain and code. Different error codes require different |
| 458 | # arguments. |
| 459 | "A String", |
| 460 | ], |
| 461 | "code": "A String", # Error code in the error domain. This should correspond to |
| 462 | # a value of the enum type whose name is in domain. See |
| 463 | # the core error domain in error_domain.proto. |
| 464 | "location": "A String", # Location of the error, as specified by the location type. |
| 465 | # |
| 466 | # If location_type is PATH, this should be a path to a field that's |
| 467 | # relative to the request, using FieldPath notation |
| 468 | # (net/proto2/util/public/field_path.h). |
| 469 | # |
| 470 | # Examples: |
| 471 | # authenticated_user.gaia_id |
| 472 | # resource.address[2].country |
| 473 | "externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google. |
| 474 | # |
| 475 | # Please set domain, code and arguments whenever possible instead of this |
| 476 | # error message so that external APIs can build safe error messages |
| 477 | # themselves. |
| 478 | # |
| 479 | # External messages built in a RoSy interface will most likely refer to |
| 480 | # information and concepts that are not available externally and should not |
| 481 | # be exposed. It is safer if external APIs can understand the errors and |
| 482 | # decide what the error message should look like. |
| 483 | "locationType": "A String", |
| 484 | "debugInfo": "A String", # Debugging information, which should not be |
| 485 | # shared externally. |
| 486 | "domain": "A String", # Error domain. RoSy services can define their own |
| 487 | # domain and error codes. This should normally be |
| 488 | # the name of an enum type, such as: gdata.CoreErrorDomain |
| 489 | }, |
| 490 | ], |
| 491 | "code": "A String", # Global error code. Deprecated and ignored. |
| 492 | # Set custom error codes in ErrorProto.domain and ErrorProto.code |
| 493 | # instead. |
| 494 | }, |
| 495 | "etag": "A String", # The Etag of this resource. |
| 496 | "kind": "A String", # Identifies the API resource's type. The value will be `youtube#group`. |
| 497 | "id": "A String", # The ID that YouTube uses to uniquely identify the group. |
| 498 | }, |
| 499 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 500 | "nextPageToken": "A String", # The token that can be used as the value of the `pageToken` parameter to |
| 501 | # retrieve the next page in the result set. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 502 | }</pre> |
| 503 | </div> |
| 504 | |
| 505 | <div class="method"> |
| 506 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 507 | <pre>Retrieves the next page of results. |
| 508 | |
| 509 | Args: |
| 510 | previous_request: The request for the previous page. (required) |
| 511 | previous_response: The response from the request for the previous page. (required) |
| 512 | |
| 513 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 514 | A request object that you can call 'execute()' on to request the next |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 515 | page. Returns None if there are no more items in the collection. |
| 516 | </pre> |
| 517 | </div> |
| 518 | |
| 519 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 520 | <code class="details" id="update">update(body=None, onBehalfOfContentOwner=None, x__xgafv=None)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 521 | <pre>Modifies a group. For example, you could change a group's title. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 522 | |
| 523 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 524 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 525 | The object takes the form of: |
| 526 | |
| 527 | { # A group. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 528 | "contentDetails": { # A group's content details. # The `contentDetails` object contains additional information about the |
| 529 | # group, such as the number and type of items that it contains. |
| 530 | "itemCount": "A String", # The number of items in the group. |
| 531 | "itemType": "A String", # The type of resources that the group contains. |
| 532 | # |
| 533 | # Valid values for this property are: |
| 534 | # * `youtube#channel` |
| 535 | # * `youtube#playlist` |
| 536 | # * `youtube#video` |
| 537 | # * `youtubePartner#asset` |
| 538 | }, |
| 539 | "snippet": { # A group snippet. # The `snippet` object contains basic information about the group, including |
| 540 | # its creation date and name. |
| 541 | "publishedAt": "A String", # The date and time that the group was created. The value is specified in |
| 542 | # ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. |
| 543 | "title": "A String", # The group name. The value must be a non-empty string. |
| 544 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 545 | "errors": { # Request Error information. # Apiary error details |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 546 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 547 | # The presence of an error field signals that the operation |
| 548 | # has failed. |
| 549 | "requestId": "A String", # Request identifier generated by the service, which can be |
| 550 | # used to identify the error in the logs |
| 551 | "error": [ # Specific error description and codes |
| 552 | { # Describes one specific error. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 553 | "argument": [ # Error arguments, to be used when building user-friendly error messages |
| 554 | # given the error domain and code. Different error codes require different |
| 555 | # arguments. |
| 556 | "A String", |
| 557 | ], |
| 558 | "code": "A String", # Error code in the error domain. This should correspond to |
| 559 | # a value of the enum type whose name is in domain. See |
| 560 | # the core error domain in error_domain.proto. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 561 | "location": "A String", # Location of the error, as specified by the location type. |
| 562 | # |
| 563 | # If location_type is PATH, this should be a path to a field that's |
| 564 | # relative to the request, using FieldPath notation |
| 565 | # (net/proto2/util/public/field_path.h). |
| 566 | # |
| 567 | # Examples: |
| 568 | # authenticated_user.gaia_id |
| 569 | # resource.address[2].country |
| 570 | "externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google. |
| 571 | # |
| 572 | # Please set domain, code and arguments whenever possible instead of this |
| 573 | # error message so that external APIs can build safe error messages |
| 574 | # themselves. |
| 575 | # |
| 576 | # External messages built in a RoSy interface will most likely refer to |
| 577 | # information and concepts that are not available externally and should not |
| 578 | # be exposed. It is safer if external APIs can understand the errors and |
| 579 | # decide what the error message should look like. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 580 | "locationType": "A String", |
| 581 | "debugInfo": "A String", # Debugging information, which should not be |
| 582 | # shared externally. |
| 583 | "domain": "A String", # Error domain. RoSy services can define their own |
| 584 | # domain and error codes. This should normally be |
| 585 | # the name of an enum type, such as: gdata.CoreErrorDomain |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 586 | }, |
| 587 | ], |
| 588 | "code": "A String", # Global error code. Deprecated and ignored. |
| 589 | # Set custom error codes in ErrorProto.domain and ErrorProto.code |
| 590 | # instead. |
| 591 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 592 | "etag": "A String", # The Etag of this resource. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 593 | "kind": "A String", # Identifies the API resource's type. The value will be `youtube#group`. |
| 594 | "id": "A String", # The ID that YouTube uses to uniquely identify the group. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 595 | } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 596 | |
| 597 | onBehalfOfContentOwner: string, This parameter can only be used in a properly authorized request. **Note:** |
| 598 | This parameter is intended exclusively for YouTube content partners that |
| 599 | own and manage many different YouTube channels. |
| 600 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 601 | The `onBehalfOfContentOwner` parameter indicates that the request's |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 602 | authorization credentials identify a YouTube user who is acting on behalf |
| 603 | of the content owner specified in the parameter value. It allows content |
| 604 | owners to authenticate once and get access to all their video and channel |
| 605 | data, without having to provide authentication credentials for each |
| 606 | individual channel. The account that the user authenticates with must be |
| 607 | linked to the specified YouTube content owner. |
| 608 | x__xgafv: string, V1 error format. |
| 609 | Allowed values |
| 610 | 1 - v1 error format |
| 611 | 2 - v2 error format |
| 612 | |
| 613 | Returns: |
| 614 | An object of the form: |
| 615 | |
| 616 | { # A group. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 617 | "contentDetails": { # A group's content details. # The `contentDetails` object contains additional information about the |
| 618 | # group, such as the number and type of items that it contains. |
| 619 | "itemCount": "A String", # The number of items in the group. |
| 620 | "itemType": "A String", # The type of resources that the group contains. |
| 621 | # |
| 622 | # Valid values for this property are: |
| 623 | # * `youtube#channel` |
| 624 | # * `youtube#playlist` |
| 625 | # * `youtube#video` |
| 626 | # * `youtubePartner#asset` |
| 627 | }, |
| 628 | "snippet": { # A group snippet. # The `snippet` object contains basic information about the group, including |
| 629 | # its creation date and name. |
| 630 | "publishedAt": "A String", # The date and time that the group was created. The value is specified in |
| 631 | # ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. |
| 632 | "title": "A String", # The group name. The value must be a non-empty string. |
| 633 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 634 | "errors": { # Request Error information. # Apiary error details |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 635 | # |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 636 | # The presence of an error field signals that the operation |
| 637 | # has failed. |
| 638 | "requestId": "A String", # Request identifier generated by the service, which can be |
| 639 | # used to identify the error in the logs |
| 640 | "error": [ # Specific error description and codes |
| 641 | { # Describes one specific error. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 642 | "argument": [ # Error arguments, to be used when building user-friendly error messages |
| 643 | # given the error domain and code. Different error codes require different |
| 644 | # arguments. |
| 645 | "A String", |
| 646 | ], |
| 647 | "code": "A String", # Error code in the error domain. This should correspond to |
| 648 | # a value of the enum type whose name is in domain. See |
| 649 | # the core error domain in error_domain.proto. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 650 | "location": "A String", # Location of the error, as specified by the location type. |
| 651 | # |
| 652 | # If location_type is PATH, this should be a path to a field that's |
| 653 | # relative to the request, using FieldPath notation |
| 654 | # (net/proto2/util/public/field_path.h). |
| 655 | # |
| 656 | # Examples: |
| 657 | # authenticated_user.gaia_id |
| 658 | # resource.address[2].country |
| 659 | "externalErrorMessage": "A String", # A short explanation for the error, which can be shared outside Google. |
| 660 | # |
| 661 | # Please set domain, code and arguments whenever possible instead of this |
| 662 | # error message so that external APIs can build safe error messages |
| 663 | # themselves. |
| 664 | # |
| 665 | # External messages built in a RoSy interface will most likely refer to |
| 666 | # information and concepts that are not available externally and should not |
| 667 | # be exposed. It is safer if external APIs can understand the errors and |
| 668 | # decide what the error message should look like. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 669 | "locationType": "A String", |
| 670 | "debugInfo": "A String", # Debugging information, which should not be |
| 671 | # shared externally. |
| 672 | "domain": "A String", # Error domain. RoSy services can define their own |
| 673 | # domain and error codes. This should normally be |
| 674 | # the name of an enum type, such as: gdata.CoreErrorDomain |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 675 | }, |
| 676 | ], |
| 677 | "code": "A String", # Global error code. Deprecated and ignored. |
| 678 | # Set custom error codes in ErrorProto.domain and ErrorProto.code |
| 679 | # instead. |
| 680 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 681 | "etag": "A String", # The Etag of this resource. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 682 | "kind": "A String", # Identifies the API resource's type. The value will be `youtube#group`. |
| 683 | "id": "A String", # The ID that YouTube uses to uniquely identify the group. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 684 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 685 | </div> |
| 686 | |
| 687 | </body></html> |