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 网址。

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。表示资源或其某个外键的资源名称(唯一 ID)。

没有运算符支持 RESOURCE_NAME 字段。

STRING

映射到 google.protobuf.StringValue。

适用的运算符:=、!=、LIKE、NOT LIKE、IN、NOT IN

UINT64

映射到 google.protobuf.UInt64Value

适用的运算符:=、!=、<、>、<=、>=、BETWEEN、IN、NOT IN

方法

get

仅返回请求的字段。
返回与搜索查询匹配的所有字段。