Opération de service GetEstimatedPositionByKeywordIds - Ad Insight
Obtient la position estimée dans les résultats de la recherche si la valeur d’enchère spécifiée a été utilisée pour les mots clés au cours des 7 derniers jours. En outre, l’opération fournit des estimations de clics, le coût moyen par clic (CPC) et des impressions que les mots clés auraient pu générer avec l’offre estimée.
Les estimations sont basées sur les 7 derniers jours de données de performances, et non sur une prédiction ou une garantie des 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 GetEstimatedPositionByKeywordIdsRequest 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é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 GetEstimatedPositionByKeywordIdsResponse 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 | Liste d’objets de données KeywordIdEstimatedPosition . Le tableau contient un élément pour chaque mot clé spécifié dans la demande. Si l’ID mot clé n’est pas valide, l’élément correspondant dans le tableau est null. Chaque KeywordIdEstimatedPosition contient un identificateur mot clé et un KeywordEstimatedPosition. Si des données sont disponibles pour l’mot clé, EstimatedPositionAndTraffic fournit la position estimée dans les résultats de la recherche, en fonction de la valeur d’enchère spécifiée. Sinon, l’élément EstimatedPositions sera défini sur null. |
Tableau KeywordIdEstimatedPosition |
É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">GetEstimatedPositionByKeywordIds</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>
<GetEstimatedPositionByKeywordIdsRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
<KeywordIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</KeywordIds>
<MaxBid>ValueHere</MaxBid>
</GetEstimatedPositionByKeywordIdsRequest>
</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>
<GetEstimatedPositionByKeywordIdsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
<KeywordEstimatedPositions d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<KeywordIdEstimatedPosition>
<KeywordId>ValueHere</KeywordId>
<KeywordEstimatedPosition d4p1:nil="false">
<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>
</KeywordIdEstimatedPosition>
</KeywordEstimatedPositions>
</GetEstimatedPositionByKeywordIdsResponse>
</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<GetEstimatedPositionByKeywordIdsResponse> GetEstimatedPositionByKeywordIdsAsync(
IList<long> keywordIds,
double maxBid)
{
var request = new GetEstimatedPositionByKeywordIdsRequest
{
KeywordIds = keywordIds,
MaxBid = maxBid
};
return (await AdInsightService.CallAsync((s, r) => s.GetEstimatedPositionByKeywordIdsAsync(r), request));
}
static GetEstimatedPositionByKeywordIdsResponse getEstimatedPositionByKeywordIds(
ArrayOflong keywordIds,
double maxBid) throws RemoteException, Exception
{
GetEstimatedPositionByKeywordIdsRequest request = new GetEstimatedPositionByKeywordIdsRequest();
request.setKeywordIds(keywordIds);
request.setMaxBid(maxBid);
return AdInsightService.getService().getEstimatedPositionByKeywordIds(request);
}
static function GetEstimatedPositionByKeywordIds(
$keywordIds,
$maxBid)
{
$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];
$request = new GetEstimatedPositionByKeywordIdsRequest();
$request->KeywordIds = $keywordIds;
$request->MaxBid = $maxBid;
return $GLOBALS['AdInsightProxy']->GetService()->GetEstimatedPositionByKeywordIds($request);
}
response=adinsight_service.GetEstimatedPositionByKeywordIds(
KeywordIds=KeywordIds,
MaxBid=MaxBid)
Configuration requise
Service : AdInsightService.svc v13
Noms: https://bingads.microsoft.com/AdInsight/v13