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"> |
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"> |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 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">Removes an item from 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 item.</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, groupId=None, x__xgafv=None)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 88 | <p class="firstline">Returns a collection of group items that match the API request parameters.</p> |
| 89 | <h3>Method Details</h3> |
| 90 | <div class="method"> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 91 | <code class="details" id="close">close()</code> |
| 92 | <pre>Close httplib2 connections.</pre> |
| 93 | </div> |
| 94 | |
| 95 | <div class="method"> |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 96 | <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] | 97 | <pre>Removes an item from a group. |
| 98 | |
| 99 | Args: |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 100 | id: string, The `id` parameter specifies the YouTube group item ID of the group item that is being deleted. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 101 | onBehalfOfContentOwner: string, This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 102 | x__xgafv: string, V1 error format. |
| 103 | Allowed values |
| 104 | 1 - v1 error format |
| 105 | 2 - v2 error format |
| 106 | |
| 107 | Returns: |
| 108 | An object of the form: |
| 109 | |
| 110 | { # Empty response. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 111 | "errors": { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details |
| 112 | "code": "A String", # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 113 | "requestId": "A String", # Request identifier generated by the service, which can be used to identify the error in the logs |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 114 | "error": [ # Specific error description and codes |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 115 | { # Describes one specific error. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 116 | "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] | 117 | "A String", |
| 118 | ], |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 119 | "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. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 120 | "debugInfo": "A String", # Debugging information, which should not be shared externally. |
| 121 | "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. |
| 122 | "location": "A String", # Location of the error, as specified by the location type. If location_type is PATH, this should be a path to a field that's relative to the request, using FieldPath notation (net/proto2/util/public/field_path.h). Examples: authenticated_user.gaia_id resource.address[2].country |
| 123 | "locationType": "A String", |
| 124 | "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 |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 125 | }, |
| 126 | ], |
| 127 | }, |
| 128 | }</pre> |
| 129 | </div> |
| 130 | |
| 131 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 132 | <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] | 133 | <pre>Creates a group item. |
| 134 | |
| 135 | Args: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 136 | body: object, The request body. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 137 | The object takes the form of: |
| 138 | |
| 139 | { # A group item. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 140 | "id": "A String", # The ID that YouTube uses to uniquely identify the `channel`, `video`, `playlist`, or `asset` resource that is included in the group. Note that this ID refers specifically to the inclusion of that resource in a particular group and is different than the channel ID, video ID, playlist ID, or asset ID that uniquely identifies the resource itself. The `resource.id` property's value specifies the unique channel, video, playlist, or asset ID. |
| 141 | "kind": "A String", # Identifies the API resource's type. The value will be `youtube#groupItem`. |
| 142 | "resource": { # The `resource` object contains information that identifies the item being added to the group. |
| 143 | "kind": "A String", # Identifies the type of resource being added to the group. Valid values for this property are: * `youtube#channel` * `youtube#playlist` * `youtube#video` * `youtubePartner#asset` |
| 144 | "id": "A String", # The channel, video, playlist, or asset ID that YouTube uses to uniquely identify the item that is being added to the group. |
| 145 | }, |
| 146 | "groupId": "A String", # The ID that YouTube uses to uniquely identify the group that contains the item. |
| 147 | "errors": { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details |
| 148 | "code": "A String", # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead. |
| 149 | "requestId": "A String", # Request identifier generated by the service, which can be used to identify the error in the logs |
| 150 | "error": [ # Specific error description and codes |
| 151 | { # Describes one specific error. |
| 152 | "argument": [ # Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments. |
| 153 | "A String", |
| 154 | ], |
| 155 | "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. |
| 156 | "debugInfo": "A String", # Debugging information, which should not be shared externally. |
| 157 | "code": "A String", # Error code in the error domain. This should correspond to a value of the enum type whose name is in domain. See the core error domain in error_domain.proto. |
| 158 | "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 |
| 159 | "locationType": "A String", |
| 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 | }, |
| 162 | ], |
| 163 | }, |
| 164 | "etag": "A String", # The Etag of this resource. |
| 165 | } |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 166 | |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 167 | onBehalfOfContentOwner: string, This parameter can only be used in a properly authorized request. **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The `onBehalfOfContentOwner` parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 168 | x__xgafv: string, V1 error format. |
| 169 | Allowed values |
| 170 | 1 - v1 error format |
| 171 | 2 - v2 error format |
| 172 | |
| 173 | Returns: |
| 174 | An object of the form: |
| 175 | |
| 176 | { # A group item. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 177 | "id": "A String", # The ID that YouTube uses to uniquely identify the `channel`, `video`, `playlist`, or `asset` resource that is included in the group. Note that this ID refers specifically to the inclusion of that resource in a particular group and is different than the channel ID, video ID, playlist ID, or asset ID that uniquely identifies the resource itself. The `resource.id` property's value specifies the unique channel, video, playlist, or asset ID. |
| 178 | "kind": "A String", # Identifies the API resource's type. The value will be `youtube#groupItem`. |
| 179 | "resource": { # The `resource` object contains information that identifies the item being added to the group. |
| 180 | "kind": "A String", # Identifies the type of resource being added to the group. Valid values for this property are: * `youtube#channel` * `youtube#playlist` * `youtube#video` * `youtubePartner#asset` |
| 181 | "id": "A String", # The channel, video, playlist, or asset ID that YouTube uses to uniquely identify the item that is being added to the group. |
| 182 | }, |
| 183 | "groupId": "A String", # The ID that YouTube uses to uniquely identify the group that contains the item. |
| 184 | "errors": { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details |
| 185 | "code": "A String", # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead. |
| 186 | "requestId": "A String", # Request identifier generated by the service, which can be used to identify the error in the logs |
| 187 | "error": [ # Specific error description and codes |
| 188 | { # Describes one specific error. |
| 189 | "argument": [ # Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments. |
| 190 | "A String", |
| 191 | ], |
| 192 | "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. |
| 193 | "debugInfo": "A String", # Debugging information, which should not be shared externally. |
| 194 | "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. |
| 195 | "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 |
| 196 | "locationType": "A String", |
| 197 | "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 |
| 198 | }, |
| 199 | ], |
| 200 | }, |
| 201 | "etag": "A String", # The Etag of this resource. |
| 202 | }</pre> |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 203 | </div> |
| 204 | |
| 205 | <div class="method"> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 206 | <code class="details" id="list">list(onBehalfOfContentOwner=None, groupId=None, x__xgafv=None)</code> |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 207 | <pre>Returns a collection of group items that match the API request parameters. |
| 208 | |
| 209 | Args: |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 210 | 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. |
| 211 | groupId: string, The `groupId` parameter specifies the unique ID of the group for which you want to retrieve group items. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 212 | x__xgafv: string, V1 error format. |
| 213 | Allowed values |
| 214 | 1 - v1 error format |
| 215 | 2 - v2 error format |
| 216 | |
| 217 | Returns: |
| 218 | An object of the form: |
| 219 | |
| 220 | { # Response message for GroupsService.ListGroupItems. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 221 | "items": [ # A list of groups that match the API request parameters. Each item in the list represents a `groupItem` resource. |
| 222 | { # A group item. |
| 223 | "id": "A String", # The ID that YouTube uses to uniquely identify the `channel`, `video`, `playlist`, or `asset` resource that is included in the group. Note that this ID refers specifically to the inclusion of that resource in a particular group and is different than the channel ID, video ID, playlist ID, or asset ID that uniquely identifies the resource itself. The `resource.id` property's value specifies the unique channel, video, playlist, or asset ID. |
| 224 | "kind": "A String", # Identifies the API resource's type. The value will be `youtube#groupItem`. |
| 225 | "resource": { # The `resource` object contains information that identifies the item being added to the group. |
| 226 | "kind": "A String", # Identifies the type of resource being added to the group. Valid values for this property are: * `youtube#channel` * `youtube#playlist` * `youtube#video` * `youtubePartner#asset` |
| 227 | "id": "A String", # The channel, video, playlist, or asset ID that YouTube uses to uniquely identify the item that is being added to the group. |
| 228 | }, |
| 229 | "groupId": "A String", # The ID that YouTube uses to uniquely identify the group that contains the item. |
| 230 | "errors": { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details |
| 231 | "code": "A String", # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead. |
| 232 | "requestId": "A String", # Request identifier generated by the service, which can be used to identify the error in the logs |
| 233 | "error": [ # Specific error description and codes |
| 234 | { # Describes one specific error. |
| 235 | "argument": [ # Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments. |
| 236 | "A String", |
| 237 | ], |
| 238 | "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. |
| 239 | "debugInfo": "A String", # Debugging information, which should not be shared externally. |
| 240 | "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. |
| 241 | "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 |
| 242 | "locationType": "A String", |
| 243 | "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 |
| 244 | }, |
| 245 | ], |
| 246 | }, |
| 247 | "etag": "A String", # The Etag of this resource. |
| 248 | }, |
| 249 | ], |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 250 | "errors": { # Request Error information. The presence of an error field signals that the operation has failed. # Apiary error details |
| 251 | "code": "A String", # Global error code. Deprecated and ignored. Set custom error codes in ErrorProto.domain and ErrorProto.code instead. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 252 | "requestId": "A String", # Request identifier generated by the service, which can be used to identify the error in the logs |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 253 | "error": [ # Specific error description and codes |
| 254 | { # Describes one specific error. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 255 | "argument": [ # Error arguments, to be used when building user-friendly error messages given the error domain and code. Different error codes require different arguments. |
| 256 | "A String", |
| 257 | ], |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 258 | "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. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 259 | "debugInfo": "A String", # Debugging information, which should not be shared externally. |
| 260 | "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. |
| 261 | "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 |
| 262 | "locationType": "A String", |
| 263 | "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 |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 264 | }, |
| 265 | ], |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 266 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 267 | "etag": "A String", # The Etag of this resource. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 268 | "kind": "A String", # Identifies the API resource's type. The value will be `youtube#groupItemListResponse`. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 269 | }</pre> |
| 270 | </div> |
| 271 | |
| 272 | </body></html> |