REST Resource: properties.audienceLists

Recurso: AudienceList

Una lista de público es una lista de usuarios de un público en el momento de la creación de la lista. Un público puede tener varias listas de público creadas para diferentes días.

Representación JSON 
{
  "name": string,
  "audience": string,
  "audienceDisplayName": string,
  "dimensions": [
    {
      object (AudienceDimension)
    }
  ],
  "creationQuotaTokensCharged": integer,
  "state": enum (State),
  "beginCreatingTime": string,
  "rowCount": integer,
  "errorMessage": string,
  "percentageCompleted": number,
  "recurringAudienceList": string,
  "webhookNotification": {
    object (WebhookNotification)
  }
}
Campos
name

string

Solo salida. Es el identificador. Es el nombre del recurso de la lista de público asignado durante la creación. Este nombre de recurso identifica esta AudienceList.

Formato: properties/{property}/audienceLists/{audienceList}
audience

string

Obligatorio. Es el nombre del recurso de público. Este nombre de recurso identifica el público que se está enumerando y se comparte entre las APIs de Analytics Data y Admin.

Formato: properties/{property}/audiences/{audience}
audienceDisplayName

string

Solo salida. Es el nombre visible descriptivo de este público. Por ejemplo, "Compradores".
dimensions[]

object (AudienceDimension)

Obligatorio. Son las dimensiones solicitadas y que se muestran en la respuesta de la consulta.
creationQuotaTokensCharged

integer

Solo salida. Son los tokens de cuota totales que se cobraron durante la creación de AudienceList. Debido a que este recuento de tokens se basa en la actividad del estado CREATING, los tokens cobrados se fijarán una vez que AudienceList ingrese a los estados ACTIVE o FAILED.
state

enum (State)

Solo salida. Es el estado actual de esta AudienceList.
beginCreatingTime

string (Timestamp format)

Solo salida. Es la hora en la que se llamó a audienceLists.create y AudienceList comenzó el estado CREATING.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
rowCount

integer

Solo salida. Es la cantidad total de filas en el resultado de AudienceList.
errorMessage

string

Solo salida. El mensaje de error se propaga cuando falla una lista de público durante la creación. Un motivo común de esta falla es el agotamiento de la cuota.
percentageCompleted

number

Solo salida. Es el porcentaje completado de esta exportación de público, que oscila entre 0 y 100.
recurringAudienceList

string

Solo salida. Es la lista de público recurrente que creó esta lista de público. Las listas de público recurrentes crean listas de público a diario.

Si las listas de público se crean directamente, no tendrán ninguna lista de público recurrente asociada, y este campo estará en blanco.
webhookNotification

object (WebhookNotification)

Es opcional. Configura las notificaciones de webhook para que se envíen desde la API de Google Analytics Data a tu servidor de webhook. El uso de webhooks es opcional. Si no se usa, deberás sondear esta API para determinar cuándo una lista de público está lista para usarse. Los webhooks permiten que se envíe una notificación a tus servidores y evitan la necesidad de realizar un sondeo.

Se enviará una o dos solicitudes POST al webhook. La primera solicitud POST se enviará de inmediato y mostrará la lista de público recién creada en su estado CREATING. La segunda solicitud POST se enviará después de que la lista de público complete la creación (ya sea el estado ACTIVE o FAILED).

Si se solicitan listas de público idénticas en rápida sucesión, la segunda y las siguientes listas de público se pueden entregar desde la caché. En ese caso, el método de creación de la lista de público puede mostrar que una lista de público ya está ACTIVE. En este caso, solo se enviará una solicitud POST al webhook.

Estado

La AudienceList existe actualmente en este estado.

Enums
STATE_UNSPECIFIED El estado sin especificar nunca se usará.
CREATING La AudienceList se está creando y estará disponible en el futuro. La creación se produce inmediatamente después de la llamada a audienceLists.create.
ACTIVE La AudienceList está completamente creada y lista para la consulta. Una AudienceList se actualiza a activa de forma asíncrona desde una solicitud; esto ocurre un tiempo (por ejemplo, 15 minutos) después de la llamada de creación inicial.
FAILED No se pudo crear la AudienceList. Es posible que la solicitud de esta lista de público vuelva a tener éxito.

Métodos

create

 Crea una lista de público para recuperarla más tarde.

get

 Obtiene metadatos de configuración sobre una lista de público específica.

list

 Enumera todas las listas de público de una propiedad.

query

 Recupera una lista de público de usuarios.