用户元数据 user-metadata

IMPORTANT
此页面上的内容仅供参考。 使用此API需要来自Adobe的当前许可证。 不允许未经授权使用。

用户元数据是指由MVPD维护并通过Adobe Pass身份验证REST API V2提供给程序员的用户特定的属性(例如邮政编码、家长评级、用户ID等)。

在身份验证流程完成后,用户元数据将变为可用,但在授权流程期间,某些元数据属性可能会更新,具体取决于MVPD和有问题的特定元数据属性。

用户元数据可用于增强用户的个性化,但也可用于分析。 例如,程序员可能使用用户的邮政编码来传送本地化的新闻或天气更新,或实施家长监控。

当MVPD以不同格式提供数据时,Adobe Pass身份验证会标准化用户元数据值。 此外,对于某些属性(例如,邮政编码),可以使用程序员的证书加密

Adobe Pass身份验证使程序员能够查看在其MVPD集成中提供的用户元数据,并🔗通过Adobe Pass TVE仪表板管理这些元数据。

用户元数据属性 attributes

下表列出了一些可供程序员使用的用户元数据属性:

类型
示例
需要加密
描述
详细信息
userID
字符串
“1o7241p”
帐户标识符。
属性值可以是家庭标识符或子帐户标识符。 如果MVPD支持子帐户并且当前用户不是主帐户所有者,则userID值将与householdID值不同。
upstreamUserID
字符串
“1o7241p”
用于并发监控的帐户标识符。
属性值可用于在MVPD和程序员网站及应用程序中强制实施并发限制。 对于大多数MVPD,upstreamUserID值与userID值相同。
householdID
字符串
“1o7241p”
用于家长控制的帐户标识符。
属性值可用于区分家庭和子帐户使用情况。 有时,如果无法提供真实评级,则将其用作家长控制的替代项;如果用户使用家庭帐户登录,则可以观看分级内容,否则,不会显示分级内容。 在MVPD中,此值表示方式存在很大差异(例如,家庭用户ID、户主ID、家庭负责人标志等),如果MVPD不支持子帐户,则它将与userID相同。
primaryOID
字符串
“uuidd1e19ec9-012c-124f-b520-acaf118d16a0”
帐户标识符。
该属性特定于AT&T。当typeID值设置为“Primary”时,primaryOID值与userID值相同。
typeID
字符串
"Primary"
指示当前用户是主帐户持有人还是辅助帐户持有人的属性。
该属性特定于AT&T。当typeID值设置为“Primary”时,primaryOID值与userID值相同。
is_hoh
字符串
"1"
指示当前用户是否为户主的属性。
该属性特定于Synacor。
hba_status
布尔型
"true"
指示当前用户是否通过HBA进行身份验证的属性。
allowMirroring
布尔型
"true"
指示当前设备是否可以镜像屏幕的属性。
该属性特定于频谱。
zip
数组
["77754", "12345"]
用户的邮政编码。
属性值可用于投放本地化的新闻、天气更新或体育赛事。 zip值表示需要与MVPD签订法律协议的敏感数据。 加密后,zip密钥的表示形式将为String,而不是Array
encryptedZip
字符串
“”
用户的加密邮政编码。
该属性专用于Comcast。
channelID
数组
["channel-1", "channel-2"]
用户有权查看的渠道列表。
属性值可用于从聚合多个网络的门户过滤各种渠道。 我们建议使用预授权API而不是此用户元数据属性来过滤掉用户不可用的渠道。
maxRating
对象
{ MPAA: "NR", VCHIP: "X", URL: "http://manage.my/parental" }
当前用户的最大家长分级。
属性值可用于根据“MPAA”或“VCHIP”等级筛选不适合于当前用户的内容。
language
字符串
"English"
语言设置。
属性值可用于根据用户的语言偏好显示消息。

对于程序员可用的用户元数据属性取决于MVPD提供的内容。 下表列出了各种MVPD提供的属性:

