Freigeben über

AddConversionGoals-Dienstvorgang – Kampagnenverwaltung

  • Artikel

Fügt der Bibliothek für gemeinsame Konvertierungsziele des Kontos neue Konvertierungsziele hinzu.

Wichtig

Jedes Mal, wenn Sie ein neues DurationGoal-, EventGoal-, OfflineConversionGoal-, PagesViewedPerVisitGoal - oder UrlGoal-Objekt über die Microsoft Advertising-Webanwendung oder die Kampagnenverwaltungs-API hinzufügen oder aktualisieren, wird der MSCLKIDAutoTaggingEnabled-Wert der entsprechenden AccountProperty automatisch auf True festgelegt. Wenn der Bereich des Ziels auf Kundenebene festgelegt ist, wird die AccountProperty für alle Konten unter dem Kunden festgelegt.

Hinweis

Um ein erweitertes Konvertierungsziel zu erstellen und festzulegen isEnhancedConversionsEnabled=true, müssen Sie über die Microsoft Advertising-Benutzeroberfläche ein Konvertierungsziel für das Konto erstellen, wobei die Einstellung für die erweiterte Konvertierung ausgewählt und das zugehörige Kontrollkästchen aktiviert ist.

Tipp

Eine Übersicht über die Implementierung finden Sie im technischen Leitfaden zur universellen Ereignisnachverfolgung .

Anfordern von Elementen

Das AddConversionGoalsRequest-Objekt definiert den Text und die Headerelemente der Dienstvorgangsanforderung. Die Elemente müssen in der gleichen Reihenfolge wie im Anforderungs-SOAP dargestellt sein.

Hinweis

Sofern unten nicht anders angegeben, sind alle Anforderungselemente erforderlich.

Anforderungstextelemente

Element Beschreibung Datentyp
ConversionGoals Die Liste der Konvertierungsziele, die der Freigegebenen Konvertierungszielbibliothek des Kontos hinzugefügt werden sollen.

Sie können pro Serviceanfrage maximal 100 Konvertierungsziele hinzufügen.

Das Konto wird durch das erforderliche CustomerAccountId-Headerelement bestimmt.		 ConversionGoal-Array

Anforderungsheaderelemente

Element Beschreibung Datentyp
AuthenticationToken Das OAuth-Zugriffstoken, das die Anmeldeinformationen eines Benutzers darstellt, der über Berechtigungen für Microsoft Advertising-Konten verfügt.

Weitere Informationen finden Sie unter Authentifizierung mit OAuth.		 Zeichenfolge
CustomerAccountId Der Bezeichner des Anzeigenkontos, das die Entitäten in der Anforderung besitzt oder zugeordnet ist. Dieses Headerelement muss denselben Wert wie das AccountId-Body-Element aufweisen, wenn beides erforderlich ist. Dieses Element ist für die meisten Dienstvorgänge erforderlich, und als bewährte Methode sollten Sie es immer festlegen.

Weitere Informationen finden Sie unter Abrufen Von Konto- und Kunden-IDs.		 Zeichenfolge
CustomerId Der Bezeichner des Vorgesetztenkontos (Kunde), auf das der Benutzer zugreift oder von dort aus arbeitet. Ein Benutzer kann Zugriff auf mehrere Managerkonten haben. Dieses Element ist für die meisten Dienstvorgänge erforderlich, und als bewährte Methode sollten Sie es immer festlegen.

Weitere Informationen finden Sie unter Abrufen Von Konto- und Kunden-IDs.		 Zeichenfolge
DeveloperToken Das Entwicklertoken, das für den Zugriff auf die Bing Ads-API verwendet wird.

Weitere Informationen finden Sie unter Abrufen eines Entwicklertokens.		 Zeichenfolge
Kennwort Dieses Element ist für die interne Verwendung reserviert und wird aus einer zukünftigen Version der API entfernt. Sie müssen das AuthenticationToken-Element verwenden, um Benutzeranmeldeinformationen festzulegen. Zeichenfolge
UserName Dieses Element ist für die interne Verwendung reserviert und wird aus einer zukünftigen Version der API entfernt. Sie müssen das AuthenticationToken-Element verwenden, um Benutzeranmeldeinformationen festzulegen. Zeichenfolge

