Parsequerade / docs
App Custom Product Page Localizations
GET/custom-product-page-versions/{pageVersionId}/localizations/{locale}/placements

Proposed · Extended read design · Adapter not implemented

Request

Routes are relative to your connection. Use a facade API key; the service manages Apple authentication.

cURL
BASE='https://asc.example.com/v1/connections/conn_example'

curl --fail-with-body "$BASE/custom-product-page-versions/page_version_123/localizations/en-US/placements" \
  -H "Authorization: Bearer $ASC_FACADE_KEY"

asc.example.com is a placeholder for your deployment. Examples use fictional IDs.

Path parameters

NameTypeDescription
pageVersionIdRequiredstringThe selected resource’s ID.
localeRequiredstringThe exact locale to read. No fallback to a different locale.

Query parameters

NameTypeDescription
placementTypeOptionalstringFilter by placement type. Multiple values are comma-separated.
ValuesAPP_SCREENSHOT, IMESSAGE_APP_SCREENSHOT, APP_PREVIEW, PRODUCT_PAGE_HEADER_ASSET, APP_STORE_SEARCH_RESULTS_ASSET, SEARCH_RESULTS_ADS_ASSET, TODAY_TAB_ADS_ASSET, EVENT_CARD_ASSET, EVENT_DETAILS_PAGE_ASSET, RETENTION_MESSAGE_ASSET
placementGroupOptionalstringFilter by placement group. Multiple values are comma-separated.
stateOptionalstringFilter by the current resource state. Version requests map this to Apple’s appVersionState. Multiple values are comma-separated.
ValuesASSET_PROCESSING, FAILED, PARENT_PREPARE_FOR_SUBMISSION, PARENT_READY_FOR_REVIEW, PARENT_WAITING_FOR_REVIEW, PARENT_IN_REVIEW, PARENT_APPROVED
imageOptionalstringFilter by image. Multiple values are comma-separated.
videoOptionalstringFilter by video. Multiple values are comma-separated.
appEventLocalizationOptionalstringFilter by app event localization. Multiple values are comma-separated.
appStoreVersionLocalizationOptionalstringFilter by app store version localization. Multiple values are comma-separated.
appStoreVersionExperimentTreatmentLocalizationOptionalstringFilter by app store version experiment treatment localization. Multiple values are comma-separated.
idOptionalstringRestrict results to the specified resource IDs. Multiple values are comma-separated.
sortOptionalstringComma-separated sort keys. Prefix a key with - for descending order. Only the values below are supported. Multiple values are comma-separated.
ValuescreatedDate, -createdDate, lastModifiedDate, -lastModifiedDate, placementGroupPosition, -placementGroupPosition
fieldsOptionalstringComma-separated attribute names to return. This selects read fields and does not expand relationships. Multiple values are comma-separated.
ValuesmediaType, placementType, placementGroup, createdDate, lastModifiedDate, state, stateDetails
limitOptional · Default 50integerNumber of items per page, from 1 to 200.
cursorOptionalstringOpaque nextCursor from a previous response. Keep the route, connection, filters, and ordering unchanged.

Response

A page of flat objects, with an opaque continuation cursor.

200 · application/json
{
  "items": [
    {
      "id": "app_asset_library_placement_123",
      "mediaType": "IMAGE",
      "placementType": "APP_SCREENSHOT",
      "placementGroup": "placement_group_example",
      "createdDate": "2026-10-14T12:00:00Z",
      "lastModifiedDate": "2026-10-14T12:00:00Z"
    }
  ],
  "nextCursor": null
}

Illustrative response. Optional read fields may be absent or null; unknown enum values are preserved.

Response fields

NameTypeDescription
itemsobject[]The current page of plain resource objects. An empty collection returns [].
nextCursorstring | nullOpaque continuation token, or null when the collection is complete. Pass it back as cursor.

Each item

NameTypeDescription
idstringApple’s resource ID. Keep this string unchanged when addressing a resource.
mediaTypestringThe media type value reported by Apple for this resource.
ValuesIMAGE, VIDEO
placementTypestringThe placement type value reported by Apple for this resource.
ValuesAPP_SCREENSHOT, IMESSAGE_APP_SCREENSHOT, APP_PREVIEW, PRODUCT_PAGE_HEADER_ASSET, APP_STORE_SEARCH_RESULTS_ASSET, SEARCH_RESULTS_ADS_ASSET, TODAY_TAB_ADS_ASSET, EVENT_CARD_ASSET, EVENT_DETAILS_PAGE_ASSET, RETENTION_MESSAGE_ASSET
placementGroupstringThe placement group value reported by Apple for this resource.
createdDatestring · date-timeWhen Apple created this resource, as an RFC 3339 timestamp.
lastModifiedDatestring · date-timeWhen this resource was last changed, as an RFC 3339 timestamp.
statestringThe current state reported by Apple for this resource.
ValuesASSET_PROCESSING, FAILED, PARENT_PREPARE_FOR_SUBMISSION, PARENT_READY_FOR_REVIEW, PARENT_WAITING_FOR_REVIEW, PARENT_IN_REVIEW, PARENT_APPROVED
stateDetailsobject[]The state details value reported by Apple for this resource.
stateDetails fields
NameTypeDescription
codeOptionalstringThe code value reported by Apple for this resource.
descriptionOptionalstringThe 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.

Pagination

Pass nextCursor back as cursor with the same filters and ordering. Stop when it is null. Each request returns one bounded page; the service never reports a capped or incomplete traversal as a complete collection.

Errors

HTTPTypeDescription
400invalid_queryUnsupported filter, sort, limit, or cursor.
401unauthorizedMissing or invalid facade API key.
403forbidden / upstream_forbiddenThe caller or configured Apple key cannot read this resource.
404localization_not_foundThe requested resource, parent, or exact locale is absent or outside the caller’s scope.
409ambiguous_selectionMore than one localization matches the selected parent and locale.
429rate_limitedA facade or Apple rate limit was reached. Respect Retry-After when returned.
502–504upstream errorApple authentication, response parsing, availability, or timeout failure; this is not an empty result.

Apple mapping

Upstream route and translation

The adapter calls GET /v1/appCustomProductPageLocalizations/{id}/placements. 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 parameterTypeDescription
placementTypequeryfilter[placementType]
placementGroupqueryfilter[placementGroup]
statequeryfilter[state]
imagequeryfilter[image]
videoqueryfilter[video]
appEventLocalizationqueryfilter[appEventLocalization]
appStoreVersionLocalizationqueryfilter[appStoreVersionLocalization]
appStoreVersionExperimentTreatmentLocalizationqueryfilter[appStoreVersionExperimentTreatmentLocalization]
idqueryfilter[id]
sortquerysort
fieldsqueryfields[appAssetLibraryPlacements]
limitquerylimit
cursorqueryFacade-owned pagination

Reviewed 2026-10-14 · OpenAPI 4.5.1