Method: properties.audienceLists.exportSheet

Экспортирует список аудитории пользователей в таблицу Google. После создания аудитории пользователи не сразу доступны для листинга. Во-первых, запрос к audienceLists.create необходим для создания списка аудитории пользователей, а затем, во-вторых, этот метод используется для экспорта этих пользователей из списка аудитории в Google Sheet.

См. Создание списка аудитории для ознакомления со списками аудитории с примерами.

Аудитории в Google Analytics 4 позволяют сегментировать пользователей по критериям, важным для вашего бизнеса. Дополнительную информацию см. на странице https://support.google.com/analytics/answer/9267572 .

Этот метод представлен на стадии альфа-версии с целью сбора отзывов о синтаксисе и возможностях перед входом в бета-версию. Чтобы оставить отзыв об этом API, заполните форму отзыва об API экспорта аудитории Google Analytics .

HTTP-запрос

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/audienceLists/*}:exportSheet

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
name

string

Необходимый. Имя списка аудитории, из которого извлекаются пользователи. Формат: properties/{property}/audienceLists/{audienceList}

Тело запроса

Тело запроса содержит данные следующей структуры:

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

string ( int64 format)

Необязательный. Количество строк в начальной строке. Первая строка считается строкой 0.

При пейджинге первый запрос не указывает смещение; или, что то же самое, устанавливает смещение в 0; первый запрос возвращает первый limit строк. Второй запрос устанавливает смещение, равное limit первого запроса; второй запрос возвращает второй limit строк.

Дополнительные сведения об этом параметре нумерации страниц см. в разделе Нумерация страниц .

limit

string ( int64 format)

Необязательный. Количество возвращаемых строк. Если не указано, возвращается 10 000 строк. API возвращает максимум 250 000 строк на запрос, независимо от того, сколько вы запрашиваете. limit должен быть положительным.

API также может возвращать меньше строк, чем запрошенное limit , если значений измерения не так много, как limit .

Дополнительные сведения об этом параметре нумерации страниц см. в разделе Нумерация страниц .

Тело ответа

Созданный Google Sheet со списком пользователей в списке аудитории.

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление
{
  "spreadsheetUri": string,
  "spreadsheetId": string,
  "rowCount": integer,
  "audienceList": {
    object (AudienceList)
  }
}
Поля
spreadsheetUri

string

URI, который вы можете посетить в своем браузере для просмотра Google Sheet.

spreadsheetId

string

Идентификатор, идентифицирующий созданный ресурс Google Sheet.

rowCount

integer

Общее количество строк в результате AudienceList. rowCount не зависит от количества строк, возвращаемых в ответе, параметра запроса limit и параметра запроса offset . Например, если запрос возвращает 175 строк и включает limit в 50 в запросе API, ответ будет содержать rowCount , равный 175, но только 50 строк.

Дополнительные сведения об этом параметре нумерации страниц см. в разделе Нумерация страниц .

audienceList

object ( AudienceList )

Экспортируемые данные конфигурации AudienceList. Вернулся, чтобы помочь интерпретировать AudienceList в Google Sheet этого ответа.

Например, список AudienceList может содержать больше строк, чем присутствует в Google Sheet, и в этом случае вы можете захотеть отправить дополнительный запрос на экспорт листа с другим значением offset , чтобы получить следующую страницу строк в дополнительном Google Sheet.

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets