Default App Clip Experience Localizations
Read App Clip card image information for a localized default App Clip experience
Read app clip header image information as a flat JSON object. Address an exact locale; the service resolves its localization ID.
/app-clip-default-experiences/{experienceId}/localizations/{locale}/app-clip-header-imageProposed · Extended read design · Adapter not implemented
Request
Routes are relative to your connection. Use a facade API key; the service manages Apple authentication.
BASE='https://asc.example.com/v1/connections/conn_example'
curl --fail-with-body "$BASE/app-clip-default-experiences/experience_123/localizations/en-US/app-clip-header-image" \
-H "Authorization: Bearer $ASC_FACADE_KEY"const base = "https://asc.example.com/v1/connections/conn_example";
const response = await fetch(`${base}/app-clip-default-experiences/experience_123/localizations/en-US/app-clip-header-image`, {
headers: { Authorization: `Bearer ${process.env.ASC_FACADE_KEY}` }
});
const body = await response.json();
if (!response.ok) {
throw new Error(body.error?.message ?? `HTTP ${response.status}`);
}
console.log(body);import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError
base = "https://asc.example.com/v1/connections/conn_example"
request = Request(
f"{base}/app-clip-default-experiences/experience_123/localizations/en-US/app-clip-header-image",
headers={"Authorization": f"Bearer {os.environ['ASC_FACADE_KEY']}"},
)
try:
with urlopen(request) as response:
print(json.load(response))
except HTTPError as error:
detail = json.load(error)
raise RuntimeError(detail["error"]["message"]) from errorasc.example.com is a placeholder for your deployment. Examples use fictional IDs.
Path parameters
| Name | Type | Description |
|---|---|---|
| experienceId | string | The selected resource’s ID. |
| locale | string | The exact locale to read. No fallback to a different locale. |
Query parameters
| Name | Type | Description |
|---|---|---|
| fields | string | Comma-separated attribute names to return. This selects read fields and does not expand relationships. Multiple values are comma-separated.ValuesfileSize, fileName, sourceFileChecksum, imageAsset, uploadOperations, assetDeliveryState |
Response
One flat object for the selected resource.
{
"id": "app_clip_header_image_123",
"fileSize": 184320,
"fileName": "screenshot.png",
"sourceFileChecksum": "source_file_checksum_example",
"imageAsset": {
"templateUrl": "template_url_example",
"width": 1290,
"height": 2796
},
"uploadOperations": [
{
"method": "method_example",
"url": "https://example.com",
"length": 1,
"offset": 1,
"requestHeaders": [
{
"name": "Example Notes",
"value": "value_example"
}
]
}
]
}Illustrative response. Optional read fields may be absent or null; unknown enum values are preserved.
Response fields
| Name | Type | Description |
|---|---|---|
| id | string | Apple’s resource ID. Keep this string unchanged when addressing a resource. |
| fileSize | integer | The file size in bytes. |
| fileName | string | The uploaded file’s name. |
| sourceFileChecksum | string | The checksum Apple records for the uploaded source file. |
| imageAsset | object | Apple’s image dimensions and URL template. The service does not download the image. |
| uploadOperations | object[] | Apple’s recorded upload-operation metadata. A GET does not perform these operations. |
| assetDeliveryState | object | The delivery state and any processing issues Apple reports for this asset. |
| appClipDefaultExperienceLocalizationId | string | null | ID of the related app clip default experience localization. Present only when Apple supplies linkage; related objects are not loaded automatically. |
imageAsset fields
| Name | Type | Description |
|---|---|---|
| templateUrl | string | The template url value reported by Apple for this resource. |
| width | integer | The width value reported by Apple for this resource. |
| height | integer | The height value reported by Apple for this resource. |
uploadOperations fields
| Name | Type | Description |
|---|---|---|
| method | string | The method value reported by Apple for this resource. |
| url | string | The url value reported by Apple for this resource. |
| length | integer | The length value reported by Apple for this resource. |
| offset | integer | The offset value reported by Apple for this resource. |
| requestHeaders | object[] | The request headers value reported by Apple for this resource. |
uploadOperations.requestHeaders fields
| Name | Type | Description |
|---|---|---|
| name | string | The resource’s name. An app’s localized name is read from its app-info localization. |
| value | string | The value value reported by Apple for this resource. |
assetDeliveryState fields
| Name | Type | Description |
|---|---|---|
| errors | object[] | The errors value reported by Apple for this resource. |
| warnings | object[] | The warnings value reported by Apple for this resource. |
| state | string | The current state reported by Apple for this resource.ValuesAWAITING_UPLOAD, UPLOAD_COMPLETE, COMPLETE, FAILED |
assetDeliveryState.errors fields
| Name | Type | Description |
|---|---|---|
| code | string | The code value reported by Apple for this resource. |
| description | string | The localized store description. |
assetDeliveryState.warnings fields
| Name | Type | Description |
|---|---|---|
| code | string | The code value reported by Apple for this resource. |
| description | string | The localized store description. |
Behavior
- Resolve the exact locale within the selected parent, validate ownership, and read the resolved localization. No match returns localization_not_found; multiple matches return ambiguous_selection. GET does not create a locale or substitute another language.
Errors
| HTTP | Type | Description |
|---|---|---|
| 400 | invalid_query | Unsupported filter, sort, limit, or cursor. |
| 401 | unauthorized | Missing or invalid facade API key. |
| 403 | forbidden / upstream_forbidden | The caller or configured Apple key cannot read this resource. |
| 404 | localization_not_found | The requested resource, parent, or exact locale is absent or outside the caller’s scope. |
| 409 | ambiguous_selection | More than one localization matches the selected parent and locale. |
| 429 | rate_limited | A facade or Apple rate limit was reached. Respect Retry-After when returned. |
| 502–504 | upstream error | Apple authentication, response parsing, availability, or timeout failure; this is not an empty result. |
Apple mapping
Upstream route and translation
The adapter calls GET /v1/appClipDefaultExperienceLocalizations/{id}/appClipHeaderImage. Read Apple’s original endpoint ↗
Resolve the parent’s localization collection using the exact locale, validate ownership, and then supply the resolved ID to this Apple endpoint.
Flatten Apple’s attributes into each resource object. Expose supplied singleton linkage as IDs, with no automatic relationship traversal. Read access does not make these fields writable.
| Facade parameter | Type | Description |
|---|---|---|
| fields | query | fields[appClipHeaderImages] |
Reviewed 2026-10-14 · OpenAPI 4.5.1