此页面由 Cloud Translation API 翻译。

Usage

本页介绍了使用 Travel Partner API v3 的一些示例调用。

旅游合作伙伴 API 端点接受 HTTPS 调用中的 RESTful 语法。所有 API 请求的 base_url 为：

https://travelpartner.googleapis.com/v3/accounts/account_id

如需查看请求和响应字段的完整列表，请参阅 API 资源目录。

房源效果报告

媒体资源效果报告视图服务可用于查询（获取、过滤和细分）特定账号的媒体资源效果报告。

查询媒体资源效果报告

以下示例获取账号 12345678 中所有资源的资源效果报告，过滤条件为 2022 年 5 月 11 日，并按合作伙伴酒店 ID 分组。

GET https://travelpartner.googleapis.com/v3/accounts/12345678/propertyPerformanceReportViews:query?filter=date%20%3D%20%272022-05-11%27&aggregateBy=partnerPropertyId

响应示例

{
  "results": [
    {
      "partnerPropertyId": "10001",
      "clickCount": "47"
      "impressionCount": "360"
    },
    {
      "partnerPropertyId": "10003",
      "clickCount": "23"
      "impressionCount": "400"
    },
    {
      "partnerPropertyId": "10007",
      "clickCount": "106"
      "impressionCount": "780"
    },
    {
      "partnerPropertyId": "10009",
      "clickCount": "81"
      "impressionCount": "520"
    },
  ]
}

酒店

酒店视图服务可提供特定账号的所有酒店的列表或摘要。

获取酒店列表

以下示例检索了账号 12345678 中的所有酒店的列表：

GET https://travelpartner.googleapis.com/v3/accounts/12345678/hotelViews

该请求接受用于浏览多页结果的查询参数：

GET base_url/hotelViews?pageSize=10&pageToken=11

响应示例

{
  "nextPageToken": "11",
  "hotelViews": [
    {
      "googleHotelDisplayName": "Alameda Hotel",
      "googleHotelId": "11111111111111111111",
      "partnerHotelDisplayName": "Alameda Hotel",
      "partnerHotelId": "10",
      "dataIssues": [
        "MISSING_STREET_NUMBER"
      ],
      "googleClusterId": "1131326789990787753"
    },
    {
      "googleClusterId": "11390920309628839218",
      "googleHotelDisplayName": "At Hotel",
      "googleHotelId": "9999999999999999999",
      "partnerHotelDisplayName": "At Hotel and Restaurant",
      "partnerHotelId": "100001"
    },
...
    {
      "googleHotelDisplayName": "Aquapark & Spa Hotel",
      "googleHotelId": "444444444444444444",
      "partnerHotelDisplayName": "Aquapark & Spa Hotel",
      "partnerHotelId": "100069",
      "dataIssues": [
        "MISSING_PHONE_NUMBER",
        "MISSING_STREET_NUMBER",
        "LATLONG_INCONSISTENT_WITH_ADDRESS"
      ],
      "googleClusterId": "18401597592098761505"
    }
  ]
}

获取媒体资源摘要

此示例获取了账号 12345678 的媒体资源摘要：

GET https://travelpartner.googleapis.com/v3/accounts/12345678/hotelViews:summarize

响应示例

{
  "lastManifestUpdateTime": "2019-09-26T18:24:54.479972Z",
  "matchedPropertyCount": "206107",
  "overclusteredPropertyWithErrorsCount": "16927",
  "overclusteredPropertyCount": "17611",
  "unmatchedPropertyWithErrorsCount": "93638",
  "lastFeedSubmissionTime": "2019-09-19T20:51:08Z",
  "unmatchedPropertyCount": "99673"
}

参与度报告

参与度报告查看服务可用于查询（获取、过滤和细分）特定账号的参与度报告。

查询参与度报告

以下示例获取了账号 12345678 中所有媒体资源的参与度报告，并使用 2020 年 10 月 4 日的日期过滤了该报告。

GET https://travelpartner.googleapis.com/v3/accounts/12345678/participationReportViews:query?filter=date%20%3D%20%272020-10-04%27

响应示例

