SearchAds360Row

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

JSON-представление
{
  "adGroup": {
    object (AdGroup)
  },
  "adGroupAd": {
    object (AdGroupAd)
  },
  "adGroupAdEffectiveLabel": {
    object (AdGroupAdEffectiveLabel)
  },
  "adGroupAdLabel": {
    object (AdGroupAdLabel)
  },
  "adGroupAsset": {
    object (AdGroupAsset)
  },
  "adGroupAssetSet": {
    object (AdGroupAssetSet)
  },
  "adGroupAudienceView": {
    object (AdGroupAudienceView)
  },
  "adGroupBidModifier": {
    object (AdGroupBidModifier)
  },
  "adGroupCriterion": {
    object (AdGroupCriterion)
  },
  "adGroupCriterionEffectiveLabel": {
    object (AdGroupCriterionEffectiveLabel)
  },
  "adGroupCriterionLabel": {
    object (AdGroupCriterionLabel)
  },
  "adGroupEffectiveLabel": {
    object (AdGroupEffectiveLabel)
  },
  "adGroupLabel": {
    object (AdGroupLabel)
  },
  "ageRangeView": {
    object (AgeRangeView)
  },
  "asset": {
    object (Asset)
  },
  "assetGroupAsset": {
    object (AssetGroupAsset)
  },
  "assetGroupSignal": {
    object (AssetGroupSignal)
  },
  "assetGroupListingGroupFilter": {
    object (AssetGroupListingGroupFilter)
  },
  "assetGroupTopCombinationView": {
    object (AssetGroupTopCombinationView)
  },
  "assetGroup": {
    object (AssetGroup)
  },
  "assetSetAsset": {
    object (AssetSetAsset)
  },
  "assetSet": {
    object (AssetSet)
  },
  "biddingStrategy": {
    object (BiddingStrategy)
  },
  "campaignBudget": {
    object (CampaignBudget)
  },
  "campaign": {
    object (Campaign)
  },
  "campaignAsset": {
    object (CampaignAsset)
  },
  "campaignAssetSet": {
    object (CampaignAssetSet)
  },
  "campaignAudienceView": {
    object (CampaignAudienceView)
  },
  "campaignCriterion": {
    object (CampaignCriterion)
  },
  "campaignEffectiveLabel": {
    object (CampaignEffectiveLabel)
  },
  "campaignLabel": {
    object (CampaignLabel)
  },
  "cartDataSalesView": {
    object (CartDataSalesView)
  },
  "audience": {
    object (Audience)
  },
  "conversionAction": {
    object (ConversionAction)
  },
  "conversionCustomVariable": {
    object (ConversionCustomVariable)
  },
  "customer": {
    object (Customer)
  },
  "customerAsset": {
    object (CustomerAsset)
  },
  "customerAssetSet": {
    object (CustomerAssetSet)
  },
  "accessibleBiddingStrategy": {
    object (AccessibleBiddingStrategy)
  },
  "customerManagerLink": {
    object (CustomerManagerLink)
  },
  "customerClient": {
    object (CustomerClient)
  },
  "dynamicSearchAdsSearchTermView": {
    object (DynamicSearchAdsSearchTermView)
  },
  "genderView": {
    object (GenderView)
  },
  "geoTargetConstant": {
    object (GeoTargetConstant)
  },
  "keywordView": {
    object (KeywordView)
  },
  "label": {
    object (Label)
  },
  "languageConstant": {
    object (LanguageConstant)
  },
  "locationView": {
    object (LocationView)
  },
  "productBiddingCategoryConstant": {
    object (ProductBiddingCategoryConstant)
  },
  "productGroupView": {
    object (ProductGroupView)
  },
  "shoppingPerformanceView": {
    object (ShoppingPerformanceView)
  },
  "userList": {
    object (UserList)
  },
  "userLocationView": {
    object (UserLocationView)
  },
  "webpageView": {
    object (WebpageView)
  },
  "visit": {
    object (Visit)
  },
  "conversion": {
    object (Conversion)
  },
  "metrics": {
    object (Metrics)
  },
  "segments": {
    object (Segments)
  },
  "customColumns": [
    {
      object (Value)
    }
  ]
}
Поля
adGroup

object ( AdGroup )

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

adGroupAd

object ( AdGroupAd )

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

adGroupAdEffectiveLabel

object ( AdGroupAdEffectiveLabel )

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

adGroupAdLabel

object ( AdGroupAdLabel )

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

adGroupAsset

object ( AdGroupAsset )

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

adGroupAssetSet

object ( AdGroupAssetSet )

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

adGroupAudienceView

object ( AdGroupAudienceView )

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

adGroupBidModifier

object ( AdGroupBidModifier )

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

adGroupCriterion

object ( AdGroupCriterion )

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

adGroupCriterionEffectiveLabel

object ( AdGroupCriterionEffectiveLabel )

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

adGroupCriterionLabel

object ( AdGroupCriterionLabel )

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

adGroupEffectiveLabel

object ( AdGroupEffectiveLabel )

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

adGroupLabel

object ( AdGroupLabel )

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

ageRangeView

object ( AgeRangeView )

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

asset

object ( Asset )

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

assetGroupAsset

object ( AssetGroupAsset )

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

assetGroupSignal

object ( AssetGroupSignal )

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

assetGroupListingGroupFilter

object ( AssetGroupListingGroupFilter )

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

assetGroupTopCombinationView

object ( AssetGroupTopCombinationView )

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

assetGroup

object ( AssetGroup )

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

assetSetAsset

object ( AssetSetAsset )

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

assetSet

object ( AssetSet )

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

biddingStrategy

object ( BiddingStrategy )

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

campaignBudget

object ( CampaignBudget )

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

campaign

object ( Campaign )

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

campaignAsset

object ( CampaignAsset )

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

campaignAssetSet

object ( CampaignAssetSet )

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

campaignAudienceView

object ( CampaignAudienceView )

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

campaignCriterion

object ( CampaignCriterion )

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

campaignEffectiveLabel

object ( CampaignEffectiveLabel )

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

campaignLabel

object ( CampaignLabel )

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

cartDataSalesView

object ( CartDataSalesView )

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

audience

object ( Audience )

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

conversionAction

object ( ConversionAction )

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

conversionCustomVariable

object ( ConversionCustomVariable )

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

customer

object ( Customer )

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

customerAsset

object ( CustomerAsset )

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

customerAssetSet

object ( CustomerAssetSet )

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

accessibleBiddingStrategy

object ( AccessibleBiddingStrategy )

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

customerClient

object ( CustomerClient )

CustomerClient, на который ссылается запрос.

dynamicSearchAdsSearchTermView

object ( DynamicSearchAdsSearchTermView )

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

genderView

object ( GenderView )

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

geoTargetConstant

object ( GeoTargetConstant )

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

keywordView

object ( KeywordView )

Вид ключевого слова, указанный в запросе.

label

object ( Label )

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

languageConstant

object ( LanguageConstant )

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

locationView

object ( LocationView )

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

productBiddingCategoryConstant

object ( ProductBiddingCategoryConstant )

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

productGroupView

object ( ProductGroupView )

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

shoppingPerformanceView

object ( ShoppingPerformanceView )

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

userList

object ( UserList )

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

userLocationView

object ( UserLocationView )

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

webpageView

object ( WebpageView )

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

visit

object ( Visit )

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

conversion

object ( Conversion )

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

metrics

object ( Metrics )

Метрики.

segments

object ( Segments )

Сегменты.

customColumns[]

object ( Value )

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

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

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

JSON-представление
{
  "resourceName": string,
  "status": enum (AdGroupStatus),
  "type": enum (AdGroupType),
  "adRotationMode": enum (AdGroupAdRotationMode),
  "creationTime": string,
  "targetingSetting": {
    object (TargetingSetting)
  },
  "labels": [
    string
  ],
  "effectiveLabels": [
    string
  ],
  "engineId": string,
  "startDate": string,
  "endDate": string,
  "languageCode": string,
  "lastModifiedTime": string,
  "id": string,
  "name": string,
  "trackingUrlTemplate": string,
  "cpcBidMicros": string,
  "engineStatus": enum (AdGroupEngineStatus),
  "finalUrlSuffix": string
}
Поля
resourceName

string

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

customers/{customerId}/adGroups/{ad_group_id}

status

enum ( AdGroupStatus )

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

type

enum ( AdGroupType )

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

adRotationMode

enum ( AdGroupAdRotationMode )

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

creationTime

string

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

targetingSetting

object ( TargetingSetting )

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

labels[]

string

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

effectiveLabels[]

string

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

engineId

string

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

startDate

string

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

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

endDate

string

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

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

languageCode

string

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

lastModifiedTime

string

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

id

string ( int64 format)

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

name

string

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

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

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

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

trackingUrlTemplate

string

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

cpcBidMicros

string ( int64 format)

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

engineStatus

enum ( AdGroupEngineStatus )

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

finalUrlSuffix

string

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

AdGroupStatus

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

Перечисления
UNSPECIFIED Статус не указан.
UNKNOWN

Полученное значение в этой версии неизвестно.

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

ENABLED Группа объявлений включена.
PAUSED Группа объявлений приостановлена.
REMOVED Группа объявлений удалена.

AdGroupType

Перечисление возможных типов группы объявлений.

Перечисления
UNSPECIFIED Тип не указан.
UNKNOWN

Полученное значение в этой версии неизвестно.

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

SEARCH_STANDARD Тип группы объявлений по умолчанию для поисковых кампаний.
DISPLAY_STANDARD Тип группы объявлений по умолчанию для медийных кампаний.
SHOPPING_PRODUCT_ADS Тип группы объявлений для торговых кампаний, показывающих стандартные товарные объявления.
SHOPPING_SHOWCASE_ADS Тип для групп объявлений, которые ограничены показом рекламы Showcase или Merchant в результатах поиска.
HOTEL_ADS Тип группы объявлений по умолчанию для кампаний по бронированию гостиниц.
SHOPPING_SMART_ADS Тип для групп объявлений в умных торговых кампаниях.
VIDEO_BUMPER Короткие непереключаемые видеорекламы в потоковом режиме.
VIDEO_TRUE_VIEW_IN_STREAM TrueView (с возможностью пропуска) in-stream видеореклама.
VIDEO_TRUE_VIEW_IN_DISPLAY Видеореклама TrueView in-display.
VIDEO_NON_SKIPPABLE_IN_STREAM Непропускаемая потоковая видеореклама.
VIDEO_OUTSTREAM Рекламные видеоролики Outstream.
SEARCH_DYNAMIC_ADS Тип группы объявлений для групп объявлений Dynamic Search Ads.
SHOPPING_COMPARISON_LISTING_ADS Тип для групп объявлений в кампаниях со сравнительным списком товаров.
PROMOTED_HOTEL_ADS Тип группы объявлений для групп объявлений «Продвигаемые отели».
VIDEO_RESPONSIVE Группы адаптивных видеообъявлений.
VIDEO_EFFICIENT_REACH Группы видеорекламы с эффективным охватом.
SMART_CAMPAIGN_ADS Тип группы объявлений для умных кампаний.
TRAVEL_ADS Тип группы объявлений для туристических кампаний.

AdGroupAdRotationMode

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

Перечисления
UNSPECIFIED Режим ротации рекламы не указан.
UNKNOWN

Полученное значение в этой версии неизвестно.

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

OPTIMIZE Оптимизируйте объявления группы на основе кликов или конверсий.
ROTATE_FOREVER Вращайтесь равномерно всегда.

AdGroupEngineStatus

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

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
AD_GROUP_ELIGIBLE

Устарело. Не использовать.

AD_GROUP_EXPIRED Объявления этой группы объявлений не показываются, поскольку дата окончания группы объявлений уже прошла.
AD_GROUP_REMOVED Группа объявлений удалена.
AD_GROUP_DRAFT Для этой группы объявлений не показывается ни одна реклама, поскольку соответствующая группа объявлений все еще находится в стадии черновика.
AD_GROUP_PAUSED Группа объявлений приостановлена.
AD_GROUP_SERVING Группа объявлений активна и в настоящее время показывает рекламу.
AD_GROUP_SUBMITTED Группа объявлений отправлена ​​(статус устаревшей версии Microsoft Bing Ads).
CAMPAIGN_PAUSED Объявления этой группы объявлений не показываются, поскольку кампания приостановлена.
ACCOUNT_PAUSED Реклама в этой группе объявлений не показывается, поскольку аккаунт приостановлен.

Настройка таргетинга

Настройки функций таргетинга на уровне кампании и группы объявлений. Подробнее о настройке таргетинга см. на странице https://support.google.com/google-ads/answer/7365594.

JSON-представление
{
  "targetRestrictions": [
    {
      object (TargetRestriction)
    }
  ]
}
Поля
targetRestrictions[]

object ( TargetRestriction )

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

TargetRestriction

Список настроек таргетинга по параметрам таргетинга.

JSON-представление
{
  "targetingDimension": enum (TargetingDimension),
  "bidOnly": boolean
}
Поля
targetingDimension

enum ( TargetingDimension )

Измерение таргетинга, к которому применяются эти настройки.

bidOnly

boolean

Указывает, следует ли ограничить показ объявлений только критериями, выбранными для этого параметра таргетинга, или настроить таргетинг на все значения этого параметра таргетинга и показывать рекламу на основе таргетинга в других параметрах таргетинга. Значение « true означает, что эти критерии будут применять только модификаторы ставок и не будут влиять на таргетинг. Значение false означает, что эти критерии будут ограничивать таргетинг, а также применять модификаторы ставок.

TargetingDimension

Перечисление, описывающее возможные параметры таргетинга.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
KEYWORD Критерии ключевых слов, например, «круиз на Марс». КЛЮЧЕВОЕ СЛОВО можно использовать в качестве пользовательского параметра ставки. Ключевые слова всегда являются параметром таргетинга, поэтому их нельзя задать как целевой параметр «ВСЕ» с помощью TargetRestriction.
AUDIENCE Критерии аудитории, включающие список пользователей, интересы пользователей, индивидуальные предпочтения и присутствие на рынке.
TOPIC Критерии темы для таргетинга категорий контента, например, «category::Animals>Pets». Используется для таргетинга дисплейной и видеорекламы.
GENDER Критерии таргетинга по полу.
AGE_RANGE Критерии определения возрастных диапазонов.
PLACEMENT Критерии размещения, которые включают такие веб-сайты, как «www.flowers4sale.com», а также мобильные приложения, категории мобильных приложений, видеоролики YouTube и каналы YouTube.
PARENTAL_STATUS Критерии таргетинга по родительскому статусу.
INCOME_RANGE Критерии таргетинга диапазона доходов.

AdGroupAd

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

JSON-представление
{
  "resourceName": string,
  "status": enum (AdGroupAdStatus),
  "ad": {
    object (Ad)
  },
  "creationTime": string,
  "labels": [
    string
  ],
  "effectiveLabels": [
    string
  ],
  "engineId": string,
  "engineStatus": enum (AdGroupAdEngineStatus),
  "lastModifiedTime": string
}
Поля
resourceName

string

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

customers/{customerId}/adGroupAds/{ad_group_id}~{adId}

status

enum ( AdGroupAdStatus )

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

ad

object ( Ad )

Реклама.

creationTime

string

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

labels[]

string

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

effectiveLabels[]

string

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

engineId

string

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

engineStatus

enum ( AdGroupAdEngineStatus )

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

lastModifiedTime

string

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

AdGroupAdStatus

Возможные статусы AdGroupAd.

Перечисления
UNSPECIFIED Значение не указано.
UNKNOWN

Полученное значение в этой версии неизвестно.

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

ENABLED Группа объявлений включена.
PAUSED Показ объявления в группе приостановлен.
REMOVED Объявление группы объявлений удалено.

FinalAppUrl

URL-адрес для глубокой ссылки на приложение для данной операционной системы.

JSON-представление
{
  "osType": enum (AppUrlOperatingSystemType),
  "url": string
}
Поля
osType

enum ( AppUrlOperatingSystemType )

Операционная система, на которую ориентирован этот URL. Обязательно.

url

string

URL-адрес глубокой ссылки приложения. Глубокие ссылки указывают местоположение в приложении, соответствующее контенту, который вы хотите отобразить, и должны иметь вид {scheme}://{host_path}. Схема определяет, какое приложение открыть. Для своего приложения вы можете использовать собственную схему, которая начинается с имени приложения. Хост и путь указывают уникальное местоположение в приложении, где находится ваш контент. Пример: "exampleapp://productid_1234". Обязательно.

AppUrlOperatingSystemType

Операционная система

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
IOS Операционная система Apple iOS.
ANDROID Операционная система Android.

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

Возможные типы рекламы.

Перечисления
UNSPECIFIED Значение не указано.
UNKNOWN

Полученное значение в этой версии неизвестно.

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

TEXT_AD Это текстовое объявление.
EXPANDED_TEXT_AD Объявление представляет собой развернутую текстовую рекламу.
CALL_ONLY_AD Это объявление только с звонком.
EXPANDED_DYNAMIC_SEARCH_AD Объявление представляет собой развернутую динамическую поисковую рекламу.
HOTEL_AD Это реклама отеля.
SHOPPING_SMART_AD Это реклама Smart Shopping.
SHOPPING_PRODUCT_AD Это стандартное объявление о покупках.
VIDEO_AD Это видеореклама.
GMAIL_AD Это реклама Gmail.
IMAGE_AD Это графическое объявление.
RESPONSIVE_SEARCH_AD Это адаптивное поисковое объявление.
LEGACY_RESPONSIVE_DISPLAY_AD Это устаревшая адаптивная медийная реклама.
APP_AD Это реклама приложения.
LEGACY_APP_INSTALL_AD Это устаревшая реклама установки приложения.
RESPONSIVE_DISPLAY_AD Это адаптивное медийное объявление.
LOCAL_AD Это локальная реклама.
HTML5_UPLOAD_AD Объявление представляет собой загружаемую рекламу с типом продукта HTML5_UPLOAD_AD.
DYNAMIC_HTML5_AD Объявление представляет собой рекламное объявление с загрузкой изображения и одним из типов продуктов DYNAMIC_HTML5_*.
APP_ENGAGEMENT_AD Это реклама для повышения вовлеченности в приложение.
SHOPPING_COMPARISON_LISTING_AD Данное объявление представляет собой сравнительный листинг товаров.
VIDEO_BUMPER_AD Видеореклама.
VIDEO_NON_SKIPPABLE_IN_STREAM_AD Видеореклама без возможности пропуска.
VIDEO_OUTSTREAM_AD Видеореклама out-stream.
VIDEO_TRUEVIEW_DISCOVERY_AD Видеореклама TrueView in-display.
VIDEO_TRUEVIEW_IN_STREAM_AD Видеореклама TrueView in-stream.
VIDEO_RESPONSIVE_AD Адаптивная видеореклама.
SMART_CAMPAIGN_AD Умная рекламная кампания.
APP_PRE_REGISTRATION_AD Универсальная реклама предварительной регистрации в приложении.
DISCOVERY_MULTI_ASSET_AD Мультиактивная реклама Discovery.
TRAVEL_AD Туристическая реклама.
DISCOVERY_VIDEO_RESPONSIVE_AD Адаптивная видеореклама Discovery.
MULTIMEDIA_AD Мультимедийная реклама.

SearchAds360TextAdInfo

Текстовое объявление Search Ads 360.

JSON-представление
{
  "headline": string,
  "description1": string,
  "description2": string,
  "displayUrl": string,
  "displayMobileUrl": string,
  "adTrackingId": string
}
Поля
headline

string

Заголовок объявления.

description1

string

Первая строка описания объявления.

description2

string

Вторая строка описания объявления.

displayUrl

string

Отображаемый URL-адрес объявления.

displayMobileUrl

string

Отображаемый мобильный URL-адрес объявления.

adTrackingId

string ( int64 format)

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

SearchAds360ExpandedTextAdInfo

Расширенное текстовое объявление Search Ads 360.

JSON-представление
{
  "headline": string,
  "headline2": string,
  "headline3": string,
  "description1": string,
  "description2": string,
  "path1": string,
  "path2": string,
  "adTrackingId": string
}
Поля
headline

string

Заголовок объявления.

headline2

string

Второй заголовок объявления.

headline3

string

Третий заголовок объявления.

description1

string

Первая строка описания объявления.

description2

string

Вторая строка описания объявления.

path1

string

Текст, добавленный к автоматически сгенерированному видимому URL-адресу с разделителем.

path2

string

Текст, добавленный к path1 с разделителем.

adTrackingId

string ( int64 format)

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

SearchAds360ResponsiveSearchAdInfo

Адаптивное поисковое объявление Search Ads 360.

JSON-представление
{
  "headlines": [
    {
      object (AdTextAsset)
    }
  ],
  "descriptions": [
    {
      object (AdTextAsset)
    }
  ],
  "path1": string,
  "path2": string,
  "adTrackingId": string
}
Поля
headlines[]

