כשמבצעים קריאה ל-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 של כל קריאה ל-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 לאחד מחשבונות הלקוח שלו), צריך לספק גם את login-customer-id HTTP header. הערך הזה מייצג את מספר הלקוח ב-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