google_api_you_tube_analytics v0.12.0 GoogleApi.YouTubeAnalytics.V2.Api.Reports View Source
API calls for all endpoints tagged Reports
.
Link to this section Summary
Functions
Retrieve your YouTube Analytics reports.
Link to this section Functions
youtube_analytics_reports_query(connection, optional_params \\ [], opts \\ [])
View Sourceyoutube_analytics_reports_query(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.YouTubeAnalytics.V2.Model.QueryResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Retrieve your YouTube Analytics reports.
Parameters
connection
(type:GoogleApi.YouTubeAnalytics.V2.Connection.t
) - Connection to serveroptional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - 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.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - 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.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:currency
(type:String.t
) - 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}:dimensions
(type:String.t
) - A comma-separated list of YouTube Analytics dimensions, such asviews
orageGroup,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,]+:endDate
(type:String.t
) - The end date for fetching YouTube Analytics data. The value should be inYYYY-MM-DD
format. required: true, pattern: [0-9]{4}-[0-9]{2}-[0-9]{2}:filters
(type:String.t
) - 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 ofvideo==dMH0bHeiRNg;country==IT
restricts the result set to include data for the given video in Italy.",:ids
(type:String.t
) - Identifies the YouTube channel or content owner for which you are retrieving YouTube Analytics data.- To request data for a YouTube user, set the
ids
parameter value tochannel==CHANNEL_ID
, whereCHANNEL_ID
specifies the unique YouTube channel ID. - To request data for a YouTube CMS content owner, set the
ids
parameter value tocontentOwner==OWNER_NAME
, whereOWNER_NAME
is the CMS name of the content owner. required: true, pattern: [a-zA-Z]+==[a-zA-Z0-9_+-]+
- To request data for a YouTube user, set the
:includeHistoricalChannelData
(type:boolean()
) - If set to true historical data (i.e. channel data from before the linking of the channel to the content owner) will be retrieved.",:maxResults
(type:integer()
) - The maximum number of rows to include in the response.", minValue: 1:metrics
(type:String.t
) - A comma-separated list of YouTube Analytics metrics, such asviews
orlikes,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,]+:sort
(type:String.t
) - 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,]+:startDate
(type:String.t
) - The start date for fetching YouTube Analytics data. The value should be inYYYY-MM-DD
format. required: true, pattern: "[0-9]{4}-[0-9]{2}-[0-9]{2}:startIndex
(type:integer()
) - An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter (one-based, inclusive).", minValue: 1
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.YouTubeAnalytics.V2.Model.QueryResponse{}}
on success{:error, info}
on failure