通过 API 查询商家状态

使用场景

Google 地图预订 API 提供了两种方法,可用于以编程方式检索各个商家的状态,以便与各种 Action Center 集成或 Local Services Ads 广告资源进行集成。

Merchant Status API 的用例:

  • 改进现有的客户关系管理工具,向客户展示其商品在 Action 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 个满足过滤条件且按 merchant_id 排序的 MerchantStatus。响应中还包含用于查询下一页的页面令牌(如果不是最后一页)。

请注意:过滤条件应在所有网页中保持一致。

最佳做法

由于商家状态在大多数情况下不会频繁更改,因此建议您缓存检索到的结果,并定期(例如每隔几个小时)通过新查询检索这些结果。如果每秒请求数量过高,Action Center 可能会限制您的查询。