Method: properties.audienceLists.query

Mengambil daftar audiens pengguna. Setelah membuat audiens, pengguna tidak langsung tersedia untuk dicantumkan. Pertama, permintaan ke audienceLists.create diperlukan untuk membuat daftar audiens pengguna, lalu kedua, metode ini digunakan untuk mengambil pengguna dalam daftar audiens.

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

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 dengan stabilitas beta di audienceExports.query. 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/*}:query

URL ini menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
name

string

Wajib. Nama daftar audiens yang akan diambil penggunanya. 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 melakukan penomoran halaman, permintaan pertama tidak menentukan offset; atau sama dengan, 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

Daftar pengguna dalam 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 50 dalam permintaan API, respons akan berisi rowCount 175, 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 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "value": string
  // End of mutually exclusive fields.
}
Kolom
Satu jenis nilai dimensi. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
value

string

Nilai sebagai string jika jenis dimensi adalah string.
Akhir kolom yang saling eksklusif.