Partager via

Opération de service GetBidLandscapeByKeywordIds - Ad Insight

  • Article

À partir d’une liste de mots clés existants, cette opération retourne pour chacun une liste d’offres suggérées et des statistiques de performances estimées de 1 à 7 jours. Cette opération n’est pas basée sur la position cible, mais elle renvoie plusieurs options d’enchères qui produisent des clics, des impressions et des coûts estimés différents. Vous pouvez utiliser la vue paysage de plusieurs points d’enchère avec une estimation du trafic pour la même mot clé pour vous aider à prendre des décisions sur la façon d’ajuster votre enchère mot clé afin d’optimiser les clics, les impressions et les coûts. Par exemple, vous pouvez utiliser les données obtenues pour visualiser une courbe de coût de clics ou une courbe d’enchère aux impressions.

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 GetBidLandscapeByKeywordIdsRequest 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
IncludeCurrentBid Lorsqu’elles sont définies sur false, les valeurs d’enchère suggérées peuvent ne pas inclure l’enchère actuelle de l’mot clé. La valeur par défaut est false.

Lorsque la valeur est true, l’une des valeurs d’enchère suggérées est égale à l’enchère actuelle de l’mot clé.		 boolean
KeywordIds Tableau d’identificateurs des mots clés pour lesquels vous souhaitez obtenir la liste des valeurs d’enchère suggérées avec des statistiques de performances estimées.

Vous pouvez spécifier un maximum de 1 000 mots clés.		 tableau long

É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 GetBidLandscapeByKeywordIdsResponse 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
BidLandscape Tableau d’objets KeywordBidLandscape . Le tableau contient un KeywordBidLandscape correspondant à chaque mot clé spécifié dans la requête. Les identificateurs mot clé en double sont autorisés dans le même appel et retournent les mêmes résultats.

Si l’identificateur de mot clé spécifié n’est pas valide ou n’a aucun résultat de données associé, tous les éléments dans KeywordBidLandscape sont nuls, à l’exception du KeywordId qui reflète l’identificateur mot clé spécifié dans la requête.

Si des données sont disponibles pour le mot clé, l’objet KeywordBidLandscape fournit une liste d’offres suggérées et des statistiques de performances estimées.		 KeywordBidLandscape array

