דף זה תורגם על ידי Cloud Translation API.

אימות כאפליקציית Google Chat

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

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

שיטות של Google Chat API שתומכות בהרשאת גישה לאפליקציות עם היקפי הרשאה ששמותיהם מתחילים ב-https://www.googleapis.com/auth/chat.app.* דורשות אישור אדמין חד-פעמי. שיטות של Google Chat API שתומכות בהרשאת אפליקציות עם היקף ההרשאה https://www.googleapis.com/auth/chat.bot לא דורשות אישור נוסף. היקפי ההרשאות של https://www.googleapis.com/auth/chat.app.* זמינים בגרסת תצוגה מקדימה למפתחים.

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

מידע נוסף על המקרים שבהם נדרש אימות באפליקציות ל-Chat ועל סוג האימות שצריך להשתמש בו זמין במאמר סוגי האימות הנדרשים בסקירה הכללית על אימות והרשאות ב-Chat API.

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

Java

‫JDK גרסה 1.7 ואילך
כלי ניהול החבילות Maven

פרויקט Maven מאותחל. כדי לאתחל פרויקט חדש, מריצים את הפקודה הבאה בממשק שורת הפקודה:

mvn archetype:generate -DgroupId=com.google.chat.app.authsample -DartifactId=auth-sample-app -DarchetypeArtifactId=maven-archetype-quickstart -DarchetypeVersion=1.4 -DinteractiveMode=false

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

Python

‫Python 3.6 ואילך
כלי ניהול החבילות pip
אפליקציית Google Chat שמקבלת אירועי אינטראקציה ומגיבה להם. כדי ליצור אפליקציה אינטראקטיבית ל-Chat באמצעות שירות HTTP, צריך לפעול לפי המדריך למתחילים.
מוסיפים את אפליקציית Chat למרחב. כדי להוסיף את אפליקציית Chat, אפשר לעיין במאמר בדיקת תכונות אינטראקטיביות לאפליקציות ל-Google Chat.

Node.js

‫Node.js מגרסה 14 ואילך
הכלי לניהול חבילות npm
פרויקט Node.js מאותחל. כדי לאתחל פרויקט חדש, יוצרים תיקייה חדשה ועוברים אליה, ואז מריצים את הפקודה הבאה בממשק שורת הפקודה:
```
npm init
```
אפליקציית Google Chat שמקבלת אירועי אינטראקציה ומגיבה להם. כדי ליצור אפליקציה אינטראקטיבית ל-Chat באמצעות שירות HTTP, צריך לפעול לפי המדריך למתחילים.
מוסיפים את אפליקציית Chat למרחב. כדי להוסיף את אפליקציית Chat, אפשר לעיין במאמר בדיקת תכונות אינטראקטיביות לאפליקציות ל-Google Chat.

Apps Script

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

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

יוצרים חשבון שירות שאפליקציית Chat יכולה להשתמש בו כדי לגשת ל-Google APIs.

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

כדי ליצור חשבון שירות:

מסוף Google Cloud

במסוף Google Cloud, לוחצים על סמל התפריט > IAM & Admin > Service Accounts (חשבונות שירות).
לדף Service accounts
לוחצים על יצירת חשבון שירות.
ממלאים את פרטי חשבון השירות ולוחצים על יצירה והמשך.
הערה: כברירת מחדל, Google יוצרת מזהה ייחודי לחשבון שירות. אם רוצים לשנות את המזהה, משנים אותו בשדה של מזהה חשבון השירות.
אופציונלי: מקצים תפקידים לחשבון השירות כדי לתת גישה למשאבים בפרויקט Google Cloud. פרטים נוספים זמינים במאמר הענקה, שינוי וביטול גישה למשאבים.
לוחצים על המשך.
אופציונלי: מזינים משתמשים או קבוצות שיכולים לנהל את חשבון השירות הזה ולבצע בו פעולות. פרטים נוספים זמינים במאמר ניהול התחזות לחשבון שירות.
לוחצים על סיום. רושמים את כתובת האימייל של חשבון השירות.

CLI של gcloud

יוצרים את חשבון השירות:

