GetBidLandscapeByKeywordIds サービス操作 - Ad Insight
既存のキーワードの一覧を指定すると、この操作では、提案された入札の一覧と 1 日から 7 日間の推定パフォーマンス統計の一覧が返されます。 この操作はターゲットの位置に基づくものではなく、さまざまな推定クリック数、インプレッション数、コストを生成する複数の入札オプションを返します。 同じキーワード (keyword)の推定トラフィックを持つ複数の入札ポイントの横向きビューを使用して、クリック数、インプレッション数、コストを最適化するためにキーワード (keyword)入札を調整する方法を決定するのに役立ちます。 たとえば、結果のデータを使用して、クリック数をコスト曲線に視覚化したり、インプレッションへの入札曲線を視覚化したりできます。
見積もりは過去 7 日間のパフォーマンス データに基づいており、将来のパフォーマンスの予測や保証ではありません。
注:
この操作は、拡張 CPC 入札戦略を使用する検索キャンペーン用です。
Request 要素
GetBidLandscapeByKeywordIdsRequest オブジェクトは、サービス操作要求の本文とヘッダー要素を定義します。 要素は、 要求 SOAP に示されている順序と同じ順序である必要があります。
注:
以下に特に記載がない限り、すべての要求要素が必要です。
要求本文要素
要求ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
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 要素
GetBidLandscapeByKeywordIdsResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。 要素は、 応答 SOAP に示されている順序と同じ順序で返されます。
応答本文の要素
要素 | 説明 | データ型 |
---|---|---|
BidLandscape |
KeywordBidLandscape オブジェクトの配列。 配列には、要求で指定された各キーワード (keyword)に対応する KeywordBidLandscape が含まれています。 重複するキーワード (keyword)識別子は同じ呼び出しで許可され、同じ結果が返されます。 指定したキーワード (keyword)識別子が無効であるか、関連付けられたデータ結果がない場合、KeywordBidLandscape 内のすべての要素は、要求で指定されたキーワード (keyword)識別子を反映する KeywordId を除いて nil になります。 キーワード (keyword)で使用可能なデータがある場合、KeywordBidLandscape オブジェクトには、推奨される入札と推定パフォーマンス統計の一覧が表示されます。 |
KeywordBidLandscape 配列 |
応答ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
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">GetBidLandscapeByKeywordIds</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>
<GetBidLandscapeByKeywordIdsRequest 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>
<IncludeCurrentBid i:nil="false">ValueHere</IncludeCurrentBid>
</GetBidLandscapeByKeywordIdsRequest>
</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>
<GetBidLandscapeByKeywordIdsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
<BidLandscape d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<KeywordBidLandscape>
<KeywordId>ValueHere</KeywordId>
<StartDate d4p1:nil="false">
<Day>ValueHere</Day>
<Month>ValueHere</Month>
<Year>ValueHere</Year>
</StartDate>
<EndDate d4p1:nil="false">
<Day>ValueHere</Day>
<Month>ValueHere</Month>
<Year>ValueHere</Year>
</EndDate>
<BidLandscapePoints d4p1:nil="false">
<BidLandscapePoint>
<Bid>ValueHere</Bid>
<Clicks d4p1:nil="false">ValueHere</Clicks>
<Impressions>ValueHere</Impressions>
<TopImpressions d4p1:nil="false">ValueHere</TopImpressions>
<CurrencyCode>ValueHere</CurrencyCode>
<Cost d4p1:nil="false">ValueHere</Cost>
<MarginalCPC d4p1:nil="false">ValueHere</MarginalCPC>
</BidLandscapePoint>
</BidLandscapePoints>
</KeywordBidLandscape>
</BidLandscape>
</GetBidLandscapeByKeywordIdsResponse>
</s:Body>
</s:Envelope>
コード構文
構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。
public async Task<GetBidLandscapeByKeywordIdsResponse> GetBidLandscapeByKeywordIdsAsync(
IList<long> keywordIds,
bool? includeCurrentBid)
{
var request = new GetBidLandscapeByKeywordIdsRequest
{
KeywordIds = keywordIds,
IncludeCurrentBid = includeCurrentBid
};
return (await AdInsightService.CallAsync((s, r) => s.GetBidLandscapeByKeywordIdsAsync(r), request));
}
static GetBidLandscapeByKeywordIdsResponse getBidLandscapeByKeywordIds(
ArrayOflong keywordIds,
boolean includeCurrentBid) throws RemoteException, Exception
{
GetBidLandscapeByKeywordIdsRequest request = new GetBidLandscapeByKeywordIdsRequest();
request.setKeywordIds(keywordIds);
request.setIncludeCurrentBid(includeCurrentBid);
return AdInsightService.getService().getBidLandscapeByKeywordIds(request);
}
static function GetBidLandscapeByKeywordIds(
$keywordIds,
$includeCurrentBid)
{
$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];
$request = new GetBidLandscapeByKeywordIdsRequest();
$request->KeywordIds = $keywordIds;
$request->IncludeCurrentBid = $includeCurrentBid;
return $GLOBALS['AdInsightProxy']->GetService()->GetBidLandscapeByKeywordIds($request);
}
response=adinsight_service.GetBidLandscapeByKeywordIds(
KeywordIds=KeywordIds,
IncludeCurrentBid=IncludeCurrentBid)
要件
Service: AdInsightService.svc v13
Namespace: https://bingads.microsoft.com/AdInsight/v13
要求 URL
https://adinsight.api.bingads.microsoft.com/AdInsight/v13/BidLandscape/QueryByKeywordIds
Request 要素
GetBidLandscapeByKeywordIdsRequest オブジェクトは、サービス操作要求の本文とヘッダー要素を定義します。
注:
以下に特に記載がない限り、すべての要求要素が必要です。
要求本文要素
要求ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
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 要素
GetBidLandscapeByKeywordIdsResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。 要素は、 Response JSON に示されている順序と同じ順序で返されます。
応答本文の要素
要素 | 説明 | データ型 |
---|---|---|
BidLandscape |
KeywordBidLandscape オブジェクトの配列。 配列には、要求で指定された各キーワード (keyword)に対応する KeywordBidLandscape が含まれています。 重複するキーワード (keyword)識別子は同じ呼び出しで許可され、同じ結果が返されます。 指定したキーワード (keyword)識別子が無効であるか、関連付けられたデータ結果がない場合、KeywordBidLandscape 内のすべての要素は、要求で指定されたキーワード (keyword)識別子を反映する KeywordId を除いて nil になります。 キーワード (keyword)で使用可能なデータがある場合、KeywordBidLandscape オブジェクトには、推奨される入札と推定パフォーマンス統計の一覧が表示されます。 |
KeywordBidLandscape 配列 |
応答ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
TrackingId | API 呼び出しの詳細を含むログ エントリの識別子。 | string |
JSON を要求する
このテンプレートは、JSON 要求の 本文 と ヘッダー 要素を表示するツールによって生成されました。 このサービス操作で使用できるサポートされる型については、上記の 要求本文要素 のリファレンスを参照してください。
{
"KeywordIds": [
"LongValueHere"
],
"IncludeCurrentBid": "ValueHere"
}
応答 JSON
このテンプレートは、JSON 応答の 本文 と ヘッダー 要素を表示するツールによって生成されました。
{
"BidLandscape": [
{
"BidLandscapePoints": [
{
"Bid": DoubleValueHere,
"Clicks": DoubleValueHere,
"Cost": DoubleValueHere,
"CurrencyCode": "ValueHere",
"Impressions": "LongValueHere",
"MarginalCPC": DoubleValueHere,
"TopImpressions": "LongValueHere"
}
],
"EndDate": {
"Day": IntValueHere,
"Month": IntValueHere,
"Year": IntValueHere
},
"KeywordId": "LongValueHere",
"StartDate": {
"Day": IntValueHere,
"Month": IntValueHere,
"Year": IntValueHere
}
}
]
}
コード構文
SDK を使用して REST API を呼び出すには、SDK を特定のバージョンにアップグレードし、システム パラメーターを構成する必要があります。構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。
public async Task<GetBidLandscapeByKeywordIdsResponse> GetBidLandscapeByKeywordIdsAsync(
IList<long> keywordIds,
bool? includeCurrentBid)
{
var request = new GetBidLandscapeByKeywordIdsRequest
{
KeywordIds = keywordIds,
IncludeCurrentBid = includeCurrentBid
};
return (await AdInsightService.CallAsync((s, r) => s.GetBidLandscapeByKeywordIdsAsync(r), request));
}
static GetBidLandscapeByKeywordIdsResponse getBidLandscapeByKeywordIds(
ArrayOflong keywordIds,
boolean includeCurrentBid) throws RemoteException, Exception
{
GetBidLandscapeByKeywordIdsRequest request = new GetBidLandscapeByKeywordIdsRequest();
request.setKeywordIds(keywordIds);
request.setIncludeCurrentBid(includeCurrentBid);
return AdInsightService.getService().getBidLandscapeByKeywordIds(request);
}
static function GetBidLandscapeByKeywordIds(
$keywordIds,
$includeCurrentBid)
{
$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];
$request = new GetBidLandscapeByKeywordIdsRequest();
$request->KeywordIds = $keywordIds;
$request->IncludeCurrentBid = $includeCurrentBid;
return $GLOBALS['AdInsightProxy']->GetService()->GetBidLandscapeByKeywordIds($request);
}
response=adinsight_service.GetBidLandscapeByKeywordIds(
KeywordIds=KeywordIds,
IncludeCurrentBid=IncludeCurrentBid)