REST Resource: projects.chatAppConfig

Kaynak: ChatAppConfig

Google Workspace eklentisi olarak oluşturulmuş bir Google Chat uygulamasının yapılandırmasını temsil eder.

JSON gösterimi 
{
  "name": string,
  "displayName": string,
  "description": string,
  "interactiveFeatureConfig": {
    object (InteractiveFeatureConfig)
  },
  "avatarUri": string,
  "state": enum (AppState),
  "errorLoggingEnabled": boolean,
  "markupSyntax": enum (MarkupSyntax)
}
Alanlar
name

string

Zorunlu. Tanımlayıcı. Chat uygulaması yapılandırmasının kaynak adı.

Biçim: projects/{project}/chatAppConfig ({project}, Google Cloud proje numarasıdır).
displayName

string

Zorunlu. Chat uygulamasının görünen adı. Uzunluk 3 ila 25 karakter arasında olmalıdır.
description

string

Zorunlu. Chat uygulamasının kısa açıklaması. 1 ila 40 karakter uzunluğunda olmalıdır.
interactiveFeatureConfig

object (InteractiveFeatureConfig)

İsteğe bağlıdır. Uygulamanın etkileşimli özelliklerinin ayarları. Bu ayar sağlanmazsa uygulama etkileşimli olmaz. Yani Chat API'yi kullanabilir ancak kullanıcılar uygulamayla etkileşim kuramaz.
avatarUri

string

İsteğe bağlıdır. Uygulamanın avatar resminin URL'si. Kare (1:1 en boy oranı) PNG resmi barındıran bir HTTPS URL'si olmalıdır. Önerilen minimum boyut: 256 x 256 piksel. Belirtilmezse varsayılan bir uygulama avatarı kullanılır.
state

enum (AppState)

İsteğe bağlıdır. Uygulamanın durumu. Belirtilmezse varsayılan olarak ACTIVE olur.
errorLoggingEnabled

boolean

İsteğe bağlıdır. Hataların Cloud Logging'e kaydedilip kaydedilmeyeceğini belirler. Belirtilmezse varsayılan olarak false değerine ayarlanır.
markupSyntax

enum (MarkupSyntax)

İsteğe bağlıdır. Bu Chat uygulaması tarafından gönderilen veya okunan mesajlar için varsayılan işaretleme söz dizimi. Belirtilmezse varsayılan olarak MARKUP_SYNTAX_MARKDOWN değerine ayarlanır.

AppState

Chat uygulamasının mevcut durumu.

Sıralamalar
APP_STATE_UNSPECIFIED Varsayılan değer. Belirtilmedi.
ACTIVE Chat API yapılandırma sayfasında CANLI ile eşleşir. Uygulama etkindir, görünürlüğü olan kişiler tarafından bulunabilir ve kullanılabilir.
DISABLED Uygulama devre dışı bırakılır, artık kimse tarafından bulunamaz ve kimse uygulamayla konuşamaz.

InteractiveFeatureConfig

Uygulamanın etkileşimli özellikleri ile ilgili ayarlar.

JSON gösterimi 
{
  "connectionConfig": {
    object (ConnectionConfig)
  },
  "appCommands": [
    {
      object (AppCommand)
    }
  ],
  "urlPatterns": [
    {
      object (UrlPattern)
    }
  ],
  "allowlistedTestingPrincipals": [
    string
  ],
  "supportsMultiuserSpaces": boolean
}
Alanlar
connectionConfig

object (ConnectionConfig)

Zorunlu. Uygulamanın Google Chat'ten etkinlikleri alma şekli.
appCommands[]

object (AppCommand)

İsteğe bağlıdır. Uygulama komutları için yapılandırma.
urlPatterns[]

object (UrlPattern)

İsteğe bağlıdır. Bağlantı önizlemeleri için yapılandırma.
allowlistedTestingPrincipals[]

string

İsteğe bağlıdır. Google Workspace alanınızda uygulamayı bulup kullanabilecek kullanıcıların ve grupların e-posta adresleri.
supportsMultiuserSpaces

boolean

İsteğe bağlıdır. Uygulamanın bire bir DM'lere, grup sohbetlerine ve alanlara eklenip eklenemeyeceği. Belirtilmezse varsayılan olarak false değerine ayarlanır.

ConnectionConfig

Uygulamanın etkinlikleri nasıl aldığı.

JSON gösterimi 
{

  "httpEndpointConfig": {
    object (HttpEndpointConfig)
  },
  "appsScriptEndpointConfig": {
    object (AppsScriptEndpointConfig)
  },
  "cloudPubSubEndpointConfig": {
    object (CloudPubSubEndpointConfig)
  },
  "dialogflowEndpointConfig": {
    object (DialogflowEndpointConfig)
  }
}
Alanlar
Bağlantı türü. Aşağıda, birbirini dışlayan alanların listesi verilmiştir. Yanıtta alanlardan en fazla biri ayarlanır:
httpEndpointConfig

object (HttpEndpointConfig)

