Skip to main content

Validation rules for brand asset metadata including dimensions, partner asset IDs, and photo quality checks

Brand Asset Details

BrandAssetDetailsMustBePresent

DefinitionSeverityAPISampleMode
Validate that brandAssetDetails is present
VIOLATION
POST_AND_PUT
S

Dimensions

ImageMustHaveValidDimensionsForIntent

DefinitionSeverityAPISampleMode
Validate that the actual dimensions of an image/photo resource, referenced via imageId, are within a permitted range for the specified intent
VIOLATION
POST_AND_PUT
Link
S
Example Validation Report
{
"code": "VALIDATION__ImageMustHaveValidDimensionsForIntent",
"message": "Actual dimensions for Apple-generated '{{imageId}}' are not within permitted range for specified `intent`",
"severity": "VIOLATION",
"context": {
"id": "9467895078742654901"
}
}

Partners Asset ID

PartnersAssetIdAlreadyExists

DefinitionSeverityAPISampleMode
Validate that partnersAssetId is not associated with another brand
VIOLATION
POST
S

PartnersAssetIdMustNotBeEmpty

DefinitionSeverityAPISampleMode
Validate that partnersAssetId is not an empty string
VIOLATION
POST_AND_PUT
S

Photo

PhotoRejected

DefinitionSeverityAPISampleMode
Validate that a Brand Asset's referenced photo/image satisfies Apple Maps requirements
VIOLATION
POST_AND_PUT
A
Example Validation Report
{
"validationReports": [
{
"code": "VALIDATION__PhotoRejected",
"severity": "VIOLATION",
"message": "Photo with Apple-generated '{{id}}', with '{{value}}', rejected for reason: {{reason}}",
"context": {
"id": "9467895078742654976",
"value": "{nps_photo_id}",
"reason": "tobacco_product"
}
}
]
}