as

Settings
Sign out
Notifications
Alexa
亚马逊应用商店
Ring
AWS
文档
Support
Contact Us
My Cases
开发
测试
应用发布
盈利
用户参与
设备规格
资源

徽标 (VSK Echo Show)

徽标 (VSK Echo Show)

在搜索结果图块上或视频播放上方添加徽标或上下文图像通常很有用,这样可以为用户提供有用的信息。此部分介绍可用的徽标类型及其预期用途。

您可以实现的徽标

下表示出了您可以实现的显示徽标的类型。

徽标类型 描述
记录 当用户主动记录内容时,会显示此徽标。此徽标优先于所有其他徽标。
上线 此徽标将在实时播出当前活动时显示(例如,奥斯卡、艾美奖颁奖典礼和体育比赛等节目)。
当前热映 当内容在给定时间在某个频道播出时,会显示此徽标,不会被视为直播。

除徽标外,您还应显示网络标志或网络呼叫信号,以表明播放该内容片段的位置。例如,假设用户说:“Show me comedy TV shows on [provider]”(播放 [提供方] 上的喜剧电视节目)。 在这种情况下,[提供方] 可以显示来自多个网络的内容,例如ABC、HBO、CBS等。 

当您在多模式设备上返回此类结果时,还应在方框图案的底部显示网络标志,以表明内容的来源。如果网络标志不可用,则应显示网络呼叫信号,例如ABC、HBO等。 

内容新鲜度

您还应使用搜索结果元数据指明内容是否为“新”内容。此信息来自内容提供方,显示的目的是表明该内容是首次播出。

例如,如果您搜索“The Big Bang Theory”的剧集,并且第1-5集已经播出,现在第6集可供观看,则内容提供方应通知您,以便您可以显示“NEW”(新)以及该剧集的其他元数据。 

您可以通过来自Lambda的GetDisplayableItemsMetadataResponseGetPlayableItemsMetadataResponse响应,在技能中指定徽标。 

徽标API

要支持徽标,应在GetDisplayableItemsMetadataResponse响应有效负载中使用以下结构: 

  • recording: 用于指明当前是否正在记录内容。
  • contentFreshness: 用于指明内容是否为新内容。
  • networkDetails: 用于指定频道元数据。
  • airingDetails: 用于指定开始和结束时间以及内容是否为直播。

GetDisplayableItemsMetadataResponse示例

以下是来自Lambda的GetDisplayableItemsMetadataResponse示例,其中含有徽标。

{
    "payload": {
        "searchResults": [
            {
                "name": "Interstellar",
                "contentType": "LIVE",
                "releaseYear": "2011",
                "selectionAction": "PLAY",
                "thumbnailImage": {
                    "contentDescription": "InterstellarImage",
                    "sources": [
                        {
                            "url": "https://ecx.images-amazon.com/images/I/81nSh3pZUDL.RI.jpg",
                            "size": "X_SMALL",
                            "widthPixels": 480,
                            "heightPixels": 320
                        }
                    ]
                },
                "runtime": {
                    "runTimeInMilliseconds": 120931123,
                    "displayString": "2h30min"
                },
                "closedCaption": {
                    "status": "AVAILABLE",
                    "displayString": "CC"
                },
                "absoluteViewingPositionMilliseconds": 0,
                "parentalControl": {
                    "pinControl": "REQUIRED"
                },
                "viewingDisplayString": "PlayNow",
                "rating": {
                    "category": "PG-13"
                },
                "recording": {
                    "status": "RECORDING"
                },
                "contentFreshness": {
                    "state": "NEW"
                },
                "networkDetails": [
                    {
                        "channel": {
                            "number": "1234",
                            "callSign": "PBS",
                            "affiliateCallSign": "KCTS9",
                            "uri": "someUrl"
                        },
                        "channelMetadata": {
                            "name": "AlternateChannelName",
                            "image": "https://ecx.images-amazon.com/images/I/81nSh3pZUDL.RI.jpg"
                        },
                        "airingDetails": [
                            {
                                "isLiveBroadcast": "true",
                                "end": "2018-01-24T02: 30: 00Z",
                                "start": "2018-01-24T00: 00: 00Z"
                            }
                        ]
                    }
                ]
            }
        ]
    }
}

有效负载描述

有效负载描述
字段 描述 数据类型
recording
可选

与记录相关的信息。当前结构只有一个用于status的字段。之所以将此设置为结构而不是独立字段,是因为Alexa技能工具包将来可能需要向记录结构添加更多信息。将其作为对象使用可让Alexa技能工具包对这些项目进行分组,并使其可扩展以满足未来的需求。

对象
status (recording)
可选

内容的记录状态。允许使用以下枚举值:

  • RECORDED: 这意味着先前已记录该内容。
  • RECORDING: 这意味着在提出请求时,正在活跃地记录内容。
  • SCHEDULED: 这意味着计划在将来的某个时候记录内容。



示例: RECORDEDRECORDINGSCHEDULED

字符串
contentFreshness
可选

有关内容新鲜度的详细信息。

对象
state (contentFreshness)
可选

对于Alexa从中获取结果的提供方而言,此内容是否是新内容。唯一允许的枚举值是NEW — 这意味着内容是新的,并且是首次在提供方播出。



示例: NEW

字符串
networkDetails
可选

网络详细信息提供有关节目通过哪个网络播放的信息。例如,通过CBS播出"The Big Bang Theory"的新剧集,或通过ESPN播出直播足球赛。对于点播内容,例如,这可以是显示HBO "Game of thrones"结果的Prime Video。如果结果项目表示频道上的直播节目(contentType = LIVE),则该对象包含其元数据。

列表
isLiveBroadcast
可选

内容是否为实时播放。对于实时发生的现场活动,如观看NFL橄榄球比赛,或奥斯卡或艾美奖等颁奖典礼,将此项设置为true

对于在初始播放时间之前已拍摄好的内容,将此项设置为false。例如,每周四播出的Big Bang Theory的新剧集。对于曾经实时流式播放但现在不再实时播放的内容(如过去的橄榄球比赛),也必须将此项设置为false



示例truefalse

布尔值

GetPlayableItemsMetadataResponse示例

GetDisplayableItemsMetadata中使用的相同networkDetails结构也用于GetPlayableItemsMetadata。以下是GetPlayableItemsMetadataResponse响应示例:

{
    "event": {
        "header": {
            "correlationToken": "dFMb0z+PgpgdDmluhJ1LddFvSqZ/jCc8ptlAKulUj90jSqg==",
            "messageId": "38ce5b22-eeff-40b8-a84f-979446f9b27e",
            "name": "GetPlayableItemsMetadataResponse",
            "namespace": "Alexa.VideoContentProvider",
            "payloadVersion": "3"
        },
        "payload": {
            "searchResults": [
                {
                    "name": "Interstellar",
                    "contentType": "LIVE",
                    "playbackContextToken": "amzn1.dv.gti.b4a9f7c6-5def-7e63-9aa7-df38a479333e",
                    "parentalControl": {
                        "pinControl": "REQUIRED"
                    },
                    "networkDetails": [
                        {
                            "channel": {
                                "callSign": "PBS",
                                "affiliateCallSign": "KCTS9"
                            },
                            "channelMetadata": {
                                "name": "AlternateChannelName"
                            },
                            "airingDetails": [
                                {
                                    "isLiveBroadcast": "true",
                                    "end": "2018-01-24T02: 30: 00Z",
                                    "start": "2018-01-24T00: 00: 00Z"
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    }
}

Last updated: 2021年5月24日