Measurement

ウェブイベントタグ

Postmanで実行 ❯

GET accounts/:account_id/web_event_tags

現在のアカウントに関連付けられている一部またはすべてのウェブイベントタグの詳細を取得します。

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
count
任意

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

タイプ: 整数

デフォルト: 200
最小、最大: 1、1000
cursor
任意

結果の次のページを取得するためのカーソルを指定します。詳細については、「ページネーション」を参照してください。

タイプ: 文字列

例: 8x7v00oow
sort_by
任意

サポートされている属性で昇順または降順に並べ替えます。詳細については、「並べ替え」を参照してください。

タイプ: 文字列

例: created_at-asc
web_event_tag_ids
任意

カンマ区切りのIDリストを指定して、応答の範囲を目的のウェブイベントタグのみに設定します。最大200件のIDを指定できます。

タイプ: 文字列

例: o3bk1
with_deleted
任意

削除した結果をリクエストに含めます。

タイプ: ブール値

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

total_count応答属性を含めます。

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

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

タイプ: ブール値

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

リクエストの例

GET https://ads-api.x.com/10/accounts/18ce54d4x5t/web_event_tags?web_event_tag_ids=o3bk1

応答の例

{
  "request": {
    "params": {
      "web_event_tag_ids": [
        "o3bk1"
      ],
      "account_id": "18ce54d4x5t"
    }
  },
  "next_cursor": null,
  "data": [
    {
      "name": "web event tag",
      "view_through_window": 7,
      "click_window": 7,
      "embed_code": "<script src='"//platform.twitter.com/oct.js"' type='"text/javascript"'></script><script type='"text/javascript"'>twttr.conversion.trackPid('ny3od',  { tw_sale_amount: 0, tw_order_quantity: 0 });</script><noscript><img alt='""' height='"1"' src='"https://analytics.twitter.com/i/adsct?txn_id=ny3od&p_id=Twitter&tw_sale_amount=0&tw_order_quantity=0"' style='"display:none;"' width='"1"'/><img alt='""' height='"1"' src='"//t.co/i/adsct?txn_id=ny3od&p_id=Twitter&tw_sale_amount=0&tw_order_quantity=0"' style='"display:none;"' width='"1"'/></noscript>",
      "id": "o3bk1",
      "retargeting_enabled": false,
      "status": "UNVERIFIED",
      "type": "SITE_VISIT",
      "website_tag_id": "ny3od",
      "deleted": false
    }
  ]
}

GET accounts/:account_id/web_event_tags/:web_event_tag_id

現在のアカウントに関連付けられている特定のウェブイベントタグを取得します。

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
web_event_tag_id
必須

リクエスト内で操作するウェブイベントタグへの参照。

タイプ: 文字列

例: o3bk1
with_deleted
任意

削除した結果をリクエストに含めます。

タイプ: ブール値

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

リクエストの例

GET https://ads-api.x.com/10/accounts/18ce54d4x5t/web_event_tags/o3bk1

応答の例

