Method: advertisers.adGroups.list

Muestra una lista de los grupos de anuncios.

Solicitud HTTP

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

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

Parámetros de ruta de acceso

Parámetros
advertiserId

string (int64 format)

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

Opcional. 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 adGroups.list. Si no se especifica, se mostrará 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 para un campo, se debe agregar el sufijo "desc" al nombre del campo. Ejemplo: displayName desc.
filter

string

Opcional. Permite filtrar por campos de grupos de anuncios personalizados.

Sintaxis compatible:

  • 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 manera implícita.
  • Una restricción tiene el formato {field} {operator} {value}.
  • Todos los campos deben usar el operador EQUALS (=).

Propiedades admitidas:

  • adGroupId
  • displayName
  • entityStatus
  • lineItemId
  • adGroupFormat

Ejemplos:

  • Todos los grupos de anuncios de una línea de pedido: lineItemId="1234"
  • Todos los grupos de anuncios ENTITY_STATUS_ACTIVE o ENTITY_STATUS_PAUSED AD_GROUP_FORMAT_IN_STREAM de un anunciante: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="AD_GROUP_FORMAT_IN_STREAM"

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.

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

object (AdGroup)

Es la lista de grupos de anuncios.

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

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