DouYinPlatform

share

auth

shareUI

概述

DouYinPlatform封装了，图片，视频分享到抖音。使用抖音授权&登录，获取使用抖音登录第三方应用的权限。第三方使用抖音授权之后，可以通过接口调用的方式获得该抖音用户的相关公开信息，包括用户昵称、头像、性别和地区等信息。使用本原生插件需要到 https://open.douyin.com/platform/management 申请 DouYin 原生插件的开发者账号，并创建应用获取到 DouyinAppID 的 urlScheme。申请教程参考(https://open.douyin.com/platform/management)。

使用此原生插件之前需先配置 config.xml文件

config.xml 配置详解：

  • 名称：DouYinPlatform
  • 参数：DouyinAppID、urlScheme
  • 配置示例:
  <feature name="DouYinPlatform">
        <param name="DouyinAppID" value="awthr029xo9nkiay" />
        <param name="androidClientKey" value="awthr029xo9nkiay" />
        <param name="urlScheme" value="aw8wfn2w6s17v3pj" />

  </feature>

  • 字段描述:

    DouyinAppID：（必须配置）从 抖音平台获取的iOS端ClientKey

    androidClientKey：（必须配置）从 抖音平台获取的android端ClientKey

    urlScheme：（必须配置） 抖音的URL Schemes ，App之间通讯使用

注意：

iOS 平台上只支持分享系统相册内的图片视频，且必须添加白名单，如下：

   <preference name="querySchemes" value="douyinopensdk,douyinsharesdk,snssdk1128" />

详情参考 Yonbuilder 移动开发平台官方文档之-----白名单配置

share

分享单图/多图到抖音；分享图片要求：宽高都大于360/高宽比需满足区间 1/2.2-2.2；分享视频要求：时长要求在3s以上/格式要求mp4文件，且文件支持解析/画幅会根据机型白名单判断是否支持更高分辨率的，非白名单最短边不大于1100px，机型白名单以内是4096*2160。

注意：iOS端只支持分享系统相册内的图片视频。通过其它原生插件获取相册资源的id（不需transPath转换），然后传给paths即可。不支持图片视频混合。

share(callback(ret, err))

params

paths：

  • 类型：JSON 数组类型
  • 描述：要分享的图片/视频地址，支持原生地址，fs。图片/视频个数<=12，注意iOS端仅支持UIAlbum等原生插件返回的系统相册资源的ID，无需transPath接口转换。

type：

  • 类型：数字类型
  • 描述：分享内容类别
  • 取值范围：1/图片，2/视频
  • 默认：1

mHashTag：

  • 类型：字符串类型
  • 描述：（可选项）默认话题功能,使用默认话题功能前确保自己app拥有默认话题权限，否则功能无效。权限申请可参考分享内容携带话题相关内容。目前不支持拼接话题。抖音6.3.0以上版本可用

mState：

  • 类型：字符串类型
  • 描述：（可选项）两种传值：1.传入自定义字符串，会在回调中返回，可唯一标识这次请求；2.传入OpenAPI中申请ShareID，分享结果会通过Webhooks进行回调。通过ShareID文档了解更多

tikTokMicroAppInfo：

  • 类型：JSON对象类型
  • 描述：（可选项）小程序信息；成功发布视频后，在视频左下角带有小程序入口。开发者需要先在字节跳动小程序平台上开发小程序后，在抖音开放平台提交该功能的申请，完成 app 和指定小程序的绑定。点击开通分享内容携带小程序 注意：抖音 6.7.0 以上版本可用
  • 内部字段：
{appTitle:'',     //字符串类型；小程序title
description:'',         //字符串类型；小程序描述
appId:'',                 //字符串类型；appId
appUrl:'',              //字符串类型；小程序地址
}

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
    code:0,   //数字类型
                  0 ；成功
                  -1 ；通用错误类型（包括网络错误）
                  -2 ；用户手动取消
                  -3 ；发送失败
                  -4 ；权限序错误
                  -5 ；不支持	
                  2：用户留在抖音内（仅android支持）
    mState:'',              //字符串类型；与传参中mState一致，仅成功后返回
    
}

