תחילת העבודה עם Ads Data Hub API

במדריך הזה מוסבר איך להתחיל לכתוב אפליקציות שמשתמשות ב-Ads Data Hub REST API כדי לקיים אינטראקציה עם Ads Data Hub. API ל-Ads Data Hub ל-REST מאפשר לכם לראות לקוחות Ads Data Hub שמשויכים לחשבון Google שלכם, ליצור שאילתות ולהריץ שאילתות.

Setup (הגדרה)

יש כמה שלבים שצריך לבצע לפני שמשתמשים ב-Ads Data Hub API:

  1. חשוב לוודא שהמשתמש שמפעיל את ה-API מקבל את ההרשאה serviceusage.services.enable בפרויקט ב-Google Cloud. גם משתמש עם ההרשאה serviceusage.services.enable חייב להיכלל ברשימת ההיתרים כדי לגשת ל-API.
  2. מפעילים את Ads Data Hub API בפרויקט ב-Google Cloud שבו נוצרו פרטי הכניסה של הלקוח או חשבון השירות. כדי להפעיל את Ads Data Hub API לפרויקט באמצעות המסוף:
    1. נכנסים אל ספריית Cloud Console API.
    2. בוחרים את הפרויקט שבו רוצים להשתמש מתוך רשימת הפרויקטים.
    3. מחפשים את האפשרות Ads Data Hub API.
    4. בדף ה-API, לוחצים על ENABLE.
  3. ניהול ההרשאות:
    1. צריך להוסיף ל-Ads Data Hub את כתובת האימייל או את חשבון השירות שמשמשים ליצירת פרטי הכניסה עם ההרשאות המתאימות. בחשבון שירות, זוהי כתובת האימייל של חשבון השירות. ב-OAuth, זו כתובת האימייל של המשתמש. כך אפשר לוודא שלחשבון השירות או לחשבון של משתמש הקצה יש הרשאה להריץ שאילתות ב-Ads Data Hub.
  4. (מומלץ) מתקינים ספריית לקוח של Google API:
    1. ספריות הלקוח של Google API זמינות בכמה שפות פופולריות ומאפשרות לעבוד עם ממשקי Google API רבים. זה לא חובה, אבל ספריות הלקוח מצמצמות את כמות הקוד שצריך לכתוב, ומקלות על הגדרת האימות.
ספריית לקוח דוגמאות ל-Ads Data Hub
ספריית הלקוח של Google API ל-Java Java
ספריית הלקוח של Google API ל-Python

אימות ואישור

ל-Ads Data Hub API יש אפשרות לגשת לנתונים בחשבון הלקוח ב-Ads Data Hub ולשנות אותם, כך שיש לאמת שאתם משתמשים מורשים. לכן, לפני שתתחילו להשתמש ב-Ads Data Hub API, תצטרכו לבצע את תהליך ההרשאה. תהליך ההרשאה מספק את ההרשאות הנדרשות כדי לקיים אינטראקציה עם ה-API. אפשר לבצע אימות באמצעות OAuth 2.0 או חשבון שירות.

הגדרת חשבון שירות

  1. עוברים למסוף Google API ועוברים לפרויקט האדמין.
  2. מוודאים ש-Ads Data Hub API מופעל בפרויקט בקטע APIs & Services.
    1. אם היא לא מופעלת, לוחצים על + הפעלת ממשקי API ושירותים ומפעילים את Ads Data Hub API.
  3. בתפריט הניווט הימני, לוחצים על IAM & Admin > Service Accounts.
    1. אם עדיין לא יצרתם חשבון שירות, יוצרים אותו.
  4. לוחצים על סמל התפריט (3 נקודות) () בקטע Actions (פעולות) ואז לוחצים על Manage Keys (ניהול מפתחות).
    1. לוחצים על Add key > Create new key.
    2. מוודאים שהאפשרות 'JSON' מסומנת, לוחצים על יצירה.
  5. מוסיפים את כתובת האימייל של חשבון השירות כמשתמש בחשבון Ads Data Hub.

שליחת בקשה לדוגמה

#!/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))

השלבים הבאים

  • בקטע שאילתות לדוגמה ב-Ads Data Hub מוצגות דוגמאות לשאילתות שאפשר ליצור ולהפעיל באמצעות Ads Data Hub REST API.
  • הרחיבו את הדוגמאות כדי להכיר את ה-API ולהתאים אותו לתרחיש לדוגמה שלכם. לאחר מכן, אפשר לנסות:
  • אם יש לך שאלות או משוב בנוגע ל-API, אפשר לפנות לתמיכה של ADH.
הקודם
איך מגדירים חשבון
הבא
שימוש בממשק המשתמש באינטרנט