Package google.shopping.merchant.promotions.v1beta

Indice

PromotionsService

Servizio per gestire le promozioni dei prodotti.

GetPromotion

rpc GetPromotion(GetPromotionRequest) returns (Promotion)

Recupera la promozione dal tuo account Merchant Center.

Dopo aver inserito o aggiornato un input della promozione, potrebbero essere necessari diversi minuti prima che la promozione aggiornata possa essere recuperata.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

  • https://www.googleapis.com/auth/content

Per ulteriori informazioni, consulta la Panoramica di OAuth 2.0.
InsertPromotion

rpc InsertPromotion(InsertPromotionRequest) returns (Promotion)

Inserisce una promozione per il tuo account Merchant Center. Se la promozione esiste già, viene aggiornata.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

  • https://www.googleapis.com/auth/content

Per ulteriori informazioni, consulta la Panoramica di OAuth 2.0.
ListPromotions

rpc ListPromotions(ListPromotionsRequest) returns (ListPromotionsResponse)

Elenca le promozioni nel tuo account Merchant Center. La risposta potrebbe contenere meno elementi rispetto a quanto specificato da pageSize. Utilizza pageToken per determinare se ci sono altri elementi da richiedere.

Dopo aver inserito o aggiornato una promozione, potrebbero essere necessari diversi minuti prima che la promozione elaborata aggiornata possa essere recuperata.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

  • https://www.googleapis.com/auth/content

Per ulteriori informazioni, consulta la Panoramica di OAuth 2.0.

Attributi

Attributi.

Campi
product_applicability

ProductApplicability

Obbligatorio. Applicabilità della promozione a tutti i prodotti o solo a prodotti specifici.
offer_type

OfferType

Obbligatorio. Tipo della promozione. Utilizza questo attributo per indicare se i clienti hanno bisogno o meno di un codice coupon per utilizzare la tua promozione.
generic_redemption_code

string

(Facoltativo) Codice promozionale generico per la promozione. Da utilizzare con il campo offerType e deve soddisfare i requisiti minimi.
long_title

string

Obbligatorio. Titolo lungo della promozione.
coupon_value_type

CouponValueType

Obbligatorio. L'attributo tipo di valore del coupon per indicare il tipo di promozione che vuoi pubblicare. A seconda del tipo di valore del coupon selezionato, alcuni attributi sono obbligatori.
promotion_destinations[]

DestinationEnum

Obbligatorio. L'elenco delle destinazioni a cui si applica la promozione. Se non specifichi una destinazione includendo un valore supportato nell'origine dati, per impostazione predefinita la promozione verrà visualizzata negli annunci Shopping e nelle schede senza costi.

Potresti aver già inviato i seguenti valori come destinazioni per i tuoi prodotti: Shopping Actions, Piattaforme Google, Piattaforme Google locali. Per rappresentare questi valori, utilizza FREE_LISTINGS, FREE_LOCAL_LISTINGS, LOCAL_INVENTORY_ADS. Per maggiori dettagli, consulta Destinazione della promozione.
item_id_inclusion[]

string

(Facoltativo) Filtro dei prodotti per ID articolo per la promozione. Gli attributi del filtro di prodotto si applicano solo quando l'attributo prodotti idonei alla promozione product_applicability è impostato su specific_products.
brand_inclusion[]

string

(Facoltativo) Filtro dei prodotti per brand per la promozione. Gli attributi del filtro di prodotto si applicano solo quando l'attributo prodotti idonei all'applicabilità del prodotto in promozione product_applicability è impostato su specific_products.
item_group_id_inclusion[]

string

(Facoltativo) Filtro dei prodotti per ID gruppo di articoli per la promozione. Gli attributi del filtro di prodotto si applicano solo quando l'attributo prodotti idonei alla promozione [product_applicability] è impostato su specific_products.
product_type_inclusion[]

string

(Facoltativo) Filtro dei prodotti per tipo di prodotto per la promozione. Gli attributi del filtro di prodotto si applicano solo quando l'attributo prodotti idonei alla promozione product_applicability è impostato su specific_products.
item_id_exclusion[]

string

(Facoltativo) Filtro dei prodotti per esclusione dell'ID articolo per la promozione. Gli attributi del filtro di prodotto si applicano solo quando l'attributo prodotti idonei alla promozione product_applicability è impostato su specific_products.
brand_exclusion[]

string

(Facoltativo) Filtra i prodotti in base all'esclusione dei brand per la promozione. Gli attributi del filtro di prodotto si applicano solo quando l'attributo prodotti idonei all'applicabilità del prodotto in promozione product_applicability è impostato su specific_products.
item_group_id_exclusion[]

