Freigeben über

GetNotifications Service Operation – Kundenverwaltung

  • Artikel

Ruft eine Liste von Benachrichtigungsobjekten ab.

Anfordern von Elementen

Das GetNotificationsRequest-Objekt definiert den Text und die Headerelemente der Dienstvorgangsanforderung. Die Elemente müssen in der gleichen Reihenfolge wie im Anforderungs-SOAP dargestellt sein.

Hinweis

Sofern unten nicht anders angegeben, sind alle Anforderungselemente erforderlich.

Anforderungstextelemente

Element Beschreibung Datentyp
Locale Das Gebietsschema der Nachricht. Der Standardwert ist en.

Hinzufügen: Wahlfrei
Aktualisieren: Wahlfrei		 Zeichenfolge
TypeIds Eine Liste des Benachrichtigungstypfilters.

Hinzufügen: Wahlfrei
Aktualisieren: Wahlfrei		 int-Array
UserId Der UserId-Filter .

Hinzufügen: Wahlfrei
Aktualisieren: Wahlfrei		 int

Anforderungsheaderelemente

Element Beschreibung Datentyp
AuthenticationToken Das OAuth-Zugriffstoken, das die Anmeldeinformationen eines Benutzers darstellt, der über Berechtigungen für Microsoft Advertising-Konten verfügt.

Weitere Informationen finden Sie unter Authentifizierung mit OAuth.		 Zeichenfolge
DeveloperToken Das Entwicklertoken, das für den Zugriff auf die Bing Ads-API verwendet wird.

Weitere Informationen finden Sie unter Abrufen eines Entwicklertokens.		 Zeichenfolge
Kennwort Dieses Element ist für die interne Verwendung reserviert und wird aus einer zukünftigen Version der API entfernt. Sie müssen das AuthenticationToken-Element verwenden, um Benutzeranmeldeinformationen festzulegen. Zeichenfolge
UserName Dieses Element ist für die interne Verwendung reserviert und wird aus einer zukünftigen Version der API entfernt. Sie müssen das AuthenticationToken-Element verwenden, um Benutzeranmeldeinformationen festzulegen. Zeichenfolge

Antwortelemente

Das GetNotificationsResponse-Objekt definiert den Text und die Headerelemente der Dienstvorgangsantwort. Die Elemente werden in der gleichen Reihenfolge zurückgegeben, in der die Antwort-SOAP gezeigt wird.

Antworttextelemente

Element Beschreibung Datentyp
Benachrichtigungen Eine Auflistung von Notification-Objekten , die Informationen zur Benachrichtigung enthält. Benachrichtigungsarray

Antwortheaderelemente

Element Beschreibung Datentyp
TrackingId Der Bezeichner des Protokolleintrags, der die Details des API-Aufrufs enthält. Zeichenfolge

SOAP anfordern

Diese Vorlage wurde von einem Tool generiert, um die Reihenfolge der Text- und Headerelemente für die SOAP-Anforderung anzuzeigen. Informationen zu unterstützten Typen, die Sie mit diesem Dienstvorgang verwenden können, finden Sie oben in der Referenz zu Anforderungstextelementen .

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

Antwort-SOAP

Diese Vorlage wurde von einem Tool generiert, um die Reihenfolge der Text- und Headerelemente für die SOAP-Antwort anzuzeigen.

<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:e43="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e43:Notification>
          <e43:TypeId>ValueHere</e43:TypeId>
          <e43:Id>ValueHere</e43:Id>
          <e43:Severity>ValueHere</e43:Severity>
          <e43:Title d4p1:nil="false">ValueHere</e43:Title>
          <e43:Message d4p1:nil="false">ValueHere</e43:Message>
          <e43:AdditionalInfo d4p1:nil="false">
            <e43:KeyValueEntityOfstringstring>
              <e43:Key d4p1:nil="false">ValueHere</e43:Key>
              <e43:Value d4p1:nil="false">ValueHere</e43:Value>
            </e43:KeyValueEntityOfstringstring>
          </e43:AdditionalInfo>
        </e43:Notification>
      </Notifications>
    </GetNotificationsResponse>
  </s:Body>
