Class AccountsResource.ReportsResource.GenerateRequest

Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<Report>
AdSenseHostBaseServiceRequest<Report>
AccountsResource.ReportsResource.GenerateRequest
Implements
Inherited Members
Namespace: Google.Apis.AdSenseHost.v4_1
Assembly: Google.Apis.AdSenseHost.v4_1.dll
Syntax
public class AccountsResource.ReportsResource.GenerateRequest : AdSenseHostBaseServiceRequest<Report>, IClientServiceRequest<Report>, IClientServiceRequest

Constructors

GenerateRequest(IClientService, string, string, string)

Constructs a new Generate request.

Declaration
public GenerateRequest(IClientService service, string accountId, string startDate, string endDate)
Parameters
Type Name Description
IClientService service
string accountId
string startDate
string endDate

Properties

AccountId

Hosted account upon which to report.

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

Dimension

Dimensions to base the report on.

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

EndDate

End of the date range to report on in "YYYY-MM-DD" format, inclusive.

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

Filter

Filters to be run on the report.

Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual Repeatable<string> Filter { 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.AdSenseHost.v4_1.Data.Report>.HttpMethod

Locale

Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.

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

MaxResults

The maximum number of rows of report data to return.

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

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.AdSenseHost.v4_1.Data.Report>.MethodName

Metric

Numeric columns to include in the report.

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

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.AdSenseHost.v4_1.Data.Report>.RestPath

Sort

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

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

StartDate

Start of the date range to report on in "YYYY-MM-DD" format, inclusive.

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

StartIndex

Index of the first row of report data to return.

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

Methods

InitParameters()

Initializes Generate parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements