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