creative_crop

Field Name

Modifier & Defaults

Type

Description

creative_crop

Optional

Object

Contains crop_data array.

Allows you to provide different images for specific aspect ratios.

Use this field to upload tailored images for different placements (e.g. 16:9, 1:1).

crop_data array

Each entry in the crop_data array specifies an image for a particular aspect ratio.

FieldTypeDescription
ratioObjectThe aspect ratio for this image. Contains width and height integers.
areaObjectOptional. Cropping coordinates within the image. Contains top_left_x, top_left_y, width, height.
urlStringThe URL of the replacement image for this aspect ratio.

ratio object

FieldTypeDescription
widthIntegerThe width component of the aspect ratio (e.g. 16 for 16:9).
heightIntegerThe height component of the aspect ratio (e.g. 9 for 16:9).

area object

FieldTypeDescription
top_left_xIntegerX coordinate of the crop area's top-left corner.
top_left_yIntegerY coordinate of the crop area's top-left corner.
widthIntegerWidth of the crop area in pixels.
heightIntegerHeight of the crop area in pixels.

Example

{
  "creative_crop": {
    "crop_data": [
      {
        "ratio": { "width": 16, "height": 9 },
        "url": "https://cdn.example.com/wide-image.jpg"
      },
      {
        "ratio": { "width": 1, "height": 1 },
        "url": "https://cdn.example.com/square-image.jpg"
      }
    ]
  }
}
📘

When to use creative_crop

  • Use creative_crop when your image contains logos or text that may be cropped awkwardly at certain aspect ratios.
  • Provide a dedicated image for each aspect ratio where precise control is needed.
  • The system serves the appropriate image based on the placement's aspect ratio requirements.
🚧

Limitations