Class GuaranteedOrdersResource.ListRequest

Lists guaranteed orders that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, guaranteed orders with entity status ENTITY_STATUS_ARCHIVED will not be included in the results.

Inheritance
System.Object
ClientServiceRequest
ClientServiceRequest<ListGuaranteedOrdersResponse>
DisplayVideoBaseServiceRequest<ListGuaranteedOrdersResponse>
GuaranteedOrdersResource.ListRequest
Implements
Inherited Members
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.DisplayVideo.v1
Assembly: Google.Apis.DisplayVideo.v1.dll
Syntax
public class ListRequest : DisplayVideoBaseServiceRequest<ListGuaranteedOrdersResponse>, IClientServiceRequest<ListGuaranteedOrdersResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService)

Constructs a new List request.

Declaration
public ListRequest(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

AdvertiserId

The ID of the advertiser that has access to the guaranteed order.

Declaration
[RequestParameter("advertiserId", RequestParameterType.Query)]
public virtual long? AdvertiserId { get; set; }
Property Value
Type Description
System.Nullable<System.Int64>

Filter

Allows filtering by guaranteed order properties. * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND. * A restriction has the form of {field} {operator} {value}. * The operator must be EQUALS (=). * Supported fields: - guaranteed_order_id - exchange - display_name

  • status.entityStatus Examples: * All active guaranteed orders: status.entityStatus=&quot;ENTITY_STATUS_ACTIVE&quot; * Guaranteed orders belonging to Google Ad Manager or Rubicon exchanges: exchange=&quot;EXCHANGE_GOOGLE_AD_MANAGER&quot; OR exchange=&quot;EXCHANGE_RUBICON&quot; The length of this field should be no more than 500 characters.
Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual string Filter { get; set; }
Property Value
Type Description
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.DisplayVideo.v1.Data.ListGuaranteedOrdersResponse>.HttpMethod

MethodName

Gets the method name.

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

OrderBy

Field by which to sort the list. Acceptable values are: * displayName (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, displayName desc.

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

PageSize

Requested page size. Must be between 1 and 200. If unspecified will default to 100.

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

PageToken

A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListGuaranteedOrders method. If not specified, the first page of results will be returned.

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

PartnerId

The ID of the partner that has access to the guaranteed order.

Declaration
[RequestParameter("partnerId", RequestParameterType.Query)]
public virtual long? PartnerId { get; set; }
Property Value
Type Description
System.Nullable<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.DisplayVideo.v1.Data.ListGuaranteedOrdersResponse>.RestPath

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides
Google.Apis.DisplayVideo.v1.DisplayVideoBaseServiceRequest<Google.Apis.DisplayVideo.v1.Data.ListGuaranteedOrdersResponse>.InitParameters()

Implements