Method: accounts.participationReportViews.query

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

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
name

string

Nama resource akun yang dikueri. Formatnya adalah accounts/{account_id}.

Parameter kueri

Parameter
filter

string

Kondisi (kolom dan ekspresi) digunakan untuk memfilter metrik partisipasi 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.

Contoh kondisi yang valid adalah sebagai berikut:

  • advanceBookingWindow = 2
  • advanceBookingWindow >= 0
  • advanceBookingWindow <= 5
  • advanceBookingWindow between 1 and 5
  • checkinDate = '2020-10-01'
  • checkinDate >= '2020-10-01'
  • checkinDate <= '2020-10-01'
  • checkinDate between '2020-10-01' and '2020-10-05'
  • date = '2020-02-04'
  • date between '2020-02-04' and '2020-02-09'
  • deviceType = 'TABLET'
  • deviceType in ('MOBILE', 'TABLET')
  • hotelRegionCode = 'US'
  • hotelRegionCode in ('US', 'CA')
  • lengthOfStayDays = 2
  • lengthOfStayDays >= 0
  • lengthOfStayDays <= 5
  • lengthOfStayDays between 1 and 5
  • occupancy = 2
  • occupancy >= 0
  • occupancy <= 5
  • occupancy between 1 and 5
  • partnerHotelId = 'AAA'
  • partnerHotelId in ('AAA', 'BBB')
  • userRegionCode = 'US'
  • userRegionCode in ('US', 'CA')
aggregateBy

string

Menentukan cara menyegmentasikan metrik yang ditampilkan oleh kueri. Misalnya, jika userRegionCode ditentukan sebagai nilai aggregateBy, participationResult akan memberikan metrik yang digabungkan menurut wilayah pengguna.

Nilai string adalah daftar kolom yang dipisahkan koma. Kolom yang valid adalah: date, userRegionCode, deviceType, partnerHotelId, hotelRegionCode, advanceBookingWindow, lengthOfStayDays, checkinDate, dan occupancy. Kolom yang tidak ditentukan tidak disertakan dalam PartisipasiResult.

Penggunaan spesifikasi aggregateBy yang menghasilkan baris dalam jumlah besar akan menyebabkan error. Hal ini terutama berlaku jika digabungkan menurut partnerHotelId atau lebih dari dua kolom. Untuk mengurangi kemungkinan error, filter menurut partnerHotelId dan date agar hanya menyertakan jumlah hotel dan tanggal tertentu. Akun dengan jumlah hotel yang besar harus lebih mengurangi data dengan lebih banyak pemfilteran.
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 ParticipationReportService.QueryParticipationReport.

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

object (ParticipationResult)

Daftar hasil yang cocok dengan kueri.
nextPageToken

string

Token penomoran yang digunakan untuk mengambil halaman hasil berikutnya.

Cakupan Otorisasi

Memerlukan cakupan OAuth berikut ini:

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

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.

Hasil Partisipasi

Merepresentasikan hasil dari pembuatan kueri statistik partisipasi untuk akun.

Representasi JSON 
{
  "key": {
    object (Key)
  },
  "opportunityCount": string,
  "participationCount": string,
  "participationPercent": number,
  "missedParticipationCount": string,
  "missedParticipationCountDetails": {
    object (MissedParticipationCountDetails)
  },
  "partnerHotelDisplayName": string
}
Kolom
key

object (Key)

Kunci hasil.
opportunityCount

string (int64 format)

Jumlah total peluang yang tersedia untuk hotel tertentu. Peluang adalah jumlah total instance saat iklan hotel dapat ditampilkan kepada pengguna.
participationCount

string (int64 format)

Jumlah total peluang saat Anda memenuhi syarat untuk berpartisipasi dalam proses lelang Google Ads.
participationPercent

number

Tingkat persentase partisipasi di mana jumlah peluang yang berhasil berpartisipasi dibagi dengan jumlah total peluang. Misalnya, jika suatu properti memenuhi syarat untuk berpartisipasi dalam lelang Google Ads sebanyak 90 kali dari 100 peluang, tingkat partisipasinya adalah 90%.
missedParticipationCount

