REST Resource: properties.customMetrics

Risorsa: CustomMetrica

Una 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 della risorsa per questa risorsa CustomMetrica. Formato: proprietà/{property}/customMetrics/{customMetric}

parameterName

string

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

Se questa è una metrica basata sugli eventi, questo è il nome del parametro evento.

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

displayName

string

Obbligatorio. Il nome visualizzato per questa metrica personalizzata, come indicato nella UI di Analytics. Lunghezza massima di 82 caratteri, caratteri alfanumerici più spazi e trattini bassi che iniziano con una lettera. I nomi visualizzati generati dal sistema precedenti possono contenere parentesi quadre, ma gli aggiornamenti a questo campo non consentono mai le parentesi quadre.

description

string

(Facoltativo) Descrizione di questa dimensione personalizzata. La lunghezza massima di 150 caratteri.

measurementUnit

enum (MeasurementUnit)

Obbligatorio. Il tipo di valore della metrica personalizzata.

scope

enum (MetricScope)

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

restrictedMetricType[]

enum (RestrictedMetricType)

(Facoltativo) Tipi di dati soggetti a limitazioni che possono essere contenuti in questa metrica. Obbligatorio per le metriche con l'unità di misura CURRENCY. Il campo deve essere vuoto per le metriche con un'unità di misura diversa dalla valuta.

MeasurementUnit

Possibili tipi di rappresentazione del valore della metrica personalizzata.

La rappresentazione della valuta potrebbe cambiare in futuro, il che richiede una modifica dell'API che provoca un errore.

Enum
MEASUREMENT_UNIT_UNSPECIFIED MeasurementUnit non specificata o mancante.
STANDARD Questa metrica utilizza le unità predefinite.
CURRENCY Questa metrica misura una valuta.
FEET Questa metrica misura i piedi.
METERS Questa metrica misura i 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 che ha come ambito 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 Dati di costo nei report sulle metriche.
REVENUE_DATA La metrica riporta i dati sulle entrate.

Metodi

archive

Archivia una metrica personalizzata in una proprietà.

create

Crea una metrica personalizzata.

get

Cerca una singola CustomMetrica.

list

Elenca le metriche personalizzate in una proprietà.

patch

Aggiorna una metrica personalizzata su una proprietà.