Risorsa archivio

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 Store per gestire gli archivi di proprietà dell'utente. È possibile aggiungere negozi, ottenere un archivio specifico o ottenere tutti i negozi di proprietà dell'utente. Altre informazioni.

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 aggiungere un archivio o ottenere un elenco di negozi di proprietà dell'utente, usare l'endpoint seguente:

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

Modelli

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

Modello /stores

Verbo HTTP	Descrizione	Risorsa
POST	Aggiunge un archivio. I limiti seguenti si applicano e sono soggetti a modifiche: Un cliente può aggiungere un massimo di 14 archivi che specificano lo stesso URL dello store. Un cliente può aggiungere un massimo di 1.024 negozi.	Richiesta: StoreCreate Risposta: Archivio
GET	Ottiene un elenco di archivi di proprietà dell'utente.	Richiesta: N/D Risposta: StoreCollection

Modello /stores/{merchantId}

Verbo HTTP	Descrizione	Risorsa
GET	Ottiene l'archivio specificato. Impostare `{merchantId}` sull'ID dell'archivio che si vuole ottenere.	Richiesta: N/D Risposta: Archivio

Parametri di query

La richiesta può includere i parametri di query seguenti:

Parametro	Descrizione
dry-run	Facoltativo. Usare per testare o eseguire il debug dell'applicazione. Le chiamate che includono questo parametro non influiranno sui dati di produzione (gli archivi non vengono aggiunti); tuttavia, la risposta conterrà eventuali errori generati dalla chiamata. Quando si usa questo parametro, considerare le limitazioni seguenti. Le operazioni di aggiunta non restituiscono ID. Il servizio non genera o restituisce messaggi di errore secondari, ad esempio qualità dei dati, problemi editoriali e convalide correlate al database. Per altre informazioni sul test dell'applicazione, vedere Sandbox.

Parametro

Descrizione

dry-run

Facoltativo. Usare per testare o eseguire il debug dell'applicazione. Le chiamate che includono questo parametro non influiranno sui dati di produzione (gli archivi non vengono aggiunti); tuttavia, la risposta conterrà eventuali errori generati dalla chiamata.

Quando si usa questo parametro, considerare le limitazioni seguenti.

Le operazioni di aggiunta non restituiscono ID.
Il servizio non genera o restituisce messaggi di errore secondari, ad esempio qualità dei dati, problemi editoriali e convalide correlate al database.

Per altre informazioni sul test dell'applicazione, vedere Sandbox.

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.
Negozio	Definisce un negozio in Microsoft Merchant Center.
StoreCollection	Definisce una raccolta di negozi in Microsoft Merchant Center.
StoreCreate	Definisce un archivio da aggiungere a Microsoft Merchant Center.
StoreStatus	Definisce lo stato dell'archivio.

Error

Definisce un errore.

Name	Valore	Tipo
code	Motivo per cui la richiesta non è riuscita. Ad esempio, il codice è InvalidStoreNameErr se la convalida del `storeName` campo 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[]

Negozio

Definisce un negozio in Microsoft Merchant Center.

Name	Valore	Tipo
isBlockAggregator	Valore booleano che indica se vuoi impedire agli aggregatori di pubblicare annunci dal tuo negozio. Gli aggregatori consolidano le offerte di prodotti di più aziende, spesso non correlate. Per impostazione predefinita, gli aggregatori possono includere il catalogo negli annunci. È vero se vuoi impedire che i tuoi prodotti vengano visualizzati negli annunci degli aggregatori in Bing. Se sono presenti due negozi (uno per il Stati Uniti e uno per il Regno Unito) che usano http://www.contoso.com e uno di essi blocca gli aggregatori, entrambi archiviano gli aggregatori di blocchi.	Booleano
isSslCheckout	Valore booleano che indica se l'archivio è abilitato per SSL. Tutti gli archivi devono avere pagine di accesso e di estrazione SSL. È true se il sito Web del tuo negozio è abilitato per SSL.	Booleano
merchantId	ID dell'archivio.	Long senza segno
notificationEmail	Elenco di destinatari per ricevere messaggi di posta elettronica di notifica. I messaggi di posta elettronica inviano una notifica quando l'archivio è approvato o se sono presenti errori di convalida con l'archivio.	String[]
notificationLanguage	Lingua usata per scrivere i messaggi di posta elettronica di notifica. La lingua è nel formato paese-lingua><</area geografica>. Ad esempio, en-US.	Stringa
storeDescription	Descrizione che descrive l'uso dell'archivio.	Stringa
Storename	Nome dell'archivio.	Stringa
storeStatus	Stato dell'archivio.	StoreStatus
storeUrl	URL di destinazione dell'archivio. L'URL di destinazione è la pagina Web a cui gli utenti vengono indirizzati quando fanno clic sul tuo annuncio.	Stringa

StoreCollection

Definisce un elenco di archivi.

Name	Valore	Tipo
Negozi	Elenco di negozi di proprietà dell'utente.	Store[]

StoreCreate

Definisce un archivio da aggiungere a Microsoft Merchant Center.

