Method: customers.recommendations.apply

توصیه های داده شده را با پارامترهای کاربردی مربوطه اعمال می کند.

فهرست خطاهای پرتاب شده: AuthenticationError AuthorizationError DatabaseError FieldError HeaderError داخلی Error MutateError QuotaError RecommendationError RequestError UrlFieldError

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

مولفه های
customerId

string

ضروری. شناسه مشتری با توصیه.

درخواست بدن

بدنه درخواست حاوی داده هایی با ساختار زیر است:

نمایندگی JSON
{
  "operations": [
    {
      object (ApplyRecommendationOperation)
    }
  ],
  "partialFailure": boolean
}
زمینه های
operations[]

object ( ApplyRecommendationOperation )

ضروری. لیست عملیات برای اعمال توصیه ها. اگر partialFailure=false همه توصیه‌ها باید از یک نوع باشند، در هر درخواست محدودیت 100 عملیات وجود دارد.

partialFailure

boolean

اگر درست باشد، عملیات موفقیت آمیز انجام می شود و عملیات نامعتبر خطاها را برمی گرداند. اگر نادرست باشد، عملیات به عنوان یک تراکنش انجام خواهد شد، اگر و تنها در صورتی که همه آنها معتبر باشند. پیش فرض نادرست است.

بدن پاسخگو

پیام پاسخ برای RecommendationService.ApplyRecommendation .

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON
{
  "results": [
    {
      object (ApplyRecommendationResult)
    }
  ],
  "partialFailureError": {
    object (Status)
  }
}
زمینه های
results[]

object ( ApplyRecommendationResult )

نتایج عملیات برای اعمال توصیه ها.

partialFailureError

object ( Status )

خطاهایی که مربوط به خرابی عملیات در حالت شکست جزئی است. فقط زمانی که partialFailure = true باشد و تمام خطاها در داخل عملیات رخ دهد، برگردانده می شود. اگر هر خطایی در خارج از عملیات رخ دهد (به عنوان مثال، خطاهای auth)، ما خطای سطح RPC را برمی گردانیم.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

ApplyRecommendationOperation

اطلاعاتی درباره عملیات اعمال یک توصیه و هر پارامتری برای سفارشی کردن آن.

نمایندگی 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.
}
زمینه های
resourceName

string

نام منبع توصیه برای اعمال.

فیلد اتحادیه apply_parameters . پارامترهای مورد استفاده در هنگام اعمال توصیه apply_parameters فقط می تواند یکی از موارد زیر باشد:
campaignBudget

object ( CampaignBudgetParameters )

پارامترهای اختیاری برای استفاده در هنگام اعمال توصیه بودجه کمپین.

textAd

object ( TextAdParameters )

پارامترهای اختیاری برای استفاده در هنگام اعمال توصیه تبلیغات متنی.

keyword

object ( KeywordParameters )

پارامترهای اختیاری برای استفاده در هنگام اعمال توصیه کلمه کلیدی.

targetCpaOptIn

object ( TargetCpaOptInParameters )

پارامترهای اختیاری برای استفاده در هنگام اعمال توصیه انتخاب CPA هدف.

targetRoasOptIn

object ( TargetRoasOptInParameters )

پارامترهای اختیاری برای استفاده در هنگام اعمال توصیه انتخاب ROAS هدف.

calloutExtension

object ( CalloutExtensionParameters )

پارامترهایی که باید هنگام اعمال توصیه افزونه callout استفاده شوند.

callExtension

object ( CallExtensionParameters )

پارامترهایی که باید هنگام اعمال توصیه افزونه تماس استفاده کنید.

moveUnusedBudget

object ( MoveUnusedBudgetParameters )

پارامترهایی که باید هنگام اعمال توصیه بودجه استفاده نشده جابجا شوند.

responsiveSearchAd

object ( ResponsiveSearchAdParameters )

پارامترهایی که باید هنگام اعمال توصیه تبلیغات جستجوی پاسخگو استفاده کنید.

useBroadMatchKeyword

object ( UseBroadMatchKeywordParameters )

پارامترهایی که باید هنگام استفاده از پیشنهاد کلمه کلیدی مطابقت گسترده استفاده کنید.

responsiveSearchAdAsset