string (int64 format)

Jumlah total peluang yang tidak memenuhi syarat untuk proses lelang Google Ads. Meliputi hal-hal berikut:

  • Halaman landing tidak ada
  • Harga tidak ada
  • Masalah harga
  • Harga tidak tersedia
  • Lainnya
missedParticipationCountDetails

object (MissedParticipationCountDetails)

Alasan yang berkontribusi terhadap jumlah partisipasi yang terlewat (misalnya, tidak ada ketersediaan) dan jumlah total untuk setiap alasan.
partnerHotelDisplayName

string

Nama tampilan hotel partner. Kolom ini hanya diisi saat hasil digabungkan oleh partnerHotelId.

Kunci

Kunci hasil.

Representasi JSON 
{
  "date": {
    object (Date)
  },
  "userRegionCode": string,
  "deviceType": enum (Device),
  "partnerHotelId": string,
  "hotelRegionCode": string,
  "advanceBookingWindow": integer,
  "lengthOfStayDays": integer,
  "checkinDate": {
    object (Date)
  },
  "occupancy": integer
}
Kolom
date

object (Date)

Tanggal saat Anda meminta metrik.

Jika date bukan nilai parameter aggregateBy dalam panggilan permintaan, kolom date tidak akan ditampilkan di Key.
userRegionCode

string

Kode wilayah ISO 3116 negara/wilayah pengguna.

Jika userRegionCode bukan nilai parameter aggregateBy dalam panggilan permintaan, kolom userRegionCode tidak akan ditampilkan di Key.
deviceType

enum (Device)

Jenis perangkat pengguna.

Jika deviceType bukan nilai parameter aggregateBy dalam panggilan permintaan, kolom deviceType tidak akan ditampilkan di Key.
partnerHotelId

string

ID hotel partner.

Jika partnerHotelId bukan nilai parameter aggregateBy dalam panggilan permintaan, kolom partnerHotelId tidak akan ditampilkan di Key.
hotelRegionCode

string

Kode wilayah CLDR negara/wilayah hotel.

Jika hotelRegionCode bukan nilai parameter aggregateBy dalam panggilan permintaan, kolom hotelRegionCode tidak akan ditampilkan di Key.
advanceBookingWindow

integer

Jumlah hari sebelum pengguna ingin memesan itinerari.

Jika advanceBookingWindow bukan nilai parameter aggregateBy dalam panggilan permintaan, kolom advanceBookingWindow tidak akan ditampilkan di Key.
lengthOfStayDays

integer

Jumlah malam untuk itinerari.

Jika lengthOfStayDays bukan nilai parameter aggregateBy dalam panggilan permintaan, kolom lengthOfStayDays tidak akan ditampilkan di Key.
checkinDate

object (Date)

Tanggal check in itinerari.

Jika checkinDate bukan nilai parameter aggregateBy dalam panggilan permintaan, kolom checkinDate tidak akan ditampilkan di Key.
occupancy

integer

Total kehadiran itinerari.

Jika occupancy bukan nilai parameter aggregateBy dalam panggilan permintaan, kolom occupancy tidak akan ditampilkan di Key.

PartisipasiCountCountDetails

Jumlah partisipasi yang terlewat diperinci berdasarkan alasan.

Representasi JSON 
{
  "noAvailabilityCount": string,
  "hotelSuspendedCount": string,
  "noTaxBreakdownCount": string,
  "noLandingPageCount": string,
  "noPriceCount": string,
  "noPriceCountDetails": {
    object (NoPriceCountDetails)
  },
  "otherReasonCount": string,
  "priceMissingCount": string,
  "priceMissingCountDetails": {
    object (PriceMissingCountDetails)
  },
  "priceProblemCount": string,
  "priceProblemCountDetails": {
    object (PriceProblemCountDetails)
  },
  "priceUnavailableCount": string,
  "priceUnavailableCountDetails": {
    object (PriceUnavailableCountDetails)
  }
}
Kolom
noAvailabilityCount
(deprecated)

