Campaign management

アカウント

Postmanで実行 ❯

GET accounts

認証ユーザーがアクセスできる広告対応アカウントの一部またはすべての詳細を取得します。

リソースURL

https://ads-api.twitter.com/10/accounts

パラメーター

名前 説明
account_ids
任意
 カンマ区切りのIDリストを指定して、応答の範囲を目的のアカウントIDのみに設定します。

タイプ: 文字列

例: 18ce54d4x5t
count
任意
 個別のリクエストごとに試行および取得するレコード数を指定します。

タイプ: 整数

デフォルト: 200
最小、最大: 1、1000
cursor
任意
 結果の次のページを取得するためのカーソルを指定します。詳細については、「ページネーション」を参照してください。

タイプ: 文字列

例: 8x7v00oow
q
任意
 リソースをnameごとに範囲設定する任意のクエリ。

注: プレフィックスの一致は大文字と小文字を区別します。

タイプ: 文字列

最小および最長の長さ: 1、255
sort_by
任意
 サポートされている属性で昇順または降順に並べ替えます。詳細については、「並べ替え」を参照してください。

タイプ: 文字列

例: created_at-asc
with_deleted
任意
 削除した結果をリクエストに含めます。

タイプ: ブール値

デフォルト: false
使用可能な値: true、false
with_total_count
optional
 total_count応答属性を含めます。

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

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

タイプ: ブール値

デフォルト: false
使用可能な値: true、false

リクエストの例

GET https://ads-api.twitter.com/10/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

認証ユーザーがアクセスできる特定のアカウントを取得します。

リソースURL

https://ads-api.twitter.com/10/accounts/:account_id

パラメーター

名前 説明
account_id
必須
 利用するアカウントのID。リソースのパス内に表示され、通常、GET accountsを除くすべての広告主APIリクエストに必須のパラメーターです。

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

タイプ: 文字列

例: 18ce54d4x5t
with_deleted
optional
 削除した結果をリクエストに含めます。

タイプ: ブール値

デフォルト: false
使用可能な値: true、false

リクエストの例

GET https://ads-api.twitter.com/10/accounts/18ce54d4x5t

応答の例

   {
     "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

注:サンドボックスのみ

サンドボックス環境で広告アカウントを作成します。

リソースURL

https://ads-api-sandbox.twitter.com/10/accounts

パラメーター

なし

リクエストの例

POST https://ads-api-sandbox.twitter.com/10/accounts

応答の例

   {
     "request": {
       "params": {}
     },
     "next_cursor": null,
     "data": [
       {
         "name": "Sandbox account",
         "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

アカウント名や業種を更新します。

リソースURL

https://ads-api.twitter.com/10/accounts/:account_id

パラメーター

名前 説明
account_id
必須
 利用するアカウントのID。リソースのパス内に表示され、通常、GET accountsを除くすべての広告主APIリクエストに必須のパラメーターです。
指定するアカウントは、認証済みユーザーに関連付けられている必要があります。

タイプ: 文字列

例: 18ce54d4x5t
name
optional
 アカウントの名前。

タイプ: 文字列

例: API McTestface
industry_type
任意
 アカウントが関連付けられている業界。

タイプ: 文字列

使用可能な値: AGENCY、BUSINESS_TO_BUSINESS、ONLINE_SERVICES、EDUCATION、FINANCIAL、HEALTH、GOVERNMENT、MEDIA、MOBILE、RESTAURANT、RETAIL、TECHNOLOGY、TRAVEL、OTHER

リクエストの例

PUT https://ads-api.twitter.com/10/accounts/18ce54d4x5t?name='API McTestface 2'&industry_type=TECHNOLOGY

応答の例

   {
     "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

注:サンドボックスのみ

サンドボックス環境で広告アカウントを削除します。

リソースURL

https://ads-api-sandbox.twitter.com/10/accounts/:account_id

パラメーター

名前 説明
account_id
required
 利用するアカウントのID。リソースのパス内に表示され、通常、GET accountsを除くすべての広告主APIリクエストに必須のパラメーターです。

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

タイプ: 文字列

例: 18ce54d4x5t

リクエストの例

DELETE https://ads-api-sandbox.twitter.com/10/accounts/gq12fh

応答の例

   {
     "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"
       }
     }
   }