הגדרת גישה ל-API

כך מגדירים גישה ל-Data Manager API באמצעות SDK או REST.

דרישות מוקדמות

לפני שמשתמשים ב-Data API, צריך לוודא שיש לכם את הדברים הבאים:

  1. פרויקט ב-Google Cloud. אפשר להשתמש בפרויקט קיים או ליצור פרויקט חדש במיוחד עבור Data Manager API.

  2. חשבון Google עם ההרשאה serviceusage.services.enable בפרויקט בענן ב-Google Cloud, או עם תפקיד שכולל את ההרשאה הזו. לדוגמה, ההרשאה serviceusage.services.enable כלולה גם ב-roles/owner וגם ב-roles/serviceusage.serviceUsageAdmin. כדי לבדוק את ההרשאות, אפשר לעיין במאמר בנושא הצגת הרשאות הגישה הנוכחיות.

  3. ‫Google Cloud CLI מותקן.

הפעלת ה-API

אם עדיין לא עשיתם את זה, מפעילים את Data Manager API. לשם כך לוחצים על Enable the Data Manager API או פועלים לפי ההוראות לביצוע השלב הזה באופן ידני.

הפעלת Data Manager API

אם אתם לא מוצאים את Data Manager API או שההפעלה של Data Manager API נכשלת, צריך לוודא שחשבון Google שלכם עומד בדרישות המוקדמות.

מגדירים אימות

אתם יכולים להשתמש בכל אחת משיטות האימות ב-Google, חוץ ממפתחות API. מומלץ לעיין במאמר בנושא בחירת שיטת האימות שמתאימה לתרחיש שלכם לדוגמה כדי להחליט איזו גישה מתאימה לתרחיש שלכם.

שתי שיטות נפוצות לאימות הן חשבונות משתמשים וחשבונות שירות:

  • חשבונות משתמשים: מייצגים אנשים שמנהלים אינטראקציה ישירה עם Google APIs והשירותים של Google.
  • חשבונות שירות: מייצגים אפליקציות, לא אנשים, בתור משתמשים. הן מאפשרות לאפליקציות שלכם לנהל אימות והרשאה. לדוגמה, אם אפליקציה צריכה לגשת למשאבים של Google Cloud.

האינטגרציה יכולה להשתמש ב-Application Default Credentials‏ (ADC) כדי למצוא באופן אוטומטי פרטי כניסה מהסביבה, כך שלא תצטרכו לשנות את קוד הלקוח כדי לבצע אימות.

כדי להגדיר ADC, בוחרים באפשרות חשבון משתמש או חשבון שירות:

חשבון משתמש

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

  1. מגדירים את ההגדרות של Google Auth Platform בפרויקט.

    1. פותחים את הדף Branding במסוף Google Cloud.

    2. בוחרים את הפרויקט הרצוי.

    3. ממלאים את הטופס ולוחצים על יצירה.

  2. ההיקף של Data Manager API הוא היקף רגיש, ולכן צריך לבצע את השלבים הבאים:

    1. עוברים להגדרות הגישה לנתונים של הפרויקט.

    2. לוחצים על הוספה או הסרה של היקפים.

    3. מסמנים את התיבה לצד Data Manager API (ה-API של המרכז לניהול נתונים) ברשימת ההיקפים ולוחצים על Update (עדכון).

    4. לוחצים על שמירה.

    5. עוברים אל קהל במסוף Google Cloud ומעדכנים את סטטוס הפרסום ואת סוג המשתמש. מידע נוסף על ההגדרות האלה זמין במאמר ניהול קהל האפליקציה.

  3. לוחצים על Create OAuth2 client (יצירת לקוח OAuth2) כדי ליצור לקוח OAuth2 בפרויקט, או פועלים לפי ההוראות ליצירת לקוח OAuth2 למחשב. אפשר לדלג על השלב הזה אם כבר יש לכם לקוח Desktop OAuth2 שבו אתם רוצים להשתמש עבור Data Manager API.

    אם לוחצים על Create OAuth2 client (יצירת לקוח OAuth2), בוחרים באפשרות Desktop app (אפליקציית מחשב) כשמוצגת ההנחיה Configure your OAuth client (הגדרת לקוח OAuth), כדי שאפשר יהיה להשתמש בלקוח בשלבים הבאים.

    יצירת לקוח OAuth2

    בשלב האחרון, לוחצים על הורדת הגדרות הלקוח ורושמים את מיקום ההורדה שבחרתם.

  4. מריצים את הפקודה הבאה כדי ליצור קובץ 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"

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

    gcloud auth application-default print-access-token

