Package google.ads.searchads360.v0.resources

Индекс

Доступная стратегия торгов

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

В отличие от BiddingStrategy, этот ресурс включает стратегии, принадлежащие менеджерам клиента и предоставленные этому клиенту, в дополнение к стратегиям, принадлежащим этому клиенту. Этот ресурс не предоставляет метрики и предоставляет лишь ограниченное подмножество атрибутов BiddingStrategy.

Поля
resource_name

string

Имя ресурса доступной стратегии назначения ставок. Имена ресурсов AccessibleBiddingStrategy имеют следующий вид:

customers/{customer_id}/accessibleBiddingStrategies/{bidding_strategy_id}

id

int64

Идентификатор стратегии ставок.

name

string

Название стратегии торгов.

type

BiddingStrategyType

Тип стратегии торгов.

owner_customer_id

int64

Идентификатор клиента, которому принадлежит стратегия торгов.

owner_descriptive_name

string

descriptive_name Клиента, которому принадлежит стратегия торгов.

scheme поля Союза. Схема торгов.

Можно задать только одну схему. scheme может быть только одной из следующих:

maximize_conversion_value

MaximizeConversionValue

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

maximize_conversions

MaximizeConversions

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

target_cpa

TargetCpa

Стратегия назначения ставок, которая устанавливает ставки, помогающие получить как можно больше конверсий по заданной вами целевой цене за конверсию (CPA).

target_impression_share

TargetImpressionShare

Стратегия назначения ставок, которая автоматически оптимизируется до выбранного процента показов.

target_roas

TargetRoas

Стратегия назначения ставок, которая помогает вам максимизировать доход и при этом достигать определенного целевого показателя рентабельности инвестиций в рекламу (ROAS).

target_spend

TargetSpend

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

Максимизировать ценность конверсии

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

Поля
target_roas

double

Параметр «Целевая рентабельность инвестиций в рекламу» (ROAS). Если он установлен, стратегия назначения ставок будет максимизировать доход, одновременно усредняя целевую рентабельность инвестиций в рекламу. Если целевая рентабельность инвестиций в рекламу высока, стратегия назначения ставок может не позволить полностью освоить бюджет. Если целевая рентабельность инвестиций в рекламу не установлена, стратегия назначения ставок будет стремиться к достижению максимально возможной рентабельности инвестиций в рекламу в рамках бюджета.

Максимизироватьконверсии

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

Поля
target_cpa

int64

Целевая цена за привлечение (CPA). Это средняя сумма, которую вы готовы потратить на привлечение.

target_cpa_micros

int64

Целевая цена за привлечение (CPA). Это средняя сумма, которую вы готовы потратить на привлечение.

TargetCpa

Автоматизированная стратегия ставок, которая устанавливает ставки, помогающие получить максимально возможное количество конверсий по заданной вами целевой цене за конверсию (CPA).

Поля
target_cpa_micros

int64

Средняя целевая цена за конверсию (CPA). Эта целевая цена должна быть больше или равна минимальной платёжной единице в зависимости от валюты счёта.

TargetImpressionShare

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

Поля
location

TargetImpressionShareLocation

Целевое местоположение на странице результатов поиска.

location_fraction_micros

int64

Выбранная доля рекламы, которая будет показана в целевом месте, в микро. Например, 1% равен 10 000.

cpc_bid_ceiling_micros

int64

Максимальная цена за клик, которую может указать автоматизированная система назначения ставок. Это обязательное поле, которое заполняет рекламодатель, устанавливающий максимальную цену за клик, и указывается в локальных микро-коэффициентах.

TargetRoas

Автоматизированная стратегия назначения ставок, которая помогает вам максимизировать доход и при этом достигать определенной целевой рентабельности инвестиций в рекламу (ROAS).

Поля
target_roas

double

Выбранный доход (на основе данных о конверсиях) на единицу расходов.

TargetSpend

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

Поля
target_spend_micros
(deprecated)

int64

Целевой показатель расходов, ниже которого необходимо максимизировать количество кликов. Участник торгов TargetSpend попытается потратить меньшее из этих значений или суммы естественного ограничения расходов. Если не указано, в качестве целевого показателя расходов используется бюджет. Это поле устарело и больше не должно использоваться. Подробнее см. https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.html .

cpc_bid_ceiling_micros

int64

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

Реклама.

Поля
resource_name

string

Имя ресурса объявления. Имя ресурса объявления имеет вид:

customers/{customer_id}/ads/{ad_id}

final_urls[]

string

Список возможных конечных URL-адресов после всех кросс-доменных перенаправлений для объявления.

final_app_urls[]

FinalAppUrl

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

final_mobile_urls[]

string

Список возможных конечных мобильных URL-адресов после всех кросс-доменных перенаправлений для объявления.

type

AdType

Тип объявления.

id

int64

Идентификатор объявления.

tracking_url_template

string

Шаблон URL для построения URL-адреса отслеживания.

final_url_suffix

string

Суффикс, используемый при построении конечного URL.

display_url

string

URL-адрес, который отображается в описании объявления для некоторых форматов объявлений.

name

string

Название объявления. Используется только для его идентификации. Оно не обязательно должно быть уникальным и не влияет на показ объявления.

Поле ad_data . Информация, относящаяся к типу объявления. Необходимо задать только одно значение. ad_data может быть только одним из следующих:
text_ad

SearchAds360TextAdInfo

Подробная информация о текстовом объявлении.

expanded_text_ad

SearchAds360ExpandedTextAdInfo

Подробная информация о развернутом текстовом объявлении.

responsive_search_ad

SearchAds360ResponsiveSearchAdInfo

Подробная информация об адаптивной поисковой рекламе.

product_ad

SearchAds360ProductAdInfo

Подробная информация, касающаяся рекламы продукта.

expanded_dynamic_search_ad

SearchAds360ExpandedDynamicSearchAdInfo

Подробная информация о расширенном динамическом поисковом объявлении.

Группа объявлений

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

Поля
resource_name

string

Имя ресурса группы объявлений. Имя ресурса группы объявлений имеет следующий вид:

customers/{customer_id}/adGroups/{ad_group_id}

status

AdGroupStatus

Статус группы объявлений.

type

AdGroupType

Тип группы объявлений.

ad_rotation_mode

AdGroupAdRotationMode

Режим ротации объявлений группы.

creation_time

string

Временная метка создания этой группы объявлений. Временная метка указывается в часовом поясе клиента в формате «гггг-ММ-дд ЧЧ:мм:сс».

targeting_setting

TargetingSetting

Настройка для таргетинга связанных функций.

labels[]

string

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

effective_labels[]

string

Названия ресурсов эффективных меток, привязанных к данной группе объявлений. Эффективная метка — это метка, унаследованная или напрямую назначенная данной группе объявлений.

engine_id

string

Идентификатор группы объявлений во внешнем аккаунте поисковой системы. Это поле предназначено только для аккаунтов, отличных от Google Ads, например Yahoo Japan, Microsoft, Baidu и т. д. Для сущности Google Ads используйте "ad_group.id".

start_date

string

Дата начала показа рекламы в этой группе объявлений. По умолчанию показ группы объявлений начинается сейчас или в дату её начала, в зависимости от того, что наступит позже. Если это поле задано, показ группы объявлений начинается с начала указанной даты в часовом поясе клиента. Это поле доступно только для аккаунтов Microsoft Advertising и Facebook Gateway.

Формат: ГГГГ-ММ-ДД Пример: 2019-03-14

end_date

string

Дата окончания показа рекламы в группе объявлений. По умолчанию показ рекламы в группе объявлений заканчивается в дату окончания. Если это поле задано, показ рекламы в группе объявлений заканчивается в указанную дату в часовом поясе клиента. Это поле доступно только для аккаунтов Microsoft Advertising и Facebook Gateway.

Формат: ГГГГ-ММ-ДД Пример: 2019-03-14

language_code

string

Язык объявлений и ключевые слова в группе объявлений. Это поле доступно только для учётных записей Microsoft Advertising. Подробнее: https://docs.microsoft.com/en-us/advertising/guides/ad-languages?view=bingads-13#adlanguage

last_modified_time

string

Дата и время последнего изменения этой группы объявлений. Дата и время указаны в часовом поясе клиента в формате «гггг-ММ-дд ЧЧ:мм:сс.сссссс».

id

int64

Идентификатор группы объявлений.

name

string

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

Это поле обязательно для заполнения и не должно быть пустым при создании новых групп объявлений.

Он должен содержать менее 255 полноширинных символов UTF-8.

