Operação do Serviço SendUserInvitation – Gestão de Clientes

Artigo
12/21/2023

Envia um convite por e-mail para um utilizador se inscrever no Microsoft Advertising. O convite limita o acesso e as permissões da conta.

Nota

Apenas um utilizador com credenciais Super Administração ou Standard pode enviar convites de utilizador. Um utilizador Standard não pode convidar um Super Administração. Para obter mais informações, veja o Guia técnico das Funções de Utilizador.

Importante

Quando o convite é enviado, pode optar por limitar o acesso dos utilizadores a um subconjunto de contas de anunciantes diretamente sob o seu cliente. Se uma hierarquia de agências estiver configurada (agora ou no futuro) no cliente onde o utilizador é convidado e se não limitar o acesso a contas específicas, o utilizador terá acesso a todas as contas na hierarquia.

É possível que sejam enviados vários convites pendentes para o mesmo endereço de e-mail, que ainda não expiraram. Também é possível que esses convites tenham especificado diferentes funções de utilizador, por exemplo, se enviou um convite com uma função de utilizador incorreta e, em seguida, enviou um segundo convite com a função de utilizador correta. O destinatário pode aceitar qualquer um dos convites e pode inscrever-se com credenciais diferentes do endereço de e-mail do convite. Os utilizadores do Microsoft Advertising podem aceitar convites para vários clientes com as mesmas credenciais. Para obter mais informações, veja o guia técnico Credenciais multiutilizador .

Pode procurar convites pendentes por ID de convite e saber se o convite foi aceite ou expirou. A operação SearchUserInvitations devolve todos os convites pendentes, quer tenham expirado ou não. Os convites aceites não estão incluídos na resposta SearchUserInvitations .

Depois de o convite ter sido aceite, pode ligar para GetUsersInfo e GetUser para aceder aos detalhes do utilizador do Microsoft Advertising. No entanto, uma vez que um destinatário pode aceitar o convite e inscrever-se com credenciais diferentes do endereço de e-mail de convite, não pode determinar com certeza o mapeamento de um objeto UserInvitation para um utilizador ou userInfo . Com o ID de utilizador devolvido por GetUsersInfo ou GetUser, pode chamar DeleteUser para remover o utilizador conforme necessário. A API de Anúncios do Bing não suporta operações para eliminar convites de utilizador pendentes. Depois de convidar um utilizador, a única forma de cancelar o convite é através da aplicação Web Microsoft Advertising. Pode encontrar convites pendentes e aceites na secção Utilizadores de Contas & Faturação.

Elementos do Pedido

O objeto SendUserInvitationRequest define os elementos do corpo e do cabeçalho do pedido de operação do serviço. Os elementos têm de estar na mesma ordem mostrada no Pedido SOAP.

Nota

Salvo indicação em contrário abaixo, todos os elementos do pedido são necessários.

Elementos do Corpo do Pedido

Elemento	Descrição	Tipo de Dados
UserInvitation	O convite de utilizador para enviar.	UserInvitation

Elementos do Cabeçalho do Pedido

Elemento	Descrição	Tipo de Dados
AuthenticationToken	O token de acesso OAuth que representa as credenciais de um utilizador que tem permissões para contas do Microsoft Advertising. Para obter mais informações, veja Authentication with OAuth (Autenticação com OAuth).	cadeia
DeveloperToken	O token de programador utilizado para aceder à API de Anúncios do Bing. Para obter mais informações, veja Obter um Token de Programador.	cadeia
Palavra-passe	Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador.	cadeia
Nome de Utilizador	Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador.	cadeia

Elementos de Resposta

O objeto SendUserInvitationResponse define os elementos do corpo e do cabeçalho da resposta da operação do serviço. Os elementos são devolvidos pela mesma ordem mostrada no SOAP de Resposta.

Elementos do Corpo da Resposta

Elemento	Descrição	Tipo de Dados
UserInvitationId	Um identificador gerado pelo sistema para o convite de utilizador que foi enviado.	long

Elementos do Cabeçalho de Resposta

Elemento	Descrição	Tipo de Dados
TrackingId	O identificador da entrada de registo que contém os detalhes da chamada à API.	cadeia

Pedir SOAP

Este modelo foi gerado por uma ferramenta para mostrar a ordem dos elementos do corpo e do cabeçalho do pedido SOAP. Para tipos suportados que pode utilizar com esta operação de serviço, veja a referência Request Body Elements (Elementos do Corpo do Pedido ) acima.

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

Este modelo foi gerado por uma ferramenta para mostrar a ordem dos elementos do corpo e do cabeçalho para a resposta 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>

Sintaxe de Código

A sintaxe de exemplo pode ser utilizada com os SDKs de Anúncios do Bing. Veja Exemplos de Código da API de Anúncios do Bing para obter mais exemplos.

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)

Requisitos

Serviço: CustomerManagementService.svc v13
Espaço de nomes: https://bingads.microsoft.com/Customer/v13

Compartilhar via