Method: inventory.partners.merchants.services.availability.replace

替换由指定的集合商家管理的商家现有 ServiceAvailability,并将其返回。

HTTP 请求

POST https://mapsbooking.googleapis.com/v1alpha/inventory/{serviceAvailability.name=partners/*/merchants/*/services/*}/availability:replace

网址采用 gRPC 转码语法。

路径参数

参数
serviceAvailability.name

string

要将此参数应用到的服务资源的名称。格式为 partners/{partner_id}/merchants/{merchantId}/services/{serviceId}

请求正文

请求正文中包含结构如下的数据:

JSON 表示法
{
  "serviceAvailability": {
    "name": string,
    "startTimeRestrict": string,
    "endTimeRestrict": string,
    "durationRestrict": string,
    "resourcesRestrict": {
      "staffId": string,
      "staffName": string,
      "roomId": string,
      "roomName": string,
      "partySize": integer,
      "roomDescription": {
        object (Text)
      }
    },
    "availability": [
      {
        "startTime": string,
        "duration": string,
        "spotsTotal": string,
        "spotsOpen": string,
        "availabilityTag": string,
        "resources": {
          object (Resources)
        },
        "paymentOptionId": [
          string
        ],
        "recurrence": {
          object (Recurrence)
        },
        "scheduleException": [
          {
            object (ScheduleException)
          }
        ],
        "deposit": {
          object (Deposit)
        },
        "noShowFee": {
          object (NoShowFee)
        },
        "prepayment": {
          object (Prepayment)
        },
        "requireCreditCard": enum (RequireCreditCard),
        "ticketTypeId": [
          string
        ],
        "durationRequirement": enum (DurationRequirement),
        "schedulingRuleOverrides": {
          object (SchedulingRuleOverrides)
        },
        "confirmationMode": enum (ConfirmationMode),
        "linkoutRequiredReason": enum (LinkoutRequiredReason)
      }
    ]
  }
}
字段
serviceAvailability.startTimeRestrict

string (Timestamp format)

如果提供,我们会将提供的可用性实体视为 [startTimeRestrict, endTimeRestrict] 的完整概况。也就是说,如果符合以下条件,则所有现有可用性都将被删除:

   startTimeRestrict <= availability.start_sec &&
   availability.start_sec < endTimeRestrict

如果设置了 duration 消息,系统会进一步对条件进行限制:

  availability.duration == durationRestrict

如果设置了 resourcesRestrict 消息,系统会进一步对条件进行限制:

   availability.resources.staff_id == resourcesRestrict.staff_id &&
   availability.resources.room_id == resourcesRestrict.room_id

这些字段通常用于对特定时间范围内的可用性进行完整的更新。

已设置 startTimeRestrict 但未设置 endTimeRestrict 时,表示所有时间均从 startTimeRestrict 开始。

时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

serviceAvailability.endTimeRestrict

string (Timestamp format)

已设置 endTimeRestrict 但未设置 startTimeRestrict 时,表示所有时间的结束时间均为 endTimeRestrict。

时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

serviceAvailability.durationRestrict

string (Duration format)

设置持续时间可进一步限制为仅更新与持续时间匹配的可用性。

该时长以秒为单位,最多包含九个小数位,以“s”结尾。示例:"3.5s"

serviceAvailability.resourcesRestrict

object (Resources)

对 resourcesRestrict 进行设置可进一步限制为仅更新该组资源。资源的所有 ID 字段均必须完全匹配。

serviceAvailability.availability[]

object (Availability)

新的可用性列表。

响应正文

可用性列表及其所适用的人员或时间。

如果成功,响应正文将包含结构如下的数据:

JSON 表示法
{
  "name": string,
  "startTimeRestrict": string,
  "endTimeRestrict": string,
  "durationRestrict": string,
  "resourcesRestrict": {
    object (Resources)
  },
  "availability": [
    {
      object (Availability)
    }
  ]
}
字段
name

string

要将此参数应用到的服务资源的名称。格式为 partners/{partner_id}/merchants/{merchantId}/services/{serviceId}

startTimeRestrict

string (Timestamp format)

如果提供,我们会将提供的可用性实体视为 [startTimeRestrict, endTimeRestrict] 的完整概况。也就是说,如果符合以下条件,则所有现有可用性都将被删除:

   startTimeRestrict <= availability.start_sec &&
   availability.start_sec < endTimeRestrict

如果设置了 duration 消息,系统会进一步对条件进行限制:

  availability.duration == durationRestrict

如果设置了 resourcesRestrict 消息,系统会进一步对条件进行限制:

   availability.resources.staff_id == resourcesRestrict.staff_id &&
   availability.resources.room_id == resourcesRestrict.room_id

这些字段通常用于对特定时间范围内的可用性进行完整的更新。

已设置 startTimeRestrict 但未设置 endTimeRestrict 时,表示所有时间均从 startTimeRestrict 开始。

时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

endTimeRestrict

string (Timestamp format)

已设置 endTimeRestrict 但未设置 startTimeRestrict 时,表示所有时间的结束时间均为 endTimeRestrict。

时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

durationRestrict

string (Duration format)

设置持续时间可进一步限制为仅更新与持续时间匹配的可用性。

该时长以秒为单位,最多包含九个小数位,以“s”结尾。示例:"3.5s"

resourcesRestrict

object (Resources)

对 resourcesRestrict 进行设置可进一步限制为仅更新该组资源。资源的所有 ID 字段均必须完全匹配。

availability[]

object (Availability)

新的可用性列表。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/mapsbooking