Method: customers.recommendations.apply

Wendet bestimmte Empfehlungen mit den entsprechenden angewendeten Parametern an.

Liste der ausgelösten Fehler: AuthenticationError AuthorizationError DatabaseError FieldError HeaderError InternalError MutateError QuotaError RecommendationError RequestError UrlFieldError

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameters
customerId

string

Erforderlich. Die ID des Kunden mit der Empfehlung.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "operations": [
    {
      object (ApplyRecommendationOperation)
    }
  ],
  "partialFailure": boolean
}
Felder
operations[]

object (ApplyRecommendationOperation)

Erforderlich. Die Liste der Vorgänge, auf die Empfehlungen angewendet werden sollen. Bei partFailure=false sollten alle Empfehlungen vom gleichen Typ sein. Pro Anfrage sind maximal 100 Vorgänge zulässig.
partialFailure

boolean

Bei „true“ werden erfolgreiche Vorgänge ausgeführt und bei ungültigen Vorgängen werden Fehler zurückgegeben. Wenn "false", werden Operationen nur dann als Transaktion ausgeführt, wenn sie alle gültig sind. Der Standardwert ist "false".

Antworttext

Antwortnachricht für RecommendationService.ApplyRecommendation.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "results": [
    {
      object (ApplyRecommendationResult)
    }
  ],
  "partialFailureError": {
    object (Status)
  }
}
Felder
results[]

object (ApplyRecommendationResult)

Ergebnisse der Vorgänge zum Anwenden von Empfehlungen.
partialFailureError

object (Status)

Fehler, die sich auf Betriebsausfälle im Modus für teilweise Fehler beziehen. Wird nur zurückgegeben, wenn partialFailure = "true" ist und alle Fehler innerhalb der Vorgänge auftreten. Wenn Fehler außerhalb der Vorgänge auftreten (z. B. Authentifizierungsfehler), geben wir den RPC-Fehler zurück.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.

ApplyRecommendationOperation

Informationen zum Vorgang zum Anwenden einer Empfehlung sowie zu allen Parametern zum Anpassen der Empfehlung.

JSON-Darstellung 
{
  "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.
}
Felder
resourceName

string

Der Ressourcenname der anzuwendenden Empfehlung.
Union-Feld apply_parameters. Parameter, die beim Anwenden der Empfehlung verwendet werden sollen. Für apply_parameters ist nur einer der folgenden Werte zulässig:
campaignBudget

object (CampaignBudgetParameters)

Optionale Parameter, die beim Anwenden einer Empfehlung für das Kampagnenbudget verwendet werden.
textAd

object (TextAdParameters)

Optionale Parameter, die beim Anwenden einer Empfehlung für Textanzeigen verwendet werden.
keyword

object (KeywordParameters)

Optionale Parameter, die beim Anwenden einer Keyword-Empfehlung verwendet werden.
targetCpaOptIn

object (TargetCpaOptInParameters)

Optionale Parameter, die beim Anwenden der Empfehlung zum Aktivieren des Ziel-CPA verwendet werden.
targetRoasOptIn

object (TargetRoasOptInParameters)

Optionale Parameter, die beim Anwenden der Opt-in-Empfehlung für den Ziel-ROAS verwendet werden können.
calloutExtension

object (CalloutExtensionParameters)

Parameter, die beim Anwenden einer Empfehlung für Erweiterungen mit Zusatzinformationen verwendet werden sollen.
callExtension

object (CallExtensionParameters)

Parameter, die beim Anwenden einer Empfehlung für Anruferweiterungen verwendet werden sollen.
moveUnusedBudget

object (MoveUnusedBudgetParameters)

Parameter, die beim Anwenden einer Empfehlung zum Verschieben nicht aufgebrauchter Budgets verwendet werden sollen.
responsiveSearchAd

object (ResponsiveSearchAdParameters)

Parameter, die beim Anwenden einer Empfehlung für responsive Suchanzeigen verwendet werden sollen.
useBroadMatchKeyword

