Method: accounts.propertyPerformanceReportViews.query

इसकी मदद से, किसी खाते के लिए बिना शुल्क वाले बुकिंग लिंक की रिपोर्ट को क्वेरी किया जा सकता है. जैसे, रिपोर्ट को पाना, फ़िल्टर करना, और सेगमेंट में बांटना. इस नए वर्शन में इंप्रेशन और क्लिक के साथ-साथ, फ़िल्टर/एग्रीगेशन का एक बड़ा सुपरसेट भी मिलता है.

एचटीटीपी अनुरोध

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

यह यूआरएल, 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 में शामिल किए जाते हैं.

अहम जानकारी: partnerHotelId या इससे ज़्यादा वैल्यू के साथ aggregateBy पैरामीटर का इस्तेमाल करने पर गड़बड़ी हो सकती है. partnerHotelId और date का इस्तेमाल करके, लाइनों की संख्या को कम करने के लिए फ़िल्टर करने से गड़बड़ियों को रोका जा सकता है.
pageSize

integer

जवाब देने वाले लोगों की ज़्यादा से ज़्यादा संख्या. ऐसा हो सकता है कि सेवा इस वैल्यू से कम नतीजे दिखाए. अगर इसे तय नहीं किया गया है, तो ज़्यादा से ज़्यादा 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)

तारीख की उस सीमा के अंदर की कोई तारीख जिसके लिए अनुरोध किया गया है.

यह सिर्फ़ तब मौजूद होता है, जब अनुरोध में aggregateBy में date की जानकारी दी गई हो.
advanceBookingWindow

enum (AdvanceBookingWindow)

प्रॉपर्टी के स्थानीय समय क्षेत्र के हिसाब से, क्वेरी की तारीख और चेक-इन की तारीख के बीच दिनों का अंतर.

यह सिर्फ़ तब मौजूद होता है, जब अनुरोध में aggregateBy में advanceBookingWindow की जानकारी दी गई हो.
brand

string

प्रॉपर्टी के लिए, पार्टनर की ओर से तय किया गया ब्रैंड.

यह सिर्फ़ तब मौजूद होता है, जब अनुरोध में aggregateBy में brand की जानकारी दी गई हो.
deviceType

enum (Device)

उपयोगकर्ता के डिवाइस का टाइप.

यह सिर्फ़ तब मौजूद होता है, जब अनुरोध में aggregateBy में deviceType की जानकारी दी गई हो.
highIntentUsers

boolean

क्या उपयोगकर्ता की क्वेरी से बुकिंग में उसकी दिलचस्पी का पता चला.

यह सिर्फ़ तब मौजूद होता है, जब अनुरोध में aggregateBy में highIntentUsers की जानकारी दी गई हो.
lengthOfStay

enum (LengthOfStay)

उपयोगकर्ता ने चेक-इन और चेक-आउट करने की जो तारीखें बताई हैं उनके बीच की रातों की संख्या.

यह सिर्फ़ तब मौजूद होता है, जब अनुरोध में aggregateBy में lengthOfStay की जानकारी दी गई हो.
propertyRegionCode

string

प्रॉपर्टी के देश/इलाके का ISO 3116 क्षेत्र कोड.

यह पैरामीटर सिर्फ़ तब मौजूद होता है, जब अनुरोध में aggregateBy में propertyRegionCode तय किया गया हो
occupancy

enum (Occupancy)

प्रॉपर्टी में ठहरने वाले लोगों की संख्या के लिए अनुरोध किया गया.

यह सिर्फ़ तब मौजूद होता है, जब अनुरोध में aggregateBy में partnerPropertyId की जानकारी दी गई हो.
partnerPropertyId

string

पार्टनर की प्रॉपर्टी का आईडी.

यह सिर्फ़ तब मौजूद होता है, जब अनुरोध में aggregateBy में partnerPropertyId की जानकारी दी गई हो.
partnerPropertyDisplayName

string

पार्टनर की प्रॉपर्टी का नाम.

यह सिर्फ़ तब मौजूद होता है, जब अनुरोध में aggregateBy में partnerPropertyDisplayName की जानकारी दी गई हो.
userRegionCode

string

उपयोगकर्ता के देश/इलाके का आईएसओ 3116 क्षेत्र कोड.

यह पैरामीटर सिर्फ़ तब मौजूद होता है, जब अनुरोध में aggregateBy में userRegionCode तय किया गया हो
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

इसमें, पहले से बुकिंग करने की सुविधा (एबीडब्ल्यू) के लिए उपलब्ध विंडो की जानकारी दी गई है. तारीख की सभी तुलनाएं, प्रॉपर्टी के टाइमज़ोन के हिसाब से की जाती हैं.

Enums
ADVANCE_BOOKING_WINDOW_UNSPECIFIED जानकारी नहीं दी गई है.
ADVANCE_BOOKING_WINDOW_SAME_DAY चेक-इन करने की तारीख, क्वेरी की तारीख के बराबर थी.
ADVANCE_BOOKING_WINDOW_NEXT_DAY क्वेरी की तारीख के अगले दिन चेक-इन किया गया था.
ADVANCE_BOOKING_WINDOW_DAYS_2_TO_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

इसमें ठहरने की कुल अवधि (एलओएस) के बारे में बताया जाता है.

Enums
LENGTH_OF_STAY_UNSPECIFIED जानकारी नहीं दी गई है.
LENGTH_OF_STAY_NIGHTS_1 एक रात के लिए ठहरने की सुविधा.
LENGTH_OF_STAY_NIGHTS_2 दो रातें ठहरने की सुविधा.
LENGTH_OF_STAY_NIGHTS_3 तीन रातें ठहरने की सुविधा.
LENGTH_OF_STAY_NIGHTS_4_TO_7 चार से सात रातों तक ठहरने की सुविधा.
LENGTH_OF_STAY_NIGHTS_8_TO_14 आठ से 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 रातों से ज़्यादा की बुकिंग.

बुक किया हुआ

इसमें, कमरे में मौजूद लोगों की कुल संख्या के बारे में बताया जाता है.

Enums
OCCUPANCY_UNSPECIFIED जानकारी नहीं दी गई है.
OCCUPANCY_1 एक व्यक्ति.
OCCUPANCY_2 दो उपयोगकर्ता.
OCCUPANCY_3 तीन लोग.
OCCUPANCY_4 चार लोग.
OCCUPANCY_OVER_4 चार से ज़्यादा लोग.