Risorsa ProductStatuses

Articolo
12/21/2023

Nota

La risorsa dello Store è disponibile solo per i partecipanti a beta chiusa. Per informazioni sulla partecipazione al programma closed-beta o open beta, contattare il proprio account manager.

Tutti gli elementi di programmazione e la documentazione dello Store sono soggetti a modifiche durante la versione beta.

Usare la risorsa ProductStatuses per ottenere lo stato delle offerte di prodotti in un negozio.

Base URI

Di seguito è riportato l'URI di base a cui si aggiungono i modelli .

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

Ad esempio, per ottenere una visualizzazione riepilogativa dello stato delle offerte di prodotti in un negozio, usare l'endpoint seguente:

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

Modelli

Questi sono i modelli aggiunti all'URI di base per creare un endpoint HTTP.

/stores/{merchantId}/productstatusessummary

Verbo HTTP	Descrizione	Risorsa
Get	Ottiene una visualizzazione riepilogativa dello stato delle offerte di prodotti in un negozio. Il servizio restituisce il numero di offerte approvate, non approvate e in scadenza nell'archivio. Impostare `{merchantId}` sull'ID dell'archivio da cui ottenere gli stati. Potrebbero essere necessarie fino a due ore dal momento in cui lo stato di un'offerta cambia rispetto all'ora in cui viene riflessa nella visualizzazione di riepilogo.	Richiesta: N/D Risposta: ProductStatusesSummary

/stores/{merchantId}/productstatuses

Verbo HTTP	Descrizione	Risorsa
Get	Ottiene una visualizzazione dettagliata dello stato delle offerte di prodotti in un negozio. I dettagli vengono restituiti solo per i prodotti con stato Non approvato o Avviso. Impostare `{merchantId}` sull'ID dell'archivio da cui si vogliono ottenere gli stati. Il parametro di query max-results determina il numero di offerte restituite dal servizio. Per scorrere tutte le offerte, usare il parametro di query continuation-token .	Richiesta: N/D Risposta: ProductStatuses

Parametri di query

La richiesta può includere i parametri di query seguenti:

Parametro Descrizione

max-results Facoltativo. Utilizzare per specificare il numero massimo di elementi da restituire in una richiesta Elenco, ad /stores/{merchantId}/productstatusesesempio . Il valore massimo che è possibile specificare è 250. Il valore predefinito è 25.

continuation-token Facoltativo. Usare per scorrere l'elenco di stati del prodotto di un negozio. Il token identifica la pagina successiva degli stati del prodotto da restituire. Non specificare questo parametro nella prima richiesta List. Se l'archivio contiene più del numero di prodotti richiesto (vedere il parametro di query max-results ), la risposta include il nextPageToken campo . Nella richiesta successiva impostare continuation-token sul valore del token in nextPageToken.

Parametro	Descrizione
max-results	Facoltativo. Utilizzare per specificare il numero massimo di elementi da restituire in una richiesta Elenco, ad `/stores/{merchantId}/productstatuses`esempio . Il valore massimo che è possibile specificare è 250. Il valore predefinito è 25.
continuation-token	Facoltativo. Usare per scorrere l'elenco di stati del prodotto di un negozio. Il token identifica la pagina successiva degli stati del prodotto da restituire. Non specificare questo parametro nella prima richiesta List. Se l'archivio contiene più del numero di prodotti richiesto (vedere il parametro di query max-results ), la risposta include il `nextPageToken` campo . Nella richiesta successiva impostare continuation-token sul valore del token in `nextPageToken`.

Intestazioni

Di seguito sono riportate le intestazioni di richiesta e risposta.

Intestazione	Descrizione
AuthenticationToken	Intestazione della richiesta. Impostare questa intestazione su un token di accesso OAuth. Per informazioni su come ottenere un token di accesso, vedere Autenticazione delle credenziali.
Content-Type	Intestazione della richiesta. Tutte le richieste POST devono specificare questa intestazione e deve essere impostata su `application/json`.
CustomerAccountId	Intestazione della richiesta. ID account di qualsiasi account gestito per conto del cliente specificato nell'intestazione `CustomerId` . Non importa quale account specificare. Specificare questa intestazione solo se si gestisce un account per conto del cliente.
Customerid	Intestazione della richiesta. ID cliente del cliente di cui si gestisce il negozio. Specificare questa intestazione solo se si gestisce lo store per conto del cliente. Se si imposta questa intestazione, è necessario impostare anche l'intestazione `CustomerAccountId` .
DeveloperToken	Intestazione della richiesta. Token di sviluppo dell'applicazione client. Ogni richiesta deve includere questa intestazione. Per informazioni su come ottenere un token, vedere Le credenziali di Microsoft Advertising e il token per sviluppatori sono disponibili?
WebRequestActivityId	Intestazione della risposta. ID della voce di log che contiene i dettagli della richiesta. È consigliabile acquisire sempre questo ID se si verifica un errore. Se non si è in grado di determinare e risolvere il problema, includere questo ID insieme alle altre informazioni fornite al team di supporto.