gcloud iam service-accounts create SERVICE_ACCOUNT_NAME \
  --display-name="SERVICE_ACCOUNT_NAME"

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

חשבון השירות מופיע בדף של חשבונות השירות. בשלב הבא, יוצרים מפתח פרטי לחשבון השירות.

יצירת מפתח פרטי

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

במסוף Google Cloud, לוחצים על סמל התפריט > IAM & Admin > Service Accounts (חשבונות שירות).
לדף Service accounts
בוחרים את חשבון השירות.
לוחצים על מפתחות > הוספת מפתח > יצירת מפתח חדש.
בוחרים באפשרות JSON ולוחצים על Create.
זוג המפתחות הציבורי/הפרטי החדש נוצר ומורד למחשב שלכם כקובץ חדש. שומרים את קובץ ה-JSON שהורדתם בשם credentials.json בספריית העבודה. הקובץ הזה הוא העותק היחיד של המפתח. מידע על אחסון מאובטח של המפתח זמין במאמר ניהול מפתחות לחשבונות שירות.
לוחצים על סגירה.

מידע נוסף על חשבונות שירות זמין במאמר בנושא חשבונות שירות במרכז העזרה של IAM ב-Google Cloud.

בשלב הבא, יוצרים לקוח OAuth שמתאים ל-Google Workspace Marketplace בשביל חשבון השירות הזה.

קבלת אישור אדמין

כדי להשתמש בהיקף ההרשאה https://www.googleapis.com/auth/chat.bot, לא נדרש אישור אדמין. עוברים אל שלב 2: התקנת ספריית הלקוח של Google ותלות אחרות. בדוגמה במדריך הזה נעשה שימוש בהיקף ההרשאות https://www.googleapis.com/auth/chat.bot, אז אם אתם פועלים לפי הדוגמה, אתם יכולים לעבור לשלב 2.

כדי להשתמש בהיקף הרשאות שמתחיל ב-https://www.googleapis.com/auth/chat.app.*, שזמין כחלק מגרסת Developer Preview, אפליקציית Chat צריכה לקבל אישור אדמין חד-פעמי.

כדי לקבל אישור מהאדמין, צריך להכין את חשבון השירות של אפליקציית Chat עם הפרטים הבאים:

לקוח OAuth שתואם ל-Google Workspace Marketplace.
הגדרת האפליקציה ב-Google Workspace Marketplace SDK.

יצירת לקוח OAuth שתואם ל-Google Workspace Marketplace

כדי ליצור לקוח OAuth שתואם ל-Google Workspace Marketplace:

במסוף Google Cloud, לוחצים על סמל התפריט > IAM & Admin > Service Accounts.

לדף Service accounts
לוחצים על חשבון השירות שיצרתם לאפליקציית Chat.
לוחצים על הגדרות מתקדמות.
לוחצים על Create Google Workspace Marketplace-compatible OAuth client (יצירת לקוח OAuth שתואם ל-Google Workspace Marketplace).
לוחצים על המשך.

תוצג הודעת אישור שלפיה נוצר לקוח OAuth שתואם ל-Google Workspace Marketplace.

הגדרת אפליקציית Chat ב-Google Workspace Marketplace SDK

כדי להגדיר את אפליקציית Chat ב-SDK של Google Workspace Marketplace, פועלים לפי השלבים הבאים:

במסוף Google Cloud, מפעילים את Google Workspace Marketplace SDK.

הפעלת Google Workspace Marketplace SDK
במסוף Google Cloud, עוברים אל תפריט > APIs & Services > Enabled APIs & services > Google Workspace Marketplace SDK > App Configuration.

