参照サービス

  • [アーティクル]

この読み取り専用サービスを使用すると、ID、名前、コード、状態、場合によっては、アカウント内の次の種類のオブジェクトの説明を取得できます。 また、これらのオブジェクトに関する階層情報 (たとえば、広告申込情報のプレースメントの発行元 ID や広告主 ID) も返します。 オブジェクトに関する情報が限られている場合、このサービスを使用すると、他の関連データに簡単にマップできます。 たとえば、一括レポート フィードは、オブジェクト ID でグループ化されたデータを返します。 Lookup Service を使用して、これらの ID を名前、コードなどと照合できます。

  • 広告 主
  • 挿入順序
  • 行項目
  • キャンペーン
  • クリエイティブ
  • セグメント ピクセル
  • 変換ピクセル
  • 出版 社
  • 支払いルール
  • サイト
  • プレースメント
  • ラベル

注:

  • ルックアップ サービスは、アカウント内の特定の種類のすべてのオブジェクトを返すので、 Search Service とは異なります。 Search Service を使用すると、特定の名前、コード、または ID を持つオブジェクトを検索できます。
  • Lookup Service は、最大 50,000 個のオブジェクトを返すことができます。
  • Lookup Service は、キャッシュされ、8 分ごとに更新されるデータに基づいています。

REST API

メソッド エンドポイント 説明
GET https://api.appnexus.com/lookup システム内のすべてのオブジェクトに関する情報を表示します。
GET https://api.appnexus.com/lookup?type=OBJECT_TYPE 特定の型のすべてのオブジェクトに関する情報を表示します。

注:
オブジェクトの種類 advertiser、、insertion_order、campaigncreativesegment_pixelconversion_pixelbudget_splitterline_itempayment_ruleplacementpublishersiteおよび に関する情報をlabel取得できます。
GET https://api.appnexus.com/lookup?advertiser_id=ADVERTISER_ID 特定の広告主に属するすべてのオブジェクトに関する情報を表示します。

JSON フィールド

すべてのオブジェクト型に対して返されるフィールド:

フィールド 種類 説明
code string オブジェクトのカスタム コード (すべてのオブジェクト型に適用されるわけではありません)。
id int オブジェクトに関連付けられている内部 ID。
last_modified timestamp オブジェクトが最後に変更された日時。
name string オブジェクトの名前。
state 列挙 オブジェクトの状態。
使用可能な値: "active" または "inactive"。

オブジェクト固有の JSON フィールド

特定のオブジェクト型に対して返されるその他のフィールド。

広告 主

フィールド 種類 説明
member_id int 広告主が属するメンバーの ID。

挿入順序

フィールド 種類 説明
advertiser_id int 挿入注文が属する広告主の ID。

行項目

フィールド 種類 説明
advertiser_id int 広告申込情報が属する広告主の ID。

キャンペーン

フィールド 種類 説明
line_item_id int キャンペーンが属する広告申込情報の ID。

予算スプリッター

フィールド 種類 説明
line_item_id int 予算分割が属する明細の ID。
name string 予算分割の名前。
id int 予算分割の ID。
state string 予算分割の状態。
許可される値は次のとおりです。
- active
- inactive
last_modified date 分割が最後に変更されたときのタイムスタンプ。

クリエイティブ

フィールド 種類 説明
advertiser_id int クリエイティブが属する広告主の ID。
brand_id int クリエイティブに関連付けられているブランドの ID。
description string クリエイティブの説明。
landing_page_url string このクリエイティブに関連付けられているランディング ページの URL。
publisher_id int クリエイティブが関連付けられている発行元の ID。

セグメント ピクセル

フィールド 種類 説明
advertiser_id int セグメント ピクセルが関連付けられている広告主の ID。
member_id int セグメント ピクセルが属するメンバーの ID。

変換ピクセル

フィールド 種類 説明
advertiser_id int コンバージョン ピクセルが属する広告主の ID。

Publisher

フィールド 種類 説明
member_id int パブリッシャーが属するメンバーの ID。

支払いルール

フィールド 種類 説明
description string 支払ルールの説明。
publisher_id int 支払いルールが属する発行元の ID。

Placement

フィールド 種類 説明
publisher_id int 配置が属する発行元の ID。

Site

フィールド 種類 説明
publisher_id int サイトが属する発行元の ID。

Label

フィールド 種類 説明
label_id int ラベルの ID。
member_id int ラベルが属するメンバーの ID。
object_id int ラベルを適用できるオブジェクトの ID。
object_type 列挙 ラベルを適用できるオブジェクトの種類。
指定できる値は、"advertiser"、"insertion_order"、、"campaign""line_item"、または "publisher"です。
value string ラベル テキスト。

例

すべてのキャンペーンを検索する

$ curl -b cookies -c cookies 'https://api.appnexus.com/lookup?type=campaign'
{
    "response": {
        "status": "OK",
        "num_elements": 2,
        "start_element": 0,
        "results": {
            "campaign": {
                "results": [
                    {
                        "id": "58990",
                        "name": "Car Donations",
                        "line_item_id": "31189",
                        "state": "active",
                        "code": "cdon",
                        "last_modified": "2011-10-18 17:25:00"
                    },
                    {
                        "id": "58991",
                        "name": "Bucket Builders",
                        "line_item_id": "31189",
                        "state": "active",
                        "code": "bb",
                        "last_modified": "2011-10-12 22:08:04"
                    }
                ],
                "num_elements": "2"
            }
        }
    }
}

このサービスからアクセスできるすべてのオブジェクトを検索する

