Package google.ads.searchads360.v0.services

Индекс

CustomColumnService

Сервис для управления пользовательскими столбцами.

GetCustomColumn

rpc GetCustomColumn( GetCustomColumnRequest ) returns ( CustomColumn )

Возвращает запрошенный специальный столбец с полной информацией.

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/doubleclicksearch
Список пользовательских столбцов

rpc ListCustomColumns( ListCustomColumnsRequest ) returns ( ListCustomColumnsResponse )

Возвращает все пользовательские столбцы, связанные с клиентом, в подробностях.

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/doubleclicksearch

Обслуживание клиентов

Сервис для управления клиентами.

Список доступных клиентов

rpc ListAccessibleCustomers( ListAccessibleCustomersRequest ) returns ( ListAccessibleCustomersResponse )

Возвращает имена ресурсов клиентов, к которым непосредственно может получить доступ пользователь, аутентифицирующий вызов.

Список выброшенных ошибок: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/doubleclicksearch

SearchAds360FieldService

Сервис для получения полей Search Ads 360 API.

GetSearchAds360Field

rpc GetSearchAds360Field( GetSearchAds360FieldRequest ) returns ( SearchAds360Field )

Возвращает только запрошенное поле.

Список выброшенных ошибок: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/doubleclicksearch
ПоискSearchAds360Поля

rpc SearchSearchAds360Fields( SearchSearchAds360FieldsRequest ) returns ( SearchSearchAds360FieldsResponse )

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

Список выброшенных ошибок: AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/doubleclicksearch

Служба SearchAds360

Сервис для получения данных и показателей по ресурсам.

Поиск

rpc Search( SearchSearchAds360Request ) returns ( SearchSearchAds360Response )

Возвращает все строки, соответствующие поисковому запросу.

Список выброшенных ошибок: AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/doubleclicksearch
Поисковый поток

rpc SearchStream( SearchSearchAds360StreamRequest ) returns ( SearchSearchAds360StreamResponse )

Возвращает все строки, соответствующие запросу потока поиска.

Список выброшенных ошибок: AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/doubleclicksearch

ConversionCustomDimensionHeader

Сообщение для заголовка специального параметра преобразования.

Поля
id

int64

Идентификатор специального параметра конверсии.

name

string

Определенное пользователем имя специального параметра конверсии.

ConversionCustomMetricHeader

Сообщение для заголовка специальной метрики преобразования.

Поля
id

int64

Идентификатор специального показателя конверсии.

name

string

Определяемое пользователем имя специального показателя конверсии.

CustomColumnHeader

Сообщение для заголовка пользовательского столбца.

Поля
id

int64

Идентификатор специального столбца.

name

string

Определенное пользователем имя настраиваемого столбца.

references_metrics

bool

Истинно, если специальный столбец ссылается на метрики.

GetCustomColumnRequest

Сообщение запроса для CustomColumnService.GetCustomColumn .

Поля
resource_name

string

Необходимый. Имя ресурса пользовательского столбца, который требуется получить.

GetSearchAds360FieldRequest

Сообщение запроса для SearchAds360FieldService.GetSearchAds360Field .

Поля
resource_name

string

Необходимый. Имя ресурса поля, которое нужно получить.

Список доступных клиентовЗапрос

Этот тип не имеет полей.

Сообщение запроса для CustomerService.ListAccessibleCustomers .

ListAccessibleCustomersResponse

Ответное сообщение для CustomerService.ListAccessibleCustomers .

Поля
resource_names[]

string

Имя ресурса клиентов, доступное непосредственно пользователю, аутентифицирующему вызов.

ListCustomColumnsRequest

Сообщение запроса для CustomColumnService.ListCustomColumns

Поля
customer_id

string

Необходимый. Идентификатор клиента, к которому нужно применить операцию списка CustomColumn.

ListCustomColumnsResponse

Ответное сообщение для получения всех специальных столбцов, связанных с клиентом.

Поля
custom_columns[]

CustomColumn

CustomColumns, принадлежащий предоставленному клиенту.

RawEventConversionDimensionHeader

Сообщение для заголовка измерения преобразования необработанных событий.

Поля
id

int64

Идентификатор пользовательской переменной преобразования.

name

string

Определяемое пользователем имя измерения необработанных событий.

RawEventConversionMetricHeader

Сообщение для заголовка необработанной метрики преобразования событий.

Поля
id

int64

Идентификатор пользовательской переменной преобразования.

name

string

Определяемое пользователем имя необработанной метрики событий.

Поисковая реклама360строка

Возвращенная строка из запроса.

Поля
ad_group

AdGroup

Группа объявлений, указанная в запросе.

ad_group_ad

AdGroupAd

Объявление, указанное в запросе.

ad_group_ad_label

AdGroupAdLabel

Ярлык объявления группы объявлений, указанный в запросе.

ad_group_asset

AdGroupAsset

