- 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 uỷ quyền
- PropertyPerformanceResult
- AdvanceBookingWindow
- LengthOfStay
- Số người lưu trú
Cho phép truy vấn (nhận, lọc và phân đoạn) báo cáo đường liên kết đặt phòng miễn phí cho một tài khoản cụ thể. Phiên bản mới này trả về lượt hiển thị và lượt nhấp, cũng như một siêu tập hợp lớn hơn nhiều các bộ lọc/mức độ tổng hợp.
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
| Thông 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
| Thông số | |
|---|---|
filter |
Các điều kiện (trường và biểu thức) được dùng để lọc cá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 phải có khoảng trắng xung quanh toán tử Lưu ý quan trọng: Cú pháp chính xác để thêm nhiều điều kiện là: Bạn bắt buộc phải điền vào trường Các giá trị trường Các giá trị cho Sau đây là ví dụ về các điều kiện hợp lệ:
|
aggregateBy |
Chỉ định cách phân đoạn các chỉ số do 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à: Lưu ý quan trọng: Việc sử dụng tham số |
pageSize |
Số lượng kết quả tham gia tối đa cần 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ị lớn hơn 10.000 sẽ được ép buộc thành 10.000. |
pageToken |
Mã thông báo trang nhận được từ yêu cầu participationReportViews.query trước đó. Cung cấp thông tin này để nhận trang tiếp theo. Khi phân trang, tất cả các tham số khác được cung cấp cho participationReportViews.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
Thông báo phản hồi cho PropertyPerformanceReportService.QueryPropertyPerformanceReport.
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:
| Biểu diễn dưới dạng JSON |
|---|
{
"results": [
{
object ( |
| Trường | |
|---|---|
results[] |
Danh sách kết quả khớp với truy vấn. |
nextPageToken |
Mã thông báo phân trang dùng để truy xuất trang kết quả tiếp theo. Nếu bạn bỏ qua trường này, thì sẽ không có các trang tiếp theo. |
Phạm vi uỷ quyền
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 OAuth 2.0 Overview.
PropertyPerformanceResult
Đại diện cho kết quả từ việc 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 ( |
| 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ố ngày chênh lệch giữa ngày tìm kiếm 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 cơ sở lưu trú. 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 |
Liệu cụm từ tìm kiếm của người dùng có cho thấy họ rất quan tâm đế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 nơi có tài sản. Chỉ xuất hiện nếu |
occupancy |
Số lượng người 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ã khu vực ISO 3116 của quốc gia/khu vực nơi người dùng sinh sống. Chỉ xuất hiện nếu |
clickCount |
Tổng số lượt nhấp vào đường liên kết miễn phí để đặt phòng được ghi nhận cho kết quả này. |
impressionCount |
Tổng số lượt hiển thị của đường liên kết miễn phí để đặt phòng được ghi nhận 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 |
adsClickCount |
Tổng số lượt nhấp vào quảng cáo được ghi nhận cho kết quả này. |
adsImpressionCount |
Tổng số lượt hiển thị quảng cáo được ghi nhận cho kết quả này. |
adsClickthroughRate |
Bằng |
vrWebsiteButtonClicks |
Tổng số lượt nhấp vào nút "Trang web" trên Google đối với nhà/căn hộ du lịch. |
AdvanceBookingWindow
Liệt kê các thời hạn đặt trước (ABW) được hỗ trợ. Tất cả các so sánh về 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 trù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à từ 2 đến 7 ngày sau ngày tìm kiếm. |
ADVANCE_BOOKING_WINDOW_DAYS_8_TO_14 |
Ngày nhận phòng là 8 đến 14 ngày sau ngày tìm kiếm. |
ADVANCE_BOOKING_WINDOW_DAYS_15_TO_30 |
Ngày nhận phòng là 15 đến 30 ngày sau ngày truy vấn. |
ADVANCE_BOOKING_WINDOW_DAYS_31_TO_60 |
Ngày nhận phòng là 31 đến 60 ngày sau ngày tìm kiếm. |
ADVANCE_BOOKING_WINDOW_DAYS_61_TO_90 |
Ngày nhận phòng là từ 61 đến 90 ngày sau ngày tìm kiếm. |
ADVANCE_BOOKING_WINDOW_DAYS_91_TO_120 |
Ngày nhận phòng là 91 đến 120 ngày sau ngày truy vấn. |
ADVANCE_BOOKING_WINDOW_DAYS_121_TO_150 |
Ngày nhận phòng là 121 đến 150 ngày sau ngày truy vấn. |
ADVANCE_BOOKING_WINDOW_DAYS_151_TO_180 |
Ngày nhận phòng là 151 đến 180 ngày sau ngày tìm kiếm. |
ADVANCE_BOOKING_WINDOW_DAYS_OVER_180 |
Ngày nhận phòng cách ngày tìm kiếm hơn 180 ngày. |
LengthOfStay
Liệt kê thời gian lưu trú (LOS) được hỗ trợ.
| Enum | |
|---|---|
LENGTH_OF_STAY_UNSPECIFIED |
Chưa chỉ định. |
LENGTH_OF_STAY_NIGHTS_1 |
Lưu trú một đêm. |
LENGTH_OF_STAY_NIGHTS_2 |
Lưu trú 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. |
Số người lưu trú
Liệt kê tổng số người ở được hỗ trợ trong phòng.
| 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. |