REST Resource: customers.analysisQueries

Recurso: AnalysisQuery

Define uma consulta de análise que pode ser executada no Ads Data Hub.

Representação 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.
}
Campos
name

string

Nome que identifica uma consulta de forma exclusiva. Ele tem o formato clients/[customerId]/analysisQuery/[resource_id], por exemplo, 'customers/123/analysisQuery/abcd1234' O ID do recurso é gerado pelo servidor.
title

string

Título da consulta, que é exclusivo em um único cliente do Ads Data Hub e tipo de consulta.
queryText

string

Texto de consulta escrito em SQL padrão. Consulte https://cloud.google.com/bigquery/docs/reference/standard-sql/.
parameterTypes

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

Todos os outros parâmetros esperados pela consulta. Mapeia cada nome de argumento pelo tipo de argumento.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
mergeSpec
(deprecated)

object (MergeSpec)

Instruções para mesclar linhas. Se estiver presente, todas as linhas que foram descartadas por motivos de privacidade serão combinadas em uma única linha mesclada. A linha mesclada estará na saída final se ela atender aos requisitos de privacidade.
queryState

enum (QueryState)

Estado da consulta.
updateTime

string (Timestamp format)

Hora em que a consulta foi atualizada pela última vez.

Timestamp no formato RFC3339 UTC "Zulu" com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
updateEmail

string

Endereço de e-mail do usuário que atualizou a consulta pela última vez.
createTime

string (Timestamp format)

Hora em que a consulta foi criada.

Timestamp no formato RFC3339 UTC "Zulu" com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
createEmail

string

Endereço de e-mail do usuário que criou a consulta.
queryShare[]

object (QueryShare)

Indica como uma consulta pode ser compartilhada além do cliente proprietário do Ads Data Hub.
Campo de união filtered_row. Instruções para mesclar linhas. filtered_row pode ser apenas de um dos tipos a seguir:
filteredRowSummary

object (FilteredRowSummary)

Defina como combinar linhas descartadas por motivos de privacidade em uma única linha mesclada. A linha mesclada será incluída na saída final se ela atender aos requisitos de privacidade.
generateFilteredRowSummaryAutomatically

boolean

Se for verdadeiro, um resumo da linha filtrada será gerado automaticamente.

MergeSpec

Instruções de mesclagem para um esquema de resultados da consulta de análise.

Representação JSON 
{
  "columns": {
    string: {
      object (MergeColumn)
    },
    ...
  }
}
Campos
columns

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

Instruções para mesclar cada coluna, codificadas por nome. Qualquer coluna ausente será tratada como merge_TYPE_UNSPECIFIED.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

MergeColumn

Instruções de mesclagem para uma única coluna de saída.

Representação JSON 
{
  "type": enum (MergeType),
  "value": {
    object (ParameterValue)
  }
}
Campos
type

enum (MergeType)

Método usado para combinar os valores da coluna.
value

object (ParameterValue)

O valor constante a ser usado (válido somente para o tipo de mesclagem CONSTANT).

Tipo de mesclagem

Todas as operações compatíveis para mesclagem de colunas.

Enums
MERGE_TYPE_UNSPECIFIED Tipo de mesclagem não especificado. O valor da coluna mesclada será NULL.
CONSTANT Substituir o valor da coluna mesclada pela constante especificada.
SUM Veja a soma dos valores da coluna mesclada.

Resumo de filtro de linha

Instruções de mesclagem para um esquema de resultados da consulta de análise.

Representação JSON 
{
  "columns": {
    string: {
      object (ColumnSummaryRule)
    },
    ...
  }
}
Campos
columns

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

Instruções para mesclar cada coluna, codificadas por nome. Qualquer coluna ausente será tratada como SUMMARY_TYPE_UNSPECIFIED.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Regra de resumo de colunas

Instruções de mesclagem para uma única coluna de saída.

Representação JSON 
{
  "type": enum (SummaryType),
  "value": {
    object (ParameterValue)
  }
}
Campos
type

enum (SummaryType)

Método usado para combinar os valores da coluna.
value

object (ParameterValue)

O valor constante a ser usado (válido somente para o tipo de resumo CONSTANT).

Tipo de resumo

Todas as operações compatíveis para mesclagem de colunas.

Enums
SUMMARY_TYPE_UNSPECIFIED Tipo de resumo não especificado. O valor da coluna de resumo será NULL.
CONSTANT Substituir o valor da coluna mesclada pela constante especificada.
SUM Veja a soma dos valores da coluna mesclada.

Métodos

create

 Cria uma consulta de análise para execução posterior.

delete

 Exclui uma consulta de análise.

get

 Recupera a consulta de análise solicitada.

list

 Lista as consultas de análise que pertencem ao cliente especificado.

patch

 Atualiza uma consulta de análise existente.

start

 Inicia a execução em uma consulta de análise armazenada.

startTransient

 Inicia a execução em uma consulta de análise temporária.

validate

 Realiza verificações de validação estáticas na consulta de análise fornecida.