SearchUserInvitations 服务操作 - 客户管理

搜索与请求条件匹配的用户邀请。

此操作将返回所有挂起的邀请，无论它们是否已过期。 响应中不包含已接受的邀请。

请求元素

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

注意

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

请求正文元素

元素	说明	数据类型
谓词	确定返回用户邀请必须满足的所有条件。 必须仅包含一个谓词。 有关每个支持的谓词 字段 值的详细信息，请参阅 谓词备注。	谓词 数组

请求标头元素

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

响应元素

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

响应正文元素

元素	说明	数据类型
UserInvitations	符合指定条件的用户邀请列表。	UserInvitation 数组

响应标头元素

元素	说明	数据类型
跟踪 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">SearchUserInvitations</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <SearchUserInvitationsRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <Predicates xmlns:e89="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e89:Predicate>
          <e89:Field i:nil="false">ValueHere</e89:Field>
          <e89:Operator>ValueHere</e89:Operator>
          <e89:Value i:nil="false">ValueHere</e89:Value>
        </e89:Predicate>
      </Predicates>
    </SearchUserInvitationsRequest>
  </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>
    <SearchUserInvitationsResponse xmlns="https://bingads.microsoft.com/Customer/v13">
      <UserInvitations xmlns:e90="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e90:UserInvitation>
          <e90:Id>ValueHere</e90:Id>
          <e90:FirstName d4p1:nil="false">ValueHere</e90:FirstName>
          <e90:LastName d4p1:nil="false">ValueHere</e90:LastName>
          <e90:Email d4p1:nil="false">ValueHere</e90:Email>
          <e90:CustomerId>ValueHere</e90:CustomerId>
          <e90:RoleId>ValueHere</e90:RoleId>
          <e90:AccountIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <a1:long>ValueHere</a1:long>
          </e90:AccountIds>
          <e90:ExpirationDate>ValueHere</e90:ExpirationDate>
          <e90:Lcid>ValueHere</e90:Lcid>
        </e90:UserInvitation>
      </UserInvitations>
    </SearchUserInvitationsResponse>
  </s:Body>
</s:Envelope>

代码语法

示例语法可用于 必应广告 SDK。 有关更多示例，请参阅 必应广告 API 代码示例 。

public async Task<SearchUserInvitationsResponse> SearchUserInvitationsAsync(
	IList<Predicate> predicates)
{
	var request = new SearchUserInvitationsRequest
	{
		Predicates = predicates
	};

	return (await CustomerManagementService.CallAsync((s, r) => s.SearchUserInvitationsAsync(r), request));
}

static SearchUserInvitationsResponse searchUserInvitations(
	ArrayOfPredicate predicates) throws RemoteException, Exception
{
	SearchUserInvitationsRequest request = new SearchUserInvitationsRequest();

	request.setPredicates(predicates);

	return CustomerManagementService.getService().searchUserInvitations(request);
}

static function SearchUserInvitations(
	$predicates)
{

	$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];

	$request = new SearchUserInvitationsRequest();

	$request->Predicates = $predicates;

	return $GLOBALS['CustomerManagementProxy']->GetService()->SearchUserInvitations($request);
}

response=customermanagement_service.SearchUserInvitations(
	Predicates=Predicates)

要求

服务： CustomerManagementService.svc v13
命名空间： https://bingads.microsoft.com/Customer/v13

请求 URL

生产 URL

https://clientcenter.api.bingads.microsoft.com/CustomerManagement/v13/UserInvitations/Search

沙盒 URL

https://clientcenter.api.sandbox.bingads.microsoft.com/CustomerManagement/v13/UserInvitations/Search

请求元素

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

注意

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

请求正文元素

元素	说明	数据类型
谓词	确定返回用户邀请必须满足的所有条件。 必须仅包含一个谓词。 有关每个支持的谓词 字段 值的详细信息，请参阅 谓词备注。	谓词 数组

请求标头元素

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

响应元素

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

响应正文元素

元素	说明	数据类型
UserInvitations	符合指定条件的用户邀请列表。	UserInvitation 数组

响应标头元素

元素	说明	数据类型
跟踪 ID	包含 API 调用详细信息的日志条目的标识符。	string

请求 JSON

此模板由显示 JSON 请求的 正文 和 标头 元素的工具生成。 有关可用于此服务操作的支持类型，请参阅上面的 请求正文元素 参考。

{
  "Predicates": [
    {
      "Field": "ValueHere",
      "Operator": "ValueHere",
      "Value": "ValueHere"
    }
  ]
}

响应 JSON

此模板由一个工具生成，用于显示 JSON 响应的 正文 和 标头 元素。

{
  "UserInvitations": [
    {
      "AccountIds": [
        "LongValueHere"
      ],
      "CustomerId": "LongValueHere",
      "Email": "ValueHere",
      "ExpirationDate": "ValueHere",
      "FirstName": "ValueHere",
      "Id": "LongValueHere",
      "LastName": "ValueHere",
      "Lcid": "ValueHere",
      "RoleId": IntValueHere
    }
  ]
}

代码语法

若要通过 SDK 调用 REST API，需要将 SDK 升级到特定版本并配置系统参数。示例语法可用于 必应广告 SDK。 有关更多示例，请参阅 必应广告 API 代码示例 。

public async Task<SearchUserInvitationsResponse> SearchUserInvitationsAsync(
	IList<Predicate> predicates)
{
	var request = new SearchUserInvitationsRequest
	{
		Predicates = predicates
	};

	return (await CustomerManagementService.CallAsync((s, r) => s.SearchUserInvitationsAsync(r), request));
}

static SearchUserInvitationsResponse searchUserInvitations(
	ArrayOfPredicate predicates) throws RemoteException, Exception
{
	SearchUserInvitationsRequest request = new SearchUserInvitationsRequest();

	request.setPredicates(predicates);

	return CustomerManagementService.getService().searchUserInvitations(request);
}

static function SearchUserInvitations(
	$predicates)
{

	$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];

	$request = new SearchUserInvitationsRequest();

	$request->Predicates = $predicates;

	return $GLOBALS['CustomerManagementProxy']->GetService()->SearchUserInvitations($request);
}

response=customermanagement_service.SearchUserInvitations(
	Predicates=Predicates)