FindAccounts-Dienstvorgang – Kundenverwaltung

Artikel
11/14/2024

Ruft eine Liste der Konten ab, die dem angegebenen Kunden gehören und den angegebenen Filterkriterien entsprechen.

Anfordern von Elementen

Das FindAccountsRequest-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
AccountFilter	Die Kriterien, die zum Filtern der Liste der Konten verwendet werden sollen. Sie können entweder einen Kontonamen oder eine Kontonummer angeben. Wenn Der Filterwert das Format Xnnnnn hat, wobei nnnnn eine Reihe von Ziffern ist, filtert der Vorgang nach Kontonummer. Der Filterwert kann einen teilweisen oder vollständigen Kontonamen oder eine Nummer der Konten enthalten, die Sie abrufen möchten. Der Vorgang schließt das Konto in das Ergebnis ein, wenn der Name oder die Nummer des Kontos mit dem angegebenen Filterwert beginnt. Der Vorgang führt einen Vergleich ohne Berücksichtigung der Groß-/Kleinschreibung durch, wenn der Filterwert mit dem Kontonamen oder der Kontonummer verglichen wird. Wenn Sie beispielsweise "t" als Filterwert angeben, enthält die Liste Konten, deren Namen mit "t" oder "T" beginnen. Das Festlegen dieses Elements auf eine leere Zeichenfolge entspricht dem Aufrufen von GetAccountsInfo.	Zeichenfolge
CustomerId	Der Bezeichner des Kunden, dessen Konten Sie abrufen möchten. Wenn null, sucht der Vorgang nach einer Übereinstimmung zwischen allen Konten der Kunden, die der Benutzer verwaltet und besitzt.	lang
TopN	Eine positive ganze Zahl ungleich 0 (null), die die Anzahl von Konten angibt, die im Ergebnis zurückgegeben werden sollen. Sie müssen einen Wert zwischen 1 und 5.000 angeben.	int

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 FindAccountsResponse-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
AccountsInfo	Eine Liste der AccountInfo-Objekte der Konten, die den angegebenen Filterkriterien entsprechen. Um die vollständigen Details eines Kontos in der Liste abzurufen, greifen Sie auf das Id-Element des AccountInfo-Objekts zu, und verwenden Sie es zum Aufrufen von GetAccount.	AccountInfo-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">FindAccounts</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <FindAccountsRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <CustomerId i:nil="false">ValueHere</CustomerId>
      <AccountFilter i:nil="false">ValueHere</AccountFilter>
      <TopN>ValueHere</TopN>
    </FindAccountsRequest>
  </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>
    <FindAccountsResponse xmlns="https://bingads.microsoft.com/Customer/v13">
      <AccountsInfo xmlns:e475="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e475:AccountInfo>
          <e475:Id>ValueHere</e475:Id>
          <e475:Name d4p1:nil="false">ValueHere</e475:Name>
          <e475:Number d4p1:nil="false">ValueHere</e475:Number>
          <e475:AccountLifeCycleStatus>ValueHere</e475:AccountLifeCycleStatus>
          <e475:PauseReason d4p1:nil="false">ValueHere</e475:PauseReason>
        </e475:AccountInfo>
      </AccountsInfo>
    </FindAccountsResponse>
  </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<FindAccountsResponse> FindAccountsAsync(
	long? customerId,
	string accountFilter,
	int topN)
{
	var request = new FindAccountsRequest
	{
		CustomerId = customerId,
		AccountFilter = accountFilter,
		TopN = topN
	};

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

static FindAccountsResponse findAccounts(
	java.lang.Long customerId,
	java.lang.String accountFilter,
	int topN) throws RemoteException, Exception
{
	FindAccountsRequest request = new FindAccountsRequest();

	request.setCustomerId(customerId);
	request.setAccountFilter(accountFilter);
	request.setTopN(topN);

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

static function FindAccounts(
	$customerId,
	$accountFilter,
	$topN)
{

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

	$request = new FindAccountsRequest();

	$request->CustomerId = $customerId;
	$request->AccountFilter = $accountFilter;
	$request->TopN = $topN;

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

response=customermanagement_service.FindAccounts(
	CustomerId=CustomerId,
	AccountFilter=AccountFilter,
	TopN=TopN)

Anforderungen

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

https://clientcenter.api.bingads.microsoft.com/CustomerManagement/v13/Accounts/Find

https://clientcenter.api.sandbox.bingads.microsoft.com/CustomerManagement/v13/Accounts/Find

Anfordern von Elementen

Das FindAccountsRequest-Objekt definiert den Text und die Headerelemente der Dienstvorgangsanforderung.

Hinweis

Sofern unten nicht anders angegeben, sind alle Anforderungselemente erforderlich.

Anforderungstextelemente

Element	Beschreibung	Datentyp
AccountFilter	Die Kriterien, die zum Filtern der Liste der Konten verwendet werden sollen. Sie können entweder einen Kontonamen oder eine Kontonummer angeben. Wenn Der Filterwert das Format Xnnnnn hat, wobei nnnnn eine Reihe von Ziffern ist, filtert der Vorgang nach Kontonummer. Der Filterwert kann einen teilweisen oder vollständigen Kontonamen oder eine Nummer der Konten enthalten, die Sie abrufen möchten. Der Vorgang schließt das Konto in das Ergebnis ein, wenn der Name oder die Nummer des Kontos mit dem angegebenen Filterwert beginnt. Der Vorgang führt einen Vergleich ohne Berücksichtigung der Groß-/Kleinschreibung durch, wenn der Filterwert mit dem Kontonamen oder der Kontonummer verglichen wird. Wenn Sie beispielsweise "t" als Filterwert angeben, enthält die Liste Konten, deren Namen mit "t" oder "T" beginnen. Das Festlegen dieses Elements auf eine leere Zeichenfolge entspricht dem Aufrufen von GetAccountsInfo.	Zeichenfolge
CustomerId	Der Bezeichner des Kunden, dessen Konten Sie abrufen möchten. Wenn null, sucht der Vorgang nach einer Übereinstimmung zwischen allen Konten der Kunden, die der Benutzer verwaltet und besitzt.	lang
TopN	Eine positive ganze Zahl ungleich 0 (null), die die Anzahl von Konten angibt, die im Ergebnis zurückgegeben werden sollen. Sie müssen einen Wert zwischen 1 und 5.000 angeben.	int

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 FindAccountsResponse-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
AccountsInfo	Eine Liste der AccountInfo-Objekte der Konten, die den angegebenen Filterkriterien entsprechen. Um die vollständigen Details eines Kontos in der Liste abzurufen, greifen Sie auf das Id-Element des AccountInfo-Objekts zu, und verwenden Sie es zum Aufrufen von GetAccount.	AccountInfo-Array

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 .

{
  "CustomerId": "LongValueHere",
  "AccountFilter": "ValueHere",
  "TopN": IntValueHere
}

Antwort-JSON

Diese Vorlage wurde von einem Tool generiert, um die Text- und Headerelemente für die JSON-Antwort anzuzeigen.

{
  "AccountsInfo": [
    {
      "AccountLifeCycleStatus": "ValueHere",
      "Id": "LongValueHere",
      "Name": "ValueHere",
      "Number": "ValueHere",
      "PauseReason": "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<FindAccountsResponse> FindAccountsAsync(
	long? customerId,
	string accountFilter,
	int topN)
{
	var request = new FindAccountsRequest
	{
		CustomerId = customerId,
		AccountFilter = accountFilter,
		TopN = topN
	};

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

static FindAccountsResponse findAccounts(
	java.lang.Long customerId,
	java.lang.String accountFilter,
	int topN) throws RemoteException, Exception
{
	FindAccountsRequest request = new FindAccountsRequest();

	request.setCustomerId(customerId);
	request.setAccountFilter(accountFilter);
	request.setTopN(topN);

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

static function FindAccounts(
	$customerId,
	$accountFilter,
	$topN)
{

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

	$request = new FindAccountsRequest();

	$request->CustomerId = $customerId;
	$request->AccountFilter = $accountFilter;
	$request->TopN = $topN;

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

response=customermanagement_service.FindAccounts(
	CustomerId=CustomerId,
	AccountFilter=AccountFilter,
	TopN=TopN)

Freigeben über

FindAccounts-Dienstvorgang – Kundenverwaltung

Anfordern von Elementen

Anforderungstextelemente

Anforderungsheaderelemente

Antwortelemente

Antworttextelemente

Antwortheaderelemente

SOAP anfordern

Antwort-SOAP

Codesyntax

Anforderungen

Anforderungs-URL

Anfordern von Elementen

Anforderungstextelemente

Anforderungsheaderelemente

Antwortelemente

Antworttextelemente

Antwortheaderelemente

JSON anfordern

Antwort-JSON

Codesyntax

Feedback

Zusätzliche Ressourcen