Recurso produtos

O recurso Produtos permite-lhe gerir ofertas de produtos na loja Microsoft Merchant Center (MMC). Para obter informações sobre como utilizar os recursos de Produtos, consulte Gerir os seus Produtos. Para obter exemplos que mostram como adicionar, eliminar e obter produtos, 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 utilizados para gerir as suas ofertas de produtos, acrescente o modelo adequado ao URI base.

Modelo Verbo HTTP Descrição Recurso
{mmcMerchantId}/products/batch POST Utilize para efetuar várias inserções (atualizações), obtém e elimina num único pedido. O lote não pode incluir várias ações para o mesmo produto. Por exemplo, o pedido não pode tentar inserir e eliminar o mesmo produto.

Defina {mmcMerchantId} para o ID da loja MMC.
Pedido: Batch
Resposta: Batch
{mmcMerchantId}/products/{productUniqueId} ELIMINAR Utilize para eliminar uma única oferta de produto da loja.

Defina {mmcMerchantId} para o ID da loja MMC.

Defina {productUniqueId} como o ID de produto completamente qualificado (por exemplo, Online:en:US:Sku123).

Se inseriu um produto com o mesmo ID em vários catálogos, este será eliminado de todos.

Os produtos eliminados podem demorar até 12 horas a parar a entrega. Recomendamos que atualize a disponibilidade do produto para "esgotado" antes de eliminar.
Pedido: N/D
Resposta: N/D
{mmcMerchantId}/products/{productUniqueId} GET Utilize para obter uma única oferta de produto a partir da loja.

Defina {mmcMerchantId} para o ID da loja MMC.

Defina {productUniqueId} como o ID de produto completamente qualificado (por exemplo, Online:en:US:Sku123).

Se inseriu um produto com o mesmo ID em vários catálogos, o serviço devolve apenas um deles e qual é indeterminado.
Pedido: N/D
Resposta: Produto
{mmcMerchantId}/products GET Utilize para obter uma lista de produtos na loja.

Defina {mmcMerchantId} para o ID da loja MMC.
Pedido: N/D
Resposta: Produtos
{mmcMerchantId}/products POST Utilize para inserir (atualizar) uma única oferta de produto na loja.

Se o produto não existir, será adicionado; caso contrário, o produto é atualizado. Uma vez que as atualizações substituem a oferta atual, tem de incluir todos os campos que compõem a oferta.

Para inserir a oferta num catálogo específico, especifique o parâmetro de consulta bmc-catalog-id ; caso contrário, o produto é inserido no catálogo predefinido da loja.

Defina {mmcMerchantId} para o ID da loja MMC.

Tenha em atenção que, uma vez que os pedidos Get/List e Delete atuam em relação à loja e não a um catálogo específico, não deve inserir um produto com o mesmo canal, contentLanguage, targetCountry e offerId em vários catálogos.
Pedido: Produto
Resposta: Produto

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.
bmc-catalog-id Opcional. Utilize para especificar o catálogo no qual inserir (atualizar) ofertas de produtos.

Utilize este parâmetro se o arquivo contiver vários catálogos. Se não especificar este parâmetro, o produto é inserido no catálogo predefinido da loja.

Este parâmetro só é utilizado para inserir ofertas de produtos. Este parâmetro é ignorado para pedidos Get, List e Delete porque funcionam em catálogos.
dry-run Opcional. Utilize ao depurar a sua aplicação para testar chamadas. As chamadas que incluem este parâmetro não afetarão os dados de produção (os produtos não são inseridos ou eliminados); no entanto, a resposta conterá quaisquer erros gerados pela chamada.

Considere as seguintes limitações ao utilizar este parâmetro.
  • As operações de inserção não devolvem IDs.
  • O serviço não gera nem devolve mensagens de erro secundárias, tais como qualidade de dados, problemas editoriais e validações relacionadas com a base de dados.
Para obter mais informações sobre como testar a sua aplicação, consulte Sandbox.
max-results Opcional. Utilize para especificar o número máximo de itens a devolver num pedido de Lista. O valor máximo que pode especificar é 250. A predefinição é 25.
start-token Opcional. Utilize para percorrer a lista de produtos de uma loja. O token identifica a página seguinte dos produtos a devolver num pedido de Lista. Não especifique este parâmetro no primeiro pedido de Lista. Se o catálogo contiver mais do que o número pedido de produtos (veja o parâmetro de consulta de resultados máximos ), a resposta inclui o nextPageToken campo (consulte Produtos), que contém o valor do token que utiliza no próximo pedido de Lista.

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 acesso OAuth. Para obter informações sobre como obter um token de acesso, consulte Autenticar as suas credenciais.
Localização do Conteúdo Cabeçalho de resposta.

Um URL que identifica o arquivo no qual o produto foi inserido. Este cabeçalho está incluído na resposta de um pedido Insert.
Tipo de Conteúdo Cabeçalho de pedido e resposta.

O tipo de conteúdo no corpo do pedido ou resposta. Para POSTs, se utilizar JSON, defina este cabeçalho como application/json. Caso contrário, se utilizar XML, defina este cabeçalho como application/xml.
CustomerAccountId Cabeçalho do pedido.

O ID de conta de qualquer conta 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 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 produto 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 os detalhes do 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 especificou para o pedido.

