google.walletobjects.v1.offer 软件包

索引

OfferClassService

AddMessage

rpc AddMessage(OfferClassAddMessageRequest) returns (OfferClassAddMessageResponse)

向指定类 ID 引用的优惠类添加消息。

授权范围

需要以下 OAuth 范围：

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

rpc Get(OfferClassGetRequest) returns (OfferClass)

返回具有指定类 ID 的优惠类。

授权范围

需要以下 OAuth 范围：

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

rpc Insert(OfferClassInsertRequest) returns (OfferClass)

插入具有指定 ID 和属性的优惠类。

授权范围

需要以下 OAuth 范围：

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

rpc List(OfferClassListRequest) returns (OfferClassListResponse)

返回指定发卡机构 ID 的所有优惠类的列表。

授权范围

需要以下 OAuth 范围：

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

rpc Patch(OfferClassPatchRequest) returns (OfferClass)

更新指定类 ID 引用的优惠类。此方法支持补丁语义。

授权范围

需要以下 OAuth 范围：

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

rpc Update(OfferClassUpdateRequest) returns (OfferClass)

更新指定类 ID 引用的优惠类。

授权范围

需要以下 OAuth 范围：

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

OfferObjectService

AddMessage

rpc AddMessage(OfferObjectAddMessageRequest) returns (OfferObjectAddMessageResponse)

向指定对象 ID 引用的优惠对象添加消息。

授权范围

需要以下 OAuth 范围：

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

rpc Get(OfferObjectGetRequest) returns (OfferObject)

返回具有指定对象 ID 的优惠对象。

授权范围

需要以下 OAuth 范围：

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

rpc Insert(OfferObjectInsertRequest) returns (OfferObject)

插入具有指定 ID 和属性的优惠对象。

授权范围

需要以下 OAuth 范围：

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

rpc List(OfferObjectListRequest) returns (OfferObjectListResponse)

返回指定发卡机构 ID 的所有优惠对象的列表。

授权范围

需要以下 OAuth 范围：

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

rpc Patch(OfferObjectPatchRequest) returns (OfferObject)

更新指定对象 ID 引用的优惠对象。此方法支持补丁语义。

授权范围

需要以下 OAuth 范围：

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

rpc Update(OfferObjectUpdateRequest) returns (OfferObject)

更新指定对象 ID 引用的优惠对象。

授权范围

需要以下 OAuth 范围：

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

OfferClass

字段
kind
(deprecated)

string

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

string

必填。优惠的标题，例如“购买任一件 T 恤衫八折优惠”。建议的最大长度为 60 个字符，以确保字符串能在较小的屏幕上完整显示。
redemption_channel

RedemptionChannel

必填。适用于此优惠的兑换渠道。
provider

string

必填。优惠提供方（集合商家名称或商家名称）。建议的最大长度为 12 个字符，以确保字符串能在较小的屏幕上完整显示。
title_image

Image

优惠的标题图片。此图片将显示在应用的详细信息视图和列表视图中。
details

string

优惠详情。
fine_print

string

优惠的细则或条款，例如“在亚当服饰店购买任意一件 T 恤即享八折优惠”。
help_uri

Uri

优惠的帮助链接，例如 http://myownpersonaldomain.com/help
localized_title

LocalizedString

已翻译的标题字符串。建议的最大长度为 60 个字符，以确保字符串能在较小的屏幕上完整显示。
localized_provider

LocalizedString

已翻译的提供方字符串。建议的最大长度为 12 个字符，以确保字符串能在较小的屏幕上完整显示。
localized_details

LocalizedString

详情的翻译后字符串。
localized_fine_print

LocalizedString

fine_print 的翻译后字符串。
short_title

string

优惠的标题简写形式，例如“八折优惠”，供用户快速大致了解优惠内容。建议的最大长度为 20 个字符。
localized_short_title

LocalizedString

已翻译的短标题字符串。建议的最大长度为 20 个字符。
class_template_info

ClassTemplateInfo

有关应如何显示类的模板信息。如果未设置，Google 将回退为显示默认字段集。
id

string

必选。类的唯一标识符。此 ID 在一个发卡机构的所有类中必须是唯一的。此值应遵循“issuer ID.identifier”格式，其中发卡机构 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

必选。类的状态。此字段可设置为 draft 或类的状态。此字段可通过插入、修补或更新 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

回调选项，用于在最终用户每次保存/删除此类的对象时回调发卡机构。此类的所有对象都可进行回调。

RedemptionChannel

枚举
REDEMPTION_CHANNEL_UNSPECIFIED
INSTORE
instore

INSTORE 的旧别名。现已弃用。
ONLINE
online

ONLINE 的旧别名，已弃用。
BOTH
both

BOTH 的旧别名，已弃用。
TEMPORARY_PRICE_REDUCTION
temporaryPriceReduction

TEMPORARY_PRICE_REDUCTION 的旧别名，已弃用。

OfferClassAddMessageRequest

字段
resource_id

string

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

AddMessageRequest

请求的正文。

OfferClassAddMessageResponse

字段
resource

OfferClass

更新的 OfferClass 资源。

OfferClassGetRequest

字段
resource_id

string

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

OfferClassInsertRequest

字段
resource

OfferClass

请求的正文。

OfferClassListRequest

字段
issuer_id

int64

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

string

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

int32

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

OfferClassListResponse

字段
resources[]

OfferClass

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

Pagination

响应的分页。

OfferClassPatchRequest

字段
resource_id

string

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

OfferClass

请求的正文。

OfferClassUpdateRequest

字段
resource_id

string

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

OfferClass

请求的正文。

OfferObject

字段
kind
(deprecated)

string

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

OfferClass

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

string

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

string

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

类 ID 应遵循“issuer ID.identifier”格式，其中发卡机构 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。

OfferObjectAddMessageRequest

字段
resource_id

string

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

AddMessageRequest

请求的正文。

OfferObjectAddMessageResponse

字段
resource

OfferObject

更新的 OfferObject 资源。

OfferObjectGetRequest

字段
resource_id

string

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

OfferObjectInsertRequest

字段
resource

OfferObject

请求的正文。

OfferObjectListRequest

字段
class_id

string

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

string

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

int32

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

OfferObjectListResponse

字段
resources[]

OfferObject

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

Pagination

响应的分页。

OfferObjectPatchRequest

字段
resource_id

string

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

OfferObject

请求的正文。

OfferObjectUpdateRequest

字段
resource_id

string

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

OfferObject

请求的正文。