GetEstimatedBidByKeywords サービス操作 - Ad Insight

[アーティクル]
10/04/2023

検索結果のターゲット位置に広告が表示される可能性がある 1 つ以上のキーワードの推定入札価格を取得します。

見積もりは、将来のパフォーマンスの予測または保証ではありません。

注:

この操作は、拡張 CPC 入札戦略を使用する検索キャンペーン用です。

Request 要素

GetEstimatedBidByKeywordsRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。要素は、要求 SOAP に示されている順序と同じ順序である必要があります。

注:

以下に特に記載がない限り、すべての要求要素が必要です。

要求本文要素

要素	説明	データ型
AdGroupId	広告グループのコンテキストでのキーワードのパフォーマンスの判断に役立つパフォーマンスデータを持つ広告グループの識別子。広告グループを指定すると、推奨される入札の精度が向上します。広告グループを指定する場合は、属するキャンペーンを指定する必要があります。	long
CampaignId	AdGroupId で指定された広告グループを所有するキャンペーンの識別子。広告グループを指定しない場合は、キャンペーンのパフォーマンスデータを使用して、キャンペーンのコンテキストでキーワードのパフォーマンスを判断できます。キャンペーンと広告グループを指定すると、推奨される入札の精度が向上します。 AdGroupId と CampaignId の両方が指定されていない場合、操作では、指定された CustomerAccountId ヘッダー要素を使用して、キーワードがアカウントのコンテキストでどの程度適切に実行されるかを判断できます。	long
CurrencyCode	コスト見積もりと推奨入札値の計算に使用する金額単位の ISO コード。設定されていない場合、サービスは CustomerAccountId ヘッダー要素で指定されたアカウントから通貨を決定します。 Currency または CustomerAccountId が設定されていない場合、サービスは USD を使用します。	CurrencyCode
EntityLevelBid	キーワードレベルの入札単価、広告グループレベルの入札、またはその両方の見積もりを返すかどうかを指定します。 - EntityLevelBid を Keyword に設定して、指定したキーワードに対応する KeywordEstimatedBid の配列を取得します。 - EntityLevelBid を AdGroup に設定して、指定した広告グループに対して 1 つの EstimatedBidAndTraffic を取得します。 - EntityLevelBid を AllEntities に設定して、キーワードに KeywordEstimatedBid の配列を取得し、広告グループに 1 つの EstimatedBidAndTraffic を取得します。 EntityLevelBid を設定しない場合、既定では KeywordEstimatedBid の配列のみ、または EntityLevelBid を Keyword に設定するのと同等の配列が返されます。 EntityLevelBid をKeyword、AdGroup、または AllEntities 以外の値に設定すると、ErrorCode CampaignServiceBidLevelInvalid で Code 3501 が返されます。	string
キーワード	推奨される入札値を取得する KeywordAndMatchType データオブジェクトの一覧。最大 1,000 個のキーワードを指定でき、各キーワードには最大 100 文字を含めることができます。	KeywordAndMatchType 配列
言語	入札を見積もる場所識別子と並行して使用される言語。言語は、 LocationIds で指定した各場所でサポートされている必要があります。使用できる言語の値については、「広告の言語」を参照してください。言語を指定しない場合、サービス操作では、指定した AdGroupId または CampaignId の言語が使用されます。これらのプロパティがいずれも設定されていない場合、 EN (英語) が既定で使用されます。	string
LocationIds	入札の見積もりに使用する地理的な場所の識別子。すべての場所で、 Language 要素で指定された言語をサポートする必要があります。複数の場所識別子を指定できますが、1 か所あたりの最も正確な入札見積もりのベストプラクティスとして、サービス呼び出しごとに 1 つの場所のみを指定する必要があります。可能な場所識別子については、「地理的な場所コード」を参照してください。場所を指定しない場合、サービス操作では、指定した AdGroupId または CampaignId の場所の条件が使用されます。これらのプロパティがいずれも設定されていない場合、既定では 190 (米国) が使用されます。	long 配列
TargetPositionForAds	検索結果に広告を表示する位置。既定値は MainLine1 です。	TargetAdPosition

