REST Resource: brands.agents

資源：Agent

代表品牌的對話實體。

JSON 表示法 
{
  "name": string,
  "displayName": string,

  // Union field detail_info can be only one of the following:
  "businessMessagesAgent": {
    object (BusinessMessagesAgent)
  }
  // End of list of possible types for union field detail_info.
}
欄位
name

string

服務專員的專屬 ID。

唯讀。由平台定義。
displayName

string

必要欄位。代理程式向使用者顯示的名稱。最多 100 個字元。

服務專員通過驗證後即無法修改。

聯集欄位 detail_info。內含特定產品的必填欄位。

必要欄位。detail_info 只能採用下列其中一種設定：
businessMessagesAgent

object (BusinessMessagesAgent)

Business Messages 的詳細服務專員資訊。

BusinessMessagesAgent

Business Messages 專屬的服務專員資訊。

JSON 表示法 
{
  "logoUrl": string,
  "entryPointConfigs": [
    {
      object (BusinessMessagesEntryPointConfig)
    }
  ],
  "conversationalSettings": {
    string: {
      object (ConversationalSetting)
    },
    ...
  },
  "defaultLocale": string,
  "primaryAgentInteraction": {
    object (SupportedAgentInteraction)
  },
  "additionalAgentInteractions": [
    {
      object (SupportedAgentInteraction)
    }
  ],
  "customAgentId": string,
  "agentTestUrl": string,
  "testUrls": [
    {
      object (TestUrl)
    }
  ],
  "phone": {
    object (Phone)
  },
  "authorizationConfig": {
    object (AuthorizationConfig)
  },
  "nonLocalConfig": {
    object (NonLocalConfig)
  },
  "surveyConfig": {
    object (SurveyConfig)
  }
}
欄位
logoUrl

string

選用設定。服務專員的標誌公開網址。大小上限為 50 KB。

服務專員通過驗證後即無法修改。
entryPointConfigs[]

object (BusinessMessagesEntryPointConfig)

選用設定。進入點設定清單。

服務專員通過驗證後即無法修改。
conversationalSettings

map (key: string, value: object (ConversationalSetting))

必要欄位。代理程式的對話設定 (對應至語言代碼)。語言代碼會以格式正確的 IETF BCP 47 語言標記表示。

這個物件中包含 "key": value 組合的清單，範例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
defaultLocale

string

必要欄位。代理程式的預設語言代碼。必須與 conversationalSettings 中定義的語言代碼相符。
primaryAgentInteraction

object (SupportedAgentInteraction)

必要欄位。主要服務專員互動資訊。在使用者發起對話時使用。
additionalAgentInteractions[]

object (SupportedAgentInteraction)

選用設定。其他服務專員互動資訊。可讓代理程式支援多種互動類型。
customAgentId

string

選用設定。代理程式的合作夥伴指定 ID。這個 ID 會與傳送至代理程式的所有訊息一併傳遞。
agentTestUrl
(deprecated)

string

僅供輸出。用於測試代理程式對話體驗的網址。

由平台定義。
testUrls[]

object (TestUrl)

僅供輸出。用於測試代理程式對話體驗的網址。

由平台定義。
phone

object (Phone)

選用設定。要顯示的服務專員電話號碼。如未指定，代理程式會顯示 Google 知識圖譜中找到的品牌電話號碼 (如有)。
authorizationConfig

object (AuthorizationConfig)

選用設定。OAuth 支援服務的授權設定。
nonLocalConfig

object (NonLocalConfig)

選用設定。非本機進入點的設定。
surveyConfig

object (SurveyConfig)

選用設定。啟用自訂問卷調查的設定。

BusinessMessagesEntryPointConfig

代理程式的進入點設定。

JSON 表示法 
{
  "allowedEntryPoint": enum (EntryPoint)
}
欄位
allowedEntryPoint

enum (EntryPoint)

必要欄位。允許顯示服務專員的 Google 途徑。

EntryPoint

允許顯示服務專員的 Google 途徑。

列舉
ENTRY_POINT_UNSPECIFIED 未指定進入點。
LOCATION 為這個服務專員啟用定位功能。
NON_LOCAL 針對非本機進入點啟用 Business Messages。

SupportedAgentInteraction

代理程式支援的互動。