חשבון שירות

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

  1. לוחצים על הלחצן Create service account או פועלים לפי ההוראות כדי לבחור או ליצור חשבון שירות.

    יצירת חשבון שירות

  2. נותנים לחשבון השירות את תפקיד צרכן השימוש בשירות ב-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"

  3. נותנים לחשבון Google את תפקיד ה-IAM ‏Service Account Token Creator (roles/iam.serviceAccountTokenCreator) בחשבון השירות.

    gcloud iam service-accounts add-iam-policy-binding SERVICE_ACCOUNT_EMAIL \
  --member="user:USER_EMAIL" \
  --role="roles/iam.serviceAccountTokenCreator"

  4. מגדירים את ה-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 שהוקצה לו התפקיד 'יצירת אסימונים בחשבון שירות'.

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

    gcloud auth application-default print-access-token --scopes="https://www.googleapis.com/auth/datamanager"

למידע נוסף על אימות ופרטי כניסה לאפליקציה, אפשר לעיין במאמרים שיטות אימות ב-Google והסבר על Application Default Credentials.

הגדרת גישה לחשבון

חשבון משתמש

נותנים לכתובת האימייל שמשויכת למשתמש גישה אל Destination.

  • אם אתם משתמשים בחשבון Google Ads, צריך לפעול לפי ההוראות כדי להוסיף את כתובת האימייל של המשתמש לחשבון Google Ads או לחשבון ניהול ב-Google Ads.
  • אם אתם משתמשים בחשבון Display & Video 360, צריך לפעול לפי ההוראות כדי להוסיף את כתובת האימייל של המשתמש לחשבון.
  • אם אתם משתמשים בנכס ב-Google Analytics, פועלים לפי ההוראות כדי להוסיף את כתובת האימייל של המשתמש לחשבון.
  • אם אתם ניגשים אל Destination באמצעות חשבון של שותף נתונים עם קישור לשותף מחשבון המפרסם, פועלים לפי ההוראות כדי להוסיף את כתובת האימייל של המשתמש לחשבון של שותף הנתונים.

חשבון שירות

מעניקים לכתובת האימייל שמשויכת לחשבון השירות גישה אל Destination.

  • אם משתמשים בחשבון Google Ads, צריך להשלים את הגדרת הגישה לחשבון כדי להוסיף את חשבון השירות לחשבון Google Ads או לחשבון ניהול ראשי ב-Google Ads.
  • אם משתמשים בחשבון Display & Video 360, צריך לפעול לפי ההוראות כדי ליצור משתמש Display & Video 360 שמשויך לחשבון השירות.
  • אם אתם משתמשים בנכס ב-Google Analytics, פועלים לפי ההוראות כדי להוסיף את כתובת האימייל של המשתמש לחשבון.
  • אם אתם ניגשים אל Destination באמצעות חשבון של שותף נתונים עם קישור לשותף מחשבון המפרסם, צריך להשלים את הגדרת הגישה לחשבון בחשבון של שותף הנתונים כדי להוסיף את חשבון השירות ולהגדיר את רמת הגישה שלו.

השלבים הבאים

מתקינים ספריית לקוח ומריצים דוגמאות קוד כדי לנסות את בקשת ה-API הראשונה שלכם ל-Data Manager.

הבא
התקן ספריית לקוח