string

(Facoltativo) Filtro dei prodotti per ID gruppo di articoli. Gli attributi del filtro di prodotto si applicano solo quando l'attributo prodotti idonei alla promozione product_applicability è impostato su specific_products. esclusione per la promozione.
product_type_exclusion[]

string

(Facoltativo) Filtro dei prodotti per esclusione del tipo di prodotto per la promozione. Gli attributi del filtro di prodotto si applicano solo quando l'attributo prodotti idonei alla promozione product_applicability è impostato su specific_products.
minimum_purchase_amount

Price

(Facoltativo) Soglia minima di acquisto per la promozione.
minimum_purchase_quantity

int64

(Facoltativo) Quantità minima di acquisto per la promozione.
limit_quantity

int64

(Facoltativo) Quantità massima di acquisto per la promozione.
limit_value

Price

(Facoltativo) Prezzo massimo del prodotto per la promozione.
percent_off

int64

(Facoltativo) La percentuale di sconto offerta nella promozione.
money_off_amount

Price

(Facoltativo) L'importo dello sconto monetario offerto nella promozione.
get_this_quantity_discounted

int64

(Facoltativo) Il numero di articoli scontati nella promozione. L'attributo viene impostato quando couponValueType è uguale a buy_m_get_n_money_off o buy_m_get_n_percent_off.
free_gift_value

Price

(Facoltativo) Valore del regalo per la promozione.
free_gift_description

string

(Facoltativo) Descrizione del regalo per la promozione.
free_gift_item_id

string

(Facoltativo) ID articolo del regalo per la promozione.
promotion_effective_time_period

Interval

Obbligatorio. TimePeriod rappresentazione delle date di validità della promozione. Questo attributo specifica che la promozione può essere testata nel tuo negozio online durante questo periodo di tempo.
promotion_display_time_period

Interval

(Facoltativo) TimePeriod rappresentazione delle date di visualizzazione della promozione. Questo attributo specifica la data e l'intervallo di tempo in cui la promozione verrà pubblicata su Google.com e negli annunci Shopping. Se l'attributo periodo di visualizzazione della promozione promotion_display_time_period non è specificato, il periodo di tempo di validità della promozione promotion_effective_time_period determina la data e l'intervallo di tempo in cui la promozione sarà attiva su Google.com e negli annunci Shopping.
store_applicability

StoreApplicability

(Facoltativo) Indica se la promozione si applica a tutti i negozi o solo a negozi specifici. Le promozioni degli annunci di inventario locale generano un errore se non è inclusa l'applicabilità al negozio. Viene generato un errore INVALID_ARGUMENT se store_applicability è impostato su ALL_STORES e store_codes_inclusion o score_code_exclusion è impostato su un valore.
store_codes_inclusion[]

string

(Facoltativo) Codici negozio da includere nella promozione. Gli attributi del filtro dei negozi si applicano solo quando l'attributo store_applicability è impostato su specific_stores.

Codice negozio (l'ID negozio presente nel profilo dell'attività) del negozio fisico in cui viene venduto il prodotto. Per ulteriori informazioni, consulta la specifica dei dati di inventario locale dei prodotti.
store_codes_exclusion[]

string

(Facoltativo) Codici negozio da escludere per la promozione. Gli attributi del filtro dei negozi si applicano solo quando l'attributo store_applicability è impostato su specific_stores.
promotion_url

string

(Facoltativo) URL della pagina del sito del commerciante in cui viene visualizzata la promozione. Le promozioni per gli annunci di inventario locale generano un errore se non viene incluso promotion_url. L'URL viene utilizzato per verificare l'utilizzabilità e la validità della promozione.

CouponValueType

Tipo di valore del coupon di una promozione.

