กำหนดค่า Google Chat API

แอป Google Chat แต่ละแอปที่คุณสร้างต้องมีโปรเจ็กต์ Google Cloud ของตัวเองที่เปิดใช้และกำหนดค่า Chat API ไว้

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

หากต้องการเรียกใช้ API เพื่อสร้าง อัปเดต และลบ หรือเพื่อติดตั้งใช้งานและทดสอบแอป Chat แบบอินเทอร์แอกทีฟ (สร้างเป็นส่วนเสริมของ Google Workspace ที่ขยายการทำงานของ Chat) คุณต้องกำหนดค่า Chat API ด้วย การตั้งค่าการกำหนดค่า Chat API เป็นที่ที่คุณระบุรายละเอียดทั้งหมดเกี่ยวกับ แอปใน Chat รวมถึงชื่อที่แสดง อวาตาร์ ปลายทางการติดตั้งใช้งาน และฟีเจอร์แบบอินเทอร์แอกทีฟ

ข้อกำหนดเบื้องต้น

เลือกชื่อที่แสดง รูปโปรไฟล์ และคำอธิบายสำหรับแอปใน Chat

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

ก่อนกำหนดค่าแอปใน Chat ให้เตรียมข้อมูลต่อไปนี้

ช่อง คำอธิบาย รูปแบบ
ชื่อแอป ชื่อที่แสดงของแอปใน Chat อักขระที่เป็นตัวอักษรและตัวเลขคละกันสูงสุด 25 ตัว
URL ของรูปโปรไฟล์ รูปภาพที่แสดงเป็นรูปโปรไฟล์ของแอปใน Chat HTTPS URL ที่ชี้ไปยังรูปภาพกราฟิกสี่เหลี่ยมจัตุรัส (PNG หรือ JPEG) ขนาดที่แนะนำคือ 256 x 256 พิกเซลขึ้นไป
คำอธิบาย คำอธิบายสั้นๆ ของแอปใน Chat ซึ่งจะแสดงเมื่อผู้ใช้ค้นหาแอปใน Chat อักขระที่เป็นตัวอักษรและตัวเลขคละกันสูงสุด 40 ตัว
คำอธิบายขนาดยาว ไม่บังคับ คำอธิบายสิ่งที่แอปใน Chat ทำได้ ซึ่งจะแสดงเมื่อผู้ใช้เริ่มการสนทนากับแอปใน Chat หรือเปิดหน้าแรกของเซสชันสำหรับตัวแทน ปัจจุบันรองรับเฉพาะเมื่ออัปเดตการกำหนดค่าแอปโดยใช้คอนโซล Google Cloud และไม่รองรับผ่าน API ส่วนเสริมของ Google Workspace สูงสุด 250 อักขระ

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

ตัวอย่างเช่น หากคุณเรียกใช้เมธอด spaces.create() Chat จะรวมชื่อแอปใน Chat ไว้ในคำอธิบายว่าใครเป็นผู้สร้างพื้นที่ทำงาน ดังที่แสดงในรูปภาพต่อไปนี้

แอป Google Chat จะสร้างพื้นที่ทำงานให้ผู้ใช้
รูปที่ 1 ข้อความการระบุแหล่งที่มาที่ Chat แสดงเมื่อใช้วิธี spaces.create() เพื่อสร้างพื้นที่ทำงานในนามของผู้ใช้

หากต้องการโต้ตอบกับแอปใน Chat ผู้ใช้จะเห็นหรือใช้ข้อมูลนี้ในลักษณะต่อไปนี้ด้วย

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

กำหนดค่าแอปใน Chat ในคอนโซล Google Cloud

