Authentication

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

ספריות הלקוח של Ad Manager משתמשות ב-Application Default Credentials כדי ליצור טוקני גישה עם היקפי הרשאות של Ad Manager API. במדריך הזה מוסבר איך להגדיר את Application Default Credentials.

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

למידע נוסף על אימות והרשאה, קראו את המדריך שימוש ב-OAuth 2.0.

בחירת סוג האימות

סוג אימות תיאור
חשבון שירות צריך לבחור באפשרות הזו אם רוצים לבצע אימות כחשבון ייעודי ולא כאדם מסוים.
מידע נוסף
אפליקציית אינטרנט צריך לבחור באפשרות הזו אם רוצים לאמת כל משתמש שנותן לאפליקציה הרשאה לגשת לנתונים שלו ב-Ad Manager.
מידע נוסף
פיתוח מקומי בחרו באפשרות הזו אם אתם רוצים לבצע אימות כחשבון Google שלכם או כחשבון שירות מסביבת הפיתוח המקומית.

הפעלת Ad Manager API

  1. מפעילים את Ad Manager API בפרויקט בענן ב-Google API Console.

  2. אם מתבקשים, בוחרים פרויקט או יוצרים פרויקט חדש.

יצירת פרטי כניסה

לוחצים על הכרטיסייה של סוג האימות ופועלים לפי ההוראות כדי ליצור את פרטי הכניסה:

חשבון שירות

ב-Google Cloud

כדי לאמת עומס עבודה שפועל ב-Google Cloud, צריך להשתמש בפרטי הכניסה של חשבון השירות שמקושר למשאב המחשוב שבו הקוד פועל.

לדוגמה, אתם יכולים לקשר חשבון שירות למכונה וירטואלית (VM) של Compute Engine, לשירות Cloud Run או למשימת Dataflow. זאת שיטת האימות המועדפת לקוד שפועל במשאב מחשוב של Google Cloud.

במאמרי העזרה בנושא צירוף חשבונות שירות מוסבר לאילו משאבים אפשר לצרף חשבונות שירות ואיך מצרפים אותם.

בארגון או אצל ספק אחר של שירותי ענן

הדרך המומלצת להגדיר אימות מחוץ ל-Google Cloud היא באמצעות איחוד שירותי אימות הזהות של עומסי עבודה. כדי לעשות זאת, יוצרים קובץ תצורה עם פרטי הכניסה, ומגדירים את משתנה הסביבה GOOGLE_APPLICATION_CREDENTIALS שיצביע אליו. הדרך הזו מאובטחת יותר מאשר יצירה של מפתח לחשבון שירות.

אם אין לכם אפשרות להגדיר את איחוד שירותי אימות הזהות של עומסי עבודה, תצטרכו ליצור חשבון שירות וליצור מפתח לחשבון השירות:

  1. פותחים את דף פרטי הכניסה ב-Google API Console.

  2. בדף Credentials, לוחצים על Create credentials ואז על Service Account.

  3. לוחצים על כתובת האימייל של חשבון השירות שעבורו רוצים ליצור מפתח.

  4. לוחצים על הכרטיסייה Keys.

  5. לוחצים על התפריט הנפתח Add key ובוחרים באפשרות Create new key.

  6. בוחרים באפשרות JSON בתור Key type ולוחצים על Create.

  7. מגדירים את משתנה הסביבה GOOGLE_APPLICATION_CREDENTIALS לנתיב של קובץ ה-JSON.

Linux או macOS

export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Windows

set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

אפליקציית אינטרנט

  1. פותחים את דף פרטי הכניסה ב-Google API Console.

  2. אם מוצגת בקשה, בוחרים את הפרויקט שבו הפעלתם את Ad Manager API.

  3. בדף Credentials, לוחצים על Create credentials ואז על OAuth client ID.

  4. בוחרים בסוג האפליקציה אפליקציית אינטרנט.

  5. ממלאים את הטופס ולוחצים על יצירה. באפליקציות שמשתמשות בשפות ובמסגרות כמו PHP, ‏ Java, ‏ Python, ‏ Ruby ו-‎ .NET, צריך לציין מזהי URI מורשים להפניה אוטומטית. כתובות ה-URI להפניה אוטומטית הן נקודות הקצה שאליהן שרת OAuth 2.0 יכול לשלוח תגובות. נקודות הקצה האלה חייבות לעמוד בכללי האימות של Google.

  6. אחרי שיוצרים את פרטי הכניסה, מורידים את הקובץ client_secret.json. שומרים את הקובץ באופן מאובטח במיקום שרק לאפליקציה יש גישה אליו.

