GetBidOpportunities サービス操作 - Ad Insight
指定した広告グループのキーワード (keyword)入札機会を取得します。
見積もりは過去 7 日間のパフォーマンス データに基づいており、将来のパフォーマンスの予測や保証ではありません。
注:
この操作は、手動の CPC 入札戦略を使用して検索キャンペーン用に最適化されています。 2021 年 4 月の検索キャンペーンの手動 CPC の日暮れにより、この操作は非推奨になりました。
Request 要素
GetBidOpportunitiesRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。 要素は、 要求 SOAP に示されている順序と同じ順序である必要があります。
注:
以下に特に記載がない限り、すべての要求要素が必要です。
要求本文要素
要素 | 説明 | データ型 |
---|---|---|
AdGroupId | 入札機会を決定する広告グループキーワード (keyword)識別子。 この要素が nil または空の場合、操作は指定されたキャンペーンのすべての入札機会を返します。 |
long |
CampaignId |
AdGroupId 要素で指定された広告グループを所有するキャンペーンの識別子。 この要素が nil または空の場合、 AdGroupId も nil または空である必要があり、操作によってアカウントのすべての入札機会が返されます。 |
long |
OpportunityType | 広告掲載順位の目標に対応する入札機会の種類または種類を決定します。 この操作は、指定した目標を達成するのに役立つ現在の入札の 100% 以内に推奨される引き上げがある場合にのみ、機会を返します。 |
BidOpportunityType |
要求ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
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 要素
GetBidOpportunitiesResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。 要素は、 応答 SOAP に示されている順序と同じ順序で返されます。
応答本文の要素
要素 | 説明 | データ型 |
---|---|---|
機会 | 推奨される一致タイプの入札値を適用した場合にクリック数とインプレッション数が増加する可能性があるキーワードを識別する BidOpportunity オブジェクトの配列。 現在、最大 1,000 個のリスト アイテムを返すことができますが、制限は変更される可能性があります。 |
BidOpportunity 配列 |
応答ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
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">GetBidOpportunities</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>
<GetBidOpportunitiesRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
<AdGroupId i:nil="false">ValueHere</AdGroupId>
<CampaignId i:nil="false">ValueHere</CampaignId>
<OpportunityType>ValueHere</OpportunityType>
</GetBidOpportunitiesRequest>
</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>
<GetBidOpportunitiesResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
<Opportunities d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<BidOpportunity>
<AdGroupId>ValueHere</AdGroupId>
<CampaignId>ValueHere</CampaignId>
<CurrentBid>ValueHere</CurrentBid>
<EstimatedIncreaseInClicks>ValueHere</EstimatedIncreaseInClicks>
<EstimatedIncreaseInCost>ValueHere</EstimatedIncreaseInCost>
<EstimatedIncreaseInImpressions>ValueHere</EstimatedIncreaseInImpressions>
<KeywordId>ValueHere</KeywordId>
<MatchType d4p1:nil="false">ValueHere</MatchType>
<SuggestedBid>ValueHere</SuggestedBid>
</BidOpportunity>
</Opportunities>
</GetBidOpportunitiesResponse>
</s:Body>
</s:Envelope>
コード構文
構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。
public async Task<GetBidOpportunitiesResponse> GetBidOpportunitiesAsync(
long? adGroupId,
long? campaignId,
BidOpportunityType opportunityType)
{
var request = new GetBidOpportunitiesRequest
{
AdGroupId = adGroupId,
CampaignId = campaignId,
OpportunityType = opportunityType
};
return (await AdInsightService.CallAsync((s, r) => s.GetBidOpportunitiesAsync(r), request));
}
static GetBidOpportunitiesResponse getBidOpportunities(
java.lang.Long adGroupId,
java.lang.Long campaignId,
ArrayList<BidOpportunityType> opportunityType) throws RemoteException, Exception
{
GetBidOpportunitiesRequest request = new GetBidOpportunitiesRequest();
request.setAdGroupId(adGroupId);
request.setCampaignId(campaignId);
request.setOpportunityType(opportunityType);
return AdInsightService.getService().getBidOpportunities(request);
}
static function GetBidOpportunities(
$adGroupId,
$campaignId,
$opportunityType)
{
$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];
$request = new GetBidOpportunitiesRequest();
$request->AdGroupId = $adGroupId;
$request->CampaignId = $campaignId;
$request->OpportunityType = $opportunityType;
return $GLOBALS['AdInsightProxy']->GetService()->GetBidOpportunities($request);
}
response=adinsight_service.GetBidOpportunities(
AdGroupId=AdGroupId,
CampaignId=CampaignId,
OpportunityType=OpportunityType)
要件
Service: AdInsightService.svc v13
Namespace: https://bingads.microsoft.com/AdInsight/v13
要求 URL
https://adinsight.api.bingads.microsoft.com/AdInsight/v13/BidOpportunities/Query
Request 要素
GetBidOpportunitiesRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。
注:
以下に特に記載がない限り、すべての要求要素が必要です。
要求本文要素
要素 | 説明 | データ型 |
---|---|---|
AdGroupId | 入札機会を決定する広告グループキーワード (keyword)識別子。 この要素が nil または空の場合、操作は指定されたキャンペーンのすべての入札機会を返します。 |
long |
CampaignId |
AdGroupId 要素で指定された広告グループを所有するキャンペーンの識別子。 この要素が nil または空の場合、 AdGroupId も nil または空である必要があり、操作によってアカウントのすべての入札機会が返されます。 |
long |
OpportunityType | 広告掲載順位の目標に対応する入札機会の種類または種類を決定します。 この操作は、指定した目標を達成するのに役立つ現在の入札の 100% 以内に推奨される引き上げがある場合にのみ、機会を返します。 |
BidOpportunityType |
要求ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
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 要素
GetBidOpportunitiesResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。 要素は、 Response JSON に示されている順序と同じ順序で返されます。
応答本文の要素
要素 | 説明 | データ型 |
---|---|---|
機会 | 推奨される一致タイプの入札値を適用した場合にクリック数とインプレッション数が増加する可能性があるキーワードを識別する BidOpportunity オブジェクトの配列。 現在、最大 1,000 個のリスト アイテムを返すことができますが、制限は変更される可能性があります。 |
BidOpportunity 配列 |
応答ヘッダー要素
要素 | 説明 | データ型 |
---|---|---|
TrackingId | API 呼び出しの詳細を含むログ エントリの識別子。 | string |
JSON を要求する
このテンプレートは、JSON 要求の 本文 と ヘッダー 要素を表示するツールによって生成されました。 このサービス操作で使用できるサポートされる型については、上記の 要求本文要素 のリファレンスを参照してください。
{
"AdGroupId": "LongValueHere",
"CampaignId": "LongValueHere",
"OpportunityType": "ValueHere"
}
応答 JSON
このテンプレートは、JSON 応答の 本文 と ヘッダー 要素を表示するツールによって生成されました。
{
"Opportunities": [
{
"AdGroupId": "LongValueHere",
"CampaignId": "LongValueHere",
"CurrentBid": DoubleValueHere,
"EstimatedIncreaseInClicks": DoubleValueHere,
"EstimatedIncreaseInCost": DoubleValueHere,
"EstimatedIncreaseInImpressions": "LongValueHere",
"KeywordId": "LongValueHere",
"MatchType": "ValueHere",
"SuggestedBid": DoubleValueHere
}
]
}
コード構文
SDK を使用して REST API を呼び出すには、SDK を特定のバージョンにアップグレードし、システム パラメーターを構成する必要があります。構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。
public async Task<GetBidOpportunitiesResponse> GetBidOpportunitiesAsync(
long? adGroupId,
long? campaignId,
BidOpportunityType opportunityType)
{
var request = new GetBidOpportunitiesRequest
{
AdGroupId = adGroupId,
CampaignId = campaignId,
OpportunityType = opportunityType
};
return (await AdInsightService.CallAsync((s, r) => s.GetBidOpportunitiesAsync(r), request));
}
static GetBidOpportunitiesResponse getBidOpportunities(
java.lang.Long adGroupId,
java.lang.Long campaignId,
ArrayList<BidOpportunityType> opportunityType) throws RemoteException, Exception
{
GetBidOpportunitiesRequest request = new GetBidOpportunitiesRequest();
request.setAdGroupId(adGroupId);
request.setCampaignId(campaignId);
request.setOpportunityType(opportunityType);
return AdInsightService.getService().getBidOpportunities(request);
}
static function GetBidOpportunities(
$adGroupId,
$campaignId,
$opportunityType)
{
$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];
$request = new GetBidOpportunitiesRequest();
$request->AdGroupId = $adGroupId;
$request->CampaignId = $campaignId;
$request->OpportunityType = $opportunityType;
return $GLOBALS['AdInsightProxy']->GetService()->GetBidOpportunities($request);
}
response=adinsight_service.GetBidOpportunities(
AdGroupId=AdGroupId,
CampaignId=CampaignId,
OpportunityType=OpportunityType)