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 にマッピングします。

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

INT64

google.protobuf.Int64Value にマッピングします。

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

MESSAGE

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

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

RESOURCE_NAME

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

RESOURCE_NAME フィールドを操作できる演算子はありません。

STRING

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

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

UINT64

google.protobuf.UInt64Value にマッピングします。

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

Methods

get

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