REST Resource: projects.chatAppConfig

Resource: ChatAppConfig

Merepresentasikan konfigurasi aplikasi Google Chat yang dibuat sebagai add-on Google Workspace.

Representasi JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "interactiveFeatureConfig": {
    object (InteractiveFeatureConfig)
  },
  "avatarUri": string,
  "state": enum (AppState),
  "errorLoggingEnabled": boolean,
  "markupSyntax": enum (MarkupSyntax)
}
Kolom
name

string

Wajib. ID. Nama resource konfigurasi aplikasi Chat.

Format: projects/{project}/chatAppConfig, dengan {project} sebagai nomor project Google Cloud.
displayName

string

Wajib. Nama tampilan aplikasi Chat. Panjangnya harus antara 3 dan 25 karakter.
description

string

Wajib. Deskripsi singkat aplikasi Chat. Harus berisi antara 1 dan 40 karakter.
interactiveFeatureConfig

object (InteractiveFeatureConfig)

Opsional. Setelan untuk fitur interaktif aplikasi. Jika setelan ini tidak diberikan, aplikasi akan bersifat non-interaktif, yang berarti aplikasi dapat menggunakan Chat API, tetapi pengguna tidak dapat berinteraksi dengan aplikasi.
avatarUri

string

Opsional. URL untuk gambar avatar aplikasi. Harus berupa URL HTTPS yang menghosting gambar PNG persegi (rasio aspek 1:1). Ukuran minimum yang direkomendasikan: 256 x 256 piksel. Avatar aplikasi default akan digunakan jika tidak ditentukan.
state

enum (AppState)

Opsional. Status aplikasi. Defaultnya adalah ACTIVE jika tidak ditentukan.
errorLoggingEnabled

boolean

Opsional. Apakah akan mencatat error ke Cloud Logging. Jika tidak ditentukan, setelan defaultnya adalah false.
markupSyntax

enum (MarkupSyntax)

Opsional. Sintaksis markup default untuk pesan yang dikirim atau dibaca oleh aplikasi Chat ini. Defaultnya adalah MARKUP_SYNTAX_MARKDOWN jika tidak ditentukan.

AppState

Status aplikasi Chat saat ini.

Enum
APP_STATE_UNSPECIFIED Nilai default. Tidak ditentukan.
ACTIVE Dipetakan ke LIVE di halaman konfigurasi Chat API. Aplikasi aktif, dapat ditemukan dan digunakan oleh orang yang memiliki visibilitas.
DISABLED Aplikasi dinonaktifkan, tidak dapat lagi ditemukan oleh siapa pun, dan tidak ada yang dapat berbicara dengan aplikasi lagi.

InteractiveFeatureConfig

Setelan untuk fitur interaktif aplikasi.

Representasi JSON 
{
  "connectionConfig": {
    object (ConnectionConfig)
  },
  "appCommands": [
    {
      object (AppCommand)
    }
  ],
  "urlPatterns": [
    {
      object (UrlPattern)
    }
  ],
  "allowlistedTestingPrincipals": [
    string
  ],
  "supportsMultiuserSpaces": boolean
}
Kolom
connectionConfig

object (ConnectionConfig)

Wajib. Cara aplikasi menerima peristiwa dari Google Chat.
appCommands[]

object (AppCommand)

Opsional. Konfigurasi untuk perintah aplikasi.
urlPatterns[]

object (UrlPattern)

Opsional. Konfigurasi untuk pratinjau link.
allowlistedTestingPrincipals[]

string

Opsional. Alamat email pengguna dan grup di domain Google Workspace Anda yang dapat menemukan dan menggunakan aplikasi.
supportsMultiuserSpaces

boolean

Opsional. Apakah aplikasi dapat ditambahkan ke DM personal, chat grup, dan ruang. Jika tidak ditentukan, setelan defaultnya adalah false.

ConnectionConfig

Cara aplikasi menerima peristiwa.

Representasi JSON 
{

  "httpEndpointConfig": {
    object (HttpEndpointConfig)
  },
  "appsScriptEndpointConfig": {
    object (AppsScriptEndpointConfig)
  },
  "cloudPubSubEndpointConfig": {
    object (CloudPubSubEndpointConfig)
  },
  "dialogflowEndpointConfig": {
    object (DialogflowEndpointConfig)
  }
}
Kolom
Jenis koneksi. Berikut adalah daftar kolom yang sama-sama bersifat eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
httpEndpointConfig

object (HttpEndpointConfig)

Konfigurasi endpoint HTTP.
appsScriptEndpointConfig

object (AppsScriptEndpointConfig)

Konfigurasi deployment Apps Script.
cloudPubSubEndpointConfig

