به عنوان یک برنامه چت Google به دستورات اسلش پاسخ دهید

این صفحه نحوه تنظیم و پاسخ به دستورات اسلش را برای برنامه Google Chat توضیح می دهد.

دستور اسلش روشی متداول است که کاربران با آن برنامه چت را فراخوانی کرده و با آن تعامل دارند. دستورات اسلش همچنین به کاربران کمک می کند تا ویژگی های کلیدی یک برنامه چت را کشف کرده و از آنها استفاده کنند.

برای استفاده از دستور اسلش، کاربران یک اسلش ( / ) و سپس یک دستور متن کوتاه مانند /about را تایپ می کنند تا اطلاعاتی در مورد برنامه چت دریافت کنند. کاربران می توانند با تایپ یک اسلش در Google Chat، دستورات اسلش موجود را پیدا کنند، که پنجره ای را نشان می دهد که دستورات موجود برای برنامه Chat را فهرست می کند:

برای تصمیم‌گیری در مورد اینکه آیا باید دستورات اسلش را تنظیم کنید یا نه و برای درک نحوه طراحی تعاملات کاربر، به تعریف همه سفرهای کاربر مراجعه کنید.

دستورات اسلش با پاسخ های خصوصی

وقتی کاربر پیامی حاوی دستور اسلش ارسال می‌کند، پیام فقط برای کاربر و برنامه چت قابل مشاهده است. اگر برنامه چت خود را طوری پیکربندی کرده‌اید که به فضاهایی با چند نفر اضافه شود، می‌توانید به دستور اسلش به صورت خصوصی پاسخ دهید تا تعامل بین کاربر و برنامه چت خصوصی بماند.

به عنوان مثال، برای اطلاع از برنامه چت که در یک فضا پیدا می‌کنند، کاربران می‌توانند از دستوراتی مانند /about یا /help استفاده کنند. برای جلوگیری از اطلاع سایر افراد در فضا، برنامه چت می‌تواند به صورت خصوصی با اطلاعاتی درباره نحوه استفاده از برنامه چت و دریافت پشتیبانی پاسخ دهد.

پیش نیازها

یک دستور اسلش را تنظیم کنید

این بخش نحوه تکمیل مراحل زیر را برای تنظیم دستور اسلش توضیح می دهد:

1. یک نام برای دستور اسلش خود ایجاد کنید .
2. دستور اسلش را در Google Chat API پیکربندی کنید .

دستور اسلش خود را نام ببرید

نام یک دستور اسلش همان چیزی است که کاربران در پیام چت برای فراخوانی برنامه چت تایپ می کنند. توضیحات کوتاهی نیز در زیر نام ظاهر می شود تا کاربران را در مورد نحوه استفاده از دستور بیشتر راهنمایی کند:

هنگام انتخاب نام و توضیحات برای دستور اسلش، توصیه های زیر را در نظر بگیرید:

• برای نامگذاری دستور اسلش:

  • از کلمات یا عبارات کوتاه، توصیفی و کاربردی استفاده کنید تا دستورات برای کاربر واضح و ساده باشد. به عنوان مثال، به جای گفتن /createAReminder ، از /remindMe استفاده کنید.
  • اگر دستور شما حاوی بیش از یک کلمه است، با استفاده از تمام حروف کوچک برای کلمه اول و سپس بزرگ کردن حرف اول کلمات اضافی به کاربران کمک کنید دستور را بخوانند. به عنوان مثال، به جای /updatecontact ، از /updateContact استفاده کنید.
  • در نظر بگیرید که آیا از یک نام منحصر به فرد یا معمول برای دستور خود استفاده کنید. اگر دستور شما یک تعامل یا ویژگی معمولی را توصیف می‌کند، می‌توانید از نام مشترکی استفاده کنید که کاربران آن را تشخیص می‌دهند و انتظار دارند، مانند /settings یا /feedback . در غیر این صورت، سعی کنید از نام‌های دستوری منحصربه‌فرد استفاده کنید، زیرا اگر نام دستور شما برای سایر برنامه‌های چت یکسان است، کاربر باید دستورات مشابه را برای یافتن و استفاده از دستورات شما فیلتر کند.

• برای توصیف دستور اسلش:

  • توضیحات را کوتاه و واضح نگه دارید تا کاربران بدانند هنگام فراخوانی دستور چه انتظاری داشته باشند.
  • به کاربران اطلاع دهید که آیا الزامات قالب بندی برای دستور وجود دارد. برای مثال، اگر یک دستور /remindMe ایجاد می‌کنید که به متن آرگومان نیاز دارد، توضیحات را روی چیزی مانند Remind me to do [something] at [time] تنظیم کنید.
  • به کاربران اطلاع دهید که آیا برنامه Chat به همه افراد موجود در فضا پاسخ می دهد یا به صورت خصوصی به کاربری که این فرمان را فراخوانی می کند. برای مثال، برای دستور اسلش /about ، می‌توانید آن را با عنوان Learn about this app (Only visible to you) توصیف کنید. برای پاسخ دادن خصوصی به دستور اسلش، بخش پاسخ با پیام خصوصی را ببینید.

