google.walletobjects.v1.loyalty 套件

透過集合功能整理內容 你可以依據偏好儲存及分類內容。

索引

LoyaltyClassService

AddMessage

rpc AddMessage(LoyaltyClassAddMessageRequest) returns (LoyaltyClassAddMessageResponse)

新增訊息至指定類別 ID 參照的會員類別。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer
Get

rpc Get(LoyaltyClassGetRequest) returns (LoyaltyClass)

傳回具有指定類別 ID 的會員類別。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer
Insert

rpc Insert(LoyaltyClassInsertRequest) returns (LoyaltyClass)

插入具有指定 ID 和屬性的會員類別。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer
List

rpc List(LoyaltyClassListRequest) returns (LoyaltyClassListResponse)

傳回指定核發機構 ID 的所有會員類別清單。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer
Patch

rpc Patch(LoyaltyClassPatchRequest) returns (LoyaltyClass)

更新指定類別 ID 參照的會員類別。這個方法支援 patch 語意。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer
Update

rpc Update(LoyaltyClassUpdateRequest) returns (LoyaltyClass)

更新指定類別 ID 參照的會員類別。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer

LoyaltyObjectService

AddMessage

rpc AddMessage(LoyaltyObjectAddMessageRequest) returns (LoyaltyObjectAddMessageResponse)

新增訊息至指定物件 ID 參照的會員物件。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer
Get

rpc Get(LoyaltyObjectGetRequest) returns (LoyaltyObject)

傳回具有指定物件 ID 的會員物件。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer
Insert

rpc Insert(LoyaltyObjectInsertRequest) returns (LoyaltyObject)

插入具有指定 ID 和屬性的會員物件。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer
List

rpc List(LoyaltyObjectListRequest) returns (LoyaltyObjectListResponse)

傳回指定核發機構 ID 的所有會員物件清單。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer
ModifyLinkedOfferObjects

rpc ModifyLinkedOfferObjects(LoyaltyObjectModifyLinkedOfferObjectsRequest) returns (LoyaltyObject)

針對具有指定 ID 的會員物件,修改已連結的優惠物件。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer
Patch

rpc Patch(LoyaltyObjectPatchRequest) returns (LoyaltyObject)

更新指定物件 ID 參照的會員物件。這個方法支援 patch 語意。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer
Update

rpc Update(LoyaltyObjectUpdateRequest) returns (LoyaltyObject)

更新指定物件 ID 參照的會員物件。

授權範圍

需要下列 OAuth 範圍:

  • https://www.googleapis.com/auth/wallet_object.issuer

LoyaltyClass

欄位
kind
(deprecated)

string

表示資源的種類。值:固定字串 "walletobjects#loyaltyClass"

program_name

string

必要項目。方案名稱,例如「小明服飾店」。應用程式可能會在前 20 個字元之後顯示省略符號,以確保在較小的螢幕上可顯示完整字串。

account_name_label

string

帳戶名稱標籤,例如「會員名稱」。建議長度上限為 15 個字元,以確保在較小的螢幕上可顯示完整字串。

account_id_label

string

帳戶 ID 標籤,例如「會員 ID」。建議長度上限為 15 個字元,以確保在較小的螢幕上可顯示完整字串。

rewards_tier_label

string

獎勵級別標籤,例如「獎勵級別」。建議長度上限為 9 個字元,以確保在較小的螢幕上可顯示完整字串。

rewards_tier

string

獎勵級別,例如「爍金」或「白金」。建議長度上限為 7 個字元,以確保在較小的螢幕上可顯示完整字串。

localized_program_name

LocalizedString

program_name 的翻譯字串。應用程式可能會在前 20 個字元之後顯示省略符號,以確保在較小的螢幕上可顯示完整字串。

localized_account_name_label

LocalizedString

account_name_label 的翻譯字串。建議長度上限為 15 個字元,以確保在較小的螢幕上可顯示完整字串。

localized_account_id_label

LocalizedString

account_id_label 的翻譯字串。建議長度上限為 15 個字元,以確保在較小的螢幕上可顯示完整字串。

localized_rewards_tier_label

LocalizedString

rewards_tier_label 的翻譯字串。建議長度上限為 9 個字元,以確保在較小的螢幕上可顯示完整字串。

