mirror of
https://github.com/octoleo/restic.git
synced 2024-12-11 13:52:31 +00:00
548 lines
22 KiB
JSON
548 lines
22 KiB
JSON
{
|
|
"kind": "discovery#restDescription",
|
|
"etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/oTivMR1Fefkt9JK_g8x8csBABMw\"",
|
|
"discoveryVersion": "v1",
|
|
"id": "youtubeAnalytics:v1",
|
|
"name": "youtubeAnalytics",
|
|
"canonicalName": "YouTube Analytics",
|
|
"version": "v1",
|
|
"revision": "20170913",
|
|
"title": "YouTube Analytics API",
|
|
"description": "Retrieves your YouTube Analytics data.",
|
|
"ownerDomain": "google.com",
|
|
"ownerName": "Google",
|
|
"icons": {
|
|
"x16": "https://www.google.com/images/icons/product/youtube-16.png",
|
|
"x32": "https://www.google.com/images/icons/product/youtube-32.png"
|
|
},
|
|
"documentationLink": "http://developers.google.com/youtube/analytics/",
|
|
"protocol": "rest",
|
|
"baseUrl": "https://www.googleapis.com/youtube/analytics/v1/",
|
|
"basePath": "/youtube/analytics/v1/",
|
|
"rootUrl": "https://www.googleapis.com/",
|
|
"servicePath": "youtube/analytics/v1/",
|
|
"batchPath": "batch/youtubeAnalytics/v1",
|
|
"parameters": {
|
|
"alt": {
|
|
"type": "string",
|
|
"description": "Data format for the response.",
|
|
"default": "json",
|
|
"enum": [
|
|
"csv",
|
|
"json"
|
|
],
|
|
"enumDescriptions": [
|
|
"Responses with Content-Type of text/csv",
|
|
"Responses with Content-Type of application/json"
|
|
],
|
|
"location": "query"
|
|
},
|
|
"fields": {
|
|
"type": "string",
|
|
"description": "Selector specifying which fields to include in a partial response.",
|
|
"location": "query"
|
|
},
|
|
"key": {
|
|
"type": "string",
|
|
"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.",
|
|
"location": "query"
|
|
},
|
|
"oauth_token": {
|
|
"type": "string",
|
|
"description": "OAuth 2.0 token for the current user.",
|
|
"location": "query"
|
|
},
|
|
"prettyPrint": {
|
|
"type": "boolean",
|
|
"description": "Returns response with indentations and line breaks.",
|
|
"default": "true",
|
|
"location": "query"
|
|
},
|
|
"quotaUser": {
|
|
"type": "string",
|
|
"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. Overrides userIp if both are provided.",
|
|
"location": "query"
|
|
},
|
|
"userIp": {
|
|
"type": "string",
|
|
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
|
|
"location": "query"
|
|
}
|
|
},
|
|
"auth": {
|
|
"oauth2": {
|
|
"scopes": {
|
|
"https://www.googleapis.com/auth/youtube": {
|
|
"description": "Manage your YouTube account"
|
|
},
|
|
"https://www.googleapis.com/auth/youtube.readonly": {
|
|
"description": "View your YouTube account"
|
|
},
|
|
"https://www.googleapis.com/auth/youtubepartner": {
|
|
"description": "View and manage your assets and associated content on YouTube"
|
|
},
|
|
"https://www.googleapis.com/auth/yt-analytics-monetary.readonly": {
|
|
"description": "View monetary and non-monetary YouTube Analytics reports for your YouTube content"
|
|
},
|
|
"https://www.googleapis.com/auth/yt-analytics.readonly": {
|
|
"description": "View YouTube Analytics reports for your YouTube content"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"schemas": {
|
|
"Group": {
|
|
"id": "Group",
|
|
"type": "object",
|
|
"properties": {
|
|
"contentDetails": {
|
|
"type": "object",
|
|
"properties": {
|
|
"itemCount": {
|
|
"type": "string",
|
|
"format": "uint64"
|
|
},
|
|
"itemType": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"etag": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"kind": {
|
|
"type": "string",
|
|
"default": "youtube#group"
|
|
},
|
|
"snippet": {
|
|
"type": "object",
|
|
"properties": {
|
|
"publishedAt": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"title": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GroupItem": {
|
|
"id": "GroupItem",
|
|
"type": "object",
|
|
"properties": {
|
|
"etag": {
|
|
"type": "string"
|
|
},
|
|
"groupId": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"kind": {
|
|
"type": "string",
|
|
"default": "youtube#groupItem"
|
|
},
|
|
"resource": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"kind": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"GroupItemListResponse": {
|
|
"id": "GroupItemListResponse",
|
|
"type": "object",
|
|
"description": "A paginated list of grouList resources returned in response to a youtubeAnalytics.groupApi.list request.",
|
|
"properties": {
|
|
"etag": {
|
|
"type": "string"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "GroupItem"
|
|
}
|
|
},
|
|
"kind": {
|
|
"type": "string",
|
|
"default": "youtube#groupItemListResponse"
|
|
}
|
|
}
|
|
},
|
|
"GroupListResponse": {
|
|
"id": "GroupListResponse",
|
|
"type": "object",
|
|
"description": "A paginated list of grouList resources returned in response to a youtubeAnalytics.groupApi.list request.",
|
|
"properties": {
|
|
"etag": {
|
|
"type": "string"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "Group"
|
|
}
|
|
},
|
|
"kind": {
|
|
"type": "string",
|
|
"default": "youtube#groupListResponse"
|
|
},
|
|
"nextPageToken": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"ResultTable": {
|
|
"id": "ResultTable",
|
|
"type": "object",
|
|
"description": "Contains a single result table. The table is returned as an array of rows that contain the values for the cells of the table. Depending 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).",
|
|
"properties": {
|
|
"columnHeaders": {
|
|
"type": "array",
|
|
"description": "This value specifies information about the data 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 data. The columnHeaders list will begin with the dimensions specified in the API request, which will be followed by the metrics specified in the API request. The order of both dimensions and metrics will match the ordering in the API request. For example, if the API request contains the parameters dimensions=ageGroup,gender&metrics=viewerPercentage, the API response will return columns in this order: ageGroup,gender,viewerPercentage.",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"columnType": {
|
|
"type": "string",
|
|
"description": "The type of the column (DIMENSION or METRIC)."
|
|
},
|
|
"dataType": {
|
|
"type": "string",
|
|
"description": "The type of the data in the column (STRING, INTEGER, FLOAT, etc.)."
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "The name of the dimension or metric."
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"kind": {
|
|
"type": "string",
|
|
"description": "This value specifies the type of data included in the API response. For the query method, the kind property value will be youtubeAnalytics#resultTable.",
|
|
"default": "youtubeAnalytics#resultTable"
|
|
},
|
|
"rows": {
|
|
"type": "array",
|
|
"description": "The list contains all rows of the result table. Each item in the list is an array that contains comma-delimited data corresponding to a single row of data. The order of the comma-delimited data fields will match the order of the columns listed in the columnHeaders field. If no data is available for the given query, the rows element will be omitted from the response. The response for a query with the day dimension will not contain rows for the most recent days.",
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "any"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"resources": {
|
|
"groupItems": {
|
|
"methods": {
|
|
"delete": {
|
|
"id": "youtubeAnalytics.groupItems.delete",
|
|
"path": "groupItems",
|
|
"httpMethod": "DELETE",
|
|
"description": "Removes an item from a group.",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "The id parameter specifies the YouTube group item ID for the group that is being deleted.",
|
|
"required": true,
|
|
"location": "query"
|
|
},
|
|
"onBehalfOfContentOwner": {
|
|
"type": "string",
|
|
"description": "Note: This parameter is intended exclusively for YouTube content partners.\n\nThe onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.",
|
|
"location": "query"
|
|
}
|
|
},
|
|
"parameterOrder": [
|
|
"id"
|
|
],
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/youtube",
|
|
"https://www.googleapis.com/auth/youtubepartner"
|
|
]
|
|
},
|
|
"insert": {
|
|
"id": "youtubeAnalytics.groupItems.insert",
|
|
"path": "groupItems",
|
|
"httpMethod": "POST",
|
|
"description": "Creates a group item.",
|
|
"parameters": {
|
|
"onBehalfOfContentOwner": {
|
|
"type": "string",
|
|
"description": "Note: This parameter is intended exclusively for YouTube content partners.\n\nThe onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.",
|
|
"location": "query"
|
|
}
|
|
},
|
|
"request": {
|
|
"$ref": "GroupItem"
|
|
},
|
|
"response": {
|
|
"$ref": "GroupItem"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/youtube",
|
|
"https://www.googleapis.com/auth/youtubepartner"
|
|
]
|
|
},
|
|
"list": {
|
|
"id": "youtubeAnalytics.groupItems.list",
|
|
"path": "groupItems",
|
|
"httpMethod": "GET",
|
|
"description": "Returns a collection of group items that match the API request parameters.",
|
|
"parameters": {
|
|
"groupId": {
|
|
"type": "string",
|
|
"description": "The id parameter specifies the unique ID of the group for which you want to retrieve group items.",
|
|
"required": true,
|
|
"location": "query"
|
|
},
|
|
"onBehalfOfContentOwner": {
|
|
"type": "string",
|
|
"description": "Note: This parameter is intended exclusively for YouTube content partners.\n\nThe onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.",
|
|
"location": "query"
|
|
}
|
|
},
|
|
"parameterOrder": [
|
|
"groupId"
|
|
],
|
|
"response": {
|
|
"$ref": "GroupItemListResponse"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/youtube",
|
|
"https://www.googleapis.com/auth/youtube.readonly",
|
|
"https://www.googleapis.com/auth/youtubepartner",
|
|
"https://www.googleapis.com/auth/yt-analytics.readonly"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"groups": {
|
|
"methods": {
|
|
"delete": {
|
|
"id": "youtubeAnalytics.groups.delete",
|
|
"path": "groups",
|
|
"httpMethod": "DELETE",
|
|
"description": "Deletes a group.",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "The id parameter specifies the YouTube group ID for the group that is being deleted.",
|
|
"required": true,
|
|
"location": "query"
|
|
},
|
|
"onBehalfOfContentOwner": {
|
|
"type": "string",
|
|
"description": "Note: This parameter is intended exclusively for YouTube content partners.\n\nThe onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.",
|
|
"location": "query"
|
|
}
|
|
},
|
|
"parameterOrder": [
|
|
"id"
|
|
],
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/youtube",
|
|
"https://www.googleapis.com/auth/youtubepartner"
|
|
]
|
|
},
|
|
"insert": {
|
|
"id": "youtubeAnalytics.groups.insert",
|
|
"path": "groups",
|
|
"httpMethod": "POST",
|
|
"description": "Creates a group.",
|
|
"parameters": {
|
|
"onBehalfOfContentOwner": {
|
|
"type": "string",
|
|
"description": "Note: This parameter is intended exclusively for YouTube content partners.\n\nThe onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.",
|
|
"location": "query"
|
|
}
|
|
},
|
|
"request": {
|
|
"$ref": "Group"
|
|
},
|
|
"response": {
|
|
"$ref": "Group"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/youtube",
|
|
"https://www.googleapis.com/auth/youtubepartner"
|
|
]
|
|
},
|
|
"list": {
|
|
"id": "youtubeAnalytics.groups.list",
|
|
"path": "groups",
|
|
"httpMethod": "GET",
|
|
"description": "Returns a collection of groups that match the API request parameters. For example, you can retrieve all groups that the authenticated user owns, or you can retrieve one or more groups by their unique IDs.",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "The id parameter specifies a comma-separated list of the YouTube group ID(s) for the resource(s) that are being retrieved. In a group resource, the id property specifies the group's YouTube group ID.",
|
|
"location": "query"
|
|
},
|
|
"mine": {
|
|
"type": "boolean",
|
|
"description": "Set this parameter's value to true to instruct the API to only return groups owned by the authenticated user.",
|
|
"location": "query"
|
|
},
|
|
"onBehalfOfContentOwner": {
|
|
"type": "string",
|
|
"description": "Note: This parameter is intended exclusively for YouTube content partners.\n\nThe onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.",
|
|
"location": "query"
|
|
},
|
|
"pageToken": {
|
|
"type": "string",
|
|
"description": "The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identifies the next page that can be retrieved.",
|
|
"location": "query"
|
|
}
|
|
},
|
|
"response": {
|
|
"$ref": "GroupListResponse"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/youtube",
|
|
"https://www.googleapis.com/auth/youtube.readonly",
|
|
"https://www.googleapis.com/auth/youtubepartner",
|
|
"https://www.googleapis.com/auth/yt-analytics.readonly"
|
|
]
|
|
},
|
|
"update": {
|
|
"id": "youtubeAnalytics.groups.update",
|
|
"path": "groups",
|
|
"httpMethod": "PUT",
|
|
"description": "Modifies a group. For example, you could change a group's title.",
|
|
"parameters": {
|
|
"onBehalfOfContentOwner": {
|
|
"type": "string",
|
|
"description": "Note: This parameter is intended exclusively for YouTube content partners.\n\nThe onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.",
|
|
"location": "query"
|
|
}
|
|
},
|
|
"request": {
|
|
"$ref": "Group"
|
|
},
|
|
"response": {
|
|
"$ref": "Group"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/youtube",
|
|
"https://www.googleapis.com/auth/youtubepartner"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"reports": {
|
|
"methods": {
|
|
"query": {
|
|
"id": "youtubeAnalytics.reports.query",
|
|
"path": "reports",
|
|
"httpMethod": "GET",
|
|
"description": "Retrieve your YouTube Analytics reports.",
|
|
"parameters": {
|
|
"currency": {
|
|
"type": "string",
|
|
"description": "The currency to which financial metrics should be converted. The default is US Dollar (USD). If the result contains no financial metrics, this flag will be ignored. Responds with an error if the specified currency is not recognized.",
|
|
"pattern": "[A-Z]{3}",
|
|
"location": "query"
|
|
},
|
|
"dimensions": {
|
|
"type": "string",
|
|
"description": "A comma-separated list of YouTube Analytics 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 dimensions.",
|
|
"pattern": "[0-9a-zA-Z,]+",
|
|
"location": "query"
|
|
},
|
|
"end-date": {
|
|
"type": "string",
|
|
"description": "The end date for fetching YouTube Analytics data. The value should be in YYYY-MM-DD format.",
|
|
"required": true,
|
|
"pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}",
|
|
"location": "query"
|
|
},
|
|
"filters": {
|
|
"type": "string",
|
|
"description": "A list of filters that should be applied when retrieving YouTube Analytics data. The Available Reports document identifies the dimensions that can be used to filter each report, and the Dimensions document defines those dimensions. If a request uses multiple filters, join them 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.",
|
|
"location": "query"
|
|
},
|
|
"ids": {
|
|
"type": "string",
|
|
"description": "Identifies the YouTube channel or content owner for which you are retrieving YouTube Analytics data.\n- To request data for a YouTube user, set the ids parameter value to channel==CHANNEL_ID, where CHANNEL_ID specifies the unique YouTube channel ID.\n- To request data for a YouTube CMS content owner, set the ids parameter value to contentOwner==OWNER_NAME, where OWNER_NAME is the CMS name of the content owner.",
|
|
"required": true,
|
|
"pattern": "[a-zA-Z]+==[a-zA-Z0-9_+-]+",
|
|
"location": "query"
|
|
},
|
|
"include-historical-channel-data": {
|
|
"type": "boolean",
|
|
"description": "If set to true historical data (i.e. channel data from before the linking of the channel to the content owner) will be retrieved.",
|
|
"location": "query"
|
|
},
|
|
"max-results": {
|
|
"type": "integer",
|
|
"description": "The maximum number of rows to include in the response.",
|
|
"format": "int32",
|
|
"minimum": "1",
|
|
"location": "query"
|
|
},
|
|
"metrics": {
|
|
"type": "string",
|
|
"description": "A comma-separated list of YouTube Analytics metrics, such as views or likes,dislikes. See the Available Reports document for a list of the reports that you can retrieve and the metrics available in each report, and see the Metrics document for definitions of those metrics.",
|
|
"required": true,
|
|
"pattern": "[0-9a-zA-Z,]+",
|
|
"location": "query"
|
|
},
|
|
"sort": {
|
|
"type": "string",
|
|
"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.",
|
|
"pattern": "[-0-9a-zA-Z,]+",
|
|
"location": "query"
|
|
},
|
|
"start-date": {
|
|
"type": "string",
|
|
"description": "The start date for fetching YouTube Analytics data. The value should be in YYYY-MM-DD format.",
|
|
"required": true,
|
|
"pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}",
|
|
"location": "query"
|
|
},
|
|
"start-index": {
|
|
"type": "integer",
|
|
"description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter (one-based, inclusive).",
|
|
"format": "int32",
|
|
"minimum": "1",
|
|
"location": "query"
|
|
}
|
|
},
|
|
"parameterOrder": [
|
|
"ids",
|
|
"start-date",
|
|
"end-date",
|
|
"metrics"
|
|
],
|
|
"response": {
|
|
"$ref": "ResultTable"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/youtube",
|
|
"https://www.googleapis.com/auth/youtube.readonly",
|
|
"https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
|
|
"https://www.googleapis.com/auth/yt-analytics.readonly"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|