脚本标签

ScriptTag资源表示加载到商店店面页面或结帐的订单状态页面中的远程JavaScript代码。这使您可以在不使用主题模板的情况下向这些页面添加功能。

脚本标记的作用域仅限于创建它们的应用程序。从商店中卸载应用程序后,该应用程序创建的所有脚本标签都会随之自动删除。

ScriptTag可以做什么

Shopify API允许您使用ScriptTag资源执行以下操作。这些常规操作的更详细的版本可能可用:

ScriptTag属性

created_at 只读 plain "created_at": "2012-08-24T14:01:47-04:00" 创建脚本标签 的日期和时间(ISO 8601)。
事件 必需的 plain "event": "onload" 触发脚本加载的DOM事件。有效值:onload
ID 只读 plain "id": 596726825 脚本标签的ID。
src 必需的 plain "src": "https://js-aplenty.com/foo.js" 远程脚本的URL。
display_scope plain "display_scope": "online_store" 在线商店中应包含脚本的页面。有效值:
+ online_store:仅在Web店面中包含脚本。
+ order_status:仅在订单状态页面上包含脚本。
+ all:在Web店面和订单状态页面上都包含脚本。
快取 plain "cache": true Shopify CDN是否可以缓存并提供脚本标签。有效值:
+ true:脚本将由CDN缓存并提供服务。成功返回脚本标记后15分钟,缓存将过期。
+ false:脚本将按原样提供。
默认值:false
Updated_at 只读 plain "updated_at": "2012-08-24T14:01:47-04:00" 脚本标记上次更新 的日期和时间(ISO 8601)。

终点

得到/admin/api/2021-01/script_tags.json?src=https://js-aplenty.com/foo.js 检索所有脚本标签的列表。注意:从2019-10版本开始,此端点通过使用响应标头中提供的链接来实现分页。发送<font style="background-color:#F4F6F8;">page</font>参数将返回错误。要了解更多信息,请参阅向分页的REST Admin API端点发出请求
限制 要返回的结果数。
(默认值:50
最大:250
since_id 将结果限制为指定的ID之后。
created_at_min 显示在此日期之后创建的脚本标签。(格式:2014-04-25T16:15:47-04:00)
created_at_max 显示在此日期之前创建的脚本标签。(格式:2014-04-25T16:15:47-04:00)
Updated_at_min 显示脚本标签在此日期之后最后更新。(格式:2014-04-25T16:15:47-04:00)
Updated_at_max 显示脚本标签在此日期之前最后更新。(格式:2014-04-25T16:15:47-04:00)
src 显示具有此URL的脚本标签。
领域 以逗号分隔的字段列表,包括在响应中。

检索具有特定URL的所有脚本标签的列表

GET /admin/api/2021-01/script_tags.json?src=https://js-aplenty.com/foo.js

查看回应

在指定的ID之后检索所有脚本标签的列表

GET /admin/api/2021-01/script_tags.json?since_id=421379493

查看回应

检索所有脚本标签的列表

GET /admin/api/2021-01/script_tags.json

查看回应

得到/admin/api/2021-01/script_tags/count.json 检索所有脚本标签的计数
src 仅计数具有给定URL的脚本标记。

检索您商店的所有脚本标签的数量

GET /admin/api/2021-01/script_tags/count.json

查看回应

得到/admin/api/2021-01/script_tags/{script_tag_id}.json 检索单个脚本标签
领域 以逗号分隔的字段列表,包括在响应中。

通过ID检索单个脚本标签

GET /admin/api/2021-01/script_tags/596726825.json

查看回应

邮政/admin/api/2021-01/script_tags.json 创建一个新的脚本标签

创建一个新的脚本标签

POST /admin/api/2021-01/script_tags.json

{

“ script_tag” : {

  1. event :“ onload”,
  2. src :“ [https://djavaskripped.org/fancy.js](https://djavaskripped.org/fancy.js)”

}

}

查看回应

创建没有src和event的脚本标签将返回错误

POST /admin/api/2021-01/script_tags.json

{

“ script_tag” : {

  1. body :“ foobar

}

}

查看回应

/admin/api/2021-01/script_tags/{script_tag_id}.json 更新脚本标签

更新脚本标签的URL

PUT /admin/api/2021-01/script_tags/596726825.json

{

“ script_tag” : {

  1. id 596726825
  2. src :“ [https://somewhere-else.com/another.js](https://somewhere-else.com/another.js)”

}

}

查看回应

删除/admin/api/2021-01/script_tags/{script_tag_id}.json 删除脚本标签

删除现有的脚本标签

删除/admin/api/2021-01/script_tags/596726825.json

查看回应