object (UseBroadMatchKeywordParameters)

Parameter, die beim Anwenden einer Empfehlung für weitgehend passende Keywords verwendet werden sollen.
responsiveSearchAdAsset

object (ResponsiveSearchAdAssetParameters)

Parameter, die beim Anwenden einer Empfehlung für Assets für responsive Suchanzeigen verwendet werden sollen.
responsiveSearchAdImproveAdStrength

object (ResponsiveSearchAdImproveAdStrengthParameters)

Parameter, die beim Anwenden einer responsiven Suchanzeige verwendet werden, verbessern die Empfehlung zur Anzeigeneffektivität.
raiseTargetCpaBidTooLow

object (RaiseTargetCpaBidTooLowParameters)

Parameter, die beim Anwenden einer Empfehlung zur Erhöhung des Ziel-CPA-Gebots verwendet werden sollen. Das Anwenden ist asynchron und kann je nach Anzahl der Anzeigengruppen in der zugehörigen Kampagne einige Minuten dauern.
forecastingSetTargetRoas

object (ForecastingSetTargetRoasParameters)

Parameter, die beim Anwenden einer Empfehlung zum Ziel-ROAS für Prognosen verwendet werden sollen.
calloutAsset

object (CalloutAssetParameters)

Parameter, die beim Anwenden einer Empfehlung für Assets mit Zusatzinformationen verwendet werden sollen.
callAsset

object (CallAssetParameters)

Parameter, die beim Anwenden einer Empfehlung für Anruf-Assets verwendet werden sollen.
raiseTargetCpa

object (RaiseTargetCpaParameters)

Parameter, die beim Anwenden der Empfehlung „Ziel-CPA“ verwendet werden sollen.
lowerTargetRoas

object (LowerTargetRoasParameters)

Parameter, die beim Anwenden einer Empfehlung für einen niedrigeren Ziel-ROAS verwendet werden sollen.
forecastingSetTargetCpa

object (ForecastingSetTargetCpaParameters)

Parameter, die bei der Anwendung von Prognosen und Empfehlungen für den Ziel-CPA verwendet werden sollen.
setTargetCpa

object (ForecastingSetTargetCpaParameters)

Parameter, die beim Anwenden einer Empfehlung für den festgelegten Ziel-CPA verwendet werden sollen.
setTargetRoas

object (ForecastingSetTargetRoasParameters)

Parameter, die beim Anwenden einer Empfehlung für den festgelegten Ziel-ROAS verwendet werden sollen.
leadFormAsset

object (LeadFormAssetParameters)

Parameter, die beim Anwenden einer Empfehlung für Assets mit Lead-Formular verwendet werden sollen.

CampaignBudgetParameters

Parameter, die beim Anwenden einer Empfehlung für das Kampagnenbudget verwendet werden sollen.

JSON-Darstellung 
{
  "newBudgetAmountMicros": string
}
Felder
newBudgetAmountMicros

string (int64 format)

Neuer Budgetbetrag, der für die Zielbudgetressource festgelegt werden soll. Dies ist ein Pflichtfeld.

TextAdParameters

Parameter, die beim Anwenden einer Empfehlung für Textanzeigen verwendet werden sollen.

JSON-Darstellung 
{
  "ad": {
    object (Ad)
  }
}
Felder
ad

object (Ad)

Neue Anzeige, die der empfohlenen Anzeigengruppe hinzugefügt werden soll. In dieser Nachricht müssen alle erforderlichen Felder festgelegt werden. Dies ist ein Pflichtfeld.

KeywordParameters

Parameter, die beim Anwenden einer Keyword-Empfehlung verwendet werden sollen.

JSON-Darstellung 
{
  "matchType": enum (KeywordMatchType),
  "adGroup": string,
  "cpcBidMicros": string
}
Felder
matchType

enum (KeywordMatchType)

Der Übereinstimmungstyp des Keywords. Dies ist ein Pflichtfeld.
adGroup