示例代码

var mobShare = api.require('DouYinPlatform');
mobShare.share({
paths:['','']
},function(ret) {
    if (ret)
       api.alert({
            msg: JSON.stringify(ret)
        })
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

auth

第三方登录

auth(callback(ret))

params

scope：

  • 类型：字符串类型
  • 描述：（可选项）授权域；授权域是指您的应用使用抖音授权之后，可以获得抖音用户的哪些信息，目前开放了user_info授权域，表示可以获得请求用户头像、昵称等相关信息的权限, 如果有多种必选权限，权限之间请使用逗号隔开, "xxx,xxx"
  • 默认值：‘user_info’

state：

  • 类型：字符串类型
  • 描述：（可选项）用于保持请求和回调的状态，授权请求后原样返回，可传任意String （iOS不支持）

optionalScope0：

  • 类型：字符串类型
  • 描述：（可选项）用户可选授权域0 （iOS不支持）

optionalScope1：

  • 类型：字符串类型
  • 描述：（可选项）用户可选授权域1 （iOS不支持）

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
    code:0,   //数字类型
                  0 ；成功
                  -1 ；通用错误类型（包括网络错误）
                  -2 ；用户手动取消
                  -3 ；发送失败
                  -4 ；权限序错误
                  -5 ；不支持	
    authCode:'',     //字符串类型；临时票据code，用来换取access_token
    state:'',           //字符串类型；同传入state
    grantedPermissions:'',         //字符串类型；获得的授权域
}

示例代码

var mobShare = api.require('DouYinPlatform');
mobShare.auth(function(ret) {
    if (ret) {
       api.alert({
            msg: JSON.stringify(ret)
        })
    } 
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

shareUI (仅支持iOS)

自带相册UI 分享单图/多图到抖音；分享图片要求：宽高都大于360/高宽比需满足区间 1/2.2-2.2；分享视频要求：时长要求在3s以上/格式要求mp4文件，且文件支持解析/画幅会根据机型白名单判断是否支持更高分辨率的，非白名单最短边不大于1100px，机型白名单以内是4096*2160

shareUI(callback(ret, err))

params

mHashTag：

  • 类型：字符串类型
  • 描述：（可选项）默认话题功能,使用默认话题功能前确保自己app拥有默认话题权限，否则功能无效。权限申请可参考分享内容携带话题相关内容。目前不支持拼接话题。抖音6.3.0以上版本可用

mState：

  • 类型：字符串类型
  • 描述：（可选项）两种传值：1.传入自定义字符串，会在回调中返回，可唯一标识这次请求；2.传入OpenAPI中申请ShareID，分享结果会通过Webhooks进行回调。通过ShareID文档了解更多

tikTokMicroAppInfo：

  • 类型：JSON对象类型
  • 描述：（可选项）小程序信息；成功发布视频后，在视频左下角带有小程序入口。开发者需要先在字节跳动小程序平台上开发小程序后，在抖音开放平台提交该功能的申请，完成 app 和指定小程序的绑定。点击开通分享内容携带小程序 注意：抖音 6.7.0 以上版本可用
  • 内部字段：
{appTitle:'',     //字符串类型；小程序title
description:'',         //字符串类型；小程序描述
appId:'',                 //字符串类型；appId
appUrl:'',              //字符串类型；小程序地址
}

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
    code:0,   //数字类型
                  0 ；成功
                  -1 ；通用错误类型（包括网络错误）
                  -2 ；用户手动取消
                  -3 ；发送失败
                  -4 ；权限序错误
                  -5 ；不支持	
                  2：用户留在抖音内（仅android支持）
    mState:'',              //字符串类型；与传参中mState一致，仅成功后返回
    
}

示例代码

var mobShare = api.require('DouYinPlatform');
mobShare.shareUI(function(ret) {
    if (ret) {
       api.alert({
            msg: JSON.stringify(ret)
        })
    }
});

可用性

iOS系统

可提供的1.0.0及更高版本

是否仍需要帮助？ 请保持联络！
最后更新于 2024/07/31