Partager via

Opération de service GetNotifications - Gestion des clients

  • Article

Obtient une liste d’objets de notification.

Éléments de demande

L’objet GetNotificationsRequest 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
Locale Paramètres régionaux du message. La valeur par défaut est en.

Ajouter: Optionnel
Mettre à jour: Optionnel		 chaîne
TypeIds Liste de filtres de type de notification.

Ajouter: Optionnel
Mettre à jour: Optionnel		 int array
UserId Filtre UserId .

Ajouter: Optionnel
Mettre à jour: Optionnel		 int

É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
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 GetNotificationsResponse 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
Notifications Collection d’objets Notification qui contient des informations sur la notification. Tableau de notification

É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/Customer/v13">
    <Action mustUnderstand="1">GetNotifications</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <GetNotificationsRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <Locale i:nil="false">ValueHere</Locale>
      <UserId i:nil="false">ValueHere</UserId>
      <TypeIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:int>ValueHere</a1:int>
      </TypeIds>
    </GetNotificationsRequest>
  </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/Customer/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <GetNotificationsResponse xmlns="https://bingads.microsoft.com/Customer/v13">
      <Notifications xmlns:e499="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e499:Notification>
          <e499:TypeId>ValueHere</e499:TypeId>
          <e499:Id>ValueHere</e499:Id>
          <e499:Severity>ValueHere</e499:Severity>
          <e499:Title d4p1:nil="false">ValueHere</e499:Title>
          <e499:Message d4p1:nil="false">ValueHere</e499:Message>
          <e499:AdditionalInfo d4p1:nil="false">
            <e499:KeyValueEntityOfstringstring>
              <e499:Key d4p1:nil="false">ValueHere</e499:Key>
              <e499:Value d4p1:nil="false">ValueHere</e499:Value>
            </e499:KeyValueEntityOfstringstring>
          </e499:AdditionalInfo>
        </e499:Notification>
      </Notifications>
    </GetNotificationsResponse>
  </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<GetNotificationsResponse> GetNotificationsAsync(
	string locale,
	int? userId,
	IList<int> typeIds)
{
	var request = new GetNotificationsRequest
	{
		Locale = locale,
		UserId = userId,
		TypeIds = typeIds
	};

	return (await CustomerManagementService.CallAsync((s, r) => s.GetNotificationsAsync(r), request));
}

static GetNotificationsResponse getNotifications(
	java.lang.String locale,
	int userId,
	ArrayOfint typeIds) throws RemoteException, Exception
{
	GetNotificationsRequest request = new GetNotificationsRequest();

	request.setLocale(locale);
	request.setUserId(userId);
	request.setTypeIds(typeIds);

	return CustomerManagementService.getService().getNotifications(request);
}

static function GetNotifications(
	$locale,
	$userId,
	$typeIds)
{

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

	$request = new GetNotificationsRequest();

	$request->Locale = $locale;
	$request->UserId = $userId;
	$request->TypeIds = $typeIds;

	return $GLOBALS['CustomerManagementProxy']->GetService()->GetNotifications($request);
}

response=customermanagement_service.GetNotifications(
	Locale=Locale,
	UserId=UserId,
	TypeIds=TypeIds)

Configuration requise

Service : CustomerManagementService.svc v13
Namespace: https://bingads.microsoft.com/Customer/v13

URL de la demande

https://clientcenter.api.bingads.microsoft.com/CustomerManagement/v13/Notifications/Query

Éléments de demande

L’objet GetNotificationsRequest 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
Locale Paramètres régionaux du message. La valeur par défaut est en.

Ajouter: Optionnel
Mettre à jour: Optionnel		 chaîne
TypeIds Liste de filtres de type de notification.

Ajouter: Optionnel
Mettre à jour: Optionnel		 int array
UserId Filtre UserId .

Ajouter: Optionnel
Mettre à jour: Optionnel		 int

É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
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 GetNotificationsResponse 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
Notifications Collection d’objets Notification qui contient des informations sur la notification. Tableau de notification

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

{
  "Locale": "ValueHere",
  "UserId": IntValueHere,
  "TypeIds": [
    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.

{
  "Notifications": [
    {
      "AdditionalInfo": [
        {
          "Key": "ValueHere",
          "Value": "ValueHere"
        }
      ],
      "Id": "LongValueHere",
      "Message": "ValueHere",
      "Severity": "ValueHere",
      "Title": "ValueHere",
      "TypeId": IntValueHere
    }
  ]
}

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<GetNotificationsResponse> GetNotificationsAsync(
	string locale,
	int? userId,
	IList<int> typeIds)
{
	var request = new GetNotificationsRequest
	{
		Locale = locale,
		UserId = userId,
		TypeIds = typeIds
	};

	return (await CustomerManagementService.CallAsync((s, r) => s.GetNotificationsAsync(r), request));
}

static GetNotificationsResponse getNotifications(
	java.lang.String locale,
	int userId,
	ArrayOfint typeIds) throws RemoteException, Exception
{
	GetNotificationsRequest request = new GetNotificationsRequest();

	request.setLocale(locale);
	request.setUserId(userId);
	request.setTypeIds(typeIds);

	return CustomerManagementService.getService().getNotifications(request);
}

static function GetNotifications(
	$locale,
	$userId,
	$typeIds)
{

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

	$request = new GetNotificationsRequest();

	$request->Locale = $locale;
	$request->UserId = $userId;
	$request->TypeIds = $typeIds;

	return $GLOBALS['CustomerManagementProxy']->GetService()->GetNotifications($request);
}

response=customermanagement_service.GetNotifications(
	Locale=Locale,
	UserId=UserId,
	TypeIds=TypeIds)