Class AccountsResource.ReportsResource.GenerateRequest

Generates an ad hoc report.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<ReportResult>
AdsenseBaseServiceRequest<ReportResult>
AccountsResource.ReportsResource.GenerateRequest
Implements
Inherited Members
Namespace: Google.Apis.Adsense.v2
Assembly: Google.Apis.Adsense.v2.dll
Syntax
public class AccountsResource.ReportsResource.GenerateRequest : AdsenseBaseServiceRequest<ReportResult>, IClientServiceRequest<ReportResult>, IClientServiceRequest

Constructors

GenerateRequest(IClientService, string)

Constructs a new Generate request.

Declaration
public GenerateRequest(IClientService service, string account)
Parameters
Type Name Description
IClientService service
string account

Properties

Account

Required. The account which owns the collection of reports. Format: accounts/{account}

Declaration
[RequestParameter("account", RequestParameterType.Path)]
public virtual string Account { get; }
Property Value
Type Description
string

CurrencyCode

The ISO-4217 currency code to use when reporting on monetary metrics. Defaults to the account's currency if not set.

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

DateRange

Date range of the report, if unset the range will be considered CUSTOM.

Declaration
[RequestParameter("dateRange", RequestParameterType.Query)]
public virtual AccountsResource.ReportsResource.GenerateRequest.DateRangeEnum? DateRange { get; set; }
Property Value
Type Description
AccountsResource.ReportsResource.GenerateRequest.DateRangeEnum?

Dimensions

Dimensions to base the report on.

Declaration
[RequestParameter("dimensions", RequestParameterType.Query)]
public virtual AccountsResource.ReportsResource.GenerateRequest.DimensionsEnum? Dimensions { get; set; }
Property Value
Type Description
AccountsResource.ReportsResource.GenerateRequest.DimensionsEnum?
Remarks

Use this property to set a single value for the parameter, or DimensionsList to set multiple values. Do not set both properties.

DimensionsList

Dimensions to base the report on.

Declaration
[RequestParameter("dimensions", RequestParameterType.Query)]
public virtual Repeatable<AccountsResource.ReportsResource.GenerateRequest.DimensionsEnum> DimensionsList { get; set; }
Property Value
Type Description
Repeatable<AccountsResource.ReportsResource.GenerateRequest.DimensionsEnum>
Remarks

Use this property to set one or more values for the parameter. Do not set both this property and Dimensions.

EndDateDay

Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

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

EndDateMonth

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

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

EndDateYear

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

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

Filters

A list of filters to apply to the report. All provided filters must match in order for the data to be included in the report.

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

HttpMethod

Gets the HTTP method.

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

LanguageCode

The language to use for translating report output. If unspecified, this defaults to English ("en"). If the given language is not supported, report output will be returned in English. The language is specified as an IETF BCP-47 language code.

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

Limit

The maximum number of rows of report data to return. Reports producing more rows than the requested limit will be truncated. If unset, this defaults to 100,000 rows for Reports.GenerateReport and 1,000,000 rows for Reports.GenerateCsvReport, which are also the maximum values permitted here. Report truncation can be identified (for Reports.GenerateReport only) by comparing the number of rows returned to the value returned in total_matched_rows.

Declaration
[RequestParameter("limit", RequestParameterType.Query)]
public virtual int? Limit { 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.Adsense.v2.Data.ReportResult>.MethodName

Metrics

Required. Reporting metrics.

Declaration
[RequestParameter("metrics", RequestParameterType.Query)]
public virtual AccountsResource.ReportsResource.GenerateRequest.MetricsEnum? Metrics { get; set; }
Property Value
Type Description
AccountsResource.ReportsResource.GenerateRequest.MetricsEnum?
Remarks

Use this property to set a single value for the parameter, or MetricsList to set multiple values. Do not set both properties.

MetricsList

Required. Reporting metrics.

Declaration
[RequestParameter("metrics", RequestParameterType.Query)]
public virtual Repeatable<AccountsResource.ReportsResource.GenerateRequest.MetricsEnum> MetricsList { get; set; }
Property Value
Type Description
Repeatable<AccountsResource.ReportsResource.GenerateRequest.MetricsEnum>
Remarks

Use this property to set one or more values for the parameter. Do not set both this property and Metrics.

OrderBy

The name of a dimension or metric to sort the resulting report on, can be prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending.

Declaration
[RequestParameter("orderBy", RequestParameterType.Query)]
public virtual Repeatable<string> OrderBy { get; set; }
Property Value
Type Description
Repeatable<string>

ReportingTimeZone

Timezone in which to generate the report. If unspecified, this defaults to the account timezone. For more information, see changing the time zone of your reports.

Declaration
[RequestParameter("reportingTimeZone", RequestParameterType.Query)]
public virtual AccountsResource.ReportsResource.GenerateRequest.ReportingTimeZoneEnum? ReportingTimeZone { get; set; }
Property Value
Type Description
AccountsResource.ReportsResource.GenerateRequest.ReportingTimeZoneEnum?

RestPath

Gets the REST path.

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

StartDateDay

Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

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

StartDateMonth

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

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

StartDateYear

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

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

Methods

InitParameters()

Initializes Generate parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements