Method: properties.checkCompatibility

Questo metodo di compatibilità elenca le dimensioni e le metriche che possono essere aggiunte a una richiesta di report e mantenere la compatibilità. Questo metodo non va a buon fine se le dimensioni e le metriche della richiesta non sono compatibili.

In Google Analytics, i report non vengono generati se richiedono dimensioni e/o metriche incompatibili. In questo caso, dovrai rimuovere le dimensioni e/o le metriche dal report incompatibile finché non sarà compatibile.

I report in tempo reale e principali hanno regole di compatibilità diverse. Questo metodo verifica la compatibilità per i report di base.

Richiesta HTTP

POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:checkCompatibility

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
property

string

Un identificatore della proprietà Google Analytics di cui vengono monitorati gli eventi. Per saperne di più, consulta Dove trovare l'ID proprietà. property deve avere lo stesso valore della richiesta runReport.

Esempio: properties/1234

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "compatibilityFilter": enum (Compatibility)
}
Campi
dimensions[]

object (Dimension)

Le dimensioni in questo report. dimensions deve avere lo stesso valore della richiesta runReport.
metrics[]

object (Metric)

Le metriche in questo report. metrics deve avere lo stesso valore della richiesta runReport.
dimensionFilter

object (FilterExpression)

La clausola di filtro delle dimensioni. dimensionFilter deve avere lo stesso valore della richiesta runReport.
metricFilter

object (FilterExpression)

La clausola di filtro delle metriche. metricFilter deve avere lo stesso valore della richiesta runReport
compatibilityFilter

enum (Compatibility)

Filtra le dimensioni e le metriche nella risposta in base a questa compatibilità. Utilizzato di uso comune come ”compatibilityFilter”: “COMPATIBLE” per restituire solo dimensioni e metriche compatibili.

Corpo della risposta

La risposta di compatibilità con la compatibilità di ogni dimensione e metrica.

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

Rappresentazione JSON 
{
  "dimensionCompatibilities": [
    {
      object (DimensionCompatibility)
    }
  ],
  "metricCompatibilities": [
    {
      object (MetricCompatibility)
    }
  ]
}
Campi
dimensionCompatibilities[]

object (DimensionCompatibility)

La compatibilità di ogni dimensione.
metricCompatibilities[]

object (MetricCompatibility)

La compatibilità di ogni metrica.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Compatibilità

I tipi di compatibilità per una singola dimensione o metrica.

Enum
COMPATIBILITY_UNSPECIFIED Compatibilità non specificata.
COMPATIBLE La dimensione o la metrica è compatibile. Questa dimensione o metrica può essere aggiunta correttamente a un report.
INCOMPATIBLE La dimensione o la metrica non è compatibile. Questa dimensione o metrica non può essere aggiunta correttamente a un report.

DimensionCompatibility

La compatibilità per una singola dimensione.

Rappresentazione JSON 
{
  "dimensionMetadata": {
    object (DimensionMetadata)
  },
  "compatibility": enum (Compatibility)
}
Campi
dimensionMetadata

object (DimensionMetadata)

I metadati della dimensione contengono il nome API per queste informazioni sulla compatibilità. I metadati della dimensione contengono anche altre informazioni utili, come il nome e la descrizione dell'interfaccia utente.
compatibility

enum (Compatibility)

La compatibilità di questa dimensione. Se la compatibilità è COMPATIBILE, questa dimensione può essere aggiunta correttamente al report.

MetricCompatibility

La compatibilità per una singola metrica.

Rappresentazione JSON 
{
  "metricMetadata": {
    object (MetricMetadata)
  },
  "compatibility": enum (Compatibility)
}
Campi
metricMetadata

object (MetricMetadata)

I metadati della metrica contengono il nome dell'API per queste informazioni sulla compatibilità. I metadati della metrica contengono anche altre informazioni utili, come il nome e la descrizione dell'interfaccia utente.
compatibility

enum (Compatibility)

La compatibilità di questa metrica. Se la compatibilità è COMPATIBILE, questa metrica può essere aggiunta correttamente al report.