Objeto Descrição
Batch Define a lista de itens a processar num pedido de lote.
Erro Define um erro.
ErrorResponse Define o objeto de erro de nível superior para uma única inserção de produto.
BatchItemError Define os erros que ocorreram para um item durante o processamento em lotes.
Item Define um item num pedido ou resposta em lote.
Produto Define um produto.
ProductCustomAttribute Define um atributo personalizado.
ProductCustomGroup Define um grupo de atributos personalizados.
ProductDestination Define um destino.
PreçoDoProduto Define o preço de um produto.
ProductTax Define a localização geográfica que determina os impostos aplicáveis.
Produtos Define uma lista de produtos.
ProductShipping Define o custo de envio.
ProductShippingWeight Define o peso de envio do item.
Preços Unitários Define o preço por unidade do item.
Aviso Define uma mensagem de aviso.

Batch

Define a lista de itens a processar num pedido de lote. Tenha em atenção que este objeto é utilizado num pedido e resposta em lote.

Name Valor Tipo Nome do elemento XML
entradas Uma matriz de itens a processar num pedido em lote.

O número máximo de itens que pode especificar é 12 000. No entanto, o tamanho máximo do pedido é de 4 MB, pelo que o número real de itens depende do número de atributos do produto (por exemplo, tamanho, cor, padrão) que inclui e se comprime os dados. Por exemplo, se comprimir os dados, poderá conseguir especificar 12 000 itens, mas se não o fizer, poderá conseguir especificar apenas 2000 itens.
Item[] <batch>

BatchItemError

Define os erros que ocorreram para um item durante o processamento em lotes.

Name Valor Tipo Nome do elemento XML
erros Uma lista de erros que ocorreram durante o processamento do item. Erro[] <erros>
código O código de estado HTTP do erro. Cadeia
Mensagem Uma mensagem associada ao erro. Cadeia

Erro

Define um erro.

Name Valor Tipo Nome do elemento XML
domínio Apenas para utilização interna. Cadeia <domínio>
localização Não utilizado. Cadeia <location type="string">
locationType Não utilizado. Cadeia Ver o atributo de tipo do <elemento de localização>
Mensagem Uma descrição do erro. Cadeia <internalReason>
motivo O motivo pelo qual o pedido falhou. Por exemplo, a validação do produto falhou. Cadeia <motivo>

ErrorResponse

Define o objeto de erro de nível superior para uma única inserção de produto.

Name Valor Tipo Nome do elemento XML
erro Uma lista de erros que ocorreram durante o processamento do item. Erros[] <erro>

Erros

Define a lista de erros e avisos de uma oferta.

Name Valor Tipo Nome do elemento XML
erros Uma lista de erros que ocorreram durante o processamento do item. Erro[] <erros>
avisos Uma lista de avisos que ocorreram durante o processamento do item. A oferta foi aceite, mas deve resolver os problemas o mais rapidamente possível. Por exemplo, a MMC devolve avisos se não especificar os identificadores de marca, mpn e gtin, caso devam ser conhecidos. Aviso[] <avisos>
código O código de estado HTTP ou o erro. Cadeia
Mensagem Uma mensagem associada ao erro. Cadeia

Item

Define um item num pedido de lote.

Name Valor Tipo Nome do elemento XML
batchId Um ID definido pelo utilizador que identifica este item no pedido de lote. Por exemplo, se o lote contiver 10 itens, pode atribuir-lhes IDs 1 a 10. Número Inteiro Não Assinado <entry batch_id="unsigned integer" method="string">
erros Um objeto de erro que contém uma lista de erros de validação que ocorreram. A resposta inclui este campo apenas quando ocorre um erro. BatchItemError <erros>
merchantId O ID da loja Merchant Center. Sem Assinatura Por Extenso <merchant_id>
método A ação a aplicar ao item. Os valores possíveis são insert, gete delete. Se o item estiver a adicionar ou a atualizar uma oferta de produto, defina o método como insert; se o item estiver a eliminar um produto, defina o método como delete; e, se o item estiver a obter um produto, defina o método como get. As cadeias não são sensíveis a maiúsculas e minúsculas. Cadeia Ver o method atributo do <elemento de entrada>
produto A oferta de produto. Especifique este campo num pedido apenas se inserir (atualizar) um produto. A resposta incluirá este campo apenas para obter e inserir (atualizações). Produto <produto>
productId O ID de produto completamente qualificado (por exemplo, Online:en:US:Sku123). Inclua este campo apenas ao obter ou eliminar uma oferta de produto.

Não inclua vários itens com o mesmo ID de produto num pedido de lote.
Cadeia <product_id>

Produto

Define um produto. Para obter mais informações sobre os campos neste objeto, consulte Como está organizado o ficheiro de feed?

Nome JSON e XML Valor Tipo Necessário para inserir
additionalImageLinks

<additional_image_link>
Os URLs de imagens adicionais do produto que podem ser utilizados no anúncio do produto. Para especificar múltiplas imagens,

A MMC não utiliza as imagens adicionais; este campo está incluído para compatibilidade do Google.
Cadeia[] Não
adulto

<adulto>
Um valor Booleano que determina se o item é um produto para adultos. Definido como verdadeiro se o mercado-alvo do item for adulto. A predefinição é false.

Tenha em atenção que os produtos para adultos não são suportados e serão rejeitados.
Booleano Não
adwordsGrouping

