Class AdvertisersResource.CampaignsResource.ListRequest

Lists campaigns in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, campaigns with ENTITY_STATUS_ARCHIVED will not be included in the results.

Inheritance
System.Object
ClientServiceRequest
ClientServiceRequest<ListCampaignsResponse>
DisplayVideoBaseServiceRequest<ListCampaignsResponse>
AdvertisersResource.CampaignsResource.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<ListCampaignsResponse>, IClientServiceRequest<ListCampaignsResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, Int64)

Constructs a new List request.

Declaration
public ListRequest(IClientService service, long advertiserId)
Parameters
Type Name Description
IClientService service
System.Int64 advertiserId

Properties

AdvertiserId

The ID of the advertiser to list campaigns for.

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

Filter

Allows filtering by campaign properties. Supported syntax: * 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 used on updateTime must be GREATER THAN OR EQUAL TO (&amp;gt;=) or LESS THAN OR EQUAL TO (&amp;lt;=). * The operator must be EQUALS (=). * Supported fields: - campaignId - displayName - entityStatus - updateTime (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) Examples: * All ENTITY_STATUS_ACTIVE or ENTITY_STATUS_PAUSED campaigns under an advertiser: (entityStatus=&quot;ENTITY_STATUS_ACTIVE&quot; OR entityStatus=&quot;ENTITY_STATUS_PAUSED&quot;) * All campaigns with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): updateTime&amp;lt;=&quot;2020-11-04T18:54:47Z&quot; * All campaigns with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): updateTime&amp;gt;=&quot;2020-11-04T18:54:47Z&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.ListCampaignsResponse>.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.ListCampaignsResponse>.MethodName

OrderBy

Field by which to sort the list. Acceptable values are: * displayName (default) * entityStatus * updateTime The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. 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 ListCampaigns 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

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.ListCampaignsResponse>.RestPath

Methods

InitParameters()

Initializes List parameter list.

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

Implements