- Risorsa: ReportTask
- ReportDefinition
- Dimensione
- DimensionExpression
- CaseExpression
- ConcatenateExpression
- Metrica
- DateRange
- FilterExpression
- FilterExpressionList
- Filtro
- StringFilter
- MatchType
- InListFilter
- NumericFilter
- Operazione
- NumericValue
- BetweenFilter
- MetricAggregation
- OrderBy
- MetricOrderBy
- DimensionOrderBy
- OrderType
- CohortSpec
- Coorte
- CohortsRange
- Granularità
- CohortReportSettings
- ReportMetadata
- Stato
- Metodi
Risorsa: ReportTask
Una configurazione di attività di report specifica.
Rappresentazione JSON |
---|
{ "name": string, "reportDefinition": { object ( |
Campi | |
---|---|
name |
Solo output. Identificatore. Il nome della risorsa dell'attività di report assegnato durante la creazione. Formato: "properties/{property}/reportTasks/{reportTask}" |
reportDefinition |
(Facoltativo) Una definizione di report per recuperare i dati del report, che descrive la struttura di un report. In genere, include i campi che verranno inclusi nel report e i criteri che verranno utilizzati per filtrare i dati. |
reportMetadata |
Solo output. I metadati del report per una specifica attività di report, che forniscono informazioni su un report. In genere include le seguenti informazioni: nome risorsa del report, stato del report, timestamp in cui è stato creato il report e così via. |
ReportDefinition
La definizione di come deve essere eseguito un report.
Rappresentazione JSON |
---|
{ "dimensions": [ { object ( |
Campi | |
---|---|
dimensions[] |
(Facoltativo) Le dimensioni richieste e visualizzate. |
metrics[] |
(Facoltativo) Le metriche richieste e visualizzate. |
dateRanges[] |
(Facoltativo) Intervalli di date dei dati da leggere. Se sono richiesti più intervalli di date, ogni riga di risposta conterrà un indice di intervallo di date basato su zero. Se due intervalli di date si sovrappongono, i dati sugli eventi per i giorni che si sovrappongono vengono inclusi nelle righe di risposta per entrambi gli intervalli di date. In una richiesta di coorte, questo |
dimensionFilter |
(Facoltativo) I filtri delle dimensioni ti consentono di richiedere solo valori di dimensione specifici nel report. Per ulteriori informazioni, consulta la sezione Concetti fondamentali dei filtri delle dimensioni per alcuni esempi. Le metriche non possono essere utilizzate in questo filtro. |
metricFilter |
(Facoltativo) La clausola di filtro delle metriche. Applicato dopo aver aggregato le righe del report, in modo simile alla clausola SQL. Le dimensioni non possono essere utilizzate in questo filtro. |
offset |
(Facoltativo) Il conteggio delle righe della riga iniziale dello spazio di archiviazione di Google Analytics. La prima riga viene conteggiata come riga 0. Quando crei un'attività per il report, i parametri |
limit |
(Facoltativo) Il numero di righe da restituire nel report. Se non vengono specificate, vengono restituite 10.000 righe. L'API restituisce un massimo di 250.000 righe per richiesta, indipendentemente da quante sono le richieste. L'API può anche restituire meno righe rispetto al valore |
metricAggregations[] |
(Facoltativo) Aggregazione delle metriche. I valori aggregati delle metriche verranno mostrati nelle righe in cui i valori di dimensionValue sono impostati su "RESERVED_(MetricAggregation)". |
orderBys[] |
(Facoltativo) Specifica l'ordine delle righe nella risposta. |
currencyCode |
(Facoltativo) Un codice valuta in formato ISO4217, ad esempio "AED", "USD", "JPY". Se il campo è vuoto, il report utilizza la valuta predefinita della proprietà. |
cohortSpec |
(Facoltativo) Gruppo di coorti associato a questa richiesta. Se nella richiesta è presente un gruppo di coorte, la "coorte" deve essere presente. |
keepEmptyRows |
(Facoltativo) Se il valore è false o non specificato, non verrà restituita ogni riga con tutte le metriche uguali a 0. Se impostato su true, queste righe vengono restituite se non vengono rimosse separatamente da un filtro. Indipendentemente da questa impostazione di Ad esempio, se una proprietà non registra mai un evento |
Dimensione
Le dimensioni sono attributi dei dati. Ad esempio, la dimensione Città indica la città in cui ha origine un evento. I valori delle dimensioni nelle risposte ai report sono stringhe, ad esempio, la città potrebbe essere "Parigi" o "New York".
Rappresentazione JSON |
---|
{
"name": string,
"dimensionExpression": {
object ( |
Campi | |
---|---|
name |
Il nome della dimensione. Consulta la pagina Dimensioni API per l'elenco dei nomi delle dimensioni supportati dai principali metodi di generazione dei report, come Se
|
dimensionExpression |
Una dimensione può essere il risultato di un'espressione di più dimensioni. Ad esempio, la dimensione "paese, città": concatenate(paese, ", ", città). |
DimensionExpression
Utilizzato per esprimere una dimensione risultante da una formula composta da più dimensioni. Esempi di utilizzo: 1) minuscolo(dimensione) 2) concatenato(dimensione1, simbolo, dimensione2).
Rappresentazione JSON |
---|
{ // Union field |
Campi | |
---|---|
Campo unione one_expression . Specifica un tipo di espressione di dimensione per DimensionExpression . one_expression può essere solo uno dei seguenti: |
|
lowerCase |
Utilizzato per convertire un valore di dimensione in minuscolo. |
upperCase |
Utilizzato per convertire un valore di dimensione in lettere maiuscole. |
concatenate |
Utilizzato per combinare i valori delle dimensioni in una singola dimensione. Ad esempio, la dimensione "paese, città": concatenate(paese, ", ", città). |
CaseExpression
Utilizzato per convertire un valore di dimensione in un caso singolo.
Rappresentazione JSON |
---|
{ "dimensionName": string } |
Campi | |
---|---|
dimensionName |
Nome di una dimensione. Il nome deve fare riferimento a un nome nel campo delle dimensioni della richiesta. |
ConcatenateExpression
Utilizzato per combinare i valori delle dimensioni in una singola dimensione.
Rappresentazione JSON |
---|
{ "dimensionNames": [ string ], "delimiter": string } |
Campi | |
---|---|
dimensionNames[] |
Nomi delle dimensioni. I nomi devono fare riferimento ai nomi nel campo delle dimensioni della richiesta. |
delimiter |
Il delimitatore posizionato tra i nomi delle dimensioni. I delimitatori sono spesso caratteri singoli, come "|" o "," ma possono essere stringhe più lunghe. Se il valore di una dimensione contiene il delimitatore, entrambi saranno presenti in risposta senza alcuna distinzione. Ad esempio,se il valore della dimensione 1 = "US,FR", il valore della dimensione 2 = "JP" e il delimitatore = ",", la risposta conterrà "US,FR,JP". |
Metrica
Le misurazioni quantitative di un report. Ad esempio, la metrica eventCount
è il numero totale di eventi. Per le richieste sono consentite fino a 10 metriche.
Rappresentazione JSON |
---|
{ "name": string, "expression": string, "invisible": boolean } |
Campi | |
---|---|
name |
Il nome della metrica. Consulta Metriche API per un elenco dei nomi delle metriche supportati dai principali metodi di generazione dei report, come Se Le metriche fanno riferimento da |
expression |
Un'espressione matematica per le metriche derivate. Ad esempio, la metrica Conteggio eventi per utente è |
invisible |
Indica se una metrica è invisibile nella risposta del report. Se una metrica non è visibile, non genera una colonna nella risposta, ma può essere utilizzata in |
DateRange
Un insieme contiguo di giorni: startDate
, startDate + 1
, ..., endDate
. Per le richieste sono consentiti fino a quattro intervalli di date.
Rappresentazione JSON |
---|
{ "startDate": string, "endDate": string, "name": string } |
Campi | |
---|---|
startDate |
La data di inizio inclusa per la query nel formato |
endDate |
La data di fine inclusa per la query nel formato |
name |
Assegna un nome a questo intervallo di date. Questo nome viene assegnato alla dimensione |
FilterExpression
Per esprimere i filtri di dimensioni o metriche. I campi nella stessa espressione di filtro devono essere relativi a tutte le dimensioni o a tutte le metriche.
Rappresentazione JSON |
---|
{ // Union field |
Campi | |
---|---|
Campo unione expr . Specifica un tipo di espressione di filtro per FilterExpression . expr può essere solo uno dei seguenti: |
|
andGroup |
Le espressioni filtro in andGroup hanno una relazione AND. |
orGroup |
Le espressioni filtro in orGroup hanno una relazione OR. |
notExpression |
Filtro Expression NON è di notExpression. |
filter |
Un filtro primitivo. Nella stessa espressione di filtro, tutti i nomi dei campi del filtro devono essere relativi a tutte le dimensioni o a tutte le metriche. |
FilterExpressionList
Un elenco di espressioni di filtro.
Rappresentazione JSON |
---|
{
"expressions": [
{
object ( |
Campi | |
---|---|
expressions[] |
Un elenco di espressioni di filtro. |
Filtro
Un'espressione per filtrare i valori di dimensioni o metriche.
Rappresentazione JSON |
---|
{ "fieldName": string, // Union field |
Campi | |
---|---|
fieldName |
Il nome della dimensione o della metrica. Deve essere un nome definito nelle dimensioni o nelle metriche. |
Campo unione one_filter . Specifica un tipo di filtro per Filter . one_filter può essere solo uno dei seguenti: |
|
stringFilter |
Filtro correlato alle stringhe. |
inListFilter |
Un filtro per i valori nell'elenco. |
numericFilter |
Un filtro per i valori numerici o relativi alle date. |
betweenFilter |
Un filtro per tra due valori. |
StringFilter
Il filtro per la stringa
Rappresentazione JSON |
---|
{
"matchType": enum ( |
Campi | |
---|---|
matchType |
Il tipo di corrispondenza per questo filtro. |
value |
Il valore della stringa utilizzato per la corrispondenza. |
caseSensitive |
Se true, il valore della stringa è sensibile alle maiuscole. |
MatchType
Il tipo di corrispondenza di un filtro stringa
Enum | |
---|---|
MATCH_TYPE_UNSPECIFIED |
Non specificato |
EXACT |
Corrispondenza esatta del valore della stringa. |
BEGINS_WITH |
Inizia con il valore della stringa. |
ENDS_WITH |
Termina con il valore della stringa. |
CONTAINS |
Contiene il valore della stringa. |
FULL_REGEXP |
Corrispondenza completa dell'espressione regolare con il valore della stringa. |
PARTIAL_REGEXP |
Corrispondenza parziale dell'espressione regolare con il valore della stringa. |
InListFilter
Il risultato deve essere in un elenco di valori stringa.
Rappresentazione JSON |
---|
{ "values": [ string ], "caseSensitive": boolean } |
Campi | |
---|---|
values[] |
L'elenco di valori stringa. Il campo non può essere vuoto. |
caseSensitive |
Se true, il valore della stringa è sensibile alle maiuscole. |
NumericFilter
Filtri per valori numerici o relativi alle date.
Rappresentazione JSON |
---|
{ "operation": enum ( |
Campi | |
---|---|
operation |
Il tipo di operazione per questo filtro. |
value |
Un valore numerico o un valore di data. |
Operazione
L'operazione applicata a un filtro numerico
Enum | |
---|---|
OPERATION_UNSPECIFIED |
Non specificato. |
EQUAL |
Uguale |
LESS_THAN |
Minore di |
LESS_THAN_OR_EQUAL |
Minore o uguale |
GREATER_THAN |
Maggiore di |
GREATER_THAN_OR_EQUAL |
Maggiore o uguale a |
NumericValue
Per rappresentare un numero.
Rappresentazione JSON |
---|
{ // Union field |
Campi | |
---|---|
Campo unione one_value . Uno dei valori numerici one_value può essere solo uno dei seguenti: |
|
int64Value |
Valore Integer |
doubleValue |
Valore doppio |
BetweenFilter
Per esprimere che il risultato deve essere compreso tra due numeri (inclusi).
Rappresentazione JSON |
---|
{ "fromValue": { object ( |
Campi | |
---|---|
fromValue |
Inizia con questo numero. |
toValue |
Termina con questo numero. |
MetricAggregation
Rappresenta l'aggregazione delle metriche.
Enum | |
---|---|
METRIC_AGGREGATION_UNSPECIFIED |
Operatore non specificato. |
TOTAL |
con l'operatore SUM. |
MINIMUM |
Operatore minimo. |
MAXIMUM |
Operatore massimo. |
COUNT |
Operatore di conteggio. |
OrderBy
L'ordinamento per definire il modo in cui le righe verranno ordinate nella risposta. Ad esempio, ordinare le righe in base al conteggio degli eventi in ordine decrescente è un ordine, mentre ordinare le righe in base alla stringa del nome dell'evento è diverso.
Rappresentazione JSON |
---|
{ "desc": boolean, // Union field |
Campi | |
---|---|
desc |
Se true, ordina i dati in ordine decrescente. |
Campo unione one_order_by . Specifica un tipo di ordine in base a per OrderBy . one_order_by può essere solo uno dei seguenti: |
|
metric |
Ordina i risultati in base ai valori di una metrica. |
dimension |
Ordina i risultati in base ai valori di una dimensione. |
MetricOrderBy
Ordina in base ai valori delle metriche.
Rappresentazione JSON |
---|
{ "metricName": string } |
Campi | |
---|---|
metricName |
Il nome di una metrica nella richiesta in base a cui ordinare. |
DimensionOrderBy
Ordina in base ai valori delle dimensioni.
Rappresentazione JSON |
---|
{
"dimensionName": string,
"orderType": enum ( |
Campi | |
---|---|
dimensionName |
Un nome di dimensione nella richiesta in base a cui ordinare. |
orderType |
Controlla la regola per l'ordinamento dei valori delle dimensioni. |
OrderType
Regola per ordinare i valori delle dimensioni stringa.
Enum | |
---|---|
ORDER_TYPE_UNSPECIFIED |
Non specificato. |
ALPHANUMERIC |
Ordinamento alfanumerico per punto di codice Unicode. Ad esempio, "2". < "A" < "X" < "b" < "z". |
CASE_INSENSITIVE_ALPHANUMERIC |
Ordinamento alfanumerico senza distinzione tra maiuscole e minuscole per punto di codice Unicode minuscolo. Ad esempio, "2". < "A" < "b" < "X" < "z". |
NUMERIC |
I valori delle dimensioni vengono convertiti in numeri prima dell'ordinamento. Ad esempio, nell'ordinamento NUMERIC, "25" < "100" e in ALPHANUMERIC tipo "100" < "25". I valori delle dimensioni non numeriche hanno tutti lo stesso valore di ordinamento al di sotto di tutti i valori numerici. |
CohortSpec
Specificare le coorti per un report sulle coorti.
I report sulle coorti creano una serie temporale di fidelizzazione degli utenti per la coorte. Ad esempio, potresti selezionare la coorte di utenti acquisiti nella prima settimana di settembre e seguirla per le sei settimane successive. La selezione degli utenti acquisiti nella coorte della prima settimana di settembre viene specificata nell'oggetto cohort
. La seguente coorte per le sei settimane successive viene specificata nell'oggetto cohortsRange
.
Per alcuni esempi, consulta la sezione Esempi di report di coorte.
La risposta al report potrebbe mostrare una serie temporale settimanale in cui l'app ha conservato il 60% di questa coorte dopo tre settimane e il 25% di questa coorte dopo sei settimane. Queste due percentuali possono essere calcolate dalla metrica cohortActiveUsers/cohortTotalUsers
e saranno righe separate nel report.
Rappresentazione JSON |
---|
{ "cohorts": [ { object ( |
Campi | |
---|---|
cohorts[] |
Definisce i criteri di selezione per raggruppare gli utenti in coorti. La maggior parte dei report sulle coorti definisce una sola coorte. Se vengono specificate più coorti, ciascuna può essere riconosciuta nel report con il proprio nome. |
cohortsRange |
I report sulle coorti seguono le coorti per un intervallo di date del report esteso. Questo intervallo specifica una durata dell'offset da seguire per le coorti. |
cohortReportSettings |
Impostazioni facoltative per un report sulle coorti. |
Coorte
Definisce un criterio di selezione della coorte. Una coorte è un gruppo di utenti con una caratteristica comune. Ad esempio, gli utenti con lo stesso firstSessionDate
appartengono alla stessa coorte.
Rappresentazione JSON |
---|
{
"name": string,
"dimension": string,
"dateRange": {
object ( |
Campi | |
---|---|
name |
Assegna un nome a questa coorte. Questo nome viene assegnato alla dimensione |
dimension |
Dimensione utilizzata dalla coorte. Obbligatorio e supporta solo |
dateRange |
La coorte seleziona gli utenti la cui data del primo contatto è compresa tra la data di inizio e quella di fine definite in In una richiesta di coorte, questo valore Questo |
CohortsRange
Consente di configurare l'intervallo di date del report esteso per un report sulle coorti. Specifica una durata di offset per seguire le coorti.
Rappresentazione JSON |
---|
{
"granularity": enum ( |
Campi | |
---|---|
granularity |
Obbligatorio. La granularità utilizzata per interpretare i valori |
startOffset |
Se Se Se |
endOffset |
Obbligatorio. Se Se Se |
Granularità
La granularità utilizzata per interpretare i valori startOffset
e endOffset
per l'intervallo di date del report esteso per un report sulle coorti.
Enum | |
---|---|
GRANULARITY_UNSPECIFIED |
Non deve mai essere specificato. |
DAILY |
Livello di granularità giornaliera. Comunemente utilizzato se il valore dateRange della coorte è un solo giorno e la richiesta contiene cohortNthDay . |
WEEKLY |
Livello di granularità settimanale. Comunemente utilizzato se il valore dateRange della coorte ha una durata di una settimana (da domenica a sabato) e la richiesta contiene cohortNthWeek . |
MONTHLY |
Livello di granularità mensile. Di uso comune se l'attributo dateRange della coorte ha una durata di un mese e la richiesta contiene cohortNthMonth . |
CohortReportSettings
Impostazioni facoltative di un report sulle coorti.
Rappresentazione JSON |
---|
{ "accumulate": boolean } |
Campi | |
---|---|
accumulate |
Se impostato su true, accumula il risultato dal giorno del primo contatto al giorno di fine. Non supportata nel seguente paese: |
ReportMetadata
I metadati del report per una specifica attività di report.
Rappresentazione JSON |
---|
{
"creationQuotaTokensCharged": integer,
"state": enum ( |
Campi | |
---|---|
creationQuotaTokensCharged |
Solo output. I token di quota totali addebitati durante la creazione del report. Poiché questo conteggio dei token si basa sull'attività nello stato |
state |
Solo output. Stato attuale di questa attività di report. |
beginCreatingTime |
Solo output. L'ora in cui è stato chiamato Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: |
taskRowCount |
Solo output. Il numero totale di righe nel risultato del report. Questo campo verrà compilato quando lo stato sarà attivo. Puoi utilizzare |
errorMessage |
Solo output. Il messaggio di errore viene compilato se un'attività di report non riesce durante la creazione. |
totalRowCount |
Solo output. Il numero totale di righe nello spazio di archiviazione di Google Analytics. Se vuoi eseguire query su righe di dati aggiuntive oltre a quelle del report corrente, è possibile avviare una nuova attività relativa al report in base all'
Ad esempio, supponiamo che il valore |
Stato
Lo stato di elaborazione.
Enum | |
---|---|
STATE_UNSPECIFIED |
Non verrà mai utilizzato lo stato non specificato. |
CREATING |
Il report è attualmente in fase di creazione e sarà disponibile in futuro. La creazione avviene immediatamente dopo la chiamata CreateReport. |
ACTIVE |
Il report è stato creato completamente ed è pronto per l'esecuzione di query. |
FAILED |
Impossibile creare il report. |
Metodi |
|
---|---|
|
Avvia la creazione di un'attività di report. |
|
Consente di recuperare i metadati del report su una specifica attività di report. |
|
Elenca tutte le attività di report per una proprietà. |
|
Recupera i contenuti di un'attività di report. |