REST Resource: properties.audienceLists

Источник: AudienceList

Список аудитории — это список пользователей, входящих в аудиторию на момент создания списка. Для одной аудитории может быть создано несколько списков аудитории на разные дни.

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)
  }
}
Поля
name

string

Только вывод. Идентификатор. Имя ресурса списка аудитории, присвоенное при создании. Это имя ресурса идентифицирует данный AudienceList .

Формат: properties/{property}/audienceLists/{audienceList}

audience

string

Обязательно. Имя ресурса аудитории. Это имя ресурса идентифицирует отображаемую аудиторию и используется совместно API аналитики и администрирования.

Формат: properties/{property}/audiences/{audience}

audienceDisplayName

string

Только для вывода. Описательное отображаемое имя для этой аудитории. Например, "Покупатели".

dimensions[]

object ( AudienceDimension )

Обязательно. Запрашиваемые размеры, которые будут отображены в ответе на запрос.

creationQuotaTokensCharged

integer

Только для вывода. Общее количество токенов квоты, списанных при создании списка аудитории. Поскольку это количество токенов основано на активности из состояния CREATING , списанные токены будут зафиксированы, как только список аудитории перейдет в состояние ACTIVE или FAILED .

state

enum ( State )

Только вывод. Текущее состояние данного списка аудитории.

beginCreatingTime

string ( Timestamp format)

Только вывод. Момент, когда был вызван метод audienceLists.create и список AudienceList перешел в состояние CREATING .

Используется RFC 3339, согласно которому генерируемый вывод всегда будет Z-нормализован и будет содержать 0, 3, 6 или 9 дробных знаков. Допускаются также смещения, отличные от "Z". Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

rowCount

integer

Только вывод. Общее количество строк в результате AudienceList.

errorMessage

string

Только для вывода. Сообщение об ошибке отображается, если создание списка аудитории не удается. Распространенная причина такой ошибки — исчерпание квоты.

percentageCompleted

number

Только вывод. Процент завершения экспорта для этой аудитории варьируется от 0 до 100.

recurringAudienceList

string

Только вывод. Список повторяющихся аудиторий, создавший этот список. Списки повторяющихся аудиторий создают списки аудиторий ежедневно.

Если списки аудитории создаются напрямую, к ним не будет привязан список повторяющихся аудиторий, и это поле будет пустым.

webhookNotification

object ( WebhookNotification )

Необязательно. Настраивает отправку уведомлений через веб-перехватчики из API данных Google Analytics на ваш сервер веб-перехватчиков. Использование веб-перехватчиков необязательно. Если они не используются, вам потребуется опрашивать этот API, чтобы определить, когда список аудитории готов к использованию. Веб-перехватчики позволяют отправлять уведомления на ваши серверы и избавляют от необходимости опроса.

На веб-хук будет отправлен один или два POST-запроса. Первый POST-запрос будет отправлен немедленно, отображая только что созданный список аудитории в состоянии «СОЗДАНИЕ». Второй POST-запрос будет отправлен после завершения создания списка аудитории (в состоянии «АКТИВНО» или «НЕУДАЧНО»).

Если запрашиваются идентичные списки аудитории с небольшим интервалом, второй и последующие списки могут быть предоставлены из кэша. В этом случае метод создания списка аудитории может вернуть сообщение о том, что список аудитории уже АКТИВЕН. В таком случае на веб-хук будет отправлен только один POST-запрос.

Состояние

В настоящее время список аудитории находится в этом состоянии.

Перечисления
STATE_UNSPECIFIED Неуказанный штат никогда не будет использоваться.
CREATING В данный момент создается список аудитории (AudienceList), который станет доступен в будущем. Создание списка происходит сразу после вызова метода audienceLists.create.
ACTIVE Список аудитории полностью создан и готов к запросам. Обновление списка аудитории до активного состояния происходит асинхронно после запроса; это происходит через некоторое время (например, 15 минут) после первоначального вызова функции создания.
FAILED Создание списка аудитории не удалось. Возможно, повторный запрос на создание этого списка аудитории окажется успешным.

Методы

create

 Создает список аудитории для последующего извлечения.

get

 Получает метаданные конфигурации для конкретного списка аудитории.

list

 Выводит список всех списков аудитории для данного ресурса.

query

 Получает список пользователей, представляющих аудиторию.