<adwords_grouping>
Um grupo de itens para licitação de Custo por aquisição (CPA).

A MMC não utiliza este campo; está incluído para compatibilidade com o Google.
Cadeia Não
adwordsLabels

<adwords_label>
As etiquetas para itens agrupados (veja adwordsGrouping). Aplica-se apenas a Custo por clique (CPC).

A MMC não utiliza este campo; está incluído para compatibilidade com o Google.
Cadeia[] Não
adwordsRedirect

<adwords_redirect>
O URL a utilizar no anúncio do produto. Se especificado, este URL tem de redirecionar para o URL especificado na ligação. Cadeia Não
ageGroup

<age_group>
O grupo etário de destino do item. Seguem-se os valores possíveis.

  • adulto
  • crianças
  • criança
  • bebé
  • recém-nascido
Cadeia Não
disponibilidade

<disponibilidade>
O estado de disponibilidade do produto. Seguem-se os valores possíveis.

  • em stock
  • fora de stock
  • pré-encomenda
A predefinição está em stock.
Cadeia Sim
availabilityDate

<availability_date>
A data UTC em que um produto de pré-encomenda estará disponível para envio (consulte o availability campo). Este campo é opcional, mas se souber a data em que o produto pré-encomendado estará disponível para envio, deve definir este campo. Especifique a data no formato ISO 8601.

NOTA: Atualmente, a MMC ignora o conteúdo deste campo.
Cadeia Não
marca

<marca>
A marca, fabricante ou fabricante do item. A cadeia pode conter um máximo de 10 palavras e 1000 carateres. Para garantir que a cadeia é apresentada corretamente na experiência de utilizador, deve limitar o nome da marca a um máximo de 70 carateres. Cadeia Sim
canal

<canal>
O canal de vendas do produto. Seguem-se os possíveis valores não sensíveis a maiúsculas e minúsculas.

  • Local
  • Online
Uma vez que o canal é utilizado para criar o ID do produto, não poderá alterar este campo depois de adicionar o produto à loja.
Cadeia Sim
cor

<cor>
A cor dominante do produto. Se a cor for uma mistura de cores, pode especificar uma lista delimitada por barras com até 3 cores (por exemplo, vermelho/verde/azul).

Se um vestido estiver disponível em múltiplas cores, pode criar um produto para cada cor e utilizar itemGroupId para agrupar as variantes do produto.

O campo está limitado a 100 carateres.

Recomendado para artigos de vestuário.
Cadeia Não
condição

<condição>
A condição do produto. Seguem-se os valores possíveis.

  • novo
  • recondicionado
  • utilizado
A predefinição é nova.
Cadeia Sim
contentLanguage

<content_language>
O código de idioma ISO 639-1 de duas letras para o produto. Seguem-se os possíveis valores não sensíveis a maiúsculas e minúsculas:
  • Albanês (sq)
  • Bósnio (bs)
  • Búlgaro (bg)
  • Croata (h)
  • Checo (cs)
  • Neerlandês (nl)
  • Inglês (en)
  • Estónio (et)
  • Francês (fr)
  • Alemão (de)
  • Grego (el)
  • Húngaro (hu)
  • Islandês (é)
  • Italiano (it)
  • Letão (lv)
  • Lituano (lt)
  • Macedónio (mk)
  • Maltês (mt)
  • Polaco (pl)
  • Português (pt)
  • Romeno (ro)
  • Sérvio (sr)
  • Eslovaco (sk)
  • Esloveno (sl)
  • Espanhol (es)
  • Sueco (sv)
  • Turco (tr)
Uma vez que o idioma é utilizado para criar o ID do produto, não poderá alterar este campo depois de adicionar o produto à loja.
Cadeia Sim
customAttributes

<custom_attribute>
Uma lista de atributos personalizados utilizados pelo comerciante. ProductCustomAttribute[] Não
customGroups<custom_group> Uma lista de grupos personalizados utilizados pelo comerciante. ProductCustomGroup[] Não
customLabel0

<custom_label_0>
Etiqueta personalizada 0, que é utilizada para filtrar produtos para campanhas do Microsoft Shopping. A etiqueta está limitada a 100 carateres. Cadeia Não
customLabel1

<custom_label_1>
Etiqueta personalizada 1, que é utilizada para filtrar produtos para campanhas do Microsoft Shopping. A etiqueta está limitada a 100 carateres. Cadeia Não
customLabel2

<custom_label_2>
Etiqueta personalizada 2, que é utilizada para filtrar produtos para campanhas do Microsoft Shopping. A etiqueta está limitada a 100 carateres. Cadeia Não
customLabel3

<custom_label_3>
Etiqueta personalizada 3, que é utilizada para filtrar produtos para campanhas do Microsoft Shopping. A etiqueta está limitada a 100 carateres. Cadeia Não
customLabel4

<custom_label_4>
Etiqueta personalizada 4, que é utilizada para filtrar produtos para campanhas do Microsoft Shopping. A etiqueta está limitada a 100 carateres. Cadeia Não
descrição

<descrição>
Uma descrição do produto. A descrição pode não incluir texto promocional. A descrição está limitada a um máximo de 10 000 carateres e pode incluir carateres Unicode.

A descrição será submetida a revisão editorial.
Cadeia Não
destinos

<destino>
Os destinos pretendidos do produto.

