Contents

List related placements

List the placements for an App Store version localization.

URL

GET https://api.appstoreconnect.apple.com/v1/appStoreVersionLocalizations/{id}/placements

Path Parameters

NameTypeDescription
id Requiredstring

An opaque resource ID that uniquely identifies the resource.

Query Parameters

NameTypeDescription
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[appEventLocalization] Optional[string]

Filter the returned app asset library placements by in-app event 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 Optionalinteger

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

StatusReasonTypeDescription
200OK
Content-Type: application/json
AppAssetLibraryPlacementsResponse

The request completed successfully.

400Bad Request
Content-Type: application/json
ErrorResponse

An error occurred with your request.

401Unauthorized
Content-Type: application/json
ErrorResponse

403Forbidden
Content-Type: application/json
ErrorResponse

Request not authorized.

404Not Found
Content-Type: application/json
ErrorResponse

Resource not found.

429
Content-Type: application/json
ErrorResponse

Mentioned in

See Also

Getting asset library placements