จัดรูปแบบข้อความ

หน้านี้อธิบายวิธีที่แอป Google Chat สามารถจัดรูปแบบข้อความเพื่อส่งข้อความที่มีสิ่งต่อไปนี้

• Rich Text ที่มีไฮเปอร์ลิงก์หรือ @พูดถึงผู้ใช้คนเดียวหรือทุกคนในพื้นที่ทำงานของ Chat
• ข้อความที่ปรากฏในอินเทอร์เฟซการ์ด รวมถึงข้อความย่อหน้าหรือข้อความ UI ที่แสดงข้างไอคอน เช่น ปุ่ม

จัดรูปแบบ SMS

Chat ช่วยให้คุณเพิ่มการจัดรูปแบบพื้นฐานให้กับ SMS ได้ เช่น ตัวหนา ตัวเอียง และขีดทับ คุณจัดรูปแบบข้อความในข้อความธรรมดาแตกต่างจากข้อความการ์ด เนื่องจากข้อความธรรมดาจะจัดรูปแบบด้วยไวยากรณ์เดียวกับที่ผู้ใช้ Chat ใช้

สำหรับข้อความที่ส่งหรือเรียกข้อมูลโดยใช้ Chat API คุณสามารถใช้ไวยากรณ์ Markdown มาตรฐาน (MARKUP_SYNTAX_MARKDOWN) หรือไวยากรณ์มาร์กอัปของ Chat (MARKUP_SYNTAX_CHAT) ก็ได้ คุณสามารถกำหนดค่าไวยากรณ์มาร์กอัปเริ่มต้นระดับแอปได้ในคอนโซล Google Cloud (ดูหัวข้อกำหนดค่า Google Chat API)

• มาร์กดาวน์: ไวยากรณ์มาร์กดาวน์มาตรฐาน (MARKUP_SYNTAX_MARKDOWN) ตามข้อกำหนด CommonMark พร้อมส่วนขยายเพิ่มเติม แอปใน Chat ที่สร้างใหม่จะใช้ Markdown เป็นค่าเริ่มต้น
• Chat: ไวยากรณ์มาร์กอัปของ Chat (MARKUP_SYNTAX_CHAT) แอป Chat ที่มีอยู่จะใช้ค่าเริ่มต้นเป็น Chat เพื่อรักษาความเข้ากันได้แบบย้อนหลัง

นอกจากนี้ คุณยังระบุ markup_syntax ในคำขอ Chat API แต่ละรายการเพื่อลบล้างค่าเริ่มต้นระดับแอปได้ด้วย เมื่อไม่ได้ระบุ markup_syntax ในคำขอ API ระบบจะตั้งค่ามาร์กอัปตามวิธีที่คุณเรียกใช้ Chat API ดังนี้

• แอปใน Chat ที่กำหนดค่าไว้: ใช้ไวยากรณ์มาร์กอัปที่บันทึกไว้ในหน้าการกำหนดค่า Chat API
• โปรเจ็กต์ Cloud ที่ไม่ได้กำหนดค่า (ไม่มีการกำหนดค่า): หากโปรเจ็กต์ที่อยู่ในระบบคลาวด์เรียกใช้ Chat API โดยไม่มีการกำหนดค่าแอป Chat ที่บันทึกไว้ คำขอจะใช้ค่าเริ่มต้นเป็น MARKUP_SYNTAX_MARKDOWN
• เว็บฮุคขาเข้า: ค่าเริ่มต้นคือ MARKUP_SYNTAX_CHAT ดูหัวข้อส่งข้อความโดยใช้เว็บฮุคขาเข้า

หากต้องการจัดรูปแบบข้อความ ให้ใช้ไวยากรณ์ต่อไปนี้

ตัวอย่างเช่น ลองพิจารณา JSON ต่อไปนี้

    {
      "text": "Your pizza delivery *has arrived*!\nThank you for using _Cymbal Pizza!_"
    }

