SearchAds360Row

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

JSON-представление
{
  "adGroup": {
    object (AdGroup)
  },
  "adGroupAd": {
    object (AdGroupAd)
  },
  "adGroupAdLabel": {
    object (AdGroupAdLabel)
  },
  "adGroupAsset": {
    object (AdGroupAsset)
  },
  "adGroupAssetSet": {
    object (AdGroupAssetSet)
  },
  "adGroupAudienceView": {
    object (AdGroupAudienceView)
  },
  "adGroupBidModifier": {
    object (AdGroupBidModifier)
  },
  "adGroupCriterion": {
    object (AdGroupCriterion)
  },
  "adGroupCriterionLabel": {
    object (AdGroupCriterionLabel)
  },
  "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)
  },
  "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)
  },
  "webpageView": {
    object (WebpageView)
  },
  "visit": {
    object (Visit)
  },
  "conversion": {
    object (Conversion)
  },
  "metrics": {
    object (Metrics)
  },
  "segments": {
    object (Segments)
  },
  "customColumns": [
    {
      object (Value)
    }
  ]
}
Поля
adGroup

object ( AdGroup )

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

adGroupAd

object ( AdGroupAd )

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

adGroupAdLabel

object ( AdGroupAdLabel )

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

adGroupAsset

object ( AdGroupAsset )

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

adGroupAssetSet

object ( AdGroupAssetSet )

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

adGroupAudienceView

object ( AdGroupAudienceView )

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

adGroupBidModifier

object ( AdGroupBidModifier )

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

adGroupCriterion

object ( AdGroupCriterion )

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

adGroupCriterionLabel

object ( AdGroupCriterionLabel )

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

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 )

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

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 )

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

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
  ],
  "engineId": string,
  "startDate": string,
  "endDate": string,
  "languageCode": string,
  "lastModifiedTime": string,
  "id": string,
  "name": string,
  "cpcBidMicros": string,
  "engineStatus": enum (AdGroupEngineStatus)
}
Поля
resourceName

string

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

customers/{customerId}/adGroups/{ad_group_id}

status

enum ( AdGroupStatus )

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

type

enum ( AdGroupType )

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

adRotationMode

enum ( AdGroupAdRotationMode )

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

creationTime

string

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

targetingSetting

object ( TargetingSetting )

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

labels[]

string

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

engineId

string

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

startDate

string

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

Формат: ГГГГ-ММ-ДД. Пример: 14.03.2019.

endDate

string

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

Формат: ГГГГ-ММ-ДД. Пример: 14.03.2019.

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).

cpcBidMicros

string ( int64 format)

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

engineStatus

enum ( AdGroupEngineStatus )

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

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

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

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

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

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

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

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

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

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

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

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

SEARCH_STANDARD Тип группы объявлений по умолчанию для кампаний в поисковой сети.
DISPLAY_STANDARD Тип группы объявлений по умолчанию для кампаний в контекстно-медийной сети.
SHOPPING_PRODUCT_ADS Тип группы объявлений для торговых кампаний со стандартной рекламой товаров.
SHOPPING_SHOWCASE_ADS Тип групп объявлений, которые ограничиваются показом объявлений-витрин или торговых объявлений в результатах покупок.
HOTEL_ADS Тип группы объявлений по умолчанию для кампаний для гостиниц.
SHOPPING_SMART_ADS Тип групп объявлений в умных торговых кампаниях.
VIDEO_BUMPER Короткие видеообъявления In-Stream, которые нельзя пропустить.
VIDEO_TRUE_VIEW_IN_STREAM Видеообъявления TrueView (с возможностью пропуска).
VIDEO_TRUE_VIEW_IN_DISPLAY Видеореклама TrueView In-Display.
VIDEO_NON_SKIPPABLE_IN_STREAM Видеообъявления In-Stream, которые нельзя пропустить.
VIDEO_OUTSTREAM Аутстрим видеореклама.
SEARCH_DYNAMIC_ADS Тип группы объявлений для групп объявлений динамических поисковых объявлений.
SHOPPING_COMPARISON_LISTING_ADS Тип групп объявлений в кампаниях со сравнительными торговыми листами.
PROMOTED_HOTEL_ADS Тип группы объявлений для групп объявлений продвигаемых гостиниц.
VIDEO_RESPONSIVE Группы адаптивных видеообъявлений.
VIDEO_EFFICIENT_REACH Группы видеообъявлений с эффективным охватом.
SMART_CAMPAIGN_ADS Тип группы объявлений для умных кампаний.
TRAVEL_ADS Тип группы объявлений для туристических кампаний.

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

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

Перечисления
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 )

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

Целевое ограничение

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

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

enum ( TargetingDimension )

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

bidOnly

boolean

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

Измерение таргетинга

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

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

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

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

JSON-представление
{
  "resourceName": string,
  "status": enum (AdGroupAdStatus),
  "ad": {
    object (Ad)
  },
  "creationTime": string,
  "labels": [
    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

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

engineId

string

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

engineStatus

enum ( AdGroupAdEngineStatus )

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

lastModifiedTime

string

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

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

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

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

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

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

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

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

Возможные типы объявления.

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

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

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

TEXT_AD Объявление представляет собой текстовое объявление.
EXPANDED_TEXT_AD Это развернутое текстовое объявление.
CALL_ONLY_AD Это объявление только с номером телефона.
EXPANDED_DYNAMIC_SEARCH_AD Это расширенное динамическое поисковое объявление.
HOTEL_AD Реклама представляет собой рекламу отеля.
SHOPPING_SMART_AD Это умное товарное объявление.
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 Видеореклама In-Stream без возможности пропуска.
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.

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

Текстовое объявление Поисковой рекламы 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

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

adTrackingId

string ( int64 format)

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

SearchAds360АдаптивныйSearchAdInfo

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

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

string

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

path2

string

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

adTrackingId

string ( int64 format)

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

SearchAds360ProductAdInfo

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

Товарное объявление Search Ads 360.

SearchAds360ExpandedDynamicSearchAdInfo

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

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

string

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

description2

string

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

adTrackingId

string ( int64 format)

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

Статус AdGroupAdEngine

Перечисляет статусы системы 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

Устарело. Не использовать. Ранее использовался Близнецами

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 Креатив приостановлен, поскольку группа объявлений приостановлена.

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

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

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

string

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

adGroupAd

string

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

label

string

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

Актив группы объявлений

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

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 )

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

Ассетлинкстатус

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

Перечисления
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 )

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

