Table of Contents

Class AccountsResource.ReportsResource.GenerateRequest

Namespace
Google.Apis.AdSense.v1_4
Assembly
Google.Apis.AdSense.v1_4.dll

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.

public class AccountsResource.ReportsResource.GenerateRequest : AdSenseBaseServiceRequest<AdsenseReportsGenerateResponse>
Inheritance
AccountsResource.ReportsResource.GenerateRequest
Inherited Members

Constructors

GenerateRequest(IClientService, string, string, string)

Constructs a new Generate request.

public GenerateRequest(IClientService service, string accountId, string startDate, string endDate)

Parameters

service IClientService
accountId string
startDate string
endDate string

Properties

AccountId

Account upon which to report.

public virtual string AccountId { get; }

Property Value

string

Currency

Optional currency to use when reporting on monetary metrics. Defaults to the account's currency if not set.

public virtual string Currency { get; set; }

Property Value

string

Dimension

Dimensions to base the report on.

public virtual Repeatable<string> Dimension { get; set; }

Property Value

Repeatable<string>

EndDate

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

public virtual string EndDate { get; }

Property Value

string

Filter

Filters to be run on the report.

public virtual Repeatable<string> Filter { get; set; }

Property Value

Repeatable<string>

HttpMethod

Gets the HTTP method.

public override string HttpMethod { get; }

Property Value

string

Locale

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

public virtual string Locale { get; set; }

Property Value

string

MaxResults

The maximum number of rows of report data to return.

public virtual int? MaxResults { get; set; }

Property Value

int?

MediaDownloader

Gets the media downloader.

public IMediaDownloader MediaDownloader { get; }

Property Value

IMediaDownloader

MethodName

Gets the method name.

public override string MethodName { get; }

Property Value

string

Metric

Numeric columns to include in the report.

public virtual Repeatable<string> Metric { get; set; }

Property Value

Repeatable<string>

RestPath

Gets the REST path.

public override string RestPath { get; }

Property Value

string

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.

public virtual Repeatable<string> Sort { get; set; }

Property Value

Repeatable<string>

StartDate

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

public virtual string StartDate { get; }

Property Value

string

StartIndex

Index of the first row of report data to return.

public virtual int? StartIndex { get; set; }

Property Value

int?

UseTimezoneReporting

Whether the report should be generated in the AdSense account's local timezone. If false default PST/PDT timezone will be used.

public virtual bool? UseTimezoneReporting { get; set; }

Property Value

bool?

Methods

Download(Stream)

Synchronously download the media into the given stream.

public virtual void Download(Stream stream)

Parameters

stream Stream

DownloadAsync(Stream)

Asynchronously download the media into the given stream.

public virtual Task<IDownloadProgress> DownloadAsync(Stream stream)

Parameters

stream Stream

Returns

Task<IDownloadProgress>

DownloadAsync(Stream, CancellationToken)

Asynchronously download the media into the given stream.

public virtual Task<IDownloadProgress> DownloadAsync(Stream stream, CancellationToken cancellationToken)

Parameters

stream Stream
cancellationToken CancellationToken

Returns

Task<IDownloadProgress>

InitParameters()

Initializes Generate parameter list.

protected override void InitParameters()