Opération de service GetEstimatedPositionByKeywords - Ad Insight

Obtient la position estimée dans les résultats de la recherche si la valeur d’enchère spécifiée est utilisée pour les mots clés spécifiés. En outre, l’opération fournit des estimations des clics, le coût moyen par clic (CPC) et des impressions que les mots clés peuvent être générés avec l’offre estimée.

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 GetEstimatedPositionByKeywordsRequest 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 la position 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 la précision de la position 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
Mots-clés	Tableau de mots clés pour lesquels vous souhaitez obtenir la position estimée dans les résultats de recherche, en fonction de la valeur d’enchère spécifiée. 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 de chaînes
Langue	Langage utilisé parallèlement aux identificateurs d’emplacement pour estimer la position. 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 la position. 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 de position les plus précises par emplacement, vous devez spécifier 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
MatchTypes	Tableau de types de correspondance uniques pour lesquels vous souhaitez obtenir des estimations. Vous ne pouvez pas spécifier le type de correspondance de contenu.	Tableau MatchType
MaxBid	Valeur d’enchère maximale à utiliser pour déterminer la position estimée dans les résultats de la recherche.	Double

É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 GetEstimatedPositionByKeywordsResponse 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
KeywordEstimatedPositions	Tableau d’objets de données KeywordEstimatedPosition . 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. Si des données sont disponibles pour le mot clé, EstimatedPositionAndTraffic fournit la position estimée dans les résultats de recherche où vos annonces peuvent apparaître, en fonction de la valeur d’enchère spécifiée. Sinon, l’élément EstimatedPositions sera défini sur null.	Tableau KeywordEstimatedPosition

É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">GetEstimatedPositionByKeywords</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>
    <GetEstimatedPositionByKeywordsRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <Keywords i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:string>ValueHere</a1:string>
      </Keywords>
      <MaxBid>ValueHere</MaxBid>
      <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>
      <MatchTypes i:nil="false">
        <MatchType>ValueHere</MatchType>
      </MatchTypes>
      <CampaignId i:nil="false">ValueHere</CampaignId>
      <AdGroupId i:nil="false">ValueHere</AdGroupId>
    </GetEstimatedPositionByKeywordsRequest>
  </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>
    <GetEstimatedPositionByKeywordsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <KeywordEstimatedPositions d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <KeywordEstimatedPosition>
          <Keyword d4p1:nil="false">ValueHere</Keyword>
          <EstimatedPositions d4p1:nil="false">
            <EstimatedPositionAndTraffic>
              <MatchType>ValueHere</MatchType>
              <MinClicksPerWeek>ValueHere</MinClicksPerWeek>
              <MaxClicksPerWeek>ValueHere</MaxClicksPerWeek>
              <AverageCPC>ValueHere</AverageCPC>
              <MinImpressionsPerWeek>ValueHere</MinImpressionsPerWeek>
              <MaxImpressionsPerWeek>ValueHere</MaxImpressionsPerWeek>
              <CTR>ValueHere</CTR>
              <MinTotalCostPerWeek>ValueHere</MinTotalCostPerWeek>
              <MaxTotalCostPerWeek>ValueHere</MaxTotalCostPerWeek>
              <CurrencyCode>ValueHere</CurrencyCode>
              <EstimatedAdPosition>ValueHere</EstimatedAdPosition>
            </EstimatedPositionAndTraffic>
          </EstimatedPositions>
        </KeywordEstimatedPosition>
      </KeywordEstimatedPositions>
    </GetEstimatedPositionByKeywordsResponse>
  </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<GetEstimatedPositionByKeywordsResponse> GetEstimatedPositionByKeywordsAsync(
	IList<string> keywords,
	double maxBid,
	string language,
	IList<long> locationIds,
	CurrencyCode? currencyCode,
	IList<MatchType> matchTypes,
	long? campaignId,
	long? adGroupId)
{
	var request = new GetEstimatedPositionByKeywordsRequest
	{
		Keywords = keywords,
		MaxBid = maxBid,
		Language = language,
		LocationIds = locationIds,
		CurrencyCode = currencyCode,
		MatchTypes = matchTypes,
		CampaignId = campaignId,
		AdGroupId = adGroupId
	};

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

static GetEstimatedPositionByKeywordsResponse getEstimatedPositionByKeywords(
	ArrayOfstring keywords,
	double maxBid,
	java.lang.String language,
	ArrayOflong locationIds,
	CurrencyCode currencyCode,
	ArrayOfMatchType matchTypes,
	java.lang.Long campaignId,
	java.lang.Long adGroupId) throws RemoteException, Exception
{
	GetEstimatedPositionByKeywordsRequest request = new GetEstimatedPositionByKeywordsRequest();

	request.setKeywords(keywords);
	request.setMaxBid(maxBid);
	request.setLanguage(language);
	request.setLocationIds(locationIds);
	request.setCurrencyCode(currencyCode);
	request.setMatchTypes(matchTypes);
	request.setCampaignId(campaignId);
	request.setAdGroupId(adGroupId);

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

static function GetEstimatedPositionByKeywords(
	$keywords,
	$maxBid,
	$language,
	$locationIds,
	$currencyCode,
	$matchTypes,
	$campaignId,
	$adGroupId)
{

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

	$request = new GetEstimatedPositionByKeywordsRequest();

	$request->Keywords = $keywords;
	$request->MaxBid = $maxBid;
	$request->Language = $language;
	$request->LocationIds = $locationIds;
	$request->CurrencyCode = $currencyCode;
	$request->MatchTypes = $matchTypes;
	$request->CampaignId = $campaignId;
	$request->AdGroupId = $adGroupId;

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

response=adinsight_service.GetEstimatedPositionByKeywords(
	Keywords=Keywords,
	MaxBid=MaxBid,
	Language=Language,
	LocationIds=LocationIds,
	CurrencyCode=CurrencyCode,
	MatchTypes=MatchTypes,
	CampaignId=CampaignId,
	AdGroupId=AdGroupId)

Configuration requise

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