string (int64 format)

Jumlah total partisipasi yang terlewat karena kombinasi hotel/itinerari tidak tersedia, atau wisatawan tidak memenuhi syarat untuk mendapatkan tarif tersebut. Untuk berpartisipasi dalam lelang ini, Anda mungkin perlu memberikan informasi harga lainnya.
hotelSuspendedCount
(deprecated)

string (int64 format)

Jumlah total partisipasi yang terlewat karena satu atau beberapa hotel Anda ditangguhkan karena pelanggaran akurasi harga.
noTaxBreakdownCount
(deprecated)

string (int64 format)

Jumlah total partisipasi yang terlewat karena satu atau beberapa hotel Anda tidak menentukan pajak dan biaya secara terpisah.
noLandingPageCount

string (int64 format)

Tidak ada halaman landing yang cocok dengan pengguna.
noPriceCount
(deprecated)

string (int64 format)

Jumlah total partisipasi yang terlewat karena harga tidak ditawarkan untuk itinerari yang diminta.
noPriceCountDetails
(deprecated)

object (NoPriceCountDetails)

Alasan yang menyebabkan jumlah harga tidak ada (misalnya, harga real time tidak tersedia) dan jumlah total untuk setiap alasan.
otherReasonCount

string (int64 format)

Hotel tidak berpartisipasi karena alasan yang tidak diketahui.
priceMissingCount

string (int64 format)

Jumlah total partisipasi yang terlewat karena harga tidak ada di cache Google atau harga real time gagal direspons. Meliputi hal-hal berikut:

  • Bandwidth habis
  • Tarif di cache tidak ada
  • Itinerari diblokir
  • Harga real time belum disiapkan
  • Harga real time kedaluwarsa
  • Error harga real time
priceMissingCountDetails

object (PriceMissingCountDetails)

Alasan yang menyebabkan jumlah harga tidak ada.
priceProblemCount

string (int64 format)

Jumlah total partisipasi yang terlewat karena masalah dengan akurasi harga yang diberikan untuk itinerari. Meliputi hal-hal berikut:

  • Hotel ditangguhkan
  • Harga sangat tinggi
  • Harga sangat rendah
  • Tidak ada pajak dan feed
priceProblemCountDetails

object (PriceProblemCountDetails)

Alasan yang berkontribusi pada jumlah masalah harga.
priceUnavailableCount

string (int64 format)

Jumlah total partisipasi yang terlewat karena harga tercantum sebagai tidak tersedia (-1) untuk itinerari yang diminta. Meliputi hal-hal berikut:

  • Harga tidak tersedia
  • Partisipasi tidak memungkinkan
  • Lainnya
priceUnavailableCountDetails

object (PriceUnavailableCountDetails)

Alasan yang memengaruhi jumlah harga yang tidak tersedia.

NoPriceCountDetails

Alasan yang berkontribusi pada jumlah tidak ada harga dan jumlah total untuk setiap alasan.

Representasi JSON 
{
  "livePricingTechnicalIssueCount": string,
  "livePricingNotTriggeredCount": string,
  "livePricingConfigIssueCount": string,
  "livePricingNotAvailableCount": string,
  "livePricingOtherReasonCount": string
}
Kolom
livePricingTechnicalIssueCount

string (int64 format)

Jumlah total partisipasi yang terlewat karena masalah teknis pada harga real time karena salah satu alasan berikut:

  • Respons yang Anda berikan tidak cukup cepat dan melebihi batas waktu respons (sekitar 4.000 milidetik).
  • Anda membuat error.
  • Respons Anda salah format.
livePricingNotTriggeredCount

string (int64 format)

Jumlah total partisipasi yang terlewat karena harga real time tidak dipicu oleh salah satu alasan berikut:

  • Anda tidak menetapkan bid.
  • Anda tidak memiliki halaman landing yang valid.
  • Tidak ada harga yang cukup di cache.
