REST Resource: properties.audienceLists

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.

Representasi JSON 
{
  "name": string,
  "audience": string,
  "audienceDisplayName": string,
  "dimensions": [
    {
      object (AudienceDimension)
    }
  ],
  "creationQuotaTokensCharged": integer,
  "state": enum (State),
  "beginCreatingTime": string,
  "rowCount": integer,
  "errorMessage": string,
  "percentageCompleted": number,
  "recurringAudienceList": string,
  "webhookNotification": {
    object (WebhookNotification)
  }
}
Kolom
name

string

Hanya output. ID. Nama resource daftar audiens yang ditetapkan selama pembuatan. Nama resource mengidentifikasi AudienceList ini.

Format: properties/{property}/audienceLists/{audienceList}
audience

string

Wajib. Nama resource audiens. Nama referensi ini mengidentifikasi audiens yang tercantum dan dibagikan antara Data Analytics & Admin API.

Format: properties/{property}/audiences/{audience}
audienceDisplayName

string

Hanya output. Nama tampilan deskriptif untuk audiens ini. Misalnya, "Pembeli".
dimensions[]

object (AudienceDimension)

Wajib. Dimensi yang diminta dan ditampilkan dalam respons kueri.
creationQuotaTokensCharged

integer

Hanya output. Total token kuota yang dibebankan selama pembuatan AudienceList. Karena jumlah token ini didasarkan pada aktivitas dari status CREATING, token yang dikenai biaya ini akan diperbaiki setelah AudienceList memasuki status ACTIVE atau FAILED.
state

enum (State)

Hanya output. Status saat ini untuk AudienceList ini.
beginCreatingTime

string (Timestamp format)

Hanya output. Waktu saat audienceLists.create dipanggil dan AudienceList memulai status CREATING.

Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
rowCount

integer

Hanya output. Jumlah total baris dalam hasil AudienceList.
errorMessage

string

Hanya output. Pesan error diisi saat daftar audiens gagal selama pembuatan. Penyebab umum kegagalan tersebut adalah kehabisan kuota.
percentageCompleted

number

Hanya output. Persentase yang selesai untuk ekspor audiens ini memiliki rentang antara 0 hingga 100.
recurringAudienceList

string

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

object (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 & sehingga tidak perlu melakukan polling.

Satu atau dua permintaan POST akan dikirim ke webhook. Permintaan POST pertama akan segera dikirim dan menampilkan daftar audiens yang baru dibuat dalam status CREATING. Permintaan POST kedua akan dikirim setelah daftar audiens menyelesaikan pembuatan (status AKTIF atau GAGAL).

Jika daftar audiens yang identik diminta dengan cepat, yang kedua & daftar audiens berikutnya dapat ditayangkan dari cache. Dalam hal ini, metode pembuatan daftar audiens dapat menampilkan daftar audiens 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 dibuat dan akan tersedia di masa mendatang. Pembuatan terjadi segera setelah panggilan audienceLists.create.
ACTIVE AudienceList dibuat sepenuhnya dan siap untuk pembuatan kueri. AudienceList diperbarui agar aktif secara asinkron dari permintaan; hal ini terjadi beberapa saat (misalnya 15 menit) setelah panggilan create awal.
FAILED AudienceList gagal dibuat. Ada kemungkinan bahwa permintaan ulang daftar audiens ini akan berhasil.

Metode

create

 Membuat daftar audiens untuk diambil nanti.

exportSheet

 Mengekspor daftar audiens pengguna ke Spreadsheet Google.

get

 Mendapatkan metadata konfigurasi tentang daftar audiens tertentu.

list

 Mencantumkan semua daftar audiens untuk properti.

query

 Mengambil daftar audiens pengguna.