HTTP uç noktası yapılandırması.
appsScriptEndpointConfig

object (AppsScriptEndpointConfig)

Apps Komut Dosyası dağıtım yapılandırması.
cloudPubSubEndpointConfig

object (CloudPubSubEndpointConfig)

Pub/Sub konusu yapılandırması.
dialogflowEndpointConfig

object (DialogflowEndpointConfig)

Dialogflow yapılandırması.
Birbirini hariç tutan alanların sonu.

HttpEndpointConfig

HTTP uç noktası yapılandırması.

JSON gösterimi 
{

  "commonUrl": string,
  "perEventEndpointConfig": {
    object (HttpPerEventEndpointConfig)
  }
}
Alanlar
HTTP uç noktası URL yapılandırması. Aşağıda, birbirini dışlayan alanların listesi verilmiştir. Yanıtta alanlardan en fazla biri ayarlanır:
commonUrl

string

İsteğe bağlıdır. Google Chat'in tüm etkileşimli etkinlikleri gönderdiği HTTPS URL'si.
perEventEndpointConfig

object (HttpPerEventEndpointConfig)

İsteğe bağlıdır. Google Chat'in her etkileşimli etkinlik türünü gönderdiği ayrı HTTPS URL'leri.
Birbirini hariç tutan alanların sonu.

HttpPerEventEndpointConfig

Belirli etkinlik türleri için HTTP uç noktası yapılandırması.

JSON gösterimi 
{
  "appCommandEndpoint": string,
  "addedToSpaceEndpoint": string,
  "messageEndpoint": string,
  "removedFromSpaceEndpoint": string
}
Alanlar
appCommandEndpoint

string

Zorunlu. Uygulama komut etkinlikleri için HTTPS URL uç noktası.
addedToSpaceEndpoint

string

Zorunlu. Alana eklenen etkinlikler için HTTPS URL uç noktası.
messageEndpoint

string

Zorunlu. Mesaj etkinlikleri için HTTPS URL uç noktası.
removedFromSpaceEndpoint

string

Zorunlu. Alandan kaldırılan etkinlikler için HTTPS URL uç noktası.

AppsScriptEndpointConfig

Apps Komut Dosyası uç nokta yapılandırması.

JSON gösterimi 
{
  "deploymentId": string,
  "perEventEndpointConfig": {
    object (AppsScriptPerEventEndpointConfig)
  }
}
Alanlar
deploymentId

string

Zorunlu. Apps Komut Dosyası dağıtım kimliği.
perEventEndpointConfig

object (AppsScriptPerEventEndpointConfig)

İsteğe bağlıdır. Google Chat'in her etkileşimli etkinlik türü için çağırdığı Apps Komut Dosyası işlevlerinin adları. Belirtilmezse Chat, her etkinlik türü için varsayılan işlevi çağırır.

AppsScriptPerEventEndpointConfig

Belirli etkinlik türleri için Apps Komut Dosyası uç nokta yapılandırması.

JSON gösterimi 
{
  "appCommandEndpoint": string,
  "addedToSpaceEndpoint": string,
  "messageEndpoint": string,
  "removedFromSpaceEndpoint": string
}
Alanlar
appCommandEndpoint

string

İsteğe bağlıdır. Uygulama komutu etkinliklerinin işlev adı. Belirtilmezse varsayılan onAppCommand işlev adı kullanılır.
addedToSpaceEndpoint

string

İsteğe bağlıdır. Alana eklenen etkinlikler için işlev adı. Belirtilmezse varsayılan onAddedToSpace işlev adı kullanılır.
messageEndpoint

string

İsteğe bağlıdır. Mesaj etkinlikleri için işlev adı. Belirtilmezse varsayılan onMessage işlev adı kullanılır.
removedFromSpaceEndpoint

string

İsteğe bağlıdır. Alandan kaldırılma etkinliklerinin işlev adı. Belirtilmezse varsayılan onRemovedFromSpace işlev adı kullanılır.

CloudPubSubEndpointConfig

Pub/Sub uç nokta yapılandırması.

JSON gösterimi 
{
  "topic": string
}
Alanlar
topic

string

Zorunlu. Google Chat'in tüm etkileşimli etkinlikleri yayınladığı Pub/Sub konusu. Konu, uygulamayla aynı Google Cloud projesinde olmalı ve Chat'in konuda mesaj yayınlama izni olmalıdır. Ayrıntılı bilgi için Pub/Sub ile Google Chat uygulaması oluşturma başlıklı makaleyi inceleyin.

Biçim: projects/{project}/topics/{topic}

DialogflowEndpointConfig

Dialogflow uç nokta yapılandırması.

JSON gösterimi 
{
  "dialogflowEdition": enum (DialogflowEdition),
  "agent": string
}
Alanlar
dialogflowEdition

enum (DialogflowEdition)

Zorunlu. Dialogflow sürümü.
agent

string

İsteğe bağlıdır. Dialogflow CX temsilcisinin veya ortamının adı. Dialogflow CX için gereklidir. Dialogflow ES için ayarlamayın.

