App Custom Product Page Localizations
List all search keywords for a custom product page localization
Read related IDs directly, without Apple’s resource-type envelope. Results are paginated.
/custom-product-page-versions/{pageVersionId}/localizations/{locale}/search-keywords/idsProposed · 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/custom-product-page-versions/page_version_123/localizations/en-US/search-keywords/ids" \
-H "Authorization: Bearer $ASC_FACADE_KEY"const base = "https://asc.example.com/v1/connections/conn_example";
const response = await fetch(`${base}/custom-product-page-versions/page_version_123/localizations/en-US/search-keywords/ids`, {
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}/custom-product-page-versions/page_version_123/localizations/en-US/search-keywords/ids",
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 |
|---|---|---|
| pageVersionId | string | The selected resource’s ID. |
| locale | string | The exact locale to read. No fallback to a different locale. |
Query parameters
| Name | Type | Description |
|---|---|---|
| limit | integer | Number of items per page, from 1 to 200. |
| cursor | string | Opaque nextCursor from a previous response. Keep the route, connection, filters, and ordering unchanged. |
Response
A page of plain resource IDs, with an opaque continuation cursor.
{
"items": [
"search_keyword_123"
],
"nextCursor": null
}Illustrative response. Optional read fields may be absent or null; unknown enum values are preserved.
Response fields
| Name | Type | Description |
|---|---|---|
| items | string[] | The current page of IDs. |
| nextCursor | string | null | Opaque continuation token, or null when the collection is complete. Pass it back as cursor. |
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
| 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/appCustomProductPageLocalizations/{id}/relationships/searchKeywords. 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.
Keep the related ID values and remove Apple’s resource-type objects. Collections use the facade cursor rather than an upstream pagination URL.
| Facade parameter | Type | Description |
|---|---|---|
| limit | query | limit |
| cursor | query | Facade-owned pagination |
Reviewed 2026-10-14 · OpenAPI 4.5.1