Validation rules for brand asset metadata including dimensions, partner asset IDs, and photo quality checks
Brand Asset Details
BrandAssetDetailsMustBePresent
| Definition | Severity | API | Sample | Mode |
|---|---|---|---|---|
Validate that brandAssetDetails is present |
Dimensions
ImageMustHaveValidDimensionsForIntent
| Definition | Severity | API | Sample | Mode |
|---|---|---|---|---|
Validate that the actual dimensions of an image/photo resource, referenced via imageId, are within a permitted range for the specified intent | Link |
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
| Definition | Severity | API | Sample | Mode |
|---|---|---|---|---|
Validate that partnersAssetId is not associated with another brand |
PartnersAssetIdMustNotBeEmpty
| Definition | Severity | API | Sample | Mode |
|---|---|---|---|---|
Validate that partnersAssetId is not an empty string |
Photo
PhotoRejected
| Definition | Severity | API | Sample | Mode |
|---|---|---|---|---|
| Validate that a Brand Asset's referenced photo/image satisfies Apple Maps requirements |
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"
}
}
]
}