Recurso de Estado

O recurso Estado permite-lhe obter o estado das ofertas de produto que carregou para o catálogo especificado. Depois de carregar as ofertas para o catálogo, estas passam por um processo de validação e revisão editorial. Este processo pode demorar até 36 horas. A oferta só é incluída no relatório depois de concluir o processo de revisão.

Para obter uma descrição geral de como o processo funciona, consulte Como Posso Obter o Estado das Ofertas de Produto?

Para obter um exemplo de código que mostra como obter o estado do catálogo e transferir o relatório, veja Transferir o Relatório de Estado do Catálogo.

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 obter o estado das ofertas de produtos num catálogo, acrescente o modelo adequado ao URI base.

Nota

{bmcMerchantId}/catalogs/{catalogId}/status foi preterido e não recomendamos que o utilize.

Modelo	Verbo HTTP	Descrição	Recurso
{bmcMerchantId}/catalogs/{catalogId}/status	GET	Utilize para obter o número de ofertas carregadas que passaram ou falharam a validação e a revisão editorial. Defina {bmcMerchantId} para o ID da loja MMC. Defina {catalogId} para o ID do catálogo.	Pedido: N/D Resposta: Estado

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
Aceitar	Cabeçalho do pedido.<p>Inclua este cabeçalho quando transferir o relatório. Tem de definir este cabeçalho como application/x-zip-compressed.
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 produto 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 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 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 especificou para o pedido.

Objeto	Descrição
Estado	Define o estado das ofertas de produtos que foram carregadas para o catálogo.

Estado

Define o estado das ofertas de produtos que foram carregadas para o catálogo. O nome XML do objeto é <catalogStatus>.

Name	Valor	Tipo	Nome do elemento XML
catalogId	O ID do catálogo que está a ser reportado.	ulong	<catalog_id>
publishedCount	O número de ofertas que passaram na validação e revisão editorial.	ulong	<published_count>
rejectedCount	O número de ofertas que falharam na validação e revisão editorial. Esta contagem indica o número de linhas no corpo do relatório (veja Formato do Relatório).	ulong	<rejected_count>
rejectionReportUrl	O URL que utiliza para transferir o relatório. O objeto inclui este campo apenas quando rejectedCount é maior que zero. O relatório é comprimido e tem de ser deszipado antes de poder lê-lo.	cadeia	<catalog_id>

Códigos de estado HTTP

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

Código de estado	Descrição
200	Sucesso.
400	Pedido incorreto. Um valor de parâmetro de consulta não é válido ou o URL do relatório (veja rejeiçãoReportUrl) já não é válido.
401	Não autorizado. As credenciais do utilizador não são válidas.
404	Não encontrado. O estado não está disponível para o catálogo especificado ou o catálogo ou o ID de arquivo não é válido.
500	Erro do servidor.

Formato do Relatório

O ficheiro de relatório que transferir está contido numa pasta comprimida zip (*.zip). Tem de deszipar a pasta e os respetivos conteúdos antes de poder ler o relatório. O relatório é um ficheiro delimitado por vírgulas com o nome MerchantCatalogReport.csv.

O relatório é dividido numa secção de cabeçalho e na secção do corpo do relatório. A primeira linha contém os seguintes nomes de coluna para a secção de cabeçalho.

Nome da Coluna	Descrição
Nome do Catálogo	O nome do catálogo.
ID do Catálogo	O ID do catálogo.
ID da Loja	O ID do arquivo que contém o catálogo.
Hora de Carregamento	Não utilize. Se este campo existir, ignore-o.

A segunda linha contém os dados do cabeçalho.

A terceira linha está em branco.

A quarta linha contém os seguintes nomes de coluna para o corpo do relatório, que começa na quinta linha.

Nome da Coluna	Descrição
Item Id	O offerId da oferta que falhou na validação ou revisão editorial. O relatório irá conter IDs exclusivos.
Mensagem	O erro que está a ser comunicado.
Tipo	O tipo de erro. Os valores possíveis são Erro ou Aviso.
Valores	O valor de dados que causou o erro, se o erro tiver sido causado por um valor inválido.
Fragmento de Oferta	Uma lista delimitada por ponto e vírgula do subconjunto dos dados da oferta. O formato é título; productType; ligação; imageLink; preço; salePrice; saleStartDate; saleEndDate. Nem todos os erros incluirão todos os componentes.

Para obter um exemplo do relatório, veja Relatório de Exemplo.