Method: properties.getMetadata

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

Ad esempio, se una metrica personalizzata con il nome 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/v1alpha/{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 del nome è specificato nel percorso dell'URL e non nei parametri URL. Property è un identificatore numerico della proprietà Google Analytics. Per saperne di più, consulta Dove trovare l'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 restituirà 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)
    }
  ],
  "conversions": [
    {
      object (ConversionMetadata)
    }
  ]
}
Campi
name

string

Nome della risorsa di questi metadati.
dimensions[]

object (DimensionMetadata)

Le descrizioni delle dimensioni.
metrics[]

object (MetricMetadata)

Le descrizioni delle metriche.
comparisons[]

object (ComparisonMetadata)

Le descrizioni del confronto.
conversions[]

object (ConversionMetadata)

Le descrizioni delle conversioni.

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,
  "category": string,
  "sections": [
    enum (Section)
  ]
}
Campi
apiName

string

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

string

Il nome di questa dimensione all'interno dell'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 tramite apiName o uno dei deprecatedApiNames per un periodo di tempo. Al termine del periodo di ritiro, la dimensione sarà disponibile solo tramite apiName.
customDefinition

boolean

True se la dimensione è personalizzata per questa proprietà. Ciò include le dimensioni personalizzate con ambito utente, evento e articolo. Per saperne di più sulle dimensioni personalizzate, consulta la pagina https://support.google.com/analytics/answer/14240153. Sono inclusi anche i gruppi di canali personalizzati. Per saperne di più, consulta https://support.google.com/analytics/answer/13051316.
category

string

Il nome visualizzato della categoria a cui appartiene questa dimensione. Dimensioni e metriche simili sono raggruppate.
sections[]

enum (Section)

Specifica le sezioni di Google Analytics a cui si applica questa dimensione.

MetricMetadata

Spiega una metrica.

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

string

Un nome di metrica. Utilizzabile in name della metrica. Ad esempio: eventCount.
uiName

string

Il nome di questa metrica all'interno dell'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 per apiName o per uno dei deprecatedApiNames per un periodo di tempo. Al termine del periodo di ritiro, la metrica sarà disponibile solo tramite apiName.
type

enum (MetricType)

Il tipo di metrica.
expression

string

L'espressione matematica per questa metrica derivata. Può essere utilizzato nel campo expression della 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à.
blockedReasons[]

enum (BlockedReason)

Se vengono specificati i motivi, il tuo accesso a questa metrica per questa proprietà viene bloccato. Le richieste API che invii a questa proprietà per questa metrica andranno a buon fine, ma il report conterrà solo zeri per questa metrica. Le richieste API con filtri metriche sulle metriche bloccate non andranno a buon fine. Se i motivi sono vuoti, hai accesso a questa metrica.

Per saperne di più, consulta Gestione delle restrizioni relative a dati e accessi.
category

string

Il nome visualizzato della categoria a cui appartiene questa metrica. Dimensioni e metriche simili sono raggruppate.
sections[]

enum (Section)

Specifica le sezioni di Google Analytics a cui si applica questa metrica.

BlockedReason

Motivazioni del blocco di questa metrica.

Enum
BLOCKED_REASON_UNSPECIFIED Non verrà mai specificato nella risposta dell'API.
NO_REVENUE_METRICS Se presente, il tuo accesso alle metriche relative alle entrate per questa proprietà è bloccato e questa metrica è correlata alle entrate.
NO_COST_METRICS Se presente, il tuo accesso alle metriche relative ai costi per questa proprietà è bloccato e questa metrica è correlata ai costi.

ComparisonMetadata

I metadati per un singolo confronto.

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

string

Il nome della risorsa di questo confronto. Utilizzabile nel campo comparison di 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.

ConversionMetadata

I metadati di una singola conversione.

Rappresentazione JSON 
{
  "conversionAction": string,
  "displayName": string
}
Campi
conversionAction

string

L'identificatore univoco dell'azione di conversione. Questo ID viene utilizzato per specificare le conversioni da includere in un report compilando il campo conversionActions in ConversionsSpec di una richiesta di report. Ad esempio, "conversionActions/1234".
displayName

string

Il nome di questa conversione nell'interfaccia utente di Google Analytics.