Opération de service GetEstimatedBidByKeywords - Ad Insight

Obtient la valeur d’enchère estimée d’un ou de plusieurs mots clés qui peuvent entraîner l’affichage d’une publicité à la position ciblée dans les résultats de la recherche.

Les estimations ne sont pas une prédiction ou une garantie de performances futures.

Remarque

Cette opération est destinée aux campagnes de recherche qui utilisent la stratégie d’enchères DECP améliorée.

Éléments de demande

L’objet GetEstimatedBidByKeywordsRequest définit les éléments body et header 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
AdGroupId	Identificateur du groupe d’annonces dont les données de performances sont utilisées pour vous aider à déterminer l’efficacité de l’mot clé dans le contexte du groupe d’annonces. La spécification d’un groupe d’annonces permet d’améliorer la précision de l’offre suggérée. Si vous spécifiez un groupe d’annonces, vous devez spécifier la campagne à laquelle il appartient.	Long
CampaignId	Identificateur de la campagne qui possède le groupe d’annonces spécifié dans AdGroupId. Si vous ne spécifiez pas de groupe d’annonces, les données de performances de la campagne sont utilisées pour déterminer l’efficacité de l’mot clé dans le contexte de la campagne. La spécification d’une campagne et d’un groupe d’annonces permet d’améliorer l’exactitude de l’offre suggérée. Si ni AdGroupId ni CampaignId ne sont spécifiés, l’opération utilise l’élément d’en-tête CustomerAccountId spécifié pour déterminer l’exécution de l’mot clé dans le contexte du compte.	Long
CurrencyCode	Code ISO de l’unité monétaire à utiliser pour calculer les estimations de coût et la valeur de l’offre suggérée. S’il n’est pas défini, le service détermine la devise à partir du compte spécifié dans l’élément d’en-tête CustomerAccountId . Si ni Currency ni CustomerAccountId n’est défini, le service utilise USD.	CurrencyCode
EntityLevelBid	Détermine s’il faut retourner des estimations pour les enchères de niveau mot clé, les enchères au niveau du groupe d’annonces ou les deux. - Définissez EntityLevelBid sur Keyword pour obtenir un tableau de KeywordEstimatedBid correspondant aux mots clés spécifiés. - Définissez EntityLevelBid sur AdGroup pour obtenir un EstimatedBidAndTraffic pour le groupe d’annonces spécifié. - Définissez EntityLevelBid sur AllEntities pour obtenir un tableau de KeywordEstimatedBid pour les mots clés et un EstimatedBidAndTraffic pour un groupe d’annonces. Si vous ne définissez pas EntityLevelBid, la valeur par défaut consiste à renvoyer uniquement un tableau de KeywordEstimatedBid, ou l’équivalent de définir EntityLevelBid sur Keyword. Si vous définissez EntityLevelBid sur une valeur autre queKeyword, AdGroup ou AllEntities, le service renvoie le code 3501 avec ErrorCode CampaignServiceBidLevelInvalid.	chaîne
Mots-clés	Liste d’objets de données KeywordAndMatchType pour lesquels vous souhaitez obtenir des valeurs d’enchère suggérées. Vous pouvez spécifier un maximum de 1 000 mots clés et chaque mot clé peut contenir un maximum de 100 caractères.	Tableau KeywordAndMatchType
Langue	Langage utilisé parallèlement aux identificateurs d’emplacement pour estimer les enchères. La langue doit être prise en charge dans chacun des emplacements que vous spécifiez dans LocationIds. Pour connaître les valeurs de langue possibles, consultez Langues publicitaires. Si vous ne spécifiez pas la langue, l’opération de service utilise la langue de l’AdGroupId ou de CampaignId spécifié. Si aucune de ces propriétés n’est définie, EN (anglais) est utilisé par défaut.	chaîne
LocationIds	Identificateur ou identificateurs des emplacements géographiques à utiliser pour estimer les enchères. Tous les emplacements doivent prendre en charge la langue spécifiée dans l’élément Language . Bien que vous puissiez spécifier plusieurs identificateurs d’emplacement, comme meilleure pratique pour les estimations d’enchères les plus précises par emplacement, vous ne devez spécifier qu’un seul emplacement par appel de service. Pour connaître les identificateurs d’emplacement possibles, consultez Codes d’emplacement géographiques. Si vous ne spécifiez aucun emplacement, l’opération de service utilise les critères d’emplacement de l’AdGroupId ou de CampaignId spécifié. Si aucune de ces propriétés n’est définie, 190 (États-Unis) est utilisé par défaut.	tableau long
TargetPositionForAds	Position à laquelle vous souhaitez que vos annonces apparaissent dans les résultats de la recherche. La valeur par défaut est MainLine1.	TargetAdPosition

