כדי להפעיל את 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:
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 Reporting API:
GET /v0/customers:listAccessibleCustomers HTTP/1.1
Host: searchads360.googleapis.com
Authorization: Bearer ACCESS_TOKEN
כותרות הבקשות
מספר לקוח להתחברות
בשביל קריאות של Search Ads 360 Reporting API שמנהלות בחשבון לקוח (כלומר, כשאתם מתחברים לחשבון ניהול כדי לבצע קריאות ל-API באחד מחשבונות הלקוח שלו), צריך גם לספק את כותרת ה-HTTP login-customer-id. הערך הזה מייצג את מספר הלקוח ב-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