מכאן, פועלים לפי השלבים כדי לקבל טוקני גישה מסוג OAuth 2.0

פיתוח מקומי

מגדירים את Application Default Credentials (ADC) בסביבה המקומית.

מתקינים את ה-CLI של Google Cloud ומאתחלים אותו באמצעות הפקודה הבאה:

gcloud init

יוצרים פרטי כניסה לאימות מקומי בחשבון Google ומגדירים את מזהה הפרויקט לפרויקט שבו Ad Manager API מופעל:

gcloud auth application-default login --scopes="https://www.googleapis.com/auth/admanager"
gcloud auth application-default set-quota-project PROJECT_ID

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

Linux או macOS

export GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

Windows

set GOOGLE_APPLICATION_CREDENTIALS=KEY_FILE_PATH

הגדרת רשת Ad Manager

חשבון שירות

  1. עוברים אל רשת Ad Manager.
  2. לוחצים על הכרטיסייה אדמין.
  3. מוודאים שהגישה ל-API מופעלת.
  4. לוחצים על הכפתור הוספת משתמש לחשבון השירות.
  5. ממלאים את הטופס באמצעות כתובת האימייל של חשבון השירות. צריך להוסיף את המשתמש בחשבון השירות לתפקידים ולצוותים המתאימים לשילוב ה-API.
  6. לוחצים על הלחצן שמירה. אמורה להופיע הודעה שמאשרת את הוספת חשבון השירות.
  7. כדי לראות את משתמשי חשבון השירות הקיימים, נכנסים לכרטיסייה Users ולוחצים על המסנן Service Account.

אפליקציית אינטרנט

  1. עוברים אל רשת Ad Manager.
  2. לוחצים על הכרטיסייה אדמין.
  3. מוודאים שהגישה ל-API מופעלת.

פיתוח מקומי

  1. עוברים אל רשת Ad Manager.
  2. לוחצים על הכרטיסייה אדמין.
  3. מוודאים שהגישה ל-API מופעלת.

בלי ספריית לקוח

אם אתם לא משתמשים בספריית לקוח, אנחנו עדיין ממליצים מאוד להשתמש בספריית OAuth2 לאימות.

הוראות מפורטות לקבלת אסימוני גישה זמינות במאמר שימוש ב-OAuth2 עם Google APIs.

אסימוני גישה

כדי לכלול את טוקן הגישה בבקשה ל-API, צריך לכלול ערך של פרמטר השאילתה access_token או ערך של כותרת ה-HTTP‏ Authorization Bearer. כשאפשר, עדיף להשתמש בכותרת HTTP, כי מחרוזות של שאילתות נוטות להופיע ביומני השרת.

לדוגמה:

GET /v1/networks/1234
Host: admanager.googleapis.com
Authorization: Bearer ya29.a0Ad52N3_shYLX

GET https://admanager.googleapis.com/v1/networks/1234?access_token=1/fFAGRNJru1FTz70BzhT3Zg

היקף

כל טוקן גישה משויך להיקף אחד או יותר. היקף ההרשאות קובע את קבוצת המשאבים והפעולות שאסימון הגישה מאפשר. ל-Ad Manager API יש שני היקפים. אם האפליקציה לא צריכה לכתוב נתונים, מומלץ להשתמש בהיקף הצר יותר admanager.readonly.

היקף הרשאות
https://www.googleapis.com/auth/admanager לראות ולנהל את הקמפיינים ב-Google Ad Manager.
https://www.googleapis.com/auth/admanager.readonly צפייה בקמפיינים ובנתונים ב-Google Ad Manager.