GetUser 服务操作 - 客户管理

项目
11/14/2024

获取用户的详细信息。

提示

有关示例的概述，请参阅帐户层次结构和用户权限指南。

请求元素

GetUserRequest 对象定义服务操作请求的正文和标头元素。元素的顺序必须与请求 SOAP 中所示的顺序相同。

注意

除非下面另有说明，否则需要所有请求元素。

请求正文元素

元素	说明	数据类型
UserID	要获取的用户的标识符。如果此元素为 null 或未提供，则响应将包括请求标头中指定的经过身份验证的用户的详细信息。	long

请求标头元素

元素	说明	数据类型
AuthenticationToken	OAuth 访问令牌，表示有权Microsoft广告帐户的用户的凭据。有关详细信息，请参阅使用 OAuth 进行身份验证。	string
DeveloperToken	用于访问必应广告 API 的开发人员令牌。有关详细信息，请参阅获取开发人员令牌。	string
Password	此元素保留供内部使用，将从 API 的未来版本中删除。必须使用 AuthenticationToken 元素来设置用户凭据。	string
UserName	此元素保留供内部使用，将从 API 的未来版本中删除。必须使用 AuthenticationToken 元素来设置用户凭据。	string

响应元素

GetUserResponse 对象定义服务操作响应的正文和标头元素。元素的返回顺序与响应 SOAP 中所示的顺序相同。

响应正文元素

元素	说明	数据类型
CustomerRoles	用户为每个客户拥有的角色列表或帐户列表。将至少返回一个列表项。如果用户的凭据可以访问多个客户，则每个客户将返回一个 CustomerRole 对象。可查看所有客户中自己的所有角色;但是，你只会看到其他用户的角色，因为它与可以访问的客户有关。例如， you@contoso.com 假设和 another-user@contoso.com 可以访问客户 A。其他用户可能还有权访问客户 B 和 C;但是，当你使用用户标识符调用此操作时，只会在“客户 A”下看到其角色。使用自己的凭据调用此操作时 another-user@contoso.com ，该操作将返回三个 CustomerRole 对象。	CustomerRole 数组
用户	包含有关用户的信息的用户对象。	用户

响应标头元素

元素	说明	数据类型
跟踪 ID	包含 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>

代码语法

示例语法可用于必应广告 SDK。有关更多示例，请参阅必应广告 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

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

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

请求元素

GetUserRequest 对象定义服务操作请求的正文和标头元素。

注意

除非下面另有说明，否则需要所有请求元素。

请求正文元素

元素	说明	数据类型
UserID	要获取的用户的标识符。如果此元素为 null 或未提供，则响应将包括请求标头中指定的经过身份验证的用户的详细信息。	long

请求标头元素

元素	说明	数据类型
Authorization	OAuth 访问令牌，表示有权Microsoft广告帐户的用户的凭据。请确保令牌的前缀为“持有者”，这是正确身份验证所必需的。有关详细信息，请参阅使用 OAuth 进行身份验证。	string
DeveloperToken	用于访问必应广告 API 的开发人员令牌。有关详细信息，请参阅获取开发人员令牌。	string
Password	此元素保留供内部使用，将从 API 的未来版本中删除。必须使用 AuthenticationToken 元素来设置用户凭据。	string
UserName	此元素保留供内部使用，将从 API 的未来版本中删除。必须使用 AuthenticationToken 元素来设置用户凭据。	string

响应元素

GetUserResponse 对象定义服务操作响应的正文和标头元素。元素的返回顺序与响应 JSON 中所示的顺序相同。

响应正文元素

元素	说明	数据类型
CustomerRoles	用户为每个客户拥有的角色列表或帐户列表。将至少返回一个列表项。如果用户的凭据可以访问多个客户，则每个客户将返回一个 CustomerRole 对象。可查看所有客户中自己的所有角色;但是，你只会看到其他用户的角色，因为它与可以访问的客户有关。例如， you@contoso.com 假设和 another-user@contoso.com 可以访问客户 A。其他用户可能还有权访问客户 B 和 C;但是，当你使用用户标识符调用此操作时，只会在“客户 A”下看到其角色。使用自己的凭据调用此操作时 another-user@contoso.com ，该操作将返回三个 CustomerRole 对象。	CustomerRole 数组
用户	包含有关用户的信息的用户对象。	用户

响应标头元素

元素	说明	数据类型
跟踪 ID	包含 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 升级到特定版本并配置系统参数。示例语法可用于必应广告 SDK。有关更多示例，请参阅必应广告 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)

通过

GetUser 服务操作 - 客户管理

请求元素

请求正文元素

请求标头元素

响应元素

响应正文元素

响应标头元素

请求 SOAP

响应 SOAP

代码语法

要求

请求 URL

请求元素

请求正文元素

请求标头元素

响应元素

响应正文元素

响应标头元素

请求 JSON

响应 JSON

代码语法

反馈

其他资源