เมื่อมีรายละเอียดแอปใน Chat แล้ว ให้เปิดโปรเจ็กต์ที่อยู่ในระบบคลาวด์ และกำหนดค่า Chat API ดังนี้

  1. ในคอนโซล Google Cloud ให้ไปที่หน้า Chat API แล้วคลิกหน้าการกำหนดค่า

    ไปที่หน้าการกำหนดค่า Chat API

  2. ในส่วนข้อมูลแอปพลิเคชัน ให้กรอกข้อมูลในช่องชื่อแอป URL ของรูปโปรไฟล์ และคำอธิบาย

  3. ไม่บังคับ: กรอกข้อมูลในช่องคำอธิบายแบบยาว

  4. ไม่บังคับ: จากเมนูไวยากรณ์มาร์กอัป ให้เลือกไวยากรณ์มาร์กอัปเริ่มต้น (Markdown หรือ Chat) สำหรับข้อความของแอปใน Chat ดูข้อมูลเพิ่มเติมเกี่ยวกับการจัดรูปแบบข้อความและวิธีที่ Chat กำหนดไวยากรณ์มาร์กอัปสำหรับคำขอ API ได้ที่หัวข้อจัดรูปแบบข้อความ

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

    หากต้องการสร้างแอปใน Chat แบบอินเทอร์แอกทีฟ ให้เปิดเปิดใช้ฟีเจอร์แบบอินเทอร์แอกทีฟ แล้วทำตามขั้นตอนต่อไปนี้

    1. ในส่วนฟังก์ชันการทำงาน ให้ทำดังนี้
      • ไม่บังคับ: เลือกรองรับหน้าแรกของแอปเพื่อแสดงการ์ดหน้าแรกในแท็บหน้าแรกของข้อความส่วนตัวแบบ 1:1 กับแอปใน Chat
      • เลือกเข้าร่วมพื้นที่ทำงานและการสนทนากลุ่มเพื่อให้แอปใน Chat พร้อมให้ติดตั้งและใช้งาน โดยค่าเริ่มต้น ผู้ใช้จะติดตั้งและส่งข้อความด้วยแอปใน Chat ในพื้นที่ทำงานเฉพาะระหว่างผู้ใช้กับแอปใน Chat ได้ นอกจากนี้ ผู้ใช้ยังเพิ่มและโต้ตอบกับแอปใน Chat ในพื้นที่ทำงานที่มีผู้ใช้หลายคนได้ด้วย
    2. ในส่วนการตั้งค่าการเชื่อมต่อ ให้เลือกสถาปัตยกรรมที่ต้องการใช้เพื่อรับออบเจ็กต์เหตุการณ์จาก Chat ดังนี้

      • หากต้องการใช้บริการ HTTP ให้เลือก URL ปลายทาง HTTP แล้วระบุ URL
      • หากต้องการใช้โปรเจ็กต์ Google Apps Script ให้เลือก Apps Script และระบุรหัสการทำให้ใช้งานได้สำหรับโปรเจ็กต์
      • หากต้องการใช้ Agent ของ Dialogflow ให้เลือก Dialogflow แล้วเลือก Dialogflow CX หรือ Dialogflow ES จากนั้นระบุชื่อทรัพยากรของ Agent
      • หากต้องการใช้ Pub/Sub ให้เลือก Cloud Pub/Sub แล้วป้อนชื่อหัวข้อ
    3. ไม่บังคับ: หากต้องการกำหนดเส้นทางออบเจ็กต์เหตุการณ์ไปยังปลายทางหรือฟังก์ชันที่เฉพาะเจาะจง ให้ไปที่การตั้งค่าการเชื่อมต่อ > ทริกเกอร์ แล้วระบุหรืออัปเดตปลายทางหรือฟังก์ชัน Callback สำหรับทริกเกอร์ Chat ต่อไปนี้

      • หน้าแรกของแอป (หากเปิดใช้รองรับหน้าแรกของแอป): ผู้ใช้เปิดแท็บหน้าแรกในข้อความส่วนตัวแบบ 1:1 ด้วยแอปใน Chat
      • เพิ่มไปยังพื้นที่ทำงาน: ผู้ใช้เพิ่มแอปใน Chat ไปยังการสนทนากลุ่มหรือพื้นที่ทำงาน หรือติดตั้งแอปใน Chat สำหรับข้อความแบบ 1:1
      • ข้อความ: ผู้ใช้ส่งข้อความไปยังแอปใน Chat เช่น ผู้ใช้ส่งข้อความส่วนตัวไปยังแอปใน Chat หรือ @พูดถึงแอปใน Chat ในพื้นที่ทำงานที่มีผู้ใช้หลายคน
      • นำออกจากพื้นที่ทำงาน: ผู้ใช้ถอนการติดตั้งหรือนำแอปใน Chat ออกจากพื้นที่ทำงาน
      • คำสั่งแอป: ผู้ใช้เรียกใช้คำสั่งด่วน คำสั่งเครื่องหมายทับ หรือการดำเนินการกับข้อความจากแอปใน Chat
    4. ไม่บังคับ: เพิ่มฟีเจอร์แบบอินเทอร์แอกทีฟอื่นๆ เช่น เซสชัน พรอมต์เริ่มต้น คำสั่ง (คำสั่งด่วน คำสั่งเครื่องหมายทับ และการดำเนินการกับข้อความ) หรือ ตัวอย่างลิงก์

    5. ในส่วนระดับการเข้าถึง ให้เลือกทำให้แอปใน Chat นี้พร้อมใช้งานสำหรับบุคคลและกลุ่มที่ระบุ แล้วป้อนอีเมลของบุคคลหรือ Google Groups ในองค์กร Google Workspace ดังนี้

      • หากต้องการติดตั้งและทดสอบแอปด้วยตนเอง ให้ป้อนอีเมลของคุณเอง
      • หากต้องการแชร์แอปใน Chat ภายในกับทีมหรือทั้งองค์กรโดยไม่ต้องเผยแพร่ไปยัง Marketplace ให้ป้อน Google Groups อย่างน้อย 1 กลุ่ม กลุ่มไม่มีขีดจำกัดจำนวนสมาชิก หากแอปขอขอบเขต chat.app.* คุณยังคงต้องเผยแพร่แอปเพื่อให้ผู้ดูแลระบบอนุมัติ
      • หากผู้ดูแลระบบจำกัดการติดตั้ง Marketplace ไว้เฉพาะแอปในรายการที่อนุญาต คอนโซล Google Cloud จะจำกัดช่องนี้ไว้ที่อีเมลผู้ใช้ 5 รายสำหรับการพัฒนา การแสดงผลของกลุ่มจะมีผลหลังจากที่ผู้ดูแลระบบเพิ่มแอปไปยังรายการที่อนุญาตเท่านั้น
  6. ไม่บังคับ: ในส่วนบันทึก ให้เลือกช่องทำเครื่องหมายบันทึกข้อผิดพลาดไปยัง Logging เพื่อใช้ Google Cloud Logging โปรดดูข้อมูลเพิ่มเติมที่หัวข้อบันทึกข้อผิดพลาดในการค้นหาสำหรับแอปใน Chat

  7. คลิกบันทึก

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

กำหนดค่าแอปใน Chat โดยใช้ Google Cloud CLI

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

กลุ่มคำสั่ง gcloud beta workspace-add-ons chat-app-config มีคำสั่งต่อไปนี้

  • describe: แสดงการกำหนดค่า
  • update: กำหนดค่าแอปใน Chat เป็นครั้งแรก หรือเปลี่ยนการกำหนดค่า

คำสั่งจะใช้ทรัพยากร chatAppConfig ใน API ส่วนเสริมของ Google Workspace

ก่อนเริ่มต้น

  1. ติดตั้ง gcloud CLI หากคุณติดตั้ง gcloud CLI ไว้ก่อนหน้านี้ ให้ตรวจสอบว่าคุณมีเวอร์ชันล่าสุดโดยเรียกใช้ gcloud components update
  2. ลงชื่อเข้าใช้ gcloud CLI ด้วยบัญชีผู้ใช้ของคุณ คำสั่งไม่รองรับบัญชีบริการ

    gcloud auth login
  3. ตั้งค่าโปรเจ็กต์ที่อยู่ในระบบคลาวด์ของแอปใน Chat เป็นโปรเจ็กต์เริ่มต้นของ gcloud CLI ใช้รหัสโปรเจ็กต์ เนื่องจากคำสั่งไม่ยอมรับหมายเลขโปรเจ็กต์

    gcloud config set project PROJECT_ID

    หรือจะเพิ่มแฟล็ก --project ลงในแต่ละคำสั่งก็ได้

  4. เปิดใช้ API ส่วนเสริมของ Google Workspace ในโปรเจ็กต์ที่อยู่ในระบบคลาวด์โดยทำดังนี้

    gcloud services enable gsuiteaddons.googleapis.com
  5. ตรวจสอบว่าคุณมีบทบาท Identity and Access Management (IAM) ต่อไปนี้ในโปรเจ็กต์ที่อยู่ในระบบคลาวด์

    • นักพัฒนาซอฟต์แวร์ส่วนเสริมของ Google Workspace (roles/gsuiteaddons.developer) เพื่อดูและอัปเดตการกำหนดค่า หรือผู้อ่านส่วนเสริมของ Google Workspace (roles/gsuiteaddons.reader) เพื่อดูเท่านั้น บทบาทเหล่านี้รวมถึงสิทธิ์ที่แสดงอยู่ในข้อกำหนดเบื้องต้นและการตรวจสอบสิทธิ์
    • ผู้บริโภคของการใช้บริการ (roles/serviceusage.serviceUsageConsumer) gcloud CLI ใช้โปรเจ็กต์ที่อยู่ในระบบคลาวด์เป็นโปรเจ็กต์โควต้าสำหรับคำขอ ซึ่งต้องใช้สิทธิ์ serviceusage.services.use

    บทบาทเจ้าของและผู้แก้ไขจะมีสิทธิ์ทั้งหมดเหล่านี้ บทบาทเจ้าของแอป Chat และผู้ดูแอป Chat ซึ่งให้สิทธิ์เข้าถึงหน้าการกำหนดค่าในคอนโซล Google Cloud นั้นไม่เพียงพอ

