ReportsQueryOptions
import type { ReportsQueryOptions } from "https://googleapis.deno.dev/v1/youtubeAnalytics:v2.ts";
Additional options for YouTubeAnalytics#reportsQuery.
§Properties
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}
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,]+
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}
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.",
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 to channel==CHANNEL_ID
, where CHANNEL_ID
specifies the unique YouTube channel ID. - 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_+-]+
If set to true historical data (i.e. channel data from before the linking of the channel to the content owner) will be retrieved.",
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,]+
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,]+