REST Resource: searchAds360Fields

Recurso: SearchAds360Field

Um campo ou recurso (artefato) usado pelo SearchAds360Service.

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

string

O nome do recurso do artefato. Os nomes dos recursos do artefato têm o seguinte formato:

SearchAds360Fields/{name}

category

enum (SearchAds360FieldCategory)

A categoria do artefato.

selectableWith[]

string

Os nomes de todos os recursos, segmentos e métricas que podem ser selecionados com o artefato descrito.

attributeResources[]

string

Os nomes de todos os recursos que podem ser selecionados com o artefato descrito. Os campos desses recursos não segmentam métricas quando incluídas em consultas de pesquisa.

Este campo é definido apenas para artefatos com categoria RESOURCE.

metrics[]

string

Esse campo lista os nomes de todas as métricas que podem ser selecionadas com o artefato descrito quando ele é usado na cláusula FROM. É definido apenas para artefatos com categoria RESOURCE.

segments[]

string

Este campo lista os nomes de todos os artefatos, seja um segmento ou outro recurso, que segmentam métricas quando incluídos em consultas de pesquisa e quando o artefato descrito é usado na cláusula FROM. Ele é definido apenas para artefatos com a categoria RESOURCE.

enumValues[]

string

Valores que o artefato pode assumir se for um campo do tipo ENUM.

Esse campo é definido apenas para artefatos da categoria SEGMENT ou ATTRIBUTE.

dataType

enum (SearchAds360FieldDataType)

Esse campo determina os operadores que podem ser usados com o artefato em cláusulas WHERE.

name

string

O nome do artefato.

selectable

boolean

Indica se o artefato pode ser usado em uma cláusula SELECT em consultas de pesquisa.

filterable

boolean

Indica se o artefato pode ser usado em uma cláusula WHERE em consultas de pesquisa.

sortable

boolean

Indica se o artefato pode ser usado em uma cláusula ORDER BY em consultas de pesquisa.

typeUrl

string

O URL do proto que descreve o tipo de dados do artefato.

isRepeated

boolean

Define se o artefato do campo é repetido.

SearchAds360FieldCategory

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 de recurso em uma consulta pode segmentar a consulta se o recurso a que ele é atribuído segmenta 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. Ele nunca segmenta consultas de pesquisa.

SearchAds360FieldDataType

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

Enums
UNSPECIFIED Não especificado
UNKNOWN Desconhecido
BOOLEAN

Mapeia para google.protobuf.BoolValue

Operadores aplicáveis: =, !=

DATE

É mapeado para google.protobuf.StringValue. No entanto, é possível fazer comparações 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 um tipo enumerado. Sua definição específica pode ser encontrada em typeUrl.

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

FLOAT

Mapeia para google.protobuf.FloatValue

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

INT32

É mapeado 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) ou uma das chaves estrangeiras dele.

Nenhum operador funciona com campos RESOURCE_NAME.

STRING

É mapeado para google.protobuf.StringValue.

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

UINT64

É associado a google.protobuf.UInt64Value

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

Métodos

get

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