Class FirstAndThirdPartyAudiencesResource.ListRequest
Lists first and third party audiences. 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<ListFirstAndThirdPartyAudiencesResponse>, IClientServiceRequest<ListFirstAndThirdPartyAudiencesResponse>, 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 advertiser that has access to the fetched first and third party audiences.
Declaration
[RequestParameter("advertiserId", RequestParameterType.Query)]
public virtual long? AdvertiserId { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> |
Filter
Allows filtering by first and third party audience fields. Supported syntax: * Filter expressions for
first and third party audiences 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 first and third party audiences 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: * firstAndThirdPartyAudienceId (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 ListFirstAndThirdPartyAudiences 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
The ID of the partner that has access to the fetched first and third party audiences.
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
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()