メインコンテンツへスキップ

​
Advertiser API

このAPIスイートを使って、X上のキャンペーンをプログラムでスケジューリングし、広告を管理できます。

​
何をプロモーションできますか？

  • プロモーション広告は、より幅広いユーザー層にリーチしたい、または既存のフォロワーからのエンゲージメントを高めたい広告主が購入する一般的な広告です。
  • 広告主がX上での掲載に対して支払っている場合、プロモーション広告には明確に「プロモーション」と表示されます。それ以外の点では通常の広告と同様に機能し、リポスト、返信、いいねなどが可能です。一般的な配信ルールが適用され、POST statuses/update を使用して作成されます。
  • 「Promoted-only」Tweets は POST accounts/:account_id/tweet で作成でき、Promoted Tweets キャンペーンで使用可能ですが、フォロワーへの配信や公開タイムラインへの表示は行われません。特定のアカウントにおける promoted-only tweets の一覧を取得するには、GET accounts/:account_id/scoped_timeline を使用してください。
  • プロモアカウントは「おすすめユーザー（Who to Follow）」の一部で、現在フォローしていないものの興味を持ちそうなアカウントを提案します。プロモアカウントは、ユーザーが楽しめるアカウントの幅をさらに広げるのに役立ちます。
  • タイムライン向けのプロモアカウントでは、プロモツイートをプロモアカウントのキャンペーンに関連付け、ユーザーのタイムラインに表示します。
プロモトレンドは Ads API ではご利用いただけません。

​
キャンペーンと広告グループ（ラインアイテム）

キャンペーンは広告の配信スケジュールと予算を定義します。広告主は日次予算と総予算を指定します。キャンペーンは特定の開始・終了時刻に設定することも、予算が消化されるまで継続配信することもできます。予算は広告アカウントの Funding Instruments のいずれかから拠出されます。キャンペーン識別子（:campaign_id）は、X Ads の UI に表示される 10 進数の値を 36 進数で表したものです。 広告アカウントには、アクティブなキャンペーンは最大 200 件という制限があります。この上限は、広告主の X アカウントマネージャーへのリクエストにより、手動でアクティブキャンペーン 4,000 件まで引き上げることができます。キャンペーンは、終了時刻に達するか削除されるまでアクティブと見なされます。一時停止中のキャンペーンも、指定された終了時刻まではアクティブと見なされます。 ラインアイテムは、キャンペーンで定義された予算を消化します。ラインアイテムは、エンゲージメント単価の入札額、プロモーション対象の Tweet またはアカウント、ターゲティングルールを組み合わせます。

​
アナリティクス

X Ads API には、広告パフォーマンスを追跡・最適化するための一連のアナリティクス用エンドポイントが用意されています。詳細は「Analytics」および「Analytics Best Practices」を参照してください。 請求関連の指標については、イベント発生から最大 3 日間は data が確定しない場合があります。この期間中の data は暫定値として取り扱ってください。最終的な課金対象の数値は、必ず暫定値を下回ります。課金対象の数値は、スパムや関連する低品質トラフィックを考慮して補正されます。時間に関するその他の考慮事項については「Timezones」を参照してください。

​
キャンペーンの作成 - ステップバイステップ

次の例では、twurl を使用してアプリとユーザーのインストール、設定、認可を済ませていることを前提とします。twurl は cURL に近い思想のコマンドラインツールで、X の OAuth 認証を適切に処理します。twurl は Ads API（および REST API）の機能をすばやくテスト・デバッグするのに最適なツールです。リクエストとレスポンスの全ヘッダーを表示するには、-t を使用して呼び出しをトレースします。これは cURL の -v オプションにおおむね相当します。 この例では、キーワードでターゲティングする Promoted Ads キャンペーンを作成します。
  1. アカウントの id を取得します。
twurl -H ads-api.x.com /9/accounts/

{
  "request": {
    "params": {
    }
  },
  "data": [
    {
      "name": "@AdsAPI のテストアカウント",
      "timezone": "America/Los_Angeles",
      "timezone_switch_at": null,
      "id": "xxxxxx",
      "created_at": "2014-03-09T00:41:49Z",
      "salt": "f9f9d5a5f23075c618da5eb1d1a9df57",
      "updated_at": "2015-01-29T00:41:49Z",
      "approval_status": "ACCEPTED",
      "deleted": false
    }
  ],
  "data_type": "account",
  "total_count": 1,
  "next_cursor": null
}
  1. 資金手段のidを取得します。
前のコマンドで取得したアカウントidを使用して、GET accounts/:account_id/funding_instruments APIを呼び出します。 
twurl -H ads-api.x.com /9/accounts/xxxxxx/funding_instruments

{
  "data": [
    {
      "cancelled": true,
      "created_at": "2014-03-09T00:41:49Z",
      "credit_limit_local_micro": null,
      "currency": "USD",
      "deleted": false,
      "description": null,
      "end_time": null,
      "funded_amount_local_micro": null,
      "id": "yyyy",
      "type": null,
      "updated_at": "2014-05-29T00:41:49Z"
    }
  ],
  "data_type": "funding_instrument",
  "next_cursor": null,
  "request": {
    "params": {
      "account_id": "xxxxxx"
    }
  },
  "total_count": 1
}
  1. キャンペーンを作成し、資金手段に関連付けます。
キャンペーンの開始時刻と予算を指定します。本例では、予算を 500、1日あたりの上限を500、1日あたりの上限を 50 とします。 
twurl -H ads-api.x.com -d "funding_instrument_id=yyyy&name=My First Campaign&total_budget_amount_local_micro=500000000&daily_budget_amount_local_micro=50000000" /9/accounts/xxxxxx/campaigns

{
  "data": {
    "created_at": "2015-02-09T00:00:00Z",
    "currency": "USD",
    "daily_budget_amount_local_micro": 50000000,
    "deleted": false,
    "end_time": null,
    "funding_instrument_id": "yyyy",
    "id": "92ph",
    "name": "最初のキャンペーン",
    "entity_status": "PAUSED",
    "standard_delivery": true,
    "total_budget_amount_local_micro": 500000000,
    "updated_at": "2015-02-09T00:00:00Z"
  },
  "data_type": "campaign",
  "request": {
    "params": {
      "account_id": "xxxxxx",
      "daily_budget_amount_local_micro": 50000000,
      "funding_instrument_id": "yyyy",
      "name": "最初のキャンペーン",
      "total_budget_amount_local_micro": 500000000
    }
  }
}
  1. キャンペーンに関連付けられたラインアイテムを作成します。
キャンペーンのidが取得できたので、それに関連付けるラインアイテムを作成できます。ラインアイテムは、入札額、ターゲティング、クリエイティブ（実際の制作物）をまとめたものです。今回のラインアイテムでは、$1.50の入札でTweetをプロモーションします。 
twurl -H ads-api.x.com -d "campaign_id=XXXX&bid_amount_local_micro=1500000&product_type=PROMOTED_TWEETS&placements=ALL_ON_TWITTER&objective=ENGAGEMENTS&entity_status=PAUSED" /9/accounts/xxxxxxx/line_items

{
  "data_type": "line_item",
  "data": {
    "bid_type": "MAX",
    "name": "無題",
    "placements": [
      "ALL_ON_TWITTER"
    ],
    "bid_amount_local_micro": 1500000,
    "automatically_select_bid": false,
    "advertiser_domain": null,
    "primary_web_event_tag": null,
    "charge_by": "ENGAGEMENT",
    "product_type": "PROMOTED_TWEETS",
    "bid_unit": "ENGAGEMENT",
    "total_budget_amount_local_micro": null,
    "objective": "ENGAGEMENTS",
    "id": "azjx",
    "entity_status": "一時停止中",
    "optimization": "DEFAULT",
    "categories": [],
    "currency": "USD",
    "created_at": "2015-02-09T00:00:00Z",
    "updated_at": "2015-02-09T00:00:00Z",
    "include_sentiment": "POSITIVE_ONLY",
    "campaign_id": "92ph",
    "deleted": false
  },
  "request": {
    "params": {
      "placements": [
        "ALL_ON_TWITTER"
      ],
      "bid_amount_local_micro": 1500000,
      "product_type": "PROMOTED_TWEETS",
      "entity_status": "一時停止中",
      "account_id": "xxxxxxx",
      "campaign_id": "92ph"
    }
  }
}
  1. ラインアイテムに関連付けるターゲティングプロファイルを作成します。
ラインアイテムを作成したので、ターゲティング条件を設定します。サンフランシスコ湾岸地域をロケーションとして、フレーズキーワード「grumpy cat」を対象にします。これにはロケーションのidの参照と、targeting_criteriaへのPOSTリクエストを2回実行する必要があります。 
twurl -H ads-api.x.com "/9/targeting_criteria/locations?location_type=CITIES&q=San Francisco"

{
  "data": [
    {
      "name": "San Francisco-Oakland-San Jose CA, US",
      "targeting_type": "LOCATION",
      "targeting_value": "5122804691e5fecc"
    }
  ],
  "data_type": "targeting_criterion",
  "request": {
    "params": {
      "location_type": "CITY",
      "q": "San Francisco"
    }
  }
}

twurl -H ads-api.x.com -X POST -d "line_item_id=yyyy&targeting_type=LOCATION&targeting_value=5122804691e5fecc" /9/accounts/xxxxxx/targeting_criteria

{
  "data": {
    "created_at": "2015-02-09T00:00:15Z",
    "deleted": false,
    "id": "2u3be",
    "line_item_id": "yyyy",
    "name": "サンフランシスコ-オークランド-サンノゼ CA, US",
    "targeting_type": "LOCATION",
    "targeting_value": "5122804691e5fecc",
    "updated_at": "2013-05-30T21:01:35Z"
  },
  "data_type": "targeting_criterion",
  "request": {
    "params": {
      "account_id": "xxxxxx",
      "line_item_id": "yyyy",
      "targeting_type": "LOCATION",
      "targeting_value": "5122804691e5fecc"
    }
  }
}

twurl -H ads-api.x.com -X POST -d "line_item_id=yyyy&targeting_type=PHRASE_KEYWORD&targeting_value=grumpy cat" /9/accounts/xxxxxx/targeting_criteria

{
  "data": {
    "created_at": "2015-02-09T00:00:20Z",
    "deleted": false,
    "id": "2u3bd",
    "line_item_id": "yyyy",
    "name": "grumpy cat",
    "targeting_type": "PHRASE_KEYWORD",
    "targeting_value": "grumpy cat",
    "updated_at": "2013-05-30T18:05:35Z"
  },
  "data_type": "targeting_criterion",
  "request": {
    "params": {
      "account_id": "xxxxxx",
      "line_item_id": "yyyy",
      "targeting_type": "PHRASE_KEYWORD",
      "targeting_value": "grumpy cat"
    }
  }
}
  1. 最後に、ラインアイテムの一時停止を解除します。
twurl -H ads-api.x.com -X PUT "/9/accounts/xxxxxx/line_items/yyyy/?entity_status=ACTIVE"

{
  "data_type": "line_item",
  "data": {
    "bid_type": "MAX",
    "name": "grumpy cat",
    "placements": [],
    "bid_amount_local_micro": 1500000,
    "automatically_select_bid": false,
    "advertiser_domain": null,
    "primary_web_event_tag": null,
    "charge_by": "ENGAGEMENT",
    "product_type": "PROMOTED_TWEETS",
    "bid_unit": "ENGAGEMENT",
    "total_budget_amount_local_micro": null,
    "objective": "ENGAGEMENTS",
    "id": "yyyy",
    "entity_status": "ACTIVE",
    "optimization": "DEFAULT",
    "categories": [],
    "currency": "USD",
    "created_at": "2015-02-09T00:00:20Z",
    "updated_at": "2015-02-09T00:00:20Z",
    "include_sentiment": "POSITIVE_ONLY",
    "campaign_id": "dy1f",
    "deleted": false
  },
  "request": {
    "params": {
      "line_item_id": "yyyy",
      "entity_status": "ACTIVE",
      "account_id": "xxxxxx"
    }
  }
}
以上です。これで、タイムラインで配信される、ターゲティング済みで予算が割り当てられた Promoted Tweets のキャンペーンが稼働中になりました。

​
目的ベースのキャンペーン

目的ベースのキャンペーンと料金設定により、広告主は自社のマーケティング目標に沿ったアクションに対して支払うことができます。これを実現するため、ラインアイテムに適切なobjectiveを設定してください。 ラインアイテムの書き込みエンドポイントで使用され、読み取りエンドポイントで返されるパラメータはobjectiveです。このフィールドは現時点で次の値を取ります。
  • APP_ENGAGEMENTS
  • APP_INSTALLS
  • FOLLOWERS
  • ENGAGEMENTS
  • REACH
  • VIDEO_VIEWS
  • PREROLL_VIEWS
  • WEBSITE_CLICKS
目的は、当社のオークションにおけるキャンペーンの最適化方法およびそのキャンペーンの課金方法に影響します。たとえば、APP_ENGAGEMENTSにはCPAC、APP_INSTALLSにはCPACまたはCPI、WEBSITE_CLICKSにはCPLC、FOLLOWERSにはCPF、ENGAGEMENTSにはCPE、REACHにはCPMといった、目的に基づく料金設定を提供しています。 モバイルアプリプロモーションのキャンペーンには、APP_ENGAGEMENTSまたはAPP_INSTALLSのいずれかの目的が必須です。 注: 異なる目的を持つラインアイテムを同一キャンペーン内に含めることはできません。
キャンペーンの目的APIのobjectiveツイート内のメディア課金モデル
アプリの再エンゲージメントAPP_ENGAGEMENTS画像または動画のアプリダウンロードカードが必須。CPAC
アプリのインストールAPP_INSTALLS画像または動画のアプリダウンロードカードが必須。CPAC または CPI（charge_byで設定）
リーチREACH制限なし。CPM
フォロワー獲得FOLLOWERSツイートは必須ではないが推奨。フォロワーキャンペーンのツイートにメディア制限はありませんが、テキストのみのツイートを推奨します。 詳細CPF
エンゲージメントENGAGEMENTS制限なし。CPE
動画再生数VIDEO_VIEWSVideo Conversation Card、動画、またはGIFが必須。CPV または 3秒/100%視聴あたりのコスト
プレロール再生数PREROLL_VIEWS動画が必須。CPV または 3秒/100%視聴あたりのコスト
ウェブサイトクリックWEBSITE_CLICKSWebsite Cardを推奨（必須ではない）。ツイートにはWebsite Cardまたはウェブサイトリンクのいずれか一方を含める必要があります（両方は不可）。CPLC

​
資金手段

資金手段はキャンペーン予算の原資です。Ads API から新規作成することはできません。利用可能にするには、X の広告主担当アカウントマネージャー（与信枠）または ads.x.com（クレジットカード）で事前に設定されている必要があります。 アカウントのすべての funding_instruments の一覧を取得するには GET accounts/:account_id/funding_instruments、特定の資金手段の詳細については GET accounts/:account_id/funding_instruments/:funding_instrument_id を参照してください。

​
資金提供インストルメントの属性

記述: account_id、資金提供インストルメントの id、資金提供インストルメントの type、description、および io_header（インサーションオーダーのヘッダーID）。1つの io_header が複数の資金提供インストルメントに紐づく場合がある点に注意してください。 資金提供可否: able_to_fund と reasons_not_able_to_fund。 時間: created_at、updated_at、start_time、end_time（文字列で表現。書式は “%Y-%m-%dT%l:%M:%S%z”）。 ブール値ステータス: paused、deleted、cancelled（true または false）。 財務: currency（ISO-4217 形式）、credit_limit_local_micro、credit_remaining_local_micro、funded_amount_local_micro。通貨の値はマイクロ単位で表します。USD の場合、$5.50 は 5.50*1e6、すなわち 5,500,000 としてエンコードされます。「整数値」を表現するには、すべての通貨でローカルマイクロを 1e6（1_000_000）倍してください。

​
属性の詳細

credit_limit_local_micro は CREDIT_CARD または CREDIT_LINE タイプの資金手段にのみ有効で、その手段の与信上限を表します。 funded_amount_local_micro は INSERTION_ORDER タイプの資金手段にのみ有効で、割り当て済みの予算を表します。 credit_remaining_local_micro は CREDIT_LINE および AGENCY_CREDIT_LINE タイプの資金手段に有効です。これは、その資金手段で既に支出された金額を差し引いた後の credit_limit_local_micro を表します。funded_amount_local_micro と支出額との差を表すものではありません。与信上限と拠出額は、広告主との間で定めた資金方法や支出契約の根本が異なるため、区別しています。

​
資金手段の種類

クレジットカード 通常は（アカウントマネージャーがいない）セルフサーブの広告主が利用します。 クレジットライン インサーションオーダー（IO）の形式で提供され、アカウントマネージャーによって設定されます。 マルチハンドル・クレジットライン 広告主は、このタイプのクレジットラインを使用して複数のハンドルにまたがるキャンペーンに資金を充当できます。この機能は X のアカウントマネージャーによって有効化され、複数の @handle を特定のクレジットラインに関連付けます。 例えば、@NikeSB と @NikeFuel の両方が @Nike のクレジットラインにアクセスできます。この資金手段は他と同様に利用可能です。funding_instrument エンドポイントに GET リクエストを送信して data を取得します。以下はサンプルレスポンスです（CREDIT_LINE タイプに注目してください）。 
      GET https://ads-api.x.com/5/accounts/a0b1c3/funding_instruments

{
    "request": {
        "params": {
            "account_id": "a0b1c3"
        }
    },
    "data": [
        {
            "start_time": "2013-05-30T04:00:00Z",
            "description": "FakeNike - 与信枠",
            "credit_limit_local_micro": 150000000000,
            "end_time": null,
            "cancelled": false,
            "id": "i1234",
            "paused": false,
            "account_id": "a0b1c3",
            "reasons_not_able_to_fund": [],
            "io_header": null,
            "currency": "USD",
            "funded_amount_local_micro": 0,
            "created_at": "2013-05-30T18:16:38Z",
            "type": "CREDIT_LINE",
            "able_to_fund": true,
            "updated_at": "2013-05-30T18:16:38Z",
            "credit_remaining_local_micro": 123661919751,
            "deleted": false,
        }
    ],
    "data_type": "funding_instrument",
    "total_count": 1,
    "next_cursor": null
}
この資金手段に関して特筆すべき点は、その種類と、それに関連付けられているすべてのアカウントで利用可能であるという事実だけです。もちろん、残高のクレジットは、この資金手段で資金提供されるすべてのキャンペーンの影響を受け、これを共有するすべてのアカウントにまたがって変動します。特定のクレジットラインにどのアカウントが関連付けられているかの詳細は、API（ads.x.com でも同様）では取得できません。 Funding Instrument の列挙について詳しくは、こちらをご覧ください。

​
ターゲティング

ターゲティングは Ads API の中核となる概念です。ターゲティングはラインアイテム単位で設定され、オプションは掲載面によって異なります。新しいターゲティング条件を設定するには POST accounts/:account_id/targeting_criteria を使用し、更新には PUT accounts/:account_id/targeting_criteria を使用します。 すべてのラインアイテムの一覧には GET accounts/:account_id/line_items、特定のラインアイテムを取得するには GET accounts/:account_id/line_items/:line_item_id を使用します。

​
配置別のターゲティングオプション

Promoted Tweets および Promoted Accounts の各プロダクトは、さまざまな配置で配信できます。Promoted Trends (PTr) は API 経由では利用できません。 利用可能な配置の組み合わせは、GET line_items/placements エンドポイントを参照してください。配置ごとにターゲティングオプションは異なります。ロケーション、プラットフォーム、性別はすべての配置で利用可能です。その他のオプションは配置の種類に応じて異なります。
  • X Search: 年齢ターゲティング、デバイス、イベント、性別、キーワード種別（すべて）、言語、ロケーション、ネットワーク有効化、通信事業者、プラットフォーム、プラットフォームバージョン、テーラードオーディエンス、Wi‑Fi のみ
  • X Timeline: 年齢ターゲティング、デバイス、イベント、フォロワーのフォロワー、フォロワーの類似、性別、興味関心、言語、ロケーション、ネットワーク有効化、通信事業者、部分一致のキーワード種別、パートナーオーディエンス種別、プラットフォーム、プラットフォームバージョン、リターゲティング種別、テーラードオーディエンス、TV ターゲティング種別、Wi‑Fi のみ
  • X Profiles & Tweet Details: 年齢ターゲティング、デバイス、イベント、フォロワーのフォロワー、フォロワーの類似、性別、興味関心、言語、ロケーション、ネットワーク有効化、通信事業者、部分一致のキーワード種別、パートナーオーディエンス種別、プラットフォーム、プラットフォームバージョン、リターゲティング種別、テーラードオーディエンス、TV ターゲティング種別、Wi‑Fi のみ

​
ターゲティングタイプを理解する

年齢ターゲティング: 特定の年齢バケットに基づいてユーザーを対象にします。年齢バケットの列挙値は Enumerations ページを参照してください。 イベント: ターゲティングするイベントを指定します。ターゲティングに使用できるイベントは（ラインアイテムごとに）1つのみです。利用可能なイベントは GET targeting_criteria/events エンドポイントで確認できます。 性別: 男性 (1) または女性 (2) を対象にします。すべてを対象にする場合は null のままにします。 インストール済み App ストアカテゴリ: ユーザーがインストールした、または関心を示したアプリのカテゴリに基づいてターゲティングします。詳しくは GET targeting_criteria/app_store_categories を参照してください。 興味関心: 興味関心でユーザーをターゲティングします。興味関心の一覧は GET targeting_criteria/interests から取得できます。最大 100 件まで指定できます。 Followers Of: 現在のアカウントで完全にプロモーション可能なユーザーのフォロワーを対象にします（注：現時点では、そのアカウントで完全にプロモーション可能なのはプライマリのアカウント保有者のみです）。プロモーション可能なユーザーの一覧は GET accounts/:account_id/promotable_users で取得できます。 Similar to Followers Of: 特定ユーザーのフォロワーと同じ興味関心を持つ人々を対象にします。最大 100 人までの Users を使用できます。 地域: 対象とする地域を最大 2,000 件まで指定します。一覧は GET targeting_criteria/locations から取得します。特定の国を対象とする広告には追加要件があります。詳細は Country Targeting and Display Requirements を参照してください。 キーワード: キーワードターゲティングのオプションは掲載面の種類ごとに異なります。ターゲティングに使用できるキーワードは（ラインアイテムごとに）最大 1,000 個です。詳細は「Keyword Types」セクションを参照してください。 言語ターゲティング: 特定の言語を理解するユーザーを対象にします。 モバイルネットワーク事業者ターゲティング: モバイルキャリアに基づいてユーザーをターゲティングできます。GET targeting_criteria/network_operators のターゲティングタイプ NETWORK_OPERATOR を使用します。 新規モバイルデバイスターゲティング: ユーザーがそのデバイスで初めて X にアクセスした日付に基づいてリーチします。ターゲティングタイプ NETWORK_ACTIVATION_DURATION を使用し、operator_type には「未満」を表す LT と「以上」を表す GTE を指定します。 プラットフォーム、プラットフォームバージョン、デバイス、および WiFi のみ: 多様な軸でモバイルデバイスをターゲティングできます。プラットフォームは高レベルのターゲティングタイプで、広いカテゴリの端末を対象にできます。例: iOS、Android。デバイスでは特定のモバイル端末のユーザーを対象にできます（例: iPhone 5s、Nexus 4、Samsung Galaxy Note）。プラットフォームバージョンでは、特定のモバイル OS のバージョンをポイントリリースまで指定して対象にできます（例: iOS 7.1、Android 4.4）。WiFi のみは、WiFi ネットワークを使用しているユーザーのみに限定します。これを設定しない場合、キャリア回線および WiFi を使用しているユーザーが対象になります。
  • 重複しない限り、プラットフォームとデバイスを同時にターゲティングできます。たとえば、プラットフォームを BlackBerry、デバイスを iPad Air に同時指定できます。
  • デバイスと OS バージョンは同時にターゲティングできます。たとえば、iPad Air と iOS >= 7.0 を同時指定できます。
  • デバイスより広いプラットフォームを同時にターゲティングすることはできません。たとえば、iOS と iPad Air を同時には指定できません。
[Tailored Audiences]/x-ads-api/audiences: 承認済みの広告パートナーを通じて、顧客グループを精確にターゲティングし、X 上でつながることができます。 TV Targeting TV Show Targeting: 特定のテレビ番組に反応・関与している人々にリーチします。キャンペーン実施中は、TV_SHOW ターゲティングタイプで継続的に配信するよう設定できます。利用可能なテレビ番組は、GET targeting_criteria/tv_markets および GET targeting_criteria/tv_shows エンドポイントで確認してください。 Tweet Engager Retargeting Tweet engager retargeting は、広告主が X 上でプロモーションまたはオーガニックの Tweet に以前に露出またはエンゲージしたユーザーを、デバイスをまたいでターゲティングできるようにする機能です。このターゲティングにより、X 上で広告主のコンテンツを見た、またはエンゲージした人々にフォローアップでき、後続のメッセージやオファーでさらなるエンゲージやコンバージョンが見込まれるユーザーにアプローチできます。ユーザーは露出またはエンゲージから数分以内にターゲット対象となり、エンゲージは最大 90 日間、露出は最大 30 日間、対象のままとなります。 Tweet Engager Targeting のタイプ:
  • ENGAGEMENT_TYPE は、ターゲティング値として IMPRESSION または ENGAGEMENT を受け付けます。露出ユーザー（IMPRESSION）を対象にするか、エンゲージしたユーザー（ENGAGEMENT）を対象にするかを指定します。
  • CAMPAIGN_ENGAGEMENT は、ターゲティング値としてキャンペーン ID を使用します。このキャンペーンで（ENGAGEMENT_TYPE に応じて）エンゲージまたは露出したユーザーが対象となります。
  • USER_ENGAGEMENT は、広告主のオーガニックコンテンツに（ENGAGEMENT_TYPE に応じて）露出またはエンゲージしたユーザーを対象にするため、プロモート対象のユーザー ID をターゲティング値として使用します。これは Ads アカウントに関連付けられたプロモート対象のユーザー ID である必要があります。
注: ENGAGEMENT_TYPE は、少なくとも 1 つの有効な CAMPAIGN_ENGAGEMENT または USER_ENGAGEMENT の値と合わせて必須です。両方の tweet engager ターゲティングタイプを併用でき、特定のラインアイテムで複数のキャンペーンを対象にできます。 Video Viewer Targeting: Video viewer targeting は Tweet engager targeting を拡張し、過去に X 上の動画を一部または全部視聴したオーディエンスをターゲティングできるようにします。広告主はオーガニック動画、プロモート動画、またはその両方を対象にできます。プロモート動画は、動画視聴数目的のキャンペーンやラインアイテムに限定されません。 Video Viewer Targeting のタイプ:
  • VIDEO_VIEW: 動画の再生をクリックした、または自動再生で 3 秒視聴したユーザー
  • VIDEO_VIEW_PARTIAL: 動画の 50% を視聴したユーザー
  • VIDEO_VIEW_COMPLETE: 動画の少なくとも 95% を視聴したユーザー
Tweet engager targeting と同様に、ENGAGEMENT_TYPE を使用する場合、ラインアイテムのターゲティング条件に以下のいずれかまたは両方を含める必要があります:
  • CAMPAIGN_ENGAGEMENT は、ターゲティング値としてキャンペーン ID を使用します。このキャンペーンで（ENGAGEMENT_TYPE に基づいて）動画を視聴したユーザーが対象となります。
  • USER_ENGAGEMENT は、広告主のオーガニックコンテンツで（ENGAGEMENT_TYPE に基づいて）動画を視聴したユーザーを対象にするため、プロモート対象のユーザー ID をターゲティング値として使用します。これは Ads アカウントに関連付けられたプロモート対象のユーザー ID である必要があります。
Keyword Types コンセプトの概要は、keyword targeting に関するサポートドキュメントをご覧ください。
  • Broad（デフォルト値）: 単語の順序に関係なく、すべての単語にマッチします。大文字小文字、複数形、時制の違いには影響されません。可能な場合は自動的に拡張されます（例: “car repair” は “automobile fix” にもマッチ）。拡張せずにターゲティングしたい場合は、キーワードの前に + 記号を付けてください（例: “+boat +jet”）。+ を付けないキーワードは Broad Match がデフォルトになります。
  • Unordered（非推奨）: 単語の順序に関係なく、すべての単語にマッチします。大文字小文字、複数形、時制の違いには影響されません。
  • Phrase: 指定のキーワード文字列に一致し、他のキーワードが含まれていても構いません。
  • Exact: 指定のキーワード文字列と完全一致した場合のみマッチします。
  • Negative: クエリ内のどこかにこれらすべてのキーワードが含まれる検索とのマッチを回避します。順序や他の語の有無は問いません。
  • Negative Phrase: クエリ内のどこかにこの正確なキーワード文字列が含まれる検索とのマッチを回避します。他の語が含まれていても構いません。
  • Negative Exact: これらのキーワードと完全一致し、他の語を含まない検索とのマッチを回避します。  
Emoji targeting 絵文字ターゲティングはキーワードターゲティングでサポートされています。絵文字ターゲティングを使用するには、対象の絵文字を表す Unicode コードポイント（例：「喜びの涙」顔の絵文字（😂）の場合は U+1F602、UTF-8 では xF0x9Fx98x82）をキーワードとして作成するだけです。対応している絵文字は twemoji のリストで確認できます。特定の絵文字をターゲティングすると、そのすべてのバリエーションが対象になります。 必須／任意の区別や各値の詳細仕様の概要については、PUT accounts/:account_id/targeting_criteria を参照してください。

​
ターゲティング条件の組み合わせ

キャンペーンのワークフローの更新 地域、性別、言語、デバイス/プラットフォームの条件で広くターゲティングするキャンペーンを作成します。広告主は、その広範なターゲティングに加えて、さらに追加のターゲティング条件（例：興味関心、キーワード、フォロワー、テイラードオーディエンス、TV）を組み合わせることができます。ラインアイテムにターゲティング条件が指定されていない場合、そのラインアイテムは世界中のすべてのユーザーを対象に配信されます。
「プライマリ」タイプその他のタイプ
フォロワーロケーション
テイラードオーディエンス性別
興味関心言語
キーワードデバイスとプラットフォーム
TV年齢
ターゲティング条件は、広告グループに対して次のように組み合わされます：
  • 「プライマリ」ターゲティングタイプは ∪（論理和）で結合されます。
  • その他のターゲティングタイプは AND で結合されます。
  • 同一タイプ内では OR で結合されます。
例 概要： [(フォロワー) ∪ (テイラードオーディエンス) ∪ (興味関心) ∪ (キーワード)] AND (ロケーション) AND (性別) AND (言語) AND (デバイスとプラットフォーム) 地域の例： あるキャンペーンの広告グループで、次のようにターゲティングしたいとします：
  • 米国、イングランド、カナダの X ユーザー（ロケーション）
  • 女性（性別）
  • テイラードオーディエンスのリストに基づく（「プライマリ」）
  • キーワード（「プライマリ」）
ターゲティング条件は次のようになります： [US OR GB OR CA] AND [Female] AND [Tailored Audiences ∪ Keyword]

​
追加例

  • 性別と地域を選択（プライマリなし）：(Male) AND (US OR GB)
  • 性別、地域、興味・関心を選択：(Female) AND (CA) AND (Computers OR Technology OR Startups)
  • 性別、地域、興味・関心、Tailored Audiences、キーワードを選択：(Male) AND (GB) AND (Cars ∪ Tailored Audiences for CRM ∪ autocross)

​
予算ペーシング

広告主は、プロモーション対象のTweetおよびアカウントキャンペーンにおける日次予算の消化スピードを、これまでより柔軟にコントロールできるようになりました。デフォルトの標準配信を有効にすると、1日を通じて均等なペースで予算が消化されます。 標準配信をオフにすると、日次予算を使い切るまで、可能な限り早くインプレッションを配信し、エンゲージメントを獲得します。ターゲティングや競合状況によっては、これは一日のかなり早い時間に発生する可能性があります。これを加速配信と呼びます。 はじめに 標準配信はすべてのキャンペーンでデフォルトのオプションのため、オフにしない限り操作は不要です。キャンペーンの日次予算をできるだけ早く消化したい場合は、ペースを加速配信にするために standard_delivery パラメータを false に設定します（GET accounts/:account_id/campaigns を参照）。 注意事項
  • 「日」は、Xのadvertiser account のタイムゾーン（例: America/Los_Angeles）に基づきます。
  • 初期の結果では、標準配信により、1日を通じたより一貫したカバレッジにより広告主の eCPE/CPF が改善されることが示されています。
予算およびペーシングの詳細については、Bidding and Auctions FAQ を参照してください。

​
目標入札

キャンペーン管理

​
入札戦略