Он не должен содержать никаких нулевых символов (кодовая точка 0x0), символов перевода строки NL (кодовая точка 0xA) или возврата каретки (кодовая точка 0xD).

tracking_url_template

string

Шаблон URL для построения URL-адреса отслеживания.

cpc_bid_micros

int64

Максимальная ставка CPC (цена за клик).

engine_status

AdGroupEngineStatus

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

final_url_suffix

string

Шаблон URL для добавления параметров к конечному URL.

AdGroupAd

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

Поля
resource_name

string

Имя ресурса объявления. Имена ресурсов объявлений группы объявлений имеют следующий вид:

customers/{customer_id}/adGroupAds/{ad_group_id}~{ad_id}

status

AdGroupAdStatus

Статус объявления.

ad

Ad

Реклама.

creation_time

string

Метка времени создания объявления ad_group_ad. Дата и время указаны в часовом поясе клиента в формате «гггг-ММ-дд ЧЧ:мм:сс.сссссс».

labels[]

string

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

effective_labels[]

string

Названия ресурсов эффективных меток, прикреплённых к данному объявлению. Эффективная метка — это метка, унаследованная или напрямую назначенная данному объявлению.

engine_id

string

Идентификатор объявления во внешнем аккаунте поисковой системы. Это поле предназначено только для аккаунтов Search Ads 360, например Yahoo Japan, Microsoft, Baidu и т. д. Для объектов, не относящихся к Search Ads 360, используйте "ad_group_ad.ad.id".

engine_status

AdGroupAdEngineStatus

Дополнительный статус объявления во внешнем аккаунте поисковой системы. Возможные статусы (в зависимости от типа внешнего аккаунта) включают «активно», «подходит», «ожидает рассмотрения» и т. д.

last_modified_time

string

Дата и время последнего изменения объявления в этой группе объявлений. Дата и время указаны в часовом поясе клиента в формате «гггг-ММ-дд ЧЧ:мм:сс.сссссс».

AdGroupAdEffectiveLabel

Связь между объявлением группы объявлений и эффективной меткой. Эффективная метка — это метка, унаследованная или напрямую назначенная данному объявлению группы объявлений.

Поля
resource_name

string

Имя ресурса метки эффективности рекламы для группы объявлений. Имена ресурсов метки эффективности рекламы для группы объявлений имеют следующий вид: customers/{owner_customer_id}/adGroupAdEffectiveLabels/{ad_group_id}~{ad_id}~{label_id}

ad_group_ad

string

Группа объявлений, к которой прикреплена эффективная метка.

label

string

Эффективная метка, присвоенная группе объявлений.

owner_customer_id

int64

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

AdGroupAdLabel

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

Поля
resource_name

string

Имя ресурса метки объявления группы объявлений. Имена ресурсов метки объявления группы объявлений имеют следующий вид: customers/{owner_customer_id}/adGroupAdLabels/{ad_group_id}~{ad_id}~{label_id}

ad_group_ad

string

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

label

string

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

owner_customer_id

int64

Идентификатор клиента, которому принадлежит этикетка.

AdGroupAsset

Связь между группой объявлений и активом.

Поля
resource_name

string

Имя ресурса группы объявлений. Имена ресурсов AdGroupAsset имеют следующий вид:

customers/{customer_id}/adGroupAssets/{ad_group_id}~{asset_id}~{field_type}

ad_group

string

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

asset

string

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

status

AssetLinkStatus

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

AdGroupAssetSet

AdGroupAssetSet — это связь между группой объявлений и набором объектов. Создание AdGroupAssetSet связывает набор объектов с группой объявлений.

Поля
resource_name

string

Имя ресурса набора активов группы объявлений. Имена ресурсов набора активов группы объявлений имеют следующий вид:

customers/{customer_id}/adGroupAssetSets/{ad_group_id}~{asset_set_id}

ad_group

string

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

asset_set

string

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

status

AssetSetLinkStatus

Статус набора активов группы объявлений. Только для чтения.

AdGroupAudienceView

Представление аудитории группы объявлений. Включает данные об эффективности из интересов и списков ремаркетинга для контекстно-медийной сети и YouTube, а также списков ремаркетинга для поисковой рекламы (RLSA), агрегированные на уровне аудитории.

Поля
resource_name

string

Имя ресурса представления аудитории группы объявлений. Имена ресурсов представления аудитории группы объявлений имеют следующий вид:

customers/{customer_id}/adGroupAudienceViews/{ad_group_id}~{criterion_id}

AdGroupBidModifier

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

Поля
resource_name

string

Имя ресурса модификатора ставок для группы объявлений. Имена ресурсов модификатора ставок для группы объявлений имеют следующий вид:

customers/{customer_id}/adGroupBidModifiers/{ad_group_id}~{criterion_id}

bid_modifier

double

Модификатор ставки при соответствии критерию. Диапазон модификатора: 0,1–10,0. Для PreferredContent диапазон составляет 1,0–6,0. Значение 0 используется для отказа от типа устройства.

criterion поля объединения. Критерий модификатора ставки для этой группы объявлений.

Требуется в операциях создания, начиная с версии V5. criterion может быть только одним из следующих:

device

DeviceInfo

Критерий устройства.

AdGroupCriterion

Критерий группы объявлений. Отчёт ad_group_criterion возвращает только критерии, которые были явно добавлены в группу объявлений.

Поля
resource_name

string

Имя ресурса критерия группы объявлений. Имена ресурсов критерия группы объявлений имеют следующий вид:

customers/{customer_id}/adGroupCriteria/{ad_group_id}~{criterion_id}

creation_time

string

Временная метка создания критерия группы объявлений. Временная метка указывается в часовом поясе клиента в формате «гггг-ММ-дд ЧЧ:мм:сс».

status

AdGroupCriterionStatus

Статус критерия.

Это статус сущности критерия группы объявлений, установленный клиентом. Примечание: отчёты пользовательского интерфейса могут содержать дополнительную информацию, влияющую на возможность показа критерия. В некоторых случаях критерий, УДАЛЁННЫЙ в API, может по-прежнему отображаться в пользовательском интерфейсе как включённый. Например, кампании по умолчанию показываются пользователям всех возрастных групп, если не исключены. В пользовательском интерфейсе каждая возрастная группа будет отображаться как «включённая», поскольку пользователи имеют право на просмотр рекламы; но AdGroupCriterion.status будет отображаться как «удалённая», поскольку положительный критерий не был добавлен.

quality_info

QualityInfo

Информация о качестве критерия.

type

CriterionType

Тип критерия.

labels[]

string

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

effective_labels[]

string

Названия ресурсов эффективных меток, привязанных к данному критерию группы объявлений. Эффективная метка — это метка, унаследованная или напрямую назначенная данному критерию группы объявлений.

position_estimates

PositionEstimates

Оценки критериальных ставок на различных позициях.

final_urls[]

string

Список возможных конечных URL-адресов после всех кросс-доменных перенаправлений для объявления.

final_mobile_urls[]

string

Список возможных конечных мобильных URL-адресов после всех кросс-доменных перенаправлений.

url_custom_parameters[]

CustomParameter

Список сопоставлений, используемых для замены пользовательских тегов параметров в tracking_url_template , final_urls или mobile_final_urls .

engine_id

string

Идентификатор критерия группы объявлений во внешнем аккаунте поисковой системы. Это поле предназначено только для аккаунтов, отличных от Google Ads, например Yahoo Japan, Microsoft, Baidu и т. д. Для сущности Google Ads используйте вместо него "ad_group_criterion.criterion_id".

last_modified_time

string

Дата и время последнего изменения критерия группы объявлений. Дата и время указаны в часовом поясе клиента в формате «гггг-ММ-дд ЧЧ:мм:сс.сссссс».

criterion_id

int64

Идентификатор критерия.

ad_group

string

Группа объявлений, к которой принадлежит критерий.

negative

bool

Следует ли применять ( false ) или исключать ( true ) критерий.

Это поле неизменяемо. Чтобы изменить критерий с положительного на отрицательный, удалите его и добавьте заново.

bid_modifier

double

Модификатор ставки при соответствии критерию. Модификатор должен находиться в диапазоне от 0,1 до 10,0. Большинство критериев таргетинга поддерживают модификаторы.

cpc_bid_micros

int64

Ставка CPC (цена за клик).

effective_cpc_bid_micros

int64

Эффективная ставка CPC (цена за клик).

engine_status

AdGroupCriterionEngineStatus

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

final_url_suffix

string

Шаблон URL для добавления параметров к конечному URL.

tracking_url_template

string

Шаблон URL для построения URL-адреса отслеживания.

