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/v20/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 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 sebagian. Hanya ditampilkan jika partialFailure = true dan semua error terjadi di dalam operasi. Jika terjadi error di luar operasi (misalnya, error autentikasi), kami akan menampilkan error tingkat RPC.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat OAuth 2.0 Overview.

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)
  },
  "forecastingSetTargetCpa": {
    object (ForecastingSetTargetCpaParameters)
  },
  "setTargetCpa": {
    object (ForecastingSetTargetCpaParameters)
  },
  "setTargetRoas": {
    object (ForecastingSetTargetRoasParameters)
  },
  "leadFormAsset": {
    object (LeadFormAssetParameters)
  }
  // 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 dapat berupa salah satu dari 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 akan 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 pindahkan anggaran yang tidak digunakan.
responsiveSearchAd

object (ResponsiveSearchAdParameters)

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

object (UseBroadMatchKeywordParameters)

Parameter yang akan digunakan saat menerapkan rekomendasi penggunaan 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 peningkatan daya iklan untuk iklan penelusuran responsif.
raiseTargetCpaBidTooLow

object (RaiseTargetCpaBidTooLowParameters)

Parameter yang akan digunakan saat menerapkan rekomendasi naikkan bid target CPA yang terlalu rendah. Penerapan ini 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 untuk memanfaatkan perkiraan.
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.
forecastingSetTargetCpa

object (ForecastingSetTargetCpaParameters)

Parameter yang akan digunakan saat menerapkan rekomendasi tetapkan target CPA untuk memanfaatkan perkiraan.
setTargetCpa

object (ForecastingSetTargetCpaParameters)

Parameter yang akan digunakan saat menerapkan rekomendasi tetapkan target CPA.
setTargetRoas

object (ForecastingSetTargetRoasParameters)

Parameter yang akan digunakan saat menerapkan rekomendasi penetapan target ROAS.
leadFormAsset

object (LeadFormAssetParameters)

Parameter yang akan digunakan saat menerapkan rekomendasi aset formulir prospek.

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 yang akan 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 tempat kata kunci akan ditambahkan. 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)

Opsional, jumlah anggaran yang akan ditetapkan untuk kampanye.

TargetRoasOptInParameters

Parameter yang akan digunakan saat menerapkan rekomendasi keikutsertaan Target ROAS.

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

number

ROAS rata-rata (pendapatan per unit pembelanjaan) yang akan 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)

Opsional, jumlah anggaran yang akan ditetapkan untuk kampanye.

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.

CalloutFeedItem

Merepresentasikan ekstensi info.

Representasi JSON 
{
  "calloutText": string
}
Kolom
calloutText

string

Teks info. Panjang string ini harus antara 1 dan 25, inklusif.

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.

CallFeedItem

Merepresentasikan Ekstensi panggilan.

Representasi JSON 
{
  "callConversionReportingState": enum (CallConversionReportingState),
  "phoneNumber": string,
  "countryCode": string,
  "callTrackingEnabled": boolean,
  "callConversionAction": string,
  "callConversionTrackingDisabled": boolean
}
Kolom
callConversionReportingState

enum (CallConversionReportingState)

Nilai enum yang menunjukkan apakah ekstensi panggilan ini menggunakan setelan konversi panggilannya sendiri (atau hanya menonaktifkan konversi panggilan), atau mengikuti setelan tingkat akun.
phoneNumber

string

Nomor telepon pengiklan yang akan ditambahkan ke iklan. String ini tidak boleh kosong.
countryCode

string

Kode negara dua huruf dengan huruf besar dari nomor telepon pengiklan. String ini tidak boleh kosong.
callTrackingEnabled

boolean

Menunjukkan apakah pelacakan panggilan diaktifkan. Secara default, pelacakan panggilan tidak diaktifkan.
callConversionAction

string

Tindakan konversi yang akan diatribusikan konversi panggilan. Jika tidak ditetapkan, tindakan konversi default akan digunakan. Kolom ini hanya berpengaruh jika callTrackingEnabled ditetapkan ke true. Jika tidak, kolom ini akan diabaikan.
callConversionTrackingDisabled

boolean

Jika benar, nonaktifkan tracking konversi panggilan. callConversionAction tidak boleh ditetapkan jika ini benar. Opsional.

SitelinkExtensionParameters

Parameter yang akan digunakan saat menerapkan rekomendasi sitelink.

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

SitelinkFeedItem

Merepresentasikan sitelink.