object (CloudPubSubEndpointConfig)

Konfigurasi topik Pub/Sub.
dialogflowEndpointConfig

object (DialogflowEndpointConfig)

Konfigurasi Dialogflow.
Akhir kolom yang saling eksklusif.

HttpEndpointConfig

Konfigurasi endpoint HTTP.

Representasi JSON 
{

  "commonUrl": string,
  "perEventEndpointConfig": {
    object (HttpPerEventEndpointConfig)
  }
}
Kolom
Konfigurasi URL endpoint HTTP. Berikut adalah daftar kolom yang sama-sama bersifat eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
commonUrl

string

Opsional. URL HTTPS tempat Google Chat mengirim semua peristiwa interaktif.
perEventEndpointConfig

object (HttpPerEventEndpointConfig)

Opsional. URL HTTPS terpisah yang digunakan Google Chat untuk mengirim setiap jenis peristiwa interaktif.
Akhir kolom yang saling eksklusif.

HttpPerEventEndpointConfig

Konfigurasi endpoint HTTP untuk jenis peristiwa tertentu.

Representasi JSON 
{
  "appCommandEndpoint": string,
  "addedToSpaceEndpoint": string,
  "messageEndpoint": string,
  "removedFromSpaceEndpoint": string
}
Kolom
appCommandEndpoint

string

Wajib. Endpoint URL HTTPS untuk peristiwa perintah aplikasi.
addedToSpaceEndpoint

string

Wajib. Endpoint URL HTTPS untuk peristiwa ditambahkan ke ruang.
messageEndpoint

string

Wajib. Endpoint URL HTTPS untuk peristiwa pesan.
removedFromSpaceEndpoint

string

Wajib. Endpoint URL HTTPS untuk peristiwa dihapus dari ruang.

AppsScriptEndpointConfig

Konfigurasi endpoint Apps Script.

Representasi JSON 
{
  "deploymentId": string,
  "perEventEndpointConfig": {
    object (AppsScriptPerEventEndpointConfig)
  }
}
Kolom
deploymentId

string

Wajib. ID deployment Apps Script.
perEventEndpointConfig

object (AppsScriptPerEventEndpointConfig)

Opsional. Nama fungsi Apps Script yang dipanggil Google Chat untuk setiap jenis peristiwa interaktif. Jika tidak ditentukan, Chat akan memanggil fungsi default untuk setiap jenis peristiwa.

AppsScriptPerEventEndpointConfig

Konfigurasi endpoint Apps Script untuk jenis peristiwa tertentu.

Representasi JSON 
{
  "appCommandEndpoint": string,
  "addedToSpaceEndpoint": string,
  "messageEndpoint": string,
  "removedFromSpaceEndpoint": string
}
Kolom
appCommandEndpoint

string

Opsional. Nama fungsi untuk peristiwa perintah aplikasi. Jika tidak ditentukan, nama fungsi onAppCommand default akan digunakan.
addedToSpaceEndpoint

string

Opsional. Nama fungsi untuk peristiwa ditambahkan ke ruang. Jika tidak ditentukan, nama fungsi onAddedToSpace default akan digunakan.
messageEndpoint

string

Opsional. Nama fungsi untuk peristiwa pesan. Jika tidak ditentukan, nama fungsi onMessage default akan digunakan.
removedFromSpaceEndpoint

string

Opsional. Nama fungsi untuk peristiwa dihapus dari ruang. Jika tidak ditentukan, nama fungsi onRemovedFromSpace default akan digunakan.

CloudPubSubEndpointConfig

Konfigurasi endpoint Pub/Sub.

Representasi JSON 
{
  "topic": string
}
Kolom
topic

string

Wajib. Topik Pub/Sub tempat Google Chat memublikasikan semua peristiwa interaktif. Topik harus berada dalam project Google Cloud yang sama dengan aplikasi, dan Chat harus memiliki izin untuk memublikasikan pesan ke topik tersebut. Untuk mengetahui detailnya, lihat Membangun aplikasi Google Chat dengan Pub/Sub.

Format: projects/{project}/topics/{topic}

DialogflowEndpointConfig

Konfigurasi endpoint Dialogflow.

Representasi JSON 
{
  "dialogflowEdition": enum (DialogflowEdition),
  "agent": string
}
Kolom
dialogflowEdition

enum (DialogflowEdition)

Wajib. Edisi Dialogflow.
agent

string

Opsional. Nama agen atau lingkungan Dialogflow CX. Diperlukan untuk Dialogflow CX. Jangan tetapkan untuk Dialogflow ES.

Format: projects/{project}/locations/{location}/agents/{agent} atau projects/{project}/locations/{location}/agents/{agent}/environments/{environment}.

