یک پیام را به روز کنید

این راهنما نحوه استفاده از متد update() در منبع Message از API چت گوگل را برای به‌روزرسانی یک پیام متنی یا کارتی در یک فضا توضیح می‌دهد. به‌روزرسانی یک پیام برای تغییر ویژگی‌های پیام، مانند آنچه می‌گوید یا محتوای یک کارت. همچنین می‌توانید یک پیام متنی را به یک پیام کارتی اضافه کنید یا یک کارت را به یک پیام متنی اضافه کنید.

در API چت، یک پیام چت توسط منبع Message نمایش داده می‌شود. در حالی که کاربران چت فقط می‌توانند پیام‌هایی حاوی متن ارسال کنند، برنامه‌های چت می‌توانند از بسیاری از ویژگی‌های پیام‌رسانی دیگر، از جمله نمایش رابط‌های کاربری ایستا یا تعاملی، جمع‌آوری اطلاعات از کاربران و ارسال پیام‌ها به صورت خصوصی، استفاده کنند. برای کسب اطلاعات بیشتر در مورد ویژگی‌های پیام‌رسانی موجود برای API چت، به نمای کلی پیام‌های Google Chat مراجعه کنید.

پیش‌نیازها

نود جی اس

پایتون

جاوا

اسکریپت برنامه‌ها

به‌روزرسانی پیام از طرف یک کاربر

با احراز هویت کاربر ، فقط متن پیام می‌تواند به‌روزرسانی شود.

برای به‌روزرسانی یک پیام با احراز هویت کاربر، موارد زیر را در درخواست خود ارسال کنید:

  • دامنه مجوز chat.messages را مشخص کنید.
  • متد UpdateMessage() را فراخوانی کنید.
  • message به عنوان نمونه‌ای از Message با موارد زیر ارسال کنید:
    • فیلد name که برای پیام به‌روزرسانی تنظیم شده است، که شامل یک شناسه فاصله و یک شناسه پیام است.
    • فیلد text با متن جدید تنظیم می‌شود.
  • مقدار text را به updateMask ارسال کنید.

اگر پیام به‌روزرسانی‌شده یک پیام کارتی باشد، متن به کارت‌ها (که همچنان نمایش داده می‌شوند) اضافه می‌شود.

در اینجا نحوه به‌روزرسانی یک پیام یا افزودن یک پیام متنی به پیام کارت با احراز هویت کاربر آمده است:

نود جی اس

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();

پایتون

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()

جاوا

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));
    }
  }
}

اسکریپت برنامه‌ها

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 برگردانده می‌شود، یا با نام سفارشی که در زمان ایجاد به پیام اختصاص داده شده است، دریافت کنید.

API چت نمونه‌ای از Message را برمی‌گرداند که جزئیات پیام به‌روزرسانی‌شده را شرح می‌دهد.

به‌روزرسانی پیام به عنوان برنامه چت

با احراز هویت برنامه ، هم متن و هم کارت‌های یک پیام می‌توانند به‌روزرسانی شوند.

برای به‌روزرسانی یک پیام با احراز هویت برنامه، موارد زیر را در درخواست خود ارسال کنید:

  • دامنه مجوز chat.bot را مشخص کنید.
  • متد UpdateMessage() را فراخوانی کنید.
  • message به عنوان نمونه‌ای از Message با موارد زیر ارسال کنید:
    • فیلد name که برای پیام به‌روزرسانی تنظیم شده است، که شامل یک شناسه فاصله و یک شناسه پیام است.
    • فیلد text در صورت نیاز به به‌روزرسانی، با متن جدید تنظیم می‌شود.
    • فیلد cardsV2 در صورت نیاز به به‌روزرسانی کارت‌های جدید، با آنها تنظیم می‌شود.
  • updateMask به همراه لیست فیلدها به به‌روزرسانی‌هایی مانند text و cardsV2 ارسال کنید.

اگر پیام به‌روزرسانی‌شده یک پیام کارتی باشد و متن به‌روزرسانی شود، متن به‌روزرسانی‌شده به کارت‌ها (که همچنان نمایش داده می‌شوند) اضافه می‌شود. اگر پیام به‌روزرسانی‌شده یک پیام متنی باشد و کارت‌ها به‌روزرسانی شوند، کارت‌های به‌روزرسانی‌شده به متن (که همچنان نمایش داده می‌شود) اضافه می‌شوند.

در اینجا نحوه به‌روزرسانی متن و کارت‌های یک پیام با احراز هویت برنامه آمده است:

نود جی اس

چت/کتابخانه‌های-مشتری/ابر/به‌روزرسانی-پیام-برنامه-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();

پایتون

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()

جاوا

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));
    }
  }
}

اسکریپت برنامه‌ها

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 برگردانده می‌شود، یا با نام سفارشی که در زمان ایجاد به پیام اختصاص داده شده است، دریافت کنید.

API چت نمونه‌ای از Message را برمی‌گرداند که جزئیات پیام به‌روزرسانی‌شده را شرح می‌دهد.