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

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

ユーザーが Microsoft Advertising にサインアップするための招待メールを送信します。招待により、アカウントのアクセスとアクセス許可が制限されます。

注:

ユーザーの招待を送信できるのは、Super 管理または Standard 資格情報を持つユーザーのみです。 Standard ユーザーは Super 管理を招待できません。詳細については、ユーザーロールのテクニカルガイドを参照してください。

重要

招待が送信されると、顧客のすぐ下にある広告主アカウントのサブセットへのユーザーアクセスを制限できます。ユーザーが招待された顧客の下で代理店階層が (現在または将来) 設定されていて、特定のアカウントへのアクセスを制限しない場合、ユーザーは階層内のすべてのアカウントにアクセスできます。

同じメールアドレスに複数の保留中の招待を送信できます。これは、まだ期限切れではありません。また、不適切なユーザーロールで招待を送信し、正しいユーザーロールを持つ 2 つ目の招待を送信した場合など、それらの招待で異なるユーザーロールを指定することもできます。受信者は任意の招待を受け入れ、招待メールアドレスとは異なる資格情報でサインアップできます。 Microsoft Advertising ユーザーは、同じ資格情報を持つ複数の顧客への招待を受け入れます。詳細については、マルチユーザー資格情報のテクニカルガイドを参照してください。

招待 ID で保留中の招待を検索し、招待が承諾されたか期限切れになっているかを確認できます。 SearchUserInvitations 操作は、有効期限が切れているかどうかにかかわらず、保留中のすべての招待を返します。受け入れられた招待は、SearchUserInvitations 応答には含まれません。

招待が承諾されたら、GetUsersInfo と GetUser を呼び出して、Microsoft Advertising ユーザーの詳細にアクセスできます。ただし、受信者は招待を受け入れ、招待メールアドレスとは異なる資格情報でサインアップできるため、UserInvitation から User または UserInfo オブジェクトへのマッピングを確実に判断することはできません。 GetUsersInfo または GetUser によって返されるユーザー ID を使用すると、DeleteUser を呼び出して、必要に応じてユーザーを削除できます。 Bing Ads API では、保留中のユーザー招待を削除する操作はサポートされていません。ユーザーを招待した後、招待をキャンセルする唯一の方法は、Microsoft Advertising Web アプリケーションを使用することです。保留中の招待と承諾された招待の両方は、[アカウント] & [課金] の [ユーザー] セクションにあります。

Request 要素

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

注:

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

要求本文要素

要素	説明	データ型
UserInvitation	送信するユーザーの招待。	UserInvitation

要求ヘッダー要素

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

Response 要素

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

応答本文の要素

要素	説明	データ型
UserInvitationId	送信されたユーザー招待のシステム生成識別子。	long

応答ヘッダー要素

要素	説明	データ型
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">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:e263="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e263:Id>ValueHere</e263:Id>
        <e263:FirstName i:nil="false">ValueHere</e263:FirstName>
        <e263:LastName i:nil="false">ValueHere</e263:LastName>
        <e263:Email i:nil="false">ValueHere</e263:Email>
        <e263:CustomerId>ValueHere</e263:CustomerId>
        <e263:RoleId>ValueHere</e263:RoleId>
        <e263:AccountIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <a1:long>ValueHere</a1:long>
        </e263:AccountIds>
        <e263:ExpirationDate>ValueHere</e263:ExpirationDate>
        <e263:Lcid>ValueHere</e263:Lcid>
      </UserInvitation>
    </SendUserInvitationRequest>
  </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>
    <SendUserInvitationResponse xmlns="https://bingads.microsoft.com/Customer/v13">
      <UserInvitationId>ValueHere</UserInvitationId>
    </SendUserInvitationResponse>
  </s:Body>
</s:Envelope>

コード構文

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

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)

要件

サービス: CustomerManagementService.svc v13
Namespace: https://bingads.microsoft.com/Customer/v13

次の方法で共有