TinyTag サービスを使用すると、TinyTag ID を作成したり、変更したり表示したりできます。
ID は、サイズ、予約価格、そのスペースで実行できるブランドやクリエイティブなど、広告スペースに関する情報に関連付けられています。 この情報は Xandr のサーバー側に保存され、簡単に変更できます。
TinyTag ID は、パブリッシャーのページに直接配置され、基本的な形式の https://ib.``adnxs``.com/tt?id=1 を取る TinyTag で使用できます。 詳細情報は、 動的 TinyTag パラメーターを使用して TinyTag に渡すことができます。
なお、TinyTag IDに関連付けられたメンバーは、在庫に対する優先拒否権を持ち、他のメンバーが購入した場合はクレジット(または現金)を受け取ります。
REST API
| HTTP メソッド | エンドポイント | 説明 |
|---|---|---|
| DELETE | https://api.adnxs.com/tt/MEMBER_ID/TAG_ID | 既存の TinyTag を削除します。 |
| GET | https://api.adnxs.com/tt/MEMBER_ID | メンバーのすべての TinyTags を表示します。 |
| GET | https://api.adnxs.com/tt/MEMBER_ID/TAG_ID | 特定の TinyTag を表示します。 |
| POST | https://api.adnxs.com/tt/MEMBER_ID (tag JSON) |
新しい TinyTag を作成します。 |
| PUT | https://api.adnxs.com/tt/MEMBER_ID/TAG_ID (tag JSON) |
既存の TinyTag を変更します。 |
JSON フィールド
| フィールド | 必須 | 型 | 説明 |
|---|---|---|---|
acb_code |
いいえ | string(32) | あまり使用されません。 |
active |
いいえ、既定値はアクティブです | int | ブール値は、セグメントを使用できるかどうかを決定します |
ad_profile_id |
いいえ | int | これは、クリエイティブ品質基準で使用される 広告承認プロファイル の ID です。 |
audit_level |
いいえ | 列挙 | 自己監査専用の値。 注: サイト レベルでの自己監査は、配置 (tinytag) レベルでオーバーライドできます。 使用可能な値: - 「tinytag」 - 監査対象フィールドが配置で true に設定されている場合は、この値を使用します。 - "site" - 監査対象フィールドが配置で false に設定されているが、サイトでは true に設定されている場合は、この値を使用します。 |
audited |
いいえ | ブール値 | true の場合、配置は所有者によって自己監査されています。 |
code |
いいえ | string(100) | コードを使用してタグを呼び出すためのユーザー定義フィールド。 詳細については、 Tinytag ページをご覧ください。 |
code2 |
いいえ | string(100) | 2 番目のコード (必要な場合)。 |
content_retrieval_timeout_ms |
いいえ | int | - 0の場合、広告サーバーは メンバー サービスの値を使用します。 - PUT または POST 呼び出しで API に指定されない場合、既定値は 0 になります。 - 広告サーバーがこのフィールドで 0 を読み取った場合、広告サーバーはメンバー検索を実行し、 メンバー サービス によって定義されたデフォルトのタイムアウトを使用します (これも 0 でないと仮定します)。 - TinyTag を作成すると、メンバーのデフォルト設定からこのフィールドに値がコピーされることはありません。 POST への呼び出しで明示的に指定する必要があります。 詳細については、「メンバー サービスのdefault_content_retrieval_timeout_ms」フィールドを参照してください。 |
default_calculation_type |
いいえ | 列挙 | これにより、既定のクリエイティブが提供される入札価格のしきい値が決まります。 このしきい値を、ネットワークの総収益にするか、パブリッシャーの純収益にするかを選択できます。 対象となるキャンペーンが他にない場合、または利用可能な既定のクリエイティブがない場合は、PSA が配信されます。 指定可能な値: "gross" または "net"。 |
default_creative_id |
いいえ | int | 予約価格を満たす入札がない場合に実行される既定のクリエイティブ。 |
default_creatives |
いいえ | 配列 | オークションの落札者がない場合に PSA の代わりに表示される既定のクリエイティブ。 既定のクリエイティブごとに、予約価格は配列内の "price" フィールドを使用して設定されます。 詳細については、下記 のデフォルト クリエイティブ をご覧ください。 注: ポップ配置の場合: 予約価格が満たされない場合、プレースメントはポップされません (プレポップの場合を除きます)。 |
default_referrer_url |
いいえ | string | 入札リクエストでインベントリ URL を非表示にするように表示範囲プロファイルが設定されている場合は、代わりにバニティ URL を渡すようにこのフィールドを設定できます。 これは、パブリッシャーが実際のドメインを共有したくないが、購入者がドメイン別にそれらを識別できるようにしたい場合に特に便利です。 ただし、バニティ ドメインは、外部の入札者がターゲットにすることはできますが、Xandr キャンペーンによって直接ターゲットにすることはできません。 |
enable_for_mediation |
いいえ | ブール値 | - これは、TinyTagが仲介されたコンテンツを受け入れるべきかどうかの真実の情報源です - PUT または POST に設定されていない限り、このフィールドはメンバーからデフォルト値を継承します。
メンバー サービスで既定値を変更した場合、そのアクションは以前に作成された TinyTags に遡及的には影響しません。引き続き以前の既定値に設定されます。 つまり、このフィールドの値を、メンバーの既定値を設定して遡及的に更新することはできません。 詳細については、「メンバー サービスのdefault_enable_for_mediation」フィールドを参照してください。 |
estimated_clear_prices |
いいえ | 歴史的に、参加するサード パーティ オークションの過半数 (95%) を獲得した入札金額。 詳細については、以下の 推定クリア価格 を参照してください。 | |
exclusive |
いいえ、既定値は false です | ブール値 |
読み取り専用です。 このフィールドは 非推奨になりました。 このフィールドは、以前は TinyTag の排他的な動作の既定値として機能していました。 この設定は、site サービスの marketplace_map オブジェクトの rtb フィールドを介して制御されるようになりました。 |
floor_application_target |
いいえ | 列挙 | 予約価格が適用される入札のタイプ。 使用可能な値: -"external_only" - 予約価格は外部入札にのみ適用されます (購入メンバーと販売メンバーは異なります)。 既定値を提供するよりも、使用可能なマネージド学習インプレッションを提供する場合に、学習の 1 日の最大ボリュームの割合を超える場合でも、このオプションを使用します。 - 「external_non_preferred」 - 予約価格は、外部入札(メンバーの購入と販売メンバーが異なります)、またはインプレッションが利用可能なマネージド学習インプレッションであり、学習の1日のボリュームの最大%を超える場合に適用されます。 学習の 1 日の最大ボリュームの割合を超える利用可能なマネージド Learn インプレッションを提供するのではなく、既定値を提供する場合は、このオプションを使用します。 - 「すべて」 - 予約価格は、マネージド学習インプレッションを除くすべての入札単価に、学習の 1 日あたりのボリュームの最大の割合以内に適用されます。 |
height |
いいえ | int | タグの高さ (ピクセル単位)。 |
hide_referer |
ブール値 | 参照元のページを表示しない。 | |
id |
いいえ、変更時のみ | int | このタグを参照するために API によって割り当てられた Xandr ID。 |
intended_audiences |
いいえ | 列挙 | 自己監査専用の値。 指定可能な値: "general"、"children"、"young_adult"、"mature"。 |
inventory_attributes |
いいえ | 配列 | 自己監査専用の値。 これは、ID を持つオブジェクトの配列です。 ID の一覧については、 Inventory Attribute Service を参照してください。 |
is_resizable |
いいえ | ブール値 | プレースメントでフレンドリ iFrame が使用されており、サイズを小さくしたり大きなクリエイティブに合わせて変更する場合は、このフィールドを true に設定します。 |
last_activity |
いいえ | timestamp | この小さなタグへの最終変更のタイムスタンプ。 |
media_subtypes |
いいえ | 列挙 | 非推奨です。 代わりに supported_media_types と supported_media_subtypes を使用してください。 |
member_id |
○ | int | このタグを所有するメンバー ID。 呼び出しには必要ですが、JSON には必要ありません。 |
name |
いいえ | string | TinyTag に関連付けられている名前 |
pixel_type |
いいえ | 列挙 | ピクセルの種類を識別します。 指定可能な値は、"script" または "image" です。 |
pixel_url |
いいえ | string | ユーザーがその配置をクリックしたときにピクセルが通知する場所。 |
pixel_url_secure |
いいえ | ブール値 | ピクセル URL が暗号化された Web ページをポイントしているかどうかを示します。 |
pop_values |
いいえ | 配列 | supported_media_typeが "Pop" の場合、またはsupported_media_subtypesが "Popup" または "Popunder" の場合、この配列はポップの動作を定義します。 詳細については、以下の POP 値 を参照してください。 |
position |
いいえ | 列挙 | "above"、"below"、または "unknown" - ページ折りに対する TinyTag の位置 |
publisher_id |
いいえ | int | タグが設定されているサイトに関連付けられているパブリッシャーの ID。 |
reserve_price |
いいえ、既定値は $0 です | double | $CPM の広告の予約価格 - これは、在庫所有者が販売する意思のある最低価格です。それ以外の場合は、既定のクリエイティブが提供されます。 注 : このフィールドは、/meta リストで "price" として表示されます。 |
segments |
いいえ | オブジェクトの配列 | この TinyTag を表示しているユーザーは、指定されたすべてのセグメントに配置されます。例: "segments": [ {"segment_id":1} ] |
site_id |
○ | int | タグが関連付けられているサイトの ID。 階層は Sites>Tags です。 サイト サービスの詳細については、https://api.adnxs.com/site/meta にGET呼び出してください。 |
supported_media_subtypes |
いいえ | 配列 | プレースメントで配信が許可されているメディアのサブタイプ。 詳細については、以下のサポート 対象メディア サブタイプ を参照してください。 |
supported_media_types |
いいえ | 配列 | プレースメントで提供できるメディアの種類。 詳細については 、以下のサポートされているメディアの種類 を参照してください。 |
tag_data |
いいえ | string | その他の情報 (多くの場合、人口統計データまたは説明データ)。 所有者の入札者にのみ送信されます。
TinyTags のqs_dataも参照してください。 注: このフィールドは /meta リストに "other_data" として表示されます。 |
use_detected_domain |
いいえ、既定値は true です。 | ブール値 | 読み取り専用です。 検出されたドメインと報告されたドメインのどちらを使用するか。 すべてのクライアントの既定値は true です。 |
visibility_profile_id |
いいえ | int | 配置に直接割り当てられている表示範囲プロファイルの ID。 |
width |
いいえ | int | タグの幅 (ピクセル単位)。 |
サポートされているメディアの種類
クリエイティブは、メディア タイプとメディア サブタイプによって分類されます。 メディア タイプは、クリエイティブの一般的な表示スタイルを定義します ("バナー"など)。メディア サブタイプは、"Standard Banner" や "In-Banner Video" など、クリエイティブの特定の表示スタイルを定義します。 この配列を使用して、プレースメントで配信できるメディアの種類 (クリエイティブの一般的な表示スタイル) を制限できます。 メディア サブタイプ、つまりクリエイティブの特定の表示スタイルを制限するには、supported_media_subtypes 配列を使用します (下記 の「サポートされるメディア サブタイプ 」を参照)。
| フィールド | 種類 | 説明 |
|---|---|---|
id |
int | 許可されるメディア サブタイプの ID。 |
name |
string | 読み取り専用です。 許可されるメディア サブタイプの名前。 |
サポートされるメディア サブタイプ
クリエイティブは、メディア タイプとメディア サブタイプによって分類されます。 メディア タイプは、クリエイティブの一般的な表示スタイルを定義します ("バナー"など)。メディア サブタイプは、"Standard Banner" や "In-Banner Video" など、クリエイティブの特定の表示スタイルを定義します。 この配列を使用して、プレースメントで配信できるメディア サブタイプ (クリエイティブの特定の表示スタイル) を制限できます。 メディアの種類 (クリエイティブの一般的な表示スタイル) を制限するには、supported_media_types 配列を使用します (上記の 「サポートされているメディア サブタイプ 」を参照)。
| フィールド | 種類 | 説明 |
|---|---|---|
id |
int | 許可されるメディア サブタイプの ID。 |
name |
string | 読み取り専用です。 許可されるメディア サブタイプの名前。 |
サポートされているメディアの種類とメディア サブタイプに関する注意事項
サポートされているメディアの種類またはサポートされているメディア サブタイプのいずれも指定しない場合、既定で "バナー" メディアの種類が許可されます。
"バナー" と "テキスト" メディアの種類、およびそれらのメディア サブタイプの任意の組み合わせを 1 つの配置で組み合わせることができますが、他のメディアの種類とメディア サブタイプを組み合わせることはできません。 この制限により、適切なクリエイティブのみがプレースメントで提供されます。 たとえば、メディア タイプ "ビデオ" のクリエイティブを許可する配置は、ビデオ プレーヤーに供給されることを目的としています。"インタースティシャル" など、他のメディア タイプのクリエイティブがプレースメントに配信されることを許可するのは意味がありません。
ダイレクト インベントリに "Expandable" メディアの種類またはそのサブタイプのいずれかを許可するように配置を設定できます。 他のプラットフォーム メンバーに再販できるプレースメントの拡張可能なクリエイティブをサポートする場合は、 検証用のサポート URL を指定してください。
既定のクリエイティブ
この配列を使用して、既定のクリエイティブを配置に割り当てます。 以下の要件に注意してください。
- 既定のクリエイティブの有効期限が切れてはなりません。 詳細については、クリエイティブサービスの is_expired フィールドを参照してください。
- 既定のクリエイティブは、プレースメントのsupported_media_typesとsupported_media_subtypesに一致するクリエイティブ テンプレートに割り当てる必要があります。 たとえば、プレースメントで "バナー" メディア タイプのクリエイティブが許可されている場合、"インタースティシャル" メディア タイプのクリエイティブ テンプレートを使用する既定のクリエイティブを関連付けることはできません。 詳細については、 クリエイティブ サービスのテンプレート フィールド を参照してください。
- プレースメントにサイズが設定されている場合 ("幅" フィールドと "高さ" フィールドがプレースメント用に定義されている場合)、この配列には、一致するサイズのクリエイティブが 1 つだけ含まれている必要があります。
| フィールド | 種類 | 説明 |
|---|---|---|
height |
int | 既定のクリエイティブの高さ。 |
id |
int | 既定のクリエイティブの ID。 |
name |
string | 読み取り専用です。 既定のクリエイティブの名前。 |
price |
double | 既定のクリエイティブの予約価格。 落札はこの価格を超える必要があります。 |
width |
int | 既定のクリエイティブの幅。 |
POP 値
supported_media_typeが "Pop" の場合、またはsupported_media_subtypesが "Popup" または "Popunder" の場合、これらのフィールドは "pop_values" 配列に含める必要があります。 例については以下をご覧ください。
| フィールド | 種類 | 説明 | 既定値 |
|---|---|---|---|
| pop_freq_duration | int | pop_freq_timesを参照してください。 | 頻度の上限なし |
| pop_freq_times | int | pop_frequency_duration 秒以内にタグを一意のユーザーにポップできる回数。 pop_is_prepop が true に設定されている場合、効果はありません。 | 頻度の上限なし |
| pop_is_prepop | ブール値 | true の場合、タグは事前ポップ タグであり、パブリッシャー ページが既にポップしたウィンドウで機能します。 | false |
| pop_max_height | int | クリエイティブの最大高さ。 pop_max_height が指定されている場合、タグによって表示されるクリエイティブの高さは pop_max_height 以下である必要があります | 最大高さなし |
| pop_max_width | int | pop_max_width が指定されている場合、タグによって表示されるクリエイティブの幅は pop_max_width 以下でなければなりません | 最大幅なし |
推定クリア価格
| フィールド | 種類 | 説明 |
|---|---|---|
| average_price | double | これは、このプレースメントに対して送信されたすべての入札単価の平均です。 |
| clear_price | int | このプレースメントに参加するサード パーティ オークションの過半数 (95%) を歴史的に落札した入札金額。 |
| height | int | サイズレス配置タグをエクスポートして配信する場合は、配置の高さが決まります。 |
| verified | ブール値 | 作成された価格が検証済みかどうかを示します。 |
| 幅 | int | サイズレス配置タグをエクスポートして配信する場合は、配置の幅が決まります。 |
例
手順 1. 関連するパラメーターを使用して JSON 形式のファイルを作成する
$ cat tag
{
"tinytag":
{
"width": "728",
"height": "90",
"reserve_price": "5.00",
"default_creative_id": 212,
"active": true,
"tag_data": "male/22",
"ad_profile_id": 234
}
}
手順 2. メンバー ID を使用して TinyTag ファイルを Imp バス キャッシュに追加する
$ curl -b cookies -c cookies -X POST --data-binary @tag https://api.adnxs.com/tt/1/
{
"response": {
"status": "OK",
"id": "1234"
}
}
手順 3. タグ ID を使用して作成したタグを表示する 1234
$ curl -b cookies -c cookies https://api.adnxs.com/tt/1/1234
$ curl -b cookies -c cookies [adnxs.com/tt/1/1234](https://api.adnxs.com/tt/1/1234)
{
"response": {
"tinytag": {
"id": 1234,
"width": "728",
"height": "90",
"member_id": 1,
"reserve_price": 5.00,
"default_creative_id": 212,
"tag_data": "male\/22",
"active": true,
"ad_profile_id": 234
},
"status": "OK"
}
}