Изменить

Поделиться через

GetUsersInfo Service Operation - Customer Management

  • Статья

Gets a list of objects that contains user identification information, for example the user name and identifier of the user.

Request Elements

The GetUsersInfoRequest object defines the body and header elements of the service operation request. The elements must be in the same order as shown in the Request SOAP.

Note

Unless otherwise noted below, all request elements are required.

Request Body Elements

Element Description Data Type
CustomerId The identifier of the customer to which the users belong. long
StatusFilter The status value that the operation uses to filter the list of users that it returns. The operation returns only those users with the specified status. UserLifeCycleStatus

Request Header Elements

Element Description Data Type
AuthenticationToken The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts.

For more information see Authentication with OAuth.		 string
DeveloperToken The developer token used to access the Bing Ads API.

For more information see Get a Developer Token.		 string
Password This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. string
UserName This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. string

Response Elements

The GetUsersInfoResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response SOAP.

Response Body Elements

Element Description Data Type
UsersInfo A list of UserInfo objects that identifies the list of users who meet the filter criteria.

To get the user data for a user in the list, access the Id element of the UserInfo object and use it to call GetUser.		 UserInfo array

Response Header Elements

Element Description Data Type
TrackingId The identifier of the log entry that contains the details of the API call. string

Request SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP request. For supported types that you can use with this service operation, see the Request Body Elements reference above.

<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">GetUsersInfo</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <GetUsersInfoRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <CustomerId>ValueHere</CustomerId>
      <StatusFilter i:nil="false">ValueHere</StatusFilter>
    </GetUsersInfoRequest>
  </s:Body>
</s:Envelope>

Response SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP response.

<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>
    <GetUsersInfoResponse xmlns="https://bingads.microsoft.com/Customer/v13">
      <UsersInfo xmlns:e507="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e507:UserInfo>
          <e507:Id>ValueHere</e507:Id>
          <e507:UserName d4p1:nil="false">ValueHere</e507:UserName>
        </e507:UserInfo>
      </UsersInfo>
    </GetUsersInfoResponse>
  </s:Body>
</s:Envelope>

Code Syntax

The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.

public async Task<GetUsersInfoResponse> GetUsersInfoAsync(
	long customerId,
	UserLifeCycleStatus? statusFilter)
{
	var request = new GetUsersInfoRequest
	{
		CustomerId = customerId,
		StatusFilter = statusFilter
	};

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

static GetUsersInfoResponse getUsersInfo(
	java.lang.Long customerId,
	UserLifeCycleStatus statusFilter) throws RemoteException, Exception
{
	GetUsersInfoRequest request = new GetUsersInfoRequest();

	request.setCustomerId(customerId);
	request.setStatusFilter(statusFilter);

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

static function GetUsersInfo(
	$customerId,
	$statusFilter)
{

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

	$request = new GetUsersInfoRequest();

	$request->CustomerId = $customerId;
	$request->StatusFilter = $statusFilter;

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

response=customermanagement_service.GetUsersInfo(
	CustomerId=CustomerId,
	StatusFilter=StatusFilter)

Requirements

Service: CustomerManagementService.svc v13
Namespace: https://bingads.microsoft.com/Customer/v13

Request Url

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

Request Elements

The GetUsersInfoRequest object defines the body and header elements of the service operation request.

Note

Unless otherwise noted below, all request elements are required.

Request Body Elements

Element Description Data Type
CustomerId The identifier of the customer to which the users belong. long
StatusFilter The status value that the operation uses to filter the list of users that it returns. The operation returns only those users with the specified status. UserLifeCycleStatus

Request Header Elements

Element Description Data Type
Authorization The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. Please ensure that the token is prefixed with "Bearer ", this is necessary for proper authentication.

For more information see Authentication with OAuth.		 string
DeveloperToken The developer token used to access the Bing Ads API.

For more information see Get a Developer Token.		 string
Password This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. string
UserName This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. string

Response Elements

The GetUsersInfoResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response JSON.

Response Body Elements

Element Description Data Type
UsersInfo A list of UserInfo objects that identifies the list of users who meet the filter criteria.

To get the user data for a user in the list, access the Id element of the UserInfo object and use it to call GetUser.		 UserInfo array

Response Header Elements

Element Description Data Type
TrackingId The identifier of the log entry that contains the details of the API call. string

Request JSON

This template was generated by a tool to show the body and header elements for the JSON request. For supported types that you can use with this service operation, see the Request Body Elements reference above.

{
  "CustomerId": "LongValueHere",
  "StatusFilter": "ValueHere"
}

Response JSON

This template was generated by a tool to show the body and header elements for the JSON response.

{
  "UsersInfo": [
    {
      "Id": "LongValueHere",
      "UserName": "ValueHere"
    }
  ]
}

Code Syntax

To call REST API through SDKs, you need to upgrade SDK to a certain version and configure the system parameters.The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.

public async Task<GetUsersInfoResponse> GetUsersInfoAsync(
	long customerId,
	UserLifeCycleStatus? statusFilter)
{
	var request = new GetUsersInfoRequest
	{
		CustomerId = customerId,
		StatusFilter = statusFilter
	};

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

static GetUsersInfoResponse getUsersInfo(
	java.lang.Long customerId,
	UserLifeCycleStatus statusFilter) throws RemoteException, Exception
{
	GetUsersInfoRequest request = new GetUsersInfoRequest();

	request.setCustomerId(customerId);
	request.setStatusFilter(statusFilter);

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

static function GetUsersInfo(
	$customerId,
	$statusFilter)
{

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

	$request = new GetUsersInfoRequest();

	$request->CustomerId = $customerId;
	$request->StatusFilter = $statusFilter;

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

response=customermanagement_service.GetUsersInfo(
	CustomerId=CustomerId,
	StatusFilter=StatusFilter)