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

  • [アーティクル]

ユーザーの詳細を取得します。

ヒント

例を含む概要については、 アカウント Hierchy とユーザーのアクセス許可 に関するガイドを参照してください。

Request 要素

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

注:

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

要求本文要素

要素 説明 データ型
UserId 取得するユーザーの識別子。

この要素が null または指定されていない場合、応答には、要求ヘッダーで指定された認証済みユーザーの詳細が含まれます。		 long

要求ヘッダー要素

要素 説明 データ型
AuthenticationToken Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセス トークン。

詳細については、「 OAuth による認証」を参照してください。		 string
DeveloperToken Bing Ads API へのアクセスに使用される開発者トークン。

詳細については、「 開発者トークンを取得する」を参照してください。		 string
Password この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 string
UserName この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 string

Response 要素

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

応答本文の要素

要素 説明 データ型
CustomerRoles 各顧客またはアカウントの一覧に対してユーザーが持つロールの一覧。

少なくとも 1 つのリスト アイテムが返されます。 ユーザーの資格情報が複数の顧客にアクセスできる場合は、顧客ごとに 1 つの CustomerRole オブジェクトが返されます。

すべての顧客に対して、独自のすべてのロールを表示できます。ただし、アクセスできる顧客に関連する他のユーザーのロールのみが表示されます。 たとえば、顧客 A にアクセスできる you@contoso.com と another-user@contoso.com があるとします。他のユーザーは、顧客 B と C にもアクセスできる可能性があります。ただし、ユーザー識別子を使用してこの操作を呼び出すと、顧客 A の下にのみロールが表示されます。 another-user@contoso.com が独自の資格情報でこの操作を呼び出すと、操作は 3 つの CustomerRole オブジェクトを 返します。		 CustomerRole 配列
User ユーザーに関する情報を含むユーザー オブジェクト。 ユーザー

応答ヘッダー要素

要素 説明 データ型
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">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

このテンプレートは、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:e45="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e45:ContactInfo d4p1:nil="false">
          <e45:Address d4p1:nil="false">
            <e45:City d4p1:nil="false">ValueHere</e45:City>
            <e45:CountryCode d4p1:nil="false">ValueHere</e45:CountryCode>
            <e45:Id d4p1:nil="false">ValueHere</e45:Id>
            <e45:Line1 d4p1:nil="false">ValueHere</e45:Line1>
            <e45:Line2 d4p1:nil="false">ValueHere</e45:Line2>
            <e45:Line3 d4p1:nil="false">ValueHere</e45:Line3>
            <e45:Line4 d4p1:nil="false">ValueHere</e45:Line4>
            <e45:PostalCode d4p1:nil="false">ValueHere</e45:PostalCode>
            <e45:StateOrProvince d4p1:nil="false">ValueHere</e45:StateOrProvince>
            <e45:TimeStamp d4p1:nil="false">ValueHere</e45:TimeStamp>
            <e45:BusinessName d4p1:nil="false">ValueHere</e45:BusinessName>
          </e45:Address>
          <e45:ContactByPhone d4p1:nil="false">ValueHere</e45:ContactByPhone>
          <e45:ContactByPostalMail d4p1:nil="false">ValueHere</e45:ContactByPostalMail>
          <e45:Email d4p1:nil="false">ValueHere</e45:Email>
          <e45:EmailFormat d4p1:nil="false">ValueHere</e45:EmailFormat>
          <e45:Fax d4p1:nil="false">ValueHere</e45:Fax>
          <e45:HomePhone d4p1:nil="false">ValueHere</e45:HomePhone>
          <e45:Id d4p1:nil="false">ValueHere</e45:Id>
          <e45:Mobile d4p1:nil="false">ValueHere</e45:Mobile>
          <e45:Phone1 d4p1:nil="false">ValueHere</e45:Phone1>
          <e45:Phone2 d4p1:nil="false">ValueHere</e45:Phone2>
        </e45:ContactInfo>
        <e45:CustomerId d4p1:nil="false">ValueHere</e45:CustomerId>
        <e45:Id d4p1:nil="false">ValueHere</e45:Id>
        <e45:JobTitle d4p1:nil="false">ValueHere</e45:JobTitle>
        <e45:LastModifiedByUserId d4p1:nil="false">ValueHere</e45:LastModifiedByUserId>
        <e45:LastModifiedTime d4p1:nil="false">ValueHere</e45:LastModifiedTime>
        <e45:Lcid d4p1:nil="false">ValueHere</e45:Lcid>
        <e45:Name d4p1:nil="false">
          <e45:FirstName d4p1:nil="false">ValueHere</e45:FirstName>
          <e45:LastName d4p1:nil="false">ValueHere</e45:LastName>
          <e45:MiddleInitial d4p1:nil="false">ValueHere</e45:MiddleInitial>
        </e45:Name>
        <e45:Password d4p1:nil="false">ValueHere</e45:Password>
        <e45:SecretAnswer d4p1:nil="false">ValueHere</e45:SecretAnswer>
        <e45:SecretQuestion>ValueHere</e45:SecretQuestion>
        <e45:UserLifeCycleStatus d4p1:nil="false">ValueHere</e45:UserLifeCycleStatus>
        <e45:TimeStamp d4p1:nil="false">ValueHere</e45:TimeStamp>
        <e45:UserName d4p1:nil="false">ValueHere</e45:UserName>
        <e45:ForwardCompatibilityMap xmlns:e46="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
          <e46:KeyValuePairOfstringstring>
            <e46:key d4p1:nil="false">ValueHere</e46:key>
            <e46:value d4p1:nil="false">ValueHere</e46:value>
          </e46:KeyValuePairOfstringstring>
        </e45:ForwardCompatibilityMap>
        <e45:AuthenticationToken d4p1:nil="false">ValueHere</e45:AuthenticationToken>
      </User>
      <CustomerRoles xmlns:e47="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e47:CustomerRole>
          <e47:RoleId>ValueHere</e47:RoleId>
          <e47:CustomerId>ValueHere</e47:CustomerId>
          <e47:AccountIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <a1:long>ValueHere</a1:long>
          </e47:AccountIds>
          <e47:LinkedAccountIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <a1:long>ValueHere</a1:long>
          </e47:LinkedAccountIds>
          <e47:CustomerLinkPermission d4p1:nil="false">ValueHere</e47:CustomerLinkPermission>
        </e47:CustomerRole>
      </CustomerRoles>
    </GetUserResponse>
  </s:Body>
