索引
OfferClassService
(接口)OfferObjectService
(接口)OfferClass
(消息)OfferClass.RedemptionChannel
(枚举)OfferClassAddMessageRequest
(消息)OfferClassAddMessageResponse
(消息)OfferClassGetRequest
(消息)OfferClassInsertRequest
(消息)OfferClassListRequest
(消息)OfferClassListResponse
(消息)OfferClassPatchRequest
(消息)OfferClassUpdateRequest
(消息)OfferObject
(消息)OfferObjectAddMessageRequest
(消息)OfferObjectAddMessageResponse
(消息)OfferObjectGetRequest
(消息)OfferObjectInsertRequest
(消息)OfferObjectListRequest
(消息)OfferObjectListResponse
(消息)OfferObjectPatchRequest
(消息)OfferObjectUpdateRequest
(消息)
OfferClassService
AddMessage | |
---|---|
向指定类 ID 引用的优惠类添加消息。
|
Get | |
---|---|
返回具有指定类 ID 的优惠类。
|
Insert | |
---|---|
插入具有指定 ID 和属性的优惠类。
|
List | |
---|---|
返回指定发卡机构 ID 的所有优惠类的列表。
|
Patch | |
---|---|
更新指定类 ID 引用的优惠类。此方法支持补丁语义。
|
Update | |
---|---|
更新指定类 ID 引用的优惠类。
|
OfferObjectService
AddMessage | |
---|---|
向指定对象 ID 引用的优惠对象添加消息。
|
Get | |
---|---|
返回具有指定对象 ID 的优惠对象。
|
Insert | |
---|---|
插入具有指定 ID 和属性的优惠对象。
|
List | |
---|---|
返回指定发卡机构 ID 的所有优惠对象的列表。
|
Patch | |
---|---|
更新指定对象 ID 引用的优惠对象。此方法支持补丁语义。
|
Update | |
---|---|
更新指定对象 ID 引用的优惠对象。
|
OfferClass
字段 | |
---|---|
kind |
指明资源的种类。值:固定字符串 |
title |
必填。优惠的标题,例如“购买任一件 T 恤衫八折优惠”。建议的最大长度为 60 个字符,以确保字符串能在较小的屏幕上完整显示。 |
redemption_channel |
必填。适用于此优惠的兑换渠道。 |
provider |
必填。优惠提供方(集合商家名称或商家名称)。建议的最大长度为 12 个字符,以确保字符串能在较小的屏幕上完整显示。 |
title_image |
优惠的标题图片。此图片将显示在应用的详细信息视图和列表视图中。 |
details |
优惠详情。 |
fine_print |
优惠的细则或条款,例如“在亚当服饰店购买任意一件 T 恤即享八折优惠”。 |
help_uri |
优惠的帮助链接,例如 |
localized_title |
已翻译的标题字符串。建议的最大长度为 60 个字符,以确保字符串能在较小的屏幕上完整显示。 |
localized_provider |
已翻译的提供方字符串。建议的最大长度为 12 个字符,以确保字符串能在较小的屏幕上完整显示。 |
localized_details |
详情的翻译后字符串。 |
localized_fine_print |
fine_print 的翻译后字符串。 |
short_title |
优惠的标题简写形式,例如“八折优惠”,供用户快速大致了解优惠内容。建议的最大长度为 20 个字符。 |
localized_short_title |
已翻译的短标题字符串。建议的最大长度为 20 个字符。 |
class_template_info |
有关应如何显示类的模板信息。如果未设置,Google 将回退为显示默认字段集。 |
id |
必选。类的唯一标识符。此 ID 在一个发卡机构的所有类中必须是唯一的。此值应遵循“issuer ID.identifier”格式,其中发卡机构 ID 由 Google 提供,标识符由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。 |
version |
已弃用 |
issuer_name |
必选。发行机构名称。建议的最大长度为 20 个字符,以确保字符串能在较小的屏幕上完整显示。 |
messages[] |
在应用中显示的一组消息。此对象的所有用户都将收到其关联消息。这些字段的数量上限为 10。 |
allow_multiple_users_per_object |
已弃用。请改用 |
homepage_uri |
应用首页的 URI。在此字段中填充 URI 的效果与在 linksModuleData 中填充 URI 的效果完全相同(在呈现对象时,显示的首页链接通常被认为是该对象的 linksModuleData 部分)。 |
locations[] |
可使用对象的位置的列表。平台使用此信息来触发发送给用户的地理定位通知。请注意,对象中的位置会替换类中的位置,而类中的位置又会替换 Google 商家信息 ID 中的位置。 |
review_status |
必选。类的状态。此字段可设置为 如果该类尚在开发中,您应将此字段保留为 如果您认为该类可以随时使用,您应将此字段设置为 更新 |
review |
当某个类被标记为 |
info_module_data |
已弃用。请改用 textModulesData。 |
image_modules_data[] |
图片模块数据。从对象级别开始,显示的字段数量上限为 1;对于类对象级别,上限也为 1。 |
text_modules_data[] |
文本模块数据。如果还在类中定义了文本模块数据,则将一并显示这些数据。从对象开始,显示的字段数量上限为 10;对于类,上限也为 10。 |
links_module_data |
链接模块数据。如果还在对象中定义了链接模块数据,则将一并显示这些数据。 |
redemption_issuers[] |
仅适用于支持智能触碰技术的合作伙伴。如需更多指导,请与支持人员联系。 |
country_code |
国家/地区代码,用于在用户不在该国家/地区时显示发卡国家/地区,以及在用户的语言区域未推出该内容时显示本地化的内容。 |
hero_image |
在卡片正面显示的可选横幅图片。如果不存在,则不会显示任何内容。图片将以 100% 宽度显示。 |
word_mark |
已弃用。 |
enable_smart_tap |
仅适用于支持智能触碰技术的合作伙伴。如需更多指导,请与支持人员联系。 |
hex_background_color |
卡片的背景颜色。如果未设置,则使用主打图片的主体色;如果未设置主打图片,则使用徽标的主体色。格式为 #rrggbb,其中 rrggbb 为十六进制 RGB 三元组,例如 |
localized_issuer_name |
已翻译的 issuer_name 字符串。建议的最大长度为 20 个字符,以确保字符串能在较小的屏幕上完整显示。 |
multiple_devices_and_holders_allowed_status |
指明是否允许多个用户和设备保存引用该类的同一个对象。 |
callback_options |
回调选项,用于在最终用户每次保存/删除此类的对象时回调发卡机构。此类的所有对象都可进行回调。 |
RedemptionChannel
枚举 | |
---|---|
REDEMPTION_CHANNEL_UNSPECIFIED |
|
INSTORE |
|
instore |
|
ONLINE |
|
online |
|
BOTH |
|
both |
|
TEMPORARY_PRICE_REDUCTION |
|
temporaryPriceReduction |
|
OfferClassAddMessageRequest
字段 | |
---|---|
resource_id |
类的唯一标识符。此 ID 在一个发卡机构的所有类中必须是唯一的。此值应遵循“issuer ID.identifier”格式,其中发卡机构 ID 由 Google 提供,标识符由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。 |
add_message_request |
请求的正文。 |
OfferClassAddMessageResponse
字段 | |
---|---|
resource |
更新的 OfferClass 资源。 |
OfferClassGetRequest
字段 | |
---|---|
resource_id |
类的唯一标识符。此 ID 在一个发卡机构的所有类中必须是唯一的。此值应遵循“issuer ID.identifier”格式,其中发卡机构 ID 由 Google 提供,标识符由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。 |
OfferClassInsertRequest
字段 | |
---|---|
resource |
请求的正文。 |
OfferClassListRequest
字段 | |
---|---|
issuer_id |
有权列出类的发卡机构的 ID。 |
token |
如果已指定 |
max_results |
确定列表返回的结果数上限。如果未定义 |
OfferClassListResponse
字段 | |
---|---|
resources[] |
与列表请求相对应的资源。 |
pagination |
响应的分页。 |
OfferClassPatchRequest
字段 | |
---|---|
resource_id |
类的唯一标识符。此 ID 在一个发卡机构的所有类中必须是唯一的。此值应遵循“issuer ID.identifier”格式,其中发卡机构 ID 由 Google 提供,标识符由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。 |
resource |
请求的正文。 |
OfferClassUpdateRequest
字段 | |
---|---|
resource_id |
类的唯一标识符。此 ID 在一个发卡机构的所有类中必须是唯一的。此值应遵循“issuer ID.identifier”格式,其中发卡机构 ID 由 Google 提供,标识符由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。 |
resource |
请求的正文。 |
OfferObject
字段 | |
---|---|
kind |
指明资源的种类。值:固定字符串 |
class_reference |
父类的继承字段的副本。执行 GET 操作期间会检索这些字段。 |
id |
必填。对象的唯一标识符。此 ID 在一个发卡机构的所有对象中必须是唯一的。此值应遵循“issuer ID.identifier”格式,其中发卡机构 ID 由 Google 提供,标识符由您自行选择。该唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。 |
class_id |
必选。与此对象关联的类。该类必须与此对象具有相同的类型、已存在且已获批准。 类 ID 应遵循“issuer ID.identifier”格式,其中发卡机构 ID 由 Google 提供,标识符由您自行选择。 |
version |
已弃用 |
state |
必选。对象的状态。此字段用于确定对象在应用中的显示方式。例如,系统会将 |
barcode |
条形码的类型和值。 |
messages[] |
在应用中显示的一组消息。此对象的所有用户都将收到其关联消息。这些字段的数量上限为 10。 |
valid_time_interval |
此对象处于 |
locations[] |
可使用对象的位置的列表。平台使用此信息来触发发送给用户的地理定位通知。请注意,对象中的位置会替换类中的位置,而类中的位置又会替换 Google 商家信息 ID 中的位置。 |
has_users |
指明对象是否具有用户。此字段由平台设置。 |
smart_tap_redemption_value |
仅适用于支持智能触碰技术的合作伙伴。如需更多指导,请与支持人员联系。 |
has_linked_device |
指明此对象当前是否已关联到某个设备。当用户保存对象并将其关联到自己的设备时,平台会设置此字段。此字段仅供部分合作伙伴使用。如需获取更多信息,请与支持人员联系。 |
disable_expiration_notification |
指明是否明确禁止通知。如果此字段设置为 true,则无论 此属性目前仅可用于设置优惠对象。 |
info_module_data |
已弃用。请改用 textModulesData。 |
image_modules_data[] |
图片模块数据。从对象级别开始,显示的字段数量上限为 1;对于类对象级别,上限也为 1。 |
text_modules_data[] |
文本模块数据。如果还在类中定义了文本模块数据,则将一并显示这些数据。从对象开始,显示的字段数量上限为 10;对于类,上限也为 10。 |
links_module_data |
链接模块数据。如果还在类中定义了链接模块数据,则将一并显示这些数据。 |
app_link_data |
有关合作伙伴应用链接的可选信息。 |
OfferObjectAddMessageRequest
字段 | |
---|---|
resource_id |
对象的唯一标识符。此 ID 在一个发卡机构的所有对象中必须是唯一的。此值应遵循“issuer ID.identifier”格式,其中发卡机构 ID 由 Google 提供,标识符由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。 |
add_message_request |
请求的正文。 |
OfferObjectAddMessageResponse
字段 | |
---|---|
resource |
更新的 OfferObject 资源。 |
OfferObjectGetRequest
字段 | |
---|---|
resource_id |
对象的唯一标识符。此 ID 在一个发卡机构的所有对象中必须是唯一的。此值应遵循“issuer ID.identifier”格式,其中发卡机构 ID 由 Google 提供,标识符由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。 |
OfferObjectInsertRequest
字段 | |
---|---|
resource |
请求的正文。 |
OfferObjectListRequest
字段 | |
---|---|
class_id |
要列出其对象的类的 ID。 |
token |
如果已指定 |
max_results |
确定列表返回的结果数上限。如果未定义 |
OfferObjectListResponse
字段 | |
---|---|
resources[] |
与列表请求相对应的资源。 |
pagination |
响应的分页。 |
OfferObjectPatchRequest
字段 | |
---|---|
resource_id |
对象的唯一标识符。此 ID 在一个发卡机构的所有对象中必须是唯一的。此值应遵循“issuer ID.identifier”格式,其中发卡机构 ID 由 Google 提供,标识符由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。 |
resource |
请求的正文。 |
OfferObjectUpdateRequest
字段 | |
---|---|
resource_id |
对象的唯一标识符。此 ID 在一个发卡机构的所有对象中必须是唯一的。此值应遵循“issuer ID.identifier”格式,其中发卡机构 ID 由 Google 提供,标识符由您自行选择。您的唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。 |
resource |
请求的正文。 |