כל הקריאות ל-Google Ad Manager API חייבות לקבל הרשאה דרך OAuth2 תקן פתוח שמאפשר למשתמשים להעניק הרשאות לאפליקציות צד שלישי, כדי שהאפליקציה תוכל לקיים אינטראקציה עם שירותי אינטרנט בשמו של המשתמש. OAuth2 מאפשר לאפליקציית הלקוח ב-Ad Manager API לגשת לחשבון Ad Manager של המשתמש, בלי שתצטרכו לטפל בשם המשתמש או בסיסמה שלו או לשמור אותם.
יצירת פרטי כניסה של OAuth2
מבצעים את הפעולות הבאות כדי ליצור את פרטי הכניסה של OAuth2.
1. קביעת סוג האימות
בטבלה שבהמשך תוכלו לראות איזה סוג אימות הכי מתאים לאפליקציית Ad Manager API:
| בחירת סוג האימות של OAuth2 | |
|---|---|
| חשבון שירות |
כדאי לבחור באפשרות הזו אם אתם צריכים גישה רק לנתונים שלכם ב-Ad Manager. מידע נוסף |
| אפליקציית אינטרנט |
יש לבחור באפשרות הזו אם ברצונך לבצע אימות כמשתמש שמעניק הרשאה לאפליקציה לגשת לנתונים שלו ב-Ad Manager. מידע נוסף |
2. יצירת פרטי כניסה של OAuth2
אחרי שקובעים את סוג האימות, לוחצים על הכרטיסייה המתאימה למטה ומבצעים את ההוראות ליצירת פרטי הכניסה של OAuth2:
- פותחים את הדף Credentials Console של Google API.
- בתפריט הנפתח של הפרויקט, לוחצים על Create a new project, נותנים שם לפרויקט. אפשר גם לערוך את מזהה הפרויקט הרלוונטי. לוחצים על Create.
- בדף Credentials, בוחרים באפשרות Create credentials ואז בוחרים באפשרות Service account key.
- בוחרים באפשרות חשבון שירות חדש ובוחרים באפשרות JSON.
- לוחצים על יצירה כדי להוריד קובץ שמכיל מפתח פרטי.
- פותחים את הדף Credentials Console של Google API.
- בתפריט הנפתח של הפרויקט, לוחצים על Create a new project, מזינים שם לפרויקט (ואפשר גם לערוך את מזהה הפרויקט הרלוונטי) ולוחצים על Create.
- בדף Credentials, בוחרים באפשרות Create credentials ואז בוחרים באפשרות OAuth client ID.
- יכול להיות שתתבקשו להגדיר שם מוצר בדף Consent Screen. אם זה יקרה, תצטרכו ללחוץ על Configure consent screen, לשלוח את המידע הנדרש וללחוץ על Save כדי לחזור לדף Credentials.
- בשדה סוג האפליקציה, בוחרים באפשרות אפליקציית אינטרנט. פועלים לפי ההוראות כדי להזין מקורות JavaScript, מזהי URI להפניה אוטומטית או את שניהם.
- לוחצים על יצירה.
- בדף שמופיע, מעתיקים את מזהה הלקוח ואת סוד הלקוח ללוח, כי תצטרכו אותם כשתגדירו את ספריית הלקוח.
3. הגדרה של רשת Ad Manager
אם אתם מפתחים צד שלישי, ייתכן שהלקוח יצטרך לבצע את השלב הזה עבורכם.
- עוברים אל רשת Ad Manager.
- לוחצים על הכרטיסייה ניהול מערכת.
- מוודאים שהגישה ל-API מופעלת.
- לוחצים על הלחצן הוספת משתמש לחשבון שירות.
- ממלאים את הטופס באמצעות כתובת האימייל של חשבון השירות. המשתמש בחשבון השירות צריך לקבל הרשאות גישה לישויות כאילו שהמשתמש בחשבון השירות ניגש לישויות בממשק המשתמש.
- לוחצים על הלחצן שמירה. אמורה להופיע הודעה שמאשרת את הוספת חשבון השירות.
- כדי להציג משתמשים קיימים של חשבון שירות, נכנסים לכרטיסייה Users (משתמשים) ולוחצים על המסנן Service Account.
- עוברים אל רשת Ad Manager.
- לוחצים על הכרטיסייה ניהול מערכת.
- מוודאים שהגישה ל-API מופעלת.
4. הגדרה של ספריית לקוח ושימוש בה
כדי להשתמש בפרטי הכניסה בספריית הלקוח, פועלים לפי המדריך המתאים בהמשך:
Java
.NET
Python
PHP
Ruby
אם תבחרו לא להשתמש באחת מספריות הלקוח שלנו, תצטרכו להטמיע בעצמכם את חשבון השירות או את אפליקציית האינטרנט של OAuth2.
מאחורי הקלעים
ספריות הלקוח שלנו מטפלות באופן אוטומטי בפרטים המופיעים בהמשך, כך שמומלץ לקרוא רק אם אתם מתעניינים במה שקורה מאחורי הקלעים. הקטע הזה מיועד למשתמשים מתקדמים שכבר מכירים את מפרט OAuth2 ויודעים איך להשתמש ב-OAuth2 עם Google APIs.
כותרת בקשת HTTP
כותרת ה-HTTP בכל בקשה ל-Ad Manager API חייבת לכלול אסימון גישה בצורה הזו:
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. |