Class OrderDocumentsResource.ListRequest

Retrieves a list of order documents, possibly filtered. This method supports paging.

Inheritance
System.Object
Google.Apis.Requests.ClientServiceRequest
Google.Apis.Requests.ClientServiceRequest<OrderDocumentsListResponse>
DfareportingBaseServiceRequest<OrderDocumentsListResponse>
OrderDocumentsResource.ListRequest
Implements
Google.Apis.Requests.IClientServiceRequest<OrderDocumentsListResponse>
Google.Apis.Requests.IClientServiceRequest
Inherited Members
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.OrderDocumentsListResponse>.Execute()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.OrderDocumentsListResponse>.ExecuteAsStream()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.OrderDocumentsListResponse>.ExecuteAsync()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.OrderDocumentsListResponse>.ExecuteAsync(System.Threading.CancellationToken)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.OrderDocumentsListResponse>.ExecuteAsStreamAsync()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.OrderDocumentsListResponse>.ExecuteAsStreamAsync(System.Threading.CancellationToken)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.OrderDocumentsListResponse>.CreateRequest(System.Nullable<System.Boolean>)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.OrderDocumentsListResponse>.GenerateRequestUri()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.OrderDocumentsListResponse>.GetBody()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.OrderDocumentsListResponse>.GetDefaultETagAction(System.String)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.OrderDocumentsListResponse>.ETagAction
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.OrderDocumentsListResponse>.ModifyRequest
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.OrderDocumentsListResponse>.ValidateParameters
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.OrderDocumentsListResponse>.RequestParameters
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.OrderDocumentsListResponse>.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.Dfareporting.v3_4
Assembly: Google.Apis.Dfareporting.v3_4.dll
Syntax
public class ListRequest : DfareportingBaseServiceRequest<OrderDocumentsListResponse>, IClientServiceRequest<OrderDocumentsListResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, Int64, Int64)

Constructs a new List request.

Declaration
public ListRequest(IClientService service, long profileId, long projectId)
Parameters
Type Name Description
Google.Apis.Services.IClientService service
System.Int64 profileId
System.Int64 projectId

Properties

Approved

Select only order documents that have been approved by at least one user.

Declaration
[RequestParameter("approved", RequestParameterType.Query)]
public virtual bool? Approved { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.OrderDocumentsListResponse>.HttpMethod

Ids

Select only order documents with these IDs.

Declaration
[RequestParameter("ids", RequestParameterType.Query)]
public virtual Repeatable<string> Ids { get; set; }
Property Value
Type Description
Google.Apis.Util.Repeatable<System.String>

MaxResults

Maximum number of results to return.

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

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.OrderDocumentsListResponse>.MethodName

OrderId

Select only order documents for specified orders.

Declaration
[RequestParameter("orderId", RequestParameterType.Query)]
public virtual Repeatable<string> OrderId { get; set; }
Property Value
Type Description
Google.Apis.Util.Repeatable<System.String>

PageToken

Value of the nextPageToken from the previous result page.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
System.String

ProfileId

User profile ID associated with this request.

Declaration
[RequestParameter("profileId", RequestParameterType.Path)]
public virtual long ProfileId { get; }
Property Value
Type Description
System.Int64

ProjectId

Project ID for order documents.

Declaration
[RequestParameter("projectId", RequestParameterType.Path)]
public virtual long ProjectId { get; }
Property Value
Type Description
System.Int64

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.OrderDocumentsListResponse>.RestPath

SearchString

Allows searching for order documents by name or ID. Wildcards () are allowed. For example, "orderdocument2015" will return order documents with names like "orderdocument June 2015", "orderdocument April 2015", or simply "orderdocument 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "orderdocument" will match order documents with name "my orderdocument", "orderdocument 2015", or simply "orderdocument".

Declaration
[RequestParameter("searchString", RequestParameterType.Query)]
public virtual string SearchString { get; set; }
Property Value
Type Description
System.String

SiteId

Select only order documents that are associated with these sites.

Declaration
[RequestParameter("siteId", RequestParameterType.Query)]
public virtual Repeatable<string> SiteId { get; set; }
Property Value
Type Description
Google.Apis.Util.Repeatable<System.String>

SortField

Field by which to sort the list.

Declaration
[RequestParameter("sortField", RequestParameterType.Query)]
public virtual OrderDocumentsResource.ListRequest.SortFieldEnum? SortField { get; set; }
Property Value
Type Description
System.Nullable<OrderDocumentsResource.ListRequest.SortFieldEnum>

SortOrder

Order of sorted results.

Declaration
[RequestParameter("sortOrder", RequestParameterType.Query)]
public virtual OrderDocumentsResource.ListRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type Description
System.Nullable<OrderDocumentsResource.ListRequest.SortOrderEnum>

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides
Google.Apis.Dfareporting.v3_4.DfareportingBaseServiceRequest<Google.Apis.Dfareporting.v3_4.Data.OrderDocumentsListResponse>.InitParameters()

Implements

Google.Apis.Requests.IClientServiceRequest<TResponse>
Google.Apis.Requests.IClientServiceRequest