Membuat ekspor audiens

Audiens di Google Analytics memungkinkan Anda menyegmentasikan pengguna dengan cara yang sesuai dengan bisnis Anda. Dengan audiens, Anda dapat mengelompokkan pengguna situs atau aplikasi berdasarkan atribut yang sama.

Anda dapat mengekspor audiens, termasuk ringkasan data penggunanya, menggunakan Data API.

Lihat panduan Ekspektasi data ekspor audiens untuk mengetahui informasi penting tentang data yang Anda lihat dalam ekspor audiens.

Ringkasan

Buat permintaan Data API berikut untuk membuat dan mengkueri ekspor audiens:

1. Panggil metode audienceExports.create untuk membuat ekspor audiens.
2. Panggil metode audienceExports.query untuk mengambil pengguna dalam audiens.

Untuk mengetahui informasi selengkapnya, Anda dapat memanggil audienceExports.get untuk mengambil metadata konfigurasi tentang ekspor audiens tertentu, dan audienceExports.list untuk mencantumkan semua ekspor audiens untuk properti tertentu.

Pilih entitas pelaporan

Semua metode Data API mengharuskan ID properti Google Analytics ditentukan di dalam jalur permintaan URL, dalam bentuk properties/GA_PROPERTY_ID. Berikut contohnya:

  POST  https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID/audienceExports

Laporan ini dibuat berdasarkan data peristiwa Google Analytics yang dikumpulkan di properti Google Analytics yang ditentukan.

Jika menggunakan salah satu library klien Data API, Anda tidak perlu mengubah jalur URL permintaan. Sebagian besar klien API menyediakan parameter property yang mengharapkan string dalam bentuk properties/GA_PROPERTY_ID. Lihat Panduan memulai cepat untuk mengetahui contoh penggunaan library klien.

Membuat ekspor audiens

Untuk membuat ekspor audiens, panggil metode audienceExports.create menggunakan objek AudienceExport dalam permintaan Anda. Parameter berikut diperlukan:

• Nama audiens yang valid di kolom audience, yang diformat sebagai properties/{propertyId}/audiences/{audienceId}. Anda dapat menggunakan metode audiences.list Google Analytics Admin API v1 untuk mendapatkan nilai ini. Kolom Audience.name dari respons audiences.list berisi nama audiens.
• Daftar dimensi yang valid di kolom dimensions. Daftar dimensi yang didukung oleh metode ini dapat ditemukan dalam dokumentasi Skema ekspor audiens. Hanya data untuk dimensi yang disebutkan dalam kolom ini yang disertakan dalam ekspor audiens.

Berikut adalah contoh permintaan untuk membuat ekspor audiens:

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

Respons metode audienceExports.create berisi nama ekspor audiens di kolom name, misalnya properties/1234567/audienceExports/123. Berikut adalah contoh respons:

{
  "response": {
    "@type": "type.googleapis.com/google.analytics.data.v1alpha.AudienceExport",
    "name": "properties/1234567/audienceExports/123",
    "audience": "properties/1234567/audiences/12345",
    "audienceDisplayName": "Purchasers",
    "dimensions": [
      {
        "dimensionName": "deviceId"
      }
    ],
    "state": "CREATING",
    "beginCreatingTime": "2023-06-22T23:35:28.787910949Z"
  }
}

Anda dapat menggunakan name untuk mengkueri pengguna dari ekspor audiens.

Membuat kueri status kesiapan ekspor audiens

Mungkin perlu waktu beberapa menit untuk membuat ekspor audiens setelah panggilan audienceExports.create.

Anda dapat memeriksa status kesiapan ekspor audiens dengan memanggil metode audienceExports.get.

Gunakan nama ekspor audiens dari respons audienceExports.create untuk menentukan ekspor audiens dalam permintaan Anda.

Berikut adalah contoh permintaan:

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

Status kesiapan untuk ekspor audiens ditampilkan di kolom state respons. Setelah pembuatan ekspor audiens selesai, statusnya akan berubah dari CREATING menjadi ACTIVE.

Berikut adalah contoh respons:

{
  "name": "properties/1234567/audienceExports/123",
  "audience": "properties/1234567/audiences/12345",
  "audienceDisplayName": "Purchasers",
  "dimensions": [
    {
      "dimensionName": "deviceId"
    }
  ],
  "state": "CREATING",
  "beginCreatingTime": "2023-06-22T23:35:28.787910949Z"
}

Anda dapat memperoleh status semua ekspor audiens dengan memanggil metode audienceExports.list.

Mengambil pengguna dari ekspor audiens

Setelah ekspor audiens dibuat, panggil metode audienceExports.query, dan tentukan name ekspor audiens dalam permintaan.

Berikut adalah contoh permintaan:

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

Jika ekspor audiens sudah siap, panggilan ini akan menampilkan daftar pengguna dalam audiens.

Berikut adalah contoh respons:

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