Biçim: projects/{project}/locations/{location}/agents/{agent} veya projects/{project}/locations/{location}/agents/{agent}/environments/{environment}.

DialogflowEdition

Dialogflow sürüm türü.

Sıralamalar
DIALOGFLOW_EDITION_UNSPECIFIED Varsayılan değer. Belirtilmedi.
ES Dialogflow ES sürümü. Bu sürümü kullanmak için uygulamayla aynı Google Cloud projesinde bir Dialogflow ES temsilcisi bulunmalıdır. Google Chat, tüm etkileşimli etkinlikleri bu temsilciye gönderir.
CX Dialogflow CX sürümü Bu sürümü kullanmak için uygulamayla aynı Google Cloud projesinde bir Dialogflow CX temsilcisi bulunmalı ve agent alanında belirtilmelidir. Google Chat, tüm etkileşimli etkinlikleri bu temsilciye gönderir.

AppCommand

Uygulama komutu yapılandırması.

JSON gösterimi 
{
  "commandType": enum (CommandType),
  "commandId": integer,
  "command": string,
  "displayName": string,
  "description": string,
  "dialogEnabled": boolean,
  "loadingNotificationMessage": string
}
Alanlar
commandType

enum (CommandType)

Zorunlu. Bu komutun türü.
commandId

integer

Zorunlu. Komutun kimliği (1-1000). Uygulama içinde benzersiz olmalıdır.
command

string

İsteğe bağlıdır. Komutun adı. SLASH_COMMAND için gereklidir, diğer komut türleri için ayarlamayın. "/" ile başlamalıdır (ör. "/komut").
displayName

string

İsteğe bağlıdır. Komutun kullanıcı dostu görünen adı. MESSAGE_ACTION ve QUICK_COMMAND için gereklidir, SLASH_COMMAND için ayarlamayın.
description

string

Zorunlu. Komutun kısa bir açıklaması.
dialogEnabled

boolean

İsteğe bağlıdır. Bu komutun bir iletişim kutusu tetikleyip tetiklemeyeceği. Belirtilmezse varsayılan olarak false olur.
loadingNotificationMessage

string

İsteğe bağlıdır. Kullanıcı mesaj işlemini tetiklediğinde gönderilecek bildirim. Yalnızca MESSAGE_ACTION komutları için desteklenir.

CommandType

Uygulama komutunun türü.

Sıralamalar
COMMAND_TYPE_UNSPECIFIED Varsayılan değer. Belirtilmedi.
SLASH_COMMAND "/" işaretinden sonra komut adı yazılarak çağrılan komut. Mesaj metninde ek bağımsız değişkenler kabul edebilir.
QUICK_COMMAND İleti oluşturma bağlam menüsünden çağrılan hızlı komut. Hızlı komutlar ek bağımsız değişkenleri kabul etmez.
MESSAGE_ACTION İleti bağlam menüsünden çağrılan bir komut.

UrlPattern

Bağlantı önizlemesi için yapılandırma.

JSON gösterimi 
{
  "hostPattern": string,
  "pathPrefix": string
}
Alanlar
hostPattern

string

Zorunlu. Eşleştirilecek alan. "subdomain.example.com" gibi belirli bir alt alan adını veya joker karakter olarak yıldız işareti (*) ekleyerek alan adının tamamını eşleştirin. Örneğin, "*.example.com" ifadesi "https://subdomain.example.com" ve "https://any.number.of.subdomains.example.com" ile eşleşir.
pathPrefix

string

İsteğe bağlıdır. Ana makine kalıbına eklenen yol ön eki. Boş bırakılırsa ana makine kalıbındaki tüm URL'lerle eşleşir. Örneğin, "subdomain.example.com" ana makine kalıbıyla eşlendiğinde "https://subdomain.example.com/path/" ile başlayan sayfa URL'lerini eşleştirmek için "path/" değerini belirtin.

MarkupSyntax

Bu Chat uygulamasının mesaj metnini biçimlendirmek için kullanılan işaretleme söz dizimi.

Sıralamalar
MARKUP_SYNTAX_UNSPECIFIED Varsayılan değer. Belirtilmedi. markup_syntax kullanıma sunulmadan önce oluşturulan mevcut Chat uygulamaları bu değere sahiptir ve açıkça güncellenene kadar MARKUP_SYNTAX_CHAT kullanır.
MARKUP_SYNTAX_CHAT Google Chat'in işaretleme söz dizimini kullanır. Daha fazla bilgi için https://developers.google.com/workspace/chat/format-messages#format-texts adresini ziyaret edin.
MARKUP_SYNTAX_MARKDOWN Markdown söz dizimini kullanır. Bu söz dizimi, ek uzantılarla birlikte CommonMark spesifikasyonunu temel alır. Daha fazla bilgi için https://developers.google.com/workspace/chat/format-messages#format-texts adresini ziyaret edin.

Yöntemler

get

 Bir projenin Chat uygulaması yapılandırmasını alır.

patch

 Bir projenin Chat uygulaması yapılandırmasını günceller.