criterion поля объединения. Критерий группы объявлений.

Необходимо установить только один критерий. criterion может быть только одним из следующих:

keyword

KeywordInfo

Ключевое слово.

listing_group

ListingGroupInfo

Группа листинга.

age_range

AgeRangeInfo

Возрастной диапазон.

gender

GenderInfo

Пол.

user_list

UserListInfo

Список пользователей.

webpage

WebpageInfo

Веб-страница

location

LocationInfo

Расположение.

PositionEstimates

Оценки критериальных ставок на различных позициях.

Поля
top_of_page_cpc_micros

int64

Расчетная ставка CPC, необходимая для показа объявления в верхней части первой страницы результатов поиска.

QualityInfo

Контейнер для информации о качестве критериев группы объявлений.

Поля
quality_score

int32

Показатель качества.

Это поле может быть не заполнено, если у Google недостаточно информации для определения значения.

AdGroupCriterionEffectiveLabel

Связь между критерием группы объявлений и эффективной меткой. Эффективная метка — это метка, унаследованная или напрямую назначенная данному критерию группы объявлений.

Поля
resource_name

string

Имя ресурса эффективной метки критерия группы объявлений. Имена ресурсов эффективной метки критерия группы объявлений имеют следующий вид: customers/{owner_customer_id}/adGroupCriterionEffectiveLabels/{ad_group_id}~{criterion_id}~{label_id}

ad_group_criterion

string

Критерий группы объявлений, к которому прикреплена эффективная метка.

label

string

Эффективная метка, присвоенная критерию группы объявлений.

owner_customer_id

int64

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

AdGroupCriterionLabel

Связь между критерием группы объявлений и меткой.

Поля
resource_name

string

Имя ресурса метки критерия группы объявлений. Имена ресурсов метки критерия группы объявлений имеют следующий вид: customers/{owner_customer_id}/adGroupCriterionLabels/{ad_group_id}~{criterion_id}~{label_id}

ad_group_criterion

string

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

label

string

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

owner_customer_id

int64

Идентификатор клиента, которому принадлежит этикетка.

AdGroupEffectiveLabel

Связь между группой объявлений и эффективной меткой. Эффективная метка — это метка, унаследованная или напрямую назначенная данной группе объявлений.

Поля
resource_name

string

Имя ресурса эффективной метки группы объявлений. Имена ресурсов эффективной метки группы объявлений имеют следующий вид: customers/{owner_customer_id}/adGroupEffectiveLabels/{ad_group_id}~{label_id}

ad_group

string

Группа объявлений, к которой прикреплена эффективная метка.

label

string

Эффективная метка, присвоенная группе объявлений.

owner_customer_id

int64

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

AdGroupLabel

Связь между группой объявлений и меткой.

Поля
resource_name

string

Имя ресурса метки группы объявлений. Имена ресурсов метки группы объявлений имеют вид: customers/{owner_customer_id}/adGroupLabels/{ad_group_id}~{label_id}

ad_group

string

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

label

string

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

owner_customer_id

int64

Идентификатор клиента, которому принадлежит этикетка.

AgeRangeView

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

Поля
resource_name

string

Имя ресурса представления возрастного диапазона. Имена ресурсов представления возрастного диапазона имеют следующий вид:

customers/{customer_id}/ageRangeViews/{ad_group_id}~{criterion_id}

Объект

Ресурс — это часть рекламного объявления, которая может использоваться несколькими рекламными материалами. Это может быть изображение (ImageAsset), видео (YoutubeVideoAsset) и т. д. Ресурсы неизменяемы и не могут быть удалены. Чтобы остановить показ ресурса, удалите его из объекта, который его использует.

Поля
resource_name

string

Имя ресурса актива. Имена ресурсов актива имеют следующий вид:

customers/{customer_id}/assets/{asset_id}

type

AssetType

Тип актива.

final_urls[]

string

Список возможных конечных URL-адресов после всех кросс-доменных перенаправлений.

final_mobile_urls[]

string

Список возможных конечных мобильных URL-адресов после всех кросс-доменных перенаправлений.

url_custom_parameters[]

CustomParameter

Список сопоставлений, которые следует использовать для замены тегов пользовательских параметров URL в tracking_url_template, final_urls и/или final_mobile_urls.

status

AssetStatus

Статус актива.

creation_time

string

Временная метка создания этого актива. Временная метка указывается в часовом поясе клиента в формате «гггг-ММ-дд ЧЧ:мм:сс».

last_modified_time

string

Дата и время последнего изменения этого актива. Дата и время указаны в часовом поясе клиента в формате «гггг-ММ-дд ЧЧ:мм:сс.сссссс».

id

int64

Идентификатор актива.

name

string

Необязательное имя актива.

tracking_url_template

string

Шаблон URL для построения URL-адреса отслеживания.

final_url_suffix

string

Шаблон URL для добавления параметров к URL-адресам целевых страниц, обслуживаемых параллельным отслеживанием.

engine_status

AssetEngineStatus

Статус двигателя для актива.

Объединенное поле asset_data . Конкретный тип актива asset_data может быть только одним из следующих:
youtube_video_asset

YoutubeVideoAsset

Видеоматериал YouTube.

image_asset

ImageAsset

Имиджевый актив.

text_asset

TextAsset

Текстовый актив.

callout_asset

UnifiedCalloutAsset

Унифицированный актив выноски.

page_feed_asset

UnifiedPageFeedAsset

Унифицированный ресурс подачи страниц.

mobile_app_asset

MobileAppAsset

Актив мобильного приложения.

call_asset

UnifiedCallAsset

Единый актив вызова.

call_to_action_asset

CallToActionAsset

Актив призыва к действию.

location_asset

UnifiedLocationAsset

Единый локационный актив.

AssetGroup

Группа активов. AssetGroupAsset используется для привязки актива к группе активов. AssetGroupSignal используется для привязки сигнала к группе активов.

Поля
resource_name

string

Имя ресурса группы активов. Имена ресурсов группы активов имеют следующий вид:

customers/{customer_id}/assetGroups/{asset_group_id}

id

int64

Идентификатор группы активов.

campaign

string

Кампания, с которой связана эта группа активов. Актив, связанный с группой активов.

name

string

Обязательно. Название группы активов. Обязательно. Длина имени должна быть не менее 1 и не более 128 символов. Имя должно быть уникальным в рамках кампании.

final_urls[]

string

Список конечных URL после всех междоменных перенаправлений. В режиме максимальной производительности URL-адреса по умолчанию могут быть расширены, если не указано иное.

final_mobile_urls[]

string

Список конечных мобильных URL после всех кроссдоменных перенаправлений. В режиме максимальной производительности URL-адреса по умолчанию доступны для расширения, если не указано иное.

status

AssetGroupStatus

Статус группы активов.

path1

string

Первая часть текста, которая может быть добавлена ​​к URL-адресу, отображаемому в объявлении.

path2

string

Вторая часть текста, которая может быть добавлена ​​к URL-адресу, отображаемому в объявлении. Это поле можно заполнить только при указании path1.

ad_strength

AdStrength

Общая эффективность рекламы этой группы активов.

AssetGroupAsset

AssetGroupAsset — это связующее звено между активом и группой активов. Добавление AssetGroupAsset связывает актив с группой активов.

Поля
resource_name

string

Имя ресурса группы активов. Имя ресурса группы активов имеет следующий вид:

customers/{customer_id}/assetGroupAssets/{asset_group_id}~{asset_id}~{field_type}

asset_group

string

Группа активов, с которой связан данный актив группы активов.

asset

string

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

field_type

AssetFieldType

Описание размещения актива в группе активов. Например: HEADLINE, YOUTUBE_VIDEO и т. д.

status

AssetLinkStatus

Статус связи между активом и группой активов.

AssetGroupAssetCombinationData

Данные о сочетании активов группы активов

Поля
asset_combination_served_assets[]

AssetUsage

Обслуживаемые активы.

AssetGroupListingGroupFilter

AssetGroupListingGroupFilter представляет собой узел дерева фильтров группы листинга в группе активов.

Поля
resource_name

string

Имя ресурса фильтра группы активов. Имя ресурса фильтра группы активов имеет следующий вид:

customers/{customer_id}/assetGroupListingGroupFilters/{asset_group_id}~{listing_group_filter_id}

asset_group

string

Группа активов, к которой принадлежит данный фильтр списка групп активов.

id

int64

Идентификатор ListingGroupFilter.

type

ListingGroupFilterType

Тип узла фильтра группы листинга.

vertical

ListingGroupFilterVertical

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