localized_rewards_tier

LocalizedString

rewards_tier 的翻譯字串。建議長度上限為 7 個字元,以確保在較小的螢幕上可顯示完整字串。

secondary_rewards_tier_label

string

次要獎勵級別標籤,例如「獎勵級別」。

localized_secondary_rewards_tier_label

LocalizedString

secondary_rewards_tier_label 的翻譯字串。

secondary_rewards_tier

string

次要獎勵級別,例如「爍金」或「白金」。

localized_secondary_rewards_tier

LocalizedString

secondary_rewards_tier 的翻譯字串。

discoverable_program

DiscoverableProgram

如何在 Google Pay 應用程式中探索類別及將類別例項化的相關資訊。

class_template_info

ClassTemplateInfo

類別顯示方式的範本資訊。如未設定,Google 會恢復為顯示一組預設的欄位。

id

string

必要項目。類別的專屬 ID。特定核發機構的所有類別 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。

version
(deprecated)

int64

已淘汰

issuer_name

string

必要項目。發卡機構名稱。建議長度上限為 20 個字元,以確保在較小的螢幕上可顯示完整字串。

messages[]

Message

應用程式中顯示的訊息陣列。這個物件的所有使用者都會收到與該物件相關聯的訊息。這類欄位的數量上限是 10 個。

allow_multiple_users_per_object
(deprecated)

bool

已淘汰,請改用 multipleDevicesAndHoldersAllowedStatus

homepage_uri

Uri

應用程式首頁的 URI。在這個欄位填入 URI 所產生的行為與在 linksModuleData 填入 URI 相同 (顯示物件時,首頁的連結會顯示在通常視為物件 linksModuleData 區段的地方)。

locations[]

LatLongPoint

可以使用物件的位置清單。平台會使用這項資訊以觸發向使用者顯示的地理位置通知。請注意,物件中的位置會覆寫類別中的位置,類別中的位置會覆寫 Google 地方資訊 ID 中的位置。

review_status

ReviewStatus

必要項目。類別的狀態。可以透過 insert、patch 或 update 的 API 呼叫,將這個欄位設定為 draftunderReview。一旦審查狀態從 draft 變更為其他狀態,就無法再變回 draft

當類別處於發展階段時,這個欄位應保持為 draftdraft 類別無法用於建立任何物件。

如果您確認類別可供使用,則應將此欄位設為 underReview。平台會自動將此欄位設為 approved,這樣就能立即用以建立或遷移物件。

更新已處於 approved 的類別時,請繼續將這個欄位設為 underReview

review

Review

當類別被標示為 approvedrejected 時,平台所設定的審查留言。

info_module_data
(deprecated)

InfoModuleData

已淘汰,請改用 textModulesData。

image_modules_data[]

ImageModuleData

圖片模組資料。這類欄位的顯示數量上限為物件層級 1 個,以及類別物件層級 1 個。

text_modules_data[]

TextModuleData

文字模組資料。如果類別中也定義了文字模組資料,則兩項資料都會顯示。這類欄位的顯示數量上限為來自物件的 10 個,以及來自類別的 10 個。

redemption_issuers[]

int64

僅適用於支援智慧感應功能的合作夥伴。如需其他協助,請聯絡支援小組。

country_code

string

國家/地區代碼,用於顯示卡片的國家/地區 (當使用者不在該國家/地區時),以及用於顯示本地化內容 (當沒有使用者語言代碼適用的內容時)。

hero_image

Image

顯示在卡片正面的選用橫幅圖片。如果未提供,就不會顯示任何圖片。圖片會以 100% 寛度顯示。

word_mark
(deprecated)

Image

已淘汰。

enable_smart_tap

bool

僅適用於支援智慧感應功能的合作夥伴。如需其他協助,請聯絡支援小組。

hex_background_color

string

卡片的背景顏色。如果未設定,將會使用主頁橫幅的主要顏色;如果未設定主頁橫幅,將會使用標誌的主要顏色。格式為 #rrggbb,其中 rrggbb 是採十六進位制的 RGB 三元組,例如 #ffcc00。你也可以使用 RGB 三元組的簡寫版本 #rgb,例如 #fc0

