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 연산자를 사용하여 조건을 조인할 수 있습니다.

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에 포함됩니다.
pageSize

integer

반환할 최대 참여 결과 수입니다. 서비스가 이 값보다 더 적게 반환할 수 있습니다. 지정하지 않으면 최대 10,000개의 결과가 반환됩니다. 최댓값은 10,000이며 10,000을 초과하는 값은 10,000으로 변환됩니다.
pageToken

string

이전 engagementReportViews.query 요청에서 받은 페이지 토큰입니다. 후속 페이지를 받으려면 이 값을 입력합니다.

페이지로 나누기를 수행할 때 engagementReportViews.query에 제공된 다른 모든 매개변수는 페이지 토큰을 제공한 호출과 일치해야 합니다.

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

성공하면 응답 본문에 다음과 같은 구조의 데이터가 포함됩니다.

PropertyPerformanceReportService.QueryPropertyPerformanceReport에 대한 응답 메시지입니다.

JSON 표현 
{
  "results": [
    {
      object (PropertyPerformanceResult)
    }
  ],
  "nextPageToken": string
}
필드
results[]

object (PropertyPerformanceResult)

쿼리와 일치하는 결과 목록
nextPageToken

string

결과의 다음 페이지를 검색하는 데 사용되는 페이지로 나누기 토큰입니다. 이 필드를 생략하면 후속 페이지가 표시되지 않습니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 OAuth 2.0 개요를 참고하세요.

속성 성능 결과

계정의 속성 실적 보고서에 대한 쿼리 결과를 나타냅니다.

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
}
필드
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

파트너의 속성 ID입니다.

요청에서 aggregateBy에 partnerPropertyId이 지정된 경우에만 존재합니다.
partnerPropertyDisplayName

string

파트너 속성 이름입니다.

요청에서 aggregateBy에 partnerPropertyDisplayName이 지정된 경우에만 존재합니다.
userRegionCode

string

사용자 국가/지역의 ISO 3116 지역 코드입니다.

요청에서 aggregateBy에 userRegionCode이 지정된 경우에만 존재합니다.
clickCount

string (int64 format)

이 결과에 대해 기록된 총 클릭수입니다.
impressionCount

string (int64 format)

이 결과에 대해 기록된 총 노출수입니다. 이 값은 사용자 개인 정보 보호를 위해 반올림됩니다.
clickthroughRate

number

clickCount을 impressionCount로 나눈 값입니다.

사전 예약 기간

지원되는 사전 예약 기간 (ABW)을 열거합니다. 모든 날짜 비교는 속성의 시간대로 표시됩니다.

열거형
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일 이상 지났습니다.

투숙 기간

지원되는 숙박 기간 (LOS)을 열거합니다.

열거형
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일 이상 투숙합니다.

사람 감지

지원되는 총 회의실 점유율을 열거합니다.

열거형
OCCUPANCY_UNSPECIFIED 지정되지 않음.
OCCUPANCY_1 1명
OCCUPANCY_2 두 명입니다.
OCCUPANCY_3 3명입니다.
OCCUPANCY_4 4명.
OCCUPANCY_OVER_4 4명 초과