複数のパラメータ組み合わせによる混乱を減らし、キャンペーン作成のワークフローを簡素化するため、「入札戦略」という概念を導入しました。 従来（レガシーと表示）のパラメータ組み合わせは、同等の goal パラメータを設定することで再現できます。詳細はアナウンスのこちらをご確認ください。 例:
キャンペーン目的レガシーAds API v10+
App Installsbid_type = AUTO

bid_unit = APP_INSTALLS

charge_by = APP_CLICKS		goal = APP_INSTALLS

bid_strategy = AUTO
Website Clicksbid_type = TARGET（注：一部のキャンペーン目的では bid_unit は不要でした）bid_strategy = TARGET

​
目標入札

目標入札を使用すると、支払いを希望する目標コストを指定でき、X Ads プラットフォームがその目標コスト付近またはそれ以下を維持しつつ、パフォーマンス最大化に向けてキャンペーンを最適化します。 この機能により、コストを管理しながら、（リンクのクリック、リード、フォローなど）望ましいアクションを起こす可能性が高いユーザーに柔軟にリーチできます。キャンペーンの設定や最適化（入札オプションを含む）に、より多くの選択肢を求める広告主にとって強力な機能です。 互換性のあるキャンペーン目的のラインアイテムに対して、支払いを希望する目標コストを指定できる新しい入札額の価格メカニズムを導入しました。広告プラットフォームは、指定した目標の平均コストを目標の20%以内に抑えるよう努めながら、より多くの成果を得られるよう自動で入札を行います。ラインアイテムの bid_strategy 設定に TARGET を指定することで、次の関連するキャンペーン目的で目標入札を有効にできます。
  • WEBSITE_CLICKS
  • WEBSITE_CONVERSIONS
  • APP_INSTALLS
  • APP_ENGAGEMENTS
  • REACH

​
国別のターゲティングおよび表示要件

キャンペーン管理 国別のターゲティングおよび表示要件はこのページに記載されています。これらの要件は、すべてのパートナーが遵守する必要があります。

​
ロシア

X の広告ポリシーでは、ロシア向けの広告はロシア語であることを広告主に義務付けています。ユーザーが配信対象をロシアに明確に設定する場合、次の警告メッセージを表示する必要があります。 ロシアを対象とする広告は、ロシア語で作成する必要があります。

​
パートナー管理の資金手段

オンボーディングフローでは、X アカウントに紐づく ads.x.com アカウントを設定します。このアカウントはパートナーが Ads API を通じて管理でき、広告費用はパートナーに請求されます。  

​
パートナーの初期セットアップ

新しい PMFI Ads API パートナーの初期セットアップは、必要情報のやり取り開始から最大3週間かかります。プロセスを開始するため、以下を X の技術担当者およびパートナーとの統合を担当する X の窓口に共有してください。
  • パートナーは PGP/GPG の公開鍵を共有する必要があります。 Ads API パートナーと X の間で共有の秘密鍵を交換します。これはオンボーディングのフロー中に data を検証するために使用されます。
  • Ads API へのアクセスに使用する X アプリ の app_id または consumer_secret 。 developer.x.com で X アカウントにログインしている場合は、app dashboard から既存の X アプリを表示・編集できます。新たに X アプリを作成する必要がある場合は、承認済みのdeveloper accountが必要です。X では、本番＋サンドボックス用に1つのアプリと、任意でサンドボックス専用のアプリを1つ許可しています。X アプリは、企業のパートナー管理下にある X ハンドルで作成する必要があります。  

​
広告主のオンボーディングフロー

広告主のオンボーディングフローは、以下のとおりウェブブラウザ上で行われます。
  1. ユーザーはパートナーのウェブサイトでオンボーディングを開始し、オンボードしたいハンドルを入力します。
  2. パートナーは署名付きのペイロードを付与して、ユーザーを ads.x.com 上のURLへリダイレクトします。このペイロードには、パートナーのAPI app_id、オンボード対象のXハンドルに対応するXの user_id、コールバックURL、ならびに以下に記載のその他のfieldsが含まれます。
  3. ユーザーは標準の x.com のログインページを使用して ads.x.com にサインインするよう求められます。
  4. ユーザーがログインすると、オンボーディング処理が開始されます。このステップには、広告審査、アカウントの検証、その他のチェックが含まれます。
  5. すべてのオンボーディング作業が完了すると、成功または失敗を示すペイロードとともに、Ads API パートナーが提供したコールバックURLにユーザーがリダイレクトされます。これには3-legged認可プロセスが含まれます。  

​
オンボーディングのリダイレクトペイロード

リダイレクト用URL: https://ads.x.com/link_managed_account リダイレクトURLは次のパラメータとともに呼び出されます:
名前型説明
callback_urlURLエンコードされた文字列結果に関係なく、アカウント連携プロセスの完了後にユーザーはこのURLへリダイレクトされます。プロトコルの詳細はパートナーリダイレクトURLのセクションを参照してください
client_app_idinteger管理パートナーを識別するために使用される X API クライアントアプリのid
promotable_user_idinteger管理パートナーがプロモーションを管理する対象 @handle の X user_id。ads.x.com にログインして連携を完了するユーザーと同一であることの確認に使用されます
fi_descriptionURLエンコードされた文字列（最大255文字）資金手段名。資金手段を取得した際、APIの説明フィールドに表示されます。funding_instrument の説明が指定された場合、既存の funding_instrument は一時停止され、新しい管理パートナーの資金手段が設定されます（同名のものが既に存在する場合は何も起こりません）
timezone文字列（Area/Location 形式）日次予算の適用日および課金の集計に使用されるタイムゾーン
currencyISO 4217 通貨コード入札入力および請求に使用される通貨
countryISO 3166-1 alpha 2 国コードアカウントの請求先の国
signature以下の説明のとおり、URLエンコードおよびbase64エンコードされたバイナリコード共有シークレットと他のパラメータを組み合わせて、コールの真正性およびパラメータの有効性を検証するための署名

​
コールバックURLのペイロード

ベースとなるリダイレクトURLは、アカウントリンクリクエストの callback_url パラメータ（上記参照）で指定します。ads.x.com により追加されるパラメータは次のとおりです：
名前型説明
statusstringOK アカウントが作成された、または既存の適格なアカウントが見つかりました。

ACCOUNT_INELIGIBLE パートナー固有の要件を満たしていない USER_MISMATCH ads.x.com へのサインインに使用されたXアカウントが、アカウントリンクリクエストの promotable_user_id と異なる INCOMPLETE_SERVING_BILLING_INFO タイムゾーン、通貨、または国が指定されていない INVALID_COUNTRY 無効な国コードが指定された INVALID_CURRENCY 無効な通貨コードが指定された INVALID_TIMEZONE 無効なタイムゾーンが指定された
account_idURL エンコードされた文字列リンクされたアカウントの X 広告アカウント id
funding_instrument_idURL エンコードされた文字列アクティブなパートナー管理の資金管理手段（ファンディングインストゥルメント）のID
signature下記のとおり、URL エンコードおよび base64 エンコードされたバイナリコード共有シークレットと他のパラメータを組み合わせてコールの正当性およびパラメータの有効性を検証する、Base64 エンコードされた HMAC-SHA1 署名。コールバックURLがアカウントリンク処理の対象となる X の user_id に対してのみ有効となるよう、リクエストに署名する際は、共有シークレットに（& を使用して）X の user_id を連結してください。
コールバックURLがアカウントリンク処理の対象となる X の user_id に対してのみ有効となるよう、リクエストに署名する際は、共有シークレットに（& を使用して）X の user_id を連結してください。  

​
リクエストおよびコールバックURLへの署名

/link_managed_account へのリクエストとコールバックURLが正当であることを確保するため、リクエストは送信元で署名し、受信者が処理を行う前に受信側で検証する必要があります。X と管理パートナーの間で共有するシークレットでリクエストに署名することで、両者は認可された相手から送信されたリクエストのみを受け入れられるようになります。 署名生成アルゴリズムは OAuth で使用されるものと類似しています。 次の手順で署名ベース文字列を作成します:
  • HTTPメソッドを大文字に変換し、その値をベース文字列とします。
  • ‘&’ 文字をベース文字列に追加します。
  • URL（パラメータなし）をパーセントエンコードしてベース文字列に追加します。
  • ‘&’ 文字をベース文字列に追加します。
  • 次の手順で構築されるパーセントエンコード済みのクエリ文字列を追加します:
  • 署名対象のすべてのキーと値をパーセントエンコードします。
  • パラメータ一覧をキーでアルファベット順にソートします。
  • 各キー/値の組（およびパートナーのリダイレクトURL用の primary_promotable_user_id）について:
  • パーセントエンコードしたキーをクエリ文字列に追加します。
  • ‘=’ 文字をベース文字列に追加します。
  • パーセントエンコードした値をクエリ文字列に追加します。
  • パーセントエンコードした key=value の組を ‘&’ 文字で区切ります。
  • 事前に交換した共有シークレットをキー、ベース文字列を値として HMAC-SHA1 アルゴリズムで署名を生成します。
  • 前のステップの出力を Base64 エンコードし、末尾の改行文字を削除して、生成した署名をパーセントエンコードし、signature パラメータとして URL に追加します  

​
署名の例

リンクアカウントリクエストへの署名 GET リクエストを想定した署名対象の URL: https://ads.x.com/link_managed_account?callback_url=https%3A%2F%2Fmanagingpartner.com%2Flink_account_callback&client_app_id=12345&fi_description=some%20name&promotable_user_id=1 この URL には次のパラメータが含まれます: callback_url = https://managingpartner.com/link_account_callback client_app_id = 12345 fi_description = some name promotable_user_id = 1 手順 a - d に相当する、パラメータを除いた HTTP メソッドと URL から成るベース文字列は次のとおりです: GET https://ads.x.com/link_managed_account 手順 e のサブステップで生成されるクエリ文字列は次のとおりです: callback_url=https://managingpartner.com/link_account_callback&client_app_id=12345&fi_description=some name&promotable_user_id=1 キーと値のペアはキー名でソートされている点に注意してください。 パーセントエンコードされたクエリ文字列は次のとおりです: callback_url%3Dhttps%253A%252F%252Fmanagingpartner.com%252Flink_account_callback%26client_app_id%3D12345%26fi_description%3Dsome%2520name%26promotable_user_id%3D1 手順 a - d と e を結合した完全なベース文字列: GET https://ads.x.com/link_managed_account&callback_url%3Dhttps%253A%252F%252Fmanagingpartner.com%252Flink_account_callback%26client_app_id%3D12345%26fi_description%3Dsome%2520name%26promotable_user_id%3D1 hmac-sha1 アルゴリズムを使用し、キーとして「secret」という語で署名します。結果は Base64 エンコードされ、末尾の「\n」を除いて示されます（手順 2 および 3）: KBxQMMSpKRrtg9aw3qxK4fTXvUc= この署名は、その後（パーセントエンコードして）元の URL の末尾に signature パラメータとして追加します（手順 4）: https://ads.x.com/link_managed_account?callback_url=https%3A%2F%2Fmanagingpartner.com%2Flink_account_callback&client_app_id=12345&fi_description=some%20name&promotable_user_id=1&signature=KBxQMMSpKRrtg9aw3qxK4fTXvUc%3D パートナーのリダイレクト URL（アカウントリンクリクエストのコールバック）への署名 GET リクエストを想定した署名対象の URL: https://managingpartner.com/link_account_callback?status=OK&account_id=ABC&funding_instrument_id=DEF この URL には次のパラメータが含まれます: account_id = ABC、funding_instrument_id = DEF、status = OK 手順 a - d に相当する、パラメータを除いた HTTP メソッドと URL から成るベース文字列は次のとおりです: GET https%3A%2F%2Fmanagingpartner.com%2Flink_account_callback&“ 手順 e のサブステップで生成されるクエリ文字列は次のとおりです: account_id=ABC&funding_instrument_id=DEF&status=OK パーセントエンコードされたクエリ文字列は次のとおりです: account_id%3DABC%26funding_instrument_id%3DDEF%26status%3DOK 手順 a - d と e を結合した完全なベース文字列: GET https%3A%2F%2Fmanagingpartner.com%2Flink_account_callback&account_id%3DABC%26funding_instrument_id%3DDEF%26status%3DOK hmac-sha1 アルゴリズムを使用し、キーとして「secret」と、元のリンクリクエストが作成された X のユーザー id である 1（上記の promotable_user_id = 1）を組み合わせた「secret&1」で署名します。 結果は Base64 エンコードされ、末尾の「\n」を除いて示されます（手順 2 および 3）: jDSHDkHJIFXpPLVxtA3a9d4bPjM= この署名は、その後（パーセントエンコードのうえ）元のURLの末尾に、signature パラメータとして追加されます（手順 4）: https://managingpartner.com/link_account_callback?&status=OK&account_id=ABC&funding_instrument_id=DEF&signature=jDSHDkHJIFXpPLVxtA3a9d4bPjM%3D

​
共有キーの使用／更新

署名アルゴリズムは、複数のキーに対して反復適用できる必要があります。これにより、複数の共有キーを使用でき、共有キーを定期的にローテーションできます。  

​
partner_managed_funding_instrument の作成

fi_description パラメータが指定され、同名の partner_managed_funding_instrument がアカウント内に存在しない場合は、新しい partner_managed_funding_instrument が作成され、既存のすべての partner_managed_funding_instrument は一時停止されます。 同名の partner_managed_funding_instrument が存在する場合は、新規作成は行われません。  

​
オンボーディングフローの再実行 / トークンのリフレッシュ

API アクセストークンを紛失した場合は、オンボーディングフローを再実行できます。オンボーディングフローの実装では、ユーザーがログインしている必要があります。ユーザーが promotable_user_id と一致し、関連する広告アカウントが見つかり、問題がなければ、ユーザーはコールバック URL にリダイレクトされ、パートナーは OAuth フローを開始してアクセストークンを取得できます。  

​
リダイレクト不能なエラーフロー

アカウントリンクのURLが無効なパラメータで呼び出された場合、OAuth フローで無効または期限切れのパラメータが指定されたときに表示されるページと同様のページがユーザーに表示されます。  

​
PMFI の継続的な更新

広告主のオンボーディングが完了すると、資金調達手段は、それを管理するパートナーのみが PUT accounts/:account_id/funding_instruments/:funding_instrument_id エンドポイントを使用して管理できます。

​
配置

X の広告は、いくつかの場所に表示できます。これは ラインアイテム の placements パラメータで設定します。指定可能な値は次のとおりです:
  • ALL_ON_TWITTER
  • PUBLISHER_NETWORK
  • TWITTER_PROFILE
  • TWITTER_SEARCH
  • TWITTER_TIMELINE
  • SPOTLIGHT
  • TREND
ラインアイテムの product_type と objective によって、許可される配置が決まります。GET line_items/placements エンドポイントを使用すると、各プロダクトタイプで有効な配置オプションを取得できます。 また、以下の表は有効な配置と目的の組み合わせを示します。
ObjectiveALL_ON_TWITTERTWITTER_PROFILETWITTER_SEARCHTWITTER_TIMELINE
APP_ENGAGEMENTS✔✔✔✔
APP_INSTALLS✔✔✔✔
REACH✔✔✔✔
FOLLOWERS✔✔✔✔
ENGAGEMENTS✔✔✔✔
VIDEO_VIEWS✔✔✔✔
PREROLL_VIEWS✔✔✔✔
WEBSITE_CLICKS✔✔✔✔
注記: TWITTER_PROFILE の配置のみを指定することはできません。 注記: TWITTER_SEARCH には キーワードターゲティング が必要です。 注記: REACH の目的には TWITTER_TIMELINE の配置を含める必要があります。ALL_ON_TWITTER、TWITTER_TIMELINE を含む任意の配置の組み合わせ、または TWITTER_TIMELINE 単独のいずれかを指定できます。

​
広告グループに関するFAQ

このドキュメントは、X の Ads API における広告グループに関するよくある質問をまとめたものです。

​
広告グループとは何ですか？

広告グループは、Ads API では line item と呼ばれ、キャンペーンの配下にあり、特定の X ユーザー群に対するターゲティングや入札に用いられます。広告主は、Tweet やメディア（例: In-stream 広告として配信する動画）を line item に関連付けてプロモーションします。

​
広告グループはどのように作成しますか？

広告グループは、同一のキャンペーンIDに対して POST accounts/:account_id/line_items を複数回呼び出し、各ラインアイテムに紐づく（まったく異なる場合もある）ターゲティングやTweetを維持することで作成します。1つのキャンペーンあたりのラインアイテム数は最大100件、1つの広告アカウントあたりの有効なキャンペーン数は最大200件です。すべてのキャンペーンを合算した場合、1つの広告アカウントあたり有効なラインアイテムは最大8,000件までです。

​
なぜ Ad Groups をサポートすべきですか？

Ad Groups は、広告主がキャンペーンを整理・最適化・管理しやすくするための機能です。 Ad Groups の利点は、入札、予算、クリエイティブ、ターゲティングといった要素にまたがる異なる戦略を比較・コントロールできる点にあります。複数の Promoted Tweets を1つのラインアイテムに紐づけると、オークションはまずそのグループ内で最適な Tweet を選び、さらにキャンペーン全体ではすべてのラインアイテムを横断して最適な Tweet を選択します。複数の Ad Groups にそれぞれ単一の Tweet がある場合は、その Ad Group からより高い成果が見込まれる Tweet が実質的に選ばれることになります。 Ad Groups を使うことで、広告主はターゲティングや入札をはるかに多くの組み合わせに分割でき、またターゲティングを論理的なグループに分けて管理できます。 特に Ads API ツールは、Ad Groups を前提に、手動編集ではスケールの大きさゆえに難しいラインアイテムとクリエイティブの組み合わせを対象に、きめ細かな最適化ルールに基づいて構築できます。

​
Ad Groupsキャンペーンにおけるラインアイテムの予算はキャンペーン予算とどのような関係がありますか？

ラインアイテムの total_budget_amount_local_micro は、その親キャンペーンの総予算を超えることはできません。同様に、ラインアイテムの bid_amount_local_micro の値は、親キャンペーンの daily_budget_amount_local_micro または total_budget_amount_local_micro を超えないようにする必要があります。これらの値を不適切に設定すると、キャンペーン全体が一時停止され、配信不可の状態になる可能性があります。 なお、キャンペーンの総予算が、子であるラインアイテムの予算合計を下回る場合があります。ラインアイテム間の予算配分は一部 Ads API ツールに委ねられており、X のリアルタイム性によりターゲティング（ラインアイテム）の日々のパフォーマンスが大きく変動し得るため、効果的な最適化や変更が行われます。

​
Ad Groupは単一のLine Itemよりもパフォーマンスが高いですか？

キャンペーンの成果は多くの要因に左右され、最終的にはTweetがパフォーマンスを決定づける要素となります。Line Itemは、そもそもそのTweetがユーザーへの配信候補に入るかどうかを左右する要素として扱われます。 同じユーザー集合をターゲティングしているLine Itemは、ユーザーが重複していると見なされます。Line Item間のターゲティング重複を減らすことは、最も高い成果を示すユーザー集合を明確に特定しやすくするためのベストプラクティスです。

​
ガイド

​
動画視聴数プレロールの目標

以下のガイドでは、Ads API で PREROLL_VIEWS キャンペーンを設定するために必要な手順を説明します。概ね、これらのキャンペーンは「キュレーテッドカテゴリ」と「コンテンツカテゴリ」（Ads UI では「標準カテゴリ」と表記）という2種類に分類されます。  

​
必要なエンドポイント

​
手順

​
動画をアップロードする

動画のアップロードは次の2ステップで行います：

​
動画メディアをアップロードする

まず、Chunked media upload エンドポイントを使用して、処理のために動画を X にアップロードします。最初の INIT では、このエンドポイントで media_category=amplify_video を指定する必要があります。動画はチャンクに分割してアップロードします。STATUS が state として succeeded を返したら、次の手順に進むことができます。チャンクアップロードエンドポイントを使用したメディアのアップロードの詳細は、Promoted Video の概要を参照してください。

​
動画を広告アカウントに追加する

STATUS コマンドで返される状態が succeeded になったら、そのエンドポイントから返された media_key を使い、POST accounts/:account_id/media_library エンドポイントを用いて広告主のメディアライブラリに動画を追加します。 
POST https://ads-api.x.com/8/55w3kv/media\_library?media\_key=3_931236738554519552

{
 "request": {
   "params": {
     "account_id": "55w3kv",
     "media\_key": "3\_931236738554519552"
   }
 },
 "data": {
   "tweeted": false,
   "name": null,
   "file_name": null,
   "media\_url": "https://video.twimg.com/amplify\_video/1059840836186165250/vid/568x320/Gr2l1fB1X7xotKwC.mp4?tag=8",
   "media\_category": "AMPLIFY\_VIDEO",
   "media\_key": "3\_931236738554519552",
   "created_at": "2017-11-16T19:05:14Z",
   "media\_status": "TRANSCODE\_COMPLETED",
   "media_id": 931236738554519552,
   "media_type": "VIDEO",
   "updated_at": "2017-11-16T19:05:23Z",
   "deleted": false
 }
}

​
キャンペーンを設定

​
キャンペーンの作成

キャンペーンとラインアイテム/広告グループを作成します。ラインアイテムは、objective を VIDEO_VIEWS_PREROLL、product_type を MEDIA に設定して作成してください。さらに、categories パラメータも適切な広告主の業種カテゴリに設定する必要があります。 
POST https://ads-api.x.com/8/accounts/55w3kv/campaigns?name=test-curated-categories-api&funding\_instrument\_id=103hp9&start\_time=2021-02-10&entity\_status=PAUSED&daily\_budget\_amount\_local\_micro=55000000

{
  "request": {
    "params": {
      "name": "test-curated-categories-api",
      "start_time": "2021-02-10T00:00:00Z",
      "daily\_budget\_amount\_local\_micro": 55000000,
      "funding\_instrument\_id": "103hp9",
      "entity_status": "PAUSED",
      "account_id": "55w3kv"
    }
  },
  "data": {
    "name": "test-curated-categories-api",
    "start_time": "2021-02-10T00:00:00Z",
    "reasons\_not\_servable": \[
      "EXPIRED",
      "PAUSED\_BY\_ADVERTISER",
      "FUNDING_PROBLEM"
    \],
    "servable": false,
    "purchase\_order\_number": null,
    "effective_status": "PAUSED",
    "daily\_budget\_amount\_local\_micro": 55000000,
    "end_time": null,
    "funding\_instrument\_id": "103hp9",
    "duration\_in\_days": null,
    "standard_delivery": true,
    "total\_budget\_amount\_local\_micro": null,
    "id": "f2rp3",
    "entity_status": "PAUSED",
    "frequency_cap": null,
    "currency": "USD",
    "created_at": "2021-02-08T23:55:38Z",
    "updated_at": "2021-02-08T23:55:38Z",
    "deleted": false
  }
}

​
Line Item の作成

Line item には、GET content_categories エンドポイントで取得できる、該当する IAB カテゴリのセットを categories パラメータに設定する必要があります。これらのコンテンツカテゴリは、それぞれ 1 つ以上の IAB カテゴリに対応します。 これらの値を使用するには、パートナーは適切なコンテンツカテゴリを選択し、レスポンスで返される iab_categories のセット全体を使用して、line items エンドポイントの categories パラメータを設定する必要があります。iab_categories の一部のみを適用した場合でも、そのグループ全体が当該 line item に設定されます。たとえば、 
GET https://ads-api.x.com/8/advertiser\_business\_categories

{
  "request": {
    "params": {}
  },
  "next_cursor": null,
  "data": \[
    {
      "id": "1jl",
      "name": "消費財",
      "iab_categories": \[
        "IAB9-26",
        "IAB9-18",
        "IAB9-29",
        "IAB9-1",
        "IAB9-8",
        "IAB9-22",
        "IAB6",
        "IAB9-5",
        "IAB9-12",
        "IAB9-11",
        "IAB9-23",
        "IAB9-14",
        "IAB4",
        "IAB9-25",
        "IAB9-17",
        "IAB23",
        "IAB9-24",
        "IAB9-13",
        "IAB16",
        "IAB9-4",
        "IAB9-9",
        "IAB9-20",
        "IAB22",
        "IAB9-28",
        "IAB9-27",
        "IAB9-16",
        "IAB9-31",
        "IAB9-3",
        "IAB9-19",
        "IAB10",
        "IAB9-2",
        "IAB9-6",
        "IAB9-21",
        "IAB9-10",
        "IAB9-15"
      \]
    },
    {
      "id": "1jm",
      "name": "ヘルスケア・医薬品",
      "iab_categories": \[
        "IAB7"
      \]
    },
    {
      "id": "1jn",
      "name": "アルコール",
      "iab_categories": \[
        "IAB8-5",
        "IAB8-18"
      \]
    },
    {
      "id": "1jo",
      "name": "飲食",
      "iab_categories": \[
        "IAB8-10",
        "IAB8-8",
        "IAB8-7",
        "IAB8-15",
        "IAB8-3",
        "IAB8-4",
        "IAB8-1",
        "IAB8-16",
        "IAB8-12",
        "IAB8-13",
        "IAB8-17",
        "IAB8-11",
        "IAB8-6",
        "IAB8-9",
        "IAB8-2",
        "IAB8-14"
      \]
    },
    {
      "id": "1jp",
      "name": "金融サービス",
      "iab_categories": \[
        "IAB3",
        "IAB13",
        "IAB21"
      \]
    },
    {
      "id": "1jq",
      "name": "小売",
      "iab_categories": \[
        "IAB18"
      \]
    },
    {
      "id": "1jr",
      "name": "旅行",
      "iab_categories": \[
        "IAB20"
      \]
    },
    {
      "id": "1js",
      "name": "ゲーム",
      "iab_categories": \[
        "IAB9-30"
      \]
    },
    {
      "id": "1jt",
      "name": "テクノロジー",
      "iab_categories": \[
        "IAB19-22",
        "IAB19-13",
        "IAB19-4",
        "IAB19-33",
        "IAB19-26",
        "IAB19-3",
        "IAB19-16",
        "IAB19-9",
        "IAB19-32",
        "IAB19-25",
        "IAB19-30",
        "IAB19-36",
        "IAB19-21",
        "IAB5",
        "IAB19-12",
        "IAB19-28",
        "IAB19-17",
        "IAB19-8",
        "IAB19-7",
        "IAB19-24",
        "IAB15",
        "IAB19-11",
        "IAB19-31",
        "IAB19-20",
        "IAB19-15",
        "IAB19-1",
        "IAB19-35",
        "IAB19-29",
        "IAB19-34",
        "IAB19-23",
        "IAB19-2",
        "IAB19-5",
        "IAB19-14",
        "IAB19-27",
        "IAB19-10",
        "IAB19-19"
      \]
    },
    {
      "id": "1ju",
      "name": "通信",
      "iab_categories": \[
        "IAB19-6",
        "IAB19-18"
      \]
    },
    {
      "id": "1jv",
      "name": "自動車",
      "iab_categories": \[
        "IAB2"
      \]
    },
    {
      "id": "1jw",
      "name": "メディア・エンターテインメント",
      "iab_categories": \[
        "IAB14-8",
        "IAB14-4",
        "IAB1-5",
        "IAB14-7",
        "IAB1-7",
        "IAB17",
        "IAB14-3",
        "IAB1-1",
        "IAB12",
        "IAB1-6",
        "IAB25-1",
        "IAB1-2",
        "IAB14-2",
        "IAB14-6",
        "IAB1-3",
        "IAB1-4",
        "IAB14-5"
      \]
    },
    {
      "id": "1jx",
      "name": "政治",
      "iab_categories": \[
        "IAB11-4"
      \]
    },
    {
      "id": "1jy",
      "name": "ギャンブル",
      "iab_categories": \[
        "IAB9-7"
      \]
    },
    {
      "id": "1jz",
      "name": "デート",
      "iab_categories": \[
        "IAB14-1"
      \]
    },
    {
      "id": "1k0",
      "name": "非営利団体",
      "iab_categories": \[
        "IAB11-1",
        "IAB11-2",
        "IAB11-3",
        "IAB11-5"
      \]
    }
  \]
}
では、categories パラメータを「Science & Education」に設定するには、iab_categories の全セット、つまり "IAB5", "IAB15" をラインアイテムに次のように設定する必要があります。 
POST https://ads-api.x.com/8/accounts/55w3kv/line\_items?campaign\_id=f2rp3&bid\_amount\_local\_micro=5500000&name=curated-category-line-item&product\_type=MEDIA&placements=ALL\_ON\_TWITTER&objective=PREROLL_VIEWS&categories=IAB3,IAB13,IAB21

{
  "request": {
    "params": {
      "name": "キュレーション済みカテゴリー広告項目",
      "placements": \[
        "ALL\_ON\_TWITTER"
      \],
      "bid\_amount\_local_micro": 5500000,
      "product_type": "MEDIA",
      "objective": "PREROLL_VIEWS",
      "account_id": "55w3kv",
      "categories": \[
        "IAB3",
        "IAB13",
        "IAB21"
      \],
      "campaign_id": "f2rp3"
    }
  },
  "data": {
    "bid_type": "MAX",
    "advertiser\_user\_id": 312226591,
    "name": "キュレーション済みカテゴリー広告項目",
    "placements": \[
      "ALL\_ON\_TWITTER"
    \],
    "start_time": null,
    "bid\_amount\_local_micro": 5500000,
    "automatically\_select\_bid": false,
    "advertiser_domain": null,
    "target\_cpa\_local_micro": null,
    "raw_categories": \[
      "x",
      "5l",
      "9z"
    \],
    "primary\_web\_event_tag": null,
    "charge\_by": "VIEW\_3S_100PCT",
    "product\_type": "PROMOTED\_TWEETS",
    "end_time": null,
    "duration\_in\_days": null,
    "bid\_unit": "VIEW\_3S_100PCT",
    "total\_budget\_amount\_local\_micro": null,
    "objective": "PREROLL_VIEWS",
    "id": "iqwka",
    "entity_status": "ACTIVE",
    "automatic\_tweet\_promotion": null,
    "optimization": "DEFAULT",
    "frequency_cap": null,
    "android\_app\_store_identifier": null,
    "categories": \[
      "IAB3",
      "IAB13",
      "IAB21"
    \],
    "currency": "USD",
    "created_at": "2021-02-09T00:00:46Z",
    "tracking_tags": \[\],
    "ios\_app\_store_identifier": null,
    "amplify_config": {
      "auto_promote": true,
      "is_open": true
    },
    "updated_at": "2021-02-09T00:00:46Z",
    "campaign_id": "f2rp3",
    "creative_source": "MANUAL",
    "deleted": false
  }
}

​
パブリッシャーの選択

広告主は、以下で詳述する内容に基づき、Content Category または Curated Category のいずれかをターゲティングとして選択できます。 注: Line item は Curated または Content のいずれかの Category をターゲットにできますが、両方を同時に設定することはできません。 

​
キュレーテッドカテゴリ

キュレーテッドカテゴリを使用すると、広告主はあらかじめ用意されたパブリッシャーのグループをターゲティングでき、GET curated_categories エンドポイントで取得できます。これらのカテゴリは国別であるため、カテゴリの country_code に基づき、ラインアイテムで該当する国をターゲティングする必要があります。 これらのカテゴリを使用するには、以下の手順を記載の順序で実行する必要があります。
  1. ラインアイテムで、キュレーテッドカテゴリの country_code に基づいて該当する国をターゲティングします
  2. POST line_item_curated_categories エンドポイントを使用して、ラインアイテムを特定の curated_category_id に関連付けます。
注: ラインアイテムをキュレーテッドカテゴリに関連付けると、denylist に追加できるパブリッシャーは最大 5 件に制限されます。特定のパブリッシャーを denylist するために使用される user_id の全リストは、GET publishers エンドポイントから取得できます。さらに、1 つのラインアイテムが同時にターゲティングできるキュレーテッドカテゴリは 1 つまでです。 次の例は、US のみで利用可能なキュレーテッドカテゴリ id: b0xt を、前の手順で作成したラインアイテムに関連付ける方法を示しています。 まず、ラインアイテムのターゲティング条件を値 96683cc9126741d に設定します 
GET https://ads-api.x.com/8/targeting\_criteria/locations?country\_code=US&location_type=COUNTRIES

{
  "data": \[
    {
      "name": "United States",
      "country_code": "US",
      "location_type": "COUNTRIES",
      "targeting_value": "96683cc9126741d1",
      "targeting_type": "LOCATION"
    }
  \],
  "request": {
    "params": {
      "location_type": "COUNTRIES",
      "country_code": "US"
    }
  },
  "next_cursor": null
}

POST https://ads-api.x.com/8/batch/accounts/55w3kv/targeting_criteria
\[
  {
    "operation_type": "Create",
    "params": {
      "line\_item\_id": "iqwka",
      "targeting_type": "LOCATION",
      "targeting_value": "96683cc9126741d1",
      "operator_type": "EQ"
    }
  }
\]

