# Display & Video 360 API . customBiddingAlgorithms

## Instance Methods

Close httplib2 connections.

Gets a custom bidding algorithm.

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.

Retrieves the next page of results.

### Method Details

`close()`

    Close httplib2 connections.

`get(customBiddingAlgorithmId, partnerId=None, advertiserId=None, x__xgafv=None)`

    Gets a custom bidding algorithm.

    Args:
      customBiddingAlgorithmId: string, Required. The ID of the custom bidding algorithm to fetch. (required)
      partnerId: string, The ID of the DV360 partner that has access to the custom bidding algorithm.
      advertiserId: string, The ID of the DV360 partner that has access to the custom bidding algorithm.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # A single custom bidding algorithm.
        "name": "A String", # Output only. The resource name of the custom bidding algorithm.
        "entityStatus": "A String", # Controls whether or not the custom bidding algorithm can be used as a bidding strategy. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED`
        "advertiserId": "A String", # Immutable. The unique ID of the advertiser that owns the custom bidding algorithm.
        "customBiddingAlgorithmId": "A String", # Output only. The unique ID of the custom bidding algorithm. Assigned by the system.
        "displayName": "A String", # Required. The display name of the custom bidding algorithm. Must be UTF-8 encoded with a maximum size of 240 bytes.
        "customBiddingAlgorithmType": "A String", # Required. Immutable. The type of custom bidding algorithm.
        "partnerId": "A String", # Immutable. The unique ID of the partner that owns the custom bidding algorithm.
      }

`list(orderBy=None, pageSize=None, pageToken=None, advertiserId=None, filter=None, partnerId=None, x__xgafv=None)`

    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.

    Args:
      orderBy: string, 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: integer, Requested page size. Must be between `1` and `100`. 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 next_page_token returned from the previous call to `ListCustomBiddingAlgorithms` method. If not specified, the first page of results will be returned.
      advertiserId: string, The ID of the DV360 advertiser that has access to the custom bidding algorithm.
      filter: string, 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.
      partnerId: string, The ID of the DV360 partner that has access to the custom bidding algorithm.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        {
        "customBiddingAlgorithms": [ # The list of custom bidding algorithms. This list will be absent if empty.
          { # A single custom bidding algorithm.
            "name": "A String", # Output only. The resource name of the custom bidding algorithm.
            "entityStatus": "A String", # Controls whether or not the custom bidding algorithm can be used as a bidding strategy. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED`
            "advertiserId": "A String", # Immutable. The unique ID of the advertiser that owns the custom bidding algorithm.
            "customBiddingAlgorithmId": "A String", # Output only. The unique ID of the custom bidding algorithm. Assigned by the system.
            "displayName": "A String", # Required. The display name of the custom bidding algorithm. Must be UTF-8 encoded with a maximum size of 240 bytes.
            "customBiddingAlgorithmType": "A String", # Required. Immutable. The type of custom bidding algorithm.
            "partnerId": "A String", # Immutable. The unique ID of the partner that owns the custom bidding algorithm.
          },
        ],
        "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCustomBiddingAlgorithmsRequest` method to retrieve the next page of results. If this field is null, it means this is the last page.
      }

`list_next(previous_request, previous_response)`

    Retrieves the next page of results.

    Args:
      previous_request: The request for the previous page. (required)
      previous_response: The response from the request for the previous page. (required)

    Returns:
      A request object that you can call 'execute()' on to request the next
      page. Returns None if there are no more items in the collection.