REST Resource: searchAds360Fields

リソース: SearchAds360Field

SearchAds360Service で使用されるフィールドまたはリソース(アーティファクト)。

JSON 表現
{
  "resourceName": string,
  "category": enum (SearchAds360FieldCategory),
  "selectableWith": [
    string
  ],
  "attributeResources": [
    string
  ],
  "metrics": [
    string
  ],
  "segments": [
    string
  ],
  "enumValues": [
    string
  ],
  "dataType": enum (SearchAds360FieldDataType),
  "name": string,
  "selectable": boolean,
  "filterable": boolean,
  "sortable": boolean,
  "typeUrl": string,
  "isRepeated": boolean
}
フィールド
resourceName

string

アーティファクトのリソース名。アーティファクト リソース名の形式は次のとおりです。

SearchAds360Fields/{name}

category

enum (SearchAds360FieldCategory)

アーティファクトのカテゴリ。

selectableWith[]

string

説明されているアーティファクトで選択可能なすべてのリソース、セグメント、指標の名前。

attributeResources[]

string

記述されたアーティファクトで選択可能なすべてのリソースの名前。検索クエリに含まれている場合、これらのリソースのフィールドは指標を分割されません。

このフィールドは、カテゴリが RESOURCE のアーティファクトにのみ設定されます。

metrics[]

string

このフィールドには、FROM 句で使用されたときに、説明されているアーティファクトで選択できるすべての指標の名前が一覧表示されます。カテゴリが RESOURCE のアーティファクトにのみ設定されます。

segments[]

string

このフィールドには、検索クエリに含まれるセグメント指標と、説明されているアーティファクトが FROM 句で使用されるすべてのアーティファクト(セグメントまたは他のリソース)の名前が一覧表示されます。カテゴリが RESOURCE のアーティファクトにのみ設定されます。

enumValues[]

string

アーティファクトが ENUM 型のフィールドである場合に、アーティファクトが想定できる値。

このフィールドは、カテゴリ SEGMENT または ATTRIBUTE のアーティファクトにのみ設定されます。

dataType

enum (SearchAds360FieldDataType)

このフィールドは、WHERE 句でアーティファクトで使用できる演算子を決定します。

name

string

アーティファクトの名前。

selectable

boolean

アーティファクトを検索クエリの SELECT 句で使用できるかどうか。

filterable

boolean

アーティファクトを検索クエリの WHERE 句で使用できるかどうか。

sortable

boolean

アーティファクトを検索クエリの ORDER BY 句で使用できるかどうか。

typeUrl

string

アーティファクトのデータ型を記述する proto の URL。

isRepeated

boolean

フィールド アーティファクトが繰り返されるかどうか。

SearchAds360FieldCategory

アーティファクトのカテゴリ。

列挙型
UNSPECIFIED 指定なし
UNKNOWN 不明
RESOURCE 記述されたアーティファクトはリソースです。
ATTRIBUTE 記述されたアーティファクトはフィールドであり、リソースの属性です。クエリにリソース属性フィールドを含めると、関連付けられているリソースが FROM 句で見つかったリソースがセグメント化される場合、クエリがセグメント化されることがあります。
SEGMENT 説明されているアーティファクトはフィールドであり、常に検索クエリをセグメント化します。
METRIC 記述されたアーティファクトはフィールドであり、指標です。検索クエリをセグメント化することは決してありません。

SearchAds360FieldDataType

以下は、SearchAds360Service アーティファクトが持つ可能性のあるさまざまなタイプです。

列挙型
UNSPECIFIED 指定なし
UNKNOWN 不明
BOOLEAN

google.protobuf.BoolValue にマッピングされます。

使用できる演算子: =、!=

DATE

google.protobuf.StringValue にマッピングされます。ただし、日付に固有の演算子セットを使用して比較することは可能です。

使用できる演算子: =、<、>、<=、>=、BETWEEN、DURING、IN

DOUBLE

google.protobuf.DoubleValue にマッピングされます。

使用できる演算子: =、!=、<、>、IN、NOT IN

ENUM

列挙型にマッピングされます。具体的な定義は typeUrl で確認できます。

使用できる演算子: =、!=、IN、NOT IN

FLOAT

google.protobuf.FloatValue にマッピング

使用できる演算子: =、!=、<、>、IN、NOT IN

INT32

google.protobuf.Int32Value にマッピングされる

使用できる演算子: =、!=、<、>、<=、>=、BETWEEN、IN、NOT IN

INT64

google.protobuf.Int64Value にマッピングされる

使用できる演算子: =、!=、<、>、<=、>=、BETWEEN、IN、NOT IN

MESSAGE

プロトコル バッファ メッセージ タイプにマッピングされます。データ型の詳細は typeUrl にあります。

MESSAGE フィールドで使用できる演算子はありません。

RESOURCE_NAME

google.protobuf.StringValue にマッピングされます。リソースまたはその外部キーのリソース名(一意の ID)を表します。

RESOURCE_NAME フィールドでは演算子を使用できません。

STRING

google.protobuf.StringValue にマッピングされます。

使用できる演算子: =、!=、LIKE、NOT LIKE、IN、NOT IN

UINT64

google.protobuf.UInt64Value にマッピング

使用できる演算子: =、!=、<、>、<=、>=、BETWEEN、IN、NOT IN

メソッド

get

リクエストされたフィールドのみを返します。
検索クエリに一致するすべてのフィールドを返します。