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
object
ClientServiceRequest
ClientServiceRequest<ListCampaignsResponse>
DisplayVideoBaseServiceRequest<ListCampaignsResponse>
AdvertisersResource.CampaignsResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.DisplayVideo.v4
Assembly: Google.Apis.DisplayVideo.v4.dll
Syntax
public class AdvertisersResource.CampaignsResource.ListRequest : DisplayVideoBaseServiceRequest<ListCampaignsResponse>, IClientServiceRequest<ListCampaignsResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, long)

Constructs a new List request.

Declaration
public ListRequest(IClientService service, long advertiserId)
Parameters
Type Name Description
IClientService service
long 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
long

Filter

Allows filtering by campaign fields. 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 updateTime field must use the GREATER THAN OR EQUAL TO (&gt;=) or LESS THAN OR EQUAL TO (&lt;=) operators. * All other fields must use the EQUALS (=) operator. 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="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")

  • All campaigns with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): updateTime&lt;="2020-11-04T18:54:47Z" * All campaigns with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): updateTime&gt;="2020-11-04T18:54:47Z" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.
Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual string Filter { get; set; }
Property Value
Type Description
string

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

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
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
int?

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
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements