כדי לבצע קריאות ל-Google Ads API, צריך פרטי כניסה של OAuth 2.0. אם אתם מבצעים קריאות ל-API באמצעות חשבון ניהול ב-Google Ads, אתם צריכים גם לציין כותרת login-customer-id בכל בקשה. בדף הזה מוסבר איך להגדיר את הערכים האלה, ומתועדות בו כמה כותרות HTTP נוספות שספציפיות ל-API ונשלחות ומתקבלות כשמשתמשים בממשק REST.
פרטי כניסה של OAuth 2.0
ב-Google Ads API נעשה שימוש ב-OAuth 2.0 כדי לאשר בקשות ל-API. יש תמיכה בתהליך אימות משתמשים וגם בתהליך של חשבון שירות ב-OAuth 2.0. פרטים נוספים זמינים במאמר OAuth 2.0 ב-Google Ads API.
אם אתם חדשים ב-Google APIs, אתם יכולים להשתמש ב-gcloud CLI או ב-OAuth 2.0 Playground כדי להתנסות בהרשאות OAuth 2.0 וב-Google Ads API לפני שתכתבו קוד לאפליקציה שלכם.
מומלץ להשתמש באחת מספריות OAuth 2.0 שזמינות בכתובת https://oauth.net/code/ כדי להטמיע את תהליכי העבודה של הרשאת OAuth 2.0. עם זאת, ריכזנו את ההוראות לשימוש ב-curl למקרה שתצטרכו להטמיע אותו בעצמכם.
חשבונות שירות
פועלים לפי השלבים להגדרת פרויקט ב-Google Cloud עבור Google Ads API. רושמים את כתובת האימייל בחשבון השירות ואת המפתח של חשבון השירות. לאחר מכן, פועלים לפי ההוראות הכלליות במדריך בנושא חשבונות שירות כדי להגדיר את חשבון השירות כך שתהיה לו גישה לחשבון Google Ads.
אימות משתמשים
פועלים לפי השלבים להגדרת פרויקט ב-מסוף Google Cloud עבור Google Ads API. רושמים את מזהה הלקוח ואת הסוד של הלקוח. לאחר מכן, פועלים לפי ההוראות לשימוש באפליקציה למחשב או לפי ההוראות לשימוש באפליקציית האינטרנט כדי ליצור אסימון רענון ואסימון גישה. ה-scope שצריך להשתמש בו כדי לגשת אל Google Ads API הוא https://www.googleapis.com/auth/adwords.
יצירת טוקנים חדשים של גישה
חשבונות שירות
אחרי שיש לכם את כתובת האימייל בחשבון השירות ואת המפתח של חשבון השירות, אתם יכולים לפעול לפי המדריך שימוש ב-OAuth 2.0 לאפליקציות שרת-אל-שרת כדי ליצור קבוצת הצהרות JWT, שאפשר להחליף אותה כדי לקבל טוקן גישה מסוג OAuth 2.0. חשוב לוודא שבוחרים בכרטיסייה HTTP/REST כשפועלים לפי ההוראות. ה-OAuth 2.0 scope שמשמש לגישה אל Google Ads API הוא https://www.googleapis.com/auth/adwords. בנוסף, אפשר לדלג על הפרמטר sub כשיוצרים את קבוצת התביעות של ה-JWT, כי שלבי ההגדרה מעניקים לחשבון השירות גישה ישירה לחשבון Google Ads, ולכן אין צורך להתחזות למשתמש Google Ads.
לאחר מכן משתמשים בטוקן הגישה בכותרת ה-HTTP של Authorization בכל קריאה ל-Google Ads API:
GET /v25/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
אימות משתמשים
אחרי שיש לכם מזהה לקוח, סוד לקוח ואסימון רענון מסוג OAuth 2.0, אתם יכולים ליצור אסימון גישה חדש לשימוש בקריאות ל-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 של כל קריאה ל-Google Ads API:
GET /v25/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
כותרות של בקשות
בקטעים הבאים מתוארות כותרות ה-HTTP שנדרשות או שנעשה בהן שימוש כששולחים בקשות אל Google Ads API.
מספר הלקוח להתחברות
בקריאות ל-Google Ads API שמתבצעות על ידי חשבון ניהול לחשבון לקוח (כלומר, כשמתחברים לחשבון ניהול כדי לבצע קריאות ל-API לאחד מחשבונות הלקוח שלו), צריך לספק גם את כותרת ה-HTTP login-customer-id. הערך הזה מייצג את מזהה הלקוח ב-Google Ads של חשבון הניהול שמבצע את הקריאה ל-API.
הכללת הכותרת הזו שקולה לבחירת חשבון בממשק המשתמש של Google Ads אחרי הכניסה לחשבון או לחיצה על תמונת הפרופיל בפינה השמאלית העליונה של הדף. כשמציינים את מספר הלקוח, חשוב להסיר את כל המקפים (—). לדוגמה: 1234567890, ולא 123-456-7890. במדריך למודל הגישה של Google Ads יש מידע נוסף על מספר הלקוח להתחברות.
GET /v25/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID
מספר הלקוח המקושר
הכותרת Linked customer ID משמשת שותפים (כמו ספקים של ניתוח נתוני אפליקציות של צד שלישי או שותפי נתונים) כשהם מבצעים פעולות בחשבון Google Ads מקושר. פרטים נוספים מופיעים במדריך בנושא מבנה הקריאות ל-API.
Authorization: Bearer ACCESS_TOKEN
login-customer-id: PARTNER_CUSTOMER_ID
linked-customer-id: ADVERTISER_CUSTOMER_ID
כותרות תגובה
הכותרות הבאות מוחזרות בתגובות HTTP מה-API.
מזהה בקשה
request-id היא מחרוזת שמזהה באופן ייחודי את בקשת ה-API. כשמבצעים ניפוי באגים או פותרים בעיות שקשורות לקריאות ספציפיות ל-API, חשוב שיהיה לכם את מזהה request-id בהישג יד כדי שתוכלו לפנות לתמיכת המפתחים של Google.
request-id: 2a5Cj89VV7CNhya1DZjjrC