Giftcardobject: addmessage

需要授权

向给定对象 ID 引用的礼品卡对象添加消息。

请求

HTTP 请求

POST https://www.googleapis.com/walletobjects/v1/giftCardObject/resourceId/addMessage

参数

参数名称 说明
路径参数
resourceId string 对象的唯一标识符。此 ID 在一个发卡机构的所有对象中必须是唯一的。此值应遵循 issuer ID.identifier 格式,其中 issuer ID(发卡机构 ID)由 Google 提供,identifier(标识符)由您自行选择。该唯一标识符应仅包含字母数字字符、“.”、“_”或“-”。

授权

此请求需要获得以下范围的授权(详细了解身份验证和授权)。

范围
https://www.googleapis.com/auth/wallet_object.issuer

请求正文

在请求正文中,请提供具有以下结构的数据:

{
  "message": {
    "kind": "walletobjects#walletObjectMessage",
    "header": string,
    "localizedHeader": {
      "kind": "walletobjects#localizedString",
      "translatedValues": [
        {
          "kind": "walletobjects#translatedString",
          "language": string,
          "value": string
        }
      ],
      "defaultValue": {
        "kind": "walletobjects#translatedString",
        "language": string,
        "value": string
      }
    },
    "body": string,
    "localizedBody": {
      "kind": "walletobjects#localizedString",
      "translatedValues": [
        {
          "kind": "walletobjects#translatedString",
          "language": string,
          "value": string
        }
      ],
      "defaultValue": {
        "kind": "walletobjects#translatedString",
        "language": string,
        "value": string
      }
    },
    "displayInterval": {
      "kind": "walletobjects#timeInterval",
      "start": {
        "date": datetime
      },
      "end": {
        "date": datetime
      }
    },
    "id": string,
    "messageType": string
  }
}
属性名称 说明 备注
message nested object 消息的容器对象。
message.kind string 指明资源的类型。值:固定字符串 "walletobjects#walletObjectMessage"
message.header string 消息标头。 可写
message.body string 消息正文。 可写
message.displayInterval nested object 向用户显示消息的时间段。您可以为每条消息定义 startTimeendTime。如果未设置 startTime,在插入 Wallet Object 后会立即显示一条消息。如果未提供 endTime,消息将一直显示在消息列表中。 可写
message.displayInterval.kind string 指明资源的类型。值:固定字符串 "walletobjects#timeInterval"
message.displayInterval.start nested object 时间段的开始时间。

偏移量不是必需属性。如果提供了偏移量并设置了 end 时间,则 end 也必须包含偏移量。
可写
message.displayInterval.start.date datetime RFC 3339 格式的日期和时间。例如,“1985-04-12T23:20:50.52Z”表示世界协调时间 (UTC) 1985 年 4 月 12 日 23 时 20 分 50.52 秒。 可写
message.displayInterval.end nested object 时间段的结束时间。

偏移量不是必需属性。如果提供了偏移量并设置了 start 时间,则 start 也必须包含偏移量。
可写
message.displayInterval.end.date datetime RFC 3339 格式的日期和时间。例如,“1985-04-12T23:20:50.52Z”表示世界协调时间 (UTC) 1985 年 4 月 12 日 23 时 20 分 50.52 秒。 可写
message.id string 与消息关联的 ID。此字段便于进行消息管理。请注意,同一个类/实例中可能有多个消息具有重复的 ID 值,因此必须小心谨慎,为每个消息都选择合理的 ID。 可写
message.localizedHeader nested object 已翻译的消息标头字符串。 可写
message.localizedHeader.kind string 指明资源的类型。值:固定字符串 "walletobjects#localizedString"
message.localizedHeader.translatedValues[] list 包含字符串的译文。 可写
message.localizedHeader.translatedValues[].kind string 指明资源的类型。值:固定字符串 "walletobjects#translatedString"
message.localizedHeader.translatedValues[].language string 表示 BCP 47 语言标记。示例值为“en-US”、“en-GB”、“de”或“de-AT”。

对于每个类型为 walletobjects#translatedString 的嵌套对象,此属性为必需属性。
可写
message.localizedHeader.translatedValues[].value string 以 UTF-8 编码的已翻译字符串。

对于每个类型为 walletobjects#translatedString 的嵌套对象,此属性为必需属性。
可写
message.localizedHeader.defaultValue nested object 包含在缺少适当翻译时显示的字符串。

对于每个类型为 walletobjects#localizedString 的嵌套对象,此属性为必需属性。
可写
message.localizedHeader.defaultValue.kind string 指明资源的类型。值:固定字符串 "walletobjects#translatedString"
message.localizedHeader.defaultValue.language string 表示 BCP 47 语言标记。示例值为“en-US”、“en-GB”、“de”或“de-AT”。

对于每个类型为 walletobjects#translatedString 的嵌套对象,此属性为必需属性。
可写
message.localizedHeader.defaultValue.value string 以 UTF-8 编码的已翻译字符串。

对于每个类型为 walletobjects#translatedString 的嵌套对象,此属性为必需属性。
可写
message.localizedBody nested object 已翻译的消息正文字符串。 可写
message.localizedBody.kind string 指明资源的类型。值:固定字符串 "walletobjects#localizedString"
message.localizedBody.translatedValues[] list 包含字符串的译文。 可写
message.localizedBody.translatedValues[].kind string 指明资源的类型。值:固定字符串 "walletobjects#translatedString"
message.localizedBody.translatedValues[].language string 表示 BCP 47 语言标记。示例值为“en-US”、“en-GB”、“de”或“de-AT”。

对于每个类型为 walletobjects#translatedString 的嵌套对象,此属性为必需属性。
可写
message.localizedBody.translatedValues[].value string 以 UTF-8 编码的已翻译字符串。

对于每个类型为 walletobjects#translatedString 的嵌套对象,此属性为必需属性。
可写
message.localizedBody.defaultValue nested object 包含在缺少适当翻译时显示的字符串。

对于每个类型为 walletobjects#localizedString 的嵌套对象,此属性为必需属性。
可写
message.localizedBody.defaultValue.kind string 指明资源的类型。值:固定字符串 "walletobjects#translatedString"
message.localizedBody.defaultValue.language string 表示 BCP 47 语言标记。示例值为“en-US”、“en-GB”、“de”或“de-AT”。

对于每个类型为 walletobjects#translatedString 的嵌套对象,此属性为必需属性。
可写
message.localizedBody.defaultValue.value string 以 UTF-8 编码的已翻译字符串。

对于每个类型为 walletobjects#translatedString 的嵌套对象,此属性为必需属性。
可写
message.messageType string 消息的类型。此属性目前仅可用于设置优惠对象。

可接受以下值:
  • expirationNotification”:显示优惠到期通知。displayInterval.start.date 设置了显示通知的时间。最早可设置为到期日的 30 天前。如果指定的时间范围超过此值,则通知将在第 30 天触发。
  • text”:以文本形式在卡片详细信息屏幕上呈现消息。此为默认的消息类型。
可写

响应

如果成功,此方法将返回具有以下结构的响应正文:

{
  "resource": giftcardobject Resource
}
属性名称 说明 备注
resource nested object REST 资源。