V tomto průvodci se dozvíte, jak začít psát aplikace, které ke komunikaci se službou Ads Data Hub využívají její rozhraní REST API. Pomocí rozhraní Ads Data Hub REST API si můžete prohlížet zákazníky služby Ads Data Hub přidružené k vašemu účtu Google, vytvářet dotazy a spouštět je.
Úvodní nastavení
Než začnete rozhraní Ads Data Hub API používat, musíte provést několik kroků:
- Uživatel, který rozhraní API povolí, musí mít v projektu Google Cloud oprávnění
serviceusage.services.enable
. Uživatel s oprávněnímserviceusage.services.enable
také musí mít povolen přístup k danému rozhraní API. - Rozhraní Ads Data Hub API musíte povolit v projektu Google Cloud, v němž byly vytvořeny identifikační údaje klienta nebo servisní účet. Postup povolení rozhraní Ads Data Hub API pro projekt pomocí konzole:
- Přejděte do knihovny rozhraní API v nástroji Cloud Console.
- Ze seznamu projektů vyberte ten, který chcete použít.
- Najděte rozhraní Ads Data Hub API.
- Na stránce tohoto API klikněte na POVOLIT.
- Správa oprávnění:
- E-mailovou adresu nebo servisní účet, pomocí nichž byly vytvořeny identifikační údaje, je třeba přidat do služby Ads Data Hub s příslušnými oprávněními. U servisního účtu jde o jeho e-mailovou adresu. V případě protokolu OAuth jde o e-mailovou adresu uživatele. Tímto krokem zajistíte, že servisní účet nebo účet koncového uživatele bude mít ve službě Ads Data Hub oprávnění ke spouštění dotazů.
- (Doporučeno) Nainstalujte klientskou knihovnu rozhraní Google API:
- Klientské knihovny rozhraní Google API jsou dostupné v několika populárních jazycích. Můžete pomocí nich pracovat s mnoha rozhraními Google API. Ačkoli tento krok není nezbytný, ušetří vám klientské knihovny část psaní kódu a usnadní nastavení ověření.
Příklady klientských knihoven | Ads Data Hub |
---|---|
Klientská knihovna Google API pro jazyk Java | Java |
Klientská knihovna Google API pro jazyk Python |
Ověření a autorizace
Rozhraní Ads Data Hub API může přistupovat k datům ve vašem zákaznickém účtu služby Ads Data Hub a měnit je. Musí tedy ověřit, že jste oprávněným uživatelem. Proto musíte před tím, než začnete s rozhraním Ads Data Hub komunikovat, absolvovat autorizaci. Autorizační postup vám zajistí oprávnění nezbytná k interakci s tímto rozhraním. Ověření můžete provést pomocí protokolu OAuth 2.0 nebo servisního účtu.
Nastavení servisního účtu
- Otevřete konzoli Google API a přejděte ke svému administrátorskému projektu.
- V části APIs & Services (Rozhraní API a služby) zkontrolujte, zda je pro váš projekt povoleno rozhraní Ads Data Hub API.
- Pokud není, klikněte na + Enable APIs and services (+ Povolit rozhraní API a služby) a povolte ho.
- V levé navigační nabídce klikněte na možnost IAM & Admin (Správa identit a přístupů a administrátoři) > Service Accounts (Servisní účty).
- Pokud jste servisní účet ještě nevytvořili, udělejte to nyní.
- Klikněte na nabídku se třemi tečkami (
- Klikněte na Add key (Přidat klíč) > Create new key (Vytvořit nový klíč).
- Vyberte možnost JSON a klikněte na Create (Vytvořit).
) v části Actions (Akce), pak klikněte na Manage keys (Správa klíčů).
- Jako uživatele v účtu služby Ads Data Hub zadejte e-mailovou adresu servisního účtu.
Odeslání ukázkového požadavku
#!/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))
Další kroky
- Podívejte se na příklady dotazů ve službě Ads Data Hub, které můžete pomocí rozhraní Ads Data Hub REST API vytvářet a spouštět.
- Experimentujte s uvedenými příklady, abyste se s rozhraním API seznámili, a přizpůsobte je svým potřebám. Pak zkuste:
- Dotázat se na stav průběhu dotazu.
- Pomocí klientské knihovny BigQuery získat výsledky dokončeného dotazu.
- Pokud budete mít k tomuto rozhraní otázky nebo nám budete chtít sdělit své názory na něj, kontaktujte podporu služby Ads Data Hub.