- คำขอ 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
พารามิเตอร์เส้นทาง
พารามิเตอร์ | |
---|---|
customerId |
ต้องระบุ รหัสของลูกค้าที่มีคำแนะนำ |
เนื้อหาของคำขอ
เนื้อหาของคำขอมีข้อมูลซึ่งมีโครงสร้างต่อไปนี้
การแสดง JSON |
---|
{
"operations": [
{
object ( |
ช่อง | |
---|---|
operations[] |
ต้องระบุ รายการการดำเนินการที่จะใช้คำแนะนำ หาก partialFailure=false คำแนะนำทั้งหมดควรเป็นประเภทเดียวกัน ระบบจะจำกัดจำนวนการดำเนินการไว้ที่ 100 รายการต่อคำขอ |
partialFailure |
หาก "จริง" ระบบจะดำเนินการสำเร็จและการดำเนินการที่ไม่ถูกต้องจะแสดงข้อผิดพลาด หากเป็นเท็จ การดำเนินการจะอยู่ในรูปแบบธุรกรรมก็ต่อเมื่อทั้งหมดถูกต้องเท่านั้น ทั้งนี้ ระบบตั้งค่าเริ่มต้นไว้ที่ false |
เนื้อหาการตอบกลับ
ข้อความตอบกลับสำหรับ RecommendationService.ApplyRecommendation
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
การแสดง JSON |
---|
{ "results": [ { object ( |
ช่อง | |
---|---|
results[] |
ผลการดำเนินการเพื่อใช้คำแนะนำ |
partialFailureError |
ข้อผิดพลาดที่เกี่ยวข้องกับความล้มเหลวในการดำเนินการในโหมดความล้มเหลวบางส่วน แสดงผลเฉพาะเมื่อบางส่วนFailure = 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 |
พารามิเตอร์ที่ไม่บังคับซึ่งคุณจะใช้เมื่อใช้คำแนะนำในการเลือกใช้ CPA เป้าหมาย |
targetRoasOptIn |
พารามิเตอร์ที่ไม่บังคับซึ่งจะใช้เมื่อใช้คําแนะนําการเลือกใช้ ROAS เป้าหมาย |
calloutExtension |
พารามิเตอร์ที่จะใช้เมื่อใช้คำแนะนำส่วนขยายไฮไลต์ |
callExtension |
พารามิเตอร์ที่จะใช้เมื่อใช้คำแนะนำส่วนขยายการโทร |
sitelinkExtension |
พารามิเตอร์ที่จะใช้เมื่อใช้คำแนะนำไซต์ลิงก์ |
moveUnusedBudget |
พารามิเตอร์ที่จะใช้เมื่อใช้คำแนะนำการย้ายงบประมาณที่ไม่ได้ใช้ |
responsiveSearchAd |
พารามิเตอร์ที่จะใช้เมื่อใช้คำแนะนำโฆษณา Search ที่ปรับเปลี่ยนตามบริบท |
useBroadMatchKeyword |
พารามิเตอร์ที่จะใช้เมื่อใช้คำแนะนำคีย์เวิร์ดที่ทำงานแบบกว้าง |
responsiveSearchAdAsset |
พารามิเตอร์ที่จะใช้เมื่อใช้คำแนะนำชิ้นงานโฆษณา Search ที่ปรับเปลี่ยนตามบริบท |
responsiveSearchAdImproveAdStrength |
พารามิเตอร์ที่จะใช้เมื่อใช้โฆษณา Search ที่ปรับเปลี่ยนตามบริบทเพื่อปรับปรุงคำแนะนำคุณภาพของโฆษณา |
raiseTargetCpaBidTooLow |
พารามิเตอร์ที่จะใช้เมื่อใช้คำแนะนำการเพิ่มราคาเสนอ CPA เป้าหมายต่ำเกินไป การใช้งานไม่พร้อมกันและอาจใช้เวลาเพียงไม่กี่นาที ทั้งนี้ขึ้นอยู่กับจำนวนกลุ่มโฆษณาในแคมเปญที่เกี่ยวข้อง |
forecastingSetTargetRoas |
พารามิเตอร์ที่จะใช้เมื่อใช้คำแนะนำ ROAS เป้าหมายที่ตั้งไว้สำหรับการคาดการณ์ |
calloutAsset |
พารามิเตอร์ที่จะใช้เมื่อใช้คำแนะนำชิ้นงานข้อความไฮไลต์ |
callAsset |
พารามิเตอร์ที่จะใช้เมื่อใช้คำแนะนำชิ้นงานการโทร |
sitelinkAsset |
พารามิเตอร์ที่จะใช้เมื่อใช้คําแนะนําชิ้นงานไซต์ลิงก์ |
raiseTargetCpa |
พารามิเตอร์ที่จะใช้เมื่อจะใช้คำแนะนำการเพิ่ม CPA เป้าหมาย |
lowerTargetRoas |
พารามิเตอร์ที่จะใช้เมื่อใช้คำแนะนำ ROAS เป้าหมายที่ต่ำลง |
forecastingSetTargetCpa |
พารามิเตอร์ที่จะใช้เมื่อใช้คำแนะนำ CPA เป้าหมายที่ตั้งไว้สำหรับการคาดการณ์ |
setTargetCpa |
พารามิเตอร์ที่จะใช้เมื่อใช้คำแนะนำ CPA เป้าหมายที่ตั้งไว้ |
setTargetRoas |
พารามิเตอร์ที่จะใช้เมื่อใช้คำแนะนำ ROAS เป้าหมายที่ตั้งไว้ |
leadFormAsset |
พารามิเตอร์ที่จะใช้เมื่อใช้คําแนะนําชิ้นงานโฆษณาแบบกรอกฟอร์ม |
CampaignBudgetParameters
พารามิเตอร์ที่จะใช้เมื่อใช้คำแนะนำงบประมาณแคมเปญ
การแสดง JSON |
---|
{ "newBudgetAmountMicros": string } |
ช่อง | |
---|---|
newBudgetAmountMicros |
จำนวนงบประมาณใหม่ที่จะกำหนดสำหรับทรัพยากรงบประมาณเป้าหมาย ช่องนี้ต้องระบุ |
TextAdParameters
พารามิเตอร์ที่จะใช้เมื่อใช้คำแนะนำโฆษณาแบบข้อความ
การแสดง JSON |
---|
{
"ad": {
object ( |
ช่อง | |
---|---|
ad |
โฆษณาใหม่ที่จะเพิ่มในกลุ่มโฆษณาที่แนะนำ ต้องตั้งค่าช่องที่จำเป็นทั้งหมดในข้อความนี้ ช่องนี้ต้องระบุ |
KeywordParameters
พารามิเตอร์ที่จะใช้เมื่อใช้คำแนะนำคีย์เวิร์ด
การแสดง JSON |
---|
{
"matchType": enum ( |
ช่อง | |
---|---|
matchType |
ประเภทการทำงานของคีย์เวิร์ด ช่องนี้ต้องระบุ |
adGroup |
ทรัพยากรของกลุ่มโฆษณาที่จะเพิ่มคีย์เวิร์ด ช่องนี้ต้องระบุ |
cpcBidMicros |
ตัวเลือกการเสนอราคา CPC ที่จะตั้งค่าสำหรับคีย์เวิร์ด หากไม่ได้ตั้งค่า คีย์เวิร์ดจะใช้ราคาเสนอตามกลยุทธ์การเสนอราคาที่กลุ่มโฆษณาเป้าหมายใช้ |
TargetCpaOptInParameters
พารามิเตอร์ที่จะใช้เมื่อใช้คำแนะนำ CPA เป้าหมาย
การแสดง JSON |
---|
{ "targetCpaMicros": string, "newCampaignBudgetAmountMicros": string } |
ช่อง | |
---|---|
targetCpaMicros |
CPA เฉลี่ยที่จะใช้กับกลยุทธ์การเสนอราคา CPA เป้าหมาย ช่องนี้ต้องระบุ |
newCampaignBudgetAmountMicros |
จำนวนงบประมาณ (ไม่บังคับ) ที่จะตั้งให้กับแคมเปญ |
TargetRoasOptInParameters
พารามิเตอร์ที่จะใช้เมื่อใช้คำแนะนำในการเลือกใช้ ROAS เป้าหมาย
การแสดง JSON |
---|
{ "targetRoas": number, "newCampaignBudgetAmountMicros": string } |
ช่อง | |
---|---|
targetRoas |
ROAS เฉลี่ย (รายได้ต่อหน่วยการใช้จ่าย) ที่จะใช้กับกลยุทธ์การเสนอราคา ROAS เป้าหมาย ค่านี้จะอยู่ระหว่าง 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
พารามิเตอร์ที่จะใช้เมื่อใช้คำแนะนำโฆษณา Search ที่ปรับเปลี่ยนตามบริบท
การแสดง JSON |
---|
{
"ad": {
object ( |
ช่อง | |
---|---|
ad |
ต้องระบุ โฆษณาใหม่ที่จะเพิ่มในกลุ่มโฆษณาที่แนะนำ |
UseBroadMatchKeywordParameters
พารามิเตอร์ที่จะใช้เมื่อใช้คำแนะนำคีย์เวิร์ดที่ทำงานแบบกว้าง
การแสดง JSON |
---|
{ "newBudgetAmountMicros": string } |
ช่อง | |
---|---|
newBudgetAmountMicros |
จำนวนงบประมาณใหม่ที่จะกำหนดสำหรับทรัพยากรงบประมาณเป้าหมาย |
ResponsiveSearchAdAssetParameters
พารามิเตอร์ที่จะใช้เมื่อใช้คำแนะนำชิ้นงานโฆษณา Search ที่ปรับเปลี่ยนตามบริบท
การแสดง JSON |
---|
{
"updatedAd": {
object ( |
ช่อง | |
---|---|
updatedAd |
อัปเดตโฆษณาแล้ว เนื้อหาของโฆษณาปัจจุบันจะถูกแทนที่ |
ResponsiveSearchAdImproveAdStrengthParameters
พารามิเตอร์ที่จะใช้เมื่อใช้โฆษณา Search ที่ปรับเปลี่ยนตามบริบทเพื่อปรับปรุงคำแนะนำคุณภาพของโฆษณา
การแสดง JSON |
---|
{
"updatedAd": {
object ( |
ช่อง | |
---|---|
updatedAd |
อัปเดตโฆษณาแล้ว เนื้อหาของโฆษณาปัจจุบันจะถูกแทนที่ |
RaiseTargetCpaBidTooLowParameters
พารามิเตอร์ที่จะใช้เมื่อใช้คำแนะนำการเพิ่มราคาเสนอ CPA เป้าหมายต่ำเกินไป การใช้งานเป็นแบบไม่พร้อมกันและอาจใช้เวลาสักครู่ ทั้งนี้ขึ้นอยู่กับจำนวนกลุ่มโฆษณาในแคมเปญที่เกี่ยวข้อง
การแสดง JSON |
---|
{ "targetMultiplier": number } |
ช่อง | |
---|---|
targetMultiplier |
ต้องระบุ ตัวเลขที่มากกว่า 1.0 หมายถึงปัจจัยที่จะเพิ่ม CPA เป้าหมาย ช่องนี้ต้องระบุ |
ForecastingSetTargetRoasParameters
พารามิเตอร์ที่จะใช้เมื่อใช้คำแนะนำ ROAS เป้าหมายที่ตั้งไว้สำหรับการคาดการณ์
การแสดง JSON |
---|
{ "targetRoas": number, "campaignBudgetAmountMicros": string } |
ช่อง | |
---|---|
targetRoas |
ROAS เป้าหมายใหม่ (รายได้ต่อหน่วยการใช้จ่าย) ที่จะกําหนดให้กับทรัพยากรแคมเปญ ค่านี้จะอยู่ระหว่าง 0.01 และ 1000.0 |
campaignBudgetAmountMicros |
จำนวนงบประมาณแคมเปญใหม่ที่จะกำหนดสำหรับทรัพยากรแคมเปญ |
CalloutAssetParameters
พารามิเตอร์ที่จะใช้เมื่อใช้คำแนะนำชิ้นงานข้อความไฮไลต์
การแสดง JSON |
---|
{
"adAssetApplyParameters": {
object ( |
ช่อง | |
---|---|
adAssetApplyParameters |
ต้องระบุ ชิ้นงานข้อความไฮไลต์ที่จะเพิ่ม ช่องนี้ต้องระบุ |
AdAssetApplyParameters
ใช้พารามิเตอร์ทั่วไปเมื่อใช้คําแนะนําชิ้นงานโฆษณา
การแสดง JSON |
---|
{ "newAssets": [ { object ( |
ช่อง | |
---|---|
newAssets[] |
เนื้อหาที่จะสร้างและแนบตามขอบเขต ซึ่งอาจรวมกับชิ้นงานที่มีอยู่แล้วในการเรียกเดียวกัน |
existingAssets[] |
ชื่อทรัพยากรของเนื้อหาที่มีอยู่ที่จะแนบกับขอบเขต ซึ่งอาจรวมกับชิ้นงานใหม่ในการเรียกเดียวกัน |
scope |
ต้องระบุ ขอบเขตที่จะนำไปใช้กับเนื้อหา ระบบจะใช้ชิ้นงานในขอบเขตแคมเปญกับแคมเปญที่เชื่อมโยงกับคําแนะนํา ชิ้นงานที่อยู่ในขอบเขตลูกค้าจะมีผลกับทั้งบัญชี ชิ้นงานในขอบเขตแคมเปญจะลบล้างชิ้นงานที่แนบมากับขอบเขตของลูกค้า |
ApplyScope
ขอบเขตที่จะนำไปใช้กับเนื้อหา
Enum | |
---|---|
UNSPECIFIED |
ยังไม่ได้ระบุขอบเขตที่ปรับใช้ |
UNKNOWN |
ไม่รู้จัก |
CUSTOMER |
นำไปใช้ตามขอบเขตของลูกค้า |
CAMPAIGN |
นำไปใช้ที่ขอบเขตของแคมเปญ |
CallAssetParameters
พารามิเตอร์ที่จะใช้เมื่อใช้คำแนะนำชิ้นงานการโทร
การแสดง JSON |
---|
{
"adAssetApplyParameters": {
object ( |
ช่อง | |
---|---|
adAssetApplyParameters |
ต้องระบุ ชิ้นงานการโทรที่จะเพิ่ม ช่องนี้ต้องระบุ |
SitelinkAssetParameters
พารามิเตอร์ที่จะใช้เมื่อใช้คําแนะนําชิ้นงานไซต์ลิงก์
การแสดง JSON |
---|
{
"adAssetApplyParameters": {
object ( |
ช่อง | |
---|---|
adAssetApplyParameters |
ต้องระบุ ชิ้นงานไซต์ลิงก์ที่จะเพิ่ม ช่องนี้ต้องระบุ |
RaiseTargetCpaParameters
พารามิเตอร์ที่จะใช้เมื่อจะใช้คำแนะนำ CPA เป้าหมายเพิ่มขึ้น
การแสดง JSON |
---|
{ "targetCpaMultiplier": number } |
ช่อง | |
---|---|
targetCpaMultiplier |
ต้องระบุ กำหนดเป้าหมายเพื่อกำหนดตัวคูณ CPA ช่องนี้ต้องระบุ |
LowerTargetRoasParameters
พารามิเตอร์ที่จะใช้เมื่อใช้คำแนะนำ ROAS เป้าหมายที่ต่ำลง
การแสดง JSON |
---|
{ "targetRoasMultiplier": number } |
ช่อง | |
---|---|
targetRoasMultiplier |
ต้องระบุ กำหนดเป้าหมายที่จะกำหนดตัวคูณ ROAS ช่องนี้ต้องระบุ |
ForecastingSetTargetCpaParameters
พารามิเตอร์ที่จะใช้เมื่อใช้คำแนะนำ CPA เป้าหมายที่ตั้งไว้
การแสดง JSON |
---|
{ "targetCpaMicros": string, "campaignBudgetAmountMicros": string } |
ช่อง | |
---|---|
targetCpaMicros |
CPA เฉลี่ยที่จะใช้กับกลยุทธ์การเสนอราคา CPA เป้าหมาย |
campaignBudgetAmountMicros |
จำนวนงบประมาณแคมเปญใหม่ที่จะกำหนดสำหรับทรัพยากรแคมเปญ |
LeadFormAssetParameters
พารามิเตอร์ที่จะใช้เมื่อใช้คําแนะนําชิ้นงานโฆษณาแบบกรอกฟอร์ม
การแสดง JSON |
---|
{
"adAssetApplyParameters": {
object ( |
ช่อง | |
---|---|
adAssetApplyParameters |
ต้องระบุ ชิ้นงานโฆษณาแบบกรอกฟอร์มที่จะเพิ่ม ช่องนี้ต้องระบุ |
setSubmitLeadFormAssetCampaignGoal |
หากเป็นจริง ระบบจะตั้งค่าเป้าหมาย "ส่งแบบฟอร์มโอกาสในการขาย" ในแคมเปญเป้าหมาย ด้วยเหตุนี้ ระบบจะแสดงโฆษณาเป็นโฆษณาแบบกรอกฟอร์ม หากเป็น "เท็จ" ระบบจะไม่กําหนดเป้าหมาย "ส่งแบบฟอร์มโอกาสในการขาย" ในแคมเปญ และโฆษณาจะมีชิ้นงานโฆษณาแบบกรอกฟอร์ม |
ApplyRecommendationResult
ผลลัพธ์ของการใช้คําแนะนํา
การแสดง JSON |
---|
{ "resourceName": string } |
ช่อง | |
---|---|
resourceName |
แสดงผลสำเร็จ |