A MMC não utiliza este campo; está incluído para compatibilidade com o Google.
ProductDestination[] Não
energyEfficiencyClass

<energy_efficiency_class>
A classe de eficiência energética, conforme definido na directiva 2010/30/UE da UE. Seguem-se os valores possíveis.

  • A
  • A+
  • A++
  • A+++
  • B
  • C
  • D
  • E
  • F
  • G
Cadeia Não
expirationDate

<expiration_date>
A data e hora UTC que especifica quando o produto irá expirar.

Se não especificar uma data de expiração, o produto expira 30 dias a partir da data e hora que adicionar ou atualizar o produto (a data e hora baseiam-se no fuso horário do servidor Microsoft).

Utilize este campo para especificar uma data de expiração inferior a 30 dias a partir de hoje.

A data de expiração deve incluir sempre o componente de hora e especificar as informações de fuso horário ou desvio. Se tal não acontecer, a API tentará determinar o fuso horário com targetCountry. Para países ou regiões com vários fusos horários, a API determina o fuso horário a utilizar. Por exemplo, se o país for EUA, a API utilizará a hora padrão (PST) do Pacífico.

Deve controlar os produtos que estão prestes a expirar e antes de expirarem atualizar a data de expiração ou simplesmente atualizar o produto (não tem de atualizar nenhum dos campos do produto), o que irá prolongar automaticamente a data de expiração mais 30 dias. Se definir explicitamente a data de expiração, tem de definir uma nova data de expiração manualmente; atualizar o produto não prolongará automaticamente a data de expiração mais 30 dias neste caso.
Cadeia Não
género

<género>
O sexo que o produto visa. Seguem-se os valores possíveis.

  • fêmea
  • macho
  • unisexo
Cadeia Não
googleProductCategory

<google_product_category>
A categoria de produto em que o produto se encontra. Pode especificar uma cadeia de categoria (por exemplo, Animais & Aprovisionamento de > Animais de Estimação Fornece Materiais > para Animais de Estimação) ou um ID de categoria (por exemplo, 3). Para uma cadeia de categoria, a lista de subcategorias é delimitada pelo símbolo maior que ('>'). O campo está limitado a 255 carateres.

Para obter uma lista de cadeias de categoria e IDs, veja Categorias.
Cadeia Não
gtin

<gtin>
O Número Global de Item de Comércio (GTIN) atribuído pelo fabricante. Se o fabricante atribuir um GTIN, tem de especificá-lo. Seguem-se os tipos de GTINs.

  • EAN (Número do Artigo Europeu)
  • ISBN (International Standard Book Number)
  • JAN (Número do Artigo Japonês)
  • UPC (Código de Produto Universal)
Cadeia Sim
ID

<ID>
O ID de produto completamente qualificado. O ID é um composto de canal, contentLanguage, targetCountry e offerId. O ID é sensível às maiúsculas e minúsculas.

Utilize este ID para obter ou eliminar um produto.
Cadeia Não
identifierExists

<identifier_exists>
Um valor Booleano que determina se a oferta do produto especifica os identificadores de marca, mpn ou gtin. A predefinição é true. Defina como falso se não especificar os três identificadores.

Os identificadores de produto exclusivos definem um produto num marketplace global. Etiquetar os seus produtos com identificadores exclusivos facilita a localização dos seus produtos por parte dos clientes. Deve especificar os três identificadores, se conhecidos.
Booleano Não
imageLink

<image_link>
O URL para uma imagem do produto que pode ser utilizada no anúncio do produto. O URL está limitado a 1000 carateres e pode utilizar o protocolo HTTP ou HTTPS. Os tipos de imagem permitidos são bmp, gif, exif, jpg, png e tiff. O tamanho de imagem recomendado é 200x200 pixels. A imagem não pode exceder 3,9 MB.

A imagem será submetida a uma revisão editorial.
Cadeia Sim
isBundle

<is_bundle>
Um valor Booleano que determina se o produto é um pacote definido pelo comerciante. O valor é verdadeiro se o produto for um pacote. Booleano Não
itemGroupId

<item_group_id>
Um ID que pode ser utilizado para agrupar todas as variantes do mesmo produto. Por exemplo, se o vestido estiver disponível em três cores, pode criar um produto para cada cor e utilizar este ID para as agrupar. Normalmente, agrupa itens que variam consoante a cor, o material, o padrão ou o tamanho.

O ID tem de ser exclusivo num catálogo e está limitado a 50 carateres.
Cadeia Não
tipo

<tipo>
O tipo do objeto. Este campo está definido como content#product. Cadeia Não
ligação

<ligação>
O URL para a página do produto no seu site. O URL está limitado a 2000 carateres e pode utilizar o protocolo HTTP ou HTTPS. O domínio tem de corresponder ao domínio do arquivo.

A ligação é utilizada no anúncio do produto. O URL pode não ser redirecionado. Para utilizar outro URL no anúncio do produto que pode ser redirecionado para este URL, veja adwordsRedirect.

A página Web para a qual esta ligação aponta será submetida a uma revisão editorial.
Cadeia Sim
material

<material>
O material dominante do produto. Se o material for uma mistura de materiais, pode especificar uma lista delimitada por barras de até 3 materiais (por exemplo, couro/camurça/seda).

Se um vestido estiver disponível em vários materiais, deverá criar um produto para cada material e utilizar itemGroupId para agrupar as variantes do produto.

