REST Resource: customers.userListQueries

リソース: UserListQuery

Ads Data Hub 内で実行できるユーザーリスト クエリを定義します。

JSON 表現
{
  "name": string,
  "title": string,
  "queryText": string,
  "parameterTypes": {
    string: {
      object (ParameterType)
    },
    ...
  },
  "queryState": enum (QueryState),
  "updateTime": string,
  "updateEmail": string,
  "createTime": string,
  "createEmail": string,
  "queryShare": [
    {
      object (QueryShare)
    }
  ],
  "userList": [
    string
  ]
}
フィールド
name

string

クエリを一意に識別する名前。形式は users/[customerId]/userListQueries/[resource_id] です(例: 'customers/123/userListQueries/abcd1234')。リソース ID はサーバーによって生成されます。

title

string

クエリのタイトル。Ads Data Hub の単一顧客とクエリタイプ内で一意です。

queryText

string

クエリテキスト。

parameterTypes

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

クエリで想定されるその他のパラメータ。各引数名をその引数タイプにマッピングします。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

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 ユーザー以外のクエリも共有する方法を紹介します。

userList[]

string

出力のみ。このユーザーリスト クエリによって入力できる Ads Data Hub ユーザーリスト リソース。

Methods

create

後で実行するためのユーザーリスト クエリを作成します。

delete

ユーザーリスト クエリを削除します。

get

リクエストされたユーザーリスト クエリを取得します。

list

指定した顧客が所有するユーザーリストのクエリを一覧表示します。

patch

既存のユーザーリストのクエリを更新します。

start

保存されているユーザーリスト クエリの実行を開始します。

startTransient
(deprecated)

一時的なユーザーリスト クエリの実行を開始します。

validate

提供されたユーザーリスト クエリに対して静的検証チェックを行います。