SearchCustomers Service Operation – Kundenverwaltung
Sucht nach Kunden, die den Anforderungskriterien entsprechen.
Anfordern von Elementen
Das SearchCustomersRequest-Objekt definiert den Text und die Headerelemente der Dienstvorgangsanforderung. Die Elemente müssen in der gleichen Reihenfolge wie im Anforderungs-SOAP dargestellt sein.
Hinweis
Sofern unten nicht anders angegeben, sind alle Anforderungselemente erforderlich.
Anforderungstextelemente
Element | Beschreibung | Datentyp |
---|---|---|
DateRange | Bestimmt den minimalen und maximalen Datumsbereich für die Kundenerstellung. Dieses Anforderungselement ist optional. |
DateRange |
Ordnung | Bestimmt die Reihenfolge der Ergebnisse anhand der angegebenen Eigenschaft eines Kunden. Dieses Anforderungselement ist optional. Sie können bis zu einem OrderBy-Element im Array angeben. Zusätzliche Elemente werden nicht unterstützt und vom Dienst ignoriert. Für diesen Dienstvorgang werden die folgenden Werte im Field-Element eines OrderBy-Objekts unterstützt: ID : Die Bestellung wird durch das Id-Element des zurückgegebenen Kunden bestimmt. Name : Die Bestellung wird durch das Name-Element des zurückgegebenen Kunden bestimmt. Number : Die Bestellung wird durch das Number-Element des zurückgegebenen Kunden bestimmt. |
OrderBy-Array |
PageInfo | Bestimmt den Index und die Größe der Ergebnisse pro Seite. | Paging |
Prädikate | Bestimmt die Bedingungen, unter denen alle erfüllt sein müssen, um Kunden zurückzugeben. Sie müssen zwischen einem und 10 Prädikaten einschließen. Um nach dem erstellten Datumsbereich zu filtern, können Sie zwei Prädikate mit dem Wert Field einschließen, der auf CreatedDate festgelegt ist. Andernfalls können Sie jedes Prädikatfeld nur einmal verwenden. Ausführliche Informationen zu den einzelnen unterstützten Prädikat-Feldwerten finden Sie in den Prädikatshinweisen. |
Prädikatarray |
Anforderungsheaderelemente
Element | Beschreibung | Datentyp |
---|---|---|
AuthenticationToken | Das OAuth-Zugriffstoken, das die Anmeldeinformationen eines Benutzers darstellt, der über Berechtigungen für Microsoft Advertising-Konten verfügt. Weitere Informationen finden Sie unter Authentifizierung mit OAuth. |
Zeichenfolge |
DeveloperToken | Das Entwicklertoken, das für den Zugriff auf die Bing Ads-API verwendet wird. Weitere Informationen finden Sie unter Abrufen eines Entwicklertokens. |
Zeichenfolge |
Kennwort | Dieses Element ist für die interne Verwendung reserviert und wird aus einer zukünftigen Version der API entfernt. Sie müssen das AuthenticationToken-Element verwenden, um Benutzeranmeldeinformationen festzulegen. | Zeichenfolge |
UserName | Dieses Element ist für die interne Verwendung reserviert und wird aus einer zukünftigen Version der API entfernt. Sie müssen das AuthenticationToken-Element verwenden, um Benutzeranmeldeinformationen festzulegen. | Zeichenfolge |
Antwortelemente
Das SearchCustomersResponse-Objekt definiert den Text und die Headerelemente der Dienstvorgangsantwort. Die Elemente werden in der gleichen Reihenfolge zurückgegeben, in der die Antwort-SOAP gezeigt wird.
Antworttextelemente
Element | Beschreibung | Datentyp |
---|---|---|
Kundschaft | Eine Liste der Kunden, die die Anforderungskriterien erfüllen. | Kundenarray |
Antwortheaderelemente
Element | Beschreibung | Datentyp |
---|---|---|
TrackingId | Der Bezeichner des Protokolleintrags, der die Details des API-Aufrufs enthält. | Zeichenfolge |
SOAP anfordern
Diese Vorlage wurde von einem Tool generiert, um die Reihenfolge der Text- und Headerelemente für die SOAP-Anforderung anzuzeigen. Informationen zu unterstützten Typen, die Sie mit diesem Dienstvorgang verwenden können, finden Sie oben in der Referenz zu Anforderungstextelementen .
<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:e77="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e77:Predicate>
<e77:Field i:nil="false">ValueHere</e77:Field>
<e77:Operator>ValueHere</e77:Operator>
<e77:Value i:nil="false">ValueHere</e77:Value>
</e77:Predicate>
</Predicates>
<DateRange xmlns:e78="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e78:MinDate i:nil="false">ValueHere</e78:MinDate>
<e78:MaxDate i:nil="false">ValueHere</e78:MaxDate>
</DateRange>
<Ordering xmlns:e79="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e79:OrderBy>
<e79:Field>ValueHere</e79:Field>
<e79:Order>ValueHere</e79:Order>
</e79:OrderBy>
</Ordering>
<PageInfo xmlns:e80="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e80:Index>ValueHere</e80:Index>
<e80:Size>ValueHere</e80:Size>
</PageInfo>
</SearchCustomersRequest>
</s:Body>
</s:Envelope>
Antwort-SOAP
Diese Vorlage wurde von einem Tool generiert, um die Reihenfolge der Text- und Headerelemente für die SOAP-Antwort anzuzeigen.
<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:e81="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<e81:Customer>
<e81:CustomerFinancialStatus d4p1:nil="false">ValueHere</e81:CustomerFinancialStatus>
<e81:Id d4p1:nil="false">ValueHere</e81:Id>
<e81:Industry d4p1:nil="false">ValueHere</e81:Industry>
<e81:LastModifiedByUserId d4p1:nil="false">ValueHere</e81:LastModifiedByUserId>
<e81:LastModifiedTime d4p1:nil="false">ValueHere</e81:LastModifiedTime>
<e81:MarketCountry d4p1:nil="false">ValueHere</e81:MarketCountry>
<e81:ForwardCompatibilityMap xmlns:e82="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e82:KeyValuePairOfstringstring>
<e82:key d4p1:nil="false">ValueHere</e82:key>
<e82:value d4p1:nil="false">ValueHere</e82:value>
</e82:KeyValuePairOfstringstring>
</e81:ForwardCompatibilityMap>
<e81:MarketLanguage d4p1:nil="false">ValueHere</e81:MarketLanguage>
<e81:Name d4p1:nil="false">ValueHere</e81:Name>
<e81:ServiceLevel d4p1:nil="false">ValueHere</e81:ServiceLevel>
<e81:CustomerLifeCycleStatus d4p1:nil="false">ValueHere</e81:CustomerLifeCycleStatus>
<e81:TimeStamp d4p1:nil="false">ValueHere</e81:TimeStamp>
<e81:Number d4p1:nil="false">ValueHere</e81:Number>
<e81:CustomerAddress d4p1:nil="false">
<e81:City d4p1:nil="false">ValueHere</e81:City>
<e81:CountryCode d4p1:nil="false">ValueHere</e81:CountryCode>
<e81:Id d4p1:nil="false">ValueHere</e81:Id>
<e81:Line1 d4p1:nil="false">ValueHere</e81:Line1>
<e81:Line2 d4p1:nil="false">ValueHere</e81:Line2>
<e81:Line3 d4p1:nil="false">ValueHere</e81:Line3>
<e81:Line4 d4p1:nil="false">ValueHere</e81:Line4>
<e81:PostalCode d4p1:nil="false">ValueHere</e81:PostalCode>
<e81:StateOrProvince d4p1:nil="false">ValueHere</e81:StateOrProvince>
<e81:TimeStamp d4p1:nil="false">ValueHere</e81:TimeStamp>
<e81:BusinessName d4p1:nil="false">ValueHere</e81:BusinessName>
</e81:CustomerAddress>
</e81:Customer>
</Customers>
</SearchCustomersResponse>
</s:Body>
</s:Envelope>
Codesyntax
Die Beispielsyntax kann mit Bing Ads SDKs verwendet werden. Weitere Beispiele finden Sie unter Codebeispiele für die Bing Ads-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)
Anforderungen
Service: CustomerManagementService.svc v13
Namespace: https://bingads.microsoft.com/Customer/v13
Anforderungs-URL
https://clientcenter.api.bingads.microsoft.com/CustomerManagement/v13/Customers/Search
Anfordern von Elementen
Das SearchCustomersRequest-Objekt definiert den Text und die Headerelemente der Dienstvorgangsanforderung.
Hinweis
Sofern unten nicht anders angegeben, sind alle Anforderungselemente erforderlich.
Anforderungstextelemente
Element | Beschreibung | Datentyp |
---|---|---|
DateRange | Bestimmt den minimalen und maximalen Datumsbereich für die Kundenerstellung. Dieses Anforderungselement ist optional. |
DateRange |
Ordnung | Bestimmt die Reihenfolge der Ergebnisse anhand der angegebenen Eigenschaft eines Kunden. Dieses Anforderungselement ist optional. Sie können bis zu einem OrderBy-Element im Array angeben. Zusätzliche Elemente werden nicht unterstützt und vom Dienst ignoriert. Für diesen Dienstvorgang werden die folgenden Werte im Field-Element eines OrderBy-Objekts unterstützt: ID : Die Bestellung wird durch das Id-Element des zurückgegebenen Kunden bestimmt. Name : Die Bestellung wird durch das Name-Element des zurückgegebenen Kunden bestimmt. Number : Die Bestellung wird durch das Number-Element des zurückgegebenen Kunden bestimmt. |
OrderBy-Array |
PageInfo | Bestimmt den Index und die Größe der Ergebnisse pro Seite. | Paging |
Prädikate | Bestimmt die Bedingungen, unter denen alle erfüllt sein müssen, um Kunden zurückzugeben. Sie müssen zwischen einem und 10 Prädikaten einschließen. Um nach dem erstellten Datumsbereich zu filtern, können Sie zwei Prädikate mit dem Wert Field einschließen, der auf CreatedDate festgelegt ist. Andernfalls können Sie jedes Prädikatfeld nur einmal verwenden. Ausführliche Informationen zu den einzelnen unterstützten Prädikat-Feldwerten finden Sie in den Prädikatshinweisen. |
Prädikatarray |
Anforderungsheaderelemente
Element | Beschreibung | Datentyp |
---|---|---|
Authorization | Das OAuth-Zugriffstoken, das die Anmeldeinformationen eines Benutzers darstellt, der über Berechtigungen für Microsoft Advertising-Konten verfügt. Stellen Sie sicher, dass dem Token das Präfix "Bearer" vorangestellt ist. Dies ist für die ordnungsgemäße Authentifizierung erforderlich. Weitere Informationen finden Sie unter Authentifizierung mit OAuth. |
Zeichenfolge |
DeveloperToken | Das Entwicklertoken, das für den Zugriff auf die Bing Ads-API verwendet wird. Weitere Informationen finden Sie unter Abrufen eines Entwicklertokens. |
Zeichenfolge |
Kennwort | Dieses Element ist für die interne Verwendung reserviert und wird aus einer zukünftigen Version der API entfernt. Sie müssen das AuthenticationToken-Element verwenden, um Benutzeranmeldeinformationen festzulegen. | Zeichenfolge |
UserName | Dieses Element ist für die interne Verwendung reserviert und wird aus einer zukünftigen Version der API entfernt. Sie müssen das AuthenticationToken-Element verwenden, um Benutzeranmeldeinformationen festzulegen. | Zeichenfolge |
Antwortelemente
Das SearchCustomersResponse-Objekt definiert den Text und die Headerelemente der Dienstvorgangsantwort. Die Elemente werden in der gleichen Reihenfolge zurückgegeben wie im Antwort-JSON-Code gezeigt.
Antworttextelemente
Element | Beschreibung | Datentyp |
---|---|---|
Kundschaft | Eine Liste der Kunden, die die Anforderungskriterien erfüllen. | Kundenarray |
Antwortheaderelemente
Element | Beschreibung | Datentyp |
---|---|---|
TrackingId | Der Bezeichner des Protokolleintrags, der die Details des API-Aufrufs enthält. | Zeichenfolge |
JSON anfordern
Diese Vorlage wurde von einem Tool generiert, um die Text- und Headerelemente für die JSON-Anforderung anzuzeigen. Informationen zu unterstützten Typen, die Sie mit diesem Dienstvorgang verwenden können, finden Sie oben in der Referenz zu Anforderungstextelementen .
{
"Predicates": [
{
"Field": "ValueHere",
"Operator": "ValueHere",
"Value": "ValueHere"
}
],
"DateRange": {
"MaxDate": "ValueHere",
"MinDate": "ValueHere"
},
"Ordering": [
{
"Field": "ValueHere",
"Order": "ValueHere"
}
],
"PageInfo": {
"Index": IntValueHere,
"Size": IntValueHere
}
}
Antwort-JSON
Diese Vorlage wurde von einem Tool generiert, um die Text- und Headerelemente für die JSON-Antwort anzuzeigen.
{
"Customers": [
{
"CustomerAddress": {
"BusinessName": "ValueHere",
"City": "ValueHere",
"CountryCode": "ValueHere",
"Id": "LongValueHere",
"Line1": "ValueHere",
"Line2": "ValueHere",
"Line3": "ValueHere",
"Line4": "ValueHere",
"PostalCode": "ValueHere",
"StateOrProvince": "ValueHere",
"TimeStamp": "ValueHere"
},
"CustomerFinancialStatus": "ValueHere",
"CustomerLifeCycleStatus": "ValueHere",
"ForwardCompatibilityMap": [
{
"key": "ValueHere",
"value": "ValueHere"
}
],
"Id": "LongValueHere",
"Industry": "ValueHere",
"LastModifiedByUserId": "LongValueHere",
"LastModifiedTime": "ValueHere",
"MarketCountry": "ValueHere",
"MarketLanguage": "ValueHere",
"Name": "ValueHere",
"Number": "ValueHere",
"ServiceLevel": "ValueHere",
"TimeStamp": "ValueHere"
}
]
}
Codesyntax
Um die REST-API über SDKs aufzurufen, müssen Sie das SDK auf eine bestimmte Version aktualisieren und die Systemparameter konfigurieren. Die Beispielsyntax kann mit Bing Ads SDKs verwendet werden. Weitere Beispiele finden Sie unter Codebeispiele für die Bing Ads-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)