object ( ResponsiveSearchAdAssetParameters )

پارامترهایی که باید هنگام اعمال توصیه دارایی تبلیغات جستجوی پاسخگو استفاده شوند.

responsiveSearchAdImproveAdStrength

object ( ResponsiveSearchAdImproveAdStrengthParameters )

پارامترهایی که باید هنگام اعمال یک تبلیغ جستجوی واکنشگرا استفاده شوند، توصیه قدرت تبلیغ را بهبود می بخشند.

raiseTargetCpaBidTooLow

object ( RaiseTargetCpaBidTooLowParameters )

پارامترهایی که باید هنگام اعمال پیشنهاد افزایش قیمت CPA هدف بسیار کم استفاده شوند. این درخواست ناهمزمان است و بسته به تعداد گروه های تبلیغاتی موجود در کمپین مربوطه می تواند چند دقیقه طول بکشد.

forecastingSetTargetRoas

object ( ForecastingSetTargetRoasParameters )

پارامترهایی که باید هنگام اعمال یک توصیه ROAS هدف تنظیم پیش بینی استفاده شوند.

calloutAsset

object ( CalloutAssetParameters )

پارامترهایی که باید هنگام اعمال توصیه دارایی callout استفاده شوند.

callAsset

object ( CallAssetParameters )

پارامترهایی که باید هنگام اعمال توصیه دارایی تماس استفاده کنید.

raiseTargetCpa

object ( RaiseTargetCpaParameters )

پارامترهای مورد استفاده در هنگام اعمال توصیه CPA هدف را افزایش می دهند.

lowerTargetRoas

object ( LowerTargetRoasParameters )

پارامترهایی که باید هنگام اعمال توصیه ROAS هدف کمتر استفاده شوند.

CampaignBudgetParameters

پارامترهایی که باید هنگام اعمال توصیه بودجه کمپین استفاده کنید.

نمایندگی JSON
{
  "newBudgetAmountMicros": string
}
زمینه های
newBudgetAmountMicros

string ( int64 format)

مقدار بودجه جدید برای تنظیم منبع بودجه هدف. این فیلد ضروری است.

TextAdParameters

پارامترهایی که باید هنگام اعمال یک توصیه تبلیغات متنی استفاده کنید.

نمایندگی JSON
{
  "ad": {
    object (Ad)
  }
}
زمینه های
ad

object ( Ad )

آگهی جدید برای افزودن به گروه تبلیغات توصیه شده. تمام فیلدهای لازم باید در این پیام تنظیم شوند. این فیلد ضروری است.

پارامترهای کلیدواژه

پارامترهای مورد استفاده در هنگام اعمال توصیه کلمه کلیدی.

نمایندگی JSON
{
  "matchType": enum (KeywordMatchType),
  "adGroup": string,
  "cpcBidMicros": string
}
زمینه های
matchType

enum ( KeywordMatchType )

نوع مطابقت کلمه کلیدی. این فیلد ضروری است.

adGroup

string

منبع گروه تبلیغات برای افزودن کلمه کلیدی این فیلد ضروری است.

cpcBidMicros

string ( int64 format)

اختیاری، پیشنهاد CPC برای تنظیم برای کلمه کلیدی. اگر تنظیم نشود، کلمه کلیدی از پیشنهاد قیمت بر اساس استراتژی پیشنهاد استفاده شده توسط گروه تبلیغات هدف استفاده می کند.

TargetCpaOptInParameters

پارامترهای مورد استفاده در هنگام اعمال توصیه CPA هدف.

نمایندگی JSON
{
  "targetCpaMicros": string,
  "newCampaignBudgetAmountMicros": string
}
زمینه های
targetCpaMicros

string ( int64 format)

میانگین CPA برای استفاده برای استراتژی مناقصه CPA هدف. این فیلد ضروری است.

newCampaignBudgetAmountMicros

string ( int64 format)

اختیاری، مقدار بودجه برای تنظیم کمپین.

TargetRoasOptInParameters

پارامترهایی که باید هنگام اعمال یک توصیه انتخاب کردن ROAS هدف استفاده کنید.

نمایندگی JSON
{
  "targetRoas": number,
  "newCampaignBudgetAmountMicros": string
}
زمینه های
targetRoas

