- HTTP-Anfrage
- Pfadparameter
- Anfragetext
- Antworttext
- Autorisierungsbereiche
- ApplyRecommendationOperation
- CampaignBudgetParameters
- TextAdParameters
- KeywordParameters
- TargetCpaOptInParameters
- TargetRoasOptInParameters
- CalloutExtensionParameters
- CallExtensionParameters
- SitelinkExtensionParameters
- MoveUnusedBudgetParameters
- ResponsiveSearchAdParameters
- UseBroadMatchKeywordParameters
- ResponsiveSearchAdAssetParameters
- ResponsiveSearchAdImproveAdStrengthParameters
- RaiseTargetCpaBidTooLowParameters
- ForecastingSetTargetRoasParameters
- CalloutAssetParameters
- AdAssetApplyParameters
- ApplyScope
- CallAssetParameters
- SitelinkAssetParameters
- RaiseTargetCpaParameters
- LowerTargetRoasParameters
- ForecastingSetTargetCpaParameters
- ApplyRecommendationResult (Empfehlungen anwenden)
- Testen!
Angegebene Empfehlungen werden mit entsprechenden angewendeten Parametern angewendet.
Liste der ausgelösten Fehler: AuthenticationError AuthorizationError DatabaseError FieldError HeaderError InternalError MutateError QuotaError RecommendationError RequestError UrlFieldError
HTTP-Anfrage
POST https://googleads.googleapis.com/v15/customers/{customerId}/recommendations:apply
Die URL verwendet die Syntax der gRPC-Transcodierung.
Pfadparameter
Parameter | |
---|---|
customerId |
Erforderlich. Die ID des Kunden mit der Empfehlung. |
Anfragetext
Der Anfragetext enthält Daten mit folgender Struktur:
JSON-Darstellung |
---|
{
"operations": [
{
object ( |
Felder | |
---|---|
operations[] |
Erforderlich. Die Liste der Vorgänge, auf die Empfehlungen angewendet werden sollen. Wenn partialFailure=false, sollten alle Empfehlungen vom gleichen Typ sein. Pro Anfrage sind maximal 100 Vorgänge zulässig. |
partialFailure |
Bei Einstellung auf „true“ werden erfolgreiche Vorgänge ausgeführt und bei ungültigen Vorgängen werden Fehler zurückgegeben. Bei „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 ( |
Felder | |
---|---|
results[] |
Ergebnisse der angewendeten Empfehlungen |
partialFailureError |
Fehler, die sich auf Betriebsausfälle im Modus „Teilweise fehlgeschlagen“ 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), wird der Fehler auf RPC-Ebene zurückgegeben. |
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 und zu allen Parametern zum Anpassen der Empfehlung.
JSON-Darstellung |
---|
{ "resourceName": string, // Union field |
Felder | |
---|---|
resourceName |
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 |
Optionale Parameter, die beim Anwenden einer Empfehlung für das Kampagnenbudget verwendet werden. |
textAd |
Optionale Parameter, die beim Anwenden einer Empfehlung für Textanzeigen verwendet werden. |
keyword |
Optionale Parameter zum Anwenden einer Keyword-Empfehlung. |
targetCpaOptIn |
Optionale Parameter, die beim Anwenden einer Empfehlung zur Aktivierung des Ziel-CPA verwendet werden. |
targetRoasOptIn |
Optionale Parameter, die beim Anwenden einer Empfehlung zur Aktivierung des Ziel-ROAS verwendet werden. |
calloutExtension |
Parameter, die beim Anwenden einer Empfehlung für Erweiterungen mit Zusatzinformationen verwendet werden. |
callExtension |
Parameter, die beim Anwenden einer Empfehlung für Anruferweiterungen verwendet werden. |
sitelinkExtension |
Parameter, die beim Anwenden einer Sitelink-Empfehlung verwendet werden. |
moveUnusedBudget |
Parameter, die verwendet werden, wenn eine Empfehlung zum Verschieben nicht aufgebrauchter Budgets angewendet wird. |
responsiveSearchAd |
Parameter, die beim Anwenden einer Empfehlung für responsive Suchanzeigen verwendet werden. |
useBroadMatchKeyword |
Parameter, die beim Anwenden einer Empfehlung für weitgehend passende Keywords verwendet werden. |
responsiveSearchAdAsset |
Parameter, die beim Anwenden einer Empfehlung für Assets für responsive Suchanzeigen verwendet werden. |
responsiveSearchAdImproveAdStrength |
Parameter, die beim Anwenden einer responsiven Suchanzeige verwendet werden, verbessern die Empfehlung zur Anzeigeneffektivität. |
raiseTargetCpaBidTooLow |
Parameter, die verwendet werden sollen, wenn eine Empfehlung zum Erhöhen des Ziel-CPA-Gebots zu niedrig ist. Das Anwenden ist asynchron und kann je nach Anzahl der Anzeigengruppen in der zugehörigen Kampagne Minuten dauern. |
forecastingSetTargetRoas |
Parameter, die beim Anwenden einer Empfehlung für den Ziel-ROAS von Prognosen verwendet werden. |
calloutAsset |
Parameter, die beim Anwenden einer Empfehlung für Assets mit Zusatzinformationen verwendet werden. |
callAsset |
Parameter, die beim Anwenden einer Empfehlung für Anruf-Assets verwendet werden. |
sitelinkAsset |
Parameter, die beim Anwenden einer Empfehlung für Sitelink-Assets verwendet werden. |
raiseTargetCpa |
Parameter, die beim Anwenden einer Empfehlung für die Ziel-CPA-Erhöhung verwendet werden. |
lowerTargetRoas |
Parameter, die beim Anwenden einer Empfehlung für einen niedrigeren Ziel-ROAS verwendet werden. |
forecastingSetTargetCpa |
Parameter, die beim Anwenden der Empfehlung zum Ziel-CPA von Prognosen verwendet werden. |
setTargetCpa |
Parameter, die beim Anwenden einer Empfehlung für einen festgelegten Ziel-CPA verwendet werden sollen. |
setTargetRoas |
Parameter, die beim Anwenden einer Empfehlung für einen festgelegten Ziel-ROAS verwendet werden. |
CampaignBudgetParameters
Parameter, die beim Anwenden einer Empfehlung für das Kampagnenbudget verwendet werden.
JSON-Darstellung |
---|
{ "newBudgetAmountMicros": string } |
Felder | |
---|---|
newBudgetAmountMicros |
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.
JSON-Darstellung |
---|
{
"ad": {
object ( |
Felder | |
---|---|
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.
JSON-Darstellung |
---|
{
"matchType": enum ( |
Felder | |
---|---|
matchType |
Der Übereinstimmungstyp des Keywords. Dies ist ein Pflichtfeld. |
adGroup |
Die Ressource der Anzeigengruppe, der das Keyword hinzugefügt werden soll Dies ist ein Pflichtfeld. |
cpcBidMicros |
Optionales CPC-Gebot, das für das Keyword festgelegt werden kann 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 für den Ziel-CPA verwendet werden sollen.
JSON-Darstellung |
---|
{ "targetCpaMicros": string, "newCampaignBudgetAmountMicros": string } |
Felder | |
---|---|
targetCpaMicros |
Durchschnittlicher CPA für die Gebotsstrategie „Ziel-CPA“. Dies ist ein Pflichtfeld. |
newCampaignBudgetAmountMicros |
Optionaler Budgetbetrag, der für die Kampagne festgelegt werden soll. |
TargetRoasOptInParameters
Parameter, die beim Anwenden einer Empfehlung zur Aktivierung des Ziel-ROAS verwendet werden.
JSON-Darstellung |
---|
{ "targetRoas": number, "newCampaignBudgetAmountMicros": string } |
Felder | |
---|---|
targetRoas |
Der durchschnittliche ROAS (Umsatz pro Ausgabeeinheit) für die Gebotsstrategie „Ziel-ROAS“. Der Wert liegt zwischen 0,01 und 1.000,0 (einschließlich). Dies ist ein Pflichtfeld, sofern "newCampaignBudgetAmountMicros" nicht festgelegt ist. |
newCampaignBudgetAmountMicros |
Optionaler Budgetbetrag, der für die Kampagne festgelegt werden soll. |
CalloutExtensionParameters
Parameter, die beim Anwenden einer Empfehlung für Erweiterungen mit Zusatzinformationen verwendet werden.
JSON-Darstellung |
---|
{
"calloutExtensions": [
{
object ( |
Felder | |
---|---|
calloutExtensions[] |
Erweiterungen mit Zusatzinformationen werden hinzugefügt. Dies ist ein Pflichtfeld. |
CallExtensionParameters
Parameter, die beim Anwenden einer Empfehlung für Anruferweiterungen verwendet werden.
JSON-Darstellung |
---|
{
"callExtensions": [
{
object ( |
Felder | |
---|---|
callExtensions[] |
Anruferweiterungen werden hinzugefügt. Dies ist ein Pflichtfeld. |
SitelinkExtensionParameters
Parameter, die beim Anwenden einer Sitelink-Empfehlung verwendet werden.
JSON-Darstellung |
---|
{
"sitelinkExtensions": [
{
object ( |
Felder | |
---|---|
sitelinkExtensions[] |
Hinzuzufügende Sitelinks Dies ist ein Pflichtfeld. |
MoveUnusedBudgetParameters
Parameter, die verwendet werden, wenn eine Empfehlung zum Verschieben nicht aufgebrauchter Budgets angewendet wird.
JSON-Darstellung |
---|
{ "budgetMicrosToMove": string } |
Felder | |
---|---|
budgetMicrosToMove |
Budget, das von einem überschüssigen 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.
JSON-Darstellung |
---|
{
"ad": {
object ( |
Felder | |
---|---|
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.
JSON-Darstellung |
---|
{ "newBudgetAmountMicros": string } |
Felder | |
---|---|
newBudgetAmountMicros |
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.
JSON-Darstellung |
---|
{
"updatedAd": {
object ( |
Felder | |
---|---|
updatedAd |
Anzeige 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 ( |
Felder | |
---|---|
updatedAd |
Anzeige aktualisiert. Der Inhalt der aktuellen Anzeige wird ersetzt. |
RaiseTargetCpaBidTooLowParameters
Parameter, die verwendet werden sollen, wenn eine Empfehlung zum Erhöhen des Ziel-CPA-Gebots zu niedrig ist. Das Anwenden ist asynchron und kann je nach Anzahl der Anzeigengruppen in der zugehörigen Kampagne Minuten dauern.
JSON-Darstellung |
---|
{ "targetMultiplier": number } |
Felder | |
---|---|
targetMultiplier |
Erforderlich. Eine Zahl größer als 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 (Return on Advertising Spend) von Prognosen verwendet werden.
JSON-Darstellung |
---|
{ "targetRoas": number, "campaignBudgetAmountMicros": string } |
Felder | |
---|---|
targetRoas |
Neuer Ziel-ROAS (Umsatz pro Ausgabeeinheit), der für eine Kampagnenressource festgelegt werden soll. Der Wert liegt zwischen 0,01 und 1.000,0 (einschließlich). |
campaignBudgetAmountMicros |
Neues Kampagnenbudget, das für eine Kampagnenressource festgelegt werden soll. |
CalloutAssetParameters
Parameter, die beim Anwenden von Asset-Empfehlungen für Zusatzinformationen verwendet werden sollen.
JSON-Darstellung |
---|
{
"adAssetApplyParameters": {
object ( |
Felder | |
---|---|
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 ( |
Felder | |
---|---|
newAssets[] |
Die Assets, die erstellt und einem Bereich zugeordnet werden sollen. Dies kann im selben Aufruf mit vorhandenen Assets kombiniert werden. |
existingAssets[] |
Die Ressourcennamen vorhandener Assets, die an einen Bereich angehängt werden sollen. Dies kann im selben Aufruf mit newAssets kombiniert werden. |
scope |
Erforderlich. Umfang, in dem 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 angehängten 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.
JSON-Darstellung |
---|
{
"adAssetApplyParameters": {
object ( |
Felder | |
---|---|
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 ( |
Felder | |
---|---|
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 |
Erforderlich. Ziel, auf das der CPA-Multiplikator gesetzt werden soll. Dies ist ein Pflichtfeld. |
LowerTargetRoasParameters
Parameter, die beim Anwenden von Empfehlungen für einen niedrigeren Ziel-ROAS verwendet werden.
JSON-Darstellung |
---|
{ "targetRoasMultiplier": number } |
Felder | |
---|---|
targetRoasMultiplier |
Erforderlich. Ziel, auf das der ROAS-Multiplikator festgelegt werden soll. Dies ist ein Pflichtfeld. |
ForecastingSetTargetCpaParameters
Parameter, die beim Anwenden einer Empfehlung für einen festgelegten Ziel-CPA verwendet werden.
JSON-Darstellung |
---|
{ "targetCpaMicros": string, "campaignBudgetAmountMicros": string } |
Felder | |
---|---|
targetCpaMicros |
Durchschnittlicher CPA für die Gebotsstrategie „Ziel-CPA“. |
campaignBudgetAmountMicros |
Neues Kampagnenbudget, das für eine Kampagnenressource festgelegt werden soll. |
ApplyRecommendationResult
Das Ergebnis der Anwendung einer Empfehlung.
JSON-Darstellung |
---|
{ "resourceName": string } |
Felder | |
---|---|
resourceName |
Zurückgegeben, wenn der Antrag erfolgreich gestellt wurde. |