تعديل رسالة

يشرح هذا الدليل كيفية استخدام طريقة update في المورد Message ضمن Google Chat API لتعديل رسالة نصية أو رسالة بطاقة في مساحة. تعديل رسالة لتغيير سماتها، مثل محتواها أو محتوى بطاقة يمكنك أيضًا إضافة رسالة نصية قبل رسالة بطاقة أو إضافة بطاقة إلى رسالة نصية.

في Chat API، يتم تمثيل رسالة Chat من خلال المورد Message. في حين أنّه بإمكان مستخدمي Chat إرسال رسائل تتضمّن نصًا فقط، يمكن لتطبيقات Chat استخدام العديد من ميزات المراسلة الأخرى، بما في ذلك عرض واجهات مستخدم ثابتة أو تفاعلية، وجمع المعلومات من المستخدمين، وتسليم الرسائل بشكل خاص. لمزيد من المعلومات حول ميزات المراسلة المتاحة لواجهة برمجة تطبيقات Chat، يُرجى الاطّلاع على نظرة عامة على رسائل Google Chat.

المتطلبات الأساسية

Node.js

حساب Google Workspace من إصدار Business أو Enterprise مع إذن الوصول إلى Google Chat

إعداد البيئة:
- أنشئ مشروعًا على Google Cloud.
- ضبط شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth
- فعِّل واجهة Google Chat API وأعِدّها من خلال إضافة اسم ورمز ووصف لتطبيق محادثات.
- ثبِّت Node.js Cloud Client Library.
- أنشئ بيانات اعتماد الوصول استنادًا إلى الطريقة التي تريد استخدامها للمصادقة في طلب Google Chat API:
  - لإجراء المصادقة كمستخدم في Chat، أنشئ بيانات اعتماد معرّف عميل OAuthواحفظها كملف JSON باسم credentials.json في الدليل المحلي.
  - لإجراء المصادقة بصفتك تطبيق محادثات، أنشئ بيانات اعتماد لحساب الخدمة واحفظها كملف JSON باسم credentials.json.
اختَر نطاق تفويض استنادًا إلى ما إذا كنت تريد المصادقة كمستخدم أو كتطبيق محادثات.

Python

حساب Google Workspace من إصدار Business أو Enterprise مع إذن الوصول إلى Google Chat

إعداد البيئة:
- أنشئ مشروعًا على Google Cloud.
- ضبط شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth
- فعِّل واجهة Google Chat API وأعِدّها من خلال إضافة اسم ورمز ووصف لتطبيق محادثات.
- ثبِّت مكتبة برامج Cloud للغة Python.
- أنشئ بيانات اعتماد الوصول استنادًا إلى الطريقة التي تريد استخدامها للمصادقة في طلب Google Chat API:
  - لإجراء المصادقة كمستخدم في Chat، أنشئ بيانات اعتماد معرّف عميل OAuthواحفظها كملف JSON باسم credentials.json في الدليل المحلي.
  - لإجراء المصادقة بصفتك تطبيق محادثات، أنشئ بيانات اعتماد لحساب الخدمة واحفظها كملف JSON باسم credentials.json.
اختَر نطاق تفويض استنادًا إلى ما إذا كنت تريد المصادقة كمستخدم أو كتطبيق محادثات.

جافا

حساب Google Workspace من إصدار Business أو Enterprise مع إذن الوصول إلى Google Chat

إعداد البيئة:
- أنشئ مشروعًا على Google Cloud.
- ضبط شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth
- فعِّل واجهة Google Chat API وأعِدّها من خلال إضافة اسم ورمز ووصف لتطبيق محادثات.
- ثبِّت Java Cloud Client Library.
- أنشئ بيانات اعتماد الوصول استنادًا إلى الطريقة التي تريد استخدامها للمصادقة في طلب Google Chat API:
  - لإجراء المصادقة كمستخدم في Chat، أنشئ بيانات اعتماد معرّف عميل OAuthواحفظها كملف JSON باسم credentials.json في الدليل المحلي.
  - لإجراء المصادقة بصفتك تطبيق محادثات، أنشئ بيانات اعتماد لحساب الخدمة واحفظها كملف JSON باسم credentials.json.
اختَر نطاق تفويض استنادًا إلى ما إذا كنت تريد المصادقة كمستخدم أو كتطبيق محادثات.

برمجة التطبيقات

