Resource: AudienceList
Daftar audiens adalah daftar pengguna di audiens pada saat pembuatan daftar. Satu audiens mungkin memiliki beberapa daftar audiens yang dibuat untuk hari yang berbeda-beda.
Representasi JSON |
---|
{ "name": string, "audience": string, "audienceDisplayName": string, "dimensions": [ { object ( |
Kolom | |
---|---|
name |
Hanya output. Pengenal. Nama resource daftar audiens yang ditetapkan selama pembuatan. Nama resource ini mengidentifikasi Format: |
audience |
Wajib. Nama resource audiens. Nama resource ini mengidentifikasi audiens yang tercantum dan digunakan bersama oleh Data Analytics & Admin API. Format: |
audienceDisplayName |
Hanya output. Nama tampilan deskriptif untuk audiens ini. Misalnya, "Pembeli". |
dimensions[] |
Wajib. Dimensi yang diminta dan ditampilkan dalam respons kueri. |
creationQuotaTokensCharged |
Hanya output. Total token kuota yang dikenakan biaya selama pembuatan AudienceList. Karena jumlah token ini didasarkan pada aktivitas dari status |
state |
Hanya output. Status saat ini untuk AudienceList ini. |
beginCreatingTime |
Hanya output. Waktu saat audienceLists.create dipanggil dan AudienceList memulai status Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. Contoh: |
rowCount |
Hanya output. Jumlah total baris dalam hasil AudienceList. |
errorMessage |
Hanya output. Pesan error terisi saat daftar audiens gagal selama pembuatan. Penyebab umum kegagalan tersebut adalah kehabisan kuota. |
percentageCompleted |
Hanya output. Persentase yang selesai untuk ekspor audiens ini berkisar antara 0 hingga 100. |
recurringAudienceList |
Hanya output. Daftar audiens berulang yang membuat daftar audiens ini. Daftar audiens berulang membuat daftar audiens setiap hari. Jika daftar audiens dibuat secara langsung, daftar tersebut tidak akan memiliki daftar audiens berulang yang terkait, dan kolom ini akan kosong. |
webhookNotification |
Opsional. Mengonfigurasi notifikasi webhook untuk dikirim dari Google Analytics Data API ke server webhook Anda. Penggunaan webhook bersifat opsional. Jika tidak digunakan, Anda harus melakukan polling pada API ini untuk menentukan kapan daftar audiens siap digunakan. Webhook memungkinkan notifikasi dikirim ke server Anda & menghindari polling. Satu atau dua permintaan POST akan dikirim ke webhook. Permintaan POST pertama akan dikirim segera yang menampilkan daftar audiens yang baru dibuat dalam status MEMBUATNYA. Permintaan POST kedua akan dikirim setelah daftar audiens selesai dibuat (status AKTIF atau GAGAL). Jika daftar audiens identik diminta secara cepat, daftar audiens kedua & berikutnya dapat disalurkan dari cache. Dalam hal ini, metode pembuatan daftar audiens dapat mengembalikan daftar audiens yang sudah AKTIF. Dalam skenario ini, hanya satu permintaan POST yang akan dikirim ke webhook. |
Negara Bagian
AudienceList saat ini ada dalam status ini.
Enum | |
---|---|
STATE_UNSPECIFIED |
Status yang tidak ditentukan tidak akan pernah digunakan. |
CREATING |
AudienceList saat ini sedang dibuat dan akan tersedia di masa mendatang. Pembuatan dilakukan segera setelah panggilan audienceLists.create. |
ACTIVE |
AudienceList sudah sepenuhnya dibuat dan siap untuk pembuatan kueri. AudienceList diperbarui menjadi aktif secara asinkron dari permintaan; hal ini terjadi beberapa saat (misalnya 15 menit) setelah panggilan create awal. |
FAILED |
AudienceList gagal dibuat. Ada kemungkinan permintaan ulang daftar audiens ini akan berhasil. |
Metode |
|
---|---|
|
Membuat daftar audiens untuk diambil nanti. |
|
Mengekspor daftar audiens pengguna ke Spreadsheet Google. |
|
Mendapatkan metadata konfigurasi tentang daftar audiens tertentu. |
|
Mencantumkan semua daftar audiens untuk properti. |
|
Mengambil daftar audiens pengguna. |