Antwortelemente

Das AddConversionGoalsResponse-Objekt definiert den Text und die Headerelemente der Dienstvorgangsantwort. Die Elemente werden in der gleichen Reihenfolge zurückgegeben, in der die Antwort-SOAP gezeigt wird.

Antworttextelemente

Element Beschreibung Datentyp
ConversionGoalIds Eine Liste eindeutiger Systembezeichner, die den hinzugefügten Konvertierungszielen entsprechen.

Die Liste der Bezeichner entspricht direkt der Liste der Konvertierungsziele in der Anforderung. Elemente der Liste können als NULL zurückgegeben werden. Für jeden Listenindex, bei dem kein Konvertierungsziel hinzugefügt wurde, ist das entsprechende Element NULL.		 langes Array
PartialErrors Ein Array von BatchError-Objekten , die Details für alle Anforderungselemente enthalten, die nicht erfolgreich waren.

Die Liste der Fehler entspricht nicht direkt der Liste der Elemente in der Anforderung. Die Liste kann leer sein, wenn keine Fehler aufgetreten sind, oder ein oder mehrere Fehlerobjekte enthalten, die jedem nicht erfolgreichen Listenelement in der Anforderung entsprechen.		 BatchError-Array

Antwortheaderelemente

Element Beschreibung Datentyp
TrackingId Der Bezeichner des Protokolleintrags, der die Details des API-Aufrufs enthält. Zeichenfolge

SOAP anfordern

Diese Vorlage wurde von einem Tool generiert, um die Reihenfolge der Text- und Headerelemente für die SOAP-Anforderung anzuzeigen. Informationen zu unterstützten Typen, die Sie mit diesem Dienstvorgang verwenden können, finden Sie oben in der Referenz zu Anforderungstextelementen .

<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
    <Action mustUnderstand="1">AddConversionGoals</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <CustomerAccountId i:nil="false">ValueHere</CustomerAccountId>
    <CustomerId i:nil="false">ValueHere</CustomerId>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <AddConversionGoalsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <ConversionGoals i:nil="false">
        <ConversionGoal i:type="-- derived type specified here with the appropriate prefix --">
          <AttributionModelType i:nil="false">ValueHere</AttributionModelType>
          <ConversionWindowInMinutes i:nil="false">ValueHere</ConversionWindowInMinutes>
          <CountType i:nil="false">ValueHere</CountType>
          <ExcludeFromBidding i:nil="false">ValueHere</ExcludeFromBidding>
          <GoalCategory i:nil="false">ValueHere</GoalCategory>
          <Id i:nil="false">ValueHere</Id>
          <IsEnhancedConversionsEnabled i:nil="false">ValueHere</IsEnhancedConversionsEnabled>
          <Name i:nil="false">ValueHere</Name>
          <Revenue i:nil="false">
            <CurrencyCode i:nil="false">ValueHere</CurrencyCode>
            <Type i:nil="false">ValueHere</Type>
            <Value i:nil="false">ValueHere</Value>
          </Revenue>
          <Scope i:nil="false">ValueHere</Scope>
          <Status i:nil="false">ValueHere</Status>
          <TagId i:nil="false">ValueHere</TagId>
          <TrackingStatus i:nil="false">ValueHere</TrackingStatus>
          <Type i:nil="false">ValueHere</Type>
          <ViewThroughConversionWindowInMinutes i:nil="false">ValueHere</ViewThroughConversionWindowInMinutes>
          <!--These fields are applicable if the derived type attribute is set to UrlGoal-->
          <UrlExpression i:nil="false">ValueHere</UrlExpression>
          <UrlOperator i:nil="false">ValueHere</UrlOperator>
          <!--This field is applicable if the derived type attribute is set to DurationGoal-->
          <MinimumDurationInSeconds i:nil="false">ValueHere</MinimumDurationInSeconds>
          <!--This field is applicable if the derived type attribute is set to PagesViewedPerVisitGoal-->
          <MinimumPagesViewed i:nil="false">ValueHere</MinimumPagesViewed>
          <!--These fields are applicable if the derived type attribute is set to EventGoal-->
          <ActionExpression i:nil="false">ValueHere</ActionExpression>
          <ActionOperator i:nil="false">ValueHere</ActionOperator>
          <CategoryExpression i:nil="false">ValueHere</CategoryExpression>
          <CategoryOperator i:nil="false">ValueHere</CategoryOperator>
          <LabelExpression i:nil="false">ValueHere</LabelExpression>
          <LabelOperator i:nil="false">ValueHere</LabelOperator>
          <Value i:nil="false">ValueHere</Value>
          <ValueOperator i:nil="false">ValueHere</ValueOperator>
          <!--These fields are applicable if the derived type attribute is set to AppInstallGoal-->
          <AppPlatform i:nil="false">ValueHere</AppPlatform>
          <AppStoreId i:nil="false">ValueHere</AppStoreId>
          <!--This field is applicable if the derived type attribute is set to OfflineConversionGoal-->
          <IsExternallyAttributed i:nil="false">ValueHere</IsExternallyAttributed>
          <!--No additional fields are applicable if the derived type attribute is set to InStoreTransactionGoal-->
        </ConversionGoal>
      </ConversionGoals>
    </AddConversionGoalsRequest>
  </s:Body>
