Back to Details

asc-app-clips

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

App Clips with 
asc

使用
asc
管理App Clips

Manage App Clips, their default experiences, and locale-specific card content through the App Store Connect API.
通过App Store Connect API管理App Clips、它们的默认体验以及特定区域的卡片内容。

Authentication

身份验证

bash
asc auth login --key-id <id> --issuer-id <id> --private-key-path ~/.asc/AuthKey.p8
bash
asc auth login --key-id <id> --issuer-id <id> --private-key-path ~/.asc/AuthKey.p8

How to Navigate (CAEOAS Affordances)

操作导航（CAEOAS 功能入口）

Every JSON response contains an 
"affordances"
field with ready-to-run commands — IDs already filled in. Start from the App Clip and navigate to experiences and localizations.
json
{
  "id": "clip-abc",
  "appId": "6443417124",
  "bundleId": "com.example.MyApp.Clip",
  "affordances": {
    "listAppClips": "asc app-clips list --app-id 6443417124",
    "listExperiences": "asc app-clip-experiences list --app-clip-id clip-abc"
  }
}
每个JSON响应都包含一个
"affordances"
字段，其中包含可直接运行的命令——ID已自动填充。从App Clip开始，可导航到对应的体验和本地化内容。
json
{
  "id": "clip-abc",
  "appId": "6443417124",
  "bundleId": "com.example.MyApp.Clip",
  "affordances": {
    "listAppClips": "asc app-clips list --app-id 6443417124",
    "listExperiences": "asc app-clip-experiences list --app-clip-id clip-abc"
  }
}

Typical Workflow

典型工作流

Set up an App Clip experience with localizations

创建带本地化内容的App Clip体验

bash
undefined
bash
undefined

1. Find the App Clip for your app

1. 找到你的应用对应的App Clip

asc app-clips list --app-id 6443417124 --pretty
asc app-clips list --app-id 6443417124 --pretty

2. Create a default experience (copy --app-clip-id from the listExperiences affordance)

2. 创建默认体验（从listExperiences功能入口中复制--app-clip-id）

asc app-clip-experiences create
--app-clip-id clip-abc
--action OPEN
--pretty
asc app-clip-experiences create
--app-clip-id clip-abc
--action OPEN
--pretty

3. Add an English localization (copy --experience-id from the listLocalizations affordance)

3. 添加英文本地化内容（从listLocalizations功能入口中复制--experience-id）

asc app-clip-experience-localizations create
--experience-id exp-xyz
--locale en-US
--subtitle "Order faster with your loyalty card"
--pretty
asc app-clip-experience-localizations create
--experience-id exp-xyz
--locale en-US
--subtitle "Order faster with your loyalty card"
--pretty

4. Add a French localization

4. 添加法文本地化内容

asc app-clip-experience-localizations create
--experience-id exp-xyz
--locale fr-FR
--subtitle "Commandez plus vite avec votre carte"
--pretty
asc app-clip-experience-localizations create
--experience-id exp-xyz
--locale fr-FR
--subtitle "Commandez plus vite avec votre carte"
--pretty

5. Review all localizations

5. 查看所有本地化内容

asc app-clip-experience-localizations list --experience-id exp-xyz --output table
undefined
asc app-clip-experience-localizations list --experience-id exp-xyz --output table
undefined

View all App Clip content at a glance

一键查看所有App Clip内容

bash
CLIP_ID=$(asc app-clips list --app-id APP_ID | jq -r '.data[0].id')
asc app-clip-experiences list --app-clip-id "$CLIP_ID" --output table

EXP_ID=$(asc app-clip-experiences list --app-clip-id "$CLIP_ID" | jq -r '.data[0].id')
asc app-clip-experience-localizations list --experience-id "$EXP_ID" --output table
bash
CLIP_ID=$(asc app-clips list --app-id APP_ID | jq -r '.data[0].id')
asc app-clip-experiences list --app-clip-id "$CLIP_ID" --output table

EXP_ID=$(asc app-clip-experiences list --app-clip-id "$CLIP_ID" | jq -r '.data[0].id')
asc app-clip-experience-localizations list --experience-id "$EXP_ID" --output table

Commands

命令说明

asc app-clips list

asc app-clips list

List all App Clips for an app.
FlagRequiredDescription
--app-id
yesApp Store Connect app ID
--output table|json
noOutput format (default: json)
--pretty
noPretty-print JSON
bash
asc app-clips list --app-id 6443417124 --pretty
asc app-clips list --app-id 6443417124 --output table
列出应用的所有App Clips。
参数是否必填说明
--app-id
是App Store Connect应用ID
--output table|json
否输出格式（默认：json）
--pretty
否格式化输出JSON
bash
asc app-clips list --app-id 6443417124 --pretty
asc app-clips list --app-id 6443417124 --output table

asc app-clip-experiences list

asc app-clip-experiences list

List default experiences for an App Clip.
FlagRequiredDescription
--app-clip-id
yesApp Clip ID
--output table|json
noOutput format
--pretty
noPretty-print JSON
bash
asc app-clip-experiences list --app-clip-id clip-abc --pretty
列出某个App Clip的所有默认体验。
参数是否必填说明
--app-clip-id
是App Clip ID
--output table|json
否输出格式
--pretty
否格式化输出JSON
bash
asc app-clip-experiences list --app-clip-id clip-abc --pretty

asc app-clip-experiences create

asc app-clip-experiences create

