Method: accounts.participationReportViews.query

可查詢特定帳戶參與報表 (取得、篩選和區隔) 的功能。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
name

string

所查詢帳戶的資源名稱。格式為 accounts/{account_id}

查詢參數

參數
filter

string

用於篩選所查詢帳戶的參與度指標的條件 (欄位和運算式)。語法必須有 in 運算子周圍的空格。否則,您可以省略空格。您可以使用 and 運算子彙整條件。

date 為必填欄位。其他欄位則為選填欄位。

有效的條件範例如下:

  • 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

指定如何區隔查詢傳回的指標。舉例來說,如果將 userRegionCode 指定為 aggregateBy 的值,participationResult 就會提供依使用者區域匯總的指標。

字串值是以半形逗號分隔的欄位清單。有效欄位包括:dateuserRegionCodedeviceTypepartnerHotelIdhotelRegionCodeadvanceBookingWindowlengthOfStayDayscheckinDateoccupancy。未指定的欄位不會包含在 ParticipationResult。

如果使用 aggregateBy 規格產生大量的資料列,就會發生錯誤。匯總 partnerHotelId 或兩個以上的欄位時,這點尤其重要。為避免發生錯誤,請在 partnerHotelIddate 中進行篩選,即可只選取特定飯店和日期。大量飯店的帳戶需要進一步篩選資料。

pageSize

integer

要傳回的參與結果上限。服務傳回的值可能會低於這個值。如果未指定,則最多傳回 10,000 筆結果。最大值為 10,000;高於 10,000 的值將強制轉換成 10,000。

pageToken

string

您先前從 engagementReportViews.query 要求收到的頁面權杖,請提供這項資訊,以便接收後續頁面。

進行分頁時,提供給 engagementReportViews.query 的所有其他參數都必須與提供網頁權杖的呼叫相符。

要求主體

要求主體必須為空白。

回應主體

如果成功,回應主體即會包含具有以下結構的資料:

ParticipationReportService.QueryParticipationReport」的回應訊息。

JSON 表示法
{
  "results": [
    {
      object (ParticipationResult)
    }
  ],
  "nextPageToken": string
}
欄位
results[]

object (ParticipationResult)

符合查詢的結果清單。

nextPageToken

string

用於擷取下一頁結果的分頁符記。

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱 OAuth 2.0 總覽

參加結果

代表查詢帳戶的參與統計資料產生的結果。

JSON 表示法
{
  "key": {
    object (Key)
  },
  "opportunityCount": string,
  "participationCount": string,
  "participationPercent": number,
  "missedParticipationCount": string,
  "missedParticipationCountDetails": {
    object (MissedParticipationCountDetails)
  },
  "partnerHotelDisplayName": string
}
欄位
key

object (Key)

結果的鍵。

opportunityCount

string (int64 format)

特定飯店的商機總數。「商機」是指飯店廣告可向使用者顯示的次數總數。

participationCount

string (int64 format)

您在 Google Ads 競價程序中符合申請資格的商機總數。

participationPercent

number

成功參與的商機數量除以商機總數的百分比。舉例來說,假設某項資源可在 100 個商機中 90 次參加 Google Ads 競價,參與率就是 90%。

missedParticipationCount

string (int64 format)

「不符合」Google Ads 競價程序資格的商機總數。包括:

  • 缺少到達網頁
  • 缺少價格資訊
  • 價格資訊有問題
  • 沒有可用的價格資訊
  • 其他
missedParticipationCountDetails

object (MissedParticipationCountDetails)

導致錯失的參與原因 (例如沒有空位),以及每個原因的總數。

partnerHotelDisplayName

string

合作夥伴的顯示名稱。只有在 partnerHotelId 匯總結果時,才會填入這個欄位。

索引鍵

結果金鑰。

JSON 表示法
{
  "date": {
    object (Date)
  },
  "userRegionCode": string,
  "deviceType": enum (Device),
  "partnerHotelId": string,
  "hotelRegionCode": string,
  "advanceBookingWindow": integer,
  "lengthOfStayDays": integer,
  "checkinDate": {
    object (Date)
  },
  "occupancy": integer
}
欄位
date