</s:Envelope>

Antwort-SOAP

Diese Vorlage wurde von einem Tool generiert, um die Reihenfolge der Text- und Headerelemente für die SOAP-Antwort anzuzeigen.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <AddConversionGoalsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <ConversionGoalIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <a1:long>ValueHere</a1:long>
      </ConversionGoalIds>
      <PartialErrors d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <BatchError d4p1:type="-- derived type specified here with the appropriate prefix --">
          <Code>ValueHere</Code>
          <Details d4p1:nil="false">ValueHere</Details>
          <ErrorCode d4p1:nil="false">ValueHere</ErrorCode>
          <FieldPath d4p1:nil="false">ValueHere</FieldPath>
          <ForwardCompatibilityMap xmlns:e237="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e237:KeyValuePairOfstringstring>
              <e237:key d4p1:nil="false">ValueHere</e237:key>
              <e237:value d4p1:nil="false">ValueHere</e237:value>
            </e237:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Index>ValueHere</Index>
          <Message d4p1:nil="false">ValueHere</Message>
          <Type d4p1:nil="false">ValueHere</Type>
          <!--These fields are applicable if the derived type attribute is set to EditorialError-->
          <Appealable d4p1:nil="false">ValueHere</Appealable>
          <DisapprovedText d4p1:nil="false">ValueHere</DisapprovedText>
          <Location d4p1:nil="false">ValueHere</Location>
          <PublisherCountry d4p1:nil="false">ValueHere</PublisherCountry>
          <ReasonCode>ValueHere</ReasonCode>
        </BatchError>
      </PartialErrors>
    </AddConversionGoalsResponse>
  </s:Body>
</s:Envelope>

Codesyntax

Die Beispielsyntax kann mit Bing Ads SDKs verwendet werden. Weitere Beispiele finden Sie unter Codebeispiele für die Bing Ads-API .

public async Task<AddConversionGoalsResponse> AddConversionGoalsAsync(
	IList<ConversionGoal> conversionGoals)
{
	var request = new AddConversionGoalsRequest
	{
		ConversionGoals = conversionGoals
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.AddConversionGoalsAsync(r), request));
}

static AddConversionGoalsResponse addConversionGoals(
	ArrayOfConversionGoal conversionGoals) throws RemoteException, Exception
{
	AddConversionGoalsRequest request = new AddConversionGoalsRequest();

	request.setConversionGoals(conversionGoals);

	return CampaignManagementService.getService().addConversionGoals(request);
}

static function AddConversionGoals(
	$conversionGoals)
{

	$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];

	$request = new AddConversionGoalsRequest();

	$request->ConversionGoals = $conversionGoals;

	return $GLOBALS['CampaignManagementProxy']->GetService()->AddConversionGoals($request);
}

