scriptTag - admin-graphql - QUERY

Version: 2024-10

Description:

Lookup a script tag resource by ID.

Access Scopes

Arguments

• id: ID! - The ID of the ScriptTag to return.

Returns

• cache: Boolean! Whether the Shopify CDN can cache and serve the script tag. If `true`, then the script will be cached and served by the CDN. The cache expires 15 minutes after the script tag is successfully returned. If `false`, then the script will be served as is.
• createdAt: DateTime! The date and time when the script tag was created.
• displayScope: ScriptTagDisplayScope! The page or pages on the online store that the script should be included.
• id: ID! A globally-unique ID.
• legacyResourceId: UnsignedInt64! The ID of the corresponding resource in the REST Admin API.
• src: URL! The URL to the remote script.
• updatedAt: DateTime! The date and time when the script tag was last updated.

Examples

• Retrieves a single script tag

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query GetScriptTag($id: ID!) { scriptTag(id: $id) { id cache createdAt displayScope src updatedAt } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/ScriptTag/466217408\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `query GetScriptTag($id: ID!) {\n      scriptTag(id: $id) {\n        id\n        cache\n        createdAt\n        displayScope\n        src\n        updatedAt\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/ScriptTag/466217408\"\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query GetScriptTag($id: ID!) {\n    scriptTag(id: $id) {\n      id\n      cache\n      createdAt\n      displayScope\n      src\n      updatedAt\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/ScriptTag/466217408\"\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = << \"gid://shopify/ScriptTag/466217408\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query GetScriptTag($id: ID!) {\n    scriptTag(id: $id) {\n      id\n      cache\n      createdAt\n      displayScope\n      src\n      updatedAt\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/ScriptTag/466217408\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "query GetScriptTag($id: ID!) {\n  scriptTag(id: $id) {\n    id\n    cache\n    createdAt\n    displayScope\n    src\n    updatedAt\n  }\n}"
        

  input: {
    "id": "gid://shopify/ScriptTag/466217408"
  }

  response: {
    "data": {
      "scriptTag": {
        "id": "gid://shopify/ScriptTag/466217408",
        "cache": false,
        "createdAt": "2024-10-29T22:38:08Z",
        "displayScope": "ALL",
        "src": "https://js.example.org/foo.js",
        "updatedAt": "2024-10-29T22:38:08Z"
      }
    }
  }