Method: customers.recommendations.apply

Menerapkan rekomendasi yang diberikan dengan parameter penerapan yang sesuai.

Daftar error yang ditampilkan: AuthenticationError AuthorizationError DatabaseError FieldError HeaderError InternalError MutateError QuotaError RecommendationError RequestError UrlFieldError

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
customerId

string

Wajib. ID pelanggan dengan rekomendasi.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "operations": [
    {
      object (ApplyRecommendationOperation)
    }
  ],
  "partialFailure": boolean
}
Kolom
operations[]

object (ApplyRecommendationOperation)

Wajib. Daftar operasi untuk menerapkan rekomendasi. Jika partialFailure=false, semua rekomendasi harus memiliki jenis yang sama. Ada batas 100 operasi per permintaan.
partialFailure

boolean

Jika true (benar), operasi yang berhasil akan dilakukan dan operasi yang tidak valid akan menampilkan error. Jika salah, operasi akan dilakukan sebagai transaksi jika dan hanya jika semuanya valid. Defaultnya adalah false.

Isi respons

Pesan respons untuk RecommendationService.ApplyRecommendation.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "results": [
    {
      object (ApplyRecommendationResult)
    }
  ],
  "partialFailureError": {
    object (Status)
  }
}
Kolom
results[]

object (ApplyRecommendationResult)

Hasil operasi untuk menerapkan rekomendasi.
partialFailureError

object (Status)

Error yang berkaitan dengan kegagalan operasi dalam mode kegagalan parsial. Ditampilkan hanya jika partialFailure = true dan semua error terjadi dalam operasi. Jika terjadi error di luar operasi (misalnya, error autentikasi), kami akan menampilkan error tingkat RPC.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

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

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.

ApplyRecommendationOperation

Informasi tentang operasi untuk menerapkan rekomendasi dan parameter apa pun untuk menyesuaikannya.

Representasi 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.
}
Kolom
resourceName

string

Nama resource rekomendasi yang akan diterapkan.
Kolom union apply_parameters. Parameter yang akan digunakan saat menerapkan rekomendasi. apply_parameters hanya ada berupa salah satu diantara berikut:
campaignBudget

object (CampaignBudgetParameters)

Parameter opsional yang akan digunakan saat menerapkan rekomendasi anggaran kampanye.
textAd

object (TextAdParameters)

Parameter opsional yang akan digunakan saat menerapkan rekomendasi iklan teks.
keyword

object (KeywordParameters)

Parameter opsional yang akan digunakan saat menerapkan rekomendasi kata kunci.
targetCpaOptIn

object (TargetCpaOptInParameters)

Parameter opsional yang digunakan saat menerapkan rekomendasi keikutsertaan Target CPA.
targetRoasOptIn

object (TargetRoasOptInParameters)

Parameter opsional yang akan digunakan saat menerapkan rekomendasi keikutsertaan Target ROAS.
calloutExtension

object (CalloutExtensionParameters)

Parameter yang akan digunakan saat menerapkan rekomendasi ekstensi info.
callExtension

object (CallExtensionParameters)

Parameter yang akan digunakan saat menerapkan rekomendasi ekstensi panggilan.
moveUnusedBudget

object (MoveUnusedBudgetParameters)

Parameter yang akan digunakan saat menerapkan rekomendasi anggaran yang tidak digunakan akan dipindahkan.
responsiveSearchAd

object (ResponsiveSearchAdParameters)

Parameter yang akan digunakan saat menerapkan rekomendasi iklan penelusuran responsif.
useBroadMatchKeyword

object (UseBroadMatchKeywordParameters)

Parameter yang akan digunakan saat menerapkan rekomendasi kata kunci pencocokan luas.
responsiveSearchAdAsset

object (ResponsiveSearchAdAssetParameters)

Parameter yang akan digunakan saat menerapkan rekomendasi aset iklan penelusuran responsif.
responsiveSearchAdImproveAdStrength

