Microsoft 収益化 - モバイル広告通話リファレンス
注:
Microsoft Advertising では、 adnxs-simple.com
要求時にブラウザー Cookie の送受信を行わないドメインがサポートされるようになりました。 クライアントは、個人データの使用に同意がない場合に、この Cookie を使用しないドメインを利用できます。 Microsoft Advertising によって開始された関連する呼び出しは、同意がない場合、または関数に Cookie が必要ない場合に、このドメインを自動的に使用します。 詳細については、「 サービス ポリシーの一部」を参照してください。
このドキュメントでは、モバイル 広告の呼び出しと /ssmob
呼び出し /mob
について説明します。これは、モバイル アプリの広告を要求するために使用されます。 これらの呼び出しには、クエリ文字列パラメーターとしてのクライアント デバイスに関する情報が含まれます。
サポートされているすべてのパラメーターの定義については、以下の「クエリ文字列パラメーター」を参照してください。 実際のモバイル広告通話の例については、「例」を参照してください。
このページで説明されている と /mob
の呼び出しは、モバイル アプリトラフィック専用であることに/ssmob
注意してください。
この広告呼び出しはモバイル アプリ インベントリ用であるため、非推奨 referrer
のパラメーターを使用するなど、Web サイト ドメインを渡そうとした場合は無視されます。 これは、アプリ トラフィックに site_domain
必要ないため、 レポート ガイド のフィールドが空白に設定されることを意味します。
重要
モバイル タグ形式の生成
モバイル広告呼び出しタグの形式は、当社のプラットフォームによって生成されません。 配置タグをエクスポートしてから変更する必要があります。
広告配信用に CNAME レコードを設定している場合は、 を指す呼び出しで仲介された広告要求に個別の /ssmob
CNAME を mediation.``adnxs``.com
使用することをお勧めします。 呼び出しにカスタム CNAME を /mob
使用することはお勧めしません。
ヒント
デバッグ オークションを実行するための有効な運送業者コード モバイルでデバッグ オークションを実行しようとしていますか? パラメーターをスプーフィング carrier
する必要があります。 有効な運送業者コードの一覧については、「 携帯電話会社コード」を参照してください。
クエリ文字列のパラメーター
モバイル広告の呼び出しでは、次に示すクエリ文字列パラメーターを受け入れます。 モバイル広告通話要求の例については、ページの下部にある 例 を参照してください。
重要
デバイス ID フィールドでは大文字と小文字が区別されることに注意してください。
注:
これらのパラメーターの一部を URL エンコードする必要があります。
パラメーター | 型 | 必須 | 説明 |
---|---|---|---|
aaid | 文字列 | いいえ | Google Play サービスから取得した Android デバイスの Google 広告識別子。 |
Appid | string | いいえ (ただし、強くお勧めします。説明を参照してください) | この文字列は、Android または iOS デバイスで実行されているモバイル アプリを識別するために使用されます。 - Android では、これはアプリのパッケージ名です。 次のように書式設定されます。 com example.helloworld - iOS では、これはアプリの iTunes ID です。 次のように書式設定されます。 123456789 多くのバイヤーは、 に基づいて appid ターゲット設定とレポートを設定します。 適切な appid を指定しなかった場合、これらの購入者はインベントリを魅力的にできなくなります。 したがって、 が に設定されている場合supply_type は、このフィールドを"mobile_app" 渡すことを強くお勧めします。 これは、モバイル SDK が広告を要求するときに行うことです。 (SDK が を渡す方法については、以下を appid 参照してください)。特定の Android または IOS アプリのアプリ ID を見つけるには、アプリの詳細ページを見つけます。 最も簡単な方法は、Web 検索を実行する方法です。 アプリ ストアの詳細ページの URL には、アプリの ID が表示されます (可視性のために赤で強調表示されています)。 たとえば、"Fussball" アプリの詳細ページを次に示します。 - Google Play: https://play.google.com/store/apps/details?id=de.telekom.FUSSBALL.DE -Itunes: https://itunes.apple.com/de/app/fussball.de/id422052549 |
キャリア | 文字列 | いいえ | 携帯電話会社の名前。 通常、システムはデバイスの IP アドレスから通信事業者を推測できるため、これは省略可能です。 |
connection_type | 文字列 | いいえ | デバイスで使用されるネットワークの種類。 使用できる値は または "wifi" "wan" です。 |
devmake | 文字列 | いいえ | 広告を要求するデバイスの製造元。 |
devmodel | 文字列 | いいえ | 広告を要求するデバイスのモデル。 |
devtime | int | いいえ | デバイス上の時刻 (エポック以降の秒単位)、または UNIX 時刻。 |
devtz | 文字列 | いいえ | デバイスのタイムゾーン。 |
Dnt | ブール値 | 不要 | 注: このフィールドは非推奨であり、今後削除される可能性があります。 代わりに フラグを LimitAdTrackingEnabled 使用します。の場合 true 、ユーザーはシステム レベルの設定を、行動的にターゲットとする広告を受け取らないよう設定しています。 使用できる値: true 、、false 1 、または 0 。 |
id | int | はい | 広告が配信される配置の一意の ID。 生の配置 ID を渡さない場合は、パラメーターと inv_code パラメーターのmember 組み合わせを渡すことができます。 詳細については、これらのパラメーターのドキュメントを参照してください。 |
idfa | 文字列 | いいえ | iOS 6 以降を実行している iOS デバイスの Apple アドバタイズ識別子。 |
inv_code | 文字列 | いいえ | (省略可能)特定の配置を識別するユーザー指定の "code" (任意の文字列)。 配置 ID を渡す代わりに、このフィールドの組み合わせを渡し、 member 特定の配置を一意に識別できます。 |
Ip | string | はい(呼び出し時)/ssmob |
広告要求を行うデバイスの IP アドレス (例 207.237.150.246 : )。- 呼び出しに /mob 指定しない場合は、代わりに HTTP ヘッダー経由で渡された IP が geo 検出に使用されます。- 通話に /ssmob 指定されていない場合、Microsoft Advertising は地理的な場所を検出できないため、購入者は geo でターゲットを設定できません。 |
istest | ブール値 | 不要 | これがテスト要求かどうか。 許可される値: true または false 、 1 または 0 。 |
language | 文字列 | いいえ | ISO 言語コードで指定されたデバイスの言語。 |
LimitAdTrackingEnabled | ブール値 | 不要 | の場合 true 、ユーザーはシステム レベルの設定を、行動的にターゲットとする広告を受け取らないよう設定しています。 使用できる値: true 、、false 1 、または 0 。ヒント: iOS でのシステム レベルの広告設定の詳細については、「 iAd からの興味に基づく広告のオプトアウト」を参照してください。 Android でのシステム レベルの広告設定の詳細については、「 広告 ID」を参照してください。 |
Loc | 文字列 | いいえ | 緯度と経度で表されるユーザーの場所。形式は snnn.ddddddddddddd,snnn.ddddddddddddd です。 小数点以下 13 桁までの有効桁数を使用できます。 |
loc_age | int | 不要 | 位置データの経過時間 (ミリ秒単位)。 |
loc_prec | int | いいえ | 位置データの精度 (メートル単位)。 |
max_size | 文字列 | いいえ | 許可される最大バナー サイズ (例: "320x250" )。 スポット広告の N/A。 |
クライアント | int | 不要 | ITU によって指定されたモバイル国コード。 |
md5udid | 文字列 | いいえ | の MD5 ハッシュ ANDROID_ID 。 これは Android デバイスに対してのみ送信する必要があります。 URL エンコードする必要があります。 |
メンバー | int | 不要 | (省略可能)広告が配信される配置のメンバーのメンバー ID。 配置 ID を渡す代わりに、このフィールドの組み合わせを渡し、 inv_code 特定の配置を一意に識別できます。 |
Mnc | int | 不要 | ITU によって指定されたモバイル ネットワーク コード。 |
openudid | 文字列 | いいえ | デバイスの OpenUDID 。 これは、iOS バージョン 5 以降でのみ送信する必要があります。 |
orientation | 文字列 | いいえ | 広告リクエスト中のデバイス画面の向き。 使用できる値は または "v" "h" です。 |
os | 文字列 | いいえ | デバイスのオペレーティング システム。 たとえば、Android 4.0.2 などです。 モバイル アプリの場合、これは通常、ユーザー エージェントによって提供されます。 |
pcode | 文字列 | いいえ | 広告を要求するユーザーの郵便番号。 指定しない場合、郵便番号は IP アドレスから決定されます。 |
Psa | ブール値 | 不要 | の場合 true 、オークションに勝者がいない場合は PSA が配信されます。 それ以外の場合は、空 200 OK の HTTP 応答が返されます。 許可される値: true または false 、 1 または 0 。 |
sha1mac | 文字列 | いいえ | sha1mac は、2019 年 5 月 7 日の時点で非推奨となりました。 使用しないでください。 |
sha1udid | 文字列 | いいえ | の SHA1 ハッシュ ANDROID_ID 。 これは Android デバイスに対してのみ送信する必要があります。 これは URL エンコードされている必要があります。. |
size | 文字列 | いいえ | 要求されたバナー サイズ (例: )、 "320x50" スポット広告の画面サイズ。 |
st | 文字列 | いいえ | 広告が表示される環境を示す在庫の供給の種類。 許可される値: "mobile_app" 、、 "mobile_web" または "web" 。 既定値は "mobile_app" です。 |
tmpl_id | int | 不要 | 供給テンプレート識別子。 |
Ua | 文字列 | いいえ | 広告を要求するデバイスに関連付けられているユーザー エージェント文字列。 指定した場合、HTTP ヘッダー経由で送信される標準ユーザー エージェントではなく、この値が使用されます。 URL エンコードする必要があります。 |
例
このセクションの例のほとんどは、Mobile SDK によって行われた実際の広告呼び出しに基づいています。 これらを自分で試すことができます。
要求は、SDK によって行われた要求とは次のように異なります。
- さまざまな形式の広告をお願いします。 JavaScript (既定値)、JSON、HTML
- コマンド ライン ツールを
curl
使用してサーバーに広告を要求します。詳細についてはcurl
、 のプロジェクト Web サイトを参照してください。 https://curl.haxx.se/
注:
これらの例のパラメーターは id
、Microsoft Advertising の配置 ID を参照します。 これを、作業中の Microsoft Advertising プラットフォーム メンバーから提供されたものに置き換える必要があります。
JavaScript
重要
応答形式が指定されていない場合、応答は既定で JavaScript になります。
$ curl "https://mobile.adnxs.com/mob?id=1281482&idfa=610B91D7-8F0D-423A-A98E-333DC41D04A2&devmake=Apple&devmodel=x86_64&appid=ANX.FunWithBeingMediatedByMoPub&ua=Mozilla%2F5.0%20%28iPhone%3B%20CPU%20iPhone%20OS%207_0_3%20like%20Mac%20OS%20X%29%20AppleWebKit%2F537.51.1%20%28KHTML%2C%20like%20Gecko%29%20Mobile%2F11B508&orientation=v&connection_type=wifi&devtime=1389725718&language=en&native_browser=0&psa=1&st=mobile_app&sdkver=1.7&size=320x50" document.write('<a href="https://nym1.mobile.adnxs.com/click?_Knx0k1iUD_8qfHSTWJQPwAAAAAAAPA__Knx0k1iUD_8qfHSTWJQP6DymlWmmrZKp-qJIdPe_STeGiJTAAAAAMqNEwC-AwAAvgMAAAIAAADtN2oAPsYCAAYAAQBVU0QAVVNEAEABMgARIAAAS7AAAgMCAQIAAAAADSiQdwAAAAA./cnd=%21LAZnOQjmx04Q7e-oAxi-jAsgBA../referrer=https%3A%2F%2Fapps.mobile.adnxs.com/clickenc=https%3A%2F%2Faww.reddit.com" target="_blank"><img width="320" height="50" style="border-style: none" src="https://placekitten.com/g/320/50"/></a>');
JSON
重要
JSON 応答を受信するには、要求のクエリ文字列に を追加 &format=json
する必要があります。
バナー
$ curl "https://mobile.adnxs.com/mob?id=1281482&idfa=610B91D7-8F0D-423A-A98E-333DC41D04A2&devmake=Apple&devmodel=x86_64&appid=ANX.FunWithBeingMediatedByMoPub&ua=Mozilla%2F5.0%20%28iPhone%3B%20CPU%20iPhone%20OS%207_0_3%20like%20Mac%20OS%20X%29%20AppleWebKit%2F537.51.1%20%28KHTML%2C%20like%20Gecko%29%20Mobile%2F11B508&orientation=v&connection_type=wifi&devtime=1389725718&language=en&native_browser=0&psa=1&format=json&st=mobile_app&sdkver=1.7&size=320x50" { "status": "ok", "ads": [{"type":"banner", "width":320, "height":50, "content": "<script type=\"text/javascript\">document.write('<a href=\"https://nym1.mobile.adnxs.com/click?_Knx0k1iUD_8qfHSTWJQPwAAAAAAAPA__Knx0k1iUD_8qfHSTWJQP-ciduUWOCtUp-qJIdPe_SR4FSJTAAAAAMqNEwC-AwAAvgMAAAIAAADtN2oAPsYCAAYAAQBVU0QAVVNEAEABMgARIAAA4pUABQMCAQIAAAAAkSZ64AAAAAA./cnd=%21LAZnOQjmx04Q7e-oAxi-jAsgBA../referrer=https%3A%2F%2Fapps.mobile.adnxs.com/clickenc=https%3A%2F%2Faww.reddit.com\" target=\"_blank\"><img width=\"320\" height=\"50\" style=\"border-style: none\" src=\"https://placekitten.com/g/320/50\"/></a>');</script>"}] }
間隙
$ curl 'https://mobile.adnxs.com/mob?id=1281482&md5udid=8747a995943822f78754d20587f7b4f7&sha1udid=028df4e36437e98f9e93c3ae0f9f99e512a28cee&devmake=motorola&devmodel=DROID%20X2&carrier=Verizon%20Wireless&appid=com.example.helloworldinterstitial&ua=Mozilla%2F5.0%20(Linux%3B%20U%3B%20Android%202.3.5%3B%20en-us%3B%20DROID%20X2%20Build%2F4.5.1A-DTN-200-18)%20AppleWebKit%2F533.1%20(KHTML%2C%20like%20Gecko)%20Version%2F4.0%20Mobile%20Safari%2F533.1&orientation=v&size=360x640&promo_sizes=300x250,320x480&language=en&devtime=1396901116263&connection_type=wan&native_browser=0&psa=1&format=json&st=mobile_app&sdkver=1.14' { "ads": [ { "content": "<script type="text/javascript">document.write('<a href="https://nym1.mobile.adnxs.com/click?_Knx0k1iUD_8qfHSTWJQPwAAAAAAAPA__Knx0k1iUD_8qfHSTWJQP833ijTfLRsp7_epnuN8OQDtBENTAAAAAMqNEwC-AwAAvgMAAAIAAABRoWAAPsYCAAYAAQBVU0QAVVNEACwB-gARIAAAA6YABQMCAQIAAAAAGScpIgAAAAA./cnd=%21vQWKNQjmx04Q0cKCAxi-jAsgBA../referrer=https%3A%2F%2Fapps.mobile.adnxs.com/clickenc=https%3A%2F%2Faww.reddit.com" target="_blank"><img width="300" height="250" style="border-style: none" src="https://placekitten.com/300/250"/></a>');</script>", "height": 250, "width": 300, "type": "interstitial" } ], "status": "ok" }
広告が返されない
$ curl "https://mobile.adnxs.com/mob?id=656561&size=320x480&devmake=Motorola&devmodel=Droid&pcode=12561&LimitAdTrackingEnabled=false&appid=com.example.hello_world&format=json"
注:
広告が返されない場合、JSON 応答は返されません。
エラー メッセージ
$ curl "https://mobile.adnxs.com/mob?id=656561&size=320x480&devmake=Motorola&devmodel=Droid&pcode=12561&LimitAdTrackingEnabled=false&appid=com.example.hello_world&format=json&FOO=BAR" { "status": "error", "errorMessage": "invalid input parameter: FOO" }
HTML
重要
HTML 応答を受信するには、要求のクエリ文字列に を追加 &format=html
する必要があります。
$ curl "https://mobile.adnxs.com/mob?id=1281482&idfa=610B91D7-8F0D-423A-A98E-333DC41D04A2&devmake=Apple&devmodel=x86_64&appid=ANX.FunWithBeingMediatedByMoPub&ua=Mozilla%2F5.0%20%28iPhone%3B%20CPU%20iPhone%20OS%207_0_3%20like%20Mac%20OS%20X%29%20AppleWebKit%2F537.51.1%20%28KHTML%2C%20like%20Gecko%29%20Mobile%2F11B508&orientation=v&connection_type=wifi&devtime=1389725718&language=en&native_browser=0&psa=1&format=html&st=mobile_app&sdkver=1.7&size=320x50" <script type="text/javascript">document.write('<a href="https://nym1.mobile.adnxs.com/click?_Knx0k1iUD_8qfHSTWJQPwAAAAAAAPA__Knx0k1iUD_8qfHSTWJQP1bxcdIRjzU7p-qJIdPe_STAFyJTAAAAAMqNEwC-AwAAvgMAAAIAAADtN2oAPsYCAAYAAQBVU0QAVVNEAEABMgARIAAAQq8AAQMCAQIAAAAAuibhDAAAAAA./cnd=%21LAZnOQjmx04Q7e-oAxi-jAsgBA../referrer=https%3A%2F%2Fapps.mobile.adnxs.com/clickenc=https%3A%2F%2Faww.reddit.com" target="_blank"><img width="320" height="50" style="border-style: none" src="https://placekitten.com/g/320/50"/></a>');</script>
ネイティブ広告
注:
ネイティブ広告はエンドポイントから /ssmob
利用できません。
空の応答
$ curl 'https://mobile.adnxs.com/mob?id=4448024' {"status":"no_bid","version":1}
ネイティブ広告での応答
ヒント
"native"
この応答の配列には、一連のネイティブ広告オブジェクトが含まれています。 ネイティブ クリエイティブの詳細については、 クリエイティブ サービスに関するページを参照してください。
ネイティブ広告の応答に関する注意事項は次のとおりです。
フィールドの
type
使用可能な値は と です"in-feed-standard"
。"recommendation-widget."
ネイティブ広告が表示されている場合にのみ、Web ページ/アプリで ping
impression_trackers
を実行する必要があります。クリックが検出されたときにを ping
click_trackers
するには、Web ページ/アプリが必要です。$ curl 'https://mobile.adnxs.com/mob?id=4469257' {"status":"ok","version":1,"ads":[],"mediated":[], "native": [{"type":"in-feed-standard","title":"Disqus rocks","description":"Let us disqus!", "fulltext":"Disqus rocks really long text","iconimgurl":"https://dummyimage.com/100x100?text=ICON", "mainmedia":[{"label":"default","width":800,"height":500,"url":"https://dummyimage.com/800x500?text=MAINIMAGE"}],"cta":"download", "clicktrackers": ["https://secure-nym.adnxs.com/click?AAAAAAAA8D8AAAAAAADwPwAAAAAAAPAAAAAAAAA8D8AAAAAAADw PzmS3KNRni9xPwJNJXfgutNwtVAAAAAAkyRAC-AwAAvgMAAAIAAACs95cBFPAGAAYAAQBVU0QAVVNEAAEAAQARIAAALe8BAgMAAQIAAAAAQBir5QAAAAA. /cnd=%21fwYfPAiWscsDEKzv3wwYlOAbIAQ./", "https://dummyimage.com/1x1?text=CLICK-TRACKER","https://dummyimage.com/1x1?text=CLICK-TRACKER2"], "impressiontrackers": ["https://secure-nym.adnxs.com/it?e=wqT3QLXA8DOAQAAAgDWAAUIre-sqAUQuaTynprK55dxGPnw6e i-pWCyABKi0JAAAAAAAA8D8RBQgMAPAGREJACERCQApEQmoMInkkAI4vgdAvgdIAlCs798MWJTgG2AGaJFAcAB4rd4DgAEBigEDVVNEkgUG8FCYAQGgAQGoAQGwAQC4AQLAAQPIAQ DQAQDYAQDgAQDwAQCKAjp1ZignYScsIDQxNjA3MywgMTQyNjc5ODUwOSk7dWYoJ3InLCAyNjczNjU1NiwyHgDwbJICnQEhUlI2Nkd3aVdzY3NERUt6djN3d1lBQ0NVNEJzd0FEZ0F RQVJJdmdkUWllU1FBbGdBWVBjRGFBQndBSGdBZ0FFQWlBRUFrQUVCbUFFQm9BRUJxQUVEc0FFQXVRRUFBQUFBQUFEd1A4RUIJDExBQThEX0pBZFlYNHB5SDFRQkEyUR0oGC1BQkFQ VUIJLCwuLpoCHSFmd1lmUEE2oADsbE9BYklBUS7YAugh3ALH0wGAAwCIAwGQAwCYAxagAwGqAwCwAwC4AwDAA6wCyAMA2AMA4AMB6AMC8AMB&dlo=1", "https://dummyimage.com/1x1?text=IMP-TRACKER","https://dummyimage.com/1x1?text=IMP-TRACKER2"], "click_url":"https://disqus.com"}]}