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}

audience Display Name

string

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

dimensions[]

object ( AudienceDimension )

Обязательно. Запрошенные параметры отображаются в ответе на запрос.

creation Quota Tokens Charged

integer

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

state

enum ( State )

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

begin Creating Time

string ( Timestamp format)

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

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

row Count

integer

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

error Message

string

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

percentage Completed

number

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

recurring Audience List

string

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

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

webhook Notification

object ( WebhookNotification )

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

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

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

Состояние

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

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

Методы

create

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

get

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

list

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

query

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