O campo está limitado a 200 carateres.

Recomendado para artigos de vestuário.
Cadeia Não
mobileLink

<mobile_link>
Um URL para uma versão otimizada para dispositivos móveis da página Web que contém informações sobre o produto (ver ligação). Cadeia Não
multipack

<multipack>
O número de produtos idênticos a serem vendidos como uma única unidade (por exemplo, 4 lanternas). Ao definir o preço, tem de ser o preço total do multipack. Número inteiro Não
mpn

<mpn>
O número de peça (MPN) do fabricante do produto. Se o fabricante atribuir um MPN, tem de especificá-lo. O MPN está limitado a 70 carateres. Cadeia Sim
offerId

<offer_id>
O ID definido pelo utilizador do produto que está a ser oferecido. O ID da oferta não é sensível a maiúsculas e minúsculas e tem de ser exclusivo num catálogo e está limitado a um máximo de 50 carateres.

Uma vez que o ID da oferta é utilizado para criar o ID do produto, não poderá alterar este campo depois de adicionar o produto à loja.
Cadeia Sim
onlineOnly

<online_only>
Um valor booleano que determina se o produto só está disponível para compra online. O valor é verdadeiro se o produto estiver disponível apenas online. A predefinição é false. Booleano Não
padrão

<padrão>
O padrão ou impressão gráfica do produto (por exemplo, xadrez). O padrão está limitado a 100 carateres.

Se um vestido estiver disponível em múltiplos padrões, pode criar um produto para cada padrão e utilizar itemGroupId para agrupar as variantes do produto.

Recomendado para artigos de vestuário.
Cadeia Não
preço

<preço>
O preço do produto. Especifique o preço na moeda do país-alvo. Para obter informações sobre se deve incluir impostos no preço, consulte Política fiscal do catálogo do Centro de Comerciantes da Microsoft. O preço tem de corresponder ao preço apresentado na página Web do produto (ver ligação) e tem de estar entre 0,01 (1 cêntimo) e 10000000,00 (10 milhões).

No entanto, se as seguintes condições forem cumpridas, pode definir o preço como 0,0 (zero).

1. O campo googleProductCategory está definido para uma das seguintes categorias:
    - Telefones > Móveis de Telefonia de > Comunicações Eletrónicas >
    - Computadores > Eletrónicos > Tablet Computadores
2. O campo de título contém uma das seguintes palavras-chave:
    - contrato
    - prestação
    - concessão
    - pagamento

As palavras-chave acima são apresentadas em inglês; no entanto, o título e a palavra-chave têm de estar no idioma do mercado especificado.

Normalmente, o título contém sintagmas como "... com plano de prestação" ou "... apenas com contrato". A palavra-chave do contrato pode ser utilizada em todos os mercados; no entanto, a prestação, o pagamento e a concessão só podem ser utilizados no mercado norte-americano.
PreçoDoProduto Sim
productType

<product_type>
A categoria de produto definida pelo anunciante, que pode ser diferente de googleProductCategory. Por exemplo, animais & de animais de estimação abastecem > o fornecimento > de aves veterinárias > . A lista de subcategorias é delimitada pelo símbolo maior que ('>'). O campo está limitado a 750 carateres.

Pode especificar múltiplas cadeias de categoria delimitadas por vírgulas. Por exemplo, Fantasias & Acessórios Acessórios >> de Peruca Wig Caps, Fantasias & Acessórios > Peruca Acessórios > Wig Glue.
Cadeia Não
promotionId

<promotion_id>
Uma lista delimitada por vírgulas de IDs que identificam promoções no seu feed Promoções. Pode especificar um máximo de 10 IDs de promoção.

O ID tem de conter um mínimo de 1 caráter e um máximo de 60 carateres. Os carateres permitidos são quaisquer carateres alfanuméricos, um travessão (-) e um caráter de sublinhado (_).

Todos os IDs de um mercado (ver contentLanguage e targetCountry) têm de ser exclusivos. Por exemplo, num mercado, pode não utilizar PROMO1 e promo1, mas pode utilizar PROMO1 no mercado en-US e promo1 no mercado en-GB. Pode especificar o mesmo ID de promoção exclusivo num ou mais produtos.

A Microsoft promove o produto se o ID que especificar corresponder a um ID de promoção no feed Promoções (para o mesmo país-alvo). Os IDs só correspondem se a caixa for a mesma. Por exemplo, os IDs correspondem se o ID do produto for PROMO1 e o ID do feed for PROMO1, mas não corresponderem se o ID do feed for Promo1.

Para garantir que o produto não é acidentalmente promovido no futuro, deve remover os IDs das promoções que terminaram. Embora o ID não possa ser utilizado novamente num feed promoções durante 6 meses após o fim da promoção, se o ID for reutilizado noutra promoção depois disso, o produto será promovido.
Cadeia Não
salePrice

<sale_price>
O preço de venda do item. O preço de venda tem de estar entre 0,01 (1 cêntimo) e 10000000,00 (10 milhões).

Para itens de venda, defina o preço de venda e a data efetiva da venda (consulte salePriceEffectiveDate). Se definir o preço de venda, mas não a data efetiva do preço de venda, o preço de venda continuará a ser utilizado até que o produto expire ou defina uma data efetiva.

Se as seguintes condições forem cumpridas, pode definir o preço de venda como 0,0 (zero).

