Creates a Script.
Read Only Fields
- If kind is
src–- Only the
srcproperty is needed, and you can optionally supply a
htmlfield should not be specified.
- If kind is script_tag – Only the
script_tagis needed. The
srcfield should not be specified.
- Each app can have 10 scripts installed.
- Multiple scripts can be created per call.
Script properties common to
The user-friendly name.
The user-friendly description.
An html string containing exactly one
script tag. Only present if
src attribute of the script to load. Only present if
It will enable automatic cleanup of the script when the single click app is uninstalled or OAuth token is revoked.
The load method to use for the script. Values are
defer. It determines how the script should be loaded into the page.
Where on the page to place the script. Values are
Which set of pages the script should load on.
Please note that you need to have
Checkout content scope to use
The current visibility options are
storefront: All pages that are not
For a list of all locations visit Scripts Visibility.
What type of script this is.
src - a
script tag will be generated with its
src attribute set to the value of
src; For scripts that use the src url. By providing a path to the script, we can optimize and serve the script tag automatically for you.
script_tag - The value of
html will be injected directly onto the page.
For scripts which include a raw HTML script_tag to be inserted into the page. The load_method must be default.
The client id of the API user that created this script, or blank if created by other means.
What category of script this is for the purposes of GDPR/CCPA compliance.