Enum
COUPON_VALUE_TYPE_UNSPECIFIED Indica che il tipo di valore del coupon non è specificato.
MONEY_OFF Tipo di valore del coupon sconto.
PERCENT_OFF Tipo di valore del coupon con sconto in percentuale.
BUY_M_GET_N_MONEY_OFF Tipo di valore del coupon Acquista una quantità M e ricevi uno sconto in denaro di N. minimum_purchase_quantity e get_this_quantity_discounted devono essere presenti. Deve essere presente anche money_off_amount.
BUY_M_GET_N_PERCENT_OFF Acquista una quantità M e ottieni una percentuale di sconto N sul tipo di valore del coupon. minimum_purchase_quantity e get_this_quantity_discounted devono essere presenti. Deve essere presente anche percent_off_percentage.
BUY_M_GET_MONEY_OFF Acquista una quantità M e ottieni uno sconto in denaro. minimum_purchase_quantity e money_off_amount devono essere presenti.
BUY_M_GET_PERCENT_OFF Acquista una quantità M e ottieni uno sconto in denaro. minimum_purchase_quantity e percent_off_percentage devono essere presenti.
FREE_GIFT Regalo senza costi solo con descrizione.
FREE_GIFT_WITH_VALUE Regalo con valore monetario.
FREE_GIFT_WITH_ITEM_ID Regalo con ID articolo.
FREE_SHIPPING_STANDARD Tipo di valore del coupon per la spedizione gratuita standard.
FREE_SHIPPING_OVERNIGHT Tipo di valore del coupon per la spedizione gratuita il giorno successivo.
FREE_SHIPPING_TWO_DAY Tipo di valore del coupon con spedizione gratuita in due giorni.

GetPromotionRequest

Messaggio di richiesta per il metodo GetPromotion.

Campi
name

string

Obbligatorio. Il nome della promozione da recuperare. Formato: accounts/{account}/promotions/{promotions}

InsertPromotionRequest

Messaggio di richiesta per il metodo InsertPromotion.

Campi
parent

string

Obbligatorio. L'account in cui verrà inserita la promozione. Formato: accounts/{account}
promotion

Promotion

Obbligatorio. La promozione da inserire.
data_source

string

Obbligatorio. L'origine dati del formato della promozione: accounts/{account}/dataSources/{datasource}.

ListPromotionsRequest

Messaggio di richiesta per il metodo ListPromotions.

Campi
parent

string

Obbligatorio. L'account per cui elencare le promozioni elaborate. Formato: accounts/{account}
page_size

int32

Solo output. Il numero massimo di promozioni da restituire. Il servizio potrebbe restituire meno di questo valore. Il valore massimo è 250; i valori superiori a 250 verranno forzati a 250. Se non specificato, verrà restituito il numero massimo di promozioni.
page_token

string

Solo output. Un token di pagina, ricevuto da una precedente chiamata a ListPromotions. Fornisci questo valore per recuperare la pagina successiva.

Quando viene applicata la paginazione, tutti gli altri parametri forniti a ListPromotions devono corrispondere alla chiamata che ha fornito il token pagina.

ListPromotionsResponse

Messaggio di risposta per il metodo ListPromotions.

Campi
promotions[]

Promotion

Le promozioni elaborate dall'account specificato.
next_page_token

string

Un token che può essere inviato come page_token per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.

OfferType

Tipo di offerta di una promozione.

Enum
OFFER_TYPE_UNSPECIFIED Tipo di offerta sconosciuto.
NO_CODE Tipo di offerta senza codice.
GENERIC_CODE Tipo di offerta con un codice. È necessario un codice promozionale generico per la promozione quando offerType = GENERIC_CODE.

ProductApplicability

A quale prodotto o elenco di prodotti si applica la promozione.

Enum
PRODUCT_APPLICABILITY_UNSPECIFIED Non è noto a quali prodotti si applica la promozione.
ALL_PRODUCTS Applicabile a tutti i prodotti.
SPECIFIC_PRODUCTS Applicabile solo a un singolo prodotto o a un elenco di prodotti.

Promozione

Rappresenta una promozione. Per ulteriori dettagli, leggi gli articoli seguenti.

Di seguito sono definiti principalmente gli attributi di input delle promozioni obbligatori per superare i controlli di convalida dei dati:

Dopo aver inserito e aggiornato un input della promozione, potrebbero essere necessari diversi minuti prima che la promozione finale possa essere recuperata.

Campi
name

string

Identificatore. Il nome della promozione. Formato: accounts/{account}/promotions/{promotion}
promotion_id

string

Obbligatorio. L'utente ha fornito l'ID promozione per identificare in modo univoco la promozione. Rispetta i requisiti minimi per evitare la mancata approvazione delle promozioni.
content_language

string

Obbligatorio. Il codice lingua ISO 639-1 di due lettere per la promozione.

Le promozioni sono disponibili solo per alcune lingue selezionate.
target_country

string

Obbligatorio. Il paese di destinazione utilizzato come parte dell'identificatore univoco. Rappresentato come codice di territorio CLDR.

Le promozioni sono disponibili solo in alcuni paesi, Schede senza costi e annunci Shopping Annunci di inventario locale
redemption_channel[]

RedemptionChannel

Obbligatorio. Canale di utilizzo della promozione. È richiesto almeno un canale.
data_source

string