object ( AdTextAsset )

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

descriptions[]

object ( AdTextAsset )

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

path1

string

Текст, добавленный к автоматически сгенерированному видимому URL-адресу с разделителем.

path2

string

Текст, добавленный к path1 с разделителем.

adTrackingId

string ( int64 format)

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

AdTextAsset

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

JSON-представление
{
  "text": string
}
Поля
text

string

Текст актива.

SearchAds360ProductAdInfo

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

Рекламное объявление продукта Search Ads 360.

SearchAds360ExpandedDynamicSearchAdInfo

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

JSON-представление
{
  "description1": string,
  "description2": string,
  "adTrackingId": string
}
Поля
description1

string

Первая строка описания объявления.

description2

string

Вторая строка описания объявления.

adTrackingId

string ( int64 format)

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

AdGroupAdEngineStatus

Перечисляет статусы движка AdGroupAd.

Перечисления
UNSPECIFIED Значение не указано.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
AD_GROUP_AD_ELIGIBLE

Устарело. Не использовать.

AD_GROUP_AD_INAPPROPRIATE_FOR_CAMPAIGN Baidu: Креатив не был одобрен.
AD_GROUP_AD_MOBILE_URL_UNDER_REVIEW Baidu: Мобильный URL-адрес находится на рассмотрении.
AD_GROUP_AD_PARTIALLY_INVALID Baidu: Креатив недействителен на мобильном устройстве, но действителен на настольном компьютере.
AD_GROUP_AD_TO_BE_ACTIVATED Baidu: Креатив готов к активации.
AD_GROUP_AD_NOT_REVIEWED Baidu: Креатив не рассмотрен.
AD_GROUP_AD_ON_HOLD

Устарело. Не использовать. Ранее использовалось Gemini.

AD_GROUP_AD_PAUSED Креатив приостановлен.
AD_GROUP_AD_REMOVED Креатив был удален.
AD_GROUP_AD_PENDING_REVIEW Креатив ожидает рассмотрения.
AD_GROUP_AD_UNDER_REVIEW Креатив находится на рассмотрении.
AD_GROUP_AD_APPROVED Креатив одобрен.
AD_GROUP_AD_DISAPPROVED Креатив был отклонен.
AD_GROUP_AD_SERVING Креатив — это служение.
AD_GROUP_AD_ACCOUNT_PAUSED Креатив приостановлен, поскольку аккаунт приостановлен.
AD_GROUP_AD_CAMPAIGN_PAUSED Креатив приостановлен, поскольку кампания приостановлена.
AD_GROUP_AD_AD_GROUP_PAUSED Показ креатива приостановлен, поскольку приостановлена ​​группа объявлений.

AdGroupAdEffectiveLabel

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

JSON-представление
{
  "resourceName": string,
  "adGroupAd": string,
  "label": string,
  "ownerCustomerId": string
}
Поля
resourceName

string

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

adGroupAd

string

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

label

string

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

ownerCustomerId

string ( int64 format)

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

AdGroupAdLabel

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

JSON-представление
{
  "resourceName": string,
  "adGroupAd": string,
  "label": string,
  "ownerCustomerId": string
}
Поля
resourceName

string

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

adGroupAd

string

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

label

string

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

ownerCustomerId

string ( int64 format)

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

AdGroupAsset

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

JSON-представление
{
  "resourceName": string,
  "adGroup": string,
  "asset": string,
  "status": enum (AssetLinkStatus)
}
Поля
resourceName

string

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

customers/{customerId}/adGroupAssets/{ad_group_id}~{assetId}~{fieldType}

adGroup

string

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

asset

string

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

status

enum ( AssetLinkStatus )

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

AssetLinkStatus

Перечисление, описывающее статусы ссылки на актив.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
ENABLED Ссылка на актив включена.
REMOVED Ссылка на актив удалена.
PAUSED Ссылка на актив приостановлена.

AdGroupAssetSet

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

JSON-представление
{
  "resourceName": string,
  "adGroup": string,
  "assetSet": string,
  "status": enum (AssetSetLinkStatus)
}
Поля
resourceName

string

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

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

adGroup

string

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

assetSet

string

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

status

enum ( AssetSetLinkStatus )

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

AssetSetLinkStatus

Возможные статусы связи между набором активов и его контейнером.

Перечисления
UNSPECIFIED Статус не указан.
UNKNOWN Полученное значение неизвестно в этой версии. Это значение только для ответа.
ENABLED Включена связь между набором активов и его контейнером.
REMOVED Связь между набором активов и его контейнером удалена.

AdGroupAudienceView

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

JSON-представление
{
  "resourceName": string
}
Поля
resourceName

string

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

customers/{customerId}/adGroupAudienceViews/{ad_group_id}~{criterionId}

AdGroupBidModifier

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

JSON-представление
{
  "resourceName": string,
  "bidModifier": number,

  // Union field criterion can be only one of the following:
  "device": {
    object (DeviceInfo)
  }
  // End of list of possible types for union field criterion.
}
Поля
resourceName

string

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

customers/{customerId}/adGroupBidModifiers/{ad_group_id}~{criterionId}

bidModifier

number

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

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

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

device

object ( DeviceInfo )

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

Информация об устройстве

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

JSON-представление
{
  "type": enum (Device)
}
Поля
type

enum ( Device )

Тип устройства.

Устройство

Перечисляет устройства Google Ads, доступные для таргетинга.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN В этой версии значение неизвестно.
MOBILE Мобильные устройства с полнофункциональными браузерами.
TABLET Планшеты с полнофункциональными браузерами.
DESKTOP Компьютеры.
CONNECTED_TV Умные телевизоры и игровые приставки.
OTHER Другие типы устройств.

AdGroupCriterion

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

JSON-представление
{
  "resourceName": string,
  "creationTime": string,
  "status": enum (AdGroupCriterionStatus),
  "qualityInfo": {
    object (QualityInfo)
  },
  "type": enum (CriterionType),
  "labels": [
    string
  ],
  "effectiveLabels": [
    string
  ],
  "positionEstimates": {
    object (PositionEstimates)
  },
  "finalUrls": [
    string
  ],
  "finalMobileUrls": [
    string
  ],
  "urlCustomParameters": [
    {
      object (CustomParameter)
    }
  ],
  "engineId": string,
  "lastModifiedTime": string,
  "criterionId": string,
  "adGroup": string,
  "negative": boolean,
  "bidModifier": number,
  "cpcBidMicros": string,
  "effectiveCpcBidMicros": string,
  "engineStatus": enum (AdGroupCriterionEngineStatus),
  "finalUrlSuffix": string,
  "trackingUrlTemplate": string,

  // Union field criterion can be only one of the following:
  "keyword": {
    object (KeywordInfo)
  },
  "listingGroup": {
    object (ListingGroupInfo)
  },
  "ageRange": {
    object (AgeRangeInfo)
  },
  "gender": {
    object (GenderInfo)
  },
  "userList": {
    object (UserListInfo)
  },
  "webpage": {
    object (WebpageInfo)
  },
  "location": {
    object (LocationInfo)
  }
  // End of list of possible types for union field criterion.
}
Поля
resourceName

string

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

customers/{customerId}/adGroupCriteria/{ad_group_id}~{criterionId}

creationTime

string

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

status

enum ( AdGroupCriterionStatus )

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

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

qualityInfo

object ( QualityInfo )

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

type

enum ( CriterionType )

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

labels[]

string

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

effectiveLabels[]

string

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

positionEstimates

object ( PositionEstimates )

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

finalUrls[]

string

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

finalMobileUrls[]

string

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

urlCustomParameters[]

object ( CustomParameter )

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

engineId

string

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

lastModifiedTime

string

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

criterionId

string ( int64 format)

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

adGroup

string

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

negative

boolean

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

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

bidModifier

number

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

cpcBidMicros

string ( int64 format)

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

effectiveCpcBidMicros

string ( int64 format)

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

engineStatus

enum ( AdGroupCriterionEngineStatus )

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

finalUrlSuffix

string

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

trackingUrlTemplate

string

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

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

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

keyword

object ( KeywordInfo )

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

listingGroup

object ( ListingGroupInfo )

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

ageRange

object ( AgeRangeInfo )

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

gender

object ( GenderInfo )

Пол.

userList

object ( UserListInfo )

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

webpage

object ( WebpageInfo )

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

location

object ( LocationInfo )

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

AdGroupCriterionStatus

Возможные статусы AdGroupCriterion.

Перечисления
UNSPECIFIED Значение не указано.
UNKNOWN

Полученное значение в этой версии неизвестно.

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

ENABLED Критерий группы объявлений включен.
PAUSED Критерий группы объявлений приостановлен.
REMOVED Критерий группы объявлений удален.

QualityInfo

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

JSON-представление
{
  "qualityScore": integer
}
Поля
qualityScore

integer

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

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

CriterionType

Перечисление, описывающее возможные типы критериев.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
KEYWORD Ключевое слово, например, «круиз на Марс».
PLACEMENT Место размещения, также известное как «Веб-сайт», например, «www.flowers4sale.com»
MOBILE_APP_CATEGORY Целевые категории мобильных приложений.
MOBILE_APPLICATION Целевые мобильные приложения.
DEVICE Устройства для выбора.
LOCATION Целевые местоположения.
LISTING_GROUP Составление списка целевых групп.
AD_SCHEDULE Расписание показов объявлений.
AGE_RANGE Возрастной диапазон.
GENDER Пол.
INCOME_RANGE Диапазон доходов.
PARENTAL_STATUS Родительский статус.
YOUTUBE_VIDEO Видео на YouTube.
YOUTUBE_CHANNEL Канал на YouTube.
USER_LIST Список пользователей.
PROXIMITY Близость.
TOPIC Тематическая целевая реклама в контекстно-медийной сети (например, «Домашние животные»).
LISTING_SCOPE Область листинга для нацеливания.
LANGUAGE Язык.
IP_BLOCK IpBlock.
CONTENT_LABEL Метка контента для исключения категории.
CARRIER Перевозчик.
USER_INTEREST Категория, которая интересует пользователя.
WEBPAGE Критерий веб-страницы для динамической поисковой рекламы.
OPERATING_SYSTEM_VERSION Версия операционной системы.
APP_PAYMENT_MODEL Модель оплаты приложений.
MOBILE_DEVICE Мобильное устройство.
CUSTOM_AFFINITY Индивидуальная близость.
CUSTOM_INTENT Индивидуальное намерение.
LOCATION_GROUP Группа местоположений.
CUSTOM_AUDIENCE Индивидуальная аудитория
COMBINED_AUDIENCE Совместная аудитория
KEYWORD_THEME Тема ключевых слов Smart Campaign
AUDIENCE Аудитория
LOCAL_SERVICE_ID Идентификатор сервиса «Реклама местных услуг».
BRAND Бренд
BRAND_LIST Список брендов
LIFE_EVENT Событие в жизни

PositionEstimates

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

JSON-представление
{
  "topOfPageCpcMicros": string
}
Поля
topOfPageCpcMicros

string ( int64 format)

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

AdGroupCriterionEngineStatus

Перечисляет статусы движка AdGroupCriterion.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
AD_GROUP_CRITERION_ELIGIBLE

Устарело. Не использовать.

AD_GROUP_CRITERION_INAPPROPRIATE_FOR_CAMPAIGN Baidu: Ставка или качество слишком низкие для отображения.
AD_GROUP_CRITERION_LOW_SEARCH_VOLUME Baidu: Приостановлено Baidu из-за низкого объема поиска.
AD_GROUP_CRITERION_MOBILE_URL_UNDER_REVIEW Baidu: Мобильный URL-адрес находится на рассмотрении.
AD_GROUP_CRITERION_PARTIALLY_INVALID Baidu: Целевая страница для одного устройства недействительна, в то время как целевая страница для другого устройства действительна.
AD_GROUP_CRITERION_TO_BE_ACTIVATED Baidu: ключевое слово было создано и приостановлено менеджерами аккаунта Baidu и теперь готово к активации.
AD_GROUP_CRITERION_UNDER_REVIEW Baidu: В процессе рассмотрения Baidu. Gemini: Критерий на рассмотрении.
AD_GROUP_CRITERION_NOT_REVIEWED Baidu: Критерий, подлежащий пересмотру.
AD_GROUP_CRITERION_ON_HOLD

Устарело. Не использовать. Ранее использовалось Gemini.

AD_GROUP_CRITERION_PENDING_REVIEW Y!J: Критерий ожидает рассмотрения
AD_GROUP_CRITERION_PAUSED Критерий приостановлен.
AD_GROUP_CRITERION_REMOVED Критерий был удален.
AD_GROUP_CRITERION_APPROVED Критерий одобрен.
AD_GROUP_CRITERION_DISAPPROVED Критерий отклонен.
AD_GROUP_CRITERION_SERVING Критерий активен и действует.
AD_GROUP_CRITERION_ACCOUNT_PAUSED Критерий был приостановлен, поскольку учетная запись была приостановлена.

Пользовательский параметр

Сопоставление, которое может использоваться пользовательскими тегами параметров в trackingUrlTemplate , finalUrls или mobile_final_urls .

JSON-представление
{
  "key": string,
  "value": string
}
Поля
key

string

Ключ, соответствующий имени тега параметра.

value

string

Значение, которое необходимо заменить.

KeywordInfo

Критерий ключевого слова.

JSON-представление
{
  "matchType": enum (KeywordMatchType),
  "text": string
}
Поля
matchType

enum ( KeywordMatchType )

Тип соответствия ключевого слова.

text

string

Текст ключевого слова (максимум 80 символов и 10 слов).

KeywordMatchType

Возможные типы соответствия ключевых слов.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
EXACT Точное совпадение.
PHRASE Фразовое соответствие.
BROAD Широкое соответствие.

ListingGroupInfo

Критерий листинговой группы.

JSON-представление
{
  "type": enum (ListingGroupType)
}
Поля
type

enum ( ListingGroupType )

Тип листинговой группы.

ListingGroupType

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

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
SUBDIVISION Разделение товаров по некоторому измерению листинга. Эти узлы не используются для целевого назначения записей листинга, а предназначены исключительно для определения структуры дерева.
UNIT Единица группы листинга, определяющая ставку.

AgeRangeInfo

Критерий возрастного диапазона.

JSON-представление
{
  "type": enum (AgeRangeType)
}
Поля
type

enum ( AgeRangeType )

Тип возрастного диапазона.

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

Тип демографического возрастного диапазона (например, от 18 до 24 лет).

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
AGE_RANGE_18_24 От 18 до 24 лет.
AGE_RANGE_25_34 От 25 до 34 лет.
AGE_RANGE_35_44 От 35 до 44 лет.
AGE_RANGE_45_54 От 45 до 54 лет.
AGE_RANGE_55_64 От 55 до 64 лет.
AGE_RANGE_65_UP 65 лет и старше.
AGE_RANGE_UNDETERMINED Возрастной диапазон не определен.

ГендерИнфо

Гендерный критерий.

JSON-представление
{
  "type": enum (GenderType)
}
Поля
type

enum ( GenderType )

Тип пола.

ПолТип

Тип демографического пола (например, женский).

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
MALE Мужской.
FEMALE Женский.
UNDETERMINED Пол не определен.

UserListInfo

Критерий «Список пользователей». Представляет собой список пользователей, определенных рекламодателем для таргетинга.

JSON-представление
{
  "userList": string
}
Поля
userList

string

Имя ресурса списка пользователей.

Информация о веб-странице

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

JSON-представление
{
  "conditions": [
    {
      object (WebpageConditionInfo)
    }
  ],
  "coveragePercentage": number,
  "criterionName": string
}
Поля
conditions[]

object ( WebpageConditionInfo )

Условия, или логические выражения, для таргетинга веб-страниц. Список условий таргетинга веб-страниц объединяется оператором "И" при оценке таргетинга. Пустой список условий означает, что все страницы веб-сайта кампании таргетингуются.

Это поле обязательно для операций CREATE и запрещено для операций UPDATE.

coveragePercentage

number

Процент покрытия критериев веб-сайта. Это процент покрытия веб-сайта, рассчитанный на основе целевого веб-сайта, запрещенного целевого веб-сайта и минус-слов в группе объявлений и кампании. Например, если значение покрытия равно 1, это означает 100% покрытие. Это поле доступно только для чтения.

criterionName

string

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

Это поле обязательно для операций CREATE и запрещено для операций UPDATE.

Информация о состоянии веб-страницы

Логическое выражение для таргетинга веб-страниц сайта рекламодателя.

JSON-представление
{
  "operand": enum (WebpageConditionOperand),
  "operator": enum (WebpageConditionOperator),
  "argument": string
}
Поля
operand

enum ( WebpageConditionOperand )

Операнд условия таргетинга веб-страницы.

operator

enum ( WebpageConditionOperator )

Оператор условия таргетинга веб-страницы.

argument

string

Аргумент условия таргетинга веб-страницы.

Веб-страницаУсловиеОперанд

Операнд условия веб-страницы в критерии веб-страницы.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
URL Операнд, обозначающий условие таргетинга URL-адреса веб-страницы.
CATEGORY Операнд, обозначающий условие таргетинга категории веб-страницы.
PAGE_TITLE Операнд, обозначающий условие таргетинга на заголовок веб-страницы.
PAGE_CONTENT Операнд, обозначающий условие таргетинга содержимого веб-страницы.
CUSTOM_LABEL Операнд, обозначающий условие таргетинга пользовательской метки веб-страницы.

Веб-страницаСостояниеОператор

Оператор условия веб-страницы в критерии веб-страницы.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
EQUALS Аргументное условие сети равно сравниваемому условию сети.
CONTAINS Аргументное веб-условие является частью сравниваемого веб-условия.

LocationInfo

Критерий местоположения.

JSON-представление
{
  "geoTargetConstant": string
}
Поля
geoTargetConstant

string

Имя постоянного ресурса геоцелевого объекта.

AdGroupCriterionEffectiveLabel

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

JSON-представление
{
  "resourceName": string,
  "adGroupCriterion": string,
  "label": string,
  "ownerCustomerId": string
}
Поля
resourceName

string

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

adGroupCriterion

string

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

label

string

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

ownerCustomerId

string ( int64 format)

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

AdGroupCriterionLabel

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

JSON-представление
{
  "resourceName": string,
  "adGroupCriterion": string,
  "label": string,
  "ownerCustomerId": string
}
Поля
resourceName

string

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

adGroupCriterion

string

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

label

string

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

ownerCustomerId

string ( int64 format)

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

AdGroupEffectiveLabel

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

JSON-представление
{
  "resourceName": string,
  "adGroup": string,
  "label": string,
  "ownerCustomerId": string
}
Поля
resourceName

string

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

adGroup

string

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

label

string

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

ownerCustomerId

string ( int64 format)

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

AdGroupLabel

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

JSON-представление
{
  "resourceName": string,
  "adGroup": string,
  "label": string,
  "ownerCustomerId": string
}
Поля
resourceName

string

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

adGroup

string

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

label

string

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

ownerCustomerId

string ( int64 format)

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

AgeRangeView

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

JSON-представление
{
  "resourceName": string
}
Поля
resourceName

string

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

customers/{customerId}/ageRangeViews/{ad_group_id}~{criterionId}

Объект

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

JSON-представление
{
  "resourceName": string,
  "type": enum (AssetType),
  "finalUrls": [
    string
  ],
  "finalMobileUrls": [
    string
  ],
  "urlCustomParameters": [
    {
      object (CustomParameter)
    }
  ],
  "status": enum (AssetStatus),
  "creationTime": string,
  "lastModifiedTime": string,
  "id": string,
  "name": string,
  "trackingUrlTemplate": string,
  "finalUrlSuffix": string,
  "engineStatus": enum (AssetEngineStatus),

  // Union field asset_data can be only one of the following:
  "youtubeVideoAsset": {
    object (YoutubeVideoAsset)
  },
  "imageAsset": {
    object (ImageAsset)
  },
  "textAsset": {
    object (TextAsset)
  },
  "calloutAsset": {
    object (UnifiedCalloutAsset)
  },
  "sitelinkAsset": {
    object (UnifiedSitelinkAsset)
  },
  "pageFeedAsset": {
    object (UnifiedPageFeedAsset)
  },
  "mobileAppAsset": {
    object (MobileAppAsset)
  },
  "callAsset": {
    object (UnifiedCallAsset)
  },
  "callToActionAsset": {
    object (CallToActionAsset)
  },
  "locationAsset": {
    object (UnifiedLocationAsset)
  }
  // End of list of possible types for union field asset_data.
}
Поля
resourceName

string

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

customers/{customerId}/assets/{assetId}

type

enum ( AssetType )

Тип актива.

finalUrls[]

string

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

finalMobileUrls[]

string

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

urlCustomParameters[]

object ( CustomParameter )

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

status

enum ( AssetStatus )

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

creationTime

string

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