ดูการกำหนดค่า

หากต้องการดูการกำหนดค่าของแอป Chat ให้เรียกใช้คำสั่ง describe ดังนี้

gcloud beta workspace-add-ons chat-app-config describe

เอาต์พุตจะคล้ายกับตัวอย่างต่อไปนี้

avatarUri: https://www.gstatic.com/dynamite/images/quickstart-app-avatar.png
description: Helps manage tasks and schedules
displayName: Cymbal Assistant
errorLoggingEnabled: true
interactiveFeatureConfig:
  allowlistedTestingPrincipals:
  - user@example.com
  appCommands:
  - command: /help
    commandId: 1
    commandType: SLASH_COMMAND
    description: Show available commands
  connectionConfig:
    httpEndpointConfig:
      commonUrl: https://example.com/chat
  supportsMultiuserSpaces: true
  urlPatterns:
  - hostPattern: example.com
    pathPrefix: tasks/
name: projects/123456789012/chatAppConfig
state: ACTIVE

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

name: projects/123456789012/chatAppConfig

หากต้องการเปลี่ยนเอาต์พุต ให้เพิ่มแฟล็กอย่างใดอย่างหนึ่งต่อไปนี้

  • --format=json: พิมพ์การกำหนดค่าในรูปแบบ JSON
  • --view=basic: ละเว้นการตั้งค่าฟีเจอร์แบบอินเทอร์แอกทีฟ (interactiveFeatureConfig)
  • --format="value(displayName)": พิมพ์เฉพาะชื่อที่แสดง หรือบรรทัดว่างหากโปรเจ็กต์ที่อยู่ในระบบคลาวด์ยังไม่มีแอปใน Chat แอปใน Chat ที่กำหนดค่าแล้วจะมีชื่อที่แสดงเสมอ คุณจึงใช้แฟล็กนี้ในสคริปต์เพื่อตรวจสอบว่ามีแอปใน Chat อยู่หรือไม่

อัปเดตการกำหนดค่า

หากต้องการกำหนดค่าแอป Chat เป็นครั้งแรกหรือเปลี่ยนการกำหนดค่า ให้เรียกใช้คำสั่ง update ระบุการตั้งค่าด้วยแฟล็กหรือในไฟล์การกำหนดค่า คุณไม่สามารถรวมทั้ง 2 อย่างไว้ในคำสั่งเดียว

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

ใช้แฟล็ก

ตัวอย่างต่อไปนี้จะกำหนดค่าแอปใน Chat ที่รับเหตุการณ์ที่ปลายทาง HTTP

gcloud beta workspace-add-ons chat-app-config update \
    --display-name="Quickstart App" \
    --description="Quickstart app" \
    --avatar-uri=https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png \
    --http-endpoint-url=HTTP_ENDPOINT_URL \
    --supports-multiuser-spaces \
    --add-allowlisted-testing-principals=USER_EMAIL \
    --error-logging-enabled

แทนที่ค่าต่อไปนี้

  • HTTP_ENDPOINT_URL: HTTPS URL ที่รับออบเจ็กต์เหตุการณ์จาก Chat
  • USER_EMAIL: อีเมลของบุคคลหรือกลุ่มในองค์กร Google Workspace ที่สามารถติดตั้งและทดสอบแอปใน Chat ได้ เช่น อีเมลของคุณเอง

คำสั่งจะพิมพ์การกำหนดค่าที่อัปเดตแล้ว

ตารางต่อไปนี้แสดง Flag สำหรับการตั้งค่าในหน้าการกำหนดค่า Chat API ในคอนโซล Google Cloud โปรดดูรายละเอียดเกี่ยวกับแฟล็กแต่ละรายการที่ข้อมูลอ้างอิงคำสั่ง update

การตั้งค่าในคอนโซล Google Cloud ธง
ชื่อแอป --display-name
URL ของรูปโปรไฟล์ --avatar-uri พร้อม HTTPS URL ของรูปภาพที่ตรงตามข้อกำหนดของรูปโปรไฟล์ หรือ --clear-avatar-uri เพื่อใช้รูปโปรไฟล์เริ่มต้น
คำอธิบาย --description
สถานะแอป --state=active หรือ --state=disabled
ไวยากรณ์มาร์กอัป --markup-syntax=markdown หรือ --markup-syntax=chat
เข้าร่วมพื้นที่ทำงานและการสนทนากลุ่ม --supports-multiuser-spaces หรือ --no-supports-multiuser-spaces
การตั้งค่าการเชื่อมต่อ ระดับใดระดับหนึ่งต่อไปนี้
  • URL ปลายทาง HTTP: --http-endpoint-url
  • Apps Script: --apps-script-deployment-id
  • Cloud Pub/Sub: --pubsub-topic ที่มีหัวข้อในโปรเจ็กต์ที่อยู่ในระบบคลาวด์เดียวกัน ในรูปแบบ projects/PROJECT_ID/topics/TOPIC_ID
  • Dialogflow: --dialogflow-edition=es หรือ --dialogflow-edition=cx โดยตั้งค่า --dialogflow-agent เป็นชื่อทรัพยากรของ Agent หรือสภาพแวดล้อม เช่น projects/PROJECT_ID/locations/LOCATION/agents/AGENT_ID
