Method: accounts.hotelViews.list
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
HTTP リクエスト
GET https://travelpartner.googleapis.com/v3/{parent=accounts/*}/hotelViews
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ |
parent |
string
クエリ対象のアカウントのリソース名。形式は accounts/{account_id} です。
|
クエリ パラメータ
パラメータ |
pageSize |
integer
1 つのページで取得する要素の数。
|
pageToken |
string
取得するページのトークン。
|
filter |
string
(省略可)HotelView のフィルタに使用される条件(フィールドと式)。この構文では、in 演算子を囲むスペースが必要です。それ以外の場合は、スペースを省略できます。 条件を結合できません。 hotelId フィールドを使用すると、特定のホテルを選択できます。
liveOnGoogle フィールドでは、Google が表示するプロパティ、または Google 検索結果で省略されているプロパティを選択できます。
matchStatus フィールドを使用すると、アカウントに返された HotelView のリストをフィルタリングできます。
有効な条件の例とその構文は次のとおりです。
hotelId = 'hotel_ABC'
hotelId in ('hotel_ABC', 'hotel_XYZ')
liveOnGoogle = 'TRUE'
liveOnGoogle = 'FALSE'
matchStatus = 'NOT_MATCHED'
matchStatus in ('NOT_MATCHED', 'MATCHED', 'MAP_OVERLAP')
|
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
{
"hotelViews": [
{
object (HotelView )
}
],
"nextPageToken": string
} |
フィールド |
hotelViews[] |
object (HotelView )
クエリに一致する行のリスト。
|
nextPageToken |
string
結果の次のページを取得するために使用されるページ設定トークン。
|
認証スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/travelpartner
詳しくは、OAuth 2.0 の概要をご覧ください。
All rights reserved. Java は Oracle および関連会社の登録商標です。
最終更新日 2022-08-23 UTC。
[null,null,["最終更新日 2022-08-23 UTC。"],[[["\u003cp\u003eRetrieves a list of hotel views associated with a specific account, allowing for filtering and pagination.\u003c/p\u003e\n"],["\u003cp\u003eRequest is made via a GET method to the specified endpoint with required path and optional query parameters.\u003c/p\u003e\n"],["\u003cp\u003eResponse includes an array of hotel views and a token for retrieving subsequent pages if available.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/travelpartner\u003c/code\u003e scope.\u003c/p\u003e\n"]]],[],null,["# Method: accounts.hotelViews.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListHotelViewsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n\nReturns the list of hotel views.\n\n### HTTP request\n\n`GET https://travelpartner.googleapis.com/v3/{parent=accounts/*}/hotelViews`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-------------------------------------------------------------------------------------------------|\n| `parent` | `string` The resource name of the account being queried. The format is `accounts/{account_id}`. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Number of elements to retrieve in a single page. |\n| `pageToken` | `string` Token of the page to retrieve. |\n| `filter` | `string` Optional. The conditions (fields and expressions) used to filter HotelViews. The syntax requires spaces surrounding the `in` operator. Otherwise, spaces can be omitted. Conditions cannot be joined. The `hotelId` field can be used to select specific hotels. The `liveOnGoogle` field can select properties that Google shows, or properties that are omitted in google search results. A value of 'TRUE' includes properties that are conditionally active, e.g. LIVE_ON_GOOGLE_STATUS_ACTIVE_OUTSIDE_DSA_REGION. The `matchStatus` field can be used to filter the list of HotelViews returned for the account. Examples of valid conditions and their syntax are as follows: - `hotelId = 'hotel_ABC'` - `hotelId in ('hotel_ABC', 'hotel_XYZ')` - `liveOnGoogle = 'TRUE'` - `liveOnGoogle = 'FALSE'` - `matchStatus = 'NOT_MATCHED'` - `matchStatus in ('NOT_MATCHED', 'MATCHED', 'MAP_OVERLAP')` |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for [HotelViewService.ListHotelViews](/hotels/hotel-prices/api-reference/rest/v3/accounts.hotelViews/list#google.travel.travelpartner.v3.HotelViewService.ListHotelViews).\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"hotelViews\": [ { object (/hotels/hotel-prices/api-reference/rest/v3/accounts.hotelViews#HotelView) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------|\n| `hotelViews[]` | `object (`[HotelView](/hotels/hotel-prices/api-reference/rest/v3/accounts.hotelViews#HotelView)`)` The list of rows that match the query. |\n| `nextPageToken` | `string` Pagination token used to retrieve the next page of results. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/travelpartner`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]