Show / Hide Table of Contents

Class AdvertisersResource.ListRequest

Lists advertisers that are accessible to the current user. The order is defined by the order_by parameter. A single partner_id is required. Cross-partner listing is not supported.

Inheritance
System.Object
ClientServiceRequest
ClientServiceRequest<ListAdvertisersResponse>
DisplayVideoBaseServiceRequest<ListAdvertisersResponse>
AdvertisersResource.ListRequest
Implements
IClientServiceRequest<ListAdvertisersResponse>
IClientServiceRequest
Inherited Members
DisplayVideoBaseServiceRequest<ListAdvertisersResponse>.Xgafv
DisplayVideoBaseServiceRequest<ListAdvertisersResponse>.AccessToken
DisplayVideoBaseServiceRequest<ListAdvertisersResponse>.Alt
DisplayVideoBaseServiceRequest<ListAdvertisersResponse>.Callback
DisplayVideoBaseServiceRequest<ListAdvertisersResponse>.Fields
DisplayVideoBaseServiceRequest<ListAdvertisersResponse>.Key
DisplayVideoBaseServiceRequest<ListAdvertisersResponse>.OauthToken
DisplayVideoBaseServiceRequest<ListAdvertisersResponse>.PrettyPrint
DisplayVideoBaseServiceRequest<ListAdvertisersResponse>.QuotaUser
DisplayVideoBaseServiceRequest<ListAdvertisersResponse>.UploadType
DisplayVideoBaseServiceRequest<ListAdvertisersResponse>.UploadProtocol
ClientServiceRequest<ListAdvertisersResponse>.Execute()
ClientServiceRequest<ListAdvertisersResponse>.ExecuteAsStream()
ClientServiceRequest<ListAdvertisersResponse>.ExecuteAsync()
ClientServiceRequest<ListAdvertisersResponse>.ExecuteAsync(CancellationToken)
ClientServiceRequest<ListAdvertisersResponse>.ExecuteAsStreamAsync()
ClientServiceRequest<ListAdvertisersResponse>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<ListAdvertisersResponse>.CreateRequest(Nullable<Boolean>)
ClientServiceRequest<ListAdvertisersResponse>.GenerateRequestUri()
ClientServiceRequest<ListAdvertisersResponse>.GetBody()
ClientServiceRequest<ListAdvertisersResponse>.GetDefaultETagAction(String)
ClientServiceRequest<ListAdvertisersResponse>.ETagAction
ClientServiceRequest<ListAdvertisersResponse>.ModifyRequest
ClientServiceRequest<ListAdvertisersResponse>.ValidateParameters
ClientServiceRequest<ListAdvertisersResponse>.RequestParameters
ClientServiceRequest<ListAdvertisersResponse>.Service
ClientServiceRequest._unsuccessfulResponseHandlers
ClientServiceRequest._exceptionHandlers
ClientServiceRequest._executeInterceptors
ClientServiceRequest.AddUnsuccessfulResponseHandler(IHttpUnsuccessfulResponseHandler)
ClientServiceRequest.AddExceptionHandler(IHttpExceptionHandler)
ClientServiceRequest.AddExecuteInterceptor(IHttpExecuteInterceptor)
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.DisplayVideo.v1
Assembly: Google.Apis.DisplayVideo.v1.dll
Syntax
public class ListRequest : DisplayVideoBaseServiceRequest<ListAdvertisersResponse>, IClientServiceRequest<ListAdvertisersResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService)

Constructs a new List request.

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

Properties

Filter

Allows filtering by advertiser 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: - advertiserId - displayName

  • entityStatus - updateTime (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) Examples: * All active advertisers under a partner: entityStatus=&quot;ENTITY_STATUS_ACTIVE&quot; * All advertisers 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 advertisers 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.ListAdvertisersResponse>.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.ListAdvertisersResponse>.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. 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 ListAdvertisers 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

Required. The ID of the partner that the fetched advertisers should all belong to. The system only supports listing advertisers for one partner at a time.

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

Methods

InitParameters()

Initializes List parameter list.

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

Implements

IClientServiceRequest<TResponse>
IClientServiceRequest
In This Article
Back to top Generated by DocFX