Method: accounts.propertyPerformanceReportViews.query

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

string

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

string

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ử in. Nếu không, có thể bỏ qua dấu cách. Bạn có thể kết hợp các điều kiện bằng toán tử and.

Trường date là bắt buộc. Tất cả các trường khác là không bắt buộc.

Các giá trị của trường date bao gồm và phải ở định dạng YYYY-MM-DD. Ngày có thể chấp nhận sớm nhất là ngày 9 tháng 3 năm 2021; các giá trị ngày trước đó sẽ bị buộc thành ngày 9 tháng 3 năm 2021.

Các giá trị của partnerPropertyDisplayName và brand được so khớp không phân biệt chữ hoa chữ thường.

Ví dụ về các điều kiện hợp lệ như sau:

  • advanceBookingWindow = 'ADVANCE_BOOKING_WINDOW_SAME_DAY'
  • advanceBookingWindow in ('ADVANCE_BOOKING_WINDOW_SAME_DAY', 'ADVANCE_BOOKING_WINDOW_DAYS_61_TO_90')
  • brand = 'Brand A'
  • brand in ('Brand A', 'brand B')
  • date = '2021-12-03'
  • date between '2021-12-03' and '2021-12-08'
  • deviceType = 'TABLET'
  • deviceType in ('MOBILE', 'TABLET')
  • highIntentUsers = 'TRUE'
  • highIntentUsers = 'FALSE'
  • lengthOfStay = 'LENGTH_OF_STAY_NIGHTS_2'
  • lengthOfStay in ('LENGTH_OF_STAY_NIGHTS_2', 'LENGTH_OF_STAY_NIGHTS_4_TO_7')
  • propertyRegionCode = 'US'
  • propertyRegionCode in ('US', 'CA')
  • occupancy = 'OCCUPANCY_2'
  • occupancy in ('OCCUPANCY_2', 'OCCUPANCY_OVER_4')
  • partnerPropertyId = 'AAA'
  • partnerPropertyId in ('AAA', 'BBB')
  • partnerPropertyDisplayName = 'hotel A'
  • partnerPropertyDisplayName in ('Hotel A', 'HOTEL b')
  • userRegionCode = 'US'
  • userRegionCode in ('US', 'CA')
aggregateBy

string

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 userRegionCode, thì PropertyPerformanceResult sẽ cung cấp các chỉ số được tổng hợp theo khu vực của người dùng.

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à: advanceBookingWindow, brand, date, deviceType, highIntentUsers, lengthOfStay, propertyRegionCode, occupancy, partnerPropertyId, partnerPropertyDisplayName và userRegionCode. Chỉ các trường được chỉ định ở đây mới được đưa vào PropertyPerformanceResult.
pageSize

integer

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

string

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 (PropertyPerformanceResult)
    }
  ],
  "nextPageToken": string
}
Các trường
results[]

object (PropertyPerformanceResult)

Danh sách kết quả phù hợp với truy vấn.
nextPageToken

string

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 (Date)
  },
  "advanceBookingWindow": enum (AdvanceBookingWindow),
  "brand": string,
  "deviceType": enum (Device),
  "highIntentUsers": boolean,
  "lengthOfStay": enum (LengthOfStay),
  "propertyRegionCode": string,
  "occupancy": enum (Occupancy),
  "partnerPropertyId": string,
  "partnerPropertyDisplayName": string,
  "userRegionCode": string,
  "clickCount": string,
  "impressionCount": string,
  "clickthroughRate": number
}
Các trường
date

object (Date)

Một ngày trong phạm vi ngày được yêu cầu.

Chỉ xuất hiện nếu date được chỉ định trong aggregateBy trong yêu cầu.
advanceBookingWindow

enum (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 advanceBookingWindow được chỉ định trong aggregateBy trong yêu cầu.
brand

string

Thương hiệu do đối tác chỉ định cho tài sản.

Chỉ xuất hiện nếu brand được chỉ định trong aggregateBy trong yêu cầu.
deviceType

enum (Device)

Loại thiết bị của người dùng.

Chỉ xuất hiện nếu deviceType được chỉ định trong aggregateBy trong yêu cầu.
highIntentUsers

boolean

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 highIntentUsers được chỉ định trong aggregateBy trong yêu cầu.
lengthOfStay

enum (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 lengthOfStay được chỉ định trong aggregateBy trong yêu cầu.
propertyRegionCode

string

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 propertyRegionCode được chỉ định trong aggregateBy trong yêu cầu
occupancy

enum (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 được chỉ định trong aggregateBy trong yêu cầu.
partnerPropertyId

string

Mã tài sản của đối tác.

Chỉ xuất hiện nếu partnerPropertyId được chỉ định trong aggregateBy trong yêu cầu.
partnerPropertyDisplayName

string

Tên cơ sở lưu trú của đối tác.

Chỉ xuất hiện nếu partnerPropertyDisplayName được chỉ định trong aggregateBy trong yêu cầu.
userRegionCode

string

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 userRegionCode được chỉ định trong aggregateBy trong yêu cầu
clickCount

string (int64 format)

Tổng số lượt nhấp được ghi lại cho kết quả này.
impressionCount

string (int64 format)

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

number

Bằng clickCount chia cho impressionCount.

Đặ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.