Contents

Asset

Unified asset entity containing product-agnostic asset metadata and references.

Declaration

object Asset

Properties

NameTypeDescription
iduuid

Internal asset identifier (UUID). Filterable with EQUALS, IN.

namestring

User-facing asset name or description. Filterable with EQUALS, IN, LIKE, STARTS_WITH, ENDS_WITH.

assetTypeAssetType

The media type of the asset. See AssetType for details. Filterable with EQUALS, IN.

providerAssetIdstring

Asset identifier assigned by the provider system (for example, App Store Connect asset ID). Filterable with EQUALS, IN.

promotedObjectIdstring

Identifier of the promoted object (for example, adamId for apps, brandId for Maps). Filterable with EQUALS.

promotedObjectTypePromotedObjectType

The type of the promoted object. See PromotedObjectType for details. Filterable with EQUALS.

providerAssetMetadataAsset.ProviderAssetMetadata

Provider-specific metadata. Structure varies by provider type. For example, an App Store Connect asset returns keys such as appPreviewDevice and assetGenId.

assetDetailsAssetImage

Type-specific asset details. When assetType is IMAGE, contains AssetImage properties: width, height, format, sizeBytes, orientation, providerAssetUrl (provider URL for accessing the image), providerToken (provider token for referencing the image in provider-specific APIs), checkSum (file checksum), sortPosition (display order for UI sorting), and adAccountId (ad account identifier, present for custom assets). See AssetImage for details.

parentAssetIdstring

Identifier of the parent asset if this asset is a variant (crop, resize). Null for original assets.

variantIds[string]

Asset variant identifiers (for example, different sizes, formats, or localizations).

creationTimedate-time

Asset creation timestamp (ISO-8601 format). Read-only.

modificationTimedate-time

Last modification timestamp (ISO-8601 format). Read-only.

deletedboolean

Soft delete flag indicating whether the asset has been deleted. Deleted assets are excluded from query results unless an explicit deleted filter is supplied. Default: false. Read-only. Filterable with EQUALS.

eligibilityAssetEligibility

Eligibility data. Always returned unless excluded via a fields projection parameter. See AssetEligibility for details. Read-only.

Discussion

An Asset is the unified media entity used across ad placements in the Apple Ads Platform API. Different providers supply assets: App Store Connect images for Apple Ads campaigns, and Maps media for Apple Maps. The assetType field determines which sub-object is present in assetDetails.

Query endpoint requests support fields marked Filterable in the properties as filter criteria. See Calling the Apple Ads Platform API for details on constructing queries.

Example

{
  "id": "770e8400-e29b-41d4-a716-446655440002",
  "name": "awayfinder_hero.png",
  "assetType": "IMAGE",
  "providerAssetId": "abc123-provider-id",
  "promotedObjectId": "987654321",
  "promotedObjectType": "BUSINESS_BRAND",
  "providerAssetMetadata": {
    "appPreviewDevice": "iphone_6_7",
    "assetGenId": "123456789;en-US;iphone_6_7;1;abc123def"
  },
  "assetDetails": {
    "width": 1920,
    "height": 1080,
    "format": "PNG",
    "sizeBytes": 2097152,
    "orientation": "LANDSCAPE",
    "providerAssetUrl": "https://is5-ssl.mzstatic.com/image/thumb/Purple123/v4/9b/7a/a4/awayfinder_hero.png/2048x2732.png",
    "providerToken": "Purple123/v4/9b/7a/a4/awayfinder_hero.png",
    "checkSum": "a3c2e1d4b5f6",
    "sortPosition": 1,
    "adAccountId": "123456789"
  },
  "parentAssetId": null,
  "variantIds": [],
  "creationTime": "2026-03-01T12:00:00.000",
  "modificationTime": "2026-03-01T12:00:00.000",
  "deleted": false,
  "eligibility": {
    "status": "ELIGIBLE",
    "blockedGroups": [],
    "allowedGroups": []
  }
}

Topics

Dictionaries

See Also