可查詢或取得特定帳戶的資源成效連結報表 (取得、篩選及區隔)。
HTTP 要求
GET https://travelpartner.googleapis.com/v3/{name=accounts/*}/propertyPerformanceReportViews:query
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
name |
所查詢帳戶的資源名稱。格式:accounts/{account_id} |
查詢參數
參數 | |
---|---|
filter |
用於篩選所查詢帳戶資源成效指標的條件 (欄位和運算式)。語法必須有
有效的條件範例如下:
|
aggregateBy |
指定如何區隔查詢傳回的指標。舉例來說,如果指定 字串值是以半形逗號分隔的欄位清單。有效欄位包括: |
pageSize |
要傳回的參與結果上限。服務傳回的值可能會低於這個值。如果未指定,則最多傳回 10,000 筆結果。最大值為 10,000;高於 10,000 的值將強制轉換成 10,000。 |
pageToken |
您先前從 engagementReportViews.query 要求收到的頁面權杖,請提供這項資訊,以便接收後續頁面。 進行分頁時,提供給 engagementReportViews.query 的所有其他參數都必須與提供網頁權杖的呼叫相符。 |
要求主體
要求主體必須為空白。
回應主體
如果成功,回應主體即會包含具有以下結構的資料:
「PropertyPerformanceReportService.QueryPropertyPerformanceReport
」的回應訊息。
JSON 表示法 |
---|
{
"results": [
{
object ( |
欄位 | |
---|---|
results[] |
符合查詢的結果清單。 |
nextPageToken |
用於擷取下一頁結果的分頁符記。如果省略這個欄位,就不會有後續頁面。 |
授權範圍
需要下列 OAuth 範圍:
https://www.googleapis.com/auth/travelpartner
詳情請參閱 OAuth 2.0 總覽。
屬性效能結果
代表查詢帳戶的資源成效報表所產生的結果。
JSON 表示法 |
---|
{ "date": { object ( |
欄位 | |
---|---|
date |
在指定日期範圍內的日期範圍。 只有在要求的 |
advanceBookingWindow |
資源當地時區查詢日期與入住日期之間的差異。 只有在要求的 |
brand |
房源的合作夥伴指定品牌。 只有在要求的 |
deviceType |
使用者的裝置類型。 只有在要求的 |
highIntentUsers |
使用者的查詢是否指出他們有強烈的預訂意願。 只有在要求的 |
lengthOfStay |
使用者指定的入住和退房日期之間的入住天數。 只有在要求的 |
propertyRegionCode |
資源所在國家/地區的 ISO 3116 區域代碼。 只有在要求的 |
occupancy |
要求入住飯店的人數。 只有在要求的 |
partnerPropertyId |
合作夥伴的資源 ID。 只有在要求的 |
partnerPropertyDisplayName |
合作夥伴的資源名稱。 只有在要求的 |
userRegionCode |
使用者所在國家/地區的 ISO 3116 區域代碼。 只有在要求的 |
clickCount |
針對這個結果記錄的點擊總數。 |
impressionCount |
針對這個結果記錄的曝光總數。為保障使用者隱私,這個值會四捨五入。 |
clickthroughRate |
等於 |
提前預訂回溯期
採用支援的提前預訂回溯期 (ABW)。所有日期比較結果都會以資源時區為準。
列舉 | |
---|---|
ADVANCE_BOOKING_WINDOW_UNSPECIFIED |
未指定。 |
ADVANCE_BOOKING_WINDOW_SAME_DAY |
入住日期與查詢日期相同。 |
ADVANCE_BOOKING_WINDOW_NEXT_DAY |
入住日期晚於查詢日期的隔天。 |
ADVANCE_BOOKING_WINDOW_DAYS_2_TO_7 |
入住日期是查詢日期後 2 到 7 天。 |
ADVANCE_BOOKING_WINDOW_DAYS_8_TO_14 |
入住日期在查詢日期過後的 8 到 14 天。 |
ADVANCE_BOOKING_WINDOW_DAYS_15_TO_30 |
入住日期是查詢日期的 15 到 30 天。 |
ADVANCE_BOOKING_WINDOW_DAYS_31_TO_60 |
入住日期是查詢日期的 31 到 60 天。 |
ADVANCE_BOOKING_WINDOW_DAYS_61_TO_90 |
入住日期是查詢日期後的 61 到 90 天。 |
ADVANCE_BOOKING_WINDOW_DAYS_91_TO_120 |
入住日期是查詢日期的 91 到 120 天。 |
ADVANCE_BOOKING_WINDOW_DAYS_121_TO_150 |
入住日期是在查詢日期後 121 到 150 天。 |
ADVANCE_BOOKING_WINDOW_DAYS_151_TO_180 |
入住日期是在查詢日期後 151 到 180 天。 |
ADVANCE_BOOKING_WINDOW_DAYS_OVER_180 |
入住日期在查詢日期後超過 180 天。 |
入住天數
列舉支援的入住天數 (LOS)。
列舉 | |
---|---|
LENGTH_OF_STAY_UNSPECIFIED |
未指定。 |
LENGTH_OF_STAY_NIGHTS_1 |
住宿一晚。 |
LENGTH_OF_STAY_NIGHTS_2 |
住宿 2 晚。 |
LENGTH_OF_STAY_NIGHTS_3 |
住宿 3 晚。 |
LENGTH_OF_STAY_NIGHTS_4_TO_7 |
入住 4 至 7 晚。 |
LENGTH_OF_STAY_NIGHTS_8_TO_14 |
住宿 8 至 14 晚。 |
LENGTH_OF_STAY_NIGHTS_15_TO_21 |
住宿 15 晚至 21 晚。 |
LENGTH_OF_STAY_NIGHTS_22_TO_30 |
入住 22 至 30 晚。 |
LENGTH_OF_STAY_NIGHTS_OVER_30 |
住宿超過 30 晚。 |
活動情形
列舉支援的會議室總入座率。
列舉 | |
---|---|
OCCUPANCY_UNSPECIFIED |
未指定。 |
OCCUPANCY_1 |
單人遊戲。 |
OCCUPANCY_2 |
兩人。 |
OCCUPANCY_3 |
三個人。 |
OCCUPANCY_4 |
四人 |
OCCUPANCY_OVER_4 |
超過 4 人。 |