OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
5 "https://www.googleapis.com/auth/yt-analytics.readonly": { | 5 "https://www.googleapis.com/auth/yt-analytics.readonly": { |
6 "description": "View YouTube Analytics reports for your YouT
ube content" | 6 "description": "View YouTube Analytics reports for your YouT
ube content" |
7 }, | 7 }, |
8 "https://www.googleapis.com/auth/yt-analytics-monetary.readonly"
: { | 8 "https://www.googleapis.com/auth/yt-analytics-monetary.readonly"
: { |
9 "description": "View monetary and non-monetary YouTube Analy
tics reports for your YouTube content" | 9 "description": "View monetary and non-monetary YouTube Analy
tics reports for your YouTube content" |
10 } | 10 } |
(...skipping 10 matching lines...) Expand all Loading... |
21 "icons": { | 21 "icons": { |
22 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 22 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
23 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 23 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
24 }, | 24 }, |
25 "id": "youtubereporting:v1", | 25 "id": "youtubereporting:v1", |
26 "kind": "discovery#restDescription", | 26 "kind": "discovery#restDescription", |
27 "name": "youtubereporting", | 27 "name": "youtubereporting", |
28 "ownerDomain": "google.com", | 28 "ownerDomain": "google.com", |
29 "ownerName": "Google", | 29 "ownerName": "Google", |
30 "parameters": { | 30 "parameters": { |
31 "access_token": { | 31 "pp": { |
32 "description": "OAuth access token.", | 32 "default": "true", |
| 33 "description": "Pretty-print response.", |
| 34 "location": "query", |
| 35 "type": "boolean" |
| 36 }, |
| 37 "oauth_token": { |
| 38 "description": "OAuth 2.0 token for the current user.", |
| 39 "location": "query", |
| 40 "type": "string" |
| 41 }, |
| 42 "bearer_token": { |
| 43 "description": "OAuth bearer token.", |
| 44 "location": "query", |
| 45 "type": "string" |
| 46 }, |
| 47 "upload_protocol": { |
| 48 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
33 "location": "query", | 49 "location": "query", |
34 "type": "string" | 50 "type": "string" |
35 }, | 51 }, |
36 "prettyPrint": { | 52 "prettyPrint": { |
37 "default": "true", | 53 "default": "true", |
38 "description": "Returns response with indentations and line breaks."
, | 54 "description": "Returns response with indentations and line breaks."
, |
39 "location": "query", | 55 "location": "query", |
40 "type": "boolean" | 56 "type": "boolean" |
41 }, | 57 }, |
42 "key": { | 58 "uploadType": { |
43 "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.", | 59 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
44 "location": "query", | 60 "location": "query", |
45 "type": "string" | 61 "type": "string" |
46 }, | 62 }, |
47 "quotaUser": { | |
48 "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.", | |
49 "location": "query", | |
50 "type": "string" | |
51 }, | |
52 "pp": { | |
53 "default": "true", | |
54 "description": "Pretty-print response.", | |
55 "location": "query", | |
56 "type": "boolean" | |
57 }, | |
58 "fields": { | 63 "fields": { |
59 "description": "Selector specifying which fields to include in a par
tial response.", | 64 "description": "Selector specifying which fields to include in a par
tial response.", |
60 "location": "query", | 65 "location": "query", |
61 "type": "string" | 66 "type": "string" |
62 }, | 67 }, |
63 "alt": { | |
64 "default": "json", | |
65 "description": "Data format for response.", | |
66 "enum": [ | |
67 "json", | |
68 "media", | |
69 "proto" | |
70 ], | |
71 "enumDescriptions": [ | |
72 "Responses with Content-Type of application/json", | |
73 "Media download with context-dependent Content-Type", | |
74 "Responses with Content-Type of application/x-protobuf" | |
75 ], | |
76 "location": "query", | |
77 "type": "string" | |
78 }, | |
79 "$.xgafv": { | 68 "$.xgafv": { |
80 "description": "V1 error format.", | 69 "description": "V1 error format.", |
81 "enum": [ | 70 "enum": [ |
82 "1", | 71 "1", |
83 "2" | 72 "2" |
84 ], | 73 ], |
85 "enumDescriptions": [ | 74 "enumDescriptions": [ |
86 "v1 error format", | 75 "v1 error format", |
87 "v2 error format" | 76 "v2 error format" |
88 ], | 77 ], |
89 "location": "query", | 78 "location": "query", |
90 "type": "string" | 79 "type": "string" |
91 }, | 80 }, |
92 "callback": { | 81 "callback": { |
93 "description": "JSONP", | 82 "description": "JSONP", |
94 "location": "query", | 83 "location": "query", |
95 "type": "string" | 84 "type": "string" |
96 }, | 85 }, |
97 "oauth_token": { | 86 "alt": { |
98 "description": "OAuth 2.0 token for the current user.", | 87 "default": "json", |
| 88 "description": "Data format for response.", |
| 89 "enum": [ |
| 90 "json", |
| 91 "media", |
| 92 "proto" |
| 93 ], |
| 94 "enumDescriptions": [ |
| 95 "Responses with Content-Type of application/json", |
| 96 "Media download with context-dependent Content-Type", |
| 97 "Responses with Content-Type of application/x-protobuf" |
| 98 ], |
99 "location": "query", | 99 "location": "query", |
100 "type": "string" | 100 "type": "string" |
101 }, | 101 }, |
102 "uploadType": { | 102 "access_token": { |
103 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 103 "description": "OAuth access token.", |
104 "location": "query", | 104 "location": "query", |
105 "type": "string" | 105 "type": "string" |
106 }, | 106 }, |
107 "bearer_token": { | 107 "key": { |
108 "description": "OAuth bearer token.", | 108 "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.", |
109 "location": "query", | 109 "location": "query", |
110 "type": "string" | 110 "type": "string" |
111 }, | 111 }, |
112 "upload_protocol": { | 112 "quotaUser": { |
113 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 113 "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.", |
114 "location": "query", | 114 "location": "query", |
115 "type": "string" | 115 "type": "string" |
116 } | 116 } |
117 }, | 117 }, |
118 "protocol": "rest", | 118 "protocol": "rest", |
119 "resources": { | 119 "resources": { |
120 "reportTypes": { | |
121 "methods": { | |
122 "list": { | |
123 "description": "Lists report types.", | |
124 "httpMethod": "GET", | |
125 "id": "youtubereporting.reportTypes.list", | |
126 "parameterOrder": [], | |
127 "parameters": { | |
128 "pageSize": { | |
129 "description": "Requested page size. Server may retu
rn fewer report types than requested.\nIf unspecified, server will pick an appro
priate default.", | |
130 "format": "int32", | |
131 "location": "query", | |
132 "type": "integer" | |
133 }, | |
134 "includeSystemManaged": { | |
135 "description": "If set to true, also system-managed
report types will be returned;\notherwise only the report types that can be used
to create new reporting\njobs will be returned.", | |
136 "location": "query", | |
137 "type": "boolean" | |
138 }, | |
139 "onBehalfOfContentOwner": { | |
140 "description": "The content owner's external ID on w
hich behalf the user is acting on. If\nnot set, the user is acting for himself (
his own channel).", | |
141 "location": "query", | |
142 "type": "string" | |
143 }, | |
144 "pageToken": { | |
145 "description": "A token identifying a page of result
s the server should return. Typically,\nthis is the value of\nListReportTypesRes
ponse.next_page_token\nreturned in response to the previous call to the `ListRep
ortTypes` method.", | |
146 "location": "query", | |
147 "type": "string" | |
148 } | |
149 }, | |
150 "path": "v1/reportTypes", | |
151 "response": { | |
152 "$ref": "ListReportTypesResponse" | |
153 }, | |
154 "scopes": [ | |
155 "https://www.googleapis.com/auth/yt-analytics-monetary.r
eadonly", | |
156 "https://www.googleapis.com/auth/yt-analytics.readonly" | |
157 ] | |
158 } | |
159 } | |
160 }, | |
161 "media": { | 120 "media": { |
162 "methods": { | 121 "methods": { |
163 "download": { | 122 "download": { |
164 "description": "Method for media download. Download is suppo
rted\non the URI `/v1/media/{+name}?alt=media`.", | 123 "description": "Method for media download. Download is suppo
rted\non the URI `/v1/media/{+name}?alt=media`.", |
165 "httpMethod": "GET", | 124 "httpMethod": "GET", |
166 "id": "youtubereporting.media.download", | 125 "id": "youtubereporting.media.download", |
167 "parameterOrder": [ | 126 "parameterOrder": [ |
168 "resourceName" | 127 "resourceName" |
169 ], | 128 ], |
170 "parameters": { | 129 "parameters": { |
(...skipping 12 matching lines...) Expand all Loading... |
183 "scopes": [ | 142 "scopes": [ |
184 "https://www.googleapis.com/auth/yt-analytics-monetary.r
eadonly", | 143 "https://www.googleapis.com/auth/yt-analytics-monetary.r
eadonly", |
185 "https://www.googleapis.com/auth/yt-analytics.readonly" | 144 "https://www.googleapis.com/auth/yt-analytics.readonly" |
186 ], | 145 ], |
187 "supportsMediaDownload": true | 146 "supportsMediaDownload": true |
188 } | 147 } |
189 } | 148 } |
190 }, | 149 }, |
191 "jobs": { | 150 "jobs": { |
192 "methods": { | 151 "methods": { |
193 "create": { | 152 "list": { |
194 "description": "Creates a job and returns it.", | 153 "description": "Lists jobs.", |
195 "httpMethod": "POST", | 154 "httpMethod": "GET", |
196 "id": "youtubereporting.jobs.create", | 155 "id": "youtubereporting.jobs.list", |
197 "parameterOrder": [], | 156 "parameterOrder": [], |
198 "parameters": { | 157 "parameters": { |
| 158 "pageSize": { |
| 159 "description": "Requested page size. Server may retu
rn fewer jobs than requested.\nIf unspecified, server will pick an appropriate d
efault.", |
| 160 "format": "int32", |
| 161 "location": "query", |
| 162 "type": "integer" |
| 163 }, |
199 "onBehalfOfContentOwner": { | 164 "onBehalfOfContentOwner": { |
200 "description": "The content owner's external ID on w
hich behalf the user is acting on. If\nnot set, the user is acting for himself (
his own channel).", | 165 "description": "The content owner's external ID on w
hich behalf the user is acting on. If\nnot set, the user is acting for himself (
his own channel).", |
201 "location": "query", | 166 "location": "query", |
202 "type": "string" | 167 "type": "string" |
| 168 }, |
| 169 "pageToken": { |
| 170 "description": "A token identifying a page of result
s the server should return. Typically,\nthis is the value of\nListReportTypesRes
ponse.next_page_token\nreturned in response to the previous call to the `ListJob
s` method.", |
| 171 "location": "query", |
| 172 "type": "string" |
| 173 }, |
| 174 "includeSystemManaged": { |
| 175 "description": "If set to true, also system-managed
jobs will be returned; otherwise only\nuser-created jobs will be returned. Syste
m-managed jobs can neither be\nmodified nor deleted.", |
| 176 "location": "query", |
| 177 "type": "boolean" |
203 } | 178 } |
204 }, | 179 }, |
205 "path": "v1/jobs", | 180 "path": "v1/jobs", |
206 "request": { | |
207 "$ref": "Job" | |
208 }, | |
209 "response": { | 181 "response": { |
210 "$ref": "Job" | 182 "$ref": "ListJobsResponse" |
211 }, | 183 }, |
212 "scopes": [ | 184 "scopes": [ |
213 "https://www.googleapis.com/auth/yt-analytics-monetary.r
eadonly", | 185 "https://www.googleapis.com/auth/yt-analytics-monetary.r
eadonly", |
214 "https://www.googleapis.com/auth/yt-analytics.readonly" | 186 "https://www.googleapis.com/auth/yt-analytics.readonly" |
215 ] | 187 ] |
216 }, | 188 }, |
217 "get": { | 189 "get": { |
218 "description": "Gets a job.", | 190 "description": "Gets a job.", |
219 "httpMethod": "GET", | 191 "httpMethod": "GET", |
220 "id": "youtubereporting.jobs.get", | 192 "id": "youtubereporting.jobs.get", |
(...skipping 15 matching lines...) Expand all Loading... |
236 }, | 208 }, |
237 "path": "v1/jobs/{jobId}", | 209 "path": "v1/jobs/{jobId}", |
238 "response": { | 210 "response": { |
239 "$ref": "Job" | 211 "$ref": "Job" |
240 }, | 212 }, |
241 "scopes": [ | 213 "scopes": [ |
242 "https://www.googleapis.com/auth/yt-analytics-monetary.r
eadonly", | 214 "https://www.googleapis.com/auth/yt-analytics-monetary.r
eadonly", |
243 "https://www.googleapis.com/auth/yt-analytics.readonly" | 215 "https://www.googleapis.com/auth/yt-analytics.readonly" |
244 ] | 216 ] |
245 }, | 217 }, |
246 "list": { | 218 "create": { |
247 "description": "Lists jobs.", | 219 "description": "Creates a job and returns it.", |
248 "httpMethod": "GET", | 220 "httpMethod": "POST", |
249 "id": "youtubereporting.jobs.list", | 221 "id": "youtubereporting.jobs.create", |
250 "parameterOrder": [], | 222 "parameterOrder": [], |
251 "parameters": { | 223 "parameters": { |
252 "pageSize": { | |
253 "description": "Requested page size. Server may retu
rn fewer jobs than requested.\nIf unspecified, server will pick an appropriate d
efault.", | |
254 "format": "int32", | |
255 "location": "query", | |
256 "type": "integer" | |
257 }, | |
258 "includeSystemManaged": { | |
259 "description": "If set to true, also system-managed
jobs will be returned; otherwise only\nuser-created jobs will be returned. Syste
m-managed jobs can neither be\nmodified nor deleted.", | |
260 "location": "query", | |
261 "type": "boolean" | |
262 }, | |
263 "onBehalfOfContentOwner": { | 224 "onBehalfOfContentOwner": { |
264 "description": "The content owner's external ID on w
hich behalf the user is acting on. If\nnot set, the user is acting for himself (
his own channel).", | 225 "description": "The content owner's external ID on w
hich behalf the user is acting on. If\nnot set, the user is acting for himself (
his own channel).", |
265 "location": "query", | 226 "location": "query", |
266 "type": "string" | 227 "type": "string" |
267 }, | |
268 "pageToken": { | |
269 "description": "A token identifying a page of result
s the server should return. Typically,\nthis is the value of\nListReportTypesRes
ponse.next_page_token\nreturned in response to the previous call to the `ListJob
s` method.", | |
270 "location": "query", | |
271 "type": "string" | |
272 } | 228 } |
273 }, | 229 }, |
274 "path": "v1/jobs", | 230 "path": "v1/jobs", |
| 231 "request": { |
| 232 "$ref": "Job" |
| 233 }, |
275 "response": { | 234 "response": { |
276 "$ref": "ListJobsResponse" | 235 "$ref": "Job" |
277 }, | 236 }, |
278 "scopes": [ | 237 "scopes": [ |
279 "https://www.googleapis.com/auth/yt-analytics-monetary.r
eadonly", | 238 "https://www.googleapis.com/auth/yt-analytics-monetary.r
eadonly", |
280 "https://www.googleapis.com/auth/yt-analytics.readonly" | 239 "https://www.googleapis.com/auth/yt-analytics.readonly" |
281 ] | 240 ] |
282 }, | 241 }, |
283 "delete": { | 242 "delete": { |
284 "description": "Deletes a job.", | 243 "description": "Deletes a job.", |
285 "httpMethod": "DELETE", | 244 "httpMethod": "DELETE", |
286 "id": "youtubereporting.jobs.delete", | 245 "id": "youtubereporting.jobs.delete", |
(...skipping 19 matching lines...) Expand all Loading... |
306 }, | 265 }, |
307 "scopes": [ | 266 "scopes": [ |
308 "https://www.googleapis.com/auth/yt-analytics-monetary.r
eadonly", | 267 "https://www.googleapis.com/auth/yt-analytics-monetary.r
eadonly", |
309 "https://www.googleapis.com/auth/yt-analytics.readonly" | 268 "https://www.googleapis.com/auth/yt-analytics.readonly" |
310 ] | 269 ] |
311 } | 270 } |
312 }, | 271 }, |
313 "resources": { | 272 "resources": { |
314 "reports": { | 273 "reports": { |
315 "methods": { | 274 "methods": { |
316 "get": { | |
317 "description": "Gets the metadata of a specific repo
rt.", | |
318 "httpMethod": "GET", | |
319 "id": "youtubereporting.jobs.reports.get", | |
320 "parameterOrder": [ | |
321 "jobId", | |
322 "reportId" | |
323 ], | |
324 "parameters": { | |
325 "jobId": { | |
326 "description": "The ID of the job.", | |
327 "location": "path", | |
328 "required": true, | |
329 "type": "string" | |
330 }, | |
331 "reportId": { | |
332 "description": "The ID of the report to retr
ieve.", | |
333 "location": "path", | |
334 "required": true, | |
335 "type": "string" | |
336 }, | |
337 "onBehalfOfContentOwner": { | |
338 "description": "The content owner's external
ID on which behalf the user is acting on. If\nnot set, the user is acting for h
imself (his own channel).", | |
339 "location": "query", | |
340 "type": "string" | |
341 } | |
342 }, | |
343 "path": "v1/jobs/{jobId}/reports/{reportId}", | |
344 "response": { | |
345 "$ref": "Report" | |
346 }, | |
347 "scopes": [ | |
348 "https://www.googleapis.com/auth/yt-analytics-mo
netary.readonly", | |
349 "https://www.googleapis.com/auth/yt-analytics.re
adonly" | |
350 ] | |
351 }, | |
352 "list": { | 275 "list": { |
353 "description": "Lists reports created by a specific
job.\nReturns NOT_FOUND if the job does not exist.", | 276 "description": "Lists reports created by a specific
job.\nReturns NOT_FOUND if the job does not exist.", |
354 "httpMethod": "GET", | 277 "httpMethod": "GET", |
355 "id": "youtubereporting.jobs.reports.list", | 278 "id": "youtubereporting.jobs.reports.list", |
356 "parameterOrder": [ | 279 "parameterOrder": [ |
357 "jobId" | 280 "jobId" |
358 ], | 281 ], |
359 "parameters": { | 282 "parameters": { |
360 "onBehalfOfContentOwner": { | 283 "startTimeBefore": { |
361 "description": "The content owner's external
ID on which behalf the user is acting on. If\nnot set, the user is acting for h
imself (his own channel).", | 284 "description": "If set, only reports whose s
tart time is smaller than the specified\ndate/time are returned.", |
| 285 "format": "google-datetime", |
362 "location": "query", | 286 "location": "query", |
363 "type": "string" | 287 "type": "string" |
364 }, | 288 }, |
| 289 "jobId": { |
| 290 "description": "The ID of the job.", |
| 291 "location": "path", |
| 292 "required": true, |
| 293 "type": "string" |
| 294 }, |
| 295 "createdAfter": { |
| 296 "description": "If set, only reports created
after the specified date/time are returned.", |
| 297 "format": "google-datetime", |
| 298 "location": "query", |
| 299 "type": "string" |
| 300 }, |
365 "startTimeAtOrAfter": { | 301 "startTimeAtOrAfter": { |
366 "description": "If set, only reports whose s
tart time is greater than or equal the\nspecified date/time are returned.", | 302 "description": "If set, only reports whose s
tart time is greater than or equal the\nspecified date/time are returned.", |
367 "format": "google-datetime", | 303 "format": "google-datetime", |
368 "location": "query", | 304 "location": "query", |
369 "type": "string" | 305 "type": "string" |
370 }, | 306 }, |
371 "startTimeBefore": { | 307 "pageToken": { |
372 "description": "If set, only reports whose s
tart time is smaller than the specified\ndate/time are returned.", | 308 "description": "A token identifying a page o
f results the server should return. Typically,\nthis is the value of\nListReport
sResponse.next_page_token\nreturned in response to the previous call to the `Lis
tReports` method.", |
373 "format": "google-datetime", | |
374 "location": "query", | 309 "location": "query", |
375 "type": "string" | 310 "type": "string" |
376 }, | 311 }, |
377 "pageSize": { | 312 "pageSize": { |
378 "description": "Requested page size. Server
may return fewer report types than requested.\nIf unspecified, server will pick
an appropriate default.", | 313 "description": "Requested page size. Server
may return fewer report types than requested.\nIf unspecified, server will pick
an appropriate default.", |
379 "format": "int32", | 314 "format": "int32", |
380 "location": "query", | 315 "location": "query", |
381 "type": "integer" | 316 "type": "integer" |
382 }, | 317 }, |
383 "createdAfter": { | 318 "onBehalfOfContentOwner": { |
384 "description": "If set, only reports created
after the specified date/time are returned.", | 319 "description": "The content owner's external
ID on which behalf the user is acting on. If\nnot set, the user is acting for h
imself (his own channel).", |
385 "format": "google-datetime", | |
386 "location": "query", | 320 "location": "query", |
387 "type": "string" | 321 "type": "string" |
| 322 } |
| 323 }, |
| 324 "path": "v1/jobs/{jobId}/reports", |
| 325 "response": { |
| 326 "$ref": "ListReportsResponse" |
| 327 }, |
| 328 "scopes": [ |
| 329 "https://www.googleapis.com/auth/yt-analytics-mo
netary.readonly", |
| 330 "https://www.googleapis.com/auth/yt-analytics.re
adonly" |
| 331 ] |
| 332 }, |
| 333 "get": { |
| 334 "description": "Gets the metadata of a specific repo
rt.", |
| 335 "httpMethod": "GET", |
| 336 "id": "youtubereporting.jobs.reports.get", |
| 337 "parameterOrder": [ |
| 338 "jobId", |
| 339 "reportId" |
| 340 ], |
| 341 "parameters": { |
| 342 "reportId": { |
| 343 "description": "The ID of the report to retr
ieve.", |
| 344 "location": "path", |
| 345 "required": true, |
| 346 "type": "string" |
388 }, | 347 }, |
389 "jobId": { | 348 "jobId": { |
390 "description": "The ID of the job.", | 349 "description": "The ID of the job.", |
391 "location": "path", | 350 "location": "path", |
392 "required": true, | 351 "required": true, |
393 "type": "string" | 352 "type": "string" |
394 }, | 353 }, |
395 "pageToken": { | 354 "onBehalfOfContentOwner": { |
396 "description": "A token identifying a page o
f results the server should return. Typically,\nthis is the value of\nListReport
sResponse.next_page_token\nreturned in response to the previous call to the `Lis
tReports` method.", | 355 "description": "The content owner's external
ID on which behalf the user is acting on. If\nnot set, the user is acting for h
imself (his own channel).", |
397 "location": "query", | 356 "location": "query", |
398 "type": "string" | 357 "type": "string" |
399 } | 358 } |
400 }, | 359 }, |
401 "path": "v1/jobs/{jobId}/reports", | 360 "path": "v1/jobs/{jobId}/reports/{reportId}", |
402 "response": { | 361 "response": { |
403 "$ref": "ListReportsResponse" | 362 "$ref": "Report" |
404 }, | 363 }, |
405 "scopes": [ | 364 "scopes": [ |
406 "https://www.googleapis.com/auth/yt-analytics-mo
netary.readonly", | 365 "https://www.googleapis.com/auth/yt-analytics-mo
netary.readonly", |
407 "https://www.googleapis.com/auth/yt-analytics.re
adonly" | 366 "https://www.googleapis.com/auth/yt-analytics.re
adonly" |
408 ] | 367 ] |
409 } | 368 } |
410 } | 369 } |
411 } | 370 } |
412 } | 371 } |
| 372 }, |
| 373 "reportTypes": { |
| 374 "methods": { |
| 375 "list": { |
| 376 "description": "Lists report types.", |
| 377 "httpMethod": "GET", |
| 378 "id": "youtubereporting.reportTypes.list", |
| 379 "parameterOrder": [], |
| 380 "parameters": { |
| 381 "pageToken": { |
| 382 "description": "A token identifying a page of result
s the server should return. Typically,\nthis is the value of\nListReportTypesRes
ponse.next_page_token\nreturned in response to the previous call to the `ListRep
ortTypes` method.", |
| 383 "location": "query", |
| 384 "type": "string" |
| 385 }, |
| 386 "includeSystemManaged": { |
| 387 "description": "If set to true, also system-managed
report types will be returned;\notherwise only the report types that can be used
to create new reporting\njobs will be returned.", |
| 388 "location": "query", |
| 389 "type": "boolean" |
| 390 }, |
| 391 "pageSize": { |
| 392 "description": "Requested page size. Server may retu
rn fewer report types than requested.\nIf unspecified, server will pick an appro
priate default.", |
| 393 "format": "int32", |
| 394 "location": "query", |
| 395 "type": "integer" |
| 396 }, |
| 397 "onBehalfOfContentOwner": { |
| 398 "description": "The content owner's external ID on w
hich behalf the user is acting on. If\nnot set, the user is acting for himself (
his own channel).", |
| 399 "location": "query", |
| 400 "type": "string" |
| 401 } |
| 402 }, |
| 403 "path": "v1/reportTypes", |
| 404 "response": { |
| 405 "$ref": "ListReportTypesResponse" |
| 406 }, |
| 407 "scopes": [ |
| 408 "https://www.googleapis.com/auth/yt-analytics-monetary.r
eadonly", |
| 409 "https://www.googleapis.com/auth/yt-analytics.readonly" |
| 410 ] |
| 411 } |
| 412 } |
413 } | 413 } |
414 }, | 414 }, |
415 "revision": "20170118", | 415 "revision": "20170209", |
416 "rootUrl": "https://youtubereporting.googleapis.com/", | 416 "rootUrl": "https://youtubereporting.googleapis.com/", |
417 "schemas": { | 417 "schemas": { |
418 "Report": { | 418 "Job": { |
419 "description": "A report's metadata including the URL from which the
report itself can be\ndownloaded.", | 419 "description": "A job creating reports of a specific type.", |
420 "id": "Report", | 420 "id": "Job", |
421 "properties": { | 421 "properties": { |
422 "id": { | 422 "createTime": { |
423 "description": "The server-generated ID of the report.", | 423 "description": "The creation date/time of the job.", |
424 "type": "string" | |
425 }, | |
426 "downloadUrl": { | |
427 "description": "The URL from which the report can be downloa
ded (max. 1000 characters).", | |
428 "type": "string" | |
429 }, | |
430 "endTime": { | |
431 "description": "The end of the time period that the report i
nstance covers. The value is\nexclusive.", | |
432 "format": "google-datetime", | 424 "format": "google-datetime", |
433 "type": "string" | 425 "type": "string" |
434 }, | 426 }, |
435 "createTime": { | 427 "expireTime": { |
436 "description": "The date/time when this report was created."
, | 428 "description": "The date/time when this job will expire/expi
red. After a job expired, no\nnew reports are generated.", |
437 "format": "google-datetime", | 429 "format": "google-datetime", |
438 "type": "string" | 430 "type": "string" |
439 }, | 431 }, |
440 "startTime": { | 432 "reportTypeId": { |
441 "description": "The start of the time period that the report
instance covers. The value is\ninclusive.", | 433 "description": "The type of reports this job creates. Corres
ponds to the ID of a\nReportType.", |
442 "format": "google-datetime", | |
443 "type": "string" | 434 "type": "string" |
444 }, | 435 }, |
445 "jobExpireTime": { | 436 "name": { |
446 "description": "The date/time when the job this report belon
gs to will expire/expired.", | 437 "description": "The name of the job (max. 100 characters).", |
447 "format": "google-datetime", | |
448 "type": "string" | 438 "type": "string" |
449 }, | 439 }, |
450 "jobId": { | 440 "systemManaged": { |
451 "description": "The ID of the job that created this report."
, | 441 "description": "True if this a system-managed job that canno
t be modified by the user;\notherwise false.", |
| 442 "type": "boolean" |
| 443 }, |
| 444 "id": { |
| 445 "description": "The server-generated ID of the job (max. 40
characters).", |
452 "type": "string" | 446 "type": "string" |
453 } | 447 } |
454 }, | 448 }, |
455 "type": "object" | 449 "type": "object" |
456 }, | 450 }, |
457 "ListJobsResponse": { | 451 "ListReportsResponse": { |
458 "description": "Response message for ReportingService.ListJobs.", | 452 "description": "Response message for ReportingService.ListReports.", |
459 "id": "ListJobsResponse", | 453 "id": "ListReportsResponse", |
460 "properties": { | 454 "properties": { |
461 "nextPageToken": { | 455 "nextPageToken": { |
462 "description": "A token to retrieve next page of results.\nP
ass this value in the\nListJobsRequest.page_token\nfield in the subsequent call
to `ListJobs` method to retrieve the next\npage of results.", | 456 "description": "A token to retrieve next page of results.\nP
ass this value in the\nListReportsRequest.page_token\nfield in the subsequent ca
ll to `ListReports` method to retrieve the next\npage of results.", |
463 "type": "string" | 457 "type": "string" |
464 }, | 458 }, |
465 "jobs": { | 459 "reports": { |
466 "description": "The list of jobs.", | 460 "description": "The list of report types.", |
467 "items": { | 461 "items": { |
468 "$ref": "Job" | 462 "$ref": "Report" |
469 }, | 463 }, |
470 "type": "array" | 464 "type": "array" |
471 } | 465 } |
472 }, | 466 }, |
473 "type": "object" | 467 "type": "object" |
474 }, | 468 }, |
475 "Media": { | 469 "Media": { |
476 "description": "Media resource.", | 470 "description": "Media resource.", |
477 "id": "Media", | 471 "id": "Media", |
478 "properties": { | 472 "properties": { |
479 "resourceName": { | 473 "resourceName": { |
480 "description": "Name of the media resource.", | 474 "description": "Name of the media resource.", |
481 "type": "string" | 475 "type": "string" |
482 } | 476 } |
483 }, | 477 }, |
484 "type": "object" | 478 "type": "object" |
485 }, | 479 }, |
486 "Job": { | 480 "Report": { |
487 "description": "A job creating reports of a specific type.", | 481 "description": "A report's metadata including the URL from which the
report itself can be\ndownloaded.", |
488 "id": "Job", | 482 "id": "Report", |
489 "properties": { | 483 "properties": { |
490 "id": { | 484 "jobExpireTime": { |
491 "description": "The server-generated ID of the job (max. 40
characters).", | 485 "description": "The date/time when the job this report belon
gs to will expire/expired.", |
| 486 "format": "google-datetime", |
| 487 "type": "string" |
| 488 }, |
| 489 "endTime": { |
| 490 "description": "The end of the time period that the report i
nstance covers. The value is\nexclusive.", |
| 491 "format": "google-datetime", |
| 492 "type": "string" |
| 493 }, |
| 494 "downloadUrl": { |
| 495 "description": "The URL from which the report can be downloa
ded (max. 1000 characters).", |
| 496 "type": "string" |
| 497 }, |
| 498 "startTime": { |
| 499 "description": "The start of the time period that the report
instance covers. The value is\ninclusive.", |
| 500 "format": "google-datetime", |
492 "type": "string" | 501 "type": "string" |
493 }, | 502 }, |
494 "createTime": { | 503 "createTime": { |
495 "description": "The creation date/time of the job.", | 504 "description": "The date/time when this report was created."
, |
496 "format": "google-datetime", | 505 "format": "google-datetime", |
497 "type": "string" | 506 "type": "string" |
498 }, | 507 }, |
499 "systemManaged": { | 508 "jobId": { |
500 "description": "True if this a system-managed job that canno
t be modified by the user;\notherwise false.", | 509 "description": "The ID of the job that created this report."
, |
501 "type": "boolean" | |
502 }, | |
503 "expireTime": { | |
504 "description": "The date/time when this job will expire/expi
red. After a job expired, no\nnew reports are generated.", | |
505 "format": "google-datetime", | |
506 "type": "string" | 510 "type": "string" |
507 }, | 511 }, |
508 "name": { | 512 "id": { |
509 "description": "The name of the job (max. 100 characters).", | 513 "description": "The server-generated ID of the report.", |
510 "type": "string" | |
511 }, | |
512 "reportTypeId": { | |
513 "description": "The type of reports this job creates. Corres
ponds to the ID of a\nReportType.", | |
514 "type": "string" | 514 "type": "string" |
515 } | 515 } |
516 }, | 516 }, |
517 "type": "object" | 517 "type": "object" |
518 }, | 518 }, |
519 "Empty": { | 519 "Empty": { |
520 "description": "A generic empty message that you can re-use to avoid
defining duplicated\nempty messages in your APIs. A typical example is to use i
t as the request\nor the response type of an API method. For instance:\n\n se
rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty
);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", | 520 "description": "A generic empty message that you can re-use to avoid
defining duplicated\nempty messages in your APIs. A typical example is to use i
t as the request\nor the response type of an API method. For instance:\n\n se
rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty
);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", |
521 "id": "Empty", | 521 "id": "Empty", |
522 "properties": {}, | 522 "properties": {}, |
523 "type": "object" | 523 "type": "object" |
524 }, | 524 }, |
525 "ReportType": { | |
526 "description": "A report type.", | |
527 "id": "ReportType", | |
528 "properties": { | |
529 "systemManaged": { | |
530 "description": "True if this a system-managed report type; o
therwise false. Reporting jobs\nfor system-managed report types are created auto
matically and can thus not\nbe used in the `CreateJob` method.", | |
531 "type": "boolean" | |
532 }, | |
533 "deprecateTime": { | |
534 "description": "The date/time when this report type was/will
be deprecated.", | |
535 "format": "google-datetime", | |
536 "type": "string" | |
537 }, | |
538 "id": { | |
539 "description": "The ID of the report type (max. 100 characte
rs).", | |
540 "type": "string" | |
541 }, | |
542 "name": { | |
543 "description": "The name of the report type (max. 100 charac
ters).", | |
544 "type": "string" | |
545 } | |
546 }, | |
547 "type": "object" | |
548 }, | |
549 "ListReportsResponse": { | |
550 "description": "Response message for ReportingService.ListReports.", | |
551 "id": "ListReportsResponse", | |
552 "properties": { | |
553 "nextPageToken": { | |
554 "description": "A token to retrieve next page of results.\nP
ass this value in the\nListReportsRequest.page_token\nfield in the subsequent ca
ll to `ListReports` method to retrieve the next\npage of results.", | |
555 "type": "string" | |
556 }, | |
557 "reports": { | |
558 "description": "The list of report types.", | |
559 "items": { | |
560 "$ref": "Report" | |
561 }, | |
562 "type": "array" | |
563 } | |
564 }, | |
565 "type": "object" | |
566 }, | |
567 "ListReportTypesResponse": { | 525 "ListReportTypesResponse": { |
568 "description": "Response message for ReportingService.ListReportType
s.", | 526 "description": "Response message for ReportingService.ListReportType
s.", |
569 "id": "ListReportTypesResponse", | 527 "id": "ListReportTypesResponse", |
570 "properties": { | 528 "properties": { |
571 "reportTypes": { | 529 "reportTypes": { |
572 "description": "The list of report types.", | 530 "description": "The list of report types.", |
573 "items": { | 531 "items": { |
574 "$ref": "ReportType" | 532 "$ref": "ReportType" |
575 }, | 533 }, |
576 "type": "array" | 534 "type": "array" |
577 }, | 535 }, |
578 "nextPageToken": { | 536 "nextPageToken": { |
579 "description": "A token to retrieve next page of results.\nP
ass this value in the\nListReportTypesRequest.page_token\nfield in the subsequen
t call to `ListReportTypes` method to retrieve the next\npage of results.", | 537 "description": "A token to retrieve next page of results.\nP
ass this value in the\nListReportTypesRequest.page_token\nfield in the subsequen
t call to `ListReportTypes` method to retrieve the next\npage of results.", |
580 "type": "string" | 538 "type": "string" |
581 } | 539 } |
582 }, | 540 }, |
| 541 "type": "object" |
| 542 }, |
| 543 "ReportType": { |
| 544 "description": "A report type.", |
| 545 "id": "ReportType", |
| 546 "properties": { |
| 547 "deprecateTime": { |
| 548 "description": "The date/time when this report type was/will
be deprecated.", |
| 549 "format": "google-datetime", |
| 550 "type": "string" |
| 551 }, |
| 552 "name": { |
| 553 "description": "The name of the report type (max. 100 charac
ters).", |
| 554 "type": "string" |
| 555 }, |
| 556 "id": { |
| 557 "description": "The ID of the report type (max. 100 characte
rs).", |
| 558 "type": "string" |
| 559 }, |
| 560 "systemManaged": { |
| 561 "description": "True if this a system-managed report type; o
therwise false. Reporting jobs\nfor system-managed report types are created auto
matically and can thus not\nbe used in the `CreateJob` method.", |
| 562 "type": "boolean" |
| 563 } |
| 564 }, |
| 565 "type": "object" |
| 566 }, |
| 567 "ListJobsResponse": { |
| 568 "description": "Response message for ReportingService.ListJobs.", |
| 569 "id": "ListJobsResponse", |
| 570 "properties": { |
| 571 "jobs": { |
| 572 "description": "The list of jobs.", |
| 573 "items": { |
| 574 "$ref": "Job" |
| 575 }, |
| 576 "type": "array" |
| 577 }, |
| 578 "nextPageToken": { |
| 579 "description": "A token to retrieve next page of results.\nP
ass this value in the\nListJobsRequest.page_token\nfield in the subsequent call
to `ListJobs` method to retrieve the next\npage of results.", |
| 580 "type": "string" |
| 581 } |
| 582 }, |
583 "type": "object" | 583 "type": "object" |
584 } | 584 } |
585 }, | 585 }, |
586 "servicePath": "", | 586 "servicePath": "", |
587 "title": "YouTube Reporting API", | 587 "title": "YouTube Reporting API", |
588 "version": "v1" | 588 "version": "v1" |
589 } | 589 } |
OLD | NEW |