1. O campo googleProductCategory está definido para uma das seguintes categorias:
    - Telefones > Móveis de Telefonia de > Comunicações Eletrónicas >
    - Computadores > Eletrónicos > Tablet Computadores
2. O campo de título contém uma das seguintes palavras-chave:
    - contrato
    - prestação
    - concessão
    - pagamento

As palavras-chave acima são apresentadas em inglês; no entanto, o título e a palavra-chave têm de estar no idioma do mercado especificado.

Normalmente, o título contém sintagmas como "... com plano de prestação" ou "... apenas com contrato". A palavra-chave do contrato pode ser utilizada em todos os mercados; no entanto, a prestação, o pagamento e a concessão só podem ser utilizados no mercado norte-americano.
PreçoDoProduto Não
salePriceEffectiveDate

<sale_price_effective_date>
A data de início e fim utc da venda. Especifique as datas no formato ISO 8601 . Por exemplo, 2016-04-05T08:00-08:00/2016-04-10T19:30-08:00 (utilize uma barra ('/') para separar as datas de início e de fim). Para obter mais informações, consulte salePrice. Cadeia Não
sellerName

<seller_name>
O nome do comerciante que está a vender o produto. Utilizado apenas por agregadores para identificar o comerciante. Os agregadores são sites de terceiros que se comportam em nome de comerciantes individuais. Os produtos que um agregador submete em nome do comerciante têm de estar em conformidade com as políticas de Publicidade da Microsoft e os Termos de Serviço.

Os agregadores têm de definir este campo como o nome dos vendedores. Se o autor da chamada não for um agregador e este campo não estiver definido, será predefinido para o nome da loja.

O nome está limitado a 255 carateres.
Cadeia Não
envio

<envio>
O preço para enviar o produto com base na localização.

NOTA: o envio é necessário se o país-alvo for DE (Alemanha); caso contrário, é opcional.
ProductShipping[] Sim
shippingLabel

<shipping_label>
A etiqueta de envio.

NOTA: as informações de envio são necessárias se o país-alvo for DE (Alemanha); caso contrário, é opcional.
Cadeia Sim
peso de envio

<shipping_weight>
O peso do produto. O peso é utilizado para fins de envio.

NOTA: as informações de envio são necessárias se o país-alvo for DE (Alemanha); caso contrário, é opcional.
ProductShippingWeight Sim
tamanhos

<tamanho>
Os tamanhos disponíveis do produto. Por exemplo, pequeno, médio e grande. Aplicar o dimensionamento de forma consistente. O valor de tamanho é definido pelo utilizador, mas deve basear-se no seu país-alvo. Este campo é necessário para todos os produtos de Vestuário & Acessórios para o destino: França, Alemanha, Reino Unido e Estados Unidos. Cadeia[] Não
sizeSystem

<size_system>
O sistema de medição utilizado para dimensionar o produto. Por exemplo, os sapatos podem ser dimensionados utilizando o sistema dos E.U.A. ou o sistema do Reino Unido.

Seguem-se os valores possíveis.

  • AU
  • DE
  • FR
  • Reino Unido
  • E.U.A
É predefinido para o sistema utilizado pelo país de destino. Recomendado para artigos de vestuário.
Cadeia Não
sizeType

<size_type>
O corte do produto. Seguem-se os valores possíveis.

  • regular
  • maternidade
  • petite
  • mais
  • grande e alto
A predefinição é Regular. Recomendado para artigos de vestuário.
Cadeia Não
targetCountry

<target_country>
O código de país ISO 3166 de duas letras do país-alvo (o país onde pretende anunciar o produto). O país deve corresponder ao mercado especificado pelo catálogo.

Seguem-se os possíveis valores não sensíveis a maiúsculas e minúsculas:

  • AD (Andorra)
  • AL (Albânia)
  • AR (Argentina)
  • AW (Aruba)
  • AT (Áustria)
  • AU (Austrália)
  • BS (Bahamas)
  • BD (Bangladesh)
  • BA (Bósnia e Herzegovina)
  • BE (Bélgica)
  • BO (Bolívia)
  • BG (Bulgária)
  • BR (Brasil)
  • BN (Brunei)
  • AC (Canadá)
  • KY (Ilhas Caimão)
  • CH (Suíça)
  • CL (Chile)
  • CO (Colômbia)
  • CR (Costa Rica)
  • CY (Chipre)
  • CZ (República Checa)
  • DE (Alemanha)
  • DK (Dinamarca)
  • DM (Dominica)
  • DO (República Dominicana)
  • CE (Equador)
  • SV (El Salvador)
  • EE (Estónia)
  • ES (Espanha)
  • FJ (Fiji)
  • FI (Finlândia)
  • FR (França)
  • GF (Guiana Francesa)
  • PF (Polinésia Francesa)
  • GB (Grã-Bretanha)
  • GR (Grécia)
  • GU (Guam)
  • GT (Guatemala)
  • GY (Guiana)
  • HT (Haiti)
  • HN (Honduras)
  • RH (Croácia)
  • HU (Hungria)
  • ID (Indonésia)
  • IE (Irlanda)
  • IN (Índia)
  • IS (Islândia)
  • TI (Itália)
  • LI (Liechtenstein)
  • LT (Lituânia)
  • LU (Luxemburgo)
  • LV (Letónia)
  • MV (Maldivas)
  • MC (Mónaco)
  • ME (Montenegro)
  • MK (Macedónia do Norte)
  • MT (Malta)
  • MQ (Martinica)
  • MY (Malásia)
  • MX (México)
  • MN (Mongólia)
  • MS (Montserrat)
  • NP (Nepal)
  • NL (Países Baixos)
  • NC (Nova Caledónia)
  • NÃO (Noruega)
  • NZ (Nova Zelândia)
  • PA (Panamá)
  • PG (Papua-Nova Guiné)
  • PH (Filipinas)
  • PY (Paraguai)
  • PE (Peru)
  • PL (Polónia)
  • PT (Portugal)
  • PR (Porto Rico)
  • RO (Roménia)
  • RS (Sérvia)
  • LK (Sri Lanka)
  • SE (Suécia)
  • SG (Singapura)
  • SI (Eslovénia)
  • SK (Eslováquia)
  • SM (São Marino)
  • TH (Tailândia)
  • TT (Trinidad e Tobago)
  • TR (Türkiye)
  • E.U.A. (Estados Unidos)
  • UT (Uruguai)
  • VA (Cidade do Vaticano)
  • VE (Venezuela)
  • VN (Vietname)
  • ZA (África do Sul)