object (ResponsiveSearchAdImproveAdStrengthParameters)

Parameter yang akan digunakan saat menerapkan rekomendasi daya iklan untuk iklan penelusuran responsif meningkatkan kualitasnya.
raiseTargetCpaBidTooLow

object (RaiseTargetCpaBidTooLowParameters)

Parameter yang akan digunakan saat menerapkan rekomendasi naikkan bid target CPA terlalu rendah. Penerapannya bersifat asinkron dan dapat memerlukan waktu beberapa menit bergantung pada jumlah grup iklan yang ada di kampanye terkait.
forecastingSetTargetRoas

object (ForecastingSetTargetRoasParameters)

Parameter yang akan digunakan saat menerapkan rekomendasi target ROAS yang ditetapkan.
calloutAsset

object (CalloutAssetParameters)

Parameter yang akan digunakan saat menerapkan rekomendasi aset info.
callAsset

object (CallAssetParameters)

Parameter yang akan digunakan saat menerapkan rekomendasi aset panggilan.
raiseTargetCpa

object (RaiseTargetCpaParameters)

Parameter yang akan digunakan saat menerapkan rekomendasi naikkan Target CPA.
lowerTargetRoas

object (LowerTargetRoasParameters)

Parameter yang akan digunakan saat menerapkan rekomendasi Target ROAS yang lebih rendah.

CampaignBudgetParameters

Parameter yang akan digunakan saat menerapkan rekomendasi anggaran kampanye.

Representasi JSON 
{
  "newBudgetAmountMicros": string
}
Kolom
newBudgetAmountMicros

string (int64 format)

Jumlah anggaran baru yang akan ditetapkan untuk resource anggaran target. Bidang ini harus diisi.

TextAdParameters

Parameter yang akan digunakan saat menerapkan rekomendasi iklan teks.

Representasi JSON 
{
  "ad": {
    object (Ad)
  }
}
Kolom
ad

object (Ad)

Iklan baru untuk ditambahkan ke grup iklan yang direkomendasikan. Semua kolom yang diperlukan harus ditetapkan dalam pesan ini. Bidang ini harus diisi.

KeywordParameters

Parameter yang akan digunakan saat menerapkan rekomendasi kata kunci.

Representasi JSON 
{
  "matchType": enum (KeywordMatchType),
  "adGroup": string,
  "cpcBidMicros": string
}
Kolom
matchType

enum (KeywordMatchType)

Jenis pencocokan kata kunci. Bidang ini harus diisi.
adGroup

string

Resource grup iklan yang akan ditambahi kata kunci. Bidang ini harus diisi.
cpcBidMicros

string (int64 format)

Opsional, bid CPC yang akan ditetapkan untuk kata kunci. Jika tidak ditetapkan, kata kunci akan menggunakan bid berdasarkan strategi bidding yang digunakan oleh grup iklan target.

TargetCpaOptInParameters

Parameter yang akan digunakan saat menerapkan rekomendasi Target CPA.

Representasi JSON 
{
  "targetCpaMicros": string,
  "newCampaignBudgetAmountMicros": string
}
Kolom
targetCpaMicros

string (int64 format)

CPA rata-rata yang akan digunakan untuk strategi bidding Target CPA. Bidang ini harus diisi.
newCampaignBudgetAmountMicros

string (int64 format)

Jumlah anggaran yang ditetapkan untuk kampanye atau opsional.

TargetRoasOptInParameters

Parameter yang akan digunakan saat menerapkan rekomendasi keikutsertaan Target ROAS.

Representasi JSON 
{
  "targetRoas": number,
  "newCampaignBudgetAmountMicros": string
}
Kolom
targetRoas

number

ROAS (pendapatan per unit pembelanjaan) rata-rata yang digunakan untuk strategi bidding Target ROAS. Nilainya antara 0,01 dan 1000,0, inklusif. Kolom ini wajib diisi, kecuali jika newCampaignBudgetAmountMicros ditetapkan.
newCampaignBudgetAmountMicros

