透過 API 查詢商家狀態

用途

Google 地圖預訂 API 提供兩種方法，可用於以程式輔助方式，為各種動作中心整合或在地服務廣告目錄，擷取個別商家的狀態。

Merchant Status API 的用途：

  • 強化現有客戶關係管理工具，向顧客展示其庫存在 Actions Center 平台上的顯示方式。
  • 建立資訊主頁，追蹤商家的商品目錄狀態和比對狀態。
  • 以程式輔助方式擷取商家相符和可預訂狀態，並修正任何不正確的資訊，以提升資料品質。

商家狀態包含哪些內容

MerchantStatus 包含下列資訊：

  • 商家庫存狀態：適用於預訂和/或候補名單商家。
  • 商家比對狀態：包括相符商家資訊的詳細資料
  • 僅適用於 Google 在地生活服務廣告) 相符的商家服務供應商： 包括客戶 ID 和服務類別。
  • 網址，用來展示商家如何透過「透過 Google 預訂」顯示。

查詢單一商家狀態

如要取得單一商家的狀態，請使用 inventory.partners.merchants.getStatus：

GET https://mapsbooking.googleapis.com/v1alpha/inventory/partners/{partnerId}/merchants/{merchantId}/status

以下是 Python 程式碼範例 (如需更多語言的範例，請參閱這裡)：

from google.auth.transport.requests import AuthorizedSession
from google.oauth2 import service_account

credentials = service_account.Credentials.from_service_account_file(
    './your_key.json')
scoped_credentials = credentials.with_scopes(
    ['https://www.googleapis.com/auth/mapsbooking'])
authed_session = AuthorizedSession(scoped_credentials)

response = authed_session.get('https://partnerdev-mapsbooking.googleapis.com' +
    '/v1alpha/inventory/partners/123456789/merchants/001/status')

MerchantStatus 回應範例如下：

  {
    "name": "partners/123456789/merchants/001/status",
    "merchantName": "Foo Bar Restaurant",
    "inputGeoInfo": {
      "unstructured_address": "123 Foo Bar Street, Mountain View"
    },
    "processingStatus": "COMPLETED",
    "bookingStatus": {
      "hasValidFutureInventory": true
    },
    "waitlistStatus": {
      "hasValidWaitlistService": true
    }
    "geoMatch": {
      "name": "Foo Bar Restaurant",
      "formattedAddress": "123 Foo Bar St, Mountain View, CA 94043",
      "placeId": "ChIAAAAAAAAABBBBBBBB"
    },
    "directUrls": [
      {
        "type": "BOOKING",
        "url": "https://reserve-partnerdev.sandbox.google.com/maps/reserve/v/dine/m/Nwaaaaa"
      },
      {
        "type": "WAITLIST",
        "url": "https://reserve-partnerdev.sandbox.google.com/maps/reserve/v/wait/c/iDbbbbb"
      }
    ]
  }

大量擷取商家狀態

你可以使用 inventory.partners.merchants.status.list，擷取所有商家或符合特定目錄/比對條件的商家群組狀態。舉例來說，您可以發出這項呼叫，取得所有不相符的商家，以及有效的未來日期預訂庫存：

GET https://mapsbooking.googleapis.com/v1alpha/inventory/partners/{partnerId}/merchants/status?pageSize=50&bookingInventoryStatusRestrict=HAS_VALID_FUTURE_INVENTORY&geoMatchRestrict=GEO_UNMATCHED

回應範例如下：

  {
    "merchantStatuses": [
      {
        "name": "partners/123456789/merchants/002/status",
        "merchantName": "Bar Foo Restaurant",
        "inputGeoInfo": {
          "unstructured_address": "234 Bar Foo Street, Mountain View"
        },
        "processingStatus": "COMPLETED",
        "bookingStatus": {
          "hasValidFutureInventory": true
        },
        "waitlistStatus": {},
      },
      ...
      {
        "name": "partners/123456789/merchants/080/status",
        "merchantName": "Baz Restaurant",
        "inputGeoInfo": {
          "unstructured_address": "345 Baz Street, Mountain View"
        },
        "processingStatus": "COMPLETED",
        "bookingStatus": {
          "hasValidFutureInventory": true
        },
        "waitlistStatus": {
          "hasValidWaitlistService": true
        },
      },
    ],
    "nextPageToken": "AAABBBB"
  }

這項回應會包含 50 個符合篩選條件的 MerchantStatus，並依 merchant_id 排序。回應也會包含頁面權杖 (如果不是最後一頁)，用於查詢下一頁。

請注意：所有頁面的篩選條件應保持一致。

最佳做法

由於商家狀態通常不會經常變更，建議您快取擷取的結果，並定期 (例如每隔幾小時) 透過新查詢擷取結果。如果每秒要求數量過高，動作中心可能會限制查詢次數。