GetAudienceFullEstimation Service Operation - Ad Insight

Article
05/04/2024

Obtient l’estimation complète de l’audience.

Éléments de demande

L’objet GetAudienceFullEstimationRequest définit le corps et les éléments d’en-tête de la demande d’opération de service. Les éléments doivent être dans le même ordre que celui indiqué dans la requête SOAP.

Remarque

Sauf indication contraire ci-dessous, tous les éléments de requête sont requis.

Éléments du corps de la requête

Élément	Description	Type de données
Âge	Sélection du ciblage par âge. Les valeurs possibles sont : EighteenToTwentyFour, TwentyFiveToThirtyFour, ThirtyFiveToFourtyNine, FiftyToSixtyFour, SixtyFiveAndAbove, Unknown. Ajouter: Optionnel. La valeur par défaut est null. Mettre à jour: Optionnel	SelectionOfAgeEnum
Audience	Sélection du ciblage d’audience. Les types d’audience pris en charge sont les suivants : audiences personnalisées, listes combinées, listes de correspondance de clients, listes de remarketing dynamiques, audiences sur le marché, listes de remarketing et audiences similaires. Les valeurs stockées dans la sélection font référence aux ID de segment. Ajouter: Optionnel. La valeur par défaut est null. Mettre à jour: Optionnel	SelectionOflong
Offre	Valeur du paramètre d’enchère souhaitée. Si la valeur est null, l’enchère suggérée est utilisée pour effectuer l’estimation. Ajouter: Optionnel Mettre à jour: Optionnel	Decimales
CampaignBiddingStrategy	Indique la stratégie d’enchère souhaitée pour la réponse d’estimation. Les valeurs prises en charge sont : 5 : EnhancedCPC, 12 : ManualCP. Ajouter: Optionnel. La valeur par défaut est Manuel. Mettre à jour: Optionnel	int
CampaignSubType	Indiquez le type d’annonce souhaité pour la réponse d’estimation. Les valeurs prises en charge sont : 0 : StaticAds, 1 : FeedBasedAds, 2 : DynamicFeedBasedAds. Ajouter:* Optionnel. La valeur par défaut est StaticAds. Mettre à jour: Optionnel	int
Company	Société de ciblage de profil LinkedIn. Les valeurs stockées dans la sélection font référence aux ID de segment. Ajouter: Optionnel. La valeur par défaut est null. Mettre à jour: Optionnel	SelectionOflong
Devise	Devise de DailyBudget et Bid. Si la valeur est null, la devise du paramètre de compte est utilisée. Ajouter: Optionnel. La valeur par défaut est null. Mettre à jour: Optionnel	Devise
DailyBudget	Valeur du budget de campagne quotidienne. Si la valeur est null, le budget suggéré est utilisé pour effectuer l’estimation. Ajouter: Optionnel. La valeur par défaut est null. Mettre à jour: Optionnel	Decimales
Nourrir	Respectez ce paramètre uniquement lorsque CampaignSubType a la valeur FeedBasedAds ou DynamicFeedBasedAds. Il spécifie le trafic de flux souhaité à compter comme estimation. Ajouter: Optionnel. La valeur par défaut est null. Mettre à jour: Optionnel	Flux
Gender	Sexe à cibler. Les valeurs possibles sont : Mâle, Femelle, Inconnu. Ajouter: Optionnel. La valeur par défaut est null. Mettre à jour: Optionnel	SelectionOfGenderEnum
Secteur d’activité	L’industrie du ciblage de profil LinkedIn. Les valeurs stockées dans la sélection font référence aux ID de segment. Ajouter: Optionnel. La valeur par défaut est null. Mettre à jour: Optionnel	SelectionOflong
JobFunction	La fonction de travail L’industrie du ciblage de profil LinkedIn. Les valeurs stockées dans la sélection font référence aux ID de segment. Ajouter: Optionnel. La valeur par défaut est null. Mettre à jour: Optionnel	SelectionOflong
Emplacement	Sélection du ciblage d’emplacement. Les valeurs stockées dans la sélection font référence aux ID d’emplacement. Ajouter: Optionnel. La valeur par défaut est null. Mettre à jour: Optionnel	SelectionOflong
RadiusTargets	Représente la zone géographique souhaitée en termes de miles/kilomètres. Ajouter: Optionnel. La valeur par défaut est null. Mettre à jour: Optionnel	RadiusTarget, tableau

Éléments d’en-tête de requête

