כשמפעילים את Google Ads API, צריך גם פרטי כניסה לאפליקציה OAuth 2.0 וגם אסימון
מפתח. אם אתם מבצעים קריאות ל-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. רושמים את מזהה הלקוח ואת סוד הלקוח וחוזרים לדף הזה.
אחרי שיצרתם לקוח 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 /v16/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
כותרות של בקשות
קוד מפתח
כדי לבצע קריאות ל-API, יש צורך גם בקוד מפתח ב-Google Ads API. תוכלו להגיש בקשה לאסימון לחשבון הניהול שלכם ישירות מממשק המשתמש של Google Ads. במאמר קבלת קוד המפתח מוסבר איך מגדירים קוד מפתח.
עליכם לכלול את הערך של קוד המפתח שלכם בכותרת ה-HTTP developer-token של כל קריאה ל-API של Google Ads:
GET /v16/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 /v16/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