SearchCompanies Service Operation - Campaign Management

Article
03/20/2023

Search for profile data by company name.

Each returned Company includes a profile identifier that you can use with ProfileCriterion.

Note

You can use the GetProfileDataFileUrl operation to get industry and job function profile data.

Request Elements

The SearchCompaniesRequest object defines the body and header elements of the service operation request. The elements must be in the same order as shown in the Request SOAP.

Note

Unless otherwise noted below, all request elements are required.

Request Body Elements

Element	Description	Data Type
CompanyNameFilter	The company name filter string. You can search using partial or full company name. The minimum length of the string is 3. The service searches across all language-locales for the string. The company name will be returned in the requested LanguageLocale if available.	string
LanguageLocale	The language and locale of the profile display names. The supported language locale values are zh-Hant (Traditional Chinese), en (English), fr (French), de (German), it (Italian), pt-BR (Brazilian Portuguese), and es (Spanish). Please note if LinkedIn does not provide the localized profile name, then it will default to the universal name (usually defined in English).	string

Request Header Elements

Element	Description	Data Type
AuthenticationToken	The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. For more information see Authentication with OAuth.	string
CustomerAccountId	The identifier of the ad account that owns or is associated with the entities in the request. This header element must have the same value as the AccountId body element when both are required. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs.	string
CustomerId	The identifier of the manager account (customer) the user is accessing or operating from. A user can have access to multiple manager accounts. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs.	string
DeveloperToken	The developer token used to access the Bing Ads API. For more information see Get a Developer Token.	string
Password	This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials.	string
UserName	This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials.	string

Response Elements

The SearchCompaniesResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response SOAP.

Response Body Elements

Element	Description	Data Type
Companies	The list of companies that match the requested company name filter.	Company array

Response Header Elements

Element	Description	Data Type
TrackingId	The identifier of the log entry that contains the details of the API call.	string

Request SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP request. For supported types that you can use with this service operation, see the Request Body Elements reference above.

<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>

Response SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP response.

<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>

Code Syntax

The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.

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)

Requirements

Service: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13