Ассетсетлинкстатус

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

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

Группа объявленийАудиторияView

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

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

string

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

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

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

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

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. Диапазон составляет 1,0–6,0 для PreferredContent. Используйте 0, чтобы отказаться от типа устройства.

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

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

device

object ( DeviceInfo )

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

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

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

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

enum ( Device )

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

Устройство

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

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

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

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

JSON-представление
{
  "resourceName": string,
  "creationTime": string,
  "status": enum (AdGroupCriterionStatus),
  "qualityInfo": {
    object (QualityInfo)
  },
  "type": enum (CriterionType),
  "labels": [
    string
  ],
  "positionEstimates": {
    object (PositionEstimates)
  },
  "finalUrls": [
    string
  ],
  "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

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

positionEstimates

object ( PositionEstimates )

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

finalUrls[]

string

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

engineId

string

Идентификатор критерия группы объявлений во внешнем аккаунте системы. Это поле предназначено только для аккаунтов, отличных от Google Рекламы, например Yahoo Japan, Microsoft, Baidu и т. д. Для объекта Google Реклама вместо этого используйте «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 )

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

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

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

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

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

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

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

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

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

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

integer

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

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

Тип Критерия

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

Перечисления
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 IPБлок.
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 Тема ключевых слов для умной кампании
AUDIENCE Аудитория
LOCAL_SERVICE_ID Идентификатор службы рекламы местных услуг.
BRAND Бренд
BRAND_LIST Список брендов
LIFE_EVENT Случай из жизни

ПозицияОценки

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

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. Близнецы: Критерий на рассмотрении.
AD_GROUP_CRITERION_NOT_REVIEWED Baidu: Критерий подлежит пересмотру.
AD_GROUP_CRITERION_ON_HOLD

Устарело. Не использовать. Ранее использовался Близнецами

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 Критерий приостановлен, поскольку аккаунт приостановлен.

Информация о ключевом слове

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

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

enum ( KeywordMatchType )

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

text

string

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

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

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

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

ЛистингГруппаИнформация

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

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

enum ( ListingGroupType )

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

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

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

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

Возрастной диапазонИнформация

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

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 Неопределенный пол.

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

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

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 Веб-условие аргумента является частью сравниваемого веб-условия.

Информация о местоположении

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

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

string

Имя постоянного ресурса географической цели.

AdGroupCriterionLabel

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

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

string

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

adGroupCriterion

string

Критерий группы AD, к которому прикреплен этикетка.

label

string

Этикетка назначена критерию группы рекламной группы.

Adgrouplebel

Отношения между рекламной группой и лейблом.

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

string

Название ресурса лейбла AD Group. Имена ресурсов группы customers/{customerId}/adGroupLabels/{ad_group_id}~{label_id}

adGroup

string

Рекламная группа, к которой прикреплен этикетка.

label

string

Этикетка назначена группе объявлений.

AgerangeView

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

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

string

Название ресурса в возрастном диапазоне. Имена ресурсов в диапазоне возрастного диапазона имеет форму:

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

Объект

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

Представление JSON
{
  "resourceName": string,
  "type": enum (AssetType),
  "finalUrls": [
    string
  ],
  "status": enum (AssetStatus),
  "creationTime": string,
  "lastModifiedTime": string,
  "id": string,
  "name": string,
  "trackingUrlTemplate": 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 -адресов после всех перекрестных доменов перенаправления.

status

enum ( AssetStatus )

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

creationTime

string

Неэппаратная метка, когда этот актив был создан. Неэпби времени находится в часовом поясе клиента и в формате «Yyyy-MM-DD HH: MM: SS».

lastModifiedTime

string

DateTime, когда этот актив был в последний раз изменен. DateTime находится в часовом поясе клиента и в формате «Yyyy-MM-DD HH: MM: Ss.sssssss».

id

string ( int64 format)

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

name

string

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

trackingUrlTemplate

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 )

Объединенное местоположение актива.

Assettype

Enum описывает возможные типы активов.

Перечисление
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение неизвестно в этой версии.
YOUTUBE_VIDEO YouTube Video Asset.
MEDIA_BUNDLE СМИ БАКЛЕТА.
IMAGE Изображение актив.
TEXT Текстовый актив.
LEAD_FORM Ведущая форма актива.
BOOK_ON_GOOGLE Забронируйте в Google Asset.
PROMOTION Актив продвижения.
CALLOUT Выносный актив.
STRUCTURED_SNIPPET Структурированный активы фрагмента.
PAGE_FEED Страница фидального актива.
DYNAMIC_EDUCATION Динамический образовательный актив.
MOBILE_APP Актив мобильного приложения.
HOTEL_CALLOUT Отель Callout Asset.
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

Следующий идентификатор = 11

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

Youtubevideoasset

Активы на YouTube.

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

string

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

youtubeVideoId

string

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

ImageAsset

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

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

enum ( MimeType )

Тип мима изображного актива.

fullSize

object ( ImageDimension )

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

fileSize

string ( int64 format)

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

Миметип

Тип MIME

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

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

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

IMAGE_JPEG Тип изображения MIME/JPEG.
IMAGE_GIF Тип изображения MIME/GIF.
IMAGE_PNG Тип изображения MIME/PNG.
FLASH Тип приложения MIME/X-Shockwave-Flash.
TEXT_HTML Тип 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.

ИМЕНАРИНГИИНГ

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

Представление 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

Дата начала, когда этот актив вступит в силу и может начать служить в формате Yyyy-MM-DD.

endDate

string

Последняя дата, когда этот актив вступает в силу и все еще служит, в формате Yyyy-MM-DD.

adScheduleTargets[]

object ( AdScheduleInfo )

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

useSearcherTimeZone

boolean

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

Adscheduleinfo

Представляет собой критерий adschedule.

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

Не более шести Adschedules можно добавить в тот же день.

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

enum ( MinuteOfHour )

Через несколько минут после начала, в котором начинается это расписание.

Это поле требуется для создания операций и запрещено в операциях обновления.

endMinute

enum ( MinuteOfHour )

Через несколько минут после окончания, в котором это расписание заканчивается. График исключает конечную минуту.