{
  "results": [
    {
      "missedParticipationCountDetails": {
        "noAvailabilityCount": "628873",
        "otherReasonCount": "22",
        "hotelSuspendedCount": "262",
        "noTaxBreakdownCount": "1",
        "noLandingPageCount": "4558",
        "noPriceCount": "43194",
        "noPriceCountDetails": {
          "livePricingTechnicalIssueCount": "4795",
          "livePricingNotTriggeredCount": "2",
          "livePricingConfigIssueCount": "3",
          "livePricingNotAvailableCount": "27731",
          "livePricingOtherReasonCount": "1"
        }
        "otherReasonCount": "1"
        "priceMissingCount": "2235",
        "priceMissingCountDetails": {
          "cacheRateMissingCount": "2030",
          "itineraryBlockedCount": "196",
          "livePricingNotSetupCount": "0",
          "bandwidthDepletedCount": "1",
          "livePricingTimeoutCount": "8",
          "livePricingErrorCount": "0"
        }
        "priceProblemCount": "0",
        "priceProblemCountDetails": {
          "hotelSuspendedCount": "0",
          "priceUnusuallyHighCount": "0",
          "priceUnusuallyLowCount": "0",
          "taxesAndFeesMissingCount": "0"
        }
        "priceUnavailableCount": "0",
        "priceUnavailableCountDetails": {
          "priceUnavailableCount": "0",
          "participationNotLikelyCount": "0"
        }
      },
      "participationCount": "1298876",
      "missedParticipationCount": "679146",
      "opportunityCount": "1975787",
      "participationPercent": 0.6573967740444975
    }
  ]
}

价格准确性

借助 Price Accuracy Views Service，您可以检索特定账号的价格准确性报告和记分卡。

获取价格准确性报告

以下示例检索账号 12345678 在 2019 年 8 月 26 日的价格准确性报告：

GET https://travelpartner.googleapis.com/v3/accounts/12345678/priceAccuracyViews/20190826

除了用于分页浏览响应的常规查询参数之外，还有一些参数可用于在结果中包含匹配的价格或像素信号。

在此示例中，2019 年 8 月 26 日的价格准确性报告包含匹配的价格和像素信号：

GET base_url/priceAccuracyViews/20190826?includeMatchedPrices=true&includePixels=true

列出了可用的价格准确性报告

如需获取可用报告的列表，请发送以下请求：

GET https://travelpartner.googleapis.com/v3/accounts/12345678/priceAccuracyViews

您可以添加用于对结果进行分页的常规查询参数。

响应示例

{
  "priceAccuracyViews": [
    {
      "name": "accounts/12345678/priceAccuracyViews/20190925"
    },
...
    {
      "name": "accounts/12345678/priceAccuracyViews/20190827"
    }
  ]
}

获取价格准确性得分

如需获取价格准确性得分卡，请使用 summarize 方法：

GET https://travelpartner.googleapis.com/v3/accounts/12345678/priceAccuracyViews:summarize

响应示例

{
  "updateTime": "2019-09-26T18:29:32.372204Z",
  "currentScore": "EXCELLENT",
  "predictedScore": "EXCELLENT"
}

价格覆盖率

价格覆盖率视图服务可提供最新的价格覆盖率报告或完整的价格覆盖率历史记录。

获取最新的价格覆盖率统计信息

以下示例检索了账号 12345678 的最新价格覆盖率统计信息：

GET https://travelpartner.googleapis.com/v3/accounts/12345678/priceCoverageViews:latest

响应示例