string (int64 format)

Jumlah anggaran yang ditetapkan untuk kampanye atau opsional.

CalloutExtensionParameters

Parameter yang akan digunakan saat menerapkan rekomendasi ekstensi info.

Representasi JSON 
{
  "calloutExtensions": [
    {
      object (CalloutFeedItem)
    }
  ]
}
Kolom
calloutExtensions[]

object (CalloutFeedItem)

Ekstensi info yang akan ditambahkan. Bidang ini harus diisi.

CallExtensionParameters

Parameter yang akan digunakan saat menerapkan rekomendasi ekstensi panggilan.

Representasi JSON 
{
  "callExtensions": [
    {
      object (CallFeedItem)
    }
  ]
}
Kolom
callExtensions[]

object (CallFeedItem)

Ekstensi panggilan yang akan ditambahkan. Bidang ini harus diisi.

SitelinkExtensionParameters

Parameter yang akan digunakan saat menerapkan rekomendasi sitelink.

Representasi JSON 
{
  "sitelinkExtensions": [
    {
      object (SitelinkFeedItem)
    }
  ]
}
Kolom

MoveUnusedBudgetParameters

Parameter yang akan digunakan saat menerapkan rekomendasi anggaran yang tidak digunakan akan dipindahkan.

Representasi JSON 
{
  "budgetMicrosToMove": string
}
Kolom
budgetMicrosToMove

string (int64 format)

Jumlah anggaran akan dipindahkan dari kelebihan anggaran ke anggaran terbatas. Bidang ini harus diisi.

ResponsiveSearchAdParameters

Parameter yang akan digunakan saat menerapkan rekomendasi iklan penelusuran responsif.

Representasi JSON 
{
  "ad": {
    object (Ad)
  }
}
Kolom
ad

object (Ad)

Wajib. Iklan baru untuk ditambahkan ke grup iklan yang direkomendasikan.

UseBroadMatchKeywordParameters

Parameter yang akan digunakan saat menerapkan rekomendasi kata kunci pencocokan luas.

Representasi JSON 
{
  "newBudgetAmountMicros": string
}
Kolom
newBudgetAmountMicros

string (int64 format)

Jumlah anggaran baru yang akan ditetapkan untuk resource anggaran target.

ResponsiveSearchAdAssetParameters

Parameter yang akan digunakan saat menerapkan rekomendasi aset iklan penelusuran responsif.

Representasi JSON 
{
  "updatedAd": {
    object (Ad)
  }
}
Kolom
updatedAd

object (Ad)

Iklan yang diperbarui. Konten iklan saat ini akan diganti.

ResponsiveSearchAdImproveAdStrengthParameters

Parameter yang akan digunakan saat menerapkan rekomendasi daya iklan untuk iklan penelusuran responsif meningkatkan kualitasnya.

Representasi JSON 
{
  "updatedAd": {
    object (Ad)
  }
}
Kolom
updatedAd

object (Ad)

Iklan yang diperbarui. Konten iklan saat ini akan diganti.

RaiseTargetCpaBidTooLowParameters

Parameter yang akan digunakan saat menerapkan rekomendasi naikkan bid target CPA terlalu rendah. Penerapannya asinkron dan dapat memerlukan waktu beberapa menit bergantung pada jumlah grup iklan yang ada di kampanye terkait.

Representasi JSON 
{
  "targetMultiplier": number
}
Kolom
targetMultiplier

number

Wajib. Angka yang lebih besar dari 1,0 yang menunjukkan faktor yang digunakan untuk meningkatkan target CPA. Bidang ini harus diisi.

ForecastingSetTargetRoasParameters

Parameter yang akan digunakan saat menerapkan rekomendasi target ROAS yang ditetapkan perkiraan.

