Visão geral da API Merchant

Você pode usar a API Merchant para:

  • Gerencie como sua empresa e seus produtos aparecem no Google.
  • Acesse dados, insights e recursos exclusivos de forma programática.
  • Amplie seus negócios e alcance mais clientes no Google.

A API Merchant pode gerenciar contas grandes ou complexas do Merchant Center. Os casos de uso comuns são os seguintes:

  • Gerenciamento automatizado de contas
  • Gerenciamento automatizado de produtos
  • Gerenciamento automatizado de inventário
  • Gerenciamento automatizado de relatórios sobre performance e insights de mercado

Com a API Merchant, é possível criar e gerenciar várias fontes de dados, o que permite organizar melhor as informações sobre produtos, promoções e avaliações. Com a API Merchant, você pode gerenciar produtos de uma forma que complementa outros métodos de upload de dados de produtos, como arquivos e feed automático. A API Merchant também permite executar várias solicitações individuais em paralelo.

A API Merchant é uma reformulação da API Content for Shopping. Ela é composta por várias sub-APIs.

Novidades na API Merchant

Confira alguns motivos para fazer upgrade para a API Merchant:

Antes de começar

Para executar uma solicitação de API Merchant, você precisa ter o seguinte:

  • Uma conta do Merchant Center: é a conta em que você vai consultar, atualizar e fazer upload de dados. Verifique se você tem as permissões necessárias para gerenciar produtos e inventários nessa conta.

  • Um projeto do Google Cloud: usado para acessar a API da sua conta.

  • Um vínculo da sua conta do Merchant Center com o projeto na nuvem do Google Cloud. Crie o link chamando o método de registro do desenvolvedor. Você vai usar essa conta e esses usuários para comunicações sobre a integração da API, pesquisas e oportunidades.

  • Vincule sua conta do Merchant Center ao projeto na nuvem do Google Cloud registrando-se como desenvolvedor. Os usuários com a função de desenvolvedor de API vão receber comunicações sobre a API, incluindo avisos obrigatórios de serviço, pesquisas para desenvolvedores e oportunidades.

Autenticação com a API Merchant

Você pode usar as seguintes opções de autenticação:

  • É possível gerar um ID do cliente e uma chave secreta do OAuth 2.0 para seu app. O ID e a chave secreta podem ser usados para gerar as credenciais do OAuth 2.0 necessárias nas chamadas de API para a conta do Merchant Center.
  • É possível criar uma conta de serviço e fazer o download da chave privada dela para fazer chamadas de API.

Identificadores de conta e produto

A API Merchant usa nomes de recursos em vez de IDs para identificação. Um exemplo de nome de recurso para um produto pode ser accounts/123456/products/en~US~sku123, em que 123456 é o identificador exclusivo da conta e en~US~sku123 é o identificador exclusivo do produto.

Formato do URL de solicitação

Para operar em um recurso, envie solicitações para URLs no seguinte formato:

https://merchantapi.googleapis.com/{SUB_API}/{VERSION}/{RESOURCE_NAME}:{METHOD}

A parte :{METHOD} é omitida para métodos padrão, como list e get.

Por exemplo, a solicitação a seguir exclui o inventário regional:

DELETE https://merchantapi.googleapis.com/inventories/v1/accounts/123456/products/en~US~sku123/regionalInventories/456

Para criar um recurso, use o nome do recurso pai e este URL:

POST https://merchantapi.googleapis.com/{SUB_API}/{VERSION}/{RESOURCE_NAME_OF_PARENT}/{RESOURCE}

Por exemplo, a solicitação a seguir mostra como criar uma região para accounts/123456:

POST https://merchantapi.googleapis.com/accounts/v1/accounts/123456/regions?regionId=WA HTTP/1.1

{
  "displayName": "Washington",
  "name": "Washington",
  "postalCodeArea": {
    "postalCodes": [
      {
        "begin": "98039",
        "end": "98118"
      }
    ],
    "regionCode": "US"
  }
}

Para mais detalhes sobre serviços específicos, consulte a documentação de referência da API Merchant.

Começar a usar a API Merchant

Para entender rapidamente como a API Merchant funciona e tentar fazer upload de um produto de exemplo, consulte Começar a usar a API Merchant.

Usar gRPC ou REST

A API Merchant é compatível com gRPC e REST. Confira as duas maneiras de fazer chamadas da API Merchant:

gRPC (recomendado) REST
  1. Crie o corpo da solicitação como um buffer de protocolo.
  2. Envie o corpo da solicitação ao servidor com HTTP/2.
  3. Desserializar a resposta para um buffer de protocolo.
  4. Interprete os resultados.
  1. Crie o corpo da solicitação como um objeto JSON.
  2. Envie-a ao servidor usando HTTP 1.1.
  3. Desserialize a resposta como um objeto JSON.
  4. Interprete os resultados.

Usar bibliotecas de cliente e exemplos de código

Cada sub-API tem bibliotecas de cliente para ajudar você a começar. Os exemplos de código podem ajudar você a começar a escrever códigos em Java, PHP e Python. Para mais informações, consulte Exemplos da API Merchant.

Ajuda

Para saber como receber suporte, consulte Receber ajuda com a API Merchant.

Enviar feedback

Para enviar feedback, faça o seguinte:

  • Recursos da API: selecione a opção Enviar feedback na seção Qual é o problema/pergunta? do formulário de feedback.
  • Documentação: use as classificações de polegar in-page e o botão Enviar feedback.
  • Exemplos e bibliotecas: crie um problema no repositório do GitHub para os exemplos de código.

A seguir

Avançar
Merchant API terms and conditions