サプライ パートナー - 入札要求
警告
2017 年 10 月 1 日より、サーバー側の電源統合用の Supply Integration (ASI) プロトコル (旧称 AppNexus Supply Integration) が無効になりました。 OpenRTB プロトコルに供給を移行することを強くお勧めします。 このセクションのすべてが従来のコンテンツです。
Xandr に入札要求を送信するには、 POST
入札要求の詳細を含む JSON 形式のファイルを次のエンドポイントに送信します。
https://ib.adnxs.com/asi?member_id=YOUR_PROD_MEMBER_ID
クライアント テスト環境でテストする場合は、エンドポイントにアクセスします POST
。
https://ib.client-testing.adnxs.net/asi?member_id=YOUR_TESTING_MEMBER_ID
要求の書式設定に関するガイダンスについては、ページの下部にある 例 を参照してください。
JSON フィールド
フィールドが内部値と外部値 (や など) で使用できる場合は、 int_blocked_categories
ext_blocked_categories
JSON 形式のファイル内のフィールドの 1 つだけを含めます。 両方が含まれている場合は、内部値が使用されます。
フィールド | 種類 | 説明 |
---|---|---|
an_user_id |
int | ページを表示しているユーザーの Xandr ID。 ユーザー ID マッピングをシステムに格納する場合は、このフィールドを含めます。 詳細については、「 ユーザー ID マッピング」を参照してください。 必須: はい(含まれていない場合 ext_user_id )。 |
ext_user_id |
string | ページを表示しているユーザーの供給パートナー ID。 Xandr を使用してユーザー ID マッピングを格納する場合は、このフィールドを含めます。 詳細については、「 ユーザー ID マッピング」を参照してください。 必須: はい(含まれていない場合 an_user_id )。 |
ext_auction_id |
string | オークションの供給パートナー ID。 必須: はい |
width |
int | 配置の幅。 必須: はい |
height |
int | 配置の高さ。 必須: はい |
ad_format |
列挙 | 返されるクリエイティブの形式。 使用可能な値: "iframe"、"javascript"、または "vast"。 VAST に関する注意: "vast" 形式は サポートされていません。 ただし、VAST ビデオ クリエイティブに対する入札要求の外観については、「 例 」セクションの VAST 入札要求を参照してください。 必須: はい |
template_id |
int | まだサポートされていません。 VAST ビデオ クリエイティブの場合は、Xandr で入札応答のフィールドにカスタム パラメーターを ad_tag 含めることができます。 これを実現するために、Xandr は、VAST ビデオを要求するときにここで参照する "供給テンプレート" を作成できます。 詳細については、入札応答ドキュメント の「供給テンプレート 」を参照してください。必須: いいえ |
ip_address |
string | ページを表示しているユーザーの IP アドレス。 必須: いいえ |
is_secure |
ブール値 | true または false。 サプライ パートナーは、これを true に設定することで、クリエイティブの SSL バージョンを要求できます。 |
page_url |
string | 入札要求の完全なドメイン (エンコードされた URL を渡さないでください)。 必須: いいえ |
position |
列挙 | ページ上の配置の位置。 使用可能な値: "above" (フォールドの上)、"下" (フォールドの下)、または "不明" です。 既定: "不明" 必須: いいえ |
ext_pub_code |
string | 発行元の供給パートナー コード。 必須: いいえ |
ext_placement_code |
string | 配置の供給パートナー コード。 必須: いいえ |
an_placement_id |
int | 配置の Xandr ID。 配置 ID を取得するには、 配置サービスを使用します。 必須: いいえ |
language |
int | ページの言語の X ID。 言語 ID を取得するには、 Language Service を使用します。 既定値: 0 必須: いいえ |
user_agent |
string | 要求のユーザー エージェント (つまり、ブラウザー)。 必須: いいえ |
int_blocked_technical_attributes |
ints の配列 | 許可されていないクリエイティブ技術属性の Xandr ID。 技術属性 ID を取得するには、 Technical Attribute Service を使用します。 必須: いいえ |
ext_blocked_technical_attributes |
ints の配列 | 許可されていないクリエイティブ技術属性の供給パートナー ID。 必須: いいえ |
int_blocked_categories |
ints の配列 | 許可されていないクリエイティブ カテゴリの Xandr ID。 カテゴリ ID を取得するには、 カテゴリ サービスを使用します。 必須: いいえ |
ext_blocked_categories |
ints の配列 | 許可されていないクリエイティブ カテゴリのサプライ パートナー ID。 必須: いいえ |
int_content_categories |
ints の配列 | 配置に適用されるコンテンツ カテゴリの Xandr ID。 コンテンツ カテゴリ サービスを使用して、使用可能なすべての値を表示できます。 これには、供給パートナーが Xandr メンバーの下に作成したカスタム コンテンツ カテゴリが含まれます。 既定値: 0 必須: いいえ |
ext_content_categories |
ints の配列 | 配置に適用されるコンテンツ カテゴリの供給パートナー ID。 既定値: 0 必須: いいえ |
blocked_urls |
文字列の配列 | 許可されていないクリエイティブ ランディング ページ URL。 最大 20 個の URL をブロックできます。 以下の 「書式設定の例」を 参照してください。 必須: いいえ |
blocked_languages |
ints の配列 | 許可されていないクリエイティブ言語。 言語 ID を取得するには、 Language Service を使用します。 必須: いいえ |
int_blocked_brands |
ints の配列 | 許可されていないブランドの Xandr ID。 ブランド ID を取得するには、 ブランド サービスを使用します。 必須: いいえ |
age |
int | ページを表示しているユーザーの年齢。 既定値: 0 必須: いいえ |
gender |
列挙 | ページを表示しているユーザーの性別。 使用可能な値: "男性"、"女性"、または "不明" です。 既定: "不明" 必須: いいえ |
supply_type |
列挙 | 表示環境。 使用可能な値: "web"、"mobile_app"、"mobile_web"、"in-stream-video"、または "other"。 ヒント: の supply_type 値は、 サイト レベルで設定された供給の種類をオーバーライドします。メモ: "ストリーム内ビデオ" 形式 はまだサポートされていません。 既定: "web" 必須: いいえ |
書式設定の例: blocked_urls
{
"blocked_urls": [
"landingpage1.com",
"landingpage2.com"
]
}
配置マッピング
Xandr は、リクエストを Xandr のプレースメントにマップできる場合にのみ入札を送信します。 次のシーケンスで次の情報を確認します。
an_placement_id
ext_placement_code
ext_pub_code
(発行元の既定のタグ)- メンバーの既定の配置 (運用ログイン資格情報が割り当てられる前に Technical Account Manager によってアカウント用に設定されます)。
上記のいずれも利用できない場合、Xandr は入札を送信しません。 Xandr ext_placement_code
内の 1 つの配置にのみマップでき、Xandr ext_pub_code
内の 1 つのパブリッシャーにのみマップできることに注意してください。
例
最小限許容される入札要求の送信
必要なフィールドのみを含む JSON 形式のファイルを作成します。 この例では フィールドを
an_user_id
使用しますが、代わりに を使用ext_user_id
できます。$ cat bid_request | { "an_user_id": 1089773736613054100, "ext_auction_id": "395dj2j2j2dd", "ad_format":"iframe", "width": 300, "height": 250 }
POST
JSONフォーマットのファイルを開けます。 メンバー ID は必ずクエリ文字列に含めます。curl -X POST -d @bid_request 'https://ib.adnxs.com/asi?member_id=123'
Xandr 値のみを含む入札要求を送信する
パートナー値を指定する代わりに Xandr 値のフィールドを含む JSON 形式のファイルを作成します。たとえば、
an_user_id
ext_user_id
ではなく、int_blocked_technical_attributes
ext_blocked_technical_attributes
ではなく です。"$ cat bid_request"{ "an_user_id":1089773736613054100, "ext_auction_id":"395dj2j2j2dd", "width":300, "height":250, "ad_format":"iframe", "ip_address":"38.108.249.106", "page_url":"publisher.com", "position":"above", "ext_pub_code":"203pub", "ext_site_code":"145site", "an_placement_id":40, "language":1, "user_agent":"Mozilla/5.0 (X11; U; Linux x86_64; en-US; rv:1.9.1.8) Gecko/20100214 Ubuntu/9.10 (karmic) Firefox/3.5.8", "int_blocked_technical_attributes":[ 6, 10, 11 ], "int_blocked_categories":[ 16, 17, 19 ], "int_content_categories":[ 5, 6, 7 ], "blocked_urls":[ "landingpage1.com", "landingpage2.com", "landingpage3.com", "landingpage4.com", "landingpage5.com" ], "blocked_languages":[ 2, 3, 4, 5, 6, 7, 8, 9, 10 ], "age":25, "gender":"male", "supply_type":"web" }
POST
JSONフォーマットのファイルを開けます。 メンバー ID は必ずクエリ文字列に含めます。curl -X POST -d @bid_request 'https://ib.adnxs.com/asi?member_id=123'
外部値のみを含む入札要求の送信
Xandr 値ではなく、供給パートナー値のフィールドを含む JSON 形式のファイルを作成します。たとえば、
ext_placement_code
an_placement_id
ではなく、ext_blocked_categories
int_blocked_categories
ではなく です。$ cat bid_request { "ext_user_id": 1089773736613054100, "ext_auction_id": "395dj2j2j2dd", "width": 300, "height": 250, "ad_format": "iframe", "ip_address": "38.108.249.106", "page_url": "publisher.com", "position": "above", "ext_pub_code": "203pub", "ext_site_code": "145site", "ext_placement_code": "40placement", "language": 1, "user_agent": "Mozilla/5.0 (X11; U; Linux x86_64; en-US; rv:1.9.1.8) Gecko/20100214 Ubuntu/9.10 (karmic) Firefox/3.5.8", "ext_blocked_technical_attributes": [ 3, 5, 8 ], "ext_blocked_categories": [ 2, 15, 20 ], "ext_content_categories": [ 2, 9, 13 ], "blocked_urls": [ "landingpage1.com", "landingpage2.com", "landingpage3.com", "landingpage4.com", "landingpage5.com" ], "blocked_languages": [ 2, 3, 4, 5, 6, 7, 8, 9, 10 ], "age": 25, "gender": "male", "supply_type": "web" }
POST
JSONフォーマットのファイルを開けます。 メンバー ID は必ずクエリ文字列に含めます。curl -X POST -d @bid_request 'https://ib.adnxs.com/asi?member_id=123'
ブロックの詳細を含まない入札要求の送信
パブリッシャーの設定を適用するように広告プロファイルを設定する場合は、入札リクエストでブロックの詳細を指定する必要はありません。
技術的属性、クリエイティブ カテゴリ、コンテンツ カテゴリ、URL、言語をブロックするためのフィールドを除く JSON 形式のファイルを作成します。
$ cat bid_request { "an_user_id": 1089773736613054100, "ext_auction_id": "395dj2j2j2dd", "width": 300, "height": 250, "ad_format": "iframe", "ip_address": "38.108.249.106", "page_url": "publisher.com", "position": "above", "ext_pub_code": "203pub", "ext_site_code": "145site", "an_placement_id": "40", "language": 1, "user_agent": "Mozilla/5.0 (X11; U; Linux x86_64; en-US; rv:1.9.1.8) Gecko/20100214 Ubuntu/9.10 (karmic) Firefox/3.5.8", "age": 25, "gender": "male", "supply_type": "web" }
POST
JSONフォーマットのファイルを開けます。 メンバー ID は必ずクエリ文字列に含めます。curl -X POST -d @bid_request 'https://ib.adnxs.com/asi?member_id=123'
VAST ビデオ クリエイティブの入札リクエストの送信 (まだサポートされていません)
VAST ビデオ クリエイティブを要求する場合:
- を
ad_format
"vast" に設定する必要があります。 - は
width
1 に設定する必要があります。 - は
height
1 に設定する必要があります。 - 要求は、Xandr システム内の配置にマップする必要があります。これにより、"Video" メディア タイプのクリエイティブ、または "15 秒 VAST"、"30 秒 VAST"、または "Other VAST" メディア サブタイプの任意の組み合わせが可能になります。 要求がビデオ以外の配置にマップされている場合、AppNexus はエラーで応答します (広告の形式が配置形式と一致しません)。 使用する配置を検索する方法の詳細については、上の 「配置マッピング 」を参照してください。
- 渡
ext_blocked_technical_attributes
したり、必要な VAST ビデオの再生時間を定義したりしないでくださいint_blocked_technical_attributes
。 代わりに、前述のように、Xandr 配置で許可される VAST ビデオの再生時間を定義する必要があります。 - 入札応答のフィールドにカスタム パラメーター
ad_tag
を含める供給テンプレートを設定するように Xandr に依頼した場合は、その供給テンプレートの ID に設定template_id
します。 詳細については、入札応答ドキュメントの「供給テンプレート」を参照してください。
上記の要件に従って JSON 形式のファイルを作成します。 この例では、VAST ビデオ クリエイティブを許可するように定義された Xandr システムに特定の配置があることを前提としています。 この配置の ID は、 フィールドに
an_placement_id
渡されます。$ cat bid_request { "an_user_id": 1089773736613054100, "ext_auction_id": "395dj2j2j2dd", "ad_format":"vast", "width": 1, "height": 1. "an_placement_id": 204, "tmpl_id": 4, "ip_address": "38.108.249.106", "page_url": "ibdo.com", "position": "unknown", "language": 0, "user_agent": "Mozilla/5.0 (X11; U; Linux x86_64; en-US; rv:1.9.1.8) Gecko/20100214 Ubuntu/9.10 (karmic) Firefox/3.5.8", "age": 25, "gender": "female" }
POST
JSONフォーマットのファイルを開けます。 メンバー ID は必ずクエリ文字列に含めます。curl -X POST -d @bid_request 'https://ib.adnxs.com/asi?member_id=123'