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
Inherited Members
Namespace: Google.Apis.DisplayVideo.v1
Assembly: Google.Apis.DisplayVideo.v1.dll
Syntax
public class AdvertisersResource.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 fields. Supported syntax: * Filter expressions are made up of one or more
restrictions. * Restrictions can be combined by AND
or OR
logical operators. * A restriction has the
form of {field} {operator} {value}
. * The updateTime
field must use the GREATER THAN OR EQUAL TO (>=)
or LESS THAN OR EQUAL TO (<=)
operators. * All other fields must use the EQUALS (=)
operator. 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="ENTITY_STATUS_ACTIVE"
* All advertisers with an update time less than or equal to
2020-11-04T18:54:47Z (format of ISO 8601): updateTime<="2020-11-04T18:54:47Z"
* All advertisers
with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601):
updateTime>="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. For 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 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 |
---|---|
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 |
---|---|
long? |
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()