TinyTag サービス
TinyTag サービスを使用すると、TinyTag ID を作成したり、変更したり表示したりできます。
ID は、広告スペースに関する情報 (サイズ、予約価格、その空間で実行できるブランドやクリエイティブなど) に関連付けられます。 この情報は Xandr でサーバー側に格納され、簡単に変更できます。
TinyTag ID は TinyTags で使用できます。これはパブリッシャー ページに直接配置され、基本的な形式 https://ib.``adnxs``.com/tt?id=1
します。 詳細については、動的 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 (タグ JSON) |
新しい TinyTag を作成します。 |
PUT | https://api.adnxs.com/tt/MEMBER_ID/TAG_ID (タグ 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 に設定されていない限り、このフィールドはメンバーから既定値を継承します。
メンバー サービスで既定値が変更された場合、そのアクションは以前に作成した TinyTag にさかのぼって影響しません。これらは引き続き古い既定値に設定されます。 つまり、メンバーの既定値を設定することで、このフィールドの値をさかのぼって更新することはできません。 詳細については、メンバー サービスの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 の一覧については、 インベントリ属性サービス を参照してください。 |
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バナー"や"バナー内のビデオ")。 この配列を使用して、クリエイティブの一般的な表示スタイルであるメディアの種類を制限し、配置で配信できます。 クリエイティブの特定の表示スタイルであるメディア サブタイプを制限するには、supported_media_subtypes配列を使用します (後述の 「サポートされているメディア サブタイプ 」を参照してください)。
フィールド | 種類 | 説明 |
---|---|---|
id |
int | 許可されるメディア サブタイプの ID。 |
name |
string | 読み取り専用。 許可されるメディア サブタイプの名前。 |
サポートされているメディア サブタイプ
クリエイティブは、メディアの種類とメディア サブタイプによって分類されます。 メディアタイプは、クリエイティブの一般的な表示スタイルを定義します(たとえば、"バナー"、メディアサブタイプはクリエイティブの特定の表示スタイルを定義します。たとえば、"Standardバナー"や"バナー内のビデオ")。 この配列を使用して、配置で配信できるメディア サブタイプ (クリエイティブの特定の表示スタイル) を制限できます。 クリエイティブの一般的な表示スタイルであるメディアの種類を制限するには、supported_media_types配列を使用します (上記の 「サポートされているメディア サブタイプ 」を参照してください)。
フィールド | 種類 | 説明 |
---|---|---|
id |
int | 許可されるメディア サブタイプの ID。 |
name |
string | 読み取り専用。 許可されるメディア サブタイプの名前。 |
サポートされているメディアの種類とメディア サブタイプに関する注意事項
サポートされているメディアの種類またはサポートされているメディア サブタイプを指定しない場合は、既定で "バナー" メディアの種類が許可されます。
"バナー" メディアタイプと "テキスト" メディアタイプ、およびそのメディアサブタイプの任意の組み合わせを 1 つの配置で組み合わせることができますが、他のメディアタイプとメディアサブタイプを組み合わせることはできません。 この制限により、適切なクリエイティブのみが配置に配信されるようになります。 たとえば、メディア タイプ "Video" のクリエイティブを許可する配置は、ビデオ プレーヤーにフィードすることを目的としています。"スポット" などの他のメディア タイプのクリエイティブを配置に配信することは意味がありません。
配置を設定して、"展開可能" メディアの種類、またはそのサブタイプを直接インベントリに対して許可できます。 他のプラットフォーム メンバーへの転売に使用できるプレースメントに対して拡張可能なクリエイティブをサポートする場合は、確認を サポート する URL を指定してください。
既定のクリエイティブ
この配列を使用して、既定のクリエイティブを配置に割り当てます。 次の要件に注意してください。
- 既定のクリエイティブの有効期限が切れてはいけません。 詳細については、クリエイティブ サービスの [is_expired] フィールドを参照してください。
- 既定のクリエイティブは、配置のsupported_media_typesとsupported_media_subtypesに一致するクリエイティブ テンプレートに割り当てる必要があります。 たとえば、配置で "バナー" メディア タイプのクリエイティブが許可されている場合、"スポット" メディア タイプのクリエイティブ テンプレートを使用する既定のクリエイティブを関連付けることはできません。 詳細については、 クリエイティブ サービス のテンプレート フィールドを参照してください。
- 配置のサイズが設定されている場合 (配置に対して "幅" フィールドと "高さ" フィールドが定義されています)、この配列には、一致するサイズのクリエイティブが 1 つだけ含まれている必要があります。
フィールド | 種類 | 説明 |
---|---|---|
height |
int | 既定のクリエイティブの高さ。 |
id |
int | 既定のクリエイティブの ID。 |
name |
string | 読み取り専用。 既定のクリエイティブの名前。 |
price |
double | 既定のクリエイティブの予約価格。 落札額は、この価格を超える必要があります。 |
width |
int | 既定のクリエイティブの幅。 |
ポップ値
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 | 提供するサイズレス配置タグをエクスポートする場合、配置の高さが決まります。 |
検証 | ブール値 | 作成された価格が検証されているかどうかを示します。 |
幅 | 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 Bus キャッシュに追加する
$ 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"
}
}