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 引用的会员卡类。此方法支持补丁语义。

授权范围

需要以下 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 引用的会员卡对象。此方法支持补丁语义。

授权范围

需要以下 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 在一个发卡机构的所有类中必须是唯一的。此值应遵循“issuer IDidentifier”格式，其中发卡机构 ID 由 Google 提供，标识符由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。
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

必选。类的状态。此字段可通过插入、修补或更新 API 调用设置为 draft 或 underReview。审核状态从 draft 更改为其他状态后，便无法再改回 draft。

如果该类尚在开发中，您应将此字段保留为 draft。draft 类不能用于创建任何对象。

如果您认为该类可以随时使用，您应将此字段设置为 underReview。平台会将此字段自动设置为 approved，它可以立即用于创建或迁移对象。

更新 approved 类时，您应将此字段始终设置为 underReview。
review

Review

当某个类被标记为 approved 或 rejected 时，由平台设置的评论意见。
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 在一个发卡机构的所有类中必须是唯一的。此值应遵循“issuer IDidentifier”格式，其中发卡机构 ID 由 Google 提供，标识符由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。
add_message_request

AddMessageRequest

请求的正文。

LoyaltyClassAddMessageResponse

字段
resource

LoyaltyClass

更新后的 LoyaltyClass 资源。

LoyaltyClassGetRequest

字段
resource_id

string

类的唯一标识符。此 ID 在一个发卡机构的所有类中必须是唯一的。此值应遵循“issuer IDidentifier”格式，其中发卡机构 ID 由 Google 提供，标识符由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。

LoyaltyClassInsertRequest

字段
resource

LoyaltyClass

请求的正文。

LoyaltyClassListRequest

字段
issuer_id

int64

有权列出类的发卡机构的 ID。
token

string

如果已指定 maxResults，但列表中有多于 maxResults 个的类，则此参数用于获取下一组结果。例如，如果您有一个包含 200 个类的列表，maxResults 设置为 20 时，调用的列表将返回前 20 个类和一个令牌。使用设置为 20 的 maxResults 和令牌再次调用列表，将获取下一组的 20 个类。
max_results

int32

确定列表返回的结果数上限。如果未定义 maxResults，则返回所有结果。

LoyaltyClassListResponse

字段
resources[]

LoyaltyClass

与列表请求相对应的资源。
pagination

Pagination

响应的分页。

LoyaltyClassPatchRequest

字段
resource_id

string

类的唯一标识符。此 ID 在一个发卡机构的所有类中必须是唯一的。此值应遵循“issuer IDidentifier”格式，其中发卡机构 ID 由 Google 提供，标识符由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。
resource

LoyaltyClass

请求的正文。

LoyaltyClassUpdateRequest

字段
resource_id

string

类的唯一标识符。此 ID 在一个发卡机构的所有类中必须是唯一的。此值应遵循“issuer IDidentifier”格式，其中发卡机构 ID 由 Google 提供，标识符由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。
resource

LoyaltyClass

请求的正文。

LoyaltyObject

字段
kind
(deprecated)

string

指明资源的种类。值：固定字符串 "walletobjects#loyaltyObject"。
class_reference

LoyaltyClass

父类的继承字段的副本。执行 GET 操作期间会检索这些字段。
account_name

string

会员帐号持有人姓名，例如“张三”。建议的最大长度为 20 个字符，以确保字符串能在较小的屏幕上完整显示。
account_id

string

会员帐号标识符。建议的最大长度为 20 个字符。
loyalty_points

LoyaltyPoints

会员卡奖励积分的标签、余额和类型。
linked_offer_ids[]

string

与此会员卡关联的优惠对象的列表。优惠对象必须已经存在。

优惠对象 ID 应遵循“issuer IDidentifier”格式，其中发卡机构 ID 由 Google 提供，标识符由您自行选择。
secondary_loyalty_points

LoyaltyPoints

