Method: accounts.propertyPerformanceReportViews.query

Memberikan kemampuan untuk membuat kueri (mendapatkan, memfilter, dan menyegmentasikan) laporan link performa properti untuk akun tertentu.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
name

string

Nama resource akun yang dikueri. Format: accounts/{account_id}

Parameter kueri

Parameter
filter

string

Kondisi (kolom dan ekspresi) digunakan untuk memfilter metrik performa properti untuk akun yang dikueri. Sintaksis memerlukan spasi di sekitar operator in. Jika tidak, spasi dapat dihilangkan. Kondisi dapat digabungkan menggunakan operator and.

Kolom date wajib diisi. Semua kolom lainnya bersifat opsional.

Nilai kolom date bersifat inklusif dan harus dalam format YYYY-MM-DD. Tanggal paling awal yang dapat diterima adalah 09-03-2021; nilai tanggal sebelumnya akan dikonversi ke 09-03-2021.

Nilai untuk partnerPropertyDisplayName dan brand dicocokkan secara tidak peka huruf besar/kecil.

Contoh kondisi yang valid adalah sebagai berikut:

  • 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

Menentukan cara menyegmentasikan metrik yang ditampilkan oleh kueri. Misalnya, jika userRegionCode ditentukan, PropertyPerformanceResult akan menyediakan metrik yang digabungkan menurut wilayah pengguna.

Nilai string adalah daftar kolom yang dipisahkan koma. Kolom yang valid adalah: advanceBookingWindow, brand, date, deviceType, highIntentUsers, lengthOfStay, propertyRegionCode, occupancy, partnerPropertyId, partnerPropertyDisplayName, dan userRegionCode. Hanya kolom yang ditentukan di sini yang disertakan dalam PropertyPerformanceResult.
pageSize

integer

Jumlah maksimum hasil partisipasi yang akan ditampilkan. Layanan mungkin menampilkan lebih sedikit dari nilai ini. Jika tidak ditentukan, maksimal 10.000 hasil akan ditampilkan. Nilai maksimum adalah 10.000; nilai di atas 10.000 akan dikonversi menjadi 10.000.
pageToken

string

Token halaman, diterima dari permintaan partisipasiReportReports.query sebelumnya. Berikan ini untuk menerima halaman berikutnya.

Saat melakukan penomoran halaman, semua parameter lain yang disediakan untuk partisipasiReportViews.query harus sesuai dengan panggilan yang disediakan token halaman.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

Pesan respons untuk PropertyPerformanceReportService.QueryPropertyPerformanceReport.

Representasi JSON 
{
  "results": [
    {
      object (PropertyPerformanceResult)
    }
  ],
  "nextPageToken": string
}
Kolom
results[]

object (PropertyPerformanceResult)

Daftar hasil yang cocok dengan kueri.
nextPageToken

string

Token penomoran yang digunakan untuk mengambil halaman hasil berikutnya. Jika kolom ini dihilangkan, maka tidak ada halaman berikutnya.

Cakupan Otorisasi

Memerlukan cakupan OAuth berikut ini:

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

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.

PropertiPerformanceResult

Merepresentasikan hasil dari melakukan kueri untuk laporan performa properti untuk akun.

Representasi 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
}
Kolom
date

object (Date)

Tanggal dalam rentang tanggal yang diminta.

Hanya ada jika date ditentukan dalam aggregateBy dalam permintaan.
advanceBookingWindow

enum (AdvanceBookingWindow)

Perbedaan hari antara tanggal kueri dan tanggal check-in di zona waktu lokal properti.

Hanya ada jika advanceBookingWindow ditentukan dalam aggregateBy dalam permintaan.
brand

string

Merek yang ditentukan partner untuk properti.

Hanya ada jika brand ditentukan dalam aggregateBy dalam permintaan.
deviceType

enum (Device)

Jenis perangkat pengguna.

Hanya ada jika deviceType ditentukan dalam aggregateBy dalam permintaan.
highIntentUsers

boolean

Apakah kueri pengguna menunjukkan minat yang kuat pada pemesanan.

Hanya ada jika highIntentUsers ditentukan dalam aggregateBy dalam permintaan.
lengthOfStay

enum (LengthOfStay)

Jumlah malam antara tanggal check-in dan check-out yang ditentukan oleh pengguna.

Hanya ada jika lengthOfStay ditentukan dalam aggregateBy dalam permintaan.
propertyRegionCode

string

