Operación del servicio GetAudienceFullEstimation: Ad Insight
Obtiene la estimación completa de la audiencia.
Elementos Request
El objeto GetAudienceFullEstimationRequest 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 |
---|---|---|
Edad | Selección de la selección de destino de edad. Los valores posibles son: EighteenToTwentyFour, TwentyFiveToThirtyFour, ThirtyFiveToFourtyNine, FiftyToSixtyFour, SixtyFiveAndAbove, Unknown. Agregar: Opcional. El valor predeterminado es null. Actualizar: Opcional |
SelectionOfAgeEnum |
Público | Selección de la segmentación de audiencia. Los tipos de audiencia admitidos son: audiencias personalizadas, listas combinadas, listas de coincidencias de clientes, listas de remarketing dinámicos, audiencias en el mercado, listas de remarketing y audiencias similares. Los valores almacenados en la selección hacen referencia a identificadores de segmento. Agregar: Opcional. El valor predeterminado es null. Actualizar: Opcional |
SelectionOflong |
Oferta | Valor de configuración de puja deseado. Si se establece en null, la puja sugerida se usa para realizar la estimación. Agregar: Opcional Actualizar: Opcional |
decimal |
CampaignBiddingStrategy | Indica la estrategia de puja deseada para la respuesta de estimación. Los valores admitidos son: 5: EnhancedCPC, 12: ManualCP. Agregar: Opcional. El valor predeterminado es Manual. Actualizar: Opcional |
int |
CampaignSubType | Indique el tipo de anuncio deseado para la respuesta de estimación. Los valores admitidos son: *0: StaticAds, 1: FeedBasedAds, 2: DynamicFeedBasedAds. Agregar: Opcional. El valor predeterminado es StaticAds. Actualizar: Opcional |
int |
Company | La empresa de destino del perfil de LinkedIn. Los valores almacenados en la selección hacen referencia a identificadores de segmento. Agregar: Opcional. El valor predeterminado es null. Actualizar: Opcional |
SelectionOflong |
Divisa | La moneda de DailyBudget y Bid. Si es null, se usará la configuración de la moneda de la cuenta. Agregar: Opcional. El valor predeterminado es null. Actualizar: Opcional |
Moneda |
DailyBudget | Valor diario del presupuesto de la campaña. Si se establece en null, el presupuesto sugerido se usa para realizar la estimación. Agregar: Opcional. El valor predeterminado es null. Actualizar: Opcional |
decimal |
Alimentar | Respeta este parámetro solo cuando CampaignSubType es FeedBasedAds o DynamicFeedBasedAds. Especifica el tráfico de fuente deseado que se va a contar como estimación. Agregar: Opcional. El valor predeterminado es null. Actualizar: Opcional |
Fuente |
Gender | El género al que se va a dirigir. Los valores posibles son: Masculino, Femenino, Desconocido. Agregar: Opcional. El valor predeterminado es null. Actualizar: Opcional |
SelectionOfGenderEnum |
Industria | El sector de destino de perfiles de LinkedIn. Los valores almacenados en la selección hacen referencia a identificadores de segmento. Agregar: Opcional. El valor predeterminado es null. Actualizar: Opcional |
SelectionOflong |
JobFunction | Función de trabajo El sector de destino de perfiles de LinkedIn. Los valores almacenados en la selección hacen referencia a identificadores de segmento. Agregar: Opcional. El valor predeterminado es null. Actualizar: Opcional |
SelectionOflong |
Ubicación | Selección de destino de ubicación. Los valores almacenados en la selección hacen referencia a los identificadores de ubicación. Agregar: Opcional. El valor predeterminado es null. Actualizar: Opcional |
SelectionOflong |
RadiusTargets | Representa el área geográfica deseada en términos de millas/kilómetros. Agregar: Opcional. El valor predeterminado es null. Actualizar: Opcional |
Matriz RadiusTarget |
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 GetAudienceFullEstimationResponse 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 |
---|---|---|
Divisa | La moneda de DailyBudget y Bid. Si es null, se usará la configuración de la moneda de la cuenta. Agregar: Opcional. El valor predeterminado es null. Actualizar: Opcional |
Moneda |
EstAudienceSize | Recuento mensual de usuarios de alcance estimado con resultados redondeados. Solo salida. | RangeResultOfDecimalRoundedResult |
EstClick | Recuento mensual de usuarios estimados con el resultado del intervalo. Solo salida. | RangeResultOfDecimalRoundedResult |
EstCostPerEvent | Indica el costo estimado por evento. El significado del campo varía con el campo de solicitud CampaignBiddingStrategy . Solo salida. EnhancedCPC: CPC ManualCPM: CPM |
RangeResultOfDecimalRoundedResult |
EstCTR | Tasa de clics estimada (CTR) con el resultado del intervalo. Solo salida. | RangeResultOfdouble |
EstImpression | Impresión mensual estimada con el resultado del intervalo. Solo salida. | RangeResultOfDecimalRoundedResult |
EstReachAudienceSize | Recuento mensual de usuarios estimados con el resultado del intervalo. Solo salida. | DecimalRoundedResult |
EstReachImpression | Impresión mensual estimada con el resultado del intervalo. Solo salida. | DecimalRoundedResult |
EstSpend | Gasto mensual estimado con el resultado del intervalo. Solo salida. | RangeResultOfDecimalRoundedResult |
EventsLostToBid | Indica el número de eventos perdidos debido a una oferta de entrada insuficiente. El tipo de evento perdido varía con el campo de solicitud CampaignBiddingStrategy . Solo salida. EnhancedCPC: haga clic en ManualCPM: Impresión |
int |
EventsLostToBudget | Indica el recuento de eventos perdidos debido a un presupuesto de entrada insuficiente. El tipo de evento perdido varía con el campo de solicitud CampaignBiddingStrategy . Solo salida. EnhancedCPC: haga clic en ManualCPM: Impresión |
int |
SuggestedBid | Valor de puja sugerido en la segmentación actual. Solo salida. | decimal |
SuggestedBudget | Valor presupuestado diario sugerido en la segmentación y oferta actuales. Solo salida. | decimal |
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">GetAudienceFullEstimation</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>
<GetAudienceFullEstimationRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
<Age i:nil="false">
<Includes i:nil="false">
<AgeEnum>ValueHere</AgeEnum>
</Includes>
<Excludes i:nil="false">
<AgeEnum>ValueHere</AgeEnum>
</Excludes>
</Age>
<Gender i:nil="false">
<Includes i:nil="false">
<GenderEnum>ValueHere</GenderEnum>
</Includes>
<Excludes i:nil="false">
<GenderEnum>ValueHere</GenderEnum>
</Excludes>
</Gender>
<Audience i:nil="false">
<Includes i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</Includes>
<Excludes i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</Excludes>
</Audience>
<Company i:nil="false">
<Includes i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</Includes>
<Excludes i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</Excludes>
</Company>
<Industry i:nil="false">
<Includes i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</Includes>
<Excludes i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</Excludes>
</Industry>
<JobFunction i:nil="false">
<Includes i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</Includes>
<Excludes i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</Excludes>
</JobFunction>
<Location i:nil="false">
<Includes i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</Includes>
<Excludes i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</Excludes>
</Location>
<RadiusTargets i:nil="false">
<RadiusTarget>
<Radius>ValueHere</Radius>
<RadiusUnit>ValueHere</RadiusUnit>
<CenterLatitude>ValueHere</CenterLatitude>
<CenterLongitude>ValueHere</CenterLongitude>
</RadiusTarget>
</RadiusTargets>
<CampaignBiddingStrategy i:nil="false">ValueHere</CampaignBiddingStrategy>
<CampaignSubType i:nil="false">ValueHere</CampaignSubType>
<Feed i:nil="false">
<StoreId i:nil="false">ValueHere</StoreId>
<FeedId i:nil="false">ValueHere</FeedId>
<FeedType i:nil="false">ValueHere</FeedType>
</Feed>
<DailyBudget i:nil="false">ValueHere</DailyBudget>
<Bid i:nil="false">ValueHere</Bid>
<Currency i:nil="false">ValueHere</Currency>
</GetAudienceFullEstimationRequest>
</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>
<GetAudienceFullEstimationResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
<EstImpression d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<High d4p1:nil="false">
<Value d4p1:nil="false">ValueHere</Value>
<Unit d4p1:nil="false">ValueHere</Unit>
</High>
<Low d4p1:nil="false">
<Value d4p1:nil="false">ValueHere</Value>
<Unit d4p1:nil="false">ValueHere</Unit>
</Low>
</EstImpression>
<EstAudienceSize d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<High d4p1:nil="false">
<Value d4p1:nil="false">ValueHere</Value>
<Unit d4p1:nil="false">ValueHere</Unit>
</High>
<Low d4p1:nil="false">
<Value d4p1:nil="false">ValueHere</Value>
<Unit d4p1:nil="false">ValueHere</Unit>
</Low>
</EstAudienceSize>
<EstClick d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<High d4p1:nil="false">
<Value d4p1:nil="false">ValueHere</Value>
<Unit d4p1:nil="false">ValueHere</Unit>
</High>
<Low d4p1:nil="false">
<Value d4p1:nil="false">ValueHere</Value>
<Unit d4p1:nil="false">ValueHere</Unit>
</Low>
</EstClick>
<EstSpend d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<High d4p1:nil="false">
<Value d4p1:nil="false">ValueHere</Value>
<Unit d4p1:nil="false">ValueHere</Unit>
</High>
<Low d4p1:nil="false">
<Value d4p1:nil="false">ValueHere</Value>
<Unit d4p1:nil="false">ValueHere</Unit>
</Low>
</EstSpend>
<EstCostPerEvent d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<High d4p1:nil="false">
<Value d4p1:nil="false">ValueHere</Value>
<Unit d4p1:nil="false">ValueHere</Unit>
</High>
<Low d4p1:nil="false">
<Value d4p1:nil="false">ValueHere</Value>
<Unit d4p1:nil="false">ValueHere</Unit>
</Low>
</EstCostPerEvent>
<EstCTR d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<High>ValueHere</High>
<Low>ValueHere</Low>
</EstCTR>
<SuggestedBid d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</SuggestedBid>
<SuggestedBudget d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</SuggestedBudget>
<EventsLostToBid d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</EventsLostToBid>
<EventsLostToBudget d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</EventsLostToBudget>
<EstReachAudienceSize d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<Value d4p1:nil="false">ValueHere</Value>
<Unit d4p1:nil="false">ValueHere</Unit>
</EstReachAudienceSize>
<EstReachImpression d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<Value d4p1:nil="false">ValueHere</Value>
<Unit d4p1:nil="false">ValueHere</Unit>
</EstReachImpression>
<Currency d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</Currency>
</GetAudienceFullEstimationResponse>
</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<GetAudienceFullEstimationResponse> GetAudienceFullEstimationAsync(
SelectionOfAgeEnum age,
SelectionOfGenderEnum gender,
SelectionOflong audience,
SelectionOflong company,
SelectionOflong industry,
SelectionOflong jobFunction,
SelectionOflong location,
IList<RadiusTarget> radiusTargets,
int? campaignBiddingStrategy,
int? campaignSubType,
Feed feed,
decimal? dailyBudget,
decimal? bid,
Currency? currency)
{
var request = new GetAudienceFullEstimationRequest
{
Age = age,
Gender = gender,
Audience = audience,
Company = company,
Industry = industry,
JobFunction = jobFunction,
Location = location,
RadiusTargets = radiusTargets,
CampaignBiddingStrategy = campaignBiddingStrategy,
CampaignSubType = campaignSubType,
Feed = feed,
DailyBudget = dailyBudget,
Bid = bid,
Currency = currency
};
return (await AdInsightService.CallAsync((s, r) => s.GetAudienceFullEstimationAsync(r), request));
}
static GetAudienceFullEstimationResponse getAudienceFullEstimation(
SelectionOfAgeEnum age,
SelectionOfGenderEnum gender,
SelectionOflong audience,
SelectionOflong company,
SelectionOflong industry,
SelectionOflong jobFunction,
SelectionOflong location,
ArrayOfRadiusTarget radiusTargets,
int campaignBiddingStrategy,
int campaignSubType,
Feed feed,
decimal dailyBudget,
decimal bid,
Currency currency) throws RemoteException, Exception
{
GetAudienceFullEstimationRequest request = new GetAudienceFullEstimationRequest();
request.setAge(age);
request.setGender(gender);
request.setAudience(audience);
request.setCompany(company);
request.setIndustry(industry);
request.setJobFunction(jobFunction);
request.setLocation(location);
request.setRadiusTargets(radiusTargets);
request.setCampaignBiddingStrategy(campaignBiddingStrategy);
request.setCampaignSubType(campaignSubType);
request.setFeed(feed);
request.setDailyBudget(dailyBudget);
request.setBid(bid);
request.setCurrency(currency);
return AdInsightService.getService().getAudienceFullEstimation(request);
}
static function GetAudienceFullEstimation(
$age,
$gender,
$audience,
$company,
$industry,
$jobFunction,
$location,
$radiusTargets,
$campaignBiddingStrategy,
$campaignSubType,
$feed,
$dailyBudget,
$bid,
$currency)
{
$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];
$request = new GetAudienceFullEstimationRequest();
$request->Age = $age;
$request->Gender = $gender;
$request->Audience = $audience;
$request->Company = $company;
$request->Industry = $industry;
$request->JobFunction = $jobFunction;
$request->Location = $location;
$request->RadiusTargets = $radiusTargets;
$request->CampaignBiddingStrategy = $campaignBiddingStrategy;
$request->CampaignSubType = $campaignSubType;
$request->Feed = $feed;
$request->DailyBudget = $dailyBudget;
$request->Bid = $bid;
$request->Currency = $currency;
return $GLOBALS['AdInsightProxy']->GetService()->GetAudienceFullEstimation($request);
}
response=adinsight_service.GetAudienceFullEstimation(
Age=Age,
Gender=Gender,
Audience=Audience,
Company=Company,
Industry=Industry,
JobFunction=JobFunction,
Location=Location,
RadiusTargets=RadiusTargets,
CampaignBiddingStrategy=CampaignBiddingStrategy,
CampaignSubType=CampaignSubType,
Feed=Feed,
DailyBudget=DailyBudget,
Bid=Bid,
Currency=Currency)
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/AudienceFullEstimation/Query
Elementos Request
El objeto GetAudienceFullEstimationRequest 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 |
---|---|---|
Edad | Selección de la selección de destino de edad. Los valores posibles son: EighteenToTwentyFour, TwentyFiveToThirtyFour, ThirtyFiveToFourtyNine, FiftyToSixtyFour, SixtyFiveAndAbove, Unknown. Agregar: Opcional. El valor predeterminado es null. Actualizar: Opcional |
SelectionOfAgeEnum |
Público | Selección de la segmentación de audiencia. Los tipos de audiencia admitidos son: audiencias personalizadas, listas combinadas, listas de coincidencias de clientes, listas de remarketing dinámicos, audiencias en el mercado, listas de remarketing y audiencias similares. Los valores almacenados en la selección hacen referencia a identificadores de segmento. Agregar: Opcional. El valor predeterminado es null. Actualizar: Opcional |
SelectionOflong |
Oferta | Valor de configuración de puja deseado. Si se establece en null, la puja sugerida se usa para realizar la estimación. Agregar: Opcional Actualizar: Opcional |
decimal |
CampaignBiddingStrategy | Indica la estrategia de puja deseada para la respuesta de estimación. Los valores admitidos son: 5: EnhancedCPC, 12: ManualCP. Agregar: Opcional. El valor predeterminado es Manual. Actualizar: Opcional |
int |
CampaignSubType | Indique el tipo de anuncio deseado para la respuesta de estimación. Los valores admitidos son: *0: StaticAds, 1: FeedBasedAds, 2: DynamicFeedBasedAds. Agregar: Opcional. El valor predeterminado es StaticAds. Actualizar: Opcional |
int |
Company | La empresa de destino del perfil de LinkedIn. Los valores almacenados en la selección hacen referencia a identificadores de segmento. Agregar: Opcional. El valor predeterminado es null. Actualizar: Opcional |
SelectionOflong |
Divisa | La moneda de DailyBudget y Bid. Si es null, se usará la configuración de la moneda de la cuenta. Agregar: Opcional. El valor predeterminado es null. Actualizar: Opcional |
Moneda |
DailyBudget | Valor diario del presupuesto de la campaña. Si se establece en null, el presupuesto sugerido se usa para realizar la estimación. Agregar: Opcional. El valor predeterminado es null. Actualizar: Opcional |
decimal |
Alimentar | Respeta este parámetro solo cuando CampaignSubType es FeedBasedAds o DynamicFeedBasedAds. Especifica el tráfico de fuente deseado que se va a contar como estimación. Agregar: Opcional. El valor predeterminado es null. Actualizar: Opcional |
Fuente |
Gender | El género al que se va a dirigir. Los valores posibles son: Masculino, Femenino, Desconocido. Agregar: Opcional. El valor predeterminado es null. Actualizar: Opcional |
SelectionOfGenderEnum |
Industria | El sector de destino de perfiles de LinkedIn. Los valores almacenados en la selección hacen referencia a identificadores de segmento. Agregar: Opcional. El valor predeterminado es null. Actualizar: Opcional |
SelectionOflong |
JobFunction | Función de trabajo El sector de destino de perfiles de LinkedIn. Los valores almacenados en la selección hacen referencia a identificadores de segmento. Agregar: Opcional. El valor predeterminado es null. Actualizar: Opcional |
SelectionOflong |
Ubicación | Selección de destino de ubicación. Los valores almacenados en la selección hacen referencia a los identificadores de ubicación. Agregar: Opcional. El valor predeterminado es null. Actualizar: Opcional |
SelectionOflong |
RadiusTargets | Representa el área geográfica deseada en términos de millas/kilómetros. Agregar: Opcional. El valor predeterminado es null. Actualizar: Opcional |
Matriz RadiusTarget |
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 GetAudienceFullEstimationResponse 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 |
---|---|---|
Divisa | La moneda de DailyBudget y Bid. Si es null, se usará la configuración de la moneda de la cuenta. Agregar: Opcional. El valor predeterminado es null. Actualizar: Opcional |
Moneda |
EstAudienceSize | Recuento mensual de usuarios de alcance estimado con resultados redondeados. Solo salida. | RangeResultOfDecimalRoundedResult |
EstClick | Recuento mensual de usuarios estimados con el resultado del intervalo. Solo salida. | RangeResultOfDecimalRoundedResult |
EstCostPerEvent | Indica el costo estimado por evento. El significado del campo varía con el campo de solicitud CampaignBiddingStrategy . Solo salida. EnhancedCPC: CPC ManualCPM: CPM |
RangeResultOfDecimalRoundedResult |
EstCTR | Tasa de clics estimada (CTR) con el resultado del intervalo. Solo salida. | RangeResultOfdouble |
EstImpression | Impresión mensual estimada con el resultado del intervalo. Solo salida. | RangeResultOfDecimalRoundedResult |
EstReachAudienceSize | Recuento mensual de usuarios estimados con el resultado del intervalo. Solo salida. | DecimalRoundedResult |
EstReachImpression | Impresión mensual estimada con el resultado del intervalo. Solo salida. | DecimalRoundedResult |
EstSpend | Gasto mensual estimado con el resultado del intervalo. Solo salida. | RangeResultOfDecimalRoundedResult |
EventsLostToBid | Indica el número de eventos perdidos debido a una oferta de entrada insuficiente. El tipo de evento perdido varía con el campo de solicitud CampaignBiddingStrategy . Solo salida. EnhancedCPC: haga clic en ManualCPM: Impresión |
int |
EventsLostToBudget | Indica el recuento de eventos perdidos debido a un presupuesto de entrada insuficiente. El tipo de evento perdido varía con el campo de solicitud CampaignBiddingStrategy . Solo salida. EnhancedCPC: haga clic en ManualCPM: Impresión |
int |
SuggestedBid | Valor de puja sugerido en la segmentación actual. Solo salida. | decimal |
SuggestedBudget | Valor presupuestado diario sugerido en la segmentación y oferta actuales. Solo salida. | decimal |
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.
{
"Age": {
"Excludes": [
"ValueHere"
],
"Includes": [
"ValueHere"
]
},
"Gender": {
"Excludes": [
"ValueHere"
],
"Includes": [
"ValueHere"
]
},
"Audience": {
"Excludes": [
"LongValueHere"
],
"Includes": [
"LongValueHere"
]
},
"Company": {
"Excludes": [
"LongValueHere"
],
"Includes": [
"LongValueHere"
]
},
"Industry": {
"Excludes": [
"LongValueHere"
],
"Includes": [
"LongValueHere"
]
},
"JobFunction": {
"Excludes": [
"LongValueHere"
],
"Includes": [
"LongValueHere"
]
},
"Location": {
"Excludes": [
"LongValueHere"
],
"Includes": [
"LongValueHere"
]
},
"RadiusTargets": [
{
"CenterLatitude": DoubleValueHere,
"CenterLongitude": DoubleValueHere,
"Radius": IntValueHere,
"RadiusUnit": "ValueHere"
}
],
"CampaignBiddingStrategy": IntValueHere,
"CampaignSubType": IntValueHere,
"Feed": {
"FeedId": "LongValueHere",
"FeedType": "LongValueHere",
"StoreId": "LongValueHere"
},
"DailyBudget": DecimalValueHere,
"Bid": DecimalValueHere,
"Currency": "ValueHere"
}
JSON de respuesta
Esta plantilla se generó mediante una herramienta para mostrar los elementos body y header de la respuesta JSON.
{
"EstImpression": {
"High": {
"Unit": "ValueHere",
"Value": DoubleValueHere
},
"Low": {
"Unit": "ValueHere",
"Value": DoubleValueHere
}
},
"EstAudienceSize": {
"High": {
"Unit": "ValueHere",
"Value": DoubleValueHere
},
"Low": {
"Unit": "ValueHere",
"Value": DoubleValueHere
}
},
"EstClick": {
"High": {
"Unit": "ValueHere",
"Value": DoubleValueHere
},
"Low": {
"Unit": "ValueHere",
"Value": DoubleValueHere
}
},
"EstSpend": {
"High": {
"Unit": "ValueHere",
"Value": DoubleValueHere
},
"Low": {
"Unit": "ValueHere",
"Value": DoubleValueHere
}
},
"EstCostPerEvent": {
"High": {
"Unit": "ValueHere",
"Value": DoubleValueHere
},
"Low": {
"Unit": "ValueHere",
"Value": DoubleValueHere
}
},
"EstCTR": {
"High": DoubleValueHere,
"Low": DoubleValueHere
},
"SuggestedBid": DecimalValueHere,
"SuggestedBudget": DecimalValueHere,
"EventsLostToBid": IntValueHere,
"EventsLostToBudget": IntValueHere,
"EstReachAudienceSize": {
"Unit": "ValueHere",
"Value": DoubleValueHere
},
"EstReachImpression": {
"Unit": "ValueHere",
"Value": DoubleValueHere
},
"Currency": "ValueHere"
}
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<GetAudienceFullEstimationResponse> GetAudienceFullEstimationAsync(
SelectionOfAgeEnum age,
SelectionOfGenderEnum gender,
SelectionOflong audience,
SelectionOflong company,
SelectionOflong industry,
SelectionOflong jobFunction,
SelectionOflong location,
IList<RadiusTarget> radiusTargets,
int? campaignBiddingStrategy,
int? campaignSubType,
Feed feed,
decimal? dailyBudget,
decimal? bid,
Currency? currency)
{
var request = new GetAudienceFullEstimationRequest
{
Age = age,
Gender = gender,
Audience = audience,
Company = company,
Industry = industry,
JobFunction = jobFunction,
Location = location,
RadiusTargets = radiusTargets,
CampaignBiddingStrategy = campaignBiddingStrategy,
CampaignSubType = campaignSubType,
Feed = feed,
DailyBudget = dailyBudget,
Bid = bid,
Currency = currency
};
return (await AdInsightService.CallAsync((s, r) => s.GetAudienceFullEstimationAsync(r), request));
}
static GetAudienceFullEstimationResponse getAudienceFullEstimation(
SelectionOfAgeEnum age,
SelectionOfGenderEnum gender,
SelectionOflong audience,
SelectionOflong company,
SelectionOflong industry,
SelectionOflong jobFunction,
SelectionOflong location,
ArrayOfRadiusTarget radiusTargets,
int campaignBiddingStrategy,
int campaignSubType,
Feed feed,
decimal dailyBudget,
decimal bid,
Currency currency) throws RemoteException, Exception
{
GetAudienceFullEstimationRequest request = new GetAudienceFullEstimationRequest();
request.setAge(age);
request.setGender(gender);
request.setAudience(audience);
request.setCompany(company);
request.setIndustry(industry);
request.setJobFunction(jobFunction);
request.setLocation(location);
request.setRadiusTargets(radiusTargets);
request.setCampaignBiddingStrategy(campaignBiddingStrategy);
request.setCampaignSubType(campaignSubType);
request.setFeed(feed);
request.setDailyBudget(dailyBudget);
request.setBid(bid);
request.setCurrency(currency);
return AdInsightService.getService().getAudienceFullEstimation(request);
}
static function GetAudienceFullEstimation(
$age,
$gender,
$audience,
$company,
$industry,
$jobFunction,
$location,
$radiusTargets,
$campaignBiddingStrategy,
$campaignSubType,
$feed,
$dailyBudget,
$bid,
$currency)
{
$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];
$request = new GetAudienceFullEstimationRequest();
$request->Age = $age;
$request->Gender = $gender;
$request->Audience = $audience;
$request->Company = $company;
$request->Industry = $industry;
$request->JobFunction = $jobFunction;
$request->Location = $location;
$request->RadiusTargets = $radiusTargets;
$request->CampaignBiddingStrategy = $campaignBiddingStrategy;
$request->CampaignSubType = $campaignSubType;
$request->Feed = $feed;
$request->DailyBudget = $dailyBudget;
$request->Bid = $bid;
$request->Currency = $currency;
return $GLOBALS['AdInsightProxy']->GetService()->GetAudienceFullEstimation($request);
}
response=adinsight_service.GetAudienceFullEstimation(
Age=Age,
Gender=Gender,
Audience=Audience,
Company=Company,
Industry=Industry,
JobFunction=JobFunction,
Location=Location,
RadiusTargets=RadiusTargets,
CampaignBiddingStrategy=CampaignBiddingStrategy,
CampaignSubType=CampaignSubType,
Feed=Feed,
DailyBudget=DailyBudget,
Bid=Bid,
Currency=Currency)