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