ระดับการแชร์ --add-allowlisted-testing-principals, --remove-allowlisted-testing-principals และ --clear-allowlisted-testing-principals
บันทึกข้อผิดพลาดไปยัง Logging --error-logging-enabled หรือ --no-error-logging-enabled

คำสั่ง ตัวอย่างลิงก์ และปลายทางแยกต่างหากสำหรับทริกเกอร์แต่ละรายการจะไม่มีแฟล็ก หากต้องการกำหนดค่า ให้ใช้ไฟล์การกำหนดค่า

เช่น หากต้องการปิดแอปใน Chat โดยไม่เปลี่ยนการตั้งค่าอื่นๆ ให้เรียกใช้คำสั่งต่อไปนี้ หากต้องการเปิดอีกครั้ง ให้ใช้ --state=active

gcloud beta workspace-add-ons chat-app-config update --state=disabled

ใช้ไฟล์การกำหนดค่า

หากต้องการเก็บการกำหนดค่าไว้ในไฟล์ หรือกำหนดการตั้งค่าที่ไม่มีแฟล็ก ให้ส่งไฟล์ YAML หรือ JSON ไปยังคำสั่ง update ไฟล์จะใช้ช่องของทรัพยากร chatAppConfig ซึ่งเป็นช่องเดียวกับที่คำสั่ง describe พิมพ์

  1. สร้างไฟล์ที่มีการตั้งค่าที่จะอัปเดต เช่น สร้างไฟล์ชื่อ chat_app_config.yaml โดยมีเนื้อหาต่อไปนี้

    displayName: Cymbal Assistant
    description: Helps manage tasks and schedules
    avatarUri: https://www.gstatic.com/dynamite/images/quickstart-app-avatar.png
    state: ACTIVE
    errorLoggingEnabled: true
    interactiveFeatureConfig:
      supportsMultiuserSpaces: true
      connectionConfig:
        httpEndpointConfig:
          commonUrl: https://example.com/chat
      appCommands:
      - commandId: 1
        commandType: SLASH_COMMAND
        command: /help
        description: Show available commands
      urlPatterns:
      - hostPattern: example.com
        pathPrefix: tasks/
      allowlistedTestingPrincipals:
      - USER_EMAIL
    

    แทนที่ USER_EMAIL ด้วยอีเมลของบุคคลหรือกลุ่มในองค์กร Google Workspace ที่สามารถติดตั้งและทดสอบแอปใน Chat ได้

  2. เรียกใช้คำสั่ง update ด้วยแฟล็ก --config-file ดังนี้

    gcloud beta workspace-add-ons chat-app-config update \
        --config-file=chat_app_config.yaml

หากต้องการเริ่มต้นจากการกำหนดค่าปัจจุบันของแอปใน Chat ให้บันทึกเอาต์พุตของคำสั่ง describe ลงในไฟล์ โดยทำดังนี้

gcloud beta workspace-add-ons chat-app-config describe > chat_app_config.yaml

จากนั้นแก้ไขไฟล์ ลบช่องที่ไม่ต้องการเปลี่ยนแปลง และส่งไฟล์ไปยังคำสั่ง update หากไฟล์มีการตั้งค่าที่คำสั่งอัปเดตไม่ได้ คำสั่งจะดำเนินการไม่สำเร็จ โปรดดูรายละเอียดที่หัวข้อข้อจำกัด

คำสั่ง update จะไม่สนใจช่อง name ในไฟล์ โดยจะอัปเดตโปรเจ็กต์ที่อยู่ในระบบคลาวด์ที่คุณตั้งค่าไว้ใน gcloud CLI เสมอ คุณจึงใช้ไฟล์เดียวกันเพื่อกำหนดค่าแอป Chat ในโปรเจ็กต์ที่อยู่ในระบบคลาวด์อื่นได้

วิธีที่คำสั่งใช้การเปลี่ยนแปลงของคุณ

  • เฉพาะการตั้งค่าที่คุณระบุเท่านั้นที่จะเปลี่ยนแปลง เมื่อใช้แฟล็ก คำสั่งจะเปลี่ยนการตั้งค่าสำหรับแฟล็กที่คุณส่ง เมื่อใช้ไฟล์การกำหนดค่า ระบบจะเปลี่ยนช่องที่อยู่ในไฟล์ ดังนั้นไฟล์จึงไม่จำเป็นต้องมีการกำหนดค่าทั้งหมด การตั้งค่าการเชื่อมต่อเป็นข้อยกเว้น โดยประเภทการเชื่อมต่อที่คุณตั้งค่าจะแทนที่ประเภทปัจจุบัน และรุ่น Dialogflow ที่คุณตั้งค่าจะแทนที่การกำหนดค่า Dialogflow ทั้งหมด
  • ระบบจะแทนที่รายการทั้งหมด หากไฟล์มีช่อง appCommands, urlPatterns หรือ allowlistedTestingPrincipals รายการในไฟล์จะแทนที่รายการปัจจุบัน หากต้องการเพิ่มหรือนำผู้ทดสอบแต่ละคนออกแทน ให้ใช้แฟล็ก --add-allowlisted-testing-principals และ --remove-allowlisted-testing-principals
  • ค่าว่างจะล้างการตั้งค่า เช่น ไฟล์ที่มี urlPatterns: [] ใน interactiveFeatureConfig จะนำรูปแบบ URL ตัวอย่างลิงก์ทั้งหมดออก
  • คำสั่งที่ดำเนินการไม่สำเร็จจะไม่เปลี่ยนแปลงสิ่งใด หากค่าไม่ถูกต้อง คำสั่งจะพิมพ์ข้อผิดพลาดและปล่อยการกำหนดค่าไว้ตามเดิม
  • คำขอมีการจำกัดอัตราคำขอ API จะจำกัดจำนวนคำขออ่านและคำขออัปเดตต่อนาทีสำหรับโปรเจ็กต์ที่อยู่ในระบบคลาวด์แต่ละโปรเจ็กต์และสำหรับแต่ละองค์กร คำสั่ง update แต่ละรายการจะส่งคำขออัปเดต 1 รายการ หากคุณเพิ่มหรือนำผู้ทดสอบออกด้วยแฟล็ก คำสั่งจะส่งคำขออ่านด้วย หากต้องการเปลี่ยนการตั้งค่าหลายรายการ ให้ส่งการตั้งค่าเหล่านั้นในคำสั่งเดียวหรือไฟล์เดียวแทนที่จะเรียกใช้คำสั่งสำหรับการตั้งค่าแต่ละรายการ

