Method: customers.recommendations.apply

使用相應的套用參數套用指定的建議。

擲回錯誤清單:AuthenticationError AuthorizationError DatabaseError FieldError HeaderError InternalError MutateError QuotaError RecommendationError RequestError UrlFieldError

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
customerId

string

必要欄位。提供建議的客戶 ID。

要求主體

要求主體的資料會採用以下結構:

JSON 表示法
{
  "operations": [
    {
      object (ApplyRecommendationOperation)
    }
  ],
  "partialFailure": boolean
}
欄位
operations[]

object (ApplyRecommendationOperation)

必要欄位。列出要套用建議的作業。如果部分建議應屬於同一類型,則每個要求最多只能包含 100 個作業。

partialFailure

boolean

如果為 true,系統就會執行成功的作業,且無效的作業會傳回錯誤。如果為 false,只有當作業全部有效時,系統才會以交易的形式執行。預設值為 false。

回應主體

RecommendationService.ApplyRecommendation 的回應訊息。

如果成功,回應主體即會包含具有以下結構的資料:

JSON 表示法
{
  "results": [
    {
      object (ApplyRecommendationResult)
    }
  ],
  "partialFailureError": {
    object (Status)
  }
}
欄位
results[]

object (ApplyRecommendationResult)

套用最佳化建議的作業結果。

partialFailureError

object (Status)

在部分失敗模式下,與作業失敗相關的錯誤。只有在部分失敗 = true 且作業內發生所有錯誤時,才會傳回這個編號。如果在作業以外發生任何錯誤 (例如驗證錯誤),我們會傳回遠端程序呼叫 (RPC) 層級錯誤。

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱 OAuth 2.0 總覽

ApplyRecommendationOperation

套用建議的作業相關資訊,以及用來自訂建議的任何參數。

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)

套用較低目標廣告投資報酬率最佳化建議時要使用的參數。

CampaignBudgetParameters

套用廣告活動預算建議時使用的參數。

JSON 表示法
{
  "newBudgetAmountMicros": string
}
欄位
newBudgetAmountMicros

string (int64 format)

要為目標預算資源設定的新預算金額。此為必填欄位。

TextAdParameters

套用文字廣告建議時使用的參數。

JSON 表示法
{
  "ad": {
    object (Ad)
  }
}
欄位
ad

object (Ad)

要加進建議廣告群組中的新廣告。請務必在這則訊息中設定所有必要欄位。此為必填欄位。

KeywordParameters

套用關鍵字建議時使用的參數。

JSON 表示法
{
  "matchType": enum (KeywordMatchType),
  "adGroup": string,
  "cpcBidMicros": string
}
欄位
matchType

enum (KeywordMatchType)

關鍵字比對類型。此為必填欄位。

adGroup

string

要新增關鍵字的廣告群組資源。此為必填欄位。

cpcBidMicros

string (int64 format)

選擇性設定:關鍵字的單次點擊出價。如未設定,關鍵字就會根據目標廣告群組使用的出價策略來設定出價。

TargetCpaOptInParameters

套用目標單次轉換出價建議時使用的參數。

JSON 表示法
{
  "targetCpaMicros": string,
  "newCampaignBudgetAmountMicros": string
}
欄位
targetCpaMicros

string (int64 format)

目標單次轉換出價策略使用的平均單次轉換出價。此為必填欄位。

newCampaignBudgetAmountMicros

string (int64 format)

(選填) 為廣告活動設定的預算金額。

TargetRoasOptInParameters

套用「採用目標廣告投資報酬率」最佳化建議時要使用的參數。

JSON 表示法
{
  "targetRoas": number,
  "newCampaignBudgetAmountMicros": string
}
欄位
targetRoas

number

用於目標廣告投資報酬率出價策略的平均廣告投資報酬率 (每單位支出收益)。這個值介於 0.01 和 1000.0 (含) 之間。除非已設定 newCampaignBudgetAmountMicros,否則此為必填欄位。

newCampaignBudgetAmountMicros

string (int64 format)

(選填) 為廣告活動設定的預算金額。

CalloutExtensionParameters

套用摘要額外資訊建議時使用的參數。

JSON 表示法
{
  "calloutExtensions": [
    {
      object (CalloutFeedItem)
    }
  ]
}
欄位
calloutExtensions[]

object (CalloutFeedItem)

要新增的摘要額外資訊。此為必填欄位。

CallExtensionParameters

套用來電額外資訊建議時使用的參數。

JSON 表示法
{
  "callExtensions": [
    {
      object (CallFeedItem)
    }
  ]
}
欄位
callExtensions[]

object (CallFeedItem)

要加入的來電額外資訊。此為必填欄位。

SitelinkExtensionParameters

套用網站連結建議時使用的參數。

JSON 表示法
{
  "sitelinkExtensions": [
    {
      object (SitelinkFeedItem)
    }
  ]
}
欄位

MoveUnusedBudgetParameters

套用未用到的預算建議時要使用的參數。

JSON 表示法
{
  "budgetMicrosToMove": string
}
欄位
budgetMicrosToMove

