ProductStatuses Resource

Nota

O recurso loja está disponível apenas para participantes de versão beta fechada. Para obter informações sobre como participar no programa closed-beta ou open-beta, contacte o gestor de conta.

Todos os elementos de programação e documentação da Store estão sujeitos a alterações durante a versão beta.

Utilize o recurso ProductStatuses para obter o estado das ofertas de produtos numa loja.

Base URI

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

https://content.api.ads.microsoft.com/v9.1/bmc

Por exemplo, para obter uma vista de resumo do estado das ofertas de produtos numa loja, utilize o seguinte ponto final:

https://content.api.ads.microsoft.com/v9.1/bmc/stores/{merchantId}/productstatusessummary

Modelos

Estes são os modelos que acrescenta ao URI base para criar um ponto final HTTP.

/stores/{merchantId}/productstatusessummary

Verbo HTTP	Descrição	Recurso
Obter	Obtém uma vista de resumo do estado das ofertas de produtos numa loja. O serviço devolve o número de ofertas aprovadas, desaprovadas e a expirar na loja. Defina {merchantId} como o ID do arquivo para obter os estados. Pode demorar até duas horas a partir do momento em que o estado de uma oferta muda para o tempo que é refletido na vista de resumo.	Pedido: N/D Resposta: ProductStatusesSummary

/stores/{merchantId}/productstatuses

Verbo HTTP	Descrição	Recurso
Obter	Obtém uma vista detalhada do estado das ofertas de produtos numa loja. Os detalhes são devolvidos apenas para produtos com o estado Desaprovado ou Aviso. Defina {merchantId} para o ID do arquivo do qual pretende obter os estados. O parâmetro de consulta max-results determina o número de ofertas que o serviço devolve. Para analisar todas as ofertas, utilize o parâmetro de consulta continuation-token .	Pedido: N/D Resposta: ProductStatuses

Parâmetros de consulta

O pedido pode incluir os seguintes parâmetros de consulta:

Parâmetro	Descrição
max-results	Opcional. Utilize para especificar o número máximo de itens a devolver num pedido de Lista, como /stores/{merchantId}/productstatuses. O valor máximo que pode especificar é 250. A predefinição é 25.
continuation-token	Opcional. Utilize para percorrer a lista de estados de produtos de uma loja. O token identifica a página seguinte dos estados do produto a devolver. Não especifique este parâmetro no primeiro pedido de Lista. Se o arquivo 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 . No pedido seguinte, defina continuation-token como o valor do token em nextPageToken.

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.
Tipo de Conteúdo	Cabeçalho do pedido. Todos os pedidos POST têm de especificar este cabeçalho e tem de ser definido como application/json.
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?
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.

Objeto	Descrição
Erro	Define um erro.
ErrorResponse	Define o objeto de erro de nível superior.
ProductStatus	Define o estado de uma oferta de produto.
ProductStatuses	Define uma lista das ofertas de produto que têm problemas.
ProductStatusesSummary	Define uma vista de resumo do estado das ofertas de produtos numa loja.
ProductStatusItemLevelIssue	Define um problema com a oferta do produto.

Erro

Define um erro.

Name	Valor	Tipo
código	O motivo pelo qual o pedido falhou.	Cadeia
Mensagem	Uma descrição do erro.	Cadeia

ErrorResponse

Define o objeto de erro de nível superior.

Name	Valor	Tipo
erros	Uma lista de erros que ocorreram durante o processamento do pedido.	Erro[]

ProductStatus

Define o estado de uma oferta de produto.

Name	Valor	Tipo
creationDate	A data e hora em que a oferta do produto foi criada.	DateTime
expirationDate	A data e hora em que a oferta do produto está definida para expirar.	DateTime
itemLevelIssues	A lista de problemas com a oferta do produto.	ProductStatusItemLevelIssue[]
lastUpdateDate	A data e hora em que a oferta do produto foi atualizada pela última vez.	DateTime
productId	O ID do produto.	Cadeia
estado	O estado de aprovação do produto. Os valores possíveis são: Reprovado Aviso Os produtos desaprovados não são servidos. Os avisos indicam que o produto tem problemas que deve resolver, mas não impedem a oferta do produto de servir. Deve corrigir os problemas e submeter novamente a oferta do produto.	Cadeia
título	O título do produto	Cadeia

ProductStatuses

Define uma lista das ofertas de produto que têm problemas.

Name	Valor	Tipo
nextPageToken	O token para definir o parâmetro de consulta continuation-token para se existirem mais ofertas de produto disponíveis para obter.	Cadeia
recursos	A lista de ofertas de produtos que têm problemas. O parâmetro de consulta max-results determina o número máximo de ofertas na lista; o número real devolvido pode ser menor.	ProductStatus[]

ProductStatusesSummary

Define uma vista de resumo do estado das ofertas de produtos numa loja. Se o arquivo tiver acabado de ser criado, todos os valores serão zero.

Name	Valor	Tipo
aprovado	O número total de produtos na loja aprovados.	Número inteiro
não aprovada	O número total de produtos na loja que são desaprovados devido a erros.	Número inteiro
a expirar	O número total de produtos na loja que irão expirar nas próximas 72 horas.	Número inteiro
merchantId	O ID da loja onde se encontram os produtos.	Sem assinatura por extenso
pendente	O número total de produtos pendentes de revisão.	Número inteiro

ProductStatusItemLevelIssue

Define um problema com a oferta do produto.

Name	Valor	Tipo
attributeName	O nome da propriedade da oferta do produto que está a causar o problema. Nem todos os problemas identificam uma propriedade. Por exemplo, o objeto não inclui este campo se o problema for causado por mais do que uma propriedade.	Cadeia
código	O código de erro que identifica o problema. Por exemplo, TitleTooLongErr.	Cadeia
descrição	Uma descrição que explica o problema com a propriedade .	Cadeia
servabilidade	Um valor que indica se o problema impede a oferta de servir. Os valores possíveis são: Reprovado Não afetado Se não for desaprovada, a oferta não servirá.	Cadeia

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. O mais provável é que o pedido especifique um parâmetro de consulta inválido ou um valor de parâmetro.
401	Não autorizado. As credenciais do utilizador não são válidas.
404	Não encontrado. A loja pedida não foi encontrada.
500	Erro do servidor.

Códigos de erro

Os pedidos podem devolver os seguintes códigos de erro.

Código de erro	Descrição
ContinuationTokenInvalidErr	O valor do parâmetro de consulta continuation-token não é válido. Certifique-se de que define o parâmetro com o valor no campo do nextPageToken objeto ProductStatuses.