次の方法で共有

Ad Library API の概要

広告ライブラリは、Bing.com に表示されるすべての広告を表示できるパブリックな透明性ツールです。 広告コピーに存在する広告主名とキーワードで広告を検索すると、広告コンテンツと追加の広告の詳細の両方が表示されます。 広告ライブラリは、ユーザー向けに安全でオープンなインターネットを作成するためのコンプライアンスの取り組みの一環です。

Ad Library API リソース

ベース URI

テンプレートを追加するベース URI を次に示します。

https://adlibrary.api.bingads.microsoft.com/api/v1/

テンプレート

広告ライブラリのクエリに使用するエンドポイントを作成するには、適切なテンプレートをベース URL に追加します。

テンプレート HTTP 動詞 説明 リソース
広告 主 取得 名前で広告主を取得する

パラメータ :
- top (int32、既定値は 3)
- skip (int32, default 0)
- searchText (string, default "")		 配列<広告主>
Advertisers({AdvertiserId})
または
広告主/{AdvertiserId}		 取得 Id で広告主を取得する

パラメーター: なし

注: AdvertiserId は AccountId または VerifiedAdvertiserId の場合があります。 同じ ID で複数のアカウントを検証できます。 検証された AccountId が要求された場合、代わりに親 VerifiedAdvertiserId が返されます。		 広告 主
広告 取得 広告主/コンテンツ別の広告を取得する

パラメータ :
• top (int32, default 12)
• skip (int64, default 0)
• startDate (string)
• endDate (string)
• 形式 'yyyy-MM-dd' の日付
• countryCodes (string)

コンマ区切りの値 (つまり、'10,26,53')
• advertiserId (int64)
• searchText (string)		 配列<広告>
Ads({AdId})
または
Ads/{AdId}		 取得 Id で広告を取得する

パラメーター: なし		 Ad

データ オブジェクト

API で使用される要求オブジェクトと応答オブジェクトを次に示します。

オブジェクト 説明
広告 主 広告主を定義します。
Ad 広告を定義します。
AdDetails 広告に関する追加の詳細を定義します。
CountryImpressionShare 国の広告インプレッション シェアを定義します。
TargetTypeDetails 広告で使用されるターゲットの種類に関する詳細を定義します。

広告 主

広告主を定義します。

名前 値 型
AdvertiserId 広告主を識別する ID。

注: 広告主が確認されている場合、これは AccountId または VerifiedAdvertiserId である可能性があります。 が同じ広告主の下で検証されている場合、VerifiedAdvertiserId は複数のアカウントをカバーする可能性があり、検証済みの AccountId に対する要求は、代わりに親 VerifiedAdvertiserId を返します。		 Long
AdvertiserName アカウントの名前、または検証済みの広告主の法的名。 文字列
AdvertiserCountry 広告主が登録されている国。 文字列
IsVerified 広告主が検証されているかどうかを表すブール値。 ブール値

広告を定義します。

名前 値 型
AdId 広告を識別する ID。 Long
AdvertiserName アカウントの名前、または検証済みの広告主の法的名。 文字列
AdvertiserId 広告主を識別する ID。 Long
タイトル 広告コピーのタイトル部分。

注: 動的広告の種類には複数のバリエーションがあり、タイトル、説明、URL、アセットは、広告が最後に配信されたときの最新の代表的なバージョンである可能性があります。		 文字列
説明 広告コピーの説明部分。 文字列
DisplayUrl 広告によって表示される URL、または特定の広告の種類のマーチャント名。 文字列
DestinationUrl 広告によってリンクされた実際の URL。 文字列
AssetJson 資産リソースの JSON URL 文字列
AdDetails 広告に関する追加の詳細を含むオブジェクト。 AdDetails

AdDetails

広告の追加の詳細を定義します。

名前 値 型
PaidForByName アカウント所有者と異なる場合に広告を支払った顧客の名前。 文字列
StartDate 広告が最初に実行されたとき、または広告ライブラリによって最初の適格なインプレッションが記録された UTC 日付。

