Method: accounts.propertyPerformanceReportViews.query

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

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

Thông số
filter

string

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ử in. Nếu không, bạn 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.

Lưu ý quan trọng: Cú pháp chính xác để thêm nhiều điều kiện là: "?filter=<condition>=<value>%20AND%20<condition>=<value>..."

Bạn bắt buộc phải điền vào trường date. Tất cả các trường khác đều không bắt buộc.

Các giá trị trường date là giá trị bao gồm và phải ở định dạng YYYY-MM-DD. Ngày sớm nhất có thể chấp nhận là 2021-03-09; các giá trị ngày trước đó sẽ được chuyển đổi thành 2021-03-09.

Các giá trị cho partnerPropertyDisplayNamebrand được so khớp mà không phân biệt chữ hoa chữ thường.

Sau đây là ví dụ về các điều kiện hợp lệ:

  • 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ố do 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, partnerPropertyDisplayNameuserRegionCode. Chỉ những trường được chỉ định ở đây mới được đưa vào PropertyPerformanceResult.

Lưu ý quan trọng: Việc sử dụng tham số aggregateBy với partnerHotelId hoặc nhiều hơn 2 giá trị có thể dẫn đến lỗi. Việc lọc bằng partnerHotelIddate để giảm số lượng hàng có thể ngăn chặn lỗi xảy ra.

pageSize

integer

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

string

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

object (PropertyPerformanceResult)

Danh sách kết quả khớp với truy vấn.

nextPageToken

string

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 (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,
  "adsClickCount": string,
  "adsImpressionCount": string,
  "adsClickthroughRate": number,
  "vrWebsiteButtonClicks": string
}
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ố 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 advanceBookingWindow được chỉ định trong aggregateBy trong yêu cầu.

brand

string

Thương hiệu do đối tác chỉ định cho cơ sở lưu trú.

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

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 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 nơi có tài sản.

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

occupancy

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

clickCount

string (int64 format)

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

string (int64 format)

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

number

Bằng clickCount chia cho impressionCount.

adsClickCount

string (int64 format)

Tổng số lượt nhấp vào quảng cáo được ghi nhận cho kết quả này.

adsImpressionCount

string (int64 format)

Tổng số lượt hiển thị quảng cáo được ghi nhận cho kết quả này.

adsClickthroughRate

number

Bằng adsClickCount chia cho adsImpressionCount.

vrWebsiteButtonClicks

string (int64 format)

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.