ユーザー設定

GET accounts/:account_id/user_settings/:user_id

ユーザー設定を取得します。

リソースURL

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

パラメーター

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

タイプ: 文字列

例: 18ce54d4x5t
user_id
必須
リクエスト内で操作するユーザーへの参照。GET users/lookupを使用して、スクリーンネームのユーザーIDを取得します。

タイプ: 長整数型

例: 756201191646691328

リクエストの例

GET https://ads-api.x.com/10/accounts/18ce54d4x5t/user_settings/756201191646691328

応答の例

  {
    "request": {
      "params": {
        "account_id": "18ce54d4x5t",
        "user_id": "756201191646691328"
      }
    },
    "data": {
      "notification_email": "user@domain.com",
      "contact_phone": "",
      "contact_phone_extension": "",
      "subscribed_email_types": [
        "ACCOUNT_PERFORMANCE",
        "PERFORMANCE_IMPROVEMENT"
      ]
    }
  }

PUT accounts/:account_id/user_settings/:user_id

ユーザー設定を更新します。ユーザーのコンテキストが必要です。アカウント管理者はアクセスできません。

リソースURL

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

パラメーター

名前 説明
account_id
required
利用するアカウントのID。リソースのパスとGET accountsに表示されます。
指定するアカウントは、認証済みユーザーに関連付けられている必要があります。

タイプ: 文字列

例: 18ce54d4x5t
user_id
required
リクエスト内で操作するユーザーへの参照。GET users/lookupを使用して、スクリーンネームのユーザーIDを取得します。

タイプ: 長整数型

例: 756201191646691328
notification_email
任意
アカウント通知に使用するメール。

タイプ: 文字列

例: user@domain.com
contact_phone
任意
連絡先電話番号。

タイプ: 文字列

例: 202-555-0128
contact_phone_extension
任意
連絡先contact_phoneの内線番号。

タイプ: 文字列

例: 1234
subscribed_email_types
optional
通知メールの登録タイプ。

タイプ: 文字列

使用可能な値: CAMPAIGN_EVENTSACCOUNT_PERFORMANCEPERFORMANCE_IMPROVEMENT

リクエストの例

PUT https://ads-api.x.com/10/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": "",
      "subscribed_email_types": [
        "ACCOUNT_PERFORMANCE",
        "PERFORMANCE_IMPROVEMENT"
      ]
    }
  }