行項目

GET accounts/:account_id/line_items¶

現在のアカウントに関連付けられている一部またはすべての行項目の詳細を取得します。

リソースURL¶

https://ads-api.x.com/10/accounts/:account_id/line_items

パラメーター¶

リクエストの例¶

GET https://ads-api.x.com/10/accounts/18ce54d4x5t/line_items?line_item_ids=8v7jo

応答の例¶

{
  "request": {
    "params": {
      "line_item_ids": [
        "8v7jo"
      ],
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "bid_strategy": "MAX",
      "advertiser_user_id": 756201191646691328,
      "name": "Untitled",
      "placements": [
        "ALL_ON_TWITTER"
      ],
      "start_time": null,
      "bid_amount_local_micro": 100000,
      "advertiser_domain": null,
      "target_cpa_local_micro": null,
      "primary_web_event_tag": null,
      "pay_by": "ENGAGEMENT",
      "product_type": "PROMOTED_TWEETS",
      "end_time": null,
      "duration_in_days": 1,
      "total_budget_amount_local_micro": null,
      "objective": "ENGAGEMENTS",
      "id": "8v7jo",
      "entity_status": "ACTIVE",
      "goal": "ENGAGEMENT",
      "frequency_cap": 5,
      "categories": [],
      "currency": "USD",
      "created_at": "2017-05-27T08:04:00Z",
      "updated_at": "2017-05-27T08:06:25Z",
      "campaign_id": "8gdx6",
      "creative_source": "MANUAL",
      "deleted": false
    }
  ]
}

GET accounts/:account_id/line_items/:line_item_id¶

現在のアカウントに関連付けられている特定の行項目を取得します。

リソースURL¶

https://ads-api.x.com/10/accounts/:account_id/line_items/:line_item_id

パラメーター¶

リクエストの例¶

GET https://ads-api.x.com/10/accounts/18ce54d4x5t/line_items/8v7jo

応答の例¶

