REST Resource: properties.audienceLists

{
  "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)
  }
}

string

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

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

string

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

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

string

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

object (AudienceDimension)

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

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.

enum (State)

Hanya output. Status saat ini untuk AudienceList ini.

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".

integer

Hanya output. Jumlah total baris dalam hasil AudienceList.

string

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

number

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

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.

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.