Partager via


Opération de service GetHistoricalSearchCount - Ad Insight

Obtient le nombre de fois où le terme normalisé a été utilisé dans une recherche au cours de la période spécifiée. Les résultats sont agrégés par type d’appareil.

Éléments de demande

L’objet GetHistoricalSearchCountRequest définit le corps et les éléments d’en-tête 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
Dispositifs 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 les nombres de recherches pour les types d’appareils que vous spécifiez uniquement, le cas échéant.
tableau de chaînes
EndDate Date de fin de la plage de dates qui identifie les données que vous souhaitez utiliser pour déterminer le nombre de recherches historiques.

La date ne peut pas être ultérieure à la date du jour et doit être postérieure ou identique à la date de début spécifiée.

La date de fin effective peut être ajustée si le TimePeriodRollup spécifié est Hebdomadaire ou Mensuel.
DayMonthAndYear
Mots-clés Tableau de mots clés pour lesquels vous souhaitez déterminer le nombre de fois où le mot clé a été utilisé dans une requête de recherche. 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.

Pour connaître les valeurs possibles, consultez Langues prises en charge.
chaîne
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 .

Pour connaître les valeurs possibles, consultez Langages publicitaires.

Si la valeur est Null, la valeur par défaut est tous les pays/régions qui prennent en charge la langue spécifiée.
tableau de chaînes
Startdate Date de début de la plage de dates qui identifie les données que vous souhaitez utiliser pour déterminer le nombre de recherches historiques.

Cette date doit être antérieure ou identique à la date de fin spécifiée. La date doit être postérieure à la plage de données historiques maximale disponible correspondant à l’élément TimePeriodRollup spécifié.

La date de début effective peut être ajustée si le TimePeriodRollup spécifié est Hebdomadaire ou Mensuel.
DayMonthAndYear
TimePeriodRollup Vous pouvez spécifier s’il faut retourner des données agrégées quotidiennes, hebdomadaires ou mensuelles.

Pour obtenir la liste des valeurs prises en charge, consultez la section Remarques ci-dessous.
chaîne

É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 GetHistoricalSearchCountResponse 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
KeywordSearchCounts Tableau d’objets de données KeywordSearchCount . 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 KeywordSearchCount contient un tableau de SearchCountsByAttributes. Le tableau contient un élément pour chaque appareil unique spécifié dans la requête.
Tableau KeywordSearchCount

É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">GetHistoricalSearchCount</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>
    <GetHistoricalSearchCountRequest 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>
      <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>
      <StartDate i:nil="false">
        <Day>ValueHere</Day>
        <Month>ValueHere</Month>
        <Year>ValueHere</Year>
      </StartDate>
      <EndDate i:nil="false">
        <Day>ValueHere</Day>
        <Month>ValueHere</Month>
        <Year>ValueHere</Year>
      </EndDate>
      <TimePeriodRollup i:nil="false">ValueHere</TimePeriodRollup>
      <Devices i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:string>ValueHere</a1:string>
      </Devices>
    </GetHistoricalSearchCountRequest>
  </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>
    <GetHistoricalSearchCountResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <KeywordSearchCounts d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <KeywordSearchCount>
          <Keyword d4p1:nil="false">ValueHere</Keyword>
          <SearchCountsByAttributes d4p1:nil="false">
            <SearchCountsByAttributes>
              <Device d4p1:nil="false">ValueHere</Device>
              <HistoricalSearchCounts d4p1:nil="false">
                <HistoricalSearchCountPeriodic>
                  <SearchCount>ValueHere</SearchCount>
                  <DayMonthAndYear d4p1:nil="false">
                    <Day>ValueHere</Day>
                    <Month>ValueHere</Month>
                    <Year>ValueHere</Year>
                  </DayMonthAndYear>
                </HistoricalSearchCountPeriodic>
              </HistoricalSearchCounts>
            </SearchCountsByAttributes>
          </SearchCountsByAttributes>
        </KeywordSearchCount>
      </KeywordSearchCounts>
    </GetHistoricalSearchCountResponse>
  </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<GetHistoricalSearchCountResponse> GetHistoricalSearchCountAsync(
	IList<string> keywords,
	string language,
	IList<string> publisherCountries,
	DayMonthAndYear startDate,
	DayMonthAndYear endDate,
	string timePeriodRollup,
	IList<string> devices)
{
	var request = new GetHistoricalSearchCountRequest
	{
		Keywords = keywords,
		Language = language,
		PublisherCountries = publisherCountries,
		StartDate = startDate,
		EndDate = endDate,
		TimePeriodRollup = timePeriodRollup,
		Devices = devices
	};

	return (await AdInsightService.CallAsync((s, r) => s.GetHistoricalSearchCountAsync(r), request));
}
static GetHistoricalSearchCountResponse getHistoricalSearchCount(
	ArrayOfstring keywords,
	java.lang.String language,
	ArrayOfstring publisherCountries,
	DayMonthAndYear startDate,
	DayMonthAndYear endDate,
	java.lang.String timePeriodRollup,
	ArrayOfstring devices) throws RemoteException, Exception
{
	GetHistoricalSearchCountRequest request = new GetHistoricalSearchCountRequest();

	request.setKeywords(keywords);
	request.setLanguage(language);
	request.setPublisherCountries(publisherCountries);
	request.setStartDate(startDate);
	request.setEndDate(endDate);
	request.setTimePeriodRollup(timePeriodRollup);
	request.setDevices(devices);

	return AdInsightService.getService().getHistoricalSearchCount(request);
}
static function GetHistoricalSearchCount(
	$keywords,
	$language,
	$publisherCountries,
	$startDate,
	$endDate,
	$timePeriodRollup,
	$devices)
{

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

	$request = new GetHistoricalSearchCountRequest();

	$request->Keywords = $keywords;
	$request->Language = $language;
	$request->PublisherCountries = $publisherCountries;
	$request->StartDate = $startDate;
	$request->EndDate = $endDate;
	$request->TimePeriodRollup = $timePeriodRollup;
	$request->Devices = $devices;

	return $GLOBALS['AdInsightProxy']->GetService()->GetHistoricalSearchCount($request);
}
response=adinsight_service.GetHistoricalSearchCount(
	Keywords=Keywords,
	Language=Language,
	PublisherCountries=PublisherCountries,
	StartDate=StartDate,
	EndDate=EndDate,
	TimePeriodRollup=TimePeriodRollup,
	Devices=Devices)

