Freigeben über

GetConversionGoalsByIds-Dienstvorgang – Kampagnenverwaltung

  • Artikel

Ruft die angegebenen Konvertierungsziele ab.

Tipp

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

Anfordern von Elementen

Das GetConversionGoalsByIdsRequest-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
ConversionGoalIds Maximal 100 Bezeichner der Konvertierungsziele, die Sie abrufen möchten.

Wenn ConversionGoalIds NULL oder leer ist, fordern Sie effektiv alle Konvertierungsziele der angegebenen Typen für das Konto an.		 langes Array
ConversionGoalTypes Der Typ der zurückzugebenden Konvertierungsziele.

Sie können mehrere Werte als Flags einschließen. Wie Sie mehrere Flags angeben, hängt von der programmiersprache ab, die Sie verwenden. C# behandelt diese Werte beispielsweise als Flagwerte, und Java behandelt sie als Array von Zeichenfolgen. Das SOAP sollte eine Zeichenfolge enthalten, die eine durch Leerzeichen getrennte Liste von Werten enthält, <ConversionGoalTypes>Url Duration</ConversionGoalTypes>z. B. .		 ConversionGoalType
ReturnAdditionalFields Die Liste der zusätzlichen Eigenschaften, die in jedes zurückgegebene Konvertierungsziel eingeschlossen werden sollen. Mit den zusätzlichen Feldwerten können Sie die neuesten Features mithilfe der aktuellen Version der Kampagnenverwaltungs-API abrufen, und in der nächsten Version sind die entsprechenden Elemente standardmäßig enthalten.