已签署法律协议(仅限zip)
用户ID位于AuthN
AuthN的上游用户ID
家庭ID位于AuthN/Z
AuthN ​上的主OID
AuthN的类型ID
户主在AuthN
HBA状态
允许在AuthZ上镜像
AuthN/Z上的​ 邮政编码
通道ID位于AuthN
AuthN/Z评分
语言
onNet
inHome
备注
正式名称
不适用
userID
upstreamUserID
householdID
primaryOID
typeID
is_hoh
hba_status
allowMirroring
zip
channelID
maxRating
language
onNet
inHome
需要加密
不适用
敏感
不适用
Adobe IdP
是(仅限AuthN)
是(仅限AuthN)
是(仅限AuthN)
不需要法律协议。
Synacor
是(仅限AuthN)
是(仅限AuthN)
是(仅限AuthN)
法律协议未涵盖所有代理的MVPD。 这是对Synacor的通用支持,可能不会汇总到其所有MVPD。
碟子
是(仅限AuthN)
是(仅限AuthN)
是(仅限AuthN)
它与所有Synacor MVPD共享相同的列表,加上upstreamUserID
Comcast
是(仅限AuthZ)
是(仅限AuthZ)
AT&T
是(仅限AuthN)
是(仅限AuthN)
签署了法律协议。
DTV
是(仅限AuthN)
COX
是(仅限AuthN)
Cablevision
是(仅限AuthN)
签署了法律协议。
频谱
是(仅限AuthN)
是(仅限AuthN)
是(仅限AuthN)
Charter
是(仅限AuthN)
是(仅限AuthN)
是(仅限AuthN)
威里宗
是(仅限AuthN)
宏达国际电子
罗杰斯
RCN
是(仅限AuthN)
是(仅限AuthN)
是(仅限AuthN)
东链
是(仅限AuthN)
是(仅限AuthN)
是(仅限AuthN)
Cogeco
是(仅限AuthN)
是(仅限AuthN)
Videotron
*
是(仅限AuthN)
它公开与userID具有相同值的householdID
代理马西隆
是(仅限AuthN)
是(仅限AuthN)
签署了法律协议。
代理Clearleap
是(仅限AuthN)
是(仅限AuthZ)
签署了法律协议。
代理GLDS
是(仅限AuthN)
其他MVPD
尚无法律协议,敏感元数据不可用于生产。 对于所有MVPD,userID均可用,无需额外工作。
IMPORTANT
在提供敏感用户元数据(例如,邮政编码)之前,必须与MVPD签署法律协议。

用户元数据加密 encryption

若要加密和解密用户元数据属性,程序员需要生成证书(公钥/私钥对)并🔗通过Adobe Pass TVE仪表板自行配置证书或与Adobe Pass身份验证代表共享公钥。