{
  "calculationDate": {
    "month": 10,
    "day": 1,
    "year": 2019
  },
  "priceCoveragePercent": 7.683124346337668,
  "matchedPropertyCount": 486546,
  "priceCoverageBuckets": [
    {
      "availablePriceCount": "57708897",
      "advanceBookingWindowRange": "DAYS_0_TO_30",
      "priceCoveragePercent": 54.65867924338515,
      "lengthOfStayRange": "LENGTH_OF_STAY_1_TO_7"
    },
    {
      "availablePriceCount": "44221",
      "advanceBookingWindowRange": "DAYS_0_TO_30",
      "priceCoveragePercent": 0.04188368831276978,
      "lengthOfStayRange": "LENGTH_OF_STAY_8_TO_14"
    },
    {
      "availablePriceCount": "59988397",
      "advanceBookingWindowRange": "DAYS_31_TO_60",
      "priceCoveragePercent": 58.71161890824986,
      "lengthOfStayRange": "LENGTH_OF_STAY_1_TO_7"
    },
    {
      "availablePriceCount": "8805",
      "advanceBookingWindowRange": "DAYS_31_TO_60",
      "priceCoveragePercent": 0.008617596574336533,
      "lengthOfStayRange": "LENGTH_OF_STAY_8_TO_14"
    },
    {
      "availablePriceCount": "55096752",
      "advanceBookingWindowRange": "DAYS_61_TO_90",
      "priceCoveragePercent": 53.9240864613594,
      "lengthOfStayRange": "LENGTH_OF_STAY_1_TO_7"
    },
    {
      "availablePriceCount": "11747",
      "advanceBookingWindowRange": "DAYS_61_TO_90",
      "priceCoveragePercent": 0.011496979779526548,
      "lengthOfStayRange": "LENGTH_OF_STAY_8_TO_14"
    },
    {
      "availablePriceCount": "117074",
      "advanceBookingWindowRange": "DAYS_91_TO_120",
      "priceCoveragePercent": 0.11458222616057641,
      "lengthOfStayRange": "LENGTH_OF_STAY_1_TO_7"
    },
    {
      "availablePriceCount": "7527",
      "advanceBookingWindowRange": "DAYS_91_TO_120",
      "priceCoveragePercent": 0.007366797207839987,
      "lengthOfStayRange": "LENGTH_OF_STAY_8_TO_14"
    },
    {
      "availablePriceCount": "71904",
      "advanceBookingWindowRange": "DAYS_121_TO_150",
      "priceCoveragePercent": 0.07037361318354277,
      "lengthOfStayRange": "LENGTH_OF_STAY_1_TO_7"
    },
    {
      "availablePriceCount": "5544",
      "advanceBookingWindowRange": "DAYS_121_TO_150",
      "priceCoveragePercent": 0.005426002885646989,
      "lengthOfStayRange": "LENGTH_OF_STAY_8_TO_14"
    },
    {
      "availablePriceCount": "56528",
      "advanceBookingWindowRange": "DAYS_151_TO_180",
      "priceCoveragePercent": 0.05532487213561562,
      "lengthOfStayRange": "LENGTH_OF_STAY_1_TO_7"
    },
    {
      "availablePriceCount": "4680",
      "advanceBookingWindowRange": "DAYS_151_TO_180",
      "priceCoveragePercent": 0.00458039204632538,
      "lengthOfStayRange": "LENGTH_OF_STAY_8_TO_14"
    },
    {
      "availablePriceCount": "29269",
      "advanceBookingWindowRange": "DAYS_181_TO_210",
      "priceCoveragePercent": 0.02864604589826871,
      "lengthOfStayRange": "LENGTH_OF_STAY_1_TO_7"
    },
    {
      "availablePriceCount": "2336",
      "advanceBookingWindowRange": "DAYS_181_TO_210",
      "priceCoveragePercent": 0.0022862811581658314,
      "lengthOfStayRange": "LENGTH_OF_STAY_8_TO_14"
    },
    {
      "availablePriceCount": "22967",
      "advanceBookingWindowRange": "DAYS_211_TO_240",
      "priceCoveragePercent": 0.022478176095716885,
      "lengthOfStayRange": "LENGTH_OF_STAY_1_TO_7"
    },
    {
      "availablePriceCount": "1906",
      "advanceBookingWindowRange": "DAYS_211_TO_240",
      "priceCoveragePercent": 0.001865433171003456,
      "lengthOfStayRange": "LENGTH_OF_STAY_8_TO_14"
    },
    {
      "availablePriceCount": "19387",
      "advanceBookingWindowRange": "DAYS_241_TO_270",
      "priceCoveragePercent": 0.01897437192352781,
      "lengthOfStayRange": "LENGTH_OF_STAY_1_TO_7"
    },
    {
      "availablePriceCount": "2179",
      "advanceBookingWindowRange": "DAYS_241_TO_270",
      "priceCoveragePercent": 0.0021326227070391033,
      "lengthOfStayRange": "LENGTH_OF_STAY_8_TO_14"
    },
    {
      "availablePriceCount": "14102",
      "advanceBookingWindowRange": "DAYS_271_TO_300",
      "priceCoveragePercent": 0.013801856546427458,
      "lengthOfStayRange": "LENGTH_OF_STAY_1_TO_7"
    },
    {
      "availablePriceCount": "2048",
      "advanceBookingWindowRange": "DAYS_271_TO_300",
      "priceCoveragePercent": 0.0020044108783919615,
      "lengthOfStayRange": "LENGTH_OF_STAY_8_TO_14"
    },
    {
      "availablePriceCount": "10280",
      "advanceBookingWindowRange": "DAYS_301_TO_330",
      "priceCoveragePercent": 0.010061203041928398,
      "lengthOfStayRange": "LENGTH_OF_STAY_1_TO_7"
    },
    {
      "availablePriceCount": "1333",
      "advanceBookingWindowRange": "DAYS_301_TO_330",
      "priceCoveragePercent": 0.0013046287602033614,
      "lengthOfStayRange": "LENGTH_OF_STAY_8_TO_14"
    }
  ],
  "priceCoverageBinaryPercent": 76.38722751805585
}

