אימות ל-Video Intelligence API

בדף הזה מוסבר מהו חשבון שירות, איך ליצור חשבון שירות כדי לאמת בקשות ל-Video Intelligence API ואיך להשתמש בחשבון השירות כדי להגדיר Application Default Credentials.

כדי לאפשר לקוד האפליקציה להשתמש ב-Video Intelligence API, צריך להגדיר את פרטי הכניסה המתאימים לאפליקציה כדי לאמת את הזהות שלה בשירות ולקבל הרשאה לביצוע משימות. (המנגנונים האלה שקשורים לאישורים נקראים סכימות אימות).

הערה: אימות והרשאה הם נושאים רחבים שלא ניתן לכסות אותם במלואם במאמר הזה. הדרך שבה מגדירים את האפליקציה או השירות תלויה במגוון גורמים, כולל מי או איזו אפליקציה רוצים לאמת, אילו משימות רוצים לאפשר לישות המאומתת לבצע (בדרך כלל נקרא אישור), ובאיזה מאגר משתמשים (אם בכלל) משתמשים – לדוגמה, Compute Engine או App Engine. מידע נוסף זמין במדריך האימות של Google Cloud Platform.

בדרך כלל, אימות והרשאה של API (שמכונים בדרך כלל 'אימות') מתבצעים באמצעות חשבון שירות.Google Cloud חשבון שירות מאפשר לקוד שלכם לשלוח ישירות את פרטי הכניסה של האפליקציה אל Video Intelligence API. חשבון שירות, כמו חשבון משתמש, מיוצג על ידי כתובת אימייל. בניגוד לחשבון משתמש, חשבון שירות משויך רק לאפליקציה.

הפעלת ה-API

לפני שתוכלו לבצע אימות, אתם צריכים קודם להפעיל את Video Intelligence API.

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

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Video Intelligence API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

Create a service account:

1. Ensure that you have the Create Service Accounts IAM role (roles/iam.serviceAccountCreator) and the Project IAM Admin role (roles/resourcemanager.projectIamAdmin). Learn how to grant roles.

2. In the Google Cloud console, go to the Create service account page.

   Go to Create service account
3. Select your project.

4. In the Service account name field, enter a name. The Google Cloud console fills in the Service account ID field based on this name.

   In the Service account description field, enter a description. For example, Service account for quickstart.

5. Click Create and continue.

6. Click Done to finish creating the service account.

   Do not close your browser window. You will use it in the next step.

Create a service account key:

1. In the Google Cloud console, click the email address for the service account that you created.
2. Click Keys.
3. Click Add key, and then click Create new key.
4. Click Create. A JSON key file is downloaded to your computer.
5. Click Close.

Set the environment variable GOOGLE_APPLICATION_CREDENTIALS to the path of the JSON file that contains your credentials. This variable applies only to your current shell session, so if you open a new session, set the variable again.

Example: Linux or macOS

export GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

Replace KEY_PATH with the path of the JSON file that contains your credentials.

For example:

export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"

Example: Windows

For PowerShell:

$env:GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

Replace KEY_PATH with the path of the JSON file that contains your credentials.

For example:

$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"

For command prompt:

set GOOGLE_APPLICATION_CREDENTIALS=KEY_PATH

Replace KEY_PATH with the path of the JSON file that contains your credentials.

התקינו את ה-CLI של Google Cloud.

אם אתם משתמשים בספק זהויות חיצוני (IdP), קודם אתם צריכים להיכנס ל-CLI של gcloud באמצעות המאגר המאוחד לניהול זהויות.

כדי לאתחל את ה-CLI של gcloud, הריצו את הפקודה הבאה:

gcloud init

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Video Intelligence API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

Create a service account:

1. Ensure that you have the Create Service Accounts IAM role (roles/iam.serviceAccountCreator) and the Project IAM Admin role (roles/resourcemanager.projectIamAdmin). Learn how to grant roles.