</s:Envelope>

Codesyntax

Die Beispielsyntax kann mit Bing Ads SDKs verwendet werden. Weitere Beispiele finden Sie unter Codebeispiele für die Bing Ads-API .

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)

Anforderungen

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

Anforderungs-URL

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

Anfordern von Elementen

Das GetNotificationsRequest-Objekt definiert den Text und die Headerelemente der Dienstvorgangsanforderung.

Hinweis

Sofern unten nicht anders angegeben, sind alle Anforderungselemente erforderlich.

Anforderungstextelemente

Element Beschreibung Datentyp
Locale Das Gebietsschema der Nachricht. Der Standardwert ist en.

Hinzufügen: Wahlfrei
Aktualisieren: Wahlfrei		 Zeichenfolge
TypeIds Eine Liste des Benachrichtigungstypfilters.

Hinzufügen: Wahlfrei
Aktualisieren: Wahlfrei		 int-Array
UserId Der UserId-Filter .

Hinzufügen: Wahlfrei
Aktualisieren: Wahlfrei		 int

Anforderungsheaderelemente

Element Beschreibung Datentyp
Authorization Das OAuth-Zugriffstoken, das die Anmeldeinformationen eines Benutzers darstellt, der über Berechtigungen für Microsoft Advertising-Konten verfügt. Stellen Sie sicher, dass dem Token das Präfix "Bearer" vorangestellt ist. Dies ist für die ordnungsgemäße Authentifizierung erforderlich.

Weitere Informationen finden Sie unter Authentifizierung mit OAuth.		 Zeichenfolge
DeveloperToken Das Entwicklertoken, das für den Zugriff auf die Bing Ads-API verwendet wird.

Weitere Informationen finden Sie unter Abrufen eines Entwicklertokens.		 Zeichenfolge
Kennwort Dieses Element ist für die interne Verwendung reserviert und wird aus einer zukünftigen Version der API entfernt. Sie müssen das AuthenticationToken-Element verwenden, um Benutzeranmeldeinformationen festzulegen. Zeichenfolge
UserName Dieses Element ist für die interne Verwendung reserviert und wird aus einer zukünftigen Version der API entfernt. Sie müssen das AuthenticationToken-Element verwenden, um Benutzeranmeldeinformationen festzulegen. Zeichenfolge

Antwortelemente

Das GetNotificationsResponse-Objekt definiert den Text und die Headerelemente der Dienstvorgangsantwort. Die Elemente werden in der gleichen Reihenfolge zurückgegeben wie im Antwort-JSON-Code gezeigt.

Antworttextelemente

Element Beschreibung Datentyp
Benachrichtigungen Eine Auflistung von Notification-Objekten , die Informationen zur Benachrichtigung enthält. Benachrichtigungsarray

Antwortheaderelemente

Element Beschreibung Datentyp
TrackingId Der Bezeichner des Protokolleintrags, der die Details des API-Aufrufs enthält. Zeichenfolge

JSON anfordern

Diese Vorlage wurde von einem Tool generiert, um die Text- und Headerelemente für die JSON-Anforderung anzuzeigen. Informationen zu unterstützten Typen, die Sie mit diesem Dienstvorgang verwenden können, finden Sie oben in der Referenz zu Anforderungstextelementen .

{
  "Locale": "ValueHere",
  "UserId": IntValueHere,
  "TypeIds": [
    IntValueHere
  ]
}

Antwort-JSON

Diese Vorlage wurde von einem Tool generiert, um die Text- und Headerelemente für die JSON-Antwort anzuzeigen.

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

Codesyntax

Um die REST-API über SDKs aufzurufen, müssen Sie das SDK auf eine bestimmte Version aktualisieren und die Systemparameter konfigurieren. Die Beispielsyntax kann mit Bing Ads SDKs verwendet werden. Weitere Beispiele finden Sie unter Codebeispiele für die Bing Ads-API .

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)