ข้อจำกัด

  • คำสั่งรองรับเฉพาะแอปใน Chat ที่สร้างเป็นส่วนเสริมของ Google Workspace เท่านั้น
  • คำสั่งไม่รองรับบัญชีบริการหรือการแอบอ้างเป็นบัญชีบริการ คุณต้องลงชื่อเข้าใช้ gcloud CLI ด้วยบัญชีผู้ใช้
  • โปรเจ็กต์ที่อยู่ในระบบคลาวด์มีการกำหนดค่าแอปใน Chat 1 รายการ และคำสั่งจะลบการกำหนดค่าดังกล่าวไม่ได้ หากต้องการหยุดไม่ให้ผู้ใช้ใช้แอปใน Chat ให้ตั้งค่าสถานะเป็นปิดใช้หรือลบโปรเจ็กต์ที่อยู่ในระบบคลาวด์
  • การอัปเดตจะมีผลกับแอป Chat ที่ใช้งานอยู่ คำสั่งต่างๆ ไม่มีโหมดฉบับร่างหรือโหมดทดลองใช้
  • ขณะที่แอปใน Chat เผยแพร่หรืออยู่ระหว่างตรวจสอบใน Google Workspace Marketplace คำสั่งจะไม่สามารถเปลี่ยนชื่อที่แสดง, รูปโปรไฟล์, คำอธิบาย, คำสั่ง หรือรูปแบบ URL ของตัวอย่างลิงก์ได้
  • คำสั่งรองรับการตั้งค่าในทรัพยากร chatAppConfig หากต้องการกำหนดค่าการตั้งค่าที่ไม่มีในทรัพยากร ให้ใช้คอนโซล Google Cloud

แก้ปัญหา

หากคำสั่งล้มเหลว ให้ค้นหาข้อความจากข้อความแสดงข้อผิดพลาดในตารางต่อไปนี้ หากข้อความขึ้นต้นด้วยสถานะ เช่น INVALID_ARGUMENT แสดงว่า API ส่วนเสริมของ Google Workspace ปฏิเสธคำขอ และข้อความหลังสถานะจะอธิบายปัญหา

ข้อความแสดงข้อผิดพลาดมี สาเหตุ โซลูชัน
Invalid choice: 'chat-app-config' หรือ Invalid choice: 'workspace-add-ons' คำสั่งไม่มี beta หรือ gcloud CLI เวอร์ชันของคุณไม่มีคำสั่งดังกล่าว เริ่มคำสั่งด้วย gcloud beta workspace-add-ons chat-app-config หากข้อผิดพลาดยังคงอยู่ ให้อัปเดต gcloud CLI เป็นเวอร์ชันล่าสุด
PROJECT ID โปรเจ็กต์ได้รับการตั้งค่าเป็นหมายเลขโปรเจ็กต์ ตั้งค่าโปรเจ็กต์เป็นรหัสโปรเจ็กต์
Failed to parse value(s) in protobuf ไฟล์การกำหนดค่ามีฟิลด์ที่ gcloud CLI ไม่รู้จัก ข้อความแสดงข้อผิดพลาดจะระบุชื่อช่อง เปรียบเทียบชื่อฟิลด์กับเอาต์พุตของคำสั่ง describe หากช่องเป็นช่องใหม่ ให้อัปเดต gcloud CLI เป็นเวอร์ชันล่าสุด
does not have permission to access projects instance API ปฏิเสธคำขอ ข้อความหลังจากข้อความนี้จะระบุเหตุผล ตัวอย่างเช่น
  • บัญชีของคุณไม่มีบทบาท IAM ที่จำเป็น หากข้อความมี Caller does not have required permission to use project แสดงว่าไม่มีบทบาทผู้บริโภคของการใช้บริการ
  • ไม่ได้เปิดใช้ API ส่วนเสริมของ Google Workspace ในโปรเจ็กต์ที่อยู่ในระบบคลาวด์
  • คุณลงชื่อเข้าใช้ด้วยบัญชีบริการ
ตรวจสอบข้อกำหนดในส่วนก่อนเริ่มต้น
INVALID_ARGUMENT ค่าไม่ถูกต้อง ตัวอย่างเช่น ชื่อที่แสดงต้องมีอักขระระหว่าง 3 ถึง 25 ตัว และคำอธิบายต้องมีอักขระระหว่าง 1 ถึง 40 ตัว หากข้อความมี not found or deleted แสดงว่ารหัสโปรเจ็กต์ไม่ถูกต้อง แก้ไขค่าที่ข้อความแสดงข้อผิดพลาดอธิบาย แล้วเรียกใช้คำสั่งอีกครั้ง
FAILED_PRECONDITION แอปใน Chat ไม่อนุญาตคำขอ เช่น ไม่ได้สร้างเป็นส่วนเสริมของ Google Workspace หรือเผยแพร่ใน Google Workspace Marketplace และไม่สามารถเปลี่ยนการตั้งค่าได้ ทำตามวิธีการในข้อความแสดงข้อผิดพลาด หากต้องการกำหนดค่าแอปใน Chat ที่ไม่ใช่ส่วนเสริมของ Google Workspace ให้ใช้คอนโซล Google Cloud หรือแปลงแอป
RESOURCE_EXHAUSTED หรือ 429 API ได้รับคำขอมากเกินไปสำหรับโปรเจ็กต์ที่อยู่ในระบบคลาวด์ หรือสำหรับองค์กรของคุณในช่วงเวลาสั้นๆ โปรดรอสักครู่แล้วเรียกใช้คำสั่งอีกครั้ง

กำหนดค่าแอปใน Chat โดยใช้ API ส่วนเสริมของ Google Workspace

แทนที่จะกำหนดค่าแอปใน Chat ด้วยตนเองในคอนโซล Google Cloud คุณสามารถอ่านและอัปเดตการกำหนดค่าสำหรับแอปใน Chat ที่สร้างเป็นส่วนเสริมของ Google Workspace แบบเป็นโปรแกรมได้โดยใช้ทรัพยากร chatAppConfig ใน Google Workspace add-ons API

