Contents

SKExternalPurchaseMultiLink

A dictionary that contains an array of URLs to websites where people using your app can make external purchases.

Properties

NameTypeDescription
Any Key[string]

Discussion

Use this information property list key if your app has the com.apple.developer.storekit.external-purchase-link entitlement.

The keys for this dictionary are lowercased ISO 3166-1 alpha-2 country codes. Valid country codes include those for the European Union: Austria (at), Belgium (be), Bulgaria (bg), Croatia (hr), Cyprus (cy), Czechia (cz), Denmark (dk), Estonia (ee), Finland (fi), France (fr), Germany (de), Greece (gr), Hungary (hu), Ireland (ie), Italy (it), Latvia (lv), Lithuania (lt), Luxembourg (lu), Malta (mt), Netherlands (nl), Poland (pl), Portugal (pt), Romania (ro), Slovakia (sk), Slovenia (si), Spain (es), Sweden (se); and Iceland (is), Norway (no), and Russia (ru).

Include a key entry for each country code where your app supports an external purchase link. Provide from one to five destination URLs (links to your website) for your app to choose from for each country code.

Your app accesses these URLs through the eligibleURLs array in the ExternalPurchaseLink object, and uses the link you select with the open(url:) method in the ExternalPurchaseLink object.

Make sure each destination URL meets all of the following conditions:

  • Uses the HTTPS scheme

  • Forms a valid, absolute URL

  • Contains no query parameters

  • Contains 1,000 or fewer ASCII characters

The following code example shows a property list entry with keys for several country codes, and links for each entry:

<key>SKExternalPurchaseMultiLink</key>
<dict>
    <key>es</key>
    <array>
        <string>https://www.example.com/es1</string>
        <string>https://www.example.com/new-user-es</string>
        <string>https://www.example.com/seasonal-sale-es</string>
        <string>https://www.example.com/es2</string>
        <string>https://www.example.com/es3</string>
    </array>
    <key>fr</key>
    <array>
        <string>https://www.example.com/fr</string>
        <string>https://www.example.com/global-sale</string>
        <string>https://www.example.com/new-user-fr</string>
    </array>
    <key>it</key>
    <array>
        <string>https://www.example.com/global-sale</string>
    </array>
</dict>

The order of the links is not significant.

For more information, see External Purchase and ExternalPurchaseLink.

The following country codes have a maximum of five links for apps that qualify for the StoreKit External Purchase Link entitlement as described in Distributing music streaming apps in the EEA that provide an external purchase link: Austria (at), Belgium (be), Bulgaria (bg), Croatia (hr), Cyprus (cy), Czechia (cz), Denmark (dk), Estonia (ee), Finland (fi), France (fr), Germany (de), Greece (gr), Hungary (hu), Ireland (ie), Italy (it), Latvia (lv), Lithuania (lt), Luxembourg (lu), Malta (mt), Netherlands (nl), Poland (pl), Portugal (pt), Romania (ro), Slovakia (sk), Slovenia (si), Spain (es), Sweden (se), Iceland (is), Norway (no). Otherwise, the maximum is one link, for valid country codes.

Count the total number of unique links you provide for each country code by adding together the number of links you provide in the SKExternalPurchaseMultiLink and SKExternalPurchaseLink property list keys.

For example, if a country code has a maximum of five links and you provide five unique links in the SKExternalPurchaseMultiLink key, then specify one of the same five links in the SKExternalPurchaseLink key to avoid exceeding the maximum allowed links. If a country code has a maximum of one link, the SKExternalPurchaseMultiLink and SKExternalPurchaseLink keys need to specify the same link.

See Also

StoreKit