GetWaitlistEntry 方法

這個方法會根據提供的等候名單項目 ID 為使用者傳回等候名單項目。Actions Center 會定期呼叫此方法，取得有關使用者等候名單項目的最新消息。等候名單項目應可擷取自建立時間算起 30 天內。

要求

GetWaitlistEntryRequest

傳回值

GetWaitlistEntryResponse

// Get the waitlist entry corresponding to the provided waitlist entry ID.
message GetWaitlistEntryRequest {
  // Required. The partner-provided waitlist entry ID to request info for.
  string waitlist_entry_id = 1;
}

// Response with the waitlist entry corresponding to the provided
// waitlist entry ID.
message GetWaitlistEntryResponse {
  // Required. The partner-provided information about a user’s waitlist entry.
  WaitlistEntry waitlist_entry = 1;
}

GetWaitlistEntry 範例

取得請求

{ "waitlist_entry_id": "MYS-1668739060" }

取得回覆

{
  "waitlist_entry": {
    "wait_estimate": {
      "party_size": 3,
      "wait_length": { "parties_ahead_count": 3 }
    },
    "waitlist_entry_state": "WAITING",
    "waitlist_entry_state_times": { "created_time_seconds": 1234567890 }
  }
}