מעבר להגדרת האפליקציה
משלימים את הדף 'הגדרת האפליקציה'. האופן שבו מגדירים את אפליקציית Chat תלוי בקהל היעד ובגורמים אחרים. לקבלת עזרה בהשלמת דף הגדרת האפליקציה, אפשר לעיין במאמר בנושא הגדרת האפליקציה ב-Google Workspace Marketplace SDK. לצורך המדריך הזה, מזינים את הפרטים הבאים:
1. בקטע הרשאות גישה לאפליקציה, בוחרים באפשרות פרטי.
2. בקטע הגדרות התקנה, בוחרים באפשרות התקנה אישית + התקנת אדמין.
3. בקטע App integrations (שילוב אפליקציות), בוחרים באפשרות Chat app (אפליקציית Chat).
4. בקטע OAuth scopes (היקפי OAuth), מזינים את כל היקפי האימות שבהם משתמשת אפליקציית Chat.
  
  אזהרה: אל תזינו את היקף ההרשאות https://www.googleapis.com/auth/chat.bot, שלא דורש הגדרה בדף הזה. בדוגמה שבמדריך הזה נעשה שימוש בהיקף ההרשאות https://www.googleapis.com/auth/chat.bot, לכן כדי להפעיל את הדוגמה לא צריך להזין כאן שום דבר.
5. בקטע פרטים למפתחים, מזינים את שם המפתח, כתובת ה-URL של אתר המפתחים וכתובת האימייל של המפתח.
6. לוחצים על שמירת הטיוטה.

קבלת אישור אדמין

אחרי שמגדירים את חשבון השירות לקבלת אישור מהאדמין, צריך לקבל אישור מאדמין ב-Google Workspace. כדי לעשות זאת, פועלים לפי השלבים במאמר הגדרת הרשאה לאפליקציות ל-Chat.

שלב 2: התקנה של ספריית הלקוח של Google ופריטים אחרים בקשרי תלות

מתקינים את ספריית הלקוח של Google ואת שאר התלויות הנדרשות לפרויקט.

Java

כדי להוסיף את ספריות הלקוח של Google ותלות נדרשת אחרת לפרויקט Maven, עורכים את הקובץ pom.xml בספריית הפרויקט ומוסיפים את התלויות הבאות:

<dependencies>
  <!-- ... existing dependencies ... -->
  <dependency>
    <groupId>com.google.apis</groupId>
    <artifactId>google-api-services-chat</artifactId>
    <version>v1-rev20230905-2.0.0</version>
  </dependency>
  <dependency>
    <groupId>com.google.auth</groupId>
    <artifactId>google-auth-library-oauth2-http</artifactId>
    <version>1.19.0</version>
  </dependency>
  <dependency>
      <groupId>com.google.code.gson</groupId>
      <artifactId>gson</artifactId>
      <version>2.10.1</version>
  </dependency>
</dependencies>

Python

אם עדיין לא התקנתם את ספריות הלקוח של Google ל-Python, מריצים את הפקודה הבאה בממשק שורת הפקודה:

pip3 install --upgrade google-api-python-client google-auth

Node.js

כדי להוסיף את ספריות הלקוח של Google לפרויקט Node.js, עוברים לספרייה של הפרויקט ומריצים את הפקודה הבאה בממשק שורת הפקודה:

npm install "@googleapis/chat"

Apps Script

בדוגמה הזו נעשה שימוש בספריית OAuth2 for Apps Script כדי ליצור אסימון JWT לאימות של חשבון שירות. כדי להוסיף את הספרייה לפרויקט Apps Script:

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

בדוגמה הזו נעשה שימוש בשירות המתקדם של Chat כדי לבצע קריאה ל-Google Chat API. כדי להפעיל את השירות בפרויקט Apps Script:

בצד ימין, לוחצים על עורך .
בצד ימין, ליד שירותים, לוחצים על הוספת שירות .
בוחרים באפשרות Google Chat API.
בקטע Version (גרסה), בוחרים באפשרות v1.
לוחצים על הוספה.

אפשר להשתמש בכל שפה שנתמכת על ידי ספריות הלקוח שלנו.

שלב 3: כותבים סקריפט שמשתמש בחשבון השירות כדי לבצע אימות באמצעות Chat API

הקוד הבא מבצע אימות באמצעות Chat API באמצעות חשבון שירות, ואז מפרסם הודעה במרחב ב-Chat:

Java

בספרייה של הפרויקט, פותחים את הקובץ src/main/java/com/google/chat/app/authsample/App.java.

מחליפים את התוכן ב-App.java בקוד הבא:

package com.google.chat.app.authsample;

import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.HttpRequestInitializer;
import com.google.api.client.json.gson.GsonFactory;
import com.google.api.services.chat.v1.HangoutsChat;
import com.google.api.services.chat.v1.model.Message;
import com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;

