Mulai menggunakan Ads Data Hub API

Panduan ini menjelaskan cara mulai menulis 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 terkait 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 diberi izin 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 Cloud Console.
    2. Pilih project yang ingin Anda gunakan dari daftar project.
    3. Telusuri "Ads Data Hub API".
    4. Di halaman API, klik ENABLE.
  3. Mengelola 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, ini adalah alamat email akun layanan. Untuk OAuth, ini adalah alamat email pengguna. Tindakan ini memastikan bahwa akun layanan 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 bahasa populer, dan memungkinkan Anda menggunakan banyak Google API. Meskipun tidak diperlukan, library klien mengurangi jumlah kode yang harus Anda tulis, dan mempermudah penyiapan autentikasi.
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 akun pelanggan Ads Data Hub Anda, sehingga API ini perlu memverifikasi bahwa Anda adalah pengguna yang diberi otorisasi. Oleh karena itu, sebelum mulai berinteraksi dengan Ads Data Hub API, Anda harus mengikuti alur otorisasi. Alur otorisasi memberi Anda izin yang diperlukan untuk berinteraksi dengan API. Anda dapat melakukan autentikasi menggunakan OAuth 2.0 atau akun layanan.

Penyiapan akun layanan

  1. Buka konsol Google API dan buka project admin Anda.
  2. Pastikan Ads Data Hub API diaktifkan untuk project Anda di bagian API & Layanan.
    1. Jika tidak, klik + Aktifkan API dan layanan, lalu aktifkan Ads Data Hub API.
  3. Di menu navigasi sebelah kiri, klik IAM & Admin > Service Accounts.
    1. Jika Anda belum membuat akun layanan, buat akun.
  4. Klik menu 3 titik () di bagian "Tindakan", lalu klik Kelola kunci.
    1. Klik Add key > Create new key
    2. Setelah memastikan bahwa "JSON" dipilih, klik Create.
  5. Tambahkan alamat email akun layanan sebagai pengguna di akun Ads Data Hub Anda.

Mengirim permintaan contoh

#!/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 dengan kasus penggunaan Anda. Kemudian, coba:
    • Status operasi kueri polling.
    • Gunakan library klien BigQuery untuk mengambil hasil kueri yang telah selesai.
  • Hubungi dukungan ADH jika Anda memiliki pertanyaan atau masukan tentang API.
Sebelumnya
Menyiapkan akun
Berikutnya
Menggunakan UI web