Como consultar o status do comerciante pela API

Casos de uso

A API Google Maps Booking oferece dois métodos que podem ser usados para recuperar de forma programática o status dos comerciantes individuais para várias integrações ou inventário de anúncios de serviços locais.

Casos de uso da API Merchant Status:

  • Melhore as ferramentas de gestão de relacionamento com o cliente para mostrar aos clientes como o inventário deles é exibido no Google.
  • Crie um painel para acompanhar o status do inventário e da correspondência dos seus comerciantes.
  • Extraia de forma programática os status de correspondência e de reserva dos seus comerciantes e corrija as informações incorretas para melhorar a qualidade dos dados.

O que o status do comerciante contém

O MerchantStatus contém as seguintes informações:

  • Status do inventário do comerciante: se aplica a comerciantes de reservas e/ou de lista de espera.
  • Status de correspondência do comerciante: inclui detalhes sobre a ficha da empresa correspondente
  • Somente para anúncios do Google Serviços Locais: provedor de serviços do comerciante correspondente: inclui o ID do cliente e as categorias de serviço.
  • Os URLs para demonstrar como o comerciante aparece no Google.

Consultar o status de um único comerciante

É possível receber o status de um único comerciante usando inventory.partners.merchants.getStatus: 

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

Confira um exemplo de código Python (confira exemplos em mais idiomas aqui): 

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')

Um exemplo de resposta MerchantStatus é semelhante a este: 

  {
    "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"
      }
    ]
  }

Extrair status de comerciantes em massa

É possível extrair os status de todos os comerciantes ou de um grupo de comerciantes que atendem a determinadas condições de inventário/correspondência usando inventory.partners.merchants.status.list. Por exemplo, você pode fazer esta chamada para receber todos os comerciantes sem correspondência com inventário de reserva válido futuro: 

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

Um exemplo de resposta seria assim:

  {
    "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"
  }

Essa resposta vai conter 50 MerchantStatus que atendem às condições de filtragem e são ordenados por merchant_id. A resposta também contém um token de página (se não for a última página) para consultar a próxima.

As condições de filtragem precisam ser consistentes em todas as páginas.

Práticas recomendadas

Como os status do comerciante não mudam com frequência na maioria das vezes, é recomendável armazenar em cache os resultados recuperados e recuperá-los periodicamente (por exemplo, a cada poucas horas) com novas consultas. O Centro de ações pode limitar suas consultas se o número de solicitações por segundo for considerado excessivamente alto.

Anterior
Diretrizes de correspondência
Próxima
Correspondência de comerciantes usando URL do Google Maps