- HTTP 请求
- 路径参数
- 请求正文
- 响应正文
- 授权范围
- ApplyRecommendationOperation
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- CampaignBudgetParameters
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- TextAdParameters
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- KeywordParameters
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- TargetCpaOptInParameters
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- TargetRoasOptInParameters
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- CalloutExtensionParameters
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- CallExtensionParameters
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- SitelinkExtensionParameters
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- MoveUnusedBudgetParameters
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- ResponsiveSearchAdParameters
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- UseBroadMatchKeywordParameters
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- ResponsiveSearchAdAssetParameters
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- ResponsiveSearchAdImproveAdStrengthParameters
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- RaiseTargetCpaBidTooLowParameters
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- ForecastingSetTargetRoasParameters
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- CalloutAssetParameters
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- AdAssetApplyParameters
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- ApplyScope
- CallAssetParameters
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- SitelinkAssetParameters
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- RaiseTargetCpaParameters
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- LowerTargetRoasParameters
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- ForecastingSetTargetCpaParameters
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- LeadFormAssetParameters
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- ApplyRecommendationResult
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- 试试看!
采用具有相应应用参数的给定建议。
抛出的错误列表:AuthenticationError AuthorizationError DatabaseError FieldError HeaderError InternalError MutateError QuotaError RecommendationError RequestError UrlFieldError
HTTP 请求
POST https://googleads.googleapis.com/v17/customers/{customerId}/recommendations:apply
网址采用 gRPC 转码语法。
路径参数
参数 | |
---|---|
customerId |
必需。提供推荐内容的客户的 ID。 |
请求正文
请求正文中包含结构如下的数据:
JSON 表示法 |
---|
{
"operations": [
{
object ( |
字段 | |
---|---|
operations[] |
必需。用于应用建议的操作列表。如果 partialFailure=false,所有建议都必须属于同一类型。每个请求的操作限制为 100。 |
partialFailure |
如果值为 true,则系统将执行成功的操作,而无效操作将返回错误。如果为 false,则当且仅当操作全部有效时,操作才会作为事务执行。默认值为 false。 |
响应正文
RecommendationService.ApplyRecommendation
的响应消息。
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{ "results": [ { object ( |
字段 | |
---|---|
results[] |
应用建议的操作结果。 |
partialFailureError |
与部分失败模式下的操作失败相关的错误。仅当 partialFailure = true 并且所有错误都发生在操作内部时,系统才会返回。如果在操作之外发生任何错误(例如,身份验证错误),我们将返回 RPC 级错误。 |
授权范围
需要以下 OAuth 范围:
https://www.googleapis.com/auth/adwords
如需了解详情,请参阅 OAuth 2.0 概览。
ApplyRecommendationOperation
要应用建议的操作的相关信息以及用于自定义建议的参数。
JSON 表示法 |
---|
{ "resourceName": string, // Union field |
字段 | |
---|---|
resourceName |
要应用的建议的资源名称。 |
联合字段 apply_parameters 。应用建议时使用的参数。apply_parameters 只能是下列其中一项: |
|
campaignBudget |
采纳广告系列预算建议时要使用的可选参数。 |
textAd |
采纳文字广告建议时要使用的可选参数。 |
keyword |
采纳关键字建议时要使用的可选参数。 |
targetCpaOptIn |
采纳“目标每次转化费用”出价策略选择启用建议时要使用的可选参数。 |
targetRoasOptIn |
采纳“目标广告支出回报率”出价策略启用建议时要使用的可选参数。 |
calloutExtension |
采纳附加宣传信息建议时要使用的参数。 |
callExtension |
采纳附加电话信息建议时要使用的参数。 |
sitelinkExtension |
采纳附加链接建议时要使用的参数。 |
moveUnusedBudget |
应用“改分未使用的预算”建议时使用的参数。 |
responsiveSearchAd |
应用自适应搜索广告建议时要使用的参数。 |
useBroadMatchKeyword |
应用“使用广泛匹配关键字”建议时要使用的参数。 |
responsiveSearchAdAsset |
应用自适应搜索广告素材资源建议时要使用的参数。 |
responsiveSearchAdImproveAdStrength |
应用自适应搜索广告时要使用的参数,可提升广告效力建议。 |
raiseTargetCpaBidTooLow |
应用目标每次转化费用的提高出价过低建议时使用的参数。此操作是异步进行的,可能需要几分钟,具体取决于相关广告系列中的广告组数量。 |
forecastingSetTargetRoas |
应用预测设置的目标广告支出回报率建议时使用的参数。 |
calloutAsset |
应用宣传信息素材资源建议时使用的参数。 |
callAsset |
采纳电话素材资源建议时要使用的参数。 |
sitelinkAsset |
采纳站内链接素材资源建议时要使用的参数。 |
raiseTargetCpa |
应用“提高目标每次转化费用”建议时使用的参数。 |
lowerTargetRoas |
应用“目标广告支出回报率”较低的建议时要使用的参数。 |
forecastingSetTargetCpa |
应用预测设置目标每次转化费用建议时使用的参数。 |
setTargetCpa |
应用设定的目标每次转化费用建议时要使用的参数。 |
setTargetRoas |
应用“目标广告支出回报率”建议时要使用的参数。 |
leadFormAsset |
采纳潜在客户表单素材资源建议时要使用的参数。 |
CampaignBudgetParameters
应用广告系列预算建议时使用的参数。
JSON 表示法 |
---|
{ "newBudgetAmountMicros": string } |
字段 | |
---|---|
newBudgetAmountMicros |
要为目标预算资源设置的新预算金额。此字段是必填字段。 |
TextAdParameters
应用文字广告建议时要使用的参数。
JSON 表示法 |
---|
{
"ad": {
object ( |
字段 | |
---|---|
ad |
要添加到推荐的广告组中的新广告。此消息中需要设置所有必填字段。此字段是必填字段。 |
KeywordParameters
应用关键字建议时使用的参数。
JSON 表示法 |
---|
{
"matchType": enum ( |
字段 | |
---|---|
matchType |
关键字的匹配类型。此字段是必填字段。 |
adGroup |
要添加关键字的广告组资源。此字段是必填字段。 |
cpcBidMicros |
(可选)为关键字设置的每次点击费用出价。如果未设置,关键字将根据目标广告组所使用的出价策略来使用出价。 |
TargetCpaOptInParameters
采纳“目标每次转化费用”建议时要使用的参数。
JSON 表示法 |
---|
{ "targetCpaMicros": string, "newCampaignBudgetAmountMicros": string } |
字段 | |
---|---|
targetCpaMicros |
用于“目标每次转化费用”出价策略的平均每次转化费用。此字段是必填字段。 |
newCampaignBudgetAmountMicros |
(可选)要为广告系列设置的预算金额。 |
TargetRoasOptInParameters
采纳“目标广告支出回报率”启用建议时要使用的参数。
JSON 表示法 |
---|
{ "targetRoas": number, "newCampaignBudgetAmountMicros": string } |
字段 | |
---|---|
targetRoas |
用于“目标广告支出回报率”出价策略的平均广告支出回报率(单位支出的收入)。该值介于 0.01 和 1000.0 之间(含 0.01 和 1000.0)。除非设置了 newCampaignBudgetAmountMicros,否则此字段是必填字段。 |
newCampaignBudgetAmountMicros |
(可选)要为广告系列设置的预算金额。 |
CalloutExtensionParameters
采纳附加宣传信息建议时要使用的参数。
JSON 表示法 |
---|
{
"calloutExtensions": [
{
object ( |
字段 | |
---|---|
calloutExtensions[] |
要添加的附加宣传信息。此字段是必填字段。 |
CallExtensionParameters
采纳附加电话信息建议时要使用的参数。
JSON 表示法 |
---|
{
"callExtensions": [
{
object ( |
字段 | |
---|---|
callExtensions[] |
要添加的附加电话信息。此字段是必填字段。 |
SitelinkExtensionParameters
采纳附加链接建议时要使用的参数。
JSON 表示法 |
---|
{
"sitelinkExtensions": [
{
object ( |
字段 | |
---|---|
sitelinkExtensions[] |
要添加的附加链接。此字段是必填字段。 |
MoveUnusedBudgetParameters
应用“改分未使用的预算”建议时使用的参数。
JSON 表示法 |
---|
{ "budgetMicrosToMove": string } |
字段 | |
---|---|
budgetMicrosToMove |
将预算金额从超额预算转为受限预算的预算金额。此字段是必填字段。 |
ResponsiveSearchAdParameters
应用自适应搜索广告建议时要使用的参数。
JSON 表示法 |
---|
{
"ad": {
object ( |
字段 | |
---|---|
ad |
必需。要添加到推荐的广告组中的新广告。 |
UseBroadMatchKeywordParameters
应用“使用广泛匹配关键字”建议时要使用的参数。
JSON 表示法 |
---|
{ "newBudgetAmountMicros": string } |
字段 | |
---|---|
newBudgetAmountMicros |
要为目标预算资源设置的新预算金额。 |
ResponsiveSearchAdAssetParameters
应用自适应搜索广告素材资源建议时要使用的参数。
JSON 表示法 |
---|
{
"updatedAd": {
object ( |
字段 | |
---|---|
updatedAd |
已更新广告。当前广告的内容将被替换。 |
ResponsiveSearchAdImproveAdStrengthParameters
应用自适应搜索广告时要使用的参数,可提升广告效力建议。
JSON 表示法 |
---|
{
"updatedAd": {
object ( |
字段 | |
---|---|
updatedAd |
已更新广告。当前广告的内容将被替换。 |
RaiseTargetCpaBidTooLowParameters
应用目标每次转化费用的提高出价过低建议时使用的参数。此操作是异步进行的,可能需要几分钟,具体取决于相关广告系列中的广告组数量。
JSON 表示法 |
---|
{ "targetMultiplier": number } |
字段 | |
---|---|
targetMultiplier |
必需。大于 1.0 的数字,表示将目标每次转化费用提高的系数。此字段是必填字段。 |
ForecastingSetTargetRoasParameters
应用预测设置的目标广告支出回报率建议时使用的参数。
JSON 表示法 |
---|
{ "targetRoas": number, "campaignBudgetAmountMicros": string } |
字段 | |
---|---|
targetRoas |
要为广告系列资源设置的新目标广告支出回报率(支出单位收入)。该值介于 0.01 和 1000.0 之间(含 0.01 和 1000.0)。 |
campaignBudgetAmountMicros |
要为广告系列资源设置的新广告系列预算金额。 |
CalloutAssetParameters
应用宣传信息素材资源建议时要使用的参数。
JSON 表示法 |
---|
{
"adAssetApplyParameters": {
object ( |
字段 | |
---|---|
adAssetApplyParameters |
必需。要添加的宣传信息素材资源。此字段是必填字段。 |
AdAssetApplyParameters
采纳广告素材资源建议时使用的常用参数。
JSON 表示法 |
---|
{ "newAssets": [ { object ( |
字段 | |
---|---|
newAssets[] |
要创建并附加到范围的资产。这可能会与同一调用中的现有素材资源结合使用。 |
existingAssets[] |
要附加到范围的现有资产的资源名称。这可能会在同一调用中与 newAssets 结合使用。 |
scope |
必需。素材资源的应用范围。广告系列范围级别的素材资源将应用于与建议相关联的广告系列。客户范围内的资源将应用到整个账号。广告系列范围内的素材资源将覆盖客户范围附加的任何素材资源。 |
ApplyScope
素材资源的应用范围。
枚举 | |
---|---|
UNSPECIFIED |
尚未指定应用范围。 |
UNKNOWN |
未知。 |
CUSTOMER |
在客户范围内应用。 |
CAMPAIGN |
在广告系列范围内应用。 |
CallAssetParameters
应用电话素材资源建议时要使用的参数。
JSON 表示法 |
---|
{
"adAssetApplyParameters": {
object ( |
字段 | |
---|---|
adAssetApplyParameters |
必需。要添加的电话素材资源。此字段是必填字段。 |
SitelinkAssetParameters
应用站内链接素材资源建议时要使用的参数。
JSON 表示法 |
---|
{
"adAssetApplyParameters": {
object ( |
字段 | |
---|---|
adAssetApplyParameters |
必需。要添加的站内链接素材资源。此字段是必填字段。 |
RaiseTargetCpaParameters
应用“目标每次转化费用”提高建议时使用的参数。
JSON 表示法 |
---|
{ "targetCpaMultiplier": number } |
字段 | |
---|---|
targetCpaMultiplier |
必需。要将每次转化费用调节系数设为的目标。此字段是必填字段。 |
LowerTargetRoasParameters
应用“目标广告支出回报率”较低的建议时要使用的参数。
JSON 表示法 |
---|
{ "targetRoasMultiplier": number } |
字段 | |
---|---|
targetRoasMultiplier |
必需。要将广告支出回报率调节系数设为的目标。此字段是必填字段。 |
ForecastingSetTargetCpaParameters
应用设定的目标每次转化费用建议时使用的参数。
JSON 表示法 |
---|
{ "targetCpaMicros": string, "campaignBudgetAmountMicros": string } |
字段 | |
---|---|
targetCpaMicros |
用于“目标每次转化费用”出价策略的平均每次转化费用。 |
campaignBudgetAmountMicros |
要为广告系列资源设置的新广告系列预算金额。 |
LeadFormAssetParameters
采纳潜在客户表单素材资源建议时要使用的参数。
JSON 表示法 |
---|
{
"adAssetApplyParameters": {
object ( |
字段 | |
---|---|
adAssetApplyParameters |
必需。要添加的潜在客户表单素材资源。此字段是必填字段。 |
setSubmitLeadFormAssetCampaignGoal |
如果为 true,将“提交潜在客户表单”目标广告系列。因此,广告将以潜在客户表单广告素材形式展示。如果返回的是 false,“提交潜在客户表单”目标,则广告将包含潜在客户表单素材资源。 |
ApplyRecommendationResult
采纳建议的结果。
JSON 表示法 |
---|
{ "resourceName": string } |
字段 | |
---|---|
resourceName |
成功应用后返回。 |