GetKeywordLocations サービス操作 - Ad Insight
指定したキーワードを検索したユーザーの地理的な場所を取得します。
注:
GetKeywordLocations サービス操作は、2023 年 8 月 21 日の時点で非推奨となりました。 詳細情報 を参照してください。
Request 要素
GetKeywordLocationsRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。 要素は、 要求 SOAP に示されている順序と同じ順序である必要があります。
注:
以下に特に記載がない限り、すべての要求要素が必要です。
要求本文要素
要素 | 説明 | データ型 |
---|---|---|
デバイス | 地理的な位置情報を取得するデバイスの配列。 サポートされているデバイスの種類は、次のとおりです。コンピューター、スマートフォン以外、スマートフォン、タブレット。 既定値は [コンピューター] です。 応答には、指定したデバイスの種類 (使用可能な場合) についてのみキーワードの場所データが含まれます。 |
string 配列 |
キーワード | 地理的な位置情報を取得するキーワードの配列。 データは 、デバイス の種類によっても分割されます。 配列には最大 1,000 個のキーワードを含め、各キーワードには最大 100 文字を含めることができます。 |
string 配列 |
言語 | キーワードが書き込まれる言語。 使用可能な値については、「 広告言語」を参照してください。 |
string |
レベル | 地理的位置データを集計するレベル。 指定可能な値は次のいずれかです。 0 - 国 1 - 都道府県 2 - 都市圏 3 - 市区町村 既定値は 1 (State/Province) です。 |
int |
MaxLocations | 返す場所の最大数。 最大 10 の場所を要求できます。 既定値は 10 です。 |
int |
ParentCountry | 検索の送信元の国/地域。 使用可能な値については、「 地理的な場所コード」を参照してください。 既定値は US です。 |
string |
PublisherCountry | 場所データのソースとして使用する国/地域の国コード。 指定する国/地域は、 Language 要素で指定された言語をサポートする必要があります。 使用可能な値については、「 広告言語」を参照してください。 |
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 要素
GetKeywordLocationsResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。 要素は、 応答 SOAP に示されている順序と同じ順序で返されます。
応答本文の要素
要素 | 説明 | データ型 |
---|---|---|
KeywordLocationResult |
KeywordLocationResult データ オブジェクトの配列。 項目の順序は、要求で指定されたキーワードに直接対応します。 キーワードに使用できる場所データがない場合、キーワードはリストに含まれますが、対応する KeywordLocationResult オブジェクトの KeywordLocations 要素は null になります。 各 KeywordLocationResult データ オブジェクトには 、KeywordLocation の配列が含まれています。 配列には、要求で指定された各デバイスの項目が含まれています。 各 KeywordLocation には、地理的な場所のユーザーが指定したキーワードを検索した地理的な場所と時間の割合が含まれます。 |
KeywordLocationResult 配列 |
応答ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
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/AdInsight/v13">
<Action mustUnderstand="1">GetKeywordLocations</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>
<GetKeywordLocationsRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
<Keywords i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</Keywords>
<Language i:nil="false">ValueHere</Language>
<PublisherCountry i:nil="false">ValueHere</PublisherCountry>
<Device i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</Device>
<Level i:nil="false">ValueHere</Level>
<ParentCountry i:nil="false">ValueHere</ParentCountry>
<MaxLocations i:nil="false">ValueHere</MaxLocations>
</GetKeywordLocationsRequest>
</s:Body>
</s:Envelope>
応答 SOAP
このテンプレートは、SOAP 応答の 本文 要素と ヘッダー 要素の順序を示すツールによって生成されました。
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header xmlns="https://bingads.microsoft.com/AdInsight/v13">
<TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
</s:Header>
<s:Body>
<GetKeywordLocationsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
<KeywordLocationResult d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<KeywordLocationResult>
<Keyword d4p1:nil="false">ValueHere</Keyword>
<KeywordLocations d4p1:nil="false">
<KeywordLocation>
<Device d4p1:nil="false">ValueHere</Device>
<Location d4p1:nil="false">ValueHere</Location>
<Percentage>ValueHere</Percentage>
</KeywordLocation>
</KeywordLocations>
</KeywordLocationResult>
</KeywordLocationResult>
</GetKeywordLocationsResponse>
</s:Body>
</s:Envelope>
コード構文
構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。
public async Task<GetKeywordLocationsResponse> GetKeywordLocationsAsync(
IList<string> keywords,
string language,
string publisherCountry,
IList<string> device,
int? level,
string parentCountry,
int? maxLocations)
{
var request = new GetKeywordLocationsRequest
{
Keywords = keywords,
Language = language,
PublisherCountry = publisherCountry,
Device = device,
Level = level,
ParentCountry = parentCountry,
MaxLocations = maxLocations
};
return (await AdInsightService.CallAsync((s, r) => s.GetKeywordLocationsAsync(r), request));
}
static GetKeywordLocationsResponse getKeywordLocations(
ArrayOfstring keywords,
java.lang.String language,
java.lang.String publisherCountry,
ArrayOfstring device,
int level,
java.lang.String parentCountry,
int maxLocations) throws RemoteException, Exception
{
GetKeywordLocationsRequest request = new GetKeywordLocationsRequest();
request.setKeywords(keywords);
request.setLanguage(language);
request.setPublisherCountry(publisherCountry);
request.setDevice(device);
request.setLevel(level);
request.setParentCountry(parentCountry);
request.setMaxLocations(maxLocations);
return AdInsightService.getService().getKeywordLocations(request);
}
static function GetKeywordLocations(
$keywords,
$language,
$publisherCountry,
$device,
$level,
$parentCountry,
$maxLocations)
{
$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];
$request = new GetKeywordLocationsRequest();
$request->Keywords = $keywords;
$request->Language = $language;
$request->PublisherCountry = $publisherCountry;
$request->Device = $device;
$request->Level = $level;
$request->ParentCountry = $parentCountry;
$request->MaxLocations = $maxLocations;
return $GLOBALS['AdInsightProxy']->GetService()->GetKeywordLocations($request);
}
response=adinsight_service.GetKeywordLocations(
Keywords=Keywords,
Language=Language,
PublisherCountry=PublisherCountry,
Device=Device,
Level=Level,
ParentCountry=ParentCountry,
MaxLocations=MaxLocations)
要件
サービス: AdInsightService.svc v13
名前 空間: https://bingads.microsoft.com/AdInsight/v13