- Yêu cầu HTTP
- Tham số đường dẫn
- Tham số truy vấn
- Nội dung yêu cầu
- Nội dung phản hồi
- Phạm vi cấp phép
- PropertyPerformanceResult
- Cửa sổ đặt trước
- Thời lượng lưu trú
- Sức chứa
Cung cấp khả năng truy vấn (nhận, lọc và phân đoạn) một báo cáo về đường liên kết hiệu suất của cơ sở lưu trú cho một tài khoản cụ thể.
Yêu cầu HTTP
GET https://travelpartner.googleapis.com/v3/{name=accounts/*}/propertyPerformanceReportViews:query
URL sử dụng cú pháp Chuyển mã gRPC.
Tham số đường dẫn
Các tham số | |
---|---|
name |
Tên tài nguyên của tài khoản đang được truy vấn. Định dạng: accounts/{account_id} |
Tham số truy vấn
Các tham số | |
---|---|
filter |
Các điều kiện (trường và biểu thức) dùng để lọc chỉ số hiệu suất của tài sản cho tài khoản đang được truy vấn. Cú pháp này yêu cầu khoảng trắng xung quanh toán tử Trường Các giá trị của trường Các giá trị của Ví dụ về các điều kiện hợp lệ như sau:
|
aggregateBy |
Chỉ định cách phân đoạn các chỉ số mà truy vấn trả về. Ví dụ: nếu bạn chỉ định Giá trị chuỗi là một danh sách các trường được phân tách bằng dấu phẩy. Các trường hợp lệ là: |
pageSize |
Số lượng kết quả tham gia tối đa được trả về. Dịch vụ có thể trả về ít hơn giá trị này. Nếu không chỉ định, tối đa 10.000 kết quả sẽ được trả về. Giá trị tối đa là 10.000; các giá trị trên 10.000 sẽ bị ép buộc thành 10.000. |
pageToken |
Mã thông báo trang, nhận được từ yêu cầu engagementReportView.query trước đó. Cung cấp mã này để nhận trang tiếp theo. Khi phân trang, tất cả các thông số khác được cung cấp cho engagementReportViews.query phải khớp với lệnh gọi đã cung cấp mã thông báo trang. |
Nội dung yêu cầu
Nội dung yêu cầu phải trống.
Nội dung phản hồi
Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:
Thông báo phản hồi cho PropertyPerformanceReportService.QueryPropertyPerformanceReport
.
Biểu diễn dưới dạng JSON |
---|
{
"results": [
{
object ( |
Các trường | |
---|---|
results[] |
Danh sách kết quả phù hợp với truy vấn. |
nextPageToken |
Mã phân trang được dùng để truy xuất trang kết quả tiếp theo. Nếu trường này bị bỏ qua, thì sẽ không có trang nào tiếp theo. |
Phạm vi cấp phép
Yêu cầu phạm vi OAuth sau:
https://www.googleapis.com/auth/travelpartner
Để biết thêm thông tin, hãy xem Tổng quan về OAuth 2.0.
Kết quả hoạt động của thuộc tính
Đại diện cho kết quả khi truy vấn báo cáo hiệu suất của tài sản cho một tài khoản.
Biểu diễn dưới dạng JSON |
---|
{ "date": { object ( |
Các trường | |
---|---|
date |
Một ngày trong phạm vi ngày được yêu cầu. Chỉ xuất hiện nếu |
advanceBookingWindow |
Sự khác biệt về số ngày giữa ngày truy vấn và ngày nhận phòng theo múi giờ địa phương của cơ sở lưu trú. Chỉ xuất hiện nếu |
brand |
Thương hiệu do đối tác chỉ định cho tài sản. Chỉ xuất hiện nếu |
deviceType |
Loại thiết bị của người dùng. Chỉ xuất hiện nếu |
highIntentUsers |
Cụm từ tìm kiếm của người dùng có cho thấy mối quan tâm lớn đến việc đặt phòng hay không. Chỉ xuất hiện nếu |
lengthOfStay |
Số đêm giữa ngày nhận phòng và ngày trả phòng do người dùng chỉ định. Chỉ xuất hiện nếu |
propertyRegionCode |
Mã vùng ISO 3116 của quốc gia/khu vực của cơ sở lưu trú. Chỉ hiển thị nếu |
occupancy |
Số lượng người được yêu cầu lưu trú tại cơ sở lưu trú. Chỉ xuất hiện nếu |
partnerPropertyId |
Mã tài sản của đối tác. Chỉ xuất hiện nếu |
partnerPropertyDisplayName |
Tên cơ sở lưu trú của đối tác. Chỉ xuất hiện nếu |
userRegionCode |
Mã vùng ISO 3116 của quốc gia/khu vực của người dùng. Chỉ hiển thị nếu |
clickCount |
Tổng số lượt nhấp được ghi lại cho kết quả này. |
impressionCount |
Tổng số lượt hiển thị được ghi lại cho kết quả này. Giá trị này được làm tròn để bảo vệ quyền riêng tư của người dùng. |
clickthroughRate |
Bằng |
Đặt trước
Liệt kê các thời hạn đặt trước (ABW) được hỗ trợ. Tất cả thông tin so sánh ngày đều theo múi giờ của tài sản.
Enum | |
---|---|
ADVANCE_BOOKING_WINDOW_UNSPECIFIED |
Chưa chỉ định. |
ADVANCE_BOOKING_WINDOW_SAME_DAY |
Ngày nhận phòng giống với ngày truy vấn. |
ADVANCE_BOOKING_WINDOW_NEXT_DAY |
Ngày nhận phòng là ngày tiếp theo sau ngày truy vấn. |
ADVANCE_BOOKING_WINDOW_DAYS_2_TO_7 |
Ngày nhận phòng là 2–7 ngày sau ngày truy vấn. |
ADVANCE_BOOKING_WINDOW_DAYS_8_TO_14 |
Ngày nhận phòng là từ 8 đến 14 ngày sau ngày truy vấn. |
ADVANCE_BOOKING_WINDOW_DAYS_15_TO_30 |
Ngày nhận phòng là 15 – 30 ngày sau ngày truy vấn. |
ADVANCE_BOOKING_WINDOW_DAYS_31_TO_60 |
Ngày nhận phòng là 31-60 ngày sau ngày truy vấn. |
ADVANCE_BOOKING_WINDOW_DAYS_61_TO_90 |
Ngày nhận phòng là 61-90 ngày sau ngày truy vấn. |
ADVANCE_BOOKING_WINDOW_DAYS_91_TO_120 |
Ngày nhận phòng là 91-120 ngày sau ngày truy vấn. |
ADVANCE_BOOKING_WINDOW_DAYS_121_TO_150 |
Ngày nhận phòng là 121 – 150 ngày sau ngày truy vấn. |
ADVANCE_BOOKING_WINDOW_DAYS_151_TO_180 |
Ngày nhận phòng là 151 – 180 ngày sau ngày truy vấn. |
ADVANCE_BOOKING_WINDOW_DAYS_OVER_180 |
Ngày nhận phòng đã quá 180 ngày kể từ ngày truy vấn. |
Thời gian lưu trú
Liệt kê thời gian lưu trú được hỗ trợ (LOS).
Enum | |
---|---|
LENGTH_OF_STAY_UNSPECIFIED |
Chưa chỉ định. |
LENGTH_OF_STAY_NIGHTS_1 |
Ở lại một đêm. |
LENGTH_OF_STAY_NIGHTS_2 |
Ở lại 2 đêm. |
LENGTH_OF_STAY_NIGHTS_3 |
Lưu trú 3 đêm. |
LENGTH_OF_STAY_NIGHTS_4_TO_7 |
Lưu trú từ 4 đến 7 đêm. |
LENGTH_OF_STAY_NIGHTS_8_TO_14 |
Lưu trú từ 8 đến 14 đêm. |
LENGTH_OF_STAY_NIGHTS_15_TO_21 |
Lưu trú từ 15 đến 21 đêm. |
LENGTH_OF_STAY_NIGHTS_22_TO_30 |
Lưu trú từ 22 đến 30 đêm. |
LENGTH_OF_STAY_NIGHTS_OVER_30 |
Lưu trú trên 30 đêm. |
Người trong nhà
Liệt kê tổng số lượng phòng được hỗ trợ.
Enum | |
---|---|
OCCUPANCY_UNSPECIFIED |
Chưa chỉ định. |
OCCUPANCY_1 |
Một người. |
OCCUPANCY_2 |
Hai người. |
OCCUPANCY_3 |
Ba người. |
OCCUPANCY_4 |
Bốn người. |
OCCUPANCY_OVER_4 |
Hơn 4 người. |