Method: properties.audienceLists.exportSheet

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

Lihat Membuat Daftar Audiens untuk mengetahui pengantar Daftar Audiens dengan contoh.

Audiens di Google Analytics 4 memungkinkan Anda menyegmentasikan pengguna dengan cara yang relevan 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, lengkapi formulir Masukan tentang Ekspor Audiens Google Analytics.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
name

string

Wajib diisi. Nama daftar audiens yang akan diambil pengguna. 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 pada baris awal. Baris pertama dihitung sebagai baris 0.

Saat melakukan paging, permintaan pertama tidak menentukan offset; atau yang setara, mengatur offset ke 0; permintaan pertama menampilkan limit baris pertama. Set permintaan kedua di-offset ke limit permintaan pertama; permintaan kedua akan menampilkan limit baris kedua.

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

string (int64 format)

Opsional. Jumlah baris yang akan ditampilkan. Jika tidak ditentukan, total 10.000 baris akan ditampilkan. API ini 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 nilai dimensi tidak sebanyak limit.

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

Isi respons

Spreadsheet Google yang dibuat yang berisi 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 Spreadsheet Google.
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 dari 50 dalam permintaan API, responsnya akan berisi rowCount dari 175 baris, tetapi hanya 50 baris.

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

object (AudienceList)

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

Misalnya, AudienceList mungkin memiliki lebih banyak baris daripada yang ada di Spreadsheet Google, sehingga Anda sebaiknya mengirim permintaan ekspor sheet tambahan dengan nilai offset yang berbeda untuk mengambil halaman baris berikutnya di Spreadsheet Google 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