Partager via

Opération de service GetKeywordCategories - Ad Insight

  • Article

Obtient les catégories mot clé auxquelles appartiennent les mots clés spécifiés.

Remarque

L’opération de service GetKeywordCategories est déconseillée à compter du 21 août 2023. En savoir plus.

Éléments de demande

L’objet GetKeywordCategoriesRequest 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
Mots-clés Tableau de mots clés dont vous souhaitez déterminer les catégories de mot clé possibles auxquelles appartient chaque mot clé. 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.

Vous devez définir cet élément sur Anglais.		 chaîne
MaxCategories Nombre de catégories à inclure dans les résultats. Le nombre maximal de catégories que vous pouvez demander est de 5.

La valeur par défaut est 5.		 int
PublisherCountry Code de pays du pays/de la région à utiliser comme source des données de catégorie.

Vous devez définir cet élément sur US.		 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
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 GetKeywordCategoriesResponse 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
Résultat Tableau d’objets de données KeywordCategoryResult . Chaque objet contient les mot clé et une liste de catégories auxquelles il appartient.

La liste inclut un élément pour chaque mot clé que vous avez spécifié dans la demande. Si la catégorie mot clé ne peut pas être déterminée, la liste KeywordCategories contient une seule catégorie de mots clés. La valeur de Category est Unknown Category et la valeur de ConfidenceScore est 0.0.		 Tableau KeywordCategoryResult

É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">GetKeywordCategories</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>
    <GetKeywordCategoriesRequest 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>
      <MaxCategories i:nil="false">ValueHere</MaxCategories>
    </GetKeywordCategoriesRequest>
  </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>
    <GetKeywordCategoriesResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <Result d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <KeywordCategoryResult>
          <Keyword d4p1:nil="false">ValueHere</Keyword>
          <KeywordCategories d4p1:nil="false">
            <KeywordCategory>
              <Category d4p1:nil="false">ValueHere</Category>
              <ConfidenceScore>ValueHere</ConfidenceScore>
            </KeywordCategory>
          </KeywordCategories>
        </KeywordCategoryResult>
      </Result>
    </GetKeywordCategoriesResponse>
  </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<GetKeywordCategoriesResponse> GetKeywordCategoriesAsync(
	IList<string> keywords,
	string language,
	string publisherCountry,
	int? maxCategories)
{
	var request = new GetKeywordCategoriesRequest
	{
		Keywords = keywords,
		Language = language,
		PublisherCountry = publisherCountry,
		MaxCategories = maxCategories
	};

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

static GetKeywordCategoriesResponse getKeywordCategories(
	ArrayOfstring keywords,
	java.lang.String language,
	java.lang.String publisherCountry,
	int maxCategories) throws RemoteException, Exception
{
	GetKeywordCategoriesRequest request = new GetKeywordCategoriesRequest();

	request.setKeywords(keywords);
	request.setLanguage(language);
	request.setPublisherCountry(publisherCountry);
	request.setMaxCategories(maxCategories);

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

static function GetKeywordCategories(
	$keywords,
	$language,
	$publisherCountry,
	$maxCategories)
{

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

	$request = new GetKeywordCategoriesRequest();

	$request->Keywords = $keywords;
	$request->Language = $language;
	$request->PublisherCountry = $publisherCountry;
	$request->MaxCategories = $maxCategories;

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

response=adinsight_service.GetKeywordCategories(
	Keywords=Keywords,
	Language=Language,
	PublisherCountry=PublisherCountry,
	MaxCategories=MaxCategories)

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/KeywordCategories/Query

Éléments de demande

L’objet GetKeywordCategoriesRequest 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
Mots-clés Tableau de mots clés dont vous souhaitez déterminer les catégories de mot clé possibles auxquelles appartient chaque mot clé. 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.

Vous devez définir cet élément sur Anglais.		 chaîne
MaxCategories Nombre de catégories à inclure dans les résultats. Le nombre maximal de catégories que vous pouvez demander est de 5.

La valeur par défaut est 5.		 int
PublisherCountry Code de pays du pays/de la région à utiliser comme source des données de catégorie.

Vous devez définir cet élément sur US.		 chaîne

É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 GetKeywordCategoriesResponse 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
Résultat Tableau d’objets de données KeywordCategoryResult . Chaque objet contient les mot clé et une liste de catégories auxquelles il appartient.

La liste inclut un élément pour chaque mot clé que vous avez spécifié dans la demande. Si la catégorie mot clé ne peut pas être déterminée, la liste KeywordCategories contient une seule catégorie de mots clés. La valeur de Category est Unknown Category et la valeur de ConfidenceScore est 0.0.		 Tableau KeywordCategoryResult

É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"
  ],
  "Language": "ValueHere",
  "PublisherCountry": "ValueHere",
  "MaxCategories": IntValueHere
}

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.

{
  "Result": [
    {
      "Keyword": "ValueHere",
      "KeywordCategories": [
        {
          "Category": "ValueHere",
          "ConfidenceScore": 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<GetKeywordCategoriesResponse> GetKeywordCategoriesAsync(
	IList<string> keywords,
	string language,
	string publisherCountry,
	int? maxCategories)
{
	var request = new GetKeywordCategoriesRequest
	{
		Keywords = keywords,
		Language = language,
		PublisherCountry = publisherCountry,
		MaxCategories = maxCategories
	};

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

static GetKeywordCategoriesResponse getKeywordCategories(
	ArrayOfstring keywords,
	java.lang.String language,
	java.lang.String publisherCountry,
	int maxCategories) throws RemoteException, Exception
{
	GetKeywordCategoriesRequest request = new GetKeywordCategoriesRequest();

	request.setKeywords(keywords);
	request.setLanguage(language);
	request.setPublisherCountry(publisherCountry);
	request.setMaxCategories(maxCategories);

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

static function GetKeywordCategories(
	$keywords,
	$language,
	$publisherCountry,
	$maxCategories)
{

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

	$request = new GetKeywordCategoriesRequest();

	$request->Keywords = $keywords;
	$request->Language = $language;
	$request->PublisherCountry = $publisherCountry;
	$request->MaxCategories = $maxCategories;

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

response=adinsight_service.GetKeywordCategories(
	Keywords=Keywords,
	Language=Language,
	PublisherCountry=PublisherCountry,
	MaxCategories=MaxCategories)