{
  "request": {
    "params": {
      "web_event_tag_id": "o3bk1",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "name": "web event tag",
    "view_through_window": 7,
    "click_window": 7,
    "embed_code": "<script src='"//platform.twitter.com/oct.js"' type='"text/javascript"'></script><script type='"text/javascript"'>twttr.conversion.trackPid('ny3od',  { tw_sale_amount: 0, tw_order_quantity: 0 });</script><noscript><img alt='""' height='"1"' src='"https://analytics.twitter.com/i/adsct?txn_id=ny3od&p_id=Twitter&tw_sale_amount=0&tw_order_quantity=0"' style='"display:none;"' width='"1"'/><img alt='""' height='"1"' src='"//t.co/i/adsct?txn_id=ny3od&p_id=Twitter&tw_sale_amount=0&tw_order_quantity=0"' style='"display:none;"' width='"1"'/></noscript>",
    "id": "o3bk1",
    "retargeting_enabled": false,
    "status": "UNVERIFIED",
    "type": "SITE_VISIT",
    "website_tag_id": "ny3od",
    "deleted": false
  }
}

POST accounts/:account_id/web_event_tags

現在のアカウントに関連付けられている新しいウェブイベントタグを取得します。

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
click_window
必須

このウェブタグのクリック期間。

注: 以下にリストされた使用可能な値のみ受け入れられます。

タイプ: 整数

使用可能な値: 1、7、14、30、60、90
name
必須

ウェブタグの名前。

タイプ: 文字列

例: Sample single conversion event
retargeting_enabled
必須

このウェブタグのリターゲティングを有効にすべきかどうかを示します。

タイプ: ブール値

使用可能な値: true、false
type
必須

ウェブタグのタイプ。

タイプ: 列挙

使用可能な値: CUSTOM、DOWNLOAD、PURCHASE、SIGN_UP、SITE_VISIT
view_through_window
必須

このウェブタグのビュースルー期間。この値は常にclick_windowの値以下である必要があります。

注: 以下にリストされた使用可能な値のみ受け入れられます。

タイプ: 整数

使用可能な値: 0、1、7、14、30、60、90

リクエストの例

POST https://ads-api.x.com/10/accounts/18ce54d4x5t/web_event_tags?click_window=7&name=web event tag&retargeting_enabled=false&type=SITE_VISIT&view_through_window=7

応答の例

{
  "data": {
    "name": "web event tag",
    "view_through_window": 7,
    "click_window": 7,
    "embed_code": "<script src='"//platform.twitter.com/oct.js"' type='"text/javascript"'></script><script type='"text/javascript"'>twttr.conversion.trackPid('ny3od',  { tw_sale_amount: 0, tw_order_quantity: 0 });</script><noscript><img alt='""' height='"1"' src='"https://analytics.twitter.com/i/adsct?txn_id=ny3od&p_id=Twitter&tw_sale_amount=0&tw_order_quantity=0"' style='"display:none;"' width='"1"'/><img alt='""' height='"1"' src='"//t.co/i/adsct?txn_id=ny3od&p_id=Twitter&tw_sale_amount=0&tw_order_quantity=0"' style='"display:none;"' width='"1"'/></noscript>",
    "id": "o3bk1",
    "retargeting_enabled": false,
    "status": "UNVERIFIED",
    "type": "SITE_VISIT",
    "website_tag_id": "ny3od",
    "deleted": false
  },
  "request": {
    "params": {
      "name": "web event tag",
      "view_through_window": 7,
      "click_window": 7,
      "retargeting_enabled": false,
      "account_id": "18ce54d4x5t",
      "type": "SITE_VISIT"
    }
  }
}

PUT accounts/:account_id/web_event_tags/:web_event_tag_id

現在のアカウントに関連付けられているウェブイベントタグを更新します。

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
web_event_tag_id
必須

現在のアカウントに関連付けられているウェブタグのID。

タイプ: 文字列

例: o3bk1
click_window
任意

このウェブタグのクリック期間。

注: 以下にリストされた使用可能な値のみ受け入れられます。

タイプ: 整数

使用可能な値: 1、7、14、30、60、90
name
任意

ウェブタグの名前。

タイプ: 文字列

例: Sample single conversion event
retargeting_enabled
任意

このウェブタグのリターゲティングを有効にすべきかどうかを示します。

タイプ: ブール値

使用可能な値: true、false
type
任意

ウェブタグのタイプ。

タイプ: 列挙

使用可能な値: CUSTOM、DOWNLOAD、PURCHASE、SIGN_UP、SITE_VISIT
view_through_window
任意

このウェブタグのビュースルー期間。この値は常にclick_windowの値以下である必要があります。

注: 以下にリストされた使用可能な値のみ受け入れられます。

タイプ: 整数

使用可能な値: 0、1、7、14、30、60、90

リクエストの例

PUT https://ads-api.x.com/10/accounts/18ce54d4x5t/web_event_tags/o3bk1?type=DOWNLOAD

応答の例

{
  "data": {
    "name": "web event tag",
    "view_through_window": 7,
    "click_window": 7,
    "embed_code": "<script src='"//platform.twitter.com/oct.js"' type='"text/javascript"'></script><script type='"text/javascript"'>twttr.conversion.trackPid('ny3od',  { tw_sale_amount: 0, tw_order_quantity: 0 });</script><noscript><img alt='""' height='"1"' src='"https://analytics.twitter.com/i/adsct?txn_id=ny3od&p_id=Twitter&tw_sale_amount=0&tw_order_quantity=0"' style='"display:none;"' width='"1"'/><img alt='""' height='"1"' src='"//t.co/i/adsct?txn_id=ny3od&p_id=Twitter&tw_sale_amount=0&tw_order_quantity=0"' style='"display:none;"' width='"1"'/></noscript>",
    "id": "o3bk1",
    "retargeting_enabled": false,
    "status": "UNVERIFIED",
    "type": "DOWNLOAD",
    "website_tag_id": "ny3od",
    "deleted": false
  },
  "request": {
    "params": {
      "web_event_tag_id": "o3bk1",
      "type": "DOWNLOAD",
      "account_id": "18ce54d4x5t"
    }
  }
}

DELETE accounts/:account_id/web_event_tags/:web_event_tag_id

現在のアカウントに関連付けられている特定のウェブイベントタグを削除します。

リソースURL

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

パラメーター

名前 説明
account_id
必須

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

タイプ: 文字列

例: 18ce54d4x5t
web_event_tag_id
必須

現在のアカウントに関連付けられているウェブタグのID。

タイプ: 文字列

例: o3bk1

リクエストの例

DELETE https://ads-api.x.com/10/accounts/18ce54d4x5t/web_event_tags/o3bk1

応答の例

{
  "data": {
    "name": "web event tag",
    "view_through_window": 7,
    "click_window": 7,
    "embed_code": "<script src='"//platform.twitter.com/oct.js"' type='"text/javascript"'></script><script type='"text/javascript"'>twttr.conversion.trackPid('ny3od',  { tw_sale_amount: 0, tw_order_quantity: 0 });</script><noscript><img alt='""' height='"1"' src='"https://analytics.twitter.com/i/adsct?txn_id=ny3od&p_id=Twitter&tw_sale_amount=0&tw_order_quantity=0"' style='"display:none;"' width='"1"'/><img alt='""' height='"1"' src='"//t.co/i/adsct?txn_id=ny3od&p_id=Twitter&tw_sale_amount=0&tw_order_quantity=0"' style='"display:none;"' width='"1"'/></noscript>",
    "id": "o3bk1",
    "retargeting_enabled": false,
    "status": "UNVERIFIED",
    "type": "DOWNLOAD",
    "website_tag_id": "ny3od",
    "deleted": true
  },
  "request": {
    "params": {
      "web_event_tag_id": "o3bk1",
      "account_id": "18ce54d4x5t"
    }
  }
}