Select Git revision
-
James Gilliland authoredJames Gilliland authored
SiteScriptRequest.md 2.15 KiB
SiteScriptRequest
Properties
Name | Type | Description | Notes |
---|---|---|---|
src | string | A URL that points to where the script is hosted. Required if `content` is not provided. Note the TLD of the src url must match the app's url. | [optional] |
content | string | A string containing HTML/Javascript. Required if `src` is not provided. When providing the script using content, the header HMAC-SHA256-SIGNATURE is also require to be sent. Generate the signature using the app's client secret and the value. | [optional] |
name | string | A short and user-friendly string to identify the script. | |
description | string | A user-friendly explanation of the script's purpose and what it does. | |
page_scopes | string[] | An array of page and domain identifiers that the Site Script should be injected onto. `page_scopes` can contain identifiers that are groupings of pages and/or the pages themselves. The majority of the page identifiers correspond to Liquid pages. For more details, take a look at our Liquid API docs. Groupings and Page Identifiers: | Page Grouping |
location | string | Where in the HTML the script should be injected. Accepted values are: head or footer | [optional] [default to 'footer'] |
load_method | string | How the Site Script will be loaded into the page. Accepted values are: async, defer, and default | [optional] [default to 'async'] |
category | string | Describes the purpose of the script. Accepted values are: functional, analytics, marketing |
Back to Model list(../../README.md#models) Back to API list(../../README.md#endpoints) Back to README(../../README.md)