要求ヘッダー要素

要素	説明	データ型
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 要素

GetEstimatedBidByKeywordsResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。要素は、応答 SOAP に示されている順序と同じ順序で返されます。

応答本文の要素

要素	説明	データ型
AdGroupEstimatedBid	推奨入札を使用する場合、クリック数の見積もり、クリックあたりの平均コスト (CPC)、インプレッション数、クリック率 (CTR)、および指定した広告グループの合計コストが含まれます。 EstimatedBidAndTraffic 内の MatchType 値は常に集計になります。このコンテキストでは、広告グループの既定の検索入札を表します。	EstimatedBidAndTraffic
KeywordEstimatedBids	KeywordEstimatedBid データオブジェクトの配列。配列には、要求で指定されたキーワードごとに項目が含まれています。キーワードが無効な場合、配列内の対応する項目は null になります。各 KeywordEstimatedBid には、キーワードと EstimatedPositions 要素が含まれています。キーワードに対してデータが使用可能な場合、 EstimatedPositionAndTraffic は、検索結果のターゲット位置に広告が表示される可能性がある推奨入札値を提供します。それ以外の場合、 EstimatedPositions 要素は null に設定されます。	KeywordEstimatedBid 配列

応答ヘッダー要素

要素	説明	データ型
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">GetEstimatedBidByKeywords</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>
    <GetEstimatedBidByKeywordsRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <Keywords i:nil="false">
        <KeywordAndMatchType>
          <KeywordText i:nil="false">ValueHere</KeywordText>
          <MatchTypes i:nil="false">
            <MatchType>ValueHere</MatchType>
          </MatchTypes>
        </KeywordAndMatchType>
      </Keywords>
      <TargetPositionForAds>ValueHere</TargetPositionForAds>
      <Language i:nil="false">ValueHere</Language>
      <LocationIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </LocationIds>
      <CurrencyCode i:nil="false">ValueHere</CurrencyCode>
      <CampaignId i:nil="false">ValueHere</CampaignId>
      <AdGroupId i:nil="false">ValueHere</AdGroupId>
      <EntityLevelBid i:nil="false">ValueHere</EntityLevelBid>
    </GetEstimatedBidByKeywordsRequest>
  </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>
    <GetEstimatedBidByKeywordsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <KeywordEstimatedBids d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <KeywordEstimatedBid>
          <Keyword d4p1:nil="false">ValueHere</Keyword>
          <EstimatedBids d4p1:nil="false">
            <EstimatedBidAndTraffic>
              <MinClicksPerWeek d4p1:nil="false">ValueHere</MinClicksPerWeek>
              <MaxClicksPerWeek d4p1:nil="false">ValueHere</MaxClicksPerWeek>
              <AverageCPC d4p1:nil="false">ValueHere</AverageCPC>
              <MinImpressionsPerWeek d4p1:nil="false">ValueHere</MinImpressionsPerWeek>
              <MaxImpressionsPerWeek d4p1:nil="false">ValueHere</MaxImpressionsPerWeek>
              <CTR d4p1:nil="false">ValueHere</CTR>
              <MinTotalCostPerWeek d4p1:nil="false">ValueHere</MinTotalCostPerWeek>
              <MaxTotalCostPerWeek d4p1:nil="false">ValueHere</MaxTotalCostPerWeek>
              <CurrencyCode>ValueHere</CurrencyCode>
              <MatchType>ValueHere</MatchType>
              <EstimatedMinBid>ValueHere</EstimatedMinBid>
            </EstimatedBidAndTraffic>
          </EstimatedBids>
        </KeywordEstimatedBid>
      </KeywordEstimatedBids>
      <AdGroupEstimatedBid d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <MinClicksPerWeek d4p1:nil="false">ValueHere</MinClicksPerWeek>
        <MaxClicksPerWeek d4p1:nil="false">ValueHere</MaxClicksPerWeek>
        <AverageCPC d4p1:nil="false">ValueHere</AverageCPC>
        <MinImpressionsPerWeek d4p1:nil="false">ValueHere</MinImpressionsPerWeek>
        <MaxImpressionsPerWeek d4p1:nil="false">ValueHere</MaxImpressionsPerWeek>
        <CTR d4p1:nil="false">ValueHere</CTR>
        <MinTotalCostPerWeek d4p1:nil="false">ValueHere</MinTotalCostPerWeek>
        <MaxTotalCostPerWeek d4p1:nil="false">ValueHere</MaxTotalCostPerWeek>
        <CurrencyCode>ValueHere</CurrencyCode>
        <MatchType>ValueHere</MatchType>
        <EstimatedMinBid>ValueHere</EstimatedMinBid>
      </AdGroupEstimatedBid>
    </GetEstimatedBidByKeywordsResponse>
  </s:Body>