Uma vez que o país é utilizado para criar o ID do produto, não poderá alterar este campo depois de adicionar o produto à loja.
Cadeia Sim
impostos

<imposto>
As informações fiscais do produto.

A MMC não utiliza este campo; está incluído para compatibilidade com o Google.
ProductTax[] Não
título

<título>
O título do produto (por exemplo, Sapatos Femininos). O título pode não incluir texto promocional. O título está limitado a um máximo de 150 carateres e pode incluir qualquer caráter Unicode.

O título será submetido a uma revisão editorial.
Cadeia Sim
unitPricingBaseMeasure

<unit_pricing_base_measure>
A medida base do produto para preços (por exemplo, 100ml significa que o preço é calculado com base numa unidade de 100ml).
  • Peso: oz, lb, mg, g, kg
  • Volume (EUA imperial): floz, pt, qt, gal
  • Volume: ml, cl, l, cbm
  • Comprimento: em, ft, yd, cm, m
  • Área: sqft, sqm
  • Por unidade: ct

UnitPricingBaseMeasure Não
unitPricingMeasure

<unit_pricing_measure>
A medida e dimensão do produto à medida que é vendido.
  • Peso: oz, lb, mg, g, kg
  • Volume (EUA imperial): floz, pt, qt, gal
  • Volume: ml, cl, l, cbm
  • Comprimento: em, ft, yd, cm, m
  • Área: sqft, sqm
  • Por unidade: ct

UnitPricingMeasure Não
validatedDestinations

<validated_destination>
A lista só de leitura dos destinos pretendidos que passaram a validação.

A MMC não utiliza este campo; está incluído para compatibilidade com o Google.
Cadeia[] Não
avisos Uma lista de avisos sobre problemas com a oferta do produto. A oferta foi aceite, mas deve resolver os problemas o mais rapidamente possível. Por exemplo, a MMC devolve avisos se não especificar os identificadores de marca, mpn e gtin, caso devam ser conhecidos.

A oferta inclui este campo apenas na resposta de uma inserção/atualização.
Aviso[] Não

ProductCustomAttribute

Define um atributo personalizado.

Name Valor Tipo Nome do elemento XML
nome Obtém ou define o nome do atributo. Cadeia <nome>
tipo Obtém ou define o tipo do atributo. Seguem-se os valores possíveis.

  • booleano
  • datetimerange
  • float
  • grupo
  • int
  • preço
  • texto
  • hora
  • URL
Cadeia <tipo>
unidade Obtém ou define a unidade de medida do atributo. Utilizado apenas para valores do tipo INT e FLOAT. Cadeia <unidade>
valor Obtém ou define o valor do atributo. Cadeia <valor>

ProductCustomGroup

Define um grupo de atributos de cliente.

Name Valor Tipo Nome do elemento XML
atributos Obtém ou define os atributos do grupo. ProductCustomAttribute <atributos>
nome Obtém ou define o nome do grupo. Cadeia <nome>

ProductDestination

Define um destino.

Name Valor Tipo Nome do elemento XML
intenção Seguem-se os valores possíveis.

  • predefinição
  • excluído
  • opcional
  • necessário
Cadeia <intenção>
destinationName Obtém ou define o nome do destino. Cadeia <destination_name>

PreçoDoProduto

Define o preço ou o preço de venda de um produto.

Name Valor Tipo Nome do elemento XML
moeda Obtém ou define a moeda em que o preço é indicado. Especifique a moeda com códigos de moeda ISO 4217. Seguem-se os valores possíveis.

  • AUD (dólar australiano)
  • CHF (franco suíço)
  • CAD (dólar canadiano)
  • EUR (Euro)
  • GBP (libra da Grã-Bretanha)
  • IDR (rupia indonésia)
  • INR (rupia indiana)
  • MYR (ringgit malaio)
  • NZD (dólar neozelandês)
  • PHP (peso filipino)
  • SEK (coroa sueca)
  • SGD (dólar de Singapura)
  • THB (baht tailandês)
  • USD (dólar Estados Unidos)
  • VND (dong vietnamita)
Cadeia currency atributo.