DialogflowEdition

Jenis edisi Dialogflow.

Enum
DIALOGFLOW_EDITION_UNSPECIFIED Nilai default. Tidak ditentukan.
ES Edisi Dialogflow ES. Untuk menggunakan edisi ini, agen Dialogflow ES harus ada di project Google Cloud yang sama dengan aplikasi. Google Chat mengirimkan semua peristiwa interaktif ke agen tersebut.
CX Edisi Dialogflow CX. Untuk menggunakan edisi ini, agen Dialogflow CX harus ada di project Google Cloud yang sama dengan aplikasi dan ditentukan di kolom agent. Google Chat akan mengirimkan semua peristiwa interaktif ke agen tersebut.

AppCommand

Konfigurasi untuk perintah aplikasi.

Representasi JSON 
{
  "commandType": enum (CommandType),
  "commandId": integer,
  "command": string,
  "displayName": string,
  "description": string,
  "dialogEnabled": boolean,
  "loadingNotificationMessage": string
}
Kolom
commandType

enum (CommandType)

Wajib. Jenis perintah ini.
commandId

integer

Wajib. ID perintah (1-1000). Harus unik dalam aplikasi.
command

string

Opsional. Nama perintah. Wajib untuk SLASH_COMMAND, jangan tetapkan untuk jenis perintah lainnya. Harus diawali dengan "/", misalnya, "/command".
displayName

string

Opsional. Nama tampilan perintah yang mudah digunakan. Wajib untuk MESSAGE_ACTION dan QUICK_COMMAND, jangan tetapkan untuk SLASH_COMMAND.
description

string

Wajib. Deskripsi singkat perintah.
dialogEnabled

boolean

Opsional. Apakah perintah ini harus memicu dialog. Jika tidak ditentukan, setelan defaultnya adalah false.
loadingNotificationMessage

string

Opsional. Notifikasi yang akan dikirim kepada pengguna saat mereka memicu tindakan pesan. Hanya didukung untuk perintah MESSAGE_ACTION.

CommandType

Jenis Perintah Aplikasi.

Enum
COMMAND_TYPE_UNSPECIFIED Nilai default. Tidak ditentukan.
SLASH_COMMAND Perintah yang dipanggil dengan mengetik '/' diikuti dengan nama perintah. Fungsi ini dapat menerima argumen tambahan dalam teks pesan.
QUICK_COMMAND Perintah cepat yang dipanggil dari menu konteks penulisan pesan. Perintah cepat tidak menerima argumen tambahan.
MESSAGE_ACTION Perintah yang dipanggil dari menu konteks pesan.

UrlPattern

Konfigurasi untuk pratinjau link.

Representasi JSON 
{
  "hostPattern": string,
  "pathPrefix": string
}
Kolom
hostPattern

string

Wajib. Domain yang akan dicocokkan. Cocokkan subdomain tertentu, seperti "subdomain.example.com", atau seluruh domain dengan menyertakan tanda bintang (*) sebagai karakter pengganti di awal. Misalnya, "*.example.com" cocok dengan "https://subdomain.example.com" dan "https://any.number.of.subdomains.example.com".
pathPrefix

string

Opsional. Awalan jalur yang ditambahkan ke pola host. Jika kosong, cocok dengan semua URL dalam pola host. Misalnya, jika dipasangkan dengan pola host "subdomain.example.com", tentukan "path/" untuk mencocokkan URL halaman yang diawali dengan "https://subdomain.example.com/path/".

MarkupSyntax

Sintaksis markup yang digunakan untuk memformat teks pesan untuk aplikasi Chat ini.

Enum
MARKUP_SYNTAX_UNSPECIFIED Nilai default. Tidak ditentukan. Aplikasi Chat yang sudah ada dan dibuat sebelum markup_syntax diperkenalkan memiliki nilai ini dan menggunakan MARKUP_SYNTAX_CHAT hingga diupdate secara eksplisit.
MARKUP_SYNTAX_CHAT Menggunakan sintaksis markup Google Chat. Lihat https://developers.google.com/workspace/chat/format-messages#format-texts untuk mengetahui informasi selengkapnya.
MARKUP_SYNTAX_MARKDOWN Menggunakan sintaksis Markdown. Sintaksis ini didasarkan pada spesifikasi CommonMark, dengan ekstensi tambahan. Lihat https://developers.google.com/workspace/chat/format-messages#format-texts untuk mengetahui informasi selengkapnya.

Metode

get

 Mendapatkan konfigurasi aplikasi Chat dari sebuah project.

patch

 Mengupdate konfigurasi aplikasi Chat dari sebuah project.