REST Resource: brands.agents

資源：代理程式

代表品牌的對話型實體。

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

  // Union field detail_info can be only one of the following:
  "businessMessagesAgent": {
    object (BusinessMessagesAgent)
  },
  "rcsBusinessMessagingAgent": {
    object (RcsBusinessMessagingAgent)
  }
  // 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 服務專員的詳細資訊
rcsBusinessMessagingAgent

object (RcsBusinessMessagingAgent)

RCS Business Messaging 的服務專員詳細資訊。

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 啟用非當地進入點的商家訊息。

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 星期五
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

必要欄位。可提供服務專員可以啟動 NON_LOCAL 進入點的國家/地區的 CLDR 區碼清單。NON_LOCAL 進入點的必要欄位。

ContactOption

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

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

string

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

enum (Option)

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

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

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

RcsBusinessMessagingAgent

與 RCS Business Messaging 明確相關的服務專員資訊。

JSON 表示法 
{
  "description": string,
  "logoUri": string,
  "heroUri": string,
  "phoneNumbers": [
    {
      object (PhoneEntry)
    }
  ],
  "emails": [
    {
      object (EmailEntry)
    }
  ],
  "websites": [
    {
      object (WebEntry)
    }
  ],
  "privacy": {
    object (WebEntry)
  },
  "termsConditions": {
    object (WebEntry)
  },
  "color": string,
  "billingConfig": {
    object (RcsBusinessMessagingAgentBillingConfig)
  },
  "agentUseCase": enum (AgentUseCase),
  "hostingRegion": enum (HostingRegion)
}
欄位
description

string

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

string

必要欄位。服務專員的標誌公開網址。大小上限為 50 KB。

服務專員驗證完成後即無法修改。
heroUri

string

必要欄位。虛擬服務專員的主頁橫幅網址，開放給大眾使用。大小上限為 200 KB。

服務專員驗證完成後即無法修改。
phoneNumbers[]

object (PhoneEntry)

必要欄位。與服務專員相關聯的電話號碼。
emails[]

object (EmailEntry)

選用設定。與代理程式相關聯的電子郵件地址。
websites[]

object (WebEntry)

選用設定。與虛擬服務專員相關聯的網站。最多 3 個。
privacy

object (WebEntry)

必要欄位。與代理程式相關聯的隱私權政策，
termsConditions

object (WebEntry)

必要欄位。與代理程式相關的條款及細則。
color

string

必要欄位。以十六進位格式形式向使用者顯示的代理程式主題顏色。例如 #FF6347。
billingConfig

object (RcsBusinessMessagingAgentBillingConfig)

必要欄位。代理程式的帳單設定。
agentUseCase

enum (AgentUseCase)

選用設定。機器人的用途。
hostingRegion

enum (HostingRegion)

必要欄位。託管代理程式的區域。

PhoneEntry

與服務專員相關聯的電話號碼。

JSON 表示法 
{
  "phoneNumber": {
    object (Phone)
  },
  "label": string
}
欄位
phoneNumber

object (Phone)

必要欄位。E.164 格式的電話號碼。例如 +12223334444。
label

string

必要欄位。電話號碼的標籤。

EmailEntry

與服務專員相關聯的電子郵件。

JSON 表示法 
{
  "address": string,
  "label": string
}
欄位
address

string

必要欄位。電子郵件地址。
label

string

必要欄位。電子郵件地址的標籤。

WebEntry

與代理程式相關聯的網頁式資源。

JSON 表示法 
{
  "uri": string,
  "label": string
}
欄位
uri

string

必要欄位。與代理程式相關聯的可公開存取 URI。必須使用 HTTP 或 HTTPS 通訊協定。
label

string

選用設定。URI 的標籤。

RcsBusinessMessagingAgentBillingConfig

代理程式的帳單設定。

JSON 表示法 
{
  "billingCategory": enum (BillingCategory)
}
欄位
billingCategory

enum (BillingCategory)

服務專員的帳單類別。

BillingCategory

支援的帳單類別。

列舉
BILLING_CATEGORY_UNSPECIFIED 未指定類別。
CONVERSATIONAL_LEGACY 支援現有代理程式帳單設定的舊版類別。
CONVERSATIONAL 為更長、更複雜的工作階段設計，讓使用者和品牌可以交換一系列訊息。
SINGLE_MESSAGE 提供功能更豐富的簡訊服務。不再以 CONVERSATIONAL 方式收費。
BASIC_MESSAGE 計費模式與簡訊類似。不再以 CONVERSATIONAL 方式收費。

AgentUseCase

儲存空間中使用的代理程式用途類型。

列舉
AGENT_USE_CASE_UNSPECIFIED 未指定用途。
TRANSACTIONAL 只傳送重要、必要且具時效性訊息的服務專員。
PROMOTIONAL 傳送銷售、行銷和促銷訊息的服務專員。預設類型。
OTP 只傳送動態密碼的服務專員。
MULTI_USE 具有多種用途的代理程式。

HostingRegion

代理程式可能的託管區域，用於將 P2A 訊息正確轉送至區域化伺服器。

列舉
HOSTING_REGION_UNSPECIFIED 未指定的託管區域。
NORTH_AMERICA 北美洲
EUROPE 歐洲。
ASIA_PACIFIC 亞太地區。

方法

create

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

delete
(deprecated)

 已淘汰：代理程式刪除功能已淘汰。

get

 取得服務專員相關資訊。

getLaunch

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

getVerification

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

list

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

patch

 更新服務專員相關資訊。

requestLaunch

 開始服務專員的啟動程序。

requestVerification

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

updateLaunch

 更新服務專員的啟動資訊。

updateVerification

 更新服務專員的驗證狀態。