{
  "data": \[
    {
      "line\_item\_id": "iqwka",
      "name": "United States",
      "raw_negated": false,
      "raw\_targeting\_value": "2",
      "id": "rv9hmc",
      "raw\_targeting\_type": "GEO",
      "raw\_operator\_type": "EQUAL_TO",
      "location_type": "COUNTRIES",
      "operator_type": "EQ",
      "created_at": "2021-02-09T00:06:28Z",
      "targeting_value": "96683cc9126741d1",
      "updated_at": "2021-02-09T00:06:28Z",
      "deleted": false,
      "targeting_type": "LOCATION"
    }
  \],
  "request": \[
    {
      "params": {
        "line\_item\_id": "iqwka",
        "account_id": "55w3kv",
        "operator_type": "EQ",
        "targeting_value": "96683cc9126741d1",
        "targeting_type": "LOCATION"
      },
      "operation_type": "Create"
    }
  \]
}

POST https://ads-api.x.com/8/accounts/55w3kv/line\_item\_curated\_categories?line\_item\_id=iqwka&curated\_category_id=9ddrgesiap6o

{
  "request": {
    "params": {
      "curated\_category\_id": "9ddrgesiap6o",
      "line\_item\_id": "iqwka",
      "account_id": "55w3kv"
    }
  },
  "data": {
    "line\_item\_id": "iqwka",
    "curated\_category\_id": "9ddrgesiap6o",
    "id": "xq",
    "created_at": "2021-03-30T17:26:42Z",
    "updated_at": "2021-03-30T17:26:42Z",
    "deleted": false
  }
}

​
コンテンツカテゴリ

コンテンツカテゴリ（Standard Categories とも呼ばれます）は、GET curated_categories エンドポイントから取得できます。これらのカテゴリは、バッチターゲティング基準エンドポイントを使用してラインアイテムでターゲティングできます。次の例は、特定のコンテンツカテゴリ（id: sr、“News & Current Events” に対応）を選択し、ラインアイテムに適用する方法を示しています。
注: GET curated_categories のレスポンスに含まれる iab_categories の全セットは、ターゲティング基準エンドポイント経由でターゲティングする必要があります。これを行わない場合は、検証エラーになります。
GET https://ads-api.x.com/8/content_categories
{
      "name": "ニュース・時事",
      "id": "sr",
      "iab_categories": \[
        "IAB12",
        "IAB14"
      \],
      "publishers\_in\_last\_thirty\_days": 124,
      "videos\_monetized\_in\_last\_thirty_days": 5429
    }
}

POST https://ads-api.x.com/8/batch/accounts/55w3kv/targeting_criteria
\[
  {
    "operation_type": "Create",
    "params": {
      "line\_item\_id": "iqwls",
      "targeting\_type": "IAB\_CATEGORY",
      "targeting_value": "IAB12",
      "operator_type": "EQ"
    }
  },
  {
    "operation_type": "Create",
    "params": {
      "line\_item\_id": "iqwls",
      "targeting\_type": "IAB\_CATEGORY",
      "targeting_value": "IAB14",
      "operator_type": "EQ"
    }
  }
\]

{
  "data": \[
    {
      "line\_item\_id": "iqwls",
      "name": "ニュース",
      "raw_negated": false,
      "raw\_targeting\_value": "5h",
      "id": "saib9p",
      "raw\_targeting\_type": "IAB_CATEGORY",
      "raw\_operator\_type": "EQUAL_TO",
      "operator_type": "EQ",
      "created_at": "2021-03-30T17:35:50Z",
      "targeting_value": "IAB12",
      "updated_at": "2021-03-30T17:35:50Z",
      "deleted": false,
      "targeting\_type": "IAB\_CATEGORY"
    },
    {
      "line\_item\_id": "iqwls",
      "name": "社会",
      "raw_negated": false,
      "raw\_targeting\_value": "5y",
      "id": "saib9q",
      "raw\_targeting\_type": "IAB_CATEGORY",
      "raw\_operator\_type": "EQUAL_TO",
      "operator_type": "EQ",
      "created_at": "2021-03-30T17:35:50Z",
      "targeting_value": "IAB14",
      "updated_at": "2021-03-30T17:35:50Z",
      "deleted": false,
      "targeting\_type": "IAB\_CATEGORY"
    }
  \],
  "request": \[
    {
      "params": {
        "line\_item\_id": "iqwls",
        "account_id": "55w3kv",
        "operator_type": "EQ",
        "targeting_value": "IAB12",
        "targeting\_type": "IAB\_CATEGORY"
      },
      "operation_type": "Create"
    },
    {
      "params": {
        "line\_item\_id": "iqwls",
        "account_id": "55w3kv",
        "operator_type": "EQ",
        "targeting_value": "IAB14",
        "targeting\_type": "IAB\_CATEGORY"
      },
      "operation_type": "Create"
    }
  \]
}
アカウントのメディア（動画）をラインアイテムに関連付ける
POST accounts/:account_id/media_creatives エンドポイントを使用して、動画を広告グループに関連付けます。 
POST https://ads-api.x.com/8/accounts/55w3kv/media_creatives
line\_item\_id=4bii5&account\_media\_id=knb

{
 "data":{
   "account\_media\_id":"74g",
   "approval_status":"ACCEPTED",
   "created_at":"2016-02-11T22:23:23Z",
   "deleted":false,
   "id":"qeq",
   "landing_url":null,
   "line\_item\_id":"4bii5",
   "serving_status":"ACTIVE",
   "updated_at":"2016-02-11T22:23:23Z"
 },
 "request":{
   "params":{
     "line\_item\_id":"4bii5",
     "account\_media\_id":"knb"
   }
 }
}

​
CTA と遷移先 URL を設定する

X の他の多くのキャンペーンと異なり、VIDEO_VIEWS_PREROLL の目的では Promoted Tweets や Cards は使用しません。代わりに、動画クリエイティブは広告グループ（ラインアイテム）に関連付けられ、CTA 情報は preroll_call_to_action エンティティに関連付けられます。POST accounts/:account_id/preroll_call_to_action エンドポイントを使用すると、ボタンの CTA と遷移先 URL を設定できます。 
POST https://ads-api.x.com/8/accounts/55w3kv/preroll\_call\_to_action
line\_item\_id=4bii5&call\_to\_action=VISIT\_SITE&call\_to\_action\_url=https%3A%2F%2Fx.com%2FAdsAPI

{
 "data":{
   "id":"aaa111",
   "line\_item\_id":"4bii5",
   "call\_to\_action":"WATCH_NOW",
   "call\_to\_action_url":"https://x.com/AdsAPI",
   "created_at":"2016-02-11T22:23:23Z",
   "updated_at":"2016-02-11T22:23:23Z",
   "deleted":false
 },
 "request":{
   "params":{
     "line\_item\_id":"4bii5",
     "call\_to\_action":"VISIT_SITE",
     "call\_to\_action_url":"https://x.com/AdsAPI"
   }
 }
}

​
ターゲティング条件を設定する

プレロール動画広告で使用されるターゲティング条件は、一括ターゲティング条件エンドポイント POST batch/accounts/:account_id/targeting_criteria でのみ利用可能です。 広告を特定のユーザーのセットと組み合わせないように除外するには、否定ターゲティングとして CONTENT_PUBLISHER_USER を使用してください。除外するハンドルの X の user_id または publisher_user_id を指定します。 GET publishers エンドポイントを使用すると、コンテンツカテゴリで除外する user_id の一覧を取得できます。GET curated_categories のレスポンスで返される publisher_user_id を使用すると、キュレーテッドカテゴリ向けの同様の除外リストを取得できます。 注: キュレーテッドカテゴリでは最大 5 件の publisher_user_id、コンテンツカテゴリでは最大 50 件の user_id を除外できます。 
POST https://ads-api.x.com/8/batch/accounts/55w3kv/targeting_criteria
\[
  {
    "operation_type": "Create",
    "params": {
      "line\_item\_id": "iqwls",
      "targeting\_type": "CONTENT\_PUBLISHER_ID",
      "targeting_value": "1917731",
      "operator_type": "NE"
    }
  }
\]

{
  "data": \[
    {
      "line\_item\_id": "iqwka",
      "name": "realsaltlake",
      "raw_negated": true,
      "raw\_targeting\_value": "aajwo",
      "id": "sajk32",
      "raw\_targeting\_type": "CONTENT_PUBLISHER",
      "raw\_operator\_type": "EQUAL_TO",
      "operator_type": "NE",
      "created_at": "2021-03-30T18:02:32Z",
      "targeting_value": 17288520,
      "updated_at": "2021-03-30T18:02:32Z",
      "deleted": false,
      "targeting\_type": "CONTENT\_PUBLISHER_USER"
    }
  \],
  "request": \[
    {
      "params": {
        "line\_item\_id": "iqwka",
        "account_id": "55w3kv",
        "operator_type": "NE",
        "targeting_value": "17288520",
        "targeting\_type": "CONTENT\_PUBLISHER_USER"
      },
      "operation_type": "Create"
    }
  \]
}

​
キャンペーンの開始

キャンペーンを開始する準備ができたら、PUT accounts/:account_id/campaigns/:id を使用して一時停止を解除します。 PUT https://ads-api.x.com/8/accounts/55w3kv/campaigns/f2rp3? entity_status=ACTIVE 
{
  "request": {
    "params": {
      "campaign_id": "f2rp3",
      "account_id": "55w3kv"
    }
  },
  "data": {
    "name": "test-curated-categories-api",
    "start_time": "2021-02-10T00:00:00Z",
    "reasons\_not\_servable": \[
    \],
    "servable": false,
    "purchase\_order\_number": null,
    "effective_status": "ACTIVE",
    "daily\_budget\_amount\_local\_micro": 55000000,
    "end_time": null,
    "funding\_instrument\_id": "103hp9",
    "duration\_in\_days": null,
    "standard_delivery": true,
    "total\_budget\_amount\_local\_micro": null,
    "id": "f2rp3",
    "entity_status": "ACTIVE",
    "frequency_cap": null,
    "currency": "USD",
    "created_at": "2021-02-08T23:55:38Z",
    "updated_at": "2021-02-08T23:55:38Z",
    "deleted": false
  }
}

​
アナリティクス

VIDEO_VIEWS_PREROLLキャンペーンのアナリティクスは、当社の stats エンドポイントで確認できます。

​
タイムラインにおけるキーワードターゲティング

キーワードターゲティングは当社の Promoted Tweets 製品の中核機能であり、キャンペーンの到達範囲を拡大します。タイムラインでのキーワードターゲティングにより、プラットフォームはユーザーの直近の Tweet に含まれるキーワードに基づいて X ユーザーをターゲティングできます。たとえば、広告主が順序を問わないキーワードの組み合わせ「plan + trip」をターゲットに設定しており、キャンペーン実施中にユーザーが「I’m starting to plan my trip to Cabo, any suggestions?」と Tweet した場合、そのユーザーには間もなく広告主の Promoted Tweet が表示される可能性があります。

​
どのように動作しますか？

要点: API の観点では、この変更はとても簡単です。タイムラインのプロモーション対象の Tweet でキーワードターゲティングが可能になりました。ラインアイテムでは targeting_type を unordered_keywords または phrase_keywords に設定するだけです。

​
クイックスタートガイド

​
API リファレンス

​
アカウント

​
GET accounts

認証ユーザーがアクセス可能な、広告機能が有効な一部またはすべてのアカウントの詳細を取得します。 Resource URL https://ads-api.x.com/12/accounts Parameters
NameDescription
account_ids
optional		識別子をカンマ区切りで指定して、レスポンスを特定のアカウントIDのみに絞り込みます。

Type: string

Example: 18ce54d4x5t
count
optional		リクエストごとに取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
q
optional		name による絞り込みのための任意のクエリ。

Note: 大文字小文字を区別しない前方一致で照合します。

Type: string

Min, Max length: 1, 255
sort_by
optional		サポートされる属性で昇順または降順に並べ替えます。詳細は Sorting を参照してください。

Type: string

Example: created_at-asc
with_deleted
optional		削除済みの結果をレスポンスに含めます。

Type: boolean

Default: false
Possible values: true, false
with_total_count
optional		レスポンス属性 total_count を含めます。

Note: このパラメータと cursor は同時指定できません。

Note: total_count を含むリクエストはレート制限が低く、現在は15分あたり200件に設定されています。

Type: boolean

Default: false
Possible values: true, false

​
リクエスト例

GET https://ads-api.x.com/12/accounts?account_ids=18ce54d4x5t
レスポンス例 
       {
         "request": {
           "params": {
             "account_ids": [
               "18ce54d4x5t"
             ]
           }
         },
         "next_cursor": null,
         "data": [
           {
             "name": "API McTestface",
             "business_name": null,
             "timezone": "America/Los_Angeles",
             "timezone_switch_at": "2016-07-21T07:00:00Z",
             "id": "18ce54d4x5t",
             "created_at": "2016-07-21T22:42:09Z",
             "updated_at": "2017-07-06T16:51:04Z",
             "business_id": null,
             "approval_status": "ACCEPTED",
             "deleted": false
           }
         ]
       }

​
GET accounts/:account_id

認証ユーザーがアクセス権を持つ特定のアカウントを取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで原則必須のパラメータです。

指定したアカウントは認証ユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
with_deleted
optional		削除済みの結果をレスポンスに含めます。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t Example Response 
       {
         "request": {
           "params": {
             "account_id": "18ce54d4x5t"
           }
         },
         "data": {
           "name": "API McTestface",
           "business_name": null,
           "timezone": "America/Los_Angeles",
           "timezone_switch_at": "2016-07-21T07:00:00Z",
           "id": "18ce54d4x5t",
           "created_at": "2016-07-21T22:42:09Z",
           "updated_at": "2017-07-06T16:51:04Z",
           "industry_type": "TRAVEL",
           "business_id": null,
           "approval_status": "ACCEPTED",
           "deleted": false
         }
       }

​
POST accounts

注記: SANDBOX のみ サンドボックス環境で広告アカウントを作成します。 リソース URL https://ads-api-sandbox.x.com/12/accounts パラメーター なし リクエスト例 POST https://ads-api-sandbox.x.com/12/accounts レスポンス例 
       {
         "request": {
           "params": {}
         },
         "next_cursor": null,
         "data": [
           {
             "name": "サンドボックスアカウント",
             "business_name": null,
             "timezone": "America/Los_Angeles",
             "timezone_switch_at": null,
             "id": "gq12fh",
             "created_at": "2016-07-18T23:02:20Z",
             "updated_at": "2016-07-18T23:02:20Z",
             "business_id": null,
             "approval_status": "ACCEPTED",
             "deleted": false
           }
         ]
       }

​
PUT accounts/:account_id

アカウント名および／または業種タイプを更新します。 Resource URL https://ads-api.x.com/12/accounts/:account_id Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパスに含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。
指定されたアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
name
optional		アカウント名。

Type: string

Example: API McTestface
industry_type
optional		アカウントに関連付けられている業種。

Type: string

Possible values: AGENCY, BUSINESS_TO_BUSINESS, ONLINE_SERVICES, EDUCATION, FINANCIAL, HEALTH, GOVERNMENT, MEDIA, MOBILE, RESTAURANT, RETAIL, TECHNOLOGY, TRAVEL, OTHER
Example Request PUT https://ads-api.x.com/12/accounts/18ce54d4x5t?name='API McTestface 2'&industry_type=TECHNOLOGY Example Response 
       {
         "request": {
           "params": {
             "account_id": "18ce54d4x5t"
             "name"": "API McTestface 2",
             "industry_type": "TECHNOLOGY"
           }
         },
         "data": {
           "name": "API McTestface 2",
           "business_name": null,
           "timezone": "America/Los_Angeles",
           "timezone_switch_at": "2016-07-21T07:00:00Z",
           "id": "18ce54d4x5t",
           "created_at": "2016-07-21T22:42:09Z",
           "updated_at": "2017-07-06T16:51:04Z",
           "industry_type": "TECHNOLOGY",
           "business_id": null,
           "approval_status": "ACCEPTED",
           "deleted": false
         }
       }

​
DELETE accounts/:account_id

注: サンドボックスのみ サンドボックス環境で広告アカウントを削除します。 Resource URL https://ads-api-sandbox.x.com/12/accounts/:account_id Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。

指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
Example Request DELETE https://ads-api-sandbox.x.com/12/accounts/gq12fh Example Response 
       {
         "data": {
           "name": "Sandbox account",
           "timezone": "America/Los_Angeles",
           "timezone_switch_at": null,
           "id": "gq12fh",
           "created_at": "2016-07-18T23:02:20Z",
           "updated_at": "2017-08-23T18:21:10Z",
           "approval_status": "ACCEPTED",
           "deleted": true
         },
         "request": {
           "params": {
             "account_id": "gq12fh"
           }
         }
       }

​
アカウントのアプリ

Postman で実行 ❯

​
GET account_apps

指定した広告アカウントに関連付けられているすべてのモバイルアプリの詳細を取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/account_apps Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパスに含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
count
optional		リクエストごとに取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
sort_by
optional		サポートされる属性で昇順または降順に並べ替えます。詳細は Sorting を参照してください。

Type: string

Example: created_at-asc
with_deleted
optional		削除済みの結果を含めます。

Type: boolean

Default: false
Possible values: true, false
with_total_count
optional		レスポンス属性 total_count を含めます。

Note: このパラメータと cursor は相互排他です。

Note: total_count を含むリクエストはレート制限が低く、現在は15分あたり200件に設定されています。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/account_apps Example Response 
       {
         "request": {
           "params": {
             "account_ids": [
               "18ce54d4x5t"
             ]
           }
         },
         "next_cursor": null,
         "data": [
          {
            "app_store_identifier": "com.twitter.android",
            "conversion_tracking_enabled": false,
            "deep_link_pattern": "twitter://",
            "id": "4x",
            "created_at": "2019-06-20T22:36:16Z",
            "updated_at": "2021-10-19T20:05:29Z",
            "os_type": "Android",
            "deleted": false
          }
         ]
       }

​
アカウント履歴

​
GET accounts/:account_id/account_history

リクエストで指定した entity_id に対して行われた変更の概要を取得します。 注: このエンドポイントは現在ベータ版で、許可リストへの登録が必要です。 Resource URL https://ads-api.x.com/12/accounts/:account_id/account_history Parameters
NameDescription
account_id
required		対象のアカウントの識別子。

Type: string

Example: 18ce54d4x5t
count
optional		リクエストごとに取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
entity_type
required		取得対象のエンティティ種別。

Type: enum

Example: PROMOTED_TWEET
Possible values: CAMPAIGN, LINE_ITEM, PROMOTED_TWEET, TARGETING_CRITERIA, PROMOTED_ACCOUNT
entity_id
required		取得対象のエンティティの識別子。

Type: string

Example: 8u94t
start_time
required		取得するデータの開始時刻（ISO 8601）。

注: 分・秒が 0 の正時で指定する必要があります。

Type: string

Example: 2017-05-19T07:00:00Z
end_time
required		取得するデータの終了時刻（ISO 8601）。

注: 分・秒が 0 の正時で指定する必要があります。

Type: string

Example: 2017-05-26T07:00:00Z
user_id
optional		レスポンスを特定のユーザーに限定します。

Type: long

Example: 3271358660
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/account_history?entity_type=CAMPAIGN&entity_id=fc3h5&count=1 Example Response 
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "entity": "CAMPAIGN",
          "entity_id": "fc3h5",
          "count": 1
        }
      },
      "next_cursor": "1r2407sb4lc",
      "data": [
        {
          "change_by": {
            "user_id": "982978172",
            "platform": "API_OTHER"
          },
          "changes": {},
          "change_time": "2021-04-02T20:55:42Z",
          "entity_id": "fc3h5",
          "entity": "CAMPAIGN",
          "entity_data": {
            "name": "test_campaign",
            "start_time": "2021-04-02T18:59:11Z",
            "purchase_order_number": null,
            "daily_budget_amount_local_micro": 100000000,
            "end_time": null,
            "duration_in_days": null,
            "standard_delivery": true,
            "total_budget_amount_local_micro": 100000000,
            "entity_status": "ACTIVE",
            "frequency_cap": null,
            "created_at": "2021-04-02T20:55:42Z",
            "updated_at": "2021-04-02T20:55:42Z",
            "deleted": false
          },
          "change_type": "CREATE"
        }
      ]
    }

​
広告主の業種カテゴリ

​
GET advertiser_business_categories

パブリッシャー向けに広告主のブランドを説明するため、広告グループ（line_items）で使用可能な広告主ビジネスのcategoriesを取得します。 注: これらのカテゴリは、PREROLL_VIEWSオブジェクティブのline_itemsにのみ適用され、ターゲティング条件で使用されるcontent_categoriesとは別です。 各advertiser_business_categoriesはIAB Categoriesの集合を表します。PREROLL_VIEWSオブジェクティブで広告グループを作成する場合、1つまたは2つのadvertiser_business_categoriesをその広告グループに設定する必要があります。これは、このエンドポイントで提供される対応するiab_categoriesの集合を、line itemエンドポイントのcategoriesリクエストパラメータに設定することで行えます。 詳細はVideo Views Preroll Objective Guideを参照してください。 Resource URL https://ads-api.x.com/12/advertiser_business_categories Parameters リクエストパラメータはありません Example Request GET https://ads-api.x.com/12/advertiser_business_categories Example Response 
{
      "request": {
        "params": {}
      },
      "next_cursor": null,
      "data": [
        {
          "id": "1jl",
          "name": "消費財",
          "iab_categories": [
            "IAB9-26",
            "IAB9-18",
            "IAB9-29",
            "IAB9-1",
            "IAB9-8",
            "IAB9-22",
            "IAB6",
            "IAB9-5",
            "IAB9-12",
            "IAB9-11",
            "IAB9-23",
            "IAB9-14",
            "IAB4",
            "IAB9-25",
            "IAB9-17",
            "IAB23",
            "IAB9-24",
            "IAB9-13",
            "IAB16",
            "IAB9-4",
            "IAB9-9",
            "IAB9-20",
            "IAB22",
            "IAB9-28",
            "IAB9-27",
            "IAB9-16",
            "IAB9-31",
            "IAB9-3",
            "IAB9-19",
            "IAB10",
            "IAB9-2",
            "IAB9-6",
            "IAB9-21",
            "IAB9-10",
            "IAB9-15"
          ]
        },
        {
          "id": "1jm",
          "name": "ヘルスケア・医薬品",
          "iab_categories": [
            "IAB7"
          ]
        },
        {
          "id": "1jn",
          "name": "アルコール",
          "iab_categories": [
            "IAB8-5",
            "IAB8-18"
          ]
        },
        {
          "id": "1jo",
          "name": "飲食",
          "iab_categories": [
            "IAB8-10",
            "IAB8-8",
            "IAB8-7",
            "IAB8-15",
            "IAB8-3",
            "IAB8-4",
            "IAB8-1",
            "IAB8-16",
            "IAB8-12",
            "IAB8-13",
            "IAB8-17",
            "IAB8-11",
            "IAB8-6",
            "IAB8-9",
            "IAB8-2",
            "IAB8-14"
          ]
        },
        {
          "id": "1jp",
          "name": "金融サービス",
          "iab_categories": [
            "IAB3",
            "IAB13",
            "IAB21"
          ]
        },
        {
          "id": "1jq",
          "name": "小売",
          "iab_categories": [
            "IAB18"
          ]
        },
        {
          "id": "1jr",
          "name": "旅行",
          "iab_categories": [
            "IAB20"
          ]
        },
        {
          "id": "1js",
          "name": "ゲーム",
          "iab_categories": [
            "IAB9-30"
          ]
        },
        {
          "id": "1jt",
          "name": "テクノロジー",
          "iab_categories": [
            "IAB19-22",
            "IAB19-13",
            "IAB19-4",
            "IAB19-33",
            "IAB19-26",
            "IAB19-3",
            "IAB19-16",
            "IAB19-9",
            "IAB19-32",
            "IAB19-25",
            "IAB19-30",
            "IAB19-36",
            "IAB19-21",
            "IAB5",
            "IAB19-12",
            "IAB19-28",
            "IAB19-17",
            "IAB19-8",
            "IAB19-7",
            "IAB19-24",
            "IAB15",
            "IAB19-11",
            "IAB19-31",
            "IAB19-20",
            "IAB19-15",
            "IAB19-1",
            "IAB19-35",
            "IAB19-29",
            "IAB19-34",
            "IAB19-23",
            "IAB19-2",
            "IAB19-5",
            "IAB19-14",
            "IAB19-27",
            "IAB19-10",
            "IAB19-19"
          ]
        },
        {
          "id": "1ju",
          "name": "通信",
          "iab_categories": [
            "IAB19-6",
            "IAB19-18"
          ]
        },
        {
          "id": "1jv",
          "name": "自動車",
          "iab_categories": [
            "IAB2"
          ]
        },
        {
          "id": "1jw",
          "name": "メディア・エンターテインメント",
          "iab_categories": [
            "IAB14-8",
            "IAB14-4",
            "IAB1-5",
            "IAB14-7",
            "IAB1-7",
            "IAB17",
            "IAB14-3",
            "IAB1-1",
            "IAB12",
            "IAB1-6",
            "IAB25-1",
            "IAB1-2",
            "IAB14-2",
            "IAB14-6",
            "IAB1-3",
            "IAB1-4",
            "IAB14-5"
          ]
        },
        {
          "id": "1jx",
          "name": "政治",
          "iab_categories": [
            "IAB11-4"
          ]
        },
        {
          "id": "1jy",
          "name": "ギャンブル",
          "iab_categories": [
            "IAB9-7"
          ]
        },
        {
          "id": "1jz",
          "name": "デート・出会い系",
          "iab_categories": [
            "IAB14-1"
          ]
        },
        {
          "id": "1k0",
          "name": "非営利団体",
          "iab_categories": [
            "IAB11-1",
            "IAB11-2",
            "IAB11-3",
            "IAB11-5"
          ]
        }
      ]
    }

​
オーディエンス推定値

POST accounts/:account_id/audience_estimate

​
キャンペーンの推定オーディエンス規模を把握します。

このエンドポイントは、ターゲティング基準オブジェクトのパラメータを含む JSON オブジェクトの配列を受け付けます。必須および任意のターゲティング基準パラメータの一覧は、POST accounts/:account_id/targeting_criteria エンドポイントで確認できます。リクエストは JSON 本文を持つ HTTP POST とし、ヘッダーに Content-Type: application/json を指定する必要があります。 注意: 少なくとも 1 つの主要ターゲティング基準を指定する必要があります。主要ターゲティング基準の一覧はキャンペーンのターゲティングページで確認できます。 Resource URL https://ads-api.x.com/12/accounts/:account_id/audience_estimate Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで通常必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
targeting_criteria
required		ターゲティング基準オブジェクトのすべてのパラメータを含む JSON オブジェクト。必須および任意のターゲティング基準パラメータの一覧は、POST accounts/:account_id/targeting_criteria エンドポイントで確認できます。
operator_type
optional		ターゲティング基準間の関係を指定します。たとえば、除外ターゲティングを設定するには operator_type=NE を使用します。

Type: enum

Possible values: EQ, NE

Default: EQ
Example Request POST https://ads-api.x.com/12/accounts/18ce54d4x5t/audience_estimate 
    {
        "targeting_criteria": [
            {
                "targeting_type": "BROAD_KEYWORD",
                "targeting_value": "nba",
                "operator_type": "EQ"
            },
            {
                "targeting_type": "BROAD_KEYWORD",
                "targeting_value": "tech",
                "operator_type": "NE"
            },
            {
                "targeting_type": "LOCATION",
                "targeting_value": "96683cc9126741d1",
                "operator_type": "EQ"
            },
            {
                "targeting_type": "SIMILAR_TO_FOLLOWERS_OF_USER",
                "targeting_value": "14230524"
            },
            {
                "targeting_type": "SIMILAR_TO_FOLLOWERS_OF_USER",
                "targeting_value": "90420314"
            }
        ]
    }
応答例 
    {
      "request": {
        "params": {
          "targeting_criteria": null,
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "audience_size": {
          "min": 38236294,
          "max": 42261167
        }
      }
    }

​
認証ユーザーアクセス

​
GET accounts/:account_id/authenticated_user_access

指定の広告アカウントに関連して、現在の認証ユーザー（access_token）の権限を取得します。これらの権限は ads.x.com に表示される内容と一致します。 取り得る値は次のとおりです：
  • ACCOUNT_ADMIN: ユーザーの追加・削除や設定変更を含み、キャンペーンの変更と指標の閲覧に対するフルアクセス
  • AD_MANAGER: キャンペーンの変更と指標の閲覧に対するフルアクセス。ただし、ユーザーの追加・削除や設定変更は不可
  • CREATIVE_MANAGER: クリエイティブの編集とプレビューの閲覧が可能。ただし、キャンペーンの作成・変更は不可
  • CAMPAIGN_ANALYST: キャンペーンおよび指標の閲覧が可能。ただし、キャンペーンの作成・変更は不可
  • ANALYST（ads.x.com では「Organic Analyst」）: オーガニック分析およびオーディエンスインサイトの閲覧が可能。ただし、キャンペーンの作成・変更・閲覧は不可
  • PARTNER_AUDIENCE_MANAGER: API 限定でデータパートナーのオーディエンスの閲覧・編集が可能。ただし、キャンペーン、クリエイティブ、その他のオーディエンス種別へのアクセスは不可。
また、TWEET_COMPOSER 権限は、認証ユーザーが広告主に代わって nullcast（「Promoted-only」）の Tweet を作成できることを示します。これは ACCOUNT_ADMIN、AD_MANAGER、または CREATIVE_MANAGER アクセスを持つユーザーにのみ付与されます。 Resource URL https://ads-api.x.com/12/accounts/:account_id/authenticated_user_access Parameters なし Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/authenticated_user_access Example Response 
    {
      "data": {
        "user_id": "2417045708",
        "permissions": [
          "ACCOUNT_ADMIN",
          "TWEET_COMPOSER"
        ]
      },
      "request": {
        "params": {
          "account_id": "18ce54d4x5t"
        }
      }
    }

​
入札ルール

​
GET bidding_rules

一部またはすべての通貨に対する入札ルールを取得します。レスポンスには、CPE（cost-per-engagement、エンゲージメント単価）の最小値および最大値が示されます。 これらの入札ルールは変更頻度が低いものの、少なくとも月に一度は、これらのエンドポイントからシステムを更新することを推奨します。 Resource URL https://ads-api.x.com/12/bidding_rules Parameters
NameDescription
currency
optional		結果をフィルタリングするための通貨タイプ。ISO-4217で識別されます。3文字の文字列（例：「USD」「EUR」）です。すべての入札ルールを取得するには、このパラメータを省略します。

Type: string

Example: USD
Example Request GET https://ads-api.x.com/12/bidding_rules?currency=USD Example Response 
    {
      "request": {
        "params": {
          "currency": "USD"
        }
      },
      "data_type": "bidding_rule",
      "data": [
        {
          "currency": "USD",
          "minimum_cpe_bid_local_micro": 10000,
          "maximum_cpe_bid_local_micro": 1000000000,
          "minimum_denomination": 10000
        }
      ],
      "total_count": 1
    }

​
キャンペーン

​
GET accounts/:account_id/campaigns

現在のアカウントに関連付けられている一部またはすべてのキャンペーンの詳細を取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/campaigns Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
campaign_ids
optional		識別子をカンマ区切りで指定して、レスポンスを目的のキャンペーンのみに絞り込みます。最大 200 個の ID を指定できます。

Type: string

Example: 8wku2
count
optional		リクエストごとに取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
funding_instrument_ids
optional		識別子をカンマ区切りで指定して、特定の資金手段に紐づくキャンペーンのみにレスポンスを絞り込みます。最大 200 個の ID を指定できます。

Type: string

Example: lygyi
q
optional		name でリソースを絞り込むための任意のクエリ。

Type: string

Min, Max length: 1, 255
sort_by
optional		サポートされている属性で昇順または降順にソートします。詳細は Sorting を参照してください。

Type: string

Example: created_at-asc
with_deleted
optional		削除済みの結果を含めます。

Type: boolean

Default: false
Possible values: true, false
with_draft
optional		下書きキャンペーンの結果を含めます。

Type: boolean

Default: false
Possible values: true, false
with_total_count
optional		レスポンス属性 total_count を含めます。

Note: このパラメータと cursor は排他的です。

Note: total_count を含むリクエストはレート制限が低く、現在は 15 分あたり 200 に設定されています。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns?campaign_ids=8wku2 Example Response 
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "campaign_ids": [
            "8wku2"
          ]
        }
      },
      "next_cursor": null,
      "data": [
        {
          "name": "test",
          "budget_optimization": "CAMPAIGN",
          "reasons_not_servable": [
            "PAUSED_BY_ADVERTISER",
            "INCOMPLETE"
          ],
          "servable": false,
          "purchase_order_number": null,
          "effective_status": "UNKNOWN",
          "daily_budget_amount_local_micro": 10000000,
          "funding_instrument_id": "lygyi",
          "duration_in_days": null,
          "standard_delivery": false,
          "total_budget_amount_local_micro": null,
          "id": "8wku2",
          "entity_status": "PAUSED",
          "frequency_cap": null,
          "currency": "USD",
          "created_at": "2022-06-03T21:38:07Z",
          "updated_at": "2022-06-03T21:38:07Z",
          "deleted": false
        }
      ]
    }

