共用方式為

GetUser 服務作業 - 客戶管理

  • 發行項

取得使用者的詳細數據。

提示

如需範例的概觀，請參閱 帳戶階層和用戶權力 指南。

要求專案

GetUserRequest 物件會定義服務作業要求的主體和標頭元素。 元素的順序必須與 要求SOAP中所示的順序相同。

注意事項

除非下面另有說明，否則所有要求專案都是必要的。

要求本文專案

元素 描述 資料類型
UserId 要取得之使用者的標識碼。

如果此元素為 Null 或未提供，回應會包含要求標頭中指定之已驗證使用者的詳細數據。		 長

要求標頭元素

元素 描述 資料類型
AuthenticationToken OAuth 存取令牌，代表有權Microsoft Advertising 帳戶之用戶的認證。

如需詳細資訊，請 參閱使用 OAuth 進行驗證。		 string
DeveloperToken 用來存取 Bing 廣告 API 的開發人員令牌。

如需詳細資訊 ，請參閱取得開發人員令牌。		 string
密碼 此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。 string
UserName 此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。 string

Response 元素

GetUserResponse 物件會定義服務作業響應的主體和標頭元素。 這些元素的傳回順序與 回應SOAP中所示的順序相同。

回應本文專案

元素 描述 資料類型
CustomerRoles 用戶針對每個客戶或帳戶清單擁有的角色清單。

至少會傳回一個清單專案。 如果使用者的認證可以存取多個客戶，則會傳回每個客戶一個 CustomerRole 物件。

您可以在所有客戶之間檢視您自己的所有角色;不過，您只會看到其他使用者的角色，因為其與您可以存取的客戶有關。 例如， you@contoso.com 假設和 another-user@contoso.com 可以存取客戶 A。其他使用者也可以存取客戶 B 和 C;不過，當您使用使用者識別碼呼叫此作業時，您只會在客戶 A 下看到其角色。使用自己的認證呼叫此作業時 another-user@contoso.com ，作業會傳回三 個 CustomerRole 物件。		 CustomerRole 陣列
使用者 包含使用者相關信息的用戶物件。 使用者

回應標頭元素

元素 描述 資料類型
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
命名空間： https://bingads.microsoft.com/Customer/v13

要求 URL

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

要求專案

GetUserRequest 物件會定義服務作業要求的主體和標頭元素。

注意事項

除非下面另有說明，否則所有要求專案都是必要的。

要求本文專案

元素 描述 資料類型
UserId 要取得之使用者的標識碼。

如果此元素為 Null 或未提供，回應會包含要求標頭中指定之已驗證使用者的詳細數據。		 長

要求標頭元素

元素 描述 資料類型
授權 OAuth 存取令牌，代表有權Microsoft Advertising 帳戶之用戶的認證。 請確定令牌前面加上 「Bearer」 ，這是正確驗證的必要專案。

如需詳細資訊，請 參閱使用 OAuth 進行驗證。		 string
DeveloperToken 用來存取 Bing 廣告 API 的開發人員令牌。

如需詳細資訊 ，請參閱取得開發人員令牌。		 string
密碼 此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。 string
UserName 此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。 string

Response 元素

GetUserResponse 物件會定義服務作業響應的主體和標頭元素。 這些元素的傳回順序與 回應 JSON 中所示的順序相同。

回應本文專案

元素 描述 資料類型
CustomerRoles 用戶針對每個客戶或帳戶清單擁有的角色清單。

至少會傳回一個清單專案。 如果使用者的認證可以存取多個客戶，則會傳回每個客戶一個 CustomerRole 物件。

您可以在所有客戶之間檢視您自己的所有角色;不過，您只會看到其他使用者的角色，因為其與您可以存取的客戶有關。 例如， you@contoso.com 假設和 another-user@contoso.com 可以存取客戶 A。其他使用者也可以存取客戶 B 和 C;不過，當您使用使用者識別碼呼叫此作業時，您只會在客戶 A 下看到其角色。使用自己的認證呼叫此作業時 another-user@contoso.com ，作業會傳回三 個 CustomerRole 物件。		 CustomerRole 陣列
使用者 包含使用者相關信息的用戶物件。 使用者

回應標頭元素

元素 描述 資料類型
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)