跳转到正文
中文
获取 API 密钥
浏览文档

开始使用

Go SDK 快速入门

安装 Go SDK 并执行类型化 Google 搜索请求,再用同一客户端尝试 YouTube 数据。

  1. 安装 SDK

    需要 Go 1.25+。选择创建新项目,或在已有 go.mod 所在目录安装。

    安装
    mkdir flashdata-demo
    cd flashdata-demo
    go mod init example.com/flashdata-demo
    go get github.com/flashdatadev/[email protected]
  2. 认证

    注册、验证邮箱,并创建具有 Google 搜索权限的 API Key,或复用已有授权密钥。

    在下方设置 FLASHDATA_API_KEY,或保留环境已提供的值。示例显式读取该变量,不加载 .env 文件。

    隐藏密钥输入 · Bash
    # Bash: paste the key into a hidden prompt, not into this command.
    read -r -s -p "FlashData API key: " FLASHDATA_API_KEY
    printf '\n'
    export FLASHDATA_API_KEY
  3. 执行搜索

    将代码保存为 go.mod 旁的 main.go,在同一终端运行。程序发送一次搜索,最多请求五条结果,并输出 JSON 响应。

    main.go
    package main
    
    import (
        "context"
        "encoding/json"
        "log"
        "os"
        "time"
    
        flashdata "github.com/flashdatadev/flashdata-go"
    )
    
    func main() {
        key := os.Getenv("FLASHDATA_API_KEY")
        if key == "" {
            log.Fatal("Set FLASHDATA_API_KEY through your server's secret manager.")
        }
        client, err := flashdata.New(flashdata.Options{APIKey: key})
        if err != nil {
            log.Fatal(err)
        }
        ctx, cancel := context.WithTimeout(context.Background(), 2*time.Minute)
        defer cancel()
        result, err := client.Google.Search(ctx, flashdata.GoogleSearchInput{
            Query: "battery recycling research",
            Params: &flashdata.GoogleSearchParams{Num: flashdata.Ptr(int64(5))},
        })
        if err != nil {
            // Do not automatically resubmit an uncertain paid request.
            log.Fatal(err)
        }
        if err := json.NewEncoder(os.Stdout).Encode(result); err != nil {
            log.Fatal(err)
        }
        if result.Status != "done" {
            log.Fatalf("Search did not complete: %s", result.Status)
        }
    }
    运行
    go run .
  4. 检查结果

    检查输出 JSON 中的 status 是否为 done。将返回的标题、URL 和摘要用于应用或智能体。organic 列表为空也属于有效结果。

    输出示例
    {
      "status": "done",
      "results": [
        {
          "organic": [
            {
              "title": "Battery recycling research",
              "link": "https://example.org/recycling",
              "snippet": "An example search excerpt."
            }
          ]
        }
      ],
      "usage": {
        "credits": 0.02
      }
    }
    status
    done 表示搜索已完成。
    results[].organic[]
    搜索结果,包含 title、link 和 snippet 字段。
    usage.credits
    此请求消耗的 Credits。返回五条结果的一次搜索是一个请求。

尝试其他数据源

在 main.go 中,仅将 result, err := client.Google.Search(...) 调用替换为下方调用。保留客户端、context、错误检查及 JSON 输出,再运行 go run .。每次运行提交一个新请求。

需要 google_news 权限,返回查询对应的新闻结果。

替换 main.go 中的搜索调用
result, err := client.Google.News(ctx, flashdata.GoogleNewsInput{
    Query: "battery recycling",
})

Go SDK 支持的功能

Google
Search、News、Images、Shopping、Videos 和 Places。使用 Google.Pages 获取分页结果。
YouTube
Search、Metadata、Transcript、Captions、Channel 和 Suggestions 提供结构化视频数据。
YouTube.Download
提交音频或视频交付任务,将文件写入你的云存储。需要 youtube_download 权限及存储配置;请使用下方完整示例。
Jobs / Bulk
通过 Async 辅助方法提交并保存任务 ID,再调用 Jobs.Wait 和 Jobs.Result。Bulk 用于较大数据集及可恢复的任务。
Account
在无人值守任务前读取身份、余额、价格、限额和用量。复用同一客户端及已授权密钥。
WithFormat
通过显式格式选项请求 JSON、纯文本或 Markdown。Markdown 将检索数据格式化供智能体使用;模型调用及摘要由你的应用负责。

Go 类型

GoogleSearchInput 描述查询。可选参数使用指针,例如 flashdata.Ptr(int64(5))。Results 包含来源 JSON;需要类型化字段时可使用 DecodeResults[GoogleSearchPayload]。

下一步

步骤失败时

缺少包或运行环境
检查 go version,在 go.mod 所在目录运行 go get。
401 / FLASHDATA_API_KEY
在运行示例的终端设置有效密钥。
403
为此 API Key 授予 Google 搜索权限。
402
在 Billing 检查可用 Credits,或认领已耗尽的智能体试用。
429
按 Retry-After 等待,再降低请求频率。
超时或服务器错误
重发前检查 History,首次请求可能已执行。