JSON 表示法 
{
  "interactionType": enum (InteractionType),

  // Union field representative can be only one of the following:
  "botRepresentative": {
    object (BotRepresentative)
  },
  "humanRepresentative": {
    object (HumanRepresentative)
  }
  // End of list of possible types for union field representative.
}
欄位
interactionType

enum (InteractionType)

必要欄位。代理程式支援的互動類型。
聯集欄位 representative。設定類型的詳細資訊。必要欄位。representative 只能是下列其中一項：
botRepresentative

object (BotRepresentative)

機器人代表詳細資料。
humanRepresentative

object (HumanRepresentative)

真人代表詳細資料。

InteractionType

代理程式支援的互動類型。

列舉
INTERACTION_TYPE_UNSPECIFIED 未指定的互動。
BOT 與機器人互動。
HUMAN 人為互動。

BotRepresentative

機器人代表詳細資料。

JSON 表示法 
{
  "botMessagingAvailability": {
    object (MessagingAvailability)
  }
}
欄位
botMessagingAvailability

object (MessagingAvailability)

必要欄位。機器人訊息功能適用情形。

MessagingAvailability

一週內每天的營業時間。您可以將多個日子的營業時間分組。例如：* 太平洋夏令時間週一至週三 08:00 至 16:00 (太平洋夏令時間) * 太平洋夏令時間 10:00–14:00 (太平洋夏令時間) * 星期六至星期六 15:00 至 18:00 (太平洋夏令時間) * 10:00 - 14:00 (太平洋夏令時間)

如果系統沒有提供有空的時間 (例如週日未指定有空時段)，在這段過渡期間，您將無法使用訊息傳送功能。

機器人時數不會影響可用性。僅限機器人的服務專員一律會顯示歡迎訊息，同時具有人類和機器人代表設定的代理程式則在定義可用性時，只會將真人代表納入考量。

JSON 表示法 
{
  "hours": [
    {
      object (Hours)
    }
  ]
}
欄位
hours[]

object (Hours)

必要欄位。可傳送訊息的時間。

小時

提供訊息的時段。

JSON 表示法 
{
  "startTime": {
    object (TimeOfDay)
  },
  "endTime": {
    object (TimeOfDay)
  },
  "timeZone": string,
  "startDay": enum (DayOfWeek),
  "endDay": enum (DayOfWeek)
}
欄位
startTime

object (TimeOfDay)

必要欄位。在星期幾範圍內每天的開始時間。
endTime

object (TimeOfDay)

必要欄位。在星期幾範圍內每天的結束時間。
timeZone

string

必要欄位。時數的 IANA 時區。例如「America/Los_Angeles」。
startDay

enum (DayOfWeek)

必要欄位。開始日期。
endDay

enum (DayOfWeek)

必要欄位。結束日期。包含指定日期。

TimeOfDay

代表一天中的時間。日期和時區並不需要指定，或是在其他位置上指定。API 可選擇允許閏秒。相關類型為 google.type.Date 和 google.protobuf.Timestamp。

JSON 表示法 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
欄位
hours

integer

一天的營業時間，以 24 小時製表示。值應介於 0 到 23 之間。API 可選擇允許使用「24:00:00」這類的值來表示營業打烊時間等情況。
minutes

integer

一天內的分鐘數。值必須介於 0 到 59 之間。
seconds

integer

時間的秒數。正常情況下，值必須介於 0 到 59 之間。如果 API 允許閏秒，則可允許值為 60。
nanos

integer

秒數的小數，以奈秒表示。值必須介於 0 到 999,999,999 之間。

DayOfWeek

代表星期幾。

列舉
DAY_OF_WEEK_UNSPECIFIED 未指定星期幾。
MONDAY 星期一
TUESDAY 週二
WEDNESDAY 週三
THURSDAY 週四
FRIDAY Friday (週五)
SATURDAY Saturday (週六)
SUNDAY 星期日

HumanRepresentative

真人代表詳細資料。

JSON 表示法 
{
  "humanMessagingAvailability": {
    object (MessagingAvailability)
  }
}
欄位
humanMessagingAvailability

object (MessagingAvailability)

必要欄位。支援人為訊息傳送功能。

AuthorizationConfig

支援 Business Messages OAuth 的設定詳細資料。

JSON 表示法 
{
  "endpointUrl": string
}
欄位
endpointUrl

string

使用者登入的端點網址。

NonLocalConfig

啟用非本機進入點的設定。

