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 .

Используется 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

Только вывод. Общее количество строк в результате 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

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