Operazione del servizio SendUserInvitation - Gestione dei clienti

Articolo
12/21/2023

Invia un invito tramite posta elettronica per consentire a un utente di iscriversi a Microsoft Advertising. L'invito limita l'accesso all'account e le autorizzazioni.

Nota

Solo un utente con credenziali Super Amministrazione o Standard può inviare inviti utente. Un utente Standard non può invitare un Amministrazione Super. Per altre informazioni, vedere la Guida tecnica per i ruoli utente.

Importante

Quando l'invito viene inviato, puoi scegliere di limitare l'accesso dell'utente a un subset di account dell'inserzionista che si trovano direttamente sotto il cliente. Se una gerarchia di agenzie viene configurata (ora o in futuro) nel cliente in cui l'utente è invitato e se non si limita l'accesso a account specifici, l'utente avrà accesso a tutti gli account nella gerarchia.

È possibile inviare più inviti in sospeso allo stesso indirizzo di posta elettronica, che non sono ancora scaduti. È anche possibile che tali inviti abbiano ruoli utente diversi, ad esempio se è stato inviato un invito con un ruolo utente errato e quindi è stato inviato un secondo invito con il ruolo utente corretto. Il destinatario può accettare qualsiasi invito e iscriversi con credenziali diverse dall'indirizzo di posta elettronica dell'invito. Gli utenti di Microsoft Advertising possono accettare inviti a più clienti con le stesse credenziali. Per altre informazioni, vedere la guida tecnica Multi-User Credentials .

È possibile cercare gli inviti in sospeso in base all'ID invito e verificare se l'invito è stato accettato o è scaduto. L'operazione SearchUserInvitations restituisce tutti gli inviti in sospeso, indipendentemente dal fatto che siano scaduti o meno. Gli inviti accettati non sono inclusi nella risposta SearchUserInvitations .

Dopo aver accettato l'invito, è possibile chiamare GetUsersInfo e GetUser per accedere ai dettagli utente di Microsoft Advertising. Tuttavia, poiché un destinatario può accettare l'invito e iscriversi con credenziali diverse dall'indirizzo di posta elettronica dell'invito, non è possibile determinare con certezza il mapping da un oggetto UserInvitation a un oggetto User o UserInfo . Con l'ID utente restituito da GetUsersInfo o GetUser, è possibile chiamare DeleteUser per rimuovere l'utente in base alle esigenze. L'API Bing Ads non supporta alcuna operazione per eliminare gli inviti utente in sospeso. Dopo aver invitato un utente, l'unico modo per annullare l'invito è tramite l'applicazione Web Microsoft Advertising. È possibile trovare inviti in sospeso e accettati nella sezione Utenti di Account & Fatturazione.

Elementi della richiesta

L'oggetto SendUserInvitationRequest definisce il corpo e gli elementi di intestazione della richiesta di operazione del servizio. Gli elementi devono essere nello stesso ordine indicato nella richiesta SOAP.

Nota

Se non diversamente indicato di seguito, sono necessari tutti gli elementi della richiesta.

Elementi del corpo della richiesta

Elemento	Descrizione	Tipo di dati
UserInvitation	Invito dell'utente da inviare.	UserInvitation

Elementi dell'intestazione della richiesta

Elemento	Descrizione	Tipo di dati
AuthenticationToken	Token di accesso OAuth che rappresenta le credenziali di un utente che dispone delle autorizzazioni per gli account Microsoft Advertising. Per altre informazioni, vedere Autenticazione con OAuth.	Stringa
DeveloperToken	Token di sviluppo usato per accedere all'API Bing Ads. Per altre informazioni, vedere Ottenere un token per sviluppatori.	Stringa
Password	Questo elemento è riservato per l'uso interno e verrà rimosso da una versione futura dell'API. È necessario usare l'elemento AuthenticationToken per impostare le credenziali utente.	Stringa
UserName	Questo elemento è riservato per l'uso interno e verrà rimosso da una versione futura dell'API. È necessario usare l'elemento AuthenticationToken per impostare le credenziali utente.	Stringa

Elementi di risposta

L'oggetto SendUserInvitationResponse definisce gli elementi corpo e intestazione della risposta dell'operazione del servizio. Gli elementi vengono restituiti nello stesso ordine illustrato nella soap di risposta.

Elementi del corpo della risposta

Elemento	Descrizione	Tipo di dati
UserInvitationId	Identificatore generato dal sistema per l'invito utente inviato.	long

Elementi dell'intestazione della risposta

Elemento	Descrizione	Tipo di dati
TrackingId	Identificatore della voce di log che contiene i dettagli della chiamata API.	Stringa

Richiedi SOAP

Questo modello è stato generato da uno strumento per visualizzare l'ordine degli elementi corpo e intestazione per la richiesta SOAP. Per i tipi supportati che è possibile usare con questa operazione del servizio, vedere il riferimento Request Body Elements sopra riportato.

<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:e263="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e263:Id>ValueHere</e263:Id>
        <e263:FirstName i:nil="false">ValueHere</e263:FirstName>
        <e263:LastName i:nil="false">ValueHere</e263:LastName>
        <e263:Email i:nil="false">ValueHere</e263:Email>
        <e263:CustomerId>ValueHere</e263:CustomerId>
        <e263:RoleId>ValueHere</e263:RoleId>
        <e263:AccountIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <a1:long>ValueHere</a1:long>
        </e263:AccountIds>
        <e263:ExpirationDate>ValueHere</e263:ExpirationDate>
        <e263:Lcid>ValueHere</e263:Lcid>
      </UserInvitation>
    </SendUserInvitationRequest>
  </s:Body>
</s:Envelope>

SOAP della risposta

Questo modello è stato generato da uno strumento per visualizzare l'ordine degli elementi del corpo e dell'intestazione per la risposta 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>
    <SendUserInvitationResponse xmlns="https://bingads.microsoft.com/Customer/v13">
      <UserInvitationId>ValueHere</UserInvitationId>
    </SendUserInvitationResponse>
  </s:Body>
</s:Envelope>

Sintassi del codice

La sintassi di esempio può essere usata con gli SDK di Bing Ads. Per altri esempi, vedere Esempi di codice DELL'API Bing Ads .

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)

Requisiti

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

Condividi tramite