JSON 表示法 
{
  "contactOption": {
    object (ContactOption)
  },
  "enabledDomains": [
    string
  ],
  "phoneNumber": {
    object (Phone)
  },
  "callDeflectionPhoneNumbers": [
    {
      object (Phone)
    }
  ],
  "regionCodes": [
    string
  ]
}
欄位
contactOption

object (ContactOption)

必要欄位。服務專員的聯絡資訊，這項資訊會與訊息按鈕一起顯示。
enabledDomains[]

string

必要欄位。要啟用網站連結進入點的網域。
phoneNumber

object (Phone)

必要欄位。服務專員的電話號碼。覆寫非本機進入點所發起對話的 phone 欄位。這組電話號碼將用於所有已設定的區域。
callDeflectionPhoneNumbers[]

object (Phone)

必要欄位。來電轉接電話號碼清單。
regionCodes[]

string

必要欄位。CLDR 區碼清單，說明代理程式可在哪些國家/地區啟動 NON_LOCAL 進入點。對 NON_LOCAL 進入點來說為必填。

ContactOption

除了訊息按鈕外，還會顯示聯絡詳細資料。

JSON 表示法 
{
  "url": string,
  "options": [
    enum (Option)
  ]
}
欄位
url

string

必要欄位。可供聯絡選項的網址。
options[]

enum (Option)

必要欄位。指定網址的可用聯絡選項清單。

選項

聯絡選項。

列舉
OPTION_UNSPECIFIED 未指定
WEB_CHAT 網路即時通訊選項。
PHONE 電話選項。
EMAIL 電子郵件選項。
FAQS 常見問題選項。
TWITTER Twitter 選項。
WHATSAPP WhatsApp 選項。

SurveyConfig

支援自訂問卷調查問題的設定詳細資料。

JSON 表示法 
{
  "templateQuestionIds": [
    string
  ],
  "customSurveys": {
    string: {
      object (CustomSurveyConfig)
    },
    ...
  }
}
欄位
templateQuestionIds[]

string

問卷調查中範本問題範本問題 ID 清單。
customSurveys

map (key: string, value: object (CustomSurveyConfig))

服務專員的自訂問卷調查問題 (對應至特定的語言代碼)。語言代碼會以格式正確的 IETF BCP 47 語言標記表示。

這個物件中包含 "key": value 組合的清單，範例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

CustomSurveyConfig

服務專員的自訂問卷調查設定。

JSON 表示法 
{
  "customQuestions": [
    {
      object (SurveyQuestion)
    }
  ]
}
欄位
customQuestions[]

object (SurveyQuestion)

自訂問題清單。

SurveyQuestion

每個問卷調查問題的詳細內容。

JSON 表示法 
{
  "name": string,
  "questionType": enum (Type),
  "questionContent": string,
  "responseOptions": [
    {
      object (SurveyResponse)
    }
  ]
}
欄位
name

string

必要欄位。問題的專屬 ID。
questionType

enum (Type)

僅供輸出。問題類型。
questionContent

string

必要欄位。問題內容。自訂問題上限為 200 個字元。
responseOptions[]

object (SurveyResponse)

必要欄位。顯示問題的回應清單。上限為 12 個。

類型

問卷調查問題的類型。

列舉
TYPE_UNSPECIFIED 問卷調查問題類型不明。
GOOGLE_STANDARD_QUESTION Google 標準問卷調查問題。
GOOGLE_TEMPLATE_QUESTION Google 提供的問卷調查範本。
PARTNER_CUSTOM_QUESTION 合作夥伴自訂問卷調查問題。

SurveyResponse

問卷調查問題回覆的內容。

JSON 表示法 
{
  "content": string,
  "postbackData": string
}
欄位
content

string

必要欄位。使用者在問卷調查中看到的文字，會在使用者輕觸時傳回給服務專員。長度上限為 35 個半形字元。
postbackData

string

使用者輕觸問題回覆時，服務專員會收到的字串。

方法

create

 建立新代理程式來代表品牌。

delete

 刪除代理程式。

get

 取得代理程式相關資訊。

getLaunch

 取得服務專員的發布資訊。

getVerification

 取得服務專員的驗證資訊。

list

 列出與品牌相關聯的所有服務專員。

patch

 更新代理程式的相關資訊。

requestLaunch

 開始代理程式的啟動程序。

requestVerification

 開始為服務專員驗證商家資訊。

updateLaunch

 更新服務專員的推出資訊。

updateVerification

 更新代理程式的驗證狀態。