{"id":122194,"date":"2020-12-14T19:00:39","date_gmt":"2020-12-14T19:00:39","guid":{"rendered":"https:\/\/developer.apple.com\/news\/?id=s2j9do6a"},"modified":"2020-12-14T19:00:39","modified_gmt":"2020-12-14T19:00:39","slug":"how-to-store-urls-in-your-app-clip-codes","status":"publish","type":"post","link":"https:\/\/sickgaming.net\/blog\/2020\/12\/14\/how-to-store-urls-in-your-app-clip-codes\/","title":{"rendered":"How to store URLs in your App Clip Codes"},"content":{"rendered":"
<\/div>\n

An App Clip is a small part of your app which provides specific information that best suits a given task or situation. An App Clip Code activates your App Clip, helping people access relevant information wherever they happen to be \u2014 whether they\u2019re picking up takeout from a restaurant, reading an article online, or passing by an advertisement in their neighborhood.<\/p>\n

To make your App Clip Code, you\u2019ll need to create a URL that directly connects to your content. And because codes can only hold a finite number of characters, you\u2019ll need to design your URL efficiently. Here\u2019s what you need to know to make and store a URL for your App Clip Code.<\/p>\n

How App Clip Code URLs work<\/h3>\n

App Clip Codes support URLs in the following format:<\/p>\n

https:\/\/[host][\/<optional path>][?<optional query>][#<optional fragment>]<\/code><\/p>\n

URLs must use the https<\/code> scheme, all lowercase.<\/p>\n

The host segment can only contain lowercase ASCII characters \u2018a\u2019 to \u2018z\u2019, \u2018.\u2019 and \u2018-\u2019 characters. Host is the only part of the authority<\/em> component of the URL that is supported.<\/p>\n

The rest of the URL can have zero or more path components, zero or more query components, and, optionally, a fragment component. These components can contain the following ASCII characters: a<\/code> to z<\/code>, A<\/code> to Z<\/code>, 0<\/code> to 9<\/code>, and \/#?=%-._,+;:&<\/code>.<\/p>\n

Learn more about creating App Clip Codes<\/a><\/p>\n

How to store URLs efficiently in your App Clip Codes<\/h3>\n

When creating a URL, you can optimize its string length to fit within the App Clip Code\u2019s character limit in a number of different ways.<\/p>\n

Make it short and sweet<\/strong>
\nAbove all, aim for your URLs to be as short and concise as possible. URLs with fewer characters, path, and query components have a better chance to fit into an App Clip Code.<\/p>\n

We recommend using a short host name with as few subdomains as possible, as well as removing the www<\/em> subdomain whenever possible. You\u2019ll also want to omit a trailing \u2018\/\u2019 character from the end of the URL if possible. For instance, https:\/\/www.example.com\/<\/code> can be changed to https:\/\/example.com<\/code>.<\/p>\n

If you do plan to use a subdomain, consider using appclip<\/code> to define App Clip-specific URLs for App Clip Codes. This special subdomain is compressed efficiently and it allows URLs to have short path and query components by eliminating the possibility of a conflict with an unrelated functionality of your website. <\/p>\n

While adding this subdomain is optional, if you do opt to use it, it must appear as the first subdomain of the URL\u2019s host, like so: https:\/\/appclip.example.com<\/code>.<\/p>\n

Optimize for compression<\/strong>
\nConsider using the minimum number of characters needed to uniquely identify a resource in your URLs, as long UUIDs will lower the effectiveness of the compression.<\/p>\n

In addition, replace long query string argument names and values with short names and values to aid in compression. For example, you can turn argument names into shorter names and values into an enum, like so: https:\/\/example.com\/?status=view<\/code> could be restructured as https:\/\/example.com\/?p=0<\/code>.<\/p>\n

Using decimal numbers as query parameter values may also lead to better compression of the URL.<\/p>\n

Choose your words carefully<\/strong>
\nApp Clip Codes offer more effective URL encoding for certain words in the URL path component, like account<\/code>, app<\/code>, download<\/code>, shop<\/code>, upload<\/code>, visit<\/code>, and more. Consider using these whenever possible to improve your encoding and compression. You can view the full list of words within Apple\u2019s documentation.<\/p>\n

Learn more about encoding a URL in an App Clip Code<\/a><\/p>\n

In addition, a URL that contains zero or one path component from the list of special words and contains zero or more query components with ordered argument names p, p1, p2, and the like has a higher likelihood of fitting in an App Clip Code. Some examples:<\/p>\n

https:\/\/appclip.example.com\/shop<\/code>
\nhttps:\/\/appclip.example.com\/shop?p=123<\/code>
\nhttps:\/\/appclip.example.com\/?p=123<\/code>
\nhttps:\/\/appclip.example.com\/?p=123&p1=4632<\/code><\/p>\n

Resources<\/h3>\n

Learn more about creating App Clip Codes in App Store Connect<\/a><\/p>\n

Learn how to generate App Clip Codes<\/a><\/p>\n

\n
\n
<\/a> <\/section>\n
<\/p>\n

Explore App Clips<\/h4>\n

<\/a> <\/p>\n

Help people experience the right parts of your app at the exact moment they need them. We\u2019ll explain how to design and build an App Clip \u2014 a small part of your app that focuses on a specific task \u2014 and make it easily discoverable. Learn how to focus your App Clip on short and fast…<\/p>\n<\/section>\n<\/section>\n<\/section>\n

\n
\n
<\/a> <\/section>\n
<\/p>\n

Configure and link your App Clips<\/h4>\n

<\/a> <\/p>\n

App Clips are small parts of an app that offer a streamlined, direct experience and help people get what they need at the right time. Learn how you can invoke an App Clip through real-world experiences like App Clip Codes, NFC, and QR codes, or have them appear digitally through apps like Maps or…<\/p>\n<\/section>\n<\/section>\n<\/section>\n","protected":false},"excerpt":{"rendered":"

An App Clip is a small part of your app which provides specific information that best suits a given task or situation. An App Clip Code activates your App Clip, helping people access relevant information wherever they happen to be \u2014 whether they\u2019re picking up takeout from a restaurant, reading an article online, or passing […]<\/p>\n","protected":false},"author":2,"featured_media":122195,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[55],"tags":[],"class_list":["post-122194","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-apple-developer-news"],"_links":{"self":[{"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/posts\/122194","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/comments?post=122194"}],"version-history":[{"count":0,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/posts\/122194\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/media\/122195"}],"wp:attachment":[{"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/media?parent=122194"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/categories?post=122194"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/tags?post=122194"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}