SearchAccounts-Dienstvorgang – Kundenverwaltung
Sucht nach Konten, die den Anforderungskriterien entsprechen.
Sie können beispielsweise nach Konten suchen, auf die der aktuell authentifizierte Benutzer zugreifen kann.
Tipp
Eine Übersicht mit Beispielen finden Sie im Leitfaden zu Konto-Hierchy- und Benutzerberechtigungen .
Anfordern von Elementen
Das SearchAccountsRequest-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 |
---|---|---|
Bestellung | Bestimmt die Reihenfolge der Ergebnisse anhand der angegebenen Eigenschaft eines Kontos. 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. Wenn Sie das Field-Element des OrderBy-Objekts auf "Id", "Name" oder "Number" festlegen, werden die zurückgegebenen Konten entsprechend nach den Kontobezeichnern, Namen oder Zahlen sortiert. Dieses Anforderungselement ist optional. |
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 Konten zurückzugeben. Sie müssen genau ein Prädikat einschließen. Wenn das Prädikat Field auf "AccountLifeCycleStatus" festgelegt ist, müssen Sie ein zusätzliches Prädikat angeben, wobei das Feld auf einen anderen Wert festgelegt ist, z. B. UserId. Ausführliche Informationen zu den einzelnen unterstützten Prädikat-Feldwerten finden Sie in den Prädikatshinweisen. |
Prädikatarray |
ReturnAdditionalFields | Die Liste der zusätzlichen Eigenschaften, die in jedem zurückgegebenen Konto enthalten sein sollen. Mit den zusätzlichen Feldwerten können Sie die neuesten Features mithilfe der aktuellen Version der Kundenverwaltungs-API abrufen, und in der nächsten Version werden die entsprechenden Elemente standardmäßig eingeschlossen. Dieses Anforderungselement ist optional. |
AccountAdditionalField |
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 SearchAccountsResponse-Objekt definiert die Text- und Headerelemente der Dienstvorgangsantwort. Die Elemente werden in der gleichen Reihenfolge zurückgegeben, in der die Antwort-SOAP gezeigt wird.
Antworttextelemente
Element | Beschreibung | Datentyp |
---|---|---|
Konten | Eine Liste von Konten, die die Anforderungskriterien erfüllen. | AdvertiserAccount-Array |
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">SearchAccounts</Action>
<AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
<DeveloperToken i:nil="false">ValueHere</DeveloperToken>
</s:Header>
<s:Body>
<SearchAccountsRequest xmlns="https://bingads.microsoft.com/Customer/v13">
<Predicates xmlns:e243="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e243:Predicate>
<e243:Field i:nil="false">ValueHere</e243:Field>
<e243:Operator>ValueHere</e243:Operator>
<e243:Value i:nil="false">ValueHere</e243:Value>
</e243:Predicate>
</Predicates>
<Ordering xmlns:e244="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e244:OrderBy>
<e244:Field>ValueHere</e244:Field>
<e244:Order>ValueHere</e244:Order>
</e244:OrderBy>
</Ordering>
<PageInfo xmlns:e245="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e245:Index>ValueHere</e245:Index>
<e245:Size>ValueHere</e245:Size>
</PageInfo>
<ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
</SearchAccountsRequest>
</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>
<SearchAccountsResponse xmlns="https://bingads.microsoft.com/Customer/v13">
<Accounts xmlns:e246="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<e246:AdvertiserAccount>
<e246:BillToCustomerId d4p1:nil="false">ValueHere</e246:BillToCustomerId>
<e246:CurrencyCode d4p1:nil="false">ValueHere</e246:CurrencyCode>
<e246:AccountFinancialStatus d4p1:nil="false">ValueHere</e246:AccountFinancialStatus>
<e246:Id d4p1:nil="false">ValueHere</e246:Id>
<e246:Language d4p1:nil="false">ValueHere</e246:Language>
<e246:LastModifiedByUserId d4p1:nil="false">ValueHere</e246:LastModifiedByUserId>
<e246:LastModifiedTime d4p1:nil="false">ValueHere</e246:LastModifiedTime>
<e246:Name d4p1:nil="false">ValueHere</e246:Name>
<e246:Number d4p1:nil="false">ValueHere</e246:Number>
<e246:ParentCustomerId>ValueHere</e246:ParentCustomerId>
<e246:PaymentMethodId d4p1:nil="false">ValueHere</e246:PaymentMethodId>
<e246:PaymentMethodType d4p1:nil="false">ValueHere</e246:PaymentMethodType>
<e246:PrimaryUserId d4p1:nil="false">ValueHere</e246:PrimaryUserId>
<e246:AccountLifeCycleStatus d4p1:nil="false">ValueHere</e246:AccountLifeCycleStatus>
<e246:TimeStamp d4p1:nil="false">ValueHere</e246:TimeStamp>
<e246:TimeZone d4p1:nil="false">ValueHere</e246:TimeZone>
<e246:PauseReason d4p1:nil="false">ValueHere</e246:PauseReason>
<e246:ForwardCompatibilityMap xmlns:e247="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e247:KeyValuePairOfstringstring>
<e247:key d4p1:nil="false">ValueHere</e247:key>
<e247:value d4p1:nil="false">ValueHere</e247:value>
</e247:KeyValuePairOfstringstring>
</e246:ForwardCompatibilityMap>
<e246:LinkedAgencies d4p1:nil="false">
<e246:CustomerInfo>
<e246:Id d4p1:nil="false">ValueHere</e246:Id>
<e246:Name d4p1:nil="false">ValueHere</e246:Name>
</e246:CustomerInfo>
</e246:LinkedAgencies>
<e246:SalesHouseCustomerId d4p1:nil="false">ValueHere</e246:SalesHouseCustomerId>
<e246:TaxInformation xmlns:e248="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e248:KeyValuePairOfstringstring>
<e248:key d4p1:nil="false">ValueHere</e248:key>
<e248:value d4p1:nil="false">ValueHere</e248:value>
</e248:KeyValuePairOfstringstring>
</e246:TaxInformation>
<e246:BackUpPaymentInstrumentId d4p1:nil="false">ValueHere</e246:BackUpPaymentInstrumentId>
<e246:BillingThresholdAmount d4p1:nil="false">ValueHere</e246:BillingThresholdAmount>
<e246:BusinessAddress d4p1:nil="false">
<e246:City d4p1:nil="false">ValueHere</e246:City>
<e246:CountryCode d4p1:nil="false">ValueHere</e246:CountryCode>
<e246:Id d4p1:nil="false">ValueHere</e246:Id>
<e246:Line1 d4p1:nil="false">ValueHere</e246:Line1>
<e246:Line2 d4p1:nil="false">ValueHere</e246:Line2>
<e246:Line3 d4p1:nil="false">ValueHere</e246:Line3>
<e246:Line4 d4p1:nil="false">ValueHere</e246:Line4>
<e246:PostalCode d4p1:nil="false">ValueHere</e246:PostalCode>
<e246:StateOrProvince d4p1:nil="false">ValueHere</e246:StateOrProvince>
<e246:TimeStamp d4p1:nil="false">ValueHere</e246:TimeStamp>
<e246:BusinessName d4p1:nil="false">ValueHere</e246:BusinessName>
</e246:BusinessAddress>
<e246:AutoTagType d4p1:nil="false">ValueHere</e246:AutoTagType>
<e246:SoldToPaymentInstrumentId d4p1:nil="false">ValueHere</e246:SoldToPaymentInstrumentId>
<e246:TaxCertificate d4p1:nil="false">
<e246:TaxCertificateBlobContainerName d4p1:nil="false">ValueHere</e246:TaxCertificateBlobContainerName>
<e246:TaxCertificates xmlns:e249="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e249:KeyValuePairOfstringbase64Binary>
<e249:key d4p1:nil="false">ValueHere</e249:key>
<e249:value d4p1:nil="false">ValueHere</e249:value>
</e249:KeyValuePairOfstringbase64Binary>
</e246:TaxCertificates>
<e246:Status d4p1:nil="false">ValueHere</e246:Status>
</e246:TaxCertificate>
<e246:AccountMode d4p1:nil="false">ValueHere</e246:AccountMode>
</e246:AdvertiserAccount>
</Accounts>
</SearchAccountsResponse>
</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<SearchAccountsResponse> SearchAccountsAsync(
IList<Predicate> predicates,
IList<OrderBy> ordering,
Paging pageInfo,
AccountAdditionalField? returnAdditionalFields)
{
var request = new SearchAccountsRequest
{
Predicates = predicates,
Ordering = ordering,
PageInfo = pageInfo,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CustomerManagementService.CallAsync((s, r) => s.SearchAccountsAsync(r), request));
}
static SearchAccountsResponse searchAccounts(
ArrayOfPredicate predicates,
ArrayOfOrderBy ordering,
Paging pageInfo,
ArrayList<AccountAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
SearchAccountsRequest request = new SearchAccountsRequest();
request.setPredicates(predicates);
request.setOrdering(ordering);
request.setPageInfo(pageInfo);
request.setReturnAdditionalFields(returnAdditionalFields);
return CustomerManagementService.getService().searchAccounts(request);
}
static function SearchAccounts(
$predicates,
$ordering,
$pageInfo,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerManagementProxy'];
$request = new SearchAccountsRequest();
$request->Predicates = $predicates;
$request->Ordering = $ordering;
$request->PageInfo = $pageInfo;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CustomerManagementProxy']->GetService()->SearchAccounts($request);
}
response=customermanagement_service.SearchAccounts(
Predicates=Predicates,
Ordering=Ordering,
PageInfo=PageInfo,
ReturnAdditionalFields=ReturnAdditionalFields)
Anforderungen
Service: CustomerManagementService.svc v13
Namespace: https://bingads.microsoft.com/Customer/v13