Remarques

Les valeurs suivantes respectant la casse peuvent être spécifiées et les données sont retournées jusqu’à la plage de données historique maximale disponible correspondante.

TimePeriodRollup Données historiques disponibles
Journalière Jusqu’à 45 jours avant le dernier jour terminé.
En semaines Jusqu’à 15 semaines avant la dernière semaine terminée.

La date de début spécifiée est ajustée au dimanche le plus proche, et la date de fin est ajustée vers l’avant au samedi le plus proche.
Mensuelle Jusqu’à 24 mois avant le dernier mois terminé.

La date de début spécifiée est ajustée au début du mois, et la date de fin est ajustée à la fin du mois.

Langues prises en charge

Voici les langues prises en charge pour l’élément corps de la requête language :

Langues prises en charge
Danois
Néerlandais
Anglais
Finnois
Français
Allemand
Italien
Norvégien
Portugais
SimplifiedChinese
Espagnol
Suédois
TraditionalChinese

Mappage des langues et des pays/régions

Voici un tableau des langues et des mappages de pays/régions :

Langue CountryCode Pays/Région Language@Country
Danois DK Danemark Danish@Denmark
Néerlandais NL Pays-Bas Dutch@Netherlands
Anglais AU Australie English@Australia
Anglais CA Canada English@Canada
Anglais FR France English@France
Anglais DE Allemagne English@Germany
Anglais DANS Inde English@India
Anglais ID Indonésie English@Indonesia
Anglais IE Irlande English@Ireland
Anglais Professionnels de l’informatique Italie English@Italy
Anglais MON Malaisie English@Malaysia
Anglais NL Pays-Bas English@Netherlands
Anglais NZ Nouvelle-Zélande English@NewZealand
Anglais PH Philippines English@Philippines
Anglais SG Singapour English@Singapore
Anglais ES Espagne English@Spain
Anglais SE Suède English@Sweden
Anglais CH Suisse English@Switzerland
Anglais E Thaïlande English@Thailand
Anglais GO Royaume-Uni English@UK
Anglais US États-Unis English@US
Anglais VN Vietnam English@Vietnam
Finnois FI Finlande Finnish@Finland
Français CA Canada Français@Canada
Français FR France Français@France
Français CH Suisse Français@Suisse
Français GO Royaume-Uni Français@Royaume-Uni
Français US États-Unis Français@US
Allemand AU Australie German@Australia
Allemand AT Autriche German@Austria
Allemand CA Canada German@Canada
Allemand FR France German@France
Allemand DE Allemagne German@Germany
Allemand CH Suisse German@Switzerland
Allemand GO Royaume-Uni German@UK
Allemand US États-Unis German@US
Italien Professionnels de l’informatique Italie Italian@Italy
Norvégien NON Norvège Norwegian@Norway
Portugais BR Brésil Portuguese@Brazil
SimplifiedChinese CN Chine SimplifiedChinese@China
Espagnol AR Argentine Spanish@Argentina
Espagnol CL Chili Spanish@Chile
Espagnol CO Colombie Spanish@Colombia
Espagnol MX Mexique Spanish@Mexico
Espagnol PE Pérou Spanish@Peru
Espagnol ES Espagne Spanish@Spain
Espagnol US US Spanish@US
Espagnol VE Venezuela Spanish@Venezuela
Suédois SE Suède Swedish@Sweden
TraditionalChinese HK HongKongSAR TraditionalChinese@HongKongSAR
TraditionalChinese TW Taïwan TraditionalChinese@Taiwan

Configuration requise

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