Class CustomListsResource.ListRequest
Lists custom lists. The order is defined by the order_by parameter.
Inheritance
Inherited Members
Namespace: Google.Apis.DisplayVideo.v1
Assembly: Google.Apis.DisplayVideo.v1.dll
Syntax
public class ListRequest : DisplayVideoBaseServiceRequest<ListCustomListsResponse>, IClientServiceRequest<ListCustomListsResponse>, IClientServiceRequestConstructors
ListRequest(IClientService)
Constructs a new List request.
Declaration
public ListRequest(IClientService service)Parameters
| Type | Name | Description |
|---|---|---|
| IClientService | service |
Properties
AdvertiserId
The ID of the DV360 advertiser that has access to the fetched custom lists.
Declaration
[RequestParameter("advertiserId", RequestParameterType.Query)]
public virtual long? AdvertiserId { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> |
Filter
Allows filtering by custom list fields. Supported syntax: * Filter expressions for custom lists
currently can only contain at most one restriction. * A restriction has the form of {field} {operator}
{value}. * The operator must be CONTAINS (:). * Supported fields: - displayName Examples: * All
custom lists for which the display name contains "Google": displayName : "Google". 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
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
OrderBy
Field by which to sort the list. Acceptable values are: * customListId (default) * displayName 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. Returns error
code INVALID_ARGUMENT if an invalid value is specified.
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 ListCustomLists 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
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()