Skip to content
AdCrunch
Esc
↑↓navigate↵open⌘Jpreview
On this page

variation_add

Add a Variation to a Creative of your Library. A Variation holds one ready Asset.

Ask to put one more file in an ad idea. The agent adds a Variation that holds the Asset of that file.

“Add the square banner to the Spring sale creative.”

The agent finds the Creative with library_creative_list and the Asset with asset_list, and calls this tool. The Asset must be ready. A Creative holds each Asset one time only, and one Asset can be in several Creatives. You then see the Creative with the new Variation. No ad account changes.

This tool is part of the job Bring your own creative.

Reference

Add a Variation to a Creative of your Library: one rendition of the ad idea, which holds one Asset, for example the 9:16 video or the square image. The Asset must be ready: asset_get gives its status. A Creative holds one live Variation for each Asset. The same Asset can be in other Creatives. This changes no ad account. To put the file in an ad account, use asset_register.

Input

Argument Type Required Description
asset_id string yes The id of a ready Asset of your organization (ast_…). asset_list gives it.
creative_id string yes The id of a Creative of your Library (crv_…). library_creative_list gives it.

Output

A successful call returns this object in structuredContent.

Field Type Always present Description
variation object yes The new Variation, with the Asset that it holds.
variation.asset object yes
variation.asset.contentHash string yes AdCrunch’s own hash of the stored bytes. A hint for de-duplication, never an identity, and never a provider’s hash. Empty when the store reports none.
variation.asset.createdAt number yes Milliseconds since the Unix epoch, UTC.
variation.asset.createdBy string yes The user who reserved the upload.
variation.asset.deletedAt number or null yes Always null here. A deleted Asset is not answered.
variation.asset.durationMs number or null yes How long the video runs, in milliseconds, read from the header of the file at finalize. null for an image. For a video, null when the file does not state it, or for an Asset uploaded before AdCrunch read it.
variation.asset.failureCode string or null yes Why AdCrunch refused the file, as a code. Branch on this field, never on failureReason. unsupported_type: the bytes are not an accepted image or video. too_large: the file is over the size limit. unreadable: AdCrunch could not read the header of the file. source_unreachable: an import could not fetch the file from its source URL. source_length_unknown: the source of an import sent no Content-Length. null unless status is failed.
variation.asset.failureReason string or null yes Why AdCrunch refused the file, as a sentence. null unless status is failed.
variation.asset.filename string yes The name the file was uploaded under. Never a lookup key.
variation.asset.height number or null yes The height in pixels as the file is displayed, with its rotation applied, read from the header of the file at finalize. null when the file does not state it, or for an Asset uploaded before AdCrunch read it.
variation.asset.id string yes The id of the Asset, ast_….
variation.asset.key string yes Where the bytes are held. Read-only, and never sent by you.
variation.asset.kind one of image, video yes Follows from mimeType. It selects how a provider takes the file.
variation.asset.mimeType string yes The type that finalize identified from the stored bytes. The Content-Type of the upload does not set it.
variation.asset.name string or null yes The name a person gave this Asset, and what a provider receives at a future registration. null until somebody renames it, and the filename is the fallback.
variation.asset.organizationId string yes The organization that owns the Asset.
variation.asset.sizeBytes number yes Read from the stored object at finalize.
variation.asset.status one of pending, ready, failed yes ready once AdCrunch has inspected the bytes. Only a ready Asset can be registered. pending: the bytes have not been inspected yet. failed: AdCrunch refused the file and deleted it. failureCode and failureReason say why. A read answers an Asset in every status. A list answers ready Assets only.
variation.asset.updatedAt number or null yes When the Asset last changed, in milliseconds since the Unix epoch, UTC: at finalize, or at the last rename.
variation.asset.width number or null yes The width in pixels as the file is displayed, with its rotation applied, read from the header of the file at finalize. null when the file does not state it, or for an Asset uploaded before AdCrunch read it.
variation.assetId string yes The id of the Asset that the Variation holds, ast_…. asset is that Asset. Its width, height and durationMs give the dimensions of the Variation.
variation.createdAt number yes Milliseconds since the Unix epoch, UTC.
variation.createdBy string yes The user who added the Variation.
variation.creativeId string yes The Creative that the Variation belongs to, crv_….
variation.deletedAt number or null yes Always null here. A removed Variation is not answered.
variation.id string yes The id of the Variation, var_….
variation.organizationId string yes The organization that owns the Creative.
variation.updatedAt number or null yes Always null here. A Variation has no update: to use another Asset, remove the Variation and add a new one.

Failure codes

A failed call has isError set, and structuredContent.error holds one of these codes. Errors describes the shape of a failed call.

  • not_found
  • asset_not_ready
  • asset_failed
  • variation_exists
  • organization_unentitled
  • forbidden
  • invalid_request
  • internal_error

Scope

The token must hold library:write. Auth & scopes lists each scope.

Annotations

A client reads these hints. A hint that the tool does not declare has the default value of the MCP specification.

  • Writes. The tool can change data.
  • Not destructive. The tool makes only additive changes.
  • Not idempotent. A second call with the same arguments can change more.
  • Closed world. The tool reads and writes the data of AdCrunch only.

Example

The arguments:

{
  "asset_id": "ast_7c1e9a",
  "creative_id": "crv_5e2a19"
}

The result, in structuredContent:

{
  "variation": {
    "asset": {
      "contentHash": "9d2f41b7c6e8a35014f7b2d9c3e6a810",
      "createdAt": 1790000000000,
      "createdBy": "usr_2e5b84",
      "deletedAt": null,
      "durationMs": 15000,
      "failureCode": null,
      "failureReason": null,
      "filename": "spring-sale.mp4",
      "height": 1920,
      "id": "ast_7c1e9a",
      "key": "org_3a7f10/ast_7c1e9a",
      "kind": "video",
      "mimeType": "video/mp4",
      "name": "Spring sale 9:16",
      "organizationId": "org_3a7f10",
      "sizeBytes": 24117248,
      "status": "ready",
      "updatedAt": 1790000120000,
      "width": 1080
    },
    "assetId": "ast_7c1e9a",
    "createdAt": 1790000360000,
    "createdBy": "usr_2e5b84",
    "creativeId": "crv_5e2a19",
    "deletedAt": null,
    "id": "var_8c3f60",
    "organizationId": "org_3a7f10",
    "updatedAt": null
  }
}

Was this page helpful?