REST Resource: properties.customMetrics

Risorsa: Metrica personalizzata

La definizione di una metrica personalizzata.

Rappresentazione JSON
{
  "name": string,
  "parameterName": string,
  "displayName": string,
  "description": string,
  "measurementUnit": enum (MeasurementUnit),
  "scope": enum (MetricScope),
  "restrictedMetricType": [
    enum (RestrictedMetricType)
  ]
}
Campi
name

string

Solo output. Nome per questa risorsa CustomMetric. Formato: proprietà/{property}/customMetrics/{customMetric}

parameterName

string

Obbligatoria. Immutabile. Nome del tagging per questa metrica personalizzata.

Se si tratta di una metrica basata sugli eventi, questo è il nome del parametro evento.

Può contenere solo caratteri alfanumerici e trattini bassi, che iniziano con una lettera. Lunghezza massima di 40 caratteri per le metriche basate sugli eventi.

displayName

string

Obbligatoria. Nome visualizzato per questa metrica personalizzata come mostrato nell'interfaccia utente di Analytics. Lunghezza massima di 82 caratteri, più spazi alfanumerici e trattini bassi che iniziano con una lettera. I nomi visualizzati precedenti generati dal sistema possono contenere parentesi quadre, ma gli aggiornamenti di questo campo non consentono mai l'utilizzo di parentesi quadre.

description

string

Campo facoltativo. Descrizione per questa dimensione personalizzata. La lunghezza massima è di 150 caratteri.

measurementUnit

enum (MeasurementUnit)

Obbligatoria. Il tipo di valore della metrica personalizzata.

scope

enum (MetricScope)

Obbligatoria. Immutabile. L'ambito di questa metrica personalizzata.

restrictedMetricType[]

enum (RestrictedMetricType)

Campo facoltativo. Tipi di dati soggetti a limitazioni che possono essere contenuti in questa metrica. Obbligatorio per le metriche con unità di misura CURRENCY. Deve essere vuoto per le metriche con un'unità di misurazione non CURRENCY.

MeasurementUnit

Possibili tipi di rappresentazione del valore della metrica personalizzata.

La rappresentazione della valuta potrebbe cambiare in futuro e richiedere una modifica dell'API che provoca un errore.

Enum
MEASUREMENT_UNIT_UNSPECIFIED MeasurementUnit non specificato o mancante.
STANDARD Questa metrica utilizza unità predefinite.
CURRENCY Questa metrica misura una valuta.
FEET Questa metrica misura i piedi.
METERS Questa metrica misura gli metri.
KILOMETERS Questa metrica misura i chilometri.
MILES Questa metrica misura le miglia.
MILLISECONDS Questa metrica misura i millisecondi.
SECONDS Questa metrica misura i secondi.
MINUTES Questa metrica misura i minuti.
HOURS Questa metrica misura le ore.

MetricScope

L'ambito di questa metrica.

Enum
METRIC_SCOPE_UNSPECIFIED Ambito sconosciuto o non specificato.
EVENT Metrica limitata a un evento.

RestrictedMetricType

Etichette che contrassegnano i dati di questa metrica personalizzata come dati che devono essere limitati a utenti specifici.

Enum
RESTRICTED_METRIC_TYPE_UNSPECIFIED Tipo sconosciuto o non specificato.
COST_DATA I dati di costo nei report sulle metriche.
REVENUE_DATA La metrica registra i dati sulle entrate.

Metodi

archive

Archivia una metrica personalizzata su una proprietà.

create

Crea una metrica personalizzata.

get

Cerca una singola metrica personalizzata.

list

Elenca le metriche personalizzate in una proprietà.

patch

Aggiorna una metrica personalizzata su una proprietà.