Oggetti richiesta e risposta

Di seguito sono riportati gli oggetti richiesta e risposta usati dall'API.

Oggetto	Descrizione
Errore	Definisce un errore.
ErrorResponse	Definisce l'oggetto errore di primo livello.
ProductStatus	Definisce lo stato di un'offerta di prodotto.
ProductStatuses	Definisce un elenco delle offerte di prodotto che presentano problemi.
ProductStatusesSummary	Definisce una visualizzazione riepilogativa dello stato delle offerte di prodotti in un negozio.
ProductStatusItemLevelIssue	Definisce un problema con l'offerta del prodotto.

Error

Definisce un errore.

Name	Valore	Tipo
code	Motivo per cui la richiesta non è riuscita.	Stringa
messaggio	Descrizione dell'errore.	Stringa

ErrorResponse

Definisce l'oggetto errore di primo livello.

Name	Valore	Tipo
Errori	Elenco di errori che si sono verificati durante l'elaborazione della richiesta.	Errore[]

ProductStatus

Definisce lo stato di un'offerta di prodotto.

Name	Valore	Tipo
Creationdate	Data e ora di creazione dell'offerta del prodotto.	DateTime
expirationDate	Data e ora di scadenza dell'offerta del prodotto.	DateTime
itemLevelIssues	Elenco dei problemi relativi all'offerta del prodotto.	ProductStatusItemLevelIssue[]
lastUpdateDate	Data e ora dell'ultimo aggiornamento dell'offerta del prodotto.	DateTime
Productid	ID del prodotto.	Stringa
stato	Stato di approvazione del prodotto. I valori possibili sono: Approvato Avviso I prodotti non approvati non vengono serviti. Gli avvisi indicano che il prodotto presenta problemi che è necessario risolvere, ma non impediscono la distribuzione dell'offerta del prodotto. È necessario risolvere i problemi e inviare di nuovo l'offerta del prodotto.	Stringa
title	Titolo del prodotto	Stringa

ProductStatuses

Definisce un elenco delle offerte di prodotto che presentano problemi.

Name	Valore	Tipo
nextPageToken	Token su cui impostare il parametro di query continuation-token se sono disponibili altre offerte di prodotto.	Stringa
Risorse	Elenco di offerte di prodotti che presentano problemi. Il parametro di query max-results determina il numero massimo di offerte nell'elenco; il numero effettivo restituito può essere minore.	ProductStatus[]

ProductStatusesSummary

Definisce una visualizzazione riepilogativa dello stato delle offerte di prodotti in un negozio. Se l'archivio è stato appena creato, tutti i valori saranno zero.

Name	Valore	Tipo
Approvato	Numero totale di prodotti approvati nel negozio.	Numero intero
Approvato	Numero totale di prodotti nello store non approvati a causa di errori.	Numero intero
Scadenza	Numero totale di prodotti nel negozio che scadranno entro le prossime 72 ore.	Numero intero
merchantId	ID del negozio in cui si trovano i prodotti.	Long senza segno
In sospeso	Numero totale di prodotti in attesa di revisione.	Numero intero

ProductStatusItemLevelIssue

Definisce un problema con l'offerta del prodotto.

Name	Valore	Tipo
Attributename	Nome della proprietà dell'offerta del prodotto che causa il problema. Non tutti i problemi identificano una proprietà. Ad esempio, l'oggetto non include questo campo se il problema è causato da più proprietà.	Stringa
code	Codice di errore che identifica il problema. Ad esempio, TitleTooLongErr.	Stringa
descrizione	Descrizione che illustra il problema con la proprietà .	Stringa
servabilità	Valore che indica se il problema impedisce la gestione dell'offerta. I valori possibili sono: Approvato Inalterato Se non approvata, l'offerta non verrà usata.	Stringa

Codici di stato HTTP

Le richieste possono restituire i codici di stato HTTP seguenti.

Codice di stato	Descrizione
200	Completato.
400	Richiesta non valida. Molto probabilmente la richiesta specifica un parametro di query o un valore di parametro non valido.
401	Non autorizzato. Le credenziali dell'utente non sono valide.
404	Non trovato. L'archivio richiesto non è stato trovato.
500	Errore del server.

Codici di errore

Le richieste possono restituire i codici di errore seguenti.

Codice errore	Descrizione
ContinuationTokenInvalidErr	Il valore del parametro di query continuation-token non è valido. Assicurarsi di impostare il parametro usando il valore nel campo dell'oggetto `nextPageToken`ProductStatuses.

Condividi tramite