Compatibilità dell'API Content for Shopping

Puoi utilizzare questa guida per integrare l'API Merchant con la tua implementazione esistente di API Content for Shopping.

Inizia

Consulta la progettazione dell'API Merchant per i dettagli sull'API Merchant e sulle relative API secondarie.

Per iniziare a utilizzare l'API Merchant, modifica gli URL delle richieste nel seguente formato:

https://merchantapi.googleapis.com/{sub-API}/{version}/{resource name}/{service}:{method}…

Consulta la guida rapida e il riferimento dell'API Merchant per ulteriori informazioni.

Supporto gRPC

L'API Merchant supporta gRPC e REST. Puoi utilizzare gRPC per l'API Merchant e REST per l'API Content for Shopping contemporaneamente.

Le librerie client dell'API Merchant richiedono gRPC.

Per ulteriori informazioni, consulta Utilizzare gRPC.

Compatibilità

Questa guida descrive le modifiche generali che si applicano all'intera API Merchant. Consulta le seguenti guide per le modifiche a funzionalità specifiche:

• Eseguire la migrazione della gestione degli account
• Eseguire la migrazione delle impostazioni di spedizione
• Eseguire la migrazione della gestione dei prodotti
• Eseguire la migrazione della gestione delle origini dati
• Eseguire la migrazione della gestione degli inventari
• Eseguire la migrazione della gestione delle promozioni
• Eseguire la migrazione della gestione dei report
• Eseguire la migrazione della gestione delle origini conversione
• Eseguire la migrazione della gestione delle partnership per i feed locali

L'API Merchant è progettata per funzionare insieme alle funzionalità esistenti dell'API Content for Shopping v2.1.

Ad esempio, puoi utilizzare l'API Merchant Inventories insieme agli inventari dell'API Content for Shopping v2.1 e all'implementazione products esistenti. Potresti utilizzare l'API Content for Shopping per caricare un nuovo prodotto locale (che vendi in un negozio locale), quindi utilizzare la risorsa API Merchant Inventories LocalInventory per gestire le informazioni in negozio relative al prodotto in questione.

Nota: a causa del design migliorato, non possiamo garantire la totale compatibilità con le versioni precedenti di funzionalità simili tra l'API Content for Shopping e l'API Merchant Center. Ad esempio, i nomi dei campi o la disponibilità dei metodi potrebbero variare per la stessa risorsa nell'API Content for Shopping e nell'API Merchant.

Richieste batch

L'API Merchant non supporta il metodo customBatch incluso nell'API Content for Shopping. Vedi invece Inviare richieste in batch. Se utilizzi customBatch e hai bisogno di questa funzionalità per l'API Merchant, spiegaci il motivo nel tuo feedback.

Identificatori

Per allinearci ai principi di miglioramento delle API di Google, abbiamo apportato alcune modifiche agli identificatori per le risorse dell'API Merchant.

il nome sostituisce l'ID

Tutte le risorse dell'API Merchant utilizzano il campo name come identificatore univoco.

Ecco un esempio di come utilizzare il campo name nelle chiamate:

POST https://merchantapi.googleapis.com/inventories/v1beta/{parent}/regionalInventories:insert

Questo nuovo campo name viene restituito come identificatore della risorsa per tutte le chiamate di lettura e scrittura nell'API Merchant.

Il valore restituito nei campi name utilizza il nuovo formato ID.

Importante: consigliamo di utilizzare il valore del campo name direttamente nelle chiamate, anziché analizzare o creare manualmente il nome di una risorsa per evitare problemi.

Ad esempio, implementa un metodo getName() per recuperare il name da una risorsa e archiviare l'output come variabile anziché creare personalmente il name dagli ID commerciante e risorsa.

Nuovo formato ID

Nota: l'API Merchant restituirà gli ID senza valore channel fino al 13 novembre 2023. Dopo il 13 novembre, tutte le chiamate restituiranno l'ID risorsa completo. Devi utilizzare l'ID risorsa completo, incluso channel, nelle chiamate entro il 1° febbraio 2024.

Nell'API Merchant, gli ID risorsa utilizzano il seguente formato: channel~language~feedLabel~offerId

Le risorse dell'API Content hanno utilizzato : invece di ~ tra ogni valore nell'ID: channel:language:feedLabel:offerId

Tutte le chiamate API Merchant restituiscono il nuovo formato con ~ tra i valori dell'ID. Ti consigliamo di archiviare il nuovo formato della risposta e di utilizzarlo nelle chiamate future.

campi padre per le risorse figlio

Nell'API Merchant, tutte le risorse secondarie hanno il campo parent. Puoi utilizzare il campo parent per specificare il name della risorsa in cui inserire l'elemento figlio, anziché passare l'intera risorsa padre. Puoi anche utilizzare il campo parent con i metodi list per elencare le risorse figlio di parent.

Ad esempio, per elencare gli inventari locali per un determinato prodotto, specifica l'elemento name del prodotto nel campo parent per il metodo list. In questo caso, il valore product specificato è il parent delle risorse di LocalInventory restituite.

Tipi

Di seguito sono riportati alcuni tipi comuni condivisi nelle API secondarie dell'API Merchant.

Prezzo

Ecco cosa è cambiato per Price nel pacchetto Merchant Common:

	API Content	API Merchant
Campo dell'importo	value:string	amountMicros:int64
Campo Valuta	currency:string	currencyCode:string

L'importo di Price viene ora registrato in micro, dove 1 milione di micro è equivalente all'unità standard della tua valuta.

Nell'API Content for Shopping, Price era un numero decimale sotto forma di stringa.

Il nome del campo dell'importo è cambiato da value a amountMicros

Il nome del campo valuta è stato modificato da currency a currencyCode. Il formato rimane ISO 4217.