Gerir os Seus Catálogos
A API de Conteúdo é uma API RESTful que utiliza o recurso Catálogos para gerir catálogos no seu arquivo do Microsoft Merchant Center (MMC).
Segue-se o URI base que utiliza para chamar a API de Conteúdo.
https://content.api.bingads.microsoft.com/shopping/v9.1/bmc/
Cada pedido HTTP tem de incluir o token de acesso OAuth do utilizador e o token de programador. Para especificar o token de acesso do utilizador, defina o cabeçalho AuthenticationToken . Para especificar o token do programador, defina o cabeçalho DeveloperToken .
Se gerir catálogos em nome de outros clientes, tem de definir:
- O cabeçalho CustomerId para o ID de cliente do cliente cuja loja está a gerir.
- O cabeçalho CustomerAccountId para o ID da conta de qualquer uma das contas do cliente que gere (não importa qual a conta gerida).
Por predefinição, a API de Conteúdo utiliza objetos JSON para representar os catálogos. Para utilizar XML, defina o parâmetro de consulta alt como XML.
Para obter detalhes sobre como utilizar o recurso Catálogos, veja as secções seguintes.
- Obter um catálogo a partir da loja
- Obter a lista de catálogos da loja
- Eliminar um catálogo da loja
- Adicionar um catálogo à loja
- Atualizar um catálogo na loja
Para obter um exemplo de código que mostra como obter, adicionar, atualizar e eliminar catálogos, veja Managing Catalogs Code Example (Exemplo de Código de Gestão de Catálogos).
Obter um catálogo a partir da loja
Para obter um catálogo da loja, acrescente o seguinte modelo ao URI base.
{bmcMerchantId}/catalogs/{catalogId}
Defina {bmcMerchantId} para o ID da loja MMC e defina {catalogId} para o ID do catálogo.
Envie um pedido HTTP GET para o URL resultante. Se o catálogo tiver sido encontrado, a resposta contém um objeto Catálogo que contém os detalhes do catálogo.
Obter uma lista de catálogos a partir da loja
Para obter uma lista de catálogos da loja, acrescente o seguinte modelo ao URI base.
{bmcMerchantId}/catalogs
Defina {bmcMerchantId} para o ID da loja MMC.
Envie um pedido HTTP GET para o URL resultante. Se o arquivo contiver catálogos, a resposta contém um objeto Catálogos que contém a lista de catálogos.
Eliminar um catálogo da loja
Para eliminar um catálogo da loja, acrescente o seguinte modelo ao URI base.
{bmcMerchantId}/catalogs/{catalogId}
Defina {bmcMerchantId} para o ID da loja MMC e defina {catalogId} para o ID do catálogo.
Envie um pedido HTTP DELETE para o URL resultante. Se o catálogo tiver sido encontrado, será eliminado.
Adicionar um catálogo à loja
Utiliza catálogos para agrupar logicamente os seus produtos. Para adicionar um catálogo à loja, acrescente o seguinte modelo ao URI base.
{bmcMerchantId}/catalogs
Defina {bmcMerchantId} para o ID da loja MMC.
Envie um pedido HTTP POST para o URL resultante. Se o catálogo for adicionado, a resposta contém um objeto Catálogo . O Catalog objeto inclui o ID do catálogo. Utilize o ID para obter e eliminar o catálogo.
O corpo do pedido é um objeto de Catálogo . Tem de especificar os seguintes campos.
O nome que especificar tem de ser exclusivo no arquivo e está limitado a um máximo de 70 carateres. O mercado identifica onde os produtos são servidos. Para obter uma lista de mercados suportados, veja mercado. Os produtos são servidos apenas se isPublishingEnabled for verdadeiro. Para obter detalhes sobre como pode utilizar isPublishingEnabled para testar a sua aplicação, veja Testing your Code in Sandbox (Testar o código no Sandbox).
Atualizar um catálogo na loja
Para atualizar um catálogo na loja, acrescente o seguinte modelo ao URI base.
{bmcMerchantId}/catalogs/{catalogId}
Defina {bmcMerchantId} para o ID da loja MMC e defina {catalogId} para o ID do catálogo.
O corpo do pedido é um objeto de Catálogo . Tem de especificar os seguintes campos.
Envie um pedido HTTP PUT para o URL resultante. Se o catálogo for atualizado, a resposta contém o objeto Catálogo atualizado.