mirror of
https://github.com/restic/restic.git
synced 2024-09-10 21:24:06 +02:00
598 lines
22 KiB
JSON
598 lines
22 KiB
JSON
{
|
|
"basePath": "",
|
|
"ownerDomain": "google.com",
|
|
"name": "youtubereporting",
|
|
"batchPath": "batch",
|
|
"id": "youtubereporting:v1",
|
|
"documentationLink": "https://developers.google.com/youtube/reporting/v1/reports/",
|
|
"revision": "20170803",
|
|
"title": "YouTube Reporting API",
|
|
"ownerName": "Google",
|
|
"discoveryVersion": "v1",
|
|
"resources": {
|
|
"reportTypes": {
|
|
"methods": {
|
|
"list": {
|
|
"flatPath": "v1/reportTypes",
|
|
"id": "youtubereporting.reportTypes.list",
|
|
"path": "v1/reportTypes",
|
|
"description": "Lists report types.",
|
|
"response": {
|
|
"$ref": "ListReportTypesResponse"
|
|
},
|
|
"parameterOrder": [],
|
|
"httpMethod": "GET",
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
|
|
"https://www.googleapis.com/auth/yt-analytics.readonly"
|
|
],
|
|
"parameters": {
|
|
"pageSize": {
|
|
"location": "query",
|
|
"format": "int32",
|
|
"description": "Requested page size. Server may return fewer report types than requested.\nIf unspecified, server will pick an appropriate default.",
|
|
"type": "integer"
|
|
},
|
|
"onBehalfOfContentOwner": {
|
|
"description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"includeSystemManaged": {
|
|
"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.",
|
|
"type": "boolean",
|
|
"location": "query"
|
|
},
|
|
"pageToken": {
|
|
"location": "query",
|
|
"description": "A token identifying a page of results the server should return. Typically,\nthis is the value of\nListReportTypesResponse.next_page_token\nreturned in response to the previous call to the `ListReportTypes` method.",
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"media": {
|
|
"methods": {
|
|
"download": {
|
|
"description": "Method for media download. Download is supported\non the URI `/v1/media/{+name}?alt=media`.",
|
|
"supportsMediaDownload": true,
|
|
"response": {
|
|
"$ref": "Media"
|
|
},
|
|
"parameterOrder": [
|
|
"resourceName"
|
|
],
|
|
"httpMethod": "GET",
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
|
|
"https://www.googleapis.com/auth/yt-analytics.readonly"
|
|
],
|
|
"parameters": {
|
|
"resourceName": {
|
|
"location": "path",
|
|
"description": "Name of the media that is being downloaded. See\nReadRequest.resource_name.",
|
|
"type": "string",
|
|
"required": true,
|
|
"pattern": "^.+$"
|
|
}
|
|
},
|
|
"flatPath": "v1/media/{mediaId}",
|
|
"id": "youtubereporting.media.download",
|
|
"path": "v1/media/{+resourceName}"
|
|
}
|
|
}
|
|
},
|
|
"jobs": {
|
|
"methods": {
|
|
"get": {
|
|
"description": "Gets a job.",
|
|
"httpMethod": "GET",
|
|
"response": {
|
|
"$ref": "Job"
|
|
},
|
|
"parameterOrder": [
|
|
"jobId"
|
|
],
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
|
|
"https://www.googleapis.com/auth/yt-analytics.readonly"
|
|
],
|
|
"parameters": {
|
|
"jobId": {
|
|
"description": "The ID of the job to retrieve.",
|
|
"type": "string",
|
|
"required": true,
|
|
"location": "path"
|
|
},
|
|
"onBehalfOfContentOwner": {
|
|
"description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
|
|
"type": "string",
|
|
"location": "query"
|
|
}
|
|
},
|
|
"flatPath": "v1/jobs/{jobId}",
|
|
"path": "v1/jobs/{jobId}",
|
|
"id": "youtubereporting.jobs.get"
|
|
},
|
|
"list": {
|
|
"description": "Lists jobs.",
|
|
"httpMethod": "GET",
|
|
"response": {
|
|
"$ref": "ListJobsResponse"
|
|
},
|
|
"parameterOrder": [],
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
|
|
"https://www.googleapis.com/auth/yt-analytics.readonly"
|
|
],
|
|
"parameters": {
|
|
"pageSize": {
|
|
"location": "query",
|
|
"format": "int32",
|
|
"description": "Requested page size. Server may return fewer jobs than requested.\nIf unspecified, server will pick an appropriate default.",
|
|
"type": "integer"
|
|
},
|
|
"onBehalfOfContentOwner": {
|
|
"description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"includeSystemManaged": {
|
|
"description": "If set to true, also system-managed jobs will be returned; otherwise only\nuser-created jobs will be returned. System-managed jobs can neither be\nmodified nor deleted.",
|
|
"type": "boolean",
|
|
"location": "query"
|
|
},
|
|
"pageToken": {
|
|
"description": "A token identifying a page of results the server should return. Typically,\nthis is the value of\nListReportTypesResponse.next_page_token\nreturned in response to the previous call to the `ListJobs` method.",
|
|
"type": "string",
|
|
"location": "query"
|
|
}
|
|
},
|
|
"flatPath": "v1/jobs",
|
|
"path": "v1/jobs",
|
|
"id": "youtubereporting.jobs.list"
|
|
},
|
|
"create": {
|
|
"description": "Creates a job and returns it.",
|
|
"request": {
|
|
"$ref": "Job"
|
|
},
|
|
"httpMethod": "POST",
|
|
"parameterOrder": [],
|
|
"response": {
|
|
"$ref": "Job"
|
|
},
|
|
"parameters": {
|
|
"onBehalfOfContentOwner": {
|
|
"description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
|
|
"type": "string",
|
|
"location": "query"
|
|
}
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
|
|
"https://www.googleapis.com/auth/yt-analytics.readonly"
|
|
],
|
|
"flatPath": "v1/jobs",
|
|
"path": "v1/jobs",
|
|
"id": "youtubereporting.jobs.create"
|
|
},
|
|
"delete": {
|
|
"description": "Deletes a job.",
|
|
"httpMethod": "DELETE",
|
|
"response": {
|
|
"$ref": "Empty"
|
|
},
|
|
"parameterOrder": [
|
|
"jobId"
|
|
],
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
|
|
"https://www.googleapis.com/auth/yt-analytics.readonly"
|
|
],
|
|
"parameters": {
|
|
"jobId": {
|
|
"description": "The ID of the job to delete.",
|
|
"type": "string",
|
|
"required": true,
|
|
"location": "path"
|
|
},
|
|
"onBehalfOfContentOwner": {
|
|
"description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
|
|
"type": "string",
|
|
"location": "query"
|
|
}
|
|
},
|
|
"flatPath": "v1/jobs/{jobId}",
|
|
"path": "v1/jobs/{jobId}",
|
|
"id": "youtubereporting.jobs.delete"
|
|
}
|
|
},
|
|
"resources": {
|
|
"reports": {
|
|
"methods": {
|
|
"get": {
|
|
"description": "Gets the metadata of a specific report.",
|
|
"httpMethod": "GET",
|
|
"response": {
|
|
"$ref": "Report"
|
|
},
|
|
"parameterOrder": [
|
|
"jobId",
|
|
"reportId"
|
|
],
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
|
|
"https://www.googleapis.com/auth/yt-analytics.readonly"
|
|
],
|
|
"parameters": {
|
|
"reportId": {
|
|
"description": "The ID of the report to retrieve.",
|
|
"type": "string",
|
|
"required": true,
|
|
"location": "path"
|
|
},
|
|
"jobId": {
|
|
"description": "The ID of the job.",
|
|
"type": "string",
|
|
"required": true,
|
|
"location": "path"
|
|
},
|
|
"onBehalfOfContentOwner": {
|
|
"location": "query",
|
|
"description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"flatPath": "v1/jobs/{jobId}/reports/{reportId}",
|
|
"path": "v1/jobs/{jobId}/reports/{reportId}",
|
|
"id": "youtubereporting.jobs.reports.get"
|
|
},
|
|
"list": {
|
|
"flatPath": "v1/jobs/{jobId}/reports",
|
|
"id": "youtubereporting.jobs.reports.list",
|
|
"path": "v1/jobs/{jobId}/reports",
|
|
"description": "Lists reports created by a specific job.\nReturns NOT_FOUND if the job does not exist.",
|
|
"response": {
|
|
"$ref": "ListReportsResponse"
|
|
},
|
|
"parameterOrder": [
|
|
"jobId"
|
|
],
|
|
"httpMethod": "GET",
|
|
"parameters": {
|
|
"createdAfter": {
|
|
"format": "google-datetime",
|
|
"description": "If set, only reports created after the specified date/time are returned.",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"pageToken": {
|
|
"description": "A token identifying a page of results the server should return. Typically,\nthis is the value of\nListReportsResponse.next_page_token\nreturned in response to the previous call to the `ListReports` method.",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"startTimeAtOrAfter": {
|
|
"format": "google-datetime",
|
|
"description": "If set, only reports whose start time is greater than or equal the\nspecified date/time are returned.",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"pageSize": {
|
|
"location": "query",
|
|
"format": "int32",
|
|
"description": "Requested page size. Server may return fewer report types than requested.\nIf unspecified, server will pick an appropriate default.",
|
|
"type": "integer"
|
|
},
|
|
"onBehalfOfContentOwner": {
|
|
"description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"startTimeBefore": {
|
|
"format": "google-datetime",
|
|
"description": "If set, only reports whose start time is smaller than the specified\ndate/time are returned.",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"jobId": {
|
|
"description": "The ID of the job.",
|
|
"type": "string",
|
|
"required": true,
|
|
"location": "path"
|
|
}
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
|
|
"https://www.googleapis.com/auth/yt-analytics.readonly"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"parameters": {
|
|
"bearer_token": {
|
|
"location": "query",
|
|
"description": "OAuth bearer token.",
|
|
"type": "string"
|
|
},
|
|
"oauth_token": {
|
|
"description": "OAuth 2.0 token for the current user.",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"upload_protocol": {
|
|
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"prettyPrint": {
|
|
"location": "query",
|
|
"description": "Returns response with indentations and line breaks.",
|
|
"default": "true",
|
|
"type": "boolean"
|
|
},
|
|
"fields": {
|
|
"description": "Selector specifying which fields to include in a partial response.",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"uploadType": {
|
|
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"$.xgafv": {
|
|
"description": "V1 error format.",
|
|
"type": "string",
|
|
"enumDescriptions": [
|
|
"v1 error format",
|
|
"v2 error format"
|
|
],
|
|
"location": "query",
|
|
"enum": [
|
|
"1",
|
|
"2"
|
|
]
|
|
},
|
|
"callback": {
|
|
"location": "query",
|
|
"description": "JSONP",
|
|
"type": "string"
|
|
},
|
|
"alt": {
|
|
"enumDescriptions": [
|
|
"Responses with Content-Type of application/json",
|
|
"Media download with context-dependent Content-Type",
|
|
"Responses with Content-Type of application/x-protobuf"
|
|
],
|
|
"location": "query",
|
|
"description": "Data format for response.",
|
|
"default": "json",
|
|
"enum": [
|
|
"json",
|
|
"media",
|
|
"proto"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"location": "query",
|
|
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
|
"type": "string"
|
|
},
|
|
"access_token": {
|
|
"description": "OAuth access token.",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"quotaUser": {
|
|
"location": "query",
|
|
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
|
|
"type": "string"
|
|
},
|
|
"pp": {
|
|
"description": "Pretty-print response.",
|
|
"default": "true",
|
|
"type": "boolean",
|
|
"location": "query"
|
|
}
|
|
},
|
|
"schemas": {
|
|
"Job": {
|
|
"description": "A job creating reports of a specific type.",
|
|
"type": "object",
|
|
"properties": {
|
|
"createTime": {
|
|
"format": "google-datetime",
|
|
"description": "The creation date/time of the job.",
|
|
"type": "string"
|
|
},
|
|
"reportTypeId": {
|
|
"description": "The type of reports this job creates. Corresponds to the ID of a\nReportType.",
|
|
"type": "string"
|
|
},
|
|
"expireTime": {
|
|
"format": "google-datetime",
|
|
"description": "The date/time when this job will expire/expired. After a job expired, no\nnew reports are generated.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "The name of the job (max. 100 characters).",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"description": "The server-generated ID of the job (max. 40 characters).",
|
|
"type": "string"
|
|
},
|
|
"systemManaged": {
|
|
"description": "True if this a system-managed job that cannot be modified by the user;\notherwise false.",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"id": "Job"
|
|
},
|
|
"ListReportsResponse": {
|
|
"description": "Response message for ReportingService.ListReports.",
|
|
"type": "object",
|
|
"properties": {
|
|
"reports": {
|
|
"description": "The list of report types.",
|
|
"items": {
|
|
"$ref": "Report"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"nextPageToken": {
|
|
"description": "A token to retrieve next page of results.\nPass this value in the\nListReportsRequest.page_token\nfield in the subsequent call to `ListReports` method to retrieve the next\npage of results.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"id": "ListReportsResponse"
|
|
},
|
|
"Media": {
|
|
"description": "Media resource.",
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceName": {
|
|
"description": "Name of the media resource.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"id": "Media"
|
|
},
|
|
"Report": {
|
|
"description": "A report's metadata including the URL from which the report itself can be\ndownloaded.",
|
|
"type": "object",
|
|
"properties": {
|
|
"createTime": {
|
|
"format": "google-datetime",
|
|
"description": "The date/time when this report was created.",
|
|
"type": "string"
|
|
},
|
|
"jobId": {
|
|
"description": "The ID of the job that created this report.",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"description": "The server-generated ID of the report.",
|
|
"type": "string"
|
|
},
|
|
"endTime": {
|
|
"format": "google-datetime",
|
|
"description": "The end of the time period that the report instance covers. The value is\nexclusive.",
|
|
"type": "string"
|
|
},
|
|
"jobExpireTime": {
|
|
"format": "google-datetime",
|
|
"description": "The date/time when the job this report belongs to will expire/expired.",
|
|
"type": "string"
|
|
},
|
|
"downloadUrl": {
|
|
"description": "The URL from which the report can be downloaded (max. 1000 characters).",
|
|
"type": "string"
|
|
},
|
|
"startTime": {
|
|
"format": "google-datetime",
|
|
"description": "The start of the time period that the report instance covers. The value is\ninclusive.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"id": "Report"
|
|
},
|
|
"Empty": {
|
|
"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 it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
|
|
"type": "object",
|
|
"properties": {},
|
|
"id": "Empty"
|
|
},
|
|
"ListReportTypesResponse": {
|
|
"description": "Response message for ReportingService.ListReportTypes.",
|
|
"type": "object",
|
|
"properties": {
|
|
"reportTypes": {
|
|
"description": "The list of report types.",
|
|
"items": {
|
|
"$ref": "ReportType"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"nextPageToken": {
|
|
"description": "A token to retrieve next page of results.\nPass this value in the\nListReportTypesRequest.page_token\nfield in the subsequent call to `ListReportTypes` method to retrieve the next\npage of results.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"id": "ListReportTypesResponse"
|
|
},
|
|
"ReportType": {
|
|
"description": "A report type.",
|
|
"type": "object",
|
|
"properties": {
|
|
"systemManaged": {
|
|
"description": "True if this a system-managed report type; otherwise false. Reporting jobs\nfor system-managed report types are created automatically and can thus not\nbe used in the `CreateJob` method.",
|
|
"type": "boolean"
|
|
},
|
|
"id": {
|
|
"description": "The ID of the report type (max. 100 characters).",
|
|
"type": "string"
|
|
},
|
|
"deprecateTime": {
|
|
"format": "google-datetime",
|
|
"description": "The date/time when this report type was/will be deprecated.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "The name of the report type (max. 100 characters).",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"id": "ReportType"
|
|
},
|
|
"ListJobsResponse": {
|
|
"description": "Response message for ReportingService.ListJobs.",
|
|
"type": "object",
|
|
"properties": {
|
|
"nextPageToken": {
|
|
"description": "A token to retrieve next page of results.\nPass this value in the\nListJobsRequest.page_token\nfield in the subsequent call to `ListJobs` method to retrieve the next\npage of results.",
|
|
"type": "string"
|
|
},
|
|
"jobs": {
|
|
"description": "The list of jobs.",
|
|
"items": {
|
|
"$ref": "Job"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"id": "ListJobsResponse"
|
|
}
|
|
},
|
|
"icons": {
|
|
"x32": "http://www.google.com/images/icons/product/search-32.gif",
|
|
"x16": "http://www.google.com/images/icons/product/search-16.gif"
|
|
},
|
|
"protocol": "rest",
|
|
"version": "v1",
|
|
"baseUrl": "https://youtubereporting.googleapis.com/",
|
|
"canonicalName": "YouTube Reporting",
|
|
"auth": {
|
|
"oauth2": {
|
|
"scopes": {
|
|
"https://www.googleapis.com/auth/yt-analytics.readonly": {
|
|
"description": "View YouTube Analytics reports for your YouTube content"
|
|
},
|
|
"https://www.googleapis.com/auth/yt-analytics-monetary.readonly": {
|
|
"description": "View monetary and non-monetary YouTube Analytics reports for your YouTube content"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"kind": "discovery#restDescription",
|
|
"description": "Schedules reporting jobs containing your YouTube Analytics data and downloads the resulting bulk data reports in the form of CSV files.",
|
|
"servicePath": "",
|
|
"rootUrl": "https://youtubereporting.googleapis.com/"
|
|
}
|