string (int64 format)

從超出預算的預算金額挪至不足的預算。此為必填欄位。

ResponsiveSearchAdParameters

套用回應式搜尋廣告建議時使用的參數。

JSON 表示法
{
  "ad": {
    object (Ad)
  }
}
欄位
ad

object (Ad)

必要欄位。要加進建議廣告群組中的新廣告。

UseBroadMatchKeywordParameters

套用使用廣泛比對關鍵字建議時要使用的參數。

JSON 表示法
{
  "newBudgetAmountMicros": string
}
欄位
newBudgetAmountMicros

string (int64 format)

要為目標預算資源設定的新預算金額。

ResponsiveSearchAdAssetParameters

套用回應式搜尋廣告素材資源建議時使用的參數。

JSON 表示法
{
  "updatedAd": {
    object (Ad)
  }
}
欄位
updatedAd

object (Ad)

已更新廣告。系統將替換目前廣告的內容。

ResponsiveSearchAdImproveAdStrengthParameters

套用回應式搜尋廣告時要使用的參數,可改善廣告優異度建議。

JSON 表示法
{
  "updatedAd": {
    object (Ad)
  }
}
欄位
updatedAd

object (Ad)

已更新廣告。系統將替換目前廣告的內容。

RaiseTargetCpaBidTooLowParameters

套用目標單次轉換出價過低建議值時要使用的參數。這是非同步套用,且可能需要幾分鐘的時間,視相關廣告活動中的廣告群組數量而定。

JSON 表示法
{
  "targetMultiplier": number
}
欄位
targetMultiplier

number

必要欄位。大於 1.0 的數字,表示目標出價提高原因。此為必填欄位。

ForecastingSetTargetRoasParameters

套用預測設定目標目標廣告投資報酬率建議時使用的參數。

JSON 表示法
{
  "targetRoas": number,
  "campaignBudgetAmountMicros": string
}
欄位
targetRoas

number

為廣告活動資源設定的新目標廣告投資報酬率 (每單位支出的收益)。這個值介於 0.01 和 1000.0 (含) 之間。

campaignBudgetAmountMicros

string (int64 format)

為廣告活動資源設定的新廣告活動預算金額。

CalloutAssetParameters

套用摘要素材資源建議時使用的參數。

JSON 表示法
{
  "adAssetApplyParameters": {
    object (AdAssetApplyParameters)
  }
}
欄位
adAssetApplyParameters

object (AdAssetApplyParameters)

必要欄位。要新增的摘要素材資源。此為必填欄位。

AdAssetApplyParameters

套用廣告素材資源最佳化建議時使用的常見參數。

JSON 表示法
{
  "newAssets": [
    {
      object (Asset)
    }
  ],
  "existingAssets": [
    string
  ],
  "scope": enum (ApplyScope)
}
欄位
newAssets[]

object (Asset)

要建立並附加至特定範圍的資產。這類屬性可能會與同一通話中的現有資產合併。

existingAssets[]

string

要附加至範圍的現有資產資源名稱。系統可能會在同一次呼叫中與 newAsset 合併使用。

scope

enum (ApplyScope)

必要欄位。素材資源的套用範圍。廣告活動層級的素材資源會套用至與建議相關的廣告活動。客戶範圍內的素材資源會套用至整個帳戶。廣告活動範圍內的素材資源會覆寫客戶範圍中的任何附加項目。

ApplyScope

資產套用範圍。

列舉
UNSPECIFIED 未指定套用範圍。
UNKNOWN 不明。
CUSTOMER 適用於客戶範圍。
CAMPAIGN 適用於廣告活動範圍。

CallAssetParameters

套用電話素材資源建議時使用的參數。

JSON 表示法
{
  "adAssetApplyParameters": {
    object (AdAssetApplyParameters)
  }
}
欄位
adAssetApplyParameters

object (AdAssetApplyParameters)

必要欄位。要新增的電話素材資源。此為必填欄位。

SitelinkAssetParameters

套用網站連結素材資源建議時使用的參數。

JSON 表示法
{
  "adAssetApplyParameters": {
    object (AdAssetApplyParameters)
  }
}
欄位
adAssetApplyParameters

object (AdAssetApplyParameters)

必要欄位。要新增的網站連結素材資源。此為必填欄位。

RaiseTargetCpaParameters

套用提高目標單次轉換出價建議時使用的參數。

JSON 表示法
{
  "targetCpaMultiplier": number
}
欄位
targetCpaMultiplier

number

必要欄位。設定單次轉換出價調節係數的目標。此為必填欄位。

LowerTargetRoasParameters

套用較低的目標廣告投資報酬率最佳化建議時要使用的參數。

JSON 表示法
{
  "targetRoasMultiplier": number
}
欄位
targetRoasMultiplier

number

必要欄位。將廣告投資報酬率調節係數設為的目標。此為必填欄位。

ApplyRecommendationResult

套用建議的結果。

JSON 表示法
{
  "resourceName": string
}
欄位
resourceName

string

因成功套用而傳回。