GetUsersInfo 服務作業 - 客戶管理
取得包含使用者識別資訊的物件清單,例如使用者的使用者名稱和識別碼。
要求專案
GetUsersInfoRequest物件會定義服務作業要求的主體和標頭元素。 元素的順序必須與 要求 SOAP中所示的順序相同。
注意事項
除非下面另有說明,否則所有要求專案都是必要的。
要求本文專案
元素 | 說明 | 資料類型 |
---|---|---|
CustomerId | 使用者所屬客戶的識別碼。 | 長 |
StatusFilter | 作業用來篩選其傳回之使用者清單的狀態值。 作業只會傳回具有指定狀態的使用者。 | UserLifeCycleStatus |
要求標頭元素
元素 | 說明 | 資料類型 |
---|---|---|
AuthenticationToken | OAuth 存取權杖,代表具有 Microsoft Advertising 帳戶許可權之使用者的認證。 如需詳細資訊,請 參閱使用 OAuth 進行驗證。 |
string |
DeveloperToken | 用來存取 Bing 廣告 API 的開發人員權杖。 如需詳細資訊 ,請參閱取得開發人員權杖。 |
string |
密碼 | 此元素會保留供內部使用,並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定使用者認證。 | string |
UserName | 此元素會保留供內部使用,並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定使用者認證。 | string |
Response 元素
GetUsersInfoResponse物件會定義服務作業回應的主體和標頭元素。 這些元素的傳回順序與 回應 SOAP中所示的順序相同。
回應本文專案
元素 | 說明 | 資料類型 |
---|---|---|
UsersInfo |
UserInfo物件的清單,識別符合篩選準則的使用者清單。 若要取得清單中使用者的使用者資料,請存取UserInfo物件的Id元素,並使用它來呼叫GetUser。 |
UserInfo 數 組 |
回應標頭元素
元素 | 說明 | 資料類型 |
---|---|---|
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">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>
回應 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>
<GetUsersInfoResponse xmlns="https://bingads.microsoft.com/Customer/v13">
<UsersInfo xmlns:e242="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<e242:UserInfo>
<e242:Id>ValueHere</e242:Id>
<e242:UserName d4p1:nil="false">ValueHere</e242:UserName>
</e242:UserInfo>
</UsersInfo>
</GetUsersInfoResponse>
</s:Body>
</s:Envelope>
程式碼語法
範例語法可以與 Bing 廣告 SDK搭配使用。 如需更多範例,請參閱 Bing 廣告 API 程式碼范 例。
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)
需求
服務: CustomerManagementService.svc v13
命名 空間: https://bingads.microsoft.com/Customer/v13