Élément	Description	Type de données
AuthenticationToken	Jeton d’accès OAuth qui représente les informations d’identification d’un utilisateur disposant d’autorisations sur les comptes Microsoft Advertising. Pour plus d’informations, consultez Authentification avec OAuth.	chaîne
CustomerAccountId	Identificateur du compte publicitaire qui possède ou est associé aux entités dans la demande. Cet élément d’en-tête doit avoir la même valeur que l’élément de corps AccountId lorsque les deux sont nécessaires. Cet élément est requis pour la plupart des opérations de service et, à titre de bonne pratique, vous devez toujours le définir. Pour plus d’informations, consultez Obtenir votre compte et ID de client.	chaîne
Customerid	Identificateur du compte de responsable (client) auquel l’utilisateur accède ou à partir duquel il opère. Un utilisateur peut avoir accès à plusieurs comptes de gestionnaire. Cet élément est requis pour la plupart des opérations de service et, à titre de bonne pratique, vous devez toujours le définir. Pour plus d’informations, consultez Obtenir votre compte et ID de client.	chaîne
DeveloperToken	Jeton de développeur utilisé pour accéder à l’API Bing Ads. Pour plus d’informations, consultez Obtenir un jeton de développeur.	chaîne
Mot de passe	Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur.	chaîne
UserName	Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur.	chaîne

Éléments Response

L’objet GetAudienceFullEstimationResponse définit les éléments body et header de la réponse de l’opération de service. Les éléments sont retournés dans le même ordre que celui indiqué dans la réponse SOAP.

Response Body, éléments

Élément	Description	Type de données
Devise	Devise de l’offre/du budget suggéré. Sortie uniquement.	Devise
EstAudienceSize	Nombre d’utilisateurs de portée mensuelle estimée avec des résultats arrondis. Sortie uniquement.	RangeResultOfDecimalRoundedResult
EstClick	Estimation mensuelle du nombre d’utilisateurs avec le résultat de la plage. Sortie uniquement.	RangeResultOfDecimalRoundedResult
EstCostPerEvent	Indique le coût estimé par événement. La signification du champ varie selon le champ de requête CampaignBiddingStrategy . Sortie uniquement. EnhancedCPC : CPC ManualCPM : CPM	RangeResultOfDecimalRoundedResult
EstCTR	Estimation du taux de clics (CTR) avec le résultat de la plage. Sortie uniquement.	RangeResultOfdouble
EstImpression	Impression estimée mensuelle avec résultat de la plage. Sortie uniquement.	RangeResultOfDecimalRoundedResult
EstReachAudienceSize	Estimation mensuelle du nombre d’utilisateurs avec le résultat de la plage. Sortie uniquement.	DecimalRoundedResult
EstReachImpression	Impression estimée mensuelle avec résultat de la plage. Sortie uniquement.	DecimalRoundedResult
EstSpend	Dépenses mensuelles estimées avec le résultat de la plage. Sortie uniquement.	RangeResultOfDecimalRoundedResult
EventsLostToBid	Indique le nombre d’événements perdus en raison d’une enchère d’entrée insuffisante. Le type d’événement perdu varie selon le champ de requête CampaignBiddingStrategy . Sortie uniquement. EnhancedCPC : cliquez sur ManualCPM : Impression	int
EventsLostToBudget	Indique le nombre de pertes d’événements en raison d’un budget d’entrée insuffisant. Le type d’événement perdu varie selon le champ de requête CampaignBiddingStrategy . Sortie uniquement. EnhancedCPC : cliquez sur ManualCPM : Impression	int
SuggestedBid	Valeur d’enchère suggérée sous le ciblage actuel. Sortie uniquement.	Decimales
SuggestedBudget	Valeur de budget quotidienne suggérée sous le ciblage et l’enchère actuels. Sortie uniquement.	Decimales

Éléments d’en-tête de réponse

Élément	Description	Type de données
TrackingId	Identificateur de l’entrée de journal qui contient les détails de l’appel d’API.	chaîne

Requête SOAP

Ce modèle a été généré par un outil pour afficher l’ordre des éléments body et header pour la requête SOAP. Pour connaître les types pris en charge que vous pouvez utiliser avec cette opération de service, consultez la référence Éléments du corps de la demande ci-dessus.

<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 réponse

Ce modèle a été généré par un outil pour afficher l’ordre des éléments de corps et d’en-tête pour la réponse 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>

Syntaxe du code

L’exemple de syntaxe peut être utilisé avec les Kits de développement logiciel (SDK) Bing Ads. Pour plus d’exemples, consultez Exemples de code de l’API Bing Ads .

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)

Configuration requise

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

Partager via