external_video オブジェクト

{
  "access": {
    "global": false,
    "parents": [
      {
        "object": "product",
        "property": "media"
      }
    ],
    "template": []
  },
  "deprecated": false,
  "deprecation_reason": "",
  "description": "> Tip:\n> Use the [`external_video_tag` filter](/docs/api/liquid/filters/external_video_tag) to output the video in an\n> HTML `<iframe>` tag. Use the [`external_video_url` filter](/docs/api/liquid/filters/external_video_url) to specify parameters\n> for the external video player.",
  "properties": [
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "examples": [],
      "return_type": [
        {
          "type": "string",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The ID of the video from its external source.",
      "name": "external_id"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "examples": [],
      "return_type": [
        {
          "type": "number",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The aspect ratio of the video as a decimal.",
      "name": "aspect_ratio"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "examples": [],
      "return_type": [
        {
          "type": "string",
          "name": "youtube",
          "description": "",
          "array_value": ""
        },
        {
          "type": "string",
          "name": "vimeo",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The service that hosts the video.",
      "name": "host"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "examples": [],
      "return_type": [
        {
          "type": "string",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The alt text of the external video.",
      "name": "alt"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "examples": [],
      "return_type": [
        {
          "type": "number",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The ID of the external video.",
      "name": "id"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "examples": [
        {
          "name": "Filter for media of a specific type",
          "description": "You can use the `media_type` property with the [`where` filter](/docs/api/liquid/filters/where) to filter the [`product.media` array](/docs/api/liquid/objects/product#product-media) for all media of a desired type.\n",
          "syntax": "",
          "path": "/products/potion-beats",
          "raw_liquid": "{% assign external_videos = product.media | where: 'media_type', 'external_video' %}\n\n{% for external_video in external_videos %}\n  {{- external_video | external_video_tag }}\n{% endfor %}",
          "parameter": false,
          "display_type": "text",
          "show_data_tab": true
        }
      ],
      "return_type": [
        {
          "type": "string",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The media type of the external video. Always returns `external_video`.",
      "name": "media_type"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "examples": [],
      "return_type": [
        {
          "type": "number",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The position of the external video in the [`product.media`](/docs/api/liquid/objects/product#product-media) array.",
      "name": "position"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "> Note:\n> Preview images don't have an ID attribute.",
      "examples": [],
      "return_type": [
        {
          "type": "image",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "A preview image of the media.",
      "name": "preview_image"
    }
  ],
  "summary": "Information about an external video from YouTube or Vimeo.",
  "name": "external_video",
  "examples": [],
  "json_data": {
    "path": "/products/potion-beats",
    "handle": "product.featured_media",
    "data_from_file": ""
  },
  "return_type": []
}