GetHistoricalKeywordPerformance Service Operation - Ad Insight

Article
11/14/2024

Obtient les performances historiques du terme de recherche normalisé. Les résultats sont agrégés par type d’appareil.

Éléments de demande

L’objet GetHistoricalKeywordPerformanceRequest 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
Appareils	Liste d’un ou plusieurs des types d’appareils suivants : Ordinateurs, NonSmartphones, Smartphones, Tablettes. La valeur par défaut est Ordinateurs. La réponse inclut mot clé données de performances pour les types d’appareils que vous spécifiez uniquement, le cas échéant. Permet de déterminer les performances d’un mot clé sur les types d’appareils spécifiés.	tableau de chaînes
Mots-clés	Tableau de mots clés pour lesquels vous souhaitez obtenir des statistiques de performances historiques. Le tableau peut contenir 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	Langue dans laquelle les mots clés sont écrits. Les pays/régions que vous spécifiez dans l’élément PublisherCountries doivent prendre en charge la langue spécifiée. Les valeurs possibles sont le danois, le néerlandais, l’anglais, le finnois, le français, l’allemand, l’italien, le norvégien, le portugais, l’espagnol, le suédois et le chinois traditionnel.	chaîne
MatchTypes	Types de correspondance pour lesquels vous souhaitez obtenir des données d’historique. Vous ne pouvez pas spécifier le type de correspondance de contenu.	Tableau MatchType
PublisherCountries	Codes pays des pays/régions à utiliser comme source des données historiques. Vous pouvez spécifier un ou plusieurs codes pays. Chaque pays/région que vous spécifiez doit prendre en charge la langue spécifiée dans l’élément Language . Les combinaisons de langue et de pays/région suivantes sont prises en charge : Danois : DK Néerlandais : NL Anglais : AU, CA, GB, ID, IN, MY, PH, SG, TH, US, VN Finnois : FI Français : CA, FR Allemand : AT, CH, DE Italien : IT Norvégien : NB Portugais : BR Espagnol : AR, CL, CO, ES, MX, PE, VE Suédois : SE TraditionalChinese : HK, TW Si cet élément est null, le service inclut par défaut tous les pays/régions qui prennent en charge la langue spécifiée.	tableau de chaînes
TargetAdPosition	Position des résultats de la recherche pour laquelle vous souhaitez obtenir des données de performances. Par exemple, pour obtenir des données de performances lorsque des publicités sont apparues à la première position de la ligne principale à l’aide du type mot clé et de correspondance, définissez cet élément sur MainLine1. Pour obtenir des données de performances lorsque des publicités sont apparues dans n’importe quelle position des résultats de recherche à l’aide du type mot clé et de correspondance, définissez cet élément sur Tous. SixMonths Si vous spécifiez All pour cet élément, le service retourne plusieurs résultats par mot clé pour chaque position publicitaire prise en charge. Si vous spécifiez Aggregate, le service retourne un résultat agrégé. Les publicités de barre latérale ne sont plus diffusées sur les sites appartenant et exploités par Bing dans le États-Unis. Si vous demandez uniquement des données de première page, par exemple, FirstPage1 pour le États-Unis (US), l’élément KeywordKPIs dans le résultat sera nul/vide. Si vous incluez des pays/régions supplémentaires, par exemple, les États-Unis et l’autorité de certification dans la même demande, les résultats de la première page sont attribués uniquement aux pays/régions en dehors du États-Unis.	Adposition
TimeInterval	Période qui identifie les données à utiliser pour déterminer l’index de performance clé des mots clés spécifiés. Par exemple, utilisez les données des sept ou 30 jours précédents pour déterminer les performances mot clé. La valeur par défaut est LastDay.	TimeInterval

É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 GetHistoricalKeywordPerformanceResponse 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
KeywordHistoricalPerformances	Tableau d’objets de données KeywordHistoricalPerformance . Le tableau contient un élément pour chaque mot clé, appareil, type de correspondance et position publicitaire spécifiés dans la requête. Si l’mot clé n’est pas valide ou n’a pas de données disponibles, l’élément correspondant dans le tableau est null.	Tableau KeywordHistoricalPerformance

