导入
创建和编辑频道
学习如何使用 Vimeo API 创建新频道并对其进行编辑。
...
| 参数名称 | 类型 | 分类 | 描述 |
|---|---|---|---|
| description | 字符串 | 可选 | 该参数用于指定频道的描述,即说明该频道的主题内容。 |
| link | 字符串 | 可选 | 该参数可用于定义频道的自定义链接。传入此字段的字符串将替代频道 ID 出现在 URL 中。通过使用自定义名称访问频道(而非难以记忆的数字 ID),可提升访问便捷性。 |
| name | 字符串 | 必填 | 该字段用于定义频道的名称。 |
| privacy | 字符串 | 必填 | 用于指定频道的隐私级别。其值可以是:anybody:任何人都可访问该频道;moderators:仅频道的管理员可访问;user:仅管理员和指定用户可访问。 |
1// 在此处定义 API 密钥 2const API_KEY = 'Bearer {{AUTH_CODE}}'; 3 4// 在此处定义接口地址 5const endpointUrl = 'https://api.vimeo.com/channels'; 6 7// 在此处定义请求体参数 8const bodyParameters = JSON.stringify({ 9 name: 'Vimeo API 测试频道', 10 privacy: 'anybody', 11}); 12 13// 在此处定义请求头参数 14const headerParameters = { 15 authorization: API_KEY, 16 'Content-Type': 'application/json', 17}; 18 19// 设置 API 调用选项 20const options = { 21 method: 'post', 22 headers: headerParameters, 23 body: bodyParameters, 24}; 25 26// 定义发起 API 调用的函数 27async function createNewChannel() { 28 try { 29 const response = await fetch(`${endpointUrl}`, options); 30 31 // 输出响应结果 32 printResponse(response); 33 } catch (error) { 34 // 输出错误信息 35 printError(error); 36 } 37} 38 39// 调用函数执行 API 请求 40createNewChannel();
| 字段 | 描述 |
|---|---|
| uri | 该字符串字段表示创建后频道的唯一资源标识符。该值末尾的数值即为频道 ID。 |
| name | 该字段返回频道的显示名称。 |
| description | 该字段简要描述该频道的内容。当前值为 null。 |
| privacy | 该对象定义了频道的隐私设置。 |
| privacy.view | 该字段显示调用时作为参数设定的隐私级别。 |
1// 在此处定义 API 密钥 2const API_KEY = 'Bearer {{AUTH_CODE}}'; 3 4// 在此处定义新频道 ID 5const newChannelID = '{{NEW_CHANNEL_ID}}'; 6 7// 在此处定义接口地址 8const endpointUrl = `https://api.vimeo.com/channels/${newChannelID}`; 9 10// 在此处定义请求体参数 11const bodyParameters = JSON.stringify({ 12 description: '这是一个用于 API 测试的演示频道......' 13}); 14 15// 在此处定义请求头参数 16const headerParameters = { 17 authorization: API_KEY, 18 'Content-Type': 'application/json', 19}; 20 21// 设置 API 调用选项 22const options = { 23 method: 'patch', 24 headers: headerParameters, 25 body: bodyParameters, 26}; 27 28// 定义发起 API 调用的函数 29async function editChannel() { 30 try { 31 const response = await fetch(`${endpointUrl}`, options); 32 33 // 输出响应结果 34 printResponse(response); 35 } catch (error) { 36 // 输出错误信息 37 printError(error); 38 } 39} 40 41// 调用函数执行 API 请求 42editChannel();