Opération du service GetKeywordLocations - Ad Insight
Obtient les emplacements géographiques des utilisateurs qui ont recherché les mots clés spécifiés.
Remarque
L’opération de service GetKeywordLocations est déconseillée à compter du 21 août 2023. En savoir plus.
Éléments de demande
L’objet GetKeywordLocationsRequest 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 |
---|---|---|
Appareil | Tableau d’appareils pour lesquels vous souhaitez obtenir des informations de localisation géographique. Les types d’appareils pris en charge sont les suivants : Ordinateurs, NonSmartphones, Smartphones, Tablettes. La valeur par défaut est Ordinateurs. La réponse inclut mot clé données d’emplacements uniquement pour les types d’appareils que vous spécifiez, le cas échéant. |
tableau de chaînes |
Mots-clés | Tableau de mots clés pour lesquels vous souhaitez obtenir des informations d’emplacement géographique. Les données sont également réparties par type d’appareil . 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. Pour connaître les valeurs possibles, consultez Langages publicitaires. |
chaîne |
Niveau | Niveau auquel agréger les données d’emplacement géographique. Les valeurs possibles sont les suivantes : 0 - Pays 1 - État/Province 2 - Zone métropolitaine 3 - Ville La valeur par défaut est 1 (État/Province). |
int |
MaxLocations | Nombre maximal d’emplacements à retourner. Vous pouvez demander un maximum de 10 emplacements. La valeur par défaut est 10. |
int |
ParentCountry | Pays/région d’où provient la recherche. Pour connaître les valeurs possibles, consultez Codes d’emplacement géographiques. La valeur par défaut est US. |
chaîne |
PublisherCountry | Code du pays/de la région à utiliser comme source des données d’emplacement. Le pays/la 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. |
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 GetKeywordLocationsResponse 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 |
---|---|---|
KeywordLocationResult | Tableau d’objets de données KeywordLocationResult . L’ordre des éléments correspond directement aux mots clés spécifiés dans la requête. Si aucune donnée d’emplacement n’est disponible pour un mot clé, le mot clé est inclus dans la liste, mais l’élément KeywordLocations de l’objet KeywordLocationResult correspondant est null. Chaque objet de données KeywordLocationResult contient un tableau de KeywordLocation. Le tableau contient un élément pour chaque appareil spécifié dans la demande. Chaque keywordLocation contient l’emplacement géographique et le pourcentage de temps pendant lequel les utilisateurs de l’emplacement géographique ont recherché le mot clé spécifié. |
Tableau KeywordLocationResult |
É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">GetKeywordLocations</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>
<GetKeywordLocationsRequest 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>
<PublisherCountry i:nil="false">ValueHere</PublisherCountry>
<Device i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</Device>
<Level i:nil="false">ValueHere</Level>
<ParentCountry i:nil="false">ValueHere</ParentCountry>
<MaxLocations i:nil="false">ValueHere</MaxLocations>
</GetKeywordLocationsRequest>
</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>
<GetKeywordLocationsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
<KeywordLocationResult d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<KeywordLocationResult>
<Keyword d4p1:nil="false">ValueHere</Keyword>
<KeywordLocations d4p1:nil="false">
<KeywordLocation>
<Device d4p1:nil="false">ValueHere</Device>
<Location d4p1:nil="false">ValueHere</Location>
<Percentage>ValueHere</Percentage>
</KeywordLocation>
</KeywordLocations>
</KeywordLocationResult>
</KeywordLocationResult>
</GetKeywordLocationsResponse>
</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<GetKeywordLocationsResponse> GetKeywordLocationsAsync(
IList<string> keywords,
string language,
string publisherCountry,
IList<string> device,
int? level,
string parentCountry,
int? maxLocations)
{
var request = new GetKeywordLocationsRequest
{
Keywords = keywords,
Language = language,
PublisherCountry = publisherCountry,
Device = device,
Level = level,
ParentCountry = parentCountry,
MaxLocations = maxLocations
};
return (await AdInsightService.CallAsync((s, r) => s.GetKeywordLocationsAsync(r), request));
}
static GetKeywordLocationsResponse getKeywordLocations(
ArrayOfstring keywords,
java.lang.String language,
java.lang.String publisherCountry,
ArrayOfstring device,
int level,
java.lang.String parentCountry,
int maxLocations) throws RemoteException, Exception
{
GetKeywordLocationsRequest request = new GetKeywordLocationsRequest();
request.setKeywords(keywords);
request.setLanguage(language);
request.setPublisherCountry(publisherCountry);
request.setDevice(device);
request.setLevel(level);
request.setParentCountry(parentCountry);
request.setMaxLocations(maxLocations);
return AdInsightService.getService().getKeywordLocations(request);
}
static function GetKeywordLocations(
$keywords,
$language,
$publisherCountry,
$device,
$level,
$parentCountry,
$maxLocations)
{
$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];
$request = new GetKeywordLocationsRequest();
$request->Keywords = $keywords;
$request->Language = $language;
$request->PublisherCountry = $publisherCountry;
$request->Device = $device;
$request->Level = $level;
$request->ParentCountry = $parentCountry;
$request->MaxLocations = $maxLocations;
return $GLOBALS['AdInsightProxy']->GetService()->GetKeywordLocations($request);
}
response=adinsight_service.GetKeywordLocations(
Keywords=Keywords,
Language=Language,
PublisherCountry=PublisherCountry,
Device=Device,
Level=Level,
ParentCountry=ParentCountry,
MaxLocations=MaxLocations)
Configuration requise
Service : AdInsightService.svc v13
Noms: https://bingads.microsoft.com/AdInsight/v13