REST Resource: projects.locations.collections.dataStores.controls

Risorsa: Controllo

Definisce un comportamento condizionato da utilizzare durante la pubblicazione. Deve essere allegato a un ServingConfig per essere preso in considerazione al momento della pubblicazione. Azioni consentite a seconda di SolutionType.

Rappresentazione JSON 
{
  "name": string,
  "displayName": string,
  "associatedServingConfigIds": [
    string
  ],
  "solutionType": enum (SolutionType),
  "useCases": [
    enum (SearchUseCase)
  ],
  "conditions": [
    {
      object (Condition)
    }
  ],

  // Union field action can be only one of the following:
  "boostAction": {
    object (BoostAction)
  },
  "filterAction": {
    object (FilterAction)
  },
  "redirectAction": {
    object (RedirectAction)
  },
  "synonymsAction": {
    object (SynonymsAction)
  },
  "promoteAction": {
    object (PromoteAction)
  }
  // End of list of possible types for union field action.
}
Campi
name

string

Immutabile. Nome completo projects/*/locations/global/dataStore/*/controls/*
displayName

string

Obbligatorio. Nome leggibile. L'identificatore utilizzato nelle visualizzazioni dell'interfaccia utente.

Deve essere una stringa codificata in UTF-8. Il limite di lunghezza è di 128 caratteri. In caso contrario, viene generato un errore INVALID ARGUMENT.
associatedServingConfigIds[]

string

Solo output. Elenco di tutti gli ID ServingConfig a cui è collegato questo controllo. L'aggiornamento può richiedere fino a 10 minuti dopo le modifiche.
solutionType

enum (SolutionType)

Obbligatorio. Immutabile. A quale soluzione appartiene il controllo.

Deve essere compatibile con il verticale della risorsa. In caso contrario, viene generato un errore INVALID ARGUMENT.
useCases[]

enum (SearchUseCase)

Specifica il caso d'uso per il controllo. Influisce sui campi delle condizioni che possono essere impostati. Si applica solo a SOLUTION_TYPE_SEARCH. Attualmente è consentito un solo caso d'uso per controllo. Deve essere impostato quando solutionType è SolutionType.SOLUTION_TYPE_SEARCH.
conditions[]

object (Condition)

Determina quando verrà attivata l'azione associata.

Ometti per applicare sempre l'azione. Al momento è possibile specificare una sola condizione. In caso contrario, viene generato un errore INVALID ARGUMENT.

Campo unione action. Le azioni sono limitate in base al verticale e alla soluzione

Obbligatorio. action può essere solo uno dei seguenti:
boostAction

object (BoostAction)

Definisce un controllo di tipo boost
filterAction

object (FilterAction)

Definisce un controllo di tipo filtro. Attualmente non supportato da Consigli
redirectAction

object (RedirectAction)

Definisce un controllo di tipo reindirizzamento.
synonymsAction

object (SynonymsAction)

Considera un gruppo di termini come sinonimi.
promoteAction

object (PromoteAction)

Promuovi determinati link in base a query di attivazione predefinite.

BoostAction

Modifica l'ordine dei prodotti nell'elenco restituito.

Rappresentazione JSON 
{
  "boost": number,
  "filter": string,
  "dataStore": string,

  // Union field boost_spec can be only one of the following:
  "fixedBoost": number,
  "interpolationBoostSpec": {
    object (InterpolationBoostSpec)
  }
  // End of list of possible types for union field boost_spec.
}
Campi
boost
(deprecated)

number

L'intensità del boost, che deve essere compresa tra -1 e 1. Un boosting negativo indica una retrocessione. Il valore predefinito è 0.0 (nessuna operazione).
filter

string

Obbligatorio. Specifica a quali prodotti applicare il boost.

Se non viene fornito alcun filtro, tutti i prodotti verranno potenziati (nessuna operazione). Documentazione sulla sintassi: https://cloud.google.com/retail/docs/filter-and-order. La lunghezza massima è di 5000 caratteri. In caso contrario, viene generato un errore INVALID ARGUMENT.
dataStore

string

Obbligatorio. Specifica i documenti di quale datastore possono ottenere un boost con questo controllo. Nome completo del datastore, ad es. projects/123/locations/global/collections/default_collection/dataStores/default_data_store
Campo unione boost_spec. Specifiche per l'aumento del valore costante o per il ranking personalizzato basato sull'aumento. boost_spec può essere solo uno dei seguenti:
fixedBoost

number

Facoltativo. L'intensità del boost, che deve essere compresa tra -1 e 1. Un boosting negativo indica una retrocessione. Il valore predefinito è 0.0 (nessuna operazione).
interpolationBoostSpec

object (InterpolationBoostSpec)

Facoltativo. Specifica complessa per il ranking personalizzato in base al valore dell'attributo definito dal cliente.

InterpolationBoostSpec

Specifica per il ranking personalizzato basato sul valore dell'attributo specificato dal cliente. Offre più controlli per la classificazione personalizzata rispetto alla semplice combinazione (condizione, aumento) riportata sopra.

Rappresentazione JSON 
{
  "fieldName": string,
  "attributeType": enum (AttributeType),
  "interpolationType": enum (InterpolationType),
  "controlPoints": [
    {
      object (ControlPoint)
    }
  ]
}
Campi
fieldName

string

Facoltativo. Il nome del campo il cui valore verrà utilizzato per determinare l'importo dell'aggiustamento.
attributeType

enum (AttributeType)

Facoltativo. Il tipo di attributo da utilizzare per determinare l'importo del boost. Il valore dell'attributo può essere derivato dal valore del campo specificato in fieldName. Nel caso di valori numerici, è semplice, ad esempio attributeValue = numerical_field_value. Nel caso della freschezza, attributeValue = (time.now() - datetime_field_value).
interpolationType

enum (InterpolationType)

Facoltativo. Il tipo di interpolazione da applicare per collegare i punti di controllo elencati di seguito.
controlPoints[]

object (ControlPoint)

Facoltativo. I punti di controllo utilizzati per definire la curva. La funzione monotona (definita tramite interpolationType sopra) passa attraverso i punti di controllo elencati qui.

AttributeType

L'attributo(o la funzione) a cui deve essere applicato il ranking personalizzato.

Enum
ATTRIBUTE_TYPE_UNSPECIFIED Tipo di attributo non specificato.
NUMERICAL Il valore del campo numerico verrà utilizzato per aggiornare dinamicamente l'importo dell'incremento. In questo caso, attributeValue (il valore x) del punto di controllo sarà il valore effettivo del campo numerico per cui è specificato boostAmount.
FRESHNESS Per il caso d'uso della freschezza, il valore dell'attributo sarà la durata tra l'ora corrente e la data nel campo datetime specificato. Il valore deve essere formattato come valore XSD dayTimeDuration (un sottoinsieme limitato di un valore di durata ISO 8601). Il pattern è: [nD][T[nH][nM][nS]]. Ad esempio, 5D, 3DT12H30M, T24H.

InterpolationType

Il tipo di interpolazione da applicare. Il valore predefinito sarà lineare (lineare a tratti).

Enum
INTERPOLATION_TYPE_UNSPECIFIED Il tipo di interpolazione non è specificato. In questo caso, il valore predefinito è Lineare.
LINEAR Verrà applicata l'interpolazione lineare a tratti.

ControlPoint

I punti di controllo utilizzati per definire la curva. La curva definita tramite questi punti di controllo può essere solo crescente o decrescente in modo monotono(i valori costanti sono accettabili).

Rappresentazione JSON 
{
  "attributeValue": string,
  "boostAmount": number
}
Campi
attributeValue

string

Facoltativo. Può corrispondere a uno dei seguenti: 1. Il valore del campo numerico. 2. Specifica della durata per l'aggiornamento: il valore deve essere formattato come valore XSD dayTimeDuration (un sottoinsieme limitato di un valore di durata ISO 8601). Il pattern è: [nD][T[nH][nM][nS]].
boostAmount

number

Facoltativo. Il valore compreso tra -1 e 1 in base al quale aumentare il punteggio se attributeValue restituisce il valore specificato sopra.

FilterAction

Specifica quali prodotti possono essere inclusi nei risultati. Utilizza lo stesso filtro del boost.

Rappresentazione JSON 
{
  "filter": string,
  "dataStore": string
}
Campi
filter

string

Obbligatorio. Un filtro da applicare ai risultati della condizione di corrispondenza.

Documentazione sulla sintassi obbligatoria: https://cloud.google.com/retail/docs/filter-and-order. La lunghezza massima è di 5000 caratteri. In caso contrario, viene generato un errore INVALID ARGUMENT.
dataStore

string

Obbligatorio. Specifica i documenti di quale datastore possono essere filtrati con questo controllo. Nome completo del datastore, ad es. projects/123/locations/global/collections/default_collection/dataStores/default_data_store

RedirectAction

Reindirizza un acquirente all'URI fornito.

Rappresentazione JSON 
{
  "redirectUri": string
}
Campi
redirectUri

string

Obbligatorio. L'URI a cui verrà reindirizzato l'acquirente.

Obbligatorio. L'URI deve avere una lunghezza uguale o inferiore a 2000 caratteri. In caso contrario, viene generato un errore INVALID ARGUMENT.

SynonymsAction

Crea un insieme di termini che fungeranno da sinonimi l'uno dell'altro.

Esempio: "felice" verrà considerato anche come "contento", "contento" verrà considerato anche come "felice".

Rappresentazione JSON 
{
  "synonyms": [
    string
  ]
}
Campi
synonyms[]

string

Definisce un insieme di sinonimi. Può specificare fino a 100 sinonimi. Devi specificare almeno 2 sinonimi. In caso contrario, viene generato un errore INVALID ARGUMENT.

PromoteAction

Promuovere determinati link in base ad alcune query di attivazione.

Esempio: promuovi il link al negozio di scarpe quando cerchi la parola chiave shoe. Il link può trovarsi al di fuori del datastore associato.

Rappresentazione JSON 
{
  "dataStore": string,
  "searchLinkPromotion": {
    object (SearchLinkPromotion)
  }
}
Campi
dataStore

string

Obbligatorio. Datastore a cui è collegata questa promozione.

SearchLinkPromotion

Il proto della promozione include l'URI e altre informazioni utili per visualizzare la promozione.

Rappresentazione JSON 
{
  "title": string,
  "uri": string,
  "document": string,
  "imageUri": string,
  "description": string,
  "enabled": boolean
}
Campi
title

string

Obbligatorio. Il titolo della promozione. Lunghezza massima: 160 caratteri.
uri

string

Facoltativo. L'URL della pagina che l'utente vuole promuovere. Deve essere impostato per la ricerca sul sito. Per gli altri verticali, questo parametro è facoltativo.
document

string

Facoltativo. Il Document che l'utente vuole promuovere. Per la ricerca sul sito, lascia il campo vuoto e compila solo l'URI. Può essere impostato insieme all'URI.
imageUri

string

Facoltativo. L'URL dell'immagine in miniatura della promozione.
description

string

Facoltativo. La descrizione della promozione. Lunghezza massima: 200 caratteri.
enabled

boolean

Facoltativo. La promozione attivata verrà restituita per tutte le configurazioni di pubblicazione associate all'elemento principale del controllo a cui è allegata questa promozione.

Questo flag viene utilizzato solo per la ricerca di base su sito.

SearchUseCase

Definisce un'ulteriore suddivisione di SolutionType. Si applica in particolare a SOLUTION_TYPE_SEARCH.

Enum
SEARCH_USE_CASE_UNSPECIFIED Valore utilizzato quando non è impostato. Non si verificherà in CSS.
SEARCH_USE_CASE_BROWSE Sfoglia il caso d'uso. Prevede che il traffico abbia un query vuoto.

Condizione

Definisce le circostanze da verificare prima di consentire un comportamento

Rappresentazione JSON 
{
  "queryTerms": [
    {
      object (QueryTerm)
    }
  ],
  "activeTimeRange": [
    {
      object (TimeRange)
    }
  ],
  "queryRegex": string
}
Campi
queryTerms[]

object (QueryTerm)

Cerca solo un elenco di termini a cui abbinare la query. Non può essere impostato quando è impostato Condition.query_regex.

Massimo 10 termini di query.
activeTimeRange[]

object (TimeRange)

Intervallo o intervalli di tempo che specificano quando la condizione è attiva.

Massimo 10 intervalli di tempo.
queryRegex

string

Facoltativo. Espressione regolare della query per trovare la corrispondenza dell'intera query di ricerca. Non può essere impostato quando è impostato Condition.query_terms. Supportato solo per i controlli di pubblicazione della promozione della ricerca su sito di base.

QueryTerm

Matcher per la query della richiesta di ricerca

Rappresentazione JSON 
{
  "value": string,
  "fullMatch": boolean
}
Campi
value

string

Il valore della query specifico da confrontare

Deve essere in minuscolo e in formato UTF-8. Può contenere al massimo tre termini separati da spazi se fullMatch è true. Non può essere una stringa vuota. Lunghezza massima di 5000 caratteri.
fullMatch

boolean

Se la query di ricerca deve corrispondere esattamente al termine della query.

TimeRange

Utilizzato per le condizioni che dipendono dal tempo.

Rappresentazione JSON 
{
  "startTime": string,
  "endTime": string
}
Campi
startTime

string (Timestamp format)

Inizio dell'intervallo di tempo.

L'intervallo è inclusivo.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Fine dell'intervallo di tempo.

L'intervallo è inclusivo. Deve essere una data futura.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

Metodi

create

 Crea un controllo.

delete

 Elimina un controllo.

get

 Recupera un controllo.

list

 Elenca tutti i controlli in base al relativo DataStore principale.

patch

 Aggiorna un controllo.