Condividi tramite


Operazione del servizio GetConversionGoalsByIds - Gestione campagna

Ottiene gli obiettivi di conversione specificati.

Consiglio

Per una panoramica dell'implementazione, vedere la guida tecnica di Universal Event Tracking .

Elementi della richiesta

L'oggetto GetConversionGoalsByIdsRequest definisce il corpo e gli elementi di intestazione della richiesta di operazione del servizio. Gli elementi devono essere nello stesso ordine indicato nella richiesta SOAP.

Nota

Se non diversamente indicato di seguito, sono necessari tutti gli elementi della richiesta.

Elementi del corpo della richiesta

Elemento Descrizione Tipo di dati
ConversionGoalIds Un massimo di 100 identificatori degli obiettivi di conversione che si desidera ottenere.

Se ConversionGoalIds è null o vuoto, si richiede effettivamente tutti gli obiettivi di conversione dei tipi specificati per l'account.
matrice long
ConversionGoalTypes Tipo di obiettivi di conversione da restituire.

È possibile includere più valori come flag. Il modo in cui si specificano più flag dipende dal linguaggio di programmazione usato. Ad esempio, C# considera questi valori come valori flag e Java li considera come una matrice di stringhe. Soap deve includere una stringa che contiene un elenco di valori delimitato da spazi, <ConversionGoalTypes>Url Duration</ConversionGoalTypes>ad esempio .
ConversionGoalType
ReturnAdditionalFields Elenco di proprietà aggiuntive da includere all'interno di ogni obiettivo di conversione restituito. I valori di campo aggiuntivi consentono di ottenere le funzionalità più recenti usando la versione corrente dell'API Campaign Management e nella versione successiva gli elementi corrispondenti verranno inclusi per impostazione predefinita.

Questo elemento della richiesta è facoltativo.
ConversionGoalAdditionalField

Elementi dell'intestazione della richiesta

Elemento Descrizione Tipo di dati
AuthenticationToken Token di accesso OAuth che rappresenta le credenziali di un utente che dispone delle autorizzazioni per gli account Microsoft Advertising.

Per altre informazioni, vedere Autenticazione con OAuth.
Stringa
CustomerAccountId Identificatore dell'account pubblicitario proprietario o associato alle entità nella richiesta. Questo elemento di intestazione deve avere lo stesso valore dell'elemento del corpo AccountId quando sono necessari entrambi. Questo elemento è necessario per la maggior parte delle operazioni del servizio e, come procedura consigliata, è consigliabile impostarlo sempre.

Per altre informazioni, vedere Ottenere l'account e gli ID cliente.
Stringa
Customerid Identificatore dell'account manager (cliente) da cui l'utente accede o opera. Un utente può avere accesso a più account manager. Questo elemento è necessario per la maggior parte delle operazioni del servizio e, come procedura consigliata, è consigliabile impostarlo sempre.

Per altre informazioni, vedere Ottenere l'account e gli ID cliente.
Stringa
DeveloperToken Token di sviluppo usato per accedere all'API Bing Ads.

Per altre informazioni, vedere Ottenere un token per sviluppatori.
Stringa
Password Questo elemento è riservato per l'uso interno e verrà rimosso da una versione futura dell'API. È necessario usare l'elemento AuthenticationToken per impostare le credenziali utente. Stringa
UserName Questo elemento è riservato per l'uso interno e verrà rimosso da una versione futura dell'API. È necessario usare l'elemento AuthenticationToken per impostare le credenziali utente. Stringa

Elementi di risposta

L'oggetto GetConversionGoalsByIdsResponse definisce gli elementi corpo e intestazione della risposta dell'operazione del servizio. Gli elementi vengono restituiti nello stesso ordine illustrato nella soap di risposta.

Elementi del corpo della risposta

Elemento Descrizione Tipo di dati
ConversionGoals Matrice di oggetti ConversionGoal che corrisponde direttamente agli identificatori dell'obiettivo di conversione specificati nella richiesta. Gli elementi della matrice possono essere restituiti come Null. Per ogni indice di matrice in cui non è stato recuperato un obiettivo di conversione, l'elemento corrispondente sarà Null. Matrice ConversionGoal
PartialErrors Matrice di oggetti BatchError che contengono i dettagli per gli elementi della richiesta che non hanno avuto esito positivo.

L'elenco di errori non corrisponde direttamente all'elenco di elementi nella richiesta. L'elenco può essere vuoto se non si sono verificati errori o può includere uno o più oggetti errore corrispondenti a ogni voce di elenco non riuscita nella richiesta.
Matrice BatchError

Elementi dell'intestazione della risposta

Elemento Descrizione Tipo di dati
TrackingId Identificatore della voce di log che contiene i dettagli della chiamata API. Stringa

Richiedi SOAP

Questo modello è stato generato da uno strumento per visualizzare l'ordine degli elementi corpo e intestazione per la richiesta SOAP. Per i tipi supportati che è possibile usare con questa operazione del servizio, vedere il riferimento Request Body Elements sopra riportato.

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

SOAP della risposta

Questo modello è stato generato da uno strumento per visualizzare l'ordine degli elementi del corpo e dell'intestazione per la risposta SOAP.

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

Sintassi del codice

La sintassi di esempio può essere usata con gli SDK di Bing Ads. Per altri esempi, vedere Esempi di codice DELL'API Bing Ads .

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)

Requisiti

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