REST Resource: customers.analysisQueries

Ressource: AnalysisQuery

Hier wird eine Analyseabfrage definiert, die in Ads Data Hub ausgeführt werden kann.

JSON-Darstellung
{
  "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.
}
Felder
name

string

Name, der eine Abfrage eindeutig identifiziert. Sie hat das Format „customers/[customerId]/analysisAbfragen/[resource_id]“, z.B. 'customers/123/analysisQuery/abcd1234'. Die Ressourcen-ID wird vom Server generiert.

title

string

Abfragetitel, der innerhalb eines einzelnen Ads Data Hub-Kunden und eines Abfragetyps eindeutig ist.

queryText

string

Abfragetext, der in Standard-SQL geschrieben wurde Siehe https://cloud.google.com/bigquery/docs/reference/standard-sql/.

parameterTypes

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

Alle zusätzlichen Parameter, die von der Abfrage erwartet werden. Ordnet jeden Argumentnamen dem zugehörigen Argumenttyp zu.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

mergeSpec
(deprecated)

object (MergeSpec)

Anleitung zum Zusammenführen von Zeilen. Falls vorhanden, werden alle Zeilen, die aus Datenschutzgründen entfernt worden wären, in einer zusammengeführten Zeile zusammengefasst. Die zusammengeführte Zeile wird in der endgültigen Ausgabe angezeigt, wenn die zusammengeführte Zeile die Datenschutzanforderungen erfüllt.

queryState

enum (QueryState)

Abfragestatus.

updateTime

string (Timestamp format)

Zeitpunkt der letzten Aktualisierung der Abfrage.

Ein Zeitstempel im Format RFC3339 UTC mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

updateEmail

string

E-Mail-Adresse des Nutzers, der die Abfrage zuletzt aktualisiert hat.

createTime

string (Timestamp format)

Zeitpunkt der Erstellung der Abfrage.

Ein Zeitstempel im Format RFC3339 UTC mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

createEmail

string

E-Mail-Adresse des Nutzers, der die Abfrage erstellt hat.

queryShare[]

object (QueryShare)

Hier sehen Sie, wie eine Abfrage möglicherweise außerhalb des Inhabers von Ads Data Hub freigegeben wird.

Union-Feld filtered_row Anleitung zum Zusammenführen von Zeilen. Für filtered_row ist nur einer der folgenden Werte zulässig:
filteredRowSummary

object (FilteredRowSummary)

Legen Sie fest, wie aus Datenschutzgründen gelöschte Zeilen in einer zusammengeführten Zeile kombiniert werden sollen. Die zusammengeführte Zeile wird in die endgültige Ausgabe aufgenommen, wenn die zusammengeführte Zeile die Datenschutzanforderungen erfüllt.

generateFilteredRowSummaryAutomatically

boolean

Bei „true“ wird automatisch eine gefilterte Zeilenzusammenfassung erstellt.

Zusammenführungsspezifikation

Anleitung zum Zusammenführen eines Analyseabfrageergebnisses.

JSON-Darstellung
{
  "columns": {
    string: {
      object (MergeColumn)
    },
    ...
  }
}
Felder
columns

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

Anleitung zum Zusammenführen der einzelnen Spalten mit dem Schlüsselnamen. Fehlende Spalten werden als FAILED_TYPE_UNSPECIFIED behandelt.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Spalte zusammenführen

Führen Sie die Anleitung für eine einzelne Ausgabespalte zusammen.

JSON-Darstellung
{
  "type": enum (MergeType),
  "value": {
    object (ParameterValue)
  }
}
Felder
type

enum (MergeType)

Methode, mit der die Werte für die Spalte kombiniert werden.

value

object (ParameterValue)

Der zu verwendende konstante Wert (nur für CONSTANT-Zusammenführungstyp gültig).

Zusammenführungstyp

Alle unterstützten Vorgänge für das Zusammenführen von Spalten.

Enums
MERGE_TYPE_UNSPECIFIED Unbekannter Zusammenführungstyp. Der Wert der zusammengeführten Spalte ist NULL.
CONSTANT Ersetzt den Wert der zusammengeführten Spalte durch die angegebene Konstante.
SUM Addieren Sie die Summe der Werte der zusammengeführten Spalten.

GefilterteZeilenzusammenfassung

Anleitung zum Zusammenführen eines Analyseabfrageergebnisses.

JSON-Darstellung
{
  "columns": {
    string: {
      object (ColumnSummaryRule)
    },
    ...
  }
}
Felder
columns

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

Anleitung zum Zusammenführen der einzelnen Spalten mit dem Schlüsselnamen. Fehlende Spalten werden als AUDIENCE_TYPE_UNSPECIFIED behandelt.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

ColumnSummaryRule

Führen Sie die Anleitung für eine einzelne Ausgabespalte zusammen.

JSON-Darstellung
{
  "type": enum (SummaryType),
  "value": {
    object (ParameterValue)
  }
}
Felder
type

enum (SummaryType)

Methode, mit der die Werte für die Spalte kombiniert werden.

value

object (ParameterValue)

Der zu verwendende Konstantewert (nur für CONSTANT-Zusammenfassungstyp gültig).

Zusammenfassungstyp

Alle unterstützten Vorgänge für das Zusammenführen von Spalten.

Enums
SUMMARY_TYPE_UNSPECIFIED Nicht angegebener Zusammenfassungstyp. Der Wert der Zusammenfassungsspalte lautet NULL.
CONSTANT Ersetzt den Wert der zusammengeführten Spalte durch die angegebene Konstante.
SUM Addieren Sie die Summe der Werte der zusammengeführten Spalten.

Methoden

create

Erstellt eine Analyseabfrage zur späteren Ausführung.

delete

Löscht eine Analyseabfrage.

get

Ruft die angeforderte Analyseabfrage ab.

list

Listet die Analyseabfragen des angegebenen Kunden auf.

patch

Aktualisiert eine vorhandene Analyseabfrage.

start

Startet die Ausführung für eine gespeicherte Analyseabfrage.

startTransient

Startet die Ausführung für eine vorübergehende Analyseabfrage.

validate

Führt statische Validierungsprüfungen für die bereitgestellte Analyseabfrage durch.