REST Resource: googleAdsFields

リソース: GoogleAdsField

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

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

string

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

googleAdsFields/{name}

category

enum (GoogleAdsFieldCategory)

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

selectableWith[]

string

出力のみ。記述されているアーティファクトで選択できるすべてのリソース、セグメント、指標の名前。

attributeResources[]

string

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

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

metrics[]

string

出力のみ。このフィールドには、FROM 句で使用するときに、記述されたアーティファクトで選択可能なすべての指標の名前がリストされます。カテゴリが RESOURCE のアーティファクトに対してのみ設定されます。

segments[]

string

出力のみ。このフィールドには、セグメントか別のリソースかにかかわらず、検索クエリに含まれる場合と、記述されたアーティファクトが FROM 句で使用されている場合の、そのセグメント指標のすべてのアーティファクトの名前がリストされます。カテゴリが RESOURCE のアーティファクトに対してのみ設定されます。

enumValues[]

string

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

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

dataType

enum (GoogleAdsFieldDataType)

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

name

string

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

selectable

boolean

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

filterable

boolean

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

sortable

boolean

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

typeUrl

string

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

isRepeated

boolean

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

GoogleAdsFieldCategory

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

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

GoogleAdsFieldDataType

GoogleAdsService アーティファクトは次のようなさまざまなタイプを受け取ります。

列挙型
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 にマッピングされます。リソースまたはその外部キーの 1 つのリソース名(一意の ID)を表します。

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

STRING

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

適用可能な演算子: =、!=、LIKE、NOT LIKE、IN、NOT IN

UINT64

google.protobuf.UInt64Value にマッピング

適用可能な演算子: =、!=、<、>、<=、>=、BETWEEN、IN、NOT IN

Methods

get

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