| 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"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 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> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 82 | <p class="firstline">Deletes a group.</p> |
| 83 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 84 | <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] | 85 | <p class="firstline">Creates a group.</p> |
| 86 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 87 | <code><a href="#list">list(onBehalfOfContentOwner=None, pageToken=None, mine=None, id=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> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 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"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 93 | <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] | 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"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 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> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 103 | <pre>Deletes a group. |
| 104 | |
| 105 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 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. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 108 | x__xgafv: string, V1 error format. |
| 109 | Allowed values |
| 110 | 1 - v1 error format |
| 111 | 2 - v2 error format |
| 112 | |
| 113 | Returns: |
| 114 | An object of the form: |
| 115 | |
| 116 | { # Empty response. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 119 | "error": [ # Specific error description and codes |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 120 | { # Describes one specific error. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 121 | "locationType": "A String", |
| 122 | "debugInfo": "A String", # Debugging information, which should not be shared externally. |
| 123 | "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. |
| 124 | "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 |
| 125 | "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. |
| 126 | "argument": [ # Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 127 | "A String", |
| 128 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 129 | "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 |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 130 | }, |
| 131 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 132 | "requestId": "A String", # Request identifier generated by the service, which can be used to identify the error in the logs |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 133 | }, |
| 134 | }</pre> |
| 135 | </div> |
| 136 | |
| 137 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 138 | <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] | 139 | <pre>Creates a group. |
| 140 | |
| 141 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 142 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 143 | The object takes the form of: |
| 144 | |
| 145 | { # A group. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 146 | "snippet": { # A group snippet. # The `snippet` object contains basic information about the group, including its creation date and name. |
| 147 | "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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 148 | "title": "A String", # The group name. The value must be a non-empty string. |
| 149 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 150 | "id": "A String", # The ID that YouTube uses to uniquely identify the group. |
| 151 | "kind": "A String", # Identifies the API resource's type. The value will be `youtube#group`. |
| 152 | "etag": "A String", # The Etag of this resource. |
| 153 | "errors": { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details |
| 154 | "code": "A String", # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 155 | "error": [ # Specific error description and codes |
| 156 | { # Describes one specific error. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 157 | "locationType": "A String", |
| 158 | "debugInfo": "A String", # Debugging information, which should not be shared externally. |
| 159 | "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. |
| 160 | "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 |
| 161 | "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. |
| 162 | "argument": [ # Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 163 | "A String", |
| 164 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 165 | "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 |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 166 | }, |
| 167 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 168 | "requestId": "A String", # Request identifier generated by the service, which can be used to identify the error in the logs |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 169 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 170 | "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. |
| 171 | "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` |
| 172 | "itemCount": "A String", # The number of items in the group. |
| 173 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 174 | } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 175 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 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. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 177 | x__xgafv: string, V1 error format. |
| 178 | Allowed values |
| 179 | 1 - v1 error format |
| 180 | 2 - v2 error format |
| 181 | |
| 182 | Returns: |
| 183 | An object of the form: |
| 184 | |
| 185 | { # A group. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 186 | "snippet": { # A group snippet. # The `snippet` object contains basic information about the group, including its creation date and name. |
| 187 | "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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 188 | "title": "A String", # The group name. The value must be a non-empty string. |
| 189 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 190 | "id": "A String", # The ID that YouTube uses to uniquely identify the group. |
| 191 | "kind": "A String", # Identifies the API resource's type. The value will be `youtube#group`. |
| 192 | "etag": "A String", # The Etag of this resource. |
| 193 | "errors": { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details |
| 194 | "code": "A String", # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 195 | "error": [ # Specific error description and codes |
| 196 | { # Describes one specific error. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 197 | "locationType": "A String", |
| 198 | "debugInfo": "A String", # Debugging information, which should not be shared externally. |
| 199 | "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. |
| 200 | "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 |
| 201 | "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. |
| 202 | "argument": [ # Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 203 | "A String", |
| 204 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 205 | "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 |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 206 | }, |
| 207 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 208 | "requestId": "A String", # Request identifier generated by the service, which can be used to identify the error in the logs |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 209 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 210 | "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. |
| 211 | "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` |
| 212 | "itemCount": "A String", # The number of items in the group. |
| 213 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 214 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 215 | </div> |
| 216 | |
| 217 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 218 | <code class="details" id="list">list(onBehalfOfContentOwner=None, pageToken=None, mine=None, id=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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 220 | |
| 221 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 222 | 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. |
| 223 | 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. |
| 224 | 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. |
| 225 | 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`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 226 | x__xgafv: string, V1 error format. |
| 227 | Allowed values |
| 228 | 1 - v1 error format |
| 229 | 2 - v2 error format |
| 230 | |
| 231 | Returns: |
| 232 | An object of the form: |
| 233 | |
| 234 | { # Response message for GroupsService.ListGroups. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 237 | "error": [ # Specific error description and codes |
| 238 | { # Describes one specific error. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 239 | "locationType": "A String", |
| 240 | "debugInfo": "A String", # Debugging information, which should not be shared externally. |
| 241 | "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. |
| 242 | "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 |
| 243 | "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. |
| 244 | "argument": [ # Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 245 | "A String", |
| 246 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 247 | "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 |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 248 | }, |
| 249 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 250 | "requestId": "A String", # Request identifier generated by the service, which can be used to identify the error in the logs |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 251 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 252 | "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. |
| 253 | "items": [ # A list of groups that match the API request parameters. Each item in the list represents a `group` resource. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 254 | { # A group. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 255 | "snippet": { # A group snippet. # The `snippet` object contains basic information about the group, including its creation date and name. |
| 256 | "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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 257 | "title": "A String", # The group name. The value must be a non-empty string. |
| 258 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 259 | "id": "A String", # The ID that YouTube uses to uniquely identify the group. |
| 260 | "kind": "A String", # Identifies the API resource's type. The value will be `youtube#group`. |
| 261 | "etag": "A String", # The Etag of this resource. |
| 262 | "errors": { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details |
| 263 | "code": "A String", # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 264 | "error": [ # Specific error description and codes |
| 265 | { # Describes one specific error. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 266 | "locationType": "A String", |
| 267 | "debugInfo": "A String", # Debugging information, which should not be shared externally. |
| 268 | "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. |
| 269 | "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 |
| 270 | "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. |
| 271 | "argument": [ # Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 272 | "A String", |
| 273 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 274 | "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 |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 275 | }, |
| 276 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 277 | "requestId": "A String", # Request identifier generated by the service, which can be used to identify the error in the logs |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 278 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 279 | "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. |
| 280 | "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` |
| 281 | "itemCount": "A String", # The number of items in the group. |
| 282 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 283 | }, |
| 284 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 285 | "etag": "A String", # The Etag of this resource. |
| 286 | "kind": "A String", # Identifies the API resource's type. The value will be `youtube#groupListResponse`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 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 | |
| 294 | Args: |
| 295 | previous_request: The request for the previous page. (required) |
| 296 | previous_response: The response from the request for the previous page. (required) |
| 297 | |
| 298 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 299 | 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] | 300 | page. Returns None if there are no more items in the collection. |
| 301 | </pre> |
| 302 | </div> |
| 303 | |
| 304 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 305 | <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] | 306 | <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] | 307 | |
| 308 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 309 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 310 | The object takes the form of: |
| 311 | |
| 312 | { # A group. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 313 | "snippet": { # A group snippet. # The `snippet` object contains basic information about the group, including its creation date and name. |
| 314 | "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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 315 | "title": "A String", # The group name. The value must be a non-empty string. |
| 316 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 317 | "id": "A String", # The ID that YouTube uses to uniquely identify the group. |
| 318 | "kind": "A String", # Identifies the API resource's type. The value will be `youtube#group`. |
| 319 | "etag": "A String", # The Etag of this resource. |
| 320 | "errors": { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details |
| 321 | "code": "A String", # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 322 | "error": [ # Specific error description and codes |
| 323 | { # Describes one specific error. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 324 | "locationType": "A String", |
| 325 | "debugInfo": "A String", # Debugging information, which should not be shared externally. |
| 326 | "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. |
| 327 | "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 |
| 328 | "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. |
| 329 | "argument": [ # Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 330 | "A String", |
| 331 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 332 | "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 |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 333 | }, |
| 334 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 335 | "requestId": "A String", # Request identifier generated by the service, which can be used to identify the error in the logs |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 336 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 337 | "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. |
| 338 | "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` |
| 339 | "itemCount": "A String", # The number of items in the group. |
| 340 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 341 | } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 342 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 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. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 344 | x__xgafv: string, V1 error format. |
| 345 | Allowed values |
| 346 | 1 - v1 error format |
| 347 | 2 - v2 error format |
| 348 | |
| 349 | Returns: |
| 350 | An object of the form: |
| 351 | |
| 352 | { # A group. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 353 | "snippet": { # A group snippet. # The `snippet` object contains basic information about the group, including its creation date and name. |
| 354 | "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. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 355 | "title": "A String", # The group name. The value must be a non-empty string. |
| 356 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 357 | "id": "A String", # The ID that YouTube uses to uniquely identify the group. |
| 358 | "kind": "A String", # Identifies the API resource's type. The value will be `youtube#group`. |
| 359 | "etag": "A String", # The Etag of this resource. |
| 360 | "errors": { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details |
| 361 | "code": "A String", # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 362 | "error": [ # Specific error description and codes |
| 363 | { # Describes one specific error. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 364 | "locationType": "A String", |
| 365 | "debugInfo": "A String", # Debugging information, which should not be shared externally. |
| 366 | "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. |
| 367 | "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 |
| 368 | "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. |
| 369 | "argument": [ # Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 370 | "A String", |
| 371 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 372 | "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 |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 373 | }, |
| 374 | ], |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 375 | "requestId": "A String", # Request identifier generated by the service, which can be used to identify the error in the logs |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 376 | }, |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame^] | 377 | "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. |
| 378 | "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` |
| 379 | "itemCount": "A String", # The number of items in the group. |
| 380 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 381 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 382 | </div> |
| 383 | |
| 384 | </body></html> |