$ curl -b cookies -c cookies 'https://api.appnexus.com/lookup'
{
    "response": {
        "status": "OK",
        "num_elements": 24,
        "start_element": 0,
        "results": {
            "advertiser": {
                "results": [
                    {
                        "id": "35081",
                        "name": "Bucketeer",
                        "code": "bucket",
                        "member_id": "1066",
                        "state": "active",
                        "last_modified": "2011-10-18 17:25:00"
                    }
                ],
                "num_elements": "1"
            },
            "insertion_order": {
                "results": null,
                "num_elements": 0
            },
            "line_item": {
                "results": [
                    {
                        "id": "31189",
                        "name": "bucket line 1",
                        "code": "bk1",
                        "advertiser_id": "35081",
                        "state": "active",
                        "last_modified": "2011-10-18 17:25:00"
                    }
                ],
                "num_elements": "1"
            },
            "campaign": {
                "results": [
                    {
                        "id": "58990",
                        "name": "Car Donations",
                        "line_item_id": "31189",
                        "state": "active",
                        "code": "cdon",
                        "last_modified": "2011-10-18 17:25:00"
                    },
                    {
                        "id": "58991",
                        "name": "Bucket Builders",
                        "line_item_id": "31189",
                        "state": "active",
                        "code": "bb",
                        "last_modified": "2011-10-17 13:24:00"
                    }
                ],
                "num_elements": "2"
            },
            "budget_splitter":{
               "results": [
                   {
                         "line_item_id": 1,
                         "name": "Split 1",
                         "id": 1,
                         "state": "active",
                         "last_modified": "2023-04-18 17:25:00"
                    },
                    {
                    "line_item_id": 1,
                    "name": "Split 2",
                    "id": 2,
                    "state": "active",
                    "last_modified": "2023-04-19 17:25:00"
                    },
                ],
                "num_elements": "2"
            },
            "creative": {
                "results": [
                    {
                        "id": "445832",
                        "code": null,
                        "description": "Donate car.png",
                        "advertiser_id": "35081",
                        "publisher_id": "0",
                        "state": "active",
                        "brand_id": 1,
                        "landing_page_url": "www.cardonations.com/donate",
                        "last_modified": "2011-10-17 13:24:00"
                    },
                    {
                        "id": "445833",
                        "code": null,
                        "description": "bucketbuilders.png",
                        "advertiser_id": "35081",
                        "publisher_id": "0",
                        "state": "active",
                        "brand_id": 3,
                        "landing_page_url": "www.buckets.com/build",
                        "last_modified": "2011-10-17 13:24:00"
                    }
                ],
                "num_elements": "2"
            },
            "segment_pixel": {
                "results": null,
                "num_elements": 0
            },
            "payment_rule": {
                "results": [
                    {
                        "id": "91345",
                        "name": "",
                        "publisher_id": "89286",
                        "state": "active",
                        "description": "",
                        "last_modified": "2011-10-17 13:24:00"
                    },
                    {
                        "id": "91346",
                        "name": "Default",
                        "publisher_id": "89287",
                        "state": "active",
                        "description": "",
                        "last_modified": "2011-10-17 13:24:00"
                    },
                    {
                        "id": "91375",
                        "name": "Base Payment Rule",
                        "publisher_id": "89314",
                        "state": "active",
                        "description": "",
                        "last_modified": "2011-10-17 13:24:00"
                    }
                ],
                "num_elements": "3"
            },
            "conversion_pixel": {
                "results": null,
                "num_elements": 0
            },
            "publisher": {
                "results": [
                    {
                        "id": "89286",
                        "name": "Default Real Time",
                        "member_id": "1066",
                        "state": "inactive",
                        "code": "",
                        "last_modified": "2011-10-17 13:24:00"
                    },
                    {
                        "id": "89287",
                        "name": "Wide Road",
                        "member_id": "1066",
                        "state": "active",
                        "code": "bb",
                        "last_modified": "2011-10-17 13:24:00"
                    },
                    {
                        "id": "89314",
                        "name": "Radio Live",
                        "member_id": "1066",
                        "state": "active",
                        "code": "rlive",
                        "last_modified": "2011-10-17 13:24:00"
                    },
                    ...
                ],
                "num_elements": "5"
            },
            "placement": {
                "results": [
                    {
                        "id": "594594",
                        "name": "[Default Real Time] - Default",
                        "publisher_id": "89286",
                        "state": "active",
                        "code": "",
                        "last_modified": "2011-10-17 13:24:00"
                    },
                    {
                        "id": "594595",
                        "name": "[Wide Road] - Placement 1",
                        "publisher_id": "89287",
                        "state": "active",
                        "code": "",
                        "last_modified": "2011-10-17 13:24:00"
                    },
                    {
                        "id": "594641",
                        "name": "[Radio Live] - Default",
                        "publisher_id": "89314",
                        "state": "active",
                        "code": "",
                        "last_modified": "2011-10-17 13:24:00"
                    },
                    ...
                ],
                "num_elements": "5"
            },
            "site": {
                "results": [
                    {
                        "id": "188039",
                        "code": "",
                        "name": "[Default Real Time] - ROS",
                        "publisher_id": "89286",
                        "state": "active",
                        "last_modified": "2011-10-17 13:24:00"
                    },
                    {
                        "id": "188040",
                        "code": "",
                        "name": "[Wide Road] - ROS",
                        "publisher_id": "89287",
                        "state": "active",
                        "last_modified": "2011-10-17 13:24:00"
                    },
                    {
                        "id": "188070",
                        "code": "",
                        "name": "[Radio Live] - ROS",
                        "publisher_id": "89314",
                        "state": "active",
                        "last_modified": "2011-10-17 13:24:00"
                    },
                    ...
                ],
                "num_elements": "5"
            },
        }
    }
}