Daftar audiens berulang

Dokumen ini menjelaskan daftar audiens berulang, yang merupakan fitur lanjutan Google Analytics Data API v1. Sebagai pengantar tentang fitur ekspor daftar audiens, lihat panduan dasar-dasar ekspor audiens.

Daftar audiens berulang menghasilkan daftar audiens setiap hari saat perubahan keanggotaan audiens, untuk memastikan Anda menggunakan data terbaru.

Daftar audiens reguler (tidak berulang) adalah daftar pengguna statis di audiens pada saat daftar dibuat.

Membuat daftar audiens baru setiap hari

Dibutuhkan waktu yang bervariasi untuk memproses data audiens dan memperbarui satu hari keanggotaan. Tidak ada cara untuk memastikan bahwa data daftar audiens telah diperbarui di 24 jam.

Misalnya, meskipun Anda meminta daftar audiens pada saat yang sama setiap hari, pada hari-hari tertentu daftar audiens akan sama seperti hari sebelumnya, dan pada hari lain, daftar audiens akan berbeda dan berisi hari tambahan untuk perubahan keanggotaan.

Membuat Daftar Audiens baru setiap hari

Daftar audiens didasarkan pada data peristiwa dari satu hari sebelum tanggal terbaru perubahan keanggotaan. Jika Anda membuat daftar audiens sebelum menjadi anggota harian pembaruan data terjadi, sistem akan menggunakan data dari dua hari sebelumnya. Jika Anda membuat daftar audiens setelah pembaruan keanggotaan harian terjadi, mereka akan menggunakan data dari kemarin.

Melakukan polling secara berkala pada daftar audiens berulang

Daftar Audiens Berulang hanya menghasilkan Daftar Audiens pada hari tambahan data tersedia. Dengan demikian, kita tidak perlu lagi berspekulasi kapan harus membuat Daftar Audiens. Sebagai gantinya, Anda dapat melakukan polling dengan murah untuk Daftar Audiens Berulang sepanjang hari untuk melihat apakah data tambahan tersedia.

Melakukan polling Daftar Audiens berulang secara berkala sepanjang hari

Membuat Daftar Audiens Berulang

Untuk membuat daftar audiens berulang, panggil metode recurringAudienceLists.create menggunakan atribut RecurringAudienceList objek dalam permintaan. Parameter berikut wajib diisi:

  • Nama audiens yang valid dalam audience kolom, dengan format properties/{propertyId}/audiences/{audienceId}. Anda dapat menggunakan audiences.list Google Analytics Admin API v1 untuk mendapatkan nilai ini. Tujuan Audience.name kolom respons audiences.list berisi nama audiens.
  • Daftar dimensi yang valid dalam dimensions kolom tersebut. Daftar dimensi yang didukung oleh metode ini dapat ditemukan di Dokumentasi Skema Ekspor Audiens. Hanya data untuk dimensi yang disebutkan di kolom ini yang disertakan dalam Daftar Audiens.

Berikut contoh permintaan pembuatan daftar audiens berulang:

Permintaan HTTP

POST https://analyticsdata.googleapis.com/v1alpha/properties/1234567/recurringAudienceLists
{
  "audience": "properties/1234567/audiences/12345",
  "dimensions": [
    {
      "dimensionName": "deviceId"
    }
  ]
}

Respons metode recurringAudienceLists.create berisi di kolom name (seperti properties/1234567/recurringAudienceLists/123), yang dapat digunakan di kueri berikutnya untuk mengambil metadata konfigurasi untuk daftar audiens berulang ini. Selain itu, metadata konfigurasi berisi nama resource untuk instance daftar audiens yang dibuat untuk daftar audiens berulang ini.

Respons HTTP

{
  "name": "properties/1234567/recurringAudienceLists/123",
  "audience": "properties/1234567/audiences/12345",
  "audienceDisplayName": "Purchasers",
  "dimensions": [
    {
      "dimensionName": "deviceId"
    }
  ],
  "activeDaysRemaining": 180,
  "audienceLists": [
    "properties/1234567/audienceLists/45678"
  ]
}

Metadata konfigurasi polling

Gunakan recurringAudienceLists.get metode untuk mengambil metadata konfigurasi tentang daftar audiens berulang. Metadata konfigurasi berisi nama resource untuk instance daftar audiens yang dibuat untuk daftar audiens berulang ini.

Berikut contohnya:

Permintaan HTTP

GET https://analyticsdata.googleapis.com/v1alpha/properties/1234567/recurringAudienceLists/123

Instance RecurringAudienceList ditampilkan sebagai respons. {i>Dataframe<i} ini berisi metadata konfigurasi, yang mencakup nama resource untuk instance daftar audiens yang dibuat untuk daftar audiens berulang ini.

Respons HTTP

{
  "name": "properties/1234567/recurringAudienceLists/123",
  "audience": "properties/1234567/audiences/12345",
  "audienceDisplayName": "Purchasers",
  "dimensions": [
    {
      "dimensionName": "deviceId"
    }
  ],
  "activeDaysRemaining": 180,
  "audienceLists": [
    "properties/1234567/audienceLists/45678"
  ]
}

Anda dapat menggunakan recurringAudienceLists.list untuk mencantumkan semua daftar audiens berulang untuk sebuah properti.

Gunakan Webhook untuk menerima notifikasi asinkron tentang daftar audiens baru

Alih-alih melakukan polling secara berkala metadata konfigurasi tentang daftar audiens berulang menggunakan recurringAudienceLists.get Anda dapat menerima notifikasi Webhook secara asinkron saat audiens tersedia.

Untuk mengonfigurasi notifikasi Webhook, tentukan metode webhookNotification saat membuat daftar audiens berulang yang baru.

Ikuti panduan Async audience lists with webhooks untuk mendapatkan informasi selengkapnya tentang cara menggunakan Webhook di Google Analytics Data API v1.

Mengambil pengguna dalam ekspor audiens

Untuk mengambil pengguna dalam Ekspor Audiens, panggil metode audienceExports.query dan menentukan nama Ekspor Audiens yang diambil dari metadata konfigurasi yang disediakan oleh recurringAudienceLists.get atau recurringAudienceLists.list.

Permintaan HTTP

POST https://analyticsdata.googleapis.com/v1beta/properties/1234567/audienceExports/123:query

Jika Ekspor Audiens sudah siap, respons yang berisi daftar pengguna dalam audiens akan ditampilkan:

Respons HTTP

{
  "audienceExport": {
    "name": "properties/1234567/audienceExports/123",
    "audience": "properties/1234567/audiences/12345",
    "audienceDisplayName": "Purchasers",
    "dimensions": [
      {
        "dimensionName": "deviceId"
      }
    ],
    "state": "ACTIVE",
    "beginCreatingTime": "2023-06-22T23:35:28.787910949Z"
  },
  "audienceRows": [
    {
      "dimensionValues": [
        {
          "value": "1000276123.1681742376"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1000374452.1668627377"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1000391956.1652750758"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1000410539.1682018694"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1000703969.1666725875"
        }
      ]
    }
  ],
  "rowCount": 5
}