次の方法で共有

デジタル プラットフォーム API - クリエイティブ Search Service

この読み取り専用サービスでは、監査の状態、ID、サイズなど、特定の条件に従って アクティブな クリエイティブを検索できます。その後、 広告プロファイル サービスでこれらのクリエイティブ ID を使用できます。 システムにクリエイティブを追加するには、 クリエイティブ サービスに関するページを参照してください。

注:

このサービスでは、AppNexus プラットフォーム上のすべてのアクティブなクリエイティブ (独自のクリエイティブだけでなく) が検索されるため、検索範囲が広すぎるとエラーが発生する可能性があります。 結果を確実に取得するには、可能な限り検索を絞り込みます。

この API を使用すると、クリエイティブ検索で検索できる特定のネイティブ フィールドも有効になります。

検索可能なフィールドは次のとおりです。

  • title (1)
  • description (2)
  • call_to_action (3)
  • additional_description (13)

検索語句が前述のフィールド内の任意のテキストと一致する場合、検索はクリエイティブを返します。

REST API

HTTP メソッド エンドポイント 説明
POST https://api.appnexus.com/creative-search
(creative_search JSON)		 クリエイティブを検索します。
POST https://api.appnexus.com/creative-search?sort=FIELD_NAME.ASC_OR_DESC
(creative_search JSON)		 クリエイティブを検索し、結果を並べ替えます。

注:

クリエイティブの検索に使用するフィールドは、返されるフィールドとまったく同じではありません。 これは、返されたオブジェクトが クリエイティブ サービス から描画され、それに応じて書式設定されるためです。

JSON フィールド

フィールド 種類 説明
creative_ids 整数の配列 ID でクリエイティブを検索します。
ソート： はい。クエリ文字列で "id" を使用します。
description string 説明で用語でクリエイティブを検索します。
ソート： いいえ
audit_status 列挙型の配列 監査状態でクリエイティブを検索します。 使用可能な値: "no_audit"、、"pending"、"rejected""audited"。
ソート： はい
ad_profile_id int brand_status と共に使用する必要があります。 広告プロファイルの ID でクリエイティブを検索します。
ソート： いいえ
brand_status 列挙型の配列 ad_profile_id と共に使用する必要があります。 ブランドのステータスでクリエイティブを検索します。 たとえば、これが に "trusted"設定されている場合、指定された ad_profile_id 広告プロファイル内のすべての信頼されたブランドが応答で返されます。 使用可能な値: "trusted"、、"case-by-case""banned"。 [ブランドの状態] フィールドは、このフィルターを使用する場合にのみ応答で返されます。
ソート： いいえ
review_status 列挙型の配列 (関連する広告プロファイルから) レビューの状態に基づいてクリエイティブを検索します。 使用可能な値: "reviewed"、 "unreviewed"。 レビュー状態フィールドは、このフィルターを使用する場合にのみ応答で返されます。
ソート： いいえ
uploaded_since timestamp この日付以降にアップロードされたクリエイティブを検索します。
形式: "YYYY-MM-DD HH:MM:SS"
ソート： いいえ
modified_since timestamp この日付以降に変更されたクリエイティブを検索します。
形式: "YYYY-MM-DD HH:MM:SS"
ソート： いいえ
formats 列挙型の配列 クリエイティブをフォーマットで検索します。 使用可能な値: "url-html"、、、"flash"、、"image"、"raw-html""raw-js"、"iframe-html"、"url-vast"、"text"。 "url-js"
ソート： はい。クエリ文字列で "format" を使用します。
media_subtype 列挙型の配列 非推奨の場合は、代わりに を使用 media_subtype_ids してください。 メディア サブタイプでクリエイティブを検索します。 使用可能な値: "Banner"、、"Popup""Popunder"。
ソート： いいえ
media_subtype_ids 整数の配列 ID を使用して、メディア サブタイプでクリエイティブを検索します。 Media サブタイプ サービスを使用して、目的の ID を検索できます。
ソート： はい。クエリ文字列で を使用 "media_subtype_id" します。
media_url string URL でクリエイティブを検索します。
ソート： はい
media_content string [original_content] フィールドのデータでクリエイティブを検索します ( 「Creative Service」を参照)。
ソート： いいえ
sizes 文字列の配列 サイズでクリエイティブを検索します (例: "728x90")。
ソート：はい。クエリ文字列で と を"height"使用"width"します。
brand_ids 整数の配列 ブランドの ID でクリエイティブを検索します。
ソート： いいえ
member_ids 整数の配列 member_action と共に使用する必要があります。 メンバーの ID でクリエイティブを検索します。
ソート： はい。クエリ文字列で を使用 "member_id" します。
member_action 列挙 member_ids と共に使用する必要があります。 が に "exclude"設定されている場合は、 で member_ids 指定されたメンバーを検索から除外します。 それ以外の場合は、指定した ID が含まれます。
ソート： いいえ
template_id int クリエイティブ テンプレート ID でクリエイティブを検索します。
ソート： はい
size_in_bytes string フィルターではありません。 並べ替えの結果は、昇順または降順のサイズ順になります。
ソート： はい
click_url string フィルターではありません。 結果を昇順または降順で並べ替えます。アルファベット順のクリック URL 順序です。
ソート： はい
landing_page_url string フィルターではありません。 結果を昇順または降順のアルファベット順のランディング ページ URL で並べ替えます。
ソート： はい

例

AppNexus 監査に合格したすべてのバナー クリエイティブを検索する

$ cat creative_search
{
   "creative-search": {
      "audit_status": [
         "audited"
      ],
      "media_subtype": [
         "banner"
      ]
   }
}

$ curl -b cookies -c cookies -X POST -d @creative_search 'https://api.appnexus.com/creative-search'

