Method: customBiddingAlgorithms.list

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

El parámetro orderBy define el orden.

Solicitud HTTP

GET https://displayvideo.googleapis.com/v1/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. Debe ser un valor entre 1 y 200. Si no se especifica, el valor predeterminado será 100. Muestra 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 mostrar. Por lo general, es el valor de nextPageToken que se muestra en la llamada anterior al método customBiddingAlgorithms.list. Si no se especifica, se mostrará la primera página de resultados.

orderBy

string

Campo por el que se ordenará la lista. Los valores aceptables son:

  • displayName (predeterminada)

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

filter

string

Permite filtrar por campos del algoritmo de ofertas personalizadas.

Sintaxis compatible:

  • Las expresiones de filtro se componen de una o más restricciones.
  • AND puede combinar restricciones. Una secuencia de restricciones usa AND de manera 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 para los que el nombre visible contiene "política": displayName:"politics".
  • Todos los algoritmos de ofertas personalizadas para los que el tipo es "SCRIPT_BASED": customBiddingAlgorithmType=SCRIPT_BASED

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

Consulta nuestra guía de filtros de solicitudes LIST para obtener más información.

Es el parámetro de unión accessor. Obligatorio. Identifica en qué entidad de DV360 se realiza la solicitud. La solicitud LIST solo mostrará las entidades de algoritmos de ofertas personalizadas a las que puede acceder la entidad de DV360 identificada en accessor. Para realizar una solicitud LIST, el usuario debe tener permiso para la entidad accessor. accessor puede ser 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á disponible 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 el campo es nulo, significa que esta es la última página.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.