دریافت جزئیات در مورد یک پیام

این راهنما نحوه استفاده از متد get() در منبع Message از API چت گوگل را برای بازگرداندن جزئیات مربوط به یک پیام متنی یا کارت توضیح می‌دهد.

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

پیش‌نیازها

نود جی اس

پایتون

جاوا

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

دریافت پیام با احراز هویت کاربر

برای دریافت جزئیات مربوط به یک پیام با احراز هویت کاربر ، موارد زیر را در درخواست خود ارسال کنید:

  • دامنه مجوز chat.messages.readonly یا chat.messages را مشخص کنید.
  • متد GetMessage() را فراخوانی کنید.
  • name برابر با نام منبع پیامی که قرار است دریافت شود، قرار دهید.

مثال زیر پیامی حاوی احراز هویت کاربر دریافت می‌کند:

نود جی اس

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

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

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

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME and MESSAGE_NAME here
    name: 'spaces/SPACE_NAME/messages/MESSAGE_NAME',
  };

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

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

await main();

پایتون

chat/client-libraries/cloud/get_message_user_cred.py
from authentication_utils import create_client_with_user_credentials
import google.oauth2.credentials

from google.apps import chat_v1 as google_chat

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

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

    # Initialize request argument(s)
    request = google_chat.GetMessageRequest(
        # Replace SPACE_NAME and MESSAGE_NAME here
        name = "spaces/SPACE_NAME/messages/MESSAGE_NAME",
    )

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

    # Handle the response
    print(response)

get_message_with_user_cred()

جاوا

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/GetMessageUserCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.GetMessageRequest;
import com.google.chat.v1.Message;

// This sample shows how to get message with user credential.
public class GetMessageUserCred {

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

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      GetMessageRequest.Builder request = GetMessageRequest.newBuilder()
        // replace SPACE_NAME and MESSAGE_NAME here
        .setName("spaces/SPACE_NAME/members/MESSAGE_NAME");
      Message response = chatServiceClient.getMessage(request.build());

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

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

chat/advanced-service/Main.gs
/**
 * This sample shows how to get message with user credential
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.messages.readonly'
 * referenced in the manifest file (appsscript.json).
 */
function getMessageUserCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME and MESSAGE_NAME here
  const name = 'spaces/SPACE_NAME/messages/MESSAGE_NAME';

  // Make the request
  const response = Chat.Spaces.Messages.get(name);

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

برای اجرای این نمونه، موارد زیر را جایگزین کنید:

  • SPACE_NAME : شناسه‌ای که از name فضا گرفته شده است. می‌توانید شناسه را با فراخوانی متد ListSpaces() یا از URL فضا به دست آورید.
  • MESSAGE_NAME : شناسه‌ی name پیام. می‌توانید شناسه را از بدنه‌ی پاسخی که پس از ایجاد پیام به صورت ناهمگام با Chat API برگردانده می‌شود، یا با نام سفارشی که در زمان ایجاد به پیام اختصاص داده شده است، دریافت کنید.

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

دریافت پیام با احراز هویت برنامه

برای دریافت جزئیات مربوط به یک پیام با احراز هویت برنامه ، موارد زیر را در درخواست خود ارسال کنید:

  • محدوده‌ی مجوزدهی را مشخص کنید. مثال‌های این بخش از محدوده‌ی chat.bot استفاده می‌کنند که به‌طورکلی در دسترس است و نیازی به تأیید مدیر ندارد. به‌طور جایگزین، می‌توانید به‌عنوان برنامه‌ی چت با تأیید مدیر که در پیش‌نمایش توسعه‌دهندگان موجود است، مجوز دهید.
  • متد GetMessage() را فراخوانی کنید.
  • name برابر با نام منبع پیامی که قرار است دریافت شود، قرار دهید.

مثال زیر پیامی با احراز هویت برنامه دریافت می‌کند:

نود جی اس

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

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

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME and MESSAGE_NAME here
    name: 'spaces/SPACE_NAME/messages/MESSAGE_NAME',
  };

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

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

await main();

پایتون

chat/client-libraries/cloud/get_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 get message with app credential
def get_message_with_app_cred():
    # Create a client
    client = create_client_with_app_credentials()

    # Initialize request argument(s)
    request = google_chat.GetMessageRequest(
        # Replace SPACE_NAME and MESSAGE_NAME here
        name = 'spaces/SPACE_NAME/messages/MESSAGE_NAME',
    )

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

    # Handle the response
    print(response)

get_message_with_app_cred()

جاوا

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/GetMessageAppCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.GetMessageRequest;
import com.google.chat.v1.Message;