Solo output. L'origine dati principale della promozione.
attributes

Attributes

(Facoltativo) Un elenco di attributi della promozione.
custom_attributes[]

CustomAttribute

(Facoltativo) Un elenco di attributi personalizzati (forniti dal commerciante). Può essere utilizzato anche per inviare qualsiasi attributo della specifica dei dati nella sua forma generica (ad es. { "name": "size type", "value": "regular" }). Questo è utile per inviare attributi non esposti esplicitamente dall'API.
promotion_status

PromotionStatus

Solo output. Lo stato di una promozione, i problemi di convalida dei dati, ovvero le informazioni su una promozione calcolata in modo asincrono.
version_number

int64

(Facoltativo) Rappresenta la versione esistente (aggiornamento) della promozione, che può essere utilizzata per mantenere l'ordine corretto quando vengono eseguiti più aggiornamenti contemporaneamente.

Se impostato, l'inserimento viene impedito quando il numero di versione è inferiore al numero di versione corrente della promozione esistente. La reintegrazione (ad esempio l'aggiornamento della promozione dopo 30 giorni) può essere eseguita con l'attuale version_number.

Se l'operazione viene impedita, verrà lanciata l'eccezione di interruzione.

PromotionStatus

Lo stato della promozione.

Campi
destination_statuses[]

DestinationStatus

Solo output. Le destinazioni previste per la promozione.
item_level_issues[]

ItemLevelIssue

Solo output. Un elenco di problemi associati alla promozione.
creation_date

Timestamp

Solo output. Data di creazione della promozione nel formato ISO 8601: data, ora e offset, ad esempio 2020-01-02T09:00:00+01:00 o 2020-01-02T09:00:00Z
last_update_date

Timestamp

Solo output. Data dell'ultimo aggiornamento dello stato della promozione nel formato ISO 8601: data, ora e offset, ad esempio 2020-01-02T09:00:00+01:00 o 2020-01-02T09:00:00Z

DestinationStatus

Lo stato della destinazione specificata.

Campi
reporting_context

ReportingContextEnum

Solo output. Il nome della destinazione della promozione.
status

State

Solo output. Lo stato della destinazione specificata.

Stato

Lo stato attuale della promozione.

Enum
STATE_UNSPECIFIED Stato della promozione sconosciuto.
IN_REVIEW La promozione è in corso di revisione.
REJECTED La promozione non è approvata.
LIVE La promozione sia approvata e attiva.
STOPPED La promozione è stata interrotta dal commerciante.
EXPIRED La promozione non è più attiva.
PENDING La promozione non viene interrotta e tutte le revisioni sono state approvate, ma la data attiva è una data futura.

ItemLevelIssue

Il problema associato alla promozione.

Campi
code

string

Solo output. Il codice di errore del problema.
severity

Severity

Solo output. In che modo questo problema influisce sulla pubblicazione della promozione.
resolution

string

Solo output. Indica se il problema può essere risolto dal commerciante.
attribute

string

Solo output. Il nome dell'attributo, se il problema è causato da un singolo attributo.
reporting_context

ReportingContextEnum

Solo output. La destinazione a cui si applica il problema.
description

string

Solo output. Una breve descrizione del problema in inglese.
detail

string

Solo output. Una descrizione dettagliata del problema in inglese.
documentation

string

Solo output. L'URL di una pagina web che possa aiutarci a risolvere il problema.
applicable_countries[]

string

Solo output. Elenco dei codici paese (ISO 3166-1 alpha-2) in cui il problema si applica all'offerta.

Gravità

La gravità del problema.

Enum
SEVERITY_UNSPECIFIED Non specificato.
NOT_IMPACTED Questo problema rappresenta un avviso e non ha un impatto diretto sulla promozione.
DEMOTED La promozione viene retrocessa e molto probabilmente avrà un rendimento limitato nei risultati di ricerca
DISAPPROVED Il problema non approva la promozione.

RedemptionChannel

Canale di una promozione.

Enum
REDEMPTION_CHANNEL_UNSPECIFIED Indica che il canale non è specificato.
IN_STORE Indica che il canale è in negozio. È lo stesso canale local utilizzato per products.
ONLINE Indica che il canale è online.

StoreApplicability

Codici negozio o elenco di codici negozio a cui si applica la promozione. Solo per le promozioni degli annunci di inventario locale.

Enum
STORE_APPLICABILITY_UNSPECIFIED Non è noto a quali codici negozio si applica la promozione.
ALL_STORES La promozione si applica a tutti i negozi.
SPECIFIC_STORES La promozione si applica solo ai negozi specificati.