Method: accounts.propertyPerformanceReportViews.query

ทําให้ค้นหารายงาน (รับ กรอง และแบ่งกลุ่ม) รายงานประสิทธิภาพของพร็อพเพอร์ตี้สําหรับบัญชีที่เฉพาะเจาะจงได้

คำขอ HTTP

GET https://travelpartner.googleapis.com/v3/{name=accounts/*}/propertyPerformanceReportViews:query

URL ใช้ไวยากรณ์ gRPC Transcoding

พารามิเตอร์เส้นทาง

พารามิเตอร์
name

string

ชื่อทรัพยากรของบัญชีที่ค้นหา รูปแบบ: accounts/{account_id}

พารามิเตอร์การค้นหา

พารามิเตอร์
filter

string

เงื่อนไข (ช่องและนิพจน์) ที่ใช้เพื่อกรองเมตริกประสิทธิภาพของพร็อพเพอร์ตี้สําหรับบัญชีที่ค้นหา ไวยากรณ์ต้องใช้การเว้นวรรครอบโอเปอเรเตอร์ in มิเช่นนั้นให้ข้ามการเว้นวรรคไป เชื่อมโยงเงื่อนไขได้โดยใช้โอเปอเรเตอร์ and

ต้องระบุข้อมูลในช่อง date ส่วนช่องอื่นๆ ทั้งหมดเป็นตัวเลือก

ค่าในช่อง date โดยรวมและต้องอยู่ในรูปแบบ YYYY-MM-DD วันที่แรกสุดที่ยอมรับได้คือ 2021-03-09 ค่าวันที่ก่อนหน้าจะเปลี่ยนเป็น 2021-03-09

ค่าของ partnerPropertyDisplayName และ brand จะจับคู่กับตัวพิมพ์เล็กและตัวพิมพ์ใหญ่

ตัวอย่างของเงื่อนไขที่ถูกต้องมีดังต่อไปนี้

  • 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

ระบุวิธีแบ่งกลุ่มเมตริกที่แสดงผลโดยการค้นหา ตัวอย่างเช่น หากมีการระบุ userRegionCode ไว้ PropertyPerformanceResult จะแสดงเมตริกแบบรวมตามภูมิภาคผู้ใช้

ค่าสตริงคือรายการช่องที่คั่นด้วยเครื่องหมายจุลภาค ช่องที่ถูกต้องคือ advanceBookingWindow, brand, date, deviceType, highIntentUsers, lengthOfStay, propertyRegionCode, occupancy, partnerPropertyId, partnerPropertyDisplayName และ userRegionCode มีเฉพาะช่องที่ระบุที่นี่เท่านั้นที่รวมอยู่ใน PropertyPerformanceResult
pageSize

integer

จํานวนผลลัพธ์การเข้าร่วมสูงสุดที่จะส่งคืน บริการอาจแสดงผลน้อยกว่าค่านี้ หากไม่ระบุ ระบบจะแสดงผลมากที่สุด 10,000 รายการ ค่าสูงสุดคือ 10,000 รายการ ค่าที่สูงกว่า 10,000 จะถูกเปลี่ยนเป็น 10,000
pageToken

string

โทเค็นหน้าเว็บที่ได้รับจากคําขอ engagementReportViews.query ก่อนหน้านี้ ระบุข้อมูลนี้เพื่อรับหน้าต่อไป

เมื่อมีการใส่เลขหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ส่งถึง engagementReportViews.query จะต้องตรงกับการเรียกใช้โทเค็นของหน้าเว็บ

เนื้อหาของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

ข้อความตอบกลับสําหรับ PropertyPerformanceReportService.QueryPropertyPerformanceReport

การแสดง JSON 
{
  "results": [
    {
      object (PropertyPerformanceResult)
    }
  ],
  "nextPageToken": string
}
ช่อง
results[]

object (PropertyPerformanceResult)

รายการผลการค้นหาที่ตรงกับคําค้นหา
nextPageToken

string

โทเค็นการใส่เลขหน้าที่ใช้สําหรับเรียกหน้าถัดไปของผลลัพธ์ หากไม่ระบุช่องนี้ จะไม่มีหน้าต่อๆ ไป

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/travelpartner

โปรดดูข้อมูลเพิ่มเติมที่หัวข้อภาพรวมของ OAuth 2.0

ผลการค้นหาประสิทธิภาพพร็อพเพอร์ตี้

แสดงถึงผลลัพธ์จากการค้นหารายงานประสิทธิภาพของพร็อพเพอร์ตี้สําหรับบัญชี

การแสดง 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
}
ช่อง
date

object (Date)

วันที่ภายในช่วงวันที่ที่ขอ

แสดงเฉพาะเมื่อระบุ date ใน aggregateBy ในคําขอ
advanceBookingWindow

enum (AdvanceBookingWindow)

ความแตกต่างของจํานวนวันระหว่างวันที่สืบค้นกับวันที่เช็คอินในเขตเวลาท้องถิ่นของที่พัก

แสดงเฉพาะเมื่อระบุ advanceBookingWindow ใน aggregateBy ในคําขอ
brand

string

แบรนด์ที่พาร์ทเนอร์ระบุไว้สําหรับที่พัก

แสดงเฉพาะเมื่อระบุ brand ใน aggregateBy ในคําขอ
deviceType

enum (Device)

ประเภทอุปกรณ์ของผู้ใช้

แสดงเฉพาะเมื่อระบุ deviceType ใน aggregateBy ในคําขอ
highIntentUsers

boolean

คําค้นหาของผู้ใช้บ่งชี้ว่ามีความสนใจในการจองอย่างมากหรือไม่

