Opération de service GetDomainCategories - Ad Insight

Article
12/21/2023

Obtient la liste des catégories disponibles pour le domaine et la langue du site web.

Éléments de demande

L’objet GetDomainCategoriesRequest 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
Categoryname	Filtre de nom de catégorie. Si vous connaissez déjà une ou plusieurs catégories, vous pouvez éventuellement filtrer la liste des résultats par sous-catégorie. Jusqu’à trois niveaux de catégorie peuvent être spécifiés et doivent être séparés par une barre oblique (« / »). Par exemple, vous pouvez mettre en forme le filtre en tant que CategoryL1 / CategoryL2 / CategoryL3. Si vous n’incluez aucun nom de catégorie, toutes les catégories pour le domaine et la langue sont retournées.	chaîne
Domainname	Nom du site web correspondant aux pages que vous souhaitez cibler par vos annonces. La longueur maximale du domaine est de 2 048 caractères. Vous n’avez pas besoin d’inclure le préfixe http, https ou www .	chaîne
Langue	Langue du domaine du site web. Actuellement, seul l’anglais est pris en charge. Vous devez donc définir cet élément sur EN.	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 GetDomainCategoriesResponse 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
Catégories	Liste des catégories de domaine.	Tableau DomainCategory

É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">GetDomainCategories</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>
    <GetDomainCategoriesRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <CategoryName i:nil="false">ValueHere</CategoryName>
      <DomainName i:nil="false">ValueHere</DomainName>
      <Language i:nil="false">ValueHere</Language>
    </GetDomainCategoriesRequest>
  </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>
    <GetDomainCategoriesResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <Categories d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <DomainCategory>
          <Bid>ValueHere</Bid>
          <CategoryName d4p1:nil="false">ValueHere</CategoryName>
          <Coverage>ValueHere</Coverage>
        </DomainCategory>
      </Categories>
    </GetDomainCategoriesResponse>
  </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<GetDomainCategoriesResponse> GetDomainCategoriesAsync(
	string categoryName,
	string domainName,
	string language)
{
	var request = new GetDomainCategoriesRequest
	{
		CategoryName = categoryName,
		DomainName = domainName,
		Language = language
	};

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

static GetDomainCategoriesResponse getDomainCategories(
	java.lang.String categoryName,
	java.lang.String domainName,
	java.lang.String language) throws RemoteException, Exception
{
	GetDomainCategoriesRequest request = new GetDomainCategoriesRequest();

	request.setCategoryName(categoryName);
	request.setDomainName(domainName);
	request.setLanguage(language);

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

static function GetDomainCategories(
	$categoryName,
	$domainName,
	$language)
{

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

	$request = new GetDomainCategoriesRequest();

	$request->CategoryName = $categoryName;
	$request->DomainName = $domainName;
	$request->Language = $language;

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

response=adinsight_service.GetDomainCategories(
	CategoryName=CategoryName,
	DomainName=DomainName,
	Language=Language)

Configuration requise

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

Partager via