SearchCompanies サービス操作 - キャンペーン管理
会社名でプロファイル データを検索します。
返される各 会社 には、 ProfileCriterion で使用できるプロファイル識別子が含まれています。
注:
GetProfileDataFileUrl 操作を使用して、業界およびジョブ関数のプロファイル データを取得できます。
Request 要素
SearchCompaniesRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。 要素は、 要求 SOAP に示されている順序と同じ順序である必要があります。
注:
以下に特に記載がない限り、すべての要求要素が必要です。
要求本文要素
要素 | 説明 | データ型 |
---|---|---|
CompanyNameFilter | 会社名フィルター文字列。 会社名の一部または完全名を使用して検索できます。 文字列の最小長は 3 です。 サービスは、すべての言語ロケールで文字列を検索します。 使用可能な場合は、要求された LanguageLocale で会社名が返されます。 |
string |
LanguageLocale | プロファイルの表示名の言語とロケール。 サポートされている言語ロケールの値は 、zh-Hant (繁体字中国語)、 en (英語)、 fr (フランス語)、 de (ドイツ語)、 it (イタリア語)、 pt-BR (ブラジルポルトガル語)、 および es (スペイン語) です。 LinkedIn でローカライズされたプロファイル名が指定されていない場合は、既定でユニバーサル名 (通常は英語で定義されます) に注意してください。 |
string |
要求ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
AuthenticationToken | Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセス トークン。 詳細については、「 OAuth による認証」を参照してください。 |
string |
CustomerAccountId | 要求のエンティティを所有または関連付けられている広告アカウントの識別子。 両方が必要な場合、このヘッダー要素の値は AccountId 本文要素と同じである必要があります。 この要素は、ほとんどのサービス操作に必要であり、ベスト プラクティスとして常に設定する必要があります。 詳細については、「 アカウントと顧客 ID を取得する」を参照してください。 |
string |
CustomerId | ユーザーがアクセスまたは操作しているマネージャー アカウント (顧客) の識別子。 ユーザーは複数のマネージャー アカウントにアクセスできます。 この要素は、ほとんどのサービス操作に必要であり、ベスト プラクティスとして常に設定する必要があります。 詳細については、「 アカウントと顧客 ID を取得する」を参照してください。 |
string |
DeveloperToken | Bing Ads API へのアクセスに使用される開発者トークン。 詳細については、「 開発者トークンを取得する」を参照してください。 |
string |
Password | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
UserName | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
Response 要素
SearchCompaniesResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。 要素は、 応答 SOAP に示されている順序と同じ順序で返されます。
応答本文の要素
要素 | 説明 | データ型 |
---|---|---|
Companies | 要求された会社名フィルターと一致する会社の一覧。 | 会社 の配列 |
応答ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
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
Namespace: https://bingads.microsoft.com/CampaignManagement/v13
要求 URL
https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/Companies/Search
Request 要素
SearchCompaniesRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。
注:
以下に特に記載がない限り、すべての要求要素が必要です。
要求本文要素
要素 | 説明 | データ型 |
---|---|---|
CompanyNameFilter | 会社名フィルター文字列。 会社名の一部または完全名を使用して検索できます。 文字列の最小長は 3 です。 サービスは、すべての言語ロケールで文字列を検索します。 使用可能な場合は、要求された LanguageLocale で会社名が返されます。 |
string |
LanguageLocale | プロファイルの表示名の言語とロケール。 サポートされている言語ロケールの値は 、zh-Hant (繁体字中国語)、 en (英語)、 fr (フランス語)、 de (ドイツ語)、 it (イタリア語)、 pt-BR (ブラジルポルトガル語)、 および es (スペイン語) です。 LinkedIn でローカライズされたプロファイル名が指定されていない場合は、既定でユニバーサル名 (通常は英語で定義されます) に注意してください。 |
string |
要求ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
Authorization | Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセス トークン。 トークンのプレフィックスに "Bearer" があることを確認してください。これは、適切な認証に必要です。 詳細については、「 OAuth による認証」を参照してください。 |
string |
CustomerAccountId | 要求のエンティティを所有または関連付けられている広告アカウントの識別子。 両方が必要な場合、このヘッダー要素の値は AccountId 本文要素と同じである必要があります。 この要素は、ほとんどのサービス操作に必要であり、ベスト プラクティスとして常に設定する必要があります。 詳細については、「 アカウントと顧客 ID を取得する」を参照してください。 |
string |
CustomerId | ユーザーがアクセスまたは操作しているマネージャー アカウント (顧客) の識別子。 ユーザーは複数のマネージャー アカウントにアクセスできます。 この要素は、ほとんどのサービス操作に必要であり、ベスト プラクティスとして常に設定する必要があります。 詳細については、「 アカウントと顧客 ID を取得する」を参照してください。 |
string |
DeveloperToken | Bing Ads API へのアクセスに使用される開発者トークン。 詳細については、「 開発者トークンを取得する」を参照してください。 |
string |
Password | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
UserName | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
Response 要素
SearchCompaniesResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。 要素は、 Response JSON に示されている順序と同じ順序で返されます。
応答本文の要素
要素 | 説明 | データ型 |
---|---|---|
Companies | 要求された会社名フィルターと一致する会社の一覧。 | 会社 の配列 |
応答ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
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)