Risorsa stato
La risorsa Stato consente di ottenere lo stato delle offerte di prodotto caricate nel catalogo specificato. Dopo aver caricato le offerte nel catalogo, vengono sottoposti a un processo di convalida e revisione editoriale. Questo processo può richiedere fino a 36 ore. L'offerta viene inclusa nel report solo dopo aver completato il processo di revisione.
Per una panoramica del funzionamento del processo, vedere Come si ottiene lo stato delle offerte di prodotto?
Per un esempio di codice che illustra come ottenere lo stato del catalogo e scaricare il report, vedere Download del report sullo stato del catalogo.
Base URI
Di seguito è riportato l'URI di base a cui si aggiungono i modelli.
https://content.api.bingads.microsoft.com/shopping/v9.1/bmc/
Modelli
Per creare gli endpoint usati per ottenere lo stato delle offerte di prodotti in un catalogo, aggiungere il modello appropriato all'URI di base.
Nota
{bmcMerchantId}/catalogs/{catalogId}/status è stato deprecato e non è consigliabile usarlo.
| Modello | Verbo HTTP | Descrizione | Risorsa |
|---|---|---|---|
{bmcMerchantId}/catalogs/{catalogId}/status |
GET | Usare per ottenere il numero di offerte caricate che hanno superato o non superato la convalida e la revisione editoriale. Impostare sull'ID {bmcMerchantId} archivio MMC.Impostare sull'ID {catalogId} del catalogo. |
Richiesta: N/D Risposta: Stato |
Parametri di query
Gli endpoint possono includere i parametri di query seguenti.
| Parametro | Descrizione |
|---|---|
| Alt | Facoltativo. Usare per specificare il tipo di contenuto usato nella richiesta e nella risposta. I valori possibili sono json e xml. Il valore predefinito è json. |
Intestazioni
Di seguito sono riportate le intestazioni di richiesta e risposta.
| Intestazione | Descrizione |
|---|---|
| Accept | Intestazione della richiesta.<p>Includere questa intestazione quando si scarica il report. È necessario impostare questa intestazione su application/x-zip-compressed. |
| AuthenticationToken | Intestazione della richiesta. Impostare questa intestazione su un token di autenticazione OAuth. Per informazioni su come ottenere un token, vedere Autenticazione delle credenziali. |
| Content-Location | Intestazione della risposta. URL che identifica lo store in cui è stato inserito il prodotto. Questa intestazione è inclusa nella risposta di una richiesta Insert. |
| CustomerAccountId | Intestazione della richiesta. ID account di uno degli account gestiti 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 accesso per sviluppatori 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? |
| Posizione | Intestazione della risposta. URL che identifica lo store in cui è stato inserito il prodotto. Questa intestazione è inclusa nella risposta di una richiesta Insert. |
| WebRequestActivityId | Intestazione della risposta. ID della voce di log che contiene i dettagli sulla 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.
Ogni oggetto definisce il nome della chiave JSON e il nome dell'elemento XML usati a seconda del tipo di contenuto specificato per la richiesta.
| Oggetto | Descrizione |
|---|---|
| Stato | Definisce lo stato delle offerte di prodotti caricate nel catalogo. |
Stato
Definisce lo stato delle offerte di prodotti caricate nel catalogo. Il nome XML dell'oggetto è <catalogStatus>.
| Name | Valore | Tipo | Nome elemento XML |
|---|---|---|---|
| catalogId | ID del catalogo segnalato. | Ulong | <catalog_id> |
| publishedCount | Numero di offerte che hanno superato la convalida e la revisione editoriale. | Ulong | <published_count> |
| rejectedCount | Numero di offerte non riuscite per la convalida e la revisione editoriale. Questo conteggio indica il numero di righe nel corpo del report (vedere Formato report). | Ulong | <rejected_count> |
| rejectionReportUrl | URL usato per scaricare il report. L'oggetto include questo campo solo quando rejectedCount è maggiore di zero.Il report è compresso e deve essere decompresso prima di poterlo leggere. |
stringa | <catalog_id> |
Codici di stato HTTP
Le richieste possono restituire i codici di stato HTTP seguenti.
| Codice di stato | Descrizione |
|---|---|
| 200 | Completato. |
| 400 | Richiesta non valida. Un valore del parametro di query non è valido o l'URL del report (vedere rejectionReportUrl) non è più valido. |
| 401 | Non autorizzato. Le credenziali dell'utente non sono valide. |
| 404 | Non trovato. Lo stato non è disponibile per il catalogo specificato oppure l'ID catalogo o archivio non è valido. |
| 500 | Errore del server. |
Formato report
Il file di report scaricato è contenuto in una cartella compressa Zip (*.zip). Prima di poter leggere il report, è necessario decomprimere la cartella e il relativo contenuto. Il report è un file delimitato da virgole denominato MerchantCatalogReport.csv.
Il report viene suddiviso in una sezione di intestazione e in una sezione del corpo del report. La prima riga contiene i nomi di colonna seguenti per la sezione di intestazione.
| Column Name | Descrizione |
|---|---|
| Nome catalogo | Nome del catalogo. |
| ID catalogo | ID del catalogo. |
| ID archivio | ID dell'archivio che contiene il catalogo. |
| Ora di caricamento | Non utilizzare. Se questo campo esiste, ignorarlo. |
La seconda riga contiene i dati dell'intestazione.
La terza riga è vuota.
La quarta riga contiene i nomi di colonna seguenti per il corpo del report, che inizia sulla quinta riga.
| Column Name | Descrizione |
|---|---|
| ID elemento | Valore offerId dell'offerta che ha avuto esito negativo durante la convalida o la revisione editoriale. Il report conterrà ID univoci. |
| Messaggio | Errore segnalato. |
| Tipo | Tipo di errore. I valori possibili sono Errore o Avviso. |
| Valori | Valore dei dati che ha causato l'errore, se l'errore è stato causato da un valore non valido. |
| Frammento di offerta | Elenco delimitato da punto e virgola di subset dei dati dell'offerta. Il formato è titolo; productType; collegamento; imageLink; prezzo; salePrice; saleStartDate; saleEndDate. Non tutti gli errori includeranno tutti i componenti. |
Per un esempio del report, vedere Report di esempio.