Method: properties.getMetadata

Restituisce i metadati per le dimensioni e le metriche disponibili nei metodi di report. Utilizzato per esplorare le dimensioni e le metriche. Con questo metodo, nella richiesta viene specificato un identificatore 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 il nome del parametro levels_unlocked è registrata in una proprietà, la risposta dei metadati conterrà customEvent:levels_unlocked. I metadati universali sono dimensioni e metriche applicabili a qualsiasi proprietà, ad esempio country e totalUsers.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
name

string

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

Esempio: proprietà/1234/metadata

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

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Le dimensioni, le metriche e i confronti attualmente accettati nei metodi di generazione dei report.

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

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

string

Nome risorsa di questi metadati.
dimensions[]

object (DimensionMetadata)

Le descrizioni delle dimensioni.
metrics[]

object (MetricMetadata)

Le descrizioni delle metriche.
comparisons[]

object (ComparisonMetadata)

Le descrizioni dei confronti.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

ComparisonMetadata

I metadati per un singolo confronto.

Rappresentazione JSON 
{
  "apiName": string,
  "uiName": string,
  "description": string
}
Campi
apiName

string

Nome della risorsa di questo confronto. Utilizzabile nel campo comparison del Confronto. Ad esempio, "comparisons/1234".
uiName

string

Il nome di questo confronto nell'interfaccia utente di Google Analytics.
description

string

La descrizione di questo confronto.