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'）。リソース ID はサーバーによって生成されます。
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)

行をマージする手順。存在する場合、プライバシー上の理由でドロップされるはずの行が 1 つに結合されます。マージされた行がプライバシー要件を満たしている場合は、マージされた行が最終出力に表示されます。
queryState

enum (QueryState)

クエリの状態。
updateTime

string (Timestamp format)

クエリが最後に更新された時刻。

RFC3339 UTC の Zulu 形式のタイムスタンプ。ナノ秒単位で、小数点以下は 9 桁までとなります。（例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"）。
updateEmail

string

クエリを最後に更新したユーザーのメールアドレス。
createTime

string (Timestamp format)

クエリが作成された時刻。

RFC3339 UTC の Zulu 形式のタイムスタンプ。ナノ秒単位で、小数点以下は 9 桁までとなります。（例: "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)

プライバシー上の理由によってドロップされた行を 1 つの結合行に統合する方法を定義します。マージされた行がプライバシー要件を満たしている場合は、マージされた行が最終出力に含められます。
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 結合された列の値の合計を取得します。

フィルタされた行の概要

分析クエリ結果のスキーマの手順を結合します。

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 結合された列の値の合計を取得します。

Methods

create

 後で実行するための分析クエリを作成します。

delete

 分析クエリを削除します。

get

 リクエストされた分析クエリを取得します。

list

 指定した顧客が所有する分析クエリを一覧表示します。

patch

 既存の分析クエリを更新します。

start

 保存された分析クエリの実行を開始します。

startTransient

 一時的な分析クエリで実行を開始します。

validate

 提供された分析クエリに対して静的検証チェックを実行します。