Apple Business guidance for capturing action links (quicklinks)

Action Links (Quicklinks)

App Store URL

The App Store URL allows the client device to display the logo that's associated with the provider of an app. The logo is displayed after a user selects the ellipsis (...) action button.

Apple Maps Place Card - Ellipsis (...), Menu & Logo

Category

Category identifies the UI button that should be displayed to a user on the place card.

Quicklink Relationship

A quicklink is an app. Quicklink relationship describes the nature of the association between the app and a location. It does not describe the nature of the association between the app and the provider of the app itself. Valid quicklink relationships are AUTHORIZED, OTHER and OWNER.

Authorized

Chic-fil-A/Yelp
Yelp provides its apps for use by different companies, including Chick-fil-A. The following describes the business association between Chick-fil-A and Yelp.

• Chic-fil-A, Inc has a contractual agreement with Yelp which allows them to systematically process food orders on the organization's behalf.
• Yelp is the provider of an app that's used to process these food orders.
• The nature of the association between the location and app is described in relationship as AUTHORIZED. Meaning, Yelp is authorized to offer the app on a device to users that interact with an agreed upon set of Chic-fil-A locations

The following data structure models the association of Yelp's app with a Chic-fil-A location. Whether Chick-fil-A or Yelp is the API partner managing the location, relationship must still be AUTHORIZED.

Action Link Details Example

{
  "actionLinkDetails": {
    "quicklinks": [
      {
        "category": "quicklinks.restaurant_order_food",
        "appStoreUrl": "https://apps.apple.com/us/app/yelp/284910350",
        "quicklinkUrl": "https://m.yelp.com/opportunity/chick-fil-a-austin-18?adjust_creative=apple&utm_campaign=action_link_order_food&utm_medium=feed_v2&utm_source=apple&vertical=food",
        "relationship": "AUTHORIZED"
      }
    ]
  }
}

Owner

Starbucks Coffee Company
Starbucks Coffee Company owns its locations and offers apps which allow users to order and pay for goods and services using their devices.

The nature of the association between a Starbucks location and the app is described in relationship as OWNER. This relationship type is the same regardless of whether the location data is provided directly by Starbucks Coffee Company or via a delegated partner.

Action Link Details Example

{
  "actionLinkDetails": {
    "quicklinks": [
      {
        "category": "quicklinks.restaurant_order_food",
        "appStoreUrl": "https://apps.apple.com/us/app/starbucks/id331177714",
        "quicklinkUrl": "https://starbucks.com//austin-18_link_order_food",
        "relationship": "OWNER"
      }
    ]
  }
}

note

quicklinkUrl is provided for illustration purposes and is not intended to be functional

Gap, Inc
Gap, Inc has four notable brands and each brand has its own app. The apps are all attributed to Gap, Inc, not their respective brands.

Brand	App Store
Athleta: Clothing & Wellness	Link
Banana Republic	Link
Gap	Link
Old Navy	Link

The nature of the association between an Old Navy location and its respective app is described in relationship as OWNER. This relationship type is the same regardless of whether the location data is provided directly by Gap, Inc, Old Navy itself, or via a delegated partner.

note

The relationship does not distinguish whether the app is owned by Old Navy or Gap, Inc. Currently, this level of granularity is not a requirement

Action Link Details Example

{
  "actionLinkDetails": {
    "quicklinks": [
      {
        "category": "quicklinks.retail_store_shop",
        "appStoreUrl": "https://apps.apple.com/us/app/old-navy-fun-fashion-value/id342792281",
        "quicklinkUrl": "https://gap.com/old-navy-shop-store",
        "relationship": "OWNER"
      }
    ]
  }
}