​
GET accounts/:account_id/campaigns/:campaign_id

現在のアカウントに紐づく特定のキャンペーンを取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/campaigns/:campaign_id Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
campaign_id
required		リクエストで操作対象となるキャンペーンを指す識別子。

Type: string

Example: 8wku2
with_deleted
optional		削除済みの結果を含めるかどうか。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns/8wku2 Example Response 
    {
      "request": {
        "params": {
          "campaign_id": "8wku2",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "name": "test",
        "budget_optimization": "CAMPAIGN",
        "reasons_not_servable": [
          "PAUSED_BY_ADVERTISER",
          "INCOMPLETE"
        ],
        "servable": false,
        "purchase_order_number": null,
        "effective_status": "UNKNOWN",
        "daily_budget_amount_local_micro": 10000000,
        "funding_instrument_id": "lygyi",
        "duration_in_days": null,
        "standard_delivery": false,
        "total_budget_amount_local_micro": null,
        "id": "8wku2",
        "entity_status": "PAUSED",
        "frequency_cap": null,
        "currency": "USD",
        "created_at": "2022-06-03T21:38:07Z",
        "updated_at": "2022-06-03T21:38:07Z",
        "deleted": false
      }
    }

​
POST accounts/:account_id/campaigns

現在のアカウントに紐づく新しいキャンペーンを作成します。 注: 1アカウントあたりの有効なキャンペーン数の既定上限は200です。ただし、無効なキャンペーン数には制限がありません。この上限は有効なキャンペーン8,000件まで引き上げ可能です。上限引き上げを有効化するには、広告主が担当のXアカウントマネージャーに申請する必要があります。 Resource URL https://ads-api.x.com/12/accounts/:account_id/campaigns Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで原則必須です。指定するアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
funding_instrument_id
required		このキャンペーンを紐づける資金管理手段の識別子。

Type: string

Example: lygyi
name
required		キャンペーン名。最大255文字。

Type: string

Example: demo
budget_optimization
optional		適用する予算最適化の種類を選択します。

Type: enum

Default: CAMPAIGN
Possible values: CAMPAIGN, LINE_ITEM
daily_budget_amount_local_micro
sometimes required		キャンペーンに割り当てる1日あたりの予算額。指定した資金管理手段の通貨が使用されます。USDの場合、$5.50 は 5500000 で表されます。

注: total_budget_amount_local_micro 以下である必要があり、ほとんどの資金管理手段の種類で必須です。

Type: long

Example: 5500000
entity_status
optional		キャンペーンのステータス。

Type: enum

Default: ACTIVE
Possible values: ACTIVE, DRAFT, PAUSED
purchase_order_number
optional		予約参照番号。請求書照合のために使用します。最大50文字。

Type: string

Example: D00805843
standard_delivery
optional		標準配信または加速配信を有効化します。標準配信と加速配信の詳細は Budget Pacing を参照してください。budget_optimization が CAMPAIGN の場合にのみ利用可能です。

Type: boolean

Default: true
Possible values: true, false
total_budget_amount_local_micro
optional		キャンペーンに割り当てる合計予算額。指定した資金管理手段の通貨が使用されます。USDの場合、$37.50 は 37500000 で表されます。

Type: long

Example: 37500000
Example Request POST https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns?funding_instrument_id=lygyi&name=demo&daily_budget_amount_local_micro=140000000&entity_status=PAUSED&budget_optimization=CAMPIAGN&standard_delivery=false Example Response 
    {
      "request": {
        "params": {
          "name": "demo",
          "budget_optimization": "CAMPAIGN",
          "daily_budget_amount_local_micro": 140000000,
          "funding_instrument_id": "lygyi",
          "standard_delivery": false,
          "entity_status": "PAUSED",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "name": "demo",
        "budget_optimization": "CAMPAIGN",
        "reasons_not_servable": [
          "PAUSED_BY_ADVERTISER",
          "INCOMPLETE"
        ],
        "servable": false,
        "purchase_order_number": null,
        "effective_status": "UNKNOWN",
        "daily_budget_amount_local_micro": 140000000,
        "funding_instrument_id": "lygyi",
        "duration_in_days": null,
        "standard_delivery": false,
        "total_budget_amount_local_micro": null,
        "id": "hwtbm",
        "entity_status": "PAUSED",
        "frequency_cap": null,
        "currency": "USD",
        "created_at": "2022-06-03T21:38:07Z",
        "updated_at": "2022-06-03T21:38:07Z",
        "deleted": false
      }
    }

​
POST batch/accounts/:account_id/campaigns

1 回のリクエストで新規のキャンペーンをバッチ作成できます。 バッチリクエスト
  • 現在の最大バッチサイズは 40 です。
  • すべてのパラメータはリクエストボディで送信され、Content-Type は application/json が必須です。
  • バッチリクエストはグループとして一括で成功または失敗し、エラー・成功いずれの場合も、API レスポンスでは初回リクエストのアイテム順序が保持されます。
バッチレスポンス バッチ API レスポンスは順序付きのアイテムコレクションを返します。その他の点は、対応する単一アイテムのエンドポイントと構造が同一です。 バッチエラー
  • リクエストレベルのエラー（例: 最大バッチサイズ超過）は、レスポンス内の errors オブジェクトに表示されます。
  • アイテムレベルのエラー（例: 必須のキャンペーンパラメータの不足）は、レスポンス内の operation_errors オブジェクトに表示されます。
リソース URL https://ads-api.x.com/12/batch/accounts/:account_id/campaigns パラメータ
NameDescription
operation_type
required		アイテムごとに実行される操作タイプ。

Type: enum

Possible values: Create, Delete, Update
params
required		キャンペーンオブジェクトのすべてのパラメータを含む JSON オブジェクト。必須・任意のキャンペーンパラメータ一覧はこちらを参照してください。
リクエスト例 POST 'Content-Type: application/json' https://ads-api.x.com/12/batch/accounts/18ce54d4x5t/campaigns 
    [
      {
        "operation_type":"Create",
        "params":{
          "name":"batch campaigns",
          "funding_instrument_id":"lygyi",
          "daily_budget_amount_local_micro":140000000,
          "entity_status":"PAUSED",
          "budget_optimization":"CAMPAIGN"
        }
      }
    ]
応答例 
    {
      "data": [
        {
          "name": "batch campaigns",
          "budget_optimization": "CAMPAIGN",
          "reasons_not_servable": [
            "PAUSED_BY_ADVERTISER",
            "INCOMPLETE"
          ],
          "servable": false,
          "purchase_order_number": null,
          "effective_status": "UNKNOWN",
          "daily_budget_amount_local_micro": 140000000,
          "funding_instrument_id": "lygyi",
          "duration_in_days": null,
          "standard_delivery": false,
          "total_budget_amount_local_micro": null,
          "id": "8yn7m",
          "entity_status": "PAUSED",
          "frequency_cap": null,
          "currency": "USD",
          "created_at": "2022-06-03T21:38:07Z",
          "updated_at": "2022-06-03T21:38:07Z",
          "deleted": false
        }
      ],
      "request": [
        {
          "params": {
            "name": "batch campaigns",
            "funding_instrument_id": "lygyi",
            "daily_budget_amount_local_micro": 140000000,
            "entity_status": "PAUSED",
            "budget_optimization":"CAMPAIGN",
            "account_id": "18ce54d4x5t"
          },
          "operation_type": "Create"
        }
      ]
    }

​
PUT accounts/:account_id/campaigns/:campaign_id

現在のアカウントに関連付けられている指定のキャンペーンを更新します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/campaigns/:campaign_id Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパスに含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定されたアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
campaign_id
required		リクエストで操作するキャンペーンの参照。

Type: string

Example: 8wku2
budget_optimization
optional		適用する予算最適化のタイプを選択します。

Type: enum

Default: CAMPAIGN
Possible values: CAMPAIGN, LINE_ITEM
daily_budget_amount_local_micro
optional		キャンペーンに割り当てる1日あたりの予算額。指定された資金手段に紐づく通貨が使用されます。USD の場合、$5.50 は 5500000 で表されます。未指定の場合、キャンペーンは合計予算およびフライト期間に基づいて均等に消化されます。

Note: total_budget_amount_local_micro 以下である必要があります。

Type: long

Example: 5500000
entity_status
optional		キャンペーンのステータス。

Type: enum

Possible values: ACTIVE, PAUSED
name
optional		キャンペーン名。最大長: 255 文字。

Type: string

Example: demo
purchase_order_number
optional		予約参照番号。請求書の照合作業に役立てるため、このフィールドを使用します。最大長: 50 文字。

Type: string

Example: D00805843
standard_delivery
optional		標準配信または高速配信を有効にします。両者の詳細は Budget Pacing を参照してください。budget_optimization が CAMPAIGN に設定されている場合にのみ利用可能です。

Type: boolean

Default: true
Possible values: true, false
total_budget_amount_local_micro
optional		キャンペーンに割り当てる合計予算額。指定された資金手段に紐づく通貨が使用されます。USD の場合、$37.50 は 37500000 で表されます。

Type: long

Example: 140000000
Example Request PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns/8wku2?total_budget_amount_local_micro=140000000 Example Response 
    {
      "request": {
        "params": {
          "campaign_id": "8wku2",
          "daily_budget_amount_local_micro": 140000000,
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "name": "test",
        "budget_optimization": "CAMPAIGN",
        "reasons_not_servable": [
          "PAUSED_BY_ADVERTISER",
          "INCOMPLETE"
        ],
        "servable": false,
        "purchase_order_number": null,
        "effective_status": "UNKNOWN",
        "daily_budget_amount_local_micro": 140000000,
        "funding_instrument_id": "lygyi",
        "duration_in_days": null,
        "standard_delivery": false,
        "total_budget_amount_local_micro": null,
        "id": "8wku2",
        "entity_status": "PAUSED",
        "frequency_cap": null,
        "currency": "USD",
        "created_at": "2022-06-03T21:38:07Z",
        "updated_at": "2022-06-03T21:53:54Z",
        "deleted": false
      }
    }

​
DELETE accounts/:account_id/campaigns/:campaign_id

現在のアカウントに属する指定のキャンペーンを削除します。 注意: キャンペーンの削除は元に戻せません。以後、このリソースを削除しようとすると HTTP 404 が返されます。 Resource URL https://ads-api.x.com/12/accounts/:account_id/campaigns/:campaign_id Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
campaign_id
required		リクエストで操作対象となるキャンペーンの参照。

Type: string

Example: 8yn7m
Example Request DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns/8yn7m Example Response 
    {
      "request": {
        "params": {
          "campaign_id": "8yn7m",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "name": "test",
        "budget_optimization": "CAMPAIGN",
        "reasons_not_servable": [],
        "servable": null,
        "purchase_order_number": null,
        "effective_status": "RUNNING",
        "daily_budget_amount_local_micro": 140000000,
        "funding_instrument_id": "lygyi",
        "duration_in_days": null,
        "standard_delivery": false,
        "total_budget_amount_local_micro": null,
        "id": "8yn7m",
        "entity_status": "PAUSED",
        "frequency_cap": null,
        "currency": "USD",
        "created_at": "2022-06-03T21:38:07Z",
        "updated_at": "2022-06-03T21:56:35Z",
        "deleted": true
      }
    }

​
コンテンツのカテゴリ

​
GET content_categories

ラインアイテムのtargeting_criteriaとして設定可能な有効なコンテンツのcategoriesをリクエストします。 各content_categoryは、1つ以上のIAB Categoriesに対応付けられます。これは、バッチtargeting_criteriaエンドポイントでtargeting_typeをIAB_CATEGORYに設定し、content_categoriesリクエストで返される対応するiab_categoriesのセットを含めることで行えます。これを行わない場合、検証エラーが発生します。 これらの各コンテンツカテゴリーに関するパブリッシャーの詳細は、GET publishersエンドポイントで取得できます。 詳細はVideo Views Pre-roll Objective Guideを参照してください。 Resource URL https://ads-api.x.com/12/content_categories Parameters リクエストパラメータなし Example Request GET https://ads-api.x.com/12/content_categories Example Response 
{
      "request": {
        "params": {}
      },
      "next_cursor": null,
      "data": [
        {
          "name": "自動車（乗用車、トラック、レーシング）",
          "id": "ru",
          "iab_categories": [
            "IAB2"
          ],
          "publishers_in_last_thirty_days": 12,
          "videos_monetized_in_last_thirty_days": 316
        },
        {
          "name": "コメディ",
          "id": "sk",
          "iab_categories": [
            "IAB1-4"
          ],
          "publishers_in_last_thirty_days": 19,
          "videos_monetized_in_last_thirty_days": 174
        },
        {
          "name": "デジタルクリエイター",
          "id": "sl",
          "iab_categories": [
            "IAB25-1"
          ],
          "publishers_in_last_thirty_days": 110,
          "videos_monetized_in_last_thirty_days": 1257
        },
        {
          "name": "エンターテインメント&ポップカルチャー",
          "id": "sm",
          "iab_categories": [
            "IAB1-1",
            "IAB1-2",
            "IAB1-3",
            "IAB1-5"
          ],
          "publishers_in_last_thirty_days": 120,
          "videos_monetized_in_last_thirty_days": 3482
        },
        {
          "name": "金融&ビジネスニュース",
          "id": "sn",
          "iab_categories": [
            "IAB3",
            "IAB13",
            "IAB21"
          ],
          "publishers_in_last_thirty_days": 29,
          "videos_monetized_in_last_thirty_days": 1461
        },
        {
          "name": "フード&ドリンク",
          "id": "so",
          "iab_categories": [
            "IAB8-8",
            "IAB8-12",
            "IAB8-17",
            "IAB8-2",
            "IAB8-3",
            "IAB8-7",
            "IAB8-11",
            "IAB8-4",
            "IAB8-14",
            "IAB8-10",
            "IAB8-15",
            "IAB8-13",
            "IAB8-9",
            "IAB8-16",
            "IAB8-6",
            "IAB8-1"
          ],
          "publishers_in_last_thirty_days": 24,
          "videos_monetized_in_last_thirty_days": 516
        },
        {
          "name": "ライフスタイル（ファッション、トラベル、ウェルネス）",
          "id": "sp",
          "iab_categories": [
            "IAB16",
            "IAB9-21",
            "IAB9-4",
            "IAB9-25",
            "IAB9-8",
            "IAB4",
            "IAB9-3",
            "IAB9-15",
            "IAB7",
            "IAB6",
            "IAB9-11",
            "IAB9-16",
            "IAB9-7",
            "IAB9-20",
            "IAB9-24",
            "IAB9-17",
            "IAB9-12",
            "IAB9-31",
            "IAB9-27",
            "IAB10",
            "IAB9-10",
            "IAB9-23",
            "IAB9-6",
            "IAB9-18",
            "IAB9-13",
            "IAB9-1",
            "IAB9-28",
            "IAB20",
            "IAB9-5",
            "IAB9-26",
            "IAB22",
            "IAB23",
            "IAB9-9",
            "IAB9-22",
            "IAB18",
            "IAB9-2",
            "IAB9-19",
            "IAB9-14",
            "IAB9-29"
          ],
          "publishers_in_last_thirty_days": 67,
          "videos_monetized_in_last_thirty_days": 2412
        },
        {
          "name": "音楽",
          "id": "sq",
          "iab_categories": [
            "IAB1-6"
          ],
          "publishers_in_last_thirty_days": 31,
          "videos_monetized_in_last_thirty_days": 518
        },
        {
          "name": "ニュース&時事",
          "id": "sr",
          "iab_categories": [
            "IAB12",
            "IAB14"
          ],
          "publishers_in_last_thirty_days": 125,
          "videos_monetized_in_last_thirty_days": 5507
        },
        {
          "name": "政治",
          "id": "s4",
          "iab_categories": [
            "IAB11"
          ],
          "publishers_in_last_thirty_days": 19,
          "videos_monetized_in_last_thirty_days": 1402
        },
        {
          "name": "科学&教育",
          "id": "ss",
          "iab_categories": [
            "IAB5",
            "IAB15"
          ],
          "publishers_in_last_thirty_days": 7,
          "videos_monetized_in_last_thirty_days": 132
        },
        {
          "name": "スポーツ",
          "id": "se",
          "iab_categories": [
            "IAB17"
          ],
          "publishers_in_last_thirty_days": 403,
          "videos_monetized_in_last_thirty_days": 18281
        },
        {
          "name": "テクノロジー",
          "id": "sg",
          "iab_categories": [
            "IAB19"
          ],
          "publishers_in_last_thirty_days": 13,
          "videos_monetized_in_last_thirty_days": 1089
        },
        {
          "name": "テレビ",
          "id": "sh",
          "iab_categories": [
            "IAB1-7"
          ],
          "publishers_in_last_thirty_days": 58,
          "videos_monetized_in_last_thirty_days": 1307
        },
        {
          "name": "eスポーツ&ビデオゲーム",
          "id": "s0",
          "iab_categories": [
            "IAB9-30"
          ],
          "publishers_in_last_thirty_days": 109,
          "videos_monetized_in_last_thirty_days": 1844
        }
      ],
      "total_count": 15
    }

​
厳選されたカテゴリ

​
GET accounts/:account_id/curated_categories

指定したcountry_codesに対して利用可能なCurated Categoriesの一覧を取得します。 各curated_categoryは、レスポンス内のcountry_codesで示される特定の国でのみ利用可能です。 詳細はVideo Views Pre-roll Objective Guideをご参照ください。 Resource URL https://ads-api.x.com/12/accounts/:account_id/curated_categories Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accountsを除くすべてのAdvertiser APIリクエストで一般的に必須のパラメータです。指定されたアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
country_codes
required		カンマ区切りの2文字のISO国コードのリストを指定して、レスポンスを該当する国に限定します。最大200件まで指定できます。

Type: string

Example: US
cursor
optional		次ページの結果を取得するためのカーソル。詳細はPaginationをご覧ください。

Type: string

Example: 8x7v00oow
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/curated_categories?country_codes=US Example Response 
{
      "request": {
        "params": {
          "country_codes": [
            "US"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "name": "Basketball",
          "description": "大学チーム、プロチーム、シーズン中・オフシーズンのバスケットボール動画を配信するトップスポーツメディアアカウントなど、日々の優れたバスケットボールコンテンツの横に広告を配信します。",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "20265254",
            "378174762",
            "900368808",
            "18939563",
            "18371803",
            "18360370",
            "770658432928079872",
            "11026952",
            "37085464",
            "16212685",
            "57422635",
            "281669945",
            "7117962",
            "23065057",
            "41688179",
            "29779226",
            "900280416",
            "364460082",
            "902030382",
            "19409270",
            "19077044",
            "18139461",
            "14992591",
            "66753565",
            "667563",
            "16727749",
            "40941404",
            "18481113",
            "791598918",
            "16201775",
            "15900167",
            "45891626",
            "191894553",
            "2181233851",
            "34352904",
            "171483987",
            "454122399",
            "57415242",
            "19263978",
            "902089998",
            "423540866",
            "2715223320",
            "22185437",
            "17292143",
            "55590247",
            "66757066",
            "22642626",
            "41604618",
            "87275465",
            "22643259",
            "32414973",
            "73406718",
            "20346956",
            "413422891",
            "45412765",
            "19537303",
            "459511725",
            "30954864",
            "21308488",
            "18552281",
            "19924520",
            "24903350",
            "851142163",
            "26270913",
            "20444254",
            "26074296",
            "6395222",
            "15537451",
            "28672101",
            "38053254",
            "24925573",
            "19564719",
            "18164425",
            "22815383",
            "20196159"
          ],
          "id": "929wbl6ymlfk",
          "created_at": "2019-11-08T21:12:47Z",
          "updated_at": "2021-03-09T20:36:44Z",
          "videos_monetized_in_last_thirty_days": 2446
        },
        {
          "name": "Gaming Personalities",
          "description": "オンラインゲーム界で最大級かつ最も人気のあるデジタルクリエイターのリストから厳選された、日々の優れたゲームコンテンツの横に広告を配信します。",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "90779436",
            "268270621",
            "567167802",
            "246596682",
            "474919140",
            "284422688",
            "185909682",
            "4767225325",
            "2559865245",
            "186888760",
            "161418822",
            "141021153",
            "352881953",
            "1117931702",
            "146556805",
            "357294577",
            "234526497",
            "266687361",
            "214201922",
            "9451052",
            "2163885564",
            "2231422037",
            "116952434",
            "399909209",
            "15993650",
            "974356091193741312",
            "210839744",
            "2313002094",
            "159916388",
            "3258981481",
            "231992478",
            "182236262",
            "386884916",
            "22705686",
            "4140881832",
            "995979576",
            "2244953047",
            "311775629",
            "98821255",
            "2733210014",
            "2741078150"
          ],
          "id": "94ngssfrr01x",
          "created_at": "2019-12-02T20:45:12Z",
          "updated_at": "2021-03-09T20:18:13Z",
          "videos_monetized_in_last_thirty_days": 448
        },
        {
          "name": "Baseball",
          "description": "大学チーム、プロチーム、主要な野球報道を配信するトップスポーツメディアアカウントなど、日々の優れた野球コンテンツの横に広告を配信します。",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "22016177",
            "22798877",
            "52803520",
            "20710218",
            "423532170",
            "28603812",
            "41144996",
            "22819823",
            "39389304",
            "252273678",
            "123307490",
            "2319354187",
            "41488578",
            "37947138",
            "302066953",
            "159143990",
            "35006336",
            "53178109",
            "40918816",
            "39682297",
            "39397148",
            "39419180",
            "53197137",
            "52863923",
            "21407926",
            "31164229",
            "19607400",
            "39392910",
            "241544156",
            "43024351",
            "37837907",
            "165764237",
            "69117905",
            "87673496",
            "23043294",
            "52824038",
            "52861612",
            "33137450",
            "30008146",
            "39367703",
            "21436663",
            "188575356",
            "40931019",
            "41468683",
            "40927173",
            "172742915"
          ],
          "id": "9lav5usxfmdc",
          "created_at": "2020-05-18T20:20:27Z",
          "updated_at": "2021-03-09T20:37:46Z",
          "videos_monetized_in_last_thirty_days": 190
        },
        {
          "name": "Esports Teams",
          "description": "世界最高のeスポーツチームによる、イベント中の報道と年間を通じた関連コンテンツの両方をカバーするプログラムの横に広告を配信します。",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "759527448757215232",
            "61933836",
            "477213534",
            "907193396049182720",
            "895382891408089089",
            "862708050116976640",
            "115038550",
            "3182089458",
            "4131266472",
            "1145702070961496065",
            "2262070855",
            "920664872786059264",
            "1035653581683220481",
            "14229141",
            "1101275970995027968",
            "20734751",
            "1452520626",
            "720303639277928448",
            "2853641871",
            "912696400571486208",
            "874362688939413504",
            "286505380",
            "892808605170245632",
            "875087838613733376",
            "238431491",
            "867053221940011014",
            "964529942",
            "1172506293174710272",
            "535756639",
            "2255226817",
            "1100825469853696000",
            "1122713320086220803",
            "1124064709295128581",
            "899858978418642944",
            "864977592532688896",
            "864476897106898944",
            "862770685445361665",
            "257268592"
          ],
          "id": "9ys3jz3ktreo",
          "created_at": "2020-10-01T20:02:35Z",
          "updated_at": "2021-03-09T20:36:20Z",
          "videos_monetized_in_last_thirty_days": 169
        },
        {
          "name": "Football ",
          "description": "大学チーム、プロチーム、シーズン中・オフシーズンのフットボール動画を配信するトップスポーツメディアアカウントなど、日々の優れたフットボールコンテンツの横に広告を配信します。",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "21790466",
            "53103297",
            "23642374",
            "817416193854283776",
            "43403778",
            "24179879",
            "26813914",
            "36375662",
            "33587536",
            "180884045",
            "16332223",
            "27902825",
            "180503626",
            "44468807",
            "18336787",
            "818431566",
            "22146282",
            "31126587",
            "40358743",
            "35865630",
            "16347506",
            "72665816",
            "33583496",
            "389038362",
            "36155311",
            "227342532",
            "2151130166",
            "26791995",
            "44666348",
            "24109979",
            "31504542",
            "713143",
            "423536031",
            "25545388",
            "59471027",
            "706923475",
            "19383279",
            "8824902",
            "1655877529",
            "18734310",
            "240734425",
            "17076218",
            "47964412",
            "2802184770",
            "19426729",
            "56443153",
            "23508439",
            "25084916",
            "764347046",
            "19853312",
            "348590880"
          ],
          "id": "8tujg1lvi8sn",
          "created_at": "2019-08-15T20:48:51Z",
          "updated_at": "2021-03-09T20:34:13Z",
          "videos_monetized_in_last_thirty_days": 254
        },
        {
          "name": "Men's Culture + Lifestyle",
          "description": "フォロワープロフィールに基づいてキュレーションされたハンドルのコンテンツの横に広告を配信し、テクノロジー、ニュース、ライフスタイルコンテンツを共有するトップハンドルを含む、男性が大多数を占めるオーディエンスにリーチします。",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "17764377",
            "61933836",
            "28370738",
            "3224616765",
            "22819823",
            "18927441",
            "734826612684783616",
            "14372486",
            "7157132",
            "15764136",
            "590316679",
            "7302282",
            "895014043932540928",
            "7517222",
            "3489420013",
            "14063426",
            "72665816",
            "214201922",
            "14980903",
            "22199141",
            "21272440",
            "25319414",
            "119593082",
            "4760694445",
            "765905855195803648",
            "238431491",
            "22178780",
            "241544156",
            "25093616",
            "16877611",
            "22146985",
            "368703433",
            "14342661",
            "415605847",
            "2181233851",
            "890891",
            "15764001",
            "614754689",
            "18479513",
            "23508439",
            "348590880"
          ],
          "id": "8tujj1ep7t34",
          "created_at": "2019-08-15T20:49:47Z",
          "updated_at": "2021-03-09T20:39:00Z",
          "videos_monetized_in_last_thirty_days": 1330
        },
        {
          "name": "Women's Culture + Lifestyle",
          "description": "フォロワープロフィールに基づいてキュレーションされたハンドルのコンテンツの横に広告を配信し、ポップカルチャー、ニュース、ライフスタイルコンテンツを共有するトップハンドルを含む、女性が大多数を占めるオーディエンスにリーチします。",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "23482952",
            "20177423",
            "19074134",
            "15566901",
            "32469566",
            "19784831",
            "16145224",
            "16932962",
            "14934818",
            "29730065",
            "24190981",
            "30278532",
            "15846407",
            "24994219",
            "23993734",
            "40965341",
            "16312576",
            "75094638",
            "549673665",
            "18806753",
            "75306892",
            "1482663290",
            "31181674",
            "971407531972186112",
            "4020532937",
            "25087685",
            "22515362",
            "80943051",
            "19247844",
            "15279429",
            "16824090",
            "20710809",
            "979831113655996416",
            "32432308",
            "19472585",
            "25589776",
            "739963476370673665",
            "20188834",
            "926269727663673349"
          ],
          "id": "8tujl1p3yn0g",
          "created_at": "2019-08-15T20:50:24Z",
          "updated_at": "2021-03-09T20:17:53Z",
          "videos_monetized_in_last_thirty_days": 1365
        },
        {
          "name": "Light-Hearted",
          "description": "Xで一貫してポジティブで心温まるコンテンツと会話を多く生み出してきたハンドルのリストの横に広告を配信します。",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "20177423",
            "22449367",
            "9695312",
            "19074134",
            "4805771380",
            "32469566",
            "1212860112047460352",
            "16402507",
            "16932962",
            "14934818",
            "17446621",
            "29730065",
            "15846407",
            "1604444052",
            "180066380",
            "16312576",
            "549673665",
            "18806753",
            "16211434",
            "545336345",
            "971407531972186112",
            "4020532937",
            "833612154",
            "22515362",
            "20710809",
            "32432308",
            "774311630",
            "3073349892",
            "926269727663673349"
          ],
          "id": "9fg8gmz96qdg",
          "created_at": "2020-03-20T19:37:44Z",
          "updated_at": "2021-03-09T19:57:40Z",
          "videos_monetized_in_last_thirty_days": 1395
        },
        {
          "name": "Soccer",
          "description": "大学チーム、プロチーム、主要なサッカー報道を共有するトップスポーツメディアハンドルを含む、日常的なサッカーコンテンツの最高峰の横に広告を配信します。",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "21677316",
            "20636347",
            "4704552148",
            "14573900",
            "22556296",
            "1415791555",
            "107146095",
            "17288520",
            "213474069",
            "17493398",
            "44990136",
            "452155423",
            "17744542",
            "16303450",
            "2841146601",
            "2413176055",
            "29739264",
            "38580532",
            "953476292913106945",
            "27092557",
            "86356439",
            "34613288",
            "3170659367",
            "119593082",
            "73412535",
            "627586654",
            "15891449",
            "23011345",
            "96951800",
            "15997022",
            "16960789",
            "21919642",
            "102965285",
            "17224076",
            "36432200",
            "1410055968"
          ],
          "id": "9ddrgesiap6o",
          "created_at": "2020-02-28T22:43:26Z",
          "updated_at": "2021-01-26T17:54:55Z",
          "videos_monetized_in_last_thirty_days": 421
        }
      ],
      "total_count": 9
    }

​
GET accounts/:account_id/curated_categories/:curated_category_id

特定の curated_category_id の詳細を取得します 各 curated_category は、レスポンス内の country_codes で指定される特定の国でのみ利用できます。 リソース URL https://ads-api.x.com/12/accounts/:account_id/curated_categories/:curated_category_id パラメータ
NameDescription
account_id
必須		対象となるアカウントの識別子。リソースのパスに含まれ、GET accounts を除くすべての Advertiser API リクエストで通常必須のパラメータです。指定されたアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
curated_category_id
必須		このリクエストで操作する Curated Category を参照する ID。

Type: string

Example: 9ddrgesiap6o
リクエスト例 GET https://ads-api.x.com/12/accounts/18ce54d4x5t/curated_categories/9ddrgesiap6o レスポンス例 
    {
      "request": {
        "params": {
          "id": "9ddrgesiap6o",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "name": "サッカー",
        "description": "大学チーム、プロチーム、主要なサッカー報道を配信するトップスポーツメディアアカウントを含む、日々の優れたサッカーコンテンツと並んで配信されます。",
        "country_codes": [],
        "publisher_user_ids": [
          "21677316",
          "20636347",
          "4704552148",
          "14573900",
          "22556296",
          "1415791555",
          "107146095",
          "17288520",
          "213474069",
          "17493398",
          "44990136",
          "452155423",
          "17744542",
          "16303450",
          "2841146601",
          "2413176055",
          "29739264",
          "38580532",
          "953476292913106945",
          "27092557",
          "86356439",
          "34613288",
          "3170659367",
          "119593082",
          "73412535",
          "627586654",
          "15891449",
          "23011345",
          "96951800",
          "15997022",
          "16960789",
          "21919642",
          "102965285",
          "17224076",
          "36432200",
          "1410055968"
        ],
        "id": "9ddrgesiap6o",
        "created_at": "2020-02-28T22:43:26Z",
        "updated_at": "2021-01-26T17:54:55Z",
        "videos_monetized_in_last_thirty_days": 421
      }
    }

​
機能

​
GET accounts/:account_id/features

この広告アカウントで利用可能な付与済み機能の一覧を取得します。機能は説明的な機能キーで示され、ベータ版またはその他の限定リリースとして導入され、かつ Ads API で利用可能な場合にのみ、このエンドポイントで公開されます。この条件に該当しない機能は、このエンドポイントでは公開されません。 注: このエンドポイントは、ベータ版リリースへのクライアントアクセスの可視性を高めることで Ads API エコシステムの開発を支援するものです。API 開発者が広告主に代わって機能へのアクセスを申請することはできません。これらの申請は、広告主本人が自身の X アカウントマネージャーにのみ行うことができます。 Resource URL https://ads-api.x.com/12/accounts/:account_id/features Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパスに含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定されたアカウントは、認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
feature_keys
optional		特定の機能キーで照会できるオプションのパラメータ。リクエストには複数のキーをカンマ区切りで含めることができます。

注: このアカウントでアクセス可能な機能のみがレスポンスに含まれます。

Type: enum

Possible values: REACH_AND_FREQUENCY_ANALYTICS, REACH_FREQUENCY_CAP, WEBSITE_CLICKS_CPM_BILLING
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/features Example Response 
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t"
        }
      },
      "data": [
        "CITY_TARGETING",
        "CONVERSATION_CARD",
        "PROMOTED_MEDIA_POLLS",
        "REACH_AND_FREQUENCY_ANALYTICS",
        "REACH_FREQUENCY_CAP",
        "UNIVERSAL_LOOKALIKE"
      ]
    }