Kode wilayah ISO 3116 negara/wilayah properti.

Hanya ada jika propertyRegionCode ditentukan dalam aggregateBy dalam permintaan
occupancy

enum (Occupancy)

Meminta jumlah orang yang menginap di properti tersebut.

Hanya ada jika partnerPropertyId ditentukan dalam aggregateBy dalam permintaan.
partnerPropertyId

string

ID properti partner.

Hanya ada jika partnerPropertyId ditentukan dalam aggregateBy dalam permintaan.
partnerPropertyDisplayName

string

Nama properti partner.

Hanya ada jika partnerPropertyDisplayName ditentukan dalam aggregateBy dalam permintaan.
userRegionCode

string

Kode wilayah ISO 3116 negara/wilayah pengguna.

Hanya ada jika userRegionCode ditentukan dalam aggregateBy dalam permintaan
clickCount

string (int64 format)

Total jumlah klik yang direkam untuk hasil ini.
impressionCount

string (int64 format)

Total jumlah tayangan yang direkam untuk hasil ini. Nilai ini dibulatkan untuk menjaga privasi pengguna.
clickthroughRate

number

Setara dengan clickCount dibagi dengan impressionCount.

WindowBookingWindow

Menghitung periode pemesanan di awal (ABW) yang didukung. Semua perbandingan tanggal berada di zona waktu properti.

Enumerasi
ADVANCE_BOOKING_WINDOW_UNSPECIFIED Tidak ditentukan.
ADVANCE_BOOKING_WINDOW_SAME_DAY Tanggal check-in sama dengan tanggal kueri.
ADVANCE_BOOKING_WINDOW_NEXT_DAY Tanggal check-in adalah hari berikutnya setelah tanggal kueri.
ADVANCE_BOOKING_WINDOW_DAYS_2_TO_7 Tanggal check-in adalah 2-7 hari setelah tanggal kueri.
ADVANCE_BOOKING_WINDOW_DAYS_8_TO_14 Tanggal check-in adalah 8-14 hari setelah tanggal kueri.
ADVANCE_BOOKING_WINDOW_DAYS_15_TO_30 Tanggal check-in adalah 15-30 hari setelah tanggal kueri.
ADVANCE_BOOKING_WINDOW_DAYS_31_TO_60 Tanggal check-in adalah 31-60 hari setelah tanggal kueri.
ADVANCE_BOOKING_WINDOW_DAYS_61_TO_90 Tanggal check-in adalah 61-90 hari setelah tanggal kueri.
ADVANCE_BOOKING_WINDOW_DAYS_91_TO_120 Tanggal check-in adalah 91-120 hari setelah tanggal kueri.
ADVANCE_BOOKING_WINDOW_DAYS_121_TO_150 Tanggal check-in adalah 121-150 hari setelah tanggal kueri.
ADVANCE_BOOKING_WINDOW_DAYS_151_TO_180 Tanggal check-in adalah 151-180 hari setelah tanggal kueri.
ADVANCE_BOOKING_WINDOW_DAYS_OVER_180 Tanggal check-in lebih dari 180 hari setelah tanggal kueri.

Lama Menginap

Menghitung durasi menginap yang didukung (LOS).

Enumerasi
LENGTH_OF_STAY_UNSPECIFIED Tidak ditentukan.
LENGTH_OF_STAY_NIGHTS_1 Menginap satu malam.
LENGTH_OF_STAY_NIGHTS_2 Menginap 2 malam.
LENGTH_OF_STAY_NIGHTS_3 Menginap 3 malam.
LENGTH_OF_STAY_NIGHTS_4_TO_7 Menginap selama 4-7 malam.
LENGTH_OF_STAY_NIGHTS_8_TO_14 Menginap selama 8-14 malam.
LENGTH_OF_STAY_NIGHTS_15_TO_21 Menginap selama 15-21 malam.
LENGTH_OF_STAY_NIGHTS_22_TO_30 Menginap selama 22-30 malam.
LENGTH_OF_STAY_NIGHTS_OVER_30 Menginap lebih dari 30 malam.

Penggunaan

Menghitung jumlah total tamu yang didukung.

Enumerasi
OCCUPANCY_UNSPECIFIED Tidak ditentukan.
OCCUPANCY_1 Satu orang.
OCCUPANCY_2 Dua orang.
OCCUPANCY_3 Tiga orang.
OCCUPANCY_4 Empat orang.
OCCUPANCY_OVER_4 Lebih dari 4 orang.