Method: customers.recommendations.apply

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

רשימה של שגיאות התרעה: AuthenticationError AuthorizationError DatabaseError FieldError HeaderError InternalError MutateError QuotaError RecommendationError RequestError UrlFieldError

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.

פרמטרים של נתיב

פרמטרים
customerId

string

חובה. מספר הלקוח עם ההמלצה.

גוף הבקשה

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

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

object (ApplyRecommendationOperation)

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

boolean

אם הערך הוא true, יבוצעו פעולות מוצלחות ופעולות לא חוקיות יחזירו שגיאות. אם הוא שקרי, הפעולות יבוצעו כעסקה אם ורק אם כולן תקפות. ברירת המחדל היא 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)
  }
  // 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)

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

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

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

ApplyRecommendationResult

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

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

string

הוחזרה לאחר החלת הפעולה שבוצעה בהצלחה.