פרטים פנימיים של 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}" \