Method: properties.getMetadata

Restituisce i metadati per le dimensioni e le metriche disponibili nei metodi di generazione di report. Utilizzato per esplorare le dimensioni e le metriche. In questo metodo, nella richiesta viene specificato un identificatore di proprietà GA4 di Google Analytics e la risposta dei metadati include dimensioni e metriche personalizzate, nonché metadati universali.

Ad esempio, se una metrica personalizzata con nome parametro levels_unlocked è registrata in una proprietà, la risposta Metadati conterrà customEvent:levels_unlocked. I metadati universali sono dimensioni e metriche applicabili a qualsiasi proprietà, come country e totalUsers.

Richiesta HTTP

GET https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/metadata}

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
name

string

Obbligatoria. Il nome della risorsa dei metadati da recuperare. Questo campo del nome è specificato nel percorso dell'URL e non nei parametri dell'URL. La proprietà è un identificatore numerico di proprietà GA4 di Google Analytics. Per scoprire di più, scopri dove trovare il tuo ID proprietà.

Esempio: Properties/1234/metadata

Imposta l'ID proprietà su 0 per le dimensioni e le metriche comuni a tutte le proprietà. In questa modalità speciale, questo metodo non restituisce dimensioni e metriche personalizzate.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Le dimensioni e le metriche attualmente accettate nei metodi di generazione di report.

Rappresentazione JSON 
{
  "name": string,
  "dimensions": [
    {
      object (DimensionMetadata)
    }
  ],
  "metrics": [
    {
      object (MetricMetadata)
    }
  ]
}
Campi
name

string

Il nome della risorsa di questi metadati.
dimensions[]

object (DimensionMetadata)

Le descrizioni delle dimensioni.
metrics[]

object (MetricMetadata)

Le descrizioni delle metriche.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

DimensionMetadata

Spiega una dimensione.

Rappresentazione JSON 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "customDefinition": boolean
}
Campi
apiName

string

Il nome di questa dimensione. Utilizzabile in name di Dimensione. Ad esempio: eventName.
uiName

string

Il nome di questa dimensione nell'interfaccia utente di Google Analytics. Ad esempio, Event name.
description

string

Descrizione di come viene utilizzata e calcolata questa dimensione.
deprecatedApiNames[]

string

Nomi ancora utilizzabili, ma deprecati per questa dimensione. Se compilata, questa dimensione è disponibile da apiName o da uno di deprecatedApiNames per un determinato periodo di tempo. Dopo il periodo di deprecazione, la dimensione sarà disponibile solo entro il giorno apiName.
customDefinition

boolean

True se la dimensione è una dimensione personalizzata per questa proprietà.

MetricMetadata

Spiega una metrica.

Rappresentazione JSON 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "type": enum (MetricType),
  "expression": string,
  "customDefinition": boolean
}
Campi
apiName

string

Il nome di una metrica. Utilizzabile in name di Metrica. Ad esempio: eventCount.
uiName

string

Il nome di questa metrica nell'interfaccia utente di Google Analytics. Ad esempio, Event count.
description

string

Descrizione di come viene utilizzata e calcolata questa metrica.
deprecatedApiNames[]

string

Nomi ancora utilizzabili, ma deprecati per questa metrica. Se compilata, questa metrica è disponibile da apiName o da uno di deprecatedApiNames per un periodo di tempo. Dopo il periodo di deprecazione, la metrica sarà disponibile solo entro il giorno apiName.
type

enum (MetricType)

Il tipo di questa metrica.
expression

string

L'espressione matematica per questa metrica derivata. Può essere utilizzato nel campo expression di Metrica per report equivalenti. La maggior parte delle metriche non sono espressioni e, per le non espressioni, questo campo è vuoto.
customDefinition

boolean

True se la metrica è una metrica personalizzata per questa proprietà.