Method: advertisers.campaigns.list

Muestra una lista de las campañas de un anunciante.

El orden se define mediante el parámetro orderBy. Si no se especifica un valor de filter para entityStatus, los resultados no incluirán campañas con ENTITY_STATUS_ARCHIVED.

Solicitud HTTP

GET https://displayvideo.googleapis.com/v2/advertisers/{advertiserId}/campaigns

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

Parámetros de ruta de acceso

Parámetros
advertiserId

string (int64 format)

El ID del anunciante para el que se enumeran las campañas.

Parámetros de consulta

Parámetros
pageSize

integer

Indica el tamaño de la página solicitada. El valor debe estar entre 1 y 200. Si no se especifica, el valor predeterminado será 100.
pageToken

string

Es un token que identifica una página de resultados que el servidor debería mostrar. Por lo general, es el valor de nextPageToken que muestra la llamada anterior al método campaigns.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)
  • entityStatus
  • updateTime

El orden 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 de campaña.

Sintaxis compatible:

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

Campos admitidos:

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

Ejemplos:

  • Todas las campañas ENTITY_STATUS_ACTIVE o ENTITY_STATUS_PAUSED de un anunciante: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
  • Todas las campañas con una hora de actualización inferior o igual a 2020-11-04T18:54:47Z (formato ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • Todas las campañas con una fecha de actualización mayor o igual que 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 solicitudes de 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 
{
  "campaigns": [
    {
      object (Campaign)
    }
  ],
  "nextPageToken": string
}
Campos
campaigns[]

object (Campaign)

La lista de campañas.

Esta lista no aparecerá 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 campaigns.list para recuperar la siguiente página de resultados.

Permisos de autorización

Se necesita uno de los siguientes alcances de OAuth:

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

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