Create a default experience for an App Clip.
FlagRequiredDescription
--app-clip-id
yesApp Clip ID
--action
no
OPEN
, 
VIEW
, or 
PLAY
--output table|json
noOutput format
--pretty
noPretty-print JSON
bash
asc app-clip-experiences create --app-clip-id clip-abc --action OPEN --pretty
asc app-clip-experiences create --app-clip-id clip-abc  # no action
为某个App Clip创建默认体验。
参数是否必填说明
--app-clip-id
是App Clip ID
--action
否
OPEN
、
VIEW
或
PLAY
--output table|json
否输出格式
--pretty
否格式化输出JSON
bash
asc app-clip-experiences create --app-clip-id clip-abc --action OPEN --pretty
asc app-clip-experiences create --app-clip-id clip-abc  # 不指定action

asc app-clip-experiences delete

asc app-clip-experiences delete

Delete a default experience.
FlagRequiredDescription
--experience-id
yesExperience ID to delete
bash
asc app-clip-experiences delete --experience-id exp-xyz
删除某个默认体验。
参数是否必填说明
--experience-id
是要删除的体验ID
bash
asc app-clip-experiences delete --experience-id exp-xyz

asc app-clip-experience-localizations list

asc app-clip-experience-localizations list

List localizations for a default experience.
FlagRequiredDescription
--experience-id
yesExperience ID
--output table|json
noOutput format
--pretty
noPretty-print JSON
bash
asc app-clip-experience-localizations list --experience-id exp-xyz --pretty
列出某个默认体验的所有本地化内容。
参数是否必填说明
--experience-id
是体验ID
--output table|json
否输出格式
--pretty
否格式化输出JSON
bash
asc app-clip-experience-localizations list --experience-id exp-xyz --pretty

asc app-clip-experience-localizations create

asc app-clip-experience-localizations create

Create a localization for a default experience. Each locale gets its own subtitle shown in the App Clip card.
FlagRequiredDescription
--experience-id
yesExperience ID
--locale
yesLocale code (e.g. 
en-US
, 
fr-FR
, 
zh-Hans
)
--subtitle
noSubtitle shown in the App Clip card
--output table|json
noOutput format
--pretty
noPretty-print JSON
bash
asc app-clip-experience-localizations create \
  --experience-id exp-xyz \
  --locale en-US \
  --subtitle "Order faster with your loyalty card"
为某个默认体验创建本地化内容。每个区域可设置专属的App Clip卡片副标题。
参数是否必填说明
--experience-id
是体验ID
--locale
是区域代码（如
en-US
、
fr-FR
、
zh-Hans
）
--subtitle
否App Clip卡片显示的副标题
--output table|json
否输出格式
--pretty
否格式化输出JSON
bash
asc app-clip-experience-localizations create \
  --experience-id exp-xyz \
  --locale en-US \
  --subtitle "Order faster with your loyalty card"

asc app-clip-experience-localizations delete

asc app-clip-experience-localizations delete

Delete a localization.
FlagRequiredDescription
--localization-id
yesLocalization ID to delete
bash
asc app-clip-experience-localizations delete --localization-id loc-abc
删除某个本地化内容。
参数是否必填说明
--localization-id
是要删除的本地化内容ID
bash
asc app-clip-experience-localizations delete --localization-id loc-abc

Domain Models

领域模型

AppClip
 — An App Clip linked to an app
  • id
    — App Clip ID
  • appId
    — parent App ID (injected from request, not returned by API)
  • bundleId
    — App Clip bundle identifier (omitted from JSON if nil)
  • Affordances: 
    listAppClips
    , 
    listExperiences
AppClipDefaultExperience
 — How an App Clip is invoked
  • id
    — experience ID
  • appClipId
    — parent App Clip ID (injected)
  • action
    — 
    OPEN
    , 
    VIEW
    , or 
    PLAY
    (omitted from JSON if nil)
  • Affordances: 
    delete
    , 
    listExperiences
    , 
    listLocalizations
AppClipDefaultExperienceLocalization
 — Locale-specific App Clip card content
  • id
    — localization ID
  • experienceId
    — parent experience ID (injected)
  • locale
    — locale code (e.g. 
    en-US
    )
  • subtitle
    — subtitle shown in the App Clip card (omitted from JSON if nil)
  • Affordances: 
    delete
    , 
    listLocalizations
AppClip
 — 关联到应用的App Clip
  • id
    — App Clip ID
  • appId
    — 父应用ID（由请求注入，API不返回）
  • bundleId
    — App Clip的Bundle标识符（若为空则不显示在JSON中）
  • 功能入口：
    listAppClips
    、
    listExperiences
AppClipDefaultExperience
 — App Clip的唤起方式
  • id
    — 体验ID
  • appClipId
    — 父App Clip ID（由请求注入）
  • action
    — 
    OPEN
    、
    VIEW
    或
    PLAY
    （若为空则不显示在JSON中）
  • 功能入口：
    delete
    、
    listExperiences
    、
    listLocalizations
AppClipDefaultExperienceLocalization
 — 特定区域的App Clip卡片内容
  • id
    — 本地化内容ID
  • experienceId
    — 父体验ID（由请求注入）
  • locale
    — 区域代码（如
    en-US
    ）
  • subtitle
    — App Clip卡片显示的副标题（若为空则不显示在JSON中）
  • 功能入口：
    delete
    、
    listLocalizations

Full Command Reference

完整命令参考

See commands.md for all flags and examples.
查看commands.md获取所有参数及示例。