איך מעדכנים הודעות?

במדריך הזה מוסבר איך להשתמש ב-method‏ update() במשאב Message של Google Chat API כדי לעדכן הודעת טקסט או כרטיס במרחב משותף. מעדכנים הודעה כדי לשנות את המאפיינים שלה, למשל מה שכתוב בו, או התוכן של כרטיס. אפשר גם לצרף הודעת טקסט בהתחלה הודעה בכרטיס או לצרף כרטיס להודעת טקסט.

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

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

Node.js

Python

Java

Apps Script

עדכון הודעה בשם משתמש

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

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

  • מציינים את היקף ההרשאה chat.messages.
  • קוראים לפונקציה UpdateMessage() .
  • מעבירים את message כמופע של Message עם:
    • השדה name מוגדר להודעה שרוצים לעדכן, והוא כולל מזהה מרחב משותף ומזהה הודעה.
    • השדה text מוגדר עם הטקסט החדש.
  • מעבירים את updateMask עם הערך text.

אם ההודעה המעודכנת הודעה בכרטיס, והטקסט מופיע בתחילת הכרטיסים (שממשיכים להופיע).

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

Node.js

chat/client-libraries/cloud/update-message-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.messages'];

// This sample shows how to update a message with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    message: {
      // Replace SPACE_NAME and MESSAGE_NAME here
      name: 'spaces/SPACE_NAME/messages/MESSAGE_NAME',
      text: 'Updated with user credential!'
    },
    // The field paths to update. Separate multiple values with commas or use
    // `*` to update all field paths.
    updateMask: {
      // The field paths to update.
      paths: ['text']
    }
  };

  // Make the request
  const response = await chatClient.updateMessage(request);

  // Handle the response
  console.log(response);
}

main().catch(console.error);

Python

chat/client-libraries/cloud/update_message_user_cred.py
from authentication_utils import create_client_with_user_credentials
from google.apps import chat_v1 as google_chat

SCOPES = ["https://www.googleapis.com/auth/chat.messages"]

# This sample shows how to update a message with user credential
def update_message_with_user_cred():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.UpdateMessageRequest(
        message = {
            # Replace SPACE_NAME and MESSAGE_NAME here
            "name": "spaces/SPACE_NAME/messages/MESSAGE_NAME",
            "text": "Updated with user credential!"
        },
        # The field paths to update. Separate multiple values with commas or use
        # `*` to update all field paths.
        update_mask = "text"
    )

    # Make the request
    response = client.update_message(request)

    # Handle the response
    print(response)

update_message_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/UpdateMessageUserCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.UpdateMessageRequest;
import com.google.chat.v1.Message;
import com.google.protobuf.FieldMask;

// This sample shows how to update message with user credential.
public class UpdateMessageUserCred {

  private static final String SCOPE =
    "https://www.googleapis.com/auth/chat.messages";

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      UpdateMessageRequest.Builder request = UpdateMessageRequest.newBuilder()
        .setMessage(Message.newBuilder()
          // replace SPACE_NAME and MESSAGE_NAME here
          .setName("spaces/SPACE_NAME/messages/MESSAGE_NAME")
          .setText("Updated with user credential!"))
        .setUpdateMask(FieldMask.newBuilder()
          // The field paths to update.
          .addPaths("text"));
      Message response = chatServiceClient.updateMessage(request.build());

      System.out.println(JsonFormat.printer().print(response));
    }
  }
}

Apps Script

chat/advanced-service/Main.gs
/**
 * This sample shows how to update a message with user credential
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.messages'
 * referenced in the manifest file (appsscript.json).
 */
function updateMessageUserCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME and MESSAGE_NAME here
  const name = 'spaces/SPACE_NAME/messages/MESSAGE_NAME';
  const message = {
    text: 'Updated with user credential!'
  };
  // The field paths to update. Separate multiple values with commas or use
  // `*` to update all field paths.
  const updateMask = 'text';

  // Make the request
  const response = Chat.Spaces.Messages.patch(message, name, {
    updateMask: updateMask
  });

  // Handle the response
  console.log(response);
}

כדי להריץ את הדוגמה הזו, מחליפים את הפרטים הבאים:

  • SPACE_NAME: המזהה מ-name של המרחב המשותף. אפשר לקבל את המזהה על ידי קריאה ל-method‏ ListSpaces() או מכתובת ה-URL של המרחב המשותף.
  • MESSAGE_NAME: המזהה מ-name של ההודעה. אפשר לקבל את המזהה מגוף התשובה שמוחזר אחרי יצירת אסינכרונית עם ה-API של Chat, או שם מותאם אישית שהוקצה להודעה בזמן היצירה.

Chat API מחזיר מופע של Message שבה מופיעה ההודעה שמתעדכנת.

עדכון הודעה באפליקציית Chat

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

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

  • מציינים את היקף ההרשאה chat.bot.
  • קוראים ל-method‏ UpdateMessage().
  • מעבירים את message כמכונה של Message באמצעות הקוד הבא:
    • השדה name מוגדר להודעה שצריך לעדכן, כולל מזהה מרחב ומזהה הודעה.
    • אם צריך לעדכן את השדה text, מגדירים אותו עם הטקסט החדש.
    • השדה cardsV2 מוגדר עם הכרטיסים החדשים אם צריך לעדכן אותם.
  • מעבירים את updateMask עם רשימת השדות לעדכונים כמו text, ו- cardsV2.

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

