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

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

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

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

Node.js

Python

Java

Apps Script

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

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

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

  • מציינים את היקף ההרשאה של chat.messages.
  • מבצעים קריאה ל-method‏ 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);
}

await main();

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 של המרחב המשותף. אפשר לאתר את המזהה באמצעות הפעלת השיטה ListSpaces או מכתובת ה-URL של המרחב המשותף.
  • ‫MESSAGE_NAME: המזהה מהשדה name של ההודעה. אתם יכולים לקבל את המזהה מגוף התשובה שמוחזרת אחרי שיוצרים הודעה באופן אסינכרוני באמצעות Chat API, או באמצעות השם בהתאמה אישית שהוקצה להודעה בזמן היצירה.

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

עדכון הודעה בתור אפליקציית הצ'אט

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

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

  • מציינים את היקף ההרשאה של 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);
}

await main();

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 של המרחב המשותף. אפשר לאתר את המזהה באמצעות הפעלת השיטה ListSpaces או מכתובת ה-URL של המרחב המשותף.
  • ‫MESSAGE_NAME: המזהה מהשדה name של ההודעה. אפשר לקבל את המזהה מגוף התשובה שמוחזרת אחרי שיוצרים הודעה באופן אסינכרוני באמצעות Chat API, או באמצעות השם בהתאמה אישית שהוקצה להודעה בזמן היצירה.

‫Chat API מחזיר מופע של Message עם פרטי ההודעה שעודכנה.

עדכון כרטיסים באופן אסינכרוני

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

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