ข้อความที่จัดรูปแบบนี้จะแสดงข้อมูลต่อไปนี้ในพื้นที่ทำงานใน Chat

ดูการจัดรูปแบบข้อความที่ส่งในข้อความ

เมื่อผู้ใช้ส่งข้อความ เนื้อหาข้อความธรรมดาของข้อความจะอยู่ในช่อง text การจัดรูปแบบบางอย่างที่ใช้กับ SMS โดยใช้ไวยากรณ์มาร์กดาวน์จะอยู่ในช่อง text การจัดรูปแบบเพิ่มเติมจะอยู่ในฟิลด์ formattedText แบบเอาต์พุตเท่านั้น ซึ่งรวมถึงข้อมูลต่อไปนี้

• ไวยากรณ์มาร์กดาวน์เพิ่มเติมสำหรับข้อความ
• การพูดถึงผู้ใช้
• ไฮเปอร์ลิงก์ที่กำหนดเอง
• อีโมจิที่กำหนดเอง

ตัวอย่างเช่น ลองพิจารณาข้อความต่อไปนี้ที่ผู้ใช้ส่งมา

หากข้อความได้รับการจัดรูปแบบโดยใช้เมนูรูปแบบใน UI ของ Chat ช่อง text จะมีเฉพาะข้อความ ส่วนช่อง formattedText จะมีมาร์กอัป ข้อความ และไฮเปอร์ลิงก์ ตัวอย่างต่อไปนี้แสดงข้อความร่างที่มีคำที่เป็นไฮเปอร์ลิงก์ รายการในลิสต์ และคำที่ทำเป็นตัวหนา 1 คำ

ข้อความที่ได้รับจะมีรูปแบบดังนี้

    {
      "text": "I can meet there at:\nNoon\n3 pm\n5 pm\nWhat time works for you?",
      "formattedText": "I can meet <http://example.com|there> at:\n* Noon\n* 3 pm\n* 5 pm\nWhat time works for *you*?",
    }

ลิงก์รูปแบบ

หากคุณใส่ URL ของลิงก์ธรรมดาในข้อความ เช่น http://www.example.com/, Google Chat จะใช้ URL นี้เป็นข้อความลิงก์และทำไฮเปอร์ลิงก์ข้อความนั้นไปยัง URL ที่ระบุโดยอัตโนมัติ

หากต้องการระบุข้อความลิงก์อื่นสำหรับลิงก์ ให้ใช้ไวยากรณ์ต่อไปนี้

