REST Resource: properties.audienceLists

Resource: AudienceList

Daftar audiens adalah daftar pengguna dalam audiens pada saat pembuatan daftar. Satu audiens dapat 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 ini mengidentifikasi AudienceList ini.

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

string

Wajib. Nama resource audiens. Nama resource ini mengidentifikasi audiens yang tercantum dan dibagikan antara Analytics Data & 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 ditagih selama pembuatan AudienceList. Karena jumlah token ini didasarkan pada aktivitas dari status CREATING, token yang ditagih 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 format 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. Alasan umum kegagalan tersebut adalah kehabisan kuota.
percentageCompleted

number

Hanya output. Persentase yang telah selesai untuk ekspor audiens ini berkisar 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 dibuat secara langsung, daftar audiens tidak akan memiliki daftar audiens berulang terkait, dan kolom ini akan kosong.
webhookNotification

object (WebhookNotification)

Opsional. Mengonfigurasi notifikasi webhook yang akan dikirim dari Google Analytics Data API ke server webhook Anda. Penggunaan webhook bersifat opsional. Jika tidak digunakan, Anda harus melakukan polling API ini untuk menentukan kapan daftar audiens siap digunakan. Webhook memungkinkan notifikasi dikirim ke server Anda & menghindari kebutuhan polling.

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

Jika daftar audiens yang identik diminta secara berurutan, daftar audiens kedua & berikutnya dapat ditayangkan dari cache. Dalam hal ini, metode pembuatan daftar audiens dapat menampilkan daftar audiens yang sudah AKTIF. Dalam skenario ini, hanya satu permintaan POST yang akan dikirim ke webhook.

Negara Bagian

AudienceList saat ini berada 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 terjadi segera setelah panggilan audienceLists.create.
ACTIVE AudienceList telah sepenuhnya dibuat dan siap untuk dikueri. AudienceList diperbarui menjadi aktif secara asinkron dari permintaan; hal ini terjadi beberapa saat (misalnya 15 menit) setelah panggilan pembuatan awal.
FAILED AudienceList gagal dibuat. Mungkin permintaan ulang daftar audiens ini akan berhasil.

Metode

create

 Membuat daftar audiens untuk diambil nanti.

exportSheet

 Mengekspor daftar audiens pengguna ke Google Spreadsheet.

get

 Mendapatkan metadata konfigurasi tentang daftar audiens tertentu.

list

 Mencantumkan semua daftar audiens untuk properti.

query

 Mengambil daftar audiens pengguna.