List related placements
List the placements for an in-app event localization.
URL
GET https://api.appstoreconnect.apple.com/v1/appEventLocalizations/{id}/placementsPath Parameters
| Name | Type | Description |
|---|---|---|
id Required | string | An opaque resource ID that uniquely identifies the resource. |
Query Parameters
| Name | Type | Description |
|---|---|---|
filter[placementType] Optional | [string] | Filter the returned app asset library placements by placement type. |
filter[placementGroup] Optional | [string] | Filter the returned app asset library placements by placement group. |
filter[state] Optional | [string] | Filter the returned app asset library placements by state. |
filter[image] Optional | [string] | Filter the returned app asset library placements by image. |
filter[video] Optional | [string] | Filter the returned app asset library placements by video. |
filter[appStoreVersionLocalization] Optional | [string] | Filter the returned app asset library placements by App Store version localization. |
filter[appCustomProductPageLocalization] Optional | [string] | Filter the returned app asset library placements by app custom product page localization. |
filter[appStoreVersionExperimentTreatmentLocalization] Optional | [string] | Filter the returned app asset library placements by App Store version experiment treatment localization. |
filter[id] Optional | [string] | Filter the returned app asset library placements by resource ID. |
sort Optional | [string] | Attributes by which to sort. |
fields[appAssetLibraryPlacements] Optional | [string] | Additional fields to include for each app asset library placement resource returned by the response. |
fields[appAssetLibraryImages] Optional | [string] | Additional fields to include for each app asset library image resource returned by the response. |
fields[appAssetLibraryVideos] Optional | [string] | Additional fields to include for each app asset library video resource returned by the response. |
fields[appEventLocalizations] Optional | [string] | Additional fields to include for each in-app event localization resource returned by the response. |
fields[appStoreVersionLocalizations] Optional | [string] | Additional fields to include for each App Store version localization resource returned by the response. |
fields[appCustomProductPageLocalizations] Optional | [string] | Additional fields to include for each app custom product page localization resource returned by the response. |
fields[appStoreVersionExperimentTreatmentLocalizations] Optional | [string] | Additional fields to include for each App Store version experiment treatment localization resource returned by the response. |
limit Optional | integer | The maximum number of app asset library placement resources to return. |
include Optional | [string] | The relationship data to include in the response. |
fields[retentionMessageVersions] Optional | [string] |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | AppAssetLibraryPlacementsResponse | The request completed successfully. |
| 400 | Bad Request Content-Type: application/json | ErrorResponse | An error occurred with your request. |
| 401 | Unauthorized Content-Type: application/json | ErrorResponse | |
| 403 | Forbidden Content-Type: application/json | ErrorResponse | Request not authorized. |
| 404 | Not Found Content-Type: application/json | ErrorResponse | Resource not found. |
| 429 | Content-Type: application/json | ErrorResponse |
Mentioned in
See Also
Endpoints
Read app event localization informationList all video clips for an app event localizationList app event video clip IDs for an app event localizationList all screenshots for an app event localizationList app event screenshot IDs for an app event localizationModify an app event localizationCreate an app event localizationDelete an app event localizationList the placement IDs for an in-app event localization