Compartir a través de

Operación del servicio GetConversionGoalsByIds: Administración de campañas

  • Artículo

Obtiene los objetivos de conversión especificados.

Sugerencia

Para obtener información general sobre la implementación, consulte la guía técnica de Seguimiento universal de eventos .

Elementos Request

El objeto GetConversionGoalsByIdsRequest define los elementos body y header de la solicitud de operación de servicio. Los elementos deben estar en el mismo orden que se muestra en la solicitud SOAP.

Nota:

A menos que se indique lo contrario a continuación, se requieren todos los elementos de solicitud.

Elementos del cuerpo de la solicitud

Elemento Descripción Tipo de datos
ConversionGoalIds Un máximo de 100 identificadores de los objetivos de conversión que desea obtener.

Si ConversionGoalIds es null o está vacío, se solicitan eficazmente todos los objetivos de conversión de los tipos especificados para la cuenta.		 matriz larga
ConversionGoalTypes Tipo de objetivos de conversión que se van a devolver.

Puede incluir varios valores como marcas. La forma de especificar varias marcas depende del lenguaje de programación que use. Por ejemplo, C# trata estos valores como valores de marca y Java los trata como una matriz de cadenas. SOAP debe incluir una cadena que contenga una lista delimitada por espacios de valores, por ejemplo, <ConversionGoalTypes>Url Duration</ConversionGoalTypes>.		 ConversionGoalType
ReturnAdditionalFields Lista de propiedades adicionales que desea incluir dentro de cada objetivo de conversión devuelto. Los valores de campo adicionales le permiten obtener las características más recientes mediante la versión actual de Campaign Management API y, en la siguiente versión, los elementos correspondientes se incluirán de forma predeterminada.

Este elemento request es opcional.		 ConversionGoalAdditionalField

Elementos de encabezado de solicitud

Elemento Descripción Tipo de datos
AuthenticationToken Token de acceso de OAuth que representa las credenciales de un usuario que tiene permisos para cuentas de Microsoft Advertising.

Para obtener más información, consulte Autenticación con OAuth.		 string
CustomerAccountId Identificador de la cuenta de anuncio que posee o está asociada a las entidades de la solicitud. Este elemento de encabezado debe tener el mismo valor que el elemento de cuerpo AccountId cuando ambos son necesarios. Este elemento es necesario para la mayoría de las operaciones de servicio y, como procedimiento recomendado, siempre debe establecerlo.

Para obtener más información, consulte Obtención de su cuenta e identificadores de cliente.		 string
CustomerId Identificador de la cuenta de administrador (cliente) desde la que el usuario accede o funciona. Un usuario puede tener acceso a varias cuentas de administrador. Este elemento es necesario para la mayoría de las operaciones de servicio y, como procedimiento recomendado, siempre debe establecerlo.

Para obtener más información, consulte Obtención de su cuenta e identificadores de cliente.		 string
DeveloperToken Token de desarrollador que se usa para acceder a Bing Ads API.

Para obtener más información, consulte Obtención de un token de desarrollador.		 string
Password Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. string
UserName Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. string

Elementos de respuesta

El objeto GetConversionGoalsByIdsResponse define los elementos body y header de la respuesta de la operación de servicio. Los elementos se devuelven en el mismo orden que se muestra en soap de respuesta.

Elementos del cuerpo de la respuesta

Elemento Descripción Tipo de datos
ConversionGoals Matriz de objetos ConversionGoal que se corresponde directamente con los identificadores de objetivo de conversión especificados en la solicitud. Los elementos de la matriz pueden devolverse como null. Para cada índice de matriz en el que no se recuperó un objetivo de conversión, el elemento correspondiente será null. ConversionGoal array
PartialErrors Matriz de objetos BatchError que contienen detalles de los elementos de solicitud que no se han realizado correctamente.

La lista de errores no se corresponde directamente con la lista de elementos de la solicitud. La lista puede estar vacía si no hay errores o puede incluir uno o varios objetos de error correspondientes a cada elemento de lista incorrecto en la solicitud.		 Matriz BatchError

Elementos de encabezado de respuesta

Elemento Descripción Tipo de datos
Seguimiento del Id. Identificador de la entrada de registro que contiene los detalles de la llamada API. string

Solicitud de SOAP

Esta plantilla se generó mediante una herramienta para mostrar el orden del cuerpo y los elementos de encabezado de la solicitud SOAP. Para ver los tipos admitidos que puede usar con esta operación de servicio, consulte la referencia de elementos de cuerpo de solicitud anterior.

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

Esta plantilla se generó mediante una herramienta para mostrar el orden de los elementos body y header para la respuesta 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:e295="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e295:KeyValuePairOfstringstring>
              <e295:key d4p1:nil="false">ValueHere</e295:key>
              <e295:value d4p1:nil="false">ValueHere</e295:value>
            </e295: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>

Sintaxis de código

La sintaxis de ejemplo se puede usar con los SDK de Bing Ads. Consulte Ejemplos de código de API de Bing Ads para obtener más ejemplos.

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)

Requisitos

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

