GetKeywordDemographics サービス操作 - Ad Insight
指定したキーワードを検索したユーザーの年齢と性別を取得します。
注:
GetKeywordDemographics サービス操作は、2023 年 8 月 21 日の時点で非推奨になりました。 詳細情報 を参照してください。
Request 要素
GetKeywordDemographicsRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。 要素は、 要求 SOAP に示されている順序と同じ順序である必要があります。
注:
以下に特に記載がない限り、すべての要求要素が必要です。
要求本文要素
要素 | 説明 | データ型 |
---|---|---|
デバイス | 人口統計データを取得するデバイスの配列。 サポートされているデバイスの種類は、次のとおりです。コンピューター、スマートフォン以外、スマートフォン、タブレット。 既定値は [コンピューター] です。 使用可能な場合、応答には、指定キーワード (keyword)デバイスの種類の人口統計データのみが含まれます。 |
string 配列 |
キーワード | 人口統計データを取得するキーワードの配列。 データは 、デバイス の種類によっても分割されます。 配列には最大 1,000 個のキーワードを含めることができます。各キーワード (keyword)には最大 100 文字を含めることができます。 |
string 配列 |
言語 | キーワードが書き込まれる言語。 使用可能な値については、「 広告言語」を参照してください。 |
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 要素
GetKeywordDemographicsResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。 要素は、 応答 SOAP に示されている順序と同じ順序で返されます。
応答本文の要素
要素 | 説明 | データ型 |
---|---|---|
KeywordDemographicResult |
KeywordDemographicResult データ オブジェクトの配列。 項目の順序は、要求で指定されたキーワードに直接対応します。 キーワード (keyword)で利用できる人口統計データがない場合、キーワード (keyword)はリストに含まれますが、対応する KeywordDemographicResult の KeywordDemographics 要素は null になります。 各 KeywordDemographicResult には、 KeywordDemographic データ オブジェクトの配列が含まれています。 配列には、要求で指定された各デバイスの項目が含まれています。 各 KeywordDemographic には、特定の年齢と性別のユーザーが指定したキーワード (keyword)を検索した時間の割合が含まれます。 |
KeywordDemographicResult 配列 |
応答ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
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">GetKeywordDemographics</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>
<GetKeywordDemographicsRequest 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>
</GetKeywordDemographicsRequest>
</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>
<GetKeywordDemographicsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
<KeywordDemographicResult d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<KeywordDemographicResult>
<Keyword d4p1:nil="false">ValueHere</Keyword>
<KeywordDemographics d4p1:nil="false">
<KeywordDemographic>
<Device d4p1:nil="false">ValueHere</Device>
<EighteenToTwentyFour>ValueHere</EighteenToTwentyFour>
<TwentyFiveToThirtyFour>ValueHere</TwentyFiveToThirtyFour>
<ThirtyFiveToFourtyNine>ValueHere</ThirtyFiveToFourtyNine>
<FiftyToSixtyFour>ValueHere</FiftyToSixtyFour>
<SixtyFiveAndAbove>ValueHere</SixtyFiveAndAbove>
<AgeUnknown>ValueHere</AgeUnknown>
<Female>ValueHere</Female>
<Male>ValueHere</Male>
<GenderUnknown>ValueHere</GenderUnknown>
</KeywordDemographic>
</KeywordDemographics>
</KeywordDemographicResult>
</KeywordDemographicResult>
</GetKeywordDemographicsResponse>
</s:Body>
</s:Envelope>
コード構文
構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。
public async Task<GetKeywordDemographicsResponse> GetKeywordDemographicsAsync(
IList<string> keywords,
string language,
string publisherCountry,
IList<string> device)
{
var request = new GetKeywordDemographicsRequest
{
Keywords = keywords,
Language = language,
PublisherCountry = publisherCountry,
Device = device
};
return (await AdInsightService.CallAsync((s, r) => s.GetKeywordDemographicsAsync(r), request));
}
static GetKeywordDemographicsResponse getKeywordDemographics(
ArrayOfstring keywords,
java.lang.String language,
java.lang.String publisherCountry,
ArrayOfstring device) throws RemoteException, Exception
{
GetKeywordDemographicsRequest request = new GetKeywordDemographicsRequest();
request.setKeywords(keywords);
request.setLanguage(language);
request.setPublisherCountry(publisherCountry);
request.setDevice(device);
return AdInsightService.getService().getKeywordDemographics(request);
}
static function GetKeywordDemographics(
$keywords,
$language,
$publisherCountry,
$device)
{
$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];
$request = new GetKeywordDemographicsRequest();
$request->Keywords = $keywords;
$request->Language = $language;
$request->PublisherCountry = $publisherCountry;
$request->Device = $device;
return $GLOBALS['AdInsightProxy']->GetService()->GetKeywordDemographics($request);
}
response=adinsight_service.GetKeywordDemographics(
Keywords=Keywords,
Language=Language,
PublisherCountry=PublisherCountry,
Device=Device)
要件
Service: AdInsightService.svc v13
Namespace: https://bingads.microsoft.com/AdInsight/v13
要求 URL
https://adinsight.api.bingads.microsoft.com/AdInsight/v13/KeywordDemographics/Query
Request 要素
GetKeywordDemographicsRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。
注:
以下に特に記載がない限り、すべての要求要素が必要です。
要求本文要素
要素 | 説明 | データ型 |
---|---|---|
デバイス | 人口統計データを取得するデバイスの配列。 サポートされているデバイスの種類は、次のとおりです。コンピューター、スマートフォン以外、スマートフォン、タブレット。 既定値は [コンピューター] です。 使用可能な場合、応答には、指定キーワード (keyword)デバイスの種類の人口統計データのみが含まれます。 |
string 配列 |
キーワード | 人口統計データを取得するキーワードの配列。 データは 、デバイス の種類によっても分割されます。 配列には最大 1,000 個のキーワードを含めることができます。各キーワード (keyword)には最大 100 文字を含めることができます。 |
string 配列 |
言語 | キーワードが書き込まれる言語。 使用可能な値については、「 広告言語」を参照してください。 |
string |
PublisherCountry | 人口統計データのソースとして使用する国/地域の国コード。 指定する国/地域は、 Language 要素で指定された言語をサポートする必要があります。 使用可能な値については、「 広告言語」を参照してください。 |
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 要素
GetKeywordDemographicsResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。 要素は、 Response JSON に示されている順序と同じ順序で返されます。
応答本文の要素
要素 | 説明 | データ型 |
---|---|---|
KeywordDemographicResult |
KeywordDemographicResult データ オブジェクトの配列。 項目の順序は、要求で指定されたキーワードに直接対応します。 キーワード (keyword)で利用できる人口統計データがない場合、キーワード (keyword)はリストに含まれますが、対応する KeywordDemographicResult の KeywordDemographics 要素は null になります。 各 KeywordDemographicResult には、 KeywordDemographic データ オブジェクトの配列が含まれています。 配列には、要求で指定された各デバイスの項目が含まれています。 各 KeywordDemographic には、特定の年齢と性別のユーザーが指定したキーワード (keyword)を検索した時間の割合が含まれます。 |
KeywordDemographicResult 配列 |
応答ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
TrackingId | API 呼び出しの詳細を含むログ エントリの識別子。 | string |
JSON を要求する
このテンプレートは、JSON 要求の 本文 と ヘッダー 要素を表示するツールによって生成されました。 このサービス操作で使用できるサポートされる型については、上記の 要求本文要素 のリファレンスを参照してください。
{
"Keywords": [
"ValueHere"
],
"Language": "ValueHere",
"PublisherCountry": "ValueHere",
"Device": [
"ValueHere"
]
}
応答 JSON
このテンプレートは、JSON 応答の 本文 と ヘッダー 要素を表示するツールによって生成されました。
{
"KeywordDemographicResult": [
{
"Keyword": "ValueHere",
"KeywordDemographics": [
{
"AgeUnknown": DoubleValueHere,
"Device": "ValueHere",
"EighteenToTwentyFour": DoubleValueHere,
"Female": DoubleValueHere,
"FiftyToSixtyFour": DoubleValueHere,
"GenderUnknown": DoubleValueHere,
"Male": DoubleValueHere,
"SixtyFiveAndAbove": DoubleValueHere,
"ThirtyFiveToFourtyNine": DoubleValueHere,
"TwentyFiveToThirtyFour": DoubleValueHere
}
]
}
]
}
コード構文
SDK を使用して REST API を呼び出すには、SDK を特定のバージョンにアップグレードし、システム パラメーターを構成する必要があります。構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。
public async Task<GetKeywordDemographicsResponse> GetKeywordDemographicsAsync(
IList<string> keywords,
string language,
string publisherCountry,
IList<string> device)
{
var request = new GetKeywordDemographicsRequest
{
Keywords = keywords,
Language = language,
PublisherCountry = publisherCountry,
Device = device
};
return (await AdInsightService.CallAsync((s, r) => s.GetKeywordDemographicsAsync(r), request));
}
static GetKeywordDemographicsResponse getKeywordDemographics(
ArrayOfstring keywords,
java.lang.String language,
java.lang.String publisherCountry,
ArrayOfstring device) throws RemoteException, Exception
{
GetKeywordDemographicsRequest request = new GetKeywordDemographicsRequest();
request.setKeywords(keywords);
request.setLanguage(language);
request.setPublisherCountry(publisherCountry);
request.setDevice(device);
return AdInsightService.getService().getKeywordDemographics(request);
}
static function GetKeywordDemographics(
$keywords,
$language,
$publisherCountry,
$device)
{
$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];
$request = new GetKeywordDemographicsRequest();
$request->Keywords = $keywords;
$request->Language = $language;
$request->PublisherCountry = $publisherCountry;
$request->Device = $device;
return $GLOBALS['AdInsightProxy']->GetService()->GetKeywordDemographics($request);
}
response=adinsight_service.GetKeywordDemographics(
Keywords=Keywords,
Language=Language,
PublisherCountry=PublisherCountry,
Device=Device)