Representasi JSON 
{
  "finalUrls": [
    string
  ],
  "finalMobileUrls": [
    string
  ],
  "urlCustomParameters": [
    {
      object (CustomParameter)
    }
  ],
  "linkText": string,
  "line1": string,
  "line2": string,
  "trackingUrlTemplate": string,
  "finalUrlSuffix": string
}
Kolom
finalUrls[]

string

Daftar kemungkinan URL final setelah semua pengalihan lintas-domain.
finalMobileUrls[]

string

Daftar kemungkinan URL seluler final setelah semua pengalihan lintas-domain.
urlCustomParameters[]

object (CustomParameter)

Daftar pemetaan yang akan digunakan untuk mengganti tag parameter kustom URL di trackingUrlTemplate, finalUrls, dan/atau finalMobileUrls.
linkText

string

Teks tampilan URL untuk sitelink. Panjang string ini harus antara 1 dan 25, inklusif.
line1

string

Baris pertama deskripsi sitelink. Jika nilai ini ditetapkan, line2 juga harus ditetapkan. Panjang string ini harus antara 0 dan 35, inklusif.
line2

string

Baris kedua deskripsi sitelink. Jika nilai ini ditetapkan, line1 juga harus ditetapkan. Panjang string ini harus antara 0 dan 35, inklusif.
trackingUrlTemplate

string

Template URL untuk membuat URL pelacakan.
finalUrlSuffix

string

Akhiran URL final yang akan ditambahkan ke URL halaman landing yang ditayangkan dengan pelacakan paralel.

MoveUnusedBudgetParameters

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

Representasi JSON 
{
  "budgetMicrosToMove": string
}
Kolom
budgetMicrosToMove

string (int64 format)

Jumlah anggaran yang akan dipindahkan dari anggaran berlebih ke anggaran yang dibatasi. 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 yang akan ditambahkan ke grup iklan yang direkomendasikan.

UseBroadMatchKeywordParameters

Parameter yang akan digunakan saat menerapkan rekomendasi penggunaan 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 diperbarui. Konten iklan saat ini akan diganti.

ResponsiveSearchAdImproveAdStrengthParameters

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

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

object (Ad)

Iklan diperbarui. Konten iklan saat ini akan diganti.

RaiseTargetCpaBidTooLowParameters

Parameter yang akan digunakan saat menerapkan rekomendasi naikkan bid target CPA yang terlalu rendah. Penerapan ini bersifat 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 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 baru (pendapatan per unit pembelanjaan) yang akan ditetapkan untuk resource kampanye. Nilainya antara 0,01 dan 1000,0, inklusif.
campaignBudgetAmountMicros

string (int64 format)

Jumlah anggaran kampanye baru yang akan ditetapkan untuk aset 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 yang akan dibuat dan dilampirkan ke cakupan. Ini dapat digabungkan dengan existingAssets dalam panggilan yang sama.
existingAssets[]

string

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

enum (ApplyScope)

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

ApplyScope

Cakupan untuk menerapkan aset.

Enum
UNSPECIFIED Cakupan penerapan belum ditentukan.
UNKNOWN Tak diketahui.
CUSTOMER Terapkan pada cakupan pelanggan.
CAMPAIGN Terapkan di 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 yang 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.

ForecastingSetTargetCpaParameters

Parameter yang akan digunakan saat menerapkan rekomendasi target CPA yang ditetapkan.

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

string (int64 format)

CPA rata-rata yang akan digunakan untuk strategi bidding Target CPA.
campaignBudgetAmountMicros

string (int64 format)

Jumlah anggaran kampanye baru yang akan ditetapkan untuk aset kampanye.

LeadFormAssetParameters

Parameter yang akan digunakan saat menerapkan rekomendasi aset formulir prospek.

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

object (AdAssetApplyParameters)

Wajib. Aset formulir prospek yang akan ditambahkan. Bidang ini harus diisi.
setSubmitLeadFormAssetCampaignGoal

boolean

Jika benar, sasaran "Mengirim Formulir Prospek" akan ditetapkan di kampanye target. Akibatnya, iklan akan ditampilkan sebagai iklan materi iklan formulir prospek. Jika salah, sasaran "Mengirim Formulir Prospek" tidak akan ditetapkan di kampanye dan iklan akan berisi aset formulir prospek.

ApplyRecommendationResult

Hasil penerapan rekomendasi.

Representasi JSON 
{
  "resourceName": string
}
Kolom
resourceName

string

Ditampilkan untuk penerapan yang berhasil.