OLD | NEW |
(Empty) | |
| 1 { |
| 2 "auth": { |
| 3 "oauth2": { |
| 4 "scopes": { |
| 5 "https://www.googleapis.com/auth/yt-analytics-monetary.readonly"
: { |
| 6 "description": "View YouTube Analytics monetary reports for
your YouTube content" |
| 7 }, |
| 8 "https://www.googleapis.com/auth/yt-analytics.readonly": { |
| 9 "description": "View YouTube Analytics reports for your YouT
ube content" |
| 10 } |
| 11 } |
| 12 } |
| 13 }, |
| 14 "basePath": "/youtube/analytics/v1/", |
| 15 "baseUrl": "https://www.googleapis.com/youtube/analytics/v1/", |
| 16 "batchPath": "batch", |
| 17 "canonicalName": "YouTube Analytics", |
| 18 "description": "Retrieve your YouTube Analytics reports.", |
| 19 "discoveryVersion": "v1", |
| 20 "documentationLink": "http://developers.google.com/youtube/analytics/", |
| 21 "etag": "\"uUWyYHXmEn-ab7WLvo8qNz2S8ws/nlDKGR94Mbaj_YAIBNSZijmIvJQ\"", |
| 22 "icons": { |
| 23 "x16": "http://www.google.com/images/icons/product/youtube-16.png", |
| 24 "x32": "http://www.google.com/images/icons/product/youtube-32.png" |
| 25 }, |
| 26 "id": "youtubeAnalytics:v1", |
| 27 "kind": "discovery#restDescription", |
| 28 "name": "youtubeAnalytics", |
| 29 "ownerDomain": "google.com", |
| 30 "ownerName": "Google", |
| 31 "parameters": { |
| 32 "alt": { |
| 33 "default": "json", |
| 34 "description": "Data format for the response.", |
| 35 "enum": [ |
| 36 "csv", |
| 37 "json" |
| 38 ], |
| 39 "enumDescriptions": [ |
| 40 "Responses with Content-Type of text/csv", |
| 41 "Responses with Content-Type of application/json" |
| 42 ], |
| 43 "location": "query", |
| 44 "type": "string" |
| 45 }, |
| 46 "fields": { |
| 47 "description": "Selector specifying which fields to include in a par
tial response.", |
| 48 "location": "query", |
| 49 "type": "string" |
| 50 }, |
| 51 "key": { |
| 52 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
| 53 "location": "query", |
| 54 "type": "string" |
| 55 }, |
| 56 "oauth_token": { |
| 57 "description": "OAuth 2.0 token for the current user.", |
| 58 "location": "query", |
| 59 "type": "string" |
| 60 }, |
| 61 "prettyPrint": { |
| 62 "default": "true", |
| 63 "description": "Returns response with indentations and line breaks."
, |
| 64 "location": "query", |
| 65 "type": "boolean" |
| 66 }, |
| 67 "quotaUser": { |
| 68 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters. Overrides userIp if both are provided.", |
| 69 "location": "query", |
| 70 "type": "string" |
| 71 }, |
| 72 "userIp": { |
| 73 "description": "IP address of the site where the request originates.
Use this if you want to enforce per-user limits.", |
| 74 "location": "query", |
| 75 "type": "string" |
| 76 } |
| 77 }, |
| 78 "protocol": "rest", |
| 79 "resources": { |
| 80 "batchReportDefinitions": { |
| 81 "methods": { |
| 82 "list": { |
| 83 "description": "Retrieves a list of available batch report d
efinitions.", |
| 84 "httpMethod": "GET", |
| 85 "id": "youtubeAnalytics.batchReportDefinitions.list", |
| 86 "parameterOrder": [ |
| 87 "onBehalfOfContentOwner" |
| 88 ], |
| 89 "parameters": { |
| 90 "onBehalfOfContentOwner": { |
| 91 "description": "The onBehalfOfContentOwner parameter
identifies the content owner that the user is acting on behalf of.", |
| 92 "location": "query", |
| 93 "required": true, |
| 94 "type": "string" |
| 95 } |
| 96 }, |
| 97 "path": "batchReportDefinitions", |
| 98 "response": { |
| 99 "$ref": "BatchReportDefinitionList" |
| 100 }, |
| 101 "scopes": [ |
| 102 "https://www.googleapis.com/auth/yt-analytics-monetary.r
eadonly", |
| 103 "https://www.googleapis.com/auth/yt-analytics.readonly" |
| 104 ] |
| 105 } |
| 106 } |
| 107 }, |
| 108 "batchReports": { |
| 109 "methods": { |
| 110 "list": { |
| 111 "description": "Retrieves a list of processed batch reports.
", |
| 112 "httpMethod": "GET", |
| 113 "id": "youtubeAnalytics.batchReports.list", |
| 114 "parameterOrder": [ |
| 115 "batchReportDefinitionId", |
| 116 "onBehalfOfContentOwner" |
| 117 ], |
| 118 "parameters": { |
| 119 "batchReportDefinitionId": { |
| 120 "description": "The batchReportDefinitionId paramete
r specifies the ID of the batch reportort definition for which you are retrievin
g reports.", |
| 121 "location": "query", |
| 122 "required": true, |
| 123 "type": "string" |
| 124 }, |
| 125 "onBehalfOfContentOwner": { |
| 126 "description": "The onBehalfOfContentOwner parameter
identifies the content owner that the user is acting on behalf of.", |
| 127 "location": "query", |
| 128 "required": true, |
| 129 "type": "string" |
| 130 } |
| 131 }, |
| 132 "path": "batchReports", |
| 133 "response": { |
| 134 "$ref": "BatchReportList" |
| 135 }, |
| 136 "scopes": [ |
| 137 "https://www.googleapis.com/auth/yt-analytics-monetary.r
eadonly", |
| 138 "https://www.googleapis.com/auth/yt-analytics.readonly" |
| 139 ] |
| 140 } |
| 141 } |
| 142 }, |
| 143 "reports": { |
| 144 "methods": { |
| 145 "query": { |
| 146 "description": "Retrieve your YouTube Analytics reports.", |
| 147 "httpMethod": "GET", |
| 148 "id": "youtubeAnalytics.reports.query", |
| 149 "parameterOrder": [ |
| 150 "ids", |
| 151 "start-date", |
| 152 "end-date", |
| 153 "metrics" |
| 154 ], |
| 155 "parameters": { |
| 156 "dimensions": { |
| 157 "description": "A comma-separated list of YouTube An
alytics dimensions, such as views or ageGroup,gender. See the Available Reports
document for a list of the reports that you can retrieve and the dimensions used
for those reports. Also see the Dimensions document for definitions of those di
mensions.", |
| 158 "location": "query", |
| 159 "pattern": "[0-9a-zA-Z,]+", |
| 160 "type": "string" |
| 161 }, |
| 162 "end-date": { |
| 163 "description": "The end date for fetching YouTube An
alytics data. The value should be in YYYY-MM-DD format.", |
| 164 "location": "query", |
| 165 "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}", |
| 166 "required": true, |
| 167 "type": "string" |
| 168 }, |
| 169 "filters": { |
| 170 "description": "A list of filters that should be app
lied when retrieving YouTube Analytics data. The Available Reports document iden
tifies the dimensions that can be used to filter each report, and the Dimensions
document defines those dimensions. If a request uses multiple filters, join the
m together with a semicolon (;), and the returned result table will satisfy both
filters. For example, a filters parameter value of video==dMH0bHeiRNg;country==
IT restricts the result set to include data for the given video in Italy.", |
| 171 "location": "query", |
| 172 "type": "string" |
| 173 }, |
| 174 "ids": { |
| 175 "description": "Identifies the YouTube channel or co
ntent owner for which you are retrieving YouTube Analytics data.\n- To request d
ata for a YouTube user, set the ids parameter value to channel==CHANNEL_ID, wher
e CHANNEL_ID specifies the unique YouTube channel ID.\n- To request data for a Y
ouTube CMS content owner, set the ids parameter value to contentOwner==OWNER_NAM
E, where OWNER_NAME is the CMS name of the content owner.", |
| 176 "location": "query", |
| 177 "pattern": "[a-zA-Z]+==[a-zA-Z0-9_+-]+", |
| 178 "required": true, |
| 179 "type": "string" |
| 180 }, |
| 181 "max-results": { |
| 182 "description": "The maximum number of rows to includ
e in the response.", |
| 183 "format": "int32", |
| 184 "location": "query", |
| 185 "minimum": "1", |
| 186 "type": "integer" |
| 187 }, |
| 188 "metrics": { |
| 189 "description": "A comma-separated list of YouTube An
alytics metrics, such as views or likes,dislikes. See the Available Reports docu
ment for a list of the reports that you can retrieve and the metrics available i
n each report, and see the Metrics document for definitions of those metrics.", |
| 190 "location": "query", |
| 191 "pattern": "[0-9a-zA-Z,]+", |
| 192 "required": true, |
| 193 "type": "string" |
| 194 }, |
| 195 "sort": { |
| 196 "description": "A comma-separated list of dimensions
or metrics that determine the sort order for YouTube Analytics data. By default
the sort order is ascending. The '-' prefix causes descending sort order.", |
| 197 "location": "query", |
| 198 "pattern": "[-0-9a-zA-Z,]+", |
| 199 "type": "string" |
| 200 }, |
| 201 "start-date": { |
| 202 "description": "The start date for fetching YouTube
Analytics data. The value should be in YYYY-MM-DD format.", |
| 203 "location": "query", |
| 204 "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}", |
| 205 "required": true, |
| 206 "type": "string" |
| 207 }, |
| 208 "start-index": { |
| 209 "description": "An index of the first entity to retr
ieve. Use this parameter as a pagination mechanism along with the max-results pa
rameter (one-based, inclusive).", |
| 210 "format": "int32", |
| 211 "location": "query", |
| 212 "minimum": "1", |
| 213 "type": "integer" |
| 214 } |
| 215 }, |
| 216 "path": "reports", |
| 217 "response": { |
| 218 "$ref": "ResultTable" |
| 219 }, |
| 220 "scopes": [ |
| 221 "https://www.googleapis.com/auth/yt-analytics-monetary.r
eadonly", |
| 222 "https://www.googleapis.com/auth/yt-analytics.readonly" |
| 223 ] |
| 224 } |
| 225 } |
| 226 } |
| 227 }, |
| 228 "revision": "20140724", |
| 229 "rootUrl": "https://www.googleapis.com/", |
| 230 "schemas": { |
| 231 "BatchReportDefinitionList": { |
| 232 "description": "A paginated list of batchReportDefinition resources
returned in response to a youtubeAnalytics.batchReportDefinitions.list request."
, |
| 233 "id": "BatchReportDefinitionList", |
| 234 "properties": { |
| 235 "items": { |
| 236 "description": "A list of batchReportDefinition resources th
at match the request criteria.", |
| 237 "items": { |
| 238 "$ref": "BatchReportDefinitionTemplate" |
| 239 }, |
| 240 "type": "array" |
| 241 }, |
| 242 "kind": { |
| 243 "default": "youtubeAnalytics#batchReportDefinitionList", |
| 244 "description": "This value specifies the type of data includ
ed in the API response. For the list method, the kind property value is youtubeA
nalytics#batchReportDefinitionList.", |
| 245 "type": "string" |
| 246 } |
| 247 }, |
| 248 "type": "object" |
| 249 }, |
| 250 "BatchReportDefinitionTemplate": { |
| 251 "description": "Contains single batchReportDefinition resource.", |
| 252 "id": "BatchReportDefinitionTemplate", |
| 253 "properties": { |
| 254 "defaultOutput": { |
| 255 "description": "Default report definition's output.", |
| 256 "items": { |
| 257 "properties": { |
| 258 "format": { |
| 259 "description": "Format of the output.", |
| 260 "type": "string" |
| 261 }, |
| 262 "type": { |
| 263 "default": "cloudStorageOutput", |
| 264 "description": "Type of the output.", |
| 265 "type": "string" |
| 266 } |
| 267 }, |
| 268 "type": "object" |
| 269 }, |
| 270 "type": "array" |
| 271 }, |
| 272 "id": { |
| 273 "description": "The ID that YouTube assigns and uses to uniq
uely identify the report definition.", |
| 274 "type": "string" |
| 275 }, |
| 276 "name": { |
| 277 "description": "Name of the report definition.", |
| 278 "type": "string" |
| 279 }, |
| 280 "status": { |
| 281 "description": "Status of the report definition.", |
| 282 "type": "string" |
| 283 }, |
| 284 "type": { |
| 285 "description": "Type of the report definition.", |
| 286 "type": "string" |
| 287 } |
| 288 }, |
| 289 "type": "object" |
| 290 }, |
| 291 "BatchReportList": { |
| 292 "description": "A paginated list of batchReport resources returned i
n response to a youtubeAnalytics.batchReport.list request.", |
| 293 "id": "BatchReportList", |
| 294 "properties": { |
| 295 "items": { |
| 296 "description": "A list of batchReport resources that match t
he request criteria.", |
| 297 "items": { |
| 298 "$ref": "BatchReportTemplate" |
| 299 }, |
| 300 "type": "array" |
| 301 }, |
| 302 "kind": { |
| 303 "default": "youtubeAnalytics#batchReportList", |
| 304 "description": "This value specifies the type of data includ
ed in the API response. For the list method, the kind property value is youtubeA
nalytics#batchReportList.", |
| 305 "type": "string" |
| 306 } |
| 307 }, |
| 308 "type": "object" |
| 309 }, |
| 310 "BatchReportTemplate": { |
| 311 "description": "Contains single batchReport resource.", |
| 312 "id": "BatchReportTemplate", |
| 313 "properties": { |
| 314 "id": { |
| 315 "description": "The ID that YouTube assigns and uses to uniq
uely identify the report.", |
| 316 "type": "string" |
| 317 }, |
| 318 "outputs": { |
| 319 "description": "Report outputs.", |
| 320 "items": { |
| 321 "properties": { |
| 322 "downloadUrl": { |
| 323 "description": "Cloud storage URL to download th
is report. This URL is valid for 30 minutes.", |
| 324 "type": "string" |
| 325 }, |
| 326 "format": { |
| 327 "description": "Format of the output.", |
| 328 "type": "string" |
| 329 }, |
| 330 "type": { |
| 331 "default": "cloudStorageOutput", |
| 332 "description": "Type of the output.", |
| 333 "type": "string" |
| 334 } |
| 335 }, |
| 336 "type": "object" |
| 337 }, |
| 338 "type": "array" |
| 339 }, |
| 340 "report_id": { |
| 341 "description": "The ID of the the report definition.", |
| 342 "type": "string" |
| 343 }, |
| 344 "timeSpan": { |
| 345 "description": "Period included in the report. For reports c
ontaining all entities endTime is not set. Both startTime and endTime are inclus
ive.", |
| 346 "properties": { |
| 347 "endTime": { |
| 348 "description": "End of the period included in the re
port. Inclusive. For reports containing all entities endTime is not set.", |
| 349 "format": "date-time", |
| 350 "type": "string" |
| 351 }, |
| 352 "startTime": { |
| 353 "description": "Start of the period included in the
report. Inclusive.", |
| 354 "format": "date-time", |
| 355 "type": "string" |
| 356 } |
| 357 }, |
| 358 "type": "object" |
| 359 }, |
| 360 "timeUpdated": { |
| 361 "description": "The time when the report was updated.", |
| 362 "format": "date-time", |
| 363 "type": "string" |
| 364 } |
| 365 }, |
| 366 "type": "object" |
| 367 }, |
| 368 "ResultTable": { |
| 369 "description": "Contains a single result table. The table is returne
d as an array of rows that contain the values for the cells of the table. Depend
ing on the metric or dimension, the cell can contain a string (video ID, country
code) or a number (number of views or number of likes).", |
| 370 "id": "ResultTable", |
| 371 "properties": { |
| 372 "columnHeaders": { |
| 373 "description": "This value specifies information about the d
ata returned in the rows fields. Each item in the columnHeaders list identifies
a field returned in the rows value, which contains a list of comma-delimited dat
a. The columnHeaders list will begin with the dimensions specified in the API re
quest, which will be followed by the metrics specified in the API request. The o
rder of both dimensions and metrics will match the ordering in the API request.
For example, if the API request contains the parameters dimensions=ageGroup,gend
er&metrics=viewerPercentage, the API response will return columns in this order:
ageGroup,gender,viewerPercentage.", |
| 374 "items": { |
| 375 "properties": { |
| 376 "columnType": { |
| 377 "description": "The type of the column (DIMENSIO
N or METRIC).", |
| 378 "type": "string" |
| 379 }, |
| 380 "dataType": { |
| 381 "description": "The type of the data in the colu
mn (STRING, INTEGER, FLOAT, etc.).", |
| 382 "type": "string" |
| 383 }, |
| 384 "name": { |
| 385 "description": "The name of the dimension or met
ric.", |
| 386 "type": "string" |
| 387 } |
| 388 }, |
| 389 "type": "object" |
| 390 }, |
| 391 "type": "array" |
| 392 }, |
| 393 "kind": { |
| 394 "default": "youtubeAnalytics#resultTable", |
| 395 "description": "This value specifies the type of data includ
ed in the API response. For the query method, the kind property value will be yo
utubeAnalytics#resultTable.", |
| 396 "type": "string" |
| 397 }, |
| 398 "rows": { |
| 399 "description": "The list contains all rows of the result tab
le. Each item in the list is an array that contains comma-delimited data corresp
onding to a single row of data. The order of the comma-delimited data fields wil
l match the order of the columns listed in the columnHeaders field. If no data i
s available for the given query, the rows element will be omitted from the respo
nse. The response for a query with the day dimension will not contain rows for t
he most recent days.", |
| 400 "items": { |
| 401 "items": { |
| 402 "type": "any" |
| 403 }, |
| 404 "type": "array" |
| 405 }, |
| 406 "type": "array" |
| 407 } |
| 408 }, |
| 409 "type": "object" |
| 410 } |
| 411 }, |
| 412 "servicePath": "youtube/analytics/v1/", |
| 413 "title": "YouTube Analytics API", |
| 414 "version": "v1" |
| 415 } |
OLD | NEW |