JSON 表示法 |
---|
{ "type": enum ( |
欄位 | |
---|---|
type |
此條碼的類型。 |
renderEncoding |
條碼的轉譯編碼。如有指定,則會以指定的編碼轉譯條碼。如未提供,則由 Google 選擇最已知的編碼。 |
valuePattern |
字串編碼的條碼值。這個字串支援下列替換項目:* {totp_value_n}:替換為 TOTP 值 (請參閱 TotpDetails.parameters)。* {totp_timestamp_millis}:替換為產生條碼的時間戳記 (自 Epoch 紀元時間起算的毫秒數)。* {totp_timestamp_seconds}:替換為產生條碼的時間戳記 (自 Epoch 紀元時間起算的秒數)。 |
totpDetails |
用來評估 {totp_value_n} 替代項目的詳細資料。 |
alternateText |
選用文字,會覆寫條碼下方顯示的預設文字。這個欄位提供使用者能夠理解的條碼值對應內容,條碼無法掃描時即可派上用場。 |
showCodeText |
條碼為隱藏,需執行點選動作後才會顯示,選填文字。如果票證已啟用智慧感應功能,就會發生這種情形。如果未指定,則由 Google 選擇預設值。 |
initialRotatingBarcodeValues |
僅限輸入。注意:這項功能僅適用於大眾運輸產業。一組選填的初始旋轉條碼值。如此一來,物件就能包含一小部分的條碼。進一步旋轉的條碼值必須透過 UploadRotatingBarcodeValues 端點上傳。 |
TotpDetails
以時間為依據的動態密碼替代設定。詳情請參閱 https://tools.ietf.org/html/rfc6238
JSON 表示法 |
---|
{ "periodMillis": string, "algorithm": enum ( |
欄位 | |
---|---|
periodMillis |
用於產生 TOTP 值的時間間隔 (以毫秒為單位)。 |
algorithm |
用於產生動態密碼的 TOTP 演算法。 |
parameters[] |
每個 {totp_value_*} 替代變數的 TOTP 參數。索引 n 的 TotpParameters 用於替代 {totp_value_n}。 |
TotpAlgorithm
列舉 | |
---|---|
TOTP_ALGORITHM_UNSPECIFIED |
|
TOTP_SHA1 |
RFC 6238 搭配 SHA1 雜湊函式的 TOTP 演算法 |
TotpParameters
鍵和值長度的設定。詳情請參閱 https://www.rfc-editor.org/rfc/rfc4226#section-5.3。
JSON 表示法 |
---|
{ "key": string, "valueLength": integer } |
欄位 | |
---|---|
key |
用於產生 TOTP 值的密鑰,以 Base16 字串編碼。 |
valueLength |
TOTP 值長度 (十進位數字)。 |
RotatingBarcodeValues
包含許多條碼值和開始日期/時間的酬載。
JSON 表示法 |
---|
{ "startDateTime": string, "values": [ string ], "periodMillis": string } |
欄位 | |
---|---|
startDateTime |
必要欄位。第一個條碼的生效日期/時間。條碼會由物件的 RotatingBarcodeValueInfo 定義的 PeriodMillis 旋轉。 日期/時間採用 ISO 8601 擴充格式 (含有偏移量)。時間的精確度可以指定到奈秒。指定偏移值時可以使用秒精確度 (即使偏移秒數並非 ISO 8601 的一部分)。 例如:
|
values[] |
必要欄位。要在條碼中編碼的值。至少須輸入一個值。 |
periodMillis |
必要欄位。每個條碼的有效時間長度。 |