获取价格覆盖率历史记录

此请求会获取账号的整个价格覆盖范围历史记录：

GET https://travelpartner.googleapis.com/v3/accounts/12345678/priceCoverageViews

响应示例

{
  "priceCoverageViews": [
    {
      "calculationDate": {
        "month": 9,
        "day": 17,
        "year": 2019
      },
      "priceCoveragePercent": 7.75351958685931,
      "matchedPropertyCount": 492550,
      "priceCoverageBuckets": [
        {
          "availablePriceCount": "57557901",
          "advanceBookingWindowRange": "DAYS_0_TO_30",
          "priceCoveragePercent": 53.85113864788107,
          "lengthOfStayRange": "LENGTH_OF_STAY_1_TO_7"
        },
        {
          "availablePriceCount": "40549",
          "advanceBookingWindowRange": "DAYS_0_TO_30",
          "priceCoveragePercent": 0.037937620780037304,
          "lengthOfStayRange": "LENGTH_OF_STAY_8_TO_14"
        },
        {
          "availablePriceCount": "60927294",
          "advanceBookingWindowRange": "DAYS_31_TO_60",
          "priceCoveragePercent": 58.90365880186203,
          "lengthOfStayRange": "LENGTH_OF_STAY_1_TO_7"
        },
        {
          "availablePriceCount": "9151",
          "advanceBookingWindowRange": "DAYS_31_TO_60",
          "priceCoveragePercent": 0.00884705927848756,
          "lengthOfStayRange": "LENGTH_OF_STAY_8_TO_14"
        },
        {
          "availablePriceCount": "58125328",
          "advanceBookingWindowRange": "DAYS_61_TO_90",
          "priceCoveragePercent": 56.19475711917089,
          "lengthOfStayRange": "LENGTH_OF_STAY_1_TO_7"
        },
        {
          "availablePriceCount": "6943",
          "advanceBookingWindowRange": "DAYS_61_TO_90",
          "priceCoveragePercent": 0.0067123956475291366,
          "lengthOfStayRange": "LENGTH_OF_STAY_8_TO_14"
        },
        {
          "availablePriceCount": "112206",
          "advanceBookingWindowRange": "DAYS_91_TO_120",
          "priceCoveragePercent": 0.10847919718085183,
          "lengthOfStayRange": "LENGTH_OF_STAY_1_TO_7"
        },
        {
          "availablePriceCount": "9665",
          "advanceBookingWindowRange": "DAYS_91_TO_120",
          "priceCoveragePercent": 0.00934398731576683,
          "lengthOfStayRange": "LENGTH_OF_STAY_8_TO_14"
        },
        {
          "availablePriceCount": "42373",
          "advanceBookingWindowRange": "DAYS_121_TO_150",
          "priceCoveragePercent": 0.04096562592146797,
          "lengthOfStayRange": "LENGTH_OF_STAY_1_TO_7"
        },
        {
          "availablePriceCount": "4123",
          "advanceBookingWindowRange": "DAYS_121_TO_150",
          "priceCoveragePercent": 0.0039860589449463675,
          "lengthOfStayRange": "LENGTH_OF_STAY_8_TO_14"
        },
        {
          "availablePriceCount": "34813",
          "advanceBookingWindowRange": "DAYS_151_TO_180",
          "priceCoveragePercent": 0.033656723271990756,
          "lengthOfStayRange": "LENGTH_OF_STAY_1_TO_7"
        },
        {
          "availablePriceCount": "3296",
          "advanceBookingWindowRange": "DAYS_151_TO_180",
          "priceCoveragePercent": 0.003186526869401704,
          "lengthOfStayRange": "LENGTH_OF_STAY_8_TO_14"
        },
        {
          "availablePriceCount": "26839",
          "advanceBookingWindowRange": "DAYS_181_TO_210",
          "priceCoveragePercent": 0.02594757119170884,
          "lengthOfStayRange": "LENGTH_OF_STAY_1_TO_7"
        },
        {
          "availablePriceCount": "2188",
          "advanceBookingWindowRange": "DAYS_181_TO_210",
          "priceCoveragePercent": 0.00211532790966351,
          "lengthOfStayRange": "LENGTH_OF_STAY_8_TO_14"
        },
        {
          "availablePriceCount": "20301",
          "advanceBookingWindowRange": "DAYS_211_TO_240",
          "priceCoveragePercent": 0.0196267239004017,
          "lengthOfStayRange": "LENGTH_OF_STAY_1_TO_7"
        },
        {
          "availablePriceCount": "1589",
          "advanceBookingWindowRange": "DAYS_211_TO_240",
          "priceCoveragePercent": 0.0015362230568808583,
          "lengthOfStayRange": "LENGTH_OF_STAY_8_TO_14"
        },
        {
          "availablePriceCount": "17661",
          "advanceBookingWindowRange": "DAYS_241_TO_270",
          "priceCoveragePercent": 0.01707440868947315,
          "lengthOfStayRange": "LENGTH_OF_STAY_1_TO_7"
        },
        {
          "availablePriceCount": "1768",
          "advanceBookingWindowRange": "DAYS_241_TO_270",
          "priceCoveragePercent": 0.0017092777624703316,
          "lengthOfStayRange": "LENGTH_OF_STAY_8_TO_14"
        },
        {
          "availablePriceCount": "14245",
          "advanceBookingWindowRange": "DAYS_271_TO_300",
          "priceCoveragePercent": 0.013771867492301967,
          "lengthOfStayRange": "LENGTH_OF_STAY_1_TO_7"
        },
        {
          "availablePriceCount": "2019",
          "advanceBookingWindowRange": "DAYS_271_TO_300",
          "priceCoveragePercent": 0.0019519410647214931,
          "lengthOfStayRange": "LENGTH_OF_STAY_8_TO_14"
        },
        {
          "availablePriceCount": "10625",
          "advanceBookingWindowRange": "DAYS_301_TO_330",
          "priceCoveragePercent": 0.010272101937922665,
          "lengthOfStayRange": "LENGTH_OF_STAY_1_TO_7"
        },
        {
          "availablePriceCount": "1401",
          "advanceBookingWindowRange": "DAYS_301_TO_330",
          "priceCoveragePercent": 0.0013544672767086734,
          "lengthOfStayRange": "LENGTH_OF_STAY_8_TO_14"
        }
      ],
      "priceCoverageBinaryPercent": 77.83737691604914
    },
...
  ]
}

