Android 接入指南

注:本文为抖音短视频 Android 终端 SDK 新手使用教程,只涉及 SDK 的使用方法,默认读者已经具有使用 Android Studio 开发 Android 程序的经验,以及相关的编程知识基础等。

通用流程

SDK 最低支持:Android API 15 - 4.0.x 版本

SDK 接入目前需要引入两个依赖包,包括opensdk-china-externalopensdk-common,为了方便,两者使用同样的版本号。当前最新版本为 0.1.9.0。

第一步:向抖音短视频申请你的 clientkey 及相关权限

请到开发者应用登记页面进行申请,申请后将获得 clientkey, 之后通过 clientkey 为应用申请相关的权限,如分享、授权、默认话题等;审核通过后即可使用相关的功能;

第二步:集成到开发环境

  1. aar 由之前 bintray 平台迁移到字节自建 maven 库,需要添加如下配置
//gradle文件中添加:
repositories {
    maven { url 'https://artifact.bytedance.com/repository/AwemeOpenSDK' }
}

dependencies {
    implementation 'com.bytedance.ies.ugc.aweme:opensdk-china-external:0.1.9.0'
    implementation 'com.bytedance.ies.ugc.aweme:opensdk-common:0.1.9.0'
}

第三步:配置抖音的软件包可见性

Android 11 为了加强了隐私保护策略,引入了很多变更和限制,其中软件包可见性 变更,将会导致第三方应用通过抖音开放平台的 SDK 无法正常拉起抖音,从而无法使用开放平台的全部功能,包括但不限于分享消息到抖音、通过抖音进行账号登陆等功能。

特别需要注意的是,Android11 的该变更只会影响到升级<strong>targetSdkVersion=30</strong>的应用,未升级的应用暂不受影响

<manifest xmlns:android="http://schemas.android.com/apk/res/android" package="com.xxx.xxxx">
  <queries>
    <!--允许查询抖音和抖音极速版的软件包信息-->
    <package android:name="com.ss.android.ugc.aweme" />
    <package android:name="com.ss.android.ugc.aweme.lite" />
  </queries>
</manifest>

至此,sdk 开发环境配置完毕. 具体子功能接入请查阅相关功能接入文档;

常见问题 FAQ

Q: 若想使用抖音的授权和分享功能必须同时集成 opensdk-china-external 和 opensdk-common 两个 aar 吗?

A: 是的,新版 sdk 必须要同时集成两个 aar 才可以使用抖音授权和分享功能

Q: 国内和国际版分两个包还是一个包?可以同一 app 内同时接抖音和 tiktok 相关功能吗?

A: 目前使用抖音分享授权功能和使用 tiktok 分享授权功能不再共用一个 aar,若想使用 tiktok 授权功能,请仔细阅读tiktok for developers内容。

Q: sdk 升级到新版 0.1.1.0 之后,一些 api 为什么飘红了,甚至一些类或 api 找不到了?

A: 为了适配抖音国际化,此次 sdk 对部分 api 命名做了规范,删除了了一些冗余的 api,此外,包结构以及一些类名做了相关变更。开放者只需根据分享手册授权开发手册重新引入类或修改为正确类名即可。带来的不便还请见谅;

更多 FAQ 参考Android 常见问题

诚邀您对本文档易读易用性进行评价
好用
不好用