Operación de servicio GetPerformanceInsightsDetailDataByAccountId: Ad Insight

Artículo
12/21/2023

Obtiene los datos de detalles de información de rendimiento de una sola cuenta.

Elementos Request

El objeto GetPerformanceInsightsDetailDataByAccountIdRequest 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
Enddate	Intervalo de fechas de finalización para información de rendimiento. El intervalo de fechas máximo es de un mes.	DayMonthAndYear
EntityType	Nivel de entidad desde el que desea solicitar datos de resumen de Performance Insights. Actualmente se admiten datos de nivel de cuenta y campaña .	EntityType
StartDate	Intervalo de fechas de inicio para información de rendimiento.	DayMonthAndYear

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 GetPerformanceInsightsDetailDataByAccountIdResponse 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	Define los resultados de la información de rendimiento al llamar a la operación GetPerformanceInsightsDetailDataByAccountId .	Matriz PerformanceInsightsDetail

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">GetPerformanceInsightsDetailDataByAccountId</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>
    <GetPerformanceInsightsDetailDataByAccountIdRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <EntityType>ValueHere</EntityType>
      <StartDate i:nil="false">
        <Day>ValueHere</Day>
        <Month>ValueHere</Month>
        <Year>ValueHere</Year>
      </StartDate>
      <EndDate i:nil="false">
        <Day>ValueHere</Day>
        <Month>ValueHere</Month>
        <Year>ValueHere</Year>
      </EndDate>
    </GetPerformanceInsightsDetailDataByAccountIdRequest>
  </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>
    <GetPerformanceInsightsDetailDataByAccountIdResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <Result d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <PerformanceInsightsDetail>
          <EntityId>ValueHere</EntityId>
          <EntityType>ValueHere</EntityType>
          <KPIType>ValueHere</KPIType>
          <Date d4p1:nil="false">
            <Day>ValueHere</Day>
            <Month>ValueHere</Month>
            <Year>ValueHere</Year>
          </Date>
          <Description d4p1:nil="false">
            <TemplateId>ValueHere</TemplateId>
            <Parameters d4p1:nil="false">
              <PerformanceInsightsMessageParameter d4p1:type="-- derived type specified here with the appropriate prefix --">
                <Type>ValueHere</Type>
                <!--This field is applicable if the derived type attribute is set to TextParameter-->
                <SuggestedText d4p1:nil="false">ValueHere</SuggestedText>
                <!--These fields are applicable if the derived type attribute is set to UrlParameter-->
                <SuggestedText d4p1:nil="false">ValueHere</SuggestedText>
                <SuggestedUrl d4p1:nil="false">ValueHere</SuggestedUrl>
                <UrlCategory>ValueHere</UrlCategory>
                <UrlId>ValueHere</UrlId>
                <!--These fields are applicable if the derived type attribute is set to EntityParameter-->
                <EntityCount>ValueHere</EntityCount>
                <EntityDetails d4p1:nil="false">
                  <EntityDetail>
                    <EntityId>ValueHere</EntityId>
                    <EntityName d4p1:nil="false">ValueHere</EntityName>
                  </EntityDetail>
                </EntityDetails>
                <EntityType>ValueHere</EntityType>
                <SuggestedText d4p1:nil="false">ValueHere</SuggestedText>
              </PerformanceInsightsMessageParameter>
            </Parameters>
            <IndentationLevel>ValueHere</IndentationLevel>
          </Description>
          <RootCauses d4p1:nil="false">
            <PerformanceInsightsMessage>
              <TemplateId>ValueHere</TemplateId>
              <Parameters d4p1:nil="false">
                <PerformanceInsightsMessageParameter d4p1:type="-- derived type specified here with the appropriate prefix --">
                  <Type>ValueHere</Type>
                  <!--This field is applicable if the derived type attribute is set to TextParameter-->
                  <SuggestedText d4p1:nil="false">ValueHere</SuggestedText>
                  <!--These fields are applicable if the derived type attribute is set to UrlParameter-->
                  <SuggestedText d4p1:nil="false">ValueHere</SuggestedText>
                  <SuggestedUrl d4p1:nil="false">ValueHere</SuggestedUrl>
                  <UrlCategory>ValueHere</UrlCategory>
                  <UrlId>ValueHere</UrlId>
                  <!--These fields are applicable if the derived type attribute is set to EntityParameter-->
                  <EntityCount>ValueHere</EntityCount>
                  <EntityDetails d4p1:nil="false">
                    <EntityDetail>
                      <EntityId>ValueHere</EntityId>
                      <EntityName d4p1:nil="false">ValueHere</EntityName>
                    </EntityDetail>
                  </EntityDetails>
                  <EntityType>ValueHere</EntityType>
                  <SuggestedText d4p1:nil="false">ValueHere</SuggestedText>
                </PerformanceInsightsMessageParameter>
              </Parameters>
              <IndentationLevel>ValueHere</IndentationLevel>
            </PerformanceInsightsMessage>
          </RootCauses>
          <Actions d4p1:nil="false">
            <PerformanceInsightsMessage>
              <TemplateId>ValueHere</TemplateId>
              <Parameters d4p1:nil="false">
                <PerformanceInsightsMessageParameter d4p1:type="-- derived type specified here with the appropriate prefix --">
                  <Type>ValueHere</Type>
                  <!--This field is applicable if the derived type attribute is set to TextParameter-->
                  <SuggestedText d4p1:nil="false">ValueHere</SuggestedText>
                  <!--These fields are applicable if the derived type attribute is set to UrlParameter-->
                  <SuggestedText d4p1:nil="false">ValueHere</SuggestedText>
                  <SuggestedUrl d4p1:nil="false">ValueHere</SuggestedUrl>
                  <UrlCategory>ValueHere</UrlCategory>
                  <UrlId>ValueHere</UrlId>
                  <!--These fields are applicable if the derived type attribute is set to EntityParameter-->
                  <EntityCount>ValueHere</EntityCount>
                  <EntityDetails d4p1:nil="false">
                    <EntityDetail>
                      <EntityId>ValueHere</EntityId>
                      <EntityName d4p1:nil="false">ValueHere</EntityName>
                    </EntityDetail>
                  </EntityDetails>
                  <EntityType>ValueHere</EntityType>
                  <SuggestedText d4p1:nil="false">ValueHere</SuggestedText>
                </PerformanceInsightsMessageParameter>
              </Parameters>
              <IndentationLevel>ValueHere</IndentationLevel>
            </PerformanceInsightsMessage>
          </Actions>
        </PerformanceInsightsDetail>
      </Result>
    </GetPerformanceInsightsDetailDataByAccountIdResponse>
  </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<GetPerformanceInsightsDetailDataByAccountIdResponse> GetPerformanceInsightsDetailDataByAccountIdAsync(
	EntityType entityType,
	DayMonthAndYear startDate,
	DayMonthAndYear endDate)
{
	var request = new GetPerformanceInsightsDetailDataByAccountIdRequest
	{
		EntityType = entityType,
		StartDate = startDate,
		EndDate = endDate
	};

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

static GetPerformanceInsightsDetailDataByAccountIdResponse getPerformanceInsightsDetailDataByAccountId(
	EntityType entityType,
	DayMonthAndYear startDate,
	DayMonthAndYear endDate) throws RemoteException, Exception
{
	GetPerformanceInsightsDetailDataByAccountIdRequest request = new GetPerformanceInsightsDetailDataByAccountIdRequest();

	request.setEntityType(entityType);
	request.setStartDate(startDate);
	request.setEndDate(endDate);

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

static function GetPerformanceInsightsDetailDataByAccountId(
	$entityType,
	$startDate,
	$endDate)
{

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

	$request = new GetPerformanceInsightsDetailDataByAccountIdRequest();

	$request->EntityType = $entityType;
	$request->StartDate = $startDate;
	$request->EndDate = $endDate;

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

response=adinsight_service.GetPerformanceInsightsDetailDataByAccountId(
	EntityType=EntityType,
	StartDate=StartDate,
	EndDate=EndDate)

Requisitos

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

Compartir a través de