Recurso de Catálogos

  • Artigo

O recurso Catálogos permite-lhe gerir catálogos na loja Microsoft Merchant Center (MMC). Para obter informações sobre como utilizar os recursos de Catálogos, veja Managing your Catalogs (Gerir os Catálogos). Para obter exemplos que mostram como adicionar, eliminar e obter catálogos, veja Exemplos de Código.

Base URI

Segue-se o URI base ao qual acrescenta os modelos.

https://content.api.bingads.microsoft.com/shopping/v9.1/bmc/

Modelos

Para criar os pontos finais que utiliza para gerir os catálogos, acrescente o modelo adequado ao URI base.

Modelo Verbo HTTP Descrição Recurso
{mmcMerchantId}/catalogs POST Utilize para adicionar um catálogo à loja. Para adicionar um catálogo, o respetivo nome tem de ser exclusivo. Pode adicionar um máximo de 100 catálogos a um arquivo.

Defina {mmcMerchantId} para o ID da loja MMC.		 Pedido: Catálogo
Resposta: Catálogo
{mmcMerchantId}/catalogs/{catalogId} PUT Utilize para atualizar um catálogo na loja. Os únicos campos que pode atualizar são os name campos e isPublishingEnabled e tem de especificar ambos.

Defina {mmcMerchantId} para o ID da loja MMC.		 Pedido: Catálogo
Resposta: Catálogo
{mmcMerchantId}/catalogs/{catalogId} ELIMINAR Utilize para eliminar um catálogo da loja.

Defina {mmcMerchantId} para o ID da loja MMC.

Defina {catalogId} para o ID do catálogo.		 Pedido: N/D
Resposta: N/D
{mmcMerchantId}/catalogs/{catalogId} GET Utilize para obter um catálogo a partir da loja.

Defina {mmcMerchantId} para o ID da loja MMC.

Defina {catalogId} para o ID do catálogo.		 Pedido: N/D
Resposta: Catálogo
{mmcMerchantId}/catalogs GET Utilize para obter uma lista de catálogos da loja.

Defina {mmcMerchantId} para o ID da loja MMC.		 Pedido: N/D
Resposta: Catálogos

Parâmetros de consulta

Os pontos finais podem incluir os seguintes parâmetros de consulta.

Parâmetro Descrição
alt Opcional. Utilize para especificar o tipo de conteúdo utilizado no pedido e na resposta. Os valores possíveis são json e xml. A predefinição é json.

Cabeçalhos

Seguem-se os cabeçalhos de pedido e resposta.

Cabeçalho Descrição
AuthenticationToken Cabeçalho do pedido.

Defina este cabeçalho para um token de autenticação OAuth. Para obter informações sobre como obter um token, consulte Autenticar as suas credenciais.
Localização do Conteúdo Cabeçalho de resposta.

Um URL que identifica o arquivo no qual o catálogo foi inserido. Este cabeçalho está incluído na resposta de um pedido Insert.
CustomerAccountId Cabeçalho do pedido.

O ID da conta de qualquer uma das contas que gere em nome do cliente especificado no CustomerId cabeçalho. Não importa a conta que especificar. Especifique este cabeçalho apenas se gerir uma conta em nome do cliente.
CustomerId Cabeçalho do pedido.

O ID de cliente do cliente cuja loja gere. Especifique este cabeçalho apenas se gerir a loja em nome do cliente. Se definir este cabeçalho, também tem de definir o CustomerAccountId cabeçalho.
DeveloperToken Cabeçalho do pedido.

O token de acesso de programador da aplicação cliente. Cada pedido tem de incluir este cabeçalho. Para obter informações sobre como obter um token, consulte Tem as credenciais do Microsoft Advertising e o token de programador?
Localização Cabeçalho de resposta.

Um URL que identifica o arquivo no qual o catálogo foi inserido. Este cabeçalho está incluído na resposta de um pedido Insert.
WebRequestActivityId Cabeçalho de resposta.

O ID da entrada de registo que contém detalhes sobre o pedido. Deve sempre capturar este ID se ocorrer um erro. Se não conseguir determinar e resolver o problema, inclua este ID juntamente com as outras informações que fornecer à equipa de Suporte.

Objetos de pedido e resposta