object (Date)

您要求指標的日期。

如果 date 不是要求呼叫中的 aggregateBy 參數值,則 Key 不會傳回 date 欄位。

userRegionCode

string

使用者所在國家/地區的 ISO 3116 區域代碼。

如果 userRegionCode 不是要求呼叫中的 aggregateBy 參數值,則 Key 不會傳回 userRegionCode 欄位。

deviceType

enum (Device)

使用者的裝置類型。

如果 deviceType 不是要求呼叫中的 aggregateBy 參數值,則 Key 不會傳回 deviceType 欄位。

partnerHotelId

string

合作夥伴的飯店 ID。

如果 partnerHotelId 不是要求呼叫中的 aggregateBy 參數值,則 Key 不會傳回 partnerHotelId 欄位。

hotelRegionCode

string

飯店所在國家/地區的 CLDR 區域代碼。

如果 hotelRegionCode 不是要求呼叫中的 aggregateBy 參數值,則 Key 不會傳回 hotelRegionCode 欄位。

advanceBookingWindow

integer

使用者提前預訂行程的天數。

如果 advanceBookingWindow 不是要求呼叫中的 aggregateBy 參數值,則 Key 不會傳回 advanceBookingWindow 欄位。

lengthOfStayDays

integer

行程的住宿天數。

如果 lengthOfStayDays 不是要求呼叫中的 aggregateBy 參數值,則 Key 不會傳回 lengthOfStayDays 欄位。

checkinDate

object (Date)

行程的入住日期。

如果 checkinDate 不是要求呼叫中的 aggregateBy 參數值,則 Key 不會傳回 checkinDate 欄位。

occupancy

integer

行程的總座位佔用率。

如果 occupancy 不是要求呼叫中的 aggregateBy 參數值,則 Key 不會傳回 occupancy 欄位。

遺漏的部分計數詳細資料

錯過的參與次數 (按原因細分)。

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)
  }
}
欄位
noAvailabilityCount
(deprecated)

string (int64 format)

因缺少飯店/行程組合或旅客不符合該房價的資格,而錯失的參與總數。如要參與這些競價,您可能需要提供更多價格資訊。

hotelSuspendedCount
(deprecated)

string (int64 format)

一或多間飯店因價格準確性遭到停權,而未參與的參與者總數。

noTaxBreakdownCount
(deprecated)

string (int64 format)

您有一或多間飯店未個別指定稅金和費用的遺漏參與總數。

noLandingPageCount

string (int64 format)

沒有任何到達網頁與使用者相符。

noPriceCount
(deprecated)

string (int64 format)

因行程行程未提供價格而錯失的參與者總數。

noPriceCountDetails
(deprecated)

object (NoPriceCountDetails)

導致無價格計數的原因 (例如無法使用即時價格),以及每個原因的總數。

otherReasonCount

string (int64 format)

飯店不明,原因不明。

priceMissingCount

string (int64 format)

因 Google 快取中的價格不存在,或無法成功回應即時價格,而錯失的參與者總數。包括:

  • 頻寬用盡
  • 缺少快取速率
  • 行程已遭封鎖
  • 尚未設定即時價格
  • 即時定價逾時
  • 即時價格錯誤
priceMissingCountDetails

object (PriceMissingCountDetails)

導致價格遺失的原因。

priceProblemCount

string (int64 format)

因行程行程的價格準確性而錯失的參與總數。包括:

  • 飯店已遭停權
  • 價格異常高
  • 價格異常低
  • 缺少稅金和動態饋給
priceProblemCountDetails

object (PriceProblemCountDetails)

造成價格問題的原因。

priceUnavailableCount

string (int64 format)

要求行程中因無法使用 (-1) 的價格而錯失的參與總數。包括:

  • 沒有可用的價格資訊
  • 不太可能會參加
  • 其他