​
POST accounts/:account_id/features

SANDBOX限定 サンドボックスアカウントに機能を追加します。 最新のアカウント機能一覧は、GET accounts/:account_id/features エンドポイントから取得できます。 Resource URL https://ads-api-sandbox.x.com/12/accounts/:account_id/features Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで原則必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: gq180y
feature_keys
required		アカウントに追加するアカウント機能のカンマ区切りリスト。

Type: enum

Possible values: AGE_TARGETING, ALLOW_SKIPPABLE_VIDEOS_FOR_PREROLL_VIEWS_OBJECTIVE, AWARENESS_OBJECTIVE, BRAND_TPN, CHARGE_FOR_GOOD_CLICK, CONVERSATION_CARD, CONVERSATION_CARD_FOUR_OPTIONS, CONVERSATION_CARD_UNLOCK, CPI_CHARGING, DIRECT_MESSAGE_CARD, DR_TAP, ENGAGER_RETARGETING, EVENT_TARGETING, INSTALLED_APP_CATEGORY_TARGETING, MOBILE_CONVERSION_TRANSACTION_VALUE, OPTIMIZED_ACTION_BIDDING, REACH_AND_FREQUENCY_ANALYTICS, REACH_FREQUENCY_CAP, VALIDATED_AGE_TARGETING, VIDEO_VIEWS_MIDROLL_OBJECTIVE, PREROLL_VIEWS_OBJECTIVE, VIDEO_APP_DOWNLOAD_CARD
Example Request POST https://ads-api-sandbox.x.com/12/accounts/gq180y/features?feature_keys=VALIDATED_AGE_TARGETING Example Response 
    {
      "request": {
        "params": {
          "account_id": "gq180y",
          "feature_keys": [
            "VALIDATED_AGE_TARGETING"
          ]
        }
      },
      "data": [
        "ALLOW_SKIPPABLE_VIDEOS_FOR_PREROLL_VIEWS_OBJECTIVE",
        "AWARENESS_OBJECTIVE",
        "CPI_CHARGING",
        "EVENT_TARGETING",
        "INSTALLED_APP_CATEGORY_TARGETING",
        "MOBILE_CONVERSION_TRANSACTION_VALUE",
        "OPTIMIZED_ACTION_BIDDING",
        "VALIDATED_AGE_TARGETING",
        "VIDEO_APP_DOWNLOAD_CARD"
      ]
    }

​
DELETE accounts/:account_id/features

SANDBOX のみ サンドボックスアカウントから機能を削除します。 最新のアカウント機能一覧は、GET accounts/:account_id/features エンドポイントで取得できます。 Resource URL https://ads-api-sandbox.x.com/12/accounts/:account_id/features Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで原則必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: gq180y
feature_keys
required		アカウントから削除するアカウント機能をカンマ区切りで指定します。

Type: enum

Possible values: AGE_TARGETING, ALLOW_SKIPPABLE_VIDEOS_FOR_PREROLL_VIEWS_OBJECTIVE, AWARENESS_OBJECTIVE, BRAND_TPN, CHARGE_FOR_GOOD_CLICK, CONVERSATION_CARD, CONVERSATION_CARD_FOUR_OPTIONS, CONVERSATION_CARD_UNLOCK, CPI_CHARGING, DIRECT_MESSAGE_CARD, DR_TAP, ENGAGER_RETARGETING, EVENT_TARGETING, INSTALLED_APP_CATEGORY_TARGETING, MOBILE_CONVERSION_TRANSACTION_VALUE, OPTIMIZED_ACTION_BIDDING, REACH_AND_FREQUENCY_ANALYTICS, REACH_FREQUENCY_CAP, VALIDATED_AGE_TARGETING, VIDEO_VIEWS_MIDROLL_OBJECTIVE, PREROLL_VIEWS_OBJECTIVE, VIDEO_APP_DOWNLOAD_CARD
Example Request DELETE https://ads-api-sandbox.x.com/12/accounts/gq180y/features?feature_keys=PREROLL_VIEWS_OBJECTIVE Example Response 
    {
      "request": {
        "params": {
          "account_id": "gq180y",
          "feature_keys": [
            "PREROLL_VIEWS_OBJECTIVE"
          ]
        }
      },
      "data": [
        "CPI_CHARGING",
        "EVENT_TARGETING",
        "INSTALLED_APP_CATEGORY_TARGETING",
        "MOBILE_CONVERSION_TRANSACTION_VALUE",
        "OPTIMIZED_ACTION_BIDDING",
        "VIDEO_APP_DOWNLOAD_CARD"
      ]
    }

​
資金手段

​
GET accounts/:account_id/funding_instruments

現在のアカウントに関連付けられている一部またはすべての資金手段の詳細を取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/funding_instruments Parameters
NameDescription
account_id
required		レバレッジドアカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
count
optional		リクエストごとに取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
funding_instrument_ids
optional		目的の資金手段のみにレスポンスを絞り込むため、カンマ区切りの識別子リストを指定します。最大 200 個の ID を指定できます。

Type: string

Example: lygyi
sort_by
optional		サポートされている属性で昇順または降順に並べ替えます。詳細は Sorting を参照してください。

Type: string

Example: created_at-asc
with_deleted
optional		削除済みの結果を含めます。

Type: boolean

Default: false
Possible values: true, false
with_total_count
optional		レスポンス属性 total_count を含めます。

Note: このパラメータと cursor は相互排他です。

Note: total_count を含むリクエストはレート制限が低く、現在は 15 分あたり 200 に設定されています。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/funding_instruments Example Response 
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "start_time": "2016-07-22T04:24:04Z",
          "description": "下4桁が0650のVisa",
          "credit_limit_local_micro": 200000000,
          "end_time": null,
          "id": "lygyi",
          "entity_status": "ACTIVE",
          "account_id": "18ce54d4x5t",
          "reasons_not_able_to_fund": [],
          "io_header": null,
          "currency": "USD",
          "funded_amount_local_micro": 645940000,
          "created_at": "2016-07-22T04:24:04Z",
          "type": "CREDIT_CARD",
          "able_to_fund": true,
          "updated_at": "2017-04-05T00:25:13Z",
          "credit_remaining_local_micro": null,
          "deleted": false
        }
      ]
    }

​
GET accounts/:account_id/funding_instruments/:funding_instrument_id

現在のアカウントに関連付けられている特定の資金手段を取得します。 リソース URL https://ads-api.x.com/12/accounts/:account_id/funding_instruments/:id パラメータ
NameDescription
account_id
必須		レバレッジドアカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
funding_instrument_id
必須		リクエストで操作対象となる資金手段を参照します。

Type: string

Example: lygyi
with_deleted
任意		削除済みの結果を含めます。

Type: boolean

Default: false
Possible values: true, false
リクエスト例 GET https://ads-api.x.com/12/accounts/18ce54d4x5t/funding_instruments/lygyi レスポンス例 
    {
      "request": {
        "params": {
          "funding_instrument_id": "lygyi",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "start_time": "2016-07-22T04:24:04Z",
        "description": "Visa（下4桁0650）",
        "credit_limit_local_micro": 200000000,
        "end_time": null,
        "id": "lygyi",
        "entity_status": "ACTIVE",
        "account_id": "18ce54d4x5t",
        "reasons_not_able_to_fund": [],
        "io_header": null,
        "currency": "USD",
        "funded_amount_local_micro": 645940000,
        "created_at": "2016-07-22T04:24:04Z",
        "type": "CREDIT_CARD",
        "able_to_fund": true,
        "updated_at": "2017-04-05T00:25:13Z",
        "credit_remaining_local_micro": null,
        "deleted": false
      }
    }

​
POST accounts/:account_id/funding_instruments

SANDBOX のみ サンドボックス環境で資金手段を作成します。 サンドボックスの資金手段を使用しても費用が発生することはありません。 Resource URL https://ads-api-sandbox.x.com/12/accounts/:account_id/funding_instruments Parameters
NameDescription
account_id
required		レバレッジアカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定されたアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: gq1844
currency
required		通貨（ISO-4217 で表現）。

Type: string

Example: USD
start_time
required		資金手段が有効化され使用可能になる日時（ISO 8601 で表現）。

Type: string

Example: 2017-05-19T07:00:00Z
type
required		作成する資金手段の種類。

Type: enum

Possible values: AGENCY_CREDIT_LINE, CREDIT_CARD, CREDIT_LINE, INSERTION_ORDER, PARTNER_MANAGED
end_time
sometimes required		資金手段が無効化される日時（ISO 8601 で表現）。

Type: string

Example: 2017-05-26T07:00:00Z
credit_limit_local_micro
optional		この資金手段に対して利用可能な総与信額。

Note: 一部の資金手段タイプにのみ適用されます。

Type: long

Example: 37500000
funded_amount_local_micro
optional		この資金手段に割り当てられた総予算額。

Note: 一部の資金手段タイプにのみ適用されます。

Type: long

Example: 37500000
Example Request POST https://ads-api-sandbox.x.com/12/accounts/gq1844/funding_instruments?currency=USD&start_time=2017-07-10T00:00:00Z&type=INSERTION_ORDER&end_time=2018-01-10T00:00:00Z&funded_amount_local_micro=140000000000 Example Response 
    {
      "data": {
        "start_time": "2017-07-10T00:00:00Z",
        "description": "(お支払い方法が未設定です)",
        "credit_limit_local_micro": null,
        "end_time": "2018-01-10T00:00:00Z",
        "id": "hxtet",
        "entity_status": "ACTIVE",
        "account_id": "gq1844",
        "reasons_not_able_to_fund": [],
        "io_header": null,
        "currency": "USD",
        "funded_amount_local_micro": 140000000000,
        "created_at": "2017-09-09T05:23:28Z",
        "type": "INSERTION_ORDER",
        "able_to_fund": true,
        "updated_at": "2017-09-09T05:23:28Z",
        "credit_remaining_local_micro": null,
        "deleted": false
      },
      "request": {
        "params": {
          "start_time": "2017-07-10T00:00:00Z",
          "end_time": "2018-01-10T00:00:00Z",
          "account_id": "gq1844",
          "currency": "USD",
          "funded_amount_local_micro": 140000000000,
          "type": "INSERTION_ORDER"
        }
      }
    }

​
DELETE accounts/:account_id/funding_instruments/:funding_instrument_id

SANDBOX 限定 サンドボックス環境で資金手段を削除します。 リソース URL https://ads-api-sandbox.x.com/12/accounts/:account_id/funding_instruments/:funding_instrument_id パラメータ
NameDescription
account_id
必須		レバレッジアカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: gq1844
funding_instrument_id
必須		リクエストで操作対象となる資金手段を参照します。

Type: string

Example: hxt82
リクエスト例 DELETE https://ads-api-sandbox.x.com/12/accounts/gq1844/funding_instruments/hxt82 レスポンス例 
    {
      "data": {
        "start_time": "2017-08-30T19:23:47Z",
        "description": "(お支払い方法が未設定です)",
        "credit_limit_local_micro": 500000000,
        "end_time": null,
        "id": "hxt82",
        "entity_status": "ACTIVE",
        "account_id": "gq1844",
        "reasons_not_able_to_fund": [
          "DELETED"
        ],
        "io_header": null,
        "currency": "USD",
        "funded_amount_local_micro": null,
        "created_at": "2017-08-30T19:23:47Z",
        "type": "CREDIT_CARD",
        "able_to_fund": false,
        "updated_at": "2017-09-09T02:08:30Z",
        "credit_remaining_local_micro": null,
        "deleted": true
      },
      "request": {
        "params": {
          "funding_instrument_id": "hxt82",
          "account_id": "gq1844"
        }
      }
    }

​
IAB カテゴリ

​
GET iab_categories

広告グループ（line_items）向けの有効なアプリのcategoriesを取得します。 リソースURL https://ads-api.x.com/12/iab_categories パラメータ
名前説明
count
任意		リクエストごとに取得するレコード数を指定します。

型: int

デフォルト: 200
最小/最大: 1 / 1000
cursor
任意		次ページのカテゴリを取得するためのカーソルを指定します。詳細はページネーションをご覧ください。

型: string

例: gc-ddf4a
with_total_count
任意		レスポンス属性total_countを含めます。

注: このパラメータとcursorは排他です。

注: total_countを含むリクエストはレート制限が低く、現在は15分あたり200に設定されています。

型: boolean

デフォルト: false
指定可能な値: true, false
リクエスト例 GET https://ads-api.x.com/12/iab_categories?count=2 レスポンス例 
    {
      "data": [
        {
          "id": "IAB1",
          "parent_id": null,
          "name": "アート&エンターテインメント"
        },
        {
          "id": "IAB1-1",
          "parent_id": "IAB1",
          "name": "書籍&文学"
        }
      ],
      "next_cursor": "uxa8",
      "request": {
        "params": {
          "count": 2
        }
      }
    }

​
明細行

​
GET accounts/:account_id/line_items

現在のアカウントに関連付けられた一部またはすべてのラインアイテムの詳細を取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/line_items Parameters
NameDescription
account_id
required		利用するアカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで通常必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
campaign_ids
optional		識別子のカンマ区切りリストを指定して、特定のキャンペーン配下のラインアイテムのみに結果を絞り込みます。最大 200 個の ID を指定できます。

Type: string

Example: 8gdx6
count
optional		リクエストごとに取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
funding_instrument_ids
optional		識別子のカンマ区切りリストを指定して、特定の資金管理手段（funding instrument）配下のラインアイテムのみに結果を絞り込みます。最大 200 個の ID を指定できます。

Type: string

Example: lygyi
line_item_ids
optional		識別子のカンマ区切りリストを指定して、対象のラインアイテムのみに結果を絞り込みます。最大 200 個の ID を指定できます。

Type: string

Example: 8v7jo
q
optional		name による絞り込みに使用する任意のクエリ。

Type: string

Min, Max length: 1, 255
sort_by
optional		サポートされる属性で昇順または降順にソートします。詳細は Sorting を参照してください。

Type: string

Example: created_at-asc
with_deleted
optional		削除済みの結果を含めます。

Type: boolean

Default: false
Possible values: true, false
with_draft
optional		下書きキャンペーンの結果を含めます。

Type: boolean

Default: false
Possible values: true, false
with_total_count
optional		レスポンス属性 total_count を含めます。

Note: このパラメータと cursor は相互排他です。

Note: total_count を含むリクエストはレート制限がより低く、現在は 15 分あたり 200 に設定されています。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items?line_item_ids=itttx Example Response 
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "line_item_ids": [
            "itttx"
          ]
        }
      },
      "next_cursor": null,
      "data": [
        {
          "advertiser_user_id": "756201191646691328",
          "name": "li-18",
          "placements": [
            "ALL_ON_TWITTER"
          ],
          "start_time": "2021-02-16T00:00:00Z",
          "bid_amount_local_micro": 320000,
          "advertiser_domain": null,
          "target_cpa_local_micro": null,
          "primary_web_event_tag": null,
          "goal": "ENGAGEMENT",
          "daily_budget_amount_local_micro": null,
          "product_type": "PROMOTED_TWEETS",
          "end_time": null,
          "funding_instrument_id": "lygyi",
          "bid_strategy": "MAX",
          "duration_in_days": null,
          "standard_delivery": null,
          "total_budget_amount_local_micro": null,
          "objective": "ENGAGEMENTS",
          "id": "itttx",
          "entity_status": "PAUSED",
          "automatic_tweet_promotion": null,
          "frequency_cap": null,
          "android_app_store_identifier": null,
          "categories": [],
          "currency": "USD",
          "pay_by": "ENGAGEMENT",
          "created_at": "2021-02-23T23:37:54Z",
          "ios_app_store_identifier": null,
          "updated_at": "2022-06-01T02:01:18Z",
          "campaign_id": "f4z6x",
          "creative_source": "MANUAL",
          "deleted": false
        }
      ]
    }

​
GET accounts/:account_id/line_items/:line_item_id

現在のアカウントに紐づく特定のラインアイテムを取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/line_items/:line_item_id Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで原則必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
line_item_id
required		リクエストで操作対象となるラインアイテムの参照子。

Type: string

Example: 8v7jo
with_deleted
optional		削除済みの結果を含めます。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items/itttx Example Response 
    {
      "request": {
        "params": {
          "line_item_id": "itttx",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "advertiser_user_id": "756201191646691328",
        "name": "li-18",
        "placements": [
          "ALL_ON_TWITTER"
        ],
        "start_time": "2021-02-16T00:00:00Z",
        "bid_amount_local_micro": 320000,
        "advertiser_domain": null,
        "target_cpa_local_micro": null,
        "primary_web_event_tag": null,
        "goal": "ENGAGEMENT",
        "daily_budget_amount_local_micro": null,
        "product_type": "PROMOTED_TWEETS",
        "end_time": null,
        "funding_instrument_id": "lygyi",
        "bid_strategy": "MAX",
        "duration_in_days": null,
        "standard_delivery": null,
        "total_budget_amount_local_micro": null,
        "objective": "ENGAGEMENTS",
        "id": "itttx",
        "entity_status": "PAUSED",
        "automatic_tweet_promotion": null,
        "frequency_cap": null,
        "android_app_store_identifier": null,
        "categories": [],
        "currency": "USD",
        "pay_by": "ENGAGEMENT",
        "created_at": "2021-02-23T23:37:54Z",
        "ios_app_store_identifier": null,
        "updated_at": "2022-06-01T02:01:18Z",
        "campaign_id": "f4z6x",
        "creative_source": "MANUAL",
        "deleted": false
      }
    }

​
POST accounts/:account_id/line_items

現在のアカウントに属する、指定したキャンペーンに関連付けられたラインアイテムを作成します。 キャンペーン内のすべてのラインアイテムは、同一のproduct_typeとobjectiveである必要があります。 PROMOTED_ACCOUNTのproduct_typeを使用する場合、line_itemにTweetを関連付けると、標準のPROMOTED_ACCOUNTプレースメントに加えて、モバイルでのタイムラインプレースメントが追加されます。 android_app_store_identifierまたはios_app_store_identifierを設定すると、プロモーション対象のモバイルアプリに一致するターゲティング条件がラインアイテムに自動的に追加されます。たとえば、ios_app_store_identifierを渡すと、iOS向けのPLATFORMターゲティング条件が追加されます。 注: キャンペーンあたりのラインアイテムは最大100件、全キャンペーン合計のアクティブなラインアイテムは最大256件までです。 Resource URL https://ads-api.x.com/12/accounts/:account_id/line_items Parameters
名前説明
アカウント_id
必須		レバレッジアカウントの識別子。リソース内に表示されます’のパスに含まれ、一般的に GET accounts を除くすべての Advertiser API リクエストで必須のパラメーターですGET accounts（アカウント取得）。指定したアカウントは、認証済みユーザーに紐づいている必要があります。

型: 文字列

例：18ce54d4x5t
キャンペーン_id
必須項目		作成するラインアイテムを所属させるキャンペーンの識別子。

型: string

例：8slvg
終了_時間
必須		時間（ISO 8601表記）で、ラインアイテムの配信が停止する時刻。ISO 8601、line item の配信が停止されること。

型: 文字列

例：2017-10-05T00:00:00Z
目的
必須		このラインアイテムのキャンペーン目標。

Type: 列挙型

可能な値：APP_ENGAGEMENTS、APP_INSTALLS,リーチ,フォロワー、エンゲージメント数、VIDEO_VIEWS、PREROLL_VIEWS,WEBSITE_CLICKS
配置場所
必須		このラインアイテムを表示する掲載場所。カンマ区切りで掲載プレースメントを指定します。

型: enum

可能な値：ALL_ON_X、PUBLISHER_NETWORK,バナーをタップ、TAP_FULL,TAP_FULL_LANDSCAPE、TAP_NATIVE,TAP_MRECT、TWITTER_PROFILE、TWITTER_REPLIES、TWITTER_SEARCH,TWITTER_TIMELINE
プロダクト_型
必須		このラインアイテムに含まれるプロモーション対象商品の種類。

Type: 列挙型

取り得る値:メディア,PROMOTED_ACCOUNT、PROMOTED_TWEETS
開始_時刻
必須		その時刻ISO 8601（ISO規格）、ラインアイテムの配信が開始される時刻。

型: string

例：2017-07-05T00:00:00Z
広告主_ドメイン
必須となる場合があります		この広告主のウェブサイトのドメイン（プロトコル指定なし）。

注記: ラインアイテムが〜の場合に必須’のプレースメントが設定されているPUBLISHER_NETWORK.

型: 文字列

例：x.com
Android_アプリ_ストア_識別子
必須となる場合があります		プロモーション対象アプリの Google アプリ ストア識別子。

注記:APP_INSTALLSおよびAPP_ENGAGEMENTS目標では、少なくとも1つのアプリストア識別子を設定する必要があります —android_app_store_identifierまたはios_app_store_identifier.

型: string

例：com.twitter.android
入札額_数量_ローカル_micro
場合によっては必須です		このラインアイテムに設定する入札額。指定した資金手段に紐づく通貨が使用されます。USD の場合、$5.50 は 5,500,000 と表現します。

注釈: 条件付き必須bid_strategyのいずれかに設定されているMAXまたはTARGET

注記: 0 より大きい値のみが受け付けられます。

型: long

例：5500000
カテゴリ
必須の場合あり		この広告主に関連する IAB カテゴリ。詳しくはGET iab_categories。

注記: ラインアイテムがある場合は必須’の配置が設定されているPUBLISHER_NETWORK.

型: string

例：IAB3-1
iOS_アプリ_保存する_識別子
場合によっては必須です		プロモーションされているアプリの Apple App Store 識別子の数値部分。

注:APP_INSTALLSおよびAPP_ENGAGEMENTS目的には、少なくとも1つのアプリストア識別子（android_app_store_identifier または ios_app_store_identifier のいずれか）を設定する必要があります —android_app_store_identifierまたはios_app_store_identifier。

型: string

例：333903271
プライマリー_Web_イベント_タグ
場合によって必須		プライマリ Web イベントタグの識別子。該当ラインアイテムに紐づくキャンペーンのエンゲージメントを、より正確に追跡できるようにします。

注記: ラインアイテムの場合は必須’の目標が WEBSITE_CONVERSIONS に設定されているWEBSITE_CONVERSIONS.

型: string

例：nvo4z
広告主_ユーザー_id
任意（オプション）		PREROLL_VIEWS 広告をプロモーションしているハンドルに対応する X のユーザー識別子。特定のクライアントアプリケーションのみがこのパラメータを使用できます。PREROLL_VIEWS注記：特定のクライアントアプリケーションのみがこのパラメータを使用できます。

型: string

例：312226591
対象者_展開
任意		既存のターゲットに類似するユーザーを狙うことで、キャンペーンのリーチを拡大するために使用します。

注: 既定では拡張は適用されません。

Type: 列挙型

指定可能な値:BROAD,DEFINED,展開済み
入札額_戦略
任意（オプション）		入札の仕組み。

AUTO日次予算とキャンペーンの実施期間に基づいて、入札を自動的に最適化します。

MAX最大許容入札額を設定し、not目標が次に設定されている場合に利用可能リーチまたはフォロワー.

TARGET指定値の±20%の範囲内に日次の入札平均を収めるよう試行しますbid_amount_local_microで、目的が次のいずれかに設定されている場合に利用できますリーチ、フォロワー、またはWEBSITE_CLICKS.

注記: 設定が自動,bid_amount_local_micro無視されます。

注意: 目的に基づく既定値。

型: 列挙型

使用可能な値：AUTO、MAX、TARGET
継続時間_内_日数
任意		frequency_cap が適用される期間。frequency_capが達成されます。

型: int

指定可能な値：1、7、30
エンティティ_ステータス
任意（オプション）		ラインアイテムの状態。

Type: 列挙型

既定:アクティブ
可能な値：アクティブ、草案、一時停止中
頻度_上限値
オプション		1人のユーザーに広告を配信できる最大回数。

注記: 次の場合にのみ対応リーチ、エンゲージメント,VIDEO_VIEWS、ならびにPREROLL_VIEWS目標。

型: int

例：5
目的
任意		このラインアイテムに使用する最適化設定。

TheAPP_PURCHASESオプションは次の場合に利用可能ですAPP_INSTALL。TheAPP_CLICKSおよびAPP_INSTALLS両方でオプションを利用できますAPP_INSTALLおよびAPP_ENGAGEMENTS目的であり、サポート対象のMACTパートナー.

TheSITE_VISITSこのオプションは、～でのみ利用できますWEBSITE_CLICKS目的

注記: 目的に基づく既定設定。

型: enum

可能な値：APP_CLICKS、APP_INSTALLS,APP_PURCHASES、エンゲージメント,フォロワー、LINK_CLICKS、MAX_REACH、プレロール、PREROLL_STARTS、REACH_WITH_ENGAGEMENT,SITE_VISITS,VIDEO_VIEW、VIEW_3S_100PCT、VIEW_6S、VIEW_15S、WEBSITE_CONVERSIONS
名前
※任意		ラインアイテムの名称。

型: string

例：デモ

最小長、最大長:1,255
支払う_作成者：
任意		このラインアイテムの課金単位。この設定は、次を使用するラインアイテムに対してのみ変更できますAPP_INSTALLS目的。

注釈: 既定pay_byはキャンペーンの目的とラインアイテムに基づいて自動的に設定されます’の入札単価単位。

TheAPP_INSTALLSgoal は両方に対応していますAPP_CLICKおよびIMPRESSION値インプレッションが既定値です。

Theリンククリックgoal は両方に対応していますLINK_CLICKおよびインプレッション値インプレッションはデフォルト値ですが、bid_strategy に TARGET を設定した場合はサポートされませんTARGET対象bid_strategy。

TheSITE_VISITS対応目標インプレッション値

型: enum

指定可能な値：APP_CLICK、インプレッション、LINK_CLICK
スタンダード_配信
任意		標準配信または迅速配信を有効化します。詳しくは予算ペーシング（Budget Pacing）標準配信と高速配信の違いの詳細については、を参照してください。これは、が有効な場合にのみ利用できます。budget_optimizationに設定されていますLINE_ITEM親キャンペーン用

型: ブール値

既定:true
取りうる値：true,false
合計_予算_金額_ローカル_micro
任意（オプション）		ラインアイテムに割り当てる合計予算額。指定した資金提供手段に紐づく通貨が使用されます。USD の場合、$37.50 は 37500000 と表記します。

型: long

例：37500000
毎日_予算_金額_ローカル_マイクロ
場合によっては必須です		キャンペーンに割り当てる1日あたりの予算額。指定した資金手段に対応する通貨が使用されます。USD の場合、$5.50 は 5,500,000 と表されます。未指定の場合、キャンペーンは総予算とフライト期間に基づいて均等配分で消化されます。親キャンペーンで budget_optimization が LINE_ITEM に設定されている場合にのみ利用可能ですbudget_optimizationに設定されていますLINE_ITEM親キャンペーン用

注記: これは total_budget_amount_local_micro 以下でなければなりませんtotal_budget_amount_local_micro.

型: long

例：5,500,000
リクエスト例 POST https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items?campaign_id=hwtq0&objective=ENGAGEMENTS&product_type=PROMOTED_TWEETS&placements=ALL_ON_TWITTER&bid_amount_local_micro=3210000&entity_status=PAUSED&daily_budget_amount_local_micro=1000000&start_time=2022-06-15 レスポンス例 
    {
      "request": {
        "params": {
          "placements": [
            "ALL_ON_TWITTER"
          ],
          "start_time": "2022-06-15T00:00:00Z",
          "bid_amount_local_micro": 3210000,
          "daily_budget_amount_local_micro": 1000000,
          "product_type": "PROMOTED_TWEETS",
          "objective": "ENGAGEMENTS",
          "entity_status": "PAUSED",
          "account_id": "18ce54d4x5t",
          "campaign_id": "hwtq0"
        }
      },
      "data": {
        "advertiser_user_id": "756201191646691328",
        "name": null,
        "placements": [
          "ALL_ON_TWITTER"
        ],
        "start_time": "2022-06-15T00:00:00Z",
        "bid_amount_local_micro": 3210000,
        "advertiser_domain": null,
        "target_cpa_local_micro": null,
        "primary_web_event_tag": null,
        "goal": "ENGAGEMENT",
        "daily_budget_amount_local_micro": 1000000,
        "product_type": "PROMOTED_TWEETS",
        "end_time": null,
        "bid_strategy": "MAX",
        "duration_in_days": null,
        "standard_delivery": true,
        "total_budget_amount_local_micro": null,
        "objective": "ENGAGEMENTS",
        "id": "ml5vs",
        "entity_status": "PAUSED",
        "automatic_tweet_promotion": null,
        "frequency_cap": null,
        "android_app_store_identifier": null,
        "categories": [],
        "currency": "USD",
        "pay_by": "ENGAGEMENT",
        "created_at": "2022-06-03T23:47:20Z",
        "ios_app_store_identifier": null,
        "updated_at": "2022-06-03T23:47:20Z",
        "campaign_id": "hwtq0",
        "creative_source": "MANUAL",
        "deleted": false
      }
    }

​
POST batch/accounts/:account_id/line_items

単一のリクエストで新しいラインアイテムをバッチ作成できます。 バッチリクエスト
  • 現在の最大バッチサイズは40です。
  • すべてのパラメータはリクエストボディで送信され、Content-Type は application/json が必須です。
  • バッチリクエストはグループとして一括で成功または失敗し、エラー・成功いずれの場合でも、APIレスポンスは初期リクエストのアイテム順序を保持します。
バッチレスポンス バッチAPIのレスポンスは順序付きのアイテムコレクションを返します。それ以外は、対応する単一アイテムのエンドポイントと構造は同一です。 バッチエラー
  • リクエストレベルのエラー（例：最大バッチサイズ超過）は、レスポンスの errors オブジェクト内に表示されます。
  • アイテムレベルのエラー（例：必須のラインアイテムパラメータの不足）は、レスポンスの operation_errors オブジェクト内に表示されます。
Resource URL https://ads-api.x.com/12/batch/accounts/:account_id/line_items Parameters
NameDescription
operation_type
required		各アイテムで実行される操作タイプ。

Type: enum

Possible values: Create, Delete, Update
params
required		ラインアイテムオブジェクトのすべてのパラメータを含む JSON オブジェクト。必須および任意のラインアイテムパラメータの一覧はこちらを参照してください。
Example Request POST 'Content-Type: application/json' https://ads-api.x.com/12/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": [
        {
          "advertiser_user_id": "756201191646691328",
          "name": null,
          "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,
          "goal": "ENGAGEMENT",
          "daily_budget_amount_local_micro": null,
          "product_type": "PROMOTED_TWEETS",
          "end_time": null,
          "funding_instrument_id": "lygyi",
          "bid_strategy": "MAX",
          "duration_in_days": null,
          "standard_delivery": null,
          "total_budget_amount_local_micro": null,
          "objective": "ENGAGEMENTS",
          "id": "9cqi0",
          "entity_status": "PAUSED",
          "automatic_tweet_promotion": null,
          "frequency_cap": null,
          "android_app_store_identifier": null,
          "categories": [],
          "currency": "USD",
          "pay_by": "ENGAGEMENT",
          "created_at": "2017-07-07T17:42:20Z",
          "ios_app_store_identifier": null,
          "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

現在のアカウントに紐づく指定のラインアイテムを更新します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/line_items/:line_item_id Parameters
名前概要
アカウント_id
必須		レバレッジドアカウントの識別子。リソース内に表示されます’のパスに含まれ、一般的に GET accounts を除く、すべての Advertiser API リクエストで必須のパラメータですGET /accounts。指定されたアカウントは、認証済みユーザーに紐づいている必要があります。

型: string

例：18ce54d4x5t
ライン_アイテム_id
必須項目		リクエストで操作対象となるラインアイテムへの参照。

型: 文字列

例：8v7jo
広告主_ドメイン
任意（オプション）		この広告主のウェブサイトのドメイン（プロトコル指定を除く）。

注釈: ラインアイテムが〜の場合は必須’の配置が PUBLISHER_NETWORK に設定されている場合に必要です。PUBLISHER_NETWORK。

種類: 文字列

例：x.com
広告主_ユーザー_id
オプション		PREROLL_VIEWS 広告を宣伝しているハンドルの Twitter ユーザー識別子。特定のクライアントアプリケーションのみがこのパラメータを使用できます。PREROLL_VIEWS広告。特定のクライアントアプリのみがこのパラメータを使用できます。

型: string

例：312226591
Android_アプリ_保存_識別子
任意		プロモーション対象のアプリの Google Play ストア識別子。

注記:APP_INSTALLSおよびAPP_ENGAGEMENTS目標では、少なくとも 1 つのアプリストア識別子を設定する必要があります — どちらか一方android_app_store_identifierまたはios_app_store_identifier.

型: 文字列

例：com.twitter.android
対象者_展開
任意		既存のターゲットに類似するユーザーを対象にすることで、キャンペーンのリーチを拡大するために使用されます。

種類: enum

指定可能な値：BROAD、DEFINED、展開済み
入札価格_金額_ローカル_マイクロ
※任意		このラインアイテムに関連付ける入札額です。指定された資金提供インストルメントに紐づく通貨が使用されます。USD の場合、$5.50 は 5,500,000 と表されます。

注記: 次の場合に必須ですbid_strategyに設定されているのはMAXまたはTARGET

注: 0 より大きい値のみが受け付けられます。

Type: long

例：140000
入札額_戦略
任意		入札の仕組み。

自動1日あたりの予算とキャンペーンの配信期間に基づいて、入札を自動的に最適化します。

MAX上限入札額を設定し、かつではありません目的が次の場合に利用可能リーチまたはフォロワー.

TARGET指定値の±20％以内に日次の入札平均が収まるように試みますbid_amount_local_microで、目的が次のように設定されている場合に利用できますリーチまたはWEBSITE_CLICKS.

注: 設定されている場合は自動、bid_amount_local_micro無視されます。

注意: 目的に基づくデフォルト値。

Type: 列挙型

指定可能な値：AUTO、MAX、TARGET
カテゴリ
（任意）		この広告主に該当する IAB カテゴリ。参照GET iab_categories。

注意: ラインアイテムがある場合は必須’の配置が PUBLISHER_NETWORK に設定されている場合に必須です。PUBLISHER_NETWORK.

Type: 文字列

例：IAB3-1
継続時間_内で_日数
任意		frequency_cap が適用される期間。frequency_cap達成されます。

型: int

取り得る値：1、7、30
エンティティー_ステータス
任意（オプション）		ラインアイテムの状態。

型: enum

指定可能な値:アクティブ,一時停止
終了_時間
オプション		時間は、次の形式で表現されますISO 8601、ラインアイテムの配信が停止する時刻。

型: string

例：2017-10-05T00:00:00Z
frequency（頻度）_上限
※任意		広告がユーザーに配信される可能性がある最大回数。

注: 次の場合のみサポートリーチ,エンゲージメント、VIDEO_VIEWS、ならびにPREROLL_VIEWS目的

型: int

例：5
目標
任意		このラインアイテムで使用する最適化設定。APP_PURCHASESオプションは次で利用できますAPP_INSTALL。TheAPP_CLICKSおよびAPP_INSTALLSのオプションが利用可能ですAPP_INSTALLおよびAPP_ENGAGEMENTSおよび、サポートされているMACTパートナー.

注: 目的に基づく既定値。

Type: 列挙型

可能な値：APP_CLICKS、APP_INSTALLS、APP_PURCHASES、エンゲージメント、フォロワー、LINK_CLICKS、MAX_REACH、プレロール、PREROLL_STARTS、REACH_WITH_ENGAGEMENT,VIDEO_VIEW、VIEW_3S_100PCT、VIEW_6S、VIEW_15S、WEBSITE_CONVERSIONS
iOS_アプリ_保存する_識別子
任意（オプション）		プロモーション対象のアプリの Apple App Store 識別子における数値部分。

注記:APP_INSTALLSおよびAPP_ENGAGEMENTS目的には、少なくとも1つのアプリストア識別子の設定が必要です — いずれかandroid_app_store_identifierまたはios_app_store_identifier。

型: string

例：333903271
名前
任意		ラインアイテム名。

型: string

例：デモ
支払う_作成者
任意		このラインアイテムの課金単位。この設定は、次の目的を使用するラインアイテムに対してのみ変更できますAPP_INSTALLS目的

注: 既定pay_byは、キャンペーンの目的とラインアイテムに応じて自動設定されます’の入札単価単位。

TheAPP_INSTALLS目標は両方に対応していますAPP_CLICKおよびIMPRESSION値インプレッションが既定値です。

TheLINK_CLICKSgoal は両方に対応していますLINK_CLICKおよびインプレッション値インプレッションはデフォルト値ですが、bid_strategy を TARGET に設定する場合はサポートされませんTARGET用bid_strategy。

TheSITE_VISITS対応目標インプレッション値

型: enum

指定可能な値：APP_CLICK、インプレッション、LINK_CLICK
開始_時刻
任意（オプション）		時刻（ISO 8601 形式）で表されます。ISO 8601（国際標準の日時表記）、ラインアイテムの配信開始。

型: string

例：2017-07-05T00:00:00Z
合計_予算_金額_ローカル_Micro
※任意		ラインアイテムに割り当てる合計予算額。指定された資金手段に紐づく通貨が使用されます。USD の場合、$37.50 は 37500000 と表現します。

型: long

例：37500000
毎日_予算_金額_ローカル_マイクロ
（任意）		キャンペーンに割り当てる1日あたりの予算額。指定したファンディングインストルメントに紐づく通貨が使用されます。USD の場合、$5.50 は 5500000 と表されます。未指定の場合、キャンペーンは合計予算とフライト期間に基づいて均等に消化されます。親キャンペーンの budget_optimization が LINE_ITEM に設定されている場合にのみ利用可能budget_optimizationに設定されているLINE_ITEM親キャンペーン用

注: これは total_budget_amount_local_micro 以下である必要がありますtotal_budget_amount_local_micro.

型: long

例：5,500,000
リクエスト例 PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items/9cqi0?bid_amount_local_micro=140000 レスポンス例 
    {
      "request": {
        "params": {
          "line_item_id": "9cqi0",
          "bid_amount_local_micro": 140000,
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "advertiser_user_id": "756201191646691328",
        "name": null,
        "placements": [
          "ALL_ON_TWITTER"
        ],
        "start_time": "2017-07-10T00:00:00Z",
        "bid_amount_local_micro": 140000,
        "advertiser_domain": null,
        "target_cpa_local_micro": null,
        "primary_web_event_tag": null,
        "goal": "ENGAGEMENT",
        "daily_budget_amount_local_micro": null,
        "product_type": "PROMOTED_TWEETS",
        "end_time": null,
        "bid_strategy": "MAX",
        "duration_in_days": null,
        "standard_delivery": null,
        "total_budget_amount_local_micro": null,
        "objective": "ENGAGEMENTS",
        "id": "9cqi0",
        "entity_status": "PAUSED",
        "automatic_tweet_promotion": null,
        "frequency_cap": null,
        "android_app_store_identifier": null,
        "categories": [],
        "currency": "USD",
        "pay_by": "ENGAGEMENT",
        "created_at": "2017-07-07T17:42:20Z",
        "ios_app_store_identifier": null,
        "updated_at": "2022-06-03T23:51:36Z",
        "campaign_id": "8yn7m",
        "creative_source": "MANUAL",
        "deleted": false
      }
    }

​
DELETE accounts/:account_id/line_items/:line_item_id

現在のアカウントに属する指定のラインアイテムを削除します。 注記: ラインアイテムの削除は取り消せません。以後、そのリソースの削除を試みると HTTP 404 が返されます。 注記: ラインアイテムを削除しても、その子である promoted_tweets は、リクエストで with_deleted=true が指定されている場合に限り、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/12/accounts/:account_id/line_items/:line_item_id パラメータ
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定されたアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
line_item_id
required		このリクエストで操作するラインアイテムの参照。

Type: string

Example: 9f2ix
リクエスト例 DELETE https://ads-api.x.com/12/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"
        }
      }
    }

