Show / Hide Table of Contents

Class 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
System.Object
Google.Apis.Requests.ClientServiceRequest
Google.Apis.Requests.ClientServiceRequest<Report>
AdSenseHostBaseServiceRequest<Report>
ReportsResource.GenerateRequest
Implements
Google.Apis.Requests.IClientServiceRequest<Report>
Google.Apis.Requests.IClientServiceRequest
Inherited Members
AdSenseHostBaseServiceRequest<Report>.Alt
AdSenseHostBaseServiceRequest<Report>.Fields
AdSenseHostBaseServiceRequest<Report>.Key
AdSenseHostBaseServiceRequest<Report>.OauthToken
AdSenseHostBaseServiceRequest<Report>.PrettyPrint
AdSenseHostBaseServiceRequest<Report>.QuotaUser
AdSenseHostBaseServiceRequest<Report>.UserIp
Google.Apis.Requests.ClientServiceRequest<Google.Apis.AdSenseHost.v4_1.Data.Report>.Execute()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.AdSenseHost.v4_1.Data.Report>.ExecuteAsStream()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.AdSenseHost.v4_1.Data.Report>.ExecuteAsync()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.AdSenseHost.v4_1.Data.Report>.ExecuteAsync(System.Threading.CancellationToken)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.AdSenseHost.v4_1.Data.Report>.ExecuteAsStreamAsync()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.AdSenseHost.v4_1.Data.Report>.ExecuteAsStreamAsync(System.Threading.CancellationToken)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.AdSenseHost.v4_1.Data.Report>.CreateRequest(System.Nullable<System.Boolean>)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.AdSenseHost.v4_1.Data.Report>.GenerateRequestUri()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.AdSenseHost.v4_1.Data.Report>.GetBody()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.AdSenseHost.v4_1.Data.Report>.GetDefaultETagAction(System.String)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.AdSenseHost.v4_1.Data.Report>.ETagAction
Google.Apis.Requests.ClientServiceRequest<Google.Apis.AdSenseHost.v4_1.Data.Report>.ModifyRequest
Google.Apis.Requests.ClientServiceRequest<Google.Apis.AdSenseHost.v4_1.Data.Report>.ValidateParameters
Google.Apis.Requests.ClientServiceRequest<Google.Apis.AdSenseHost.v4_1.Data.Report>.RequestParameters
Google.Apis.Requests.ClientServiceRequest<Google.Apis.AdSenseHost.v4_1.Data.Report>.Service
Google.Apis.Requests.ClientServiceRequest._unsuccessfulResponseHandlers
Google.Apis.Requests.ClientServiceRequest._exceptionHandlers
Google.Apis.Requests.ClientServiceRequest._executeInterceptors
Google.Apis.Requests.ClientServiceRequest.AddUnsuccessfulResponseHandler(Google.Apis.Http.IHttpUnsuccessfulResponseHandler)
Google.Apis.Requests.ClientServiceRequest.AddExceptionHandler(Google.Apis.Http.IHttpExceptionHandler)
Google.Apis.Requests.ClientServiceRequest.AddExecuteInterceptor(Google.Apis.Http.IHttpExecuteInterceptor)
Google.Apis.Requests.ClientServiceRequest.Credential
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.AdSenseHost.v4_1
Assembly: Google.Apis.AdSenseHost.v4_1.dll
Syntax
public class GenerateRequest : AdSenseHostBaseServiceRequest<Report>, IClientServiceRequest<Report>, IClientServiceRequest

Constructors

GenerateRequest(IClientService, String, String)

Constructs a new Generate request.

Declaration
public GenerateRequest(IClientService service, string startDate, string endDate)
Parameters
Type Name Description
Google.Apis.Services.IClientService service
System.String startDate
System.String endDate

Properties

Dimension

Dimensions to base the report on.

Declaration
[RequestParameter("dimension", RequestParameterType.Query)]
public virtual Repeatable<string> Dimension { get; set; }
Property Value
Type Description
Google.Apis.Util.Repeatable<System.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
System.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
Google.Apis.Util.Repeatable<System.String>

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
System.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
System.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
System.Nullable<System.Int64>

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
System.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
Google.Apis.Util.Repeatable<System.String>

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
System.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
Google.Apis.Util.Repeatable<System.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
System.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
System.Nullable<System.Int64>

Methods

InitParameters()

Initializes Generate parameter list.

Declaration
protected override void InitParameters()
Overrides
Google.Apis.AdSenseHost.v4_1.AdSenseHostBaseServiceRequest<Google.Apis.AdSenseHost.v4_1.Data.Report>.InitParameters()

Implements

Google.Apis.Requests.IClientServiceRequest<TResponse>
Google.Apis.Requests.IClientServiceRequest
In This Article
Back to top