Pierwsze kroki z interfejsem Ads Data Hub API

Z tego przewodnika dowiesz się, jak zacząć tworzyć aplikacje, które korzystają z interfejsu Ads Data Hub API typu REST do interakcji z Centrum danych reklam. Interfejs Ads Data Hub API typu REST umożliwia wyświetlanie listy klientów Centrum danych reklam powiązanych z Twoim kontem Google oraz tworzenie i wykonywanie zapytań.

Konfiguracja

Zanim zaczniesz korzystać z interfejsu Ads Data Hub API, musisz wykonać kilka czynności:

  1. Upewnij się, że użytkownik włączający interfejs API ma w projekcie Google Cloud uprawnienie serviceusage.services.enable. Użytkownik z uprawnieniem serviceusage.services.enable musi też mieć przyznany dostęp do interfejsu API.
  2. Włącz interfejs Ads Data Hub API w projekcie Google Cloud, w którym utworzono dane logowania klienta lub konto usługi. Aby za pomocą konsoli włączyć w projekcie interfejs Ads Data Hub API:
    1. Otwórz Bibliotekę API Cloud Console.
    2. Na liście projektów wybierz projekt, którego chcesz użyć.
    3. Wyszukaj „Ads Data Hub API”.
    4. Na stronie interfejsu API kliknij WŁĄCZ.
  3. Zarządzanie uprawnieniami:
    1. Do Centrum danych reklam musisz dodać adres e-mail lub konto usługi, którego użyto do utworzenia danych logowania, z odpowiednimi uprawnieniami. W przypadku konta usługi jest to adres e-mail tego konta. W przypadku protokołu OAuth jest to adres e-mail użytkownika. Dzięki temu konto usługi lub konto użytkownika uzyska uprawnienia do wykonywania zapytań w Centrum danych reklam.
  4. (Zalecane) Zainstaluj bibliotekę klienta interfejsów API Google:
    1. Biblioteki klienta interfejsów API Google są dostępne w kilku popularnych językach i umożliwiają pracę z licznymi interfejsami API Google. Chociaż nie jest to wymagane, biblioteki klienta zmniejszają ilość kodu do napisania i upraszczają konfigurowanie uwierzytelniania.
Biblioteka klienta Przykłady dotyczące Centrum danych reklam
Biblioteka klienta interfejsów API Google do języka Java Java
Biblioteka klienta interfejsów API Google do języka Python

Uwierzytelnianie i autoryzacja

Interfejs Ads Data Hub API ma dostęp do Twojego konta klienta Centrum danych reklam i może zmieniać na nim dane, dlatego musi sprawdzać, czy jesteś autoryzowanym użytkownikiem. Z tego względu, zanim zaczniesz korzystać z interfejsu Ads Data Hub API, musisz przejść proces autoryzacji. Dzięki temu uzyskasz uprawnienia niezbędne do korzystania z interfejsu API. Do uwierzytelniania możesz używać protokołu OAuth 2.0 lub konta usługi.

Konfigurowanie konta usługi

  1. Otwórz konsolę interfejsów API Google i przejdź do swojego projektu administracyjnego.
  2. W sekcji Interfejsy API i usługi sprawdź, czy w przypadku Twojego projektu włączony jest interfejs Ads Data Hub API.
    1. Jeśli nie, kliknij + Włącz interfejsy API i usługi, aby go włączyć.
  3. W menu nawigacyjnym po lewej stronie kliknij Administracja > Konta usługi.
    1. Jeśli nie masz jeszcze konta usługi, utwórz je.
  4. W sekcji „Działania” kliknij menu z 3 kropkami (), a potem kliknij Zarządzaj kluczami.
    1. Kliknij Dodaj klucz > Utwórz nowy klucz.
    2. Po upewnieniu się, że wybrana jest opcja „JSON”, kliknij Utwórz.
  5. Dodaj adres e-mail konta usługi jako użytkownika na swoim koncie Centrum danych reklam.

Wysyłanie przykładowego żądania

#!/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 customer ID.
customer_name = input('Customer name (e.g. "customers/123"): ').strip()
queries = service.customers().analysisQueries().list(
    parent=customer_name).execute()
print(json.dumps(queries, sort_keys=True, indent=4))

Dalsze kroki

  • Zobacz przykładowe zapytania w Centrum danych reklam, aby się dowiedzieć, jakie zapytania możesz tworzyć i wykonywać za pomocą interfejsu Ads Data Hub API typu REST.
  • Rozwijaj przykłady, aby zapoznać się z interfejsem API i dostosować go do swoich potrzeb. Następnie spróbuj wykonać te czynności:
  • Jeśli masz pytania lub chcesz się podzielić opinią na temat interfejsu API, skontaktuj się z zespołem pomocy CDR.