Method: properties.audienceLists.exportSheet

Mengekspor daftar audiens pengguna ke Google Spreadsheet. Setelah membuat audiens, pengguna tidak langsung tersedia untuk dicantumkan. Pertama, permintaan ke audienceLists.create diperlukan untuk membuat daftar audiens pengguna, dan kedua, metode ini digunakan untuk mengekspor pengguna tersebut dalam daftar audiens ke Google Spreadsheet.

Lihat Membuat Daftar Audiens untuk mengetahui pengantar Daftar Audiens beserta contohnya.

Audiens di Google Analytics 4 memungkinkan Anda menyegmentasikan pengguna dengan cara yang penting bagi bisnis Anda. Untuk mempelajari lebih lanjut, lihat https://support.google.com/analytics/answer/9267572.

Metode ini diperkenalkan di versi alfa yang sudah stabil dengan tujuan mengumpulkan masukan terkait sintaksis dan kemampuan sebelum memasuki versi beta. Untuk memberikan masukan tentang API ini, isi formulir Masukan Google Analytics Audience Export API.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
name

string

Wajib. Nama daftar audiens tempat pengguna diambil. Format: properties/{property}/audienceLists/{audienceList}

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON
{
  "offset": string,
  "limit": string
}
Kolom
offset

string (int64 format)

Opsional. Jumlah baris dari baris awal. Baris pertama dihitung sebagai baris 0.

Saat paging, permintaan pertama tidak menentukan offset; atau setara, menetapkan offset ke 0; permintaan pertama menampilkan limit baris pertama. Permintaan kedua menetapkan offset ke limit permintaan pertama; permintaan kedua menampilkan limit baris kedua.

Untuk mempelajari parameter penomoran halaman ini lebih lanjut, lihat Penomoran Halaman.

limit

string (int64 format)

Opsional. Jumlah baris yang akan ditampilkan. Jika tidak ditentukan, 10.000 baris akan ditampilkan. API menampilkan maksimum 250.000 baris per permintaan, berapa pun jumlah yang Anda minta. limit harus positif.

API juga dapat menampilkan lebih sedikit baris daripada limit yang diminta, jika tidak ada nilai dimensi sebanyak limit.

Untuk mempelajari parameter penomoran halaman ini lebih lanjut, lihat Penomoran Halaman.

Isi respons

Google Spreadsheet yang dibuat dengan daftar pengguna dalam daftar audiens.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON
{
  "spreadsheetUri": string,
  "spreadsheetId": string,
  "rowCount": integer,
  "audienceList": {
    object (AudienceList)
  }
}
Kolom
spreadsheetUri

string

URI yang dapat Anda buka di browser untuk melihat Google Spreadsheet.

spreadsheetId

string

ID yang mengidentifikasi resource Google Spreadsheet yang dibuat.

rowCount

integer

Jumlah total baris dalam hasil AudienceList. rowCount tidak bergantung pada jumlah baris yang ditampilkan dalam respons, parameter permintaan limit, dan parameter permintaan offset. Misalnya, jika kueri menampilkan 175 baris dan menyertakan limit sebanyak 50 dalam permintaan API, respons akan berisi rowCount sebanyak 175, tetapi hanya 50 baris.

Untuk mempelajari parameter penomoran halaman ini lebih lanjut, lihat Penomoran Halaman.

audienceList

object (AudienceList)

Data konfigurasi tentang AudienceList yang diekspor. Ditampilkan untuk membantu menafsirkan AudienceList di Google Spreadsheet respons ini.

Misalnya, AudienceList mungkin memiliki lebih banyak baris daripada yang ada di Google Spreadsheet, dan dalam hal ini, Anda dapat mengirim permintaan ekspor sheet tambahan dengan nilai offset yang berbeda untuk mengambil halaman baris berikutnya di Google Spreadsheet tambahan.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • 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