response=campaignmanagement_service.AddConversionGoals(
	ConversionGoals=ConversionGoals)

Anforderungen

Dienst: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13

Anforderungs-URL

https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/ConversionGoals

Anfordern von Elementen

Das AddConversionGoalsRequest-Objekt definiert den Text und die Headerelemente der Dienstvorgangsanforderung.

Hinweis

Sofern unten nicht anders angegeben, sind alle Anforderungselemente erforderlich.

Anforderungstextelemente

Element Beschreibung Datentyp
ConversionGoals Die Liste der Konvertierungsziele, die der Freigegebenen Konvertierungszielbibliothek des Kontos hinzugefügt werden sollen.

Sie können pro Serviceanfrage maximal 100 Konvertierungsziele hinzufügen.

Das Konto wird durch das erforderliche CustomerAccountId-Headerelement bestimmt.		 ConversionGoal-Array

Anforderungsheaderelemente

Element Beschreibung Datentyp
Authorization Das OAuth-Zugriffstoken, das die Anmeldeinformationen eines Benutzers darstellt, der über Berechtigungen für Microsoft Advertising-Konten verfügt. Stellen Sie sicher, dass dem Token das Präfix "Bearer" vorangestellt ist. Dies ist für die ordnungsgemäße Authentifizierung erforderlich.

Weitere Informationen finden Sie unter Authentifizierung mit OAuth.		 Zeichenfolge
CustomerAccountId Der Bezeichner des Anzeigenkontos, das die Entitäten in der Anforderung besitzt oder zugeordnet ist. Dieses Headerelement muss denselben Wert wie das AccountId-Body-Element aufweisen, wenn beides erforderlich ist. Dieses Element ist für die meisten Dienstvorgänge erforderlich, und als bewährte Methode sollten Sie es immer festlegen.

Weitere Informationen finden Sie unter Abrufen Von Konto- und Kunden-IDs.		 Zeichenfolge
CustomerId Der Bezeichner des Vorgesetztenkontos (Kunde), auf das der Benutzer zugreift oder von dort aus arbeitet. Ein Benutzer kann Zugriff auf mehrere Managerkonten haben. Dieses Element ist für die meisten Dienstvorgänge erforderlich, und als bewährte Methode sollten Sie es immer festlegen.

Weitere Informationen finden Sie unter Abrufen Von Konto- und Kunden-IDs.		 Zeichenfolge
DeveloperToken Das Entwicklertoken, das für den Zugriff auf die Bing Ads-API verwendet wird.

Weitere Informationen finden Sie unter Abrufen eines Entwicklertokens.		 Zeichenfolge
Kennwort Dieses Element ist für die interne Verwendung reserviert und wird aus einer zukünftigen Version der API entfernt. Sie müssen das AuthenticationToken-Element verwenden, um Benutzeranmeldeinformationen festzulegen. Zeichenfolge
UserName Dieses Element ist für die interne Verwendung reserviert und wird aus einer zukünftigen Version der API entfernt. Sie müssen das AuthenticationToken-Element verwenden, um Benutzeranmeldeinformationen festzulegen. Zeichenfolge

Antwortelemente

Das AddConversionGoalsResponse-Objekt definiert den Text und die Headerelemente der Dienstvorgangsantwort. Die Elemente werden in der gleichen Reihenfolge zurückgegeben wie im Antwort-JSON-Code gezeigt.

Antworttextelemente

Element Beschreibung Datentyp
ConversionGoalIds Eine Liste eindeutiger Systembezeichner, die den hinzugefügten Konvertierungszielen entsprechen.

Die Liste der Bezeichner entspricht direkt der Liste der Konvertierungsziele in der Anforderung. Elemente der Liste können als NULL zurückgegeben werden. Für jeden Listenindex, bei dem kein Konvertierungsziel hinzugefügt wurde, ist das entsprechende Element NULL.		 langes Array
PartialErrors Ein Array von BatchError-Objekten , die Details für alle Anforderungselemente enthalten, die nicht erfolgreich waren.

