GetWaitlistEntry メソッド

このメソッドは、指定された順番待ちリストエントリ ID に基づいて、ユーザーの順番待ちリストエントリを返します。 アクション センターはこれを定期的に呼び出して、ユーザーの順番待ちリストのエントリに関する最新情報を取得します。順番待ちリストのエントリは、作成時点から 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 }
  }
}