Representasi JSON 
{
  "targetRoas": number,
  "campaignBudgetAmountMicros": string
}
Kolom
targetRoas

number

Target ROAS (pendapatan per unit pembelanjaan) baru yang ditetapkan untuk resource kampanye. Nilainya antara 0,01 dan 1000,0, inklusif.
campaignBudgetAmountMicros

string (int64 format)

Jumlah anggaran kampanye baru yang harus ditetapkan untuk resource kampanye.

CalloutAssetParameters

Parameter yang akan digunakan saat menerapkan rekomendasi aset info.

Representasi JSON 
{
  "adAssetApplyParameters": {
    object (AdAssetApplyParameters)
  }
}
Kolom
adAssetApplyParameters

object (AdAssetApplyParameters)

Wajib. Aset info yang akan ditambahkan. Bidang ini harus diisi.

AdAssetApplyParameters

Parameter umum yang digunakan saat menerapkan rekomendasi aset iklan.

Representasi JSON 
{
  "newAssets": [
    {
      object (Asset)
    }
  ],
  "existingAssets": [
    string
  ],
  "scope": enum (ApplyScope)
}
Kolom
newAssets[]

object (Asset)

Aset untuk dibuat dan dilampirkan ke cakupan. Hal ini dapat digabungkan dengan Asset yang ada dalam panggilan yang sama.
existingAssets[]

string

Nama resource dari aset yang ada untuk dilampirkan ke cakupan. Hal ini dapat digabungkan dengan newAssets dalam panggilan yang sama.
scope

enum (ApplyScope)

Wajib. Cakupan untuk menerapkan aset. Aset di tingkat cakupan kampanye akan diterapkan ke kampanye yang terkait dengan rekomendasi. Aset dalam cakupan pelanggan akan berlaku untuk seluruh akun. Aset di cakupan kampanye akan menggantikan aset yang disertakan di cakupan pelanggan.

ApplyScope

Cakupan untuk menerapkan aset.

Enum
UNSPECIFIED Cakupan penerapan belum ditentukan.
UNKNOWN Tidak diketahui.
CUSTOMER Daftar sesuai lingkup pelanggan.
CAMPAIGN Terapkan pada cakupan kampanye.

CallAssetParameters

Parameter yang akan digunakan saat menerapkan rekomendasi aset panggilan.

Representasi JSON 
{
  "adAssetApplyParameters": {
    object (AdAssetApplyParameters)
  }
}
Kolom
adAssetApplyParameters

object (AdAssetApplyParameters)

Wajib. Aset panggilan yang akan ditambahkan. Bidang ini harus diisi.

SitelinkAssetParameters

Parameter yang akan digunakan saat menerapkan rekomendasi aset sitelink.

Representasi JSON 
{
  "adAssetApplyParameters": {
    object (AdAssetApplyParameters)
  }
}
Kolom
adAssetApplyParameters

object (AdAssetApplyParameters)

Wajib. Aset sitelink akan ditambahkan. Bidang ini harus diisi.

RaiseTargetCpaParameters

Parameter yang akan digunakan saat menerapkan rekomendasi naikkan Target CPA.

Representasi JSON 
{
  "targetCpaMultiplier": number
}
Kolom
targetCpaMultiplier

number

Wajib. Target untuk menetapkan pengganda CPA. Bidang ini harus diisi.

LowerTargetRoasParameters

Parameter yang akan digunakan saat menerapkan rekomendasi Target ROAS yang lebih rendah.

Representasi JSON 
{
  "targetRoasMultiplier": number
}
Kolom
targetRoasMultiplier

number

Wajib. Target untuk menetapkan pengganda ROAS. Bidang ini harus diisi.

ApplyRecommendationResult

Hasil penerapan rekomendasi.

Representasi JSON 
{
  "resourceName": string
}
Kolom
resourceName

string

Dikembalikan jika permohonan berhasil.