Class AdvertisersResource.ReachForecastResource.RetrievePlannableUserListsRequest

Retrieves first and third party user lists available for forecasting. API support for generating reach forecasts and retrieving related metadata is in beta. This method is only available to allowlisted users.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<RetrievePlannableUserListsResponse>
DisplayVideoBaseServiceRequest<RetrievePlannableUserListsResponse>
AdvertisersResource.ReachForecastResource.RetrievePlannableUserListsRequest
Implements
Inherited Members
Namespace: Google.Apis.DisplayVideo.v4
Assembly: Google.Apis.DisplayVideo.v4.dll
Syntax
public class AdvertisersResource.ReachForecastResource.RetrievePlannableUserListsRequest : DisplayVideoBaseServiceRequest<RetrievePlannableUserListsResponse>, IClientServiceRequest<RetrievePlannableUserListsResponse>, IClientServiceRequest

Constructors

RetrievePlannableUserListsRequest(IClientService, long)

Constructs a new RetrievePlannableUserLists request.

Declaration
public RetrievePlannableUserListsRequest(IClientService service, long advertiserId)
Parameters
Type Name Description
IClientService service
long advertiserId

Properties

AdvertiserId

Required. The ID of the advertiser to retrieve plannable user lists for.

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

Filter

Optional. Allows filtering by plannable user list properties. 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 displayName field must use the HAS (:) operator. * All other fields must use the EQUALS (=) operator. Supported fields: * plannableStatus * displayName * userListType * name Examples: * All plannable user lists: plannableStatus="PLANNABLE" * Plannable user lists with display name containing "Shopping": plannableStatus="PLANNABLE" AND displayName:"Shopping" * First party user lists: userListType="FIRST_PARTY" 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

PageSize

Optional. Requested page size. Must be between 1 and 5000. If unspecified will default to 5000.

Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

PageToken

Optional. 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 RetrievePlannableUserLists 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 RetrievePlannableUserLists parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements