Compartir vía

Operación del servicio GetAuctionInsightData: Ad Insight

  • Artículo

Obtiene los datos de información de subasta de una cuenta, campañas, grupos de anuncios o palabras clave.

Al mostrar dónde se realiza correctamente y dónde puede que falten oportunidades para mejorar el rendimiento, los datos de información de la subasta pueden ayudarle a tomar decisiones de optimización estratégica.

Si se trata de una nueva campaña o si tiene muy pocas impresiones, no se generarán los datos de información de la subasta.

El período de retención de datos es de 180 días.

Elementos Request

El objeto GetAuctionInsightDataRequest 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
EntityIds Identificadores de Microsoft Advertising para hasta 200 campañas, grupos de anuncios o palabras clave.

Este elemento es necesario para los tipos de entidad campaign, ad group y keyword. Si EntityType es Account, este elemento es opcional y reemplazará el valor establecido en el encabezado CustomerAccountId. Independientemente del tipo de entidad, debe establecer los elementos de encabezado CustomerId y CustomerAccountId.		 matriz larga
EntityType Nivel de entidad que desea solicitar datos de información de la subasta.

Los valores admitidos son Account, Campaign, AdGroup y Keyword.

Se requiere este elemento.		 EntityType
ReturnAdditionalFields La lista de propiedades adicionales que desea incluir en cada KPI de información de subasta devuelta. Los valores de campo adicionales permiten obtener las características más recientes mediante la versión actual de Ad Insight API y, en la siguiente versión, los elementos correspondientes se incluirán de forma predeterminada.

Este elemento request es opcional.		 AuctionInsightKpiAdditionalField
SearchParameters Los parámetros de búsqueda definen los criterios y filtros para los datos de información de la subasta.

Debe incluir exactamente un DateRangeSearchParameter. Además, opcionalmente puede incluir hasta tres objetos AuctionSegmentSearchParameter diferentes, por ejemplo, para Day, DayOfWeek y Device. Otros objetos que derivan de SearchParameter no son válidos para esta operación.		 Matriz SearchParameter

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 GetAuctionInsightDataResponse 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
Resultado Incluye las entradas de información de la subasta para la entidad solicitada, el intervalo de fechas y los parámetros de búsqueda de segmentos. AuctionInsightResult

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/AdInsight/v13">
    <Action mustUnderstand="1">GetAuctionInsightData</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>
    <GetAuctionInsightDataRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <EntityType>ValueHere</EntityType>
      <EntityIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </EntityIds>
      <SearchParameters i:nil="false">
        <SearchParameter i:type="-- derived type specified here with the appropriate prefix --">
          <!--These fields are applicable if the derived type attribute is set to DateRangeSearchParameter-->
          <EndDate i:nil="false">
            <Day>ValueHere</Day>
            <Month>ValueHere</Month>
            <Year>ValueHere</Year>
          </EndDate>
          <StartDate i:nil="false">
            <Day>ValueHere</Day>
            <Month>ValueHere</Month>
            <Year>ValueHere</Year>
          </StartDate>
          <!--This field is applicable if the derived type attribute is set to AuctionSegmentSearchParameter-->
          <Segment>ValueHere</Segment>
        </SearchParameter>
      </SearchParameters>
      <ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
    </GetAuctionInsightDataRequest>
  </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/AdInsight/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <GetAuctionInsightDataResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <Result d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <Segments d4p1:nil="false">
          <AuctionSegment>ValueHere</AuctionSegment>
        </Segments>
        <Entries d4p1:nil="false">
          <AuctionInsightEntry>
            <DisplayDomain d4p1:nil="false">ValueHere</DisplayDomain>
            <AggregatedKpi d4p1:nil="false">
              <Segments d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <a1:string>ValueHere</a1:string>
              </Segments>
              <ImpressionShare>ValueHere</ImpressionShare>
              <OverlapRate>ValueHere</OverlapRate>
              <AveragePosition>ValueHere</AveragePosition>
              <AboveRate>ValueHere</AboveRate>
              <TopOfPageRate>ValueHere</TopOfPageRate>
              <OutrankingShare>ValueHere</OutrankingShare>
              <AbsoluteTopOfPageRate>ValueHere</AbsoluteTopOfPageRate>
            </AggregatedKpi>
            <SegmentedKpis d4p1:nil="false">
              <AuctionInsightKpi>
                <Segments d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <a1:string>ValueHere</a1:string>
                </Segments>
                <ImpressionShare>ValueHere</ImpressionShare>
                <OverlapRate>ValueHere</OverlapRate>
                <AveragePosition>ValueHere</AveragePosition>
                <AboveRate>ValueHere</AboveRate>
                <TopOfPageRate>ValueHere</TopOfPageRate>
                <OutrankingShare>ValueHere</OutrankingShare>
                <AbsoluteTopOfPageRate>ValueHere</AbsoluteTopOfPageRate>
              </AuctionInsightKpi>
            </SegmentedKpis>
          </AuctionInsightEntry>
        </Entries>
        <UsedImpressions>ValueHere</UsedImpressions>
        <UsedKeywords>ValueHere</UsedKeywords>
      </Result>
    </GetAuctionInsightDataResponse>
  </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<GetAuctionInsightDataResponse> GetAuctionInsightDataAsync(
	EntityType entityType,
	IList<long> entityIds,
	IList<SearchParameter> searchParameters,
	AuctionInsightKpiAdditionalField? returnAdditionalFields)
{
	var request = new GetAuctionInsightDataRequest
	{
		EntityType = entityType,
		EntityIds = entityIds,
		SearchParameters = searchParameters,
		ReturnAdditionalFields = returnAdditionalFields
	};

	return (await AdInsightService.CallAsync((s, r) => s.GetAuctionInsightDataAsync(r), request));
}

static GetAuctionInsightDataResponse getAuctionInsightData(
	EntityType entityType,
	ArrayOflong entityIds,
	ArrayOfSearchParameter searchParameters,
	ArrayList<AuctionInsightKpiAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
	GetAuctionInsightDataRequest request = new GetAuctionInsightDataRequest();

	request.setEntityType(entityType);
	request.setEntityIds(entityIds);
	request.setSearchParameters(searchParameters);
	request.setReturnAdditionalFields(returnAdditionalFields);

	return AdInsightService.getService().getAuctionInsightData(request);
}

static function GetAuctionInsightData(
	$entityType,
	$entityIds,
	$searchParameters,
	$returnAdditionalFields)
{

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

	$request = new GetAuctionInsightDataRequest();

	$request->EntityType = $entityType;
	$request->EntityIds = $entityIds;
	$request->SearchParameters = $searchParameters;
	$request->ReturnAdditionalFields = $returnAdditionalFields;

	return $GLOBALS['AdInsightProxy']->GetService()->GetAuctionInsightData($request);
}

response=adinsight_service.GetAuctionInsightData(
	EntityType=EntityType,
	EntityIds=EntityIds,
	SearchParameters=SearchParameters,
	ReturnAdditionalFields=ReturnAdditionalFields)

Requisitos

Servicio: AdInsightService.svc v13
Namespace: https://bingads.microsoft.com/AdInsight/v13

Dirección URL de solicitud

https://adinsight.api.bingads.microsoft.com/AdInsight/v13/AuctionInsightData/Query

Elementos Request

El objeto GetAuctionInsightDataRequest 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
EntityIds Identificadores de Microsoft Advertising para hasta 200 campañas, grupos de anuncios o palabras clave.

Este elemento es necesario para los tipos de entidad campaign, ad group y keyword. Si EntityType es Account, este elemento es opcional y reemplazará el valor establecido en el encabezado CustomerAccountId. Independientemente del tipo de entidad, debe establecer los elementos de encabezado CustomerId y CustomerAccountId.		 matriz larga
EntityType Nivel de entidad que desea solicitar datos de información de la subasta.

Los valores admitidos son Account, Campaign, AdGroup y Keyword.

Se requiere este elemento.		 EntityType
ReturnAdditionalFields La lista de propiedades adicionales que desea incluir en cada KPI de información de subasta devuelta. Los valores de campo adicionales permiten obtener las características más recientes mediante la versión actual de Ad Insight API y, en la siguiente versión, los elementos correspondientes se incluirán de forma predeterminada.

Este elemento request es opcional.		 AuctionInsightKpiAdditionalField
SearchParameters Los parámetros de búsqueda definen los criterios y filtros para los datos de información de la subasta.

Debe incluir exactamente un DateRangeSearchParameter. Además, opcionalmente puede incluir hasta tres objetos AuctionSegmentSearchParameter diferentes, por ejemplo, para Day, DayOfWeek y Device. Otros objetos que derivan de SearchParameter no son válidos para esta operación.		 Matriz SearchParameter

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 GetAuctionInsightDataResponse 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
Resultado Incluye las entradas de información de la subasta para la entidad solicitada, el intervalo de fechas y los parámetros de búsqueda de segmentos. AuctionInsightResult

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.

{
  "EntityType": "ValueHere",
  "EntityIds": [
    "LongValueHere"
  ],
  "SearchParameters": [
    {
      "EndDate": {
        "Day": "ValueHere",
        "Month": "ValueHere",
        "Year": "ValueHere"
      },
      "StartDate": {
        "Day": "ValueHere",
        "Month": "ValueHere",
        "Year": "ValueHere"
      },
      "Segment": "ValueHere"
    }
  ],
  "ReturnAdditionalFields": "ValueHere"
}

JSON de respuesta

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

{
  "Result": {
    "Entries": [
      {
        "AggregatedKpi": {
          "AboveRate": DoubleValueHere,
          "AbsoluteTopOfPageRate": DoubleValueHere,
          "AveragePosition": DoubleValueHere,
          "ImpressionShare": DoubleValueHere,
          "OutrankingShare": DoubleValueHere,
          "OverlapRate": DoubleValueHere,
          "Segments": [
            "ValueHere"
          ],
          "TopOfPageRate": DoubleValueHere
        },
        "DisplayDomain": "ValueHere",
        "SegmentedKpis": [
          {
            "AboveRate": DoubleValueHere,
            "AbsoluteTopOfPageRate": DoubleValueHere,
            "AveragePosition": DoubleValueHere,
            "ImpressionShare": DoubleValueHere,
            "OutrankingShare": DoubleValueHere,
            "OverlapRate": DoubleValueHere,
            "Segments": [
              "ValueHere"
            ],
            "TopOfPageRate": DoubleValueHere
          }
        ]
      }
    ],
    "Segments": [
      "ValueHere"
    ],
    "UsedImpressions": DoubleValueHere,
    "UsedKeywords": DoubleValueHere
  }
}

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<GetAuctionInsightDataResponse> GetAuctionInsightDataAsync(
	EntityType entityType,
	IList<long> entityIds,
	IList<SearchParameter> searchParameters,
	AuctionInsightKpiAdditionalField? returnAdditionalFields)
{
	var request = new GetAuctionInsightDataRequest
	{
		EntityType = entityType,
		EntityIds = entityIds,
		SearchParameters = searchParameters,
		ReturnAdditionalFields = returnAdditionalFields
	};

	return (await AdInsightService.CallAsync((s, r) => s.GetAuctionInsightDataAsync(r), request));
}

static GetAuctionInsightDataResponse getAuctionInsightData(
	EntityType entityType,
	ArrayOflong entityIds,
	ArrayOfSearchParameter searchParameters,
	ArrayList<AuctionInsightKpiAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
	GetAuctionInsightDataRequest request = new GetAuctionInsightDataRequest();

	request.setEntityType(entityType);
	request.setEntityIds(entityIds);
	request.setSearchParameters(searchParameters);
	request.setReturnAdditionalFields(returnAdditionalFields);

	return AdInsightService.getService().getAuctionInsightData(request);
}

static function GetAuctionInsightData(
	$entityType,
	$entityIds,
	$searchParameters,
	$returnAdditionalFields)
{

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

	$request = new GetAuctionInsightDataRequest();

	$request->EntityType = $entityType;
	$request->EntityIds = $entityIds;
	$request->SearchParameters = $searchParameters;
	$request->ReturnAdditionalFields = $returnAdditionalFields;

	return $GLOBALS['AdInsightProxy']->GetService()->GetAuctionInsightData($request);
}

response=adinsight_service.GetAuctionInsightData(
	EntityType=EntityType,
	EntityIds=EntityIds,
	SearchParameters=SearchParameters,
	ReturnAdditionalFields=ReturnAdditionalFields)