number

میانگین ROAS (درآمد به ازای هر واحد هزینه) برای استفاده برای استراتژی پیشنهاد قیمت هدف. مقدار بین 0.01 و 1000.0 با احتساب است. این یک فیلد ضروری است، مگر اینکه newCampaignBudgetAmountMicros تنظیم شده باشد.

newCampaignBudgetAmountMicros

string ( int64 format)

اختیاری، مقدار بودجه برای تنظیم کمپین.

CalloutExtensionParameters

پارامترهایی که باید هنگام اعمال توصیه افزونه callout استفاده شوند.

نمایندگی JSON
{
  "calloutExtensions": [
    {
      object (CalloutFeedItem)
    }
  ]
}
زمینه های
calloutExtensions[]

object ( CalloutFeedItem )

افزونه های Callout اضافه می شوند. این فیلد ضروری است.

CallExtensionParameters

پارامترهایی که باید هنگام اعمال توصیه افزونه تماس استفاده کنید.

نمایندگی JSON
{
  "callExtensions": [
    {
      object (CallFeedItem)
    }
  ]
}
زمینه های
callExtensions[]

object ( CallFeedItem )

افزونه های تماس اضافه می شود. این فیلد ضروری است.

SitelinkExtensionParameters

پارامترهای مورد استفاده در هنگام اعمال توصیه لینک سایت.

نمایندگی JSON
{
  "sitelinkExtensions": [
    {
      object (SitelinkFeedItem)
    }
  ]
}
زمینه های

MoveUnusedBudgetParameters

پارامترهایی که باید هنگام اعمال توصیه بودجه استفاده نشده جابجا شوند.

نمایندگی JSON
{
  "budgetMicrosToMove": string
}
زمینه های
budgetMicrosToMove

string ( int64 format)

مقدار بودجه برای انتقال از بودجه مازاد به بودجه محدود. این فیلد ضروری است.

ResponsiveSearchAdParameters

پارامترهایی که باید هنگام اعمال توصیه تبلیغات جستجوی پاسخگو استفاده کنید.

نمایندگی JSON
{
  "ad": {
    object (Ad)
  }
}
زمینه های
ad

object ( Ad )

ضروری. آگهی جدید برای افزودن به گروه تبلیغات توصیه شده.

استفاده ازBroadMatchKeywordParameters

پارامترهایی که باید هنگام استفاده از پیشنهاد کلمه کلیدی مطابقت گسترده استفاده کنید.

نمایندگی JSON
{
  "newBudgetAmountMicros": string
}
زمینه های
newBudgetAmountMicros

string ( int64 format)

مقدار بودجه جدید برای تنظیم منبع بودجه هدف.

ResponsiveSearchAdAssetParameters

پارامترهایی که باید هنگام اعمال توصیه دارایی تبلیغات جستجوی پاسخگو استفاده شوند.

نمایندگی JSON
{
  "updatedAd": {
    object (Ad)
  }
}
زمینه های
updatedAd

object ( Ad )

آگهی به روز شده محتوای آگهی فعلی جایگزین خواهد شد.

ResponsiveSearchAdImproveAdStrengthParameters

پارامترهایی که باید هنگام اعمال یک تبلیغ جستجوی واکنشگرا استفاده شوند، توصیه قدرت تبلیغ را بهبود می بخشند.

نمایندگی JSON
{
  "updatedAd": {
    object (Ad)
  }
}
زمینه های
updatedAd

object ( Ad )

آگهی به روز شده محتوای آگهی فعلی جایگزین خواهد شد.

RaiseTargetCpaBidTooLowParameters

پارامترهایی که باید هنگام اعمال پیشنهاد افزایش قیمت CPA هدف بسیار کم استفاده شوند. درخواست ناهمزمان است و بسته به تعداد گروه‌های تبلیغاتی موجود در کمپین مربوطه می‌تواند چند دقیقه طول بکشد.

نمایندگی JSON
{
  "targetMultiplier": number
}
زمینه های
targetMultiplier

number

ضروری. عددی بزرگتر از 1.0 نشان دهنده عامل افزایش CPA هدف است. این فیلد ضروری است.

ForecastingSetTargetRoasParameters