حساب Google Workspace من إصدار Business أو Enterprise مع إذن الوصول إلى Google Chat

إعداد البيئة:
- أنشئ مشروعًا على Google Cloud.
- ضبط شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth
- فعِّل واجهة Google Chat API وأعِدّها من خلال إضافة اسم ورمز ووصف لتطبيق محادثات.
- أنشئ مشروعًا مستقلاً في "برمجة تطبيقات Google"، وفعِّل خدمة Chat المتقدّمة.
- في هذا الدليل، يجب استخدام مصادقة المستخدم أو التطبيق. للمصادقة كتطبيق محادثات، أنشئ بيانات اعتماد حساب خدمة. للاطّلاع على الخطوات، يُرجى قراءة مقالة المصادقة والتفويض كتطبيق Google Chat.
اختَر نطاق تفويض استنادًا إلى ما إذا كنت تريد المصادقة كمستخدم أو كتطبيق محادثات.

تعديل رسالة بالنيابة عن مستخدم

باستخدام مصادقة المستخدم، يمكن تعديل نص الرسالة فقط.

لتعديل رسالة تتضمّن مصادقة المستخدم، مرِّر ما يلي في طلبك:

حدِّد chat.messages نطاق التفويض.
استدعِ طريقة UpdateMessage.
مرِّر message كمثيل من Message مع ما يلي:
- يتم ضبط الحقل name على الرسالة المطلوب تعديلها، والتي تتضمّن معرّف مساحة ومعرّف رسالة.
- مجموعة حقول text التي تتضمّن النص الجديد
مرِّر updateMask بالقيمة text.

إذا كانت الرسالة المعدَّلة عبارة عن رسالة بطاقة، يتم إلحاق النص بالبطاقات (التي تستمر في الظهور).

في ما يلي كيفية تعديل رسالة أو إضافة رسالة نصية قبل رسالة بطاقة باستخدام مصادقة المستخدم:

Node.js

chat/client-libraries/cloud/update-message-user-cred.js

عرض على GitHub

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

عرض على GitHub

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

عرض على GitHub

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

عرض على GitHub

/**
 * 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 نطاق التفويض.
استدعِ طريقة UpdateMessage.
مرِّر message كمثيل من Message مع ما يلي:
- حقل name الذي تم ضبطه على الرسالة المطلوب تعديلها، والذي يتضمّن معرّف مساحة ومعرّف رسالة
- يتم ضبط الحقل text باستخدام النص الجديد إذا كان بحاجة إلى تعديل.
- يتم ضبط الحقل cardsV2 باستخدام البطاقات الجديدة إذا كان يجب تعديلها.
مرِّر updateMask مع قائمة الحقول التي سيتم تعديلها، مثل text وcardsV2.

إذا كانت الرسالة المعدَّلة عبارة عن رسالة بطاقة وتم تعديل النص، يتم إلحاق النص المعدَّل بالبطاقات (التي تستمر في الظهور). إذا كانت الرسالة المعدَّلة رسالة نصية وتم تعديل البطاقات، ستتم إضافة البطاقات المعدَّلة إلى النص (الذي سيستمر في الظهور).

في ما يلي كيفية تعديل نص الرسالة وبطاقاتها باستخدام مصادقة التطبيق:

Node.js

chat/client-libraries/cloud/update-message-app-cred.js

عرض على GitHub

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

عرض على GitHub

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

عرض على GitHub

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

عرض على GitHub

/**
 * 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. ويكون ذلك مفيدًا لتعديل محتوى بطاقة بدون تفاعل المستخدم، مثل إعادة تحميل معاينة رابط أو تعديل حالة مهمة. تعمل هذه الطريقة مع الرسائل التي أنشأها التطبيق، بما في ذلك الرسائل التي تم إنشاؤها نيابةً عن مستخدم.

لمزيد من التفاصيل، يُرجى الاطّلاع على مقالة إنشاء البطاقات وتعديلها.

تعديل رسالة تنظيم صفحاتك في مجموعات يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.

المتطلبات الأساسية

Node.js

Python

جافا

برمجة التطبيقات

تعديل رسالة بالنيابة عن مستخدم

Node.js

Python

جافا

برمجة التطبيقات

تعديل رسالة بصفتك تطبيق محادثات

Node.js

Python

جافا

برمجة التطبيقات

تعديل البطاقات بشكل غير متزامن

مواضيع ذات صلة

تعديل رسالة