string

Die Anzeigengruppenressource, der das Keyword hinzugefügt werden soll Dies ist ein Pflichtfeld.
cpcBidMicros

string (int64 format)

Optionales CPC-Gebot, das für das Keyword festgelegt werden soll. Wenn die Richtlinie nicht konfiguriert ist, wird für das Keyword das Gebot verwendet, das auf der Gebotsstrategie der angezielten Anzeigengruppe basiert.

TargetCpaOptInParameters

Parameter, die beim Anwenden der Empfehlung „Ziel-CPA“ verwendet werden sollen.

JSON-Darstellung 
{
  "targetCpaMicros": string,
  "newCampaignBudgetAmountMicros": string
}
Felder
targetCpaMicros

string (int64 format)

Durchschnittlicher CPA für die Gebotsstrategie „Ziel-CPA“. Dies ist ein Pflichtfeld.
newCampaignBudgetAmountMicros

string (int64 format)

Optionaler Budgetbetrag, der für die Kampagne festgelegt werden soll.

TargetRoasOptInParameters

Parameter, die beim Anwenden einer Optimierungsempfehlung für den Ziel-ROAS verwendet werden sollen.

JSON-Darstellung 
{
  "targetRoas": number,
  "newCampaignBudgetAmountMicros": string
}
Felder
targetRoas

number

Durchschnittlicher ROAS (Umsatz pro Ausgabeeinheit) für die Gebotsstrategie „Ziel-ROAS“. Der Wert liegt zwischen 0,01 und 1.000,0 (jeweils einschließlich). Dies ist ein Pflichtfeld, sofern „newCampaignBudgetAmountMicros“ nicht festgelegt ist.
newCampaignBudgetAmountMicros

string (int64 format)

Optionaler Budgetbetrag, der für die Kampagne festgelegt werden soll.

CalloutExtensionParameters

Parameter, die beim Anwenden einer Empfehlung für Erweiterungen mit Zusatzinformationen verwendet werden sollen.

JSON-Darstellung 
{
  "calloutExtensions": [
    {
      object (CalloutFeedItem)
    }
  ]
}
Felder
calloutExtensions[]

object (CalloutFeedItem)

Erweiterungen mit Zusatzinformationen werden hinzugefügt. Dies ist ein Pflichtfeld.

CallExtensionParameters

Parameter, die beim Anwenden einer Empfehlung für Anruferweiterungen verwendet werden sollen.

JSON-Darstellung 
{
  "callExtensions": [
    {
      object (CallFeedItem)
    }
  ]
}
Felder
callExtensions[]

object (CallFeedItem)

Anruferweiterungen werden hinzugefügt. Dies ist ein Pflichtfeld.

SitelinkExtensionParameters

Parameter, die beim Anwenden einer Sitelink-Empfehlung verwendet werden sollen.

JSON-Darstellung 
{
  "sitelinkExtensions": [
    {
      object (SitelinkFeedItem)
    }
  ]
}
Felder

MoveUnusedBudgetParameters

Parameter, die beim Anwenden einer Empfehlung zum Verschieben nicht aufgebrauchter Budgets verwendet werden sollen.

JSON-Darstellung 
{
  "budgetMicrosToMove": string
}
Felder
budgetMicrosToMove

string (int64 format)

Budgetbetrag, der von einem übermäßigen in ein beschränktes Budget verschoben werden soll. Dies ist ein Pflichtfeld.

ResponsiveSearchAdParameters

Parameter, die beim Anwenden einer Empfehlung für responsive Suchanzeigen verwendet werden sollen.

JSON-Darstellung 
{
  "ad": {
    object (Ad)
  }
}
Felder
ad

object (Ad)

Erforderlich. Neue Anzeige, die der empfohlenen Anzeigengruppe hinzugefügt werden soll.

UseBroadMatchKeywordParameters

Parameter, die beim Anwenden einer Empfehlung für weitgehend passende Keywords verwendet werden sollen.