livePricingConfigIssueCount

string (int64 format)

Jumlah total partisipasi yang terlewat karena harga real time tidak dipicu oleh salah satu alasan berikut:

  • Anda tidak mengonfigurasi harga real time untuk penelusuran ini.
  • Anda membatasi akses Google ke itinerari hotel yang dipermasalahkan.
livePricingNotAvailableCount

string (int64 format)

Jumlah total partisipasi yang terlewat karena harga real time tidak tersedia. Harga real time tidak akan dipicu untuk itinerari atau UI default tertentu. Dalam skenario ini, partner memerlukan harga yang di-cache untuk berpartisipasi.
livePricingOtherReasonCount

string (int64 format)

Jumlah partisipasi yang terlewat karena masalah lain dengan harga real time.

PriceMissingCountDetails

Alasan yang menyebabkan jumlah harga tidak ada dan jumlah total untuk setiap alasan.

Representasi JSON 
{
  "cacheRateMissingCount": string,
  "itineraryBlockedCount": string,
  "livePricingNotSetupCount": string,
  "bandwidthDepletedCount": string,
  "livePricingTimeoutCount": string,
  "livePricingErrorCount": string
}
Kolom
cacheRateMissingCount

string (int64 format)

Tidak ada harga di cache untuk itinerari ini. Kueri real time tidak dilakukan karena pembatasan halaman.
itineraryBlockedCount

string (int64 format)

Itinerari berada di luar parameter dasar, sehingga tidak ada harga yang diambil untuk itinerari dari kueri real time atau data di cache.
livePricingNotSetupCount

string (int64 format)

Tidak ada harga yang di-cache untuk itinerari ini, dan kueri real time tidak dikonfigurasi untuk akun ini
bandwidthDepletedCount

string (int64 format)

Tidak ada harga yang di-cache untuk itinerari ini, dan tidak ada sisa kuota kueri real time.
livePricingTimeoutCount

string (int64 format)

Tidak ada harga yang di-cache untuk itinerari ini, dan kueri real time yang dikirimkan ke sistem Anda telah kedaluwarsa.
livePricingErrorCount

string (int64 format)

Tidak ada harga yang di-cache untuk itinerari ini. Kueri real time tidak kedaluwarsa, tetapi sistem menampilkan error.

PriceIssueCountDetails

Alasan yang berkontribusi pada jumlah masalah harga dan jumlah total untuk setiap alasan.

Representasi JSON 
{
  "hotelSuspendedCount": string,
  "priceUnusuallyHighCount": string,
  "priceUnusuallyLowCount": string,
  "taxesAndFeesMissingCount": string
}
Kolom
hotelSuspendedCount

string (int64 format)

Hotel ditangguhkan. Hal ini mungkin disebabkan karena masalah persisten di bidang seperti pajak dan biaya yang salah.
priceUnusuallyHighCount

string (int64 format)

Harga yang diberikan untuk itinerari ini sangat tinggi dibandingkan dengan tren regional.
priceUnusuallyLowCount

string (int64 format)

Harga yang diberikan untuk itinerari ini sangat rendah dibandingkan dengan tren regional.
taxesAndFeesMissingCount

string (int64 format)

Tidak ada pajak dan biaya pada harga.

PriceAvailableCountDetails

Alasan yang berkontribusi pada jumlah harga tidak tersedia dan jumlah total untuk setiap alasan.

Representasi JSON 
{
  "priceUnavailableCount": string,
  "participationNotLikelyCount": string
}
Kolom
priceUnavailableCount

string (int64 format)

Hotel tidak berpartisipasi karena tidak tersedia untuk tanggal itinerari.
participationNotLikelyCount

string (int64 format)

Tidak ada harga yang di-cache untuk itinerari ini, dan tidak ada kueri real time yang dikonfigurasikan karena server Anda biasanya memberitahukan bahwa hotel tidak tersedia atau penuh.