Freigeben über

SendUserInvitation-Dienstvorgang – Kundenverwaltung

  • Artikel

Sendet eine E-Mail-Einladung für einen Benutzer, sich für Microsoft Advertising zu registrieren. Die Einladung schränkt den Kontozugriff und die Berechtigungen ein.

Hinweis

Nur ein Benutzer mit Super Admin- oder Standard-Anmeldeinformationen kann Benutzerinladungen senden. Ein Standard Benutzer kann keine Super-Admin einladen. Weitere Informationen finden Sie im technischen Leitfaden zu Benutzerrollen.

Wichtig

Wenn die Einladung gesendet wird, können Sie den Benutzerzugriff auf eine Teilmenge von Werbekundenkonten beschränken, die sich direkt unter Ihrem Kunden befinden. Wenn eine Agenturhierarchie (jetzt oder in Zukunft) unter dem Kunden eingerichtet wird, in dem der Benutzer eingeladen wird, und wenn Sie den Zugriff nicht auf bestimmte Konten beschränken, hat der Benutzer Zugriff auf alle Konten in der Hierarchie.

Es ist möglich, dass mehrere ausstehende Einladungen an dieselbe E-Mail-Adresse gesendet werden, die noch nicht abgelaufen sind. Es ist auch möglich, dass diese Einladungen unterschiedliche Benutzerrollen angegeben haben, z. B. wenn Sie eine Einladung mit einer falschen Benutzerrolle und dann eine zweite Einladung mit der richtigen Benutzerrolle gesendet haben. Der Empfänger kann alle Einladungen annehmen und sich mit Anmeldeinformationen registrieren, die von der E-Mail-Adresse der Einladung abweichen. Microsoft Advertising-Benutzer können Einladungen an mehrere Kunden mit denselben Anmeldeinformationen annehmen. Weitere Informationen finden Sie im technischen Leitfaden für Mehrbenutzeranmeldeinformationen .

Sie können nach ausstehenden Einladungen anhand der Einladungs-ID suchen und herausfinden, ob die Einladung angenommen wurde oder nicht. Der SearchUserInvitations-Vorgang gibt alle ausstehenden Einladungen zurück, unabhängig davon, ob sie abgelaufen sind. Akzeptierte Einladungen sind nicht in der SearchUserInvitations-Antwort enthalten.

Nachdem die Einladung angenommen wurde, können Sie GetUsersInfo und GetUser aufrufen, um auf die Microsoft Advertising-Benutzerdetails zuzugreifen. Da ein Empfänger jedoch die Einladung annehmen und sich mit Anmeldeinformationen registrieren kann, die von der E-Mail-Adresse der Einladung abweichen, können Sie die Zuordnung einer UserInvitation zu einem User - oder UserInfo-Objekt nicht mit Sicherheit bestimmen. Wenn die Benutzer-ID von GetUsersInfo oder GetUser zurückgegeben wird, können Sie DeleteUser aufrufen, um den Benutzer nach Bedarf zu entfernen. Die Bing Ads-API unterstützt keine Vorgänge zum Löschen ausstehender Benutzereinladungen. Nachdem Sie einen Benutzer eingeladen haben, kann die Einladung nur über die Microsoft Advertising-Webanwendung abgebrochen werden. Sie finden sowohl ausstehende als auch akzeptierte Einladungen im Abschnitt Benutzer unter Konten & Abrechnung.

Anfordern von Elementen

Das SendUserInvitationRequest-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
UserInvitation Die zu sendende Benutzerinladung. UserInvitation

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 SendUserInvitationResponse-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
UserInvitationId Ein vom System generierter Bezeichner für die benutzerseitige Einladung, die gesendet wurde. lang

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">SendUserInvitation</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <SendUserInvitationRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <UserInvitation xmlns:e557="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e557:Id>ValueHere</e557:Id>
        <e557:FirstName i:nil="false">ValueHere</e557:FirstName>
        <e557:LastName i:nil="false">ValueHere</e557:LastName>
        <e557:Email i:nil="false">ValueHere</e557:Email>
        <e557:CustomerId>ValueHere</e557:CustomerId>
        <e557:RoleId>ValueHere</e557:RoleId>
        <e557:AccountIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <a1:long>ValueHere</a1:long>
        </e557:AccountIds>
        <e557:ExpirationDate>ValueHere</e557:ExpirationDate>
        <e557:Lcid>ValueHere</e557:Lcid>
      </UserInvitation>
    </SendUserInvitationRequest>
  </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>
    <SendUserInvitationResponse xmlns="https://bingads.microsoft.com/Customer/v13">
      <UserInvitationId>ValueHere</UserInvitationId>
    </SendUserInvitationResponse>
  </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<SendUserInvitationResponse> SendUserInvitationAsync(
	UserInvitation userInvitation)
{
	var request = new SendUserInvitationRequest
	{
		UserInvitation = userInvitation
	};

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

static SendUserInvitationResponse sendUserInvitation(
	UserInvitation userInvitation) throws RemoteException, Exception
{
	SendUserInvitationRequest request = new SendUserInvitationRequest();

	request.setUserInvitation(userInvitation);

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

static function SendUserInvitation(
	$userInvitation)
{

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

	$request = new SendUserInvitationRequest();

	$request->UserInvitation = $userInvitation;

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

response=customermanagement_service.SendUserInvitation(
	UserInvitation=UserInvitation)

Anforderungen

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

Anforderungs-URL

https://clientcenter.api.bingads.microsoft.com/CustomerManagement/v13/UserInvitation/Send

Anfordern von Elementen

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

Hinweis

Sofern unten nicht anders angegeben, sind alle Anforderungselemente erforderlich.

Anforderungstextelemente

Element Beschreibung Datentyp
UserInvitation Die zu sendende Benutzerinladung. UserInvitation

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 SendUserInvitationResponse-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
UserInvitationId Ein vom System generierter Bezeichner für die benutzerseitige Einladung, die gesendet wurde. lang

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 .

{
  "UserInvitation": {
    "AccountIds": [
      "LongValueHere"
    ],
    "CustomerId": "LongValueHere",
    "Email": "ValueHere",
    "ExpirationDate": "ValueHere",
    "FirstName": "ValueHere",
    "Id": "LongValueHere",
    "LastName": "ValueHere",
    "Lcid": "ValueHere",
    "RoleId": IntValueHere
  }
}

Antwort-JSON

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

{
  "UserInvitationId": "LongValueHere"
}

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<SendUserInvitationResponse> SendUserInvitationAsync(
	UserInvitation userInvitation)
{
	var request = new SendUserInvitationRequest
	{
		UserInvitation = userInvitation
	};

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

static SendUserInvitationResponse sendUserInvitation(
	UserInvitation userInvitation) throws RemoteException, Exception
{
	SendUserInvitationRequest request = new SendUserInvitationRequest();

	request.setUserInvitation(userInvitation);

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

static function SendUserInvitation(
	$userInvitation)
{

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

	$request = new SendUserInvitationRequest();

	$request->UserInvitation = $userInvitation;

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

response=customermanagement_service.SendUserInvitation(
	UserInvitation=UserInvitation)