注: Ad Library では、2023 年 6 月以降、欧州連合 (EU) または欧州経済地域 (EEA) の広告インプレッションのみが記録されます。 広告の実際の開始日は、広告ライブラリの発売日、または広告が最初に対象となるインプレッションを受け取った日より前の日付になる場合があります。		 文字列
EndDate 広告が最後に実行された UTC 日付、または広告ライブラリによって最終対象インプレッションが記録された日時。

注: 上記の注に加えて、広告ライブラリに表示される情報に 1 日から 3 日の遅延が発生する可能性があるため、広告がまだアクティブな場合、EndDate には過去数日間に表示された新しいインプレッションが反映されない場合があります。		 文字列
TotalImpressionsRange EU および EEA で広告が受け取ったインプレッションの合計数を表す範囲。 文字列
ImpressionsByCountry EU または EEA 加盟国ごとのインプレッションの割合を表すキーと値のペアの一覧。 array<CountryImpressionShareObject>
TargetTypes 広告のターゲット設定に使用されるターゲットの種類と、それらが除外にも使用されたかどうかの一覧。

注: これは、対象となるすべてのインプレッションに対して広告の実行時に使用されたすべてのターゲット タイプの集計リストであり、特定のインプレッションに使用された要素が必ずしも示されていない場合があります。		 array<TargetTypeDetails>
RestrictionReason 存在する場合、広告が広告ライブラリに追加または表示されないように制限されている理由。 RestrictionReason

CountryImpressionShare

特定の国の広告のインプレッション シェアを定義します。

名前 値 型
国 広告が表示された国。 国
ImpressionShare 国に対する広告のインプレッションの割合。パーセンテージ (つまり 17.3%) で表されます。 文字列

TargetDetails

特定の国の広告のインプレッション シェアを定義します。

名前 値 型
TargetType ターゲット設定に使用されるパラメーター。 TargetType
UsedForExclusion ターゲットの種類が除外にも使用されたかどうかを示します。 ブール型

値セット

API で使用される値セットを次に示します。

オブジェクト 説明
国 広告のインプレッションをフィルター処理およびレポートするために、広告ライブラリによって考慮される国の値を定義します。
TargetType 広告ライブラリによって追跡されるターゲティング パラメーターの種類を定義します。
RestrictionReason 広告が追加配信や広告ライブラリへの表示を制限されている理由を定義します。

国

広告のインプレッションをフィルター処理およびレポートするために、広告ライブラリによって考慮される欧州連合諸国および欧州経済地域のメンバーの値を定義します。

名前 値
オーストリア 10
ベルギー 14
ブルガリア 26
クロアチア 49
キプロス 207
チェコ 51
デンマーク 53
エストニア 61
フィンランド 65
フランス 66
ドイツ 72
ギリシャ 76
ハンガリー 88
アイルランド 92
イタリア 93
ラトビア 104
リトアニア 108
ルクセンブルク 109
マルタ 115
オランダ 129
ポーランド 151
ポルトガル 152
ルーマニア 226
スロバキア 165
スロベニア 167
スペイン 170
スウェーデン 175
アイスランド 89
リヒテンシュタイン 107
ノルウェー 139

TargetType

広告ライブラリによって追跡されるターゲティング パラメーターの種類を定義します。

名前 値 説明
Gender 1 性別に基づくターゲット設定。
年齢 2 年齢グループに基づくターゲット設定。
場所 3 ユーザーが配置または検索している地理的領域に基づくターゲット設定。
MicrosoftAudiences 22 マーケティング対象ユーザー、類似ユーザー、LinkedIn プロファイル ターゲットなど、Microsoft が定義した対象ユーザーに基づくターゲット設定。
AdvertiserAudiences 25 カスタム オーディエンス、カスタマー マッチ リスト、リマーケティング リストなど、広告主が定義した対象ユーザーに基づくターゲティング。

