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