- Yêu cầu HTTP
- Tham số đường dẫn
- Nội dung yêu cầu
- Nội dung phản hồi
- Phạm vi uỷ quyền
- ApplyRecommendationOperation (Áp dụng đề xuất)
- 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 (Áp dụng đề xuất)
- Hãy làm thử!
Áp dụng các đề xuất có các thông số áp dụng tương ứng.
Danh sách các lỗi đã gửi: AuthenticationError AuthorizationError DatabaseError FieldError HeaderError InternalError MutateError QuotaError RecommendationError RequestError UrlFieldError
Yêu cầu HTTP
POST https://googleads.googleapis.com/v16/customers/{customerId}/recommendations:apply
URL sử dụng cú pháp Chuyển mã gRPC.
Tham số đường dẫn
Tham số | |
---|---|
customerId |
Bắt buộc. Mã của khách hàng có nội dung đề xuất. |
Nội dung yêu cầu
Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:
Biểu diễn dưới dạng JSON |
---|
{
"operations": [
{
object ( |
Trường | |
---|---|
operations[] |
Bắt buộc. Danh sách các thao tác để áp dụng đề xuất. Nếu một phầnfail=false, tất cả các đề xuất phải thuộc cùng một loại. Mỗi yêu cầu chỉ được có tối đa 100 thao tác. |
partialFailure |
Nếu đúng, các thao tác thành công sẽ được thực hiện và các thao tác không hợp lệ sẽ trả về lỗi. Nếu giá trị là sai, các thao tác sẽ được thực hiện dưới dạng giao dịch khi và chỉ khi tất cả các thao tác đó đều hợp lệ. Mặc định là sai. |
Nội dung phản hồi
Tin nhắn phản hồi cho RecommendationService.ApplyRecommendation
.
Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:
Biểu diễn dưới dạng JSON |
---|
{ "results": [ { object ( |
Trường | |
---|---|
results[] |
Kết quả hoạt động để áp dụng đề xuất. |
partialFailureError |
Lỗi liên quan đến lỗi thao tác ở chế độ lỗi một phần. Giá trị chỉ được trả về khi internalFailure = true và tất cả lỗi xảy ra trong thao tác. Nếu có lỗi xảy ra ngoài thao tác (ví dụ: lỗi xác thực), chúng tôi sẽ trả về lỗi cấp RPC. |
Phạm vi uỷ quyền
Yêu cầu phạm vi OAuth sau:
https://www.googleapis.com/auth/adwords
Để biết thêm thông tin, hãy xem Tổng quan về OAuth 2.0.
ApplyRecommendationOperation
Thông tin về thao tác để áp dụng một nội dung đề xuất và mọi thông số để tuỳ chỉnh nội dung đề xuất đó.
Biểu diễn dưới dạng JSON |
---|
{ "resourceName": string, // Union field |
Trường | |
---|---|
resourceName |
Tên tài nguyên của đề xuất sẽ áp dụng. |
Trường hợp apply_parameters . Các tham số sẽ sử dụng khi áp dụng đề xuất. apply_parameters chỉ có thể là một trong những trạng thái sau: |
|
campaignBudget |
Các tham số không bắt buộc để sử dụng khi áp dụng đề xuất về ngân sách chiến dịch. |
textAd |
Các tham số không bắt buộc để sử dụng khi áp dụng đề xuất về quảng cáo dạng văn bản. |
keyword |
Các tham số không bắt buộc để sử dụng khi áp dụng đề xuất từ khoá. |
targetCpaOptIn |
Các thông số không bắt buộc để sử dụng khi áp dụng đề xuất chọn sử dụng CPA mục tiêu. |
targetRoasOptIn |
Các thông số không bắt buộc để sử dụng khi áp dụng đề xuất chọn sử dụng lợi tức mục tiêu trên chi tiêu quảng cáo. |
calloutExtension |
Các thông số cần sử dụng khi áp dụng đề xuất phần mở rộng về chú thích. |
callExtension |
Thông số cần sử dụng khi áp dụng đề xuất phần mở rộng về cuộc gọi. |
sitelinkExtension |
Các thông số cần sử dụng khi áp dụng đề xuất về đường liên kết trang web. |
moveUnusedBudget |
Các tham số sẽ sử dụng khi áp dụng đề xuất di chuyển ngân sách chưa sử dụng. |
responsiveSearchAd |
Các thông số sẽ sử dụng khi áp dụng một đề xuất về quảng cáo tìm kiếm thích ứng. |
useBroadMatchKeyword |
Các thông số sẽ sử dụng khi áp dụng đề xuất sử dụng từ khoá khớp mở rộng. |
responsiveSearchAdAsset |
Các thông số sẽ sử dụng khi áp dụng đề xuất thành phần của quảng cáo tìm kiếm thích ứng. |
responsiveSearchAdImproveAdStrength |
Các thông số cần sử dụng khi áp dụng quảng cáo tìm kiếm thích ứng sẽ giúp cải thiện đề xuất về độ mạnh của quảng cáo. |
raiseTargetCpaBidTooLow |
Các thông số sẽ sử dụng khi áp dụng đề xuất tăng giá thầu CPA mục tiêu quá thấp. Quá trình áp dụng không đồng bộ và có thể mất vài phút tuỳ thuộc vào số lượng nhóm quảng cáo có trong chiến dịch liên quan. |
forecastingSetTargetRoas |
Các thông số sẽ sử dụng khi áp dụng một đề xuất đặt lợi tức mục tiêu trên chi tiêu quảng cáo (ROAS mục tiêu) theo dự đoán. |
calloutAsset |
Các thông số sẽ sử dụng khi áp dụng đề xuất về thành phần chú thích. |
callAsset |
Những thông số cần sử dụng khi áp dụng đề xuất về thành phần cuộc gọi. |
sitelinkAsset |
Những thông số cần sử dụng khi áp dụng đề xuất về thành phần đường liên kết của trang web. |
raiseTargetCpa |
Các thông số sẽ sử dụng khi áp dụng đề xuất tăng CPA mục tiêu. |
lowerTargetRoas |
Các thông số sẽ sử dụng khi áp dụng đề xuất lợi tức mục tiêu trên chi tiêu quảng cáo thấp hơn. |
forecastingSetTargetCpa |
Các thông số cần sử dụng khi áp dụng thông tin dự đoán sẽ đặt đề xuất về CPA mục tiêu. |
setTargetCpa |
Các thông số sẽ sử dụng khi áp dụng đề xuất đã đặt CPA mục tiêu. |
setTargetRoas |
Các thông số sẽ sử dụng khi áp dụng đề xuất đã đặt lợi tức mục tiêu trên chi tiêu quảng cáo. |
leadFormAsset |
Các thông số sẽ sử dụng khi áp dụng đề xuất về thành phần biểu mẫu khách hàng tiềm năng. |
CampaignBudgetParameters
Các thông số sẽ sử dụng khi áp dụng đề xuất về ngân sách chiến dịch.
Biểu diễn dưới dạng JSON |
---|
{ "newBudgetAmountMicros": string } |
Trường | |
---|---|
newBudgetAmountMicros |
Số tiền ngân sách mới cần đặt cho tài nguyên ngân sách mục tiêu. Đây là trường bắt buộc. |
TextAdParameters
Các thông số sẽ sử dụng khi áp dụng một đề xuất về quảng cáo dạng văn bản.
Biểu diễn dưới dạng JSON |
---|
{
"ad": {
object ( |
Trường | |
---|---|
ad |
Quảng cáo mới để thêm vào nhóm quảng cáo được đề xuất. Bạn cần đặt tất cả các trường cần thiết trong thông báo này. Đây là trường bắt buộc. |
KeywordParameters
Các tham số sẽ sử dụng khi áp dụng đề xuất từ khóa.
Biểu diễn dưới dạng JSON |
---|
{
"matchType": enum ( |
Trường | |
---|---|
matchType |
Kiểu khớp của từ khoá. Đây là trường bắt buộc. |
adGroup |
Tài nguyên nhóm quảng cáo để thêm từ khoá. Đây là trường bắt buộc. |
cpcBidMicros |
Giá thầu CPC không bắt buộc để đặt cho từ khoá. Nếu bạn không đặt chính sách này, từ khoá sẽ sử dụng giá thầu dựa trên chiến lược đặt giá thầu mà nhóm quảng cáo mục tiêu sử dụng. |
TargetCpaOptInParameters
Các thông số sẽ sử dụng khi áp dụng đề xuất CPA mục tiêu.
Biểu diễn dưới dạng JSON |
---|
{ "targetCpaMicros": string, "newCampaignBudgetAmountMicros": string } |
Trường | |
---|---|
targetCpaMicros |
CPA trung bình để sử dụng cho chiến lược đặt giá thầu CPA mục tiêu. Đây là trường bắt buộc. |
newCampaignBudgetAmountMicros |
Số tiền ngân sách cần đặt cho chiến dịch (không bắt buộc). |
TargetRoasOptInParameters
Các thông số sẽ sử dụng khi áp dụng đề xuất chọn tham gia ROAS mục tiêu.
Biểu diễn dưới dạng JSON |
---|
{ "targetRoas": number, "newCampaignBudgetAmountMicros": string } |
Trường | |
---|---|
targetRoas |
ROAS (doanh thu trên mỗi đơn vị chi tiêu) trung bình để dùng cho Chiến lược đặt giá thầu theo lợi tức mục tiêu trên chi tiêu quảng cáo. Giá trị nằm trong khoảng từ 0,01 đến 1000,0. Đây là trường bắt buộc, trừ khi bạn đặt newCampaignBudgetAmountMicros. |
newCampaignBudgetAmountMicros |
Số tiền ngân sách cần đặt cho chiến dịch (không bắt buộc). |
CalloutExtensionParameters
Các thông số cần sử dụng khi áp dụng đề xuất phần mở rộng về chú thích.
Biểu diễn dưới dạng JSON |
---|
{
"calloutExtensions": [
{
object ( |
Trường | |
---|---|
calloutExtensions[] |
Phần mở rộng về chú thích sẽ được thêm vào. Đây là trường bắt buộc. |
CallExtensionParameters
Thông số cần sử dụng khi áp dụng đề xuất phần mở rộng về cuộc gọi.
Biểu diễn dưới dạng JSON |
---|
{
"callExtensions": [
{
object ( |
Trường | |
---|---|
callExtensions[] |
Phần mở rộng về cuộc gọi sẽ được thêm vào. Đây là trường bắt buộc. |
SitelinkExtensionParameters
Các thông số cần sử dụng khi áp dụng đề xuất về đường liên kết trang web.
Biểu diễn dưới dạng JSON |
---|
{
"sitelinkExtensions": [
{
object ( |
Trường | |
---|---|
sitelinkExtensions[] |
Đường liên kết của trang web sẽ được thêm vào. Đây là trường bắt buộc. |
MoveUnusedBudgetParameters
Các tham số sẽ sử dụng khi áp dụng đề xuất di chuyển ngân sách chưa sử dụng.
Biểu diễn dưới dạng JSON |
---|
{ "budgetMicrosToMove": string } |
Trường | |
---|---|
budgetMicrosToMove |
Số tiền ngân sách để chuyển từ ngân sách vượt quá sang ngân sách bị ràng buộc. Đây là trường bắt buộc. |
ResponsiveSearchAdParameters
Các thông số sẽ sử dụng khi áp dụng một đề xuất về quảng cáo tìm kiếm thích ứng.
Biểu diễn dưới dạng JSON |
---|
{
"ad": {
object ( |
Trường | |
---|---|
ad |
Bắt buộc. Quảng cáo mới để thêm vào nhóm quảng cáo được đề xuất. |
UseBroadMatchKeywordParameters
Các thông số sẽ sử dụng khi áp dụng đề xuất sử dụng từ khoá khớp mở rộng.
Biểu diễn dưới dạng JSON |
---|
{ "newBudgetAmountMicros": string } |
Trường | |
---|---|
newBudgetAmountMicros |
Số tiền ngân sách mới cần đặt cho tài nguyên ngân sách mục tiêu. |
ResponsiveSearchAdAssetParameters
Các thông số sẽ sử dụng khi áp dụng đề xuất thành phần của quảng cáo tìm kiếm thích ứng.
Biểu diễn dưới dạng JSON |
---|
{
"updatedAd": {
object ( |
Trường | |
---|---|
updatedAd |
Đã cập nhật quảng cáo. Nội dung của quảng cáo hiện tại sẽ được thay thế. |
ResponsiveSearchAdImproveAdStrengthParameters
Các thông số cần sử dụng khi áp dụng quảng cáo tìm kiếm thích ứng sẽ giúp cải thiện đề xuất về độ mạnh của quảng cáo.
Biểu diễn dưới dạng JSON |
---|
{
"updatedAd": {
object ( |
Trường | |
---|---|
updatedAd |
Đã cập nhật quảng cáo. Nội dung của quảng cáo hiện tại sẽ được thay thế. |
RaiseTargetCpaBidTooLowParameters
Các thông số sẽ sử dụng khi áp dụng đề xuất tăng giá thầu CPA mục tiêu quá thấp. Quá trình áp dụng không đồng bộ và có thể mất vài phút tuỳ thuộc vào số lượng nhóm quảng cáo có trong chiến dịch liên quan.
Biểu diễn dưới dạng JSON |
---|
{ "targetMultiplier": number } |
Trường | |
---|---|
targetMultiplier |
Bắt buộc. Số lớn hơn 1,0 cho biết yếu tố làm tăng CPA mục tiêu. Đây là trường bắt buộc. |
ForecastingSetTargetRoasParameters
Các tham số cần sử dụng khi áp dụng đề xuất lợi tức mục tiêu trên chi tiêu quảng cáo được đặt theo dự báo.
Biểu diễn dưới dạng JSON |
---|
{ "targetRoas": number, "campaignBudgetAmountMicros": string } |
Trường | |
---|---|
targetRoas |
ROAS mục tiêu mới (doanh thu trên mỗi đơn vị chi tiêu) cần đặt cho một tài nguyên của chiến dịch. Giá trị nằm trong khoảng từ 0,01 đến 1000,0. |
campaignBudgetAmountMicros |
Số tiền ngân sách mới của chiến dịch cần đặt cho một tài nguyên chiến dịch. |
CalloutAssetParameters
Các thông số cần sử dụng khi áp dụng đề xuất về thành phần chú thích.
Biểu diễn dưới dạng JSON |
---|
{
"adAssetApplyParameters": {
object ( |
Trường | |
---|---|
adAssetApplyParameters |
Bắt buộc. Thành phần chú thích sẽ được thêm. Đây là trường bắt buộc. |
AdAssetApplyParameters
Những thông số thường dùng khi áp dụng các đề xuất về thành phần quảng cáo.
Biểu diễn dưới dạng JSON |
---|
{ "newAssets": [ { object ( |
Trường | |
---|---|
newAssets[] |
Các thành phần cần tạo và đính kèm vào một phạm vi. Tài sản này có thể được kết hợp với các Tài sản hiện có trong cùng một lệnh gọi. |
existingAssets[] |
Tên tài nguyên của những thành phần hiện có cần đính kèm vào phạm vi. Tài sản này có thể được kết hợp với Tài sản mới trong cùng một lệnh gọi. |
scope |
Bắt buộc. Phạm vi áp dụng các thành phần. Các thành phần ở cấp phạm vi chiến dịch sẽ được áp dụng cho chiến dịch được liên kết với đề xuất. Các thành phần ở phạm vi khách hàng sẽ áp dụng cho toàn bộ tài khoản. Các thành phần ở phạm vi chiến dịch sẽ ghi đè mọi thành phần được đính kèm ở phạm vi khách hàng. |
ApplyScope
Phạm vi áp dụng các thành phần.
Enum | |
---|---|
UNSPECIFIED |
Phạm vi áp dụng chưa được chỉ định. |
UNKNOWN |
Không xác định. |
CUSTOMER |
Áp dụng ở phạm vi khách hàng. |
CAMPAIGN |
Áp dụng ở phạm vi chiến dịch. |
CallAssetParameters
Những thông số sẽ sử dụng khi áp dụng đề xuất về thành phần cuộc gọi.
Biểu diễn dưới dạng JSON |
---|
{
"adAssetApplyParameters": {
object ( |
Trường | |
---|---|
adAssetApplyParameters |
Bắt buộc. Các thành phần cuộc gọi sẽ được thêm vào. Đây là trường bắt buộc. |
SitelinkAssetParameters
Những thông số cần sử dụng khi áp dụng đề xuất về thành phần đường liên kết của trang web.
Biểu diễn dưới dạng JSON |
---|
{
"adAssetApplyParameters": {
object ( |
Trường | |
---|---|
adAssetApplyParameters |
Bắt buộc. Thành phần đường liên kết của trang web sẽ được thêm vào. Đây là trường bắt buộc. |
RaiseTargetCpaParameters
Các thông số sẽ sử dụng khi áp dụng các đề xuất tăng CPA mục tiêu.
Biểu diễn dưới dạng JSON |
---|
{ "targetCpaMultiplier": number } |
Trường | |
---|---|
targetCpaMultiplier |
Bắt buộc. Mục tiêu để đặt hệ số CPA. Đây là trường bắt buộc. |
LowerTargetRoasParameters
Các thông số cần sử dụng khi áp dụng các đề xuất ROAS mục tiêu thấp hơn.
Biểu diễn dưới dạng JSON |
---|
{ "targetRoasMultiplier": number } |
Trường | |
---|---|
targetRoasMultiplier |
Bắt buộc. Mục tiêu để đặt hệ số ROAS. Đây là trường bắt buộc. |
ForecastingSetTargetCpaParameters
Các thông số sẽ sử dụng khi áp dụng đề xuất CPA mục tiêu đã đặt.
Biểu diễn dưới dạng JSON |
---|
{ "targetCpaMicros": string, "campaignBudgetAmountMicros": string } |
Trường | |
---|---|
targetCpaMicros |
CPA trung bình để sử dụng cho chiến lược đặt giá thầu CPA mục tiêu. |
campaignBudgetAmountMicros |
Số tiền ngân sách mới của chiến dịch cần đặt cho một tài nguyên chiến dịch. |
LeadFormAssetParameters
Các thông số sẽ sử dụng khi áp dụng đề xuất về thành phần biểu mẫu khách hàng tiềm năng.
Biểu diễn dưới dạng JSON |
---|
{
"adAssetApplyParameters": {
object ( |
Trường | |
---|---|
adAssetApplyParameters |
Bắt buộc. Thành phần biểu mẫu khách hàng tiềm năng cần được thêm vào. Đây là trường bắt buộc. |
setSubmitLeadFormAssetCampaignGoal |
Nếu đúng, mục tiêu "Gửi biểu mẫu khách hàng tiềm năng" sẽ được đặt cho chiến dịch mục tiêu. Do đó, quảng cáo sẽ xuất hiện dưới dạng quảng cáo mẫu khách hàng tiềm năng. Nếu bạn đặt giá trị thành false, thì mục tiêu "Gửi biểu mẫu khách hàng tiềm năng" sẽ không được đặt cho chiến dịch, và quảng cáo sẽ chứa thành phần biểu mẫu khách hàng tiềm năng. |
ApplyRecommendationResult
Kết quả của việc áp dụng một đề xuất.
Biểu diễn dưới dạng JSON |
---|
{ "resourceName": string } |
Trường | |
---|---|
resourceName |
Giá trị được trả về nếu thành công sẽ áp dụng. |