Это поле требуется для создания операций и запрещено в операциях обновления.

dayOfWeek

enum ( DayOfWeek )

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

Это поле требуется для создания операций и запрещено в операциях обновления.

startHour

integer

Начальный час в 24 часа. Это поле должно быть от 0 до 23, включительно.

Это поле требуется для создания операций и запрещено в операциях обновления.

endHour

integer

Конец часа за 24 часа; 24 означает конец дня. Это поле должно быть от 0 до 24, включительно.

Это поле требуется для создания операций и запрещено в операциях обновления.

Минута

Перечисления четверть часа. Например, "Пятнадцать"

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

День недели

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

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

UnifiedSitelinkasset

Объединенный актив SiteLink.

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

string

URL -отображение текст для SiteLink. Длина этой строки должна быть от 1 до 25, включительно.

description1

string

Первая строка описания для SiteLink. Если установлена, длина должна быть от 1 до 35, инклюзивных, а также должно быть установлено описание2.

description2

string

Вторая строка описания для SiteLink. Если установлена, длина должна быть от 1 до 35, включительно, а также должно быть установлено описание1.

startDate

string

Дата начала, когда этот актив вступит в силу и может начать служить в формате Yyyy-MM-DD.

endDate

string

Последняя дата, когда этот актив вступает в силу и все еще служит, в формате Yyyy-MM-DD.

adScheduleTargets[]

object ( AdScheduleInfo )

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

trackingId

string ( int64 format)

Идентификатор используется для отслеживания кликов для актива SiteLink. Это Yahoo! Япония только поле.

useSearcherTimeZone

boolean

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

mobilePreferred

boolean

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

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 App Store.
GOOGLE_APP_STORE Поставщик мобильных приложений для Google App Store.

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

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

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.

callTrackingEnabled

boolean

Должен ли вызов быть включен при отслеживании вызовов. Применяется к рекламе Microsoft.

useSearcherTimeZone

boolean

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

startDate

string

Дата начала, когда этот актив вступит в силу и может начать служить в формате Yyyy-MM-DD.

endDate

string

Последняя дата, когда этот актив вступает в силу и все еще служит, в формате Yyyy-MM-DD.

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

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

Перечисление
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 Place и на картах Google. Это поле уникально для данного идентификатора клиента и типа активов. См .

businessProfileLocations[]

object ( BusinessProfileLocation )

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

locationOwnershipType

enum ( LocationOwnershipType )

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

BusinessProfileLocation

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

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

string

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

storeCode

string

Код магазина бизнеса в этом месте. Это синхронизируется с учетной записи бизнес -профиля.

listingId

string ( int64 format)

Листинг идентификатор этого местоположения бизнес -профиля. Это синхронизируется из связанной учетной записи бизнес -профиля.

LocationOWNERSPHETYPE

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

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

AssetGroupasset

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

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

string

Название ресурса актива Asset Group. Название ресурса активов Asset Group имеет форму:

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

assetGroup

string

Группа активов, которую связывает этот активы группы активов.

asset

string

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

fieldType

enum ( AssetFieldType )

Описание размещения актива в группе активов. Например: заголовок, youtube_video и т. Д.

status

enum ( AssetLinkStatus )

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

AssetFieldType

Enum описывает возможные размещения актива.

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

AssetGroupSignal

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

Представление 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

Название ресурса сигнала группы активов. Имя ресурса сигнала Asset Group имеет форму:

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

assetGroup

string

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

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

object ( AudienceInfo )

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

Аудитория

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

Представление 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 Представляет вертикаль покупок. Вертикаль разрешена только в производительности Max для розничных кампаний.

ListingGroupFilterDimension

Листинг измерений для группового фильтра группы Acset Group.

Представление 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.

Продукт

Бренд продукта.

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

string

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

ProductChannel

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

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

enum ( ListingGroupFilterProductChannel )

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

ListingGroupFilterProductChannel

Enum описывает местонахождение предложения продукта.

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

ProductCondition

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

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

enum ( ListingGroupFilterProductCondition )

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

ListingGroupFilterProductCondition

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

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

ProductCustomattribute

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

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

enum ( ListingGroupFilterCustomAttributeIndex )

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

value

string

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

LiledingGroupFilterCustomattributeIndex

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

Перечисление
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

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

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

ListingGroupFilterDimensionPath

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

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

object ( ListingGroupFilterDimension )

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

AssetGrouptOpCombinationView

Взгляд на использование комбинации активов AD Group AD.

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

string