Por exemplo, <price currency="USD">.
valor Obtém ou define o preço do item. Não inclua símbolos de moeda, como "$". Duplo Valor do texto.

Por exemplo, <price currency="USD">38.0<\price>.

Produtos

Define uma lista de produtos. Tenha em atenção que este é o objeto de nível superior que o pedido de Lista devolve.

Name Valor Tipo Nome do elemento XML
tipo Obtém o tipo do objeto. Este campo está definido como content#productsListResponse. Cadeia <tipo>
nextPageToken Obtém o token utilizado para obter a página seguinte dos resultados. Se o objeto não incluir este campo, não existem mais páginas para obter. Veja start-token. Cadeia <next_page_token>
recursos Obtém a lista de produtos. Se o catálogo não contiver ofertas, a matriz estará vazia. Produto[] <produtos>

ProductShipping

Define o custo de envio.

Name Valor Tipo Nome do elemento XML
país/região Obtém ou define o código de país ISO 3166 de duas letras do país/região para o qual o item está a ser enviado. Cadeia <país/região>
locationGroupName Obtém ou define o nome do grupo de localização. Cadeia <location_group_name>
locationId Obtém ou define o ID da localização geográfica para onde o item está a ser enviado. Para obter uma lista de IDs, veja Códigos de Localização Geográfica. Cadeia <location_id>
postalCode Obtém ou define o código postal ou o intervalo de código postal da localização para onde o item está a ser enviado. Pode especificar o código postal da seguinte forma:

  • Um código postal completo: 94114

  • Um código postal com um caráter universal (apenas sufixo): 94*

  • Um intervalo de códigos: 94002-95460

  • Um intervalo de códigos com carateres universais (os prefixos de código postal têm de ter um comprimento igual: 94*-95*
Cadeia <postal_code>
preço Obtém ou define o preço fixo para enviar o item para a localização especificada. PreçoDoProduto <preço>
região Obtém ou define a região geográfica para a qual o item está a ser enviado (por exemplo, código postal). Cadeia <região>
serviço Obtém ou define uma descrição de texto que descreve a classe de serviço ou a velocidade de entrega. Cadeia <serviço>

ProductShippingWeight

Define o peso de envio do item.

Name Valor Tipo Nome do elemento XML
unidade Obtém ou define a unidade de medida. Cadeia unit atributo.

Por exemplo, <shipping_weight unit="oz">.
valor Obtém ou define o peso do item, que é utilizado para calcular o custo de envio do item. Cadeia Valor do texto.

Por exemplo, <shipping_weight unit="oz">20,3<shipping_weight>.

ProductTax

Define a localização geográfica que determina os impostos aplicáveis.

Name Valor Tipo Nome do elemento XML
país/região Obtém ou define o país cuja taxa de imposto se aplica. Utiliza o código de país ISO 3166 de duas letras. Cadeia <país/região>
locationId Obtém ou define o ID da localização geográfica cuja taxa de imposto se aplica. Para obter uma lista de IDs, veja Códigos de Localização Geográfica. Longo <location_id>
postalCode Obtém ou define o código postal ou o intervalo de códigos postais cuja taxa de imposto se aplica. Pode especificar o código postal da seguinte forma:

  • Um código postal completo: 94114

  • Um código postal com um caráter universal (apenas sufixo): 94*

  • Um intervalo de códigos: 94002-95460

  • Um intervalo de códigos com carateres universais (os prefixos de código postal têm de ter um comprimento igual: 94*-95*
Cadeia <postal_code>
taxa Obtém ou define a taxa de imposto percentual a aplicar ao preço do item. Para especificar uma taxa de 5%, defina este campo como 5. Para especificar uma taxa de 9,8%, defina este campo como 9,8. Duplo <taxa>
região Obtém ou define uma região geográfica cuja taxa de imposto se aplica. Cadeia <região>
taxShip Obtém ou define um valor booleano que determina se deve aplicar o imposto ao custo do envio. Definido como verdadeiro se o imposto for cobrado no envio. Booleano <enviar>

Preços Unitários

Define o preço por unidade do item.

Name Valor Tipo Nome do elemento XML
unidade Obtém ou define a unidade de medida. Por exemplo, oz se o preço for por onça. Cadeia unit atributo.

Por exemplo, <unit_pricing_measure unit="oz">
valor Obtém ou define o preço por unidade. Duplo Valor do texto.

Por exemplo, <unit_pricing_measure unit="oz">34.5<\unit_pricing_measure>

Aviso

Define uma mensagem de aviso.

Name Valor Tipo Nome do elemento XML
domínio Apenas para utilização interna. Cadeia <domínio>
Mensagem Uma descrição do aviso. Cadeia <internalReason>
motivo O motivo pelo qual a oferta gerou um aviso. Por exemplo, não forneceu um identificador (gtin, mpn ou marca) quando se sabe que o fabricante os atribuiu. Cadeia <motivo>

Códigos de estado HTTP

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

Código de estado Descrição
200 Sucesso.
204 O produto 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.

Batch: se ocorrer um erro, o item de lote que falhou incluirá os erros.
401 Não autorizado. As credenciais do utilizador não são válidas.
404 Não encontrado.
409 Conflito. Não foi possível concluir a operação devido a um conflito com o estado atual do recurso.
413 Entidade de pedido demasiado grande. O tamanho do pedido excede o máximo permitido.
500 Erro do servidor.