Method: advertisers.adGroupAds.list

Muestra los anuncios del grupo de anuncios.

Solicitud HTTP

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

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

Parámetros de ruta de acceso

Parámetros
advertiserId

string (int64 format)

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

Parámetros de consulta

Parámetros
pageSize

integer

Opcional. Indica el tamaño de la página solicitada. El valor debe estar comprendido entre 1 y 100. Si no se especifica, se usará el valor predeterminado 100. Muestra 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 mostrar. Por lo general, este es el valor de nextPageToken que se muestra de la llamada anterior al método adGroupAds.list. Si no se especifica, se mostrará la primera página de resultados.
orderBy

string

Opcional. Campo según el cual se ordenan los resultados. 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 un sufijo "desc" al nombre del campo. Ejemplo: displayName desc.
filter

string

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

Sintaxis admitida:

  • Las expresiones de filtro constan 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 de un grupo de anuncios: adGroupId="1234"
  • Todos los anuncios de un 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 de solicitudes de LIST de filtro 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)

La lista de anuncios del grupo de anuncios.

Esta lista no se mostrará 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.

Alcances de 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.