REST Resource: properties.audienceLists

Recurso: AudienceList

Una lista de público es una lista de los usuarios incluidos en un público al 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. Identificador. El nombre del recurso de la lista de público que se asignó durante la creación. El nombre de este recurso identifica este AudienceList.

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

string

Obligatorio. Es el nombre del recurso del público. El nombre de este recurso identifica el público que se muestra en la lista y se comparte entre las APIs de Analytics Data & Admin.

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

string

Solo salida. Es el nombre visible descriptivo para 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, estos tokens cobrados se corregirán una vez que AudienceList entre en los estados ACTIVE o FAILED.
state

enum (State)

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

string (Timestamp format)

Solo salida. Es el momento en que se llamó a audienceLists.create y este comenzó el estado CREATING.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con 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. Se propaga un mensaje de error cuando una lista de público falla durante la creación. Un motivo común para una falla de este tipo es el agotamiento de la cuota.
percentageCompleted

number

Solo salida. El porcentaje completado para esta exportación de público 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 una lista de público recurrente asociada, por lo que este campo quedará en blanco.
webhookNotification

object (WebhookNotification)

Opcional. Configura las notificaciones de webhook que se enviarán desde la API de datos de Google Analytics a su servidor de webhook. El uso de webhooks es opcional. Si no se utiliza, deberá consultar esta API para determinar cuándo se podrá utilizar una lista de público. Los webhooks permiten que se envíe una notificación a tus servidores y evitan que se usen sondeos.

Se enviarán una o dos solicitudes POST al webhook. La primera solicitud POST se enviará de inmediato para 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 con el estado ACTIVO o FALLIDO).

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

Estado

Actualmente, AudienceList existe en este estado.

Enumeradores
STATE_UNSPECIFIED Nunca se usará el estado no especificado.
CREATING Se está creando AudienceList en este momento y estará disponible en el futuro. La creación se produce inmediatamente después de la llamada audienceLists.create.
ACTIVE AudienceList está completamente creada y lista para realizar consultas. Una AudienceList se actualiza a activa de forma asíncrona a partir de una solicitud. Esto ocurre algún tiempo (por ejemplo, 15 minutos) después de la llamada de creación inicial.
FAILED No se pudo crear la lista de público. Es posible que la nueva solicitud de esta lista de público tenga éxito.

Métodos

create

 Crea una lista de público para su recuperación posterior.

exportSheet

 Exporta una lista de público de usuarios a una hoja de cálculo de Google.

get

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

list

 Muestra una lista de todas las listas de público de una propiedad.

query

 Recupera una lista de público de usuarios.