Method: customBiddingAlgorithms.list

Enumera los algoritmos de ofertas personalizadas a los que puede acceder el usuario actual y que se pueden usar en las estrategias de ofertas.

El orden se define con el parámetro orderBy.

Solicitud HTTP

GET https://displayvideo.googleapis.com/v3/customBiddingAlgorithms

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de consulta

Parámetros
pageSize

integer

Indica el tamaño de la página solicitada. La hora debe configurarse entre 1 y 200. Si no se especifica, se establecerá de forma predeterminada como 100. Devuelve el código de error INVALID_ARGUMENT si se especifica un valor no válido.
pageToken

string

Un token que identifica una página de resultados que el servidor debe devolver. Por lo general, este es el valor de nextPageToken que se devolvió de la llamada anterior al método customBiddingAlgorithms.list. Si no se especifica, se devolverá la primera página de resultados.
orderBy

string

Campo según el cual se ordenará la lista. Los valores aceptables son:

  • displayName (predeterminada)

El orden de clasificación predeterminado es ascendente. Para especificar el orden descendente de un campo, se debe agregar el sufijo "desc" al nombre del campo. Ejemplo: displayName desc.
filter

string

Permite filtrar por campos de algoritmos de ofertas personalizadas.

Sintaxis admitida:

  • Las expresiones de filtro se componen de una o más restricciones.
  • Las restricciones se pueden combinar con AND. Una secuencia de restricciones usa AND de forma implícita.
  • Una restricción tiene el formato {field} {operator} {value}.
  • El campo customBiddingAlgorithmType debe usar el operador EQUALS (=).
  • El campo displayName debe usar el operador HAS (:).

Campos admitidos:

  • customBiddingAlgorithmType
  • displayName

Ejemplos:

  • Todos los algoritmos de ofertas personalizadas cuyo nombre visible contenga "política": displayName:"politics".
  • Todos los algoritmos de ofertas personalizadas cuyo tipo es "SCRIPT_BASED": customBiddingAlgorithmType=SCRIPT_BASED

La longitud de este campo no debe superar los 500 caracteres.

Consulta nuestra guía sobre cómo solicitar el filtro LIST para obtener más información.
Parámetro de unión accessor. Obligatorio. Identifica dentro de qué entidad de DV360 se realiza la solicitud. La solicitud LIST solo devolverá entidades de algoritmos de ofertas personalizadas a las que se pueda acceder desde la entidad de DV360 identificada en accessor. Para realizar la solicitud LIST, el usuario debe tener permiso para la entidad accessor. accessor puede ser solo una de las siguientes opciones:
partnerId

string (int64 format)

Es el ID del socio de DV360 que tiene acceso al algoritmo de ofertas personalizadas.
advertiserId

string (int64 format)

Es el ID del anunciante de DV360 que tiene acceso al algoritmo de ofertas personalizadas.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si el proceso es satisfactorio, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "customBiddingAlgorithms": [
    {
      object (CustomBiddingAlgorithm)
    }
  ],
  "nextPageToken": string
}
Campos
customBiddingAlgorithms[]

object (CustomBiddingAlgorithm)

Es la lista de algoritmos de ofertas personalizadas.

Esta lista no estará presente si está vacía.
nextPageToken

string

Un token para recuperar los resultados de la página siguiente. Pasa este valor en el campo pageToken en la llamada posterior al método ListCustomBiddingAlgorithmsRequest para recuperar la siguiente página de resultados. Si este campo es nulo, significa que es la última página.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

Para obtener más información, consulta OAuth 2.0 Overview.