cURL
curl --request PUT \
--url https://api.brightdata.com/datasets/views/{view_id}/delivery_settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filename": {
"extension": "json",
"template": "bd_{[datetime]}",
"tz_offset": "+00:00"
},
"flatten_csv": false,
"deliver": {
"type": "s3",
"bucket": "my-bucket",
"credentials": {
"aws-access-key": "AKIAIOSFODNN7",
"aws-secret-key": "wJalrXUtnFEMI"
},
"region": "us-east-1",
"directory": "my/directory"
},
"tar": true,
"compress": true,
"batch_size": 1000
}
'import requests
url = "https://api.brightdata.com/datasets/views/{view_id}/delivery_settings"
payload = {
"filename": {
"extension": "json",
"template": "bd_{[datetime]}",
"tz_offset": "+00:00"
},
"flatten_csv": False,
"deliver": {
"type": "s3",
"bucket": "my-bucket",
"credentials": {
"aws-access-key": "AKIAIOSFODNN7",
"aws-secret-key": "wJalrXUtnFEMI"
},
"region": "us-east-1",
"directory": "my/directory"
},
"tar": True,
"compress": True,
"batch_size": 1000
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
filename: {extension: 'json', template: 'bd_{[datetime]}', tz_offset: '+00:00'},
flatten_csv: false,
deliver: {
type: 's3',
bucket: 'my-bucket',
credentials: {'aws-access-key': 'AKIAIOSFODNN7', 'aws-secret-key': 'wJalrXUtnFEMI'},
region: 'us-east-1',
directory: 'my/directory'
},
tar: true,
compress: true,
batch_size: 1000
})
};
fetch('https://api.brightdata.com/datasets/views/{view_id}/delivery_settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.brightdata.com/datasets/views/{view_id}/delivery_settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'filename' => [
'extension' => 'json',
'template' => 'bd_{[datetime]}',
'tz_offset' => '+00:00'
],
'flatten_csv' => false,
'deliver' => [
'type' => 's3',
'bucket' => 'my-bucket',
'credentials' => [
'aws-access-key' => 'AKIAIOSFODNN7',
'aws-secret-key' => 'wJalrXUtnFEMI'
],
'region' => 'us-east-1',
'directory' => 'my/directory'
],
'tar' => true,
'compress' => true,
'batch_size' => 1000
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.brightdata.com/datasets/views/{view_id}/delivery_settings"
payload := strings.NewReader("{\n \"filename\": {\n \"extension\": \"json\",\n \"template\": \"bd_{[datetime]}\",\n \"tz_offset\": \"+00:00\"\n },\n \"flatten_csv\": false,\n \"deliver\": {\n \"type\": \"s3\",\n \"bucket\": \"my-bucket\",\n \"credentials\": {\n \"aws-access-key\": \"AKIAIOSFODNN7\",\n \"aws-secret-key\": \"wJalrXUtnFEMI\"\n },\n \"region\": \"us-east-1\",\n \"directory\": \"my/directory\"\n },\n \"tar\": true,\n \"compress\": true,\n \"batch_size\": 1000\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.brightdata.com/datasets/views/{view_id}/delivery_settings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filename\": {\n \"extension\": \"json\",\n \"template\": \"bd_{[datetime]}\",\n \"tz_offset\": \"+00:00\"\n },\n \"flatten_csv\": false,\n \"deliver\": {\n \"type\": \"s3\",\n \"bucket\": \"my-bucket\",\n \"credentials\": {\n \"aws-access-key\": \"AKIAIOSFODNN7\",\n \"aws-secret-key\": \"wJalrXUtnFEMI\"\n },\n \"region\": \"us-east-1\",\n \"directory\": \"my/directory\"\n },\n \"tar\": true,\n \"compress\": true,\n \"batch_size\": 1000\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.brightdata.com/datasets/views/{view_id}/delivery_settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filename\": {\n \"extension\": \"json\",\n \"template\": \"bd_{[datetime]}\",\n \"tz_offset\": \"+00:00\"\n },\n \"flatten_csv\": false,\n \"deliver\": {\n \"type\": \"s3\",\n \"bucket\": \"my-bucket\",\n \"credentials\": {\n \"aws-access-key\": \"AKIAIOSFODNN7\",\n \"aws-secret-key\": \"wJalrXUtnFEMI\"\n },\n \"region\": \"us-east-1\",\n \"directory\": \"my/directory\"\n },\n \"tar\": true,\n \"compress\": true,\n \"batch_size\": 1000\n}"
response = http.request(request)
puts response.read_body{
"view_id": "v_id1"
}{
"error": "Invalid delivery settings"
}{
"error": "View not found"
}交付设置
更新视图交付设置
设置单个数据集视图的交付目标、凭证、文件名模板和批处理选项。返回更新后的视图ID。
PUT
/
datasets
/
views
/
{view_id}
/
delivery_settings
cURL
curl --request PUT \
--url https://api.brightdata.com/datasets/views/{view_id}/delivery_settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filename": {
"extension": "json",
"template": "bd_{[datetime]}",
"tz_offset": "+00:00"
},
"flatten_csv": false,
"deliver": {
"type": "s3",
"bucket": "my-bucket",
"credentials": {
"aws-access-key": "AKIAIOSFODNN7",
"aws-secret-key": "wJalrXUtnFEMI"
},
"region": "us-east-1",
"directory": "my/directory"
},
"tar": true,
"compress": true,
"batch_size": 1000
}
'import requests
url = "https://api.brightdata.com/datasets/views/{view_id}/delivery_settings"
payload = {
"filename": {
"extension": "json",
"template": "bd_{[datetime]}",
"tz_offset": "+00:00"
},
"flatten_csv": False,
"deliver": {
"type": "s3",
"bucket": "my-bucket",
"credentials": {
"aws-access-key": "AKIAIOSFODNN7",
"aws-secret-key": "wJalrXUtnFEMI"
},
"region": "us-east-1",
"directory": "my/directory"
},
"tar": True,
"compress": True,
"batch_size": 1000
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
filename: {extension: 'json', template: 'bd_{[datetime]}', tz_offset: '+00:00'},
flatten_csv: false,
deliver: {
type: 's3',
bucket: 'my-bucket',
credentials: {'aws-access-key': 'AKIAIOSFODNN7', 'aws-secret-key': 'wJalrXUtnFEMI'},
region: 'us-east-1',
directory: 'my/directory'
},
tar: true,
compress: true,
batch_size: 1000
})
};
fetch('https://api.brightdata.com/datasets/views/{view_id}/delivery_settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.brightdata.com/datasets/views/{view_id}/delivery_settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'filename' => [
'extension' => 'json',
'template' => 'bd_{[datetime]}',
'tz_offset' => '+00:00'
],
'flatten_csv' => false,
'deliver' => [
'type' => 's3',
'bucket' => 'my-bucket',
'credentials' => [
'aws-access-key' => 'AKIAIOSFODNN7',
'aws-secret-key' => 'wJalrXUtnFEMI'
],
'region' => 'us-east-1',
'directory' => 'my/directory'
],
'tar' => true,
'compress' => true,
'batch_size' => 1000
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.brightdata.com/datasets/views/{view_id}/delivery_settings"
payload := strings.NewReader("{\n \"filename\": {\n \"extension\": \"json\",\n \"template\": \"bd_{[datetime]}\",\n \"tz_offset\": \"+00:00\"\n },\n \"flatten_csv\": false,\n \"deliver\": {\n \"type\": \"s3\",\n \"bucket\": \"my-bucket\",\n \"credentials\": {\n \"aws-access-key\": \"AKIAIOSFODNN7\",\n \"aws-secret-key\": \"wJalrXUtnFEMI\"\n },\n \"region\": \"us-east-1\",\n \"directory\": \"my/directory\"\n },\n \"tar\": true,\n \"compress\": true,\n \"batch_size\": 1000\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.brightdata.com/datasets/views/{view_id}/delivery_settings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filename\": {\n \"extension\": \"json\",\n \"template\": \"bd_{[datetime]}\",\n \"tz_offset\": \"+00:00\"\n },\n \"flatten_csv\": false,\n \"deliver\": {\n \"type\": \"s3\",\n \"bucket\": \"my-bucket\",\n \"credentials\": {\n \"aws-access-key\": \"AKIAIOSFODNN7\",\n \"aws-secret-key\": \"wJalrXUtnFEMI\"\n },\n \"region\": \"us-east-1\",\n \"directory\": \"my/directory\"\n },\n \"tar\": true,\n \"compress\": true,\n \"batch_size\": 1000\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.brightdata.com/datasets/views/{view_id}/delivery_settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filename\": {\n \"extension\": \"json\",\n \"template\": \"bd_{[datetime]}\",\n \"tz_offset\": \"+00:00\"\n },\n \"flatten_csv\": false,\n \"deliver\": {\n \"type\": \"s3\",\n \"bucket\": \"my-bucket\",\n \"credentials\": {\n \"aws-access-key\": \"AKIAIOSFODNN7\",\n \"aws-secret-key\": \"wJalrXUtnFEMI\"\n },\n \"region\": \"us-east-1\",\n \"directory\": \"my/directory\"\n },\n \"tar\": true,\n \"compress\": true,\n \"batch_size\": 1000\n}"
response = http.request(request)
puts response.read_body{
"view_id": "v_id1"
}{
"error": "Invalid delivery settings"
}{
"error": "View not found"
}替换数据集视图的传递配置。
要一次将相同的配置应用于许多视图,请改用 Bulk update view delivery settings。
deliver.type 字段选择目标,deliver 内的其余字段必须与该目标的 Get destination type schema 返回的架构匹配。
如何更新视图
- 调用 Get delivery options 以确认支持该目标类型。
- 使用该目标类型调用 Get destination type schema 以获取所需字段。
- 发送本页面上记录的
PUT请求,并填充deliver对象。
设置
tar: true 会将所有输出文件捆绑到单个 TAR 存档中。设置 compress: true 会对每个交付的文件进行 gzip 压缩。两者可以结合使用。batch_size 是每个输出文件的最大记录数。使用它可以将大型交付拆分为较小的文件。每批最大大小为 5 GB。授权
在 Authorization 头中使用您的 Bright Data API Key 作为 Bearer token。
认证方法:
- 从 Bright Data 账户设置获取您的 API Key: https://brightdata.com/cp/setting/users
- 在请求的 Authorization 头中包含 API Key
- 格式:
Authorization: Bearer YOUR_API_KEY
示例:
Authorization: Bearer b5648e1096c6442f60a6c4bbbe73f8d2234d3d8324554bd6a7ec8f3f251f07df
了解如何获取 Bright Data API Key: https://docs.brightdata.com/cn/api-reference/authentication#如何生成新的-api-key?
路径参数
数据集视图的唯一标识。
示例:
"v_id1"
请求体
application/json
数据集视图的交付配置。用于视图交付设置的 GET、PUT 和批量 PUT 端点。
交付目标配置。type 字段用于选择目标(例如 s3、sftp、webhook),其余字段取决于 /datasets/delivery_settings/{destination_type}/schema 返回的目标 schema。
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
Show child attributes
Show child attributes
输出文件名和格式的配置。
Show child attributes
Show child attributes
为 true 时,CSV 输出中的嵌套字段会被展平。
为 true 时,交付的文件会打包为 TAR 归档。
为 true 时,交付的文件会使用 gzip 压缩。
每个批次文件的最大记录数,用于将大型交付拆分为较小的文件。最大批次大小为 5GB。
示例:
1000
响应
视图交付设置已更新
此页面对您有帮助吗?