แสดงเฉพาะเมื่อระบุ highIntentUsers ใน aggregateBy ในคําขอ
lengthOfStay

enum (LengthOfStay)

จํานวนคืนระหว่างวันที่เช็คอินและเช็คเอาต์ที่ระบุโดยผู้ใช้

แสดงเฉพาะเมื่อระบุ lengthOfStay ใน aggregateBy ในคําขอ
propertyRegionCode

string

รหัสภูมิภาค ISO 3116 ของประเทศ/ภูมิภาคของที่พัก

แสดงเฉพาะเมื่อระบุ propertyRegionCode ใน aggregateBy ในคําขอ
occupancy

enum (Occupancy)

จํานวนผู้คนที่ขอเข้าพักในที่พัก

แสดงเฉพาะเมื่อระบุ partnerPropertyId ใน aggregateBy ในคําขอ
partnerPropertyId

string

รหัสพร็อพเพอร์ตี้ของพาร์ทเนอร์

แสดงเฉพาะเมื่อระบุ partnerPropertyId ใน aggregateBy ในคําขอ
partnerPropertyDisplayName

string

ชื่อพร็อพเพอร์ตี้ของพาร์ทเนอร์

แสดงเฉพาะเมื่อระบุ partnerPropertyDisplayName ใน aggregateBy ในคําขอ
userRegionCode

string

รหัสภูมิภาค ISO 3116 ของประเทศ/ภูมิภาคของผู้ใช้

แสดงเฉพาะเมื่อระบุ userRegionCode ใน aggregateBy ในคําขอ
clickCount

string (int64 format)

จํานวนคลิกทั้งหมดที่บันทึกไว้สําหรับผลลัพธ์นี้
impressionCount

string (int64 format)

จํานวนการแสดงผลที่บันทึกไว้ทั้งหมดสําหรับผลการค้นหานี้ โดยระบบจะปัดเศษค่านี้เพื่อรักษาความเป็นส่วนตัวของผู้ใช้
clickthroughRate

number

เท่ากับ clickCount หารด้วย impressionCount

ระยะเวลาการจองล่วงหน้า

แจกแจงกรอบเวลาการจองล่วงหน้าที่รองรับ (ABW) การเปรียบเทียบวันที่ทั้งหมดอยู่ในเขตเวลาของพร็อพเพอร์ตี้

Enum
ADVANCE_BOOKING_WINDOW_UNSPECIFIED ไม่ได้ระบุ
ADVANCE_BOOKING_WINDOW_SAME_DAY วันที่เช็คอินเป็นวันเดียวกับวันที่สืบค้น
ADVANCE_BOOKING_WINDOW_NEXT_DAY วันที่เช็คอินคือวันถัดไปหลังจากวันที่ค้นหา
ADVANCE_BOOKING_WINDOW_DAYS_2_TO_7 วันที่เช็คอินคือ 2-7 วันหลังจากวันที่สืบค้น
ADVANCE_BOOKING_WINDOW_DAYS_8_TO_14 วันที่เช็คอินคือ 8-14 วันหลังจากวันที่สืบค้น
ADVANCE_BOOKING_WINDOW_DAYS_15_TO_30 วันที่เช็คอินคือ 15-30 วันหลังจากวันที่สืบค้น
ADVANCE_BOOKING_WINDOW_DAYS_31_TO_60 วันที่เช็คอินคือ 31-60 วันหลังจากวันที่สืบค้น
ADVANCE_BOOKING_WINDOW_DAYS_61_TO_90 วันที่เช็คอินคือ 61-90 วันหลังจากวันที่สืบค้น
ADVANCE_BOOKING_WINDOW_DAYS_91_TO_120 วันที่เช็คอินคือ 91-120 วันหลังจากวันที่สืบค้น
ADVANCE_BOOKING_WINDOW_DAYS_121_TO_150 วันที่เช็คอินคือ 121-150 วันหลังจากวันที่สืบค้น
ADVANCE_BOOKING_WINDOW_DAYS_151_TO_180 วันที่เช็คอินคือ 151-180 วันหลังจากวันที่สืบค้น
ADVANCE_BOOKING_WINDOW_DAYS_OVER_180 วันที่เช็คอินเกิน 180 วันหลังจากวันที่ค้นหา

ระยะเวลาในการเข้าพัก

ระบุระยะเวลาเข้าพักที่รองรับ (LOS)

Enum
LENGTH_OF_STAY_UNSPECIFIED ไม่ได้ระบุ
LENGTH_OF_STAY_NIGHTS_1 การเข้าพัก 1 คืน
LENGTH_OF_STAY_NIGHTS_2 การเข้าพัก 2 คืน
LENGTH_OF_STAY_NIGHTS_3 การเข้าพัก 3 คืน
LENGTH_OF_STAY_NIGHTS_4_TO_7 การเข้าพัก 4-7 คืน
LENGTH_OF_STAY_NIGHTS_8_TO_14 การเข้าพัก 8-14 คืน
LENGTH_OF_STAY_NIGHTS_15_TO_21 การเข้าพัก 15-21 คืน
LENGTH_OF_STAY_NIGHTS_22_TO_30 การเข้าพัก 22-30 คืน
LENGTH_OF_STAY_NIGHTS_OVER_30 การเข้าพักมากกว่า 30 คืน

การเข้าพัก

แจกแจงจํานวนผู้เข้าพักทั้งหมดของห้องที่รองรับ

Enum
OCCUPANCY_UNSPECIFIED ไม่ได้ระบุ
OCCUPANCY_1 คนเดียว
OCCUPANCY_2 2 คน
OCCUPANCY_3 3 คน
OCCUPANCY_4 4 คน
OCCUPANCY_OVER_4 มากกว่า 4 คน