Seguem-se os objetos de pedido e resposta utilizados pela API.

Cada objeto define o nome da chave JSON e o nome do elemento XML que utiliza consoante o tipo de conteúdo que especificar para o pedido.

Objeto Descrição
Catálogo Define um catálogo.
Catálogos Define a lista de catálogos.

Catálogo

Define um catálogo.

Name Valor Tipo Nome do elemento XML
ID Um ID que identifica exclusivamente o catálogo no arquivo.

Este campo é só de leitura; não defina este campo.		 Sem Assinatura Por Extenso <ID>
isDefault Um valor Booleano que determina se o catálogo é o catálogo predefinido do arquivo. É verdadeiro se o catálogo for o catálogo predefinido da loja; caso contrário, falso.

Quando cria uma loja, obtém um catálogo predefinido no qual os produtos são escritos se não especificar outro catálogo.

Este campo é só de leitura; não defina este campo.		 Booleano <is_default>
isPublishingEnabled Um valor booleano que determina se a Microsoft pode publicar produtos a partir do catálogo. Definido como verdadeiro se a Microsoft conseguir publicar produtos a partir do catálogo; caso contrário, defina-o como falso.

Pode atualizar este campo.

Também pode utilizar este campo para testar a sua aplicação antes de a implementar na produção. Ao definir este campo como falso, pode efetuar chamadas de Recursos de Produtos sem alterar ou publicar os seus dados de produção.		 Booleano <is_publishing_enabled>
mercado O mercado onde os produtos no catálogo são publicados.

NOTA: Nem todos têm esta funcionalidade ainda. Se não o fizer, não se preocupe, está disponível em breve!.