É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
Password	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 GetEstimatedBidByKeywordsResponse 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
AdGroupEstimatedBid	Contient des estimations de clics, le coût moyen par clic (CPC), les impressions, le taux de clics (CTR) et le coût total pour le groupe d’annonces spécifié si vous utilisez l’offre suggérée. La valeur MatchType dans EstimatedBidAndTraffic sera toujours Aggregate. Dans ce contexte, il représente l’enchère de recherche par défaut pour un groupe d’annonces.	EstimatedBidAndTraffic
KeywordEstimatedBids	Tableau d’objets de données KeywordEstimatedBid . Le tableau contient un élément pour chaque mot clé spécifié dans la demande. Si la mot clé n’est pas valide, l’élément correspondant dans le tableau est null. Chaque KeywordEstimatedBid contient un élément mot clé et EstimatedPositions. Si des données sont disponibles pour l’mot clé, EstimatedPositionAndTraffic fournit la valeur d’enchère suggérée qui aurait pu faire apparaître une publicité à la position ciblée des résultats de la recherche. Sinon, l’élément EstimatedPositions sera défini sur null.	Tableau KeywordEstimatedBid

É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">GetEstimatedBidByKeywords</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>
    <GetEstimatedBidByKeywordsRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <Keywords i:nil="false">
        <KeywordAndMatchType>
          <KeywordText i:nil="false">ValueHere</KeywordText>
          <MatchTypes i:nil="false">
            <MatchType>ValueHere</MatchType>
          </MatchTypes>
        </KeywordAndMatchType>
      </Keywords>
      <TargetPositionForAds>ValueHere</TargetPositionForAds>
      <Language i:nil="false">ValueHere</Language>
      <LocationIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </LocationIds>
      <CurrencyCode i:nil="false">ValueHere</CurrencyCode>
      <CampaignId i:nil="false">ValueHere</CampaignId>
      <AdGroupId i:nil="false">ValueHere</AdGroupId>
      <EntityLevelBid i:nil="false">ValueHere</EntityLevelBid>
    </GetEstimatedBidByKeywordsRequest>
  </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>
    <GetEstimatedBidByKeywordsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <KeywordEstimatedBids d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <KeywordEstimatedBid>
          <Keyword d4p1:nil="false">ValueHere</Keyword>
          <EstimatedBids d4p1:nil="false">
            <EstimatedBidAndTraffic>
              <MinClicksPerWeek d4p1:nil="false">ValueHere</MinClicksPerWeek>
              <MaxClicksPerWeek d4p1:nil="false">ValueHere</MaxClicksPerWeek>
              <AverageCPC d4p1:nil="false">ValueHere</AverageCPC>
              <MinImpressionsPerWeek d4p1:nil="false">ValueHere</MinImpressionsPerWeek>
              <MaxImpressionsPerWeek d4p1:nil="false">ValueHere</MaxImpressionsPerWeek>
              <CTR d4p1:nil="false">ValueHere</CTR>
              <MinTotalCostPerWeek d4p1:nil="false">ValueHere</MinTotalCostPerWeek>
              <MaxTotalCostPerWeek d4p1:nil="false">ValueHere</MaxTotalCostPerWeek>
              <CurrencyCode>ValueHere</CurrencyCode>
              <MatchType>ValueHere</MatchType>
              <EstimatedMinBid>ValueHere</EstimatedMinBid>
            </EstimatedBidAndTraffic>
          </EstimatedBids>
        </KeywordEstimatedBid>
      </KeywordEstimatedBids>
      <AdGroupEstimatedBid d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <MinClicksPerWeek d4p1:nil="false">ValueHere</MinClicksPerWeek>
        <MaxClicksPerWeek d4p1:nil="false">ValueHere</MaxClicksPerWeek>
        <AverageCPC d4p1:nil="false">ValueHere</AverageCPC>
        <MinImpressionsPerWeek d4p1:nil="false">ValueHere</MinImpressionsPerWeek>
        <MaxImpressionsPerWeek d4p1:nil="false">ValueHere</MaxImpressionsPerWeek>
        <CTR d4p1:nil="false">ValueHere</CTR>
        <MinTotalCostPerWeek d4p1:nil="false">ValueHere</MinTotalCostPerWeek>
        <MaxTotalCostPerWeek d4p1:nil="false">ValueHere</MaxTotalCostPerWeek>
        <CurrencyCode>ValueHere</CurrencyCode>
        <MatchType>ValueHere</MatchType>
        <EstimatedMinBid>ValueHere</EstimatedMinBid>
      </AdGroupEstimatedBid>
    </GetEstimatedBidByKeywordsResponse>
  </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<GetEstimatedBidByKeywordsResponse> GetEstimatedBidByKeywordsAsync(
	IList<KeywordAndMatchType> keywords,
	TargetAdPosition targetPositionForAds,
	string language,
	IList<long> locationIds,
	CurrencyCode? currencyCode,
	long? campaignId,
	long? adGroupId,
	string entityLevelBid)
{
	var request = new GetEstimatedBidByKeywordsRequest
	{
		Keywords = keywords,
		TargetPositionForAds = targetPositionForAds,
		Language = language,
		LocationIds = locationIds,
		CurrencyCode = currencyCode,
		CampaignId = campaignId,
		AdGroupId = adGroupId,
		EntityLevelBid = entityLevelBid
	};

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

static GetEstimatedBidByKeywordsResponse getEstimatedBidByKeywords(
	ArrayOfKeywordAndMatchType keywords,
	TargetAdPosition targetPositionForAds,
	java.lang.String language,
	ArrayOflong locationIds,
	CurrencyCode currencyCode,
	java.lang.Long campaignId,
	java.lang.Long adGroupId,
	java.lang.String entityLevelBid) throws RemoteException, Exception
{
	GetEstimatedBidByKeywordsRequest request = new GetEstimatedBidByKeywordsRequest();

	request.setKeywords(keywords);
	request.setTargetPositionForAds(targetPositionForAds);
	request.setLanguage(language);
	request.setLocationIds(locationIds);
	request.setCurrencyCode(currencyCode);
	request.setCampaignId(campaignId);
	request.setAdGroupId(adGroupId);
	request.setEntityLevelBid(entityLevelBid);

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

static function GetEstimatedBidByKeywords(
	$keywords,
	$targetPositionForAds,
	$language,
	$locationIds,
	$currencyCode,
	$campaignId,
	$adGroupId,
	$entityLevelBid)
{

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

	$request = new GetEstimatedBidByKeywordsRequest();

	$request->Keywords = $keywords;
	$request->TargetPositionForAds = $targetPositionForAds;
	$request->Language = $language;
	$request->LocationIds = $locationIds;
	$request->CurrencyCode = $currencyCode;
	$request->CampaignId = $campaignId;
	$request->AdGroupId = $adGroupId;
	$request->EntityLevelBid = $entityLevelBid;

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

response=adinsight_service.GetEstimatedBidByKeywords(
	Keywords=Keywords,
	TargetPositionForAds=TargetPositionForAds,
	Language=Language,
	LocationIds=LocationIds,
	CurrencyCode=CurrencyCode,
	CampaignId=CampaignId,
	AdGroupId=AdGroupId,
	EntityLevelBid=EntityLevelBid)

Configuration requise

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