Compartir a través de

Operación de servicio GetUser: Administración de clientes

  • Artículo

Obtiene los detalles de un usuario.

Sugerencia

Consulte la Guía de permisos de usuario y hierchy de la cuenta para obtener información general con ejemplos.

Elementos Request

El objeto GetUserRequest 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
UserId Identificador del usuario que se va a obtener.

Si este elemento es null o no se proporciona, la respuesta incluirá los detalles del usuario autenticado especificado en el encabezado de solicitud.		 largo

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 GetUserResponse 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
CustomerRoles Lista de roles que un usuario tiene para cada cliente o lista de cuentas.

Como mínimo, se devolverá un elemento de lista. Si las credenciales de un usuario pueden acceder a varios clientes, se devolverá un objeto CustomerRole por cliente.

Puede ver todos sus propios roles en todos los clientes; sin embargo, solo verá los roles de otros usuarios en relación con los clientes a los que puede acceder. Por ejemplo, supongamos que you@contoso.com puede another-user@contoso.com acceder al cliente A. El otro usuario también podría tener acceso al cliente B y C; sin embargo, al llamar a esta operación con su identificador de usuario, solo verá su rol en El cliente A. Cuando another-user@contoso.com llama a esta operación con sus propias credenciales, la operación devolvería tres objetos CustomerRole .		 Matriz CustomerRole
User Objeto de usuario que contiene información sobre el usuario. Usuario

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">GetUser</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <GetUserRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <UserId i:nil="false">ValueHere</UserId>
    </GetUserRequest>
  </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>
    <GetUserResponse xmlns="https://bingads.microsoft.com/Customer/v13">
      <User xmlns:e501="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e501:ContactInfo d4p1:nil="false">
          <e501:Address d4p1:nil="false">
            <e501:City d4p1:nil="false">ValueHere</e501:City>
            <e501:CountryCode d4p1:nil="false">ValueHere</e501:CountryCode>
            <e501:Id d4p1:nil="false">ValueHere</e501:Id>
            <e501:Line1 d4p1:nil="false">ValueHere</e501:Line1>
            <e501:Line2 d4p1:nil="false">ValueHere</e501:Line2>
            <e501:Line3 d4p1:nil="false">ValueHere</e501:Line3>
            <e501:Line4 d4p1:nil="false">ValueHere</e501:Line4>
            <e501:PostalCode d4p1:nil="false">ValueHere</e501:PostalCode>
            <e501:StateOrProvince d4p1:nil="false">ValueHere</e501:StateOrProvince>
            <e501:TimeStamp d4p1:nil="false">ValueHere</e501:TimeStamp>
            <e501:BusinessName d4p1:nil="false">ValueHere</e501:BusinessName>
          </e501:Address>
          <e501:ContactByPhone d4p1:nil="false">ValueHere</e501:ContactByPhone>
          <e501:ContactByPostalMail d4p1:nil="false">ValueHere</e501:ContactByPostalMail>
          <e501:Email d4p1:nil="false">ValueHere</e501:Email>
          <e501:EmailFormat d4p1:nil="false">ValueHere</e501:EmailFormat>
          <e501:Fax d4p1:nil="false">ValueHere</e501:Fax>
          <e501:HomePhone d4p1:nil="false">ValueHere</e501:HomePhone>
          <e501:Id d4p1:nil="false">ValueHere</e501:Id>
          <e501:Mobile d4p1:nil="false">ValueHere</e501:Mobile>
          <e501:Phone1 d4p1:nil="false">ValueHere</e501:Phone1>
          <e501:Phone2 d4p1:nil="false">ValueHere</e501:Phone2>
        </e501:ContactInfo>
        <e501:CustomerId d4p1:nil="false">ValueHere</e501:CustomerId>
        <e501:Id d4p1:nil="false">ValueHere</e501:Id>
        <e501:JobTitle d4p1:nil="false">ValueHere</e501:JobTitle>
        <e501:LastModifiedByUserId d4p1:nil="false">ValueHere</e501:LastModifiedByUserId>
        <e501:LastModifiedTime d4p1:nil="false">ValueHere</e501:LastModifiedTime>
        <e501:Lcid d4p1:nil="false">ValueHere</e501:Lcid>
        <e501:Name d4p1:nil="false">
          <e501:FirstName d4p1:nil="false">ValueHere</e501:FirstName>
          <e501:LastName d4p1:nil="false">ValueHere</e501:LastName>
          <e501:MiddleInitial d4p1:nil="false">ValueHere</e501:MiddleInitial>
        </e501:Name>
        <e501:Password d4p1:nil="false">ValueHere</e501:Password>
        <e501:SecretAnswer d4p1:nil="false">ValueHere</e501:SecretAnswer>
        <e501:SecretQuestion>ValueHere</e501:SecretQuestion>
        <e501:UserLifeCycleStatus d4p1:nil="false">ValueHere</e501:UserLifeCycleStatus>
        <e501:TimeStamp d4p1:nil="false">ValueHere</e501:TimeStamp>
        <e501:UserName d4p1:nil="false">ValueHere</e501:UserName>
        <e501:ForwardCompatibilityMap xmlns:e502="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
          <e502:KeyValuePairOfstringstring>
            <e502:key d4p1:nil="false">ValueHere</e502:key>
            <e502:value d4p1:nil="false">ValueHere</e502:value>
          </e502:KeyValuePairOfstringstring>
        </e501:ForwardCompatibilityMap>
        <e501:AuthenticationToken d4p1:nil="false">ValueHere</e501:AuthenticationToken>
      </User>
      <CustomerRoles xmlns:e503="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e503:CustomerRole>
          <e503:RoleId>ValueHere</e503:RoleId>
          <e503:CustomerId>ValueHere</e503:CustomerId>
          <e503:AccountIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <a1:long>ValueHere</a1:long>
          </e503:AccountIds>
          <e503:LinkedAccountIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <a1:long>ValueHere</a1:long>
          </e503:LinkedAccountIds>
          <e503:CustomerLinkPermission d4p1:nil="false">ValueHere</e503:CustomerLinkPermission>
        </e503:CustomerRole>
      </CustomerRoles>
    </GetUserResponse>
  </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<GetUserResponse> GetUserAsync(
	long? userId)
{
	var request = new GetUserRequest
	{
		UserId = userId
	};

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

static GetUserResponse getUser(
	java.lang.Long userId) throws RemoteException, Exception
{
	GetUserRequest request = new GetUserRequest();

	request.setUserId(userId);

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

static function GetUser(
	$userId)
{

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

	$request = new GetUserRequest();

	$request->UserId = $userId;

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

response=customermanagement_service.GetUser(
	UserId=UserId)

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/User/Query

Elementos Request

El objeto GetUserRequest 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
UserId Identificador del usuario que se va a obtener.

Si este elemento es null o no se proporciona, la respuesta incluirá los detalles del usuario autenticado especificado en el encabezado de solicitud.		 largo

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 GetUserResponse 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
CustomerRoles Lista de roles que un usuario tiene para cada cliente o lista de cuentas.

Como mínimo, se devolverá un elemento de lista. Si las credenciales de un usuario pueden acceder a varios clientes, se devolverá un objeto CustomerRole por cliente.

Puede ver todos sus propios roles en todos los clientes; sin embargo, solo verá los roles de otros usuarios en relación con los clientes a los que puede acceder. Por ejemplo, supongamos que you@contoso.com puede another-user@contoso.com acceder al cliente A. El otro usuario también podría tener acceso al cliente B y C; sin embargo, al llamar a esta operación con su identificador de usuario, solo verá su rol en El cliente A. Cuando another-user@contoso.com llama a esta operación con sus propias credenciales, la operación devolvería tres objetos CustomerRole .		 Matriz CustomerRole
User Objeto de usuario que contiene información sobre el usuario. Usuario

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.

{
  "UserId": "LongValueHere"
}

JSON de respuesta

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

{
  "User": {
    "AuthenticationToken": "ValueHere",
    "ContactInfo": {
      "Address": {
        "BusinessName": "ValueHere",
        "City": "ValueHere",
        "CountryCode": "ValueHere",
        "Id": "LongValueHere",
        "Line1": "ValueHere",
        "Line2": "ValueHere",
        "Line3": "ValueHere",
        "Line4": "ValueHere",
        "PostalCode": "ValueHere",
        "StateOrProvince": "ValueHere",
        "TimeStamp": "ValueHere"
      },
      "ContactByPhone": "ValueHere",
      "ContactByPostalMail": "ValueHere",
      "Email": "ValueHere",
      "EmailFormat": "ValueHere",
      "Fax": "ValueHere",
      "HomePhone": "ValueHere",
      "Id": "LongValueHere",
      "Mobile": "ValueHere",
      "Phone1": "ValueHere",
      "Phone2": "ValueHere"
    },
    "CustomerId": "LongValueHere",
    "ForwardCompatibilityMap": [
      {
        "key": "ValueHere",
        "value": "ValueHere"
      }
    ],
    "Id": "LongValueHere",
    "JobTitle": "ValueHere",
    "LastModifiedByUserId": "LongValueHere",
    "LastModifiedTime": "ValueHere",
    "Lcid": "ValueHere",
    "Name": {
      "FirstName": "ValueHere",
      "LastName": "ValueHere",
      "MiddleInitial": "ValueHere"
    },
    "Password": "ValueHere",
    "SecretAnswer": "ValueHere",
    "SecretQuestion": "ValueHere",
    "TimeStamp": "ValueHere",
    "UserLifeCycleStatus": "ValueHere",
    "UserName": "ValueHere"
  },
  "CustomerRoles": [
    {
      "AccountIds": [
        "LongValueHere"
      ],
      "CustomerId": "LongValueHere",
      "CustomerLinkPermission": "ValueHere",
      "LinkedAccountIds": [
        "LongValueHere"
      ],
      "RoleId": IntValueHere
    }
  ]
}

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<GetUserResponse> GetUserAsync(
	long? userId)
{
	var request = new GetUserRequest
	{
		UserId = userId
	};

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

static GetUserResponse getUser(
	java.lang.Long userId) throws RemoteException, Exception
{
	GetUserRequest request = new GetUserRequest();

	request.setUserId(userId);

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

static function GetUser(
	$userId)
{

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

	$request = new GetUserRequest();

	$request->UserId = $userId;

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

response=customermanagement_service.GetUser(
	UserId=UserId)