Method: customers.recommendations.apply

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

Список выброшенных ошибок: AuthenticationError AuthorizationError DatabaseError FieldError HeaderError InternalError MutateError QuotaError РекомендацияError RequestError UrlFieldError

HTTP-запрос

POST https://googleads.googleapis.com/v14/customers/{customerId}/recommendations:apply

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
customerId

string

Необходимый. Идентификатор клиента с рекомендацией.

Тело запроса

Тело запроса содержит данные следующей структуры:

JSON-представление
{
  "operations": [
    {
      object (ApplyRecommendationOperation)
    }
  ],
  "partialFailure": boolean
}
Поля
operations[]

object ( ApplyRecommendationOperation )

Необходимый. Перечень операций по применению рекомендаций. Если partsFailure=false, все рекомендации должны быть одного типа. Существует ограничение в 100 операций на запрос.

partialFailure

boolean

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

Тело ответа

Ответное сообщение для RecommendationService.ApplyRecommendation .

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление
{
  "results": [
    {
      object (ApplyRecommendationResult)
    }
  ],
  "partialFailureError": {
    object (Status)
  }
}
Поля
results[]

object ( ApplyRecommendationResult )

Результаты операций по применению рекомендаций.

partialFailureError

object ( Status )

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

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

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

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

Дополнительную информацию см. в обзоре OAuth 2.0 .

ПрименитьРекомендацияОперация

Информация об операции по применению рекомендации и любых параметрах для ее настройки.

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

  // Union field apply_parameters can be only one of the following:
  "campaignBudget": {
    object (CampaignBudgetParameters)
  },
  "textAd": {
    object (TextAdParameters)
  },
  "keyword": {
    object (KeywordParameters)
  },
  "targetCpaOptIn": {
    object (TargetCpaOptInParameters)
  },
  "targetRoasOptIn": {
    object (TargetRoasOptInParameters)
  },
  "calloutExtension": {
    object (CalloutExtensionParameters)
  },
  "callExtension": {
    object (CallExtensionParameters)
  },
  "sitelinkExtension": {
    object (SitelinkExtensionParameters)
  },
  "moveUnusedBudget": {
    object (MoveUnusedBudgetParameters)
  },
  "responsiveSearchAd": {
    object (ResponsiveSearchAdParameters)
  },
  "useBroadMatchKeyword": {
    object (UseBroadMatchKeywordParameters)
  },
  "responsiveSearchAdAsset": {
    object (ResponsiveSearchAdAssetParameters)
  },
  "responsiveSearchAdImproveAdStrength": {
    object (ResponsiveSearchAdImproveAdStrengthParameters)
  },
  "raiseTargetCpaBidTooLow": {
    object (RaiseTargetCpaBidTooLowParameters)
  },
  "forecastingSetTargetRoas": {
    object (ForecastingSetTargetRoasParameters)
  },
  "calloutAsset": {
    object (CalloutAssetParameters)
  },
  "callAsset": {
    object (CallAssetParameters)
  },
  "sitelinkAsset": {
    object (SitelinkAssetParameters)
  },
  "raiseTargetCpa": {
    object (RaiseTargetCpaParameters)
  },
  "lowerTargetRoas": {
    object (LowerTargetRoasParameters)
  }
  // End of list of possible types for union field apply_parameters.
}
Поля
resourceName

string

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

Поле объединения apply_parameters . Параметры, которые следует использовать при применении рекомендации. apply_parameters может быть только одним из следующих:
campaignBudget

object ( CampaignBudgetParameters )

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

textAd

object ( TextAdParameters )

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

keyword

object ( KeywordParameters )

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

targetCpaOptIn

object ( TargetCpaOptInParameters )

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

targetRoasOptIn

object ( TargetRoasOptInParameters )

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

calloutExtension

object ( CalloutExtensionParameters )

Параметры, которые следует использовать при применении рекомендации по расширению уточнения.

callExtension

object ( CallExtensionParameters )

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

moveUnusedBudget

object ( MoveUnusedBudgetParameters )

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

responsiveSearchAd

object ( ResponsiveSearchAdParameters )

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

useBroadMatchKeyword

object ( UseBroadMatchKeywordParameters )

Параметры, которые следует использовать при применении рекомендации по использованию ключевых слов с широким соответствием.

responsiveSearchAdAsset

object ( ResponsiveSearchAdAssetParameters )

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

responsiveSearchAdImproveAdStrength

object ( ResponsiveSearchAdImproveAdStrengthParameters )

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

raiseTargetCpaBidTooLow

object ( RaiseTargetCpaBidTooLowParameters )

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

forecastingSetTargetRoas

object ( ForecastingSetTargetRoasParameters )

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

calloutAsset

object ( CalloutAssetParameters )

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

callAsset

object ( CallAssetParameters )

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

raiseTargetCpa

object ( RaiseTargetCpaParameters )