API 認証

広告ライブラリ UI と同様に、広告ライブラリ API はパブリックに使用でき、ユーザーのサインアップやログインは必要ありません。 ただし、プラットフォームのセキュリティと安定性を保護するために、認証されていない要求は、API を呼び出す頻度と、呼び出しごとに要求できるエンティティの数に対してより厳しい制限に直面します。

制限を増やして広告ライブラリ API を使用するには、次のものが必要です。

  • Microsoft アカウント
  • Microsoft Advertising アカウント
  • 開発者トークン

Microsoft Advertising アカウントを作成するには、 に移動します https://ads.microsoft.com。 Microsoft アカウントにサインインしていない場合は、アカウントにサインインするか、アカウントにサインアップするようにリダイレクトされます。 サインイン後、 新しい Microsoft Advertising アカウントにサインアップするオプションがあります。 サインアップ オプションを選択し、[続行] を選択 します。

資格情報の認証

Ad Library API では、Bing Ads API と同じ認証スキームが使用されます。 OAuth を使用した Microsoft アカウント資格情報の認証の詳細については、「Microsoft ID プラットフォームを使用した認証」を参照してください。

Bing Ads SDK for .NET、Java、または Python を使用して、Microsoft アカウントの資格情報を認証できます。 SDK を使用してアクセス トークンを取得する方法の詳細については、「 C# | Java | Python」を参照してください。

注: Bing広告 SDK には、広告ライブラリ API 用のインターフェイスは用意されていません。 SDK for Microsoft Advertising キャンペーンを使用している場合にのみ、SDK を使用してアクセス トークンを取得する必要があります。 そうしないと、SDK をインストールするオーバーヘッドの価値がない可能性があります。

認証に Bing Ads SDK を使用しない場合は、OAuth を使用して Microsoft アカウントの資格情報を認証する方法を示す例については、「C# での Microsoft アカウント資格情報の認証」を参照してください。

資格情報と開発者トークンを使用する場所

制限を増やすには、すべての呼び出しで次を指定する必要があります。

  • 開発者トークンに設定されている DeveloperToken ヘッダー。
  • アクセス トークンに設定されている AuthenticationToken ヘッダー。

これらのヘッダーと、要求と応答に含まれる可能性があるその他のヘッダーについては、「 ヘッダー」を参照してください。

最も簡単な Microsoft Advertising アカウントの Sign-Up 手順

Ad Library API にアクセスしたいが、Microsoft 広告アカウントをまだ持っていない、または当社のプラットフォームで広告を掲載したい研究者または規制当局の場合は、次の手順を実行します。

  1. [今すぐサインアップ] にアクセスhttps://ads.microsoft.com/して選択します。 Ad Library API のサインアップ手順 1

  2. 既存の Microsoft アカウントでサインインするか、[作成] を選択します 。Ad Library API のサインアップ手順 2

  3. 既存のメール アドレスまたは電話番号を使用するか、[ 新しいメール アドレスの取得] を選択します。 Ad Library API のサインアップ手順 3
    新しいメール アドレス (メール アドレス、パスワード、姓、国/地域、生年月日) を作成する場合は、上記の情報を入力し、必要に応じて captcha を解決します。

  4. セットアップをできるだけ早くスキップするには、[ 新しいキャンペーンの作成 ] を選択し、[ エキスパートに切り替える] を選択します。 Ad Library API のサインアップ手順 4a
    Ad Library API のサインアップ手順 4b

  5. [ キャンペーンの作成をスキップ ] を選択して、キャンペーンなしでアカウントを設定します。 Ad Library API のサインアップ手順 5

  6. この時点で、アカウントが作成され、それ以上の情報は必要ありません。 Ad Library API のサインアップ手順 6

開発者アカウントに進み、API にアクセスするためのトークンを要求できるようになりました。 この一環として、 開発者利用規約を確認する必要があります。