Method: accounts.propertyPerformanceReportViews.query

ช่วยให้สามารถค้นหา (รับ กรอง และแบ่งกลุ่ม) รายงานลิงก์การจองแบบไม่เสียค่าใช้จ่ายสำหรับบัญชีที่เฉพาะเจาะจง เวอร์ชันใหม่นี้จะแสดงผลการแสดงผลและการคลิก รวมถึงชุดตัวกรอง/การรวบรวมที่ใหญ่กว่ามาก

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลงรหัส gRPC

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

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

string

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

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

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

string

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

สำคัญ: ไวยากรณ์ที่ถูกต้องในการเพิ่มเงื่อนไขหลายรายการคือ "?filter=<condition>=<value>%20AND%20<condition>=<value>..."

ต้องระบุข้อมูลในช่อง 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

สำคัญ: การใช้พารามิเตอร์ aggregateBy ที่มีค่า partnerHotelId หรือมากกว่า 2 ค่าอาจทำให้เกิดข้อผิดพลาด การกรองด้วย partnerHotelId และ date เพื่อลดจำนวนแถวจะช่วยป้องกันไม่ให้เกิดข้อผิดพลาดได้
pageSize

integer

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

string

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

เมื่อแบ่งหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ระบุให้กับ participationReportViews.query ต้องตรงกับการเรียกที่ระบุโทเค็นหน้า

เนื้อความของคำขอ

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

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

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

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

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

object (PropertyPerformanceResult)

รายการผลลัพธ์ที่ตรงกับคำค้นหา
nextPageToken

string

โทเค็นการแบ่งหน้าซึ่งใช้เพื่อดึงข้อมูลผลลัพธ์หน้าถัดไป หากละเว้นช่องนี้ จะไม่มีหน้าถัดไป

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

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

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

ดูข้อมูลเพิ่มเติมได้ที่ OAuth 2.0 Overview

PropertyPerformanceResult

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

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

string (int64 format)

จำนวนคลิกโฆษณาทั้งหมดที่บันทึกไว้สำหรับผลลัพธ์นี้
adsImpressionCount

string (int64 format)

จำนวนการแสดงโฆษณาทั้งหมดที่บันทึกไว้สำหรับผลลัพธ์นี้
adsClickthroughRate

number

เท่ากับ adsClickCount หารด้วย adsImpressionCount
vrWebsiteButtonClicks

string (int64 format)

จำนวนคลิกทั้งหมดที่ปุ่ม "เว็บไซต์" ใน Google สำหรับที่พักให้เช่า

AdvanceBookingWindow

แสดงรายการระยะเวลาที่จองได้ล่วงหน้า (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 วัน

LengthOfStay

แสดงรายการระยะเวลาในการเข้าพัก (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 คน