JSON-Darstellung 
{
  "newBudgetAmountMicros": string
}
Felder
newBudgetAmountMicros

string (int64 format)

Neuer Budgetbetrag, der für die Zielbudgetressource festgelegt werden soll.

ResponsiveSearchAdAssetParameters

Parameter, die beim Anwenden einer Empfehlung für Assets für responsive Suchanzeigen verwendet werden sollen.

JSON-Darstellung 
{
  "updatedAd": {
    object (Ad)
  }
}
Felder
updatedAd

object (Ad)

Die Anzeige wurde aktualisiert. Der Inhalt der aktuellen Anzeige wird ersetzt.

ResponsiveSearchAdImproveAdStrengthParameters

Parameter, die beim Anwenden einer responsiven Suchanzeige verwendet werden, verbessern die Empfehlung zur Anzeigeneffektivität.

JSON-Darstellung 
{
  "updatedAd": {
    object (Ad)
  }
}
Felder
updatedAd

object (Ad)

Die Anzeige wurde aktualisiert. Der Inhalt der aktuellen Anzeige wird ersetzt.

RaiseTargetCpaBidTooLowParameters

Parameter, die beim Anwenden einer Empfehlung zur Erhöhung des Ziel-CPA-Gebots verwendet werden sollen. Das Anwenden ist asynchron und kann je nach Anzahl der Anzeigengruppen in der zugehörigen Kampagne einige Minuten dauern.

JSON-Darstellung 
{
  "targetMultiplier": number
}
Felder
targetMultiplier

number

Erforderlich. Eine Zahl über 1,0, die den Faktor angibt, um den der Ziel-CPA erhöht werden soll. Dies ist ein Pflichtfeld.

ForecastingSetTargetRoasParameters

Parameter, die beim Anwenden einer Empfehlung für den Ziel-ROAS für Prognosen verwendet werden sollen.

JSON-Darstellung 
{
  "targetRoas": number,
  "campaignBudgetAmountMicros": string
}
Felder
targetRoas

number

Neuer Ziel-ROAS (Umsatz pro Ausgabeeinheit), der für eine Kampagnenressource festgelegt wird. Der Wert liegt zwischen 0,01 und 1.000,0 (jeweils einschließlich).
campaignBudgetAmountMicros

string (int64 format)

Neues Kampagnenbudget, das für eine Kampagnenressource festgelegt werden soll.

CalloutAssetParameters

Parameter, die beim Anwenden von Empfehlungen für Assets mit Zusatzinformationen verwendet werden sollen.

JSON-Darstellung 
{
  "adAssetApplyParameters": {
    object (AdAssetApplyParameters)
  }
}
Felder
adAssetApplyParameters

object (AdAssetApplyParameters)

Erforderlich. Assets mit Zusatzinformationen, die hinzugefügt werden sollen. Dies ist ein Pflichtfeld.

AdAssetApplyParameters

Allgemeine Parameter, die beim Anwenden von Empfehlungen für Anzeigen-Assets verwendet werden.

JSON-Darstellung 
{
  "newAssets": [
    {
      object (Asset)
    }
  ],
  "existingAssets": [
    string
  ],
  "scope": enum (ApplyScope)
}
Felder
newAssets[]

object (Asset)

Die Assets, die erstellt und einem Bereich zugeordnet werden sollen. Dies kann mit vorhandenen Assets im selben Aufruf kombiniert werden.
existingAssets[]

string

Die Ressourcennamen vorhandener Assets, die an einen Bereich angehängt werden sollen. Dies kann im selben Aufruf mit „newAssets“ kombiniert werden.
scope

enum (ApplyScope)

Erforderlich. Der Umfang, auf den die Assets angewendet werden sollen. Assets auf Kampagnenebene werden auf die mit der Empfehlung verknüpfte Kampagne angewendet. Assets auf Kundenebene gelten für das gesamte Konto. Assets auf Kampagnenebene überschreiben alle verknüpften Assets auf Kundenebene.

