Method: advertisers.list

Enumera los anunciantes a los que puede acceder el usuario actual.

El orden se define con el parámetro orderBy.

Se requiere un solo partnerId. No se admiten las fichas de múltiples socios.

Solicitud HTTP

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

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

Parámetros de consulta

Parámetros
partnerId

string (int64 format)

Obligatorio. Es el ID del socio al que deben pertenecer todos los anunciantes recuperados. El sistema solo admite la inclusión de anunciantes en la lista de un socio a la vez.
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.
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 advertisers.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:

  • advertiserId (predeterminada)
  • displayName
  • entityStatus
  • updateTime

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. Por ejemplo, displayName desc.
filter

string

Permite filtrar por campos del anunciante.

Sintaxis admitida:

  • Las expresiones de filtro se componen de una o más restricciones.
  • Las restricciones se pueden combinar con los operadores lógicos AND o OR.
  • Una restricción tiene el formato {field} {operator} {value}.
  • El campo updateTime debe usar los operadores GREATER THAN OR EQUAL TO (>=) o LESS THAN OR EQUAL TO (<=).
  • Todos los demás campos deben usar el operador EQUALS (=).

Campos admitidos:

  • advertiserId
  • displayName
  • entityStatus
  • updateTime (entrada en formato ISO 8601 o YYYY-MM-DDTHH:MM:SSZ)

Ejemplos:

  • Todos los anunciantes activos de un socio: entityStatus="ENTITY_STATUS_ACTIVE"
  • Todos los anunciantes con una fecha de actualización inferior o igual a 2020-11-04T18:54:47Z (formato ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • Todos los anunciantes con una fecha y hora de actualización mayor o igual a 2020-11-04T18:54:47Z (formato ISO 8601): updateTime>="2020-11-04T18:54:47Z"

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.

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 
{
  "advertisers": [
    {
      object (Advertiser)
    }
  ],
  "nextPageToken": string
}
Campos
advertisers[]

object (Advertiser)

Es la lista de anunciantes.

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 advertisers.list para recuperar la siguiente página de resultados.

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.