Объект группы объявлений, указанный в запросе.

ad_group_asset_set

AdGroupAssetSet

Набор объектов группы объявлений, указанный в запросе.

ad_group_audience_view

AdGroupAudienceView

Представление аудитории группы объявлений, указанное в запросе.

ad_group_bid_modifier

AdGroupBidModifier

Модификатор ставки, указанный в запросе.

ad_group_criterion

AdGroupCriterion

Критерий, указанный в запросе.

ad_group_criterion_label

AdGroupCriterionLabel

Метка критерия группы объявлений, указанная в запросе.

ad_group_label

AdGroupLabel

Ярлык группы объявлений, указанный в запросе.

age_range_view

AgeRangeView

Представление возрастного диапазона, указанное в запросе.

asset

Asset

Актив, указанный в запросе.

asset_group_asset

AssetGroupAsset

Актив группы активов, указанный в запросе.

asset_group_signal

AssetGroupSignal

Сигнал группы активов, указанный в запросе.

asset_group_listing_group_filter

AssetGroupListingGroupFilter

Фильтр группы списков групп активов, на который ссылается запрос.

asset_group_top_combination_view

AssetGroupTopCombinationView

Представление верхней комбинации группы активов, указанное в запросе.

asset_group

AssetGroup

Группа активов, указанная в запросе.

asset_set_asset

AssetSetAsset

Актив набора активов, на который ссылается запрос.

asset_set

AssetSet

Набор активов, на который ссылается запрос.

bidding_strategy

BiddingStrategy

Стратегия назначения ставок, указанная в запросе.

campaign_budget

CampaignBudget

Бюджет кампании, указанный в запросе.

campaign

Campaign

Кампания, указанная в запросе.

campaign_asset

CampaignAsset

Актив кампании, указанный в запросе.

campaign_asset_set

CampaignAssetSet

Набор объектов кампании, указанный в запросе.

campaign_audience_view

CampaignAudienceView

Представление аудитории кампании, указанное в запросе.

campaign_criterion

CampaignCriterion

Критерий кампании, указанный в запросе.

campaign_label

CampaignLabel

Ярлык кампании, указанный в запросе.

cart_data_sales_view

CartDataSalesView

Представление продаж данных корзины, указанное в запросе.

audience

Audience

Аудитория, указанная в запросе.

conversion_action

ConversionAction

Действие-конверсия, указанное в запросе.

conversion_custom_variable

ConversionCustomVariable

Пользовательская переменная преобразования, указанная в запросе.

customer

Customer

Клиент, указанный в запросе.

customer_asset

CustomerAsset

Актив клиента, указанный в запросе.

customer_asset_set

CustomerAssetSet

Набор активов клиента, указанный в запросе.

accessible_bidding_strategy

AccessibleBiddingStrategy

Доступная стратегия назначения ставок, указанная в запросе.

customer_client

CustomerClient

CustomerClient, указанный в запросе.

dynamic_search_ads_search_term_view

DynamicSearchAdsSearchTermView

Представление поискового запроса в динамических поисковых объявлениях, указанное в запросе.

gender_view

GenderView

Половое представление, указанное в запросе.

geo_target_constant

GeoTargetConstant

Константа географической цели, указанная в запросе.

keyword_view

KeywordView

Представление ключевого слова, указанное в запросе.

label

Label

Метка, указанная в запросе.

language_constant

LanguageConstant

Языковая константа, указанная в запросе.

location_view

LocationView

Представление местоположения, указанное в запросе.

product_bidding_category_constant

ProductBiddingCategoryConstant

Категория назначения ставок по продукту, указанная в запросе.

product_group_view

ProductGroupView

Представление группы продуктов, указанное в запросе.

shopping_performance_view

ShoppingPerformanceView

Представление эффективности покупок, указанное в запросе.

user_list

UserList

Список пользователей, на который ссылается запрос.

webpage_view

WebpageView

Представление веб-страницы, указанное в запросе.

visit

Visit

Посещение на уровне события, указанное в запросе.

conversion

Conversion

Преобразование уровня события, указанное в запросе.

metrics

Metrics

Метрики.

segments

Segments

Сегменты.

custom_columns[]

Value

Пользовательские столбцы.

ПоискSearchAds360ПоляЗапрос

Сообщение запроса для SearchAds360FieldService.SearchSearchAds360Fields .

Поля
query

string

Необходимый. Строка запроса.

page_token

string

Токен страницы, которую нужно получить. Если не указано, будет возвращена первая страница результатов. Используйте значение, полученное из next_page_token в предыдущем ответе, чтобы запросить следующую страницу результатов.

page_size

int32

Количество элементов, которые нужно получить на одной странице. Когда запрашивается слишком большая страница, сервер может принять решение дополнительно ограничить количество возвращаемых ресурсов.

ПоискSearchAds360FieldsResponse

Ответное сообщение для SearchAds360FieldService.SearchSearchAds360Fields .