دستور اسلش خود را در Google Chat API پیکربندی کنید

برای ایجاد یک دستور اسلش، باید اطلاعات مربوط به فرمان را در پیکربندی برنامه چت خود برای Google Chat API مشخص کنید.

برای پیکربندی یک دستور اسلش در Google Chat API، مراحل زیر را انجام دهید:

1. در کنسول Google Cloud، روی menu > APIs & Services > Enabled APIs & Services > Google Chat API کلیک کنید.

   به صفحه Google Chat API بروید

2. روی پیکربندی کلیک کنید.

3. در زیر دستورات اسلش ، روی افزودن دستور اسلش کلیک کنید.

4. نام، شناسه فرمان و توضیحات دستور را وارد کنید:

   1. نام: نام نمایشی دستور و آنچه کاربران برای فراخوانی برنامه شما تایپ می کنند. باید با اسلش شروع شود، فقط حاوی متن باشد و حداکثر 50 کاراکتر باشد.
   2. توضیحات: متنی که نحوه استفاده و قالب بندی دستور را توضیح می دهد. توضیحات می تواند حداکثر 50 کاراکتر باشد.
   3. شناسه فرمان: عددی از 1 تا 1000 که برنامه چت شما از آن برای تشخیص دستور اسلش و برگرداندن پاسخ استفاده می کند.

5. اختیاری: اگر می‌خواهید برنامه چت شما به فرمان با یک گفتگو پاسخ دهد، کادر باز کردن یک گفتگو را انتخاب کنید.

6. روی ذخیره کلیک کنید.

دستور اسلش اکنون برای برنامه چت پیکربندی شده است.

به یک دستور اسلش پاسخ دهید

وقتی کاربران یک پیام گپ حاوی دستور اسلش ایجاد می‌کنند، برنامه گپ شما یک رویداد تعاملی MESSAGE دریافت می‌کند. بار رویداد حاوی اشیاء slashCommand و slashCommandMetadata است. این اشیاء حاوی جزئیاتی در مورد دستور استفاده شده در پیام هستند (از جمله شناسه فرمان)، به طوری که شما می توانید پاسخ مناسب را برگردانید.

کد زیر نمونه‌ای از یک برنامه چت را نشان می‌دهد که با مدیریت رویدادهای تعامل MESSAGE و تشخیص اینکه آیا پیام حاوی شناسه فرمان منطبق است یا خیر، به دستور اسلش /about پاسخ می‌دهد. اگر پیام حاوی شناسه فرمان باشد، برنامه Chat یک پیام خصوصی برمی‌گرداند:

// Checks for the presence of a slash command in the message.
if (event.message.slashCommand) {
  // Executes the slash command logic based on its ID.
  // Slash command IDs are set in the Google Chat API configuration.
  switch (event.message.slashCommand.commandId) {
    case ABOUT_COMMAND_ID:
      return res.send({
        privateMessageViewer: event.user,
        text: 'The Avatar app replies to Google Chat messages.'
      });
  }
}

// Checks for the presence of a slash command in the message.
if (event.message.slashCommand) {
  // Executes the slash command logic based on its ID.
  // Slash command IDs are set in the Google Chat API configuration.
  switch (event.message.slashCommand.commandId) {
    case ABOUT_COMMAND_ID:
      return {
        privateMessageViewer: event.user,
        text: 'The Avatar app replies to Google Chat messages.'
      };
  }
}

# Checks for the presence of a slash command in the message.
if "slashCommand" in request_json["message"]:
  # Executes the slash command logic based on its ID.
  # Slash command IDs are set in the Google Chat API configuration.
  if request_json["message"]["slashCommand"]["commandId"] == ABOUT_COMMAND_ID:
    return {
      "privateMessageViewer": request_json["user"],
      "text": 'The Avatar app replies to Google Chat messages.'
    }

// Checks for the presence of a slash command in the message.
if (body.getAsJsonObject("message").has("slashCommand")) {
  // Executes the slash command logic based on its ID.
  // Slash command IDs are set in the Google Chat API configuration.
  JsonObject slashCommand = body.getAsJsonObject("message").getAsJsonObject("slashCommand");
  switch (slashCommand.get("commandId").getAsString()) {
    case ABOUT_COMMAND_ID:
    JsonObject aboutMessage = new JsonObject();
    aboutMessage.addProperty("text", "The Avatar app replies to Google Chat messages.");
    aboutMessage.add("privateMessageViewer", body.getAsJsonObject("user"));
      response.getWriter().write(gson.toJson(aboutMessage));
      return;
  }
}

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

موضوعات مرتبط

• نمونه‌های برنامه Chat را که از دستورات اسلش استفاده می‌کنند، مشاهده کنید
• ارسال پیام
• پیام خصوصی بفرستید
• گفتگوهای تعاملی را باز کنید