Dieses Anforderungselement ist optional.		 ConversionGoalAdditionalField

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 GetConversionGoalsByIdsResponse-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
ConversionGoals Ein Array von ConversionGoal-Objekten , das direkt den Konvertierungszielbezeichnern entspricht, die Sie in der Anforderung angegeben haben. Elemente des Arrays können als NULL zurückgegeben werden. Für jeden Arrayindex, in dem kein Konvertierungsziel abgerufen wurde, ist das entsprechende Element NULL. ConversionGoal-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">GetConversionGoalsByIds</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>
    <GetConversionGoalsByIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <ConversionGoalIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </ConversionGoalIds>
      <ConversionGoalTypes>ValueHere</ConversionGoalTypes>
      <ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
    </GetConversionGoalsByIdsRequest>
  </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>
    <GetConversionGoalsByIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <ConversionGoals d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <ConversionGoal d4p1:type="-- derived type specified here with the appropriate prefix --">
          <AttributionModelType d4p1:nil="false">ValueHere</AttributionModelType>
          <ConversionWindowInMinutes d4p1:nil="false">ValueHere</ConversionWindowInMinutes>
          <CountType d4p1:nil="false">ValueHere</CountType>
          <ExcludeFromBidding d4p1:nil="false">ValueHere</ExcludeFromBidding>
          <GoalCategory d4p1:nil="false">ValueHere</GoalCategory>
          <Id d4p1:nil="false">ValueHere</Id>
          <IsEnhancedConversionsEnabled d4p1:nil="false">ValueHere</IsEnhancedConversionsEnabled>
          <Name d4p1:nil="false">ValueHere</Name>
          <Revenue d4p1:nil="false">
            <CurrencyCode d4p1:nil="false">ValueHere</CurrencyCode>
            <Type d4p1:nil="false">ValueHere</Type>
            <Value d4p1:nil="false">ValueHere</Value>
          </Revenue>
          <Scope d4p1:nil="false">ValueHere</Scope>
          <Status d4p1:nil="false">ValueHere</Status>
          <TagId d4p1:nil="false">ValueHere</TagId>
          <TrackingStatus d4p1:nil="false">ValueHere</TrackingStatus>
          <Type d4p1:nil="false">ValueHere</Type>
          <ViewThroughConversionWindowInMinutes d4p1:nil="false">ValueHere</ViewThroughConversionWindowInMinutes>
          <!--These fields are applicable if the derived type attribute is set to UrlGoal-->
          <UrlExpression d4p1:nil="false">ValueHere</UrlExpression>
          <UrlOperator d4p1:nil="false">ValueHere</UrlOperator>
          <!--This field is applicable if the derived type attribute is set to DurationGoal-->
          <MinimumDurationInSeconds d4p1:nil="false">ValueHere</MinimumDurationInSeconds>
          <!--This field is applicable if the derived type attribute is set to PagesViewedPerVisitGoal-->
          <MinimumPagesViewed d4p1:nil="false">ValueHere</MinimumPagesViewed>
          <!--These fields are applicable if the derived type attribute is set to EventGoal-->
          <ActionExpression d4p1:nil="false">ValueHere</ActionExpression>
          <ActionOperator d4p1:nil="false">ValueHere</ActionOperator>
          <CategoryExpression d4p1:nil="false">ValueHere</CategoryExpression>
          <CategoryOperator d4p1:nil="false">ValueHere</CategoryOperator>
          <LabelExpression d4p1:nil="false">ValueHere</LabelExpression>
          <LabelOperator d4p1:nil="false">ValueHere</LabelOperator>
          <Value d4p1:nil="false">ValueHere</Value>
          <ValueOperator d4p1:nil="false">ValueHere</ValueOperator>
          <!--These fields are applicable if the derived type attribute is set to AppInstallGoal-->
          <AppPlatform d4p1:nil="false">ValueHere</AppPlatform>
          <AppStoreId d4p1:nil="false">ValueHere</AppStoreId>
          <!--This field is applicable if the derived type attribute is set to OfflineConversionGoal-->
          <IsExternallyAttributed d4p1:nil="false">ValueHere</IsExternallyAttributed>
          <!--No additional fields are applicable if the derived type attribute is set to InStoreTransactionGoal-->
        </ConversionGoal>
      </ConversionGoals>
      <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:e139="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e139:KeyValuePairOfstringstring>
              <e139:key d4p1:nil="false">ValueHere</e139:key>
              <e139:value d4p1:nil="false">ValueHere</e139:value>
            </e139: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>
    </GetConversionGoalsByIdsResponse>
  </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<GetConversionGoalsByIdsResponse> GetConversionGoalsByIdsAsync(
	IList<long> conversionGoalIds,
	ConversionGoalType conversionGoalTypes,
	ConversionGoalAdditionalField? returnAdditionalFields)
{
	var request = new GetConversionGoalsByIdsRequest
	{
		ConversionGoalIds = conversionGoalIds,
		ConversionGoalTypes = conversionGoalTypes,
		ReturnAdditionalFields = returnAdditionalFields
	};

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

static GetConversionGoalsByIdsResponse getConversionGoalsByIds(
	ArrayOflong conversionGoalIds,
	ArrayList<ConversionGoalType> conversionGoalTypes,
	ArrayList<ConversionGoalAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
	GetConversionGoalsByIdsRequest request = new GetConversionGoalsByIdsRequest();

	request.setConversionGoalIds(conversionGoalIds);
	request.setConversionGoalTypes(conversionGoalTypes);
	request.setReturnAdditionalFields(returnAdditionalFields);

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

static function GetConversionGoalsByIds(
	$conversionGoalIds,
	$conversionGoalTypes,
	$returnAdditionalFields)
{

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

	$request = new GetConversionGoalsByIdsRequest();

	$request->ConversionGoalIds = $conversionGoalIds;
	$request->ConversionGoalTypes = $conversionGoalTypes;
	$request->ReturnAdditionalFields = $returnAdditionalFields;

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

response=campaignmanagement_service.GetConversionGoalsByIds(
	ConversionGoalIds=ConversionGoalIds,
	ConversionGoalTypes=ConversionGoalTypes,
	ReturnAdditionalFields=ReturnAdditionalFields)

Anforderungen

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