A API Merchant v1beta foi descontinuada e desativada em 28 de fevereiro de 2026. Para saber como fazer a transição para a versão estável mais recente, consulte Migrar da v1beta para a v1.

Visão geral da API Merchant

É possível usar a API Merchant para:

Gerenciar como sua empresa e seus produtos aparecem no Google.
Ter acesso programático a dados, insights e recursos exclusivos.
Expandir sua empresa e alcançar mais clientes no Google.

A API Merchant pode gerenciar contas grandes ou complexas do Merchant Center. Os casos de uso típicos incluem:

Gerenciamento de contas automatizado
Gerenciamento de produtos automatizado
Gerenciamento de inventário automatizado
Gerenciamento de relatórios automatizado sobre desempenho 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 inclui várias sub-APIs.

Novidades na API Merchant

Confira alguns motivos para fazer upgrade para a API Merchant:

Melhor gerenciamento dos dados de inventários com a introdução dos seguintes novos métodos:
Permite o gerenciamento de fontes de dados complementares pela criação e recuperação de fontes de dados complementares e pela vinculação de fontes de dados complementares a fontes de dados principais.
Permite notificações de mudanças nos dados do produto, eliminando a necessidade de uma busca periódica, notificando você quando o status de um produto muda.
Apresenta o accounts.autofeedSettings recurso e métodos para recuperar e atualizar as configurações de feed automático.
Apresenta o upload de avaliações do produto e avaliações de comerciantes.
Apresenta o accounts.productInputs recurso para simplificar o accounts.products recurso.
Permite a atualização dos dados do produto em conjunto com outros métodos de upload de dados, como arquivos.
Nova NonProductPerformanceView tabela para dados de performance não relacionados a produtos, como informações sobre o tráfego recebido no site de um varejista
Design modular com melhorias de recursos isoladas e mais frequentes
Documentação e exemplos de código atualizados
Melhor alinhamento com as propostas de melhoria da API do Google
Suporte e comunicação aprimorados para desenvolvedores por meio do registro de desenvolvedor.

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: use o projeto para acessar a API da sua conta.
Um link da sua conta do Merchant Center para o projeto na nuvem do Google. Crie o link chamando o método de registro de desenvolvedor. Você vai usar essa conta e esses usuários para comunicação 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 anúncios obrigatórios de serviços, 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.
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/en~US~sku123, em que 123456 é o identificador exclusivo da conta e 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/v1/accounts/123456/products/online~en~US~sku123/regionalInventories/456

Para criar um recurso, use o nome do recurso 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 ver rapidamente como a API Merchant funciona e fazer 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
Crie o corpo da solicitação como um buffer de protocolo. Envie o corpo da solicitação para o servidor com HTTP/2. Desserialize a resposta para um buffer de protocolo. Interprete os resultados.	Crie o corpo da solicitação como um objeto JSON. Envie para o servidor usando HTTP 1.1. Desserialize a resposta como um objeto JSON. 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 informações sobre como receber suporte, consulte Receber ajuda com a API Merchant.

Enviar feedback

Para enviar feedback, envie um dos seguintes:

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

Para informações sobre compatibilidade com versões anteriores, consulte API Content for Shopping.
Para saber mais sobre os principais recursos da API Merchant, consulte os guias no menu de navegação à esquerda.
Para informações sobre os recursos e serviços disponíveis, consulte a documentação de referência.

Latest updates

Avançar

Design