SearchCompanies 服務作業 - 營銷活動管理

依公司名稱搜尋配置文件數據。

每個傳回 的公司 都包含可搭配 ProfileCriterion 使用的配置文件標識碼。

注意事項

您可以使用 GetProfileDataFileUrl 作業來取得產業和作業函式設定檔數據。

要求專案

SearchCompaniesRequest 物件會定義服務作業要求的主體和標頭元素。 元素的順序必須與 要求SOAP中所示的順序相同。

注意事項

除非下面另有說明，否則所有要求專案都是必要的。

要求本文專案

元素	描述	資料類型
CompanyNameFilter	公司名稱篩選字串。 您可以使用部分或完整公司名稱進行搜尋。 字串的最小長度為 3。 服務會在所有語言地區設定中搜尋字串。 如果有的話， 公司名稱 會在所要求的 LanguageLocale 中傳 回。	string
LanguageLocale	配置文件顯示名稱的語言和地區設定。 支援的語言地區設定值為 zh-Hant (繁體中文) 、 en (English) 、 fr (French) 、 de (german) 、 it (Italian) 、 pt-BR (巴西葡萄牙文) ，以及 es (西班牙文) 。 請注意，如果LinkedIn未提供本地化的配置檔名稱，則預設為通用名稱 (通常以英文) 定義。	string

要求標頭元素

元素	描述	資料類型
AuthenticationToken	OAuth 存取令牌，代表有權Microsoft Advertising 帳戶之用戶的認證。 如需詳細資訊，請 參閱使用 OAuth 進行驗證。	string
CustomerAccountId	擁有或與要求中實體相關聯之廣告帳戶的標識碼。 當兩者都需要時，此標頭元素必須具有與 AccountId body 元素相同的值。 此元素是大部分服務作業的必要專案，最佳做法是一律加以設定。 如需詳細資訊， 請參閱取得您的帳戶和客戶標識符。	string
CustomerId	(使用者存取或操作之使用者) 客戶的管理員帳戶標識碼。 用戶可以存取多個管理員帳戶。 此元素是大部分服務作業的必要專案，最佳做法是一律加以設定。 如需詳細資訊， 請參閱取得您的帳戶和客戶標識符。	string
DeveloperToken	用來存取 Bing 廣告 API 的開發人員令牌。 如需詳細資訊 ，請參閱取得開發人員令牌。	string
密碼	此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。	string
UserName	此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。	string

Response 元素

SearchCompaniesResponse 物件會定義服務作業響應的主體和標頭元素。 這些元素的傳回順序與 回應SOAP中所示的順序相同。

回應本文專案

元素	描述	資料類型
公司	符合要求之公司名稱篩選器的公司清單。	公司陣列

回應標頭元素

元素	描述	資料類型
TrackingId	包含 API 呼叫詳細數據的記錄項目識別碼。	string

要求SOAP

此範本是由工具所產生，用來顯示SOAP要求的主體和標頭元素順序。 如需可搭配此服務作業使用的支援類型，請參閱上述 的要求本文項目 參考。

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

回應 SOAP

此範本是由工具所產生，用來顯示SOAP回應的 主體 和 標頭 元素順序。

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

程序代碼語法

範例語法可以與 Bing 廣告 SDK 搭配使用。 如需更多範例，請參閱 Bing 廣告 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)

需求

服務： CampaignManagementService.svc v13
命名空間： https://bingads.microsoft.com/CampaignManagement/v13

要求 URL

生產URL

https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/Companies/Search

沙箱 URL

https://campaign.api.sandbox.bingads.microsoft.com/CampaignManagement/v13/Companies/Search

要求專案

SearchCompaniesRequest 物件會定義服務作業要求的主體和標頭元素。

注意事項

除非下面另有說明，否則所有要求專案都是必要的。

要求本文專案

元素	描述	資料類型
CompanyNameFilter	公司名稱篩選字串。 您可以使用部分或完整公司名稱進行搜尋。 字串的最小長度為 3。 服務會在所有語言地區設定中搜尋字串。 如果有的話， 公司名稱 會在所要求的 LanguageLocale 中傳 回。	string
LanguageLocale	配置文件顯示名稱的語言和地區設定。 支援的語言地區設定值為 zh-Hant (繁體中文) 、 en (English) 、 fr (French) 、 de (german) 、 it (Italian) 、 pt-BR (巴西葡萄牙文) ，以及 es (西班牙文) 。 請注意，如果LinkedIn未提供本地化的配置檔名稱，則預設為通用名稱 (通常以英文) 定義。	string

要求標頭元素

元素	描述	資料類型
授權	OAuth 存取令牌，代表有權Microsoft Advertising 帳戶之用戶的認證。 請確定令牌前面加上 「Bearer」 ，這是正確驗證的必要專案。 如需詳細資訊，請 參閱使用 OAuth 進行驗證。	string
CustomerAccountId	擁有或與要求中實體相關聯之廣告帳戶的標識碼。 當兩者都需要時，此標頭元素必須具有與 AccountId body 元素相同的值。 此元素是大部分服務作業的必要專案，最佳做法是一律加以設定。 如需詳細資訊， 請參閱取得您的帳戶和客戶標識符。	string
CustomerId	(使用者存取或操作之使用者) 客戶的管理員帳戶標識碼。 用戶可以存取多個管理員帳戶。 此元素是大部分服務作業的必要專案，最佳做法是一律加以設定。 如需詳細資訊， 請參閱取得您的帳戶和客戶標識符。	string
DeveloperToken	用來存取 Bing 廣告 API 的開發人員令牌。 如需詳細資訊 ，請參閱取得開發人員令牌。	string
密碼	此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。	string
UserName	此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。	string

Response 元素

SearchCompaniesResponse 物件會定義服務作業響應的主體和標頭元素。 這些元素的傳回順序與 回應 JSON 中所示的順序相同。

回應本文專案

元素	描述	資料類型
公司	符合要求之公司名稱篩選器的公司清單。	公司陣列

回應標頭元素

元素	描述	資料類型
TrackingId	包含 API 呼叫詳細數據的記錄項目識別碼。	string

要求 JSON

此範本是由工具所產生，用來顯示 JSON 要求的 主體 和 標頭 元素。 如需可搭配此服務作業使用的支援類型，請參閱上述 的要求本文項目 參考。

{
  "CompanyNameFilter": "ValueHere",
  "LanguageLocale": "ValueHere"
}

回應 JSON

此範本是由工具所產生，用來顯示 JSON 回應的 主體 和 標頭 元素。

{
  "Companies": [
    {
      "LogoUrl": "ValueHere",
      "Name": "ValueHere",
      "ProfileId": "LongValueHere",
      "Status": "ValueHere"
    }
  ]
}

程序代碼語法

若要透過 SDK 呼叫 REST API，您必須將 SDK 升級至特定版本並設定系統參數。範例語法可以與 Bing 廣告 SDK 搭配使用。 如需更多範例，請參閱 Bing 廣告 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)