Replaces the Availability
of an existing Service
of a merchant managed by the specified aggregator, and returns it.
HTTP request
POST https://mapsbooking.googleapis.com/v1alpha/inventory/{serviceAvailability.name=partners/*/merchants/*/services/*}/availability:replace
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
serviceAvailability.name |
The resource name of the service to apply this to. In the format of |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "serviceAvailability": { "name": string, "startTimeRestrict": string, "endTimeRestrict": string, "durationRestrict": string, "resourcesRestrict": { "staffId": string, "staffName": string, "roomId": string, "roomName": string, "partySize": integer }, "availability": [ { "startTime": string, "duration": string, "spotsTotal": string, "spotsOpen": string, "availabilityTag": string, "resources": { object ( |
Fields | |
---|---|
serviceAvailability.startTimeRestrict |
If provided, we will consider the Availability entities provided to be a complete snapshot from [startTimeRestrict, endTimeRestrict). That is, all existing availability will be deleted if the following condition holds true:
If a duration message is set, the condition is further restricted:
If a resourcesRestrict message is set, the condition is further restricted:
These fields are typically used to provide a complete update of availability in a given time range. Setting startTimeRestrict while leaving endTimeRestrict unset is interpreted to mean all time beginning at startTimeRestrict. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
serviceAvailability.endTimeRestrict |
Setting endTimeRestrict while leaving startTimeRestrict unset is interpreted to mean all time up to the endTimeRestrict. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
serviceAvailability.durationRestrict |
Setting duration further restricts the scope of the update to just the availability with matching duration. A duration in seconds with up to nine fractional digits, ending with ' |
serviceAvailability.resourcesRestrict |
Setting resourcesRestrict further restricts the scope of the update to just this set of resources. All id fields of the resources must match exactly. |
serviceAvailability.availability[] |
The new list of availability. |
Response body
If successful, the response body contains data with the following structure:
A list of availability and who/when they should be applied to.
JSON representation |
---|
{ "name": string, "startTimeRestrict": string, "endTimeRestrict": string, "durationRestrict": string, "resourcesRestrict": { object ( |
Fields | |
---|---|
name |
The resource name of the service to apply this to. In the format of |
startTimeRestrict |
If provided, we will consider the Availability entities provided to be a complete snapshot from [startTimeRestrict, endTimeRestrict). That is, all existing availability will be deleted if the following condition holds true:
If a duration message is set, the condition is further restricted:
If a resourcesRestrict message is set, the condition is further restricted:
These fields are typically used to provide a complete update of availability in a given time range. Setting startTimeRestrict while leaving endTimeRestrict unset is interpreted to mean all time beginning at startTimeRestrict. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
endTimeRestrict |
Setting endTimeRestrict while leaving startTimeRestrict unset is interpreted to mean all time up to the endTimeRestrict. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
durationRestrict |
Setting duration further restricts the scope of the update to just the availability with matching duration. A duration in seconds with up to nine fractional digits, ending with ' |
resourcesRestrict |
Setting resourcesRestrict further restricts the scope of the update to just this set of resources. All id fields of the resources must match exactly. |
availability[] |
The new list of availability. |
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/mapsbooking