API reference 目次

テイラードオーディエンスの権限

GET accounts/:account_id/tailored_audiences/:tailored_audience_id/permissions¶

指定したテイラードオーディエンスに関連付けられている一部またはすべての権限の詳細を取得します。

リソースURL¶

https://ads-api.x.com/5/accounts/:account_id/tailored_audiences/:tailored_audience_id/permissions

パラメーター¶

名前	説明
account_id 必須	利用するアカウントのID。リソースのパス内に表示され、通常、GET accountsを除くすべての広告主APIリクエストに必須のパラメーターです。指定するアカウントは、認証済みユーザーに関連付けられている必要があります。タイプ: 文字列例: `18ce54d4x5t`
tailored_audience_id 必須	リクエストで操作するテイラードオーディエンスへの参照。タイプ: 文字列例: `1nmth`
count 任意	個別のリクエストごとに試行および取得するレコード数を指定します。タイプ: 整数デフォルト: `200` 最小、最大: `1`、`1000`
cursor 任意	結果の次のページを取得するためのカーソルを指定します。詳細については、「ページネーション」を参照してください。タイプ: 文字列例: `8x7v00oow`
granted_account_ids 任意	カンマ区切りのIDリストを指定して、応答の範囲を目的のアカウントのみに設定します。最大200件のIDを指定できます。タイプ: 文字列例: `18ce54aymz3`
sort_by 任意	サポートされている属性で昇順または降順に並べ替えます。詳細については、「並べ替え」を参照してください。タイプ: 文字列例: `created_at-asc`
tailored_audience_permission_ids 任意	カンマ区切りのIDリストを指定して、応答の範囲を目的のテイラードオーディエンスの権限のみに設定します。最大200件のIDを指定できます。タイプ: 文字列例: `ri`
with_total_count 任意	`total_count`応答属性を含めます。注: このパラメーターと`cursor`とは相互に排他的です。注: `total_count`を含むリクエストの場合、レート制限が低くなります。現在15分あたり200に設定されています。タイプ: ブール値デフォルト: `false` 使用可能な値: `true`、`false`

リクエストの例¶

GET https://ads-api.x.com/5/accounts/18ce54d4x5t/tailored_audiences/1nmth/permissions

応答の例¶

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "tailored_audience_id": "1nmth"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "tailored_audience_id": "1nmth",
      "permission_level": "READ_ONLY",
      "id": "ri",
      "created_at": "2017-06-08T23:17:59Z",
      "granted_account_id": "18ce54aymz3",
      "updated_at": "2017-06-08T23:17:59Z",
      "deleted": false
    }
  ]
}

POST accounts/:account_id/tailored_audiences/:tailored_audience_id/permissions¶

指定したオーディエンスを特定のアカウントと共有できるようにする新しい権限オブジェクトを作成します。

注: テイラードオーディエンスの権限を作成または変更するには、権限の修正を試みるアカウントがそのオーディエンスを所有している必要があります。特定のオーディエンスに対する応答のis_owner応答属性を調べると、テイラードオーディエンスの所有権を確認できます。

注: オーディエンスは、同じビジネスの広告アカウント間、またはオーディエンスを所有する広告アカウントにSHARE_AUDIENCE_OUTSIDE_BUSINESSアカウント機能がある場合にのみ共有できます。

リソースURL¶

https://ads-api.x.com/5/accounts/:account_id/tailored_audiences/:tailored_audience_id/permissions

パラメーター¶

名前	説明
account_id 必須	利用するアカウントのID。リソースのパス内に表示され、通常、GET accountsを除くすべての広告主APIリクエストに必須のパラメーターです。指定するアカウントは、認証済みユーザーに関連付けられている必要があります。タイプ: 文字列例: `18ce54d4x5t`
granted_account_id 必須	テイラードオーディエンスの権限を付与するアカウント。タイプ: 文字列例: `18ce54aymz3`
permission_level 必須	`granted_account_id`に必要な、テイラードオーディエンスへのアクセスのタイプ。タイプ: 列挙使用可能な値: `READ_ONLY`、`READ_WRITE`
tailored_audience_id 必須	リクエストで操作するテイラードオーディエンスへの参照。タイプ: 文字列例: `2906h`

リクエストの例¶

POST https://ads-api.x.com/5/accounts/18ce54d4x5t/tailored_audiences/2906h/permissions?granted_account_id=18ce54aymz3&permission_level=READ_ONLY

応答の例¶

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "granted_account_id": "18ce54aymz3",
      "permission_level": "READ_ONLY",
      "tailored_audience_id": "2906h"
    }
  },
  "data": {
    "tailored_audience_id": "2906h",
    "permission_level": "READ_ONLY",
    "id": "14m",
    "created_at": "2017-09-12T23:49:34Z",
    "granted_account_id": "18ce54aymz3",
    "updated_at": "2017-09-12T23:49:34Z",
    "deleted": false
  }
}

DELETE accounts/:account_id/tailored_audiences/:tailored_audience_id/permissions/:tailored_audience_permission_id¶

指定したテイラードオーディエンスの共有権限を取り消します。

権限を取り消すと、権限が付与されたアカウント（granted_account_id）は、今後のキャンペーンでそのオーディエンスをターゲティングできなくなります。既存のキャンペーンは、引き続き共有したオーディエンスで実行されます。つまり、キャンペーンは停止されず、オーディエンスはキャンペーンから削除されません。オーディエンスの共有の権限が取り消された後では、このキャンペーンをコピーできません。

リソースURL¶

https://ads-api.x.com/5/accounts/:account_id/tailored_audiences/:tailored_audience_id/permissions/:tailored_audience_permission_id

パラメーター¶

名前説明

account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t

tailored_audience_id
必須

リクエストで操作するテイラードオーディエンスへの参照。

タイプ: 文字列

例: 1nmth

tailored_audience_permission_id
必須

リクエストで操作するテイラードオーディエンスの権限への参照。

タイプ: 文字列

例: ri

リクエストの例¶

DELETE https://ads-api.x.com/5/accounts/18ce54d4x5t/tailored_audiences/1nmth/permissions/ri

応答の例¶

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "tailored_audience_permission_id": "ri",
      "tailored_audience_id": "1nmth"
    }
  },
  "data": {
    "tailored_audience_id": "1nmth",
    "permission_level": "READ_ONLY",
    "id": "ri",
    "created_at": "2017-06-08T23:17:59Z",
    "granted_account_id": "18ce54aymz3",
    "updated_at": "2017-08-30T18:29:35Z",
    "deleted": true
  }
}