Method: advertisers.creatives.list

Muestra una lista de las creatividades de un anunciante.

El orden se define con el parámetro orderBy. Si no se especifica un filter por entityStatus, las creatividades con ENTITY_STATUS_ARCHIVED no se incluirán en los resultados.

Solicitud HTTP

GET https://displayvideo.googleapis.com/v1beta2/advertisers/{advertiserId}/creatives

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 para el que se enumeran las creatividades.

Parámetros de consulta

Parámetros
pageSize

integer

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

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 en la llamada anterior al método creatives.list. Si no se especifica, se mostrará la primera página de resultados.
orderBy

string

Es el campo que se usa para ordenar la lista. Los valores aceptables son:

  • creativeId (predeterminada)
  • createTime
  • mediaDuration
  • dimensions (primero ordena por ancho y, luego, por altura)

El orden predeterminado es ascendente. Para especificar el orden descendente para un campo, agrega el sufijo “desc” al nombre del campo. Ejemplo: createTime desc.
filter

string

Permite filtrar por propiedades de las creatividades.

Sintaxis admitida:

  • Las expresiones de filtro constan de una o más restricciones.
  • La restricción del mismo campo debe combinarse con OR.
  • La restricción de campos diferentes debe combinarse con AND.
  • Entre el ( y el ), solo puede haber restricciones combinadas por OR para el mismo campo.
  • Una restricción tiene el formato {field} {operator} {value}.
  • El operador debe ser EQUALS (=) en los siguientes campos:
    • entityStatus
    • creativeType.
    • dimensions
    • minDuration
    • maxDuration
    • approvalStatus
    • exchangeReviewStatus
    • dynamic
    • creativeId
  • El operador debe ser HAS (:) en los siguientes campos:
    • lineItemIds
  • El operador debe ser GREATER THAN OR EQUAL TO (>=) o LESS THAN OR EQUAL TO (<=) para los siguientes campos:
    • updateTime (ingresa en formato ISO 8601 o AAAA-MM-DDTHH:MM:SSZ)
  • Para entityStatus, minDuration, maxDuration, updateTime y dynamic, puede haber una restricción como máximo.
  • Para dimensions, el valor tiene el formato "{width}x{height}".
  • Para exchangeReviewStatus, el valor tiene el formato {exchange}-{reviewStatus}.
  • Para minDuration y maxDuration, el valor tiene el formato "{duration}s". Solo se admiten segundos con nivel de detalle de milisegundos.
  • En el caso de updateTime, el valor del campo de un recurso de creatividad refleja la última vez que se actualizó una creatividad, incluidas las actualizaciones que realizó el sistema (p.ej., las actualizaciones de la revisión de creatividades).
  • Es posible que haya varias restricciones lineItemIds para buscar en varios IDs de líneas de pedido posibles.
  • Es posible que existan varias restricciones de creativeId para realizar búsquedas en varios IDs de creatividades posibles.

Ejemplos:

  • Todas las creatividades nativas: creativeType="CREATIVE_TYPE_NATIVE"
  • Todas las creatividades activas con dimensiones de 300 x 400 o 50 x 100: entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")
  • Todas las creatividades dinámicas aprobadas por AdX o AppNexus con una duración mínima de 5 segundos y 200 ms dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")
  • Todas las creatividades de video asociadas con el ID de línea de pedido 1 o 2: creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)
  • Buscar creatividades por varios ID: creativeId=1 OR creativeId=2

  • Todas las creatividades con una hora de actualización superior o igual a 2020-11-04T18:54:47Z (format of ISO 8601): updateTime>="2020-11-04T18:54:47Z" La longitud de este campo no debe superar los 500 caracteres.

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

object (Creative)

Es la lista de creatividades.

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 ListCreativesRequest para recuperar la siguiente página de resultados. Si el campo es nulo, significa que esta es la última página.

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