Class FirstPartyAndPartnerAudiencesResource.ListRequest

Lists first party and partner audiences. The order is defined by the order_by parameter.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<ListFirstPartyAndPartnerAudiencesResponse>
DisplayVideoBaseServiceRequest<ListFirstPartyAndPartnerAudiencesResponse>
FirstPartyAndPartnerAudiencesResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.DisplayVideo.v4
Assembly: Google.Apis.DisplayVideo.v4.dll
Syntax
public class FirstPartyAndPartnerAudiencesResource.ListRequest : DisplayVideoBaseServiceRequest<ListFirstPartyAndPartnerAudiencesResponse>, IClientServiceRequest<ListFirstPartyAndPartnerAudiencesResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService)

Constructs a new List request.

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

Properties

AdvertiserId

The ID of the advertiser that has access to the fetched first party and partner audiences.

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

Filter

Optional. Allows filtering by first party and partner audience fields. Supported syntax: * Filter expressions for first party and partner audiences can only contain at most one restriction. * A restriction has the form of {field} {operator} {value}. * All fields must use the HAS (:) operator. Supported fields: * displayName Examples: * All first party and partner audiences for which the display name contains "Google": displayName:"Google". 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

Optional. Field by which to sort the list. Acceptable values are: * FirstPartyAndPartnerAudienceId (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
string

PageSize

Optional. Requested page size. Must be between 1 and 5000. If unspecified, this value defaults to 5000. 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
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 ListFirstPartyAndPartnerAudiences 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

The ID of the partner that has access to the fetched first party and partner audiences.

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()
Overrides

Implements