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

במדריך הזה מוסבר איך להתחיל לכתוב אפליקציות שמשתמשות ב-API ל-REST של Ads Data Hub כדי ליצור אינטראקציה עם 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 בפרויקט באמצעות המסוף:
    1. נכנסים אל ספריית Cloud Console API.
    2. בוחרים מתוך רשימת הפרויקטים את הפרויקט שבו רוצים להשתמש.
    3. מחפשים את Ads Data Hub API.
    4. בדף ה-API, לוחצים על הפעלה.
  3. ניהול הרשאות:
    1. כתובת האימייל או חשבון השירות ששימשו ליצירת פרטי הכניסה חייבים יתווסף ל-Ads Data Hub ההרשאות המתאימות. עבור חשבון שירות, זוהי כתובת האימייל של חשבון השירות. עבור OAuth, זו כתובת האימייל של המשתמש. כך אפשר לוודא שהשירות לחשבון או לחשבון של משתמש הקצה יש הרשאה להריץ שאילתות Ads Data Hub.
  4. (מומלץ) מתקינים ספריית לקוח של Google API:
    1. ספריות הלקוח של Google API זמינות בכמה והם מאפשרים לעבוד עם הרבה ממשקי API של Google. למרות שזו לא שנדרשות, ספריות הלקוח מפחיתות את כמות הקוד כדי לכתוב את ההודעה ולהפוך את האימות לפשוט יותר.
ספריית לקוח דוגמאות ל-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 & שירותים.
    1. אם היא לא מופעלת, לוחצים על + הפעלה של ממשקי API ושירותים ומפעילים את המודעות. ממשק API של מרכז נתונים.
  3. בתפריט הניווט השמאלי לוחצים על IAM & אדמין > חשבונות שירות.
    1. אם עדיין לא יצרתם חשבון שירות, ליצור חשבון.
  4. לוחצים על סמל התפריט (3 נקודות) () בקטע 'פעולות' ואז לוחצים על ניהול מפתחות.
    1. לוחצים על Add 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 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 REST API מופיעות במאמר שאילתות לדוגמה ב-Ads Data Hub.
  • אפשר להרחיב את הדוגמאות כדי להכיר את ה-API ולהתאים אותו אישית לתרחיש לדוגמה שלכם. לאחר מכן נסו:
  • אם יש לכם שאלות או משוב לגבי ה-API, אפשר לפנות לתמיכה של ADH.
הקודם
איך מגדירים חשבון
הבא
שימוש בממשק המשתמש באינטרנט