localized_issuer_name

LocalizedString

issuer_name 的翻譯字串。建議長度上限為 20 個字元,以確保在較小的螢幕上可顯示完整字串。

multiple_devices_and_holders_allowed_status

MultipleDevicesAndHoldersAllowedStatus

表示是否有多位使用者和多台裝置會儲存參照這個類別的同一個物件。

callback_options

CallbackOptions

每當使用者儲存/刪除這個類別的物件時,可以使用這些回呼選項來回呼發卡機構。這個類別的所有物件都適用回呼功能。

LoyaltyClassAddMessageRequest

欄位
resource_id

string

類別的專屬 ID。特定核發機構的所有類別 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。

add_message_request

AddMessageRequest

要求的內容。

LoyaltyClassAddMessageResponse

欄位
resource

LoyaltyClass

更新的 LoyaltyClass 資源。

LoyaltyClassGetRequest

欄位
resource_id

string

類別的專屬 ID。特定核發機構的所有類別 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。

LoyaltyClassInsertRequest

欄位
resource

LoyaltyClass

要求的內容。

LoyaltyClassListRequest

欄位
issuer_id

int64

獲授權可列出類別的核發機構 ID。

token

string

如有指定 maxResults,但清單中的類別數量超過 maxResults,則可使用這個項目取得下一組結果。舉例來說,如果您有包含 200 個類別的清單,且您在呼叫清單時 maxResults 是設為 20,清單則會傳回前 20 個類別和一個符記。只要在 maxResults 設為 20 的情況下使用符記再次呼叫清單,即可取得接下來的 20 個類別。

max_results

int32

表示清單傳回的結果數量上限。如未定義 maxResults,則會傳回所有結果。

LoyaltyClassListResponse

欄位
resources[]

LoyaltyClass

與清單要求相對應的資源。

pagination

Pagination

回應的分頁。

LoyaltyClassPatchRequest

欄位
resource_id

string

類別的專屬 ID。特定核發機構的所有類別 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。

resource

LoyaltyClass

要求的內容。

LoyaltyClassUpdateRequest

欄位
resource_id

string

類別的專屬 ID。特定核發機構的所有類別 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。

resource

LoyaltyClass

要求的內容。

LoyaltyObject

欄位
kind
(deprecated)

string

表示資源的種類。值:固定字串 "walletobjects#loyaltyObject"

class_reference

LoyaltyClass

父項類別的沿用欄位副本。這類欄位是在 GET 執行期間擷取的。

account_name

string

會員帳戶持有人名稱,例如「王大明」。建議長度上限為 20 個字元,以確保在較小的螢幕上可顯示完整字串。

account_id

string

會員帳戶 ID。建議長度上限為 20 個字元。

loyalty_points

LoyaltyPoints

會員獎勵點數標籤、餘額和類型。

linked_offer_ids[]

string

與這張會員卡相連結的優惠物件清單。優惠物件必須已存在。

優惠物件 ID 應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。

secondary_loyalty_points

LoyaltyPoints

次要會員獎勵點數標籤、餘額和類型,會與主要會員點數一併顯示。

id

string

必要項目。物件的專屬 ID。特定核發機構的所有物件 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。

class_id

string

必要項目。與這個物件相關聯的類別,必須是與這個物件同類型、已存在,並且經過核准的類別。

類別 ID 應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。

version
(deprecated)

int64

已淘汰

state

State

必要項目。物件的狀態。您可以使用這個欄位來設定物件在應用程式中的顯示情形。舉例來說,inactive 物件會移至「過期的票證」區段。

barcode

Barcode

條碼類型和值。

messages[]

Message

應用程式中顯示的訊息陣列。這個物件的所有使用者都會收到與該物件相關聯的訊息。這類欄位的數量上限是 10 個。

valid_time_interval

TimeInterval

這個物件處於 active 狀態且可供使用的時間範圍。如果過了這段時間範圍,物件的狀態會變成 expired

locations[]

LatLongPoint

可以使用物件的位置清單。平台會使用這項資訊以觸發向使用者顯示的地理位置通知。請注意,物件中的位置會覆寫類別中的位置,類別中的位置會覆寫 Google 地方資訊 ID 中的位置。

has_users

