GetCustomPrivacyPolicy - 获取自定义条款

获取自定义条款

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx

CustomPrivacyPolicyId

string

自定义条款 ID

pp_xxxxx

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

0441BD79-92F3-53AA-8657-F8CE4A2B912A

CustomPrivacyPolicy

object

自定义条款。

CustomPrivacyPolicyId

string

自定义条款 ID。

pp_xxxxx

CustomPrivacyPolicyName

string

自定义条款名称。

Custom Privacy Policy Name

Status

string

账户状态,取值可选范围:

  • enabled: 启用。

  • disabled: 禁用。

枚举值:

  • disabled :

    禁用

  • enabled :

    启用

enabled

DefaultLanguageCode

string

自定义条款所属语言,具体的值来自 ListLanguages 接口的返回值 LanguageCode。

zh-Hans-CN

UserConsentType

string

同意条款类型。

枚举值:

  • explicit_consent :

    手动勾选同意

  • implied_consent :

    默认同意

implied_consent

CustomPrivacyPolicyContents

array<object>

自定义条款内容详情。

array<object>

CustomPrivacyPolicyTip

string

自定义条款内容提示。

Please read and agree:

LanguageCode

string

自定义条款所属语言,具体的值来自 ListLanguages 接口的返回值 LanguageCode。

zh-Hans-CN

CustomPrivacyPolicyItems

array<object>

自定义条款项。

object

CustomPrivacyPolicyItemName

string

自定义条款项名称。

item name

CustomPrivacyPolicyItemUrl

string

自定义条款项访问地址,必须 https://开头。

https://example.com

InstanceId

string

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx

示例

正常返回示例

JSON格式

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "CustomPrivacyPolicy": {
    "CustomPrivacyPolicyId": "pp_xxxxx",
    "CustomPrivacyPolicyName": "Custom Privacy Policy Name",
    "Status": "enabled",
    "DefaultLanguageCode": "zh-Hans-CN",
    "UserConsentType": "implied_consent",
    "CustomPrivacyPolicyContents": [
      {
        "CustomPrivacyPolicyTip": "Please read and agree:",
        "LanguageCode": "zh-Hans-CN",
        "CustomPrivacyPolicyItems": [
          {
            "CustomPrivacyPolicyItemName": "item name",
            "CustomPrivacyPolicyItemUrl": "https://example.com"
          }
        ]
      }
    ],
    "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情