- درخواست HTTP
- پارامترهای مسیر
- درخواست بدن
- بدن پاسخگو
- محدوده مجوز
- ApplyRecommendationOperation
- CampaignBudgetParameters
- TextAdParameters
- پارامترهای کلیدواژه
- TargetCpaOptInParameters
- TargetRoasOptInParameters
- CalloutExtensionParameters
- CallExtensionParameters
- SitelinkExtensionParameters
- MoveUnusedBudgetParameters
- ResponsiveSearchAdParameters
- استفاده ازBroadMatchKeywordParameters
- ResponsiveSearchAdAssetParameters
- ResponsiveSearchAdImproveAdStrengthParameters
- RaiseTargetCpaBidTooLowParameters
- ForecastingSetTargetRoasParameters
- CalloutAssetParameters
- AdAssetApplyParameters
- ApplyScope
- CallAssetParameters
- SitelinkAssetParameters
- RaiseTargetCpaParameters
- LowerTargetRoasParameters
- ForecastingSetTargetCpaParameters
- ApplyRecommendationResult
- آن را امتحان کنید!
توصیه های داده شده را با پارامترهای کاربردی مربوطه اعمال می کند.
فهرست خطاهای پرتاب شده: AuthenticationError AuthorizationError DatabaseError FieldError HeaderError داخلی Error MutateError QuotaError RecommendationError RequestError UrlFieldError
درخواست HTTP
POST https://googleads.googleapis.com/v15/customers/{customerId}/recommendations:apply
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
پارامترها | |
---|---|
customerId | مورد نیاز. شناسه مشتری با توصیه. |
درخواست بدن
بدنه درخواست حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{
"operations": [
{
object ( |
فیلدها | |
---|---|
operations[] | مورد نیاز. لیست عملیات برای اعمال توصیه ها. اگر partialFailure=false همه توصیهها باید از یک نوع باشند، در هر درخواست محدودیت 100 عملیات وجود دارد. |
partialFailure | اگر درست باشد، عملیات موفقیت آمیز انجام می شود و عملیات نامعتبر خطاها را برمی گرداند. اگر نادرست باشد، عملیات به عنوان یک تراکنش انجام خواهد شد، اگر و تنها در صورتی که همه آنها معتبر باشند. پیش فرض نادرست است. |
بدن پاسخگو
پیام پاسخ برای RecommendationService.ApplyRecommendation
.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{ "results": [ { object ( |
فیلدها | |
---|---|
results[] | نتایج عملیات برای اعمال توصیه ها. |
partialFailureError | خطاهایی که مربوط به خرابی عملیات در حالت شکست جزئی است. فقط زمانی که partialFailure = true باشد و تمام خطاها در داخل عملیات رخ دهد، برگردانده می شود. اگر هر خطایی در خارج از عملیات رخ دهد (به عنوان مثال، خطاهای auth)، ما خطای سطح 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 | پارامترهایی که باید هنگام اعمال توصیه افزونه callout استفاده شوند. |
callExtension | پارامترهایی که باید هنگام اعمال توصیه افزونه تماس استفاده کنید. |
sitelinkExtension | پارامترهای مورد استفاده در هنگام اعمال توصیه لینک سایت. |
moveUnusedBudget | پارامترهایی که باید هنگام اعمال توصیه بودجه استفاده نشده جابجا شوند. |
responsiveSearchAd | پارامترهایی که باید هنگام اعمال توصیه تبلیغات جستجوی پاسخگو استفاده کنید. |
useBroadMatchKeyword | پارامترهایی که باید هنگام استفاده از پیشنهاد کلمه کلیدی مطابقت گسترده استفاده کنید. |
responsiveSearchAdAsset | پارامترهایی که باید هنگام اعمال توصیه دارایی تبلیغات جستجوی پاسخگو استفاده شوند. |
responsiveSearchAdImproveAdStrength | پارامترهایی که باید هنگام اعمال یک تبلیغ جستجوی واکنشگرا استفاده شوند، توصیه قدرت تبلیغ را بهبود می بخشند. |
raiseTargetCpaBidTooLow | پارامترهایی که باید هنگام اعمال پیشنهاد افزایش قیمت CPA هدف بسیار کم استفاده شوند. این درخواست ناهمزمان است و بسته به تعداد گروه های تبلیغاتی موجود در کمپین مربوطه می تواند چند دقیقه طول بکشد. |
forecastingSetTargetRoas | پارامترهایی که باید هنگام اعمال یک توصیه ROAS هدف تنظیم پیش بینی استفاده شوند. |
calloutAsset | پارامترهایی که باید هنگام اعمال توصیه دارایی callout استفاده شوند. |
callAsset | پارامترهایی که باید هنگام اعمال توصیه دارایی تماس استفاده کنید. |
sitelinkAsset | پارامترهایی که باید هنگام اعمال توصیه دارایی لینک سایت استفاده شوند. |
raiseTargetCpa | پارامترهای مورد استفاده در هنگام اعمال توصیه CPA هدف را افزایش می دهند. |
lowerTargetRoas | پارامترهایی که باید هنگام اعمال توصیه ROAS هدف کمتر استفاده شوند. |
forecastingSetTargetCpa | پارامترهای مورد استفاده در هنگام اعمال پیش بینی توصیه CPA هدف را تعیین می کنند. |
setTargetCpa | پارامترهای مورد استفاده در هنگام اعمال توصیه CPA هدف تعیین شده. |
setTargetRoas | پارامترهای مورد استفاده در هنگام اعمال توصیه ROAS هدف تعیین شده. |
CampaignBudgetParameters
پارامترهایی که باید هنگام اعمال توصیه بودجه کمپین استفاده کنید.
نمایندگی JSON |
---|
{ "newBudgetAmountMicros": string } |
فیلدها | |
---|---|
newBudgetAmountMicros | مقدار بودجه جدید برای تنظیم منبع بودجه هدف. این یک فیلد الزامی است. |
TextAdParameters
پارامترهایی که باید هنگام اعمال یک توصیه تبلیغات متنی استفاده کنید.
نمایندگی JSON |
---|
{
"ad": {
object ( |
فیلدها | |
---|---|
ad | آگهی جدید برای افزودن به گروه تبلیغات توصیه شده. تمام فیلدهای لازم باید در این پیام تنظیم شوند. این یک فیلد الزامی است. |
پارامترهای کلیدواژه
پارامترهای مورد استفاده در هنگام اعمال توصیه کلمه کلیدی.
نمایندگی 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 (درآمد به ازای هر واحد هزینه) برای استفاده برای استراتژی پیشنهاد قیمت هدف. مقدار بین 0.01 و 1000.0 با احتساب است. این یک فیلد ضروری است، مگر اینکه newCampaignBudgetAmountMicros تنظیم شده باشد. |
newCampaignBudgetAmountMicros | اختیاری، مقدار بودجه برای تنظیم کمپین. |
CalloutExtensionParameters
پارامترهایی که باید هنگام اعمال توصیه افزونه callout استفاده شوند.
نمایندگی JSON |
---|
{
"calloutExtensions": [
{
object ( |
فیلدها | |
---|---|
calloutExtensions[] | افزونه های Callout اضافه می شوند. این یک فیلد الزامی است. |
CallExtensionParameters
پارامترهایی که باید هنگام اعمال توصیه افزونه تماس استفاده کنید.
نمایندگی JSON |
---|
{
"callExtensions": [
{
object ( |
فیلدها | |
---|---|
callExtensions[] | افزونه های تماس اضافه می شود. این یک فیلد الزامی است. |
SitelinkExtensionParameters
پارامترهای مورد استفاده در هنگام اعمال توصیه لینک سایت.
نمایندگی JSON |
---|
{
"sitelinkExtensions": [
{
object ( |
فیلدها | |
---|---|
sitelinkExtensions[] | لینک های سایت برای اضافه شدن این یک فیلد الزامی است. |
MoveUnusedBudgetParameters
پارامترهایی که باید هنگام اعمال توصیه بودجه استفاده نشده جابجا شوند.
نمایندگی JSON |
---|
{ "budgetMicrosToMove": string } |
فیلدها | |
---|---|
budgetMicrosToMove | مقدار بودجه برای انتقال از بودجه مازاد به بودجه محدود. این یک فیلد الزامی است. |
ResponsiveSearchAdParameters
پارامترهایی که باید هنگام اعمال توصیه تبلیغات جستجوی پاسخگو استفاده کنید.
نمایندگی JSON |
---|
{
"ad": {
object ( |
فیلدها | |
---|---|
ad | مورد نیاز. آگهی جدید برای افزودن به گروه تبلیغات توصیه شده. |
استفاده ازBroadMatchKeywordParameters
پارامترهایی که باید هنگام استفاده از پیشنهاد کلمه کلیدی مطابقت گسترده استفاده کنید.
نمایندگی JSON |
---|
{ "newBudgetAmountMicros": string } |
فیلدها | |
---|---|
newBudgetAmountMicros | مقدار بودجه جدید برای تنظیم منبع بودجه هدف. |
ResponsiveSearchAdAssetParameters
پارامترهایی که باید هنگام اعمال توصیه دارایی تبلیغات جستجوی پاسخگو استفاده شوند.
نمایندگی JSON |
---|
{
"updatedAd": {
object ( |
فیلدها | |
---|---|
updatedAd | آگهی به روز شده محتوای آگهی فعلی جایگزین خواهد شد. |
ResponsiveSearchAdImproveAdStrengthParameters
پارامترهایی که باید هنگام اعمال یک تبلیغ جستجوی واکنشگرا استفاده شوند، توصیه قدرت تبلیغ را بهبود می بخشند.
نمایندگی JSON |
---|
{
"updatedAd": {
object ( |
فیلدها | |
---|---|
updatedAd | آگهی به روز شده محتوای آگهی فعلی جایگزین خواهد شد. |
RaiseTargetCpaBidTooLowParameters
پارامترهایی که باید هنگام اعمال پیشنهاد افزایش قیمت CPA هدف بسیار کم استفاده شوند. درخواست ناهمزمان است و بسته به تعداد گروههای تبلیغاتی موجود در کمپین مربوطه میتواند چند دقیقه طول بکشد.
نمایندگی JSON |
---|
{ "targetMultiplier": number } |
فیلدها | |
---|---|
targetMultiplier | مورد نیاز. عددی بزرگتر از 1.0 نشان دهنده عامل افزایش CPA هدف است. این یک فیلد الزامی است. |
ForecastingSetTargetRoasParameters
پارامترهایی که باید در هنگام اعمال یک توصیه پیشبینی هدف رواس استفاده شوند.
نمایندگی JSON |
---|
{ "targetRoas": number, "campaignBudgetAmountMicros": string } |
فیلدها | |
---|---|
targetRoas | ROAS هدف جدید (درآمد به ازای هر واحد هزینه) برای تنظیم یک منبع کمپین. مقدار بین 0.01 و 1000.0 با احتساب است. |
campaignBudgetAmountMicros | مقدار بودجه کمپین جدید برای تنظیم یک منبع کمپین. |
CalloutAssetParameters
پارامترهایی که باید هنگام اعمال توصیههای دارایی callout استفاده شوند.
نمایندگی JSON |
---|
{
"adAssetApplyParameters": {
object ( |
فیلدها | |
---|---|
adAssetApplyParameters | مورد نیاز. دارایی های Callout که باید اضافه شوند. این یک فیلد الزامی است. |
AdAssetApplyParameters
پارامترهای رایج مورد استفاده در هنگام اعمال توصیههای دارایی تبلیغات.
نمایندگی JSON |
---|
{ "newAssets": [ { object ( |
فیلدها | |
---|---|
newAssets[] | دارایی هایی برای ایجاد و پیوست کردن به یک محدوده. این ممکن است با دارایی های موجود در همان فراخوان ترکیب شود. |
existingAssets[] | نام منابع دارایی های موجود برای پیوست کردن به یک محدوده. این ممکن است با newAssets در همان تماس ترکیب شود. |
scope | مورد نیاز. دامنه استفاده از دارایی ها. داراییها در سطح دامنه کمپین برای کمپین مرتبط با توصیه اعمال خواهد شد. دارایی در محدوده مشتری برای کل حساب اعمال می شود. داراییهای موجود در محدوده کمپین، داراییهای پیوست شده در محدوده مشتری را لغو میکند. |
ApplyScope
محدوده اعمال دارایی ها.
Enums | |
---|---|
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 | مقدار بودجه کمپین جدید برای تنظیم یک منبع کمپین. |
ApplyRecommendationResult
نتیجه اعمال یک توصیه
نمایندگی JSON |
---|
{ "resourceName": string } |
فیلدها | |
---|---|
resourceName | برای درخواست های موفق بازگردانده شد. |