bool

表示這個物件是否有使用者。這個欄位是由平台所設定。

smart_tap_redemption_value

string

僅適用於支援智慧感應功能的合作夥伴。如需其他協助,請聯絡支援小組。

has_linked_device

bool

表示這個物件目前是否已連結至某部裝置。當使用者儲存物件以將物件連結到裝置時,平台會設定這個欄位。適用於特定合作夥伴。詳情請聯絡支援小組。

disable_expiration_notification

bool

表示是否應明確封鎖通知。如果將這個欄位設為 true,無論 messages 欄位的值為何,向使用者發出的到期通知都會遭封鎖。根據預設,這個欄位是設為 false。

目前此項目只能針對優惠進行設定。

info_module_data

InfoModuleData

已淘汰,請改用 textModulesData。

image_modules_data[]

ImageModuleData

圖片模組資料。這類欄位的顯示數量上限為物件層級 1 個,以及類別物件層級 1 個。

text_modules_data[]

TextModuleData

文字模組資料。如果類別中也定義了文字模組資料,則兩項資料都會顯示。這類欄位的顯示數量上限為來自物件的 10 個,以及來自類別的 10 個。

LoyaltyObjectAddMessageRequest

欄位
resource_id

string

物件的專屬 ID。特定核發機構的所有物件 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。

add_message_request

AddMessageRequest

要求的內容。

LoyaltyObjectAddMessageResponse

欄位
resource

LoyaltyObject

更新的 LoyaltyObject 資源。

LoyaltyObjectGetRequest

欄位
resource_id

string

物件的專屬 ID。特定核發機構的所有物件 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。

LoyaltyObjectInsertRequest

欄位
resource

LoyaltyObject

要求的內容。

LoyaltyObjectListRequest

欄位
class_id

string

要列出其物件的類別 ID。

token

string

如有指定 maxResults,但清單中的物件數量超過 maxResults,則可使用這個項目取得下一組結果。舉例來說,如果您有包含 200 個物件的清單,且您在呼叫清單時 maxResults 是設為 20,則清單會傳回前 20 個物件和一個符記。只要在 maxResults 設為 20 的情況下使用符記再次呼叫清單,即可取得接下來的 20 個物件。

max_results

int32

表示清單傳回的結果數量上限。如未定義 maxResults,則會傳回所有結果。

LoyaltyObjectListResponse

欄位
resources[]

LoyaltyObject

與清單要求相對應的資源。

pagination

Pagination

回應的分頁。

LoyaltyObjectModifyLinkedOfferObjectsRequest

欄位
resource_id

string

物件的專屬 ID。特定核發機構的所有物件 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。

modify_linked_offer_objects_request

ModifyLinkedOfferObjectsRequest

會員物件的優惠物件 ID。

LoyaltyObjectPatchRequest

欄位
resource_id

string

物件的專屬 ID。特定核發機構的所有物件 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。

resource

LoyaltyObject

要求的內容。

LoyaltyObjectUpdateRequest

欄位
resource_id

string

物件的專屬 ID。特定核發機構的所有物件 ID 都不得重複。這個值應依循 issuer ID.identifier 的格式,其中前者是由 Google 核發,後者則由你指定。專屬 ID 只能包含英數字元、「.」、「_」或「-」。

resource

LoyaltyObject

要求的內容。

LoyaltyPoints

欄位
label

string

會員點數標籤,例如「點數」。建議長度上限為 9 個字元。

balance

LoyaltyPointsBalance

帳戶持有人的會員點數餘額,例如「500」或「$10.00 美元」。建議長度上限為 7 個字元。這是 loyaltyPointssecondaryLoyaltyPoints 的必填欄位。

localized_label

LocalizedString

標籤的翻譯字串。建議長度上限為 9 個字元。

LoyaltyPointsBalance

欄位
string

string

餘額的字串形式。string、int、double 和 money 這四種子類型只能擇一填入。

int

int32

餘額的整數形式。string、int、double 和 money 這四種子類型只能擇一填入。

double

double

餘額的雙精度浮點數形式。string、int、double 和 money 這四種子類型只能擇一填入。

money

Money

餘額的金額形式。string、int、double 和 money 這四種子類型只能擇一填入。