- JSON representation
- ActionPlatform
- ActionLinkType
- OrderOnlineMetadata
- FulfillmentOption
- FulfillmentType
- AvailableDay
- Date
- FeeDetails
- NoFee
- MinimumFee
- FixedFee
- FoodOrderingMetadata
- FeeDetails
- FeeType
- FeeAmount
- Money
- MoneyRange
- QuantitativeValue
- RangeValue
- DurationRange
- AdvanceOrderDetails
An action URL with associated language, list of countries restricted to, and optional platform that indicates which platform this action should be performed on.
JSON representation |
---|
{ "url": string, "language": string, "restrictedCountry": [ string ], "platform": enum ( |
Fields | |
---|---|
url |
The entry point URL for this action link. |
language |
The BCP-47 language tag identifying the language in which the content from this URI is available. |
restrictedCountry[] |
ISO 3166-1 alpha-2 country code. Leave empty for unrestricted visibility. |
platform |
The platform that this action should be performed on. If this field is unset, ACTION_PLATFORM_WEB_APPLICATION will be used as fallback. |
actionLinkType |
Predetermined type of action. |
orderOnlineMetadata |
Metadata for the order online link. Supports action with ActionLinkType of ACTION_LINK_TYPE_SHOP_ONLINE. |
foodOrderingMetadata |
Metadata for Food Ordering links. Supports action type: * |
ActionPlatform
The platform that the action is performed on. Web application is the general fallback. It is recommended to have at least one ActionLink with ACTION_PLATFORM_WEB_APPLICATION. Links with Android and iOS as platform are only used on the respective system.
Enums | |
---|---|
ACTION_PLATFORM_UNSPECIFIED |
The platform is unspecified. |
ACTION_PLATFORM_WEB_APPLICATION |
The action platform is web in general. |
ACTION_PLATFORM_MOBILE_WEB |
The action platform is web on mobile devices. |
ACTION_PLATFORM_ANDROID |
The action platform is Android OS. |
ACTION_PLATFORM_IOS |
The action platform is iOS. |
ActionLinkType
Predetermined type of action associated with an action link.
Enums | |
---|---|
ACTION_LINK_TYPE_UNSPECIFIED |
The action link type is unspecified. |
ACTION_LINK_TYPE_BOOK_APPOINTMENT |
The action link type is booking an appointment. |
ACTION_LINK_TYPE_BOOK_ONLINE_APPOINTMENT |
The action link type is booking an online appointment. |
ACTION_LINK_TYPE_ORDER_FOOD |
The action link type is ordering food for delivery or takeout or both. |
ACTION_LINK_TYPE_ORDER_FOOD_DELIVERY |
The action link type is ordering food for delivery. |
ACTION_LINK_TYPE_ORDER_FOOD_TAKEOUT |
The action link type is ordering food for takeout. |
ACTION_LINK_TYPE_MAKE_DINING_RESERVATION |
The action link type is making a dining reservation. |
ACTION_LINK_TYPE_SHOP_ONLINE |
The action link type is ordering for shopping, could be deliver or pickup or both. |
OrderOnlineMetadata
Metadata for an order online action link.
JSON representation |
---|
{
"fulfillmentOption": [
{
object ( |
Fields | |
---|---|
fulfillmentOption[] |
Available fulfillment options for an order online action link. |
FulfillmentOption
The fulfillment option for an order online action link.
JSON representation |
---|
{ "fulfillmentType": enum ( |
Fields | |
---|---|
fulfillmentType |
Required. The fulfillment type. |
availableDay[] |
Required. A list of days on which there is availability for this fulfillment method (preferably at least 2). |
feeDetails |
Required. Fee details for the fulfillment method. |
minimumOrder |
Required. Minimum order for the fulfillment method associated with the action link. |
FulfillmentType
The fulfillment type associated with an action link.
Enums | |
---|---|
FULFILLMENT_TYPE_UNSPECIFIED |
The fulfillment type is unspecified. |
FULFILLMENT_TYPE_DELIVERY |
The fulfillment type is delivery. |
FULFILLMENT_TYPE_PICKUP |
The fulfillment type is pickup. |
AvailableDay
Day level availability.
JSON representation |
---|
{
"fulfillmentDate": {
object ( |
Fields | |
---|---|
fulfillmentDate |
Required. An available date for a fulfillment method. Assumed to be in merchant's timezone. |
lastOrderingTime |
Required. Unix timestamp. The last time a user could order, and receive items by For example, if the fulfillmentDate is 2020-08-10: - a lastOrderingTime value of 2020-08-10 18:00 means that, in order to receive their order on 2020-08-10, a customer must make that order by 6pm that same day. - a lastOrderingTime value of 2020-08-08 20:00 means that, in order to receive their order on 2020-08-10, a customer must make that order by 8pm two days prior. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
Date
Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:
- A full date, with non-zero year, month, and day values.
- A month and day, with a zero year (for example, an anniversary).
- A year on its own, with a zero month and a zero day.
- A year and month, with a zero day (for example, a credit card expiration date).
Related types:
google.type.TimeOfDay
google.type.DateTime
google.protobuf.Timestamp
JSON representation |
---|
{ "year": integer, "month": integer, "day": integer } |
Fields | |
---|---|
year |
Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |
month |
Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |
day |
Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |
FeeDetails
Fee details for the fulfillment method associated with the action link.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field fee_details . Fee model for the fulfillment method. fee_details can be only one of the following: |
|
noFee |
No fee for the fulfillment method. |
baseFee |
The base fee associated with the fulfillment method. |
fixedFee |
The fixed fee associated with the fulfillment method. |
NoFee
No fee required for the fulfillment method associated with the action link.
MinimumFee
The minimum fee required for the fulfillment method associated with the action link.
JSON representation |
---|
{
"baseFeeAmount": {
object ( |
Fields | |
---|---|
baseFeeAmount |
Required. The base fee amount for the fulfillment method. |
FixedFee
The fixed fee required for the fulfillment method associated with the action link.
JSON representation |
---|
{
"amount": {
object ( |
Fields | |
---|---|
amount |
Required. The amount of the fixed fee for the fulfillment method. |
FoodOrderingMetadata
Metadata for food ordering action links.
JSON representation |
---|
{ "feeDetails": [ { object ( |
Fields | |
---|---|
feeDetails[] |
Details of fees charged to the user on top of the item total. Repeated for different types of fees like service fee, delivery fee etc. |
advanceOrderDetails |
Details on advanced ordering support also known as order ahead where user can place an order for fulfillment at a later time than right now. |
Union field fulfillment_duration_options . Order fulfillment time duration from order confirmation. For delivery orders, time duration until the food is delivered. For pickup orders, time duration until the food is ready for pickup. fulfillment_duration_options can be only one of the following: |
|
fulfillmentLeadTimeDuration |
Fixed duration. For example: 30 mins. A duration in seconds with up to nine fractional digits, ending with ' |
fulfillmentLeadTimeDurationRange |
A range of duration. Examples: * 30 mins to 45 mins * Greater than 30 mins * Less than 50 mins |
FeeDetails
Fee details.
JSON representation |
---|
{ "type": enum ( |
Fields | |
---|---|
type |
Fee type. (required) |
feeAmount |
Fee amount either in unit currency, a percentage of the cart value, or a combination of both. (required) |
FeeType
Fee type.
Enums | |
---|---|
FEE_TYPE_UNSPECIFIED |
Fee type unspecified. |
DELIVERY |
For delivery fees. |
SERVICE |
For service fees. |
FeeAmount
FeeAmount
examples: * Fixed fee: USD 0 (no fee), USD 1.5 * Range of fixed fee: USD 1.0 (minimum), USD 3.0 (maximum), USD 5.0-6.0 * Percentage of cart size: 15.5%, 10%-20%, 10% (minimum), 15% (maximum) * Compound of range and percentage: 25.5% & USD 2.5 (minimum), 25.5% & USD 4.5 (maximum), 10% & USD 1.5-2.5, 10.5%-20% & USD 2.5-3.5
JSON representation |
---|
{ "cartPercentage": { object ( |
Fields | |
---|---|
cartPercentage |
Fee in terms of a percentage of the cart value. Supports a range (bounded and unbounded) or a fixed percentage. Value should be between 0 and 100. Examples: * Fixed 5.5% * At least 5.5% * At most 5.5% * 4.5% to 5.5% |
Union field amount_options . Options to specify monetary amount. amount_options can be only one of the following: |
|
amount |
Fixed amount. For example USD 3.5. |
amountRange |
Range of amount. Examples: * USD 3.5 to USD 5.5 * At least USD 3.5 * At most USD 5.5 |
amountUnknown |
Unknown amount. |
Money
Represents an amount of money with its currency type.
JSON representation |
---|
{ "currencyCode": string, "units": string, "nanos": integer } |
Fields | |
---|---|
currencyCode |
The three-letter currency code defined in ISO 4217. |
units |
The whole units of the amount. For example if |
nanos |
Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If |
MoneyRange
Wrapper for a range of monetary amount that could be bounded or unbounded. At least one of minAmount and maxAmount is required.
JSON representation |
---|
{ "minAmount": { object ( |
Fields | |
---|---|
minAmount |
Minimum amount. |
maxAmount |
Maximum amount. |
QuantitativeValue
Wrapper for a numerical value that could be a range or a fixed value. QuantitativeValue
examples: * Singular value: value: 10.5
* Bounded range: valueRange {minValue: 5.5, maxValue 10.5}
* Lower bound: valueRange {minValue: 5.5}
* Upper bound: valueRange {maxValue: 10.5}
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field value_options . (required) value_options can be only one of the following: |
|
value |
A singular value. For example: 5.6 |
valueRange |
A range of values that could also be open ended or bounded. Examples: * At least 5.5 * At most 5.5 * 5.5 to 6.5 |
RangeValue
Range of values such that minValue
< maxValue
. Requires at least one of minValue
and maxValue
.
JSON representation |
---|
{ "minValue": number, "maxValue": number } |
Fields | |
---|---|
minValue |
Minimum value. |
maxValue |
Maximum value. |
DurationRange
Wrapper for a range of duration that can be bounded or unbounded. At least one of minDuration and maxDuration duration is required.
JSON representation |
---|
{ "minDuration": string, "maxDuration": string } |
Fields | |
---|---|
minDuration |
Minimum duration. A duration in seconds with up to nine fractional digits, ending with ' |
maxDuration |
Maximum duration. A duration in seconds with up to nine fractional digits, ending with ' |
AdvanceOrderDetails
For order ahead support.
JSON representation |
---|
{ "isSupported": boolean } |
Fields | |
---|---|
isSupported |
True if Advance Orders, also known as Order Ahead, is supported. (required) |