Operación de servicio UpdateUserRoles: Administración de clientes
Novedades los roles del usuario especificado.
Nota:
Solo un usuario con credenciales super Administración o Standard puede actualizar los roles de usuario. Un usuario Standard no puede establecer ni modificar el rol Super Administración. Para obtener más información, consulte la guía técnica Roles de usuario .
Para los usuarios con un rol de cuenta, puede agregar y eliminar las cuentas a las que el usuario tiene acceso. Para los usuarios con un rol de cliente, puede agregar y eliminar los clientes a los que el usuario tiene acceso. También puede cambiar un usuario de tener un rol de cuenta a tener un rol de cliente o viceversa.
Elementos Request
El objeto UpdateUserRolesRequest 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 |
|---|---|---|
| CustomerId | Identificador del cliente al que pertenece el usuario. | largo |
| DeleteAccountIds | Matriz de identificadores de las cuentas que se van a quitar de la lista de cuentas que el usuario puede administrar. Para obtener información sobre el uso, consulte la sección Comentarios a continuación. |
matriz larga |
| DeleteCustomerIds | Matriz de identificadores de los clientes que se van a quitar de la lista de clientes que el usuario puede administrar. Para obtener información sobre el uso, consulte la sección Comentarios a continuación. |
matriz larga |
| DeleteRoleId | Identificador del rol al que se aplican los valores especificados en el elemento DeleteAccountIds o DeleteCustomerIds , si se establece. Entre los valores posibles se encuentran: 16 - El usuario tiene el rol de Administrador de campañas de anunciantes . 33: el usuario tiene el rol agregador . 41 - El usuario tiene el rol Super Administración. 100: el usuario tiene el rol Visor . 203: el usuario tiene el rol de usuario Standard. Para obtener más información, consulte la guía técnica Roles de usuario . Importante: En la lista anterior se proporcionan ejemplos de posibles valores devueltos. Es posible que se devuelvan otros valores. Los roles internos o en desuso se pueden incluir en la respuesta. |
int |
| NewAccountIds | Matriz de identificadores de las cuentas a las que se va a restringir el usuario. El usuario solo podrá administrar estas cuentas. Si el usuario está restringido actualmente a un conjunto de cuentas, establezca este elemento en las nuevas cuentas que quiera que el usuario también administre. Por ejemplo, si el usuario administra actualmente las cuentas 123 y 456 y desea que el usuario también administre la cuenta 789, establezca este elemento en 789. Para obtener información sobre el uso, consulte la sección Comentarios a continuación. |
matriz larga |
| NewCustomerIds | Matriz de identificadores de los clientes a los que se va a restringir el usuario. El usuario solo podrá administrar estos clientes. Para obtener información sobre el uso, consulte la sección Comentarios a continuación. |
matriz larga |
| NewRoleId | Identificador del rol al que se aplican los valores especificados en el elemento NewAccountIds o NewCustomerIds , si se establece. Entre los valores posibles se encuentran: 16 - El usuario tiene el rol de Administrador de campañas de anunciantes . 33: el usuario tiene el rol agregador . 41 - El usuario tiene el rol Super Administración. 100: el usuario tiene el rol Visor . 203: el usuario tiene el rol de usuario Standard. Para obtener más información, consulte la guía técnica Roles de usuario . Importante: En la lista anterior se proporcionan ejemplos de posibles valores devueltos. Es posible que se devuelvan otros valores. Los roles internos o en desuso se pueden incluir en la respuesta. |
int |
| UserId | Identificador del usuario cuyo rol desea actualizar. | 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 UpdateUserRolesResponse 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 |
|---|---|---|
| LastModifiedTime | Fecha y hora en que se actualizaron por última vez los roles de usuario. El valor se encuentra en la hora UTC (hora universal coordinada). El valor de fecha y hora refleja la fecha y hora en el servidor, no en el cliente. Para obtener información sobre el formato de la fecha y hora, vea la entrada dateTime en Tipos de datos XML primitivos. |
dateTime |
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">UpdateUserRoles</Action>
<AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
<DeveloperToken i:nil="false">ValueHere</DeveloperToken>
</s:Header>
<s:Body>
<UpdateUserRolesRequest xmlns="https://bingads.microsoft.com/Customer/v13">
<CustomerId>ValueHere</CustomerId>
<UserId>ValueHere</UserId>
<NewRoleId i:nil="false">ValueHere</NewRoleId>
<NewAccountIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</NewAccountIds>
<NewCustomerIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</NewCustomerIds>
<DeleteRoleId i:nil="false">ValueHere</DeleteRoleId>
<DeleteAccountIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</DeleteAccountIds>
<DeleteCustomerIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</DeleteCustomerIds>
</UpdateUserRolesRequest>
</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>
<UpdateUserRolesResponse xmlns="https://bingads.microsoft.com/Customer/v13">
<LastModifiedTime>ValueHere</LastModifiedTime>
</UpdateUserRolesResponse>
</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<UpdateUserRolesResponse> UpdateUserRolesAsync(
long customerId,
long userId,
int? newRoleId,
IList<long> newAccountIds,
IList<long> newCustomerIds,
int? deleteRoleId,
IList<long> deleteAccountIds,
IList<long> deleteCustomerIds)
{
var request = new UpdateUserRolesRequest
{
CustomerId = customerId,
UserId = userId,
NewRoleId = newRoleId,
NewAccountIds = newAccountIds,
NewCustomerIds = newCustomerIds,
DeleteRoleId = deleteRoleId,
DeleteAccountIds = deleteAccountIds,
DeleteCustomerIds = deleteCustomerIds
};
return (await CustomerManagementService.CallAsync((s, r) => s.UpdateUserRolesAsync(r), request));
}
static UpdateUserRolesResponse updateUserRoles(
java.lang.Long customerId,
java.lang.Long userId,
int newRoleId,
ArrayOflong newAccountIds,
ArrayOflong newCustomerIds,
int deleteRoleId,
ArrayOflong deleteAccountIds,
ArrayOflong deleteCustomerIds) throws RemoteException, Exception
{
UpdateUserRolesRequest request = new UpdateUserRolesRequest();
request.setCustomerId(customerId);
request.setUserId(userId);
request.setNewRoleId(newRoleId);
request.setNewAccountIds(newAccountIds);
request.setNewCustomerIds(newCustomerIds);
request.setDeleteRoleId(deleteRoleId);
request.setDeleteAccountIds(deleteAccountIds);
request.setDeleteCustomerIds(deleteCustomerIds);
return CustomerManagementService.getService().updateUserRoles(request);
}
static function UpdateUserRoles(
$customerId,
$userId,
$newRoleId,
$newAccountIds,
$newCustomerIds,
$deleteRoleId,
$deleteAccountIds,
$deleteCustomerIds)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];
$request = new UpdateUserRolesRequest();
$request->CustomerId = $customerId;
$request->UserId = $userId;
$request->NewRoleId = $newRoleId;
$request->NewAccountIds = $newAccountIds;
$request->NewCustomerIds = $newCustomerIds;
$request->DeleteRoleId = $deleteRoleId;
$request->DeleteAccountIds = $deleteAccountIds;
$request->DeleteCustomerIds = $deleteCustomerIds;
return $GLOBALS['CustomerManagementProxy']->GetService()->UpdateUserRoles($request);
}
response=customermanagement_service.UpdateUserRoles(
CustomerId=CustomerId,
UserId=UserId,
NewRoleId=NewRoleId,
NewAccountIds=NewAccountIds,
NewCustomerIds=NewCustomerIds,
DeleteRoleId=DeleteRoleId,
DeleteAccountIds=DeleteAccountIds,
DeleteCustomerIds=DeleteCustomerIds)
Comentarios
Por ejemplo, si un administrador de campañas de anunciantes está limitado a administrar las cuentas 123, 456 y 789 y ya no quiere que el usuario administre 456, establezca los siguientes elementos en consecuencia:
Establezca el elemento NewRoleId en 16 (rol de administrador de campañas del anunciante).
Establezca el elemento NewAccountIds en una matriz que contenga 123 y 789.
Establezca el elemento DeleteRoleId en 16 (rol de administrador de campañas de anunciante).
Establezca el elemento DeleteAccountIds en una matriz que contenga 456.
Si un administrador de campañas de anunciantes se limita a administrar las cuentas 123 y 789 y ahora quiere que el usuario administre todas las cuentas, establezca los siguientes elementos en consecuencia:
Establezca el elemento NewRoleId en 16 (rol de administrador de campañas del anunciante).
Establezca el elemento NewAccountIds en NULL.
Establezca el elemento DeleteRoleId en 16 (rol de administrador de campañas de anunciante).
Establezca el elemento DeleteAccountIds en una matriz que contenga 123, 456 y 789.
Los usuarios con roles de nivel de cuenta pueden estar restringidos a cuentas específicas. Los usuarios con roles de nivel de cliente pueden acceder a todas las cuentas del cliente del usuario y su acceso no se puede restringir a cuentas específicas.
Nota:
Al intentar restringir los roles de usuario de nivel de cliente a cuentas específicas, no se producirá un error en la operación UpdateUserRoles y el usuario conservará el acceso para todas las cuentas del cliente del usuario.
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/UserRoles
Elementos Request
El objeto UpdateUserRolesRequest 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 |
|---|---|---|
| CustomerId | Identificador del cliente al que pertenece el usuario. | largo |
| DeleteAccountIds | Matriz de identificadores de las cuentas que se van a quitar de la lista de cuentas que el usuario puede administrar. Para obtener información sobre el uso, consulte la sección Comentarios a continuación. |
matriz larga |
| DeleteCustomerIds | Matriz de identificadores de los clientes que se van a quitar de la lista de clientes que el usuario puede administrar. Para obtener información sobre el uso, consulte la sección Comentarios a continuación. |
matriz larga |
| DeleteRoleId | Identificador del rol al que se aplican los valores especificados en el elemento DeleteAccountIds o DeleteCustomerIds , si se establece. Entre los valores posibles se encuentran: 16 - El usuario tiene el rol de Administrador de campañas de anunciantes . 33: el usuario tiene el rol agregador . 41 - El usuario tiene el rol Super Administración. 100: el usuario tiene el rol Visor . 203: el usuario tiene el rol de usuario Standard. Para obtener más información, consulte la guía técnica Roles de usuario . Importante: En la lista anterior se proporcionan ejemplos de posibles valores devueltos. Es posible que se devuelvan otros valores. Los roles internos o en desuso se pueden incluir en la respuesta. |
int |
| NewAccountIds | Matriz de identificadores de las cuentas a las que se va a restringir el usuario. El usuario solo podrá administrar estas cuentas. Si el usuario está restringido actualmente a un conjunto de cuentas, establezca este elemento en las nuevas cuentas que quiera que el usuario también administre. Por ejemplo, si el usuario administra actualmente las cuentas 123 y 456 y desea que el usuario también administre la cuenta 789, establezca este elemento en 789. Para obtener información sobre el uso, consulte la sección Comentarios a continuación. |
matriz larga |
| NewCustomerIds | Matriz de identificadores de los clientes a los que se va a restringir el usuario. El usuario solo podrá administrar estos clientes. Para obtener información sobre el uso, consulte la sección Comentarios a continuación. |
matriz larga |
| NewRoleId | Identificador del rol al que se aplican los valores especificados en el elemento NewAccountIds o NewCustomerIds , si se establece. Entre los valores posibles se encuentran: 16 - El usuario tiene el rol de Administrador de campañas de anunciantes . 33: el usuario tiene el rol agregador . 41 - El usuario tiene el rol Super Administración. 100: el usuario tiene el rol Visor . 203: el usuario tiene el rol de usuario Standard. Para obtener más información, consulte la guía técnica Roles de usuario . Importante: En la lista anterior se proporcionan ejemplos de posibles valores devueltos. Es posible que se devuelvan otros valores. Los roles internos o en desuso se pueden incluir en la respuesta. |
int |
| UserId | Identificador del usuario cuyo rol desea actualizar. | 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 UpdateUserRolesResponse 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 |
|---|---|---|
| LastModifiedTime | Fecha y hora en que se actualizaron por última vez los roles de usuario. El valor se encuentra en la hora UTC (hora universal coordinada). El valor de fecha y hora refleja la fecha y hora en el servidor, no en el cliente. Para obtener información sobre el formato de la fecha y hora, vea la entrada dateTime en Tipos de datos XML primitivos. |
dateTime |
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.
{
"CustomerId": "LongValueHere",
"UserId": "LongValueHere",
"NewRoleId": IntValueHere,
"NewAccountIds": [
"LongValueHere"
],
"NewCustomerIds": [
"LongValueHere"
],
"DeleteRoleId": IntValueHere,
"DeleteAccountIds": [
"LongValueHere"
],
"DeleteCustomerIds": [
"LongValueHere"
]
}
JSON de respuesta
Esta plantilla se generó mediante una herramienta para mostrar los elementos body y header de la respuesta JSON.
{
"LastModifiedTime": "ValueHere"
}
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<UpdateUserRolesResponse> UpdateUserRolesAsync(
long customerId,
long userId,
int? newRoleId,
IList<long> newAccountIds,
IList<long> newCustomerIds,
int? deleteRoleId,
IList<long> deleteAccountIds,
IList<long> deleteCustomerIds)
{
var request = new UpdateUserRolesRequest
{
CustomerId = customerId,
UserId = userId,
NewRoleId = newRoleId,
NewAccountIds = newAccountIds,
NewCustomerIds = newCustomerIds,
DeleteRoleId = deleteRoleId,
DeleteAccountIds = deleteAccountIds,
DeleteCustomerIds = deleteCustomerIds
};
return (await CustomerManagementService.CallAsync((s, r) => s.UpdateUserRolesAsync(r), request));
}
static UpdateUserRolesResponse updateUserRoles(
java.lang.Long customerId,
java.lang.Long userId,
int newRoleId,
ArrayOflong newAccountIds,
ArrayOflong newCustomerIds,
int deleteRoleId,
ArrayOflong deleteAccountIds,
ArrayOflong deleteCustomerIds) throws RemoteException, Exception
{
UpdateUserRolesRequest request = new UpdateUserRolesRequest();
request.setCustomerId(customerId);
request.setUserId(userId);
request.setNewRoleId(newRoleId);
request.setNewAccountIds(newAccountIds);
request.setNewCustomerIds(newCustomerIds);
request.setDeleteRoleId(deleteRoleId);
request.setDeleteAccountIds(deleteAccountIds);
request.setDeleteCustomerIds(deleteCustomerIds);
return CustomerManagementService.getService().updateUserRoles(request);
}
static function UpdateUserRoles(
$customerId,
$userId,
$newRoleId,
$newAccountIds,
$newCustomerIds,
$deleteRoleId,
$deleteAccountIds,
$deleteCustomerIds)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];
$request = new UpdateUserRolesRequest();
$request->CustomerId = $customerId;
$request->UserId = $userId;
$request->NewRoleId = $newRoleId;
$request->NewAccountIds = $newAccountIds;
$request->NewCustomerIds = $newCustomerIds;
$request->DeleteRoleId = $deleteRoleId;
$request->DeleteAccountIds = $deleteAccountIds;
$request->DeleteCustomerIds = $deleteCustomerIds;
return $GLOBALS['CustomerManagementProxy']->GetService()->UpdateUserRoles($request);
}
response=customermanagement_service.UpdateUserRoles(
CustomerId=CustomerId,
UserId=UserId,
NewRoleId=NewRoleId,
NewAccountIds=NewAccountIds,
NewCustomerIds=NewCustomerIds,
DeleteRoleId=DeleteRoleId,
DeleteAccountIds=DeleteAccountIds,
DeleteCustomerIds=DeleteCustomerIds)
Comentarios
Por ejemplo, si un administrador de campañas de anunciantes está limitado a administrar las cuentas 123, 456 y 789 y ya no quiere que el usuario administre 456, establezca los siguientes elementos en consecuencia:
Establezca el elemento NewRoleId en 16 (rol de administrador de campañas del anunciante).
Establezca el elemento NewAccountIds en una matriz que contenga 123 y 789.
Establezca el elemento DeleteRoleId en 16 (rol de administrador de campañas de anunciante).
Establezca el elemento DeleteAccountIds en una matriz que contenga 456.
Si un administrador de campañas de anunciantes se limita a administrar las cuentas 123 y 789 y ahora quiere que el usuario administre todas las cuentas, establezca los siguientes elementos en consecuencia:
Establezca el elemento NewRoleId en 16 (rol de administrador de campañas del anunciante).
Establezca el elemento NewAccountIds en NULL.
Establezca el elemento DeleteRoleId en 16 (rol de administrador de campañas de anunciante).
Establezca el elemento DeleteAccountIds en una matriz que contenga 123, 456 y 789.
Los usuarios con roles de nivel de cuenta pueden estar restringidos a cuentas específicas. Los usuarios con roles de nivel de cliente pueden acceder a todas las cuentas del cliente del usuario y su acceso no se puede restringir a cuentas específicas.
Nota:
Al intentar restringir los roles de usuario de nivel de cliente a cuentas específicas, no se producirá un error en la operación UpdateUserRoles y el usuario conservará el acceso para todas las cuentas del cliente del usuario.