Die Liste der Fehler entspricht nicht direkt der Liste der Elemente in der Anforderung. Die Liste kann leer sein, wenn keine Fehler aufgetreten sind, oder ein oder mehrere Fehlerobjekte enthalten, die jedem nicht erfolgreichen Listenelement in der Anforderung entsprechen.		 BatchError-Array

Antwortheaderelemente

Element Beschreibung Datentyp
TrackingId Der Bezeichner des Protokolleintrags, der die Details des API-Aufrufs enthält. Zeichenfolge

JSON anfordern

Diese Vorlage wurde von einem Tool generiert, um die Text- und Headerelemente für die JSON-Anforderung anzuzeigen. Informationen zu unterstützten Typen, die Sie mit diesem Dienstvorgang verwenden können, finden Sie oben in der Referenz zu Anforderungstextelementen .

Im Folgenden finden Sie ein Beispiel, das anwendbar ist, wenn der Typ von ConversionGoalAppInstallGoal ist.

{
  "ConversionGoals": [
    {
      "AttributionModelType": "ValueHere",
      "ConversionWindowInMinutes": IntValueHere,
      "CountType": "ValueHere",
      "ExcludeFromBidding": "ValueHere",
      "GoalCategory": "ValueHere",
      "Id": "LongValueHere",
      "IsEnhancedConversionsEnabled": "ValueHere",
      "Name": "ValueHere",
      "Revenue": {
        "CurrencyCode": "ValueHere",
        "Type": "ValueHere",
        "Value": DecimalValueHere
      },
      "Scope": "ValueHere",
      "Status": "ValueHere",
      "TagId": "LongValueHere",
      "TrackingStatus": "ValueHere",
      "Type": "AppInstall",
      "ViewThroughConversionWindowInMinutes": IntValueHere,
      "AppPlatform": "ValueHere",
      "AppStoreId": "ValueHere"
    }
  ]
}

Antwort-JSON

Diese Vorlage wurde von einem Tool generiert, um die Text- und Headerelemente für die JSON-Antwort anzuzeigen.

Im Folgenden finden Sie ein Beispiel, das anwendbar ist, wenn der Typ von BatchErrorEditorialError ist.

{
  "ConversionGoalIds": [
    "LongValueHere"
  ],
  "PartialErrors": [
    {
      "Code": IntValueHere,
      "Details": "ValueHere",
      "ErrorCode": "ValueHere",
      "FieldPath": "ValueHere",
      "ForwardCompatibilityMap": [
        {
          "key": "ValueHere",
          "value": "ValueHere"
        }
      ],
      "Index": IntValueHere,
      "Message": "ValueHere",
      "Type": "EditorialError",
      "Appealable": "ValueHere",
      "DisapprovedText": "ValueHere",
      "Location": "ValueHere",
      "PublisherCountry": "ValueHere",
      "ReasonCode": IntValueHere
    }
  ]
}

Codesyntax

Um die REST-API über SDKs aufzurufen, müssen Sie das SDK auf eine bestimmte Version aktualisieren und die Systemparameter konfigurieren. Die Beispielsyntax kann mit Bing Ads SDKs verwendet werden. Weitere Beispiele finden Sie unter Codebeispiele für die Bing Ads-API .

public async Task<AddConversionGoalsResponse> AddConversionGoalsAsync(
	IList<ConversionGoal> conversionGoals)
{
	var request = new AddConversionGoalsRequest
	{
		ConversionGoals = conversionGoals
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.AddConversionGoalsAsync(r), request));
}

static AddConversionGoalsResponse addConversionGoals(
	ArrayOfConversionGoal conversionGoals) throws RemoteException, Exception
{
	AddConversionGoalsRequest request = new AddConversionGoalsRequest();

	request.setConversionGoals(conversionGoals);

	return CampaignManagementService.getService().addConversionGoals(request);
}

static function AddConversionGoals(
	$conversionGoals)
{

	$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];

	$request = new AddConversionGoalsRequest();

	$request->ConversionGoals = $conversionGoals;

	return $GLOBALS['CampaignManagementProxy']->GetService()->AddConversionGoals($request);
}

response=campaignmanagement_service.AddConversionGoals(
	ConversionGoals=ConversionGoals)