Method: properties.audienceLists.query

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

string

Wajib. Nama daftar audiens untuk mengambil 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 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 limit baris pertama. Permintaan kedua menetapkan offset ke limit dari 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 baris lebih sedikit daripada limit yang diminta, jika nilai dimensi tidak sebanyak limit.

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 (AudienceRow)
    }
  ],
  "audienceList": {
    object (AudienceList)
  },
  "rowCount": integer
}
Kolom
audienceRows[]

object (AudienceRow)

Baris untuk setiap pengguna dalam daftar audiens. Jumlah baris dalam respons ini akan kurang dari atau sama dengan ukuran halaman permintaan.
audienceList

object (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

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 baris dalam permintaan API, respons akan berisi rowCount dari 175 baris, tetapi hanya 50 baris.

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 (AudienceDimensionValue)
    }
  ]
}
Kolom
dimensionValues[]

object (AudienceDimensionValue)

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 one_value can be only one of the following:
  "value": string
  // End of list of possible types for union field one_value.
}
Kolom
Kolom union one_value. Salah satu jenis nilai dimensi. one_value hanya ada berupa salah satu diantara berikut:
value

string

Nilai sebagai string jika jenis dimensinya adalah string.