case_value

ListingGroupFilterDimension

Значение параметра, с помощью которого эта группа листинга уточняет свою родительскую группу. Не определено для корневой группы.

parent_listing_group_filter

string

Имя ресурса родительского подразделения группы листинга. Значение NULL для корневого узла фильтра группы листинга.

path

ListingGroupFilterDimensionPath

Путь измерений, определяющих этот фильтр группы листинга.

AssetGroupSignal

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

Поля
resource_name

string

Имя ресурса сигнала группы активов. Имя ресурса сигнала группы активов имеет следующий вид:

customers/{customer_id}/assetGroupSignals/{asset_group_id}~{signal_id}

asset_group

string

Группа активов, к которой принадлежит данный сигнал группы активов.

signal поля объединения. Сигнал группы активов. signal может быть только одним из следующих:
audience

AudienceInfo

Сигнал аудитории, который будет использоваться в кампании с максимальной эффективностью.

AssetGroupTopCombinationView

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

Поля
resource_name

string

Имя ресурса представления верхней комбинации группы активов. Имена ресурсов представления верхней комбинации группы активов имеют следующий вид: `"customers/{customer_id}/assetGroupTopCombinationViews/{asset_group_id}~{asset_combination_category}"

asset_group_top_combinations[]

AssetGroupAssetCombinationData

Лучшие комбинации активов, которые работали вместе.

AssetSet

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

Поля
id

int64

Идентификатор набора активов.

resource_name

string

Имя ресурса набора активов. Имена ресурсов набора активов имеют следующий вид:

customers/{customer_id}/assetSets/{asset_set_id}

AssetSetAsset

AssetSetAsset — это связующее звено между активом и набором активов. Добавление AssetSetAsset связывает актив с набором активов.

Поля
resource_name

string

Имя ресурса набора активов. Имена ресурсов набора активов имеют следующий вид:

customers/{customer_id}/assetSetAssets/{asset_set_id}~{asset_id}

asset_set

string

Набор активов, с которым связан данный набор активов.

asset

string

Актив, с которым связан данный набор активов.

status

AssetSetAssetStatus

Статус актива набора активов. Только для чтения.

Аудитория

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

Поля
resource_name

string

Имя ресурса аудитории. Имя аудитории имеет вид:

customers/{customer_id}/audiences/{audience_id}

id

int64

Идентификатор аудитории.

name

string

Обязательно. Название аудитории. Оно должно быть уникальным для всех аудиторий. Длина имени должна быть не менее 1 и не более 255 символов.

description

string

Описание этой аудитории.

BiddingStrategy

Стратегия торгов.

Поля
resource_name

string

Имя ресурса стратегии торгов. Имена ресурсов стратегии торгов имеют следующий вид:

customers/{customer_id}/biddingStrategies/{bidding_strategy_id}

status

BiddingStrategyStatus

Статус стратегии торгов.

Это поле доступно только для чтения.

type

BiddingStrategyType

Тип стратегии торгов. Создайте стратегию торгов, установив схему торгов.

Это поле доступно только для чтения.

currency_code

string

Валюта, используемая стратегией торгов (трехбуквенный код ISO 4217).

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

id

int64

Идентификатор стратегии ставок.

name

string

Название стратегии ставок. Все стратегии ставок в рамках аккаунта должны иметь чёткие названия.

Длина этой строки должна быть от 1 до 255 включительно в байтах UTF-8 (обрезанных).

effective_currency_code

string

Валюта, используемая стратегией торгов (трехбуквенный код ISO 4217).

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

Показатели стратегии назначения ставок отображаются в этой валюте.

Это поле доступно только для чтения.

campaign_count

int64

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

Это поле доступно только для чтения.

non_removed_campaign_count

int64

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

Это поле доступно только для чтения.

scheme поля Союза. Схема торгов.

Можно задать только одну схему. scheme может быть только одной из следующих:

enhanced_cpc

EnhancedCpc

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

maximize_conversion_value

MaximizeConversionValue

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

maximize_conversions

MaximizeConversions

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

target_cpa

TargetCpa

Стратегия назначения ставок, которая устанавливает ставки, помогающие получить как можно больше конверсий по заданной вами целевой цене за конверсию (CPA).

target_impression_share

TargetImpressionShare

Стратегия назначения ставок, которая автоматически оптимизируется до выбранного процента показов.

target_outrank_share

TargetOutrankShare

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

target_roas

TargetRoas

Стратегия назначения ставок, которая помогает вам максимизировать доход и при этом достигать определенного целевого показателя рентабельности инвестиций в рекламу (ROAS).

target_spend

TargetSpend

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

Кампания

Кампания.

Поля
resource_name

string

Имя ресурса кампании. Имя ресурса кампании имеет следующий вид:

customers/{customer_id}/campaigns/{campaign_id}

status

CampaignStatus

Статус кампании.

При добавлении новой кампании статус по умолчанию — ВКЛЮЧЕНО.

serving_status

CampaignServingStatus

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

bidding_strategy_system_status

BiddingStrategySystemStatus

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

ad_serving_optimization_status

AdServingOptimizationStatus

Статус оптимизации показа рекламы в кампании.

advertising_channel_type

AdvertisingChannelType

Основная цель показа рекламы в рамках кампании. Параметры таргетинга можно настроить в network_settings .

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

Можно задать только при создании кампаний. После создания кампании поле изменить нельзя.

advertising_channel_sub_type

AdvertisingChannelSubType

Необязательное уточнение для advertising_channel_type . Должен быть допустимым подтипом родительского типа канала.

Можно задать только при создании кампаний. После создания кампании поле изменить нельзя.

url_custom_parameters[]

CustomParameter

Список сопоставлений, используемых для замены пользовательских тегов параметров в tracking_url_template , final_urls или mobile_final_urls .

real_time_bidding_setting

RealTimeBiddingSetting

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

network_settings

NetworkSettings

Сетевые настройки кампании.

dynamic_search_ads_setting

DynamicSearchAdsSetting

Настройка управления динамическими поисковыми объявлениями (DSA).

shopping_setting

ShoppingSetting

Настройка управления торговыми кампаниями.

geo_target_type_setting

GeoTargetTypeSetting

Настройка геотаргетинга рекламы.

effective_labels[]

string

Названия ресурсов эффективных меток, привязанных к этой кампании. Эффективная метка — это метка, унаследованная или напрямую назначенная этой кампании.

labels[]

string

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

bidding_strategy_type

BiddingStrategyType

Тип стратегии торгов.

Стратегию торгов можно создать, установив либо схему торгов для создания стандартной стратегии торгов, либо поле bidding_strategy для создания портфельной стратегии торгов.

Это поле доступно только для чтения.

accessible_bidding_strategy

string

Имя ресурса AccessibleBiddingStrategy, доступного только для чтения, содержит неограниченные атрибуты прикреплённой стратегии портфеля ставок, идентифицированной как «bidding_strategy». Пусто, если в кампании не используется стратегия портфеля. Неограниченные атрибуты стратегии доступны всем клиентам, которым предоставлен общий доступ к стратегии, и считываются из ресурса AccessibleBiddingStrategy. В отличие от этого, ограниченные атрибуты доступны только владельцу стратегии и его менеджерам. Ограниченные атрибуты можно считывать только из ресурса BiddingStrategy.

frequency_caps[]

FrequencyCapEntry

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

selective_optimization

SelectiveOptimization

Выборочная настройка оптимизации для этой кампании, включающая набор действий для конверсии, которые можно оптимизировать в рамках этой кампании. Эта функция применима только к кампаниям для приложений, в которых в качестве AdvertisingChannelType используется MULTI_CHANNEL, а в качестве AdvertisingChannelSubType — APP_CAMPAIGN или APP_CAMPAIGN_FOR_ENGAGEMENT.

optimization_goal_setting

OptimizationGoalSetting

Настройка целей оптимизации для этой кампании, которая включает набор типов целей оптимизации.

tracking_setting

TrackingSetting

Настройки на уровне кампании для отслеживания информации.

engine_id

string

Идентификатор кампании во внешнем аккаунте поисковой системы. Это поле предназначено только для аккаунтов, отличных от Google Ads, например Yahoo Japan, Microsoft, Baidu и т. д. Для объекта Google Ads используйте "campaign.id".

excluded_parent_asset_field_types[]

AssetFieldType

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

create_time

string

Временная метка создания этой кампании. Временная метка указывается в часовом поясе клиента в формате «гггг-ММ-дд ЧЧ:мм:сс». Функция create_time будет устарела в версии 1. Вместо неё используйте creation_time.

creation_time

string

Временная метка создания этой кампании. Временная метка указывается в часовом поясе клиента в формате «гггг-ММ-дд ЧЧ:мм:сс».

last_modified_time

string

Дата и время последнего изменения этой кампании. Дата и время указаны в часовом поясе клиента в формате «гггг-ММ-дд ЧЧ:мм:сс.сссссс».

feed_types[]

AssetSetType

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

id

int64

Идентификатор кампании.

name

string

Название кампании.

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

Он не должен содержать никаких нулевых символов (кодовая точка 0x0), символов перевода строки NL (кодовая точка 0xA) или возврата каретки (кодовая точка 0xD).

tracking_url_template

string

The URL template for constructing a tracking URL.

campaign_budget

string

The resource name of the campaign budget of the campaign.

start_date

string

The date when campaign started in serving customer's timezone in YYYY-MM-DD format.

end_date

string

The last day of the campaign in serving customer's timezone in YYYY-MM-DD format. On create, defaults to 2037-12-30, which means the campaign will run indefinitely. To set an existing campaign to run indefinitely, set this field to 2037-12-30.

final_url_suffix

string

Suffix used to append query parameters to landing pages that are served with parallel tracking.

url_expansion_opt_out

bool

Represents opting out of URL expansion to more targeted URLs. If opted out (true), only the final URLs in the asset group or URLs specified in the advertiser's Google Merchant Center or business data feeds are targeted. If opted in (false), the entire domain will be targeted. This field can only be set for Performance Max campaigns, where the default value is false.

Union field campaign_bidding_strategy . The bidding strategy for the campaign.

Must be either portfolio (created through BiddingStrategy service) or standard, that is embedded into the campaign. campaign_bidding_strategy can be only one of the following:

bidding_strategy

string

The resource name of the portfolio bidding strategy used by the campaign.

manual_cpa

ManualCpa

Standard Manual CPA bidding strategy. Manual bidding strategy that allows advertiser to set the bid per advertiser-specified action. Supported only for Local Services campaigns.

manual_cpc

ManualCpc

Standard Manual CPC bidding strategy. Manual click-based bidding where user pays per click.

manual_cpm

ManualCpm

Standard Manual CPM bidding strategy. Manual impression-based bidding where user pays per thousand impressions.

maximize_conversions

MaximizeConversions

Standard Maximize Conversions bidding strategy that automatically maximizes number of conversions while spending your budget.

maximize_conversion_value

MaximizeConversionValue

Standard Maximize Conversion Value bidding strategy that automatically sets bids to maximize revenue while spending your budget.

target_cpa

TargetCpa

Standard Target CPA bidding strategy that automatically sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set.

target_impression_share

TargetImpressionShare

Target Impression Share bidding strategy. An automated bidding strategy that sets bids to achieve a chosen percentage of impressions.

target_roas

TargetRoas

Standard Target ROAS bidding strategy that automatically maximizes revenue while averaging a specific target return on ad spend (ROAS).

target_spend

TargetSpend

Standard Target Spend bidding strategy that automatically sets your bids to help get as many clicks as possible within your budget.

percent_cpc

PercentCpc

Standard Percent Cpc bidding strategy where bids are a fraction of the advertised price for some good or service.

target_cpm

TargetCpm

A bidding strategy that automatically optimizes cost per thousand impressions.

DynamicSearchAdsSetting

The setting for controlling Dynamic Search Ads (DSA).

Поля
domain_name

string

Required. The Internet domain name that this setting represents, for example, "google.com" or "www.google.com".

language_code

string

Required. The language code specifying the language of the domain, for example, "en".

use_supplied_urls_only

bool

Whether the campaign uses advertiser supplied URLs exclusively.

GeoTargetTypeSetting

Represents a collection of settings related to ads geotargeting.

Поля
positive_geo_target_type

PositiveGeoTargetType

The setting used for positive geotargeting in this particular campaign.

negative_geo_target_type

NegativeGeoTargetType

The setting used for negative geotargeting in this particular campaign.

NetworkSettings

The network settings for the campaign.

Поля
target_search_network

bool

Whether ads will be served on partner sites in the Google Search Network (requires target_google_search to also be true ).

target_content_network

bool

Whether ads will be served on specified placements in the Google Display Network. Placements are specified using the Placement criterion.

target_partner_search_network

bool

Whether ads will be served on the Google Partner Network. This is available only to some select Google partner accounts.

OptimizationGoalSetting

Optimization goal setting for this campaign, which includes a set of optimization goal types.

Поля
optimization_goal_types[]

OptimizationGoalType

The list of optimization goal types.

SelectiveOptimization

Selective optimization setting for this campaign, which includes a set of conversion actions to optimize this campaign towards. This feature only applies to app campaigns that use MULTI_CHANNEL as AdvertisingChannelType and APP_CAMPAIGN or APP_CAMPAIGN_FOR_ENGAGEMENT as AdvertisingChannelSubType.

Поля
conversion_actions[]

string

The selected set of resource names for conversion actions for optimizing this campaign.

ShoppingSetting

The setting for Shopping campaigns. Defines the universe of products that can be advertised by the campaign, and how this campaign interacts with other Shopping campaigns.

Поля
feed_label

string

Feed label of products to include in the campaign. Only one of feed_label or sales_country can be set. If used instead of sales_country, the feed_label field accepts country codes in the same format for example: 'XX'. Otherwise can be any string used for feed label in Google Merchant Center.

use_vehicle_inventory

bool

Whether to target Vehicle Listing inventory.

merchant_id

int64

ID of the Merchant Center account. This field is required for create operations. This field is immutable for Shopping campaigns.

sales_country

string

Sales country of products to include in the campaign.

campaign_priority

int32

Priority of the campaign. Campaigns with numerically higher priorities take precedence over those with lower priorities. This field is required for Shopping campaigns, with values between 0 and 2, inclusive. This field is optional for Smart Shopping campaigns, but must be equal to 3 if set.

enable_local

bool

Whether to include local products.

TrackingSetting

Campaign-level settings for tracking information.

Поля
tracking_url

string

The url used for dynamic tracking.

CampaignAsset

A link between a Campaign and an Asset.

Поля
resource_name

string

The resource name of the campaign asset. CampaignAsset resource names have the form:

customers/{customer_id}/campaignAssets/{campaign_id}~{asset_id}~{field_type}

status

AssetLinkStatus

Status of the campaign asset.

campaign

string

The campaign to which the asset is linked.

asset

string

The asset which is linked to the campaign.

CampaignAssetSet

CampaignAssetSet is the linkage between a campaign and an asset set. Adding a CampaignAssetSet links an asset set with a campaign.

Поля
resource_name

string

The resource name of the campaign asset set. Asset set asset resource names have the form:

customers/{customer_id}/campaignAssetSets/{campaign_id}~{asset_set_id}

campaign

string

The campaign to which this asset set is linked.

asset_set

string

The asset set which is linked to the campaign.

status

AssetSetLinkStatus

The status of the campaign asset set asset. Read-only.

CampaignAudienceView

A campaign audience view. Includes performance data from interests and remarketing lists for Display Network and YouTube Network ads, and remarketing lists for search ads (RLSA), aggregated by campaign and audience criterion. This view only includes audiences attached at the campaign level.

Поля
resource_name

string

The resource name of the campaign audience view. Campaign audience view resource names have the form:

customers/{customer_id}/campaignAudienceViews/{campaign_id}~{criterion_id}

CampaignBudget

A campaign budget.

Поля
resource_name

string

The resource name of the campaign budget. Campaign budget resource names have the form:

customers/{customer_id}/campaignBudgets/{campaign_budget_id}

delivery_method

BudgetDeliveryMethod

The delivery method that determines the rate at which the campaign budget is spent.

Defaults to STANDARD if unspecified in a create operation.

period

BudgetPeriod

Period over which to spend the budget. Defaults to DAILY if not specified.

amount_micros

int64

The amount of the budget, in the local currency for the account. Amount is specified in micros, where one million is equivalent to one currency unit. Monthly spend is capped at 30.4 times this amount.

CampaignCriterion

A campaign criterion.

Поля
resource_name

string

The resource name of the campaign criterion. Campaign criterion resource names have the form:

customers/{customer_id}/campaignCriteria/{campaign_id}~{criterion_id}

display_name

string

The display name of the criterion.

This field is ignored for mutates.

type

CriterionType

The type of the criterion.

status

CampaignCriterionStatus

The status of the criterion.

last_modified_time

string

The datetime when this campaign criterion was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.

criterion_id

int64

The ID of the criterion.

This field is ignored during mutate.

bid_modifier

float

The modifier for the bids when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Most targetable criteria types support modifiers. Use 0 to opt out of a Device type.

negative

bool

Whether to target ( false ) or exclude ( true ) the criterion.

Union field criterion . The campaign criterion.

Exactly one must be set. criterion can be only one of the following:

keyword

KeywordInfo

Ключевое слово.

location

LocationInfo

Расположение.

device

DeviceInfo

Устройство.

age_range

AgeRangeInfo

Age range.

gender

GenderInfo

Пол.

user_list

UserListInfo

User List.

language

LanguageInfo

Язык.

webpage

WebpageInfo

Веб-страница.

location_group

LocationGroupInfo

Location Group

CampaignEffectiveLabel

Represents a relationship between a campaign and an effective label. An effective label is a label inherited or directly assigned to this campaign.

Поля
resource_name

string

Name of the resource. CampaignEffectivelabel resource names have the form: customers/{owner_customer_id}/campaignEffectiveLabels/{campaign_id}~{label_id}

campaign

string

The campaign to which the effective label is attached.

label

string

The effective label assigned to the campaign.

owner_customer_id

int64

The ID of the Customer which owns the effective label.

CampaignLabel

Represents a relationship between a campaign and a label.

Поля
resource_name

string

Name of the resource. Campaign label resource names have the form: customers/{owner_customer_id}/campaignLabels/{campaign_id}~{label_id}

campaign

string

The campaign to which the label is attached.

label

string

The label assigned to the campaign.

owner_customer_id

int64

The ID of the Customer which owns the label.

CartDataSalesView

Cart data sales view.

Поля
resource_name

string

The resource name of the Cart data sales view. Cart data sales view resource names have the form: customers/{customer_id}/cartDataSalesView

Конверсия

A conversion.

Поля
resource_name

string

The resource name of the conversion. Conversion resource names have the form:

customers/{customer_id}/conversions/{ad_group_id}~{criterion_id}~{ds_conversion_id}

id

int64

The ID of the conversion

criterion_id

int64

Search Ads 360 criterion ID. A value of 0 indicates that the criterion is unattributed.

merchant_id

int64

The Search Ads 360 inventory account ID containing the product that was clicked on. Search Ads 360 generates this ID when you link an inventory account in Search Ads 360.

ad_id

int64

Ad ID. A value of 0 indicates that the ad is unattributed.

click_id

string

A unique string, for the visit that the conversion is attributed to, that is passed to the landing page as the click id URL parameter.

visit_id

int64

The Search Ads 360 visit ID that the conversion is attributed to.

advertiser_conversion_id

string

For offline conversions, this is an ID provided by advertisers. If an advertiser doesn't specify such an ID, Search Ads 360 generates one. For online conversions, this is equal to the id column or the floodlight_order_id column depending on the advertiser's Floodlight instructions.

product_id

string

The ID of the product clicked on.

product_channel

ProductChannel

The sales channel of the product that was clicked on: Online or Local.

product_language_code

string

The language (ISO-639-1) that has been set for the Merchant Center feed containing data about the product.

product_store_id

string

The store in the Local Inventory Ad that was clicked on. This should match the store IDs used in your local products feed.

product_country_code

string

The country (ISO-3166-format) registered for the inventory feed that contains the product clicked on.

attribution_type

AttributionType

What the conversion is attributed to: Visit or Keyword+Ad.

conversion_date_time

string

The timestamp of the conversion event.

conversion_last_modified_date_time

string

The timestamp of the last time the conversion was modified.

conversion_visit_date_time

string

The timestamp of the visit that the conversion is attributed to.

conversion_quantity

int64

The quantity of items recorded by the conversion, as determined by the qty url parameter. The advertiser is responsible for dynamically populating the parameter (such as number of items sold in the conversion), otherwise it defaults to 1.

conversion_revenue_micros

int64

The adjusted revenue in micros for the conversion event. This will always be in the currency of the serving account.

floodlight_original_revenue

int64

The original, unchanged revenue associated with the Floodlight event (in the currency of the current report), before Floodlight currency instruction modifications.

floodlight_order_id

string

The Floodlight order ID provided by the advertiser for the conversion.

status

ConversionStatus

The status of the conversion, either ENABLED or REMOVED..

asset_id

int64

ID of the asset which was interacted with during the conversion event.

asset_field_type

AssetFieldType

Asset field type of the conversion event.

ConversionAction

A conversion action.

Поля
resource_name

string

The resource name of the conversion action. Conversion action resource names have the form:

customers/{customer_id}/conversionActions/{conversion_action_id}

creation_time

string

Timestamp of the Floodlight activity's creation, formatted in ISO 8601.

status

ConversionActionStatus

The status of this conversion action for conversion event accrual.

type

ConversionActionType

The type of this conversion action.

category

ConversionActionCategory

The category of conversions reported for this conversion action.

value_settings

ValueSettings

Settings related to the value for conversion events associated with this conversion action.

attribution_model_settings

AttributionModelSettings

Settings related to this conversion action's attribution model.

floodlight_settings

FloodlightSettings

Floodlight settings for Floodlight conversion types.

id

int64

The ID of the conversion action.

name

string

The name of the conversion action.

This field is required and should not be empty when creating new conversion actions.

primary_for_goal

bool

If a conversion action's primary_for_goal bit is false, the conversion action is non-biddable for all campaigns regardless of their customer conversion goal or campaign conversion goal. However, custom conversion goals do not respect primary_for_goal, so if a campaign has a custom conversion goal configured with a primary_for_goal = false conversion action, that conversion action is still biddable. By default, primary_for_goal will be true if not set. In V9, primary_for_goal can only be set to false after creation through an 'update' operation because it's not declared as optional.

owner_customer

string

The resource name of the conversion action owner customer, or null if this is a system-defined conversion action.

include_in_client_account_conversions_metric

bool

Whether this conversion action should be included in the "client_account_conversions" metric.

include_in_conversions_metric

bool

Whether this conversion action should be included in the "conversions" metric.

click_through_lookback_window_days

int64

The maximum number of days that may elapse between an interaction (for example, a click) and a conversion event.

app_id

string

App ID for an app conversion action.

AttributionModelSettings

Settings related to this conversion action's attribution model.

Поля
attribution_model

AttributionModel

The attribution model type of this conversion action.

data_driven_model_status

DataDrivenModelStatus

The status of the data-driven attribution model for the conversion action.

FloodlightSettings

Settings related to a Floodlight conversion action.

Поля
activity_group_tag

string

String used to identify a Floodlight activity group when reporting conversions.

activity_tag

string

String used to identify a Floodlight activity when reporting conversions.

activity_id

int64

ID of the Floodlight activity in DoubleClick Campaign Manager (DCM).

ValueSettings

Settings related to the value for conversion events associated with this conversion action.

Поля
default_value

double

The value to use when conversion events for this conversion action are sent with an invalid, disallowed or missing value, or when this conversion action is configured to always use the default value.

default_currency_code

string

The currency code to use when conversion events for this conversion action are sent with an invalid or missing currency code, or when this conversion action is configured to always use the default value.

always_use_default_value

bool

Controls whether the default value and default currency code are used in place of the value and currency code specified in conversion events for this conversion action.

ConversionCustomVariable

A conversion custom variable. See "About custom Floodlight metrics and dimensions in the new Search Ads 360" at https://support.google.com/sa360/answer/13567857

Поля
resource_name

string

The resource name of the conversion custom variable. Conversion custom variable resource names have the form:

customers/{customer_id}/conversionCustomVariables/{conversion_custom_variable_id}

id

int64

The ID of the conversion custom variable.

name

string

Required. The name of the conversion custom variable. Name should be unique. The maximum length of name is 100 characters. There should not be any extra spaces before and after.

tag

string

Required. The tag of the conversion custom variable. Tag should be unique and consist of a "u" character directly followed with a number less than ormequal to 100. For example: "u4".

status

ConversionCustomVariableStatus

The status of the conversion custom variable for conversion event accrual.

owner_customer

string

The resource name of the customer that owns the conversion custom variable.

family

ConversionCustomVariableFamily

Family of the conversion custom variable.

cardinality

ConversionCustomVariableCardinality

Cardinality of the conversion custom variable.

floodlight_conversion_custom_variable_info

FloodlightConversionCustomVariableInfo

Fields for Search Ads 360 floodlight conversion custom variables.

custom_column_ids[]

int64

The IDs of custom columns that use this conversion custom variable.

FloodlightConversionCustomVariableInfo

Information for Search Ads 360 Floodlight Conversion Custom Variables.

Поля
floodlight_variable_type

FloodlightVariableType

Floodlight variable type defined in Search Ads 360.

floodlight_variable_data_type

FloodlightVariableDataType

Floodlight variable data type defined in Search Ads 360.

ConversionTrackingSetting

A collection of customer-wide settings related to Search Ads 360 Conversion Tracking.

Поля
accepted_customer_data_terms

bool

Whether the customer has accepted customer data terms. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only. For more information, see https://support.google.com/adspolicy/answer/7475709 .

conversion_tracking_status

ConversionTrackingStatus

Conversion tracking status. It indicates whether the customer is using conversion tracking, and who is the conversion tracking owner of this customer. If this customer is using cross-account conversion tracking, the value returned will differ based on the login-customer-id of the request.

enhanced_conversions_for_leads_enabled

bool

Whether the customer is opted-in for enhanced conversions for leads. If using cross-account conversion tracking, this value is inherited from the manager. This field is read-only.

google_ads_conversion_customer

string

The resource name of the customer where conversions are created and managed. This field is read-only.

conversion_tracking_id

int64

The conversion tracking id used for this account. This id doesn't indicate whether the customer uses conversion tracking (conversion_tracking_status does). This field is read-only.

google_ads_cross_account_conversion_tracking_id

int64

The conversion tracking id of the customer's manager. This is set when the customer is opted into conversion tracking, and it overrides conversion_tracking_id. This field can only be managed through the Google Ads UI. This field is read-only.

cross_account_conversion_tracking_id

int64

The conversion tracking id of the customer's manager. This is set when the customer is opted into cross-account conversion tracking, and it overrides conversion_tracking_id.

CustomColumn

A custom column. See Search Ads 360 custom column at https://support.google.com/sa360/answer/9633916

Поля
resource_name

string

The resource name of the custom column. Custom column resource names have the form:

customers/{customer_id}/customColumns/{custom_column_id}

id

int64

ID of the custom column.

name

string

User-defined name of the custom column.

description

string

User-defined description of the custom column.

value_type

CustomColumnValueType

The type of the result value of the custom column.

references_attributes

bool

True when the custom column is referring to one or more attributes.

references_metrics

bool

True when the custom column is referring to one or more metrics.

queryable

bool

True when the custom column is available to be used in the query of SearchAds360Service.Search and SearchAds360Service.SearchStream.

referenced_system_columns[]

string

The list of the referenced system columns of this custom column. For example, A custom column "sum of impressions and clicks" has referenced system columns of {"metrics.clicks", "metrics.impressions"}.

render_type

CustomColumnRenderType

How the result value of the custom column should be interpreted.

Клиент

Клиент.

Поля
resource_name

string

The resource name of the customer. Customer resource names have the form:

customers/{customer_id}

conversion_tracking_setting

ConversionTrackingSetting

Conversion tracking setting for a customer.

account_type

AccountType

Engine account type, for example, Google Ads, Microsoft Advertising, Yahoo Japan, Baidu, Facebook, Engine Track, etc.

double_click_campaign_manager_setting

DoubleClickCampaignManagerSetting

DoubleClick Campaign Manager (DCM) setting for a manager customer.

account_status

AccountStatus

Account status, for example, Enabled, Paused, Removed, etc.

last_modified_time

string

The datetime when this customer was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.

engine_id

string

ID of the account in the external engine account.

status

CustomerStatus

The status of the customer.

creation_time

string

The timestamp when this customer was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.

manager_id

int64

The customer ID of the manager. A 0 value indicates that the customer has no SA360 manager.

manager_descriptive_name

string

The descriptive name of the manager.

sub_manager_id

int64

The customer ID of the sub manager. A 0 value indicates that the customer has no sub SA360 manager.

sub_manager_descriptive_name

string

The descriptive name of the sub manager.

associate_manager_id

int64

The customer ID of the associate manager. A 0 value indicates that the customer has no SA360 associate manager.

associate_manager_descriptive_name

string

The descriptive name of the associate manager.

account_level

AccountLevelType

The account level of the customer: Manager, Sub-manager, Associate manager, Service account.

id

int64

The ID of the customer.

descriptive_name

string

Optional, non-unique descriptive name of the customer.

currency_code

string

The currency in which the account operates. A subset of the currency codes from the ISO 4217 standard is supported.

time_zone

string

The local timezone ID of the customer.

tracking_url_template

string

The URL template for constructing a tracking URL out of parameters.

final_url_suffix

string

The URL template for appending params to the final URL.

auto_tagging_enabled

bool

Whether auto-tagging is enabled for the customer.

manager

bool

Whether the customer is a manager.

CustomerAsset

A link between a customer and an asset.

Поля
resource_name

string

The resource name of the customer asset. CustomerAsset resource names have the form:

customers/{customer_id}/customerAssets/{asset_id}~{field_type}

asset

string

Required. The asset which is linked to the customer.

status

AssetLinkStatus

Status of the customer asset.

CustomerAssetSet

CustomerAssetSet is the linkage between a customer and an asset set. Adding a CustomerAssetSet links an asset set with a customer.

Поля
resource_name

string

The resource name of the customer asset set. Asset set asset resource names have the form:

customers/{customer_id}/customerAssetSets/{asset_set_id}

asset_set

string

The asset set which is linked to the customer.

customer

string

The customer to which this asset set is linked.

status

AssetSetLinkStatus

The status of the customer asset set asset. Read-only.

CustomerClient

A link between the given customer and a client customer. CustomerClients only exist for manager customers. All direct and indirect client customers are included, as well as the manager itself.

Поля
resource_name

string

The resource name of the customer client. CustomerClient resource names have the form: customers/{customer_id}/customerClients/{client_customer_id}

applied_labels[]

string

The resource names of the labels owned by the requesting customer that are applied to the client customer. Label resource names have the form:

customers/{customer_id}/labels/{label_id}

status

CustomerStatus

The status of the client customer. Read only.

client_customer

string

The resource name of the client-customer which is linked to the given customer. Read only.

hidden

bool

Specifies whether this is a hidden account.

Read only.

level

int64

Distance between given customer and client. For self link, the level value will be 0. Read only.

time_zone

string

Common Locale Data Repository (CLDR) string representation of the time zone of the client, for example, America/Los_Angeles. Read only.

test_account

bool

Identifies if the client is a test account. Read only.

manager

bool

Identifies if the client is a manager. Read only.

descriptive_name

string

Descriptive name for the client. Read only.

currency_code

string

Currency code (for example, 'USD', 'EUR') for the client. Read only.

id

int64

The ID of the client customer. Read only.

DoubleClickCampaignManagerSetting

DoubleClick Campaign Manager (DCM) setting for a manager customer.

Поля
advertiser_id

int64

ID of the Campaign Manager advertiser associated with this customer.

network_id

int64

ID of the Campaign Manager network associated with this customer.

time_zone

string

Time zone of the Campaign Manager network associated with this customer in IANA Time Zone Database format, such as America/New_York.

DynamicSearchAdsSearchTermView

A dynamic search ads search term view.

Поля
resource_name

string

The resource name of the dynamic search ads search term view. Dynamic search ads search term view resource names have the form:

customers/{customer_id}/dynamicSearchAdsSearchTermViews/{ad_group_id}~{search_term_fingerprint}~{headline_fingerprint}~{landing_page_fingerprint}~{page_url_fingerprint}

landing_page

string

The dynamically selected landing page URL of the impression.

This field is read-only.

GenderView

A gender view. The gender_view resource reflects the effective serving state, rather than what criteria were added. An ad group without gender criteria by default shows to all genders, so all genders appear in gender_view with stats.

Поля
resource_name

string

The resource name of the gender view. Gender view resource names have the form:

customers/{customer_id}/genderViews/{ad_group_id}~{criterion_id}

GeoTargetConstant

A geo target constant.

Поля
resource_name

string

The resource name of the geo target constant. Geo target constant resource names have the form:

geoTargetConstants/{geo_target_constant_id}

status

GeoTargetConstantStatus

Geo target constant status.

id

int64

The ID of the geo target constant.

name

string

Geo target constant English name.

country_code

string

The ISO-3166-1 alpha-2 country code that is associated with the target.

target_type

string

Geo target constant target type.

canonical_name

string

The fully qualified English name, consisting of the target's name and that of its parent and country.

parent_geo_target

string

The resource name of the parent geo target constant. Geo target constant resource names have the form:

geoTargetConstants/{parent_geo_target_constant_id}

KeywordView

A keyword view.

Поля
resource_name

string

The resource name of the keyword view. Keyword view resource names have the form:

customers/{customer_id}/keywordViews/{ad_group_id}~{criterion_id}

Этикетка

A label.

Поля
resource_name

string

Name of the resource. Label resource names have the form: customers/{owner_customer_id}/labels/{label_id}

status

LabelStatus

Status of the label. Read only.

text_label

TextLabel

A type of label displaying text on a colored background.

id

int64

ID of the label. Read only.

name

string

The name of the label.

This field is required and should not be empty when creating a new label.

The length of this string should be between 1 and 80, inclusive.

LanguageConstant

Язык.

Поля
resource_name

string

The resource name of the language constant. Language constant resource names have the form:

languageConstants/{criterion_id}

id

int64

The ID of the language constant.

code

string

The language code, for example, "en_US", "en_AU", "es", "fr", etc.

name

string

The full name of the language in English, for example, "English (US)", "Spanish", etc.

targetable

bool

Whether the language is targetable.

ListingGroupFilterDimension

Listing dimensions for the asset group listing group filter.

Поля
Union field dimension . Dimension of one of the types below is always present. dimension can be only one of the following:
product_bidding_category

ProductBiddingCategory

Bidding category of a product offer.

product_brand

ProductBrand

Brand of a product offer.

product_channel

ProductChannel

Locality of a product offer.

product_condition

ProductCondition

Condition of a product offer.

product_custom_attribute

ProductCustomAttribute

Custom attribute of a product offer.

product_item_id

ProductItemId

Item id of a product offer.

product_type

ProductType

Type of a product offer.

ProductBiddingCategory

One element of a bidding category at a certain level. Top-level categories are at level 1, their children at level 2, and so on. We currently support up to 5 levels. The user must specify a dimension type that indicates the level of the category. All cases of the same subdivision must have the same dimension type (category level).

Поля
level

ListingGroupFilterBiddingCategoryLevel

Indicates the level of the category in the taxonomy.

id

int64

ID of the product bidding category.

This ID is equivalent to the google_product_category ID as described in this article: https://support.google.com/merchants/answer/6324436

ProductBrand

Brand of the product.

Поля
value

string

String value of the product brand.

ProductChannel

Locality of a product offer.

Поля
channel

ListingGroupFilterProductChannel

Value of the locality.

ProductCondition

Condition of a product offer.

Поля
condition

ListingGroupFilterProductCondition

Value of the condition.

ProductCustomAttribute

Custom attribute of a product offer.

Поля
index

ListingGroupFilterCustomAttributeIndex

Indicates the index of the custom attribute.

value

string

String value of the product custom attribute.

ProductItemId

Item id of a product offer.

Поля
value

string

Value of the id.

ProductType

Type of a product offer.

Поля
level

ListingGroupFilterProductTypeLevel

Level of the type.

value

string

Value of the type.

ListingGroupFilterDimensionPath

The path defining of dimensions defining a listing group filter.

Поля
dimensions[]

ListingGroupFilterDimension

The complete path of dimensions through the listing group filter hierarchy (excluding the root node) to this listing group filter.

LocationView

A location view summarizes the performance of campaigns by a Location criterion.

Поля
resource_name

string

The resource name of the location view. Location view resource names have the form:

customers/{customer_id}/locationViews/{campaign_id}~{criterion_id}

ProductBiddingCategoryConstant

A Product Bidding Category.

Поля
resource_name

string

The resource name of the product bidding category. Product bidding category resource names have the form:

productBiddingCategoryConstants/{country_code}~{level}~{id}

level

ProductBiddingCategoryLevel

Level of the product bidding category.

status

ProductBiddingCategoryStatus

Status of the product bidding category.

id

int64

ID of the product bidding category.

This ID is equivalent to the google_product_category ID as described in this article: https://support.google.com/merchants/answer/6324436 .

country_code

string

Two-letter upper-case country code of the product bidding category.

product_bidding_category_constant_parent

string

Resource name of the parent product bidding category.

language_code

string

Language code of the product bidding category.

localized_name

string

Display value of the product bidding category localized according to language_code.

ProductGroupView

A product group view.

Поля
resource_name

string

The resource name of the product group view. Product group view resource names have the form:

customers/{customer_id}/productGroupViews/{ad_group_id}~{criterion_id}

SearchAds360Field

A field or resource (artifact) used by SearchAds360Service.

Поля
resource_name

string

The resource name of the artifact. Artifact resource names have the form:

SearchAds360Fields/{name}

category

SearchAds360FieldCategory

The category of the artifact.

selectable_with[]

string

The names of all resources, segments, and metrics that are selectable with the described artifact.

attribute_resources[]

string

The names of all resources that are selectable with the described artifact. Fields from these resources do not segment metrics when included in search queries.

This field is only set for artifacts whose category is RESOURCE.

metrics[]

string

This field lists the names of all metrics that are selectable with the described artifact when it is used in the FROM clause. It is only set for artifacts whose category is RESOURCE.

segments[]

string

This field lists the names of all artifacts, whether a segment or another resource, that segment metrics when included in search queries and when the described artifact is used in the FROM clause. It is only set for artifacts whose category is RESOURCE.

enum_values[]

string

Values the artifact can assume if it is a field of type ENUM.

This field is only set for artifacts of category SEGMENT or ATTRIBUTE.

data_type

SearchAds360FieldDataType

This field determines the operators that can be used with the artifact in WHERE clauses.

name

string

The name of the artifact.

selectable

bool

Whether the artifact can be used in a SELECT clause in search queries.

filterable

bool

Whether the artifact can be used in a WHERE clause in search queries.

sortable

bool

Whether the artifact can be used in a ORDER BY clause in search queries.

type_url

string

The URL of proto describing the artifact's data type.

is_repeated

bool

Whether the field artifact is repeated.

ShoppingPerformanceView

Shopping performance view. Provides Shopping campaign statistics aggregated at several product dimension levels. Product dimension values from Merchant Center such as brand, category, custom attributes, product condition and product type will reflect the state of each dimension as of the date and time when the corresponding event was recorded.

Поля
resource_name

string

The resource name of the Shopping performance view. Shopping performance view resource names have the form: customers/{customer_id}/shoppingPerformanceView

UserList

A user list. This is a list of users a customer may target.

Поля
resource_name

string

The resource name of the user list. User list resource names have the form:

customers/{customer_id}/userLists/{user_list_id}

type

UserListType

Type of this list.

This field is read-only.

id

int64

Id of the user list.

name

string

Name of this user list. Depending on its access_reason, the user list name may not be unique (for example, if access_reason=SHARED)

UserLocationView

A user location view.

User Location View includes all metrics aggregated at the country level, one row per country. It reports metrics at the actual physical location of the user by targeted or not targeted location. If other segment fields are used, you may get more than one row per country.

Поля
resource_name

string

The resource name of the user location view. UserLocation view resource names have the form:

customers/{customer_id}/userLocationViews/{country_criterion_id}~{targeting_location}

country_criterion_id

int64

Criterion Id for the country.

targeting_location

bool

Indicates whether location was targeted or not.

Посещать

A visit.

Поля
resource_name

string

The resource name of the visit. Visit resource names have the form:

customers/{customer_id}/visits/{ad_group_id}~{criterion_id}~{ds_visit_id}

id

int64

The ID of the visit.

criterion_id

int64

Search Ads 360 keyword ID. A value of 0 indicates that the keyword is unattributed.

merchant_id

int64

The Search Ads 360 inventory account ID containing the product that was clicked on. Search Ads 360 generates this ID when you link an inventory account in Search Ads 360.

ad_id

int64

Ad ID. A value of 0 indicates that the ad is unattributed.

click_id

string

A unique string for each visit that is passed to the landing page as the click id URL parameter.

visit_date_time

string

The timestamp of the visit event. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.

product_id

string

The ID of the product clicked on.

product_channel

ProductChannel

The sales channel of the product that was clicked on: Online or Local.

product_language_code

string

The language (ISO-639-1) that has been set for the Merchant Center feed containing data about the product.

product_store_id

string

The store in the Local Inventory Ad that was clicked on. This should match the store IDs used in your local products feed.

product_country_code

string

The country (ISO-3166 format) registered for the inventory feed that contains the product clicked on.

asset_id

int64

ID of the asset which was interacted with during the visit event.

asset_field_type

AssetFieldType

Asset field type of the visit event.

WebpageView

A webpage view.

Поля
resource_name

string

The resource name of the webpage view. Webpage view resource names have the form:

customers/{customer_id}/webpageViews/{ad_group_id}~{criterion_id}