Penyediaan akun yang dikontrol partner – Panduan Developer API

Pengantar

createAccountTree adalah bagian dari Provisioning API yang dapat digunakan untuk membuat akun Google Analytics baru dalam skala besar. Tidak seperti createAccountTicket, createAccountTree tidak memerlukan interaksi pengguna akhir untuk menyelesaikan pembuatan akun; prosesnya sepenuhnya otomatis. Hal ini berguna bila Anda perlu menyediakan akun Analytics yang Anda kontrol atas nama pelanggan, dan tempat Anda menyediakan tampilan khusus dari data tersebut kepada pelanggan.

API ini dicadangkan untuk partner yang mengontrol situs atau properti web pengguna mereka. Jika pengguna mengontrol situs atau properti web mereka sendiri, sebaiknya Anda membuat akun Analytics yang dikontrol pengguna.

Sebelum Memulai

Semua API Google Analytics diakses dengan cara yang sama. Sebelum memulai dengan Provisioning API, Anda harus:

  • Baca halaman library klien untuk mengetahui daftar lengkap library klien bahasa pemrograman tertentu yang berfungsi dengan API.
  • Baca Panduan Referensi untuk mempelajari antarmuka API dan cara mengakses data tanpa library klien.

Setiap library klien menyediakan satu objek layanan analisis untuk mengakses Provisioning API. Untuk membuat objek layanan, Anda biasanya harus melakukan langkah-langkah berikut:

  1. Daftarkan aplikasi Anda di Konsol API Google.
  2. Izinkan membuat akun Google Analytics baru.
  3. Buat objek layanan Analytics.

Jika Anda belum menyelesaikan langkah-langkah ini, hentikan dan baca Tutorial Hello Google Analytics API. Tutorial ini akan memandu Anda melalui langkah-langkah awal pembuatan aplikasi Google Analytics API. Setelah selesai, Anda akan memahami cara mengakses Google Analytics API untuk melakukan tugas dunia nyata.

Akun Template

Sebagai bagian dari otorisasi untuk menggunakan API ini, Anda harus menyediakan Akun Google Analytics baru, yang berfungsi sebagai akun template untuk API ini. Saat akun baru dibuat, akun tersebut mewarisi berbagai setelan dari akun template, termasuk pelamar Persyaratan Layanan, Organisasi, dan berbagai setelan berbagi data. Lihat referensi createAccountTree untuk mengetahui detail selengkapnya tentang akun template, termasuk daftar semua data yang diwarisi.

Menyediakan Akun

Untuk menyediakan akun Google Analytics baru, buat permintaan ke endpoint API createAccountTree. Anda akan memerlukan detail penyediaan berikut:

  • Kolom Akun
    • accountName untuk akun.
  • Kolom Properti Web
    • webpropertyName untuk properti.
    • websiteUrl. Entri ini harus berupa URL yang terkait dengan properti pengguna untuk akun Analytics ini.
  • Kolom Tampilan
    • profileName untuk tampilan.
    • timezone untuk tampilan.

Setelah Anda memiliki detailnya, lakukan panggilan terautentikasi ke endpoint API:

POST https://www.googleapis.com/analytics/v3/provisioning/createAccountTree
{
    "accountName": "Analytics Account",
    "webpropertyName": "Default Property",
    "profileName": "Default View",
    "timezone": "America/Los_Angeles",
    "websiteUrl": "www.example-pet-store.com",
}

Jika berhasil, API akan merespons dengan detail akun, properti web, dan tampilan yang baru dibuat:

{
    "account": {
        "id": "999999999",
        "name": "Analytics Account",
        "created": "2018-03-16T23:35:20.699Z",
        "updated": "2018-03-16T23:35:20.699Z",
        ...
    },
    "webproperty": {
        "id": "UA-999999999-1",
        "name": "Default Property",
        "websiteUrl": "www.example-pet-store.com",
        "created": "2018-03-16T23:35:20.699Z",
        "updated": "2018-03-16T23:35:20.699Z",
        ...
    },
    "profile": {
        "id": "999999999",
        "name": "Default View",
        "timezone": "America/Los_Angeles",
        "created": "2018-03-16T23:35:20.699Z",
        "updated": "2018-03-16T23:35:20.699Z",
        ...
    },
    ...
}

Pengelolaan dan Kepemilikan Akun

Akun Google Analytics yang dibuat akan dimiliki oleh akun pengguna mana pun yang mengizinkan respons melalui OAuth. Karena alasan ini, sebaiknya organisasi Anda menggunakan akun layanan untuk mengelola Akun Analytics, bukan akun pengguna individual.

Setelah akun dibuat, Anda dapat mengonfigurasinya dengan Management API. Berikut beberapa tugas umum untuk akun yang baru dibuat:

Klarifikasi Hubungan Akun

Seperti semua API Google lainnya, project Google Cloud diperlukan sebagai titik awal otorisasi permintaan. Seperti yang dijelaskan dalam dokumentasi OAuth 2.0, akun ini adalah tempat untuk mengelola kredensial Anda untuk permintaan API. Namun, akun Google Analytics yang dibuat tidak secara langsung berafiliasi dengan project Cloud atau akun pengelolanya; akun ini hanya berafiliasi dengan pengguna atau akun layanan yang mengizinkan permintaan tersebut. Anda dapat menggunakan Management API jika perlu mengonfigurasi akses akun ke akun Analytics.