SearchCompanies Service Operation – Kampagnenverwaltung
Suchen Sie nach Profildaten anhand des Firmennamens.
Jedes zurückgegebene Unternehmen enthält einen Profilbezeichner, den Sie mit ProfileCriterion verwenden können.
Hinweis
Sie können den Vorgang GetProfileDataFileUrl verwenden, um Branchen- und Auftragsfunktionsprofildaten abzurufen.
Anfordern von Elementen
Das SearchCompaniesRequest-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 |
|---|---|---|
| CompanyNameFilter | Die Filterzeichenfolge des Unternehmensnamens. Sie können mit einem teilweisen oder vollständigen Firmennamen suchen. Die Mindestlänge der Zeichenfolge ist 3. Der Dienst sucht in allen Sprachgebietsschemas nach der Zeichenfolge. Der Firmenname wird in der angeforderten LanguageLocale zurückgegeben, sofern verfügbar. |
Zeichenfolge |
| LanguageLocale | Die Sprache und das Gebietsschema der Profilanzeigenamen. Die unterstützten Sprachgebietsschemawerte sind zh-Hant (traditionelles Chinesisch), en (Englisch), fr (Französisch), de (Deutsch), it (Italienisch), pt-BR (Brasilianisches Portugiesisch) und es (Spanisch). Beachten Sie, dass, wenn LinkedIn den lokalisierten Profilnamen nicht bereitstellt, standardmäßig der universelle Name (in der Regel auf Englisch definiert) verwendet wird. |
Zeichenfolge |
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 |
| CustomerAccountId | Der Bezeichner des Anzeigenkontos, das die Entitäten in der Anforderung besitzt oder zugeordnet ist. Dieses Headerelement muss denselben Wert wie das AccountId-Body-Element aufweisen, wenn beides erforderlich ist. Dieses Element ist für die meisten Dienstvorgänge erforderlich, und als bewährte Methode sollten Sie es immer festlegen. Weitere Informationen finden Sie unter Abrufen Von Konto- und Kunden-IDs. |
Zeichenfolge |
| CustomerId | Der Bezeichner des Vorgesetztenkontos (Kunde), auf das der Benutzer zugreift oder von dort aus arbeitet. Ein Benutzer kann Zugriff auf mehrere Managerkonten haben. Dieses Element ist für die meisten Dienstvorgänge erforderlich, und als bewährte Methode sollten Sie es immer festlegen. Weitere Informationen finden Sie unter Abrufen Von Konto- und Kunden-IDs. |
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 SearchCompaniesResponse-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 |
|---|---|---|
| Unternehmen | Die Liste der Unternehmen, die dem angeforderten Firmennamenfilter entsprechen. | Unternehmensarray |
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/CampaignManagement/v13">
<Action mustUnderstand="1">SearchCompanies</Action>
<AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
<CustomerAccountId i:nil="false">ValueHere</CustomerAccountId>
<CustomerId i:nil="false">ValueHere</CustomerId>
<DeveloperToken i:nil="false">ValueHere</DeveloperToken>
</s:Header>
<s:Body>
<SearchCompaniesRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<CompanyNameFilter i:nil="false">ValueHere</CompanyNameFilter>
<LanguageLocale i:nil="false">ValueHere</LanguageLocale>
</SearchCompaniesRequest>
</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/CampaignManagement/v13">
<TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
</s:Header>
<s:Body>
<SearchCompaniesResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<Companies d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<Company>
<LogoUrl d4p1:nil="false">ValueHere</LogoUrl>
<Name d4p1:nil="false">ValueHere</Name>
<ProfileId>ValueHere</ProfileId>
<Status d4p1:nil="false">ValueHere</Status>
</Company>
</Companies>
</SearchCompaniesResponse>
</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<SearchCompaniesResponse> SearchCompaniesAsync(
string companyNameFilter,
string languageLocale)
{
var request = new SearchCompaniesRequest
{
CompanyNameFilter = companyNameFilter,
LanguageLocale = languageLocale
};
return (await CampaignManagementService.CallAsync((s, r) => s.SearchCompaniesAsync(r), request));
}
static SearchCompaniesResponse searchCompanies(
java.lang.String companyNameFilter,
java.lang.String languageLocale) throws RemoteException, Exception
{
SearchCompaniesRequest request = new SearchCompaniesRequest();
request.setCompanyNameFilter(companyNameFilter);
request.setLanguageLocale(languageLocale);
return CampaignManagementService.getService().searchCompanies(request);
}
static function SearchCompanies(
$companyNameFilter,
$languageLocale)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new SearchCompaniesRequest();
$request->CompanyNameFilter = $companyNameFilter;
$request->LanguageLocale = $languageLocale;
return $GLOBALS['CampaignManagementProxy']->GetService()->SearchCompanies($request);
}
response=campaignmanagement_service.SearchCompanies(
CompanyNameFilter=CompanyNameFilter,
LanguageLocale=LanguageLocale)
Anforderungen
Dienst: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13
Anforderungs-URL
https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/Companies/Search
Anfordern von Elementen
Das SearchCompaniesRequest-Objekt definiert den Text und die Headerelemente der Dienstvorgangsanforderung.
Hinweis
Sofern unten nicht anders angegeben, sind alle Anforderungselemente erforderlich.
Anforderungstextelemente
| Element | Beschreibung | Datentyp |
|---|---|---|
| CompanyNameFilter | Die Filterzeichenfolge des Unternehmensnamens. Sie können mit einem teilweisen oder vollständigen Firmennamen suchen. Die Mindestlänge der Zeichenfolge ist 3. Der Dienst sucht in allen Sprachgebietsschemas nach der Zeichenfolge. Der Firmenname wird in der angeforderten LanguageLocale zurückgegeben, sofern verfügbar. |
Zeichenfolge |
| LanguageLocale | Die Sprache und das Gebietsschema der Profilanzeigenamen. Die unterstützten Sprachgebietsschemawerte sind zh-Hant (traditionelles Chinesisch), en (Englisch), fr (Französisch), de (Deutsch), it (Italienisch), pt-BR (Brasilianisches Portugiesisch) und es (Spanisch). Beachten Sie, dass, wenn LinkedIn den lokalisierten Profilnamen nicht bereitstellt, standardmäßig der universelle Name (in der Regel auf Englisch definiert) verwendet wird. |
Zeichenfolge |
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 |
| CustomerAccountId | Der Bezeichner des Anzeigenkontos, das die Entitäten in der Anforderung besitzt oder zugeordnet ist. Dieses Headerelement muss denselben Wert wie das AccountId-Body-Element aufweisen, wenn beides erforderlich ist. Dieses Element ist für die meisten Dienstvorgänge erforderlich, und als bewährte Methode sollten Sie es immer festlegen. Weitere Informationen finden Sie unter Abrufen Von Konto- und Kunden-IDs. |
Zeichenfolge |
| CustomerId | Der Bezeichner des Vorgesetztenkontos (Kunde), auf das der Benutzer zugreift oder von dort aus arbeitet. Ein Benutzer kann Zugriff auf mehrere Managerkonten haben. Dieses Element ist für die meisten Dienstvorgänge erforderlich, und als bewährte Methode sollten Sie es immer festlegen. Weitere Informationen finden Sie unter Abrufen Von Konto- und Kunden-IDs. |
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 SearchCompaniesResponse-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 |
|---|---|---|
| Unternehmen | Die Liste der Unternehmen, die dem angeforderten Firmennamenfilter entsprechen. | Unternehmensarray |
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 .
{
"CompanyNameFilter": "ValueHere",
"LanguageLocale": "ValueHere"
}
Antwort-JSON
Diese Vorlage wurde von einem Tool generiert, um die Text- und Headerelemente für die JSON-Antwort anzuzeigen.
{
"Companies": [
{
"LogoUrl": "ValueHere",
"Name": "ValueHere",
"ProfileId": "LongValueHere",
"Status": "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<SearchCompaniesResponse> SearchCompaniesAsync(
string companyNameFilter,
string languageLocale)
{
var request = new SearchCompaniesRequest
{
CompanyNameFilter = companyNameFilter,
LanguageLocale = languageLocale
};
return (await CampaignManagementService.CallAsync((s, r) => s.SearchCompaniesAsync(r), request));
}
static SearchCompaniesResponse searchCompanies(
java.lang.String companyNameFilter,
java.lang.String languageLocale) throws RemoteException, Exception
{
SearchCompaniesRequest request = new SearchCompaniesRequest();
request.setCompanyNameFilter(companyNameFilter);
request.setLanguageLocale(languageLocale);
return CampaignManagementService.getService().searchCompanies(request);
}
static function SearchCompanies(
$companyNameFilter,
$languageLocale)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new SearchCompaniesRequest();
$request->CompanyNameFilter = $companyNameFilter;
$request->LanguageLocale = $languageLocale;
return $GLOBALS['CampaignManagementProxy']->GetService()->SearchCompanies($request);
}
response=campaignmanagement_service.SearchCompanies(
CompanyNameFilter=CompanyNameFilter,
LanguageLocale=LanguageLocale)