Параметры, которые следует использовать при применении рекомендации повышения целевой цены за конверсию.

lowerTargetRoas

object ( LowerTargetRoasParameters )

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

Параметры бюджета кампании

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

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

string ( int64 format)

Новая сумма бюджета, которая будет установлена ​​для целевого ресурса бюджета. Данное поле является обязательным к заполнению.

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

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

JSON-представление
{
  "ad": {
    object (Ad)
  }
}
Поля
ad

object ( Ad )

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

Ключевые словаПараметры

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

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

enum ( KeywordMatchType )

Тип соответствия ключевого слова. Данное поле является обязательным к заполнению.

adGroup

string

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

cpcBidMicros

string ( int64 format)

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

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

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

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

string ( int64 format)

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

newCampaignBudgetAmountMicros

string ( int64 format)

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

ТаргетРоасОптИнПараметры

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

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

number

Средняя рентабельность инвестиций в рекламу (доход на единицу расходов), которую можно использовать для стратегии назначения ставок "Целевая рентабельность инвестиций в рекламу". Значение находится в диапазоне от 0,01 до 1000,0 включительно. Это обязательное поле, если не установлено значение newCampaignBudgetAmountMicros.

newCampaignBudgetAmountMicros

string ( int64 format)

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

Параметры расширения CalloutExtension

Параметры, которые следует использовать при применении рекомендации по расширению уточнения.

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

object ( CalloutFeedItem )

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

Параметры CallExtension

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

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

object ( CallFeedItem )

Необходимо добавить номера телефонов. Данное поле является обязательным к заполнению.

Параметры расширения дополнительной ссылки

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

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

MoveUnusedBudgetParameters

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

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

string ( int64 format)

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

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

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

JSON-представление
{
  "ad": {
    object (Ad)
  }
}
Поля
ad

object ( Ad )

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

UseBroadMatchKeywordParameters

Параметры, которые следует использовать при применении рекомендации по использованию ключевых слов с широким соответствием.

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

string ( int64 format)

Новая сумма бюджета, которая будет установлена ​​для целевого ресурса бюджета.

АдаптивныйSearchAdAssetParameters

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

JSON-представление
{
  "updatedAd": {
    object (Ad)
  }
}
Поля
updatedAd

object ( Ad )

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

АдаптивноеПоисковоеОбъявлениеImproveAdStrengthParameters

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

JSON-представление
{
  "updatedAd": {
    object (Ad)
  }
}
Поля
updatedAd

object ( Ad )

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

RaiseTargetCpaBidTooLowParameters

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

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

number

Необходимый. Число больше 1,0, обозначающее коэффициент, на который можно увеличить целевую цену за конверсию. Данное поле является обязательным к заполнению.

ПрогнозированиеSetTargetRoasParameters

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

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

number

Новая целевая рентабельность инвестиций в рекламу (доход на единицу расходов), которую можно установить для ресурса кампании. Значение находится в диапазоне от 0,01 до 1000,0 включительно.

campaignBudgetAmountMicros

string ( int64 format)

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

ВыноскаАссетПараметры

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

JSON-представление
{
  "adAssetApplyParameters": {
    object (AdAssetApplyParameters)
  }
}
Поля
adAssetApplyParameters

object ( AdAssetApplyParameters )

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

AdAssetApplyParameters

Общие параметры, используемые при применении рекомендаций по рекламным объектам.

JSON-представление
{
  "newAssets": [
    {
      object (Asset)
    }
  ],
  "existingAssets": [
    string
  ],
  "scope": enum (ApplyScope)
}
Поля
newAssets[]

object ( Asset )

Ресурсы, которые необходимо создать и прикрепить к области. Это можно комбинировать с существующими активами в одном вызове.

existingAssets[]

string

Имена ресурсов существующих активов, которые нужно присоединить к области. Это можно комбинировать с newAssets в одном вызове.

scope

enum ( ApplyScope )

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

ПрименитьОбласть

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

Перечисления
UNSPECIFIED Область применения не указана.
UNKNOWN Неизвестный.
CUSTOMER Применить на уровне клиента.
CAMPAIGN Применить в рамках кампании.

CallAssetParameters

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

JSON-представление
{
  "adAssetApplyParameters": {
    object (AdAssetApplyParameters)
  }
}
Поля
adAssetApplyParameters

object ( AdAssetApplyParameters )

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

Параметры объекта дополнительной ссылки

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

JSON-представление
{
  "adAssetApplyParameters": {
    object (AdAssetApplyParameters)
  }
}
Поля
adAssetApplyParameters

object ( AdAssetApplyParameters )

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

Параметры RaiseTargetCpa

Параметры, которые следует использовать при применении рекомендаций по повышению целевой цены за конверсию.

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

number

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

Нижняя цельRoasПараметры

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

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

number

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

ПрименитьРекомендацияРезультат

Результат применения рекомендации.

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

string

Возвращается в случае успешных заявок.