כששולחים קריאה ל-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 או ב-OAuth 2.0 Playground כדי להתנסות בפרטי הכניסה של OAuth 2.0 וב-Google Ads API לפני שאתם כותבים קוד לאפליקציה.
כדי להטמיע את תהליכי העבודה של הרשאות OAuth 2.0, מומלץ להשתמש באחת מספריות OAuth 2.0 שזמינות בכתובת https://oauth.net/code/. עם זאת, פירטנו את ההוראות ל-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 כשפועלים לפי ההוראות במדריך. ה-scope של OAuth 2.0 שצריך להשתמש בו כדי לגשת ל-Google Ads API הוא https://www.googleapis.com/auth/adwords. בנוסף, אתם יכולים לדלג על הפרמטר sub כשאתם יוצרים את קבוצת ההצהרות של ה-JWT, כי שלבי ההגדרה נותנים לחשבון השירות גישה ישירה לחשבון Google Ads, וכך אין צורך להתחזות למשתמש ב-Google Ads.
לאחר מכן, משתמשים בטוקן הגישה בכותרת ה-HTTP של Authorization בכל קריאה ל-Google Ads API:
GET /v26/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 /v26/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
Request headers
בקטעים הבאים מתוארות כותרות ה-HTTP שנדרשות או משמשות לשליחת בקשות ל-Google Ads API.
מספר הלקוח של חשבון ההתחברות
בקריאות ל-Google Ads API שמתבצעות מחשבון ניהול לחשבון לקוח (כלומר, כשמתחברים כמנהל כדי לבצע קריאות ל-API לאחד מחשבונות הלקוח), צריך לספק גם את כותרת ה-HTTP login-customer-id. הערך הזה מייצג את מספר הלקוח ב-Google Ads של חשבון הניהול שמבצע את הקריאה ל-API.
הוספת הכותרת הזו שקולה לבחירת חשבון בממשק המשתמש של Google Ads אחרי הכניסה לחשבון, או ללחיצה על תמונת הפרופיל בפינה השמאלית העליונה של הדף. כשמציינים את מספר הלקוח, חשוב להסיר את המקפים (—). לדוגמה: 1234567890, ולא 123-456-7890. במדריך למודל הגישה של Google Ads מוסבר בהרחבה על מספר הלקוח לצורך התחברות.
GET /v26/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
login-customer-id: MANAGER_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