Uppy Google Photos 插件

@uppy/google-photos 插件允许用户从他们的 Google 照片账户导入文件。

何时使用这个？

当你想让用户从他们的 Google 照片账户导入文件时。

使用 Google 照片插件需要一个 Companion 实例。Companion 负责与 Google 照片进行身份验证，下载照片/视频，并将其上传到目的地。这节省了用户的带宽，特别是当他们在移动网络上时特别有用。

你可以自托管 Companion 或者通过任何 Transloadit 计划获得托管版本。

npm
```
npm install @uppy/google-photos
```
Shell
yarn
```
yarn add @uppy/google-photos
```
Shell

CDN

警告

此捆绑包包含了大部分Uppy插件，因此不建议在生产环境中使用此方法，因为尽管您可能仅仅用到其中一小部分插件，但用户却需要下载全部插件。
然而，这对于加速您的开发环境非常有帮助，所以在起步阶段，请放心使用它来提升开发速度。


<!-- 1. Add CSS to `<head>` -->
<link href="https://releases.transloadit.com/uppy/v3.27.3/uppy.min.css" rel="stylesheet">

<!-- 2. Initialize -->
<div id="uppy"></div>

<script type="module">
    import { Uppy, GooglePhotos } from "https://releases.transloadit.com/uppy/v3.27.3/uppy.min.mjs"
    const uppy = new Uppy()
    uppy.use(GooglePhotos, {
    // Options
    })
</script>

使用

使用 Google 照片需要在 Uppy 和 Companion 中都进行设置。

在 Uppy 中使用


import Uppy from "@uppy/core";
import Dashboard from "@uppy/dashboard";
import GooglePhotos from "@uppy/google-photos";

import "@uppy/core/dist/style.min.css";
import "@uppy/dashboard/dist/style.min.css";

new Uppy()
  .use(Dashboard, { inline: true, target: "#dashboard" })
  .use(GooglePhotos, {
    target: Dashboard,
    companionUrl: "https://your-companion.com",
  });

在 Companion 中使用

要注册 API 密钥，请前往 Google 开发者控制台。

如果你还没有项目，为你的应用创建一个。

在项目的仪表板上，启用 Google 照片 API。
设置 OAuth 授权。

应用页面有一个 "重定向 URI" 字段。在这里添加：


https://$YOUR_COMPANION_HOST_NAME/googlephotos/redirect

如果你使用的是 Transloadit 托管的 Companion：


https://api2.transloadit.com/companion/googlephotos/redirect

Google 会提供给你一个 OAuth 客户端 ID 和客户端密钥。

在 Companion 中配置 Google 密钥和密钥。对于独立的 Companion 服务器，指定环境变量：


export COMPANION_GOOGLE_KEY="Google OAuth 客户端 ID"
export COMPANION_GOOGLE_SECRET="Google OAuth 客户端秘密"

当使用 Companion Node.js API 时，配置这些选项：


companion.app({
  providerOptions: {
    googlephotos: {
      key: "Google OAuth 客户端 ID",
      secret: "Google OAuth 客户端秘密",
    },
  },
});

API

选项

`id`

此插件的唯一标识符（ string，默认值：'GooglePhotos' ）。

`title`

在 UI 中显示的标题/名称，例如 Dashboard 标签（ string，默认值：'GooglePhotos' ）。

`target`

放置拖放区域的 DOM 元素、CSS 选择器或插件（ string 或 Element，默认值：null ）。

`companionUrl`

到 Companion 实例的 URL（ string，默认值：null ）。

`companionHeaders`

每次请求时应随 Companion 发送的自定义头部（ Object，默认值：{} ）。

`companionAllowedHosts`

有效且授权的 URL(s)，用于接收 OAuth 响应 ( string 或 RegExp 或 Array，默认值: companionUrl )。

此值可以是 string、RegExp 模式或两者的 Array。当你有 Companion 运行在多个主机上时，这非常有用。否则，默认值应该足够好。

`companionCookiesRule`

此选项对应于 RequestCredentials 值（ string，默认值: 'same-origin' ）。

这告诉插件是否应向 Companion 发送 cookies。

`locale`


export default {
  strings: {
    pluginNameGooglePhotos: "谷歌相册",
  },
};

Uppy Google Photos 插件

何时使用这个？

使用

在 Uppy 中使用

在 Companion 中使用

API

选项

id

title

target

companionUrl

companionHeaders

companionAllowedHosts

companionCookiesRule

locale

在本文档中