价格

借助 Price Views Service，您可以检索指定房源的价格报告。

获取房源的价格数据

如需获取属于账号 12345678 的特定酒店（ID 为 101）的价格报告，请发出以下请求：

GET https://travelpartner.googleapis.com/v3/accounts/12345678/priceViews/101

响应示例

{
  "perItineraryPrices": [
    {
      "updateTime": "2019-09-30T23:24:32Z",
      "checkinDate": {
        "month": 9,
        "day": 30,
        "year": 2019
      },
      "taxes": 8.83,
      "currencyCode": "USD",
      "lengthOfStayDays": 1,
      "roomAvailable": true,
      "price": 68.25
    },
...
    {
      "updateTime": "2019-10-02T03:32:22.347810Z",
      "checkinDate": {
        "month": 4,
        "day": 23,
        "year": 2020
      },
      "currencyCode": "USD",
      "price": -1,
      "lengthOfStayDays": 3,
      "allInclusive": true
    }
  ],
  "name": "accounts/12345678/priceViews/101"
}

对账报告

借助对账报告服务，您可以获取报告列表、下载特定报告、验证报告，然后将报告上传到 Google。

获取对账报告列表

以下示例获取账号 12345678 的报告列表：

GET https://travelpartner.googleapis.com/v3/accounts/12345678/reconciliationReports

