list method
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.
Request parameters:
advertiserId
- The ID of the DV360 advertiser that has access to the
custom bidding algorithm.
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 customBiddingAlgorithmType
field must use the EQUALS (=)
operator. * The displayName
field must use the HAS (:)
operator.
Supported fields: * customBiddingAlgorithmType
* displayName
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. Reference our [filterLIST
requests](/display-video/api/guides/how-tos/filters) guide for more information.
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
.
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.
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.
partnerId
- The ID of the DV360 partner that has access to the custom
bidding algorithm.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a ListCustomBiddingAlgorithmsResponse.
Completes with a commons.ApiRequestError if the API endpoint returned an error.
If the used http.Client
completes with an error when making a REST call,
this method will complete with the same error.
Implementation
async.Future<ListCustomBiddingAlgorithmsResponse> list({
core.String? advertiserId,
core.String? filter,
core.String? orderBy,
core.int? pageSize,
core.String? pageToken,
core.String? partnerId,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (advertiserId != null) 'advertiserId': [advertiserId],
if (filter != null) 'filter': [filter],
if (orderBy != null) 'orderBy': [orderBy],
if (pageSize != null) 'pageSize': ['${pageSize}'],
if (pageToken != null) 'pageToken': [pageToken],
if (partnerId != null) 'partnerId': [partnerId],
if ($fields != null) 'fields': [$fields],
};
const url_ = 'v2/customBiddingAlgorithms';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListCustomBiddingAlgorithmsResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}