Nota
O acesso a esta página requer autorização. Pode tentar iniciar sessão ou alterar os diretórios.
O acesso a esta página requer autorização. Pode tentar alterar os diretórios.
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 | PUBLICAR | 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} | OBTER | 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 | OBTER | 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 |
|---|---|---|---|
|
contentLanguage <content_language> |
O código de idioma ISO 639-1 de duas letras para o catálogo. Seguem-se os possíveis valores não sensíveis a maiúsculas e minúsculas:
Uma vez que o idioma é utilizado para criar o ID do catálogo, não poderá alterar este campo depois de adicionar o catálogo ao arquivo. |
Cadeia | <content_language> |
| feedLabel | Permite-lhe anunciar todos os produtos com a mesma etiqueta de feed numa campanha Compras ou Performance Max. Recomenda-se uma etiqueta de feed, mas opcional. As etiquetas de feed podem ter um máximo de 20 carateres alfanuméricos, incluindo "-", e são automaticamente convertidas em maiúsculas. Se não for fornecida uma etiqueta de feed, o campo de mercado torna-se necessário e a etiqueta de feed é preenchida novamente apenas com o código de país de duas letras do campo de mercado, excluindo o idioma. Quando utiliza uma etiqueta de feed, é necessário um novo idioma de conteúdo de campos ao nível do catálogo (contentLanguage) e países-alvo (targetCountries: ["US", "CA", "MX"]) e as campanhas associadas têm de filtrar os produtos pela etiqueta do feed. Estes novos campos só são necessários quando uma etiqueta de feed está presente, garantindo uma segmentação adequada dentro do catálogo. |
Cadeia | <feed_label> |
| 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.
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> |
| targetCountries | O código de país de duas letras para o catálogo. Seguem-se os possíveis valores não sensíveis a maiúsculas e minúsculas por agrupamento geográfico: América do Norte (NA)
Europa, Médio Oriente & África (EMEA)
Asia-Pacific (APAC)
|
Cadeia[] | <target_countries> |
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. |