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

Имена всех ресурсов, которые можно выбрать с помощью описанного артефакта. Поля из этих ресурсов не сегментируют метрики при включении в поисковые запросы.

Это поле установлено только для артефактов категории РЕСУРС.

metrics[]

string

В этом поле перечислены имена всех метрик, которые можно выбрать с помощью описанного артефакта, когда он используется в предложении FROM. Он установлен только для артефактов категории РЕСУРС.

segments[]

string

В этом поле перечислены имена всех артефактов, будь то сегмент или другой ресурс, которые сегментируют метрики при включении в поисковые запросы и когда описанный артефакт используется в предложении FROM. Он установлен только для артефактов категории РЕСУРС.

enumValues[]

string

Значения, которые может принимать артефакт, если это поле типа ENUM.

Это поле установлено только для артефактов категории СЕГМЕНТ или АТРИБУТ.

dataType

enum ( SearchAds360FieldDataType )

Это поле определяет операторы, которые можно использовать с артефактом в предложениях WHERE.

name

string

Название артефакта.

selectable

boolean

Можно ли использовать артефакт в предложении SELECT в поисковых запросах.

filterable

boolean

Можно ли использовать артефакт в предложении WHERE в поисковых запросах.

sortable

boolean

Можно ли использовать артефакт в предложении ORDER BY в поисковых запросах.

typeUrl

string

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

Применимые операторы: =, !=, <, >, <=, >=, BETWEEN, IN, NOT IN.

INT64

Сопоставляется с google.protobuf.Int64Value

Применимые операторы: =, !=, <, >, <=, >=, BETWEEN, IN, NOT IN.

MESSAGE

Сопоставляется с типом сообщения буфера протокола. Подробности о типе данных можно найти в typeUrl.

Никакие операторы не работают с полями MESSAGE.

RESOURCE_NAME

Сопоставляется с google.protobuf.StringValue. Представляет имя ресурса (уникальный идентификатор) ресурса или одного из его внешних ключей.

Ни один оператор не работает с полями RESOURCE_NAME.

STRING

Сопоставляется с google.protobuf.StringValue.

Применимые операторы: =, !=, LIKE, NOT LIKE, IN, NOT IN.

UINT64

Сопоставляется с google.protobuf.UInt64Value

Применимые операторы: =, !=, <, >, <=, >=, BETWEEN, IN, NOT IN.

Методы

get

 Возвращает только запрошенное поле.
Возвращает все поля, соответствующие поисковому запросу .