פרטים פנימיים של OAuth 2.0 ל-Google Ads API

הקטע הזה מיועד למשתמשים מתקדמים שכבר מכירים את המפרט של OAuth 2.0 ויודעים להשתמש ב-OAuth 2.0 עם Google APIs.

היקף

טוקן גישה אחד יכול להעניק רמות שונות של גישה לכמה ממשקי API. פרמטר משתנה שנקרא scope קובע את קבוצת המשאבים והפעולות שאסימון הגישה מאפשר. במהלך הבקשה לאסימון גישה, האפליקציה שולחת ערך אחד או יותר בפרמטר scope.

היקף הגישה ל-Google Ads API הוא:

https://www.googleapis.com/auth/adwords

גישה אופליין ומשך החיים של אסימונים

אפליקציית לקוח של Google Ads API בדרך כלל מבקשת גישה אופליין. לדוגמה, יכול להיות שהאפליקציה תצטרך להריץ משימות באצווה כשהמשתמש לא גולש באתר שלכם. משך החיים של אסימוני גישה הוא 3,600 שניות (שעה אחת), ולאחר מכן האפליקציה צריכה להחליף אסימון רענון באסימון גישה חדש.

כדי לבקש גישה אופליין לאפליקציית אינטרנט, צריך להגדיר את הפרמטר access_type לערך offline. מידע נוסף זמין במדריך של Google בנושא OAuth 2.0.

באפליקציות למחשב, הגישה אופליין מופעלת כברירת מחדל, ואין צורך לבקש אותה באופן מפורש.

Request headers

כל הבקשות ל-Google Ads API חייבות לכלול את אסימון הגישה של OAuth 2.0 בכותרת הבקשה. בקטעים הבאים מוסבר איך להעביר את פרטי הכניסה האלה באמצעות gRPC ו-REST.

כותרות gRPC

כשמשתמשים ב-gRPC API, צריך לכלול את אסימון הגישה בכל בקשה. אפשר לקשר Credential ל-Channel כדי להשתמש בו בכל הבקשות בערוץ הזה. אפשר גם לשלוח פרטי כניסה בהתאמה אישית לכל קריאה. במדריך לאימות ב-gRPC מפורט מידע נוסף על הטיפול באימות.

כותרות REST

כשמשתמשים ב-API בארכיטקטורת REST, מעבירים את אסימון הגישה דרך כותרת ה-HTTP ‏Authorization: Bearer <ACCESS_TOKEN>. דוגמה לבקשת HTTP:

# Returns the resource names of customers directly accessible by the user
# authenticating the call.
#
# Variables:
#   API_VERSION,
#   OAUTH2_ACCESS_TOKEN:
#     See https://developers.google.com/google-ads/api/rest/auth#request_headers
#     for details.
#
curl -f --request GET \
"https://googleads.googleapis.com/v${API_VERSION}/customers:listAccessibleCustomers" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer ${OAUTH2_ACCESS_TOKEN}" \