</s:Envelope>

コード構文

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

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)

要件

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

要求 URL

https://clientcenter.api.bingads.microsoft.com/CustomerManagement/v13/User/Query

Request 要素

GetUserRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。

注:

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

要求本文要素

要素 説明 データ型
UserId 取得するユーザーの識別子。

この要素が null または指定されていない場合、応答には、要求ヘッダーで指定された認証済みユーザーの詳細が含まれます。		 long

要求ヘッダー要素

要素 説明 データ型
Authorization Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセス トークン。 トークンのプレフィックスに "Bearer" があることを確認してください。これは、適切な認証に必要です。

詳細については、「 OAuth による認証」を参照してください。		 string
DeveloperToken Bing Ads API へのアクセスに使用される開発者トークン。

詳細については、「 開発者トークンを取得する」を参照してください。		 string
Password この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 string
UserName この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 string

Response 要素

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

応答本文の要素

要素 説明 データ型
CustomerRoles 各顧客またはアカウントの一覧に対してユーザーが持つロールの一覧。

少なくとも 1 つのリスト アイテムが返されます。 ユーザーの資格情報が複数の顧客にアクセスできる場合は、顧客ごとに 1 つの CustomerRole オブジェクトが返されます。

すべての顧客に対して、独自のすべてのロールを表示できます。ただし、アクセスできる顧客に関連する他のユーザーのロールのみが表示されます。 たとえば、顧客 A にアクセスできる you@contoso.com と another-user@contoso.com があるとします。他のユーザーは、顧客 B と C にもアクセスできる可能性があります。ただし、ユーザー識別子を使用してこの操作を呼び出すと、顧客 A の下にのみロールが表示されます。 another-user@contoso.com が独自の資格情報でこの操作を呼び出すと、操作は 3 つの CustomerRole オブジェクトを 返します。		 CustomerRole 配列
User ユーザーに関する情報を含むユーザー オブジェクト。 ユーザー

応答ヘッダー要素

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

JSON を要求する

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

{
  "UserId": "LongValueHere"
}

応答 JSON

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

コード構文

SDK を使用して REST API を呼び出すには、SDK を特定のバージョンにアップグレードし、システム パラメーターを構成する必要があります。構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。

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)