chatAppConfig เป็นทรัพยากร Singleton ที่มีอยู่เสมอสำหรับโปรเจ็กต์ที่อยู่ในระบบคลาวด์แต่ละโปรเจ็กต์ ก่อนที่คุณจะบันทึกการกำหนดค่าเป็นครั้งแรก แหล่งข้อมูลจะมีการกำหนดค่าที่ว่างเปล่า (ซึ่งเป็นสิ่งที่ GetChatAppConfig แสดงผลด้วยหากคุณอ่านแหล่งข้อมูลก่อนการบันทึกครั้งแรก) เนื่องจากมีทรัพยากรอยู่แล้ว คุณจึงไม่จำเป็นต้องสร้างแยกต่างหาก โดยใช้ UpdateChatAppConfig ทั้งเพื่อบันทึกการกำหนดค่าเริ่มต้นและอัปเดตการกำหนดค่าที่มีอยู่

ข้อกำหนดเบื้องต้นและการตรวจสอบสิทธิ์

ก่อนเรียกใช้ GetChatAppConfig หรือ UpdateChatAppConfig ให้ทำตามข้อกำหนดเบื้องต้นต่อไปนี้ให้เสร็จสมบูรณ์

  1. เปิดใช้ API ส่วนเสริมของ Google Workspace (gsuiteaddons.googleapis.com) ในโปรเจ็กต์ที่อยู่ในระบบคลาวด์ คุณสามารถเลือกเปิดใช้ Google Chat API (chat.googleapis.com) ได้หากต้องการดูหรืออัปเดตการกำหนดค่าแอป Chat ในคอนโซล Google Cloud หรือเรียกใช้ Chat API
  2. ตรวจสอบสิทธิ์ในฐานะผู้ใช้ที่เป็นมนุษย์ด้วยข้อมูลเข้าสู่ระบบ OAuth 2.0 ที่มีขอบเขต https://www.googleapis.com/auth/cloud-platform ไม่รองรับการตรวจสอบสิทธิ์บัญชีบริการสำหรับเมธอด chatAppConfig
  3. ตรวจสอบว่าผู้ใช้ที่ตรวจสอบสิทธิ์แล้วมีสิทธิ์ Identity and Access Management (IAM) ที่จำเป็นในโปรเจ็กต์ที่อยู่ในระบบคลาวด์เป้าหมาย โดยทำดังนี้
    • gsuiteaddons.chatAppConfigs.get และ chat.bots.get เพื่ออ่านการกำหนดค่า (GetChatAppConfig)
    • gsuiteaddons.chatAppConfigs.update, chat.bots.update และ chat.bots.get เพื่ออัปเดตการกำหนดค่า (UpdateChatAppConfig)
  4. หากใช้ไลบรารีของไคลเอ็นต์ ให้ติดตั้งไลบรารีของไคลเอ็นต์ API ส่วนเสริมของ Google Workspace เวอร์ชันล่าสุดสำหรับภาษาของคุณ ดูรายการไลบรารีของไคลเอ็นต์ได้ที่เอกสารอ้างอิง API ส่วนเสริมของ Google Workspace

อัปเดตการกำหนดค่าแอปใน Chat

หากต้องการกำหนดค่าแอปใน Chat เป็นครั้งแรกหรืออัปเดตการกำหนดค่าที่มีอยู่ ให้ส่งคำขอ PATCH (UpdateChatAppConfig) ไปยังทรัพยากรซิงเกิลตัน chatAppConfig สำหรับโปรเจ็กต์ที่อยู่ในระบบคลาวด์

  • สำหรับการบันทึกครั้งแรกในโปรเจ็กต์ที่อยู่ในระบบคลาวด์ซึ่งมี chatAppConfig ที่ว่างเปล่า คุณต้องระบุ displayName (3-25 อักขระ) และ description (1-40 อักขระ) หากคุณไม่ระบุ interactiveFeatureConfig ในการบันทึกครั้งแรก ระบบจะกำหนดค่าแอปใน Chat เป็นแบบไม่มีการโต้ตอบ
  • สำหรับการอัปเดตครั้งต่อๆ ไป ให้ใช้พารามิเตอร์การค้นหา updateMask ที่ไม่บังคับเพื่อระบุช่องที่คั่นด้วยคอมมาที่จะอัปเดต (หรือละเว้น updateMask เพื่ออัปเดตช่องที่ระบุทั้งหมด) การอัปเดตฟิลด์ที่ซ้ำได้ (appCommands, urlPatterns หรือ allowlistedTestingPrincipals) จะแทนที่ทั้งรายการ
PATCH https://gsuiteaddons.googleapis.com/v1/projects/PROJECT_NUMBER/chatAppConfig?updateMask=displayName,description,avatarUri,state,errorLoggingEnabled,markupSyntax,interactiveFeatureConfig
Authorization: Bearer ACCESS_TOKEN
Content-Type: application/json

{
  "name": "projects/PROJECT_NUMBER/chatAppConfig",
  "displayName": "Cymbal Assistant",
  "description": "Helps manage tasks and schedules",
  "avatarUri": "https://www.gstatic.com/dynamite/images/quickstart-app-avatar.png",
  "state": "ACTIVE",
  "errorLoggingEnabled": true,
  "markupSyntax": "MARKUP_SYNTAX_MARKDOWN",
  "interactiveFeatureConfig": {
    "supportsMultiuserSpaces": false,
    "connectionConfig": {
      "httpEndpointConfig": {
        "commonUrl": "https://example.com/chat"
      }
    },
    "appCommands": [
      {
        "commandType": "SLASH_COMMAND",
        "commandId": 1,
        "command": "/help",
        "description": "Show available commands",
        "dialogEnabled": false
      }
    ],
    "urlPatterns": [
      {
        "hostPattern": "example.com",
        "pathPrefix": "tasks/"
      }
    ],
    "allowlistedTestingPrincipals": [
      "USER_EMAIL"
    ]
  }
}

