Class CustomBiddingAlgorithmsResource.ListRequest
Lists custom bidding algorithms that are accessible to the current user and can be used in bidding stratgies. 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<ListCustomBiddingAlgorithmsResponse>, IClientServiceRequest<ListCustomBiddingAlgorithmsResponse>, 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 DV360 advertiser that has access to the custom bidding algorithm.
Declaration
[RequestParameter("advertiserId", RequestParameterType.Query)]
public virtual long? AdvertiserId { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Int64> |
Filter
Allows filtering by custom bidding algorithm fields. Supported syntax: * Filter expressions are made up
of one or more restrictions. * Restrictions can be combined by AND
. A sequence of restrictions *
implicitly uses AND
. * A restriction has the form of {field} {operator} {value}
. * The operator must
be CONTAINS (:)
or EQUALS (=)
. * The operator must be CONTAINS (:)
for the following field: -
displayName
* The operator must be EQUALS (=)
for the following field: -
customBiddingAlgorithmType
* For displayName
, the value is a string. We return all custom bidding
algorithms whose display_name contains such string. * For customBiddingAlgorithmType
, the value is a
string. We return all algorithms whose custom_bidding_algorithm_type is equal to the given type.
Examples: * All custom bidding algorithms for which the display name contains "politics":
displayName:politics
. * All custom bidding algorithms for which the type is "SCRIPT_BASED":
customBiddingAlgorithmType=SCRIPT_BASED
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: * displayName
(default) 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 ListCustomBiddingAlgorithms
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 DV360 partner that has access to the custom bidding algorithm.
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()