• สำหรับข้อความ API ที่กำหนดค่าด้วยมาร์กดาวน์ ให้ใช้ไวยากรณ์ลิงก์มาร์กดาวน์มาตรฐาน ดังนี้

  ตัวอย่างไวยากรณ์	ข้อความที่แสดงใน Google Chat
  [Example website](https://example.com)	Example website

• สำหรับข้อความธรรมดามาตรฐาน ให้ใช้ไวยากรณ์ไปป์ดังนี้

  ตัวอย่างไวยากรณ์	ข้อความที่แสดงใน Google Chat
  <https://example.com|Example website>	Example website

  คุณจะใส่สัญลักษณ์ไปป์และข้อความลิงก์หรือไม่ก็ได้ ดังนั้น <https://example.com> และ https://example.com จึงเทียบเท่ากัน

ใช้อีโมจิที่กำหนดเองใน SMS

แอปใน Chat สามารถส่ง SMS ที่มีอีโมจิที่กำหนดเองเพื่อปรับเปลี่ยนข้อความในแบบของคุณได้ อีโมจิที่กำหนดเองจะใช้ได้เฉพาะสำหรับองค์กร Google Workspace และผู้ดูแลระบบต้องเปิดใช้อีโมจิที่กำหนดเองให้กับองค์กร ดูข้อมูลเพิ่มเติมได้ที่หัวข้อดูข้อมูลเกี่ยวกับอีโมจิที่กำหนดเองใน Google Chat และจัดการสิทธิ์สำหรับอีโมจิที่กำหนดเอง

หากต้องการสร้างข้อความที่มีอีโมจิที่กำหนดเอง แอปของคุณต้องใช้การตรวจสอบสิทธิ์ผู้ใช้ ระบบไม่รองรับอีโมจิที่กำหนดเองในข้อความที่สร้างเป็นเว็บฮุคหรือในข้อความที่สร้างด้วยการตรวจสอบสิทธิ์แอป

หากต้องการเพิ่มอีโมจิที่กำหนดเองลงในข้อความ ให้ระบุ name หรือ emoji_name ของทรัพยากร customEmoji ดังนี้

{
    "text": "Hello <customEmojis/CUSTOM_EMOJI_ID>."
}

หากต้องการใช้ตัวอย่างนี้ ให้แทนที่ CUSTOM_EMOJI_ID ด้วยรหัสของอีโมจิที่กำหนดเอง คุณดูรหัสนี้ได้ในช่อง name หรือ emoji_name ของทรัพยากร customEmoji

หากแอปส่งข้อความโดยใช้ไวยากรณ์ Markdown คุณสามารถระบุอีโมจิที่กำหนดเองในรูปแบบแท็ก HTML โดยใช้รหัสอีโมจิที่กำหนดเองได้ดังนี้

{
  "text": "Hello <chat-emoji data-custom-emoji=\"customEmojis/CUSTOM_EMOJI_ID\">."
}

หรือจะระบุชื่ออีโมจิที่กำหนดเองก็ได้ ดังนี้

{
  "text": "Hello <chat-emoji data-emoji-name=\"CUSTOM_EMOJI_NAME\">."
}

หากต้องการใช้ตัวอย่างเหล่านี้ ให้แทนที่ CUSTOM_EMOJI_ID ด้วยรหัสอีโมจิที่กำหนดเอง และแทนที่ CUSTOM_EMOJI_NAME ด้วยชื่อชอร์ตโค้ดของอีโมจิที่กำหนดเอง

พูดถึงผู้ใช้ใน SMS

แอปใน Chat สามารถส่งข้อความที่ @พูดถึงผู้ใช้คนเดียวหรือทุกคนในพื้นที่ใน Chat ได้ นอกจากนี้ แอปใน Chat ยังสามารถพูดถึงผู้ใช้ที่ยังไม่ได้เข้าร่วมพื้นที่ทำงานหรือเป็นสมาชิกของพื้นที่ทำงานที่อยู่ในโหมดการนำเข้าได้ด้วย

ข้อความแบบไม่มีเสียงไม่รองรับการพูดถึงผู้ใช้ การรวมการพูดถึงในข้อความแบบไม่มีเสียงจะแสดงข้อผิดพลาด

@พูดถึงผู้ใช้ที่เฉพาะเจาะจง

หากต้องการ @พูดถึงผู้ใช้ที่เฉพาะเจาะจง ให้เพิ่ม <users/{user}> ลงใน SMS โดยที่ {user} คือรหัสของผู้ใช้ ตัวอย่างเช่น ลองพิจารณาข้อความต่อไปนี้ซึ่ง 123456789012345678901 แสดงถึงรหัสของผู้ใช้ Mahan S.

{
    "text": "A customer has reported an issue. Assigning ticket #942 to <users/123456789012345678901>."
}

หากแอปของคุณส่งข้อความโดยใช้ไวยากรณ์ Markdown ให้ใช้รูปแบบแท็ก HTML chat-user เพื่อระบุรหัสผู้ใช้ ดังนี้

{
  "text": "Assigning ticket #942 to <chat-user data-user=\"users/123456789012345678901\">."
}

หรือระบุทางอีเมล:

{
  "text": "Assigning ticket #942 to <chat-user data-email=\"mahan@example.com\">."
}

ข้อความจะแสดงดังนี้

คุณระบุค่า users/{user} ได้ด้วยวิธีต่อไปนี้

• หากแอป Google Chat กำลังตอบกลับข้อความที่ผู้ใช้ส่ง คุณสามารถใช้ช่อง message.sender.name ของเหตุการณ์การโต้ตอบ MESSAGE ได้

• หากแอป Google Chat กำลังสร้างข้อความแบบอะซิงโครนัส คุณสามารถระบุค่าสำหรับ users/{user} ได้ด้วยวิธีต่อไปนี้

  • ใช้ช่อง name ของทรัพยากร User ของ Google Chat เช่น users/123456789012345678901
  • ใช้อีเมลของผู้ใช้เป็นชื่อแทนสำหรับค่า {user} เช่น หากอีเมลคือ mahan@example.com คุณสามารถระบุผู้ใช้เป็น users/mahan@example.com ได้ หากต้องการใช้อีเมลแทน แอป Google Chat ของคุณต้องตรวจสอบสิทธิ์ในฐานะผู้ใช้

• หากใช้ People API คุณยังใช้เมธอด people.get เพื่อระบุรหัสผู้ใช้ได้ด้วย

@พูดถึงผู้ใช้ทั้งหมด

หากต้องการสร้าง SMS ที่ @พูดถึงทุกคนในพื้นที่ทำงาน ให้แทนที่ {user} ด้วย all ตัวอย่าง JSON ต่อไปนี้จะพูดถึงผู้ใช้ทั้งหมดในข้อความ

{
    "text": "Important message for <users/all>: Code freeze starts at midnight tonight!"
}

หากแอปของคุณส่งข้อความโดยใช้ไวยากรณ์ Markdown ให้ระบุการพูดถึงโดยใช้รูปแบบแท็ก HTML chat-user ดังนี้

{
  "text": "Important message for <chat-user data-user=\"users/all\">: Code freeze starts at midnight tonight!"
}

เพิ่มการอ้างอิงใน SMS

แอปใน Chat สามารถใส่การอ้างอิงใน SMS เพื่อให้ข้อมูลแหล่งที่มาโดยละเอียดแก่ผู้ใช้ คุณระบุแหล่งข้อมูลได้ 2 วิธีดังนี้

• การอ้างอิงในบรรทัด: เพิ่มการ์ดแบบอินเทอร์แอกทีฟที่ปรากฏขึ้นเมื่อผู้ใช้เลื่อนเคอร์เซอร์ไปเหนือส่วนที่เฉพาะเจาะจงของข้อความ
• แหล่งข้อมูลในส่วนท้าย: แสดงรายการแหล่งข้อมูลที่ด้านล่างของข้อความเป็นลิงก์ส่วนท้าย

ระบบจะรองรับการอ้างอิงเมื่อตั้งค่า markupSyntax ของข้อความเป็น MARKUP_SYNTAX_MARKDOWN เท่านั้น ฟีเจอร์นี้รองรับเฉพาะการสร้างข้อความแบบอะซิงโครนัสโดยใช้ Chat API เท่านั้น

วิธีเพิ่มการอ้างอิงในบรรทัดลงในข้อความ

1. ระบุแหล่งที่มาในรายการ citations ของข้อความ elements โดยกำหนด id ที่ไม่ซ้ำกันให้กับออบเจ็กต์ Citation แต่ละรายการ
2. ในข้อความ ให้ตัดข้อความที่ต้องการอ้างอิงโดยใช้รูปแบบแท็ก HTML chat-citation: <chat-citation data-id="{id}">{text}</chat-citation> ตรวจสอบว่า {id} ตรงกับรหัสที่คุณกำหนดไว้ใน elements ระบบจะไม่สนใจการอ้างอิงที่ไม่มีการอ้างถึง (การอ้างอิงที่ไม่มีแท็กที่ตรงกัน)

{
  "text": "This is a <chat-citation data-id=\"cite_1\">cited</chat-citation> text.",
  "markupSyntax": "MARKUP_SYNTAX_MARKDOWN",
  "elements": {
    "citations": [
      {
        "id": "cite_1",
        "citedSources": [
          {
            "title": "Example Source",
            "uri": "https://example.com"
          }
        ]
      }
    ]
  }
}

หากต้องการเพิ่มแหล่งที่มาของส่วนท้ายลงในข้อความ ให้ระบุแหล่งที่มาในรายการ citedSources ของข้อความ elements แหล่งข้อมูลที่ระบุไว้ที่นี่จะปรากฏใต้ข้อความเป็นลิงก์ส่วนท้ายโดยอัตโนมัติ และไม่จำเป็นต้องมีแท็กในบรรทัดในข้อความ

{
  "text": "This is a message with a footer source.",
  "markupSyntax": "MARKUP_SYNTAX_MARKDOWN",
  "elements": {
    "citedSources": [
      {
        "title": "Example Source",
        "uri": "https://example.com"
      }
    ]
  }
}

จัดรูปแบบข้อความที่ปรากฏในการ์ด

ภายในบัตร ช่องข้อความส่วนใหญ่รองรับการจัดรูปแบบข้อความพื้นฐานโดยใช้ชุดย่อยขนาดเล็กของแท็ก HTML คุณจัดรูปแบบข้อความในการ์ดข้อความแตกต่างจากข้อความธรรมดา เนื่องจากข้อความธรรมดาจะจัดรูปแบบด้วยไวยากรณ์เดียวกับที่ผู้ใช้ Chat ใช้

ใช้เครื่องมือสร้างการ์ดเพื่อออกแบบและดูตัวอย่างการรับส่งข้อความและอินเทอร์เฟซผู้ใช้สำหรับแอปใน Chat ดังนี้

จัดรูปแบบข้อความในย่อหน้า

แท็กที่รองรับและวัตถุประสงค์ของแท็กจะแสดงในตารางต่อไปนี้

หากต้องการกำหนดรายการและบล็อกโค้ด ให้ใช้แท็กต่อไปนี้

This is a code block.

Markdown

เมื่อเปิดไวยากรณ์ Markdown คุณจะใช้ไวยากรณ์ต่อไปนี้ได้

เพิ่มไอคอนลงในข้อความ

หากต้องการแสดงไอคอนข้างข้อความในการ์ด คุณสามารถใช้วิดเจ็ต DecoratedText และ ButtonList ได้

ส่วนต่อไปนี้จะอธิบายวิธีใช้ไอคอนในตัว ไอคอน Google Material หรือไอคอนที่กำหนดเองในข้อความหรือปุ่มที่ตกแต่ง

ใช้ไอคอนจาก Chat

หากต้องการใช้ไอคอนในตัวที่มีให้ใน Chat ให้ระบุอย่างใดอย่างหนึ่งต่อไปนี้

ตารางต่อไปนี้แสดงไอคอนในตัวที่ใช้ได้กับข้อความการ์ด

ต่อไปนี้เป็นตัวอย่างของการ์ดที่มีไอคอนอีเมล

ใช้ไอคอนจากดีไซน์ Material ของ Google

คุณสามารถใช้ไอคอนจากดีไซน์ Material ของ Google เพื่อเลือกจากตัวเลือกไอคอนกว่า 2,500 รายการ และปรับแต่งน้ำหนัก การเติม และเกรดของไอคอนได้

ต่อไปนี้เป็นตัวอย่างการ์ดที่มีไอคอนจากดีไซน์ Material ของ Google

ใช้ไอคอนที่กำหนดเอง

หากต้องการเพิ่มไอคอนที่กำหนดเอง ให้ใส่ช่อง iconUrl และระบุ URL ที่เกี่ยวข้องของไอคอน

ต่อไปนี้เป็นตัวอย่างไอคอนที่กำหนดเอง