Compartir a través de

Operación del servicio SendUserInvitation: Administración de clientes

  • Artículo

Envía una invitación por correo electrónico para que un usuario se registre en Microsoft Advertising. La invitación limita el acceso y los permisos de la cuenta.

Nota:

Solo un usuario con credenciales de Super Administración o Standard puede enviar invitaciones de usuario. Un usuario Standard no puede invitar a un super Administración. Para obtener más información, consulte la guía técnica Roles de usuario.

Importante

Cuando se envía la invitación, puede optar por limitar el acceso del usuario a un subconjunto de cuentas de anunciantes que están directamente bajo su cliente. Si se configura una jerarquía de agencia (ahora o en el futuro) en el cliente donde se invita al usuario y si no limita el acceso a cuentas específicas, el usuario tendrá acceso a todas las cuentas de la jerarquía.

Es posible enviar varias invitaciones pendientes a la misma dirección de correo electrónico, que aún no han expirado. También es posible que esas invitaciones hayan especificado diferentes roles de usuario, por ejemplo, si envió una invitación con un rol de usuario incorrecto y, a continuación, envió una segunda invitación con el rol de usuario correcto. El destinatario puede aceptar cualquiera de las invitaciones y puede registrarse con credenciales distintas de la dirección de correo electrónico de invitación. Los usuarios de Microsoft Advertising pueden aceptar invitaciones a varios clientes con las mismas credenciales. Para obtener más información, consulte la Guía técnica de credenciales de varios usuarios .

Puede buscar invitaciones pendientes por identificador de invitación y averiguar si la invitación se ha aceptado o no o ha expirado. La operación SearchUserInvitations devuelve todas las invitaciones pendientes, independientemente de si han expirado o no. Las invitaciones aceptadas no se incluyen en la respuesta SearchUserInvitations .

Una vez aceptada la invitación, puede llamar a GetUsersInfo y GetUser para acceder a los detalles del usuario de Microsoft Advertising. Sin embargo, dado que un destinatario puede aceptar la invitación y registrarse con credenciales que difieren de la dirección de correo electrónico de invitación, no puede determinar con certeza la asignación de un objeto UserInvitation a un objeto User o UserInfo . Con el identificador de usuario devuelto por GetUsersInfo o GetUser, puede llamar a DeleteUser para quitar el usuario según sea necesario. Bing Ads API no admite ninguna operación para eliminar invitaciones de usuario pendientes. Después de invitar a un usuario, la única manera de cancelar la invitación es a través de la aplicación web microsoft Advertising. Puede encontrar invitaciones pendientes y aceptadas en la sección Usuarios de Cuentas & Facturación.

Elementos Request

El objeto SendUserInvitationRequest define los elementos body y header de la solicitud de operación de servicio. Los elementos deben estar en el mismo orden que se muestra en la solicitud SOAP.

Nota:

A menos que se indique lo contrario a continuación, se requieren todos los elementos de solicitud.

Elementos del cuerpo de la solicitud

Elemento Descripción Tipo de datos
UserInvitation Invitación del usuario que se va a enviar. UserInvitation

Elementos de encabezado de solicitud

Elemento Descripción Tipo de datos
AuthenticationToken Token de acceso de OAuth que representa las credenciales de un usuario que tiene permisos para cuentas de Microsoft Advertising.

Para obtener más información, consulte Autenticación con OAuth.		 string
DeveloperToken Token de desarrollador que se usa para acceder a Bing Ads API.

Para obtener más información, consulte Obtención de un token de desarrollador.		 string
Password Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. string
UserName Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. string

Elementos de respuesta

El objeto SendUserInvitationResponse define los elementos body y header de la respuesta de la operación de servicio. Los elementos se devuelven en el mismo orden que se muestra en soap de respuesta.

Elementos del cuerpo de la respuesta

Elemento Descripción Tipo de datos
UserInvitationId Identificador generado por el sistema para la invitación de usuario que se envió. largo

Elementos de encabezado de respuesta

Elemento Descripción Tipo de datos
Seguimiento del Id. Identificador de la entrada de registro que contiene los detalles de la llamada API. string

Solicitud de SOAP

Esta plantilla se generó mediante una herramienta para mostrar el orden del cuerpo y los elementos de encabezado de la solicitud SOAP. Para ver los tipos admitidos que puede usar con esta operación de servicio, consulte la referencia de elementos de cuerpo de solicitud anterior.

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

SOAP de respuesta

Esta plantilla se generó mediante una herramienta para mostrar el orden de los elementos body y header para la respuesta 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>

Sintaxis de código

La sintaxis de ejemplo se puede usar con los SDK de Bing Ads. Consulte Ejemplos de código de API de Bing Ads para obtener más ejemplos.

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

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

Dirección URL de solicitud

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

Elementos Request

El objeto SendUserInvitationRequest define los elementos body y header de la solicitud de operación de servicio.

Nota:

A menos que se indique lo contrario a continuación, se requieren todos los elementos de solicitud.

Elementos del cuerpo de la solicitud

Elemento Descripción Tipo de datos
UserInvitation Invitación del usuario que se va a enviar. UserInvitation

Elementos de encabezado de solicitud

Elemento Descripción Tipo de datos
Autorización Token de acceso de OAuth que representa las credenciales de un usuario que tiene permisos para cuentas de Microsoft Advertising. Asegúrese de que el token tiene el prefijo "Portador", esto es necesario para la autenticación adecuada.

Para obtener más información, consulte Autenticación con OAuth.		 string
DeveloperToken Token de desarrollador que se usa para acceder a Bing Ads API.

Para obtener más información, consulte Obtención de un token de desarrollador.		 string
Password Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. string
UserName Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. string

Elementos de respuesta

El objeto SendUserInvitationResponse define los elementos body y header de la respuesta de la operación de servicio. Los elementos se devuelven en el mismo orden que se muestra en el JSON de respuesta.

Elementos del cuerpo de la respuesta

Elemento Descripción Tipo de datos
UserInvitationId Identificador generado por el sistema para la invitación de usuario que se envió. largo

Elementos de encabezado de respuesta

Elemento Descripción Tipo de datos
Seguimiento del Id. Identificador de la entrada de registro que contiene los detalles de la llamada API. string

Solicitud de JSON

Esta plantilla se generó mediante una herramienta para mostrar los elementos body y header de la solicitud JSON. Para ver los tipos admitidos que puede usar con esta operación de servicio, consulte la referencia de elementos de cuerpo de solicitud anterior.

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

JSON de respuesta

Esta plantilla se generó mediante una herramienta para mostrar los elementos body y header de la respuesta JSON.

{
  "UserInvitationId": "LongValueHere"
}

Sintaxis de código

Para llamar a la API REST a través de SDK, debe actualizar el SDK a una versión determinada y configurar los parámetros del sistema. La sintaxis de ejemplo se puede usar con los SDK de Bing Ads. Consulte Ejemplos de código de API de Bing Ads para obtener más ejemplos.

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)