תחילת השימוש ב-Ads Data Hub API

קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.

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

הגדרה

יש כמה שלבים שצריך להשלים לפני שמשתמשים ב-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 בפרויקט באמצעות מסוף Google Cloud:
   1. נכנסים אל ספריית ה-API של מסוף Cloud.
   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 API יוכל לגשת לנתונים בחשבון הלקוח שלכם ב-Ads Data Hub ולשנות אותם, הוא צריך לאמת שאתם משתמשים מורשים. לכן, לפני שמתחילים לבצע פעולות ב-Ads Data Hub API, צריך לעבור תהליך הרשאה. תהליך ההרשאה מספק את ההרשאות הנדרשות כדי לקיים אינטראקציה עם ה-API. אפשר לבצע אימות באמצעות OAuth 2.0 או באמצעות חשבון שירות.

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

1. נכנסים למסוף Google API ועוברים לפרויקט הניהול.
2. מוודאים ש-Ads Data Hub API מופעל בפרויקט בקטע APIs & Services.
   1. אם הוא לא מופעל, לוחצים על + Enable APIs and services ומפעילים את Ads Data Hub API.
3. בתפריט הניווט הימני, לוחצים על IAM & Admin (ניהול זהויות והרשאות גישה ואדמין) > Service Accounts (חשבונות שירות).
   1. אם עדיין לא יצרתם חשבון שירות, יוצרים אותו.
4. לוחצים על סמל התפריט (3 נקודות) (more_vert) בקטע 'פעולות' ואז על ניהול מפתחות.
   1. לוחצים על Add key (הוספת מפתח) > Create new key (יצירת מפתח חדש).
   2. מוודאים שהאפשרות JSON מסומנת ולוחצים על Create.
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 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))

השלבים הבאים

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