​
Line Item キュレーテッドカテゴリ

利用方法の詳細はVideo Views Pre-roll Objective ガイドを参照してください

​
GET accounts/:account_id/line_item_curated_categories

現在のアカウントに関連付けられているラインアイテムのキュレートカテゴリの一部またはすべての詳細を取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories Parameters
NameDescription
account_id
required		対象となるアカウントの識別子。リソースパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは、認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
count
optional		1 回のリクエストで取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
sort_by
optional		サポートされる属性で昇順または降順に並べ替えます。詳細は Sorting を参照してください。

Type: string

Example: created_at-asc
with_deleted
optional		削除済みの結果を含めます。

Type: boolean

Default: false
Possible values: true, false
with_total_count
optional		レスポンス属性 total_count を含めます。

Note: このパラメータと cursor は併用できません。

Note: total_count を含むリクエストには、より低いレート制限（現在は 15 分あたり 200）が適用されます。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/abc1/line_item_curated_categories Example Response 
    {
      "request": {
        "params": {
          "account_id": "abc1"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "line_item_id": "by5pw",
          "curated_category_id": "7op29tp2jzeo",
          "id": "1",
          "created_at": "2018-06-29T04:19:53Z",
          "updated_at": "2018-06-29T04:19:53Z",
          "deleted": false
        }
      ]
    }

​
GET accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id

現在のアカウントに紐づく特定のラインアイテムのキュレートカテゴリの詳細を取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id Parameters
NameDescription
account_id
required		対象アカウントを示す識別子です。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
line_item_curated_category_id
required		リクエストで操作するラインアイテムのキュレートカテゴリを指す参照子です。

Type: string

Example: 43853bhii885
with_deleted
optional		削除済みの結果を含めます。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/abc1/line_item_curated_categories/yav Example Response 
    {
      "request": {
        "params": {
          "line_item_curated_category_id": "yav",
          "account_id": "abc1"
        }
      },
      "data": {
        "line_item_id": "by5pw",
        "curated_category_id": "7op29tp2jzeo",
        "id": "yav",
        "created_at": "2018-06-29T04:19:53Z",
        "updated_at": "2018-06-29T04:19:53Z",
        "deleted": false
      }
    }

​
POST accounts/:account_id/line_item_curated_categories

指定したラインアイテムにキュレートカテゴリオブジェクトを関連付けます。 リソース URL https://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories パラメータ
名前説明
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accountsを除くすべての Advertiser API リクエストで一般的に必須です。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
curated_category_id
required		本リクエストで操作対象となるキュレートカテゴリエンティティへの参照。

Type: string

Example: 10miy
line_item_id
required		本リクエストで操作対象となるラインアイテムへの参照。

Type: string

Example: 8v7jo
リクエスト例 POST https://ads-api.x.com/12/accounts/18ce54d4x5t/line_item_curated_categories?line_item_id=iqwka&curated_category_id=9ddrgesiap6o レスポンス例 
    {
      "request": {
        "params": {
          "curated_category_id": "9ddrgesiap6o",
          "line_item_id": "iqwka",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "iqwka",
        "curated_category_id": "9ddrgesiap6o",
        "id": "xq",
        "created_at": "2021-03-30T17:26:42Z",
        "updated_at": "2021-03-30T17:26:42Z",
        "deleted": false
      }
    }

​
PUT accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id

指定したラインアイテムのキュレーテッドカテゴリを更新します。 リソース URL https://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id パラメータ
NameDescription
account_id
required		対象アカウントの識別子。リソースのパスに含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
line_item_curated_category_id
required		リクエストで操作するラインアイテムのキュレーテッドカテゴリへの参照。

Type: string

Example: 1bzq3
curated_category_id
optional		リクエストで操作するキュレーテッドカテゴリエンティティへの参照。

Type: string

Example: 10miy
line_item_id
optional		リクエストで操作するラインアイテムへの参照。

Type: string

Example: 8v7jo
リクエスト例 PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/line_item_curated_categories/xq?curated_category_id=8tujl1p3yn0g レスポンス例 
    {
      "request": {
        "params": {
          "line_item_curated_category_id": "xq",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "iqwka",
        "curated_category_id": "8tujl1p3yn0g",
        "id": "xq",
        "created_at": "2021-03-30T17:26:42Z",
        "updated_at": "2021-03-30T18:22:52Z",
        "deleted": true
      }
    }

​
DELETE accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id

指定したラインアイテムのキュレーテッドカテゴリを削除します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパスに含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定のアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
line_item_curated_category_id
required		リクエストで操作するラインアイテムのキュレーテッドカテゴリを参照する ID。

Type: string

Example: 1bzq3
Example Request DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/line_item_curated_categories/xq Example Response 
    {
      "request": {
        "params": {
          "line_item_curated_category_id": "xq",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "iqwka",
        "curated_category_id": "9ddrgesiap6o",
        "id": "xq",
        "created_at": "2021-03-30T17:26:42Z",
        "updated_at": "2021-03-30T18:22:52Z",
        "deleted": true
      }
    }

​
ラインアイテムのプレースメント

​
GET line_items/placements

有効な placement と product_type の組み合わせを取得します。 リソース URL https://ads-api.x.com/12/line_items/placements パラメータ
Name説明
product_type
optional		指定した製品タイプに対する有効な配置のみを返すようにレスポンスを絞り込みます。

Type: enum

Possible values: MEDIA, PROMOTED_ACCOUNT, PROMOTED_TWEETS
リクエスト例 GET https://ads-api.x.com/12/line_items/placements?product_type=PROMOTED_ACCOUNT レスポンス例 
    {
      "data": [
        {
          "product_type": "PROMOTED_ACCOUNT",
          "placements": [
            [
              "ALL_ON_TWITTER"
            ],
            [
              "TWITTER_TIMELINE"
            ]
          ]
        }
      ],
      "request": {
        "params": {
          "product_type": "PROMOTED_ACCOUNT"
        }
      }
    }

​
メディアクリエイティブ

​
GET accounts/:account_id/media_creatives

現在のアカウントに関連付けられている一部またはすべてのメディアクリエイティブの詳細を取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/media_creatives Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで通常必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
campaign_id
optional		応答を、指定したキャンペーンに関連付けられたメディアクリエイティブのみに絞り込みます。

Type: string

Example: 8gdx6
count
optional		各リクエストで取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
line_item_ids
optional		識別子のカンマ区切りリストを指定して、指定したラインアイテムに関連付けられたメディアクリエイティブのみに応答を絞り込みます。最大 200 個の ID を指定できます。

Type: string

Example: 8v7jo
media_creative_ids
optional		識別子のカンマ区切りリストを指定して、対象のメディアクリエイティブのみに応答を絞り込みます。最大 200 個の ID を指定できます。

Type: string

Example: 1bzq3
sort_by
optional		サポートされている属性で昇順または降順に並べ替えます。詳細は Sorting を参照してください。

Type: string

Example: created_at-asc
with_deleted
optional		削除済みの結果を含めます。

Type: boolean

Default: false
Possible values: true, false
with_total_count
optional		応答属性 total_count を含めます。

Note: このパラメータと cursor は同時に使用できません。

Note: total_count を含むリクエストはレート制限が低く、現在は 15 分あたり 200 回に設定されています。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/media_creatives?media_creative_ids=1bzq3 Example Response 
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "media_creative_ids": [
            "1bzq3"
          ]
        }
      },
      "next_cursor": null,
      "data": [
        {
          "line_item_id": "8v7jo",
          "landing_url": "https://dev.x.com",
          "creative_type": "INTERSTITIAL_LANDSCAPE_TABLET",
          "id": "1bzq3",
          "entity_status": "ACTIVE",
          "created_at": "2017-07-05T06:00:42Z",
          "account_media_id": "10miy",
          "updated_at": "2019-01-11T20:21:26Z",
          "approval_status": "ACCEPTED",
          "deleted": false
        }
      ]
    }

​
GET accounts/:account_id/media_creatives/:media_creative_id

現在のアカウントに関連付けられている特定のメディアクリエイティブの詳細を取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/media_creatives/:media_creative_id Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで基本的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
media_creative_id
required		リクエストで操作するメディアクリエイティブを参照します。

Type: string