כך מעדכנים את הטקסט והכרטיסים בהודעה אימות אפליקציות:

Node.js

chat/client-libraries/cloud/update-message-app-cred.js
import {createClientWithAppCredentials} from './authentication-utils.js';

// This sample shows how to update a message with app credential
async function main() {
  // Create a client
  const chatClient = createClientWithAppCredentials();

  // Initialize request argument(s)
  const request = {
    message: {
      // Replace SPACE_NAME and MESSAGE_NAME here
      name: 'spaces/SPACE_NAME/messages/MESSAGE_NAME',
      text: 'Text updated with app credential!',
      cardsV2 : [{ card: { header: {
        title: 'Card updated with app credential!',
        imageUrl: 'https://fonts.gstatic.com/s/i/short-term/release/googlesymbols/info/default/24px.svg'
      }}}]
    },
    // The field paths to update. Separate multiple values with commas or use
    // `*` to update all field paths.
    updateMask: {
      // The field paths to update.
      paths: ['text', 'cards_v2']
    }
  };

  // Make the request
  const response = await chatClient.updateMessage(request);

  // Handle the response
  console.log(response);
}

main().catch(console.error);

Python

chat/client-libraries/cloud/update_message_app_cred.py
from authentication_utils import create_client_with_app_credentials
from google.apps import chat_v1 as google_chat

# This sample shows how to update a message with app credential
def update_message_with_app_cred():
    # Create a client
    client = create_client_with_app_credentials()

    # Initialize request argument(s)
    request = google_chat.UpdateMessageRequest(
        message = {
            # Replace SPACE_NAME and MESSAGE_NAME here
            "name": "spaces/SPACE_NAME/messages/MESSAGE_NAME",
            "text": "Text updated with app credential!",
            "cards_v2" : [{ "card": { "header": {
                "title": 'Card updated with app credential!',
                "image_url": 'https://fonts.gstatic.com/s/i/short-term/release/googlesymbols/info/default/24px.svg'
            }}}]
        },
        # The field paths to update. Separate multiple values with commas or use
        # `*` to update all field paths.
        update_mask = "text,cardsV2"
    )

    # Make the request
    response = client.update_message(request)

    # Handle the response
    print(response)

update_message_with_app_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/UpdateMessageAppCred.java
import com.google.apps.card.v1.Card;
import com.google.apps.card.v1.Card.CardHeader;
import com.google.chat.v1.CardWithId;
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.UpdateMessageRequest;
import com.google.chat.v1.Message;
import com.google.protobuf.FieldMask;

// This sample shows how to update message with app credential.
public class UpdateMessageAppCred {

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithAppCredentials()) {
      UpdateMessageRequest.Builder request = UpdateMessageRequest.newBuilder()
        .setMessage(Message.newBuilder()
          // replace SPACE_NAME and MESSAGE_NAME here
          .setName("spaces/SPACE_NAME/messages/MESSAGE_NAME")
          .setText("Text updated with app credential!")
          .addCardsV2(CardWithId.newBuilder().setCard(Card.newBuilder()
            .setHeader(CardHeader.newBuilder()
              .setTitle("Card updated with app credential!")
              .setImageUrl("https://fonts.gstatic.com/s/i/short-term/release/googlesymbols/info/default/24px.svg")))))
        .setUpdateMask(FieldMask.newBuilder()
          // The field paths to update.
          .addAllPaths(List.of("text", "cards_v2")));
      Message response = chatServiceClient.updateMessage(request.build());

      System.out.println(JsonFormat.printer().print(response));
    }
  }
}

Apps Script

chat/advanced-service/Main.gs
/**
 * This sample shows how to update a message with app credential
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.bot'
 * used by service accounts.
 */
function updateMessageAppCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME and MESSAGE_NAME here
  const name = 'spaces/SPACE_NAME/messages/MESSAGE_NAME';
  const message = {
    text: 'Text updated with app credential!',
    cardsV2 : [{ card: { header: {
      title: 'Card updated with app credential!',
      imageUrl: 'https://fonts.gstatic.com/s/i/short-term/release/googlesymbols/info/default/24px.svg'
    }}}]
  };
  // The field paths to update. Separate multiple values with commas or use
  // `*` to update all field paths.
  const updateMask = 'text,cardsV2';

  // Make the request
  const response = Chat.Spaces.Messages.patch(message, name, {
    updateMask: updateMask
  }, getHeaderWithAppCredentials());

  // Handle the response
  console.log(response);
}

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

  • SPACE_NAME: המזהה של המרחב המשותף name. אפשר לקבל את המזהה על ידי קריאה ל-method‏ ListSpaces() או מכתובת ה-URL של המרחב המשותף.
  • MESSAGE_NAME: המזהה מ-name של ההודעה. אפשר לקבל את המזהה מגוף התגובה שמוחזר אחרי יצירת הודעה באופן אסינכררוני באמצעות Chat API, או באמצעות השם המותאם אישית שהוקצה להודעה בזמן היצירה.

Chat API מחזיר מופע של Message שבה מופיעה ההודעה שמתעדכנת.