API Content for Shopping

Use este guia para integrar a API Merchant com sua implementação atual da API Content for Shopping.

Primeiros passos

Confira o design da API do Merchant para detalhes sobre o API Merchant e as subAPIs dela.

Para começar a usar a API Merchant, mude seus URLs de solicitação para os seguintes 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 gRPC para a API Merchant e REST para a API Content for Shopping, com o mesmo tempo de resposta.

As bibliotecas de cliente da API Merchant API exigem gRPC.

Consulte Usar gRPC para mais informações imprecisas ou inadequadas.

Compatibilidade

Neste guia, descrevemos as mudanças gerais que se aplicam a toda a API Merchant. Consulte os guias a seguir para alterações de 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 a API Content for Shopping. recursos da v2.1.

Por exemplo, você pode usar a API Merchant Inventories com suas Inventários da API Content for Shopping v2.1 e Implementação do products. Você poderá usar a API Content for Shopping para enviar uma nova produto (que você vende em uma loja local), use a API Merchant Inventories LocalInventory para gerenciar informações na loja física desse produto.

Observação: não podemos garantir a compatibilidade total com versões anteriores de recursos semelhantes entre a API de conteúdo do Shopping e a API do comerciante devido ao aumento da design. Por exemplo, nomes de campos ou disponibilidade de métodos podem ser diferentes para o mesmo recurso na API Content for Shopping e na API Merchant.

Solicitações em lote

A API Merchant não é compatível com o método customBatch apresentado no API Content for Shopping. Em vez disso, consulte Enviar em lote solicitações. Se você usar customBatch e precisa desse recurso para a API do comerciante, informe o motivo na sua feedback.

Identificadores

Para alinhar-se aos princípios de melhoria de APIs do Google, fizemos algumas alterações 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 ações gravação na API Merchant.

O valor retornado nos campos name usa o novo formato de ID.

Importante :recomendamos usar o valor do campo name diretamente no seu chamadas, em vez de analisar ou construir manualmente o nome de um recurso para evitar problemas.

Por exemplo, implemente um método getName() para recuperar o name de um e armazene a saída como uma variável em vez de criar o name dos IDs do comerciante e dos recursos.

Novo formato de ID

Observação: a API Merchant vai retornar IDs sem um valor channel até novembro de 2023. Depois de 13 de novembro, todas as chamadas retornarão o ID completo do recurso. Você precisa usar o ID completo do recurso, incluindo channel, em suas chamadas até 1o de fevereiro de de 2024.

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 comerciante retornam o novo formato com ~ entre os valores do parâmetro ID. Recomendamos armazenar o novo formato da resposta e usá-lo no futuras chamadas.

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 método parent campo 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 na parent para o list . Nesse caso, o product informado é o parent do LocalInventory recursos 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 um fio.

O nome do campo de valor mudou de value para amountMicros

O nome do campo de moeda mudou de currency para currencyCode. A permanece como ISO 4217.