REST Resource: properties.audienceExports

Ресурс: AudienceExport

Экспорт аудитории – это список пользователей аудитории на момент создания списка. Для одной аудитории может быть создано несколько экспортированных аудиторий для разных дней.

JSON-представление 
{
  "name": string,
  "audience": string,
  "audienceDisplayName": string,
  "dimensions": [
    {
      object (AudienceDimension)
    }
  ],
  "creationQuotaTokensCharged": integer,
  "state": enum (State),
  "beginCreatingTime": string,
  "rowCount": integer,
  "errorMessage": string,
  "percentageCompleted": number
}
Поля
name

string

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

Формат: properties/{property}/audienceExports/{audienceExport}

audience

string

Необходимый. Имя ресурса аудитории. Это имя ресурса идентифицирует указанную аудиторию и используется совместно API-интерфейсами данных аналитики и администрирования.

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

audienceDisplayName

string

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

dimensions[]

object ( AudienceDimension )

Необходимый. Параметры, запрошенные и отображаемые в ответе на запрос.

creationQuotaTokensCharged

integer

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

state

enum ( State )

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

beginCreatingTime

string ( Timestamp format)

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

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

rowCount

integer

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

errorMessage

string

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

percentageCompleted

number

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

Размер аудитории

Измерение аудитории — это атрибут пользователя. Запрашиваются определенные атрибуты пользователя, а затем они возвращаются в QueryAudienceExportResponse .

JSON-представление 
{
  "dimensionName": string
}
Поля
dimensionName

string

Необязательный. Имя API измерения. Список названий измерений см. в разделе Измерения API .

Состояние

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

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

Методы

create

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

get

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

list

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

query

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