REST Resource: customers.analysisQueries

Ressource: AnalysisQuery

Définit une requête d'analyse pouvant être exécutée dans Ads Data Hub.

Représentation JSON 
{
  "name": string,
  "title": string,
  "queryText": string,
  "parameterTypes": {
    string: {
      object (ParameterType)
    },
    ...
  },
  "mergeSpec": {
    object (MergeSpec)
  },
  "queryState": enum (QueryState),
  "updateTime": string,
  "updateEmail": string,
  "createTime": string,
  "createEmail": string,
  "queryShare": [
    {
      object (QueryShare)
    }
  ],

  // Union field filtered_row can be only one of the following:
  "filteredRowSummary": {
    object (FilteredRowSummary)
  },
  "generateFilteredRowSummaryAutomatically": boolean
  // End of list of possible types for union field filtered_row.
}
Champs
name

string

Nom qui identifie une requête de manière unique. Cet ID est au format suivant : customers/[customerId]/analysisqueries/[resource_id]. Exemple : 'customers/123/analysisqueries/abcd1234'. L'ID de ressource est généré par le serveur.
title

string

Titre de la requête, qui est unique au sein d'un même client Ads Data Hub et d'un seul type de requête.
queryText

string

Texte de la requête écrit en SQL standard. Consultez la page https://cloud.google.com/bigquery/docs/reference/standard-sql/.
parameterTypes

map (key: string, value: object (ParameterType))

Tous les paramètres supplémentaires attendus par la requête. Mappe chaque nom d'argument sur son type.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
mergeSpec
(deprecated)

object (MergeSpec)

Instructions pour fusionner des lignes Si elles sont présentes, toutes les lignes qui auraient été ignorées pour des raisons de confidentialité seront combinées en une seule ligne fusionnée. La ligne fusionnée apparaîtra dans la sortie finale si elle respecte les exigences de confidentialité.
queryState

enum (QueryState)

État de la requête.
updateTime

string (Timestamp format)

Heure de la dernière mise à jour de la requête.

Horodatage au format RFC3339 UTC "Zulu" avec une résolution de nanoseconde et jusqu'à neuf chiffres après la virgule. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
updateEmail

string

Adresse e-mail de l'utilisateur qui a actualisé la requête pour la dernière fois.
createTime

string (Timestamp format)

Heure de création de la requête.

Horodatage au format RFC3339 UTC "Zulu" avec une résolution de nanoseconde et jusqu'à neuf chiffres après la virgule. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
createEmail

string

Adresse e-mail de l'utilisateur ayant créé la requête.
queryShare[]

object (QueryShare)

Indique comment une requête peut être partagée au-delà du client Ads Data Hub.
Champ d'union filtered_row. Instructions pour fusionner des lignes filtered_row ne peut être qu'un des éléments suivants :
filteredRowSummary

object (FilteredRowSummary)

Définissez comment combiner des lignes ignorées pour des raisons de confidentialité en une seule ligne fusionnée. La ligne fusionnée sera incluse dans le résultat final si elle respecte les exigences de confidentialité.
generateFilteredRowSummaryAutomatically

boolean

Si la valeur est "true", un résumé de ligne filtré est généré automatiquement.

MergeSpec

Instructions de fusion pour un schéma de résultats de requête d'analyse.

Représentation JSON 
{
  "columns": {
    string: {
      object (MergeColumn)
    },
    ...
  }
}
Champs
columns

map (key: string, value: object (MergeColumn))

Instructions pour fusionner chaque colonne, associées à un nom Toute colonne manquante sera traitée comme une valeur de type Merge_TYPE_UNSPECIFIED.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Colonne de fusion

Instructions de fusion pour une seule colonne de sortie.

Représentation JSON 
{
  "type": enum (MergeType),
  "value": {
    object (ParameterValue)
  }
}
Champs
type

enum (MergeType)

Méthode utilisée pour combiner les valeurs de la colonne.
value

object (ParameterValue)

Valeur constante à utiliser (uniquement pour le type de fusion CONSTANT).

Type de fusion

Toutes les opérations acceptées pour la fusion de colonnes

Enums
MERGE_TYPE_UNSPECIFIED Type de fusion non spécifié. La valeur de la colonne fusionnée sera NULL.
CONSTANT Remplacez la valeur de la colonne fusionnée par la constante donnée.
SUM Prenez la somme des valeurs de la colonne fusionnée.

Récapitulatif des lignes filtrées

Instructions de fusion pour un schéma de résultats de requête d'analyse.

Représentation JSON 
{
  "columns": {
    string: {
      object (ColumnSummaryRule)
    },
    ...
  }
}
Champs
columns

map (key: string, value: object (ColumnSummaryRule))

Instructions pour fusionner chaque colonne, associées à un nom Toute colonne manquante sera traitée comme SUMMARY_TYPE_UNSPECIFIED.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

ColumnSummaryRule

Instructions de fusion pour une seule colonne de sortie.

Représentation JSON 
{
  "type": enum (SummaryType),
  "value": {
    object (ParameterValue)
  }
}
Champs
type

enum (SummaryType)

Méthode utilisée pour combiner les valeurs de la colonne.
value

object (ParameterValue)

Valeur constante à utiliser (uniquement pour le type de résumé CONSTANT).

Type de récapitulatif

Toutes les opérations acceptées pour la fusion de colonnes

Enums
SUMMARY_TYPE_UNSPECIFIED Type de récapitulatif non spécifié. La valeur de la colonne récapitulative sera nulle.
CONSTANT Remplacez la valeur de la colonne fusionnée par la constante donnée.
SUM Prenez la somme des valeurs de la colonne fusionnée.

Méthodes

create

 Crée une requête d'analyse pour une exécution ultérieure.

delete

 Supprime une requête d'analyse.

get

 Récupère la requête d'analyse demandée.

list

 Répertorie les requêtes d'analyse appartenant au client spécifié.

patch

 Met à jour une requête d'analyse existante.

start

 Démarre l'exécution d'une requête d'analyse stockée.

startTransient

 Démarre l'exécution d'une requête d'analyse temporaire.

validate

 Effectue des contrôles de validation statique sur la requête d'analyse fournie.