Class ReportsResource.QueryRequest

Retrieve your YouTube Analytics reports.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<QueryResponse>
YouTubeAnalyticsBaseServiceRequest<QueryResponse>
ReportsResource.QueryRequest
Implements
Inherited Members
Namespace: Google.Apis.YouTubeAnalytics.v2
Assembly: Google.Apis.YouTubeAnalytics.v2.dll
Syntax
public class ReportsResource.QueryRequest : YouTubeAnalyticsBaseServiceRequest<QueryResponse>, IClientServiceRequest<QueryResponse>, IClientServiceRequest

Constructors

QueryRequest(IClientService)

Constructs a new Query request.

Declaration
public QueryRequest(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

Currency

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}

Declaration
[RequestParameter("currency", RequestParameterType.Query)]
public virtual string Currency { get; set; }
Property Value
Type Description
string

Dimensions

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,]+

Declaration
[RequestParameter("dimensions", RequestParameterType.Query)]
public virtual string Dimensions { get; set; }
Property Value
Type Description
string

EndDate

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}

Declaration
[RequestParameter("endDate", RequestParameterType.Query)]
public virtual string EndDate { get; set; }
Property Value
Type Description
string

Filters

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.",

Declaration
[RequestParameter("filters", RequestParameterType.Query)]
public virtual string Filters { get; set; }
Property Value
Type Description
string

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.YouTubeAnalytics.v2.Data.QueryResponse>.HttpMethod

Ids

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_+-]+

Declaration
[RequestParameter("ids", RequestParameterType.Query)]
public virtual string Ids { get; set; }
Property Value
Type Description
string

IncludeHistoricalChannelData

If set to true historical data (i.e. channel data from before the linking of the channel to the content owner) will be retrieved.",

Declaration
[RequestParameter("includeHistoricalChannelData", RequestParameterType.Query)]
public virtual bool? IncludeHistoricalChannelData { get; set; }
Property Value
Type Description
bool?

MaxResults

The maximum number of rows to include in the response.", minValue: 1

Declaration
[RequestParameter("maxResults", RequestParameterType.Query)]
public virtual int? MaxResults { get; set; }
Property Value
Type Description
int?

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.YouTubeAnalytics.v2.Data.QueryResponse>.MethodName

Metrics

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,]+

Declaration
[RequestParameter("metrics", RequestParameterType.Query)]
public virtual string Metrics { get; set; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.YouTubeAnalytics.v2.Data.QueryResponse>.RestPath

Sort

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,]+

Declaration
[RequestParameter("sort", RequestParameterType.Query)]
public virtual string Sort { get; set; }
Property Value
Type Description
string

StartDate

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}

Declaration
[RequestParameter("startDate", RequestParameterType.Query)]
public virtual string StartDate { get; set; }
Property Value
Type Description
string

StartIndex

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

Declaration
[RequestParameter("startIndex", RequestParameterType.Query)]
public virtual int? StartIndex { get; set; }
Property Value
Type Description
int?

Methods

InitParameters()

Initializes Query parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements