Method: customers.recommendations.apply

מיישמת המלצות נתונות עם פרמטרים שיושמו תואמים.

רשימת שגיאות שהמערכת ביצעה: 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

string

חובה. מזהה הלקוח עם ההמלצה.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "operations": [
    {
      object (ApplyRecommendationOperation)
    }
  ],
  "partialFailure": boolean
}
שדות
operations[]

object (ApplyRecommendationOperation)

חובה. רשימת הפעולות שצריך לבצע כדי ליישם המלצות. אם PartFailure=false, כל ההמלצות צריכות להיות מאותו סוג. יש מגבלה של 100 פעולות בכל בקשה.
partialFailure

boolean

אם הערך הוא true, פעולות שבוצעו בהצלחה ופעולות לא חוקיות יחזירו שגיאות. אם False, הפעולות יבוצעו כעסקה אם ורק אם כולן תקינות. ברירת המחדל היא False.

גוף התשובה

הודעת תשובה לגבי RecommendationService.ApplyRecommendation.

אם הפעולה בוצעה ללא שגיאות, גוף התשובה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "results": [
    {
      object (ApplyRecommendationResult)
    }
  ],
  "partialFailureError": {
    object (Status)
  }
}
שדות
results[]

object (ApplyRecommendationResult)

תוצאות הפעולות שצריך לבצע כדי ליישם המלצות.
partialFailureError

object (Status)

שגיאות שקשורות לכשלים בפעולה במצב כשל חלקי. הפונקציה מוחזרת רק כאשר PartFailure = true וכל השגיאות מתרחשות בתוך הפעולות. אם מתרחשות שגיאות מחוץ לפעולות (למשל, שגיאות אימות), נחזיר את השגיאה ברמת ה-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)
  },
  "forecastingSetTargetCpa": {
    object (ForecastingSetTargetCpaParameters)
  },
  "setTargetCpa": {
    object (ForecastingSetTargetCpaParameters)
  },
  "setTargetRoas": {
    object (ForecastingSetTargetRoasParameters)
  },
  "leadFormAsset": {
    object (LeadFormAssetParameters)
  }
  // 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)

פרמטרים אופציונליים שבהם משתמשים כשמיישמים המלצה להצטרפות ליעד עלות להמרה.
targetRoasOptIn

object (TargetRoasOptInParameters)

פרמטרים אופציונליים שבהם משתמשים כשמיישמים המלצה להצטרפות ליעד החזר על הוצאות פרסום.
calloutExtension

object (CalloutExtensionParameters)

פרמטרים שבהם צריך להשתמש כשמיישמים המלצה לתוסף יתרונות מרכזיים.
callExtension

object (CallExtensionParameters)

פרמטרים לשימוש כשמיישמים המלצה לתוסף שיחה.
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)

הפרמטרים שבהם צריך להשתמש כשמיישמים המלצה לנכס התקשרות.
raiseTargetCpa

object (RaiseTargetCpaParameters)

פרמטרים שצריך להשתמש בהם כשמחילים את ההמלצה 'יעד עלות להמרה'.
lowerTargetRoas

object (LowerTargetRoasParameters)

פרמטרים שצריך להשתמש בהם כשמיישמים המלצה ליעד נמוך יותר של החזר על הוצאות פרסום.
forecastingSetTargetCpa

object (ForecastingSetTargetCpaParameters)

הפרמטרים שבהם צריך להשתמש כשמיישמים המלצה להגדרת יעד עלות להמרה לפי תחזית.
setTargetCpa

object (ForecastingSetTargetCpaParameters)

הפרמטרים שבהם צריך להשתמש כשמיישמים המלצה להגדרת יעד עלות להמרה.
setTargetRoas

object (ForecastingSetTargetRoasParameters)

הפרמטרים שבהם צריך להשתמש כשמיישמים את ההמלצה להגדרת יעד החזר על הוצאות פרסום.
leadFormAsset

object (LeadFormAssetParameters)

הפרמטרים שבהם צריך להשתמש כשמיישמים המלצה על נכס השארת פרטים.

CampaignBudgetParameters

פרמטרים לשימוש כשמיישמים המלצה לתקציב של קמפיין.

ייצוג JSON 
{
  "newBudgetAmountMicros": string
}
שדות
newBudgetAmountMicros

string (int64 format)

סכום התקציב החדש שיוגדר למשאב תקציב היעד. זהו שדה חובה.

TextAdParameters

פרמטרים לשימוש בעת יישום המלצה למודעת טקסט.

ייצוג JSON 
{
  "ad": {
    object (Ad)
  }
}
שדות
ad

object (Ad)

מודעה חדשה להוספה לקבוצת המודעות המומלצת. יש להגדיר את כל השדות הנדרשים בהודעה הזו. זהו שדה חובה.

KeywordParameters

פרמטרים לשימוש כשמיישמים המלצה למילות מפתח.

ייצוג JSON 
{
  "matchType": enum (KeywordMatchType),
  "adGroup": string,
  "cpcBidMicros": string
}
שדות
matchType

enum (KeywordMatchType)

סוג ההתאמה של מילת המפתח. זהו שדה חובה.
adGroup

string

משאב קבוצת המודעות שאליו יש להוסיף מילת מפתח. זהו שדה חובה.
cpcBidMicros

string (int64 format)

(אופציונלי) הצעת מחיר לקליק שתוגדר עבור מילת המפתח. אם המדיניות לא מוגדרת, מילת המפתח תשתמש בהצעת המחיר בהתאם לשיטת הבידינג שבה נעשה שימוש בקבוצת המודעות של היעד.

TargetCpaOptInParameters

פרמטרים לשימוש כשמיישמים את ההמלצה ל'יעד עלות להמרה'.

ייצוג JSON 
{
  "targetCpaMicros": string,
  "newCampaignBudgetAmountMicros": string
}
שדות
targetCpaMicros

string (int64 format)

עלות ממוצעת להמרה לשימוש בשיטת הבידינג 'יעד עלות להמרה'. זהו שדה חובה.
newCampaignBudgetAmountMicros

string (int64 format)

אופציונלי: סכום התקציב שיוגדר לקמפיין.

TargetRoasOptInParameters

פרמטרים שצריך להשתמש בהם כשמיישמים המלצה להצטרפות ליעד החזר על הוצאות פרסום.

ייצוג JSON 
{
  "targetRoas": number,
  "newCampaignBudgetAmountMicros": string
}
שדות
targetRoas

number

החזר ממוצע על הוצאות פרסום (הכנסה לכל יחידת הוצאות) לשימוש בשיטת הבידינג 'יעד החזר על הוצאות פרסום'. הערך הוא בין 0.01 ל-1000.0, כולל. זהו שדה חובה, אלא אם מוגדר newCampaignBudgetAmountMicros.
newCampaignBudgetAmountMicros

string (int64 format)

אופציונלי: סכום התקציב שיוגדר לקמפיין.

CalloutExtensionParameters

פרמטרים שבהם צריך להשתמש כשמיישמים המלצה לתוסף יתרונות מרכזיים.

ייצוג JSON 
{
  "calloutExtensions": [
    {
      object (CalloutFeedItem)
    }
  ]
}
שדות
calloutExtensions[]

object (CalloutFeedItem)

תוספי יתרונות מרכזיים להוספה. זהו שדה חובה.

CallExtensionParameters

פרמטרים לשימוש כשמיישמים המלצה לתוסף שיחה.

ייצוג JSON 
{
  "callExtensions": [
    {
      object (CallFeedItem)
    }
  ]
}
שדות
callExtensions[]

object (CallFeedItem)

תוספי שיחה להוספה. זהו שדה חובה.

SitelinkExtensionParameters

פרמטרים לשימוש כשמיישמים המלצה ל-Sitelink.

ייצוג JSON 
{
  "sitelinkExtensions": [
    {
      object (SitelinkFeedItem)
    }
  ]
}
שדות

MoveUnusedBudgetParameters

פרמטרים לשימוש כשמיישמים המלצה להעברת תקציב שלא נוצל.

ייצוג JSON 
{
  "budgetMicrosToMove": string
}
שדות
budgetMicrosToMove

string (int64 format)

סכום התקציב שיועבר מתקציב עודף לתקציב מוגבל. זהו שדה חובה.

ResponsiveSearchAdParameters

פרמטרים לשימוש כשמיישמים המלצה למודעה רספונסיבית לרשת החיפוש.

ייצוג JSON 
{
  "ad": {
    object (Ad)
  }
}
שדות
ad

object (Ad)

חובה. מודעה חדשה להוספה לקבוצת המודעות המומלצת.

UseBroadMatchKeywordParameters

פרמטרים לשימוש כשמיישמים המלצה למילות מפתח בהתאמה רחבה.

ייצוג JSON 
{
  "newBudgetAmountMicros": string
}
שדות
newBudgetAmountMicros

string (int64 format)

סכום התקציב החדש שיוגדר למשאב תקציב היעד.

ResponsiveSearchAdAssetParameters

הפרמטרים שבהם צריך להשתמש כשמיישמים המלצה לגבי נכסים שמצורפים למודעות רספונסיביות לרשת החיפוש.

ייצוג JSON 
{
  "updatedAd": {
    object (Ad)
  }
}
שדות
updatedAd

object (Ad)

המודעה עודכנה. תוכן המודעה הנוכחית יוחלף.

ResponsiveSearchAdImproveAdStrengthParameters

פרמטרים שמיישמים מודעה רספונסיבית לרשת החיפוש משפרים את ההמלצה לגבי חוזק המודעה.

ייצוג JSON 
{
  "updatedAd": {
    object (Ad)
  }
}
שדות
updatedAd

object (Ad)

המודעה עודכנה. תוכן המודעה הנוכחית יוחלף.

RaiseTargetCpaBidTooLowParameters

הפרמטרים שצריך להשתמש בהם כשמחילים המלצה להגדלה של הצעת המחיר לפי יעד עלות להמרה שהיא נמוכה מדי. פעולת ההחלה היא אסינכרונית והתהליך יכול להימשך כמה דקות, בהתאם למספר הקבוצות של המודעות שיש בקמפיין הקשור.

ייצוג JSON 
{
  "targetMultiplier": number
}
שדות
targetMultiplier

number

חובה. מספר גדול מ-1.0 שמציין את הגורם להגדלת יעד העלות להמרה. זהו שדה חובה.

ForecastingSetTargetRoasParameters

הפרמטרים שצריך להשתמש בהם כשמיישמים המלצה להגדרת יעד החזר על הוצאות פרסום בהתאם לתחזית.

ייצוג JSON 
{
  "targetRoas": number,
  "campaignBudgetAmountMicros": string
}
שדות
targetRoas

number

יעד חדש של החזר על הוצאות פרסום (הכנסה לכל יחידת הוצאות) שצריך להגדיר למשאב של הקמפיין. הערך הוא בין 0.01 ל-1000.0, כולל.
campaignBudgetAmountMicros

string (int64 format)

סכום חדש של תקציב לקמפיין שצריך להגדיר למשאב של הקמפיין.

CalloutAssetParameters

הפרמטרים שבהם משתמשים כשמיישמים המלצות לגבי נכסי יתרונות מרכזיים.

ייצוג JSON 
{
  "adAssetApplyParameters": {
    object (AdAssetApplyParameters)
  }
}
שדות
adAssetApplyParameters

object (AdAssetApplyParameters)

חובה. נכסי יתרונות מרכזיים להוספה. זהו שדה חובה.

AdAssetApplyParameters

פרמטרים נפוצים שבהם המערכת משתמשת כדי ליישם המלצות לגבי נכסים שמצורפים למודעות.

ייצוג JSON 
{
  "newAssets": [
    {
      object (Asset)
    }
  ],
  "existingAssets": [
    string
  ],
  "scope": enum (ApplyScope)
}
שדות
newAssets[]

object (Asset)

הנכסים שצריך ליצור ולצרף להיקף. אפשר לשלב את המידע הזה עם נכסים קיימים באותה קריאה.
existingAssets[]

string

