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

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

state

enum ( State )

Только вывод. Текущее состояние этого AudienceList.

beginCreatingTime

string ( Timestamp format)

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

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

rowCount

integer

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

errorMessage

string

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

percentageCompleted

number

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

recurringAudienceList

string

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

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

webhookNotification

object ( WebhookNotification )

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

На вебхук будут отправлены один или два POST-запроса. Первый запрос POST будет отправлен немедленно, показывая вновь созданный список аудитории в состоянии СОЗДАНИЕ. Второй запрос POST будет отправлен после завершения создания списка аудитории (состояние ACTIVE или FAILED).

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

Состояние

AudienceList в настоящее время находится в этом состоянии.

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

Методы

create

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

exportSheet

 Экспортирует список аудитории пользователей в таблицу Google.

get

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

list

 Перечисляет все списки аудитории для ресурса.

query

 Получает список аудитории пользователей.