REST Resource: customers.analysisQueries

资源:AnalyzeQuery

定义可在广告数据中心内执行的分析查询。

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

用于唯一标识查询的名称。它采用以下格式:customer/[customerId]/analyticsQuery/[resource_id],例如 'customers/123/analyticsQuery/abcd1234'。资源 ID 由服务器生成。

title

string

查询标题,在单个广告数据中心客户和查询类型中具有唯一性。

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)(即“祖鲁时”)格式,分辨率为纳秒级,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

updateEmail

string

上次更新查询的用户的电子邮件地址。

createTime

string (Timestamp format)

查询的创建时间。

时间戳采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,分辨率为纳秒级,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

createEmail

string

创建查询的用户的电子邮件地址。

queryShare[]

object (QueryShare)

指明在自有广告数据中心客户之外共享查询的方式。

联合字段 filtered_row。行合并说明。filtered_row 只能是下列其中一项:
filteredRowSummary

object (FilteredRowSummary)

定义出于隐私保护方面的考虑而被丢弃的行如何合并为单个合并行。如果合并后的行符合隐私权要求,则最终输出中将包含该行。

generateFilteredRowSummaryAutomatically

boolean

如果为 true,则系统会自动生成过滤后的行摘要。

合并规范

分析查询结果架构的合并说明。

JSON 表示法
{
  "columns": {
    string: {
      object (MergeColumn)
    },
    ...
  }
}
字段
columns

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

合并列的说明(按名称键)。任何缺失的列都将被视为 Merge_TYPE_UNSPECIFIED。

包含一系列 "key": value 对的对象。示例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }

合并列

合并单个输出列的说明。

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" }

ColumnSummaryRule

合并单个输出列的说明。

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

对提供的分析查询执行静态验证检查。