Visão geral da API Merchant

Esta página apresenta a API Merchant e explica como usá-la para automatizar vários fluxos de trabalho relacionados ao gerenciamento de contas, produtos e inventários no Merchant Center.

Você pode usar a API Merchant para alcançar mais clientes e mostrar seus produtos no Google. Use a API Merchant para gerenciar contas grandes ou complexas do Merchant Center. Confira alguns casos de uso típicos:

  • gerenciamento de contas automático
  • Gerenciamento automatizado de produtos
  • Gerenciamento automatizado de inventário
  • Relatórios personalizados

Com a API Merchant, é possível criar e gerenciar várias origens de dados, o que permite uma melhor organização das 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 inclui várias sub-APIs.

Novidades na API Merchant

Confira alguns motivos para fazer upgrade para a API Merchant:

Para mais informações, consulte Novos recursos introduzidos na versão Beta da API Merchant.

Antes de começar

Para executar uma solicitação da 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 receber acesso à API da sua conta.

  • Vincule sua conta do Merchant Center ao projeto do Google Cloud chamando o método Developer Registration. Os usuários da conta vinculada vão receber comunicação da API, incluindo anúncios 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:

  • Você pode gerar um ID do cliente e uma chave secreta do OAuth 2.0 para seu app. Em seguida, 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.
  • Você pode 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/online~en~US~sku123, em que 123456 é o identificador exclusivo da conta e online~en~US~sku123 é o identificador exclusivo do produto.

Formato do URL da 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/v1beta/accounts/123456/products/online~en~US~sku123/regionalInventories/456

Para criar um recurso, use o nome do recurso do recurso pai e o seguinte 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/v1beta/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 testar o upload de um produto de amostra, consulte Começar a usar a API Merchant.

Usar gRPC ou REST

A API Merchant oferece suporte a 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 para o servidor com HTTP/2.
  3. Desserialize a resposta para um buffer de protocolo.
  4. Interprete os resultados.
  1. Crie o corpo da solicitação como um objeto JSON.
  2. Envie para o 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ódigo 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

O período Beta nos dá a oportunidade de coletar e resolver seu feedback antes do lançamento da disponibilidade geral. Para enviar feedback, faça o seguinte:

  • Recursos da API:envie o formulário de feedback
  • Documentação:use as classificações com polegar para cima na página e o botão Enviar feedback.
  • Exemplos e bibliotecas:crie um problema no repositório do GitHub para os exemplos de código.

Para enviar um feedback geral depois de implementar cada tarefa, use o formulário de feedback.

A seguir

Anterior
Latest updates
Avançar
Design