UpdateUserRoles サービス操作 - 顧客管理

[アーティクル]
10/04/2023

指定したユーザーのロールをUpdatesします。

注:

ユーザーロールを更新できるのは、Super Admin または Standard 資格情報を持つユーザーのみです。 Standard ユーザーは、Super Admin ロールを設定または変更できません。詳細については、ユーザーロールのテクニカルガイドを参照してください。

アカウントロールを持つユーザーの場合は、ユーザーがアクセスできるアカウントを追加および削除できます。顧客ロールを持つユーザーの場合は、ユーザーがアクセスできる顧客を追加および削除できます。また、ユーザーがアカウントロールを持つことから顧客ロールを持つこと、またはその逆に変更することもできます。

Request 要素

UpdateUserRolesRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。要素は、要求 SOAP に示されている順序と同じ順序である必要があります。

注:

以下に特に記載がない限り、すべての要求要素が必要です。

要求本文要素

要素	説明	データ型
Customerid	ユーザーが属している顧客の識別子。	long
DeleteAccountIds	ユーザーが管理できるアカウントの一覧から削除するアカウントの識別子の配列。使用については、以下の「備考」セクションを参照してください。	long 配列
DeleteCustomerIds	ユーザーが管理できる顧客の一覧から削除する顧客の識別子の配列。使用については、以下の「備考」セクションを参照してください。	long 配列
DeleteRoleId	DeleteAccountIds または DeleteCustomerIds 要素で指定された値が適用されるロールの識別子 (設定されている場合)。以下のいずれかの値を使用できます。 16 - ユーザーは広告主キャンペーンマネージャーロールを持ちます。 33 - ユーザーはアグリゲーターロールを持っています。 41 - ユーザーは Super Admin ロールを持っています。 100 - ユーザーはビューアーロールを持ちます。 203 - ユーザーは Standard User ロールを持っています。詳細については、ユーザーロールのテクニカルガイドを参照してください。重要: 上記の一覧では、可能な戻り値の例を示します。その他の値が返される場合があります。非推奨または内部ロールを応答に含めることができます。	int
NewAccountIds	ユーザーを制限するアカウントの識別子の配列。ユーザーは、これらのアカウントのみを管理できます。ユーザーが現在一連のアカウントに制限されている場合は、この要素を、ユーザーが管理する新しいアカウントに設定します。たとえば、ユーザーが現在アカウント 123 と 456 を管理していて、アカウント 789 も管理する場合は、この要素を 789 に設定します。使用については、以下の「備考」セクションを参照してください。	long 配列
NewCustomerIds	ユーザーを制限する顧客の識別子の配列。ユーザーは、これらの顧客のみを管理できます。使用については、以下の「備考」セクションを参照してください。	long 配列
NewRoleId	NewAccountIds または NewCustomerIds 要素で指定された値が適用されるロールの識別子 (設定されている場合)。以下のいずれかの値を使用できます。 16 - ユーザーは広告主キャンペーンマネージャーロールを持ちます。 33 - ユーザーはアグリゲーターロールを持っています。 41 - ユーザーは Super Admin ロールを持っています。 100 - ユーザーはビューアーロールを持ちます。 203 - ユーザーは Standard User ロールを持っています。詳細については、ユーザーロールのテクニカルガイドを参照してください。重要: 上記の一覧では、可能な戻り値の例を示します。その他の値が返される場合があります。非推奨または内部ロールを応答に含めることができます。	int
UserId	ロールを更新するユーザーの識別子。	long

要求ヘッダー要素

要素	説明	データ型
AuthenticationToken	Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセストークン。詳細については、「 OAuth による認証」を参照してください。	string
DeveloperToken	Bing Ads API へのアクセスに使用される開発者トークン。詳細については、「開発者トークンを取得する」を参照してください。	string
Password	この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。	string
UserName	この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。	string

Response 要素

UpdateUserRolesResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。要素は、応答 SOAP に示されている順序と同じ順序で返されます。

応答本文の要素

要素	説明	データ型
LastModifiedTime	ユーザーロールが最後に更新された日時。値は、世界協定時刻 (UTC) です。日付と時刻の値は、クライアントではなく、サーバーでの日付と時刻を反映します。日付と時刻の形式については、「プリミティブ XML データ型」の dateTime エントリを参照してください。	dateTime

応答ヘッダー要素

要素	説明	データ型
TrackingId	API 呼び出しの詳細を含むログエントリの識別子。	string

SOAP を要求する

このテンプレートは、SOAP 要求の本文要素とヘッダー要素の順序を示すツールによって生成されました。このサービス操作で使用できるサポートされる型については、上記の要求本文要素のリファレンスを参照してください。

<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

このテンプレートは、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>

コード構文

構文の例は、 Bing広告 SDK で使用できます。その他の例については、「Bing広告 API コードの例」を参照してください。

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)

注釈

たとえば、広告主キャンペーンマネージャーがアカウント 123、456、789 の管理に制限されており、ユーザーが 456 を管理できないようにする場合は、次の要素を適宜設定します。

NewRoleId 要素を 16 (広告主キャンペーンマネージャーロール) に設定します。
NewAccountIds 要素を、123 と 789 を含む配列に設定します。
DeleteRoleId 要素を 16 (広告主キャンペーンマネージャーロール) に設定します。
DeleteAccountIds 要素を、456 を含む配列に設定します。

広告主キャンペーンマネージャーがアカウント 123 と 789 の管理に制限されていて、ユーザーにすべてのアカウントを管理する場合は、それに応じて次の要素を設定します。

NewRoleId 要素を 16 (広告主キャンペーンマネージャーロール) に設定します。
NewAccountIds 要素を NULL に設定します。
DeleteRoleId 要素を 16 (広告主キャンペーンマネージャーロール) に設定します。
DeleteAccountIds 要素を、123、456、789 を含む配列に設定します。

アカウントレベルのロールを持つユーザーは、特定のアカウントに制限できます。顧客レベルのロールを持つユーザーは、ユーザーの顧客内のすべてのアカウントにアクセスでき、そのアクセスを特定のアカウントに制限することはできません。

注:

顧客レベルのユーザーロールを特定のアカウントに制限しようとすると、 UpdateUserRoles 操作は失敗せず、ユーザーはユーザーの顧客内のすべてのアカウントに対するアクセス権を保持します。

要件

サービス: CustomerManagementService.svc v13
名前空間： https://bingads.microsoft.com/Customer/v13

次の方法で共有