Название ресурса в высшей комбинации группы активов. AssetGroup Top Comminate View Имена ресурсов имеют форму: `" Customs/{customer}/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 )

Поличный тип актива.

Sedassetfieldtype

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

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

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

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

HEADLINE_1 Актив используется в заголовке 1.
HEADLINE_2 Актив используется в заголовке 2.
HEADLINE_3 Актив используется в заголовке 3.
DESCRIPTION_1 Актив используется в описании 1.
DESCRIPTION_2 Актив используется в описании 2.
HEADLINE Актив использовался в заголовке. Используйте это только в том случае, если в объявлении есть только один заголовок. В противном случае используйте Headline_1, Headline_2 или Headline_3 Enumss
HEADLINE_IN_PORTRAIT Актив использовался в качестве заголовка в портретном изображении.
LONG_HEADLINE Активы использовали в длинном заголовке (используется в многосентрическом отношении).
DESCRIPTION Активы использовались в описании. Используйте это, только если в объявлении есть только одно описание. В противном случае используйте description_1 или description_@ enums
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 Актив используется в качестве свинцовой формы.

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

Название ресурса группы активов. Имена ресурсов группы Asset Group имеют форму:

customers/{customerId}/assetGroups/{asset_group_id}

id

string ( int64 format)

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

campaign

string

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

name

string

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

finalUrls[]

string

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

finalMobileUrls[]

string

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

status

enum ( AssetGroupStatus )

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

path1

string

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

path2

string

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

adStrength

enum ( AdStrength )

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

AssetGroupStatus

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

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

Adstrength

Enum перечисляет возможные сильные стороны рекламы.

Перечисление
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 Актив набора активов удален.

Активист

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

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

string ( int64 format)

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

resourceName

string

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

customers/{customerId}/assetSets/{asset_set_id}

Биддингстратеги

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

Представление 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 Трехбуктный код).

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

id

string ( int64 format)

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

name

string

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

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

effectiveCurrencyCode

string

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

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

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

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

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 )

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

Биддингстратегистатус

Возможные статусы Биддингстратегии.

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

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

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

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

Биддингстратеигит

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

Перечисление
UNSPECIFIED Не указан.
UNKNOWN Используется только для возвращаемого значения. Представляет значение неизвестно в этой версии.
COMMISSION Комиссия - это автоматическая стратегия торгов, в которой рекламодатель платит определенную часть конверсионной стоимости.
ENHANCED_CPC Enhanced CPC - это стратегия торгов, которая поднимает заявки на клики, которые, кажется, с большей вероятностью приведут к конверсии и снижают их для кликов, где они кажутся менее вероятными.
INVALID Используется только для возвращаемого значения. Указывает, что кампания не имеет стратегии торгов. Это предотвращает подачу кампании. Например, кампания может быть прикреплена к стратегии ставок менеджера, а впоследствии с учетная запись с учетной записью менеджера не связана с учетной записью. В этом случае кампания будет автоматически отделена от ныне недоступной стратегии торгов менеджером и перехода к неверной стратегии стратегии торгов.
MANUAL_CPA Стратегия ручной торговли, которая позволяет рекламодателю установить предложение на предложение по рекламодателю.
MANUAL_CPC Руководство на основе кликов, где пользователь платит за клик.
MANUAL_CPM Ручные торговцы на основе впечатлений, где пользователь платит за тысячу впечатлений.
MANUAL_CPV Стратегия торга, которая платит настраиваемую сумму за видео.
MAXIMIZE_CONVERSIONS Стратегия ставок, которая автоматически максимизирует количество конверсий с учетом ежедневного бюджета.
MAXIMIZE_CONVERSION_VALUE Автоматизированная стратегия торгов, которая автоматически устанавливает ставки для максимизации дохода при трати на ваш бюджет.
PAGE_ONE_PROMOTED Page-One Promed Scheamding, которая устанавливает Max CPC-ставки на целевые впечатления на первой странице или на странице. Это значение перечисления устарело.
PERCENT_CPC Процент CPC - это стратегия ставок, в которой предложения являются частью рекламной цены на что -то хорошее или услуги.
TARGET_CPA Target CPA-это стратегия автоматизированной ставки, которая устанавливает ставки, чтобы помочь получить как можно больше конверсий на целевой стоимости за затрат на получение (CPA), которую вы устанавливаете.
TARGET_CPM Target CPM - это стратегия автоматизированной ставки, которая устанавливает ставки, чтобы помочь получить как можно больше впечатлений по целевой стоимости на одну тысячу показов (CPM), которые вы устанавливаете.
TARGET_IMPRESSION_SHARE Автоматизированная стратегия торгов, которая устанавливает ставки так, чтобы определенный процент поисковой рекламы показан в верхней части первой страницы (или другого целевого местоположения).
TARGET_OUTRANK_SHARE Target Outrank Share - это автоматическая стратегия торгов, которая устанавливает ставки на основе целевой доли аукционов, где рекламодатель должен опередить конкретного конкурента. Это значение перечисления устарело.
TARGET_ROAS Target Roas - это автоматическая стратегия торгов, которая помогает вам максимизировать доход при усреднении определенной доходности цели в среднем (ROAS).
TARGET_SPEND Целевые расходы - это стратегия автоматической ставки, которая устанавливает ваши заявки, чтобы помочь получить как можно больше кликов в рамках вашего бюджета.

EnhancedCpc

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

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

Эта стратегия торгов устарела и больше не может быть создана. Используйте ManualCPC с EnhancedCpcenabled SET для True для эквивалентной функциональности.

MaximizeConversionValue

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

Представление JSON
{
  "cpcBidCeilingMicros": string,
  "cpcBidFloorMicros": string,
  "targetRoas": number
}
Поля
cpcBidCeilingMicros

string ( int64 format)

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

cpcBidFloorMicros

string ( int64 format)

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

targetRoas

number

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

Максимальные реверсии

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

Представление JSON
{
  "cpcBidCeilingMicros": string,
  "cpcBidFloorMicros": string,
  "targetCpaMicros": string
}
Поля
cpcBidCeilingMicros

string ( int64 format)

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

cpcBidFloorMicros

string ( int64 format)

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

targetCpaMicros

string ( int64 format)

Опция целевой стоимости за действие (CPA). Это средняя сумма, которую вы хотели бы потратить на действие конверсии, указанное в микро -единицах валюты стратегии торгов. В случае установки стратегия ставки получит как можно больше конверсий при или ниже целевой стоимости за действие. Если целевой CPA не установлен, стратегия ставки будет направлена ​​на достижение максимально возможного CPA, учитывая бюджет.

TargetCpa

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

Представление JSON
{
  "targetCpaMicros": string,
  "cpcBidCeilingMicros": string,
  "cpcBidFloorMicros": string
}
Поля
targetCpaMicros

string ( int64 format)

Средняя цель CPA. This target should be greater than or equal to minimum billable unit based on the currency for the account.

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

An automated bidding strategy that sets bids so that a certain percentage of search ads are shown at the top of the first page (or other targeted location).

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

enum ( TargetImpressionShareLocation )

The targeted location on the search results page.

locationFractionMicros

string ( int64 format)

The chosen fraction of ads to be shown in the targeted location in micros. For example, 1% equals 10,000.

cpcBidCeilingMicros

string ( int64 format)

The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros.

TargetImpressionShareLocation

Enum describing possible goals.

Enums
UNSPECIFIED Не указан.
UNKNOWN Used for return value only. Represents value unknown in this version.
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)

Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.

TargetRoas

An automated bidding strategy that helps you maximize revenue while averaging a specific target return on ad spend (ROAS).

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

number

Необходимый. 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

An automated bid strategy that sets your bids to help get as many clicks as possible within your budget.

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

string ( int64 format)

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)

Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.

CampaignBudget

A campaign budget.

JSON representation
{
  "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.

Enums
UNSPECIFIED Не указан.
UNKNOWN Used for return value only. Represents value unknown in this version.
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.

Enums
UNSPECIFIED Не указан.
UNKNOWN Used for return value only. Represents value unknown in this version.
DAILY Ежедневный бюджет.
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)
  },
  "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,
  "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

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

customers/{customerId}/campaigns/{campaign_id}

status

enum ( CampaignStatus )

The status of the campaign.

When a new campaign is added, the status defaults to ENABLED.

servingStatus

enum ( CampaignServingStatus )

The ad serving status of the campaign.

biddingStrategySystemStatus

enum ( BiddingStrategySystemStatus )

The system status of the campaign's bidding strategy.

adServingOptimizationStatus

enum ( AdServingOptimizationStatus )

The ad serving optimization status of the campaign.

advertisingChannelType

enum ( AdvertisingChannelType )

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

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

Can be set only when creating campaigns. After the campaign is created, the field can not be changed.

advertisingChannelSubType

enum ( AdvertisingChannelSubType )

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

Can be set only when creating campaigns. After campaign is created, the field can not be changed.

urlCustomParameters[]

object ( CustomParameter )

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

realTimeBiddingSetting

object ( RealTimeBiddingSetting )

Settings for Real-Time Bidding, a feature only available for campaigns targeting the Ad Exchange network.

networkSettings

object ( NetworkSettings )

The network settings for the campaign.

dynamicSearchAdsSetting

object ( DynamicSearchAdsSetting )

The setting for controlling Dynamic Search Ads (DSA).

shoppingSetting

object ( ShoppingSetting )

The setting for controlling Shopping campaigns.

geoTargetTypeSetting

object ( GeoTargetTypeSetting )

The setting for ads geotargeting.

labels[]

string

The resource names of labels attached to this campaign.

biddingStrategyType

enum ( BiddingStrategyType )

The type of bidding strategy.

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.

This field is read-only.

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 )

A list that limits how often each user will see this campaign's ads.

selectiveOptimization

object ( SelectiveOptimization )

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

optimizationGoalSetting

object ( OptimizationGoalSetting )

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

trackingSetting

object ( TrackingSetting )

Campaign-level settings for tracking information.

engineId

string

ID of the campaign in the external engine account. This field is for non-Google Ads account only, for example, Yahoo Japan, Microsoft, Baidu etc. For Google Ads entity, use "campaign.id" instead.

excludedParentAssetFieldTypes[]

enum ( AssetFieldType )

The asset field types that should be excluded from this campaign. Asset links with these field types will not be inherited by this campaign from the upper level.

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

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.

lastModifiedTime

string

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

id

string ( int64 format)

The ID of the campaign.

name

string

The name of the campaign.

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

It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters.

trackingUrlTemplate

string

The URL template for constructing a tracking URL.

campaignBudget

string

The 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

Portfolio bidding strategy used by 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.

Enums
UNSPECIFIED Не указан.
UNKNOWN Used for return value only. Represents value unknown in this version.
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.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.

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

BiddingStrategySystemStatus

The possible system statuses of a BiddingStrategy.

Enums
UNSPECIFIED Signals that an unexpected error occurred, for example, no bidding strategy type was found, or no status information was found.
UNKNOWN Used for return value only. Represents value unknown in this version.
ENABLED The bid strategy is active, and AdWords cannot find any specific issues with the strategy.
LEARNING_NEW The bid strategy is learning because it has been recently created or recently reactivated.
LEARNING_SETTING_CHANGE The bid strategy is learning because of a recent setting change.
LEARNING_BUDGET_CHANGE The bid strategy is learning because of a recent budget change.
LEARNING_COMPOSITION_CHANGE The bid strategy is learning because of recent change in number of campaigns, ad groups or keywords attached to it.
LEARNING_CONVERSION_TYPE_CHANGE The bid strategy depends on conversion reporting and the customer recently modified conversion types that were relevant to the bid strategy.
LEARNING_CONVERSION_SETTING_CHANGE The bid strategy depends on conversion reporting and the customer recently changed their conversion settings.
LIMITED_BY_CPC_BID_CEILING The bid strategy is limited by its bid ceiling.
LIMITED_BY_CPC_BID_FLOOR The bid strategy is limited by its bid floor.
LIMITED_BY_DATA The bid strategy is limited because there was not enough conversion traffic over the past weeks.
LIMITED_BY_BUDGET A significant fraction of keywords in this bid strategy are limited by budget.
LIMITED_BY_LOW_PRIORITY_SPEND The bid strategy cannot reach its target spend because its spend has been de-prioritized.
LIMITED_BY_LOW_QUALITY A significant fraction of keywords in this bid strategy have a low Quality Score.
LIMITED_BY_INVENTORY The bid strategy cannot fully spend its budget because of narrow targeting.
MISCONFIGURED_ZERO_ELIGIBILITY Missing conversion tracking (no pings present) and/or remarketing lists for SSC.
MISCONFIGURED_CONVERSION_TYPES The bid strategy depends on conversion reporting and the customer is lacking conversion types that might be reported against this strategy.
MISCONFIGURED_CONVERSION_SETTINGS The bid strategy depends on conversion reporting and the customer's conversion settings are misconfigured.
MISCONFIGURED_SHARED_BUDGET There are campaigns outside the bid strategy that share budgets with campaigns included in the strategy.
MISCONFIGURED_STRATEGY_TYPE The campaign has an invalid strategy type and is not serving.
PAUSED The bid strategy is not active. Either there are no active campaigns, ad groups or keywords attached to the bid strategy. Or there are no active budgets connected to the bid strategy.
UNAVAILABLE This bid strategy currently does not support status reporting.
MULTIPLE_LEARNING There were multiple LEARNING_* system statuses for this bid strategy during the time in question.
MULTIPLE_LIMITED There were multiple LIMITED_* system statuses for this bid strategy during the time in question.
MULTIPLE_MISCONFIGURED There were multiple MISCONFIGURED_* system statuses for this bid strategy during the time in question.
MULTIPLE There were multiple system statuses for this bid strategy during the time in question.

AdServingOptimizationStatus

Enum describing possible serving statuses.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.

OPTIMIZE Ad serving is optimized based on CTR for the campaign.
CONVERSION_OPTIMIZE Ad serving is optimized based on CTR * Conversion for the campaign. If the campaign is not in the conversion optimizer bidding strategy, it will default to OPTIMIZED.
ROTATE Ads are rotated evenly for 90 days, then optimized for clicks.
ROTATE_INDEFINITELY Show lower performing ads more evenly with higher performing ads, and do not optimize.
UNAVAILABLE Ad serving optimization status is not available.

AdvertisingChannelType

Enum describing the various advertising channel types.

Enums
UNSPECIFIED Не указан.
UNKNOWN Used for return value only. Represents value unknown in this version.
SEARCH Search Network. Includes display bundled, and Search+ campaigns.
DISPLAY Google Display Network only.
SHOPPING Shopping campaigns serve on the shopping property and on google.com search results.
HOTEL Hotel Ads campaigns.
VIDEO Видео кампании.
MULTI_CHANNEL App Campaigns, and App Campaigns for Engagement, that run across multiple channels.
LOCAL Local ads campaigns.
SMART Smart campaigns.
PERFORMANCE_MAX Performance Max campaigns.
LOCAL_SERVICES Local services campaigns.
DISCOVERY Discovery campaigns.
TRAVEL Travel campaigns.

AdvertisingChannelSubType

Enum describing the different channel subtypes.

Enums
UNSPECIFIED Не указан.
UNKNOWN Used as a return value only. Represents value unknown in this version.
SEARCH_MOBILE_APP Mobile app campaigns for Search.
DISPLAY_MOBILE_APP Mobile app campaigns for Display.
SEARCH_EXPRESS AdWords express campaigns for search.
DISPLAY_EXPRESS AdWords Express campaigns for display.
SHOPPING_SMART_ADS Smart Shopping campaigns.
DISPLAY_GMAIL_AD Gmail Ad campaigns.
DISPLAY_SMART_CAMPAIGN Smart display campaigns. New campaigns of this sub type cannot be created.
VIDEO_OUTSTREAM Video Outstream campaigns.
VIDEO_ACTION Video TrueView for Action campaigns.
VIDEO_NON_SKIPPABLE Video campaigns with non-skippable video ads.
APP_CAMPAIGN App Campaign that lets you easily promote your Android or iOS app across Google's top properties including Search, Play, YouTube, and the Google Display Network.
APP_CAMPAIGN_FOR_ENGAGEMENT App Campaign for engagement, focused on driving re-engagement with the app across several of Google's top properties including Search, YouTube, and the Google Display Network.
LOCAL_CAMPAIGN Campaigns specialized for local advertising.
SHOPPING_COMPARISON_LISTING_ADS Shopping Comparison Listing campaigns.
SMART_CAMPAIGN Standard Smart campaigns.
VIDEO_SEQUENCE Video campaigns with sequence video ads.
APP_CAMPAIGN_FOR_PRE_REGISTRATION App Campaign for pre registration, specialized for advertising mobile app pre-registration, that targets multiple advertising channels across Google Play, YouTube and Display Network.
VIDEO_REACH_TARGET_FREQUENCY Video reach campaign with Target Frequency bidding strategy.
TRAVEL_ACTIVITIES Travel Activities campaigns.

CustomParameter

A mapping that can be used by custom parameter tags in a trackingUrlTemplate , finalUrls , or mobile_final_urls .

JSON representation
{
  "key": string,
  "value": string
}
Поля
key

string

The key matching the parameter tag name.

value

string

The value to be substituted.

RealTimeBiddingSetting

Settings for Real-Time Bidding, a feature only available for campaigns targeting the Ad Exchange network.

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

boolean

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

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

The network settings for the campaign.

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

The setting for controlling Dynamic Search Ads (DSA).

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

string

Необходимый. The Internet domain name that this setting represents, for example, "google.com" or "www.google.com".

languageCode

string

Необходимый. 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.

Enums
UNSPECIFIED Не указан.
UNKNOWN The value is unknown in this version.
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.

Enums
UNSPECIFIED Не указан.
UNKNOWN The value is unknown in this version.
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

This type has no fields.

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

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

JSON representation
{
  "conversionActions": [
    string
  ]
}
Поля
conversionActions[]

string

The selected set of conversion actions for optimizing this campaign.

OptimizationGoalSetting

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

JSON representation
{
  "optimizationGoalTypes": [
    enum (OptimizationGoalType)
  ]
}
Поля
optimizationGoalTypes[]

enum ( OptimizationGoalType )

The list of optimization goal types.

OptimizationGoalType

The type of optimization goal

Enums
UNSPECIFIED Не указан.
UNKNOWN Used as a return value only. Represents value unknown in this version.
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

Campaign-level settings for tracking information.

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

string

The url used for dynamic tracking.

ManualCpa

This type has no fields.

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

This type has no fields.

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

This type has no fields.

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 )

The type of the criterion.

status

enum ( CampaignCriterionStatus )

The status of the criterion.

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)

The ID of the criterion.

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

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

Union field criterion . The campaign criterion.

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

keyword

object ( KeywordInfo )

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

location

object ( LocationInfo )

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

device

object ( DeviceInfo )

Устройство.

ageRange

object ( AgeRangeInfo )

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

gender

object ( GenderInfo )

Пол.

userList

object ( UserListInfo )

User List.

language

object ( LanguageInfo )

Язык.

webpage

object ( WebpageInfo )

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

locationGroup

object ( LocationGroupInfo )

Location Group

CampaignCriterionStatus

The possible statuses of a CampaignCriterion.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.

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)

Enums
UNSPECIFIED Не указан.
UNKNOWN Used for return value only. Represents value unknown in this version.
METERS Метры
MILES Майлз
MILLI_MILES Milli Miles

CampaignLabel

Represents a relationship between a campaign and a label.

JSON representation
{
  "resourceName": string,
  "campaign": string,
  "label": string
}
Поля
resourceName

string

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

campaign

string

The campaign to which the label is attached.

label

string

The label assigned to the campaign.

CartDataSalesView

Cart data sales view.

JSON representation
{
  "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

Аудитория

Audience is an effective targeting option that lets you intersect different segment attributes, such as detailed demographics and affinities, to create audiences that represent sections of your target segments.

JSON representation
{
  "resourceName": string,
  "id": string,
  "name": string,
  "description": string
}
Поля
resourceName

string

The resource name of the audience. Audience names have the form:

customers/{customerId}/audiences/{audience_id}

id

string ( int64 format)

ID of the audience.

name

string

Необходимый. Name of the audience. It should be unique across all audiences. It must have a minimum length of 1 and maximum length of 255.

description

string

Description of this audience.

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.

Enums
UNSPECIFIED Не указан.
UNKNOWN Used for return value only. Represents value unknown in this version.
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.

Enums
UNSPECIFIED Не указан.
UNKNOWN Used for return value only. Represents value unknown in this version.
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. Только чтение.
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. Только чтение.
ANDROID_INSTALLS_ALL_OTHER_APPS Conversions that track all Google Play downloads which aren't tracked by an app-specific type. Только чтение.
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. Только чтение.
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. Только чтение.
GOOGLE_HOSTED Conversions that track local actions from Google's products and services after interacting with an ad. Только чтение.
LEAD_FORM_SUBMIT Conversions reported when a user submits a lead form. Только чтение.
SALESFORCE Conversions that come from Salesforce. Только чтение.
SEARCH_ADS_360 Conversions imported from Search Ads 360 Floodlight data. Только чтение.
SMART_CAMPAIGN_AD_CLICKS_TO_CALL Call conversions that occur on Smart campaign Ads without call tracking setup, using Smart campaign custom criteria. Только чтение.
SMART_CAMPAIGN_MAP_CLICKS_TO_CALL The user clicks on a call element within Google Maps. Smart campaign only. Только чтение.
SMART_CAMPAIGN_MAP_DIRECTIONS The user requests directions to a business location within Google Maps. Smart campaign only. Только чтение.
SMART_CAMPAIGN_TRACKED_CALLS Call conversions that occur on Smart campaign Ads with call tracking setup, using Smart campaign custom criteria. Только чтение.
STORE_VISITS Conversions that occur when a user visits an advertiser's retail store. Только чтение.
WEBPAGE_CODELESS Conversions created from website events (such as form submissions or page loads), that don't use individually coded event snippets. Только чтение.
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.

Enums
UNSPECIFIED Не указан.
UNKNOWN Used for return value only. Represents value unknown in this version.
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

The attribution model that describes how to distribute credit for a particular conversion across potentially many prior interactions.

Enums
UNSPECIFIED Не указан.
UNKNOWN Used for return value only. Represents value unknown in this version.
EXTERNAL Uses external attribution.
GOOGLE_ADS_LAST_CLICK Attributes all credit for a conversion to its last click.
GOOGLE_SEARCH_ATTRIBUTION_FIRST_CLICK Attributes all credit for a conversion to its first click using Google Search attribution.
GOOGLE_SEARCH_ATTRIBUTION_LINEAR Attributes credit for a conversion equally across all of its clicks using Google Search attribution.
GOOGLE_SEARCH_ATTRIBUTION_TIME_DECAY Attributes exponentially more credit for a conversion to its more recent clicks using Google Search attribution (half-life is 1 week).
GOOGLE_SEARCH_ATTRIBUTION_POSITION_BASED Attributes 40% of the credit for a conversion to its first and last clicks. Remaining 20% is evenly distributed across all other clicks. This uses Google Search attribution.
GOOGLE_SEARCH_ATTRIBUTION_DATA_DRIVEN Flexible model that uses machine learning to determine the appropriate distribution of credit among clicks using Google Search attribution.

DataDrivenModelStatus

Enumerates data driven model statuses.

Enums
UNSPECIFIED Не указан.
UNKNOWN Used for return value only. Represents value unknown in this version.
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

Необходимый. 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

Необходимый. 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.

Enums
UNSPECIFIED Не указан.
UNKNOWN Used for return value only. Represents value unknown in this version.
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.

Enums
UNSPECIFIED Не указан.
UNKNOWN Used for return value only. Represents value unknown in this version.
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.

Enums
UNSPECIFIED Не указан.
UNKNOWN Used for return value only. Represents value unknown in this version.
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.

Enums
UNSPECIFIED Не указан.
UNKNOWN Used for return value only. Represents value unknown in this version.
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.

Enums
UNSPECIFIED Не указан.
UNKNOWN Used for return value only. Represents value unknown in this version.
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,
  "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.

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.

Enums
UNSPECIFIED Не указан.
UNKNOWN Used for return value only. Represents value unknown in this version.
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 .

Тип аккаунта

Possible engine account types.

Enums
UNSPECIFIED Не указан.
UNKNOWN Used for return value only. Represents value unknown in this version.
BAIDU Baidu account.
ENGINE_TRACK Engine track account.
FACEBOOK Аккаунт в Фэйсбуке.
FACEBOOK_GATEWAY Facebook account managed through gateway.
GOOGLE_ADS Google Ads account.
MICROSOFT Microsoft Advertising account.
SEARCH_ADS_360 Search Ads 360 manager account.
YAHOO_JAPAN Yahoo Japan account.

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.

Статус аккаунта

Possible statuses of an account.

Enums
UNSPECIFIED Значение по умолчанию.
UNKNOWN Unknown value.
ENABLED Account is able to serve ads.
PAUSED Account is deactivated by the user.
SUSPENDED Account is deactivated by an internal process.
REMOVED Account is irrevocably deactivated.
DRAFT Account is still in the process of setup, not ENABLED yet.

CustomerStatus

Possible statuses of a customer.

Enums
UNSPECIFIED Не указан.
UNKNOWN Used for return value only. Represents value unknown in this version.
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.

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

Необходимый. 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.

AccessibleBiddingStrategy

Represents a view of BiddingStrategies owned by and shared with the customer.

In contrast to BiddingStrategy, this resource includes strategies owned by managers of the customer and shared with this customer - in addition to strategies owned by this customer. This resource does not provide metrics and only exposes a limited subset of the BiddingStrategy attributes.

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

The resource name of the accessible bidding strategy. AccessibleBiddingStrategy resource names have the form:

customers/{customerId}/accessibleBiddingStrategies/{bidding_strategy_id}

id

string ( int64 format)

The ID of the bidding strategy.

name

string

The name of the bidding strategy.

type

enum ( BiddingStrategyType )

The type of the bidding strategy.

ownerCustomerId

string ( int64 format)

The ID of the Customer which owns the bidding strategy.

ownerDescriptiveName

string

descriptiveName of the Customer which owns the bidding strategy.

Union field scheme . The bidding scheme.

Only one can be set. scheme can be only one of the following:

maximizeConversionValue

object ( MaximizeConversionValue )

An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget.

maximizeConversions

object ( MaximizeConversions )

An automated bidding strategy to help get the most conversions for your campaigns while spending your budget.

targetCpa

object ( TargetCpa )

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

targetImpressionShare

object ( TargetImpressionShare )

A bidding strategy that automatically optimizes towards a chosen percentage of impressions.

targetRoas

object ( TargetRoas )

A bidding strategy that helps you maximize revenue while averaging a specific target Return On Ad Spend (ROAS).

targetSpend

object ( TargetSpend )

A bid strategy that sets your bids to help get as many clicks as possible within your budget.

MaximizeConversionValue

An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget.

JSON representation
{
  "targetRoas": number
}
Поля
targetRoas

number

The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget.

MaximizeConversions

An automated bidding strategy to help get the most conversions for your campaigns while spending your budget.

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

string ( int64 format)

The target cost per acquisition (CPA) option. This is the average amount that you would like to spend per acquisition.

targetCpaMicros

string ( int64 format)

The target cost per acquisition (CPA) option. This is the average amount that you would like to spend per acquisition.

TargetCpa

An automated bid strategy that sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set.

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

string ( int64 format)

Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account.

TargetImpressionShare

An automated bidding strategy that sets bids so that a certain percentage of search ads are shown at the top of the first page (or other targeted location).

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

enum ( TargetImpressionShareLocation )

The targeted location on the search results page.

locationFractionMicros

string ( int64 format)

The chosen fraction of ads to be shown in the targeted location in micros. For example, 1% equals 10,000.

cpcBidCeilingMicros

string ( int64 format)

The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros.

TargetRoas

An automated bidding strategy that helps you maximize revenue while averaging a specific target return on ad spend (ROAS).

JSON representation
{
  "targetRoas": number
}
Поля
targetRoas

number

The chosen revenue (based on conversion data) per unit of spend.

TargetSpend

An automated bid strategy that sets your bids to help get as many clicks as possible within your budget.

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

string ( int64 format)

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)

Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.

ManagerLinkStatus

Possible statuses of a link.

Enums
UNSPECIFIED Не указан.
UNKNOWN Used for return value only. Represents value unknown in this version.
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. Только чтение.

clientCustomer

string

The resource name of the client-customer which is linked to the given customer. Только чтение.

hidden

boolean

Specifies whether this is a hidden account.

Только чтение.

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. Только чтение.

testAccount

boolean

Identifies if the client is a test account. Только чтение.

manager

boolean

Identifies if the client is a manager. Только чтение.

descriptiveName

string

Descriptive name for the client. Только чтение.

currencyCode

string

Currency code (for example, 'USD', 'EUR') for the client. Только чтение.

id

string ( int64 format)

The ID of the client customer. Только чтение.

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.

This field is read-only.

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.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.

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}

Этикетка

Метка.

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/{customerId}/labels/{label_id}

status

enum ( LabelStatus )

Status of the label. Только чтение.

textLabel

object ( TextLabel )

A type of label displaying text on a colored background.

id

string ( int64 format)

ID of the label. Только чтение.

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.

Enums
UNSPECIFIED Не указан.
UNKNOWN Used for return value only. Represents value unknown in this version.
ENABLED Label is enabled.
REMOVED Label is removed.

TextLabel

A type of label displaying text on a colored background.

JSON representation
{
  "backgroundColor": string,
  "description": string
}
Поля
backgroundColor

string

Background color of the label in RGB 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 representation
{
  "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.

Enums
UNSPECIFIED Не указан.
UNKNOWN Used for return value only. Represents value unknown in this version.
LEVEL1 1-й уровень.
LEVEL2 Уровень 2.
LEVEL3 Уровень 3.
LEVEL4 Уровень 4.
LEVEL5 Level 5.

ProductBiddingCategoryStatus

Enum describing the status of the product bidding category.

Enums
UNSPECIFIED Не указан.
UNKNOWN Used for return value only. Represents value unknown in this version.
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.

This field is read-only.

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.

Enums
UNSPECIFIED Не указан.
UNKNOWN Used for return value only. Represents value unknown in this version.
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.

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}

Посещать

Визит.

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.

Enums
UNSPECIFIED Не указан.
UNKNOWN Used for return value only. Represents value unknown in this version.
ONLINE The item is sold online.
LOCAL The item is sold in local stores.

Conversion

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

Conversion attribution type in SearchAds360

Enums
UNSPECIFIED Не указан.
UNKNOWN Used for return value only. Represents value unknown in this version.
VISIT The conversion is attributed to a visit.
CRITERION_AD The conversion is attributed to a criterion and ad pair.

ConversionStatus

Possible statuses of a conversion.

Enums
UNSPECIFIED Не указан.
UNKNOWN Used for return value only. Represents value unknown in this version.
ENABLED The conversion is enabled.
REMOVED The conversion has been removed.

Метрики

Metrics data.

JSON representation
{
  "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,
  "crossDeviceConversionsValue": number,
  "ctr": number,
  "conversions": number,
  "conversionsValue": number,
  "historicalQualityScore": string,
  "impressions": string,
  "interactionRate": number,
  "interactions": string,
  "invalidClickRate": number,
  "invalidClicks": 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
}
Поля
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.

crossDeviceConversionsValue

number

The sum of the value of cross-device conversions.

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.

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.

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.

Ценить

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 . Ценность. value can be only one of the following:
booleanValue

boolean

A boolean.

int64Value

string ( int64 format)

An int64.

floatValue

number

A float.

doubleValue

number

Двойной.

stringValue

string

Строка.

QualityScoreBucket

Enum listing the possible quality score buckets.

Enums
UNSPECIFIED Не указан.
UNKNOWN Used for return value only. Represents value unknown in this version.
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.

Enums
UNSPECIFIED Не указан.
UNKNOWN Used for return value only. Represents value unknown in this version.
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,
  "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.

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

Enumerates Google Ads network types.

Enums
UNSPECIFIED Не указан.
UNKNOWN The value is unknown in this version.
SEARCH Поиск Гугл.
SEARCH_PARTNERS Search partners.
CONTENT Display Network.
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.

Enums
UNSPECIFIED Не указан.
UNKNOWN Used for return value only. Represents value unknown in this version.
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.

Enums
UNSPECIFIED Не указан.
UNKNOWN Used for return value only. Represents value unknown in this version.
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 representation
{
  "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.