指数
AddMessageRequest
(消息)AppLinkData
(消息)AppLinkData.AppLinkInfo
(消息)AppLinkData.AppLinkInfo.AppTarget
(消息)Barcode
(消息)BarcodeRenderEncoding
(枚举)BarcodeType
(枚举)CallbackOptions
(消息)DateTime
(消息)DiscoverableProgram
(消息)DiscoverableProgram.State
(枚举)DiscoverableProgramMerchantSigninInfo
(消息)DiscoverableProgramMerchantSignupInfo
(消息)DiscoverableProgramMerchantSignupInfo.SharedDataType
(枚举)GroupingInfo
(消息)Image
(消息)ImageModuleData
(消息)ImageUri
(消息)InfoModuleData
(消息)LabelValue
(消息)LabelValueRow
(消息)LatLongPoint
(消息)LinksModuleData
(消息)LocalizedString
(消息)Message
(消息)Message.MessageType
(枚举)ModifyLinkedOfferObjects
(消息)ModifyLinkedOfferObjectsRequest
(消息)Money
(消息)MultipleDevicesAndHoldersAllowedStatus
(枚举)Pagination
(消息)Review
(消息)ReviewStatus
(枚举)State
(枚举)TextModuleData
(消息)TimeInterval
(消息)TranslatedString
(消息)Uri
(消息)
AddMessageRequest
系统在调用 AddMessage 端点时使用的资源。
字段 | |
---|---|
message |
AppLinkData
字段 | |
---|---|
android_app_link_info |
有关合作伙伴应用链接的可选信息。如果包含此字段,则系统会在 Android 客户端上的有价卡券详情中呈现此应用链接模块。 |
ios_app_link_info |
有关合作伙伴应用链接的可选信息。如果包含此字段,则系统会在 iOS 客户端上的有价卡券详情中呈现此应用链接模块。 |
web_app_link_info |
有关合作伙伴应用链接的可选信息。如果包含此字段,则系统会在 Web 客户端上的有价卡券详情中呈现此应用链接模块。 |
AppLinkInfo
字段 | |
---|---|
app_logo_image |
要在应用链接模块中显示的可选图片 |
title |
要在应用链接模块的标题中显示的字符串,必需 |
description |
要在应用链接模块的说明中显示的字符串,必需 |
app_target |
在客户端上打开应用链接模块时要前往的网址。合作伙伴将使用它来打开其网页或者深层链接到其应用。 |
AppTarget
字段 | |
---|---|
target_uri |
条形码
字段 | |
---|---|
kind |
指明资源的种类。值:固定字符串 |
type |
条形码的类型。 |
render_encoding |
条形码的呈现编码。如果指定此字段,条形码会以给定的编码形式呈现。否则,Google 将选择最佳已知编码。 |
value |
条形码中编码的值。 |
alternate_text |
可选文本,将替换条形码下显示的默认文本。此字段用于显示条形码值的人类可读等效值,在无法扫描条形码时使用。 |
show_code_text |
在用户点击前条形码处于隐藏状态的情况下,系统将显示的可选文本。如果卡券启用了智能触碰,就会发生这种情况。如果未指定,则由 Google 选择默认值。 |
BarcodeRenderEncoding
枚举 | |
---|---|
RENDER_ENCODING_UNSPECIFIED |
|
UTF_8 |
条形码的 UTF_8 编码。只有条形码类型 qrCode 才支持此枚举。 |
BarcodeType
枚举 | |
---|---|
BARCODE_TYPE_UNSPECIFIED |
|
AZTEC |
|
aztec |
|
CODE_39 |
|
code39 |
|
CODE_128 |
|
code128 |
|
CODABAR |
|
codabar |
|
DATA_MATRIX |
由黑白两种颜色组成的二维矩阵条形码。单元或模块以正方形或矩形形状排列。 |
dataMatrix |
|
EAN_8 |
|
ean8 |
|
EAN_13 |
|
ean13 |
|
EAN13 |
|
ITF_14 |
14 位 ITF 编码 |
itf14 |
|
PDF_417 |
|
pdf417 |
|
PDF417 |
|
QR_CODE |
|
qrCode |
|
qrcode |
|
UPC_A |
11 位或 12 位数字代码 |
upcA |
|
TEXT_ONLY |
以文本字段的形式呈现该字段。alternateText 字段不可与 textOnly 类型的条形码一起使用。 |
textOnly |
|
CallbackOptions
字段 | |
---|---|
url |
商家配置的 HTTPS 网址。该网址应托管在 HTTPS 上,而 robots.txt 应允许 UserAgent:Google-Valuables 访问该网址路径。 |
DateTime
字段 | |
---|---|
date |
ISO 8601 扩展格式的日期/时间。可能需要偏移量,也可能不需要(请参阅父字段的文档)。指定时间时最高可达到纳秒级精度。偏移量可指定到秒级精度(虽然 ISO 8601 中未以秒为精度指定偏移量)。 例如:
提供偏移量的时间为全球绝对时间。日期/时间将根据用户所在的时区进行调整。例如,对于纽约的用户, 省略了偏移量的时间则为当地日期/时间,表示世界各地的不同时刻。日期/时间将始终采用用户所在的当前时区。例如,对于纽约的用户, |
DiscoverableProgram
有关如何在 Android Pay 应用中发现和实例化该类的信息。此项通过搜索会员卡或礼品卡计划以及扫描或手动输入来完成。
字段 | |
---|---|
merchant_signup_info |
有关能否通过商家网站注册加入此计划并添加有价卡券的信息。在启用 MERCHANT_HOSTED_SIGNUP 的情况下使用。 |
merchant_signin_info |
有关能否通过商家网站登录此计划并添加有价卡券的信息。在启用 MERCHANT_HOSTED_SIGNIN 的情况下使用。 |
state |
可发现的计划的公开范围状态。 |
State
枚举 | |
---|---|
STATE_UNSPECIFIED |
|
TRUSTED_TESTERS |
仅具有发卡机构帐号访问权限的测试人员才能查看。 |
trustedTesters |
|
LIVE |
所有人都能查看。 |
live |
|
DISABLED |
不显示。 |
disabled |
|
DiscoverableProgramMerchantSigninInfo
有关商家托管的计划登录流程的信息。
字段 | |
---|---|
signin_website |
用于将用户定向至商家登录网站的网址。 |
DiscoverableProgramMerchantSignupInfo
有关商家托管的计划注册流程的信息。
字段 | |
---|---|
signup_website |
用于将用户定向至商家注册网站的网址。 |
signup_shared_datas[] |
通过 POST 请求发送到注册网站网址的用户数据。此信息已编码并共享,以便商家网站能够预填充用户注册加入可发现计划时使用的字段。 |
GroupingInfo
NEXT_ID: 2
字段 | |
---|---|
sort_index |
与其他卡券一起分组时,用于对卡券进行排序的可选索引。 排序索引低的卡券显示在排序索引高的卡券前面。如果未指定,系统会假定该值为 INT_MAX。如果两张卡券的排序索引相同,表明未定义排序行为。 |
Image
Google 托管的图片的封装类型。
字段 | |
---|---|
kind |
指明资源的种类。值:固定字符串 |
source_uri |
图片的 URI。 |
ImageModuleData
字段 | |
---|---|
main_image |
宽度为 100% 的图片。 |
id |
与图片模块关联的 ID。此字段便于管理图片模块。 |
ImageUri
字段 | |
---|---|
uri |
图片的位置。URI 必须要有协议架构。 |
description |
有关图片的附加信息,目前不使用,仅为保证向后兼容性而保留。 |
localized_description |
说明的已翻译字符串,目前不使用,仅为保证向后兼容性而保留。 |
InfoModuleData
字段 | |
---|---|
label_value_rows[] |
标签和值的集合列表。这些标签和值将在一个列中依次显示。 |
show_last_update_time |
|
LabelValue
要在详细信息视图中显示的一对文本字符串。请注意,我们不再将 LabelValue/LabelValueRow 显示为表格,而是显示为项列表。
字段 | |
---|---|
label |
特定行和列的标签。建议双列布局的最大长度为 15 个字符,单列布局的最大长度为 30 个字符。 |
value |
特定行和列的值。建议双列布局的最大长度为 15 个字符,单列布局的最大长度为 30 个字符。 |
localized_label |
已翻译的标签字符串。建议双列布局的最大长度为 15 个字符,单列布局的最大长度为 30 个字符。 |
localized_value |
已翻译的值字符串。建议双列布局的最大长度为 15 个字符,单列布局的最大长度为 30 个字符。 |
LabelValueRow
字段 | |
---|---|
columns[] |
标签和值的列表。无论字段名称是什么,这些标签和值将在一个列(而不是多个列)中依次显示。 |
LatLongPoint
字段 | |
---|---|
kind |
指明资源的种类。值:固定字符串 |
latitude |
纬度,可指定为 -90.0 到 +90.0 范围内的任意值(含两个端点)。超出此范围的值将被拒绝。 |
longitude |
经度,可指定为 -180.0 到 +180.0 范围内的任意值(含两个端点)。超出此范围的值将被拒绝。 |
LinksModuleData
字段 | |
---|---|
uris[] |
URI 列表。 |
LocalizedString
字段 | |
---|---|
kind |
指明资源的种类。值:固定字符串 |
translated_values[] |
包含字符串的译文。 |
default_value |
包含在缺少适当翻译时显示的字符串。 |
Message
消息会随一个有价卡券显示
字段 | |
---|---|
kind |
指明资源的种类。值:固定字符串 |
header |
消息标头。 |
body |
消息正文。 |
display_interval |
向用户显示消息的时间段。您可以为每条消息定义 |
id |
与消息关联的 ID。此字段便于进行消息管理。请注意,同一个类/实例中可能有多条消息具有重复的 ID 值,因此必须小心谨慎,为每条消息选择合理的 ID。 |
message_type |
消息的类型。此属性目前仅可用于设置优惠对象。 |
localized_header |
已翻译的消息标头字符串。 |
localized_body |
已翻译的消息正文字符串。 |
MessageType
枚举 | |
---|---|
MESSAGE_TYPE_UNSPECIFIED |
|
TEXT |
以文本形式在卡片详细信息屏幕上呈现消息。这是默认的消息类型。 |
text |
|
EXPIRATION_NOTIFICATION |
显示优惠到期通知。displayInterval.start.date 设置了显示通知的时间。最早可设置为到期日的 30 天前。如果指定的时间范围超过此值,则通知将在第 30 天触发。 |
expirationNotification |
|
ModifyLinkedOfferObjects
字段 | |
---|---|
add_linked_offer_object_ids[] |
要添加到对象的关联优惠对象 ID。 |
remove_linked_offer_object_ids[] |
要从对象中移除的关联优惠对象 ID。 |
ModifyLinkedOfferObjectsRequest
字段 | |
---|---|
linked_offer_object_ids |
要在对象中添加或移除的关联优惠对象 ID。 |
Money
字段 | |
---|---|
kind |
指明资源的种类。值:固定字符串 |
micros |
金额的单位(以微单位表示)。例如,1 美元将表示为 1000000 个微单位。 |
currency_code |
货币代码,例如“USD”或“EUR”。 |
MultipleDevicesAndHoldersAllowedStatus
枚举 | |
---|---|
STATUS_UNSPECIFIED |
|
MULTIPLE_HOLDERS |
允许多个用户使用多个设备。 |
multipleHolders |
|
ONE_USER_ALL_DEVICES |
允许一个用户使用多个设备。 |
oneUserAllDevices |
|
ONE_USER_ONE_DEVICE |
仅供选定合作伙伴在有限情况下使用。如需获取更多信息,请与支持人员联系。 |
oneUserOneDevice |
|
Pagination
字段 | |
---|---|
kind |
指明资源的种类。值:固定字符串 |
results_per_page |
此页面中返回的结果数。 |
next_page_token |
为了获取下一页面而发出的页面令牌。 |
Review
字段 | |
---|---|
comments |
|
ReviewStatus
枚举 | |
---|---|
REVIEW_STATUS_UNSPECIFIED |
|
UNDER_REVIEW |
|
underReview |
|
APPROVED |
|
approved |
|
REJECTED |
|
rejected |
|
DRAFT |
|
draft |
|
State
枚举 | |
---|---|
STATE_UNSPECIFIED |
|
ACTIVE |
对象处于活动状态并与其他有效对象一同显示。 |
active |
|
COMPLETED |
|
completed |
|
EXPIRED |
对象已失效(超过 validTimeInterval )。 |
expired |
|
INACTIVE |
|
inactive |
|
TextModuleData
文本模块的数据。所有字段均为选填。其中将显示可用的标题,如果定义了不同类型的正文,则会将它们连接起来。
字段 | |
---|---|
header |
文本模块的标头。建议的最大长度为 35 个字符,以确保字符串能在较小的屏幕上完整显示。 |
body |
文本模块的正文,定义为不间断字符串。建议的最大长度为 500 个字符,以确保字符串能在较小的屏幕上完整显示。 |
localized_header |
已翻译的标头字符串。建议的最大长度为 35 个字符,以确保字符串能在较小的屏幕上完整显示。 |
localized_body |
已翻译的正文字符串。建议的最大长度为 500 个字符,以确保字符串能在较小的屏幕上完整显示。 |
id |
与文本模块关联的 ID。 此字段便于管理文本模块。 |
TimeInterval
字段 | |
---|---|
kind |
指明资源的种类。值:固定字符串 |
start |
时间段的开始时间。 偏移量不是必需属性。如果提供了偏移量并设置了 |
end |
时间段的结束时间。 偏移量不是必需属性。如果提供了偏移量并设置了 |
TranslatedString
字段 | |
---|---|
kind |
指明资源的种类。值:固定字符串 |
language |
表示 BCP 47 语言标记。示例值为“en-US”、“en-GB”、“de”或“de-AT”。 |
value |
以 UTF-8 编码的已翻译字符串。 |
URI
字段 | |
---|---|
kind |
指明资源的种类。值:固定字符串 |
uri |
网页、图片或其他资源的位置。 |
description |
在应用中以文本显示的 URI 标题。建议最多为 20 个字符,以确保字符串能在较小的屏幕上完整显示。 请注意,在某些情况下(例如图片包含 |
localized_description |
已翻译的说明字符串。建议最多为 20 个字符,以确保字符串能在较小的屏幕上完整显示。 |
id |
与 URI 关联的 ID。 此字段便于进行 URI 管理。 |