כדי לבצע קריאה ל-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 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 של כל קריאה ל-API ל-Google Ads API:
GET /v19/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 /v19/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 /v19/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