{
   "response": {
      "status": "OK",
      "creatives": [
         {
            "id": "48652",
            "width": "300",
            "height": "250",
            "media_url": "https:\/\/cdn.adnxs.com\/p\/05\/d1\/cd\/fe\/05d1cxxxxxx221db2ba8b.png",
            "content": null,
            "format": "image",
            "member_id": "408",
            "brand_id": "1",
            "click_url": "https:\/\/www.sample.com",
            "audit_status": "audited",
            "size_in_bytes": "14545",
            "landing_page_url": null,
            "last_activity": "2010-07-23 16:40:41",
            "created_on": "2010-04-30 07:20:23",
            "media_subtypes": [
               "banner"
            ],
            "pop_values": null
            },
         {
            "id": "73163",
            "width": "300",
            "height": "250",
            "media_url": null,
            "content": "<iframe src=\"https:\/\/xxxx.net\/udm\/img.fetch?sid=2773;tid=2;ev=1;dt=1;\" width=300
             height=250 Marginwidth=0 Marginheight=0 Hspace=0 Vspace=0 Frameborder=0 Scrolling=No><\/iframe>
             <noscript><a href=\"https:\/\/fletcher.net\/udm\/clk.cpx?sid=2773;ev=2;tid=2;dt=3\"><img src=\
             "https:\/\/sample.net\/udm\/img.fetch?sid=2773;ev=1;tid=2;dt=3\" width=300 height=250 border=0>
             <\/a><\/noscript>",
            "format": "iframe-html",
            "member_id": "333",
            "brand_id": "17",
            "click_url": "",
            "audit_status": "audited",
            "size_in_bytes": "0",
            "landing_page_url": "https:\/\/www.appleblueberry.com",
            "last_activity": "2010-09-07 23:33:45",
            "created_on": "2010-08-25 16:31:43",
            "media_subtypes": [
               "banner"
            ],
            "pop_values": null
         },
         ...
      ]
   }
}

2012-01-01 00:00:00 以降にアップロードされたすべてのフラッシュ クリエイティブを検索します

$ cat creative_search
{
   "creative-search": {
      "formats": [
         "flash"
      ],
      "uploaded_since": "2012-01-01 00:00:00"
   }
}

$ curl -b cookies -c cookies -X POST -d @creative_search 'https://api.appnexus.com/creative-search'

{
   "response": {
      "status": "OK",
      "creatives": [
         {
            "id": "1207858",
            "width": "160",
            "height": "600",
            "media_url": "https:\/\/cdn.adnxs.com\/p\/c7\/6d\/5b\/bd\/c76d5bbdxxxxx8b9e1507c07cbe61.swf",
            "content": null,
            "format": "flash",
            "member_id": "326",
            "brand_id": "4467",
            "click_url": "https:\/\/clickclick.com\/witness\/p=28xxx96\/c=6sxd3",
            "audit_status": "audited",
            "size_in_bytes": "40077",
            "landing_page_url": "https:\/\/www.destination.com",
            "last_activity": "2012-01-01 15:56:59",
            "created_on": "2012-01-01 02:34:14",
            "media_subtypes": [
               "banner"
            ],
            "pop_values": null
         },
         {
            "id": "1207859",
            "width": "160",
            "height": "600",
            "media_url": "https:\/\/cdn.adnxs.com\/p\/3b\/d6\/f6\/1d\/3bd6f61dkdh4473djfb579430ed.swf",
            "content": null,
            "format": "flash",
            "member_id": "326",
            "brand_id": "4467",
            "click_url": "https:\/\/clickclick.com\/witness\/p=2ddssd6\/c=3423",
            "audit_status": "audited",
            "size_in_bytes": "32094",
            "landing_page_url": "https:\/\/www.destination.com",
            "last_activity": "2012-01-01 15:57:36",
            "created_on": "2012-01-01 02:35:52",
            "media_subtypes": [
               "banner"
            ],
            "pop_values": null
         },
         ...
      ]
   }
}

メンバー 333 に属するすべての 728x90 および 300x250 イメージ クリエイティブを検索する

$ cat creative_search
{
   "creative-search": {
      "sizes": [
         "728x90", 
         "300x250"
      ],
      "formats": [
         "image"
      ],
      "member_ids": [
         333
      ]
   }
}

$ curl -b cookies -c cookies -X POST -d @creative_search 'https://api.appnexus.com/creative-search'

{
   "response": {
      "status": "OK",
      "creatives": [
         {
            "id": "61967",
            "width": "300",
            "height": "250",
            "media_url": "https://cdn.adnxs.com/p/c8/fb/12/56/c8fb125634xxxx2e67a783d91cf.png",
            "content": null,
            "format": "image",
            "member_id": "333",
            "brand_id": "1",
            "click_url": "https://www.clickplace.com/",
            "audit_status": "no_audit",
            "size_in_bytes": "29433",
            "landing_page_url": null,
            "last_activity": "2011-05-13 02:34:47",
            "created_on": "2010-07-28 20:44:22",
            "media_subtypes": [
               "banner"
            ],
            "pop_values": null
         },
         {
            "id": "291801",
            "width": "728",
            "height": "90",
            "media_url": "https://cdn.adnxs.com/p/54/62/87/d1/546287aasxxx8e6431960ad2b1fb.png",
            "content": null,
            "format": "image",
            "member_id": "333",
            "brand_id": "2450",
            "click_url": "https://thatplace.com/careers",
            "audit_status": "audited",
            "size_in_bytes": "24091",
            "landing_page_url": "https://thatplace.com/careers",
            "last_activity": "2011-05-13 03:30:00",
            "created_on": "2011-04-05 18:28:29",
            "media_subtypes": [
               "banner"
            ],
            "pop_values": null
         },
         ...
      ]
   }
}
  • Last updated on