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

סרטון: אימות

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

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

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

אם זו הפעם הראשונה שאתם משתמשים ב-Google APIs, תוכלו: oauth2l או OAuth 2.0 Playground להתנסות את פרטי הכניסה של האפליקציה ואת ה-Google Ads API לפני כתיבת הקוד עבור אפליקציה.

שימוש בתהליכי עבודה במחשב או באפליקציית אינטרנט

פועלים לפי השלבים להגדרת פרויקט ב'מסוף Google API' עבור ב-Google Ads API מתעדים את client ID client secret ואז חוזרים לדף הזה.

אחרי שיוצרים לקוח OAuth, פועלים לפי תהליך העבודה של האפליקציה למחשב הוראות או בתהליך של אפליקציית האינטרנט הוראות כדי יוצרים אסימון רענון ואסימון גישה.

שימוש בחשבונות שירות

פועלים לפי ההוראות הנפוצות בשירות. חשבונות מדריך להגדרת גישה לחשבון שירות עבור Google Ads API.

אחרי שמגדירים חשבון שירות שיש לו גישה לחשבון Google Ads, פועלים לפי השלבים הבאים: שימוש ב-OAuth 2.0 לשרת לשרת הגשת מועמדות מדריך ומקפידים לבחור בכרטיסייה HTTP/REST. scope לשימוש ב-Google Ads API הרשאת הגישה היא https://www.googleapis.com/auth/adwords.

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

אחרי שיש לכם מזהה לקוח, סוד לקוח ואסימון רענון, אתם יכולים ליצור אסימון גישה חדש לשימוש בקריאות ל-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 אל Google Ads API:

GET /v17/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN

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

קוד מפתח

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

עליך לכלול את הערך של קוד המפתח שלך ב-HTTP developer-token הכותרת של כל קריאה ל-API ל-Google Ads API:

GET /v17/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN

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

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

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

GET /v17/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID

מספר הלקוח המקושר

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

...
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID
linked-customer-id: LINKED_CUSTOMER_ID

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

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

מזהה בקשה

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

request-id: 2a5Cj89VV7CNhya1DZjjrC