请按照以下步骤操作,以确保正确生成并配置证书:

  1. 下载并安装OpenSSL工具包(http://www.openssl.org)。

  2. 生成证书签名请求(CSR):

    • 生成密钥对。 在命令终端上,运行以下命令:

      code language-bash
      openssl genrsa -des3 -out mycompany-license.key 2048
      
    • 生成CSR。 在命令终端上,运行以下命令:

      code language-bash
      openssl req -new -key mycompany-license.key -out mycompany-license.csr -batch
      

      系统将提示您输入私钥的密码。

    • 创建私钥和密码的备份副本。 示例CSR:

      code language-none
      -----BEGIN CERTIFICATE REQUEST-----
      MIIBnTCCAQYCAQAwXTELMAkGA1UEBhMCU0cxETAPBgNVBAoTCE0yQ3J5cHRvMRIw
      EAYDVQQDEwlsb2NhbGhvc3QxJzAlBgkqhkiG9w0BCQEWGGFkbWluQHNlcnZlci5l
      eGFtcGxlLmRvbTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEAr1nYY1Qrll1r
      uB/FqlCRrr5nvupdIN+3wF7q915tvEQoc74bnu6b8IbbGRMhzdzmvQ4SzFfVEAuM
      MuTHeybPq5th7YDrTNizKKxOBnqE2KYuX9X22A1Kh49soJJFg6kPb9MUgiZBiMlv
      tb7K3CHfgw5WagWnLl8Lb+ccvKZZl+8CAwEAAaAAMA0GCSqGSIb3DQEBBAUAA4GB
      AHpoRp5YS55CZpy+wdigQEwjL/wSluvo+WjtpvP0YoBMJu4VMKeZi405R7o8oEwi
      PdlrrliKNknFmHKIaCKTLRcU59ScA6ADEIWUzqmUzP5Cs6jrSRo3NKfg1bd09D1K
      9rsQkRc9Urv9mRBIsredGnYECNeRaK5R1yzpOowninXC
      -----END CERTIFICATE REQUEST-----
      
  3. 将CSR发送给证书颁发机构(CA)(例如Verisign)。

  4. CA将以.p7b格式(PKCS#7,加密消息语法标准)向您发送证书。

  5. 部署.p7b证书。 使用私钥将PKCS#7 (.p7b)文件转换为PKCS#12 ( PFX文件、个人信息交换语法标准),并生成PEM文件(连接的证书容器文件):

    • 将PKCS#7文件转换为临时PEM文件。 在命令行上,运行以下命令:

      code language-none
      openssl pkcs7 -in mycompany-license.p7b -inform DER -out mycompany-license-temp.pem -outform PEM -print_certs
      
    • 将临时PEM文件转换为PFX文件。 在命令行上,运行以下命令:

      code language-none
      openssl pkcs12 -export -inkey mycompany-license.key -in mycompany-license-temp.pem -out mycompany-license.pfx -passin pass:private_key_password -passout pass:pfx_password
      
    • 将临时PEM文件转换为最终PEM文件。 在命令行上,运行以下命令:

      code language-none
      openssl x509 -in mycompany-license-temp.pem -inform PEM -out mycompany-license.pem -outform PEM
      
  6. 使用PEM文件通过Adobe Pass TVE仪表板配置🔗证书或将PEM文件发送到Adobe Pass身份验证代表。

    • 有关如何通过Adobe Pass TVE仪表板管理证书的更多详细信息,请参阅下一节。

    • Adobe Pass身份验证支持主证书和备份证书。 如果主证书以任何方式遭到破坏,您可以撤销该证书,然后切换到辅助证书。 这将确保在证书之间平稳过渡,对客户的影响最小。

用户元数据管理 management

IMPORTANT
如果您无权访问Adobe Pass TVE仪表板,请通过我们的Zendesk创建票证,并请求技术客户经理(TAM)为您进行适当的更改。

Adobe Pass TVE Dashboard是一款用于Adobe Pass身份验证客户(程序员)管理其配置和数据的工具。 此自助仪表板启用了Adobe Pass TVE仪表板用户指南文档中描述的一系列功能。

要查看和管理MVPD提供的用户元数据属性,请按照TVE集成功能板用户指南文档中的步骤操作。

要查看和管理用于加密用户元数据属性的证书,请按照面向程序员的TVE仪表板用户指南中的步骤或面向渠道的TVE仪表板用户指南文档中的步骤操作。

REST API V2 rest-api-v2

可以使用以下API检索用户元数据属性:

请参阅上述API的​ 响应 ​和​ 示例 ​部分,了解用户元数据属性的结构。

IMPORTANT
用户元数据在身份验证流程完成后变为可用,因此客户端应用程序不需要查询单独的端点来检索用户元数据信息,因为它已包含在配置文件信息中。

有关如何以及何时集成上述API的更多详细信息,请参阅以下文档:

某些元数据属性可能会在授权流程期间更新,具体取决于MVPD和特定的元数据属性。 因此,客户端应用程序可能需要再次查询上述API以检索最新的用户元数据。

recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b