/**
 * Authenticates with Chat API using service account credentials,
 * then creates a Chat message.
 */
public class App {
    // Specify required scopes.
    private static final String CHAT_SCOPE = "https://www.googleapis.com/auth/chat.bot";

    // Specify service account details.
    private static final String PRIVATE_KEY_RESOURCE_URI = "/credentials.json";

    public static void main( String[] args ) {
        try {
            // Run app.
            Message response = App.createChatMessage();
            // Print details about the created message.
            System.out.println(response);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    private static Message createChatMessage() throws Exception {
        // Build the Chat API client and authenticate with the service account.
        GoogleCredentials credentials = GoogleCredentials.fromStream(
            App.class.getResourceAsStream(PRIVATE_KEY_RESOURCE_URI))
            .createScoped(CHAT_SCOPE);
        HttpRequestInitializer requestInitializer = new HttpCredentialsAdapter(credentials);
        HangoutsChat chatService = new HangoutsChat.Builder(
            GoogleNetHttpTransport.newTrustedTransport(),
            GsonFactory.getDefaultInstance(),
            requestInitializer)
            .setApplicationName("auth-sample-app")
            .build();

        // The space to create the message in.
        //
        // Replace SPACE_NAME with a space name.
        // Obtain the space name from the spaces resource of Chat API,
        // or from a space's URL.
        String spaceName = "spaces/SPACE_NAME";

        // Create a Chat message.
        Message message = new Message().setText("Hello, world!");
        return chatService.spaces().messages().create(spaceName, message).execute();
    }
}

בקוד, מחליפים את SPACE_NAME בשם של המרחב, שאפשר לקבל באמצעות השיטה spaces.list ב-Chat API או מכתובת ה-URL של המרחב.
יוצרים ספריית משנה חדשה בשם resources בספרייה של הפרויקט.
מוודאים שקובץ המפתח הפרטי של חשבון השירות נקרא credentials.json ומעתיקים אותו לספריית המשנה resources.
כדי להגדיר את Maven כך שיכלול את קובץ המפתח הפרטי בחבילת הפרויקט, עורכים את הקובץ pom.xml בתיקיית הפרויקט ומוסיפים את ההגדרה הבאה לקטע <build>:
```
<build>
  
  <resources>
    <resource>
      <directory>resources</directory>
    </resource>
  </resources>
</build>
```

כדי להגדיר את Maven כך שיכלול את התלויות בחבילת הפרויקט ויפעיל את המחלקה הראשית של האפליקציה, עורכים את הקובץ pom.xml בספריית הפרויקט ומוסיפים את ההגדרה הבאה לקטע <plugins>:

<plugins>
  <!-- ... existing configurations ... -->
  <plugin>
    <artifactId>maven-assembly-plugin</artifactId>
    <configuration>
      <archive>
        <manifest>
          <mainClass>com.google.chat.app.authsample.App</mainClass>
        </manifest>
      </archive>
      <descriptorRefs>
        <descriptorRef>jar-with-dependencies</descriptorRef>
      </descriptorRefs>
    </configuration>
  </plugin>
</plugins>

Python

בספריית העבודה, יוצרים קובץ בשם chat_app_auth.py.

מוסיפים את הקוד הבא אל chat_app_auth.py:

from apiclient.discovery import build
from google.oauth2 import service_account

# Specify required scopes.
SCOPES = ['https://www.googleapis.com/auth/chat.bot']

# Specify service account details.
creds = service_account.Credentials.from_service_account_file(
    'credentials.json', scopes=SCOPES)

# Build the URI and authenticate with the service account.
chat = build('chat', 'v1', credentials=creds)

# Create a Chat message.
result = chat.spaces().messages().create(

    # The space to create the message in.
    #
    # Replace SPACE_NAME with a space name.
    # Obtain the space name from the spaces resource of Chat API,
    # or from a space's URL.
    parent='spaces/SPACE_NAME',

    # The message to create.
    body={'text': 'Hello, world!'}

).execute()

# Prints details about the created message.
print(result)

בקוד, מחליפים את SPACE_NAME בשם של המרחב, שאפשר לקבל באמצעות השיטה spaces.list ב-Chat API או מכתובת ה-URL של המרחב. מוודאים שקובץ המפתח הפרטי של חשבון השירות נקרא credentials.json.

Node.js

בספרייה של הפרויקט, יוצרים קובץ בשם chat_app_auth.js.

מוסיפים את הקוד הבא אל chat_app_auth.js:

const chat = require('@googleapis/chat');

async function createMessage() {
  const auth = new chat.auth.GoogleAuth({

    // Specify service account details.
    keyFilename: 'credentials.json',

    // Specify required scopes.
    scopes: ['https://www.googleapis.com/auth/chat.bot']

  });
  const authClient = await auth.getClient();

  // Create the Chat API client and authenticate with the service account.
  const chatClient = await chat.chat({
    version: 'v1',
    auth: authClient
  });

  // Create a Chat message.
  const result = await chatClient.spaces.messages.create({

    // The space to create the message in.
    //
    // Replace SPACE_NAME with a space name.
    // Obtain the space name from the spaces resource of Chat API,
    // or from a space's URL.
    parent: 'spaces/SPACE_NAME',

    // The message to create.
    requestBody: { 'text': 'Hello, world!' }

  });
  return result;
}

// Execute function then print details about the created message.
createMessage().then(console.log);

בקוד, מחליפים את SPACE_NAME בשם של המרחב, שאפשר לקבל באמצעות השיטה spaces.list ב-Chat API או מכתובת ה-URL של המרחב. מוודאים שקובץ המפתח הפרטי של חשבון השירות נקרא credentials.json.

Apps Script

בכלי לעריכת Apps Script, עורכים את הקובץ appsscript.json ומוסיפים את היקף ההרשאות של OAuth שנדרש כדי לשלוח בקשות חיצוניות לקבלת אסימון OAuth של חשבון השירות:
```
  "oauthScopes": [
    "https://www.googleapis.com/auth/script.external_request"
  ]
```

שומרים את הקוד הבא בקובץ בשם ChatAppAuth.gs בפרויקט Apps Script:

// Specify the contents of the file credentials.json.
const CREDENTIALS = CREDENTIALS;

const SCOPE = 'https://www.googleapis.com/auth/chat.bot';

// The space to create the message in.
//
// Replace SPACE_NAME with a space name.
// Obtain the space name from the spaces resource of Chat API,
// or from a space's URL.
const PARENT = 'spaces/SPACE_NAME'

/**
 * Authenticates with Chat API using app credentials, then posts a message.
 */
function createMessageWithAppCredentials() {
  try {
    const service = getService_();
    if (!service.hasAccess()) {
      console.error(service.getLastError());
      return;
    }

    // Specify the message to create.
    const message = {'text': 'Hello world!'};

    // Call Chat API with a service account to create a message.
    const result = Chat.Spaces.Messages.create(
        message,
        PARENT,
        {},
        // Authenticate with the service account token.
        {'Authorization': 'Bearer ' + service.getAccessToken()});

    // Log details about the created message.
    console.log(result);

  } catch (err) {
    // TODO (developer) - Handle exception.
    console.log('Failed to create message with error %s', err.message);
  }
}

/**
 * Configures the OAuth library to authenticate with the service account.
 */
function getService_() {
  return OAuth2.createService(CREDENTIALS.client_email)
      .setTokenUrl('https://oauth2.googleapis.com/token')
      .setPrivateKey(CREDENTIALS.private_key)
      .setIssuer(CREDENTIALS.client_email)
      .setSubject(CREDENTIALS.client_email)
      .setScope(SCOPE)
      .setPropertyStore(PropertiesService.getScriptProperties());
}

בקוד, מחליפים את CREDENTIALS בתוכן של הקובץ credentials.json.
בקוד, מחליפים את SPACE_NAME בשם של המרחב, שאפשר לקבל באמצעות השיטה spaces.list ב-Chat API או מכתובת ה-URL של המרחב.

שלב 4: מריצים את הדוגמה המלאה

בספריית העבודה, מבצעים build ומריצים את הדוגמה:

Java

mvn compile assembly:single
java -jar target/auth-sample-app-1.0-SNAPSHOT-jar-with-dependencies.jar

Python

python3 chat_app_auth.py

Node.js

node chat_app_auth.js

Apps Script

פותחים את הקובץ ChatAppAuth.gs בכלי לעריכת Apps Script ולוחצים על הפעלה.

הסקריפט שולח בקשה מאומתת אל Chat API, והתשובה שמתקבלת היא פרסום הודעה במרחב ב-Chat כאפליקציית Chat.

פתרון בעיות בדוגמה

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

אין לך הרשאה להשתמש באפליקציה הזו

כשמריצים את הסקריפט, יכול להיות שתופיע הודעת שגיאה שאומרת:

<HttpError 403 when requesting https://chat.googleapis.com/v1/spaces/{space}/messages?alt=json returned "You are not permitted to use this app". Details: "You are not permitted to use this app">

הודעת השגיאה הזו מציינת שלאפליקציית Chat אין הרשאה ליצור הודעות ב-Chat במרחב שצוין ב-Chat.

כדי לפתור את השגיאה, צריך להוסיף את אפליקציית Chat למרחב ב-Chat שצוין בסקריפט.

האדמין צריך להעניק לאפליקציה את היקף ההרשאות הנדרש של OAuth כדי לבצע את הפעולה הזו

כשמריצים את הסקריפט, יכול להיות שתופיע הודעת שגיאה שאומרת:

<HttpError 403 when requesting https://chat.googleapis.com/v1/spaces/{space}?alt=json returned "The administrator must grant the app the required OAuth authorization scope for this action.". Details: "The administrator must grant the app the required OAuth authorization scope for this action.">

הודעת השגיאה הזו מציינת שאדמין ב-Google Workspace עדיין לא העניק אישור חד-פעמי לאפליקציית Chat להשתמש בהיקפי הרשאות שמתחילים בשם https://www.googleapis.com/auth/chat.app.*.

כדי לפתור את השגיאה:

צריך לבקש מהאדמין ב-Google Workspace לאשר את אפליקציית Chat. כשמטפלים בשגיאה הזו בלוגיקה של אפליקציית Chat, כדאי לשלוח הודעה שמודיעה שאפליקציית Chat צריכה אישור אדמין כדי לבצע את הפעולה המבוקשת, למשל: To perform this action, I need approval. <https://support.google.com/a?p=chat-app-auth|Learn more>.
אם שיטת Google Chat API תומכת בhttps://www.googleapis.com/auth/chat.bot היקף ההרשאה, שלא דורש אישור אדמין, כדאי להשתמש בה במקום זאת. כדי לבדוק אילו היקפי הרשאה נתמכים על ידי method, אפשר לעיין במסמכי העזר של Google Chat API.

במאמרי העזרה של Chat API מפורטות עוד פעולות שאפשר לבצע באמצעות Chat API.
אם אתם משתמשים בהיקפי הרשאות של OAuth שמתחילים ב-https://www.googleapis.com/auth/chat.app.*, כדאי לקרוא איך אדמינים מעניקים אישור חד-פעמי.

אימות כאפליקציית Google Chat קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.

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

Java

Python

Node.js

Apps Script

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

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

מסוף Google Cloud

CLI של gcloud

יצירת מפתח פרטי

קבלת אישור אדמין

יצירת לקוח OAuth שתואם ל-Google Workspace Marketplace

הגדרת אפליקציית Chat ב-Google Workspace Marketplace SDK

קבלת אישור אדמין

שלב 2: התקנה של ספריית הלקוח של Google ופריטים אחרים בקשרי תלות

Java

Python

Node.js

Apps Script

שלב 3: כותבים סקריפט שמשתמש בחשבון השירות כדי לבצע אימות באמצעות Chat API

Java

Python

Node.js

Apps Script

שלב 4: מריצים את הדוגמה המלאה

Java

Python

Node.js

Apps Script

פתרון בעיות בדוגמה

אין לך הרשאה להשתמש באפליקציה הזו

האדמין צריך להעניק לאפליקציה את היקף ההרשאות הנדרש של OAuth כדי לבצע את הפעולה הזו

נושאים קשורים

אימות כאפליקציית Google Chat