REST Resource: customers.analysisQueries

Ресурс: AnalysisQuery

Определяет аналитический запрос, который можно выполнить в Ads Data Hub.

Представление 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.
}
Поля
name

string

Имя, которое однозначно идентифицирует запрос. Он имеет форму customers/[customerId]/analysisQueries/[resource_id], например, «customers/123/analysisQueries/abcd1234». Идентификатор ресурса генерируется сервером.

title

string

Название запроса, уникальное для одного клиента Ads Data Hub и типа запроса.

queryText

string

Текст запроса, написанный на стандартном SQL. См. https://cloud.google.com/bigquery/docs/reference/standard-sql/ .

parameterTypes

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

Любые дополнительные параметры, ожидаемые запросом. Сопоставляет каждое имя аргумента с его типом аргумента.

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

mergeSpec
(deprecated)

object ( MergeSpec )

Инструкции по объединению строк. Если они присутствуют, то любые строки, которые были бы удалены из соображений конфиденциальности, будут объединены в одну объединенную строку. Объединенная строка будет в окончательном выводе, если объединенная строка соответствует требованиям конфиденциальности.

queryState

enum ( QueryState )

Состояние запроса.

updateTime

string ( Timestamp format)

Время последнего обновления запроса.

Временная метка в формате RFC3339 UTC "Zulu" с разрешением в наносекунды и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

updateEmail

string

Адрес электронной почты пользователя, который последним обновил запрос.

createTime

string ( Timestamp format)

Время создания запроса.

Временная метка в формате RFC3339 UTC "Zulu" с разрешением в наносекунды и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

createEmail

string

Адрес электронной почты пользователя, создавшего запрос.

queryShare[]

object ( QueryShare )

Указывает, каким образом запрос может быть передан другим пользователям Ads Data Hub.

Поле объединения filtered_row . Инструкции по объединению строк. filtered_row может быть только одним из следующих:
filteredRowSummary

object ( FilteredRowSummary )

Определите, как объединить строки, отброшенные по соображениям конфиденциальности, в одну объединенную строку. Объединенная строка будет включена в окончательный вывод, если объединенная строка соответствует требованиям конфиденциальности.

generateFilteredRowSummaryAutomatically

boolean

Если true, автоматически создается отфильтрованная сводка строк.

MergeSpec

Инструкции по слиянию для схемы результатов запроса анализа.

Представление JSON
{
  "columns": {
    string: {
      object (MergeColumn)
    },
    ...
  }
}
Поля
columns

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

Инструкции по объединению каждого столбца с указанием имени. Все отсутствующие столбцы будут рассматриваться как MERGE_TYPE_UNSPECIFIED.

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

MergeColumn

Инструкции по слиянию для одного выходного столбца.

Представление JSON
{
  "type": enum (MergeType),
  "value": {
    object (ParameterValue)
  }
}
Поля
type

enum ( MergeType )

Метод, используемый для объединения значений столбца.

value

object ( ParameterValue )

Используемое постоянное значение (допустимо только для типа слияния CONSTANT).

Тип слияния

Все поддерживаемые операции для слияния столбцов.

перечисления
MERGE_TYPE_UNSPECIFIED Неопределенный тип слияния. Значение объединенного столбца будет NULL.
CONSTANT Замените значение объединенного столбца заданной константой.
SUM Возьмите сумму объединенных значений столбца.

FilteredRowSummary

Инструкции по слиянию для схемы результатов запроса анализа.

Представление JSON
{
  "columns": {
    string: {
      object (ColumnSummaryRule)
    },
    ...
  }
}
Поля
columns

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

Инструкции по объединению каждого столбца с указанием имени. Все отсутствующие столбцы будут рассматриваться как SUMMARY_TYPE_UNSPECIFIED.

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

СтолбецСводкаПравило

Инструкции по слиянию для одного выходного столбца.

Представление JSON
{
  "type": enum (SummaryType),
  "value": {
    object (ParameterValue)
  }
}
Поля
type

enum ( SummaryType )

Метод, используемый для объединения значений столбца.

value

object ( ParameterValue )

Используемое постоянное значение (допустимо только для сводного типа CONSTANT).

Тип сводки

Все поддерживаемые операции для слияния столбцов.

перечисления
SUMMARY_TYPE_UNSPECIFIED Неопределенный тип сводки. Значение итогового столбца будет NULL.
CONSTANT Замените значение объединенного столбца заданной константой.
SUM Возьмите сумму объединенных значений столбца.

Методы

create

 Создает запрос анализа для последующего выполнения.

delete

 Удаляет запрос анализа.

get

 Извлекает запрошенный аналитический запрос.

list

 Список запросов анализа, принадлежащих указанному клиенту.

patch

 Обновляет существующий запрос анализа.

start

 Запускает выполнение сохраненного запроса анализа.

startTransient

 Запускает выполнение запроса анализа переходных процессов.

validate

 Выполняет статическую проверку достоверности предоставленного запроса анализа.