lastModifiedTime

string

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

id

string ( int64 format)

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

name

string

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

trackingUrlTemplate

string

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

finalUrlSuffix

string

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

engineStatus

enum ( AssetEngineStatus )

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

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

object ( YoutubeVideoAsset )

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

imageAsset

object ( ImageAsset )

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

textAsset

object ( TextAsset )

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

calloutAsset

object ( UnifiedCalloutAsset )

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

pageFeedAsset

object ( UnifiedPageFeedAsset )

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

mobileAppAsset

object ( MobileAppAsset )

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

callAsset

object ( UnifiedCallAsset )

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

callToActionAsset

object ( CallToActionAsset )

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

locationAsset

object ( UnifiedLocationAsset )

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

Тип актива

Перечисление, описывающее возможные типы активов.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
YOUTUBE_VIDEO Видеоактив YouTube.
MEDIA_BUNDLE Актив медиа-пакета.
IMAGE Изображение актива.
TEXT Текстовый актив.
LEAD_FORM Актив лид-формы.
BOOK_ON_GOOGLE Книга в активе Google.
PROMOTION Актив продвижения.
CALLOUT Выноска актива.
STRUCTURED_SNIPPET Актив структурированного фрагмента.
PAGE_FEED Актив Page Feed.
DYNAMIC_EDUCATION Динамичный образовательный актив.
MOBILE_APP Актив мобильного приложения.
HOTEL_CALLOUT Актив вызова отеля.
CALL Актив вызова.
PRICE Цена актива.
CALL_TO_ACTION Актив призыва к действию.
DYNAMIC_REAL_ESTATE Динамичный актив недвижимости.
DYNAMIC_CUSTOM Динамический пользовательский актив.
DYNAMIC_HOTELS_AND_RENTALS Динамичный актив отелей и аренды.
DYNAMIC_FLIGHTS Актив динамических полетов.
DYNAMIC_TRAVEL Динамичный туристический актив.
DYNAMIC_LOCAL Динамичный локальный актив.
DYNAMIC_JOBS Динамичный актив рабочих мест.
LOCATION Местоположение актива.
HOTEL_PROPERTY Актив гостиничной недвижимости.

AssetStatus

Возможные статусы актива.

Перечисления
UNSPECIFIED Статус не указан.
UNKNOWN Полученное значение неизвестно в этой версии. Это значение только для ответа.
ENABLED Актив включен.
REMOVED Актив удален.
ARCHIVED Актив заархивирован.
PENDING_SYSTEM_GENERATED Актив создается системой и ожидает проверки пользователем.

AssetEngineStatus

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

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
SERVING Актив активен.
SERVING_LIMITED Актив активен и ограничен.
DISAPPROVED Актив отклонен (не соответствует требованиям).
DISABLED Актив неактивен (ожидает рассмотрения).
REMOVED Актив был удален.

YouTubeVideoAsset

Актив YouTube.

JSON-представление
{
  "youtubeVideoTitle": string,
  "youtubeVideoId": string
}
Поля
youtubeVideoTitle

string

Название видео на YouTube.

youtubeVideoId

string

Идентификатор видео YouTube. Это строка из 11 символов, используемая в URL-адресе видео YouTube.

ImageAsset

Актив изображения.

JSON-представление
{
  "mimeType": enum (MimeType),
  "fullSize": {
    object (ImageDimension)
  },
  "fileSize": string
}
Поля
mimeType

enum ( MimeType )

Тип MIME ресурса изображения.

fullSize

object ( ImageDimension )

Метаданные для этого изображения в исходном размере.

fileSize

string ( int64 format)

Размер файла изображения в байтах.

MimeType

Тип пантомимы

Перечисления
UNSPECIFIED Тип MIME не указан.
UNKNOWN

Полученное значение в этой версии неизвестно.

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

IMAGE_JPEG Тип изображения MIME/jpeg.
IMAGE_GIF MIME-тип изображения/gif.
IMAGE_PNG Тип MIME изображения/png.
FLASH MIME-тип приложения/x-shockwave-flash.
TEXT_HTML Тип MIME text/html.
PDF Тип MIME приложения/pdf.
MSWORD MIME-тип приложения/msword.
MSEXCEL MIME-тип приложения/vnd.ms-excel.
RTF Тип MIME приложения/rtf.
AUDIO_WAV Тип MIME аудио/wav.
AUDIO_MP3 Тип MIME аудио/mp3.
HTML5_AD_ZIP MIME-тип приложения/x-html5-ad-zip.

ImageDimension

Метаданные для изображения определенного размера, как исходного, так и измененного.

JSON-представление
{
  "heightPixels": string,
  "widthPixels": string,
  "url": string
}
Поля
heightPixels

string ( int64 format)

Высота изображения.

widthPixels

string ( int64 format)

Ширина изображения.

url

string

URL-адрес, который возвращает изображение с указанной высотой и шириной.

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

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

JSON-представление
{
  "text": string
}
Поля
text

string

Текстовое содержимое текстового актива.

UnifiedCalloutAsset

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

JSON-представление
{
  "calloutText": string,
  "startDate": string,
  "endDate": string,
  "adScheduleTargets": [
    {
      object (AdScheduleInfo)
    }
  ],
  "useSearcherTimeZone": boolean
}
Поля
calloutText

string

Текст выноски. Длина этой строки должна быть от 1 до 25 символов включительно.

startDate

string

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

endDate

string

Последняя дата, когда данный актив вступает в силу и продолжает служить, в формате гггг-ММ-дд.

adScheduleTargets[]

object ( AdScheduleInfo )

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

useSearcherTimeZone

boolean

Показывать ли ресурс в часовом поясе пользователя поиска. Применимо к Microsoft Ads.

AdScheduleInfo

Представляет критерий AdSchedule.

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

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

JSON-представление
{
  "startMinute": enum (MinuteOfHour),
  "endMinute": enum (MinuteOfHour),
  "dayOfWeek": enum (DayOfWeek),
  "startHour": integer,
  "endHour": integer
}
Поля
startMinute

enum ( MinuteOfHour )

Минуты после часа начала действия этого расписания.

Это поле обязательно для операций CREATE и запрещено для операций UPDATE.

endMinute

enum ( MinuteOfHour )

Минуты после часа окончания действия этого расписания. Расписание не включает минуту окончания.

Это поле обязательно для операций CREATE и запрещено для операций UPDATE.

dayOfWeek

enum ( DayOfWeek )

День недели, к которому относится расписание.

Это поле обязательно для операций CREATE и запрещено для операций UPDATE.

startHour

integer

Начальный час в 24-часовом формате. Значение в этом поле должно быть от 0 до 23 включительно.

Это поле обязательно для операций CREATE и запрещено для операций UPDATE.

endHour

integer

Конечный час в 24-часовом формате; 24 означает конец дня. Значение в этом поле должно быть от 0 до 24 включительно.

Это поле обязательно для операций CREATE и запрещено для операций UPDATE.

MinuteOfHour

Перечисляет четверти часа. Например, «ПЯТНАДЦАТЬ».

Перечисления
UNSPECIFIED Не указан.
UNKNOWN В этой версии значение неизвестно.
ZERO Ноль минут после часа.
FIFTEEN Пятнадцать минут каждого часа.
THIRTY Тридцать минут каждого часа.
FORTY_FIVE Сорок пять минут каждого часа.

ДеньНедели

Перечисляет дни недели, например, «Понедельник».

Перечисления
UNSPECIFIED Не указан.
UNKNOWN В этой версии значение неизвестно.
MONDAY Понедельник.
TUESDAY Вторник.
WEDNESDAY Среда.
THURSDAY Четверг.
FRIDAY Пятница.
SATURDAY Суббота.
SUNDAY Воскресенье.

UnifiedSitelinkAsset

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

JSON-представление
{
  "linkText": string,
  "description1": string,
  "description2": string,
  "startDate": string,
  "endDate": string,
  "adScheduleTargets": [
    {
      object (AdScheduleInfo)
    }
  ],
  "trackingId": string,
  "useSearcherTimeZone": boolean,
  "mobilePreferred": boolean
}
Поля
description1

string

Первая строка описания ссылки сайта. Если задано, длина должна быть от 1 до 35 символов включительно, также необходимо задать параметр description2.

description2

string

Вторая строка описания ссылки сайта. Если задано, длина должна быть от 1 до 35 символов включительно, а также необходимо задать параметр description1.

startDate

string

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

endDate

string

Последняя дата, когда данный актив вступает в силу и продолжает служить, в формате гггг-ММ-дд.

adScheduleTargets[]

object ( AdScheduleInfo )

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

trackingId

string ( int64 format)

Идентификатор, используемый для отслеживания кликов по ссылке сайта. Это поле доступно только в Yahoo! Japan.

useSearcherTimeZone

boolean

Показывать ли ссылку сайта в часовом поясе пользователя поиска. Применимо к Microsoft Ads.

mobilePreferred

boolean

Отображает ли предпочтение ресурсу дополнительной ссылки на мобильных устройствах. Применимо к Microsoft Ads.

UnifiedPageFeedAsset

Актив унифицированной ленты страниц.

JSON-представление
{
  "pageUrl": string,
  "labels": [
    string
  ]
}
Поля
pageUrl

string

Веб-страница, на которую ориентируются рекламодатели.

labels[]

string

Метки, используемые для группировки URL-адресов страниц.

MobileAppAsset

Актив, представляющий мобильное приложение.

JSON-представление
{
  "appId": string,
  "appStore": enum (MobileAppVendor)
}
Поля
appId

string

Обязательно. Строка, однозначно идентифицирующая мобильное приложение. Она должна содержать только собственный идентификатор платформы, например, «com.android.ebay» для Android или «12345689» для iOS.

appStore

enum ( MobileAppVendor )

Обязательно. Магазин приложений, который распространяет это конкретное приложение.

MobileAppVendor

Тип поставщика мобильного приложения

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
APPLE_APP_STORE Поставщик мобильных приложений для магазина приложений Apple.
GOOGLE_APP_STORE Поставщик мобильных приложений для магазина приложений Google.

UnifiedCallAsset

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

JSON-представление
{
  "countryCode": string,
  "phoneNumber": string,
  "callConversionReportingState": enum (CallConversionReportingState),
  "callConversionAction": string,
  "adScheduleTargets": [
    {
      object (AdScheduleInfo)
    }
  ],
  "callOnly": boolean,
  "callTrackingEnabled": boolean,
  "useSearcherTimeZone": boolean,
  "startDate": string,
  "endDate": string
}
Поля
countryCode

string

Двухбуквенный код страны номера телефона. Примеры: «US», «us».

phoneNumber

string

Исходный номер телефона рекламодателя. Примеры: «1234567890», «(123)456-7890».

callConversionReportingState

enum ( CallConversionReportingState )

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

callConversionAction

string

Действие конверсии, которому присваивается конверсия звонка. Если не задано, используется действие конверсии по умолчанию. Это поле действует только в том случае, если для параметра callConversionReportingState задано значение USE_RESOURCE_LEVEL_CALL_CONVERSION_ACTION.

adScheduleTargets[]

object ( AdScheduleInfo )

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

callOnly

boolean

Будет ли при вызове показан только номер телефона без ссылки на веб-сайт. Применимо к Microsoft Ads.

callTrackingEnabled

boolean

Нужно ли включать отслеживание звонков. Применимо к Microsoft Ads.

useSearcherTimeZone

boolean

Показывать ли номер телефона в часовом поясе пользователя поиска. Применимо к Microsoft Ads.

startDate

string

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

endDate

string

Последняя дата, когда данный актив вступает в силу и продолжает служить, в формате гггг-ММ-дд.

CallConversionReportingState

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

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
DISABLED Действие «Конверсия звонка» отключено.
USE_ACCOUNT_LEVEL_CALL_CONVERSION_ACTION Действие «Конверсия звонка» будет использовать тип конверсии звонка, установленный на уровне аккаунта.
USE_RESOURCE_LEVEL_CALL_CONVERSION_ACTION Действие «Конверсия звонка» будет использовать тип конверсии звонка, установленный на уровне ресурса (реклама только для звонков/расширения для звонков).

CallToActionAsset

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

JSON-представление
{
  "callToAction": enum (CallToActionType)
}
Поля
callToAction

enum ( CallToActionType )

Призыв к действию.

CallToActionType

Перечисление, описывающее возможные типы призыва к действию.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
LEARN_MORE Тип призыва к действию — узнать больше.
GET_QUOTE Тип призыва к действию — получить цитату.
APPLY_NOW Тип призыва к действию — «Применить сейчас».
SIGN_UP Тип призыва к действию — регистрация.
CONTACT_US Тип призыва к действию — свяжитесь с нами.
SUBSCRIBE Тип призыва к действию — подписаться.
DOWNLOAD Тип призыва к действию — загрузка.
BOOK_NOW Тип призыва к действию — «Забронировать сейчас».
SHOP_NOW Тип призыва к действию — «Купить сейчас».
BUY_NOW Тип призыва к действию — «купить сейчас».
DONATE_NOW Тип призыва к действию — «Сделать пожертвование сейчас».
ORDER_NOW Тип призыва к действию — «заказать сейчас».
PLAY_NOW Тип призыва к действию — «Воспроизвести сейчас».
SEE_MORE Тип призыва к действию — «подробнее».
START_NOW Тип призыва к действию — «Начать сейчас».
VISIT_SITE Тип призыва к действию — посетить сайт.
WATCH_NOW Тип призыва к действию — «Посмотреть сейчас».

UnifiedLocationAsset

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

JSON-представление
{
  "placeId": string,
  "businessProfileLocations": [
    {
      object (BusinessProfileLocation)
    }
  ],
  "locationOwnershipType": enum (LocationOwnershipType)
}
Поля
placeId

string

Идентификаторы мест однозначно идентифицируют место в базе данных Google Адресов и на Картах Google. Это поле уникально для данного идентификатора клиента и типа объекта. Подробнее об идентификаторе места см. на странице https://developers.google.com/places/web-service/place-id .

businessProfileLocations[]

object ( BusinessProfileLocation )

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

locationOwnershipType

enum ( LocationOwnershipType )

Тип владения местоположением. Если тип — BUSINESS_OWNER, оно будет отображаться как расширение местоположения. Если тип — AFFILIATE, оно будет отображаться как партнерское местоположение.

BusinessProfileLocation

Данные о местоположении бизнес-профиля синхронизируются из связанной учетной записи бизнес-профиля.

JSON-представление
{
  "labels": [
    string
  ],
  "storeCode": string,
  "listingId": string
}
Поля
labels[]

string

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

storeCode

string

Код магазина в профиле компании для этого местоположения. Синхронизируется с учётной записью профиля компании.

listingId

string ( int64 format)

Идентификатор листинга этого местоположения в профиле компании. Синхронизируется с привязанной учетной записью профиля компании.

МестоположениеТип собственности

Возможные типы собственности на местоположение.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
BUSINESS_OWNER Владелец бизнеса по местоположению (устаревшее расширение местоположения - LE).
AFFILIATE Партнерское местоположение (расширение стороннего местоположения - ALE).

AssetGroupAsset

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

JSON-представление
{
  "resourceName": string,
  "assetGroup": string,
  "asset": string,
  "fieldType": enum (AssetFieldType),
  "status": enum (AssetLinkStatus)
}
Поля
resourceName

string

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

customers/{customerId}/assetGroupAssets/{asset_group_id}~{assetId}~{fieldType}

assetGroup

string

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

asset

string

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

fieldType

enum ( AssetFieldType )

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

status

enum ( AssetLinkStatus )

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

AssetFieldType

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

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
HEADLINE Актив связан для использования в качестве заголовка.
DESCRIPTION Актив связан для использования в качестве описания.
MANDATORY_AD_TEXT Актив связан для использования в качестве обязательного рекламного текста.
MARKETING_IMAGE Актив связан для использования в качестве маркетингового изображения.
MEDIA_BUNDLE Актив связан для использования в качестве медиа-пакета.
YOUTUBE_VIDEO Актив связан для использования в качестве видео на YouTube.
BOOK_ON_GOOGLE Актив связан с указанием того, что для кампании по бронированию отелей включена опция «Забронировать через Google».
LEAD_FORM Актив связан для использования в качестве расширения формы для лидов.
PROMOTION Актив привязан к использованию в качестве расширения рекламной акции.
CALLOUT Актив связан для использования в качестве расширения Callout.
STRUCTURED_SNIPPET Актив связан для использования в качестве расширения структурированного сниппета.
MOBILE_APP Актив связан для использования в качестве расширения мобильного приложения.
HOTEL_CALLOUT Актив связан для использования в качестве расширения Hotel Callout.
CALL Актив привязан к использованию в качестве расширения вызова.
PRICE Актив привязан к использованию в качестве расширения цены.
LONG_HEADLINE Актив связан для использования в качестве длинного заголовка.
BUSINESS_NAME Актив привязан к использованию в качестве названия компании.
SQUARE_MARKETING_IMAGE Актив связан для использования в качестве квадратного маркетингового изображения.
PORTRAIT_MARKETING_IMAGE Актив связан для использования в качестве портретного маркетингового изображения.
VIDEO Актив связан для использования в качестве логотипа, не относящегося к YouTube.
CALL_TO_ACTION_SELECTION Актив связан для использования при выборе призыва к действию.
AD_IMAGE Актив связан для использования при выборе рекламного изображения.
HOTEL_PROPERTY Актив привязан к использованию в качестве объекта гостиничного имущества в кампании «Максимальная эффективность для достижения целей в сфере путешествий».
LONG_DESCRIPTION Актив связан для использования в качестве длинного описания.
CALL_TO_ACTION Актив связан для использования в качестве призыва к действию.

AssetGroupSignal

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

JSON-представление
{
  "resourceName": string,
  "assetGroup": string,

  // Union field signal can be only one of the following:
  "audience": {
    object (AudienceInfo)
  }
  // End of list of possible types for union field signal.
}
Поля
resourceName

string

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

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

assetGroup

string

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

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

object ( AudienceInfo )

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

AudienceInfo

Критерий аудитории.

JSON-представление
{
  "audience": string
}
Поля
audience

string

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

AssetGroupListingGroupFilter

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

JSON-представление
{
  "resourceName": string,
  "assetGroup": string,
  "id": string,
  "type": enum (ListingGroupFilterType),
  "vertical": enum (ListingGroupFilterVertical),
  "caseValue": {
    object (ListingGroupFilterDimension)
  },
  "parentListingGroupFilter": string,
  "path": {
    object (ListingGroupFilterDimensionPath)
  }
}
Поля
resourceName

string

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

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

assetGroup

string

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

id

string ( int64 format)

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

type

enum ( ListingGroupFilterType )

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

vertical

enum ( ListingGroupFilterVertical )

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

caseValue

object ( ListingGroupFilterDimension )

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

parentListingGroupFilter

string

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

path

object ( ListingGroupFilterDimensionPath )

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

ListingGroupFilterType

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

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
SUBDIVISION Подразделение продуктов по некоторым листинговым параметрам.
UNIT_INCLUDED Включенный конечный узел фильтра группы листинга.
UNIT_EXCLUDED Конечный узел фильтра исключенной группы листинга.

ListingGroupFilterVertical

Тип фильтра группы листинга вертикальный.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
SHOPPING Представляет вертикаль «Торговля». Эта вертикаль разрешена только в кампаниях с максимальной эффективностью для розничной торговли.

ListingGroupFilterDimension

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

JSON-представление
{

  // Union field dimension can be only one of the following:
  "productBiddingCategory": {
    object (ProductBiddingCategory)
  },
  "productBrand": {
    object (ProductBrand)
  },
  "productChannel": {
    object (ProductChannel)
  },
  "productCondition": {
    object (ProductCondition)
  },
  "productCustomAttribute": {
    object (ProductCustomAttribute)
  },
  "productItemId": {
    object (ProductItemId)
  },
  "productType": {
    object (ProductType)
  }
  // End of list of possible types for union field dimension.
}
Поля
dimension поля объединения. Всегда присутствует размерность одного из перечисленных ниже типов. dimension может быть только одной из следующих:
productBiddingCategory

object ( ProductBiddingCategory )

Категория торгов товарного предложения.

productBrand

object ( ProductBrand )

Бренд товарного предложения.

productChannel

object ( ProductChannel )

Локальность предложения продукта.

productCondition

object ( ProductCondition )

Условие предложения продукта.

productCustomAttribute

object ( ProductCustomAttribute )

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

productItemId

object ( ProductItemId )

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

productType

object ( ProductType )

Тип товарного предложения.

ProductBiddingCategory

Один элемент категории торгов на определённом уровне. Категории верхнего уровня находятся на уровне 1, их дочерние категории — на уровне 2 и т. д. В настоящее время поддерживается до 5 уровней. Пользователь должен указать тип измерения, указывающий уровень категории. Все случаи одного подраздела должны иметь один и тот же тип измерения (уровень категории).

