Method: accounts.freeBookingLinksReportViews.query

KHÔNG DÙNG HOẠT ĐỘNG: Sử dụng PropertyPerformanceReportService.QueryPropertyPerformanceReport cũng có báo cáo hiển thị. Hỗ trợ truy vấn (nhận, lọc và phân đoạn) một báo cáo về đường liên kết miễn phí để đặt phòng của một tài khoản cụ thể.

Yêu cầu HTTP

GET https://travelpartner.googleapis.com/v3/{name=accounts/*}/freeBookingLinksReportViews: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ố đường liên kết miễn phí để đặt phòng 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ị cho partnerHotelDisplayName đượ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:

  • date = '2021-12-03'
  • date between '2021-12-03' and '2021-12-08'
  • deviceType = 'TABLET'
  • deviceType in ('MOBILE', 'TABLET')
  • partnerHotelId = 'AAA'
  • partnerHotelId in ('AAA', 'BBB')
  • partnerHotelDisplayName = 'hotel A'
  • partnerHotelDisplayName 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ì freeBookingLinksResult 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à: date, userRegionCode, deviceType, partnerHotelId và partnerHotelDisplayName. Chỉ những trường được chỉ định ở đây mới được đưa vào FreeBookingBookingResult.
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:

Ngừng sử dụng: Sử dụng QueryPropertyPerformanceReportResponse với PropertyPerformanceReportService. Thông báo phản hồi cho FreeBookingLinksReportService.QueryFreeBookingLinksReport.

Biểu diễn dưới dạng JSON 
{
  "results": [
    {
      object (FreeBookingLinksResult)
    }
  ],
  "nextPageToken": string
}
Các trường
results[]

object (FreeBookingLinksResult)

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ả đặt trước liên kết miễn phí

Ngừng sử dụng: Sử dụng PropertyPerformanceResult với PropertyPerformanceReportService. Đại diện cho kết quả khi truy vấn các số liệu thống kê về đường liên kết miễn phí để đặt phòng của một tài khoản.

Biểu diễn dưới dạng JSON 
{
  "date": {
    object (Date)
  },
  "userRegionCode": string,
  "deviceType": enum (Device),
  "partnerHotelId": string,
  "partnerHotelDisplayName": string,
  "clickCount": string
}
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.
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
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.
partnerHotelId

string

Mã khách sạn của đối tác.

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

string

Tên khách sạn của đối tác.

Chỉ xuất hiện nếu partnerHotelDisplayName đượ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.