É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">GetHistoricalKeywordPerformance</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>
    <GetHistoricalKeywordPerformanceRequest 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>
      <TimeInterval i:nil="false">ValueHere</TimeInterval>
      <TargetAdPosition i:nil="false">ValueHere</TargetAdPosition>
      <MatchTypes i:nil="false">
        <MatchType>ValueHere</MatchType>
      </MatchTypes>
      <Language i:nil="false">ValueHere</Language>
      <PublisherCountries i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:string>ValueHere</a1:string>
      </PublisherCountries>
      <Devices i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:string>ValueHere</a1:string>
      </Devices>
    </GetHistoricalKeywordPerformanceRequest>
  </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>
    <GetHistoricalKeywordPerformanceResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <KeywordHistoricalPerformances d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <KeywordHistoricalPerformance>
          <Keyword d4p1:nil="false">ValueHere</Keyword>
          <KeywordKPIs d4p1:nil="false">
            <KeywordKPI>
              <Device d4p1:nil="false">ValueHere</Device>
              <MatchType>ValueHere</MatchType>
              <AdPosition>ValueHere</AdPosition>
              <Clicks>ValueHere</Clicks>
              <Impressions>ValueHere</Impressions>
              <AverageCPC>ValueHere</AverageCPC>
              <CTR>ValueHere</CTR>
              <TotalCost>ValueHere</TotalCost>
              <AverageBid>ValueHere</AverageBid>
            </KeywordKPI>
          </KeywordKPIs>
        </KeywordHistoricalPerformance>
      </KeywordHistoricalPerformances>
    </GetHistoricalKeywordPerformanceResponse>
  </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<GetHistoricalKeywordPerformanceResponse> GetHistoricalKeywordPerformanceAsync(
	IList<string> keywords,
	TimeInterval? timeInterval,
	AdPosition? targetAdPosition,
	IList<MatchType> matchTypes,
	string language,
	IList<string> publisherCountries,
	IList<string> devices)
{
	var request = new GetHistoricalKeywordPerformanceRequest
	{
		Keywords = keywords,
		TimeInterval = timeInterval,
		TargetAdPosition = targetAdPosition,
		MatchTypes = matchTypes,
		Language = language,
		PublisherCountries = publisherCountries,
		Devices = devices
	};

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

static GetHistoricalKeywordPerformanceResponse getHistoricalKeywordPerformance(
	ArrayOfstring keywords,
	TimeInterval timeInterval,
	AdPosition targetAdPosition,
	ArrayOfMatchType matchTypes,
	java.lang.String language,
	ArrayOfstring publisherCountries,
	ArrayOfstring devices) throws RemoteException, Exception
{
	GetHistoricalKeywordPerformanceRequest request = new GetHistoricalKeywordPerformanceRequest();

	request.setKeywords(keywords);
	request.setTimeInterval(timeInterval);
	request.setTargetAdPosition(targetAdPosition);
	request.setMatchTypes(matchTypes);
	request.setLanguage(language);
	request.setPublisherCountries(publisherCountries);
	request.setDevices(devices);

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

static function GetHistoricalKeywordPerformance(
	$keywords,
	$timeInterval,
	$targetAdPosition,
	$matchTypes,
	$language,
	$publisherCountries,
	$devices)
{

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

	$request = new GetHistoricalKeywordPerformanceRequest();

	$request->Keywords = $keywords;
	$request->TimeInterval = $timeInterval;
	$request->TargetAdPosition = $targetAdPosition;
	$request->MatchTypes = $matchTypes;
	$request->Language = $language;
	$request->PublisherCountries = $publisherCountries;
	$request->Devices = $devices;

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

response=adinsight_service.GetHistoricalKeywordPerformance(
	Keywords=Keywords,
	TimeInterval=TimeInterval,
	TargetAdPosition=TargetAdPosition,
	MatchTypes=MatchTypes,
	Language=Language,
	PublisherCountries=PublisherCountries,
	Devices=Devices)

Configuration requise

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

https://adinsight.api.bingads.microsoft.com/AdInsight/v13/HistoricalKeywordPerformance/Query

https://adinsight.api.sandbox.bingads.microsoft.com/AdInsight/v13/HistoricalKeywordPerformance/Query

Éléments de demande

L’objet GetHistoricalKeywordPerformanceRequest 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
Appareils	Liste d’un ou plusieurs des types d’appareils suivants : Ordinateurs, NonSmartphones, Smartphones, Tablettes. La valeur par défaut est Ordinateurs. La réponse inclut mot clé données de performances pour les types d’appareils que vous spécifiez uniquement, le cas échéant. Permet de déterminer les performances d’un mot clé sur les types d’appareils spécifiés.	tableau de chaînes
Mots-clés	Tableau de mots clés pour lesquels vous souhaitez obtenir des statistiques de performances historiques. Le tableau peut contenir 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	Langue dans laquelle les mots clés sont écrits. Les pays/régions que vous spécifiez dans l’élément PublisherCountries doivent prendre en charge la langue spécifiée. Les valeurs possibles sont le danois, le néerlandais, l’anglais, le finnois, le français, l’allemand, l’italien, le norvégien, le portugais, l’espagnol, le suédois et le chinois traditionnel.	chaîne
MatchTypes	Types de correspondance pour lesquels vous souhaitez obtenir des données d’historique. Vous ne pouvez pas spécifier le type de correspondance de contenu.	Tableau MatchType
PublisherCountries	Codes pays des pays/régions à utiliser comme source des données historiques. Vous pouvez spécifier un ou plusieurs codes pays. Chaque pays/région que vous spécifiez doit prendre en charge la langue spécifiée dans l’élément Language . Les combinaisons de langue et de pays/région suivantes sont prises en charge : Danois : DK Néerlandais : NL Anglais : AU, CA, GB, ID, IN, MY, PH, SG, TH, US, VN Finnois : FI Français : CA, FR Allemand : AT, CH, DE Italien : IT Norvégien : NB Portugais : BR Espagnol : AR, CL, CO, ES, MX, PE, VE Suédois : SE TraditionalChinese : HK, TW Si cet élément est null, le service inclut par défaut tous les pays/régions qui prennent en charge la langue spécifiée.	tableau de chaînes
TargetAdPosition	Position des résultats de la recherche pour laquelle vous souhaitez obtenir des données de performances. Par exemple, pour obtenir des données de performances lorsque des publicités sont apparues à la première position de la ligne principale à l’aide du type mot clé et de correspondance, définissez cet élément sur MainLine1. Pour obtenir des données de performances lorsque des publicités sont apparues dans n’importe quelle position des résultats de recherche à l’aide du type mot clé et de correspondance, définissez cet élément sur Tous. SixMonths Si vous spécifiez All pour cet élément, le service retourne plusieurs résultats par mot clé pour chaque position publicitaire prise en charge. Si vous spécifiez Aggregate, le service retourne un résultat agrégé. Les publicités de barre latérale ne sont plus diffusées sur les sites appartenant et exploités par Bing dans le États-Unis. Si vous demandez uniquement des données de première page, par exemple, FirstPage1 pour le États-Unis (US), l’élément KeywordKPIs dans le résultat sera nul/vide. Si vous incluez des pays/régions supplémentaires, par exemple, les États-Unis et l’autorité de certification dans la même demande, les résultats de la première page sont attribués uniquement aux pays/régions en dehors du États-Unis.	Adposition
TimeInterval	Période qui identifie les données à utiliser pour déterminer l’index de performance clé des mots clés spécifiés. Par exemple, utilisez les données des sept ou 30 jours précédents pour déterminer les performances mot clé. La valeur par défaut est LastDay.	TimeInterval

É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

Response Body, éléments

Élément	Description	Type de données
KeywordHistoricalPerformances	Tableau d’objets de données KeywordHistoricalPerformance . Le tableau contient un élément pour chaque mot clé, appareil, type de correspondance et position publicitaire spécifiés dans la requête. Si l’mot clé n’est pas valide ou n’a pas de données disponibles, l’élément correspondant dans le tableau est null.	Tableau KeywordHistoricalPerformance

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

{
  "Keywords": [
    "ValueHere"
  ],
  "TimeInterval": "ValueHere",
  "TargetAdPosition": "ValueHere",
  "MatchTypes": [
    "ValueHere"
  ],
  "Language": "ValueHere",
  "PublisherCountries": [
    "ValueHere"
  ],
  "Devices": [
    "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.

{
  "KeywordHistoricalPerformances": [
    {
      "Keyword": "ValueHere",
      "KeywordKPIs": [
        {
          "AdPosition": "ValueHere",
          "AverageBid": DoubleValueHere,
          "AverageCPC": DoubleValueHere,
          "Clicks": IntValueHere,
          "CTR": DoubleValueHere,
          "Device": "ValueHere",
          "Impressions": "LongValueHere",
          "MatchType": "ValueHere",
          "TotalCost": DoubleValueHere
        }
      ]
    }
  ]
}

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<GetHistoricalKeywordPerformanceResponse> GetHistoricalKeywordPerformanceAsync(
	IList<string> keywords,
	TimeInterval? timeInterval,
	AdPosition? targetAdPosition,
	IList<MatchType> matchTypes,
	string language,
	IList<string> publisherCountries,
	IList<string> devices)
{
	var request = new GetHistoricalKeywordPerformanceRequest
	{
		Keywords = keywords,
		TimeInterval = timeInterval,
		TargetAdPosition = targetAdPosition,
		MatchTypes = matchTypes,
		Language = language,
		PublisherCountries = publisherCountries,
		Devices = devices
	};

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

static GetHistoricalKeywordPerformanceResponse getHistoricalKeywordPerformance(
	ArrayOfstring keywords,
	TimeInterval timeInterval,
	AdPosition targetAdPosition,
	ArrayOfMatchType matchTypes,
	java.lang.String language,
	ArrayOfstring publisherCountries,
	ArrayOfstring devices) throws RemoteException, Exception
{
	GetHistoricalKeywordPerformanceRequest request = new GetHistoricalKeywordPerformanceRequest();

	request.setKeywords(keywords);
	request.setTimeInterval(timeInterval);
	request.setTargetAdPosition(targetAdPosition);
	request.setMatchTypes(matchTypes);
	request.setLanguage(language);
	request.setPublisherCountries(publisherCountries);
	request.setDevices(devices);

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

static function GetHistoricalKeywordPerformance(
	$keywords,
	$timeInterval,
	$targetAdPosition,
	$matchTypes,
	$language,
	$publisherCountries,
	$devices)
{

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

	$request = new GetHistoricalKeywordPerformanceRequest();

	$request->Keywords = $keywords;
	$request->TimeInterval = $timeInterval;
	$request->TargetAdPosition = $targetAdPosition;
	$request->MatchTypes = $matchTypes;
	$request->Language = $language;
	$request->PublisherCountries = $publisherCountries;
	$request->Devices = $devices;

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

response=adinsight_service.GetHistoricalKeywordPerformance(
	Keywords=Keywords,
	TimeInterval=TimeInterval,
	TargetAdPosition=TargetAdPosition,
	MatchTypes=MatchTypes,
	Language=Language,
	PublisherCountries=PublisherCountries,
	Devices=Devices)

Partager via

GetHistoricalKeywordPerformance Service Operation - Ad Insight

Éléments de demande

Éléments du corps de la requête

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

Éléments Response

Response Body, éléments

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

Requête SOAP

Soap de réponse

Syntaxe du code

Configuration requise

URL de la demande

Éléments de demande

Éléments du corps de la requête

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

Éléments Response

Response Body, éléments

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

Requête JSON

JSON de réponse

Syntaxe du code

Commentaires

Ressources supplémentaires