JSON-представление
{
  "level": enum (ListingGroupFilterBiddingCategoryLevel),
  "id": string
}
Поля
level

enum ( ListingGroupFilterBiddingCategoryLevel )

Указывает уровень категории в таксономии.

id

string ( int64 format)

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

Этот идентификатор эквивалентен идентификатору google_product_category, описанному в этой статье: https://support.google.com/merchants/answer/6324436

ListingGroupFilterBiddingCategoryLevel

Уровень категории торгов фильтра группы листинга.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
LEVEL1 Уровень 1.
LEVEL2 Уровень 2.
LEVEL3 Уровень 3.
LEVEL4 Уровень 4.
LEVEL5 Уровень 5.

ProductBrand

Марка продукта.

JSON-представление
{
  "value": string
}
Поля
value

string

Строковое значение бренда продукта.

ProductChannel

Локальность предложения продукта.

JSON-представление
{
  "channel": enum (ListingGroupFilterProductChannel)
}
Поля
channel

enum ( ListingGroupFilterProductChannel )

Ценность местности.

ListingGroupFilterProductChannel

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

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
ONLINE Товар продается через интернет.
LOCAL Товар продается в местных магазинах.

СостояниеПродукта

Условие предложения продукта.

JSON-представление
{
  "condition": enum (ListingGroupFilterProductCondition)
}
Поля
condition

enum ( ListingGroupFilterProductCondition )

Значение условия.

ListingGroupFilterProductCondition

Перечисление, описывающее состояние предложения продукта.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
NEW Состояние товара - новый.
REFURBISHED Состояние товара – восстановленное.
USED Состояние товара - бывший в употреблении.

ProductCustomAttribute

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

JSON-представление
{
  "index": enum (ListingGroupFilterCustomAttributeIndex),
  "value": string
}
Поля
index

enum ( ListingGroupFilterCustomAttributeIndex )

Указывает индекс настраиваемого атрибута.

value

string

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

ListingGroupFilterCustomAttributeIndex

Индекс атрибутов клиента.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
INDEX0 Пользовательский атрибут фильтра первой группы листинга.
INDEX1 Пользовательский атрибут фильтра второй группы листинга.
INDEX2 Пользовательский атрибут фильтра третьей группы листинга.
INDEX3 Четвертый пользовательский атрибут фильтра группы листинга.
INDEX4 Пользовательский атрибут фильтра пятой группы листинга.

ProductItemId

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

JSON-представление
{
  "value": string
}
Поля
value

string

Значение идентификатора.

ТипПродукта

Тип товарного предложения.

JSON-представление
{
  "level": enum (ListingGroupFilterProductTypeLevel),
  "value": string
}
Поля
level

enum ( ListingGroupFilterProductTypeLevel )

Уровень типа.

value

string

Значение типа.

ListingGroupFilterProductTypeLevel

Перечисление, описывающее уровень типа товарного предложения.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
LEVEL1 Уровень 1.
LEVEL2 Уровень 2.
LEVEL3 Уровень 3.
LEVEL4 Уровень 4.
LEVEL5 Уровень 5.

ListingGroupFilterDimensionPath

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

JSON-представление
{
  "dimensions": [
    {
      object (ListingGroupFilterDimension)
    }
  ]
}
Поля
dimensions[]

object ( ListingGroupFilterDimension )

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

AssetGroupTopCombinationView

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

JSON-представление
{
  "resourceName": string,
  "assetGroupTopCombinations": [
    {
      object (AssetGroupAssetCombinationData)
    }
  ]
}
Поля
resourceName

string

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

assetGroupTopCombinations[]

object ( AssetGroupAssetCombinationData )

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

AssetGroupAssetCombinationData

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

JSON-представление
{
  "assetCombinationServedAssets": [
    {
      object (AssetUsage)
    }
  ]
}
Поля
assetCombinationServedAssets[]

object ( AssetUsage )

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

Использование активов

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

JSON-представление
{
  "asset": string,
  "servedAssetFieldType": enum (ServedAssetFieldType)
}
Поля
asset

string

Имя ресурса актива.

servedAssetFieldType

enum ( ServedAssetFieldType )

Тип обслуживаемого поля актива.

ServedAssetFieldType

Возможные типы полей активов.

Перечисления
UNSPECIFIED Значение не указано.
UNKNOWN

Полученное значение в этой версии неизвестно.

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

HEADLINE_1 Актив используется в заголовке 1.
HEADLINE_2 Актив используется в заголовке 2.
HEADLINE_3 Актив используется в заголовке 3.
DESCRIPTION_1 Актив используется в описании 1.
DESCRIPTION_2 Актив используется в описании 2.
HEADLINE Ресурс был использован в заголовке. Используйте это только если в объявлении только один заголовок. В противном случае используйте перечисления HEADLINE_1, HEADLINE_2 или HEADLINE_3.
HEADLINE_IN_PORTRAIT Актив использовался в качестве заголовка на портретном изображении.
LONG_HEADLINE Актив был использован в длинном заголовке (используется в MultiAssetResponsiveAd).
DESCRIPTION Объект был использован в описании. Используйте это только если в объявлении только одно описание. В противном случае используйте перечисления DESCRIPTION_1 или DESCRIPTION_@.
DESCRIPTION_IN_PORTRAIT Актив был использован в качестве описания на портретном изображении.
BUSINESS_NAME_IN_PORTRAIT Актив был использован в качестве названия компании на портретном изображении.
BUSINESS_NAME Актив использовался в качестве названия компании.
MARKETING_IMAGE Объект использовался в качестве маркетингового изображения.
MARKETING_IMAGE_IN_PORTRAIT Объект был использован в качестве маркетингового изображения в портретной ориентации.
SQUARE_MARKETING_IMAGE Актив использовался как квадратное маркетинговое изображение.
PORTRAIT_MARKETING_IMAGE Объект использовался в качестве портретного маркетингового изображения.
CALL_TO_ACTION Актив использовался как призыв к действию.
YOU_TUBE_VIDEO Актив был использован в качестве видео на YouTube.
CALL Данный актив используется как колл.
MOBILE_APP Этот актив используется как мобильное приложение.
CALLOUT Этот актив используется как выноска.
STRUCTURED_SNIPPET Этот актив используется как структурированный фрагмент.
PRICE Этот актив используется в качестве цены.
PROMOTION Этот актив используется в качестве продвижения.
AD_IMAGE Этот актив используется как изображение.
LEAD_FORM Актив используется в качестве лид-формы.
DESCRIPTION_PREFIX Актив используется как префикс описания.

AssetGroup

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

JSON-представление
{
  "resourceName": string,
  "id": string,
  "campaign": string,
  "name": string,
  "finalUrls": [
    string
  ],
  "finalMobileUrls": [
    string
  ],
  "status": enum (AssetGroupStatus),
  "path1": string,
  "path2": string,
  "adStrength": enum (AdStrength)
}
Поля
resourceName

string

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

customers/{customerId}/assetGroups/{asset_group_id}

id

string ( int64 format)

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

campaign

string

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

name

string

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

finalUrls[]

string

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

finalMobileUrls[]

string

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

status

enum ( AssetGroupStatus )

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

path1

string

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

path2

string

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

adStrength

enum ( AdStrength )

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

AssetGroupStatus

Возможные статусы группы активов.

Перечисления
UNSPECIFIED Статус не указан.
UNKNOWN Полученное значение в этой версии неизвестно.
ENABLED Группа активов включена.
PAUSED Группа активов приостановлена.
REMOVED Группа активов удалена.

AdStrength

Перечисление возможных преимуществ рекламы.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
PENDING Сила объявления в настоящее время находится на рассмотрении.
NO_ADS Не удалось сгенерировать ни одной рекламы.
POOR Слабая прочность.
AVERAGE Средняя сила.
GOOD Хорошая прочность.
EXCELLENT Превосходная прочность.

AssetSetAsset

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

JSON-представление
{
  "resourceName": string,
  "assetSet": string,
  "asset": string,
  "status": enum (AssetSetAssetStatus)
}
Поля
resourceName

string

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

customers/{customerId}/assetSetAssets/{asset_set_id}~{assetId}

assetSet

string

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

asset

string

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

status

enum ( AssetSetAssetStatus )

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

AssetSetAssetStatus

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

Перечисления
UNSPECIFIED Статус не указан.
UNKNOWN Полученное значение неизвестно в этой версии. Это значение только для ответа.
ENABLED Актив набора активов включен.
REMOVED Актив набора активов удален.

AssetSet

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

JSON-представление
{
  "id": string,
  "resourceName": string
}
Поля
id

string ( int64 format)

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

resourceName

string

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

customers/{customerId}/assetSets/{asset_set_id}

BiddingStrategy

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

JSON-представление
{
  "resourceName": string,
  "status": enum (BiddingStrategyStatus),
  "type": enum (BiddingStrategyType),
  "currencyCode": string,
  "id": string,
  "name": string,
  "effectiveCurrencyCode": string,
  "campaignCount": string,
  "nonRemovedCampaignCount": string,

  // Union field scheme can be only one of the following:
  "enhancedCpc": {
    object (EnhancedCpc)
  },
  "maximizeConversionValue": {
    object (MaximizeConversionValue)
  },
  "maximizeConversions": {
    object (MaximizeConversions)
  },
  "targetCpa": {
    object (TargetCpa)
  },
  "targetImpressionShare": {
    object (TargetImpressionShare)
  },
  "targetOutrankShare": {
    object (TargetOutrankShare)
  },
  "targetRoas": {
    object (TargetRoas)
  },
  "targetSpend": {
    object (TargetSpend)
  }
  // End of list of possible types for union field scheme.
}
Поля
resourceName

string

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

customers/{customerId}/biddingStrategies/{bidding_strategy_id}

status

enum ( BiddingStrategyStatus )

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

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

type

enum ( BiddingStrategyType )

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

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

currencyCode

string

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

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

id

string ( int64 format)

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

name

string

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

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

effectiveCurrencyCode

string

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

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

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

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

campaignCount

string ( int64 format)

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

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

nonRemovedCampaignCount

string ( int64 format)

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

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

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

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

enhancedCpc

object ( EnhancedCpc )

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

maximizeConversionValue

object ( MaximizeConversionValue )

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

maximizeConversions

object ( MaximizeConversions )

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

targetCpa

object ( TargetCpa )

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

targetImpressionShare

object ( TargetImpressionShare )

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

targetOutrankShare

object ( TargetOutrankShare )

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

targetRoas

object ( TargetRoas )

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

targetSpend

object ( TargetSpend )

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

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

Возможные статусы BiddingStrategy.

Перечисления
UNSPECIFIED Значение не указано.
UNKNOWN

Полученное значение в этой версии неизвестно.

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

ENABLED Стратегия ставок включена.
REMOVED Стратегия ставок удалена.

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

Перечисление, описывающее возможные типы стратегий ставок.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
COMMISSION Комиссия — это автоматическая стратегия ставок, при которой рекламодатель платит определенную часть стоимости конверсии.
ENHANCED_CPC Оптимизированная цена за клик — это стратегия назначения ставок, которая повышает ставки за клики, которые с большей вероятностью приведут к конверсии, и снижает их за клики, которые с меньшей вероятностью приведут к конверсии.
INVALID Используется только для возвращаемого значения. Указывает, что у кампании нет стратегии назначения ставок. Это препятствует показу кампании. Например, кампания может быть привязана к стратегии назначения ставок менеджера, а обслуживающий аккаунт впоследствии отсоединяется от аккаунта менеджера. В этом случае кампания будет автоматически отсоединена от теперь недоступной стратегии назначения ставок менеджера и перейдет к типу стратегии назначения ставок «НЕДЕЙСТВИТЕЛЬНО».
MANUAL_CPA Стратегия ручного назначения ставок, которая позволяет рекламодателю устанавливать ставку за указанное им действие.
MANUAL_CPC Ручное назначение ставок на основе кликов, при котором пользователь платит за клик.
MANUAL_CPM Ручное назначение ставок на основе показов, при котором пользователь платит за тысячу показов.
MANUAL_CPV Стратегия ставок, при которой выплачивается настраиваемая сумма за просмотр видео.
MAXIMIZE_CONVERSIONS Стратегия назначения ставок, которая автоматически максимизирует количество конверсий с учетом дневного бюджета.
MAXIMIZE_CONVERSION_VALUE Автоматизированная стратегия ставок, которая автоматически устанавливает ставки для максимизации дохода при расходовании вашего бюджета.
PAGE_ONE_PROMOTED Схема назначения ставок «Page-One Promoted», которая устанавливает максимальные ставки CPC для показов на первой странице или в слотах, продвигаемых на первой странице, на сайте google.com. Это значение перечисления устарело.
PERCENT_CPC Процентная цена за клик — это стратегия ставок, при которой ставки представляют собой часть рекламируемой цены на какой-либо товар или услугу.
TARGET_CPA Target CPA — это автоматизированная стратегия ставок, которая устанавливает ставки, помогающие получить как можно больше конверсий по заданной вами целевой цене за конверсию (CPA).
TARGET_CPM Target CPM is an automated bid strategy that sets bids to help get as many impressions as possible at the target cost per one thousand impressions (CPM) you set.
TARGET_IMPRESSION_SHARE Автоматизированная стратегия назначения ставок, которая устанавливает ставки таким образом, чтобы определенный процент поисковых объявлений показывался в верхней части первой страницы (или в другом целевом месте).
TARGET_OUTRANK_SHARE Target Outrank Share is an automated bidding strategy that sets bids based on the target fraction of auctions where the advertiser should outrank a specific competitor. This enum value is deprecated.
TARGET_ROAS Target ROAS is an automated bidding strategy that helps you maximize revenue while averaging a specific target Return On Average Spend (ROAS).
TARGET_SPEND Target Spend is an automated bid strategy that sets your bids to help get as many clicks as possible within your budget.

EnhancedCpc

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

An automated bidding strategy that raises bids for clicks that seem more likely to lead to a conversion and lowers them for clicks where they seem less likely.

This bidding strategy is deprecated and cannot be created anymore. Use ManualCpc with enhancedCpcEnabled set to true for equivalent functionality.

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

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

JSON representation
{
  "cpcBidCeilingMicros": string,
  "cpcBidFloorMicros": string,
  "targetRoas": number
}
Поля
cpcBidCeilingMicros

string ( int64 format)

Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.

cpcBidFloorMicros

string ( int64 format)

Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.

targetRoas

number

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

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

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

JSON representation
{
  "cpcBidCeilingMicros": string,
  "cpcBidFloorMicros": string,
  "targetCpaMicros": string
}
Поля
cpcBidCeilingMicros

string ( int64 format)

Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.

cpcBidFloorMicros

string ( int64 format)

Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. Mutable for portfolio bidding strategies only.

targetCpaMicros

string ( int64 format)

The target cost-per-action (CPA) option. This is the average amount that you would like to spend per conversion action specified in micro units of the bidding strategy's currency. If set, the bid strategy will get as many conversions as possible at or below the target cost-per-action. If the target CPA is not set, the bid strategy will aim to achieve the lowest possible CPA given the budget.

TargetCpa

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

JSON representation
{
  "targetCpaMicros": string,
  "cpcBidCeilingMicros": string,
  "cpcBidFloorMicros": string
}
Поля
targetCpaMicros

string ( int64 format)

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

cpcBidCeilingMicros

string ( int64 format)

Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.

cpcBidFloorMicros

string ( int64 format)

Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.

TargetImpressionShare

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

JSON representation
{
  "location": enum (TargetImpressionShareLocation),
  "locationFractionMicros": string,
  "cpcBidCeilingMicros": string
}
Поля
location

enum ( TargetImpressionShareLocation )

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

locationFractionMicros

string ( int64 format)

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

cpcBidCeilingMicros

string ( int64 format)

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

TargetImpressionShareLocation

Enum describing possible goals.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
ANYWHERE_ON_PAGE Any location on the web page.
TOP_OF_PAGE Top box of ads.
ABSOLUTE_TOP_OF_PAGE Top slot in the top box of ads.

TargetOutrankShare

An automated bidding strategy that sets bids based on the target fraction of auctions where the advertiser should outrank a specific competitor. This strategy is deprecated.

JSON representation
{
  "cpcBidCeilingMicros": string
}
Поля
cpcBidCeilingMicros

string ( Int64Value format)

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

TargetRoas

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

JSON representation
{
  "targetRoas": number,
  "cpcBidCeilingMicros": string,
  "cpcBidFloorMicros": string
}
Поля
targetRoas

number

Required. The chosen revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0, inclusive.

cpcBidCeilingMicros

string ( int64 format)

Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.

cpcBidFloorMicros

string ( int64 format)

Minimum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. This should only be set for portfolio bid strategies.

TargetSpend

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

JSON representation
{
  "targetSpendMicros": string,
  "cpcBidCeilingMicros": string
}
Поля
targetSpendMicros
(deprecated)

string ( int64 format)

Deprecated: The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.html for details.

cpcBidCeilingMicros

string ( int64 format)

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

CampaignBudget

A campaign budget.

JSON-представление
{
  "resourceName": string,
  "deliveryMethod": enum (BudgetDeliveryMethod),
  "period": enum (BudgetPeriod),
  "amountMicros": string
}
Поля
resourceName

string

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

customers/{customerId}/campaignBudgets/{campaign_budget_id}

deliveryMethod