2. In the Google Cloud console, go to the Create service account page.

   Go to Create service account
3. Select your project.

4. In the Service account name field, enter a name. The Google Cloud console fills in the Service account ID field based on this name.

   In the Service account description field, enter a description. For example, Service account for quickstart.

5. Click Create and continue.

6. Click Done to finish creating the service account.

   Do not close your browser window. You will use it in the next step.

Create a service account key:

1. In the Google Cloud console, click the email address for the service account that you created.
2. Click Keys.
3. Click Add key, and then click Create new key.
4. Click Create. A JSON key file is downloaded to your computer.
5. Click Close.

Set the environment variable GOOGLE_APPLICATION_CREDENTIALS to the path of the JSON file that contains your credentials. This variable applies only to your current shell session, so if you open a new session, set the variable again.

Example: Linux or macOS

export GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

Replace KEY_PATH with the path of the JSON file that contains your credentials.

For example:

export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"

Example: Windows

For PowerShell:

$env:GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"

Replace KEY_PATH with the path of the JSON file that contains your credentials.

For example:

$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"

For command prompt:

set GOOGLE_APPLICATION_CREDENTIALS=KEY_PATH

Replace KEY_PATH with the path of the JSON file that contains your credentials.

התקינו את ה-CLI של Google Cloud.

אם אתם משתמשים בספק זהויות חיצוני (IdP), קודם אתם צריכים להיכנס ל-CLI של gcloud באמצעות המאגר המאוחד לניהול זהויות.

כדי לאתחל את ה-CLI של gcloud, הריצו את הפקודה הבאה:

gcloud init

יצירת חשבון שירות במסוף Google Cloud

כדי ליצור חשבון שירות באמצעות מסוף Google Cloud :

1. בדף Credentials במסוף Google Cloud , בוחרים באפשרות Create credentials > Service account key.

   

2. בקטע Service account בוחרים באפשרות New service account.

   

3. בתיבה Service account name, מזינים שם לחשבון השירות. השם הזה משמש כשם ברירת המחדל של מזהה חשבון השירות (החלק שמשמאל לסימן @ בכתובת של מזהה חשבון השירות שנוצר), אבל אפשר לשנות את השם הזה של מזהה חשבון השירות. השמות האלה שרירותיים, וחשוב רק שתזכרו אותם.

4. בקטע Key type (סוג מפתח), בוחרים באפשרות JSON לרוב הפרויקטים החדשים.

5. לוחצים על יצירה.

לאחר מכן, במסוף Google Cloud נוצר מפתח JSON (כקובץ טקסט .json), מוצגת בקשה להורדת הקובץ למחשב ומוצג תיבת הדו-שיח נוצר חשבון שירות.

מפתח ה-JSON שנוצר יהיה דומה לדוגמה הבאה של מפתח JSON:

{
  "type": "service_account",
  "project_id": "PROJECT_ID",
  "private_key_id": "SOME_NUMBER",
  "private_key": "-----BEGIN PRIVATE KEY-----\nPRIVATE_KEY\n-----END PRIVATE KEY-----\n",
  "client_email": "SERVICE_ACCOUNT_EMAIL",
  "client_id": "...",
  "auth_uri": "https://accounts.google.com/o/oauth2/auth",
  "token_uri": "https://accounts.google.com/o/oauth2/token",
  "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
  "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/SERVICE_ACCOUNT_EMAIL"
}

חשוב לאחסן את קובץ ה-JSON הזה בצורה מאובטחת, כי הוא מכיל את המפתח הפרטי שלכם (והקובץ הזה הוא העותק היחיד של המפתח). כששולחים בקשות להערות ל-Video Intelligence API, צריך להפנות לקובץ המפתח של חשבון השירות הזה בקוד.

אימות באמצעות Application Default Credentials

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

$ export GOOGLE_APPLICATION_CREDENTIALS=PATH_TO_SERVICE_ACCOUNT_FILE