您可以添加可选的开始日期和结束日期查询参数来限制结果。例如，以下查询将报告限定为仅包含 2019 年 6 月 15 日至 2019 年 9 月 15 日之间的数据：

GET base_url/reconciliationReports?startDate=2019-06-15&endDate=2019-09-15

响应示例

{
  "reconciliationReports": [
    {
      "name": "accounts/12345678/reconciliationReports/2019-09-19T08:32:00~booking_report.csv"
    }
  ]
}

下载对账报告

此示例检索在 2019-08-26T12:00:00 上传的 booking_report.csv 报告（以 JSON 响应的形式）：

GET base_url/reconciliationReports/2019-08-26T12%3A00%3A00~bookings.csv

响应示例

{
  "contents": "Hotel ID,Hotel Name,Hotel Address,Hotel City,Hotel State/Region,Hotel PostalCode,Hotel Country Code,Hotel Phone Number,Booking Reference,Booking Date and Time,Check-in Date,Check-out Date,Number of Rooms,Number of Guests,Booking Revenue,Booking Revenue Currency,Booking Revenue Currency to Billing Currency Conversion Rate,Booking Status,Commission,Commission Currency,Commission Currency to Billing Currency Conversion Rate,Payment Date,Payment Status\n\n111,\"Capybara Hotel and Spa\",123 Foo Driveway,Boston,MA,02472,US,+11234567890,2thHRTY,2016-01-04,2016-02-01,2016-02-03,1,4,213.88,USD,1,Stayed,21.39,USD,1.0,2016-06-07,Invoice Required\n\n211,\"Mabels Gabels\",45678 Bar Street,London,,KT13 0PU,GB,+440203456123,z452121A,2016-02-04,2016-02-01,2016-02-03,1,3,414.21,GBP,1.249,Stayed,64.43,USD,1.0,2016-06-07,Invoice Required\n\n311,\"No-Tell Motels\",66 Acacia Avenue,Geneva,,1211,CH,+412241820000,42,2016-03-04,2016-02-01,2016-02-03,1,2,451.15,CHF,1.05,Stayed,37.41,EUR,0.99889,2016-06-07,Invoice Required"
}

验证对账报告

您可以使用此方法在上传报告之前对其进行验证。验证报告不会上传报告。

对账报告包含在请求正文中，作为 contents 字段的值。对账报告必须遵循对账报告中所述的语法。

以下示例验证了账号 12345678 的报告：

POST https://travelpartner.googleapis.com/v3/accounts/12345678/reconciliationReports:validate

成功响应示例

{
  "successfulRecordCount": 3
}

上传对账报告

确认对账报告有效后，您可以像以下示例中那样将其上传到 Google：

POST https://travelpartner.googleapis.com/v3/accounts/12345678/reconciliationReports

成功响应示例

{
  "successfulRecordCount": 3,
  "reconciliationReport": {
    "name": "accounts/12345678/reconciliationReports/2019-09-30T09:17~2019-09-19T08:32:00~booking_report.csv"
  }
}

Usage 使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

房源效果报告

查询媒体资源效果报告

响应示例

酒店

获取酒店列表

响应示例

获取媒体资源摘要

响应示例

参与度报告

查询参与度报告

响应示例

价格准确性

获取价格准确性报告

列出了可用的价格准确性报告

响应示例

获取价格准确性得分

响应示例

价格覆盖率

获取最新的价格覆盖率统计信息

响应示例

获取价格覆盖率历史记录

响应示例

价格

获取房源的价格数据

响应示例

对账报告

获取对账报告列表

响应示例

下载对账报告

响应示例

验证对账报告

成功响应示例

上传对账报告

成功响应示例

Usage