// This sample shows how to get message with app credential.
public class GetMessageAppCred {

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithAppCredentials()) {
      GetMessageRequest.Builder request = GetMessageRequest.newBuilder()
        // replace SPACE_NAME and MESSAGE_NAME here
        .setName("spaces/SPACE_NAME/members/MESSAGE_NAME");
      Message response = chatServiceClient.getMessage(request.build());

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

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

chat/advanced-service/Main.gs
/**
 * This sample shows how to get message with app credential
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.bot'
 * used by service accounts.
 */
function getMessageAppCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME and MESSAGE_NAME here
  const name = 'spaces/SPACE_NAME/messages/MESSAGE_NAME';
  const parameters = {};

  // Make the request
  const response = Chat.Spaces.Messages.get(name, parameters, getHeaderWithAppCredentials());

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

برای اجرای این نمونه، موارد زیر را جایگزین کنید:

  • SPACE_NAME : شناسه‌ای که از name فضا گرفته شده است. می‌توانید شناسه را با فراخوانی متد ListSpaces() یا از URL فضا به دست آورید.
  • MESSAGE_NAME : شناسه‌ی name پیام. می‌توانید شناسه را از بدنه‌ی پاسخی که پس از ایجاد پیام به صورت ناهمگام با Chat API برگردانده می‌شود، یا با نام سفارشی که در زمان ایجاد به پیام اختصاص داده شده است، دریافت کنید.

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

دریافت پیام به عنوان یک برنامه چت با تأیید مدیر

احراز هویت برنامه با دامنه مجوز chat.app.* نیاز به تأیید یکباره مدیر دارد.

برای دریافت جزئیات مربوط به یک پیام با احراز هویت برنامه با استفاده از Chat REST API ، موارد زیر را در درخواست خود ارسال کنید:

  • متد GetMessage() را فراخوانی کنید.
  • دامنه مجوز chat.app.messages.readonly مشخص کنید.
  • name برابر با نام منبع پیامی که قرار است دریافت شود، قرار دهید.

ایجاد کلید API

برای فراخوانی متد API پیش‌نمایش توسعه‌دهنده، باید از یک نسخه پیش‌نمایش توسعه‌دهنده غیرعمومی از سند کشف API استفاده کنید. برای تأیید اعتبار درخواست، باید یک کلید API ارسال کنید.

برای ایجاد کلید API، پروژه Google Cloud برنامه خود را باز کنید و موارد زیر را انجام دهید:

  1. در کنسول گوگل کلود، به Menu > APIs & Services > Credentials بروید.

    به اعتبارنامه‌ها بروید

  2. روی ایجاد اعتبارنامه > کلید API کلیک کنید.
  3. کلید API جدید شما نمایش داده می‌شود.
    • برای کپی کردن کلید API خود جهت استفاده در کد برنامه، روی گزینه کپی کردن کلیک کنید. کلید API را می‌توانید در بخش «کلیدهای API» در اعتبارنامه‌های پروژه خود نیز پیدا کنید.
    • برای جلوگیری از استفاده غیرمجاز، توصیه می‌کنیم مکان و نوع APIهایی که کلید API می‌تواند استفاده شود را محدود کنید. برای جزئیات بیشتر، به افزودن محدودیت‌های API مراجعه کنید.

اسکریپتی بنویسید که Chat API را فراخوانی کند

در اینجا نحوه دریافت جزئیات مربوط به یک پیام با احراز هویت برنامه و تأیید مدیر و API Chat REST آورده شده است:

پایتون

  1. در دایرکتوری کاری خود، فایلی با نام chat_messages_get_admin_app.py ایجاد کنید.

  2. کد زیر را در chat_messages_get_admin_app.py قرار دهید:

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

# Define your app's authorization scopes.
# When modifying these scopes, delete the file token.json, if it exists.
SCOPES = ["https://www.googleapis.com/auth/chat.app.messages.readonly"]

def main():
    '''
    Authenticates with Chat API using app authentication,
    then gets details about a message.
    '''

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

    # Build a service endpoint for Chat API.
    chat = build('chat', 'v1', credentials=creds, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY')

    # Use the service endpoint to call Chat API.
    result = chat.spaces().messages().get(

        # The message to get details about.
        #
        # Replace SPACE_NAME with a space name.
        # Obtain the space name from the spaces resource of Chat API,
        # or from a space's URL.
        name='spaces/SPACE_NAME/messages/MESSAGE_NAME',

    ).execute()

    # Print Chat API's response in your command line interface.
    print(result)

if __name__ == '__main__':
    main()

  3. در کد، موارد زیر را جایگزین کنید:

    • API_KEY : کلید API که برای ساخت نقطه پایانی سرویس برای Chat API ایجاد کرده‌اید.
    • SPACE_NAME : شناسه‌ای که از name فضا گرفته شده است. می‌توانید شناسه را با فراخوانی متد ListSpaces() یا از URL فضا به دست آورید.
    • MESSAGE_NAME : شناسه‌ی name پیام. می‌توانید شناسه را از بدنه‌ی پاسخی که پس از ایجاد پیام به صورت ناهمگام با Chat API برگردانده می‌شود، یا با نام سفارشی که در زمان ایجاد به پیام اختصاص داده شده است، دریافت کنید.

  4. در دایرکتوری کاری خود، نمونه را بسازید و اجرا کنید: 

    python3 chat_messages_get_admin_app.py

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