Mulai menggunakan Ads Data Hub API

Panduan ini menjelaskan cara mulai membuat aplikasi yang menggunakan Ads Data Hub REST API untuk berinteraksi dengan Ads Data Hub. Ads Data Hub REST API memungkinkan Anda melihat pelanggan Ads Data Hub yang dikaitkan dengan akun Google Anda, membuat kueri, dan menjalankan kueri.

Penyiapan

Ada beberapa langkah yang perlu Anda selesaikan sebelum menggunakan Ads Data Hub API:

  1. Pastikan pengguna yang mengaktifkan API telah diberikan serviceusage.services.enable di project Google Cloud. Pengguna dengan izin serviceusage.services.enable juga harus diizinkan untuk mengakses API.
  2. Aktifkan Ads Data Hub API di project Google Cloud tempat kredensial klien atau akun layanan dibuat. Untuk mengaktifkan Ads Data Hub API untuk project menggunakan konsol:
    1. Buka Library API Konsol Cloud.
    2. Pilih project yang ingin Anda gunakan dari daftar project.
    3. Telusuri "Ads Data Hub API".
    4. Di halaman API, klik ENABLE.
  3. Kelola izin:
    1. Alamat email atau akun layanan yang digunakan untuk membuat kredensial harus ditambahkan ke Ads Data Hub dengan izin yang sesuai. Untuk akun layanan, alamat ini adalah alamat email akun layanan. Sebagai OAuth, ini adalah alamat email pengguna. Hal ini memastikan bahwa layanan akun pengguna atau akun pengguna akhir memiliki izin untuk menjalankan kueri di Ads Data Hub.
  4. (Direkomendasikan) Instal library klien Google API:
    1. Library klien Google API tersedia dalam beberapa di seluruh bahasa, dan memungkinkan Anda bekerja dengan banyak Google API. Meskipun ini bukanlah diperlukan, library klien mengurangi jumlah kode yang Anda miliki untuk menulis, dan membuat otentikasi lebih mudah disiapkan.
Library Klien Contoh Ads Data Hub
Library Klien Google API untuk Java Java
Library Klien Google API untuk Python

Mengautentikasi dan memberi otorisasi

Ads Data Hub API dapat mengakses dan mengubah data di pelanggan Ads Data Hub Anda sehingga perlu memverifikasi bahwa Anda adalah pengguna yang memiliki izin. Karena ini, sebelum mulai berinteraksi dengan Ads Data Hub API, Anda harus berjalan melalui alur otorisasi. Alur otorisasi memberi Anda izin yang diperlukan untuk berinteraksi dengan API. Anda dapat melakukan otentikasi menggunakan OAuth 2.0 atau akun layanan.

Pembuatan akun layanan

  1. Buka konsol API Google dan buka project admin Anda.
  2. Verifikasi bahwa Ads Data Hub API sudah diaktifkan untuk project Anda di bagian APIs & Layanan.
    1. Jika belum, klik + Aktifkan API dan layanan dan aktifkan Iklan API Hub Data.
  3. Pada menu navigasi sebelah kiri, klik IAM & Admin > Akun Layanan.
    1. Jika Anda belum membuat akun layanan, buat akun.
  4. Klik menu 3 titik () di "Tindakan", lalu klik Kelola kunci.
    1. Klik Add key > Buat kunci baru
    2. Setelah memastikan bahwa "JSON" dipilih, klik Create.
  5. Menambahkan alamat email akun layanan sebagai pengguna di Ads Data Hub menggunakan akun layanan.

Kirim contoh permintaan

#!/usr/bin/env python3

"""This sample shows how to retrieve all accounts associated with the user.
"""
import json
from google.oauth2.service_account import Credentials
from googleapiclient.discovery import build

SCOPES = ['https://www.googleapis.com/auth/adsdatahub']
DISCOVERY_URL = 'https://adsdatahub.googleapis.com/$discovery/rest?version=v1'
creds = Credentials.from_service_account_file(
    'service-account.json').with_scopes(SCOPES)
developer_key = 'YOUR_DEVELOPER_KEY'  # Replace with your developer key.
service = build('AdsDataHub', 'v1', credentials=creds,
                developerKey=developer_key, discoveryServiceUrl=DISCOVERY_URL)

# Replace with your ADH account ID.
adh_account_id = input('ADH account ID (e.g. "customers/123456789"): ').strip()
queries = service.customers().analysisQueries().list(
    parent=adh_account_id).execute()
print(json.dumps(queries, sort_keys=True, indent=4))

Langkah berikutnya

  • Lihat contoh kueri di Ads Data Hub untuk mengetahui contoh kueri yang dapat Anda buat dan jalankan dengan Ads Data Hub REST API.
  • Perluas contoh untuk memahami API dan menyesuaikannya untuk kasus penggunaan Anda. Lalu, coba:
    • Status operasi kueri jajak pendapat.
    • Gunakan library klien BigQuery untuk mengambil hasil kueri yang sudah selesai.
  • Hubungi dukungan ADH jika Anda memiliki pertanyaan atau masukan tentang API.
Sebelumnya
Menyiapkan akun
Berikutnya
Menggunakan UI web