ApplyScope

Bereich, auf den die Assets angewendet werden sollen.

Enums
UNSPECIFIED Der Anwendungsbereich wurde nicht angegeben.
UNKNOWN Unbekannt.
CUSTOMER Auf Kundenebene anwenden.
CAMPAIGN Auf Kampagnenebene anwenden.

CallAssetParameters

Parameter, die beim Anwenden von Empfehlungen für Anruf-Assets verwendet werden sollen.

JSON-Darstellung 
{
  "adAssetApplyParameters": {
    object (AdAssetApplyParameters)
  }
}
Felder
adAssetApplyParameters

object (AdAssetApplyParameters)

Erforderlich. Anruf-Assets, die hinzugefügt werden sollen. Dies ist ein Pflichtfeld.

SitelinkAssetParameters

Parameter, die beim Anwenden von Empfehlungen für Sitelink-Assets verwendet werden.

JSON-Darstellung 
{
  "adAssetApplyParameters": {
    object (AdAssetApplyParameters)
  }
}
Felder
adAssetApplyParameters

object (AdAssetApplyParameters)

Erforderlich. Sitelink-Assets, die hinzugefügt werden sollen Dies ist ein Pflichtfeld.

RaiseTargetCpaParameters

Parameter, die beim Anwenden von Empfehlungen zum Erhöhen des Ziel-CPA verwendet werden sollen.

JSON-Darstellung 
{
  "targetCpaMultiplier": number
}
Felder
targetCpaMultiplier

number

Erforderlich. Ziel, auf das der CPA-Multiplikator gesetzt werden soll. Dies ist ein Pflichtfeld.

LowerTargetRoasParameters

Parameter, die beim Anwenden von Empfehlungen auf einen niedrigeren Ziel-ROAS verwendet werden sollen.

JSON-Darstellung 
{
  "targetRoasMultiplier": number
}
Felder
targetRoasMultiplier

number

Erforderlich. Ziel, auf das der ROAS-Multiplikator festgelegt werden soll. Dies ist ein Pflichtfeld.

ForecastingSetTargetCpaParameters

Parameter, die beim Anwenden einer festgelegten Ziel-CPA-Empfehlung verwendet werden sollen.

JSON-Darstellung 
{
  "targetCpaMicros": string,
  "campaignBudgetAmountMicros": string
}
Felder
targetCpaMicros

string (int64 format)

Durchschnittlicher CPA für die Gebotsstrategie „Ziel-CPA“.
campaignBudgetAmountMicros

string (int64 format)

Neues Kampagnenbudget, das für eine Kampagnenressource festgelegt werden soll.

LeadFormAssetParameters

Parameter, die beim Anwenden einer Empfehlung für Assets mit Lead-Formular verwendet werden.

JSON-Darstellung 
{
  "adAssetApplyParameters": {
    object (AdAssetApplyParameters)
  },
  "setSubmitLeadFormAssetCampaignGoal": boolean
}
Felder
adAssetApplyParameters

object (AdAssetApplyParameters)

Erforderlich. Assets mit Lead-Formular, die hinzugefügt werden sollen. Dies ist ein Pflichtfeld.
setSubmitLeadFormAssetCampaignGoal

boolean

Wenn „true“ festgelegt ist, wird das Zielvorhaben „Lead-Formular senden“ für die angezielte Kampagne festgelegt. Die Anzeigen werden dann als Creative-Anzeigen mit Lead-Formular präsentiert. Ist die Richtlinie auf „false“ gesetzt, wird das Zielvorhaben „Lead-Formular senden“ nicht für die Kampagne festgelegt und Anzeigen enthalten Assets mit Lead-Formular.

ApplyRecommendationResult

Das Ergebnis der Anwendung einer Empfehlung.

JSON-Darstellung 
{
  "resourceName": string
}
Felder
resourceName

string

Für erfolgreiche Anträge zurückgegeben.