WaitEstimate definition
Stay organized with collections
Save and categorize content based on your preferences.
A WaitEstimate contains information about the current wait for a specific
merchant and party size.
// The range of time for the current estimated seat time for the user. Estimated
// seat time range must change over time when the merchant or partner updates
// their estimates.
message EstimatedSeatTimeRange {
// Required. The lower bound for the range. Expressed as the number of seconds
// since the Unix epoch.
int64 start_seconds = 1;
// Required. The upper bound for the range. Expressed as the number of seconds
// since the Unix epoch.
int64 end_seconds = 2;
}
// Contains fields measuring how long (in time or # of people) until the
// user is ready to leave the waitlist and be seated.
message WaitLength {
// The count of how many other parties are ahead of the user in the waitlist.
// parties_ahead_count must change over time as parties ahead
// in the waitlist are seated or leave the waitlist. Either
// parties_ahead_count or estimated_seat_time_range must be populated. Both
// should be populated.
int32 parties_ahead_count = 1;
// The range of time that the user is estimated to be seated in. Either
// parties_ahead_count or estimated_seat_time_range must be populated. Both
// should be populated.
EstimatedSeatTimeRange estimated_seat_time_range = 2;
}
// The confirmation modes used when joining the waitlist.
enum WaitlistConfirmationMode {
// The confirmation mode was not specified.
// Synchronous confirmation will be assumed.
WAITLIST_CONFIRMATION_MODE_UNSPECIFIED = 0;
// Waitlist entries will be confirmed synchronously.
WAITLIST_CONFIRMATION_MODE_SYNCHRONOUS = 1;
// Waitlist entries will be confirmed asynchronously.
WAITLIST_CONFIRMATION_MODE_ASYNCHRONOUS = 2;
}
// The wait estimate for a particular party size, merchant and service.
message WaitEstimate {
// Required. The party size this wait estimate applies to.
int32 party_size = 1;
// Required. Contains fields measuring how long (in time or # of people) until
// the user is ready to leave the waitlist and be seated.
WaitLength wait_length = 2;
// Required. Indicates whether waitlist entries for this wait estimate will be
// confirmed synchronously or asynchronously. An UNSPECIFIED value will be
// interpreted as synchronous.
WaitlistConfirmationMode waitlist_confirmation_mode = 3;
}
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-20 UTC.
[null,null,["Last updated 2025-05-20 UTC."],[[["\u003cp\u003eA \u003ccode\u003eWaitEstimate\u003c/code\u003e provides real-time wait information for a specific merchant, party size, and service, including estimated seat time and position in the waitlist.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eWaitLength\u003c/code\u003e details the estimated wait time, presented as either a time range (\u003ccode\u003eestimated_seat_time_range\u003c/code\u003e) or the number of parties ahead (\u003ccode\u003eparties_ahead_count\u003c/code\u003e).\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eWaitlistConfirmationMode\u003c/code\u003e specifies how waitlist entries are confirmed, either synchronously or asynchronously, providing flexibility in managing waitlist entries.\u003c/p\u003e\n"]]],["A `WaitEstimate` provides wait information for a specific merchant and party size. It includes a `WaitLength` with `parties_ahead_count` and an `EstimatedSeatTimeRange` with `start_seconds` and `end_seconds`, indicating the estimated seating time. The `WaitlistConfirmationMode` specifies whether waitlist confirmation is synchronous or asynchronous. The `parties_ahead_count` and `estimated_seat_time_range` values update when the waitlist changes. Both should be populated.\n"],null,["# WaitEstimate definition\n\nA WaitEstimate contains information about the current wait for a specific\nmerchant and party size. \n\n```gdscript\n// The range of time for the current estimated seat time for the user. Estimated\n// seat time range must change over time when the merchant or partner updates\n// their estimates.\nmessage EstimatedSeatTimeRange {\n // Required. The lower bound for the range. Expressed as the number of seconds\n // since the Unix epoch.\n int64 start_seconds = 1;\n\n // Required. The upper bound for the range. Expressed as the number of seconds\n // since the Unix epoch.\n int64 end_seconds = 2;\n}\n\n// Contains fields measuring how long (in time or # of people) until the\n// user is ready to leave the waitlist and be seated.\nmessage WaitLength {\n // The count of how many other parties are ahead of the user in the waitlist.\n // parties_ahead_count must change over time as parties ahead\n // in the waitlist are seated or leave the waitlist. Either\n // parties_ahead_count or estimated_seat_time_range must be populated. Both\n // should be populated.\n int32 parties_ahead_count = 1;\n\n // The range of time that the user is estimated to be seated in. Either\n // parties_ahead_count or estimated_seat_time_range must be populated. Both\n // should be populated.\n EstimatedSeatTimeRange estimated_seat_time_range = 2;\n}\n\n// The confirmation modes used when joining the waitlist.\nenum WaitlistConfirmationMode {\n // The confirmation mode was not specified.\n // Synchronous confirmation will be assumed.\n WAITLIST_CONFIRMATION_MODE_UNSPECIFIED = 0;\n\n // Waitlist entries will be confirmed synchronously.\n WAITLIST_CONFIRMATION_MODE_SYNCHRONOUS = 1;\n\n // Waitlist entries will be confirmed asynchronously.\n WAITLIST_CONFIRMATION_MODE_ASYNCHRONOUS = 2;\n}\n\n// The wait estimate for a particular party size, merchant and service.\nmessage WaitEstimate {\n // Required. The party size this wait estimate applies to.\n int32 party_size = 1;\n\n // Required. Contains fields measuring how long (in time or # of people) until\n // the user is ready to leave the waitlist and be seated.\n WaitLength wait_length = 2;\n\n // Required. Indicates whether waitlist entries for this wait estimate will be\n // confirmed synchronously or asynchronously. An UNSPECIFIED value will be\n // interpreted as synchronous.\n WaitlistConfirmationMode waitlist_confirmation_mode = 3;\n}\n```"]]