Dirección URL de solicitud

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

Elementos Request

El objeto GetConversionGoalsByIdsRequest define los elementos body y header de la solicitud de operación de servicio.

Nota:

A menos que se indique lo contrario a continuación, se requieren todos los elementos de solicitud.

Elementos del cuerpo de la solicitud

Elemento Descripción Tipo de datos
ConversionGoalIds Un máximo de 100 identificadores de los objetivos de conversión que desea obtener.

Si ConversionGoalIds es null o está vacío, se solicitan eficazmente todos los objetivos de conversión de los tipos especificados para la cuenta.		 matriz larga
ConversionGoalTypes Tipo de objetivos de conversión que se van a devolver.

Puede incluir varios valores como marcas. La forma de especificar varias marcas depende del lenguaje de programación que use. Por ejemplo, C# trata estos valores como valores de marca y Java los trata como una matriz de cadenas. SOAP debe incluir una cadena que contenga una lista delimitada por espacios de valores, por ejemplo, <ConversionGoalTypes>Url Duration</ConversionGoalTypes>.		 ConversionGoalType
ReturnAdditionalFields Lista de propiedades adicionales que desea incluir dentro de cada objetivo de conversión devuelto. Los valores de campo adicionales le permiten obtener las características más recientes mediante la versión actual de Campaign Management API y, en la siguiente versión, los elementos correspondientes se incluirán de forma predeterminada.

Este elemento request es opcional.		 ConversionGoalAdditionalField

Elementos de encabezado de solicitud

Elemento Descripción Tipo de datos
Autorización Token de acceso de OAuth que representa las credenciales de un usuario que tiene permisos para cuentas de Microsoft Advertising. Asegúrese de que el token tiene el prefijo "Portador", esto es necesario para la autenticación adecuada.

Para obtener más información, consulte Autenticación con OAuth.		 string
CustomerAccountId Identificador de la cuenta de anuncio que posee o está asociada a las entidades de la solicitud. Este elemento de encabezado debe tener el mismo valor que el elemento de cuerpo AccountId cuando ambos son necesarios. Este elemento es necesario para la mayoría de las operaciones de servicio y, como procedimiento recomendado, siempre debe establecerlo.

Para obtener más información, consulte Obtención de su cuenta e identificadores de cliente.		 string
CustomerId Identificador de la cuenta de administrador (cliente) desde la que el usuario accede o funciona. Un usuario puede tener acceso a varias cuentas de administrador. Este elemento es necesario para la mayoría de las operaciones de servicio y, como procedimiento recomendado, siempre debe establecerlo.

Para obtener más información, consulte Obtención de su cuenta e identificadores de cliente.		 string
DeveloperToken Token de desarrollador que se usa para acceder a Bing Ads API.

Para obtener más información, consulte Obtención de un token de desarrollador.		 string
Password Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. string
UserName Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. string

Elementos de respuesta

El objeto GetConversionGoalsByIdsResponse define los elementos body y header de la respuesta de la operación de servicio. Los elementos se devuelven en el mismo orden que se muestra en el JSON de respuesta.

Elementos del cuerpo de la respuesta

Elemento Descripción Tipo de datos
ConversionGoals Matriz de objetos ConversionGoal que se corresponde directamente con los identificadores de objetivo de conversión especificados en la solicitud. Los elementos de la matriz pueden devolverse como null. Para cada índice de matriz en el que no se recuperó un objetivo de conversión, el elemento correspondiente será null. ConversionGoal array
PartialErrors Matriz de objetos BatchError que contienen detalles de los elementos de solicitud que no se han realizado correctamente.

La lista de errores no se corresponde directamente con la lista de elementos de la solicitud. La lista puede estar vacía si no hay errores o puede incluir uno o varios objetos de error correspondientes a cada elemento de lista incorrecto en la solicitud.		 Matriz BatchError

Elementos de encabezado de respuesta

Elemento Descripción Tipo de datos
Seguimiento del Id. Identificador de la entrada de registro que contiene los detalles de la llamada API. string

Solicitud de JSON

Esta plantilla se generó mediante una herramienta para mostrar los elementos body y header de la solicitud JSON. Para ver los tipos admitidos que puede usar con esta operación de servicio, consulte la referencia de elementos de cuerpo de solicitud anterior.

{
  "ConversionGoalIds": [
    "LongValueHere"
  ],
  "ConversionGoalTypes": "ValueHere",
  "ReturnAdditionalFields": "ValueHere"
}

JSON de respuesta

Esta plantilla se generó mediante una herramienta para mostrar los elementos body y header de la respuesta JSON.

A continuación se muestra un ejemplo que es aplicable si el tipo de ConversionGoal es AppInstallGoal, BatchError es EditorialError.

{
  "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"
    }
  ],
  "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
    }
  ]
}

Sintaxis de código

Para llamar a la API REST a través de SDK, debe actualizar el SDK a una versión determinada y configurar los parámetros del sistema. La sintaxis de ejemplo se puede usar con los SDK de Bing Ads. Consulte Ejemplos de código de API de Bing Ads para obtener más ejemplos.

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)