Package google.ads.searchads360.v0.services

Индекс

CustomColumnService

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

GetCustomColumn

rpc GetCustomColumn( GetCustomColumnRequest ) returns ( CustomColumn )

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

Области полномочий

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

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

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

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

GetSearchAds360Field

rpc GetSearchAds360Field( GetSearchAds360FieldRequest ) returns ( SearchAds360Field )

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

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

Области полномочий

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

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

rpc SearchSearchAds360Fields( SearchSearchAds360FieldsRequest ) returns ( SearchSearchAds360FieldsResponse )

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

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

Области полномочий

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

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

SearchAds360Service

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

Поиск

rpc Search( SearchSearchAds360Request ) returns ( SearchSearchAds360Response )

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

Список возникших ошибок: AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError HeaderError InternalError QueryError QuotaError RequestError

Области полномочий

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

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

rpc SearchStream( SearchSearchAds360StreamRequest ) returns ( SearchSearchAds360StreamResponse )

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

Список возникших ошибок: AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError 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

Значение true, если пользовательский столбец содержит ссылки на метрики.

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

Обязательно. Идентификатор клиента, к которому будет применена операция со списком пользовательских столбцов.

ListCustomColumnsResponse

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

Поля
custom_columns[]

CustomColumn

Пользовательские столбцы (CustomColumns) принадлежат указанному клиенту.

RawEventConversionDimensionHeader

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

Поля
id

int64

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

name

string

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

RawEventConversionMetricHeader

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

Поля
id

int64

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

name

string

Пользовательское имя метрики необработанного события.

SearchAds360Row

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

Поля
ad_group

AdGroup

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

ad_group_ad

AdGroupAd

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

ad_group_ad_effective_label

AdGroupAdEffectiveLabel

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

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_effective_label

AdGroupCriterionEffectiveLabel

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

ad_group_criterion_label

AdGroupCriterionLabel

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

ad_group_effective_label

AdGroupEffectiveLabel

Метка, обозначающая эффективную группу объявлений, указанная в запросе.

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_effective_label

CampaignEffectiveLabel

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

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

Ключевое слово view, на которое ссылается запрос.

label

Label

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

language_constant

LanguageConstant

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

location_view

LocationView

Вид местоположения, на который ссылается запрос.

product_bidding_category_constant

ProductBiddingCategoryConstant

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

product_group_view

ProductGroupView

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

shopping_performance_view

ShoppingPerformanceView

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

user_list

UserList

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

user_location_view

UserLocationView

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

webpage_view

WebpageView

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

visit

Visit

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

conversion

Conversion

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

metrics

Metrics

Показатели.

segments

Segments

Сегменты.

custom_columns[]

Value

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

SearchSearchAds360FieldsRequest

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

Поля
query

string

Обязательно. Строка запроса.

page_token

string

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

page_size

int32

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

SearchSearchAds360FieldsResponse

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

Поля
results[]

SearchAds360Field

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

next_page_token

string

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

total_results_count

int64

Общее количество результатов, соответствующих запросу, без учета условия LIMIT.

SearchSearchAds360Request

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

Поля
customer_id

string

Обязательно. Идентификатор клиента, к которому обращается запрос.

query

string

Обязательно. Строка запроса.

page_token

string

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

page_size

int32

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

validate_only

bool

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

return_total_results_count

bool

Если значение равно true, в ответ будет включено общее количество результатов, соответствующих запросу без учета условия LIMIT. Значение по умолчанию — false.

summary_row_setting

SummaryRowSetting

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

SearchSearchAds360Response

Ответное сообщение для 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

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

SearchSearchAds360StreamRequest

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

Поля
customer_id

string

Обязательно. Идентификатор клиента, к которому обращается запрос.

query

string

Обязательно. Строка запроса.

batch_size

int32

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

summary_row_setting

SummaryRowSetting

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

SearchSearchAds360StreamResponse

Ответное сообщение для 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

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