GetEstimatedPositionByKeywordIds サービス操作 - Ad Insight
過去 7 日間に指定した入札値がキーワードに使用されていた場合の検索結果の推定位置を取得します。 さらに、この操作では、クリック数の見積もり、クリックあたりの平均コスト (CPC)、および推定入札でキーワードが生成した可能性があるインプレッションが提供されます。
見積もりは過去 7 日間のパフォーマンス データに基づいており、将来のパフォーマンスの予測や保証ではありません。
注:
この操作は、拡張 CPC 入札戦略を使用する検索キャンペーン用です。
Request 要素
GetEstimatedPositionByKeywordIdsRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。 要素は、 要求 SOAP に示されている順序と同じ順序である必要があります。
注:
以下に特に記載がない限り、すべての要求要素が必要です。
要求本文要素
要素 | 説明 | データ型 |
---|---|---|
KeywordIds | 指定した入札値に基づいて、検索結果の推定位置を取得するキーワードの識別子の配列。 最大 1,000 個のキーワード (keyword)識別子を指定できます。 | long 配列 |
MaxBid | 検索結果の推定位置を決定するために使用する最大入札価格。 アカウントの通貨で入札値を指定する必要があります。 |
複 |
要求ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
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 要素
GetEstimatedPositionByKeywordIdsResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。 要素は、 応答 SOAP に示されている順序と同じ順序で返されます。
応答本文の要素
要素 | 説明 | データ型 |
---|---|---|
KeywordEstimatedPositions |
KeywordIdEstimatedPosition データ オブジェクトの一覧。 配列には、要求で指定された各キーワード (keyword)の項目が含まれています。 キーワード (keyword) ID が無効な場合、配列内の対応する項目は null になります。 各 KeywordIdEstimatedPosition には、キーワード (keyword)識別子と KeywordEstimatedPosition が含まれています。 キーワード (keyword)でデータが使用可能な場合、EstimatedPositionAndTraffic は、指定された入札値に基づいて、検索結果の推定位置を提供します。 それ以外の場合、 EstimatedPositions 要素は null に設定されます。 |
KeywordIdEstimatedPosition 配列 |
応答ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
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">GetEstimatedPositionByKeywordIds</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>
<GetEstimatedPositionByKeywordIdsRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
<KeywordIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</KeywordIds>
<MaxBid>ValueHere</MaxBid>
</GetEstimatedPositionByKeywordIdsRequest>
</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>
<GetEstimatedPositionByKeywordIdsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
<KeywordEstimatedPositions d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<KeywordIdEstimatedPosition>
<KeywordId>ValueHere</KeywordId>
<KeywordEstimatedPosition d4p1:nil="false">
<Keyword d4p1:nil="false">ValueHere</Keyword>
<EstimatedPositions d4p1:nil="false">
<EstimatedPositionAndTraffic>
<MatchType>ValueHere</MatchType>
<MinClicksPerWeek>ValueHere</MinClicksPerWeek>
<MaxClicksPerWeek>ValueHere</MaxClicksPerWeek>
<AverageCPC>ValueHere</AverageCPC>
<MinImpressionsPerWeek>ValueHere</MinImpressionsPerWeek>
<MaxImpressionsPerWeek>ValueHere</MaxImpressionsPerWeek>
<CTR>ValueHere</CTR>
<MinTotalCostPerWeek>ValueHere</MinTotalCostPerWeek>
<MaxTotalCostPerWeek>ValueHere</MaxTotalCostPerWeek>
<CurrencyCode>ValueHere</CurrencyCode>
<EstimatedAdPosition>ValueHere</EstimatedAdPosition>
</EstimatedPositionAndTraffic>
</EstimatedPositions>
</KeywordEstimatedPosition>
</KeywordIdEstimatedPosition>
</KeywordEstimatedPositions>
</GetEstimatedPositionByKeywordIdsResponse>
</s:Body>
</s:Envelope>
コード構文
構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。
public async Task<GetEstimatedPositionByKeywordIdsResponse> GetEstimatedPositionByKeywordIdsAsync(
IList<long> keywordIds,
double maxBid)
{
var request = new GetEstimatedPositionByKeywordIdsRequest
{
KeywordIds = keywordIds,
MaxBid = maxBid
};
return (await AdInsightService.CallAsync((s, r) => s.GetEstimatedPositionByKeywordIdsAsync(r), request));
}
static GetEstimatedPositionByKeywordIdsResponse getEstimatedPositionByKeywordIds(
ArrayOflong keywordIds,
double maxBid) throws RemoteException, Exception
{
GetEstimatedPositionByKeywordIdsRequest request = new GetEstimatedPositionByKeywordIdsRequest();
request.setKeywordIds(keywordIds);
request.setMaxBid(maxBid);
return AdInsightService.getService().getEstimatedPositionByKeywordIds(request);
}
static function GetEstimatedPositionByKeywordIds(
$keywordIds,
$maxBid)
{
$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];
$request = new GetEstimatedPositionByKeywordIdsRequest();
$request->KeywordIds = $keywordIds;
$request->MaxBid = $maxBid;
return $GLOBALS['AdInsightProxy']->GetService()->GetEstimatedPositionByKeywordIds($request);
}
response=adinsight_service.GetEstimatedPositionByKeywordIds(
KeywordIds=KeywordIds,
MaxBid=MaxBid)
要件
Service: AdInsightService.svc v13
Namespace: https://bingads.microsoft.com/AdInsight/v13
要求 URL
https://adinsight.api.bingads.microsoft.com/AdInsight/v13/EstimatedPosition/QueryByKeywordIds
Request 要素
GetEstimatedPositionByKeywordIdsRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。
注:
以下に特に記載がない限り、すべての要求要素が必要です。
要求本文要素
要素 | 説明 | データ型 |
---|---|---|
KeywordIds | 指定した入札値に基づいて、検索結果の推定位置を取得するキーワードの識別子の配列。 最大 1,000 個のキーワード (keyword)識別子を指定できます。 | long 配列 |
MaxBid | 検索結果の推定位置を決定するために使用する最大入札価格。 アカウントの通貨で入札値を指定する必要があります。 |
複 |
要求ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
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 要素
GetEstimatedPositionByKeywordIdsResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。 要素は、 Response JSON に示されている順序と同じ順序で返されます。
応答本文の要素
要素 | 説明 | データ型 |
---|---|---|
KeywordEstimatedPositions |
KeywordIdEstimatedPosition データ オブジェクトの一覧。 配列には、要求で指定された各キーワード (keyword)の項目が含まれています。 キーワード (keyword) ID が無効な場合、配列内の対応する項目は null になります。 各 KeywordIdEstimatedPosition には、キーワード (keyword)識別子と KeywordEstimatedPosition が含まれています。 キーワード (keyword)でデータが使用可能な場合、EstimatedPositionAndTraffic は、指定された入札値に基づいて、検索結果の推定位置を提供します。 それ以外の場合、 EstimatedPositions 要素は null に設定されます。 |
KeywordIdEstimatedPosition 配列 |
応答ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
TrackingId | API 呼び出しの詳細を含むログ エントリの識別子。 | string |
JSON を要求する
このテンプレートは、JSON 要求の 本文 と ヘッダー 要素を表示するツールによって生成されました。 このサービス操作で使用できるサポートされる型については、上記の 要求本文要素 のリファレンスを参照してください。
{
"KeywordIds": [
"LongValueHere"
],
"MaxBid": DoubleValueHere
}
応答 JSON
このテンプレートは、JSON 応答の 本文 と ヘッダー 要素を表示するツールによって生成されました。
{
"KeywordEstimatedPositions": [
{
"KeywordEstimatedPosition": {
"EstimatedPositions": [
{
"AverageCPC": DoubleValueHere,
"CTR": DoubleValueHere,
"CurrencyCode": "ValueHere",
"EstimatedAdPosition": DoubleValueHere,
"MatchType": "ValueHere",
"MaxClicksPerWeek": DoubleValueHere,
"MaxImpressionsPerWeek": "LongValueHere",
"MaxTotalCostPerWeek": DoubleValueHere,
"MinClicksPerWeek": DoubleValueHere,
"MinImpressionsPerWeek": "LongValueHere",
"MinTotalCostPerWeek": DoubleValueHere
}
],
"Keyword": "ValueHere"
},
"KeywordId": "LongValueHere"
}
]
}
コード構文
SDK を使用して REST API を呼び出すには、SDK を特定のバージョンにアップグレードし、システム パラメーターを構成する必要があります。構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。
public async Task<GetEstimatedPositionByKeywordIdsResponse> GetEstimatedPositionByKeywordIdsAsync(
IList<long> keywordIds,
double maxBid)
{
var request = new GetEstimatedPositionByKeywordIdsRequest
{
KeywordIds = keywordIds,
MaxBid = maxBid
};
return (await AdInsightService.CallAsync((s, r) => s.GetEstimatedPositionByKeywordIdsAsync(r), request));
}
static GetEstimatedPositionByKeywordIdsResponse getEstimatedPositionByKeywordIds(
ArrayOflong keywordIds,
double maxBid) throws RemoteException, Exception
{
GetEstimatedPositionByKeywordIdsRequest request = new GetEstimatedPositionByKeywordIdsRequest();
request.setKeywordIds(keywordIds);
request.setMaxBid(maxBid);
return AdInsightService.getService().getEstimatedPositionByKeywordIds(request);
}
static function GetEstimatedPositionByKeywordIds(
$keywordIds,
$maxBid)
{
$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];
$request = new GetEstimatedPositionByKeywordIdsRequest();
$request->KeywordIds = $keywordIds;
$request->MaxBid = $maxBid;
return $GLOBALS['AdInsightProxy']->GetService()->GetEstimatedPositionByKeywordIds($request);
}
response=adinsight_service.GetEstimatedPositionByKeywordIds(
KeywordIds=KeywordIds,
MaxBid=MaxBid)