Поля
results[]

SearchAds360Field

Список полей, соответствующих запросу.

next_page_token

string

Токен нумерации страниц, используемый для получения следующей страницы результатов. Передайте содержимое этой строки в качестве атрибута page_token следующего запроса. next_page_token не возвращается для последней страницы.

total_results_count

int64

Общее количество результатов, соответствующих запросу, игнорирующему предложение LIMIT.

ПоискSearchAds360Запрос

Сообщение запроса для SearchAds360Service.Search .

Поля
customer_id

string

Необходимый. Идентификатор запрашиваемого клиента.

query

string

Необходимый. Строка запроса.

page_token

string

Токен страницы, которую нужно получить. Если не указано, будет возвращена первая страница результатов. Используйте значение, полученное из next_page_token в предыдущем ответе, чтобы запросить следующую страницу результатов.

page_size

int32

Количество элементов, которые нужно получить на одной странице. Когда запрашивается слишком большая страница, сервер может принять решение дополнительно ограничить количество возвращаемых ресурсов.

validate_only

bool

Если это правда, запрос проверяется, но не выполняется.

return_total_results_count

bool

Если это правда, общее количество результатов, соответствующих запросу, игнорирующему предложение LIMIT, будет включено в ответ. По умолчанию — ложь.

summary_row_setting

SummaryRowSetting

Определяет, будет ли возвращена сводная строка. По умолчанию сводная строка не возвращается. По запросу строка сводки будет отправлена ​​в ответе сама по себе после того, как будут возвращены все остальные результаты запроса.

ПоискSearchAds360Response

Ответное сообщение для SearchAds360Service.Search .

Поля
results[]

SearchAds360Row

Список строк, соответствующих запросу.

next_page_token

string

Токен нумерации страниц, используемый для получения следующей страницы результатов. Передайте содержимое этой строки в качестве атрибута page_token следующего запроса. next_page_token не возвращается для последней страницы.

total_results_count

int64

Общее количество результатов, соответствующих запросу, игнорирующему предложение LIMIT.

field_mask

FieldMask

FieldMask, указывающий, какие поля были запрошены пользователем.

summary_row

SearchAds360Row

Строка сводки, содержащая сводку показателей в результатах. Сводка показателей означает агрегирование показателей по всем результатам, здесь агрегирование может быть суммой, средним значением, частотой и т. д.

custom_column_headers[]

CustomColumnHeader

Заголовки специальных столбцов в результатах.

conversion_custom_metric_headers[]

ConversionCustomMetricHeader

Заголовки специальных показателей конверсий в результатах.

conversion_custom_dimension_headers[]

ConversionCustomDimensionHeader

Заголовки специальных параметров конверсии в результатах.

raw_event_conversion_metric_headers[]

RawEventConversionMetricHeader

Заголовки необработанных показателей конверсии событий в результатах.

raw_event_conversion_dimension_headers[]

RawEventConversionDimensionHeader

Заголовки параметров преобразования необработанных событий в результатах.

ПоискSearchAds360StreamRequest

Сообщение запроса для SearchAds360Service.SearchStream .

Поля
customer_id

string

Необходимый. Идентификатор запрашиваемого клиента.

query

string

Необходимый. Строка запроса.

batch_size

int32

Число строк, возвращаемых в каждом пакете ответов потока. Если запрошен слишком большой пакет, сервер может принять решение дополнительно ограничить количество возвращаемых строк.

summary_row_setting

SummaryRowSetting

Определяет, будет ли возвращена сводная строка. По умолчанию сводная строка не возвращается. По запросу строка сводки будет отправлена ​​в ответе сама по себе после того, как будут возвращены все остальные результаты запроса.

ПоискSearchAds360StreamResponse

Ответное сообщение для SearchAds360Service.SearchStream .

Поля
results[]

SearchAds360Row

Список строк, соответствующих запросу.

field_mask

FieldMask

FieldMask, указывающий, какие поля были запрошены пользователем.

summary_row

SearchAds360Row

Строка сводки, содержащая сводку показателей в результатах. Сводка показателей означает агрегирование показателей по всем результатам, здесь агрегирование может быть суммой, средним значением, частотой и т. д.

custom_column_headers[]

CustomColumnHeader

Заголовки специальных столбцов в результатах.

conversion_custom_metric_headers[]

ConversionCustomMetricHeader

Заголовки специальных показателей конверсий в результатах.

conversion_custom_dimension_headers[]

ConversionCustomDimensionHeader

Заголовки специального параметра конверсии в результатах.

raw_event_conversion_metric_headers[]

RawEventConversionMetricHeader

Заголовки необработанных показателей конверсии событий в результатах.

raw_event_conversion_dimension_headers[]

RawEventConversionDimensionHeader

Заголовки параметров преобразования необработанных событий в результатах.

request_id

string

Уникальный идентификатор запроса, который используется в целях отладки.