SearchCustomers 服務作業 - 客戶管理
搜尋符合要求準則的客戶。
要求專案
SearchCustomersRequest物件會定義服務作業要求的主體和標頭元素。 元素的順序必須與 要求 SOAP中所示的順序相同。
注意事項
除非下面另有說明,否則所有要求專案都是必要的。
要求本文專案
元素 | 說明 | 資料類型 |
---|---|---|
DateRange | 決定客戶建立日期範圍的最小和最大值。 此要求專案是選擇性的。 |
DateRange |
訂購 | 根據客戶的指定屬性來決定結果的順序。 此要求專案是選擇性的。 您最多可以在陣列中指定一個 OrderBy 元素。 不支援其他專案,服務將會忽略這些專案。 針對此服務作業,OrderBy物件的Field元素支援下列值: 標識符 - 訂單是由傳回之Customer的Id元素所決定。 名稱 - 訂單取決於傳回之 Customer 的 Name元素。 Number - 訂單是由傳回之Customer的Number元素所決定。 |
OrderBy 數 組 |
PageInfo | 決定每頁結果的索引和大小。 | 分頁 |
謂詞 | 決定必須符合所有條件才能傳回客戶。 您必須包含一到 10 個述詞。 若要依建立的日期範圍進行篩選,您可以包含兩個述詞, 並將 Field 值設定為 CreatedDate,否則只能使用每個述詞欄位一次。 如需每個支援述詞 域 值的詳細資訊,請參閱 述詞備註。 |
述詞數 組 |
要求標頭元素
元素 | 說明 | 資料類型 |
---|---|---|
AuthenticationToken | OAuth 存取權杖,代表具有 Microsoft Advertising 帳戶許可權之使用者的認證。 如需詳細資訊,請 參閱使用 OAuth 進行驗證。 |
string |
DeveloperToken | 用來存取 Bing 廣告 API 的開發人員權杖。 如需詳細資訊 ,請參閱取得開發人員權杖。 |
string |
密碼 | 此元素會保留供內部使用,並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定使用者認證。 | string |
UserName | 此元素會保留供內部使用,並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定使用者認證。 | string |
Response 元素
SearchCustomersResponse物件會定義服務作業回應的主體和標頭元素。 這些元素的傳回順序與 回應 SOAP中所示的順序相同。
回應本文專案
元素 | 說明 | 資料類型 |
---|---|---|
客戶 | 符合要求準則的客戶清單。 | 客戶 陣列 |
回應標頭元素
元素 | 說明 | 資料類型 |
---|---|---|
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">SearchCustomers</Action>
<AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
<DeveloperToken i:nil="false">ValueHere</DeveloperToken>
</s:Header>
<s:Body>
<SearchCustomersRequest xmlns="https://bingads.microsoft.com/Customer/v13">
<Predicates xmlns:e255="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e255:Predicate>
<e255:Field i:nil="false">ValueHere</e255:Field>
<e255:Operator>ValueHere</e255:Operator>
<e255:Value i:nil="false">ValueHere</e255:Value>
</e255:Predicate>
</Predicates>
<DateRange xmlns:e256="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e256:MinDate i:nil="false">ValueHere</e256:MinDate>
<e256:MaxDate i:nil="false">ValueHere</e256:MaxDate>
</DateRange>
<Ordering xmlns:e257="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e257:OrderBy>
<e257:Field>ValueHere</e257:Field>
<e257:Order>ValueHere</e257:Order>
</e257:OrderBy>
</Ordering>
<PageInfo xmlns:e258="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e258:Index>ValueHere</e258:Index>
<e258:Size>ValueHere</e258:Size>
</PageInfo>
</SearchCustomersRequest>
</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>
<SearchCustomersResponse xmlns="https://bingads.microsoft.com/Customer/v13">
<Customers xmlns:e259="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<e259:Customer>
<e259:CustomerFinancialStatus d4p1:nil="false">ValueHere</e259:CustomerFinancialStatus>
<e259:Id d4p1:nil="false">ValueHere</e259:Id>
<e259:Industry d4p1:nil="false">ValueHere</e259:Industry>
<e259:LastModifiedByUserId d4p1:nil="false">ValueHere</e259:LastModifiedByUserId>
<e259:LastModifiedTime d4p1:nil="false">ValueHere</e259:LastModifiedTime>
<e259:MarketCountry d4p1:nil="false">ValueHere</e259:MarketCountry>
<e259:ForwardCompatibilityMap xmlns:e260="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e260:KeyValuePairOfstringstring>
<e260:key d4p1:nil="false">ValueHere</e260:key>
<e260:value d4p1:nil="false">ValueHere</e260:value>
</e260:KeyValuePairOfstringstring>
</e259:ForwardCompatibilityMap>
<e259:MarketLanguage d4p1:nil="false">ValueHere</e259:MarketLanguage>
<e259:Name d4p1:nil="false">ValueHere</e259:Name>
<e259:ServiceLevel d4p1:nil="false">ValueHere</e259:ServiceLevel>
<e259:CustomerLifeCycleStatus d4p1:nil="false">ValueHere</e259:CustomerLifeCycleStatus>
<e259:TimeStamp d4p1:nil="false">ValueHere</e259:TimeStamp>
<e259:Number d4p1:nil="false">ValueHere</e259:Number>
<e259:CustomerAddress d4p1:nil="false">
<e259:City d4p1:nil="false">ValueHere</e259:City>
<e259:CountryCode d4p1:nil="false">ValueHere</e259:CountryCode>
<e259:Id d4p1:nil="false">ValueHere</e259:Id>
<e259:Line1 d4p1:nil="false">ValueHere</e259:Line1>
<e259:Line2 d4p1:nil="false">ValueHere</e259:Line2>
<e259:Line3 d4p1:nil="false">ValueHere</e259:Line3>
<e259:Line4 d4p1:nil="false">ValueHere</e259:Line4>
<e259:PostalCode d4p1:nil="false">ValueHere</e259:PostalCode>
<e259:StateOrProvince d4p1:nil="false">ValueHere</e259:StateOrProvince>
<e259:TimeStamp d4p1:nil="false">ValueHere</e259:TimeStamp>
<e259:BusinessName d4p1:nil="false">ValueHere</e259:BusinessName>
</e259:CustomerAddress>
</e259:Customer>
</Customers>
</SearchCustomersResponse>
</s:Body>
</s:Envelope>
程式碼語法
範例語法可以與 Bing 廣告 SDK搭配使用。 如需更多範例,請參閱 Bing 廣告 API 程式碼范 例。
public async Task<SearchCustomersResponse> SearchCustomersAsync(
IList<Predicate> predicates,
DateRange dateRange,
IList<OrderBy> ordering,
Paging pageInfo)
{
var request = new SearchCustomersRequest
{
Predicates = predicates,
DateRange = dateRange,
Ordering = ordering,
PageInfo = pageInfo
};
return (await CustomerManagementService.CallAsync((s, r) => s.SearchCustomersAsync(r), request));
}
static SearchCustomersResponse searchCustomers(
ArrayOfPredicate predicates,
DateRange dateRange,
ArrayOfOrderBy ordering,
Paging pageInfo) throws RemoteException, Exception
{
SearchCustomersRequest request = new SearchCustomersRequest();
request.setPredicates(predicates);
request.setDateRange(dateRange);
request.setOrdering(ordering);
request.setPageInfo(pageInfo);
return CustomerManagementService.getService().searchCustomers(request);
}
static function SearchCustomers(
$predicates,
$dateRange,
$ordering,
$pageInfo)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];
$request = new SearchCustomersRequest();
$request->Predicates = $predicates;
$request->DateRange = $dateRange;
$request->Ordering = $ordering;
$request->PageInfo = $pageInfo;
return $GLOBALS['CustomerManagementProxy']->GetService()->SearchCustomers($request);
}
response=customermanagement_service.SearchCustomers(
Predicates=Predicates,
DateRange=DateRange,
Ordering=Ordering,
PageInfo=PageInfo)
需求
服務: CustomerManagementService.svc v13
命名 空間: https://bingads.microsoft.com/Customer/v13