Use este guia para integrar a API Merchant à sua implementação atual da API Content for Shopping.
Começar
Consulte o design da API do Merchant para detalhes sobre a API do comerciante e as subAPIs dela.
Para começar a usar a API Merchant, altere os URLs de solicitação para o seguinte formato:
https://merchantapi.googleapis.com/{sub-API}/{version}/{resource name}/{service}:{method}…
Consulte o guia de início rápido e a referência da API Merchant para mais informações.
Suporte ao gRPC
A API do Merchant Center é compatível com gRPC e REST. Você pode usar o gRPC para a API Merchant e o REST para a API Content for Shopping ao mesmo tempo.
As bibliotecas de cliente da API Merchant API exigem o gRPC.
Para mais informações, consulte Usar o gRPC.
Compatibilidade
Neste guia, descrevemos as mudanças gerais que se aplicam a toda a API Merchant. Consulte os guias abaixo para mudanças em recursos específicos:
- Migrar o gerenciamento de contas
- Migrar configurações de frete
- Migrar o gerenciamento de produtos
- Migrar o gerenciamento das origens de dados
- Migrar o gerenciamento de inventários
- Migrar o gerenciamento de promoções
- Migrar o gerenciamento de relatórios
- Migrar o gerenciamento das origens de conversão
- Migrar o gerenciamento de parceria de feeds locais
A API Merchant foi desenvolvida para funcionar com os recursos atuais da API Content for Shopping v2.1.
Por exemplo, é possível usar a API Merchant Inventories com os inventários
da API Content for Shopping v2.1 e a implementação de
products
. Você
pode usar a API Content for Shopping para fazer upload de um novo produto
local (vendido
em uma loja local) e, em seguida, usar o recurso
LocalInventory
da API Merchant Inventories para gerenciar as informações do produto na loja.
Solicitações em lote
A API Merchant não é compatível com o método customBatch
incluído na
API Content for Shopping. Em vez disso, consulte Enviar solicitações
em lote. Se você usa customBatch
e
precisa desse recurso para a API Merchant, envie um
feedback para nossa equipe.
Identificadores
Para alinhar os princípios de melhoria da API do Google, fizemos algumas mudanças nos identificadores dos recursos da API Merchant.
o nome substitui o ID
Todos os recursos da API Merchant usam o campo name
como identificador exclusivo.
Confira um exemplo de como usar o campo name
nas suas chamadas:
POST https://merchantapi.googleapis.com/inventories/v1beta/{parent}/regionalInventories:insert
Esse novo campo name
é retornado como o identificador de recurso para todas as chamadas de leitura e gravação na API Merchant.
O valor retornado nos campos name
usa o novo formato de ID.
Por exemplo, implemente um método getName()
para recuperar o name
de um recurso e armazene a saída como uma variável, em vez de criar o name
com base nos IDs do comerciante e dos recursos.
Novo formato de ID
Na API Merchant, os IDs de recursos usam o seguinte formato:
channel~language~feedLabel~offerId
Os recursos da API Content usaram :
em vez de ~
entre cada valor no ID:
channel:language:feedLabel:offerId
Todas as chamadas da API do Merchant Center retornam o novo formato com ~
entre os valores do ID. Recomendamos armazenar o novo formato da resposta e usá-lo em chamadas futuras.
campos pai para recursos filhos
Na API Merchant, todos os recursos filhos têm o campo parent
. Você pode usar
o campo parent
para especificar o name
do recurso em que o filho será inserido,
em vez de transmitir todo o recurso pai. Também é possível usar o campo parent
com métodos list
para listar os recursos filhos desse parent
.
Por exemplo, para listar inventários locais de um determinado produto, especifique o
name
do produto no campo
parent
do método
list
. Nesse caso, o product
fornecido é o parent
dos recursos
LocalInventory
retornados.
Tipos
Confira alguns tipos comuns compartilhados nas subAPIs da API Merchant.
Preço
Confira o que mudou em Price
no pacote comum do comerciante:
API Content | API Merchant | |
---|---|---|
Campo do valor | value:string |
amountMicros:int64 |
Campo de moeda | currency:string
|
currencyCode:string |
O valor de Price
agora é registrado em micros, onde um milhão de micros é equivalente à unidade padrão da sua moeda.
Na API Content for Shopping, Price
era um número decimal na forma de uma
string.
O nome do campo de valor mudou de value
para amountMicros
O nome do campo de moeda mudou de currency
para currencyCode
. O
formato permanece como ISO 4217.