Index
TimeOfDayRange(message)TimeOfDayWindow(message)ValidTimeException(message)ValidityPeriod(message)ValidityRange(message)ValidityScope(enum)
TimeOfDayRange
[START time_range_definition] A closed-open time range.
| Fields | |
|---|---|
open_time |
A Time indicating the beginning time of the day of the range (inclusive). If not set, it means 00:00:00. Optional. |
close_time |
A Time indicating the ending time of the day of the range (exclusive). If not set, it means 23:59:59. Optional. |
TimeOfDayWindow
The TimeWindow object is a composite entity that describes a list of windows the user's order can be either placed or fulfilled. [START time_window_definition]
| Fields | |
|---|---|
time_windows |
The time window the order can be placed/fulfilled. Required. |
day_of_week[] |
The list of days in a week the windows are applied. If none set, it means that it applies for all days of the week. Optional. |
ValidTimeException
[START valid_time_exception_definition]
| Fields | |
|---|---|
exceptional_period |
The start and end timestamp that the offer is not valid for. These times must represent distinct days i.e. the start time must be 00:00 (beginning of the day) and the end time must be 00:00 (exclusive) on the day the exception period ends. |
ValidityPeriod
[START validity_period_definition]
| Fields | |
|---|---|
valid_period |
The start and end timestamp that the offer is valid for. These times must represent distinct days i.e. the start time must be 00:00 (beginning of the day) and the end time must be 00:00 (exclusive) on the day the validity period ends. |
time_of_day[] |
Specifies the valid time interval on a given day and which days are available for the offer. For timeframes crossing midnight (e.g., 10 PM to 2 AM), use separate windows for each day: one ending at 11:59:59 PM and another starting at 12:00 AM the next day. For example: Monday: 10AM to 5PM Tuesday: 10AM to 2PM Tuesday: 5PM to 7PM Wed, Thur, Fri, Sat, Sun: 3PM to 7PM If none set, it means the offer is available for all time within |
time_exceptions[] |
Specifies exceptions to the above valid_period and valid_time_of_week |
date_exceptions[] |
Specifies exceptions in days to the above valid_period and time_of_day |
validity_scope |
Specifies the scope of the validity period. |
validity_duration_in_days |
The duration (in days) the voucher/coupon is valid for, once purchased. |
ValidityRange
[START validity_range_definition] A closed-open timestamp range.
| Fields | |
|---|---|
valid_from_time |
The beginning time of the range (inclusive). Required. |
valid_through_time |
The ending time of the range (exclusive). If not set, it means that this period is never ending. Optional. |
ValidityScope
[START validity_scope_definition] The scope of the validity period; ie. exactly what actions this validity period applies to.
| Enums | |
|---|---|
VALIDITY_SCOPE_UNSPECIFIED |
|
VALIDITY_SCOPE_CLAIM |
|
VALIDITY_SCOPE_REDEEM |
|