{
  "request": {
    "params": {
      "line_item_id": "8v7jo",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "bid_strategy": "MAX",
    "advertiser_user_id": 756201191646691328,
    "name": "Untitled",
    "placements": [
      "ALL_ON_TWITTER"
    ],
    "start_time": null,
    "bid_amount_local_micro": 100000,
    "advertiser_domain": null,
    "target_cpa_local_micro": null,
    "primary_web_event_tag": null,
    "pay_by": "ENGAGEMENT",
    "product_type": "PROMOTED_TWEETS",
    "end_time": null,
    "duration_in_days": 1,
    "total_budget_amount_local_micro": null,
    "objective": "ENGAGEMENTS",
    "id": "8v7jo",
    "entity_status": "ACTIVE",
    "goal": "ENGAGEMENT",
    "frequency_cap": 5,
    "categories": [],
    "currency": "USD",
    "created_at": "2017-05-27T08:04:00Z",
    "updated_at": "2017-05-27T08:06:25Z",
    "campaign_id": "8gdx6",
    "creative_source": "MANUAL",
    "deleted": false
  }
}

POST accounts/:account_id/line_items¶

現在のアカウントに属する、指定したキャンペーンに関連付けられた行項目を作成します。

キャンペーン内のすべての行項目は、product_typeとobjectiveが同じである必要があります。

PROMOTED_ACCOUNT商品タイプを使用する場合、ツイートをline_itemに関連付けると、標準のPROMOTED_ACCOUNT配置に加えて、タイムライン配置がモバイルに追加されます。

android_app_store_identifierかios_app_store_identifierを設定すると、プロモーション対象のモバイルアプリと一致する行項目のターゲティング条件が自動的に追加されます。たとえば、ios_app_store_identifierを渡すと、iOSのPLATFORMターゲティング条件が追加されます。

注: キャンペーンあたり100の行項目、全キャンペーンで8,000のアクティブな行項目の制限があります。

リソースURL¶

https://ads-api.x.com/10/accounts/:account_id/line_items

パラメーター¶

リクエストの例¶

POST https://ads-api.x.com/10/accounts/18ce54d4x5t/line_items?campaign_id=8slvg&objective=ENGAGEMENTS&product_type=PROMOTED_TWEETS&placements=ALL_ON_TWITTER&bid_amount_local_micro=3210000&entity_status=PAUSED

応答の例¶

{
  "data": {
    "bid_strategy": "MAX",
    "advertiser_user_id": 756201191646691328,
    "name": "Untitled",
    "placements": [
      "ALL_ON_TWITTER"
    ],
    "start_time": null,
    "bid_amount_local_micro": 3210000,
    "advertiser_domain": null,
    "target_cpa_local_micro": null,
    "primary_web_event_tag": null,
    "pay_by": "ENGAGEMENT",
    "product_type": "PROMOTED_TWEETS",
    "end_time": null,
    "duration_in_days": null,
    "total_budget_amount_local_micro": null,
    "objective": "ENGAGEMENTS",
    "frequency_cap": null,
    "id": "95lya",
    "entity_status": "PAUSED",
    "goal": "ENGAGEMENT",
    "categories": [],
    "currency": "USD",
    "created_at": "2017-06-23T01:59:22Z",
    "updated_at": "2017-06-23T01:59:22Z",
    "campaign_id": "8slvg",
    "creative_source": "MANUAL",
    "deleted": false
  },
  "request": {
    "params": {
      "placements": [
        "ALL_ON_TWITTER"
      ],
      "bid_amount_local_micro": 3210000,
      "product_type": "PROMOTED_TWEETS",
      "objective": "ENGAGEMENTS",
      "entity_status": "PAUSED",
      "account_id": "18ce54d4x5t",
      "campaign_id": "8slvg"
    }
  }
}

POST batch/accounts/:account_id/line_items¶

1回のリクエストで新しい行項目をバッチ作成できます。

バッチリクエスト

• 現在の最大バッチサイズは40です。
• すべてのパラメーターはリクエストボディで送信され、application/jsonのContent-Typeが必須です。
• バッチリクエストはグループ単位で失敗または成功となります。エラーの場合も、成功の場合も、API応答には、最初のリクエストの項目の順序が保持されます。

バッチ応答

バッチAPIの応答は、項目のコレクションを順番どおりに返します。その点を除くと、バッチAPIの構造は、対応する単一項目のエンドポイントと同じです。

バッチエラー

• リクエストレベルのエラー（最大バッチサイズの超過など）は、errorsオブジェクトの応答に表示されます。
• 項目レベルのエラー（必須行項目パラメーターの不足など）は、operation_errorsオブジェクトの応答に表示されます。

リソースURL¶

https://ads-api.x.com/10/batch/accounts/:account_id/line_items

パラメーター¶

リクエストの例¶

POST 'Content-Type: application/json' https://ads-api.x.com/10/batch/accounts/18ce54d4x5t/line_items

[  
  {  
    "operation_type":"Create",
    "params":{  
      "campaign_id":"8yn7m",
      "objective":"ENGAGEMENTS",
      "product_type":"PROMOTED_TWEETS",
      "placements":"ALL_ON_TWITTER",
      "bid_amount_local_micro":3210000,
      "entity_status":"PAUSED"
    }
  }
]

応答の例¶

{
  "data": [
    {
      "bid_strategy": "MAX",
      "advertiser_user_id": 756201191646691328,
      "name": "Untitled",
      "placements": [
        "ALL_ON_TWITTER"
      ],
      "start_time": null,
      "bid_amount_local_micro": 3210000,
      "advertiser_domain": null,
      "target_cpa_local_micro": null,
      "primary_web_event_tag": null,
      "pay_by": "ENGAGEMENT",
      "product_type": "PROMOTED_TWEETS",
      "end_time": null,
      "total_budget_amount_local_micro": null,
      "objective": "ENGAGEMENTS",
      "id": "9cqi0",
      "entity_status": "PAUSED",
      "goal": "ENGAGEMENT",
      "categories": [],
      "currency": "USD",
      "created_at": "2017-07-07T17:42:20Z",
      "updated_at": "2017-07-07T17:42:20Z",
      "campaign_id": "8yn7m",
      "creative_source": "MANUAL",
      "deleted": false
    }
  ],
  "request": [
    {
      "params": {
        "placements": [
          "ALL_ON_TWITTER"
        ],
        "bid_amount_local_micro": 3210000,
        "product_type": "PROMOTED_TWEETS",
        "objective": "ENGAGEMENTS",
        "entity_status": "PAUSED",
        "account_id": "18ce54d4x5t",
        "campaign_id": "8yn7m"
      },
      "operation_type": "Create"
    }
  ]
}

PUT accounts/:account_id/line_items/:line_item_id¶

現在のアカウントに関連付けられている指定された行項目を更新します。

リソースURL¶

https://ads-api.x.com/10/accounts/:account_id/line_items/:line_item_id

パラメーター¶

リクエストの例¶

PUT https://ads-api.x.com/10/accounts/18ce54d4x5t/line_items/8v7jo?bid_amount_local_micro=140000

応答の例¶

{
  "data": {
    "bid_strategy": "MAX",
    "advertiser_user_id": 756201191646691328,
    "name": "Untitled",
    "placements": [
      "ALL_ON_TWITTER"
    ],
    "start_time": null,
    "bid_amount_local_micro": 140000,
    "advertiser_domain": null,
    "target_cpa_local_micro": null,
    "primary_web_event_tag": null,
    "pay_by": "ENGAGEMENT",
    "product_type": "PROMOTED_TWEETS",
    "duration_in_days": 1,
    "end_time": null,
    "total_budget_amount_local_micro": null,
    "objective": "ENGAGEMENTS",
    "id": "8v7jo",
    "entity_status": "ACTIVE",
    "goal": "ENGAGEMENT",
    "frequency_cap": 5,
    "categories": [],
    "currency": "USD",
    "created_at": "2017-05-27T08:04:00Z",
    "updated_at": "2017-07-04T22:01:28Z",
    "campaign_id": "8gdx6",
    "creative_source": "MANUAL",
    "deleted": false
  },
  "request": {
    "params": {
      "line_item_id": "8v7jo",
      "bid_amount_local_micro": 140000,
      "account_id": "18ce54d4x5t"
    }
  }
}

DELETE accounts/:account_id/line_items/:line_item_id¶

現在のアカウントに属する、指定された行項目を削除します。

注: 行項目の削除は元に戻すことができず、その後にリソースを削除しようとするとHTTP 404が返されます。

注: 行項目が削除されると、もしリクエストにwith_deleted=trueが指定されている場合、子のpromoted_tweetsはGET accounts/:account_id/promoted_tweetsとGET accounts/:account_id/promoted_tweets/:promoted_tweet_idエンドポイントでのみ返されます。これらのpromoted_tweetsは、実際には削除されていません（応答は"deleted": false）。削除はカスケードされません。

リソースURL¶

https://ads-api.x.com/10/accounts/:account_id/line_items/:line_item_id

パラメーター¶

リクエストの例¶

DELETE https://ads-api.x.com/10/accounts/18ce54d4x5t/line_items/9f2ix

応答の例¶

{
  "data": {
    "bid_strategy": "MAX",
    "advertiser_user_id": 756201191646691328,
    "name": "Untitled",
    "placements": [],
    "start_time": null,
    "bid_amount_local_micro": 100000,
    "advertiser_domain": null,
    "target_cpa_local_micro": null,
    "primary_web_event_tag": null,
    "pay_by": "ENGAGEMENT",
    "product_type": "PROMOTED_TWEETS",
    "end_time": "2017-07-21T00:00:00Z",
    "duration_in_days": 1,
    "total_budget_amount_local_micro": null,
    "objective": "ENGAGEMENTS",
    "id": "9f2ix",
    "entity_status": "ACTIVE",
    "goal": "ENGAGEMENT",
    "frequency_cap": 5,
    "categories": [],
    "currency": "USD",
    "created_at": "2017-07-14T00:01:50Z",
    "updated_at": "2017-08-09T07:41:08Z",
    "campaign_id": "90r8n",
    "creative_source": "MANUAL",
    "deleted": true
  },
  "request": {
    "params": {
      "line_item_id": "9f2ix",
      "account_id": "18ce54d4x5t"
    }
  }
}