- HTTP リクエスト
- パスパラメータ
- リクエストの本文
- レスポンスの本文
- 認可スコープ
- ApplyRecommendationOperation
- CampaignBudgetParameters
- TextAdParameters
- KeywordParameters
- TargetCpaOptInParameters
- TargetRoasOptInParameters
- CalloutExtensionParameters
- CallExtensionParameters
- SitelinkExtensionParameters
- MoveUnusedBudgetParameters
- ResponsiveSearchAdParameters
- UseBroadMatchKeywordParameters
- ResponsiveSearchAdAssetParameters
- ResponsiveSearchAdImproveAdStrengthParameters
- RaiseTargetCpaBidTooLowParameters
- ForecastingSetTargetRoasParameters
- CalloutAssetParameters
- AdAssetApplyParameters
- ApplyScope
- CallAssetParameters
- SitelinkAssetParameters
- RaiseTargetCpaParameters
- LowerTargetRoasParameters
- ForecastingSetTargetCpaParameters
- LeadFormAssetParameters
- ApplyRecommendationResult
- 試してみる
指定された推奨事項を、対応する適用パラメータで適用します。
スローされるエラーのリスト: AuthenticationError AuthorizationError DatabaseError FieldError HeaderError InternalError MutateError QuotaError RecommendationError RequestError UrlFieldError
HTTP リクエスト
POST https://googleads.googleapis.com/v16/customers/{customerId}/recommendations:apply
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
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 です。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 です。 |
campaignBudgetAmountMicros |
キャンペーン リソースに設定する新しいキャンペーン予算額。 |
CalloutAssetParameters
コールアウト アセットの最適化案を適用するときに使用するパラメータ。
JSON 表現 |
---|
{
"adAssetApplyParameters": {
object ( |
フィールド | |
---|---|
adAssetApplyParameters |
必須。追加するコールアウト アセット。必須フィールドです。 |
AdAssetApplyParameters
広告アセットの最適化案を適用する際に使用される一般的なパラメータ。
JSON 表現 |
---|
{ "newAssets": [ { object ( |
フィールド | |
---|---|
newAssets[] |
作成してスコープに関連付けるアセット。これは、同じ呼び出しで既存の Assets と組み合わせることができます。 |
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 |
適用に成功した場合に返されます。 |