本文へスキップ

リクエスト

Ad Placement APIは、クライアント側からもサーバー側からも呼び出すことができます。

クライアント側の実装を使用する場合、ブラウザはプリフライト**リクエストを実行するかもしれません。これを避けたい場合は、リクエストヘッダで Content-Type: text/plain を使用してください。これにより、ブラウザはリクエストを "simple "と認定し、プリフライトリクエストをスキップします。

また、クライアント側でAPIを呼び出す場合、フロントエンドやJavascriptを使用してIPを検出することが困難な場合があるため、IPは実際には必要ありません**。代わりに、私たちのAPIはリクエストが行われたときに接続からIPを検出します。

サーバー側の実装を使用する場合、正しいターゲティングを保証するために、ユーザーの正しいIPを明示的に渡す必要があります**。そうでない場合、広告のターゲティングはサーバーロケーションに対して行われ、後にIPの不一致によってインプレッションが無効になる可能性があります。

クライアントであろうとサーバーであろうと、IPが渡されれば、こちらが検出したものよりも優先される。

広告掲載APIへのリクエストを実行するには、2つのオブジェクトを渡す必要がある： userとzonesです。リクエストはHTTP POSTを使用してJSONで行われます。

ユーザー​

パラメータ必要ですか？説明
アイドルいいえユーザーのID
ipおすすめユーザーIPアドレス。
uaはいユーザーエージェント：ユーザーのブラウザ/アプリとデバイス/OSを含む文字列。
言語いいえ標準の2文字のISOコード](https://www.andiamo.co.uk/resources/iso-language-codes/)とオプションの2文字の地域コードを使ってリクエストの言語を設定します。例えば、`en-us`はアメリカ合衆国英語です。
リファラいいえ広告が表示されるサイトのアドレス。
エルいいえBase64エンコードされたユーザーのEメール。
スクリーン解像度いいえユーザーが使用するデバイスの画面解像度
ウィンドウの向きいいえサイトのレイアウトがモバイルの場合は「portrait」、デスクトップの場合は「landscape」とする。
gdprいいえプライバシーに配慮した拡張機能（オブジェクト）。

ユーザー名​

パラメータ説明
gdprこれは、発信者がユーザーがGDPRの対象でないと考えている場合は0、GDPRの対象である場合は1でなければならない。
同意これはIABスタンダードが要求する同意文字列である。

ゾーン​

パラメータ必要ですか？説明
アイドルはい広告ゾーンのID
サブいいえ広告ゾーンのサブID
キーワードいいえトラフィックに関連するキーワードで、特定のタイプの広告にマッチする可能性のあるもの。キーワードがない場合は、サイトのURLがマッチングに使用されます。
カスタム・ターゲティングいいえカスタムゾーン値（オブジェクト）

zones.custom_targeting​

パラメータ説明
ex_av未定義の場合は0、年齢が確認された場合は1、年齢が確認されなかった場合は2とする。

例​

一度のリクエストで多くの広告ゾーンをリクエストすることが可能です。各ゾーンには、下記の例のように異なるIDが設定されます。

{
    "user": {
        "id": "abdef8u9",
        "ip": "10.42.0.1",
        "ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.63 Safari/537.36",
        "language": "en-US",
        "referer": "https://blabla.com",
        "gdpr" : {
                "gdpr" : 1,
                "consent": "CPAoZRHPArq3hBcADBENBJCgAAAAAAAAAAqIHKQAAOUgAAAA"
        }
    },
    "zones": [
        {
            "id": 4031007,
            "sub": 111,
            "keywords": "humour, general"
        },
        {
            "id": 4031015,
            "sub": 222 
        },
        {
            "id": 4031019,
            "sub": 222             
        }
    ]
}