- Permintaan HTTP
- Parameter lokasi
- Isi permintaan
- Isi respons
- Cakupan otorisasi
- AudienceRow
- AudienceDimensionValue
- Cobalah!
Mengambil daftar audiens pengguna. 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 mengambil pengguna di daftar audiens.
Lihat Membuat Daftar Audiens untuk pengantar Daftar Audiens yang disertai 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 tersedia pada stabilitas beta di audienceExports.query. Untuk memberikan masukan tentang API ini, lengkapi formulir Masukan Google Analytics Audience Export API.
Permintaan HTTP
POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/audienceLists/*}:query
URL menggunakan sintaksis gRPC Transcoding.
Parameter jalur
Parameter | |
---|---|
name |
Wajib. Nama daftar audiens untuk mengambil pengguna. Format: |
Isi permintaan
Isi permintaan memuat data dengan struktur berikut:
Representasi JSON |
---|
{ "offset": string, "limit": string } |
Kolom | |
---|---|
offset |
Opsional. Jumlah baris untuk baris awal. Baris pertama dihitung sebagai baris 0. Saat melakukan paging, permintaan pertama tidak menentukan offset; atau yang setara, menyetel offset ke 0; permintaan pertama menampilkan Untuk mempelajari parameter penomoran halaman ini lebih lanjut, lihat Penomoran halaman. |
limit |
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. API juga dapat menampilkan baris lebih sedikit daripada Untuk mempelajari parameter penomoran halaman ini lebih lanjut, lihat Penomoran halaman. |
Isi respons
Daftar pengguna di daftar audiens.
Jika berhasil, isi respons memuat data dengan struktur berikut:
Representasi JSON |
---|
{ "audienceRows": [ { object ( |
Kolom | |
---|---|
audienceRows[] |
Baris untuk setiap pengguna dalam daftar audiens. Jumlah baris dalam respons ini akan kurang dari atau sama dengan ukuran halaman permintaan. |
audienceList |
Data konfigurasi tentang AudienceList yang dikueri. Ditampilkan untuk membantu menafsirkan baris audiens dalam respons ini. Misalnya, dimensi dalam AudienceList ini sesuai dengan kolom di AudienceRows. |
rowCount |
Jumlah total baris dalam hasil AudienceList. Untuk mempelajari parameter penomoran halaman ini lebih lanjut, lihat Penomoran halaman. |
Cakupan otorisasi
Memerlukan salah satu cakupan OAuth berikut:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
AudienceRow
Atribut nilai dimensi untuk baris pengguna audiens.
Representasi JSON |
---|
{
"dimensionValues": [
{
object ( |
Kolom | |
---|---|
dimensionValues[] |
Setiap atribut nilai dimensi untuk pengguna audiens. Satu nilai dimensi akan ditambahkan untuk setiap kolom dimensi yang diminta. |
AudienceDimensionValue
Nilai dimensi.
Representasi JSON |
---|
{ // Union field |
Kolom | |
---|---|
Kolom union one_value . Salah satu jenis nilai dimensi. one_value hanya ada berupa salah satu diantara berikut: |
|
value |
Nilai sebagai string jika jenis dimensinya adalah string. |