Example: 43853bhii885
with_deleted
optional		削除済みの結果を含めるかどうか。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/media_creatives/1bzq3 Example Response 
    {
      "request": {
        "params": {
          "media_creative_id": "1bzq3",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "8v7jo",
        "landing_url": "https://dev.x.com",
        "creative_type": "INTERSTITIAL_LANDSCAPE_TABLET",
        "id": "1bzq3",
        "entity_status": "ACTIVE",
        "created_at": "2017-07-05T06:00:42Z",
        "account_media_id": "10miy",
        "updated_at": "2019-01-11T20:21:26Z",
        "approval_status": "ACCEPTED",
        "deleted": false
      }
    }

​
POST accounts/:account_id/media_creatives

指定したラインアイテムに account media オブジェクトを関連付けます。 このエンドポイントは、X Audience Platform 上で、インストリーム広告（アカウントメディアの creative_type が PREROLL の場合）または画像広告（BANNER や INTERSTITIAL など）を配信・展開する際に使用します。 注: Account Media リソースにメディアアセットを追加するには、POST accounts/:account_id/media_library エンドポイントを使用してください。 Resource URL https://ads-api.x.com/12/accounts/:account_id/media_creatives Parameters
NameDescription
account_id
required		対象となるアカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定されたアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
account_media_id
required		リクエストで操作対象となるアカウントメディアエンティティへの参照。

Type: string

Example: 10miy
line_item_id
required		リクエストで操作対象となるラインアイテムへの参照。

Type: string

Example: 8v7jo
landing_url
sometimes required		ユーザーを遷移させるウェブサイトの URL。これは TAP 画像（または「display creatives」）でのみ使用してください。preroll アセットと併用した場合、この値は無視されます。preroll アセットに URL を関連付けるには、POST accounts/:account_id/preroll_call_to_actions エンドポイントを使用してください。

注: ラインアイテムの objective が WEBSITE_CLICKS に設定されている場合は必須です。

Type: string

Example: https://blog.x.com/
Example Request POST https://ads-api.x.com/12/accounts/18ce54d4x5t/media_creatives?line_item_id=8v7jo&account_media_id=10miy Example Response 
    {
      "request": {
        "params": {
          "line_item_id": "8v7jo",
          "account_media_id": "10miy",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "8v7jo",
        "landing_url": "https://dev.x.com",
        "creative_type": "INTERSTITIAL_LANDSCAPE_TABLET",
        "id": "1bzq3",
        "entity_status": "ACTIVE",
        "created_at": "2017-07-05T06:00:42Z",
        "account_media_id": "10miy",
        "updated_at": "2019-01-11T20:21:26Z",
        "approval_status": "ACCEPTED",
        "deleted": false
      }
    }

​
DELETE accounts/:account_id/media_creatives/:media_creative_id

現在のアカウントに属する指定のメディアクリエイティブを削除します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/media_creatives/:media_creative_id Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパスに含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定されたアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
media_creative_id
required		リクエストで操作するメディアクリエイティブの参照。

Type: string

Example: 1bzq3
Example Request DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/media_creatives/1bzq3 Example Response 
    {
      "request": {
        "params": {
          "media_creative_id": "1bzq3",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "8v7jo",
        "landing_url": "https://dev.x.com",
        "creative_type": "INTERSTITIAL_LANDSCAPE_TABLET",
        "id": "1bzq3",
        "entity_status": "ACTIVE",
        "created_at": "2017-07-05T06:00:42Z",
        "account_media_id": "10miy",
        "updated_at": "2021-04-16T21:02:55Z",
        "approval_status": "ACCEPTED",
        "deleted": true
      }
    }

​
プロモーテッドアカウント

​
GET accounts/:account_id/promoted_accounts

現在のアカウント配下の1つ以上のラインアイテムに関連付けられた、プロモートアカウントの一部またはすべての詳細を取得します。 レスポンスで user_id として識別されるユーザーアカウントのユーザー data を取得するには、GET users/lookup を使用してください。 指定されたラインアイテムのいずれもプロモートアカウントを含むように設定されていない場合は、HTTP 400 が返されます。 Resource URL https://ads-api.x.com/12/accounts/:account_id/promoted_accounts Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパスに含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定されたアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
count
optional		リクエストごとに取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
line_item_ids
optional		識別子のカンマ区切りリストを指定して、指定したラインアイテムに関連付けられたプロモートアカウントのみにレスポンスを絞り込みます。最大 200 個の ID を指定できます。

Type: string

Example: 9bpb2
promoted_account_ids
optional		識別子のカンマ区切りリストを指定して、目的のプロモートアカウントのみにレスポンスを絞り込みます。最大 200 個の ID を指定できます。

Type: string

Example: 19pl2
sort_by
optional		サポートされる属性で昇順または降順にソートします。詳細は Sorting を参照してください。

Type: string

Example: created_at-asc
with_deleted
optional		削除済みの結果をレスポンスに含めます。

Type: boolean

Default: false
Possible values: true, false
with_total_count
optional		レスポンス属性 total_count を含めます。

Note: このパラメータと cursor は排他的です。

Note: total_count を含むリクエストはレート制限が低く、現在は 15 分あたり 200 に設定されています。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts?promoted_account_ids=19pl2 Example Response 
    {
      "request": {
        "params": {
          "promoted_account_ids": [
            "19pl2"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "line_item_id": "9bpb2",
          "user_id": "756201191646691328",
          "id": "19pl2",
          "entity_status": "ACTIVE",
          "created_at": "2017-07-05T05:54:13Z",
          "updated_at": "2017-07-05T05:54:13Z",
          "approval_status": "ACCEPTED",
          "deleted": false
        }
      ]
    }

​
GET accounts/:account_id/promoted_accounts/:promoted_account_id

現在のアカウント配下のラインアイテムに関連付けられたアカウントへの特定の参照を取得します。 リソース URL https://ads-api.x.com/12/accounts/:account_id/promoted_accounts/:promoted_account_id パラメーター
NameDescription
account_id
required		対象となるアカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで原則として必須のパラメーターです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
promoted_account_id
required		リクエストで操作対象としているプロモーションアカウントへの参照。

Type: string

Example: 19pl2
with_deleted
optional		削除済みの結果をレスポンスに含めます。

Type: boolean

Default: false
Possible values: true, false
リクエスト例 GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts/19pl2 レスポンス例 
    {
      "request": {
        "params": {
          "promoted_account_id": "19pl2",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "9bpb2",
        "user_id": "756201191646691328",
        "id": "19pl2",
        "entity_status": "ACTIVE",
        "created_at": "2017-07-05T05:54:13Z",
        "updated_at": "2017-07-05T05:54:13Z",
        "approval_status": "ACCEPTED",
        "deleted": false
      }
    }

​
POST accounts/:account_id/promoted_accounts

指定したラインアイテムにアカウント（user_id）を関連付けます。 指定したラインアイテムが Promoted Accounts に関連付けるよう設定されていない場合、HTTP 400 INCOMPATIBLE_LINE_ITEM エラーが返されます。指定したユーザーがプロモーション対象外の場合は HTTP 400 が返され、ユーザーはプロモートされません。指定のユーザーがすでにプロモート済みの場合、このリクエストは無視されます。 Promoted Accounts の詳細は、campaign management ページをご覧ください。 注意: Promoted Accounts エンティティを更新（PUT）することはできません。 Resource URL https://ads-api.x.com/12/accounts/:account_id/promoted_accounts Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定のアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
line_item_id
required		リクエストで操作するラインアイテムの参照。

Type: string

Example: 9bpb2
user_id
required		リクエストで操作するユーザーの参照。スクリーンネームに対応するユーザー ID を取得するには、GET users/lookup を使用してください。

Type: long

Example: 756201191646691328
Example Request POST https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts?line_item_id=9bpb2&user_id=756201191646691328 Example Response 
    {
      "data": {
        "line_item_id": "9bpb2",
        "user_id": "756201191646691328",
        "id": "19pl2",
        "entity_status": "有効",
        "created_at": "2017-07-05T05:54:13Z",
        "updated_at": "2017-07-05T05:54:13Z",
        "approval_status": "承認済み",
        "deleted": false
      },
      "request": {
        "params": {
          "user_id": "756201191646691328",
          "line_item_id": "9bpb2",
          "account_id": "18ce54d4x5t"
        }
      }
    }

​
DELETE accounts/:account_id/promoted_accounts/:promoted_account_id

指定したラインアイテムからアカウントの関連付けを解除します。 リソース URL https://ads-api.x.com/12/accounts/:account_id/promoted_accounts/:promoted_account_id パラメータ
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定されたアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
promoted_account_id
required		ラインアイテムに関連付けられた Promoted Account のインスタンスを指す識別子。

Type: string

Example: 19pl2
リクエスト例 DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts/19pl2 レスポンス例 
    {
      "data": {
        "line_item_id": "9bpb2",
        "user_id": "756201191646691328",
        "id": "19pl2",
        "entity_status": "ACTIVE",
        "created_at": "2017-07-05T05:54:13Z",
        "updated_at": "2017-08-23T18:53:15Z",
        "approval_status": "ACCEPTED",
        "deleted": true
      },
      "request": {
        "params": {
          "promoted_account_id": "19pl2",
          "account_id": "18ce54d4x5t"
        }
      }
    }

​
GET accounts/:account_id/promoted_tweets

現在のアカウントに属するラインアイテムに関連付けられた Tweet の参照を取得します。 GET accounts/:account_id/tweets エンドポイントを使用して Tweet オブジェクトを取得します。各 promoted_tweets オブジェクトには tweet_id の値を使用してください。 注: 親のラインアイテムが削除されている場合、リクエストで with_deleted=true を指定したときのみ promoted_tweets が返されます。なお、これらの promoted_tweets 自体は削除されていません（レスポンスでは "deleted": false" ）。 Resource URL https://ads-api.x.com/12/accounts/:account_id/promoted_tweets Parameters
NameDescription
account_id
required		利用するアカウントの識別子。リソースのパスに含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
count
optional		リクエストごとに取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
line_item_ids
optional		識別子のカンマ区切りリストを指定して、特定のラインアイテムに関連付けられた Tweet のみにレスポンスを絞り込みます。最大 200 個の ID を指定できます。

Type: string

Example: 96uzp
promoted_tweet_ids
optional		識別子のカンマ区切りリストを指定して、目的のプロモートされた Tweet のみにレスポンスを絞り込みます。最大 200 個の ID を指定できます。

Type: string

Example: 1efwlo
sort_by
optional		サポートされている属性で昇順または降順にソートします。詳細は Sorting を参照してください。

Type: string

Example: created_at-asc
with_deleted
optional		削除済みの結果をレスポンスに含めます。

Type: boolean

Default: false
Possible values: true, false
with_total_count
optional		total_count レスポンス属性を含めます。

注: このパラメータと cursor は同時指定できません。

注: total_count を含むリクエストはレート制限が低く、現在は 15 分あたり 200 回に設定されています。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_tweets?promoted_tweet_ids=1efwlo Example Response 
    {
      "request": {
        "params": {
          "promoted_tweet_ids": [
            "1efwlo"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "line_item_id": "96uzp",
          "id": "1efwlo",
          "entity_status": "ACTIVE",
          "created_at": "2017-06-29T05:06:57Z",
          "updated_at": "2017-06-29T05:08:46Z",
          "approval_status": "ACCEPTED",
          "tweet_id": "880290790664060928",
          "deleted": false
        }
      ]
    }

​
GET accounts/:account_id/promoted_tweets/:promoted_tweet_id

現在のアカウントのラインアイテムに関連付けられた特定のTweet参照を取得します。 注: 親のラインアイテムが削除されている場合、リクエストで with_deleted=true を指定したときにのみ promoted_tweets が返されます。なお、これらの promoted_tweets は実際には削除されていません（レスポンスでは "deleted": false ）。 リソースURL https://ads-api.x.com/12/accounts/:account_id/promoted_tweets/:promoted_tweet_id パラメータ
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須です。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
promoted_tweet_id
required		リクエストで操作するプロモートされたTweetへの参照。

Type: string

Example: 1efwlo
with_deleted
optional		削除済みの結果を含めるかどうか。

Type: boolean

Default: false
Possible values: true, false
リクエスト例 GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_tweets/1efwlo レスポンス例 
    {
      "request": {
        "params": {
          "promoted_tweet_id": "1efwlo",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "96uzp",
        "id": "1efwlo",
        "entity_status": "ACTIVE",
        "created_at": "2017-06-29T05:06:57Z",
        "updated_at": "2017-06-29T05:08:46Z",
        "approval_status": "ACCEPTED",
        "tweet_id": "880290790664060928",
        "deleted": false
      }
    }

​
POST accounts/:account_id/promoted_tweets

指定したラインアイテムに1つ以上のTweetを関連付けます。キャンペーンの目的によっては、すべてのTweetがプロモーションに適しているとは限りません。詳細はObjective-based Campaignsをご覧ください。 PROMOTED_ACCOUNT プロダクトタイプを使用する場合、line_item にTweetを関連付けると、標準の PROMOTED_ACCOUNT 配置に加え、モバイルのタイムライン配置が追加されます。 注記: プロモーション対象のTweetエンティティを更新（PUT）することはできません。 Resource URL https://ads-api.x.com/12/accounts/:account_id/promoted_tweets Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべてのAdvertiser APIリクエストで原則必須のパラメータです。指定のアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
line_item_id
required		リクエストで操作するラインアイテムの参照。

Type: string

Example: 8v7jo
tweet_ids
required		対象のTweetに対応する識別子のカンマ区切りリスト。最大50個のIDを指定できます。

Type: long

Example: 822333526255120384
Example Request POST https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_tweets?line_item_id=8v7jo&tweet_ids=822333526255120384 Example Response 
    {
      "data": [
        {
          "line_item_id": "8v7jo",
          "id": "1e8i2k",
          "entity_status": "ACTIVE",
          "created_at": "2017-06-24T04:21:36Z",
          "updated_at": "2017-06-24T04:21:36Z",
          "approval_status": "ACCEPTED",
          "tweet_id": "822333526255120384",
          "deleted": false
        }
      ],
      "request": {
        "params": {
          "line_item_id": "8v7jo",
          "tweet_ids": [
            822333526255120384
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "total_count": 1
    }

​
DELETE accounts/:account_id/promoted_tweets/:promoted_tweet_id

指定したラインアイテムから Tweet の関連付けを解除します。 注: 削除された promoted_tweets エンティティは ads.x.com の UI で「一時停止」と表示されます。同様に、UI で「一時停止」すると、その Tweet はラインアイテムとの関連付けが解除されます。 リソース URL https://ads-api.x.com/12/accounts/:account_id/promoted_tweets/:promoted_tweet_id パラメータ
名前説明
account_id
必須		対象アカウントの識別子。リソースのパスに含まれ、GET accounts を除くすべての Advertiser API リクエストで通常必須のパラメータです。指定するアカウントは認証済みユーザーに関連付けられている必要があります。

型: string

例: 18ce54d4x5t
promoted_tweet_id
必須		ラインアイテムに関連付けられた Promoted Tweet のインスタンスを指す識別子です。これは対象の Tweet の tweet_id ではなく、GET accounts/:account_id/promoted_tweets のレスポンス項目に含まれる id フィールドの値です。リソースのパスで指定します。

型: string

例: 1gp8a5
リクエスト例 DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_tweets/1gp8a5 レスポンス例 
    {
      "data": {
        "line_item_id": "9pl99",
        "id": "1gp8a5",
        "entity_status": "ACTIVE",
        "created_at": "2017-08-17T17:02:21Z",
        "updated_at": "2017-08-18T06:43:48Z",
        "approval_status": "ACCEPTED",
        "tweet_id": "844796297743757315",
        "deleted": true
      },
      "request": {
        "params": {
          "promoted_tweet_id": "1gp8a5",
          "account_id": "18ce54d4x5t"
        }
      }
    }

​
プロモーション可能なユーザー

​
GET accounts/:account_id/promotable_users

現在のアカウントに関連付けられているプロモーション対象ユーザーの一部またはすべての詳細を取得します。 プロモーション対象ユーザーのタイプは FULL または RETWEETS_ONLY のいずれかです。これは、そのアカウントでプロモーションできるコンテンツの種類を制御します。広告主は、他のユーザーのコンテンツをプロモーションするには許可を取得し、そのユーザーを自分のアカウントの RETWEETS_ONLY のプロモーション対象ユーザーとして追加してもらうために X に連絡する必要があります。 権限が正しく設定されていれば、プロモーテッドプロダクトのエンドポイントに対して、プロモーションしたい Tweet の Tweet ID を直接参照するリクエストを送信できます。公開済みの Tweets をプロモーションするには POST accounts/:account_id/promoted-tweets エンドポイントを、他の X 広告アカウントの Scheduled Tweets をプロモーションするには POST accounts/:account_id/scheduled-promoted-tweets エンドポイントを使用できます。 対象の Tweet をリツイートする必要はありません。この方法で Tweet をプロモーションすると、返される tweet_id は指定した Tweet ID と異なります。内部的には、その Tweet は nullcast された Tweet としてリツイートされたうえでプロモーションされます。返される tweet_id はこの新しい Tweet を指します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/promotable_users Parameters
NameDescription
account_id
required		利用するアカウントの識別子。リソースのパス内に現れ、GET accounts を除くすべての Advertiser API リクエストで一般に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
count
optional		リクエストごとに取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
promotable_user_ids
optional		識別子のカンマ区切りリストを指定して、レスポンスを目的のプロモーション対象ユーザーのみに絞り込みます。最大 200 個の ID を指定できます。

Type: string

Example: l310s
sort_by
optional		サポートされている属性で昇順または降順に並べ替えます。詳細は Sorting を参照してください。

Type: string

Example: created_at-asc
with_deleted
optional		削除済みの結果を含めます。

Type: boolean

Default: false
Possible values: true, false
with_total_count
optional		total_count レスポンス属性を含めます。

Note: このパラメータと cursor は同時に使用できません。

Note: total_count を含むリクエストはレート制限が低く、現在は 15 分あたり 200 に設定されています。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promotable_users?promotable_user_ids=l310s Example Response 
    {
      "request": {
        "params": {
          "promotable_user_ids": [
            "l310s"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "user_id": "756201191646691328",
          "id": "l310s",
          "created_at": "2016-07-21T22:42:09Z",
          "updated_at": "2016-07-21T22:42:09Z",
          "deleted": false,
          "promotable_user_type": "FULL"
        }
      ]
    }

​
GET accounts/:account_id/promotable_users/:promotable_user_id

現在のアカウントに紐づく特定のプロモーション対象ユーザーを取得します。 プロモーション対象ユーザーのタイプは FULL または RETWEETS_ONLY のいずれかです。これは、そのアカウントでプロモーションできるコンテンツの種類を制御します。 広告主は、他ユーザーのコンテンツをプロモーションするための許可を得る必要があります。適切に権限が設定されていれば、プロモーション対象のプロダクトのエンドポイントに対して、プロモーションしたい Tweet の Tweet ID を直接参照するリクエストを送信できます。 対象の Tweet をリツイートする必要はありません。この方法で Tweet をプロモーションする場合、返される tweet_id は、入力した Tweet ID とは異なります。内部的には、その Tweet が nullcast された Tweet としてリツイートされ、その後プロモーションされます。返される tweet_id はこの新しい Tweet に対応します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/promotable_users/:promotable_user_id Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定されたアカウントは認証済みユーザーに紐づいている必要があります。

Type: string

Example: 18ce54d4x5t
promotable_user_id
optional		このリクエストで操作対象となるプロモーション対象ユーザーへの参照

Type: string

Example: l310s
with_deleted
optional		削除済みの結果をレスポンスに含めるかどうか。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promotable_users/l310s Example Response 
    {
      "request": {
        "params": {
          "promotable_user_id": "l310s",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "user_id": "2417045708",
        "id": "l310s",
        "created_at": "2017-03-10T17:51:24Z",
        "updated_at": "2017-03-10T17:51:24Z",
        "deleted": false,
        "promotable_user_type": "RETWEETS_ONLY"
      }
    }

​
パブリッシャー

​
GET publishers

コンテンツカテゴリのパブリッシャーの詳細一覧を取得します 詳しくは Video Views Preroll Objective Guideをご参照ください Resource URL https://ads-api.x.com/12/publishers Parameters リクエストパラメータはありません Example Request GET https://ads-api.x.com/12/publishers Example Response 
{
      "request": {
        "params": {}
      },
      "next_cursor": null,
      "data": [
        {
          "monetizable_country_codes": [
            "US"
          ],
          "promotion_eligible_country_codes": [
            "US"
          ],
          "username": "PeoplesSports",
          "user_id": "1353868435021721602",
          "monetization_restricted": true,
          "content_category_ids": [
            "se"
          ]
        },
        {
          "monetizable_country_codes": [
            "JP"
          ],
          "promotion_eligible_country_codes": [
            "JP"
          ],
          "username": "NewYork_Jack",
          "user_id": "1331177123436851206",
          "monetization_restricted": true,
          "content_category_ids": [
            "sk"
          ]
        },
        {
          "monetizable_country_codes": [
            "JP"
          ],
          "promotion_eligible_country_codes": [
            "JP"
          ],
          "username": "twispatv",
          "user_id": "1331165719128461314",
          "monetization_restricted": true,
          "content_category_ids": [
            "sm"
          ]
        },
        {
          "monetizable_country_codes": [
            "US"
          ],
          "promotion_eligible_country_codes": [
            "US"
          ],
          "username": "LAThieves",
          "user_id": "1316808678897455105",
          "monetization_restricted": true,
          "content_category_ids": [
            "s0"
          ]
        },
        {
          "monetizable_country_codes": [
            "US"
          ],
          "promotion_eligible_country_codes": [
            "US"
          ],
          "username": "Quicktake_EE",
          "user_id": "1305900477427724290",
          "monetization_restricted": true,
          "content_category_ids": [
            "sr"
          ]
        },
        {
          "monetizable_country_codes": [
            "BR"
          ],
          "promotion_eligible_country_codes": [
            "BR"
          ],
          "username": "eufloribella",
          "user_id": "1300812459054436354",
          "monetization_restricted": true,
          "content_category_ids": [
            "sm"
          ]
        },
        {
          "monetizable_country_codes": [
            "EG"
          ],
          "promotion_eligible_country_codes": [
            "KW",
            "EG",
            "SA",
            "AE",
            "LB",
            "QA"
          ],
          "username": "Egypt2021EN",
          "user_id": "1296077573399678977",
          "monetization_restricted": true,
          "content_category_ids": [
            "se"
          ]
        },
        {
          "monetizable_country_codes": [
            "US"
          ],
          "promotion_eligible_country_codes": [
            "US"
          ],
          "username": "ClubShayShay",
          "user_id": "1283068366706454529",
          "monetization_restricted": true,
          "content_category_ids": [
            "se"
          ]
        },
        {
          "monetizable_country_codes": [
            "IN",
            "KW",
            "ID",
            "EG",
            "SG",
            "TH",
            "MY",
            "PH",
            "ES",
            "US",
            "AU",
            "SA",
            "AE",
            "LB",
            "GB",
            "FR",
            "KR",
            "BR",
            "MX",
            "QA",
            "CA",
            "JP"
          ],
          "promotion_eligible_country_codes": [
            "KW",
            "EG",
            "SA",
            "AE",
            "LB",
            "QA"
          ],
          "username": "hiaahsanshow",
          "user_id": "1253421442143641601",
          "monetization_restricted": false,
          "content_category_ids": [
            "sh"
          ]
        },
        {
          "monetizable_country_codes": [
            "TH"
          ],
          "promotion_eligible_country_codes": [
            "TH"
          ],
          "username": "HoneKrasae",
          "user_id": "1240684293719904256",
          "monetization_restricted": true,
          "content_category_ids": [
            "sr"
          ]
        },
        {
          "monetizable_country_codes": [
            "US"
          ],
          "promotion_eligible_country_codes": [
            "US"
          ],
          "username": "Sportskind",
          "user_id": "1232708694418300930",
          "monetization_restricted": true,
          "content_category_ids": [
            "se"
          ]
        },
        {
          "monetizable_country_codes": [
            "IN",
            "KW",
            "ID",
            "EG",
            "SG",
            "TH",
            "MY",
            "PH",
            "ES",
            "US",
            "AU",
            "SA",
            "AE",
            "LB",
            "GB",
            "FR",
            "KR",
            "BR",
            "MX",
            "QA",
            "CA",
            "JP"
          ],
          "promotion_eligible_country_codes": [
            "KW",
            "EG",
            "SA",
            "AE",
            "LB",
            "QA"
          ],
          "username": "almeerathShow",
          "user_id": "1229410512762437633",
          "monetization_restricted": false,
          "content_category_ids": [
            "sh"
          ]
        },
        {
          "monetizable_country_codes": [
            "US"
          ],
          "promotion_eligible_country_codes": [
            "US"
          ],
          "username": "SeeYourVoiceFOX",
          "user_id": "1225490734653947904",
          "monetization_restricted": true,
          "content_category_ids": [
            "sh"
          ]
        },
        {
          "monetizable_country_codes": [
            "IN",
            "KW",
            "ID",
            "EG",
            "SG",
            "TH",
            "MY",
            "PH",
            "ES",
            "US",
            "AU",
            "SA",
            "AE",
            "LB",
            "GB",
            "FR",
            "KR",
            "BR",
            "MX",
            "QA",
            "CA",
            "JP"
          ],
          "promotion_eligible_country_codes": [
            "US"
          ],
          "username": "AUProSports",
          "user_id": "1219303449768185859",
          "monetization_restricted": false,
          "content_category_ids": [
            "se"
          ]
        }
      ]
    }

​
推奨

​
GET accounts/:account_id/recommendations

ステータス: クローズドベータ この広告アカウントに関連付けられたキャンペーンのレコメンデーションを取得します。現在、資金管理インストゥルメントごとにレコメンデーションは1件に制限されています。 リソース URL https://ads-api.x.com/5/accounts/:account_id/recommendations パラメータ
名前説明
account_id
必須		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定されたアカウントは、認証済みユーザーに関連付けられている必要があります。

型: string

例: 18ce54d4x5t
リクエスト例 GET https://ads-api.x.com/5/accounts/18ce54d4x5t/recommendations レスポンス例 
    "request": {
      "params": {
        "account_id": "18ce54d4x5t"
      }
    },
    "total_count": 1,
    "data": [
      {
        "funding_instrument_id": "gpvzb",
        "id": "62ce8zza1q0w",
        "account_id": "18ce54d4x5t",
        "status": "PENDING",
        "message": "テスト用の推奨事項",
        "created_at": "2016-11-14T23:07:54Z",
        "updated_at": "2016-11-14T23:07:54Z"
      }
    ]

​
GET accounts/:account_id/recommendations/:recommendation_id

Status: クローズドベータ この広告アカウントに紐づく特定のキャンペーン推奨を取得します。 キャンペーン推奨には、オブジェクトツリーとして表現されたキャンペーン構造に対して提案される変更の完全なセットが含まれます。レスポンスのツリーは Batch API エンドポイントと組み合わせて利用することを想定していますが、必要に応じて単一の更新エンドポイントにも対応付けできます（POST は Create、PUT は Update、DELETE は Delete）。 Resource URL https://ads-api.x.com/5/accounts/:account_id/recommendations/:recommendation_id Parameters
NameDescription
account_id
必須		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで原則必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
recommendation_id
必須		当該リクエストで操作対象となる推奨の ID 参照

Type: string

Example: 62ce8zza1q0w
Example Request GET https://ads-api.x.com/5/accounts/18ce54d4x5t/recommendations/62ce8zza1q0w Example Response 
{
    "request": {
      "params": {
        "recommendation_id": "62ce8zza1q0w",
        "account_id": "18ce54d4x5t"
      }
    },
    "data_type": "recommendations",
      "data": {
      "changes": [
        {
          "entity_type": "campaigns",
          "params": {
            "start_time": "2016-11-08T22:00:00Z",
            "daily_budget_amount_local_micro": 2200000,
            "end_time": "2016-11-16T07:59:00Z",
            "total_budget_amount_local_micro": 12000000,
            "id": "64m0d"
          },
          "operation_type": "Update",
          "dependent_entities": [
            {
              "entity_type": "line_items",
              "params": {
                "name": "レコメンデーション用キャンペーン",
                "placements": [
                  "TWITTER_TIMELINE"
                ],
                "bid_amount_local_micro": 1430000,
                "id": "6f5kq",
                "include_sentiment": "ALL"
              },
              "operation_type": "Update",
              "dependent_entities": [
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "id": "a8po6p"
                  },
                  "operation_type": null,
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "line_item_id": "6f5kq",
                    "name": "選挙結果",
                    "targeting_value": "選挙結果",
                    "targeting_type": "PHRASE_KEYWORD"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "promoted_tweets",
                  "params": {
                    "id": "101ftp"
                  },
                  "operation_type": "Delete",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "line_item_id": "6f5kq",
                    "name": "男性",
                    "targeting_value": 1,
                    "targeting_type": "GENDER"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "line_item_id": "6f5kq",
                    "name": "サンフランシスコ・オークランド・サンノゼ CA、米国",
                    "targeting_value": "",
                    "targeting_type": "LOCATION"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "promoted_tweets",
                  "params": {
                    "id": "101fto"
                  },
                  "operation_type": "Delete",
                  "dependent_entities": []
                },
                {
                  "entity_type": "promoted_tweets",
                  "params": {
                    "line_item_id": "6f5kq",
                    "display_properties": [],
                    "paused": false,
                    "approval_status": "ACCEPTED",
                    "tweet_id": "91125952589766656"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "line_item_id": "6f5kq",
                    "name": "パートナーオーディエンスターゲティング",
                    "targeting_value": "v2cx",
                    "targeting_type": "NEGATIVE_BEHAVIOR"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "line_item_id": "6f5kq",
                    "name": "AGE_21_TO_34",
                    "targeting_value": "AGE_21_TO_34",
                    "targeting_type": "AGE"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "id": "a8po6o"
                  },
                  "operation_type": "Delete",
                  "dependent_entities": []
                },
                {
                  "entity_type": "promoted_tweets",
                  "params": {
                    "line_item_id": "6f5kq",
                    "display_properties": [],
                    "paused": false,
                    "approval_status": "ACCEPTED",
                    "tweet_id": "991101965843460096"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "promoted_tweets",
                  "params": {
                    "line_item_id": "6f5kq",
                    "display_properties": [],
                    "paused": false,
                    "approval_status": "ACCEPTED",
                    "tweet_id": "991127212156096516"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "line_item_id": "6f5kq",
                    "name": "討論",
                    "targeting_value": "討論",
                    "targeting_type": "NEGATIVE_PHRASE_KEYWORD"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "line_item_id": "6f5kq",
                    "name": "60004、IL、米国",
                    "targeting_value": "",
                    "targeting_type": "LOCATION"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "id": "a8po6n"
                  },
                  "operation_type": null,
                  "dependent_entities": []
                },
                {
                  "entity_type": "promoted_tweets",
                  "params": {
                    "id": "101ftn"
                  },
                  "operation_type": null,
                  "dependent_entities": []
                }
              ]
            }
          ]
        }
      ],
      "funding_instrument_id": "gpvzb",
      "id": "62ce8zza1q0w",
      "account_id": "18ce54d4x5t",
      "status": "PENDING",
      "message": "テスト用レコメンデーション",
      "created_at": "2016-11-14T23:07:54Z",
      "updated_at": "2016-11-14T23:07:54Z"
      }
    }

​
予約済みのプロモーションTweet

​
GET accounts/:account_id/scheduled_promoted_tweets

現在のアカウントに関連付けられているスケジュール済みのプロモーションTweetの一部または全件の詳細を取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/scheduled_promoted_tweets Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般に必須です。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
count
optional		リクエストごとに取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
line_item_ids
optional		カンマ区切りの識別子リストを指定して、特定のラインアイテムに関連付けられたスケジュール済みTweetのみにレスポンスを絞り込みます。最大200個のIDを指定できます。

Type: string

Example: 8xdpe
scheduled_promoted_tweet_ids
optional		カンマ区切りの識別子リストを指定して、目的のスケジュール済みのプロモーションTweetのみにレスポンスを絞り込みます。最大200個のIDを指定できます。

Type: string

Example: 1xboq
sort_by
optional		サポートされている属性で昇順または降順にソートします。詳細は Sorting を参照してください。

Type: string

Example: created_at-asc
with_deleted
optional		削除済みの結果を含めます。

Type: boolean

Default: false
Possible values: true, false
with_total_count
optional		レスポンスに total_count 属性を含めます。

Note: このパラメータと cursor は同時に使用できません。

Note: total_count を含むリクエストには、現在15分あたり200の低いレート制限が適用されます。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets?scheduled_promoted_tweet_ids=1xboq Example Response 
    {
      "request": {
        "params": {
          "scheduled_promoted_tweet_ids": [
            "1xboq"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "line_item_id": "8xdpe",
          "id": "1xboq",
          "created_at": "2017-06-01T19:53:32Z",
          "updated_at": "2017-06-01T20:00:06Z",
          "scheduled_tweet_id": "870366669373194240",
          "tweet_id": "870369382207070208",
          "deleted": false
        }
      ]
    }

​
GET accounts/:account_id/scheduled_promoted_tweets/:scheduled_promoted_tweet_id

現在のアカウントに紐づく特定のスケジュール済みプロモート済みTweetを取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/scheduled_promoted_tweets/:scheduled_promoted_tweet_id Parameters
NameDescription
account_id
必須		利用するアカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで通常必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
scheduled_promoted_tweet_id
必須		リクエストで操作対象となるスケジュール済みプロモート済みTweetを参照します。

Type: string

Example: 1xboq
with_deleted
任意		削除済みの結果を含めるかどうか。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets/1xboq Example Response 
    {
      "request": {
        "params": {
          "scheduled_promoted_tweet_id": "1xboq",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "8xdpe",
        "id": "1xboq",
        "created_at": "2017-06-01T19:53:32Z",
        "updated_at": "2017-06-01T20:00:06Z",
        "scheduled_tweet_id": "870366669373194240",
        "tweet_id": "870369382207070208",
        "deleted": false
      }
    }

​
POST accounts/:account_id/scheduled_promoted_tweets

指定したラインアイテムにスケジュール済みのTweetを関連付けます。 Note: スケジュール済みのプロモートTweetエンティティは更新（PUT）できません。 Resource URL https://ads-api.x.com/12/accounts/:account_id/scheduled_promoted_tweets Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定のアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
line_item_id
required		リクエストで操作するラインアイテムの参照。

Type: string

Example: 8xdpe
scheduled_tweet_id
required		リクエストで操作するスケジュール済みTweetの参照。

Type: long

Example: 870358555227860992
Example Request POST https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets?line_item_id=8xdpe&scheduled_tweet_id=870358555227860992 Example Response 
    {
      "data": {
        "line_item_id": "8xdpe",
        "id": "1xtfl",
        "created_at": "2017-06-08T07:25:26Z",
        "updated_at": "2017-06-08T07:25:26Z",
        "scheduled_tweet_id": "870358555227860992",
        "tweet_id": null,
        "deleted": false
      },
      "request": {
        "params": {
          "line_item_id": "8xdpe",
          "scheduled_tweet_id": 870358555227860992,
          "account_id": "18ce54d4x5t"
        }
      }
    }

​
DELETE accounts/:account_id/scheduled_promoted_tweets/:scheduled_promoted_tweet_id

指定したラインアイテムから、予約済みのTweetの関連付けを解除します。 注: scheduled_promoted_tweets は、対象の予約済みTweetの scheduled_at 時刻「より前」にのみ削除できます。 Resource URL https://ads-api.x.com/12/accounts/:account_id/scheduled_tweets/:scheduled_tweet_id Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
scheduled_promoted_tweet_id
required		リクエストで操作する予約済みプロモーテッドTweetへの参照。これは GET accounts/:account_id/scheduled_promoted_tweets のレスポンスオブジェクトに含まれる id 属性です。

Type: string

Example: 1xtfl
Example Request DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets/1xtfl Example Response 
    {
      "data": {
        "line_item_id": "8xdpe",
        "id": "1xtfl",
        "created_at": "2017-06-08T07:25:26Z",
        "updated_at": "2017-06-15T05:14:12Z",
        "scheduled_tweet_id": "870358555227860992",
        "tweet_id": null,
        "deleted": true
      },
      "request": {
        "params": {
          "scheduled_promoted_tweet_id": "1xtfl",
          "account_id": "18ce54d4x5t"
        }
      }
    }

​
ターゲティング基準

​
GET accounts/:account_id/targeting_criteria

現在のアカウント配下のラインアイテムに関連付けられたターゲティング条件の一部またはすべての詳細を取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/targeting_criteria Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
line_item_ids
required		指定したラインアイテム配下のターゲティング条件のみにレスポンスを絞り込むため、カンマ区切りの識別子リストを指定します。最大 200 個の ID を指定できます。

Type: string

Example: 8u94t
count
optional		リクエストごとに取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
lang
optional		ISO-639-1 言語コード。指定された場合、ローカライズ名が利用可能なオブジェクトについては、レスポンスに追加の localized_name 属性が返されます。

Type: string

Example: fr
sort_by
optional		サポートされる属性で昇順または降順にソートします。詳細は Sorting を参照してください。

Type: string

Example: created_at-asc
targeting_criterion_ids
optional		目的のターゲティング条件のみにレスポンスを絞り込むため、カンマ区切りの識別子リストを指定します。最大 200 個の ID を指定できます。

Type: string

Example: dpl3a6
with_deleted
optional		削除済みの結果をレスポンスに含めます。

Type: boolean

Default: false
Possible values: true, false
with_total_count
optional		レスポンスに total_count 属性を含めます。

Note: このパラメータと cursor は排他的です。

Note: total_count を含むリクエストはレート制限が低く、現在は 15 分あたり 200 に設定されています。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_criteria?line_item_ids=8u94t Example Response 
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "line_item_ids": [
            "8u94t"
          ]
        }
      },
      "next_cursor": null,
      "data": [
        {
          "line_item_id": "8u94t",
          "name": "カスタムオーディエンスのターゲティング",
          "id": "dpl3a6",
          "operator_type": "EQ",
          "created_at": "2017-05-26T03:29:35Z",
          "targeting_value": "249yj",
          "updated_at": "2017-05-26T03:29:35Z",
          "deleted": false,
          "targeting_type": "CUSTOM_AUDIENCE"
        }
      ]
    }

​
GET accounts/:account_id/targeting_criteria/:targeting_criterion_id

現在のアカウントに紐づく特定のターゲティング条件を取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/targeting_criteria/:targeting_criterion_id Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは、認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
targeting_criterion_id
required		リクエストで操作するターゲティング条件を参照する識別子。

Type: string

Example: eijd4y
lang
optional		ISO-639-1 言語コード。指定すると、ローカライズ名が利用可能なオブジェクトについては、レスポンスに追加の localized_name 属性が返されます。

Type: string

Example: fr
with_deleted
optional		削除済みの結果をレスポンスに含めるかどうか。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_criteria/eijd4y Example Response 
    {
      "request": {
        "params": {
          "targeting_criterion_id": "eijd4y",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "619jl",
        "name": "🤖",
        "id": "eijd4y",
        "created_at": "2017-07-06T16:51:04Z",
        "targeting_value": "🤖",
        "updated_at": "2017-07-06T16:51:04Z",
        "deleted": false,
        "targeting_type": "BROAD_KEYWORD"
      }
    }

​
POST accounts/:account_id/targeting_criteria

特定のターゲティングタイプに対応する targeting_value は、Targeting Options ページを参照してください。常に最新のターゲティングタイプ値を使用できるよう、すべてのデータを毎週更新することを推奨します。値や利用可能なターゲティング基準は随時変更されます。多くは頻繁には変わりませんが、一部は変更される場合があります。これらの値が変更されないことは保証されません。 targeting_value で指定したキーワードを用いて、BROAD_KEYWORD、EXACT_KEYWORD、PHRASE_KEYWORD、または UNORDERED_KEYWORD のターゲティングタイプを使用します。キーワードを除外するには、operator_type リクエストパラメータを NE に設定してください。各タイプの詳細な説明は targeting keyword types を参照してください。 Note: 1つのラインアイテムにつき、ターゲットにできる年齢バケットは1つだけです。 Note: Custom Audience をターゲットにするには、そのオーディエンスがターゲット可能である必要があります。すなわち、targetable が true である必要があります。 Note: ターゲティングタイプ TV_SHOW を使用する場合、TV_SHOW ターゲティングを設定する前に、そのラインアイテムに少なくとも1つの LOCATION ターゲティング基準が存在し、かつターゲットとする TV_SHOW と同一のロケール内の LOCATION でなければなりません。 Resource URL https://ads-api.x.com/12/accounts/:account_id/targeting_criteria Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に現れ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
line_item_id
required		リクエストで操作対象となるラインアイテムの参照。

Type: string

Example: 69ob
operator_type
required		ターゲティング基準が持つべき関係を指定します。たとえば、キーワードを除外するには operator_type=NE を使用します。

Type: enum

Possible values: EQ, NE, GTE, LT
targeting_type
required		このラインアイテムに適用されるターゲティングのタイプ。

キーワード非ベースの値の例: AGE, DEVICE, EVENT, CAMPAIGN_ENGAGEMENT, CAMPAIGN_ENGAGEMENT_LOOKALIKE, CONVERSATION, ENGAGEMENT_TYPE, FOLLOWERS_OF_USER, GENDER, INTEREST, LANGUAGE, LIVE_TV_EVENT, LOCATION, NETWORK_ACTIVATION_DURATION, NETWORK_OPERATOR, PLATFORM, PLATFORM_VERSION, SIMILAR_TO_FOLLOWERS_OF_USER, TV_SHOW, USER_ENGAGEMENT, USER_ENGAGEMENT_LOOKALIKE, WIFI_ONLY

Note: 1つのラインアイテムにつき、ターゲットにできる AGE バケットは1つだけです。

キーワードベースの値の例: BROAD_KEYWORD, EXACT_KEYWORD, PHRASE_KEYWORD, UNORDERED_KEYWORD

カスタムオーディエンス関連の値: CUSTOM_AUDIENCE, CUSTOM_AUDIENCE_EXPANDED

インストール済みアプリのストアカテゴリ関連の値: APP_STORE_CATEGORY, APP_STORE_CATEGORY_LOOKALIKE

Twitter Audience Platform (TAP) のアプリ除外: APP_LIST（operator_type=NE と併用時のみ使用可能）
targeting_value
required		選択した targeting_type に応じて、このターゲティングの適用対象（どのユーザー、関心、場所、イベント、プラットフォーム、プラットフォームバージョン、デバイス、キーワードまたはフレーズ、性別、Custom Audience、アプリストアカテゴリ、またはアプリリストの除外）を指定します。

Type: string

Example: 174958347
Example Request POST https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_criteria?line_item_id=619jl&targeting_type=BROAD_KEYWORD&targeting_value=technology レスポンス例 
    {
      "data": {
        "line_item_id": "619jl",
        "name": "technology",
        "id": "fbyjlr",
        "created_at": "2017-09-06T07:31:21Z",
        "targeting_value": "technology",
        "updated_at": "2017-09-06T07:31:21Z",
        "deleted": false,
        "targeting_type": "BROAD_KEYWORD"
      },
      "request": {
        "params": {
          "line_item_id": "619jl",
          "targeting_type": "BROAD_KEYWORD",
          "targeting_value": "technology",
          "account_id": "18ce54d4x5t"
        }
      }
    }

​
POST batch/accounts/:account_id/targeting_criteria

単一のリクエストで新しいターゲティング基準（Targeting Criteria）をバッチ作成できます。 バッチリクエスト
  • 現在の最大バッチサイズは500です。
  • すべてのパラメータはリクエストボディで送信され、Content-Type は application/json が必須です。
  • バッチリクエストはグループとして一括で成功または失敗し、エラー時・成功時ともに API レスポンスで初回リクエストの項目順が保持されます。
バッチレスポンス バッチ API レスポンスは順序付きの項目コレクションを返します。その他は、対応する単一項目エンドポイントと同一の構造です。 バッチエラー
  • リクエストレベルのエラー（例：最大バッチサイズ超過）は、レスポンスの errors オブジェクトに表示されます。
  • アイテムレベルのエラー（例：必須のターゲティング基準パラメータの欠落）は、レスポンスの operation_errors オブジェクトに表示されます。
Resource URL https://ads-api.x.com/12/batch/accounts/:account_id/targeting_criteria Parameters
NameDescription
operation_type
required		各項目に対して実行される操作タイプ。

Type: enum

Possible values: Create, Delete
params
required		ターゲティング基準オブジェクトのすべてのパラメータを含む JSON オブジェクト。必須および任意のターゲティング基準パラメータの一覧はこちらを参照してください。

また、このエンドポイントは特定の targeting_type 値と組み合わせて使用する operator_type パラメータをサポートします。このパラメータの有効な値は、等しいを表す EQ、以上を表す GTE、未満を表す LT、等しくないを表す NE です。
Example Request POST https://ads-api.x.com/12/batch/accounts/18ce54d4x5t/targeting_criteria 
    [
      {
        "operation_type":"Create",
        "params":{
          "line_item_id":"6f9an",
          "targeting_type":"LOCATION",
          "targeting_value":"5122804691e5fecc"
        }
      },
      {
        "operation_type":"Delete",
        "params":{
          "targeting_criterion_id":"al2rua"
        }
      }
    ]
応答例 
    {
      "data_type": "targeting_criterion",
      "data": [
        {
          "line_item_id": "6f9an",
          "name": "San Francisco-Oakland-San Jose CA, US",
          "id": "al7vt2",
          "location_type": "CITY",
          "operator_type": "EQ",
          "created_at": "2016-11-11T22:59:50Z",
          "targeting_value": "5122804691e5fecc",
          "updated_at": "2016-11-11T22:59:50Z",
          "deleted": false,
          "targeting_type": "LOCATION"
        },
        {
          "line_item_id": "6keuo",
          "name": "accounts",
          "id": "al2rua",
          "operator_type": "EQ",
          "created_at": "2016-11-11T17:50:19Z",
          "targeting_value": "accounts",
          "updated_at": "2016-11-11T22:59:50Z",
          "deleted": true,
          "targeting_type": "BROAD_KEYWORD"
        }
      ],
      "request": [
        {
          "params": {
            "line_item_id": "6f9an",
            "targeting_type": "LOCATION",
            "targeting_value": "5122804691e5fecc",
            "account_id": "18ce54d4x5t"
          },
          "operation_type": "Create"
        },
        {
          "params": {
            "targeting_criterion_id": "al2rua",
            "account_id": "18ce54d4x5t"
          },
          "operation_type": "Delete"
        }
      ]
    }

​
DELETE accounts/:account_id/targeting_criteria/:targeting_criterion_id

現在のアカウントに属する指定のターゲティング条件を削除します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/targeting_criteria/:targeting_criterion_id Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般に必須のパラメータです。指定したアカウントは認証済みユーザーにひも付いている必要があります。

Type: string

Example: 18ce54d4x5t
targeting_criterion_id
required		リクエストで操作するターゲティング条件を参照する ID。

Type: string

Example: dpl3a6
Example Request DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_criteria/dpl3a6 Example Response 
    {
      "data": {
        "line_item_id": "8u94t",
        "name": "カスタムオーディエンスのターゲティング",
        "id": "dpl3a6",
        "created_at": "2017-05-26T03:29:35Z",
        "targeting_value": "249yj",
        "updated_at": "2017-08-30T18:38:58Z",
        "deleted": true,
        "targeting_type": "CUSTOM_AUDIENCE"
      },
      "request": {
        "params": {
          "targeting_criterion_id": "dpl3a6",
          "account_id": "18ce54d4x5t"
        }
      }
    }

​
ターゲティングのオプション

​
GET targeting_criteria/app_store_categories

プロモーション対象プロダクト向けの、アプリストアのカテゴリに基づくターゲティング条件を確認します。アプリストアのカテゴリは iOS App Store と Google Play ストアでのみ利用可能です。 インストール済みアプリのカテゴリターゲティングを使用すると、ユーザーがインストールしている、または関心を示しているアプリのカテゴリに基づいてターゲティングできます。 Resource URL https://ads-api.x.com/12/targeting_criteria/app_store_categories Parameters
NameDescription
q
optional		ターゲティング条件の範囲を絞るための任意のクエリ。すべてを取得するにはこのパラメータを省略します。

Type: string

Example: music
os_type
optional		特定のアプリストアで結果を絞り込みます。

Type: enum

Possible values: ANDROID, IOS
Example Request GET https://ads-api.x.com/12/targeting_criteria/app_store_categories?q=music&os_type=IOS Example Response 
    {
      "data": [
        {
          "name": "ゲーム：音楽",
          "targeting_type": "APP_STORE_CATEGORY",
          "targeting_value": "qouq",
          "os_type": "IOS"
        },
        {
          "name": "音楽",
          "targeting_type": "APP_STORE_CATEGORY",
          "targeting_value": "qov2",
          "os_type": "IOS"
        }
      ],
      "request": {
        "params": {
          "q": "music",
          "os_type": "IOS"
        }
      }
    }

​
GET targeting_criteria/conversations

プロモーション向けプロダクトで利用可能な、会話に基づくターゲティング基準を確認します。 Resource URL https://ads-api.x.com/12/targeting_criteria/conversations Parameters
NameDescription
conversation_type
optional		特定の会話タイプに絞り込むための任意のクエリです。

Type: enum

Possible values: ACTORS, ATHLETES, BOOK_GENRES, BOOKS, BRAND_CATEGORIES, BRANDS, CELEBRITIES, COACHES, DIGITAL_CREATORS, ENTERTAINMENT_BRANDS, ENTERTAINMENT_PERSONALITIES, FICTIONAL_CHARACTERS, JOURNALISTS, LIFESTYLES, MOVIE_GENRES, MOVIES, MUSIC_GENRES, MUSICIANS, NEWS_STORIES, NEWS, PERSONS, PLACES, PODCASTS, POLITICAL_AFFILIATIONS, POLITICIANS, PRODUCTS, RADIO_STATIONS, SPORTS_LEAGUES, SPORTS_PERSONALITIES, SPORTS_TEAMS, SPORTS, TRENDS, TV_SHOWS, VIDEO_GAME_PLATFORMS, VIDEO_GAME_PUBLISHERS, VIDEO_GAMES
count
optional		各リクエストで取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
Example Request GET https://ads-api.x.com/12/targeting_criteria/conversations?count=2 Example Response 
    {
      "request": {
        "params": {
          "count": 2
        }
      },
      "next_cursor": "1f7m7",
      "data": [
        {
          "targeting_type": "CONVERSATION",
          "targeting_value": "a1",
          "name": "NFL",
          "conversation_type": "SPORTS"
        },
        {
          "targeting_type": "CONVERSATION",
          "targeting_value": "a2",
          "name": "NBA",
          "conversation_type": "SPORTS"
        }
      ]
    }

​
GET targeting_criteria/devices

Promoted Products 向けのデバイスベースのターゲティング基準を取得します。デバイスターゲティングは Promoted Tweets で利用できます。 Resource URL https://ads-api.x.com/12/targeting_criteria/devices Parameters
NameDescription
count
optional		各リクエストで取得するレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
q
optional		ターゲティング基準を絞り込むための任意のクエリ。すべてを取得する場合はこのパラメータを省略します。

Type: string

Example: apple
Example Request GET https://ads-api.x.com/12/targeting_criteria/devices?count=2&q=iphone Example Response 
    {
      "data": [
        {
          "name": "iPhone 3GS",
          "manufacturer": "Apple",
          "os_type": "iOS",
          "targeting_value": "1q",
          "targeting_type": "DEVICE"
        },
        {
          "name": "iPhone 4",
          "manufacturer": "Apple",
          "os_type": "iOS",
          "targeting_value": "1r",
          "targeting_type": "DEVICE"
        }
      ],
      "request": {
        "params": {
          "q": "iphone",
          "count": 2
        }
      }
    }

​
GET targeting_criteria/events

プロモーションプロダクト向けに利用可能なイベントベースのターゲティング基準を確認します。1つのラインアイテムにつきターゲット指定できるイベントは1つのみです。 注: イベントはしばしば異なるタイムゾーンにまたがって存在するため、タイムゾーンをまたいでイベント時刻を考慮する際に複雑さが生じます。これを簡素化するため、本エンドポイントのすべてのイベントの start_time と end_time は、イベントのロケールやタイムゾーンに関係なく UTC±00:00 で表現されます。イベントの start_time および end_time をクエリまたは操作する際は、この設計を念頭に置いてください。たとえば、米国の Independence Day は UTC±00:00 において start_time=2017-07-04T00:00:00Z、end_time=2017-07-05T00:00:00Z として表され、米国内でこの祝日が複数のタイムゾーンにまたがることによる問題を回避します。 Resource URL https://ads-api.x.com/12/targeting_criteria/events Parameters
NameDescription
event_types
required		特定のイベントタイプに絞り込む任意のクエリ。

Type: enum

Possible values: CONFERENCE, HOLIDAY, MUSIC_AND_ENTERTAINMENT, OTHER, POLITICS, RECURRING, SPORTS
count
optional		各リクエストで取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
country_codes
optional		2文字のISO国コードを用いて、特定の国にターゲティング基準の検索を絞り込む任意のクエリ。このパラメータが指定されていない場合、すべてのイベントが返されます。

Type: string
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
end_time
optional		キャンペーンが終了する時刻（ISO 8601 形式）。

Type: string

Example: 2017-10-05T00:00:00Z
start_time
optional		ラインアイテムの配信開始時刻（ISO 8601 形式）。

注: 既定値は現在時刻です。

Type: string

Example: 2017-07-05T00:00:00Z
Example Request GET https://ads-api.x.com/12/targeting_criteria/events?count=1 Example Response 
    {
      "request": {
        "params": {
          "count": 1
        }
      },
      "data_type": "events",
      "data": [
        {
          "reach": {
            "total_reach": null
          },
          "name": "元日",
          "start_time": "2017-12-31T00:00:00Z",
          "top_users": [],
          "top_tweets": [],
          "top_hashtags": [],
          "gender_breakdown_percentage": {},
          "end_time": "2018-01-02T00:00:00Z",
          "country_code": null,
          "device_breakdown_percentage": {},
          "targeting_value": "1ex",
          "is_global": true,
          "event_type": "HOLIDAY",
          "country_breakdown_percentage": {}
        }
      ],
      "next_cursor": "uww0"
    }

​
GET targeting_criteria/interests

Promoted Products 向けの興味・関心に基づくターゲティング基準を取得します。興味・関心は頻繁には変更されませんが、このリストは少なくとも週に一度の更新を推奨します。 Resource URL https://ads-api.x.com/12/targeting_criteria/interests Parameters
NameDescription
count
optional		各リクエストで取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
q
optional		ターゲティング基準を絞り込むための任意のクエリ。すべてを取得する場合は、このパラメータを省略します。

Type: string

Example: books
Example Request GET https://ads-api.x.com/12/targeting_criteria/interests?q=books Example Response 
    {
      "data": [
        {
          "name": "Books and literature/Biographies and memoirs",
          "targeting_type": "INTEREST",
          "targeting_value": "1001"
        }
      ],
      "request": {
        "params": {
          "q": "books",
          "count": 1
        }
      },
      "next_cursor": "6by4n4"
    }

​
GET targeting_criteria/languages

ターゲティングで利用可能な言語を取得します。 Resource URL https://ads-api.x.com/12/targeting_criteria/languages Parameters
NameDescription
count
optional		各リクエストで取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
q
optional		ターゲティング条件を絞り込むための任意のクエリ。すべてを取得する場合はこのパラメータを省略してください。

Type: string

Example: english
Example Request GET https://ads-api.x.com/12/targeting_criteria/languages?q=english Example Response 
    {
      "data": [
        {
          "name": "English",
          "targeting_type": "LANGUAGE",
          "targeting_value": "en"
        }
      ],
      "request": {
        "params": {
          "q": "english"
        }
      },
      "next_cursor": null
    }

​
GET targeting_criteria/locations

Promoted Products 向けに利用可能な位置情報ベースのターゲティング条件を確認します。ジオターゲティングは、国、州/地域、都市、郵便番号の各レベルで Promoted Accounts および Promoted Tweets に対して利用できます。郵便番号レベルのアナリティクスを取得する場合は、郵便番号ターゲティングを使用する必要があります。 Note: サンフランシスコやニューヨークなど特定のターゲティング可能な都市を取得するには、location_type リクエストパラメータで CITIES 列挙型を使用してください。 Designated Market Area (DMA) をターゲティングするには、METROS 列挙型を使用してください。 Resource URL https://ads-api.x.com/12/targeting_criteria/locations Parameters
NameDescription
count
optional		1 回のリクエストで取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
country_code
optional		2 文字の ISO 国コードで、特定の国に絞り込んでターゲティング条件を検索するための任意パラメータです。すべての国の結果を取得するには、このパラメータを省略します。

Type: string

Example: JP
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
location_type
optional		特定の種類のロケーションで結果を絞り込みます。COUNTRIES より詳細なターゲティングは、すべてのロケーションで利用できるとは限りません。

Type: enum

Possible values: COUNTRIES, REGIONS, METROS, CITIES, POSTAL_CODES
q
optional		ターゲティング条件検索の絞り込みに使用する任意パラメータです。すべての結果を取得するには、このパラメータを省略します。

Type: string

Example: New York
Example Request GET https://ads-api.x.com/12/targeting_criteria/locations?location_type=CITIES&q=los angeles Example Response 
    {
      "data": [
        {
          "name": "Los Angeles, Los Angeles CA, CA, USA",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "3b77caf94bfc81fe",
          "targeting_type": "LOCATION"
        },
        {
          "name": "East Los Angeles, Los Angeles CA, CA, USA",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "67571a7baaa5906b",
          "targeting_type": "LOCATION"
        },
        {
          "name": "Lake Los Angeles, Los Angeles CA, CA, USA",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "ea9bfbd43c93400f",
          "targeting_type": "LOCATION"
        },
        {
          "name": "Los Gatos, San Francisco-Oakland-San Jose CA, CA, USA",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "a2de7c70b82b0ca0",
          "targeting_type": "LOCATION"
        },
        {
          "name": "Los Altos, Monterey-Salinas CA, CA, USA",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "6a4364ea6f987c10",
          "targeting_type": "LOCATION"
        },
        {
          "name": "Los Banos, CA, USA",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "b1b6fc646de75904",
          "targeting_type": "LOCATION"
        },
        {
          "name": "Los Alamitos, Los Angeles CA, CA, USA",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "0799ff0a3c1006e9",
          "targeting_type": "LOCATION"
        },
        {
          "name": "Los Angeles, US",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "019940ae78c7b3bc",
          "targeting_type": "LOCATION"
        }
      ],
      "request": {
        "params": {
          "location_type": "CITIES",
          "q": "los angeles"
        }
      },
      "next_cursor": null
    }

​
GET targeting_criteria/network_operators

プロモーションプロダクト向けの、利用可能な通信事業者ベースのターゲティング条件を確認します。 このエンドポイントでは、AT&T、Verizon、Sprint、T-Mobile など、複数の国におけるターゲティング可能な通信事業者を検索できます。 Resource URL https://ads-api.x.com/12/targeting_criteria/network_operators Parameters
NameDescription
count
optional		リクエストごとに取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
country_code
optional		2文字のISO国コードで、特定の国に絞ってターゲティング条件を検索するための任意パラメータです。このパラメータが指定されていない場合、米国のパートナーオーディエンスのみが返されます。

Type: string

Default: US
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
q
optional		ターゲティング条件の検索範囲を絞るための任意パラメータです。すべての結果を取得するには、このパラメータを省略してください。

Type: string

Examples: Airpeak
Example Request GET https://ads-api.x.com/12/targeting_criteria/network_operators?count=5&country_code=US Example Response 
    {
      "data": [
        {
          "country_code": "US",
          "targeting_type": "NETWORK_OPERATOR",
          "name": "Advantage",
          "targeting_value": "2l"
        },
        {
          "country_code": "US",
          "targeting_type": "NETWORK_OPERATOR",
          "name": "Aeris",
          "targeting_value": "1b"
        },
        {
          "country_code": "US",
          "targeting_type": "NETWORK_OPERATOR",
          "name": "Airadigm",
          "targeting_value": "2t"
        },
        {
          "country_code": "US",
          "targeting_type": "NETWORK_OPERATOR",
          "name": "Airlink PCS",
          "targeting_value": "14"
        },
        {
          "country_code": "US",
          "targeting_type": "NETWORK_OPERATOR",
          "name": "Airpeak",
          "targeting_value": "1i"
        }
      ],
      "request": {
        "params": {
          "country_code": "US",
          "count": 5
        }
      },
      "next_cursor": "o7x9iet1a5u608olj4"
    }

​
GET targeting_criteria/platform_versions

Promoted Products で利用可能な、モバイル OS バージョンに基づくターゲティング条件を確認します。プラットフォームのバージョンターゲティングは、Promoted Accounts および Promoted Tweets で利用可能です。これにより、Android 8.0 や iOS 10.0 など、モバイル OS のポイントリリースまで細かくターゲティングできます。 Resource URL https://ads-api.x.com/12/targeting_criteria/platform_versions Parameters
NameDescription
q
optional		ターゲティング条件の検索範囲を絞り込むための任意のクエリ。すべての結果を取得するには、このパラメータを省略します。

Type: string

Examples: jelly bean
Example Request GET https://ads-api.x.com/12/targeting_criteria/platform_versions Example Response 
    {
        "data": [
            {...},
            {
                "name": "Ice Cream Sandwich",
                "number": "4.0",
                "os_type": "Android",
                "targeting_type": "PLATFORM_VERSION",
                "targeting_value": "17"
            },
            {
                "name": "Jelly Bean",
                "number": "4.1",
                "os_type": "Android",
                "targeting_type": "PLATFORM_VERSION",
                "targeting_value": "18"
            },
            {...}
        ],
        "data_type": "targeting_criterion",
        "request": {
            "params": {}
        }
    }

​
GET targeting_criteria/platforms

Promoted Products 向けに、プラットフォームに基づく利用可能なターゲティング基準を取得します。 Resource URL https://ads-api.x.com/12/targeting_criteria/platforms Parameters
NameDescription
count
optional		各リクエストで取得するレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
q
optional		ターゲティング基準の検索範囲を絞り込む任意のクエリ。すべての結果を取得するには、このパラメータを省略します。

Type: string

Examples: ios, blackberry
lang
optional		ISO-639-1 の言語コード。指定した場合、レスポンスに追加の localized_name 属性が返されます。

Type: int, string

Example: fr
Example Request GET https://ads-api.x.com/12/targeting_criteria/platforms Example Response 
    {
      "data": [
        {
          "name": "iOS",
          "targeting_type": "PLATFORM",
          "targeting_value": "0"
        },
        {
          "name": "Android",
          "targeting_type": "PLATFORM",
          "targeting_value": "1"
        },
        {
          "name": "BlackBerry端末（スマートフォン・タブレット）",
          "targeting_type": "PLATFORM",
          "targeting_value": "2"
        },
        {
          "name": "その他のデバイスでのモバイルWeb",
          "targeting_type": "PLATFORM",
          "targeting_value": "3"
        },
        {
          "name": "デスクトップ・ノートパソコン",
          "targeting_type": "PLATFORM",
          "targeting_value": "4"
        }
      ],
      "request": {
        "params": {}
      }
    }

​
GET targeting_criteria/tv_markets

TV番組をターゲティングできる利用可能なTVマーケットを取得します。ロケールごとのマーケットを返し、GET targeting_criteria/tv_shows エンドポイントのクエリに使用できます。 Resource URL https://ads-api.x.com/12/targeting_criteria/tv_markets Parameters なし Example Request GET https://ads-api.x.com/12/targeting_criteria/tv_markets Example Response 
    {
      "data": [
        {
          "name": "フランス",
          "country_code": "FR",
          "locale": "fr-FR"
        },
        {
          "name": "チリ",
          "country_code": "CL",
          "locale": "es-CL"
        },
        {
          "name": "ドイツ",
          "country_code": "DE",
          "locale": "de-DE"
        },
        {
          "name": "オランダ",
          "country_code": "NL",
          "locale": "nl-NL"
        },
        {
          "name": "アメリカ合衆国",
          "country_code": "US",
          "locale": "en-US"
        },
        {
          "name": "ベネズエラ",
          "country_code": "VE",
          "locale": "es-VE"
        },
        {
          "name": "ブラジル",
          "country_code": "BR",
          "locale": "pt-BR"
        },
        {
          "name": "メキシコ",
          "country_code": "MX",
          "locale": "es-MX"
        },
        {
          "name": "コロンビア",
          "country_code": "CO",
          "locale": "es-CO"
        },
        {
          "name": "イギリス",
          "country_code": "GB",
          "locale": "en-GB"
        },
        {
          "name": "アルゼンチン",
          "country_code": "AR",
          "locale": "es-AR"
        },
        {
          "name": "日本",
          "country_code": "JP",
          "locale": "ja-JP"
        },
        {
          "name": "カナダ",
          "country_code": "CA",
          "locale": "en-CA"
        },
        {
          "name": "スペイン",
          "country_code": "ES",
          "locale": "es-ES"
        },
        {
          "name": "イタリア",
          "country_code": "IT",
          "locale": "it-IT"
        },
        {
          "name": "アメリカ合衆国 - ヒスパニック",
          "country_code": "US",
          "locale": "es-US"
        },
        {
          "name": "アイルランド",
          "country_code": "IE",
          "locale": "en-IE"
        }
      ],
      "request": {
        "params": {}
      }
    }

​
GET targeting_criteria/tv_shows

Promoted Products 向けに利用可能なテレビ番組ベースのターゲティング条件を確認します。テレビ番組ターゲティングは、一部の市場での Promoted Tweets に対して利用できます。利用可能な市場については、GET targeting_criteria/tv_markets エンドポイントを参照してください。 注: ユーザー数が 1,000 未満のオーディエンスは、estimated_users の値が 1000 と表示されます。 注: テレビチャンネルおよびジャンルのターゲティングオプションは、現在サポートされていません。 Resource URL https://ads-api.x.com/12/targeting_criteria/tv_shows Parameters
NameDescription
locale
required		利用可能なテレビ番組の照会対象となる tv_market_locale を指定する必須パラメータです。テレビ市場は、GET targeting_criteria/tv_markets によって返される locale に基づいて照会されます。

Type: string

Example: en-US
count
optional		個々のリクエストで取得を試みるレコード数を指定します。

Type: int

Default: 50
Min, Max: 1, 50
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
q
optional		ターゲティング条件の検索範囲を絞り込む任意のクエリです。すべての結果を取得するには、このパラメータを省略します。

Type: string

Examples: ios, blackberry
Example Request GET https://ads-api.x.com/12/targeting_criteria/tv_shows?locale=en-US&q=news&count=1 Example Response 
    {
      "data": [
        {
          "name": "NewsWatch",
          "targeting_value": 10027243420,
          "genre": "PAID",
          "locales": [
            {
              "language": "en",
              "country": "US"
            }
          ]
        }
      ],
      "next_cursor": "c-22838-zdQDJrTxSvOYfQOhb2IlGQ",
      "request": {
        "params": {
          "locale": {
            "countryCode": "US",
            "languageCode": "en"
          },
          "count": 1,
          "q": "news"
        }
      }
    }

​
ターゲティングの提案

​
GET accounts/:account_id/targeting_suggestions

初期の選択内容を補完するために、最大50件のキーワードまたはユーザーのターゲティング候補を取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/targeting_suggestions Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定されたアカウントは認証ユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
suggestion_type
required		返す候補の種類を指定します。

Type: enum

Possible values: KEYWORD, USER_ID
targeting_values
required		候補生成のシードとして使用する、キーワードまたはユーザーIDのカンマ区切りの集合。

Note: これら2種類の候補は混在できません。

Example: 756201191646691328
count
optional		各リクエストで取得を試みるレコード数を指定します。

Type: int

Default: 30
Min, Max: 1, 50
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_suggestions?suggestion_type=KEYWORD&targeting_values=developers&count=2" Example Response 
    {
      "data": [
        {
          "suggestion_type": "KEYWORD",
          "suggestion_value": "devs"
        },
        {
          "suggestion_type": "KEYWORD",
          "suggestion_value": "software"
        }
      ],
      "request": {
        "params": {
          "suggestion_type": "KEYWORD",
          "targeting_values": [
            "developers"
          ],
          "count": 2,
          "account_id": "18ce54d4x5t"
        }
      }
    }

​
税金設定

​
GET accounts/:account_id/tax_settings

現在のアカウントに関連付けられている税設定の詳細を取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/tax_settings Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで原則必須のパラメータです。指定したアカウントは、認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/tax_settings Example Response 
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "tax_id": "GB896391250",
        "address_city": "London",
        "business_relationship": "SELF",
        "address_street1": "21 March St",
        "address_last_name": null,
        "address_company": "ABC, Inc.",
        "tax_category": "BUSINESS_WITH_VAT",
        "address_postal_code": "SW1A 1AA",
        "bill_to": "NOT_SET",
        "address_region": "London",
        "address_country": "GB",
        "address_first_name": null,
        "invoice_jurisdiction": "NOT_SET",
        "address_street2": null,
        "address_email": null
      }
    }

​
PUT accounts/:account_id/tax_settings

現在のアカウントの税務設定を更新します。 リソースURL https://ads-api.x.com/12/accounts/:account_id/tax_settings パラメーター
名前説明
アカウント_id
必須項目		レバレッジドアカウントの識別子。リソース内に表示されます’のパスに含まれ、一般的に GET accounts を除くすべての Advertiser API リクエストで必須のパラメータですアカウントの取得。指定されたアカウントは、認証済みユーザーにひも付いている必要があります。

型: 文字列

例：18ce54d4x5t
アドレス_city（市）
※任意		アカウント所有者の市区町村’のアドレス。

型: string

例：サンフランシスコ
アドレス_国
任意		アカウント所有者の2文字の国コード’のアドレス。

型: string

例：米国
アドレス_メールアドレス
任意（オプション）		アカウント所有者に関連付けられているメールアドレス’のアドレス。

型: string

例：api@mctestface.com
アドレス_最初_名称
任意（オプション）		アカウント所有者の名’のアドレス。

型: string

例：API
アドレス_最終_氏名
任意		アカウント所有者の姓’のアドレス。

型: string

例：McTestface
住所_氏名
（任意）		アカウント所有者の企業名’のアドレス。

Type: 文字列型

例：ABC, Co.
アドレス_郵便の_コード
任意		アカウント所有者の郵便番号’のアドレス。

型: string

例：94102
アドレス_リージョン
任意		アカウント所有者の地域’のアドレス。

型: string

例：カリフォルニア
住所_住所1
※任意		アカウント所有者の住所（番地・丁目）行’のアドレス。

型: string

例：21 March St
アドレス_住所2
任意（オプション）		アカウント所有者の住所の2行目’のアドレス。

型: string

例：スイート 99号室
請求書_へ
任意（オプション）		請求先となる主体。

型: enum

指定可能な値:広告主、代理店
ビジネス_リレーションシップ
※任意		アカウントが広告主名義か代理店名義かを示します。

型: enum

指定可能な値：代理店、SELF
クライアント_住所_市区町村
任意		広告主の市区町村’のアドレス。

広告アカウントが代理店の所有である場合に設定します。

型: string

例：トロント
クライアント_住所_国
（任意）		広告主の2文字の国コード’のアドレス。

広告アカウントが代理店所有の場合に設定します。

型: string

例：CA
クライアント_住所_Eメール
任意（オプション）		広告主に紐づくメールアドレス’のアドレスです。

代理店が広告アカウントの所有者である場合に設定します。

型: string

例：ads@brand.com
クライアント_アドレス_最初_氏名
任意		広告主の名（ファーストネーム）‘アドレス。

広告アカウントが代理店所有の場合に設定します。

型: string

例：ブランド
クライアント_アドレス_最終_名前
オプション		広告主の姓’のアドレス。

広告アカウントが代理店所有の場合に設定します。

型: string

例：広告主
クライアント_アドレス_氏名
任意（オプション）		広告主の企業名’のアドレス。

広告アカウントが代理店所有の場合に設定します。

型: string

例：Brand, Inc.（米国法人）
クライアント_アドレス_郵便_コード
任意		広告主の郵便番号’のアドレス。

広告アカウントが代理店に所有されている場合に設定します。

型: string

例：M5H 2N2
クライアント_アドレス_リージョン
任意（オプション）		広告主の地域’のアドレス。

広告アカウントが代理店の所有である場合に設定します。

型: string

例：オンタリオ
クライアント_住所_住所1
任意		広告主の住所（番地・丁目など）‘のアドレス。

広告アカウントが代理店の所有である場合に設定します。

型: string

例：Queen St W 280
クライアント_アドレス_住所2
任意（オプション）		広告主の住所の2行目（番地・通り名）‘のアドレス。

広告アカウントが代理店所有の場合に設定します。

型: string

例：6
請求書_裁判管轄
任意（オプション）		請求書の管轄。

Type: 列挙型

指定可能な値:LOI_SAPIN,なし、未設定
税金_カテゴリー
任意		課税区分を個人か事業のどちらにするか。

Type: 列挙型

取り得る値：BUSINESS_NO_VAT、BUSINESS_WITH_VAT、個人
税金_適用除外_id
※任意		VAT 免税ID。

Type: sting

例：12345
税金_id
任意		VAT登録番号。

型: string

取り得る値：67890
リクエスト例 PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/tax_settings?address_name=ABC, Co. レスポンス例 
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "address_name": "ABC Co."
        }
      },
      "data": {
        "tax_id": "GB896391250",
        "address_city": "London",
        "business_relationship": "SELF",
        "address_street1": "21 March St",
        "address_last_name": null,
        "address_company": "ABC, Co.",
        "tax_category": "BUSINESS_WITH_VAT",
        "address_postal_code": "SW1A 1AA",
        "bill_to": "NOT_SET",
        "address_region": "London",
        "address_country": "GB",
        "address_first_name": null,
        "invoice_jurisdiction": "NOT_SET",
        "address_street2": null,
        "address_email": null
      }
    }

​
トラッキングタグ

​
GET accounts/:account_id/tracking_tags

現在のアカウントに関連付けられている一部またはすべてのトラッキングタグの詳細を取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/tracking_tags Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパスに含まれ、GET accounts を除くすべての Advertiser API リクエストで通常は必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
count
optional		個別のリクエストごとに取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
line_item_ids
optional		識別子をカンマ区切りで指定して、特定のラインアイテムに関連付けられたトラッキングタグのみにレスポンスを絞り込みます。最大 200 個の ID を指定できます。

Type: string

Example: 96uzp
sort_by
optional		サポート対象の属性で昇順または降順に並べ替えます。詳細は Sorting を参照してください。

Type: string

Example: created_at-asc
tracking_tag_ids
optional		識別子をカンマ区切りで指定して、目的のトラッキングタグのみにレスポンスを絞り込みます。最大 200 個の ID を指定できます。

Type: string

Example: 3m82
with_deleted
optional		削除済みの結果を含めます。

Type: boolean

Default: false
Possible values: true, false
with_total_count
optional		レスポンス属性 total_count を含めます。

Note: このパラメータと cursor は同時指定できません。

Note: total_count を含むリクエストはレート制限が低く、現在は 15 分あたり 200 に設定されています。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags?tracking_tag_ids=3m82 Example Response 
    {
      "request": {
        "params": {
          "tracking_tag_ids": [
            "3m82"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "line_item_id": "fdwcl",
          "tracking_tag_url": "https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309",
          "tracking_tag_type": "IMPRESSION_TAG",
          "id": "3m82",
          "created_at": "2019-06-26T17:04:26Z",
          "updated_at": "2019-06-26T17:04:26Z",
          "deleted": false
        }
      ]
    }

​
GET accounts/:account_id/tracking_tags/:tracking_tag_id

現在のアカウントに関連付けられている特定のトラッキングタグを取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/tracking_tags/:tracking_tag_id Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパスに含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定されたアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
tracking_tag_id
required		当該リクエストで操作するトラッキングタグを参照する識別子。

Type: string

Example: 555j
with_deleted
optional		削除済みの結果を含めるかどうか。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags/555j Example Response 
    {
      "request": {
        "params": {
          "with_deleted": true,
          "tracking_tag_id": "555j",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "72v2x",
        "tracking_tag_url": "https://ad.doubleclick.net/ddm/trackimp/N6344.2061500TWITTER-OFFICIAL/B23028778.279118262;dc_trk_aid=473354132;dc_trk_cid=119658253",
        "tracking_tag_type": "IMPRESSION_TAG",
        "id": "555j",
        "created_at": "2020-08-13T23:02:03Z",
        "updated_at": "2020-08-13T23:02:03Z",
        "deleted": false
      }
    }

​
POST accounts/:account_id/tracking_tags

指定したラインアイテムにトラッキングタグを関連付けます。 Resource URL https://ads-api.x.com/12/accounts/:account_id/tracking_tags Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパスに含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
line_item_id
required		リクエストで操作するラインアイテムの参照。

Type: string

Example: 8v7jo
tracking_tag_type
required		トラッキングタグの種類。

Type: enum

Possible value: IMPRESSION_TAG, CLICK_TRACKER
tracking_tag_url
required		トラッキングパートナーが提供するトラッキングタグのURL。

Type: string

Example: https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309
Example Request POST https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags?line_item_id=fdwcl&tracking_tag_type=IMPRESSION_TAG&tracking_tag_url=https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309 Example Response 
    {
      "request": {
        "params": {
          "line_item_id": "fdwcl",
          "tracking_tag_type": "IMPRESSION_TAG",
          "tracking_tag_url": "https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "fdwcl",
        "tracking_tag_url": "https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309",
        "tracking_tag_type": "IMPRESSION_TAG",
        "id": "3m82",
        "created_at": "2019-06-26T17:04:26Z",
        "updated_at": "2019-06-26T17:04:26Z",
        "deleted": false
      }
    }

​
PUT accounts/:account_id/tracking_tags/:tracking_tag_id

指定したラインアイテムにトラッキングタグを関連付けます。 Resource URL https://ads-api.x.com/12/accounts/:account_id/tracking_tags/:tracking_tag_id Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで原則必須のパラメータです。指定されたアカウントは認証済みユーザーに紐づいている必要があります。

Type: string

Example: 18ce54d4x5t
tracking_tag_url
required		トラッキングパートナーによって提供されるトラッキングタグのURL。

Type: string

Example: https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309
Example Request PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags/3m82?tracking_tag_url=https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309 Example Response 
    {
      "request": {
        "params": {
          "tracking_tag_id": "3m82",
          "tracking_tag_url": "https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "fdwcl",
        "tracking_tag_url": "https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309",
        "tracking_tag_type": "IMPRESSION_TAG",
        "id": "3m82",
        "created_at": "2019-06-26T17:04:26Z",
        "updated_at": "2022-01-26T17:04:26Z",
        "deleted": false
      }
    }

​
DELETE accounts/:account_id/tracking_tags/:tracking_tag_id

指定したラインアイテムからトラッキングタグの関連付けを解除します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/tracking_tags/:tracking_tag_id Parameters
NameDescription
account_id
required		対象となるアカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで通常必須のパラメータです。指定したアカウントは、認証済みユーザーに紐づいている必要があります。

Type: string

Example: 18ce54d4x5t
tracking_tag_id
required		リクエストで操作するトラッキングタグへの参照。

Type: string

Example: 555j
Example Request DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags/555j Example Response 
    {
      "request": {
        "params": {
          "tracking_tag_id": "555j",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "72v2x",
        "tracking_tag_url": "https://ad.doubleclick.net/ddm/trackimp/N6344.2061500TWITTER-OFFICIAL/B23028778.279118262;dc_trk_aid=473354132;dc_trk_cid=119658253",
        "tracking_tag_type": "IMPRESSION_TAG",
        "id": "555j",
        "created_at": "2020-08-13T23:02:03Z",
        "updated_at": "2021-08-29T17:12:58Z",
        "deleted": true
      }
    }

​
ユーザー設定

(https://app.getpostman.com/run-collection/1d12b9fc623b8e149f87)

​
GET accounts/:account_id/user_settings/:user_id

ユーザー設定を取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/user_settings/:user_id Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパスに含まれ、GET accounts を除くすべての Advertiser API リクエストで通常必須のパラメータです。
指定したアカウントは、認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
user_id
required		当該リクエストで操作するユーザーの参照。スクリーンネームから user ID を取得するには GET users/lookup を使用してください。

Type: long

Example: 756201191646691328
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/user_settings/756201191646691328 Example Response 
      {
        "request": {
          "params": {
            "account_id": "18ce54d4x5t",
            "user_id": "756201191646691328"
          }
        },
        "data": {
          "notification_email": "user@domain.com",
          "contact_phone": "",
          "contact_phone_extension": ""
        }
      }

​
PUT accounts/:account_id/user_settings/:user_id

ユーザー設定を更新します。ユーザーコンテキストが必要です。アカウント管理者はアクセスできません。 リソース URL https://ads-api.x.com/12/accounts/:account_id/user_settings/:user_id パラメータ
NameDescription
account_id
required		利用対象のアカウント識別子。リソースのパス内および GET accounts に表示されます。
指定したアカウントは認証済みユーザーに紐づいている必要があります。

Type: string

Example: 18ce54d4x5t
user_id
required		リクエストで操作するユーザーを指す参照。スクリーン名からユーザー ID を取得するには GET users/lookup を使用してください。

Type: long

Example: 756201191646691328
notification_email
optional		アカウント通知に使用するメールアドレス。

Type: string

Example: user@domain.com
contact_phone
optional		連絡先電話番号。

Type: string

Example: 202-555-0128
contact_phone_extension
optional		contact_phone の内線番号。

Type: string

Example: 1234
リクエスト例 PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/user_settings/756201191646691328?notification_email='user@domain.com'&subscribe_email_types=ACCOUNT_PERFORMANCE,PERFORMANCE_IMPROVEMENT" レスポンス例 
      {
        "request": {
          "params": {
            "account_id": "18ce54d4x5t",
            "user_id": "756201191646691328"
            "notification_email": "user@domain.com",
            "subscribed_campaign_events": [
              "ACCOUNT_PERFORMANCE",
              "PERFORMANCE_IMPROVEMENT"
            ]
          }
        },
        "data": {
          "notification_email": "user@domain.com",
          "contact_phone": "",
          "Contact_phone_extension": ""
        }
      }