כך מגדירים גישה ל-Data Manager API באמצעות SDK או REST.
דרישות מוקדמות
פרויקט ב-Google Cloud או חשבון Google שאתם רוצים שיהיה הבעלים של הפרויקט.
- אם אין לכם פרויקט, תוכלו ליצור פרויקט בתהליך ההגדרה שבקטע הבא.
אם כבר יש לכם פרויקט, ודאו שלחשבון Google שלכם יש תפקיד שמאפשר להפעיל ממשקי API בפרויקט, כמו בעלים, עריכה או אדמין של שימוש בשירות. כדי לבדוק את התפקיד שלכם, פתחו את הדף IAM במסוף Google Cloud, בחרו את הפרויקט ומצאו את חשבון Google שלכם ברשימה.
פרטים נוספים זמינים במאמר בדיקה למי יש גישה.
התקנה של Google Cloud CLI.
הפעלת ה-API
אם עדיין לא עשיתם את זה, אתם צריכים להפעיל את Data Manager API בפרויקט ב-Google Cloud. כדי לעשות את זה, לוחצים על הפעלת Data Manager API או פועלים לפי ההוראות כדי לבצע את השלב הזה באופן ידני.
הפעלת Data Manager APIאם אתם לא מוצאים את Data Manager API או שהפעולה Enable the Data Manager API נכשלת, ודאו שחשבון Google שלכם עומד בדרישות המוקדמות.
מגדירים אימות
אתם יכולים להשתמש בכל אחת משיטות האימות ב-Google, חוץ ממפתחות API. מומלץ לקרוא את המאמר בחירת שיטת האימות שמתאימה לתרחיש שלכם לדוגמה כדי להחליט איזו גישה מתאימה לתרחיש שלכם לדוגמה.
שתי שיטות אימות נפוצות הן חשבונות משתמשים וחשבונות שירות:
- חשבונות משתמשים: מייצגים אנשים שמנהלים אינטראקציה ישירות עם Google APIs והשירותים של Google.
- חשבונות שירות: מייצגים אפליקציות, ולא אנשים, כמשתמשים. הם מאפשרים לאפליקציות לנהל את האימות וההרשאה. לדוגמה, אם אפליקציה צריכה לגשת למשאבים של Google Cloud.
האינטגרציה יכולה להשתמש ב-Application Default Credentials (ADC) כדי למצוא באופן אוטומטי את פרטי הכניסה מהסביבה, כך שלא תצטרכו לשנות את קוד הלקוח לצורך אימות.
כדי להגדיר את ADC, בוחרים באפשרות חשבון משתמש או חשבון שירות:
חשבון משתמש
כדי לבצע אימות באמצעות פרטי כניסה של חשבון משתמש:
קובעים את ההגדרות של פלטפורמת האימות של Google בפרויקט.
פותחים את הדף Branding במסוף Google Cloud.
בוחרים את הפרויקט הרצוי.
ממלאים את הטופס ולוחצים על יצירה.
מכיוון ש-Data Manager API משתמש בהיקפי הרשאות רגישים, צריך לבצע את השלבים הבאים:
עוברים להגדרות של Data Access בפרויקט.
לוחצים על הוספה או הסרה של היקפי הרשאות.
ברשימת היקפי ההרשאות, מוצאים את Data Manager API ומסמנים את התיבה של כל היקף הרשאות שהאפליקציה צריכה:
.../auth/datamanager: בחרו בהיקף הזה לפעולות API רגילות, כמו ניהול נתוני לקוחות, קהלים ואירועים. זהו היקף ההרשאות העיקרי שמשמש במדריך הזה.
.../auth/datamanager.partnerlink: בחרו בהיקף הזה רק אם אתם שותפי נתונים שיוצרים או מוחקים קישורים של שותפים בחשבונות של מפרסמים.
לוחצים על עדכון.
לוחצים על שמירה.
נכנסים לדף Audience במסוף Google Cloud וקובעים את ההגדרות לפיתוח הראשוני:
- מגדירים את Publishing status (סטטוס הפרסום) ל-Testing (בדיקה).
- מגדירים את User type ל-Internal (אם הפרויקט הוא בארגון ב-Google Workspace) או ל-External (אם הוא לא).
- אם משתמשים באפשרות External, מוסיפים את חשבונות Google שמשמשים ליצירת פרטי כניסה בתור Test users.
מידע נוסף על ההגדרות האלה זמין במאמר ניהול קהל היעד של האפליקציה.
לוחצים על Create OAuth2 client כדי ליצור לקוח OAuth2 בפרויקט, או פועלים לפי ההוראות ליצירת לקוח OAuth2 למחשב. אם כבר יש לכם לקוח OAuth2 מסוג Desktop שאתם רוצים להשתמש בו ב-Data Manager API, אתם יכולים לדלג על השלב הזה.
אם לוחצים על Create OAuth2 client, בוחרים באפשרות אפליקציה למחשב כשמוצגת ההודעה Configure your OAuth client, כדי שתוכלו להשתמש בלקוח OAuth בשלבים הבאים.
יצירת לקוח OAuth2בשלב האחרון, לוחצים על DOWNLOAD CLIENT CONFIGURATION וזוכרים את מיקום ההורדה שבחרתם.
מריצים את הפקודה הבאה כדי ליצור קובץ ADC מקומי. הפקודה הזו מפעילה תהליך אינטרנטי שבו תתבקשו להתחבר לחשבון Google שבו אתם משתמשים עם ה-API.
מחליפים את PATH_TO_CLIENT_JSON בשם של קובץ ה-JSON שהורדתם.
gcloud auth application-default login \ --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/cloud-platform" \ --client-id-file="PATH_TO_CLIENT_JSON"אם אתם רוצים להשתמש באותם פרטי כניסה ל-Data Manager API ול-Google Ads API, צריך לכלול את ההיקף של Google Ads API ברשימה
--scopes:gcloud auth application-default login \ --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/adwords,https://www.googleapis.com/auth/cloud-platform" \ --client-id-file="PATH_TO_CLIENT_JSON"אם אתם רוצים להשתמש באותם פרטי כניסה ל-Data Manager API ול-Display & Video 360 API, צריך לכלול את ההיקף של Display & Video 360 API ברשימה
--scopes:gcloud auth application-default login \ --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/display-video,https://www.googleapis.com/auth/cloud-platform" \ --client-id-file="PATH_TO_CLIENT_JSON"כדי לוודא שפרטי הכניסה הוגדרו בצורה נכונה, משתמשים בפקודה הבאה. אם הפקודה מסתיימת בלי שגיאות, היא מדפיסה אסימון גישה למסוף.
gcloud auth application-default print-access-token
חשבון שירות
כך יוצרים חשבון שירות ומשתמשים בהתחזות לחשבון שירות כדי לבצע אימות בסביבת פיתוח מקומית: בשלבים האלה משתמשים בהתחזות במקום במפתחות של חשבונות שירות, כי מפתחות של חשבונות שירות יכולים להפוך לסיכון אבטחה אם לא מנהלים אותם בקפידה.
לוחצים על הלחצן Create service account או פועלים לפי ההוראות כדי לבחור או ליצור חשבון שירות.
יצירה של חשבון שירותמקצים לחשבון השירות את התפקיד Service Usage Consumer ב-IAM (
roles/serviceusage.serviceUsageConsumer), שכולל את ההרשאהserviceusage.services.useשמאפשרת לחשבון השירות לשלוח בקשות API לפרויקט.gcloud projects add-iam-policy-binding PROJECT_ID \ --member="serviceAccount:SERVICE_ACCOUNT_EMAIL" \ --role="roles/serviceusage.serviceUsageConsumer"נותנים לחשבון Google את תפקיד ה-IAM יצירת אסימונים בחשבון שירות (
roles/iam.serviceAccountTokenCreator) בחשבון השירות.gcloud iam service-accounts add-iam-policy-binding SERVICE_ACCOUNT_EMAIL \ --member="user:USER_EMAIL" \ --role="roles/iam.serviceAccountTokenCreator"מריצים את הפקודה הבאה כדי להגדיר את ה-ADC:
gcloud auth application-default login \ --impersonate-service-account=SERVICE_ACCOUNT_EMAIL \ --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/cloud-platform"אם אתם רוצים להשתמש באותם פרטי כניסה ל-Data Manager API ול-Google Ads API, צריך לכלול את ההיקף של Google Ads API ברשימה
--scopes:gcloud auth application-default login \ --impersonate-service-account=SERVICE_ACCOUNT_EMAIL \ --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/adwords,https://www.googleapis.com/auth/cloud-platform"אם אתם רוצים להשתמש באותם פרטי כניסה ל-Data Manager API ול-Display & Video 360 API, צריך לכלול את ההיקף של Display & Video 360 API ברשימה
--scopes:gcloud auth application-default login \ --impersonate-service-account=SERVICE_ACCOUNT_EMAIL \ --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/display-video,https://www.googleapis.com/auth/cloud-platform"כשמוצגת בקשה להיכנס, נכנסים באמצעות חשבון Google שכולל את התפקיד "יצירת אסימונים בחשבון שירות".
כדי לוודא שפרטי הכניסה הוגדרו בצורה נכונה, משתמשים בפקודה הבאה. אם הפעולה הצליחה, הפקודה מדפיסה אסימון גישה למסוף.
gcloud auth application-default print-access-token --scopes="https://www.googleapis.com/auth/datamanager"
למידע נוסף על אימות ופרטי כניסה לאפליקציה, קראו את המאמרים שיטות אימות ב-Google והסבר על Application Default Credentials.
הגדרת הגישה לחשבון
חשבון משתמש
בוחרים את הכרטיסייה שמתאימה לתרחיש לדוגמה שלכם.
- בוחרים באפשרות מפרסם אם משתמשים בפרטי כניסה של חשבון Google שמוגדר כמשתמש בחשבונות המפרסמים שרוצים לנהל.
- בוחרים באפשרות שותף נתונים אם משתמשים בפרטי כניסה לחשבון Google שמוגדר כמשתמש בחשבון של שותף נתונים, ורוצים לנהל חשבונות של מפרסמים שיש להם קישור שותף לחשבון של שותף הנתונים. חשבונות של שותפי נתונים מונפקים רק אחרי שהם עוברים את תהליך האישור. כדי להתחיל, ממלאים את טופס ההתעניינות.
מפרסם
נותנים לכתובת האימייל שמשויכת למשתמש גישה אל Destination.
Google Ads
פועלים לפי ההוראות כדי להוסיף את כתובת האימייל של המשתמש לחשבון Google Ads או לחשבון ניהול ב-Google Ads ברמה גבוהה יותר בהיררכיה.
Display & Video 360
פועלים לפי ההוראות כדי להוסיף את כתובת האימייל של המשתמש לחשבון.
Google Analytics
פועלים לפי ההוראות כדי להוסיף את כתובת האימייל של המשתמש לחשבון.
שותף נתונים
נותנים לכתובת האימייל שמשויכת למשתמש גישה לחשבון שותף הנתונים. בדרך כלל, שותפי נתונים משתמשים בחשבון שירות כדי לגשת ל-API. עם זאת, אם אתם משתמשים בחשבון משתמש לבדיקה או למטרות אחרות, אתם צריכים לתת לחשבון המשתמש גישה לחשבון של שותף הנתונים.
מוסיפים את כתובת האימייל של המשתמש לחשבון של שותף הנתונים דרך ממשק המשתמש של Google Ads לפי ההוראות האלה.
חשבון שירות
בוחרים את הכרטיסייה שמתאימה לתרחיש לדוגמה שלכם.
- בוחרים באפשרות מפרסם אם משתמשים בפרטי כניסה של חשבון Google שמוגדר כמשתמש בחשבונות המפרסמים שרוצים לנהל.
- בוחרים באפשרות שותף נתונים אם משתמשים בפרטי כניסה לחשבון Google שמוגדר כמשתמש בחשבון של שותף נתונים, ורוצים לנהל חשבונות של מפרסמים שיש להם קישור שותף לחשבון של שותף הנתונים. חשבונות של שותפי נתונים מונפקים רק אחרי שהם עוברים את תהליך האישור. כדי להתחיל, ממלאים את טופס ההתעניינות.
מפרסם
נותנים לכתובת האימייל שמשויכת לחשבון השירות גישה אל Destination.
Google Ads
משלימים את הגדרת הגישה לחשבון כדי להוסיף את חשבון השירות לחשבון Google Ads או לחשבון ניהול ב-Google Ads ברמה שמעל לחשבון.
Display & Video 360
פועלים לפי ההוראות כדי ליצור משתמש ב-Display & Video 360 שמשויך לחשבון השירות.
Google Analytics
פועלים לפי ההוראות כדי להוסיף את כתובת האימייל של חשבון השירות לחשבון.
שותף נתונים
נותנים לכתובת האימייל שמשויכת לחשבון השירות גישה לחשבון שותף הנתונים.
הגישה לחשבון של שותף הנתונים מנוהלת דרך ממשק המשתמש של Google Ads. כדי להוסיף את חשבון השירות ולהגדיר את רמת הגישה שלו, פועלים לפי השלבים שמפורטים במאמר הגדרת הגישה לחשבון.
השלבים הבאים
- מתקינים ספריית לקוח ומריצים דוגמאות קוד כדי לנסות את הבקשה הראשונה של Data Manager API.
- איך מגדירים אימות כשפורסים בסביבת הייצור