REST Resource: googleAdsFields

Recurso: GoogleAdsField

Um campo ou recurso (artefato) usado pelo GoogleAdsService.

Representação 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
}
Campos
resourceName

string

Apenas saída. O nome de recurso do artefato. Os nomes dos recursos de artefato têm o formato:

googleAdsFields/{name}
category

enum (GoogleAdsFieldCategory)

Apenas saída. A categoria do artefato.
selectableWith[]

string

Apenas saída. Os nomes de todos os recursos, segmentos e métricas que podem ser selecionados com o artefato descrito.
attributeResources[]

string

Apenas saída. Os nomes de todos os recursos selecionáveis com o artefato descrito. Os campos desses recursos não segmentam métricas quando incluídos em consultas de pesquisa.

Este campo é definido apenas para artefatos cuja categoria é RESOURCE.
metrics[]

string

Apenas saída. Esse campo lista os nomes de todas as métricas selecionáveis com o artefato descrito quando ele é usado na cláusula FROM. Ele é definido apenas para artefatos cuja categoria é RESOURCE.
segments[]

string

Apenas saída. Esse campo lista os nomes de todos os artefatos, seja um segmento ou outro recurso, que segmentam as métricas quando incluídos em consultas de pesquisa e quando o artefato descrito é usado na cláusula FROM. Ele é definido apenas para artefatos cuja categoria é RESOURCE.
enumValues[]

string

Apenas saída. Valores que o artefato pode assumir se for um campo do tipo ENUM.

Esse campo só é definido para artefatos da categoria SEGMENT ou ATTRIBUTE.
dataType

enum (GoogleAdsFieldDataType)

Apenas saída. Esse campo determina os operadores que podem ser usados com o artefato em cláusulas WHERE.
name

string

Apenas saída. O nome do artefato.
selectable

boolean

Apenas saída. Se o artefato pode ser usado em uma cláusula SELECT em consultas de pesquisa.
filterable

boolean

Apenas saída. Se o artefato pode ser usado em uma cláusula WHERE em consultas de pesquisa.
sortable

boolean

Apenas saída. Se o artefato pode ser usado em uma cláusula ORDER BY em consultas de pesquisa.
typeUrl

string

Apenas saída. O URL do proto que descreve o tipo de dados do artefato.
isRepeated

boolean

Apenas saída. Se o artefato de campo é repetido.

GoogleAdsFieldCategory

A categoria do artefato.

Enums
UNSPECIFIED Não especificado
UNKNOWN Desconhecido
RESOURCE O artefato descrito é um recurso.
ATTRIBUTE O artefato descrito é um campo e um atributo de um recurso. Incluir um campo de atributo do recurso em uma consulta pode segmentar a consulta se o recurso ao qual ela é atribuído segmentar o recurso encontrado na cláusula FROM.
SEGMENT O artefato descrito é um campo e sempre segmenta consultas de pesquisa.
METRIC O artefato descrito é um campo e uma métrica. Ela nunca segmenta as consultas de pesquisa.

GoogleAdsFieldDataType

Estes são os vários tipos que um artefato GoogleAdsService pode assumir.

Enums
UNSPECIFIED Não especificado
UNKNOWN Desconhecido
BOOLEAN

Mapeia para google.protobuf.BoolValue

Operadores aplicáveis: =, !=
DATE

Mapeia para google.protobuf.StringValue. No entanto, isso pode ser comparado usando o conjunto de operadores específicos para datas.

Operadores aplicáveis: =, <, >, <=, >=, BETWEEN, DURING e IN
DOUBLE

Mapeia para google.protobuf.DoubleValue

Operadores aplicáveis: =, !=, <, >, IN, NOT IN
ENUM

Mapeia para uma enumeração. A definição específica dela pode ser encontrada em typeUrl.

Operadores aplicáveis: =, !=, IN, NOT IN
FLOAT

Mapeia para google.protobuf.FloatValue

Operadores aplicáveis: =, !=, <, >, IN, NOT IN
INT32

Mapeia para google.protobuf.Int32Value

Operadores aplicáveis: =, !=, <, >, <=, >=, BETWEEN, IN, NOT IN
INT64

Mapeia para google.protobuf.Int64Value

Operadores aplicáveis: =, !=, <, >, <=, >=, BETWEEN, IN, NOT IN
MESSAGE

Mapeia para um tipo de mensagem de buffer de protocolo. Os detalhes do tipo de dados podem ser encontrados em typeUrl.

Nenhum operador funciona com campos MESSAGE.
RESOURCE_NAME

Mapeia para google.protobuf.StringValue. Representa o nome do recurso (ID exclusivo) de um recurso ou uma de suas chaves externas.

Nenhum operador funciona com campos RESOURCE_NAME.
STRING

Mapeia para google.protobuf.StringValue.

Operadores aplicáveis: =, !=, LIKE, NOT LIKE, IN, NOT IN
UINT64

Mapeia para google.protobuf.UInt64Value

Operadores aplicáveis: =, !=, <, >, <=, >=, BETWEEN, IN, NOT IN

Métodos

get

 Retorna apenas o campo solicitado.
Retorna todos os campos que correspondem à consulta de pesquisa.