enum ( 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

enum ( BudgetPeriod )

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

amountMicros

string ( int64 format)

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.

BudgetDeliveryMethod

Possible delivery methods of a Budget.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
STANDARD The budget server will throttle serving evenly across the entire time period.
ACCELERATED The budget server will not throttle serving, and ads will serve as fast as possible.

BudgetPeriod

Possible period of a Budget.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
DAILY Daily budget.
FIXED_DAILY Fixed daily budget.
CUSTOM_PERIOD Custom budget can be used with total_amount to specify lifetime budget limit.

Кампания

Кампания.

JSON representation
{
  "resourceName": string,
  "status": enum (CampaignStatus),
  "servingStatus": enum (CampaignServingStatus),
  "biddingStrategySystemStatus": enum (BiddingStrategySystemStatus),
  "adServingOptimizationStatus": enum (AdServingOptimizationStatus),
  "advertisingChannelType": enum (AdvertisingChannelType),
  "advertisingChannelSubType": enum (AdvertisingChannelSubType),
  "urlCustomParameters": [
    {
      object (CustomParameter)
    }
  ],
  "realTimeBiddingSetting": {
    object (RealTimeBiddingSetting)
  },
  "networkSettings": {
    object (NetworkSettings)
  },
  "dynamicSearchAdsSetting": {
    object (DynamicSearchAdsSetting)
  },
  "shoppingSetting": {
    object (ShoppingSetting)
  },
  "geoTargetTypeSetting": {
    object (GeoTargetTypeSetting)
  },
  "effectiveLabels": [
    string
  ],
  "labels": [
    string
  ],
  "biddingStrategyType": enum (BiddingStrategyType),
  "accessibleBiddingStrategy": string,
  "frequencyCaps": [
    {
      object (FrequencyCapEntry)
    }
  ],
  "selectiveOptimization": {
    object (SelectiveOptimization)
  },
  "optimizationGoalSetting": {
    object (OptimizationGoalSetting)
  },
  "trackingSetting": {
    object (TrackingSetting)
  },
  "engineId": string,
  "excludedParentAssetFieldTypes": [
    enum (AssetFieldType)
  ],
  "createTime": string,
  "creationTime": string,
  "lastModifiedTime": string,
  "feedTypes": [
    enum (AssetSetType)
  ],
  "id": string,
  "name": string,
  "trackingUrlTemplate": string,
  "campaignBudget": string,
  "startDate": string,
  "endDate": string,
  "finalUrlSuffix": string,
  "urlExpansionOptOut": boolean,

  // Union field campaign_bidding_strategy can be only one of the following:
  "biddingStrategy": string,
  "manualCpa": {
    object (ManualCpa)
  },
  "manualCpc": {
    object (ManualCpc)
  },
  "manualCpm": {
    object (ManualCpm)
  },
  "maximizeConversions": {
    object (MaximizeConversions)
  },
  "maximizeConversionValue": {
    object (MaximizeConversionValue)
  },
  "targetCpa": {
    object (TargetCpa)
  },
  "targetImpressionShare": {
    object (TargetImpressionShare)
  },
  "targetRoas": {
    object (TargetRoas)
  },
  "targetSpend": {
    object (TargetSpend)
  },
  "percentCpc": {
    object (PercentCpc)
  },
  "targetCpm": {
    object (TargetCpm)
  }
  // End of list of possible types for union field campaign_bidding_strategy.
}
Поля
resourceName

string

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

customers/{customerId}/campaigns/{campaign_id}

status

enum ( CampaignStatus )

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

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

servingStatus

enum ( CampaignServingStatus )

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

biddingStrategySystemStatus

enum ( BiddingStrategySystemStatus )

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

adServingOptimizationStatus

enum ( AdServingOptimizationStatus )

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

advertisingChannelType

enum ( AdvertisingChannelType )

The primary serving target for ads within the campaign. The targeting options can be refined in networkSettings .

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

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

advertisingChannelSubType

enum ( AdvertisingChannelSubType )

Optional refinement to advertisingChannelType . Must be a valid sub-type of the parent channel type.

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

urlCustomParameters[]

object ( CustomParameter )

The list of mappings used to substitute custom parameter tags in a trackingUrlTemplate , finalUrls , or mobile_final_urls .

realTimeBiddingSetting

object ( RealTimeBiddingSetting )

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

networkSettings

object ( NetworkSettings )

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

dynamicSearchAdsSetting

object ( DynamicSearchAdsSetting )

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

shoppingSetting

object ( ShoppingSetting )

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

geoTargetTypeSetting

object ( GeoTargetTypeSetting )

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

effectiveLabels[]

string

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

labels[]

string

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

biddingStrategyType

enum ( BiddingStrategyType )

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

A bidding strategy can be created by setting either the bidding scheme to create a standard bidding strategy or the biddingStrategy field to create a portfolio bidding strategy.

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

accessibleBiddingStrategy

string

Resource name of AccessibleBiddingStrategy, a read-only view of the unrestricted attributes of the attached portfolio bidding strategy identified by 'biddingStrategy'. Empty, if the campaign does not use a portfolio strategy. Unrestricted strategy attributes are available to all customers with whom the strategy is shared and are read from the AccessibleBiddingStrategy resource. In contrast, restricted attributes are only available to the owner customer of the strategy and their managers. Restricted attributes can only be read from the BiddingStrategy resource.

frequencyCaps[]

object ( FrequencyCapEntry )

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

selectiveOptimization

object ( SelectiveOptimization )

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

optimizationGoalSetting

object ( OptimizationGoalSetting )

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

trackingSetting

object ( TrackingSetting )

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

engineId

string

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

excludedParentAssetFieldTypes[]

enum ( AssetFieldType )

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

createTime

string

The timestamp when this campaign was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format. createTime will be deprecated in v1. Use creationTime instead.

creationTime

string

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

lastModifiedTime

string

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

feedTypes[]

enum ( AssetSetType )

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

id

string ( int64 format)

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

name

string

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

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

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

trackingUrlTemplate

string

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

campaignBudget

string

The resource name of the campaign budget of the campaign.

startDate

string

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

endDate

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.

finalUrlSuffix

string

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

urlExpansionOptOut

boolean

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:

biddingStrategy

string

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

manualCpa

object ( 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.

manualCpc

object ( ManualCpc )

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

manualCpm

object ( ManualCpm )

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

maximizeConversions

object ( MaximizeConversions )

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

maximizeConversionValue

object ( MaximizeConversionValue )

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

targetCpa

object ( 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.

targetImpressionShare

object ( TargetImpressionShare )

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

targetRoas

object ( TargetRoas )

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

targetSpend

object ( TargetSpend )

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

percentCpc

object ( PercentCpc )

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

targetCpm

object ( TargetCpm )

A bidding strategy that automatically optimizes cost per thousand impressions.

CampaignStatus

Possible statuses of a campaign.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
ENABLED Campaign is active and can show ads.
PAUSED Campaign has been paused by the user.
REMOVED Campaign has been removed.

CampaignServingStatus

Possible serving statuses of a campaign.

Перечисления
UNSPECIFIED Значение не указано.
UNKNOWN

Полученное значение в этой версии неизвестно.

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

SERVING Подача.
NONE Никто.
ENDED Закончено.
PENDING В ожидании.
SUSPENDED Приостановленный.

Статус системы стратегии торгов

Возможные системные статусы BiddingStrategy.

Перечисления
UNSPECIFIED Сигнализирует о том, что произошла непредвиденная ошибка, например, не найден тип стратегии ставок или не найдена информация о статусе.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
ENABLED Стратегия назначения ставок активна, и AdWords не может обнаружить никаких конкретных проблем с ней.
LEARNING_NEW Стратегия ставок является обучающейся, поскольку она была недавно создана или недавно реактивирована.
LEARNING_SETTING_CHANGE Стратегия ставок обучается из-за недавнего изменения настроек.
LEARNING_BUDGET_CHANGE Стратегия подачи заявок учитывала недавние изменения в бюджете.
LEARNING_COMPOSITION_CHANGE Стратегия ставок обучается на основе недавних изменений в количестве кампаний, групп объявлений или ключевых слов, прикрепленных к ней.
LEARNING_CONVERSION_TYPE_CHANGE Стратегия ставок зависит от отчетов по конверсиям и недавно измененных клиентом типов конверсий, которые имеют отношение к стратегии ставок.
LEARNING_CONVERSION_SETTING_CHANGE Стратегия ставок зависит от отчетов по конверсиям, а клиент недавно изменил свои настройки конверсий.
LIMITED_BY_CPC_BID_CEILING Стратегия ставок ограничена потолком ставок.
LIMITED_BY_CPC_BID_FLOOR Стратегия ставок ограничена ее нижней границей ставки.
LIMITED_BY_DATA Стратегия ставок ограничена, поскольку за последние недели не было достаточного количества конверсионного трафика.
LIMITED_BY_BUDGET Значительная часть ключевых слов в этой стратегии ставок ограничена бюджетом.
LIMITED_BY_LOW_PRIORITY_SPEND Стратегия ставок не может достичь целевых расходов, поскольку ее расходы стали неприоритетными.
LIMITED_BY_LOW_QUALITY Значительная часть ключевых слов в этой стратегии ставок имеет низкий показатель качества.
LIMITED_BY_INVENTORY Стратегия ставок не может полностью расходовать свой бюджет из-за узкого таргетинга.
MISCONFIGURED_ZERO_ELIGIBILITY Отсутствуют отслеживание конверсий (нет пингов) и/или списки ремаркетинга для SSC.
MISCONFIGURED_CONVERSION_TYPES Стратегия ставок зависит от отчетности по конверсиям, а у клиента отсутствуют типы конверсий, которые можно было бы включить в отчетность по этой стратегии.
MISCONFIGURED_CONVERSION_SETTINGS Стратегия ставок зависит от отчетов по конверсиям, а настройки конверсий клиента настроены неправильно.
MISCONFIGURED_SHARED_BUDGET Существуют кампании за пределами стратегии назначения ставок, которые разделяют бюджеты с кампаниями, включенными в стратегию.
MISCONFIGURED_STRATEGY_TYPE Кампания имеет недопустимый тип стратегии и не показывается.
PAUSED Стратегия назначения ставок неактивна. Либо к ней не привязаны активные кампании, группы объявлений или ключевые слова, либо к ней не привязаны активные бюджеты.
UNAVAILABLE В настоящее время эта стратегия ставок не поддерживает отчетность о статусе.
MULTIPLE_LEARNING В рассматриваемый период времени для этой стратегии ставок существовало несколько системных статусов LEARNING_*.
MULTIPLE_LIMITED В рассматриваемый период для этой стратегии ставок существовало несколько системных статусов LIMITED_*.
MULTIPLE_MISCONFIGURED В рассматриваемый период для этой стратегии ставок наблюдалось несколько системных статусов MISCONFIGURED_*.
MULTIPLE В рассматриваемый период времени для этой стратегии ставок существовало несколько системных статусов.

AdServingOptimizationStatus

Перечисление, описывающее возможные статусы обслуживания.

Перечисления
UNSPECIFIED Значение не указано.
UNKNOWN

Полученное значение в этой версии неизвестно.

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

OPTIMIZE Показ рекламы оптимизируется на основе CTR кампании.
CONVERSION_OPTIMIZE Показ объявлений оптимизируется по формуле CTR * Конверсия для кампании. Если кампания не входит в стратегию назначения ставок оптимизатора конверсий, по умолчанию будет выбрана стратегия «Оптимизировано».
ROTATE Объявления равномерно ротируются в течение 90 дней, затем оптимизируются по кликам.
ROTATE_INDEFINITELY Показывайте менее эффективные объявления более равномерно вместе с более эффективными и не оптимизируйте.
UNAVAILABLE Статус оптимизации показа рекламы недоступен.

Тип канала рекламы

Перечисление, описывающее различные типы рекламных каналов.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
SEARCH Поисковая сеть. Включает пакетные кампании в медийной рекламе и кампании Search+.
DISPLAY Только контекстно-медийная сеть Google.
SHOPPING Торговые кампании показываются на сайте магазина и в результатах поиска google.com.
HOTEL Рекламные кампании в отелях.
VIDEO Видеокампании.
MULTI_CHANNEL Кампании для приложений и кампании для вовлечения приложений, которые проводятся по нескольким каналам.
LOCAL Локальные рекламные кампании.
SMART Умные кампании.
PERFORMANCE_MAX Кампании с максимальной эффективностью.
LOCAL_SERVICES Кампании по предоставлению местных услуг.
DISCOVERY Кампании по поиску информации.
TRAVEL Туристические кампании.
SOCIAL Социальные кампании.

РекламныйКаналПодТип

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

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только как возвращаемое значение. Представляет значение, неизвестное в этой версии.
SEARCH_MOBILE_APP Рекламные кампании мобильных приложений для поиска.
DISPLAY_MOBILE_APP Рекламные кампании в мобильных приложениях для контекстно-медийной сети.
SEARCH_EXPRESS Экспресс-кампании AdWords для поиска.
DISPLAY_EXPRESS Рекламные кампании AdWords Express.
SHOPPING_SMART_ADS Умные торговые кампании.
DISPLAY_GMAIL_AD Рекламные кампании Gmail.
DISPLAY_SMART_CAMPAIGN Умные кампании в контекстно-медийной сети. Новые кампании этого подтипа не могут быть созданы.
VIDEO_OUTSTREAM Видеокампании Outstream.
VIDEO_ACTION Видеокампании TrueView for Action.
VIDEO_NON_SKIPPABLE Видеокампании с рекламой, которую нельзя пропустить.
APP_CAMPAIGN Кампания для приложений, которая позволяет вам легко продвигать свое приложение для Android или iOS на ведущих ресурсах Google, включая Поиск, Play, YouTube и контекстно-медийную сеть Google.
APP_CAMPAIGN_FOR_ENGAGEMENT Кампания по вовлечению пользователей в приложение, направленная на стимулирование повторного взаимодействия с приложением на нескольких ведущих ресурсах Google, включая Поиск, YouTube и контекстно-медийную сеть Google.
LOCAL_CAMPAIGN Кампании, специализированные для местной рекламы.
SHOPPING_COMPARISON_LISTING_ADS Кампании по сравнению товаров.
SMART_CAMPAIGN Стандартные смарт-кампании.
VIDEO_SEQUENCE Видеокампании с последовательностью видеороликов.
APP_CAMPAIGN_FOR_PRE_REGISTRATION Рекламная кампания для предварительной регистрации мобильных приложений, ориентированная на предварительную регистрацию и нацеленная на несколько рекламных каналов в Google Play, YouTube и контекстно-медийной сети.
VIDEO_REACH_TARGET_FREQUENCY Видеокампания с охватом и стратегией назначения ставок «Целевая частота».
TRAVEL_ACTIVITIES Кампании по организации туристических мероприятий.
SOCIAL_FACEBOOK_TRACKING_ONLY Facebook отслеживает только социальные кампании.

RealTimeBiddingSetting

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

JSON representation
{
  "optIn": boolean
}
Поля
optIn

boolean

Whether the campaign is opted in to real-time bidding.

NetworkSettings

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

JSON representation
{
  "targetGoogleSearch": boolean,
  "targetSearchNetwork": boolean,
  "targetContentNetwork": boolean,
  "targetPartnerSearchNetwork": boolean
}
Поля
targetSearchNetwork

boolean

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

targetContentNetwork

boolean

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

targetPartnerSearchNetwork

boolean

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

DynamicSearchAdsSetting

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

JSON representation
{
  "domainName": string,
  "languageCode": string,
  "useSuppliedUrlsOnly": boolean
}
Поля
domainName

string

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

languageCode

string

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

useSuppliedUrlsOnly

boolean

Whether the campaign uses advertiser supplied URLs exclusively.

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.

JSON representation
{
  "feedLabel": string,
  "useVehicleInventory": boolean,
  "merchantId": string,
  "salesCountry": string,
  "campaignPriority": integer,
  "enableLocal": boolean
}
Поля
feedLabel

string

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

useVehicleInventory

boolean

Whether to target Vehicle Listing inventory.

merchantId

string ( int64 format)

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

salesCountry

string

Sales country of products to include in the campaign.

campaignPriority

integer

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.

enableLocal

boolean

Whether to include local products.

GeoTargetTypeSetting

Represents a collection of settings related to ads geotargeting.

JSON representation
{
  "positiveGeoTargetType": enum (PositiveGeoTargetType),
  "negativeGeoTargetType": enum (NegativeGeoTargetType)
}
Поля
positiveGeoTargetType

enum ( PositiveGeoTargetType )

The setting used for positive geotargeting in this particular campaign.

negativeGeoTargetType

enum ( NegativeGeoTargetType )

The setting used for negative geotargeting in this particular campaign.

PositiveGeoTargetType

The possible positive geo target types.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN В этой версии значение неизвестно.
PRESENCE_OR_INTEREST Specifies that an ad is triggered if the user is in, or shows interest in, advertiser's targeted locations.
SEARCH_INTEREST Specifies that an ad is triggered if the user searches for advertiser's targeted locations. This can only be used with Search and standard Shopping campaigns.
PRESENCE Specifies that an ad is triggered if the user is in or regularly in advertiser's targeted locations.

NegativeGeoTargetType

The possible negative geo target types.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN В этой версии значение неизвестно.
PRESENCE_OR_INTEREST Specifies that a user is excluded from seeing the ad if they are in, or show interest in, advertiser's excluded locations.
PRESENCE Specifies that a user is excluded from seeing the ad if they are in advertiser's excluded locations.

FrequencyCapEntry

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

A rule specifying the maximum number of times an ad (or some set of ads) can be shown to a user over a particular time period.

SelectiveOptimization

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

JSON representation
{
  "conversionActions": [
    string
  ]
}
Поля
conversionActions[]

string

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

OptimizationGoalSetting

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

JSON representation
{
  "optimizationGoalTypes": [
    enum (OptimizationGoalType)
  ]
}
Поля
optimizationGoalTypes[]

enum ( OptimizationGoalType )

The list of optimization goal types.

OptimizationGoalType

The type of optimization goal

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только как возвращаемое значение. Представляет значение, неизвестное в этой версии.
CALL_CLICKS Optimize for call clicks. Call click conversions are times people selected 'Call' to contact a store after viewing an ad.
DRIVING_DIRECTIONS Optimize for driving directions. Driving directions conversions are times people selected 'Get directions' to navigate to a store after viewing an ad.
APP_PRE_REGISTRATION Optimize for pre-registration. Pre-registration conversions are the number of pre-registration signups to receive a notification when the app is released.

TrackingSetting

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

JSON representation
{
  "trackingUrl": string
}
Поля
trackingUrl

string

The url used for dynamic tracking.

AssetSetType

Возможные типы набора активов.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
PAGE_FEED Набор активов страницы.
DYNAMIC_EDUCATION Динамический набор образовательных активов.
MERCHANT_CENTER_FEED Набор активов Google Merchant Center.
DYNAMIC_REAL_ESTATE Динамический набор активов недвижимости.
DYNAMIC_CUSTOM Динамический пользовательский набор активов.
DYNAMIC_HOTELS_AND_RENTALS Динамичный набор активов для отелей и аренды.
DYNAMIC_FLIGHTS Набор динамических активов для полетов.
DYNAMIC_TRAVEL Динамический набор туристических активов.
DYNAMIC_LOCAL Динамический локальный набор активов.
DYNAMIC_JOBS Динамический набор активов заданий.
LOCATION_SYNC Набор активов уровня синхронизации местоположения.
BUSINESS_PROFILE_DYNAMIC_LOCATION_GROUP Набор активов группы местоположений бизнес-профиля.
CHAIN_DYNAMIC_LOCATION_GROUP Набор активов группы локаций сети, который можно использовать как для собственных локаций, так и для аффилированных локаций.
STATIC_LOCATION_GROUP Набор активов статической группы местоположений, который можно использовать как для собственных местоположений, так и для филиалов.
HOTEL_PROPERTY Набор активов Hotel Property, который используется для привязки фида гостиничных объектов к Performance Max для кампаний по достижению целей в сфере путешествий.
TRAVEL_FEED Тип набора ресурсов «Лента путешествий». Может представлять собой либо ленту отелей, либо ленту мероприятий.

ManualCpa

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

Manual bidding strategy that allows advertiser to set the bid per advertiser-specified action.

ManualCpc

Manual click-based bidding where user pays per click.

JSON representation
{
  "enhancedCpcEnabled": boolean
}
Поля
enhancedCpcEnabled

boolean

Whether bids are to be enhanced based on conversion optimizer data.

ManualCpm

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

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

PercentCpc

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

JSON representation
{
  "cpcBidCeilingMicros": string,
  "enhancedCpcEnabled": boolean
}
Поля
cpcBidCeilingMicros

string ( int64 format)

Maximum bid limit that can be set by the bid strategy. This is an optional field entered by the advertiser and specified in local micros. Note: A zero value is interpreted in the same way as having bid_ceiling undefined.

enhancedCpcEnabled

boolean

Adjusts the bid for each auction upward or downward, depending on the likelihood of a conversion. Individual bids may exceed cpcBidCeilingMicros, but the average bid amount for a campaign should not.

TargetCpm

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

Target CPM (cost per thousand impressions) is an automated bidding strategy that sets bids to optimize performance given the target CPM you set.

CampaignAsset

A link between a Campaign and an Asset.

JSON representation
{
  "resourceName": string,
  "status": enum (AssetLinkStatus),
  "campaign": string,
  "asset": string
}
Поля
resourceName

string

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

customers/{customerId}/campaignAssets/{campaign_id}~{assetId}~{fieldType}

status

enum ( 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.

JSON representation
{
  "resourceName": string,
  "campaign": string,
  "assetSet": string,
  "status": enum (AssetSetLinkStatus)
}
Поля
resourceName

string

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

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

campaign

string

The campaign to which this asset set is linked.

assetSet

string

The asset set which is linked to the campaign.

status

enum ( 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.

JSON representation
{
  "resourceName": string
}
Поля
resourceName

string

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

customers/{customerId}/campaignAudienceViews/{campaign_id}~{criterionId}

CampaignCriterion

A campaign criterion.

JSON representation
{
  "resourceName": string,
  "displayName": string,
  "type": enum (CriterionType),
  "status": enum (CampaignCriterionStatus),
  "lastModifiedTime": string,
  "criterionId": string,
  "bidModifier": number,
  "negative": boolean,

  // Union field criterion can be only one of the following:
  "keyword": {
    object (KeywordInfo)
  },
  "location": {
    object (LocationInfo)
  },
  "device": {
    object (DeviceInfo)
  },
  "ageRange": {
    object (AgeRangeInfo)
  },
  "gender": {
    object (GenderInfo)
  },
  "userList": {
    object (UserListInfo)
  },
  "language": {
    object (LanguageInfo)
  },
  "webpage": {
    object (WebpageInfo)
  },
  "locationGroup": {
    object (LocationGroupInfo)
  }
  // End of list of possible types for union field criterion.
}
Поля
resourceName

string

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

customers/{customerId}/campaignCriteria/{campaign_id}~{criterionId}

displayName

string

The display name of the criterion.

This field is ignored for mutates.

type

enum ( CriterionType )

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

status

enum ( CampaignCriterionStatus )

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

lastModifiedTime

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.

criterionId

string ( int64 format)

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

This field is ignored during mutate.

bidModifier

number

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

boolean

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

Union field criterion . The campaign criterion.

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

keyword

object ( KeywordInfo )

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

location

object ( LocationInfo )

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

device

object ( DeviceInfo )

Устройство.

ageRange

object ( AgeRangeInfo )

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

gender

object ( GenderInfo )

Пол.

userList

object ( UserListInfo )

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

language

object ( LanguageInfo )

Язык.

webpage

object ( WebpageInfo )

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

locationGroup

object ( LocationGroupInfo )

Location Group

CampaignCriterionStatus

The possible statuses of a CampaignCriterion.

Перечисления
UNSPECIFIED Значение не указано.
UNKNOWN

Полученное значение в этой версии неизвестно.

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

ENABLED The campaign criterion is enabled.
PAUSED The campaign criterion is paused.
REMOVED The campaign criterion is removed.

LanguageInfo

A language criterion.

JSON representation
{
  "languageConstant": string
}
Поля
languageConstant

string

The language constant resource name.

LocationGroupInfo

A radius around a list of locations specified through a feed.

JSON representation
{
  "geoTargetConstants": [
    string
  ],
  "radiusUnits": enum (LocationGroupRadiusUnits),
  "feedItemSets": [
    string
  ],
  "radius": string
}
Поля
geoTargetConstants[]

string

Geo target constant(s) restricting the scope of the geographic area within the feed. Currently only one geo target constant is allowed.

radiusUnits

enum ( LocationGroupRadiusUnits )

Unit of the radius. Miles and meters are supported for geo target constants. Milli miles and meters are supported for feed item sets. This is required and must be set in CREATE operations.

feedItemSets[]

string

FeedItemSets whose FeedItems are targeted. If multiple IDs are specified, then all items that appear in at least one set are targeted. This field cannot be used with geoTargetConstants. This is optional and can only be set in CREATE operations.

radius

string ( int64 format)

Distance in units specifying the radius around targeted locations. This is required and must be set in CREATE operations.

LocationGroupRadiusUnits

The unit of radius distance in location group (for example, MILES)

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
METERS Метры
MILES Майлз
MILLI_MILES Milli Miles

CampaignEffectiveLabel

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

JSON representation
{
  "resourceName": string,
  "campaign": string,
  "label": string,
  "ownerCustomerId": string
}
Поля
resourceName

string

Name of the resource. CampaignEffectivelabel resource names have the form: customers/{ownerCustomerId}/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.

ownerCustomerId

string ( int64 format)

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

CampaignLabel

Represents a relationship between a campaign and a label.

JSON representation
{
  "resourceName": string,
  "campaign": string,
  "label": string,
  "ownerCustomerId": string
}
Поля
resourceName

string

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

campaign

string

The campaign to which the label is attached.

label

string

The label assigned to the campaign.

ownerCustomerId

string ( int64 format)

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

CartDataSalesView

Cart data sales view.

JSON-представление
{
  "resourceName": string
}
Поля
resourceName

string

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

Аудитория

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

JSON representation
{
  "resourceName": string,
  "id": string,
  "name": string,
  "description": string
}
Поля
resourceName

string

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

customers/{customerId}/audiences/{audience_id}

id

string ( int64 format)

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

name

string

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

description

string

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

ConversionAction

A conversion action.

JSON representation
{
  "resourceName": string,
  "creationTime": string,
  "status": enum (ConversionActionStatus),
  "type": enum (ConversionActionType),
  "category": enum (ConversionActionCategory),
  "valueSettings": {
    object (ValueSettings)
  },
  "attributionModelSettings": {
    object (AttributionModelSettings)
  },
  "floodlightSettings": {
    object (FloodlightSettings)
  },
  "id": string,
  "name": string,
  "primaryForGoal": boolean,
  "ownerCustomer": string,
  "includeInClientAccountConversionsMetric": boolean,
  "includeInConversionsMetric": boolean,
  "clickThroughLookbackWindowDays": string,
  "appId": string
}
Поля
resourceName

string

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

customers/{customerId}/conversionActions/{conversion_action_id}

creationTime

string

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

status

enum ( ConversionActionStatus )

The status of this conversion action for conversion event accrual.

type

enum ( ConversionActionType )

The type of this conversion action.

category

enum ( ConversionActionCategory )

The category of conversions reported for this conversion action.

valueSettings

object ( ValueSettings )

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

attributionModelSettings

object ( AttributionModelSettings )

Settings related to this conversion action's attribution model.

floodlightSettings

object ( FloodlightSettings )

Floodlight settings for Floodlight conversion types.

id

string ( int64 format)

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.

primaryForGoal

boolean

If a conversion action's primaryForGoal 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 primaryForGoal, so if a campaign has a custom conversion goal configured with a primaryForGoal = false conversion action, that conversion action is still biddable. By default, primaryForGoal will be true if not set. In V9, primaryForGoal can only be set to false after creation through an 'update' operation because it's not declared as optional.

ownerCustomer

string

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

includeInClientAccountConversionsMetric

boolean

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

includeInConversionsMetric

boolean

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

clickThroughLookbackWindowDays

string ( int64 format)

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

appId

string

App ID for an app conversion action.

ConversionActionStatus

Possible statuses of a conversion action.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
ENABLED Conversions will be recorded.
REMOVED Conversions will not be recorded.
HIDDEN Conversions will not be recorded and the conversion action will not appear in the UI.

ConversionActionType

Possible types of a conversion action.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
AD_CALL Conversions that occur when a user clicks on an ad's call extension.
CLICK_TO_CALL Conversions that occur when a user on a mobile device clicks a phone number.
GOOGLE_PLAY_DOWNLOAD Conversions that occur when a user downloads a mobile app from the Google Play Store.
GOOGLE_PLAY_IN_APP_PURCHASE Conversions that occur when a user makes a purchase in an app through Android billing.
UPLOAD_CALLS Call conversions that are tracked by the advertiser and uploaded.
UPLOAD_CLICKS Conversions that are tracked by the advertiser and uploaded with attributed clicks.
WEBPAGE Conversions that occur on a webpage.
WEBSITE_CALL Conversions that occur when a user calls a dynamically-generated phone number from an advertiser's website.
STORE_SALES_DIRECT_UPLOAD Store Sales conversion based on first-party or third-party merchant data uploads. Only customers on the allowlist can use store sales direct upload types.
STORE_SALES Store Sales conversion based on first-party or third-party merchant data uploads and/or from in-store purchases using cards from payment networks. Only customers on the allowlist can use store sales types. Read only.
FIREBASE_ANDROID_FIRST_OPEN Android app first open conversions tracked through Firebase.
FIREBASE_ANDROID_IN_APP_PURCHASE Android app in app purchase conversions tracked through Firebase.
FIREBASE_ANDROID_CUSTOM Android app custom conversions tracked through Firebase.
FIREBASE_IOS_FIRST_OPEN iOS app first open conversions tracked through Firebase.
FIREBASE_IOS_IN_APP_PURCHASE iOS app in app purchase conversions tracked through Firebase.
FIREBASE_IOS_CUSTOM iOS app custom conversions tracked through Firebase.
THIRD_PARTY_APP_ANALYTICS_ANDROID_FIRST_OPEN Android app first open conversions tracked through Third Party App Analytics.
THIRD_PARTY_APP_ANALYTICS_ANDROID_IN_APP_PURCHASE Android app in app purchase conversions tracked through Third Party App Analytics.
THIRD_PARTY_APP_ANALYTICS_ANDROID_CUSTOM Android app custom conversions tracked through Third Party App Analytics.
THIRD_PARTY_APP_ANALYTICS_IOS_FIRST_OPEN iOS app first open conversions tracked through Third Party App Analytics.
THIRD_PARTY_APP_ANALYTICS_IOS_IN_APP_PURCHASE iOS app in app purchase conversions tracked through Third Party App Analytics.
THIRD_PARTY_APP_ANALYTICS_IOS_CUSTOM iOS app custom conversions tracked through Third Party App Analytics.
ANDROID_APP_PRE_REGISTRATION Conversions that occur when a user pre-registers a mobile app from the Google Play Store. Read only.
ANDROID_INSTALLS_ALL_OTHER_APPS Conversions that track all Google Play downloads which aren't tracked by an app-specific type. Read only.
FLOODLIGHT_ACTION Floodlight activity that counts the number of times that users have visited a particular webpage after seeing or clicking on one of an advertiser's ads. Read only.
FLOODLIGHT_TRANSACTION Floodlight activity that tracks the number of sales made or the number of items purchased. Can also capture the total value of each sale. Read only.
GOOGLE_HOSTED Conversions that track local actions from Google's products and services after interacting with an ad. Read only.
LEAD_FORM_SUBMIT Conversions reported when a user submits a lead form. Read only.
SALESFORCE

Deprecated: The Salesforce integration will be going away and replaced with an improved way to import your conversions from Salesforce. - see https://support.google.com/google-ads/answer/14728349

SEARCH_ADS_360 Conversions imported from Search Ads 360 Floodlight data. Read only.
SMART_CAMPAIGN_AD_CLICKS_TO_CALL Call conversions that occur on Smart campaign Ads without call tracking setup, using Smart campaign custom criteria. Read only.
SMART_CAMPAIGN_MAP_CLICKS_TO_CALL The user clicks on a call element within Google Maps. Smart campaign only. Read only.
SMART_CAMPAIGN_MAP_DIRECTIONS The user requests directions to a business location within Google Maps. Smart campaign only. Read only.
SMART_CAMPAIGN_TRACKED_CALLS Call conversions that occur on Smart campaign Ads with call tracking setup, using Smart campaign custom criteria. Read only.
STORE_VISITS Conversions that occur when a user visits an advertiser's retail store. Read only.
WEBPAGE_CODELESS Conversions created from website events (such as form submissions or page loads), that don't use individually coded event snippets. Read only.
UNIVERSAL_ANALYTICS_GOAL Conversions that come from linked Universal Analytics goals.
UNIVERSAL_ANALYTICS_TRANSACTION Conversions that come from linked Universal Analytics transactions.
GOOGLE_ANALYTICS_4_CUSTOM Conversions that come from linked Google Analytics 4 custom event conversions.
GOOGLE_ANALYTICS_4_PURCHASE Conversions that come from linked Google Analytics 4 purchase conversions.

ConversionActionCategory

The category of conversions that are associated with a ConversionAction.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
DEFAULT Default category.
PAGE_VIEW User visiting a page.
PURCHASE Purchase, sales, or "order placed" event.
SIGNUP Signup user action.
LEAD Lead-generating action.
DOWNLOAD Software download action (as for an app).
ADD_TO_CART The addition of items to a shopping cart or bag on an advertiser site.
BEGIN_CHECKOUT When someone enters the checkout flow on an advertiser site.
SUBSCRIBE_PAID The start of a paid subscription for a product or service.
PHONE_CALL_LEAD A call to indicate interest in an advertiser's offering.
IMPORTED_LEAD A lead conversion imported from an external source into Google Ads.
SUBMIT_LEAD_FORM A submission of a form on an advertiser site indicating business interest.
BOOK_APPOINTMENT A booking of an appointment with an advertiser's business.
REQUEST_QUOTE A quote or price estimate request.
GET_DIRECTIONS A search for an advertiser's business location with intention to visit.
OUTBOUND_CLICK A click to an advertiser's partner's site.
CONTACT A call, SMS, email, chat or other type of contact to an advertiser.
ENGAGEMENT A website engagement event such as long site time or a Google Analytics (GA) Smart Goal. Intended to be used for GA, Firebase, GA Gold goal imports.
STORE_VISIT A visit to a physical store location.
STORE_SALE A sale occurring in a physical store.
QUALIFIED_LEAD A lead conversion imported from an external source into Google Ads, that has been further qualified by the advertiser (marketing/sales team). In the lead-to-sale journey, advertisers get leads, then act on them by reaching out to the consumer. If the consumer is interested and may end up buying their product, the advertiser marks such leads as "qualified leads".
CONVERTED_LEAD A lead conversion imported from an external source into Google Ads, that has further completed a chosen stage as defined by the lead gen advertiser.

ValueSettings

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

JSON representation
{
  "defaultValue": number,
  "defaultCurrencyCode": string,
  "alwaysUseDefaultValue": boolean
}
Поля
defaultValue

number

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.

defaultCurrencyCode

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.

alwaysUseDefaultValue

boolean

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.

AttributionModelSettings

Settings related to this conversion action's attribution model.

JSON representation
{
  "attributionModel": enum (AttributionModel),
  "dataDrivenModelStatus": enum (DataDrivenModelStatus)
}
Поля
attributionModel

enum ( AttributionModel )

The attribution model type of this conversion action.

dataDrivenModelStatus

enum ( DataDrivenModelStatus )

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

AttributionModel

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

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
EXTERNAL Использует внешнюю атрибуцию.
GOOGLE_ADS_LAST_CLICK Приписывает всю ценность конверсии последнему клику.
GOOGLE_SEARCH_ATTRIBUTION_FIRST_CLICK Приписывает всю ценность конверсии первому клику с использованием атрибуции поиска Google.
GOOGLE_SEARCH_ATTRIBUTION_LINEAR Приписывает ценность конверсии равномерно по всем кликам с использованием атрибуции поиска Google.
GOOGLE_SEARCH_ATTRIBUTION_TIME_DECAY Приписывает экспоненциально больше веса конверсии своим последним кликам с использованием атрибуции поиска Google (период полураспада составляет 1 неделю).
GOOGLE_SEARCH_ATTRIBUTION_POSITION_BASED Приписывает 40% ценности конверсии первому и последнему кликам. Оставшиеся 20% равномерно распределяются между всеми остальными кликами. Используется атрибуция Google Поиска.
GOOGLE_SEARCH_ATTRIBUTION_DATA_DRIVEN Гибкая модель, которая использует машинное обучение для определения соответствующего распределения кредита между кликами с использованием атрибуции поиска Google.

DataDrivenModelStatus

Enumerates data driven model statuses.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
AVAILABLE The data driven model is available.
STALE The data driven model is stale. It hasn't been updated for at least 7 days. It is still being used, but will become expired if it does not get updated for 30 days.
EXPIRED The data driven model expired. It hasn't been updated for at least 30 days and cannot be used. Most commonly this is because there hasn't been the required number of events in a recent 30-day period.
NEVER_GENERATED The data driven model has never been generated. Most commonly this is because there has never been the required number of events in any 30-day period.

FloodlightSettings

Settings related to a Floodlight conversion action.

JSON representation
{
  "activityGroupTag": string,
  "activityTag": string,
  "activityId": string
}
Поля
activityGroupTag

string

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

activityTag

string

String used to identify a Floodlight activity when reporting conversions.

activityId

string ( int64 format)

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

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

JSON representation
{
  "resourceName": string,
  "id": string,
  "name": string,
  "tag": string,
  "status": enum (ConversionCustomVariableStatus),
  "ownerCustomer": string,
  "family": enum (ConversionCustomVariableFamily),
  "cardinality": enum (ConversionCustomVariableCardinality),
  "floodlightConversionCustomVariableInfo": {
    object (FloodlightConversionCustomVariableInfo)
  },
  "customColumnIds": [
    string
  ]
}
Поля
resourceName

string

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

customers/{customerId}/conversionCustomVariables/{conversion_custom_variable_id}

id

string ( int64 format)

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

enum ( ConversionCustomVariableStatus )

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

ownerCustomer

string

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

family

enum ( ConversionCustomVariableFamily )

Family of the conversion custom variable.

cardinality

enum ( ConversionCustomVariableCardinality )

Cardinality of the conversion custom variable.

floodlightConversionCustomVariableInfo

object ( FloodlightConversionCustomVariableInfo )

Fields for Search Ads 360 floodlight conversion custom variables.

customColumnIds[]

string ( int64 format)

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

ConversionCustomVariableStatus

Possible statuses of a conversion custom variable.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
ACTIVATION_NEEDED

The conversion custom variable is pending activation and will not accrue stats until set to ENABLED.

This status can't be used in CREATE and UPDATE requests.

ENABLED The conversion custom variable is enabled and will accrue stats.
PAUSED The conversion custom variable is paused and will not accrue stats until set to ENABLED again.

ConversionCustomVariableFamily

Family of a conversion custom variable.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
STANDARD The standard conversion custom variable. Customers are required to activate before use.
FLOODLIGHT The conversion custom variable imported from a custom floodlight variable.

ConversionCustomVariableCardinality

Cardinality of a conversion custom variable.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
BELOW_ALL_LIMITS The conversion custom variable has cardinality below all limits. The variable can be used for segmentation, and stats can accrue for new values if the variable is enabled.
EXCEEDS_SEGMENTATION_LIMIT_BUT_NOT_STATS_LIMIT The conversion custom variable has cardinality that exceeds the segmentation limit, but does not exceed the stats limit. Segmentation will be disabled, but stats can accrue for new values if the variable is enabled.
APPROACHES_STATS_LIMIT The conversion custom variable has exceeded the segmentation limits, and is approaching the stats limits (> 90%). Segmentation will be disabled, but stats can accrue for new values if the variable is enabled.
EXCEEDS_STATS_LIMIT The conversion custom variable has exceeded both the segmentation limits and stats limits. Segmentation will be disabled, and stats for enabled variables can accrue only if the existing values do not increase the cardinality of the variable any further.

FloodlightConversionCustomVariableInfo

Information for Search Ads 360 Floodlight Conversion Custom Variables.

JSON representation
{
  "floodlightVariableType": enum (FloodlightVariableType),
  "floodlightVariableDataType": enum (FloodlightVariableDataType)
}
Поля
floodlightVariableType

enum ( FloodlightVariableType )

Floodlight variable type defined in Search Ads 360.

floodlightVariableDataType

enum ( FloodlightVariableDataType )

Floodlight variable data type defined in Search Ads 360.

FloodlightVariableType

Type of the floodlight variable, as defined in the Search Ads 360. See https://support.google.com/searchads/answer/4397154?hl=en to learn more.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
DIMENSION Dimension floodlight variable type.
METRIC Metric floodlight variable type.
UNSET Floodlight variable type is unset.

FloodlightVariableDataType

The data type of the floodlight variable, as defined in Search Ads 360. See https://support.google.com/searchads/answer/4397154?hl=en to learn more.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
NUMBER Represents a floodlight variable of "Number" type. This variable may be assigned to floodlight variables of DIMENSION or METRIC types.
STRING Represents a floodlight variable of "String" type. This variable may be assigned to floodlight variables of DIMENSION type.

Клиент

Клиент.

JSON representation
{
  "resourceName": string,
  "conversionTrackingSetting": {
    object (ConversionTrackingSetting)
  },
  "accountType": enum (AccountType),
  "doubleClickCampaignManagerSetting": {
    object (DoubleClickCampaignManagerSetting)
  },
  "accountStatus": enum (AccountStatus),
  "lastModifiedTime": string,
  "engineId": string,
  "status": enum (CustomerStatus),
  "creationTime": string,
  "managerId": string,
  "managerDescriptiveName": string,
  "subManagerId": string,
  "subManagerDescriptiveName": string,
  "associateManagerId": string,
  "associateManagerDescriptiveName": string,
  "accountLevel": enum (AccountLevelType),
  "id": string,
  "descriptiveName": string,
  "currencyCode": string,
  "timeZone": string,
  "trackingUrlTemplate": string,
  "finalUrlSuffix": string,
  "autoTaggingEnabled": boolean,
  "manager": boolean
}
Поля
resourceName

string

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

customers/{customerId}

conversionTrackingSetting

object ( ConversionTrackingSetting )

Conversion tracking setting for a customer.

accountType

enum ( AccountType )

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

doubleClickCampaignManagerSetting

object ( DoubleClickCampaignManagerSetting )

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

accountStatus

enum ( AccountStatus )

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

lastModifiedTime

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.

engineId

string

ID of the account in the external engine account.

status

enum ( CustomerStatus )

The status of the customer.

creationTime

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.

managerId

string ( int64 format)

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

managerDescriptiveName

string

The descriptive name of the manager.

subManagerId

string ( int64 format)

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

subManagerDescriptiveName

string

The descriptive name of the sub manager.

associateManagerId

string ( int64 format)

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

associateManagerDescriptiveName

string

The descriptive name of the associate manager.

accountLevel

enum ( AccountLevelType )

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

id

string ( int64 format)

The ID of the customer.

descriptiveName

string

Optional, non-unique descriptive name of the customer.

currencyCode

string

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

timeZone

string

The local timezone ID of the customer.

trackingUrlTemplate

string

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

finalUrlSuffix

string

The URL template for appending params to the final URL.

autoTaggingEnabled

boolean

Whether auto-tagging is enabled for the customer.

manager

boolean

Whether the customer is a manager.

ConversionTrackingSetting

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

JSON representation
{
  "acceptedCustomerDataTerms": boolean,
  "conversionTrackingStatus": enum (ConversionTrackingStatus),
  "enhancedConversionsForLeadsEnabled": boolean,
  "googleAdsConversionCustomer": string,
  "conversionTrackingId": string,
  "googleAdsCrossAccountConversionTrackingId": string,
  "crossAccountConversionTrackingId": string
}
Поля
acceptedCustomerDataTerms

boolean

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 .

conversionTrackingStatus

enum ( 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.

enhancedConversionsForLeadsEnabled

boolean

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.

googleAdsConversionCustomer

string

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

conversionTrackingId

string ( int64 format)

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

googleAdsCrossAccountConversionTrackingId

string ( int64 format)

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

crossAccountConversionTrackingId

string ( int64 format)

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 conversionTrackingId.

ConversionTrackingStatus

Conversion Tracking status of the customer.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
NOT_CONVERSION_TRACKED Customer does not use any conversion tracking.
CONVERSION_TRACKING_MANAGED_BY_SELF The conversion actions are created and managed by this customer.
CONVERSION_TRACKING_MANAGED_BY_THIS_MANAGER The conversion actions are created and managed by the manager specified in the request's login-customer-id .
CONVERSION_TRACKING_MANAGED_BY_ANOTHER_MANAGER The conversion actions are created and managed by a manager different from the customer or manager specified in the request's login-customer-id .

Тип учетной записи

Возможные типы учетных записей движка.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
BAIDU Аккаунт Baidu.
ENGINE_TRACK Учетная запись Engine Track.
FACEBOOK Аккаунт на Facebook.
FACEBOOK_GATEWAY Аккаунт Facebook управляется через шлюз.
GOOGLE_ADS Аккаунт Google Рекламы.
MICROSOFT Аккаунт Microsoft Advertising.
SEARCH_ADS_360 Управляющий аккаунт Search Ads 360.
YAHOO_JAPAN Аккаунт Yahoo Japan.

DoubleClickCampaignManagerSetting

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

JSON representation
{
  "advertiserId": string,
  "networkId": string,
  "timeZone": string
}
Поля
advertiserId

string ( int64 format)

ID of the Campaign Manager advertiser associated with this customer.

networkId

string ( int64 format)

ID of the Campaign Manager network associated with this customer.

timeZone

string

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

Статус аккаунта

Возможные статусы счета.

Перечисления
UNSPECIFIED Значение по умолчанию.
UNKNOWN Неизвестное значение.
ENABLED Аккаунт может показывать рекламу.
PAUSED Учетная запись деактивирована пользователем.
SUSPENDED Учетная запись деактивирована внутренним процессом.
REMOVED Учетная запись безвозвратно деактивирована.
DRAFT Учетная запись все еще находится в процессе настройки и пока не ВКЛЮЧЕНА.

CustomerStatus

Possible statuses of a customer.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
ENABLED Indicates an active account able to serve ads.
CANCELED Indicates a canceled account unable to serve ads. Can be reactivated by an admin user.
SUSPENDED Indicates a suspended account unable to serve ads. May only be activated by Google support.
CLOSED Indicates a closed account unable to serve ads. Test account will also have CLOSED status. Status is permanent and may not be reopened.

AccountLevelType

Перечисление, описывающее возможные уровни аккаунта.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
CLIENT_ACCOUNT_FACEBOOK Клиентский аккаунт (Facebook)
CLIENT_ACCOUNT_GOOGLE_ADS Клиентский аккаунт (Google Ads)
CLIENT_ACCOUNT_MICROSOFT Клиентский аккаунт (Microsoft)
CLIENT_ACCOUNT_YAHOO_JAPAN Клиентский аккаунт (Yahoo Japan)
CLIENT_ACCOUNT_ENGINE_TRACK Клиентский аккаунт (Engine Track)
MANAGER Менеджер высшего уровня.
SUB_MANAGER Младший менеджер.
ASSOCIATE_MANAGER Заместитель управляющего.

CustomerAsset

A link between a customer and an asset.

JSON representation
{
  "resourceName": string,
  "asset": string,
  "status": enum (AssetLinkStatus)
}
Поля
resourceName

string

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

customers/{customerId}/customerAssets/{assetId}~{fieldType}

asset

string

Required. The asset which is linked to the customer.

status

enum ( 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.

JSON representation
{
  "resourceName": string,
  "assetSet": string,
  "customer": string,
  "status": enum (AssetSetLinkStatus)
}
Поля
resourceName

string

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

customers/{customerId}/customerAssetSets/{asset_set_id}

assetSet

string

The asset set which is linked to the customer.

customer

string

The customer to which this asset set is linked.

status

enum ( AssetSetLinkStatus )

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

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

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

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

JSON representation
{
  "resourceName": string,
  "id": string,
  "name": string,
  "type": enum (BiddingStrategyType),
  "ownerCustomerId": string,
  "ownerDescriptiveName": string,

  // Union field scheme can be only one of the following:
  "maximizeConversionValue": {
    object (MaximizeConversionValue)
  },
  "maximizeConversions": {
    object (MaximizeConversions)
  },
  "targetCpa": {
    object (TargetCpa)
  },
  "targetImpressionShare": {
    object (TargetImpressionShare)
  },
  "targetRoas": {
    object (TargetRoas)
  },
  "targetSpend": {
    object (TargetSpend)
  }
  // End of list of possible types for union field scheme.
}
Поля
resourceName

string

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

customers/{customerId}/accessibleBiddingStrategies/{bidding_strategy_id}

id

string ( int64 format)

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

name

string

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

type

enum ( BiddingStrategyType )

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

ownerCustomerId

string ( int64 format)

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

ownerDescriptiveName

string

descriptiveName of the Customer which owns the bidding strategy.

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

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

maximizeConversionValue

object ( MaximizeConversionValue )

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

maximizeConversions

object ( MaximizeConversions )

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

targetCpa

object ( TargetCpa )

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

targetImpressionShare

object ( TargetImpressionShare )

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

targetRoas

object ( TargetRoas )

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

targetSpend

object ( TargetSpend )

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

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

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

JSON-представление
{
  "targetRoas": number
}
Поля
targetRoas

number

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

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

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

JSON representation
{
  "targetCpa": string,
  "targetCpaMicros": string
}
Поля
targetCpa

string ( int64 format)

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

targetCpaMicros

string ( int64 format)

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

TargetCpa

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

JSON representation
{
  "targetCpaMicros": string
}
Поля
targetCpaMicros

string ( int64 format)

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

TargetImpressionShare

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

JSON representation
{
  "location": enum (TargetImpressionShareLocation),
  "locationFractionMicros": string,
  "cpcBidCeilingMicros": string
}
Поля
location

enum ( TargetImpressionShareLocation )

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

locationFractionMicros

string ( int64 format)

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

cpcBidCeilingMicros

string ( int64 format)

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

TargetRoas

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

JSON representation
{
  "targetRoas": number
}
Поля
targetRoas

number

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

TargetSpend

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

JSON representation
{
  "targetSpendMicros": string,
  "cpcBidCeilingMicros": string
}
Поля
targetSpendMicros
(deprecated)

string ( int64 format)

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

cpcBidCeilingMicros

string ( int64 format)

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

ManagerLinkStatus

Possible statuses of a link.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
ACTIVE Indicates current in-effect relationship
INACTIVE Indicates terminated relationship
PENDING Indicates relationship has been requested by manager, but the client hasn't accepted yet.
REFUSED Relationship was requested by the manager, but the client has refused.
CANCELED Indicates relationship has been requested by manager, but manager canceled it.

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.

JSON representation
{
  "resourceName": string,
  "appliedLabels": [
    string
  ],
  "status": enum (CustomerStatus),
  "clientCustomer": string,
  "hidden": boolean,
  "level": string,
  "timeZone": string,
  "testAccount": boolean,
  "manager": boolean,
  "descriptiveName": string,
  "currencyCode": string,
  "id": string
}
Поля
resourceName

string

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

appliedLabels[]

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/{customerId}/labels/{label_id}

status

enum ( CustomerStatus )

The status of the client customer. Read only.

clientCustomer

string

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

hidden

boolean

Specifies whether this is a hidden account.

Read only.

level

string ( int64 format)

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

timeZone

string

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

testAccount

boolean

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

manager

boolean

Identifies if the client is a manager. Read only.

descriptiveName

string

Descriptive name for the client. Read only.

currencyCode

string

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

id

string ( int64 format)

The ID of the client customer. Read only.

DynamicSearchAdsSearchTermView

A dynamic search ads search term view.

JSON representation
{
  "resourceName": string,
  "landingPage": string
}
Поля
resourceName

string

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

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

landingPage

string

The dynamically selected landing page URL of the impression.

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

GenderView

A gender view. The genderView 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 genderView with stats.

JSON representation
{
  "resourceName": string
}
Поля
resourceName

string

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

customers/{customerId}/genderViews/{ad_group_id}~{criterionId}

GeoTargetConstant

A geo target constant.

JSON representation
{
  "resourceName": string,
  "status": enum (GeoTargetConstantStatus),
  "id": string,
  "name": string,
  "countryCode": string,
  "targetType": string,
  "canonicalName": string,
  "parentGeoTarget": string
}
Поля
resourceName

string

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

geoTargetConstants/{geo_target_constant_id}

status

enum ( GeoTargetConstantStatus )

Geo target constant status.

id

string ( int64 format)

The ID of the geo target constant.

name

string

Geo target constant English name.

countryCode

string

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

targetType

string

Geo target constant target type.

canonicalName

string

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

parentGeoTarget

string

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

geoTargetConstants/{parent_geo_target_constant_id}

GeoTargetConstantStatus

The possible statuses of a geo target constant.

Перечисления
UNSPECIFIED Значение не указано.
UNKNOWN

Полученное значение в этой версии неизвестно.

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

ENABLED The geo target constant is valid.
REMOVAL_PLANNED The geo target constant is obsolete and will be removed.

KeywordView

A keyword view.

JSON representation
{
  "resourceName": string
}
Поля
resourceName

string

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

customers/{customerId}/keywordViews/{ad_group_id}~{criterionId}

Этикетка

A label.

JSON representation
{
  "resourceName": string,
  "status": enum (LabelStatus),
  "textLabel": {
    object (TextLabel)
  },
  "id": string,
  "name": string
}
Поля
resourceName

string

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

status

enum ( LabelStatus )

Status of the label. Read only.

textLabel

object ( TextLabel )

A type of label displaying text on a colored background.

id

string ( int64 format)

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.

LabelStatus

Possible statuses of a label.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
ENABLED Label is enabled.
REMOVED Label is removed.

Текстовая метка

A type of label displaying text on a colored background.

JSON representation
{
  "backgroundColor": string,
  "description": string
}
Поля
backgroundColor

string

Background color of the label in HEX format. This string must match the regular expression '^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$'. Note: The background color may not be visible for manager accounts.

description

string

A short description of the label. The length must be no more than 200 characters.

LanguageConstant

Язык.

JSON representation
{
  "resourceName": string,
  "id": string,
  "code": string,
  "name": string,
  "targetable": boolean
}
Поля
resourceName

string

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

languageConstants/{criterionId}

id

string ( int64 format)

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

boolean

Whether the language is targetable.

LocationView

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

JSON-представление
{
  "resourceName": string
}
Поля
resourceName

string

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

customers/{customerId}/locationViews/{campaign_id}~{criterionId}

ProductBiddingCategoryConstant

A Product Bidding Category.

JSON representation
{
  "resourceName": string,
  "level": enum (ProductBiddingCategoryLevel),
  "status": enum (ProductBiddingCategoryStatus),
  "id": string,
  "countryCode": string,
  "productBiddingCategoryConstantParent": string,
  "languageCode": string,
  "localizedName": string
}
Поля
resourceName

string

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

productBiddingCategoryConstants/{countryCode}~{level}~{id}

level

enum ( ProductBiddingCategoryLevel )

Level of the product bidding category.

status

enum ( ProductBiddingCategoryStatus )

Status of the product bidding category.

id

string ( int64 format)

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 .

countryCode

string

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

productBiddingCategoryConstantParent

string

Resource name of the parent product bidding category.

languageCode

string

Language code of the product bidding category.

localizedName

string

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

ProductBiddingCategoryLevel

Enum describing the level of the product bidding category.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
LEVEL1 Уровень 1.
LEVEL2 Уровень 2.
LEVEL3 Уровень 3.
LEVEL4 Уровень 4.
LEVEL5 Level 5.

ProductBiddingCategoryStatus

Enum describing the status of the product bidding category.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
ACTIVE The category is active and can be used for bidding.
OBSOLETE The category is obsolete. Used only for reporting purposes.

ProductGroupView

A product group view.

JSON representation
{
  "resourceName": string
}
Поля
resourceName

string

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

customers/{customerId}/productGroupViews/{ad_group_id}~{criterionId}

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.

JSON representation
{
  "resourceName": string
}
Поля
resourceName

string

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

UserList

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

JSON representation
{
  "resourceName": string,
  "type": enum (UserListType),
  "id": string,
  "name": string
}
Поля
resourceName

string

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

customers/{customerId}/userLists/{user_list_id}

type

enum ( UserListType )

Type of this list.

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

id

string ( int64 format)

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)

UserListType

Enum containing possible user list types.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
REMARKETING UserList represented as a collection of conversion types.
LOGICAL UserList represented as a combination of other user lists/interests.
EXTERNAL_REMARKETING UserList created in the Google Ad Manager platform.
RULE_BASED UserList associated with a rule.
SIMILAR UserList with users similar to users of another UserList.
CRM_BASED UserList of first-party CRM data provided by advertiser in the form of emails or other formats.

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.

JSON representation
{
  "resourceName": string,
  "countryCriterionId": string,
  "targetingLocation": boolean
}
Поля
resourceName

string

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

customers/{customerId}/userLocationViews/{countryCriterionId}~{targetingLocation}

countryCriterionId

string ( int64 format)

Criterion Id for the country.

targetingLocation

boolean

Indicates whether location was targeted or not.

WebpageView

A webpage view.

JSON representation
{
  "resourceName": string
}
Поля
resourceName

string

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

customers/{customerId}/webpageViews/{ad_group_id}~{criterionId}

Посещать

A visit.

JSON representation
{
  "resourceName": string,
  "id": string,
  "criterionId": string,
  "merchantId": string,
  "adId": string,
  "clickId": string,
  "visitDateTime": string,
  "productId": string,
  "productChannel": enum (ProductChannel),
  "productLanguageCode": string,
  "productStoreId": string,
  "productCountryCode": string,
  "assetId": string,
  "assetFieldType": enum (AssetFieldType)
}
Поля
resourceName

string

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

customers/{customerId}/visits/{ad_group_id}~{criterionId}~{ds_visit_id}

id

string ( int64 format)

The ID of the visit.

criterionId

string ( int64 format)

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

merchantId

string ( int64 format)

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.

adId

string ( int64 format)

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

clickId

string

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

visitDateTime

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.

productId

string

The ID of the product clicked on.

productChannel

enum ( ProductChannel )

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

productLanguageCode

string

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

productStoreId

string

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

productCountryCode

string

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

assetId

string ( int64 format)

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

assetFieldType

enum ( AssetFieldType )

Asset field type of the visit event.

ProductChannel

Enum describing the locality of a product offer.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
ONLINE The item is sold online.
LOCAL The item is sold in local stores.

Конверсия

A conversion.

JSON representation
{
  "resourceName": string,
  "id": string,
  "criterionId": string,
  "merchantId": string,
  "adId": string,
  "clickId": string,
  "visitId": string,
  "advertiserConversionId": string,
  "productId": string,
  "productChannel": enum (ProductChannel),
  "productLanguageCode": string,
  "productStoreId": string,
  "productCountryCode": string,
  "attributionType": enum (AttributionType),
  "conversionDateTime": string,
  "conversionLastModifiedDateTime": string,
  "conversionVisitDateTime": string,
  "conversionQuantity": string,
  "conversionRevenueMicros": string,
  "floodlightOriginalRevenue": string,
  "floodlightOrderId": string,
  "status": enum (ConversionStatus),
  "assetId": string,
  "assetFieldType": enum (AssetFieldType)
}
Поля
resourceName

string

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

customers/{customerId}/conversions/{ad_group_id}~{criterionId}~{ds_conversion_id}

id

string ( int64 format)

The ID of the conversion

criterionId

string ( int64 format)

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

merchantId

string ( int64 format)

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.

adId

string ( int64 format)

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

clickId

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.

visitId

string ( int64 format)

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

advertiserConversionId

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 floodlightOrderId column depending on the advertiser's Floodlight instructions.

productId

string

The ID of the product clicked on.

productChannel

enum ( ProductChannel )

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

productLanguageCode

string

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

productStoreId

string

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

productCountryCode

string

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

attributionType

enum ( AttributionType )

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

conversionDateTime

string

The timestamp of the conversion event.

conversionLastModifiedDateTime

string

The timestamp of the last time the conversion was modified.

conversionVisitDateTime

string

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

conversionQuantity

string ( int64 format)

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.

conversionRevenueMicros

string ( int64 format)

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

floodlightOriginalRevenue

string ( int64 format)

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

floodlightOrderId

string

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

status

enum ( ConversionStatus )

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

assetId

string ( int64 format)

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

assetFieldType

enum ( AssetFieldType )

Asset field type of the conversion event.

AttributionType

Тип атрибуции конверсии в SearchAds360

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
VISIT Конверсия приписывается посещению.
CRITERION_AD Конверсия приписывается критерию и паре объявлений.

ConversionStatus

Possible statuses of a conversion.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
ENABLED The conversion is enabled.
REMOVED The conversion has been removed.

Метрики

Metrics data.

JSON-представление
{
  "allConversionsValueByConversionDate": number,
  "allConversionsByConversionDate": number,
  "conversionCustomMetrics": [
    {
      object (Value)
    }
  ],
  "conversionsValueByConversionDate": number,
  "conversionsByConversionDate": number,
  "historicalCreativeQualityScore": enum (QualityScoreBucket),
  "historicalLandingPageQualityScore": enum (QualityScoreBucket),
  "historicalSearchPredictedCtr": enum (QualityScoreBucket),
  "interactionEventTypes": [
    enum (InteractionEventType)
  ],
  "rawEventConversionMetrics": [
    {
      object (Value)
    }
  ],
  "absoluteTopImpressionPercentage": number,
  "allConversionsFromInteractionsRate": number,
  "allConversionsValue": number,
  "allConversions": number,
  "allConversionsValuePerCost": number,
  "allConversionsFromClickToCall": number,
  "allConversionsFromDirections": number,
  "allConversionsFromInteractionsValuePerInteraction": number,
  "allConversionsFromMenu": number,
  "allConversionsFromOrder": number,
  "allConversionsFromOtherEngagement": number,
  "allConversionsFromStoreVisit": number,
  "visits": number,
  "allConversionsFromStoreWebsite": number,
  "averageCost": number,
  "averageCpc": number,
  "averageCpm": number,
  "clicks": string,
  "contentBudgetLostImpressionShare": number,
  "contentImpressionShare": number,
  "contentRankLostImpressionShare": number,
  "conversionsFromInteractionsRate": number,
  "clientAccountConversionsValue": number,
  "conversionsValuePerCost": number,
  "conversionsFromInteractionsValuePerInteraction": number,
  "clientAccountConversions": number,
  "costMicros": string,
  "costPerAllConversions": number,
  "costPerConversion": number,
  "costPerCurrentModelAttributedConversion": number,
  "crossDeviceConversions": number,
  "crossDeviceConversionsByConversionDate": number,
  "crossDeviceConversionsValue": number,
  "crossDeviceConversionsValueByConversionDate": number,
  "ctr": number,
  "conversions": number,
  "conversionsValue": number,
  "averageQualityScore": number,
  "historicalQualityScore": string,
  "impressions": string,
  "interactionRate": number,
  "interactions": string,
  "invalidClickRate": number,
  "invalidClicks": string,
  "generalInvalidClickRate": number,
  "generalInvalidClicks": string,
  "mobileFriendlyClicksPercentage": number,
  "searchAbsoluteTopImpressionShare": number,
  "searchBudgetLostAbsoluteTopImpressionShare": number,
  "searchBudgetLostImpressionShare": number,
  "searchBudgetLostTopImpressionShare": number,
  "searchClickShare": number,
  "searchExactMatchImpressionShare": number,
  "searchImpressionShare": number,
  "searchRankLostAbsoluteTopImpressionShare": number,
  "searchRankLostImpressionShare": number,
  "searchRankLostTopImpressionShare": number,
  "searchTopImpressionShare": number,
  "topImpressionPercentage": number,
  "valuePerAllConversions": number,
  "valuePerAllConversionsByConversionDate": number,
  "valuePerConversion": number,
  "valuePerConversionsByConversionDate": number,
  "clientAccountViewThroughConversions": string,
  "clientAccountCrossSellCostOfGoodsSoldMicros": string,
  "crossSellCostOfGoodsSoldMicros": string,
  "clientAccountCrossSellGrossProfitMicros": string,
  "crossSellGrossProfitMicros": string,
  "clientAccountCrossSellRevenueMicros": string,
  "crossSellRevenueMicros": string,
  "clientAccountCrossSellUnitsSold": number,
  "crossSellUnitsSold": number,
  "clientAccountLeadCostOfGoodsSoldMicros": string,
  "leadCostOfGoodsSoldMicros": string,
  "clientAccountLeadGrossProfitMicros": string,
  "leadGrossProfitMicros": string,
  "clientAccountLeadRevenueMicros": string,
  "leadRevenueMicros": string,
  "clientAccountLeadUnitsSold": number,
  "leadUnitsSold": number,
  "uniqueUsers": string,
  "averageImpressionFrequencyPerUser": number
}
Поля
allConversionsValueByConversionDate

number

The value of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611 .

allConversionsByConversionDate

number

The total number of conversions. This includes all conversions regardless of the value of includeInConversionsMetric. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611 .

conversionCustomMetrics[]

object ( Value )

The conversion custom metrics.

conversionsValueByConversionDate

number

The sum of biddable conversions value by conversion date. When this column is selected with date, the values in date column means the conversion date.

conversionsByConversionDate

number

The sum of conversions by conversion date for biddable conversion types. Can be fractional due to attribution modeling. When this column is selected with date, the values in date column means the conversion date.

historicalCreativeQualityScore

enum ( QualityScoreBucket )

The creative historical quality score.

historicalLandingPageQualityScore

enum ( QualityScoreBucket )

The quality of historical landing page experience.

historicalSearchPredictedCtr

enum ( QualityScoreBucket )

The historical search predicted click through rate (CTR).

interactionEventTypes[]

enum ( InteractionEventType )

The types of payable and free interactions.

rawEventConversionMetrics[]

object ( Value )

The raw event conversion metrics.

absoluteTopImpressionPercentage

number

Search absolute top impression share is the percentage of your Search ad impressions that are shown in the most prominent Search position.

allConversionsFromInteractionsRate

number

All conversions from interactions (as oppose to view through conversions) divided by the number of ad interactions.

allConversionsValue

number

The value of all conversions.

allConversions

number

The total number of conversions. This includes all conversions regardless of the value of includeInConversionsMetric.

allConversionsValuePerCost

number

The value of all conversions divided by the total cost of ad interactions (such as clicks for text ads or views for video ads).

allConversionsFromClickToCall

number

The number of times people clicked the "Call" button to call a store during or after clicking an ad. This number doesn't include whether or not calls were connected, or the duration of any calls.

This metric applies to feed items only.

allConversionsFromDirections

number

The number of times people clicked a "Get directions" button to navigate to a store after clicking an ad.

This metric applies to feed items only.

allConversionsFromInteractionsValuePerInteraction

number

The value of all conversions from interactions divided by the total number of interactions.

allConversionsFromMenu

number

The number of times people clicked a link to view a store's menu after clicking an ad.

This metric applies to feed items only.

allConversionsFromOrder

number

The number of times people placed an order at a store after clicking an ad.

This metric applies to feed items only.

allConversionsFromOtherEngagement

number

The number of other conversions (for example, posting a review or saving a location for a store) that occurred after people clicked an ad.

This metric applies to feed items only.

allConversionsFromStoreVisit

number

Estimated number of times people visited a store after clicking an ad.

This metric applies to feed items only.

visits

number

Clicks that Search Ads 360 has successfully recorded and forwarded to an advertiser's landing page.

allConversionsFromStoreWebsite

number

The number of times that people were taken to a store's URL after clicking an ad.

This metric applies to feed items only.

averageCost

number

The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.

averageCpc

number

The total cost of all clicks divided by the total number of clicks received. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause

averageCpm

number

Average cost-per-thousand impressions (CPM). This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause

clicks

string ( int64 format)

The number of clicks.

contentBudgetLostImpressionShare

number

The estimated percent of times that your ad was eligible to show on the Display Network but didn't because your budget was too low. Note: Content budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.

contentImpressionShare

number

The impressions you've received on the Display Network divided by the estimated number of impressions you were eligible to receive. Note: Content impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.

contentRankLostImpressionShare

number

The estimated percentage of impressions on the Display Network that your ads didn't receive due to poor Ad Rank. Note: Content rank lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.

conversionsFromInteractionsRate

number

Average biddable conversions (from interaction) per conversion eligible interaction. Shows how often, on average, an ad interaction leads to a biddable conversion.

clientAccountConversionsValue

number

The value of client account conversions. This only includes conversion actions which includeInClientAccountConversionsMetric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.

conversionsValuePerCost

number

The value of biddable conversion divided by the total cost of conversion eligible interactions.

conversionsFromInteractionsValuePerInteraction

number

The value of conversions from interactions divided by the number of ad interactions. This only includes conversion actions which includeInConversionsMetric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.

clientAccountConversions

number

The number of client account conversions. This only includes conversion actions which includeInClientAccountConversionsMetric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.

costMicros

string ( int64 format)

The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause

costPerAllConversions

number

The cost of ad interactions divided by all conversions.

costPerConversion

number

Average conversion eligible cost per biddable conversion.

costPerCurrentModelAttributedConversion

number

The cost of ad interactions divided by current model attributed conversions. This only includes conversion actions which includeInConversionsMetric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.

crossDeviceConversions

number

Conversions from when a customer clicks on an ad on one device, then converts on a different device or browser. Cross-device conversions are already included in allConversions.

crossDeviceConversionsByConversionDate

number

The number of cross-device conversions by conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611 .

crossDeviceConversionsValue

number

The sum of the value of cross-device conversions.

crossDeviceConversionsValueByConversionDate

number

The sum of cross-device conversions value by conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611 .

ctr

number

The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).

conversions

number

The number of conversions. This only includes conversion actions which includeInConversionsMetric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.

conversionsValue

number

The sum of conversion values for the conversions included in the "conversions" field. This metric is useful only if you entered a value for your conversion actions.

averageQualityScore

number

The average quality score.

historicalQualityScore

string ( int64 format)

The historical quality score.

impressions

string ( int64 format)

Count of how often your ad has appeared on a search results page or website on the Google Network.

interactionRate

number

How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown.

interactions

string ( int64 format)

The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.

invalidClickRate

number

The percentage of clicks filtered out of your total number of clicks (filtered + non-filtered clicks) during the reporting period.

invalidClicks

string ( int64 format)

Number of clicks Google considers illegitimate and doesn't charge you for.

generalInvalidClickRate

number

The percentage of clicks that have been filtered out of your total number of clicks (filtered + non-filtered clicks) due to being general invalid clicks. These are clicks Google considers illegitimate that are detected through routine means of filtration (that is, known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc). You're not charged for them, and they don't affect your account statistics. See the help page at https://support.google.com/campaignmanager/answer/6076504 for details.

generalInvalidClicks

string ( int64 format)

Number of general invalid clicks. These are a subset of your invalid clicks that are detected through routine means of filtration (such as known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc.). You're not charged for them, and they don't affect your account statistics. See the help page at https://support.google.com/campaignmanager/answer/6076504 for details.

mobileFriendlyClicksPercentage

number

The percentage of mobile clicks that go to a mobile-friendly page.

searchAbsoluteTopImpressionShare

number

The percentage of the customer's Shopping or Search ad impressions that are shown in the most prominent Shopping position. See https://support.google.com/sa360/answer/9566729 for details. Any value below 0.1 is reported as 0.0999.

searchBudgetLostAbsoluteTopImpressionShare

number

The number estimating how often your ad wasn't the very first ad among the top ads in the search results due to a low budget. Note: Search budget lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.

searchBudgetLostImpressionShare

number

The estimated percent of times that your ad was eligible to show on the Search Network but didn't because your budget was too low. Note: Search budget lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.

searchBudgetLostTopImpressionShare

number

The number estimating how often your ad didn't show adjacent to the top organic search results due to a low budget. Note: Search budget lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.

searchClickShare

number

The number of clicks you've received on the Search Network divided by the estimated number of clicks you were eligible to receive. Note: Search click share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.

searchExactMatchImpressionShare

number

The impressions you've received divided by the estimated number of impressions you were eligible to receive on the Search Network for search terms that matched your keywords exactly (or were close variants of your keyword), regardless of your keyword match types. Note: Search exact match impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.

searchImpressionShare

number

The impressions you've received on the Search Network divided by the estimated number of impressions you were eligible to receive. Note: Search impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.

searchRankLostAbsoluteTopImpressionShare

number

The number estimating how often your ad wasn't the very first ad among the top ads in the search results due to poor Ad Rank. Note: Search rank lost absolute top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.

searchRankLostImpressionShare

number

The estimated percentage of impressions on the Search Network that your ads didn't receive due to poor Ad Rank. Note: Search rank lost impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.

searchRankLostTopImpressionShare

number

The number estimating how often your ad didn't show adjacent to the top organic search results due to poor Ad Rank. Note: Search rank lost top impression share is reported in the range of 0 to 0.9. Any value above 0.9 is reported as 0.9001.

searchTopImpressionShare

number

The impressions you've received among the top ads compared to the estimated number of impressions you were eligible to receive among the top ads. Note: Search top impression share is reported in the range of 0.1 to 1. Any value below 0.1 is reported as 0.0999.

Top ads are generally above the top organic results, although they may show below the top organic results on certain queries.

topImpressionPercentage

number

The percent of your ad impressions that are shown adjacent to the top organic search results.

valuePerAllConversions

number

The value of all conversions divided by the number of all conversions.

valuePerAllConversionsByConversionDate

number

The value of all conversions divided by the number of all conversions. When this column is selected with date, the values in date column means the conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611 .

valuePerConversion

number

The value of biddable conversion divided by the number of biddable conversions. Shows how much, on average, each of the biddable conversions is worth.

valuePerConversionsByConversionDate

number

Biddable conversions value by conversion date divided by biddable conversions by conversion date. Shows how much, on average, each of the biddable conversions is worth (by conversion date). When this column is selected with date, the values in date column means the conversion date.

clientAccountViewThroughConversions

string ( int64 format)

The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (for example, clicking on) another ad.

clientAccountCrossSellCostOfGoodsSoldMicros

string ( int64 format)

Client account cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause

crossSellCostOfGoodsSoldMicros

string ( int64 format)

Cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause

clientAccountCrossSellGrossProfitMicros

string ( int64 format)

Client account cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause

crossSellGrossProfitMicros

string ( int64 format)

Cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause

clientAccountCrossSellRevenueMicros

string ( int64 format)

Client account cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause

crossSellRevenueMicros

string ( int64 format)

Cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause

clientAccountCrossSellUnitsSold

number

Client account cross-sell units sold is the total number of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell units sold is the total number of cross-sold products from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The cross-sell units sold in this order is 2. This metric is only available if you report conversions with cart data.

crossSellUnitsSold

number

Cross-sell units sold is the total number of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell units sold is the total number of cross-sold products from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The cross-sell units sold in this order is 2. This metric is only available if you report conversions with cart data.

clientAccountLeadCostOfGoodsSoldMicros

string ( int64 format)

Client account lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause

leadCostOfGoodsSoldMicros

string ( int64 format)

Lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause

clientAccountLeadGrossProfitMicros

string ( int64 format)

Client account lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause

leadGrossProfitMicros

string ( int64 format)

Lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause

clientAccountLeadRevenueMicros

string ( int64 format)

Client account lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause

leadRevenueMicros

string ( int64 format)

Lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause

clientAccountLeadUnitsSold

number

Client account lead units sold is the total number of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total number of these products sold is shown under lead units sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The lead units sold in this order is 1. This metric is only available if you report conversions with cart data.

leadUnitsSold

number

Lead units sold is the total number of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total number of these products sold is shown under lead units sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The lead units sold in this order is 1. This metric is only available if you report conversions with cart data.

uniqueUsers

string ( int64 format)

The number of unique users who saw your ad during the requested time period. This metric cannot be aggregated, and can only be requested for date ranges of 92 days or less. This metric is available for following campaign types - Display, Video, Discovery and App.

averageImpressionFrequencyPerUser

number

The average number of times a unique user saw your ad during the requested time period. This metric cannot be aggregated, and can only be requested for date ranges of 92 days or less. This metric is available for following campaign types - Display, Video, Discovery and App.

Ценить

A generic data container.

JSON representation
{

  // Union field value can be only one of the following:
  "booleanValue": boolean,
  "int64Value": string,
  "floatValue": number,
  "doubleValue": number,
  "stringValue": string
  // End of list of possible types for union field value.
}
Поля
Union field value . A value. value can be only one of the following:
booleanValue

boolean

Булевое значение.

int64Value

string ( int64 format)

An int64.

floatValue

number

A float.

doubleValue

number

A double.

stringValue

string

A string.

QualityScoreBucket

Enum listing the possible quality score buckets.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
BELOW_AVERAGE Quality of the creative is below average.
AVERAGE Quality of the creative is average.
ABOVE_AVERAGE Quality of the creative is above average.

InteractionEventType

Enum describing possible types of payable and free interactions.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
CLICK Click to site. In most cases, this interaction navigates to an external location, usually the advertiser's landing page. This is also the default InteractionEventType for click events.
ENGAGEMENT The user's expressed intent to engage with the ad in-place.
VIDEO_VIEW User viewed a video ad.
NONE The default InteractionEventType for ad conversion events. This is used when an ad conversion row does NOT indicate that the free interactions (for example, the ad conversions) should be 'promoted' and reported as part of the core metrics. These are simply other (ad) conversions.

Сегменты

Segment only fields.

JSON representation
{
  "adNetworkType": enum (AdNetworkType),
  "conversionActionCategory": enum (ConversionActionCategory),
  "conversionCustomDimensions": [
    {
      object (Value)
    }
  ],
  "dayOfWeek": enum (DayOfWeek),
  "device": enum (Device),
  "keyword": {
    object (Keyword)
  },
  "productChannel": enum (ProductChannel),
  "productChannelExclusivity": enum (ProductChannelExclusivity),
  "productCondition": enum (ProductCondition),
  "productSoldCondition": enum (ProductCondition),
  "rawEventConversionDimensions": [
    {
      object (Value)
    }
  ],
  "conversionAction": string,
  "conversionActionName": string,
  "date": string,
  "geoTargetCity": string,
  "geoTargetCountry": string,
  "geoTargetMetro": string,
  "geoTargetRegion": string,
  "hour": integer,
  "month": string,
  "productBiddingCategoryLevel1": string,
  "productBiddingCategoryLevel2": string,
  "productBiddingCategoryLevel3": string,
  "productBiddingCategoryLevel4": string,
  "productBiddingCategoryLevel5": string,
  "productBrand": string,
  "productCountry": string,
  "productCustomAttribute0": string,
  "productCustomAttribute1": string,
  "productCustomAttribute2": string,
  "productCustomAttribute3": string,
  "productCustomAttribute4": string,
  "productItemId": string,
  "productLanguage": string,
  "productSoldBiddingCategoryLevel1": string,
  "productSoldBiddingCategoryLevel2": string,
  "productSoldBiddingCategoryLevel3": string,
  "productSoldBiddingCategoryLevel4": string,
  "productSoldBiddingCategoryLevel5": string,
  "productSoldBrand": string,
  "productSoldCustomAttribute0": string,
  "productSoldCustomAttribute1": string,
  "productSoldCustomAttribute2": string,
  "productSoldCustomAttribute3": string,
  "productSoldCustomAttribute4": string,
  "productSoldItemId": string,
  "productSoldTitle": string,
  "productSoldTypeL1": string,
  "productSoldTypeL2": string,
  "productSoldTypeL3": string,
  "productSoldTypeL4": string,
  "productSoldTypeL5": string,
  "productStoreId": string,
  "productTitle": string,
  "productTypeL1": string,
  "productTypeL2": string,
  "productTypeL3": string,
  "productTypeL4": string,
  "productTypeL5": string,
  "quarter": string,
  "week": string,
  "year": integer,
  "assetInteractionTarget": {
    object (AssetInteractionTarget)
  }
}
Поля
adNetworkType

enum ( AdNetworkType )

Ad network type.

conversionActionCategory

enum ( ConversionActionCategory )

Conversion action category.

conversionCustomDimensions[]

object ( Value )

The conversion custom dimensions.

dayOfWeek

enum ( DayOfWeek )

Day of the week, for example, MONDAY.

device

enum ( Device )

Device to which metrics apply.

keyword

object ( Keyword )

Keyword criterion.

productChannel

enum ( ProductChannel )

Channel of the product.

productChannelExclusivity

enum ( ProductChannelExclusivity )

Channel exclusivity of the product.

productCondition

enum ( ProductCondition )

Condition of the product.

productSoldCondition

enum ( ProductCondition )

Condition of the product sold.

rawEventConversionDimensions[]

object ( Value )

The raw event conversion dimensions.

conversionAction

string

Resource name of the conversion action.

conversionActionName

string

Conversion action name.

date

string

Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.

geoTargetCity

string

Resource name of the geo target constant that represents a city.

geoTargetCountry

string

Resource name of the geo target constant that represents a country.

geoTargetMetro

string

Resource name of the geo target constant that represents a metro.

geoTargetRegion

string

Resource name of the geo target constant that represents a region.

hour

integer

Hour of day as a number between 0 and 23, inclusive.

month

string

Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.

productBiddingCategoryLevel1

string

Bidding category (level 1) of the product.

productBiddingCategoryLevel2

string

Bidding category (level 2) of the product.

productBiddingCategoryLevel3

string

Bidding category (level 3) of the product.

productBiddingCategoryLevel4

string

Bidding category (level 4) of the product.

productBiddingCategoryLevel5

string

Bidding category (level 5) of the product.

productBrand

string

Brand of the product.

productCountry

string

Resource name of the geo target constant for the country of sale of the product.

productCustomAttribute0

string

Custom attribute 0 of the product.

productCustomAttribute1

string

Custom attribute 1 of the product.

productCustomAttribute2

string

Custom attribute 2 of the product.

productCustomAttribute3

string

Custom attribute 3 of the product.

productCustomAttribute4

string

Custom attribute 4 of the product.

productItemId

string

Item ID of the product.

productLanguage

string

Resource name of the language constant for the language of the product.

productSoldBiddingCategoryLevel1

string

Bidding category (level 1) of the product sold.

productSoldBiddingCategoryLevel2

string

Bidding category (level 2) of the product sold.

productSoldBiddingCategoryLevel3

string

Bidding category (level 3) of the product sold.

productSoldBiddingCategoryLevel4

string

Bidding category (level 4) of the product sold.

productSoldBiddingCategoryLevel5

string

Bidding category (level 5) of the product sold.

productSoldBrand

string

Brand of the product sold.

productSoldCustomAttribute0

string

Custom attribute 0 of the product sold.

productSoldCustomAttribute1

string

Custom attribute 1 of the product sold.

productSoldCustomAttribute2

string

Custom attribute 2 of the product sold.

productSoldCustomAttribute3

string

Custom attribute 3 of the product sold.

productSoldCustomAttribute4

string

Custom attribute 4 of the product sold.

productSoldItemId

string

Item ID of the product sold.

productSoldTitle

string

Title of the product sold.

productSoldTypeL1

string

Type (level 1) of the product sold.

productSoldTypeL2

string

Type (level 2) of the product sold.

productSoldTypeL3

string

Type (level 3) of the product sold.

productSoldTypeL4

string

Type (level 4) of the product sold.

productSoldTypeL5

string

Type (level 5) of the product sold.

productStoreId

string

Store ID of the product.

productTitle

string

Title of the product.

productTypeL1

string

Type (level 1) of the product.

productTypeL2

string

Type (level 2) of the product.

productTypeL3

string

Type (level 3) of the product.

productTypeL4

string

Type (level 4) of the product.

productTypeL5

string

Type (level 5) of the product.

quarter

string

Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, for example, the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.

week

string

Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.

year

integer

Year, formatted as yyyy.

assetInteractionTarget

object ( AssetInteractionTarget )

Only used with CustomerAsset, CampaignAsset and AdGroupAsset metrics. Indicates whether the interaction metrics occurred on the asset itself or a different asset or ad unit. Interactions (for example, clicks) are counted across all the parts of the served ad (for example, Ad itself and other components like Sitelinks) when they are served together. When interactionOnThisAsset is true, it means the interactions are on this specific asset and when interactionOnThisAsset is false, it means the interactions is not on this specific asset but on other parts of the served ad this asset is served with.

AdNetworkType

Перечисляет типы сетей Google Ads.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN В этой версии значение неизвестно.
SEARCH Поиск Google.
SEARCH_PARTNERS Поиск партнёров.
CONTENT Контекстно-медийная сеть.
YOUTUBE_WATCH Видео на YouTube
MIXED Кросс-сетевой.

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

A Keyword criterion segment.

JSON representation
{
  "info": {
    object (KeywordInfo)
  },
  "adGroupCriterion": string
}
Поля
info

object ( KeywordInfo )

Keyword info.

adGroupCriterion

string

The AdGroupCriterion resource name.

ProductChannelExclusivity

Enum describing the availability of a product offer.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
SINGLE_CHANNEL The item is sold through one channel only, either local stores or online as indicated by its ProductChannel.
MULTI_CHANNEL The item is matched to its online or local stores counterpart, indicating it is available for purchase in both ShoppingProductChannels.

ProductCondition

Enum describing the condition of a product offer.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение, неизвестное в этой версии.
OLD The product condition is old.
NEW The product condition is new.
REFURBISHED The product condition is refurbished.
USED The product condition is used.

AssetInteractionTarget

An AssetInteractionTarget segment.

JSON-представление
{
  "asset": string,
  "interactionOnThisAsset": boolean
}
Поля
asset

string

The asset resource name.

interactionOnThisAsset

boolean

Only used with CustomerAsset, CampaignAsset and AdGroupAsset metrics. Indicates whether the interaction metrics occurred on the asset itself or a different asset or ad unit.