Method: customBiddingAlgorithms.rules.list

    • This document outlines how to list rules resources belonging to a given custom bidding algorithm using the Display & Video 360 API v3.

    • The API endpoint for listing rules is GET https://displayvideo.googleapis.com/v3/customBiddingAlgorithms/{customBiddingAlgorithmId}/rules .

    • The required path parameter is customBiddingAlgorithmId , which is the ID of the custom bidding algorithm.

    • Query parameters like pageSize , pageToken , and orderBy can be used to control the pagination and sorting of the results.

    • The response body contains a list of customBiddingRules and a nextPageToken if there are more results.

    Lists rules resources that belong to the given algorithm.

    The order is defined by the orderBy parameter.

    HTTP request

    GET https://displayvideo.googleapis.com/v3/customBiddingAlgorithms/{customBiddingAlgorithmId}/rules

    The URL uses gRPC Transcoding syntax.

    Path parameters

    Parameters
    customBiddingAlgorithmId

    string ( int64 format)

    Required. The ID of the custom bidding algorithm that owns the rules resource.

    Query parameters

    Parameters
    pageSize

    integer

    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

    string

    A token identifying a page of results the server should return. Typically, this is the value of nextPageToken returned from the previous call to rules.list method. If not specified, the first page of results will be returned.

    orderBy

    string

    Field by which to sort the list. Acceptable values are:

    • createTime desc (default)

    The default sorting order is descending. To specify ascending order for a field, the suffix "desc" should be removed. Example: createTime .

    Union parameter accessor . Required. Identifies the DV360 entity that owns the parent custom bidding algorithm. It can be either a partner or an advertiser. accessor can be only one of the following:
    partnerId

    string ( int64 format)

    The ID of the partner that owns the parent custom bidding algorithm.

    advertiserId

    string ( int64 format)

    The ID of the advertiser that owns the parent custom bidding algorithm.

    Request body

    The request body must be empty.

    Response body

    If successful, the response body contains data with the following structure:

    JSON representation 
     { 
 "customBiddingRules" 
 : 
 [ 
 { 
 object (  CustomBiddingAlgorithmRules 
 
) 
 } 
 ] 
 , 
 "nextPageToken" 
 : 
 string 
 }
    Fields
    customBiddingRules[]

    object ( CustomBiddingAlgorithmRules )

    The list of CustomBiddingAlgorithmRules resources.

    This list will be absent if empty.
    nextPageToken

    string

    A token to retrieve the next page of results. Pass this value in the pageToken field in the subsequent call to ListCustomBiddingAlgorithmRulesRequest method to retrieve the next page of results. If this field is null, it means this is the last page.

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/display-video

    For more information, see the OAuth 2.0 Overview .
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: