Edit

Share via

GetAudienceFullEstimation Service Operation - Ad Insight

  • Article

Gets the audience full estimation.

Request Elements

The GetAudienceFullEstimationRequest object defines the body and header elements of the service operation request. The elements must be in the same order as shown in the Request SOAP.

Note

Unless otherwise noted below, all request elements are required.

Request Body Elements

Element Description Data Type
Age The selection of age targeting. Possible values are: EighteenToTwentyFour, TwentyFiveToThirtyFour, ThirtyFiveToFourtyNine, FiftyToSixtyFour, SixtyFiveAndAbove, Unknown.

Add: Optional. The default value is null.
Update: Optional		 SelectionOfAgeEnum
Audience The selection of audience targeting. Supported audience types are: Custom audiences, Combined lists, Customer match lists, Dynamic remarketing lists, In-market audiences, Remarketing lists, and Similar audiences. The values stored in the selection refer to segment IDs.

Add: Optional. The default value is null.
Update: Optional		 SelectionOflong
Bid The desired bid setting value. If set to null, the suggested bid is used to perform estimation.

Add: Optional
Update: Optional		 decimal
CampaignBiddingStrategy Indicates the desired bidding strategy for estimation response. Supported values are: 5: EnhancedCPC, 12: ManualCP.

Add: Optional. The default value is Manual.
Update: Optional		 int
CampaignSubType Indicate the desired ad type for estimation response. Supported values are: *0: StaticAds, 1: FeedBasedAds, 2: DynamicFeedBasedAds.

Add: Optional. The default value is StaticAds.
Update: Optional		 int
Company The company of LinkedIn profile targeting. The values stored in the selection refer to segment IDs.

Add: Optional. The default value is null.
Update: Optional		 SelectionOflong
Currency The currency of DailyBudget and Bid. If null, the currency of account setting will be used.

Add: Optional. The default value is null.
Update: Optional		 Currency
DailyBudget The daily campaign budget value. If set to null, the suggested budget is used to perform estimation.

Add: Optional. The default value is null.
Update: Optional		 decimal
Feed Respect this parameter only when CampaignSubType is FeedBasedAds or DynamicFeedBasedAds. It specifies the desired feed traffic to count as estimation.

Add: Optional. The default value is null.
Update: Optional		 Feed
Gender The gender to target. Possible values are: Male, Female, Unknown.

Add: Optional. The default value is null.
Update: Optional		 SelectionOfGenderEnum
Industry The industry of LinkedIn profile targeting. The values stored in the selection refer to segment IDs.

Add: Optional. The default value is null.
Update: Optional		 SelectionOflong
JobFunction The job function The industry of LinkedIn profile targeting. The values stored in the selection refer to segment IDs.

Add: Optional. The default value is null.
Update: Optional		 SelectionOflong
Location The selection of location targeting. The values stored in selection refer to location IDs.

Add: Optional. The default value is null.
Update: Optional		 SelectionOflong
RadiusTargets Represents the desired geographical area in terms of miles/kilometers.

Add: Optional. The default value is null.
Update: Optional		 RadiusTarget array

Request Header Elements

Element Description Data Type
AuthenticationToken The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts.

For more information see Authentication with OAuth.		 string
CustomerAccountId The identifier of the ad account that owns or is associated with the entities in the request. This header element must have the same value as the AccountId body element when both are required. This element is required for most service operations, and as a best practice you should always set it.

For more information see Get Your Account and Customer IDs.		 string
CustomerId The identifier of the manager account (customer) the user is accessing or operating from. A user can have access to multiple manager accounts. This element is required for most service operations, and as a best practice you should always set it.

For more information see Get Your Account and Customer IDs.		 string
DeveloperToken The developer token used to access the Bing Ads API.

For more information see Get a Developer Token.		 string
Password This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. string
UserName This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. string

Response Elements

The GetAudienceFullEstimationResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response SOAP.

Response Body Elements

Element Description Data Type
Currency The currency of DailyBudget and Bid. If null, the currency of account setting will be used.

Add: Optional. The default value is null.
Update: Optional		 Currency
EstAudienceSize Monthly estimated reach user count with rounded results. Output only. RangeResultOfDecimalRoundedResult
EstClick Monthly estimated user count with range result. Output only. RangeResultOfDecimalRoundedResult
EstCostPerEvent Indicates the estimated cost per event. The field meaning varies with CampaignBiddingStrategy request field. Output only.

EnhancedCPC: CPC
ManualCPM: CPM		 RangeResultOfDecimalRoundedResult
EstCTR Estimated click-through rate (CTR) with range result. Output only. RangeResultOfdouble
EstImpression Monthly estimated impression with range result. Output only. RangeResultOfDecimalRoundedResult
EstReachAudienceSize Monthly estimated user count with range result. Output only. DecimalRoundedResult
EstReachImpression Monthly estimated impression with range result. Output only. DecimalRoundedResult
EstSpend Monthly estimated spend with range result. Output only. RangeResultOfDecimalRoundedResult
EventsLostToBid Indicates event lost count due to insufficient input bid. The event lost type varies with CampaignBiddingStrategy request field. Output only.

EnhancedCPC: Click
ManualCPM: Impression		 int
EventsLostToBudget Indicates the event lost count due to insufficient input budget. The event lost type varies with CampaignBiddingStrategy request field. Output only.

EnhancedCPC: Click
ManualCPM: Impression		 int
SuggestedBid Suggested bid value under the current targeting. Output only. decimal
SuggestedBudget Suggested daily budget value under the current targeting and bid. Output only. decimal

Response Header Elements

Element Description Data Type
TrackingId The identifier of the log entry that contains the details of the API call. string

Request SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP request. For supported types that you can use with this service operation, see the Request Body Elements reference above.

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

Response SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP response.

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

Code Syntax

The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.

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)

Requirements

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