Method: advertisers.adGroupAds.list

Enumera los anuncios del grupo de anuncios.

Solicitud HTTP

GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/adGroupAds

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

Parámetros de ruta

Parámetros
advertiserId

string (int64 format)

Obligatorio. Es el ID del anunciante al que pertenecen los anuncios.

Parámetros de consulta

Parámetros
pageSize

integer

Opcional. Indica el tamaño de la página solicitada. La hora debe configurarse entre 1 y 100. 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

Opcional. 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 adGroupAds.list. Si no se especifica, se devolverá la primera página de resultados.
orderBy

string

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

  • displayName (predeterminada)
  • entityStatus

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

Opcional. Permite filtrar por los campos de anuncios del grupo de anuncios.

Sintaxis admitida:

  • Las expresiones de filtro se componen de una o más restricciones.
  • Las restricciones se pueden combinar con AND y OR. Una secuencia de restricciones usa AND de forma implícita.
  • Una restricción tiene el formato {field} {operator} {value}.
  • Todos los campos deben usar el operador EQUALS (=).

Campos admitidos:

  • adGroupId
  • displayName
  • entityStatus
  • adGroupAdId

Ejemplos:

  • Todos los anuncios del grupo de anuncios: adGroupId="1234"
  • Todos los anuncios del grupo de anuncios con un entityStatus de ENTITY_STATUS_ACTIVE o ENTITY_STATUS_PAUSED: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345"

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

object (AdGroupAd)

Es la lista de anuncios.

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 adGroupAds.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.