שמות המשאבים של נכסים קיימים שצריך לצרף להיקף. אפשר לשלב את המידע הזה עם נכסים חדשים באותה קריאה.
scope

enum (ApplyScope)

חובה. ההיקף שבו יש להחיל את הנכסים. נכסים ברמת הקמפיין יוחלו על הקמפיין המשויך להמלצה. נכסים בהיקף הלקוח יחולו על החשבון כולו. נכסים בהיקף הקמפיין יקבלו עדיפות על פני נכסים מצורפים ברמת הלקוח.

ApplyScope

ההיקף שעליו רוצים להחיל את הנכסים.

טיפוסים בני מנייה (enums)
UNSPECIFIED היקף ההחלה לא צוין.
UNKNOWN לא ידוע.
CUSTOMER החלה בהיקף הלקוח.
CAMPAIGN החלה ברמת הקמפיין.

CallAssetParameters

הפרמטרים שבהם משתמשים כשמיישמים המלצות לגבי נכסי התקשרות.

ייצוג JSON 
{
  "adAssetApplyParameters": {
    object (AdAssetApplyParameters)
  }
}
שדות
adAssetApplyParameters

object (AdAssetApplyParameters)

חובה. נכסי התקשרות להוספה. זהו שדה חובה.

SitelinkAssetParameters

הפרמטרים שבהם משתמשים כשמיישמים המלצות לגבי נכסי Sitelink.

ייצוג JSON 
{
  "adAssetApplyParameters": {
    object (AdAssetApplyParameters)
  }
}
שדות
adAssetApplyParameters

object (AdAssetApplyParameters)

חובה. נכסי Sitelink להוספה. זהו שדה חובה.

RaiseTargetCpaParameters

פרמטרים לשימוש כשמיישמים המלצות להגדלת יעד עלות להמרה.

ייצוג JSON 
{
  "targetCpaMultiplier": number
}
שדות
targetCpaMultiplier

number

חובה. היעד שאליו יש להגדיר את מכפיל העלות להמרה. זהו שדה חובה.

LowerTargetRoasParameters

פרמטרים שצריך להשתמש בהם כשמיישמים המלצות נמוכות יותר ליעד החזר על הוצאות פרסום.

ייצוג JSON 
{
  "targetRoasMultiplier": number
}
שדות
targetRoasMultiplier

number

חובה. היעד שצריך להגדיר בו את מכפיל ההחזר על הוצאות הפרסום. זהו שדה חובה.

ForecastingSetTargetCpaParameters

פרמטרים שצריך להשתמש בהם כשמיישמים המלצה להגדרת יעד עלות להמרה.

ייצוג JSON 
{
  "targetCpaMicros": string,
  "campaignBudgetAmountMicros": string
}
שדות
targetCpaMicros

string (int64 format)

עלות ממוצעת להמרה לשימוש בשיטת הבידינג 'יעד עלות להמרה'.
campaignBudgetAmountMicros

string (int64 format)

סכום חדש של תקציב לקמפיין שצריך להגדיר למשאב של הקמפיין.

LeadFormAssetParameters

הפרמטרים שבהם צריך להשתמש כשמיישמים המלצה לגבי נכסי השארת פרטים.

ייצוג JSON 
{
  "adAssetApplyParameters": {
    object (AdAssetApplyParameters)
  },
  "setSubmitLeadFormAssetCampaignGoal": boolean
}
שדות
adAssetApplyParameters

object (AdAssetApplyParameters)

חובה. נכסי השארת פרטים. זהו שדה חובה.
setSubmitLeadFormAssetCampaignGoal

boolean

אם הערך הוא True, היעד 'שליחת טופס להשארת פרטים' יוגדר בקמפיין היעד. כתוצאה מכך, המודעות יוצגו כמודעות קריאייטיב של טפסים להשארת פרטים. אם הערך הוא False, היעד 'שליחת טופס להשארת פרטים' לא יוגדר בקמפיין והמודעות יכילו נכסי השארת פרטים.

ApplyRecommendationResult

התוצאה של יישום המלצה.

ייצוג JSON 
{
  "resourceName": string
}
שדות
resourceName

string

הוחזרה עבור החלה בהצלחה.