Seguem-se os mercados possíveis que pode especificar.
  • Albânia, Albanês (sq-AL)
  • Andorra, francês (fr-AD)
  • Argentina, espanhol (es-AR)
  • Aruba, Inglês (en-AW)
  • Austrália, Inglês (en-AU)
  • Áustria, Alemão (de-AT)
  • Bahamas, Inglês (en-BS)
  • Bangladesh, Inglês (en-BD)
  • Bélgica, Neerlandês (nl-BE)
  • Bélgica, Francês (fr-BE)
  • Bolívia, Espanhol (es-BO)
  • Bósnia e Herzegovina, Bósnia (bs-BA)
  • Brasil, Português (pt-BR)
  • Brunei, inglês (en-BN)
  • Bulgária, Búlgara (bg-BG)
  • Canadá, Inglês (en-CA)
  • Canadá, Francês (fr-CA)
  • Ilhas Caimão, Inglês (en-KY)
  • Chile, espanhol (es-CL)
  • Colômbia, Espanhol (es-CO)
  • Costa Rica, espanhol (es-CR)
  • Croácia, Croata (hr-HR)
  • Chipre, Inglês (en-CY)
  • Chipre, Grego (el-CY)
  • República Checa, Checa (cs-CZ)
  • Dinamarca, Dinamarquês (da-DK)
  • Dominica, inglês (en-DM)
  • República Dominicana, Espanhol (es-DO)
  • Equador, Espanhol (es-EC)
  • El Salvador, espanhol (es-SV)
  • Estónia, Estónio (et-EE)
  • Fiji, Inglês(en-FJ)
  • Finlândia, Finlandês (fi-FI)
  • França, Inglês (en-FR)
  • França, Francês (fr-FR)
  • Guiana Francesa, Francês (fr-GF)
  • Polinésia Francesa, Francês (fr-PF)
  • Alemanha, Inglês (en-DE)
  • Alemanha, Alemão (de-DE)
  • Grécia, Inglês (en-GR)
  • Grécia, Grego (el-GR)
  • Guam, Inglês (en-GU)
  • Guatemala, espanhol (es-GT)
  • Guiana, Inglês (en-GY)
  • Haiti, Francês (fr-HT)
  • Honduras, espanhol (es-HN)
  • RAE de Hong Kong, Chinês Tradicional (zh-HK)
  • Hungria, Inglês (en-HU)
  • Hungria, Húngaro (hu-HU)
  • Islândia, Islandês (is-IS)
  • Índia, Inglês (en-IN)
  • Indonésia, inglês (en-ID)
  • Irlanda, Inglês (en-IE)
  • Itália, Inglês (en-IT)
  • Itália, Italiano (it-IT)
  • Japão, japonês (ja-JP)
  • Letónia, Letónia (lv-LV)
  • Liechtenstein, alemão (de-LI)
  • Lituânia, Lituânia (lt-LT)
  • Luxemburgo, Francês (fr-LU)
  • Luxemburgo, Alemão (de-LU)
  • Malásia, Inglês (en-MY)
  • Maldivas, Inglês (en-MV)
  • Malta, Maltês (mt-MT)
  • Martinica, Francês (fr-MQ)
  • México, espanhol (es-MX)
  • Mónaco, Francês (fr-MC)
  • Mongólia, Inglês (en-MN)
  • Montenegro, Inglês (en-ME)
  • Montenegro, Sérvio (sr-ME)
  • Montserrat, Inglês (en-MS)
  • Nepal, Inglês (en-NP)
  • Países Baixos, Neerlandês (nl-NL)
  • Países Baixos, Inglês (el-NL)
  • Nova Caledónia, Francês (fr-NC)
  • Nova Zelândia, Inglês (en-NZ)
  • Macedónia do Norte, Macedónio (mk-MK)
  • Noruega, Norueguês (nb-NO)
  • Panamá, Espanhol (es-PA)
  • Papua Nova Guiné, Inglês (en-PG)
  • Paraguai, espanhol (es-PY)
  • Peru, Espanhol (es-PE)
  • Phillippines, Inglês (en-PH)
  • Polónia, Polaco (pl-PL)
  • Portugal, Português (pt-PT)
  • Porto Rico, espanhol (es-PR)
  • Roménia, Romeno (ro-RO)
  • São Marino, Inglês (en-SM)
  • São Marino, Italiano (it-SM)
  • Sérvia, Inglês (en-RS)
  • Sérvia, Sérvia (sr-RS)
  • Singapura, Inglês (en-SG)
  • Eslováquia, Inglês (en-SK)
  • Eslováquia, Eslováquia (sk-SK)
  • Eslovénia, Eslovénia (sl-SI)
  • África do Sul, Inglês (en-ZA)
  • Espanha, Inglês (en-ES)
  • Espanha, Espanhol (es-ES)
  • Sri Lanka, Inglês (en-LK)
  • Suécia, Inglês (en-SE)
  • Suécia, Sueco (sv-SE)
  • Suíça, Alemão (de-CH)
  • Suíça, Francês (fr-CH)
  • Taiwan, Chinês Tradicional (zh-TW)
  • Tailândia, Inglês (en-TH)
  • Trindade e Tobago, Inglês (en-TT)
  • Türkiye, Turco (tr-TR)
  • Reino Unido, Inglês (en-GB)
  • Estados Unidos, inglês (en-US)
  • Estados Unidos, espanhol (es-US)
  • Uruguai, espanhol (es-UY)
  • Cidade do Vaticano, Italiano (it-VA)
  • Venezuela, espanhol (es-VE)
  • Vietname, Inglês (en-VN)
Todos os produtos que adicionar ao catálogo têm de especificar o mesmo mercado (veja contentLanguage e targetCountry).

Não poderá atualizar este campo depois de adicionar o catálogo ao arquivo.

Na lista acima, de-DE é o valor de mercado que especificar; não inclua (Alemão-Alemanha) na sua cadeia de mercado.		 Cadeia <mercado>
nome O nome do catálogo. O nome pode conter um máximo de 70 carateres.

Pode atualizar este campo.		 Cadeia <nome>

Catálogos

Define uma lista de catálogos.

Name Valor Tipo Nome do elemento XML
catálogos Uma lista de catálogos na loja. Catálogo[] <catálogos>

Códigos de estado HTTP

Os pedidos podem devolver os seguintes códigos de estado HTTP.

Código de estado Descrição
200 Sucesso.
201 O catálogo foi adicionado com êxito.
204 O catálogo foi eliminado com êxito.
400 Pedido incorreto. Um valor de parâmetro de consulta não é válido ou algo no corpo do pedido não é válido.
401 Não autorizado. As credenciais do utilizador não são válidas.
404 Não encontrado.
500 Erro do servidor.