REST Resource: properties.audienceLists

Recurso: AudienceList

Una lista de público es una lista de usuarios que pertenecen a un público en el momento de la creación de la lista. Un público puede tener varias listas 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 este AudienceList.

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

string

Es obligatorio. Es el nombre del recurso del público. Este nombre de recurso identifica el público que se muestra en la lista 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)

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

integer

Solo salida. Es la cantidad total de tokens de cuota que se cobraron durante la creación de AudienceList. Dado que este recuento de tokens se basa en la actividad del estado CREATING, los tokens cobrados se fijarán una vez que una 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 fecha y hora en que se llamó a audienceLists.create y la AudienceList comenzó el estado CREATING.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
rowCount

integer

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

string

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

number

Solo salida. Es el porcentaje de finalización 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 se crean 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)

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

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 se complete la creación de la lista de público (ya sea en el estado ACTIVE o FAILED).

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

Estado

Actualmente, AudienceList existe en este estado.

Enumeraciones
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 se creó por completo y está lista para realizar consultas. Un AudienceList se actualiza a activo de forma asíncrona a partir de una solicitud. Esto ocurre un tiempo después (por ejemplo, 15 minutos) de la llamada de creación inicial.
FAILED No se pudo crear el objeto AudienceList. Es posible que se complete correctamente si vuelves a solicitar esta lista de público.

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.