پارامترهایی که باید در هنگام اعمال یک توصیه پیش‌بینی هدف رواس استفاده شوند.

نمایندگی JSON
{
  "targetRoas": number,
  "campaignBudgetAmountMicros": string
}
زمینه های
targetRoas

number

ROAS هدف جدید (درآمد به ازای هر واحد هزینه) برای تنظیم یک منبع کمپین. مقدار بین 0.01 و 1000.0 با احتساب است.

campaignBudgetAmountMicros

string ( int64 format)

مقدار بودجه کمپین جدید برای تنظیم یک منبع کمپین.

CalloutAssetParameters

پارامترهایی که باید هنگام اعمال توصیه‌های دارایی callout استفاده شوند.

نمایندگی JSON
{
  "adAssetApplyParameters": {
    object (AdAssetApplyParameters)
  }
}
زمینه های
adAssetApplyParameters

object ( AdAssetApplyParameters )

ضروری. دارایی های Callout که باید اضافه شوند. این فیلد ضروری است.

AdAssetApplyParameters

پارامترهای رایج مورد استفاده در هنگام اعمال توصیه‌های دارایی تبلیغات.

نمایندگی JSON
{
  "newAssets": [
    {
      object (Asset)
    }
  ],
  "existingAssets": [
    string
  ],
  "scope": enum (ApplyScope)
}
زمینه های
newAssets[]

object ( Asset )

دارایی هایی برای ایجاد و پیوست کردن به یک محدوده. این ممکن است با دارایی های موجود در همان فراخوان ترکیب شود.

existingAssets[]

string

نام منابع دارایی های موجود برای پیوست کردن به یک محدوده. این ممکن است با newAssets در همان تماس ترکیب شود.

scope

enum ( ApplyScope )

ضروری. دامنه استفاده از دارایی ها. دارایی‌ها در سطح دامنه کمپین برای کمپین مرتبط با توصیه اعمال خواهد شد. دارایی در محدوده مشتری برای کل حساب اعمال می شود. دارایی‌های موجود در محدوده کمپین، دارایی‌های پیوست شده در محدوده مشتری را لغو می‌کند.

ApplyScope

محدوده اعمال دارایی ها.

Enums
UNSPECIFIED دامنه اعمال مشخص نشده است.
UNKNOWN ناشناخته.
CUSTOMER در محدوده مشتری اعمال کنید.
CAMPAIGN در محدوده کمپین اعمال کنید.

CallAssetParameters

پارامترهایی که باید هنگام اعمال توصیه‌های دارایی تماس استفاده کنید.

نمایندگی JSON
{
  "adAssetApplyParameters": {
    object (AdAssetApplyParameters)
  }
}
زمینه های
adAssetApplyParameters

object ( AdAssetApplyParameters )

ضروری. تماس دارایی ها برای اضافه شدن. این فیلد ضروری است.

SitelinkAssetParameters

پارامترهایی که باید هنگام اعمال توصیه‌های دارایی لینک سایت استفاده شوند.

نمایندگی JSON
{
  "adAssetApplyParameters": {
    object (AdAssetApplyParameters)
  }
}
زمینه های
adAssetApplyParameters

object ( AdAssetApplyParameters )

ضروری. دارایی های پیوند سایت که باید اضافه شوند. این فیلد ضروری است.

RaiseTargetCpaParameters

پارامترهای مورد استفاده در هنگام اعمال توصیه های CPA هدف را افزایش می دهند.

نمایندگی JSON
{
  "targetCpaMultiplier": number
}
زمینه های
targetCpaMultiplier

number

ضروری. هدف برای تنظیم ضریب CPA روی. این فیلد ضروری است.

LowerTargetRoasParameters

پارامترهایی که باید هنگام اعمال توصیه‌های ROAS هدف پایین‌تر استفاده شوند.

نمایندگی JSON
{
  "targetRoasMultiplier": number
}
زمینه های
targetRoasMultiplier

number

ضروری. هدف قرار دهید تا ضریب ROAS را روی آن تنظیم کنید. این فیلد ضروری است.

ApplyRecommendationResult

نتیجه اعمال یک توصیه

نمایندگی JSON
{
  "resourceName": string
}
زمینه های
resourceName

string

برای درخواست های موفق بازگردانده شد.