Method: customers.recommendations.apply

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/v14/customers/{customerId}/recommendations:apply

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
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. Wenn partialFailure=false, sollten alle Empfehlungen vom gleichen Typ sein. Pro Anfrage sind maximal 100 Vorgänge zulässig.
partialFailure

boolean

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 (ApplyRecommendationResult)
    }
  ],
  "partialFailureError": {
    object (Status)
  }
}
Felder
results[]

object (ApplyRecommendationResult)

Ergebnisse der angewendeten Empfehlungen
partialFailureError

object (Status)

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 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.
}
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 zum Anwenden einer Keyword-Empfehlung.
targetCpaOptIn

object (TargetCpaOptInParameters)

Optionale Parameter, die beim Anwenden einer Empfehlung zur Aktivierung des Ziel-CPA verwendet werden.
targetRoasOptIn

object (TargetRoasOptInParameters)

Optionale Parameter, die beim Anwenden einer Empfehlung zur Aktivierung des Ziel-ROAS verwendet werden.
calloutExtension

object (CalloutExtensionParameters)

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

object (CallExtensionParameters)

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

object (MoveUnusedBudgetParameters)

Parameter, die verwendet werden, wenn eine Empfehlung zum Verschieben nicht aufgebrauchter Budgets angewendet wird.
responsiveSearchAd

object (ResponsiveSearchAdParameters)

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

object (UseBroadMatchKeywordParameters)

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

object (ResponsiveSearchAdAssetParameters)

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

object (ResponsiveSearchAdImproveAdStrengthParameters)

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

object (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.
forecastingSetTargetRoas

object (ForecastingSetTargetRoasParameters)

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

object (CalloutAssetParameters)

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

object (CallAssetParameters)

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

object (RaiseTargetCpaParameters)

Parameter, die beim Anwenden einer Empfehlung für die Ziel-CPA-Erhöhung verwendet werden.
lowerTargetRoas

object (LowerTargetRoasParameters)

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

CampaignBudgetParameters

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

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.

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.

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

enum (KeywordMatchType)

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

string

Die Ressource der Anzeigengruppe, 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 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

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 Empfehlung zur Aktivierung des Ziel-ROAS verwendet werden.

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

number

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

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.

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.

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.

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

MoveUnusedBudgetParameters

Parameter, die verwendet werden, wenn eine Empfehlung zum Verschieben nicht aufgebrauchter Budgets angewendet wird.

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

string (int64 format)

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 (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.

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.

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

object (Ad)

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 (Ad)
  }
}
Felder
updatedAd

object (Ad)

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

number

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

number

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

string (int64 format)

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 (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 im selben Aufruf mit vorhandenen Assets 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. 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 (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 für einen niedrigeren Ziel-ROAS verwendet werden.

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

number

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

ApplyRecommendationResult

Das Ergebnis der Anwendung einer Empfehlung.

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

string

Zurückgegeben, wenn der Antrag erfolgreich gestellt wurde.