É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">GetBidLandscapeByKeywordIds</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>
    <GetBidLandscapeByKeywordIdsRequest 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>
      <IncludeCurrentBid i:nil="false">ValueHere</IncludeCurrentBid>
    </GetBidLandscapeByKeywordIdsRequest>
  </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>
    <GetBidLandscapeByKeywordIdsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <BidLandscape d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <KeywordBidLandscape>
          <KeywordId>ValueHere</KeywordId>
          <StartDate d4p1:nil="false">
            <Day>ValueHere</Day>
            <Month>ValueHere</Month>
            <Year>ValueHere</Year>
          </StartDate>
          <EndDate d4p1:nil="false">
            <Day>ValueHere</Day>
            <Month>ValueHere</Month>
            <Year>ValueHere</Year>
          </EndDate>
          <BidLandscapePoints d4p1:nil="false">
            <BidLandscapePoint>
              <Bid>ValueHere</Bid>
              <Clicks d4p1:nil="false">ValueHere</Clicks>
              <Impressions>ValueHere</Impressions>
              <TopImpressions d4p1:nil="false">ValueHere</TopImpressions>
              <CurrencyCode>ValueHere</CurrencyCode>
              <Cost d4p1:nil="false">ValueHere</Cost>
              <MarginalCPC d4p1:nil="false">ValueHere</MarginalCPC>
            </BidLandscapePoint>
          </BidLandscapePoints>
        </KeywordBidLandscape>
      </BidLandscape>
    </GetBidLandscapeByKeywordIdsResponse>
  </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<GetBidLandscapeByKeywordIdsResponse> GetBidLandscapeByKeywordIdsAsync(
	IList<long> keywordIds,
	bool? includeCurrentBid)
{
	var request = new GetBidLandscapeByKeywordIdsRequest
	{
		KeywordIds = keywordIds,
		IncludeCurrentBid = includeCurrentBid
	};

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

static GetBidLandscapeByKeywordIdsResponse getBidLandscapeByKeywordIds(
	ArrayOflong keywordIds,
	boolean includeCurrentBid) throws RemoteException, Exception
{
	GetBidLandscapeByKeywordIdsRequest request = new GetBidLandscapeByKeywordIdsRequest();

	request.setKeywordIds(keywordIds);
	request.setIncludeCurrentBid(includeCurrentBid);

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

static function GetBidLandscapeByKeywordIds(
	$keywordIds,
	$includeCurrentBid)
{

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

	$request = new GetBidLandscapeByKeywordIdsRequest();

	$request->KeywordIds = $keywordIds;
	$request->IncludeCurrentBid = $includeCurrentBid;

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

response=adinsight_service.GetBidLandscapeByKeywordIds(
	KeywordIds=KeywordIds,
	IncludeCurrentBid=IncludeCurrentBid)

Configuration requise

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

URL de la demande

https://adinsight.api.bingads.microsoft.com/AdInsight/v13/BidLandscape/QueryByKeywordIds

Éléments de demande

L’objet GetBidLandscapeByKeywordIdsRequest définit les éléments body et header de la demande d’opération de service.

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
IncludeCurrentBid Lorsqu’elles sont définies sur false, les valeurs d’enchère suggérées peuvent ne pas inclure l’enchère actuelle de l’mot clé. La valeur par défaut est false.

Lorsque la valeur est true, l’une des valeurs d’enchère suggérées est égale à l’enchère actuelle de l’mot clé.		 boolean
KeywordIds Tableau d’identificateurs des mots clés pour lesquels vous souhaitez obtenir la liste des valeurs d’enchère suggérées avec des statistiques de performances estimées.

Vous pouvez spécifier un maximum de 1 000 mots clés.		 tableau long

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

Élément Description Type de données
Autorisation Jeton d’accès OAuth qui représente les informations d’identification d’un utilisateur disposant d’autorisations sur les comptes Microsoft Advertising. Vérifiez que le jeton est précédé de « Porteur », ce qui est nécessaire pour une authentification appropriée.

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 GetBidLandscapeByKeywordIdsResponse 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 le json de réponse.

Response Body, éléments

Élément Description Type de données
BidLandscape Tableau d’objets KeywordBidLandscape . Le tableau contient un KeywordBidLandscape correspondant à chaque mot clé spécifié dans la requête. Les identificateurs mot clé en double sont autorisés dans le même appel et retournent les mêmes résultats.

Si l’identificateur de mot clé spécifié n’est pas valide ou n’a aucun résultat de données associé, tous les éléments dans KeywordBidLandscape sont nuls, à l’exception du KeywordId qui reflète l’identificateur mot clé spécifié dans la requête.

Si des données sont disponibles pour le mot clé, l’objet KeywordBidLandscape fournit une liste d’offres suggérées et des statistiques de performances estimées.		 KeywordBidLandscape array

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

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

{
  "KeywordIds": [
    "LongValueHere"
  ],
  "IncludeCurrentBid": "ValueHere"
}

JSON de réponse

Ce modèle a été généré par un outil pour afficher le corps et les éléments d’en-tête de la réponse JSON.

{
  "BidLandscape": [
    {
      "BidLandscapePoints": [
        {
          "Bid": DoubleValueHere,
          "Clicks": DoubleValueHere,
          "Cost": DoubleValueHere,
          "CurrencyCode": "ValueHere",
          "Impressions": "LongValueHere",
          "MarginalCPC": DoubleValueHere,
          "TopImpressions": "LongValueHere"
        }
      ],
      "EndDate": {
        "Day": IntValueHere,
        "Month": IntValueHere,
        "Year": IntValueHere
      },
      "KeywordId": "LongValueHere",
      "StartDate": {
        "Day": IntValueHere,
        "Month": IntValueHere,
        "Year": IntValueHere
      }
    }
  ]
}

Syntaxe du code

Pour appeler l’API REST via des kits SDK, vous devez mettre à niveau le KIT de développement logiciel (SDK) vers une certaine version et configurer les paramètres système. 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<GetBidLandscapeByKeywordIdsResponse> GetBidLandscapeByKeywordIdsAsync(
	IList<long> keywordIds,
	bool? includeCurrentBid)
{
	var request = new GetBidLandscapeByKeywordIdsRequest
	{
		KeywordIds = keywordIds,
		IncludeCurrentBid = includeCurrentBid
	};

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

static GetBidLandscapeByKeywordIdsResponse getBidLandscapeByKeywordIds(
	ArrayOflong keywordIds,
	boolean includeCurrentBid) throws RemoteException, Exception
{
	GetBidLandscapeByKeywordIdsRequest request = new GetBidLandscapeByKeywordIdsRequest();

	request.setKeywordIds(keywordIds);
	request.setIncludeCurrentBid(includeCurrentBid);

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

static function GetBidLandscapeByKeywordIds(
	$keywordIds,
	$includeCurrentBid)
{

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

	$request = new GetBidLandscapeByKeywordIdsRequest();

	$request->KeywordIds = $keywordIds;
	$request->IncludeCurrentBid = $includeCurrentBid;

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

response=adinsight_service.GetBidLandscapeByKeywordIds(
	KeywordIds=KeywordIds,
	IncludeCurrentBid=IncludeCurrentBid)