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.

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

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

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

חשבון שירות

ב-Google Cloud

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

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

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

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

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

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

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

  2. בדף Credentials, בוחרים באפשרות Create credentials (יצירת פרטי כניסה) ואז בוחרים באפשרות חשבון שירות.

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

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

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

  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 (מזהה לקוח OAuth).

  4. בוחרים בסוג האפליקציה Web application.

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

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

מכאן, צריך לפעול לפי השלבים לקבלת אסימוני גישה מסוג OAuth 2.0

פיתוח מקומי

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

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

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. לוחצים על הלחצן Add a service account user.
  5. ממלאים את הטופס באמצעות כתובת האימייל של חשבון השירות. צריך להוסיף משתמש בחשבון שירות לתפקידים ולצוותים מתאימים לשילוב של ה-API.
  6. לוחצים על הלחצן שמירה. אמורה להופיע הודעה עם אישור ההוספה של חשבון השירות.
  7. כדי לראות משתמשים קיימים בחשבון השירות, עוברים לכרטיסייה Users (משתמשים) ואז לוחצים על המסנן חשבון שירות.

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

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

פיתוח מקומי

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

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

גם אם אתם לא משתמשים בספריית לקוח, מומלץ מאוד להשתמש ספריית OAuth2 לצורך אימות.

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

אסימוני גישה

כלול את אסימון הגישה שלך בבקשה ל-API על ידי הוספת פרמטר של שאילתת access_token או ערך Bearer של כותרת HTTP ב-Authorization. כשהדבר אפשרי, עדיף להשתמש בכותרת 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

היקף

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

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