แทนที่ข้อมูลต่อไปนี้ใน URL, ส่วนหัว และเนื้อหาของคำขอ

  • PROJECT_NUMBER: หมายเลขโปรเจ็กต์ที่เป็นตัวเลขของโปรเจ็กต์ Cloud ที่โฮสต์แอปใน Chat ของคุณ
  • ACCESS_TOKEN: โทเค็นเพื่อการเข้าถึง OAuth 2.0 ของผู้ใช้ที่ได้รับสิทธิ์ด้วยขอบเขต https://www.googleapis.com/auth/cloud-platform
  • USER_EMAIL: อีเมลหรือ Google Group จากองค์กร Google Workspace ของคุณเพื่อเพิ่มลงในรายการที่อนุญาตสำหรับการทดสอบแอปใน Chat (เช่น อีเมลของคุณเอง)
  • ฟิลด์กำหนดค่าตัวอย่างในเนื้อหาคำขอ (เช่น displayName, description, avatarUri และ interactiveFeatureConfig รวมถึงการกำหนดค่าปลายทาง, คำสั่ง, รูปแบบ URL ของตัวอย่างลิงก์ และผู้ใช้หลักในการทดสอบ) ที่มีค่าสำหรับแอปใน Chat ของคุณ ดูรายละเอียดเกี่ยวกับฟิลด์และตัวเลือกปลายทางที่รองรับทั้งหมดได้ที่ข้อมูลอ้างอิง REST ของ projects.chatAppConfig และ projects.chatAppConfig.patch

ดูการกำหนดค่าแอปใน Chat

หากต้องการอ่านการกำหนดค่าแอปใน Chat ปัจจุบันสำหรับโปรเจ็กต์ที่อยู่ในระบบคลาวด์ ให้เรียกใช้ GetChatAppConfig คุณสามารถส่งพารามิเตอร์การค้นหา view (ChatAppConfigView) ที่ไม่บังคับได้ ดังนี้

  • BASIC (ค่าเริ่มต้น): แสดงผลข้อมูลเมตาพื้นฐานโดยไม่มี interactiveFeatureConfig
  • FULL: แสดงผลฟิลด์กำหนดค่าทั้งหมด รวมถึง interactiveFeatureConfig

หากยังไม่ได้บันทึกการกำหนดค่าแอปใน Chat สำหรับโปรเจ็กต์ที่อยู่ในระบบคลาวด์ เมธอดจะแสดงผลออบเจ็กต์ ChatAppConfig ที่ว่างเปล่า

HTTP

GET https://gsuiteaddons.googleapis.com/v1/projects/PROJECT_NUMBER/chatAppConfig?view=FULL
Authorization: Bearer ACCESS_TOKEN

Node.js

const {GSuiteAddOnsClient} = require('@google-cloud/gsuiteaddons').v1;

const client = new GSuiteAddOnsClient();

async function getChatAppConfig() {
  const [response] = await client.getChatAppConfig({
    name: 'projects/PROJECT_NUMBER/chatAppConfig',
    view: 'FULL',
  });
  console.log(JSON.stringify(response, null, 2));
}

getChatAppConfig();

Python

from google.cloud import gsuiteaddons_v1

client = gsuiteaddons_v1.GSuiteAddOnsClient()

request = gsuiteaddons_v1.GetChatAppConfigRequest(
    name="projects/PROJECT_NUMBER/chatAppConfig",
    view=gsuiteaddons_v1.GetChatAppConfigRequest.ChatAppConfigView.FULL,
)
response = client.get_chat_app_config(request=request)
print(response)

ขีดจำกัดการใช้งาน

เมธอด chatAppConfig มีโควต้าต่อโปรเจ็กต์ หากคุณใช้เกินโควต้า คำขอจะดำเนินการไม่สำเร็จและแสดงรหัสสถานะ HTTP 429: Too many requests ดูขีดจำกัดโควต้าได้ที่หัวข้อขีดจำกัดการใช้งาน API ส่วนเสริมของ Google Workspace

แก้ไขข้อผิดพลาด

หากคำขอ chatAppConfig ไม่สำเร็จ ให้ตรวจสอบรหัสสถานะ HTTP และช่อง message ในการตอบกลับข้อผิดพลาด ตารางต่อไปนี้แสดงข้อผิดพลาดที่พบบ่อย สาเหตุ และวิธีแก้ไข

รหัสสถานะ HTTP สาเหตุที่พบบ่อย ความละเอียด
400: Bad Request (INVALID_ARGUMENT)
  • updateMask มีฟิลด์ที่ไม่มีอยู่หรืออัปเดตไม่ได้
  • ค่าในช่องขาดหายไปหรือไม่ถูกต้อง เช่น interactiveFeatureConfig ไม่มี connectionConfig
ตรวจสอบช่อง message เพื่อหาช่องที่ไม่ถูกต้อง และแก้ไขคำขอ ดูช่องและค่าที่รองรับได้ในข้อมูลอ้างอิง projects.chatAppConfig
400: Bad Request (FAILED_PRECONDITION)
  • แอปใน Chat ไม่ได้สร้างขึ้นเป็นส่วนเสริมของ Google Workspace
  • เปลี่ยนช่องนี้ไม่ได้เนื่องจากแอปใน Chat เผยแพร่ใน Google Workspace Marketplace แล้ว
  • ค่าใหม่ใช้ร่วมกับการกำหนดค่าแอปใน Chat ที่มีอยู่ไม่ได้
  • แปลงแอปใน Chat เป็นส่วนเสริม Google Workspace หรือกำหนดค่าในคอนโซล Google Cloud
  • ทำตามวิธีการในช่อง message เพื่ออัปเดตข้อมูลที่เผยแพร่
  • ตรวจสอบช่อง message เพื่อดูการตั้งค่าที่ขัดแย้งกัน และอัปเดตการตั้งค่าทั้ง 2 รายการในคำขอเดียวกัน หรือเปลี่ยนการตั้งค่าที่มีอยู่ก่อน
403: Forbidden (PERMISSION_DENIED)
  • ผู้ใช้ที่ตรวจสอบสิทธิ์แล้วไม่มีสิทธิ์ IAM ที่จำเป็นในโปรเจ็กต์ที่อยู่ในระบบคลาวด์
  • คำขอจะได้รับการตรวจสอบสิทธิ์ด้วยบัญชีบริการแทนบัญชีผู้ใช้