Name	Valore	Tipo	Obbligatorio
isBlockAggregator	Valore booleano che indica se vuoi impedire agli aggregatori di pubblicare annunci dal tuo negozio. Gli aggregatori consolidano le offerte di prodotti di più aziende, spesso non correlate. Per impostazione predefinita, gli aggregatori possono includere il catalogo negli annunci. Impostare su true per impedire che i prodotti vengano visualizzati negli annunci degli aggregatori in Bing. Se sono presenti due negozi (uno per il Stati Uniti e uno per il Regno Unito) che usano http://www.contoso.com e uno di essi blocca gli aggregatori, entrambi archiviano gli aggregatori di blocchi. Il valore predefinito è false.	Booleano	No
isSslCheckout	Valore booleano che indica se l'archivio è abilitato per SSL. Tutti gli archivi devono avere pagine di accesso e di estrazione SSL. Impostare su true se il sito Web del tuo negozio è abilitato per SSL. Se false , l'archivio non è approvato. Il valore predefinito è true.	Booleano	No
notificationEmail	Elenco di destinatari per ricevere messaggi di posta elettronica di notifica. I messaggi di posta elettronica inviano una notifica quando l'archivio è approvato o se sono presenti errori di convalida con l'archivio. Il numero massimo di indirizzi di posta elettronica che è possibile specificare è 14.	String[]	Sì
notificationLanguage	Lingua usata per scrivere i messaggi di posta elettronica di notifica. La lingua è nel formato paese-lingua><</area geografica>. Di seguito sono riportati i possibili valori senza distinzione tra maiuscole e minuscole che è possibile specificare. en-US (English-Stati Uniti) en-AU (English-Australia) en-GB (Inglese-Regno Unito) fr-FR (Francese-Francia) de-DE (Germania-Germania) ja-JP (Giapponese-Giappone)	Stringa	Sì
storeDescription	Descrizione che descrive l'uso dell'archivio. La descrizione è limitata a un massimo di 350 caratteri e può contenere solo caratteri alfanumerici ([a-zA-Z0-9]).	Stringa	No
Storename	Nome dell'archivio. Poiché il nome dello store viene visualizzato negli annunci del prodotto, assicurati di usare un nome che rappresenti accuratamente il tuo sito Web. Il nome deve: Essere univoci all'interno di Bing Merchant Center Non contiene più di 70 caratteri Contengono solo caratteri alfanumerici ([a-zA-Z0-9])	Stringa	Sì
storeUrl	URL di destinazione dell'archivio. L'URL di destinazione è la pagina Web a cui gli utenti vengono indirizzati quando fanno clic sul tuo annuncio. L'URL non deve essere reindirizzato a un altro percorso. L'URL deve avere un formato corretto e avere un massimo di 1.024 caratteri. È necessario verificare e richiedere l'URL del sito Web. Gli archivi non sono approvati se Microsoft non riesce a verificare che il sito Web sia conforme a SSL. I siti Web del commerciante devono avere pagine di accesso e pagamento SSL. Verificare che i certificati SSL siano validi.	Stringa	Sì

StoreStatus

Definisce lo stato dell'archivio.

Name	Valore	Tipo
messaggio	Il motivo per cui il negozio è stato disapprovato. L'oggetto include questo campo solo se `status` non è approvato.	Stringa
stato	Stato dell'archivio. Di seguito sono riportati i valori possibili. Approvati Approvato ManualReview Se l'archivio non è approvato, vedere `message` per il motivo. Un archivio inizialmente approvato automaticamente può passare da Approvato a ManualeReview. Non è possibile aggiungere prodotti a un negozio sottoposto a revisione manuale e i prodotti nel negozio non verranno usati. A seconda del motivo della mancata approvazione, è possibile risolvere il problema usando l'applicazione Microsoft Ads. In caso contrario, sarà necessario creare un nuovo archivio con i valori appropriati.	Stringa

Codici di stato HTTP

Le richieste possono restituire i codici di stato HTTP seguenti.

Codice di stato	Descrizione
200	Completato.
201	L'archiviazione è stata aggiunta correttamente.
400	Richiesta non valida. Molto probabilmente il corpo della richiesta POST contiene dati non validi o 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
AdultAdvertiserErr	Gli inserzionisti per adulti non possono creare negozi.
DomainNotOwnedByCustomerErr	Il dominio specificato nel campo storeUrl non è di proprietà del cliente. Assicurarsi che il cliente abbia verificato di essere il proprietario del dominio.
DuplicateStoreNameErr	Esiste un altro archivio con il nome dell'archivio specificato; i nomi dei negozi devono essere univoci con Microsoft Merchant Center.
ExceededMaxStoresForCustomerErr	Il cliente ha superato il numero di negozi che può creare. Per i limiti, vedere Aggiungere il post dell'archivio.
ExceededMaxStoresForDestinationUrlErr	Il cliente ha superato il numero di negozi che può creare usando lo stesso URL di destinazione. Per i limiti, vedere Aggiungere il post dell'archivio.
InvalidStoreDescriptionErr	La descrizione dell'archivio non è valida. Per i limiti, vedere storeDescription.
InvalidStoreDestinationUrlErr	L'URL di destinazione dell'archivio specificato nel campo storeUrl non è valido.
InvalidStoreNameErr	Il nome dell'archivio non è valido. Per i limiti, vedere storeName.
MarketNotSupportedErr	Il mercato specificato nel campo notificationLanguage non è valido.
NoDomainsFoundForCustomerErr	Non sono presenti domini verificati di proprietà del cliente.

Condividi tramite