כל הקריאות ל-API של Google Ad Manager חייבות להיות מאושרות באמצעות OAuth2. תקן זה מאפשר למשתמשים להעניק הרשאות לאפליקציות של צד שלישי, כדי שהאפליקציה תוכל לתקשר עם שירותי אינטרנט בשם המשתמש. OAuth2 מאפשר לאפליקציית הלקוח של Ad Manager API לגשת לחשבון Ad Manager של המשתמש, מבלי לטפל או לאחסן את שם המשתמש או הסיסמה של המשתמש.
יצירת פרטי כניסה של OAuth2
כדי ליצור את פרטי הכניסה ל-OAuth2, יש לבצע את השלבים הבאים.
1. קביעת סוג האימות
בטבלה שבהמשך מפורטים סוגי האימותים שהכי מתאימים לאפליקציית Ad Manager API שלכם:
בחירת סוג האימות שלך ל-OAuth2 | |
---|---|
חשבון שירות |
יש לבחור באפשרות הזו אם דרושה לך גישה רק לנתונים שלך ב-Ad Manager. מידע נוסף |
אפליקציית אינטרנט |
יש לבחור באפשרות הזו אם ברצונך לבצע אימות כמשתמש שמשתמש להעניק לאפליקציה שלך הרשאת גישה לנתוני Ad Manager שלו. מידע נוסף |
2. יצירת פרטי כניסה מסוג OAuth2
אחרי שקובעים את סוג האימות, לוחצים על הכרטיסייה המתאימה למטה ופועלים לפי ההוראות ליצירת פרטי כניסה של OAuth2:
- פותחים את דף פרטי הכניסה של Google API Console.
- בתפריט הנפתח של הפרויקט, בוחרים באפשרות Create a new project, מזינים שם לפרויקט (ואפשר גם לערוך את מזהה הפרויקט שסופק). לוחצים על יצירה.
- בדף 'פרטי כניסה', בוחרים באפשרות יצירת פרטי כניסה ובוחרים באפשרות מפתח חשבון שירות.
- בוחרים באפשרות חשבון שירות חדש ובוחרים באפשרות JSON.
- לוחצים על יצירה כדי להוריד קובץ שמכיל מפתח פרטי.
- פותחים את דף פרטי הכניסה של Google API Console.
- בתפריט הנפתח של הפרויקט, בוחרים באפשרות Create a new project, מזינים שם לפרויקט (ואופציונלית, עורכים את מזהה הפרויקט) ולוחצים על Create.
- בדף 'פרטי כניסה', בוחרים באפשרות יצירת פרטי כניסה, ולאחר מכן בוחרים באפשרות מזהה לקוח OAuth.
- ייתכן שתתבקשו להגדיר שם מוצר בדף 'מסך הסכמה'. אם כן, לוחצים על הגדרת מסך הסכמה, מספקים את המידע המבוקש ולוחצים על שמירה כדי לחזור לדף פרטי הכניסה.
- בשדה סוג אפליקציה בוחרים באפשרות אפליקציית אינטרנט. פועלים לפי ההוראות כדי להזין מקורות JavaScript, הפניות ל-URI או את שניהם.
- לוחצים על Create.
- בדף שמופיע, מעתיקים את Client ID ואת ClientClient ללוח, מפני שתצטרכו אותם כשמגדירים את ספריית הלקוח.

3. הגדרה של רשת Ad Manager
אם אתם מפתחים של צד שלישי, ייתכן שתצטרכו לבקש מהלקוח לעשות זאת.
- נכנסים לרשת Ad Manager.
- לוחצים על הכרטיסייה ניהול מערכת.
- יש לוודא שהגישה ל-API מופעלת.
- לוחצים על הלחצן הוספת משתמש לחשבון שירות.
- ממלאים את הטופס באמצעות כתובת האימייל של חשבון השירות. למשתמש בחשבון השירות צריכה להיות הרשאה לגשת לישויות כאילו שהמשתמש בחשבון השירות ניגש לישויות בממשק המשתמש.
- לוחצים על הלחצן שמירה. אמורה להופיע הודעה שמאשרת את ההוספה של חשבון השירות שלך.
- כדי להציג את המשתמשים הקיימים בחשבון השירות, עוברים לכרטיסייה 'משתמשים' ולוחצים על המסנן חשבון השירות.
- נכנסים לרשת Ad Manager.
- לוחצים על הכרטיסייה ניהול מערכת.
- יש לוודא שהגישה ל-API מופעלת.
4. הגדרה של ספריית לקוח ושימוש בה
יש לפעול לפי המדריך המתאים בהמשך כדי להשתמש בפרטי הכניסה בספריית הלקוח שלך:
Java
.NET
Python
PHP
Ruby
אם תבחרו שלא להשתמש באחת מספריות הלקוחות שלנו, תצטרכו להטמיע בעצמכם את חשבון השירות או אפליקציית האינטרנט של OAuth2.
מאחורי הקלעים
ספריות הלקוחות שלנו מטפלות באופן אוטומטי בפרטים המתוארים בהמשך, כך שתקראו רק אם אתם מתעניינים במה שקורה מאחורי הקלעים. הקטע הזה מיועד למשתמשים מתקדמים שכבר מכירים את מפרט OAuth2 ומכירים את השימוש ב-OAuth2 עם Google APIs.
כותרת של בקשת HTTP
בכל בקשת HTTP API של Ad Manager יש לכלול אסימון גישה בטופס הזה:
Authorization: Bearer ACCESS_TOKEN
למשל:
POST … HTTP/1.1 Host: … Authorization: Bearer 1/fFAGRNJru1FTz70BzhT3Zg Content-Type: text/xml;charset=UTF-8 Content-Length: … <?xml version="1.0"?> <soap:Envelope xmlns:soap="http://www.w3.org/2001/12/soap-envelope"> … </soap:Envelope>
היקף ההרשאות
אסימון גישה יחיד יכול להעניק דרגות גישה שונות למספר ממשקי API. פרמטר משתנה שנקרא scope
שולט בקבוצת המשאבים והפעולות המותרים על ידי אסימון גישה. במהלך הבקשה לאסימון הגישה, האפליקציה שולחת ערך אחד או יותר בפרמטר scope
.
ל-Ad Manager יש רק היקף אחד, המוצג בהמשך. צריך לבצע את האימות ברמת המשתמש במוצר.
היקף ההרשאות | הרשאות |
---|---|
https://www.googleapis.com/auth/dfp |
הצגה וניהול של הקמפיינים ב-Ad Manager. |