404: Not Found (NOT_FOUND) ไม่มีโปรเจ็กต์ที่อยู่ในระบบคลาวด์ในชื่อทรัพยากร หรือผู้ใช้ที่ตรวจสอบสิทธิ์แล้วเข้าถึงไม่ได้ ตรวจสอบว่าชื่อทรัพยากรใช้หมายเลขโปรเจ็กต์ที่ถูกต้องในรูปแบบ projects/PROJECT_NUMBER/chatAppConfig และผู้ใช้มีสิทธิ์เข้าถึงโปรเจ็กต์ที่อยู่ในระบบคลาวด์
429: Too Many Requests (RESOURCE_EXHAUSTED) เกินโควต้าต่อโปรเจ็กต์ โปรดรอและลองส่งคำขออีกครั้งในภายหลัง ดูขีดจำกัดได้ที่หัวข้อขีดจำกัดการใช้งาน

ข้อควรพิจารณาสำหรับส่วนเสริม Google Workspace ที่มีอยู่

แอปใน Chat ต้องมีการกำหนดค่าที่แตกต่างจากส่วนเสริม Google Workspace ที่ขยายแอปพลิเคชัน Google Workspace อื่นๆ หากส่วนเสริมของคุณขยายแอปพลิเคชัน Google Workspace อื่นๆ ให้พิจารณาข้อกำหนดต่อไปนี้สำหรับการกำหนดค่าแอปใน Chat

  • ทั้งบุคคลธรรมดาและผู้ดูแลระบบ Google Workspace ต้องติดตั้งส่วนเสริมของคุณจาก Marketplace ได้ คุณกำหนดการตั้งค่าการติดตั้งเหล่านี้ได้ใน Marketplace SDK
  • แอปใน Chat จะไม่ใช้ชื่อและโลโก้ที่คุณกำหนดค่าไว้สำหรับแอปพลิเคชัน Google Workspace อื่นๆ ในออบเจ็กต์ addons.common ของไฟล์ Manifest
  • สำหรับส่วนเสริมที่เผยแพร่ไปยัง Google Workspace Marketplace คุณจะบันทึกฉบับร่างของการเปลี่ยนแปลงการตั้งค่าการกำหนดค่า Google Chat API ไม่ได้ หลังจากอัปเดตและบันทึกการตั้งค่าการกำหนดค่า Chat API แล้ว แอปใน Chat ที่อัปเดตจะพร้อมใช้งานสำหรับผู้ใช้ปัจจุบันทั้งหมดทันที หากต้องการอัปเดตข้อมูลใน Marketplace คุณสามารถสร้างฉบับร่างก่อนส่งการเปลี่ยนแปลงได้
  • หากคุณสร้างส่วนเสริมโดยใช้ Apps Script ให้ทำดังนี้
  • หากคุณสร้างส่วนเสริมโดยใช้บริการ HTTP ให้ละเว้นรายละเอียดการกำหนดค่าแอปใน Chat ในไฟล์ Manifest projects.deployments ที่คุณสร้างโดยใช้ API ส่วนเสริมของ Google Workspace การติดตั้งใช้งาน HTTP ที่คุณระบุใน SDK ของ Google Workspace Marketplace จะใช้สำหรับแอปพลิเคชัน Google Workspace อื่นๆ เท่านั้น แต่ให้กำหนดค่าแอปใน Chat ในคอนโซล Google Cloud ด้วย gcloud CLI หรือใช้ทรัพยากร chatAppConfig ใน API ส่วนเสริมของ Google Workspace แทน

ให้สิทธิ์ผู้อื่นในการกำหนดค่า Chat API

คุณสามารถให้สิทธิ์ผู้ใช้บางรายเข้าถึงหน้าการกำหนดค่าแอปใน Chat ได้โดยให้บทบาทเจ้าของแอปใน Chat หรือบทบาทผู้มีสิทธิ์ดูแอปใน Chat ใน Google Cloud Identity Access Management (IAM) ผู้ใช้ที่มีบทบาทเหล่านี้จะไปที่หน้าการกำหนดค่าแอปใน Chat โดยใช้แดชบอร์ด API และบริการไม่ได้ แต่จะเข้าถึงหน้าการกำหนดค่าได้โดยไปที่คอนโซล Google Cloud สำหรับโปรเจ็กต์ที่อยู่ในระบบคลาวด์ของโฮสต์แอปใน Chat ดังนี้

https://console.developers.google.com/apis/api/chat.googleapis.com/hangouts-chat?project=PROJECT_ID

โดยที่ PROJECT_ID คือรหัสโปรเจ็กต์ของโปรเจ็กต์ Google Cloud ที่โฮสต์แอปใน Chat

แอปใน Chat ที่ไม่ใช่ส่วนเสริม: กำหนดค่า Google Chat API

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

  1. ในคอนโซล Google Cloud ให้ไปที่หน้าการกำหนดค่า Chat API ดังนี้

    ไปที่หน้าการกำหนดค่า Chat API

  2. ในส่วนฟีเจอร์แบบอินเทอร์แอกทีฟ ให้เปิดเปิดใช้ฟีเจอร์แบบอินเทอร์แอกทีฟ

  3. ล้างสร้างแอป Chat นี้เป็นส่วนเสริมของ Google Workspace กล่องโต้ตอบจะเปิดขึ้นเพื่อขอให้คุณยืนยัน คลิกปิดใช้ในกล่องโต้ตอบ

  4. ในส่วนฟังก์ชันการทำงาน ให้เลือกรองรับหน้าแรกของแอปหรือเข้าร่วมพื้นที่ทำงานและการสนทนากลุ่มตามต้องการ

  5. ในส่วนการตั้งค่าการเชื่อมต่อ ให้ระบุปลายทางเดียวสำหรับแอปใน Chat (URL ปลายทาง HTTP, รหัสการติดตั้งใช้งาน Apps Script, ชื่อหัวข้อ Cloud Pub/Sub หรือ Dialogflow)

  6. กำหนดค่าคำสั่ง, พรอมต์เริ่มต้น, ตัวอย่างลิงก์, ระดับการเข้าถึง และบันทึก (ไม่บังคับ) แล้วคลิกบันทึก

หากต้องการอัปเกรดแอปใน Chat ที่ไม่ใช่ส่วนเสริมเป็นส่วนเสริม Google Workspace ที่ขยาย Google Chat โปรดดูหัวข้อแปลงแอป Google Chat เป็นส่วนเสริม Google Workspace