UpdateUserRoles Service Operation - Customer Management
Mises à jour les rôles de l’utilisateur spécifié.
Remarque
Seul un utilisateur disposant d’informations d’identification Super Administration ou Standard peut mettre à jour les rôles d’utilisateur. Un utilisateur Standard ne peut pas définir ou modifier le rôle Super Administration. Pour plus d’informations, consultez le guide technique rôles d’utilisateur .
Pour les utilisateurs disposant d’un rôle de compte, vous pouvez ajouter et supprimer les comptes auxquels l’utilisateur a accès. Pour les utilisateurs disposant d’un rôle client, vous pouvez ajouter et supprimer les clients auxquels l’utilisateur a accès. Vous pouvez également faire passer un utilisateur d’un rôle de compte à un rôle client ou vice versa.
Éléments de demande
L’objet UpdateUserRolesRequest définit les éléments body et header de la demande d’opération de service. Les éléments doivent être dans le même ordre que celui indiqué dans la requête SOAP.
Remarque
Sauf indication contraire ci-dessous, tous les éléments de requête sont requis.
Éléments du corps de la requête
| Élément | Description | Type de données |
|---|---|---|
| CustomerId | Identificateur du client auquel l’utilisateur appartient. | long |
| DeleteAccountIds | Tableau d’identificateurs des comptes à supprimer de la liste des comptes que l’utilisateur peut gérer. Pour l’utilisation, consultez la section Remarques ci-dessous. |
tableau long |
| DeleteCustomerIds | Tableau d’identificateurs des clients à supprimer de la liste des clients que l’utilisateur peut gérer. Pour l’utilisation, consultez la section Remarques ci-dessous. |
tableau long |
| DeleteRoleId | Identificateur du rôle auquel les valeurs spécifiées dans l’élément DeleteAccountIds ou DeleteCustomerIds s’appliquent , si elles sont définies. Les valeurs possibles sont les suivantes : 16 - L’utilisateur a le rôle Gestionnaire de campagne de l’annonceur . 33 - L’utilisateur a le rôle Agrégateur . 41 - L’utilisateur a le rôle Super Administration. 100 - L’utilisateur a le rôle Visionneuse . 203 - L’utilisateur a le rôle Utilisateur Standard. Pour plus d’informations, consultez le guide technique rôles d’utilisateur . Important : la liste ci-dessus fournit des exemples de valeurs de retour possibles. D’autres valeurs peuvent être retournées. Les rôles internes ou dépréciés peuvent être inclus dans la réponse. |
int |
| NewAccountIds | Tableau d’identificateurs des comptes auxquels restreindre l’utilisateur. L’utilisateur sera en mesure de gérer uniquement ces comptes. Si l’utilisateur est actuellement limité à un ensemble de comptes, définissez cet élément sur les nouveaux comptes que vous souhaitez que l’utilisateur gère également. Par exemple, si l’utilisateur gère actuellement les comptes 123 et 456 et que vous souhaitez que l’utilisateur gère également le compte 789, définissez cet élément sur 789. Pour l’utilisation, consultez la section Remarques ci-dessous. |
tableau long |
| NewCustomerIds | Tableau d’identificateurs des clients à restreindre à l’utilisateur. L’utilisateur sera en mesure de gérer uniquement ces clients. Pour l’utilisation, consultez la section Remarques ci-dessous. |
tableau long |
| NewRoleId | Identificateur du rôle auquel les valeurs spécifiées dans l’élément NewAccountIds ou NewCustomerIds s’appliquent, si elles sont définies. Les valeurs possibles sont les suivantes : 16 - L’utilisateur a le rôle Gestionnaire de campagne de l’annonceur . 33 - L’utilisateur a le rôle Agrégateur . 41 - L’utilisateur a le rôle Super Administration. 100 - L’utilisateur a le rôle Visionneuse . 203 - L’utilisateur a le rôle Utilisateur Standard. Pour plus d’informations, consultez le guide technique rôles d’utilisateur . Important : la liste ci-dessus fournit des exemples de valeurs de retour possibles. D’autres valeurs peuvent être retournées. Les rôles internes ou dépréciés peuvent être inclus dans la réponse. |
int |
| UserId | Identificateur de l’utilisateur dont vous souhaitez mettre à jour le rôle. | long |
Éléments d’en-tête de requête
| Élément | Description | Type de données |
|---|---|---|
| AuthenticationToken | Jeton d’accès OAuth qui représente les informations d’identification d’un utilisateur disposant d’autorisations sur les comptes Microsoft Advertising. Pour plus d’informations, consultez Authentification avec OAuth. |
chaîne |
| DeveloperToken | Jeton de développeur utilisé pour accéder à l’API Bing Ads. Pour plus d’informations, consultez Obtenir un jeton de développeur. |
chaîne |
| Mot de passe | Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur. | chaîne |
| UserName | Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur. | chaîne |
Éléments Response
L’objet UpdateUserRolesResponse définit les éléments body et header de la réponse de l’opération de service. Les éléments sont retournés dans le même ordre que celui indiqué dans la réponse SOAP.
Response Body, éléments
| Élément | Description | Type de données |
|---|---|---|
| LastModifiedTime | Date et heure de la dernière mise à jour des rôles d’utilisateur. La valeur est exprimée au format UTC (temps universel coordonné). La valeur de date et d’heure reflète la date et l’heure sur le serveur, et non le client. Pour plus d’informations sur le format de la date et de l’heure, consultez l’entrée dateTime dans Types de données XML primitifs. |
dateTime |
Éléments d’en-tête de réponse
| Élément | Description | Type de données |
|---|---|---|
| TrackingId | Identificateur de l’entrée de journal qui contient les détails de l’appel d’API. | chaîne |
Requête SOAP
Ce modèle a été généré par un outil pour afficher l’ordre des éléments body et header pour la requête SOAP. Pour connaître les types pris en charge que vous pouvez utiliser avec cette opération de service, consultez la référence Éléments du corps de la demande ci-dessus.
<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 réponse
Ce modèle a été généré par un outil pour afficher l’ordre des éléments de corps et d’en-tête pour la réponse 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>
Syntaxe du code
L’exemple de syntaxe peut être utilisé avec les Kits de développement logiciel (SDK) Bing Ads. Pour plus d’exemples, consultez Exemples de code de l’API Bing Ads .
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)
Remarques
Par exemple, si un responsable de campagne d’annonceur est limité à la gestion des comptes 123, 456 et 789 et que vous ne souhaitez plus que l’utilisateur gère 456, définissez les éléments suivants en conséquence :
Définissez l’élément NewRoleId sur 16 (rôle de gestionnaire de campagne de l’annonceur).
Définissez l’élément NewAccountIds sur un tableau qui contient 123 et 789.
Définissez l’élément DeleteRoleId sur 16 (rôle de gestionnaire de campagne de l’annonceur).
Définissez l’élément DeleteAccountIds sur un tableau qui contient 456.
Si un responsable de campagne d’annonceur est limité à la gestion des comptes 123 et 789 et que vous souhaitez maintenant que l’utilisateur gère tous les comptes, définissez les éléments suivants en conséquence :
Définissez l’élément NewRoleId sur 16 (rôle de gestionnaire de campagne de l’annonceur).
Définissez l’élément NewAccountIds sur NULL.
Définissez l’élément DeleteRoleId sur 16 (rôle de gestionnaire de campagne de l’annonceur).
Définissez l’élément DeleteAccountIds sur un tableau qui contient 123, 456 et 789.
Les utilisateurs disposant de rôles au niveau du compte peuvent être limités à des comptes spécifiques. Les utilisateurs disposant de rôles au niveau du client peuvent accéder à tous les comptes au sein du client de l’utilisateur, et leur accès ne peut pas être limité à des comptes spécifiques.
Remarque
Lorsque vous tentez de restreindre les rôles d’utilisateur au niveau du client à des comptes spécifiques, l’opération UpdateUserRoles n’échoue pas et l’utilisateur conserve l’accès pour tous les comptes au sein du client de l’utilisateur.
Configuration requise
Service : CustomerManagementService.svc v13
Namespace: https://bingads.microsoft.com/Customer/v13
URL de la demande
https://clientcenter.api.bingads.microsoft.com/CustomerManagement/v13/UserRoles
Éléments de demande
L’objet UpdateUserRolesRequest définit les éléments body et header de la demande d’opération de service.
Remarque
Sauf indication contraire ci-dessous, tous les éléments de requête sont requis.
Éléments du corps de la requête
| Élément | Description | Type de données |
|---|---|---|
| CustomerId | Identificateur du client auquel l’utilisateur appartient. | long |
| DeleteAccountIds | Tableau d’identificateurs des comptes à supprimer de la liste des comptes que l’utilisateur peut gérer. Pour l’utilisation, consultez la section Remarques ci-dessous. |
tableau long |
| DeleteCustomerIds | Tableau d’identificateurs des clients à supprimer de la liste des clients que l’utilisateur peut gérer. Pour l’utilisation, consultez la section Remarques ci-dessous. |
tableau long |
| DeleteRoleId | Identificateur du rôle auquel les valeurs spécifiées dans l’élément DeleteAccountIds ou DeleteCustomerIds s’appliquent , si elles sont définies. Les valeurs possibles sont les suivantes : 16 - L’utilisateur a le rôle Gestionnaire de campagne de l’annonceur . 33 - L’utilisateur a le rôle Agrégateur . 41 - L’utilisateur a le rôle Super Administration. 100 - L’utilisateur a le rôle Visionneuse . 203 - L’utilisateur a le rôle Utilisateur Standard. Pour plus d’informations, consultez le guide technique rôles d’utilisateur . Important : la liste ci-dessus fournit des exemples de valeurs de retour possibles. D’autres valeurs peuvent être retournées. Les rôles internes ou dépréciés peuvent être inclus dans la réponse. |
int |
| NewAccountIds | Tableau d’identificateurs des comptes auxquels restreindre l’utilisateur. L’utilisateur sera en mesure de gérer uniquement ces comptes. Si l’utilisateur est actuellement limité à un ensemble de comptes, définissez cet élément sur les nouveaux comptes que vous souhaitez que l’utilisateur gère également. Par exemple, si l’utilisateur gère actuellement les comptes 123 et 456 et que vous souhaitez que l’utilisateur gère également le compte 789, définissez cet élément sur 789. Pour l’utilisation, consultez la section Remarques ci-dessous. |
tableau long |
| NewCustomerIds | Tableau d’identificateurs des clients à restreindre à l’utilisateur. L’utilisateur sera en mesure de gérer uniquement ces clients. Pour l’utilisation, consultez la section Remarques ci-dessous. |
tableau long |
| NewRoleId | Identificateur du rôle auquel les valeurs spécifiées dans l’élément NewAccountIds ou NewCustomerIds s’appliquent, si elles sont définies. Les valeurs possibles sont les suivantes : 16 - L’utilisateur a le rôle Gestionnaire de campagne de l’annonceur . 33 - L’utilisateur a le rôle Agrégateur . 41 - L’utilisateur a le rôle Super Administration. 100 - L’utilisateur a le rôle Visionneuse . 203 - L’utilisateur a le rôle Utilisateur Standard. Pour plus d’informations, consultez le guide technique rôles d’utilisateur . Important : la liste ci-dessus fournit des exemples de valeurs de retour possibles. D’autres valeurs peuvent être retournées. Les rôles internes ou dépréciés peuvent être inclus dans la réponse. |
int |
| UserId | Identificateur de l’utilisateur dont vous souhaitez mettre à jour le rôle. | long |
Éléments d’en-tête de requête
| Élément | Description | Type de données |
|---|---|---|
| Autorisation | Jeton d’accès OAuth qui représente les informations d’identification d’un utilisateur disposant d’autorisations sur les comptes Microsoft Advertising. Vérifiez que le jeton est précédé de « Porteur », ce qui est nécessaire pour une authentification appropriée. Pour plus d’informations, consultez Authentification avec OAuth. |
chaîne |
| DeveloperToken | Jeton de développeur utilisé pour accéder à l’API Bing Ads. Pour plus d’informations, consultez Obtenir un jeton de développeur. |
chaîne |
| Mot de passe | Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur. | chaîne |
| UserName | Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur. | chaîne |
Éléments Response
L’objet UpdateUserRolesResponse définit les éléments body et header de la réponse de l’opération de service. Les éléments sont retournés dans le même ordre que celui indiqué dans le json de réponse.
Response Body, éléments
| Élément | Description | Type de données |
|---|---|---|
| LastModifiedTime | Date et heure de la dernière mise à jour des rôles d’utilisateur. La valeur est exprimée au format UTC (temps universel coordonné). La valeur de date et d’heure reflète la date et l’heure sur le serveur, et non le client. Pour plus d’informations sur le format de la date et de l’heure, consultez l’entrée dateTime dans Types de données XML primitifs. |
dateTime |
Éléments d’en-tête de réponse
| Élément | Description | Type de données |
|---|---|---|
| TrackingId | Identificateur de l’entrée de journal qui contient les détails de l’appel d’API. | chaîne |
Requête JSON
Ce modèle a été généré par un outil pour afficher le corps et les éléments d’en-tête de la requête JSON. Pour connaître les types pris en charge que vous pouvez utiliser avec cette opération de service, consultez la référence Éléments du corps de la demande ci-dessus.
{
"CustomerId": "LongValueHere",
"UserId": "LongValueHere",
"NewRoleId": IntValueHere,
"NewAccountIds": [
"LongValueHere"
],
"NewCustomerIds": [
"LongValueHere"
],
"DeleteRoleId": IntValueHere,
"DeleteAccountIds": [
"LongValueHere"
],
"DeleteCustomerIds": [
"LongValueHere"
]
}
JSON de réponse
Ce modèle a été généré par un outil pour afficher le corps et les éléments d’en-tête de la réponse JSON.
{
"LastModifiedTime": "ValueHere"
}
Syntaxe du code
Pour appeler l’API REST via des kits SDK, vous devez mettre à niveau le KIT de développement logiciel (SDK) vers une certaine version et configurer les paramètres système. L’exemple de syntaxe peut être utilisé avec les Kits de développement logiciel (SDK) Bing Ads. Pour plus d’exemples, consultez Exemples de code de l’API Bing Ads .
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)
Remarques
Par exemple, si un responsable de campagne d’annonceur est limité à la gestion des comptes 123, 456 et 789 et que vous ne souhaitez plus que l’utilisateur gère 456, définissez les éléments suivants en conséquence :
Définissez l’élément NewRoleId sur 16 (rôle de gestionnaire de campagne de l’annonceur).
Définissez l’élément NewAccountIds sur un tableau qui contient 123 et 789.
Définissez l’élément DeleteRoleId sur 16 (rôle de gestionnaire de campagne de l’annonceur).
Définissez l’élément DeleteAccountIds sur un tableau qui contient 456.
Si un responsable de campagne d’annonceur est limité à la gestion des comptes 123 et 789 et que vous souhaitez maintenant que l’utilisateur gère tous les comptes, définissez les éléments suivants en conséquence :
Définissez l’élément NewRoleId sur 16 (rôle de gestionnaire de campagne de l’annonceur).
Définissez l’élément NewAccountIds sur NULL.
Définissez l’élément DeleteRoleId sur 16 (rôle de gestionnaire de campagne de l’annonceur).
Définissez l’élément DeleteAccountIds sur un tableau qui contient 123, 456 et 789.
Les utilisateurs disposant de rôles au niveau du compte peuvent être limités à des comptes spécifiques. Les utilisateurs disposant de rôles au niveau du client peuvent accéder à tous les comptes au sein du client de l’utilisateur, et leur accès ne peut pas être limité à des comptes spécifiques.
Remarque
Lorsque vous tentez de restreindre les rôles d’utilisateur au niveau du client à des comptes spécifiques, l’opération UpdateUserRoles n’échoue pas et l’utilisateur conserve l’accès pour tous les comptes au sein du client de l’utilisateur.