הרשאה וכותרות HTTP

כדי לבצע קריאה ל-Search Ads 360 Reporting API, צריך פרטי כניסה של אפליקציה מסוג OAuth 2.0. אם אתם מבצעים קריאות API בתור חשבון ניהול ב-Search Ads 360, עליכם לציין גם כותרת login-customer-id בכל בקשה. בדף הזה מוסבר איך להגדיר את הערכים האלה, ומפורטים כמה כותרות HTTP נוספות ספציפיות ל-API שנשלחות ומתקבלות כשמשתמשים בממשק ה-REST.

פרטי כניסה ל-OAuth 2.0

ב-Search Ads 360 Reporting API נעשה שימוש בפרטי כניסה של אפליקציה לזיהוי ולמתן הרשאה לבקשות API. אפשר להגדיר לקוחות OAuth 2.0. כל הקריאות ל-Search Ads 360 Reporting API צריכות לקבל הרשאה דרך OAuth2. OAuth2 מאפשר לאפליקציית הלקוח של Search Ads 360 Reporting API לגשת לחשבון Search Ads 360 של משתמש בלי שתצטרכו לטפל בפרטי הכניסה של המשתמש או לאחסן אותם.

אם אתם משתמשים חדשים ב-Google APIs, תוכלו להשתמש ב-oauth2l או ב-OAuth 2.0 Playground כדי להתנסות בפרטי הכניסה של האפליקציה וב-Search Ads 360 Reporting API לפני כתיבת הקוד של האפליקציה. אפשר גם ליצור אסימון רענון של OAuth על ידי הפעלת הסקריפט ליצירת פרטי כניסה של משתמשים שסופק.

יצירת אסימוני גישה חדשים

אחרי שמקבלים מזהה לקוח, סוד לקוח ואסימון רענון, אפשר ליצור אסימון גישה חדש לשימוש בקריאות ל-API באמצעות כלי שורת הפקודה curl:

הערה: הגרסה v3 בכתובת ה-URL של נקודת הקצה של OAuth לא קשורה לגרסה של Search Ads 360 Reporting API, ואין לשנות אותה במהלך המעבר לגרסאות חדשות יותר של Search Ads 360 Reporting API.

curl \
  --data "grant_type=refresh_token" \
  --data "client_id=CLIENT_ID" \
  --data "client_secret=CLIENT_SECRET" \
  --data "refresh_token=REFRESH_TOKEN" \
  https://www.googleapis.com/oauth2/v3/token

לאחר מכן משתמשים באסימון הגישה שהוחזר על ידי בקשת ה-curl בכותרת ה-HTTP ‏Authorization של כל קריאה ל-API לממשק הדיווח של Search Ads 360:

GET /v0/customers:listAccessibleCustomers HTTP/1.1
Host: searchads360.googleapis.com
Authorization: Bearer ACCESS_TOKEN

כותרות של בקשות

מספר לקוח להתחברות

בקריאות ל-Reporting API של Search Ads 360 שמנוהלות על ידי חשבון ניהול לחשבון לקוח (כלומר, כשנכנסים לחשבון ניהול כדי לבצע קריאות ל-API לאחד מחשבונות הלקוח שלו), צריך לספק גם את הכותרת login-customer-id HTTP. הערך הזה מייצג את מספר הלקוח ב-Search Ads 360 של מנהל החשבון שמבצע את קריאת ה-API.

הוספת הכותרת הזו זהה לבחירת חשבון בממשק המשתמש של Search Ads 360 אחרי הכניסה לחשבון או לחיצה על תמונת הפרופיל בפינה השמאלית העליונה של הדף. כשמציינים את מספר הלקוח, חשוב להסיר מקפים (–), לדוגמה: 1234567890 ולא 123-456-7890.

GET /v0/customers:listAccessibleCustomers HTTP/1.1
Host: searchads360.googleapis.com
Authorization: Bearer ACCESS_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID

כותרות תגובה

הכותרות הבאות מוחזרות בתגובות HTTP מה-API.

מזהה בקשה

השדה request-id הוא מחרוזת שמזהה באופן ייחודי את בקשת ה-API. כשאתם מנסים לנפות באגים או לפתור בעיות בקריאות API ספציפיות, request-id הוא מזהה חשוב שצריך לשמור לשימוש כשאתם פונים לתמיכה למפתחים של Google.

request-id: 2a5Cj89VV7CNhya1DZjjrC