次要会员卡奖励积分的标签、余额和类型。与主要会员卡积分一起显示。
id

string

必选。对象的唯一标识符。此 ID 在一个发卡机构的所有对象中必须是唯一的。此值应遵循“issuer IDidentifier”格式，其中发卡机构 ID 由 Google 提供，标识符由您自行选择。该唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。
class_id

string

必选。与此对象关联的类。该类必须与此对象具有相同的类型、已存在且已获批准。

类 ID 应遵循“issuer IDidentifier”格式，其中发卡机构 ID 由 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 在一个发卡机构的所有对象中必须是唯一的。此值应遵循“issuer IDidentifier”格式，其中发卡机构 ID 由 Google 提供，标识符由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。
add_message_request

AddMessageRequest

请求的正文。

LoyaltyObjectAddMessageResponse

字段
resource

LoyaltyObject

更新后的 LoyaltyObject 资源。

LoyaltyObjectGetRequest

字段
resource_id

string

对象的唯一标识符。此 ID 在一个发卡机构的所有对象中必须是唯一的。此值应遵循“issuer IDidentifier”格式，其中发卡机构 ID 由 Google 提供，标识符由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。

LoyaltyObjectInsertRequest

字段
resource

LoyaltyObject

请求的正文。

LoyaltyObjectListRequest

字段
class_id

string

要列出其对象的类的 ID。
token

string

如果已指定 maxResults，但列表中有多于 maxResults 个的对象，则此参数用于获取下一组结果。例如，如果您有一个包含 200 个对象的列表，maxResults 设置为 20 时，调用的列表将返回前 20 个对象和一个令牌。使用设置为 20 的 maxResults 和令牌再次调用列表，将获取下一组的 20 个对象。
max_results

int32

确定列表返回的结果数上限。如果未定义 maxResults，则返回所有结果。

LoyaltyObjectListResponse

字段
resources[]

LoyaltyObject

与列表请求相对应的资源。
pagination

Pagination

响应的分页。

LoyaltyObjectModifyLinkedOfferObjectsRequest

字段
resource_id

string

对象的唯一标识符。此 ID 在一个发卡机构的所有对象中必须是唯一的。此值应遵循“issuer IDidentifier”格式，其中发卡机构 ID 由 Google 提供，标识符由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。
modify_linked_offer_objects_request

ModifyLinkedOfferObjectsRequest

会员卡对象的优惠对象 ID。

LoyaltyObjectPatchRequest

字段
resource_id

string

对象的唯一标识符。此 ID 在一个发卡机构的所有对象中必须是唯一的。此值应遵循“issuer IDidentifier”格式，其中发卡机构 ID 由 Google 提供，标识符由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。
resource

LoyaltyObject

请求的正文。

LoyaltyObjectUpdateRequest

字段
resource_id

string

对象的唯一标识符。此 ID 在一个发卡机构的所有对象中必须是唯一的。此值应遵循“issuer IDidentifier”格式，其中发卡机构 ID 由 Google 提供，标识符由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。
resource

LoyaltyObject

请求的正文。

LoyaltyPoints

字段
label

string

会员卡积分标签，例如“积分”。建议的最大长度为 9 个字符。
balance

LoyaltyPointsBalance

帐号持有人的会员卡积分余额，例如“500”或“10.00 美元”。建议的最大长度为 7 个字符。对于 loyaltyPoints 和 secondaryLoyaltyPoints，此字段为必需字段。
localized_label

LocalizedString

已翻译的标签字符串。建议的最大长度为 9 个字符。

LoyaltyPointsBalance

字段
string

string

string 类型的余额。只应填充这些子类型（string、int、double、money）之一。
int

int32

integer 类型的余额。只应填充这些子类型（string、int、double、money）之一。
double

double

double 类型的余额。只应填充这些子类型（string、int、double、money）之一。
money

Money

money 类型的余额。只应填充这些子类型（string、int、double、money）之一。