</s:Envelope>

コード構文

構文の例は、 Bing広告 SDK で使用できます。その他の例については、「Bing広告 API コードの例」を参照してください。

public async Task<GetEstimatedBidByKeywordsResponse> GetEstimatedBidByKeywordsAsync(
	IList<KeywordAndMatchType> keywords,
	TargetAdPosition targetPositionForAds,
	string language,
	IList<long> locationIds,
	CurrencyCode? currencyCode,
	long? campaignId,
	long? adGroupId,
	string entityLevelBid)
{
	var request = new GetEstimatedBidByKeywordsRequest
	{
		Keywords = keywords,
		TargetPositionForAds = targetPositionForAds,
		Language = language,
		LocationIds = locationIds,
		CurrencyCode = currencyCode,
		CampaignId = campaignId,
		AdGroupId = adGroupId,
		EntityLevelBid = entityLevelBid
	};

	return (await AdInsightService.CallAsync((s, r) => s.GetEstimatedBidByKeywordsAsync(r), request));
}

static GetEstimatedBidByKeywordsResponse getEstimatedBidByKeywords(
	ArrayOfKeywordAndMatchType keywords,
	TargetAdPosition targetPositionForAds,
	java.lang.String language,
	ArrayOflong locationIds,
	CurrencyCode currencyCode,
	java.lang.Long campaignId,
	java.lang.Long adGroupId,
	java.lang.String entityLevelBid) throws RemoteException, Exception
{
	GetEstimatedBidByKeywordsRequest request = new GetEstimatedBidByKeywordsRequest();

	request.setKeywords(keywords);
	request.setTargetPositionForAds(targetPositionForAds);
	request.setLanguage(language);
	request.setLocationIds(locationIds);
	request.setCurrencyCode(currencyCode);
	request.setCampaignId(campaignId);
	request.setAdGroupId(adGroupId);
	request.setEntityLevelBid(entityLevelBid);

	return AdInsightService.getService().getEstimatedBidByKeywords(request);
}

static function GetEstimatedBidByKeywords(
	$keywords,
	$targetPositionForAds,
	$language,
	$locationIds,
	$currencyCode,
	$campaignId,
	$adGroupId,
	$entityLevelBid)
{

	$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];

	$request = new GetEstimatedBidByKeywordsRequest();

	$request->Keywords = $keywords;
	$request->TargetPositionForAds = $targetPositionForAds;
	$request->Language = $language;
	$request->LocationIds = $locationIds;
	$request->CurrencyCode = $currencyCode;
	$request->CampaignId = $campaignId;
	$request->AdGroupId = $adGroupId;
	$request->EntityLevelBid = $entityLevelBid;

	return $GLOBALS['AdInsightProxy']->GetService()->GetEstimatedBidByKeywords($request);
}

response=adinsight_service.GetEstimatedBidByKeywords(
	Keywords=Keywords,
	TargetPositionForAds=TargetPositionForAds,
	Language=Language,
	LocationIds=LocationIds,
	CurrencyCode=CurrencyCode,
	CampaignId=CampaignId,
	AdGroupId=AdGroupId,
	EntityLevelBid=EntityLevelBid)

要件

サービス: AdInsightService.svc v13
名前空間： https://bingads.microsoft.com/AdInsight/v13

Share via