priceUnavailableCountDetails

object (PriceUnavailableCountDetails)

導致價格無法使用的原因。

沒有價格詳細資料

導致無價格計數的原因,以及每個原因的總數。

JSON 表示法
{
  "livePricingTechnicalIssueCount": string,
  "livePricingNotTriggeredCount": string,
  "livePricingConfigIssueCount": string,
  "livePricingNotAvailableCount": string,
  "livePricingOtherReasonCount": string
}
欄位
livePricingTechnicalIssueCount

string (int64 format)

因即時定價功能發生技術問題,導致您錯失的參與總數 (原因如下):

  • 您的回應速度不夠快,超過回應期限 (約 4000 毫秒)。
  • 您傳回錯誤。
  • 你的回覆格式錯誤。
livePricingNotTriggeredCount

string (int64 format)

因即時定價而未觸發的計畫參與計畫總數,原因如下:

  • 您尚未設定出價。
  • 您的到達網頁無效。
  • 快取中的資料不足。
livePricingConfigIssueCount

string (int64 format)

因即時定價而未觸發的計畫參與計畫總數,原因如下:

  • 您尚未針對這些搜尋設定即時價格。
  • 您已限制 Google 存取有問題的飯店行程。
livePricingNotAvailableCount

string (int64 format)

因無法使用即時價格而錯失的總人數。即時價格不適用於特定預設行程或使用者介面。在這種情況下,合作夥伴就需要快取價格才能參與。

livePricingOtherReasonCount

string (int64 format)

因即時定價其他問題而錯失的參與者人數。

價格遺失詳細資料

導致價格遺失的原因,以及每個原因的總數。

JSON 表示法
{
  "cacheRateMissingCount": string,
  "itineraryBlockedCount": string,
  "livePricingNotSetupCount": string,
  "bandwidthDepletedCount": string,
  "livePricingTimeoutCount": string,
  "livePricingErrorCount": string
}
欄位
cacheRateMissingCount

string (int64 format)

此行程的快取中沒有價格。由於頁面限制,系統無法執行即時查詢。

itineraryBlockedCount

string (int64 format)

行程不在基本參數外,因此不會針對即時查詢或快取填補行程傳回行程的價格。

livePricingNotSetupCount

string (int64 format)

此行程沒有任何快取價格,且未針對這個帳戶設定即時查詢。

bandwidthDepletedCount

string (int64 format)

這個行程沒有快取價格,也沒有任何即時查詢配額。

livePricingTimeoutCount

string (int64 format)

這個行程沒有任何快取,而且傳送至系統的即時查詢逾時。

livePricingErrorCount

string (int64 format)

此行程沒有任何快取價格。即時查詢並未逾時,但系統傳回錯誤。

價格問題數量詳細資料

造成價格問題的原因及每個原因的總數。

JSON 表示法
{
  "hotelSuspendedCount": string,
  "priceUnusuallyHighCount": string,
  "priceUnusuallyLowCount": string,
  "taxesAndFeesMissingCount": string
}
欄位
hotelSuspendedCount

string (int64 format)

飯店已遭停權。原因可能是稅金和費用不正確等方面持續存在。

priceUnusuallyHighCount

string (int64 format)

相較於地區趨勢,這個行程提供的價格似乎有些高。

priceUnusuallyLowCount

string (int64 format)

相較於地區趨勢,這個行程提供的價格似乎有些微。

taxesAndFeesMissingCount

string (int64 format)

定價缺少稅金和費用。

價格無法使用數量詳細資料

影響價格無法使用的原因,以及每個原因的總數。

JSON 表示法
{
  "priceUnavailableCount": string,
  "participationNotLikelyCount": string
}
欄位
priceUnavailableCount

string (int64 format)

無法參與飯店,因為該行程沒有行程日期。

participationNotLikelyCount

string (int64 format)

您的行程沒有快取任何價格,因此您的伺服器通常會告訴我們飯店已停業或售罄,因此並未執行即時查詢。