Felo API PlatformFelo API Platform
全部 DataForSEO 端点
v0.2.0-beta
OpenAPI 3.1.0

设置“关键词广告流量”任务

服务器:https://openapi.felo.ai
客户端库

DataForSEO

​

SEO, search-engine results, keyword research, backlinks and AI visibility data.

设置“关键词广告流量”任务

​

为 keywords 在给定 bid 和 match 类型下的点击、展示和花费预测加入队列,返回任务 id。search_partners 包含 Google 的合作伙伴网络。采用 DataForSEO 的信封结构:数据位于 tasks[0].result,结果状态位于 tasks[0].status_code——被拒绝的请求仍会返回 HTTP 200。这是此处唯一没有实时变体的 Google Ads 端点——预测始终走队列。使用 get_dataforseo_keywords_gads_ad_traffic_fetch 获取结果。

计费参考

  • 计量方式:按上报的响应成本计量。
  • 参考请求估算:0.09 美元。
  • 参考客户倍率:1.0。不得对已结算的客户金额再次应用。

仅供参考的元数据,不是账户报价、保证价格或消费上限。资源额度不同于 Felo 额度。最终扣费以 Felo 计费记录为准。

请求体
application/json
  • 类型: array (object | null)[]
    • bid
      类型: number

      最高自定义出价
      必填字段
      收集的数据将基于此值
      它表示你愿意为广告支付的价格;此处指定的值越高,返回指标中的数值也越高
      详见这篇帮助中心文章

    • date_from
      类型: string

      预测时间范围的开始日期
      指定 date_to 时为必填字段
      如果同时指定 date_from 和 date_to,则无需指定 date_interval
      最小值为明天的日期
      date_from 中指定的值不得晚于 date_to
      日期格式:"yyyy-mm-dd"
      示例:
      "2021-10-30"如果 Status 端点 在 actual_data 字段中返回 false,则 date_from 可设置为上上个月及更早;
      如果 Status 端点 在 actual_data 字段中返回 true,则 date_from 可设置为上个月及更早

    • date_interval
      类型: string | null

      预测日期区间
      可选字段
      如果指定 date_interval,则无需指定 date_from 和 date_to
      可能的值:next_week、next_month、next_quarter
      默认值:next_month

    • date_to
      类型: string

      预测时间范围的结束日期
      指定 date_from 时为必填字段
      如果同时指定 date_from 和 date_to,则无需指定 date_interval
      最小值为 date_from +1 天
      最大值为明年的同一日(当前日期的月和日)
      日期格式:"yyyy-mm-dd"
      示例:
      "2022-10-30"

    • keywords
      类型: array string[]

      关键词
      必填字段
      可指定的关键词数量上限:1000
      每个关键词的字符数上限:80
      每个关键词短语的词数上限:10
      指定的关键词将转换为小写格式
      注意 1:Google Ads 可能对某些关键词组不返回数据;
      注意 2:Google Ads 会为相似关键词组提供合并的搜索量数值
      要获取相似关键词的搜索量,建议将这些关键词放在单独的请求中提交;
      注意 3:Google Ads 不允许使用某些符号和字符(例如 UTF 符号、表情符号),因此设置任务时不能使用这些符号和字符;
      要了解可以使用哪些符号和字符,请参阅这篇文章

      有关 DataForSEO API 中 keyword 和 keywords 字段的规则与限制,请参阅这篇帮助中心文章

    • language_code
      类型: string | null

      搜索引擎语言代码
      可选字段
      可单独向 https://api.dataforseo.com/v3/keywords_data/google_ads/languages 发起请求,获取搜索引擎的可用语言及其 language_code 列表
      示例:
      en

    • language_name
      类型: string | null

      搜索引擎语言全名
      可选字段
      可单独向 https://api.dataforseo.com/v3/keywords_data/google_ads/languages 发起请求,获取搜索引擎的可用语言及其 language_name 列表
      示例:
      English

    • location_code
      类型: integer | null

      搜索引擎地点代码
      可选字段
      如果未指定地点,你将获得全球结果,即所有可用地点的结果;
      如果使用此字段,则无需指定 location_name 或 location_coordinate;
      可单独向 https://api.dataforseo.com/v3/keywords_data/google_ads/locations 发起请求,获取搜索引擎的可用地点及其 location_code 列表
      示例:
      2840

    • location_coordinate
      类型: string | null

      地点的 GPS 坐标
      可选字段
      如果未指定地点,你将获得全球结果,即所有可用地点的结果;
      如果使用此字段,则无需指定 location_name 或 location_code;
      location_coordinate 参数应采用 "latitude,longitude" 格式;
      数据将按指定坐标所属的国家/地区提供;
      示例:
      52.6178549,-155.352142

    • location_name
      类型: string | null

      搜索引擎地点全名
      可选字段
      如果未指定地点,你将获得全球结果,即所有可用地点的结果;
      如果使用此字段,则无需指定 location_code 或 location_coordinate
      可单独向 https://api.dataforseo.com/v3/keywords_data/google_ads/locations 发起请求,获取搜索引擎的可用地点及其 location_name 列表
      示例:
      London,England,United Kingdom

    • match
      类型: string

      关键词匹配类型
      必填字段
      可取以下值:exact、broad、phrase

    • pingback_url
      类型: string | null

      任务完成通知 URL
      可选字段
      任务完成后,我们会向你指定的 URL 发送 GET 请求进行通知
      可将 ‘$id’ 字符串用作 $id 变量,将 ‘$tag’ 用作经 URL 编码的 $tag 变量。发送请求前我们会设置必要的值。
      示例:
      http://your-server.com/pingscript?id=$id
      http://your-server.com/pingscript?id=$id&tag=$tag
      注意:pingback_url 中的特殊字符会进行 URL 编码;
      例如,# 字符会被编码为 %23

      详情请参阅我们的 帮助中心

    • postback_url
      类型: string | null

      用于发送任务结果的 URL
      可选字段
      任务完成后,我们会将其结果以 gzip 格式压缩,并向你指定的 postback_url 发送 POST 请求
      可将 ‘$id’ 字符串用作 $id 变量,将 ‘$tag’ 用作经 URL 编码的 $tag 变量。发送请求前我们会设置必要的值。
      示例:
      http://your-server.com/postbackscript?id=$id
      http://your-server.com/postbackscript?id=$id&tag=$tag
      注意:postback_url 中的特殊字符会进行 URL 编码;
      例如,# 字符会被编码为 %23

      详情请参阅我们的 帮助中心

    • sort_by
      类型: string | null

      结果排序参数
      可选字段
      使用这些参数可按 relevance、average_cpc、cost 或 clicks 对结果进行降序排序
      默认值:relevance

    • tag
      类型: string | null

      用户自定义任务标识符
      可选字段
      字符数上限为 255
      可使用此参数标识任务,并将其与结果对应
      可在响应的 data 对象中找到指定的 tag 值

响应
  • 200
    类型: object | null · Response36Afe1097B20_KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostResponseInfo
    • cost
      类型: number | null 格式: double

      任务总费用,美元

    • status_code
      类型: integer | null

      通用状态码 完整响应码列表见此处

    • status_message
      类型: string | null

      通用信息性消息 完整的一般信息性消息列表见此处

    • tasks
      类型: array (object | null)[] | null

      任务数组

      • 类型: object | null · Response36Afe1097B20_KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostTaskInfo
        • cost
          类型: number | null 格式: double

          任务总费用,美元

        • data
          类型: object | null

          包含你在 POST 请求中指定的相同参数

          • propertyName
            类型: object | null
        • id
          类型: string | null

          任务标识符 我们系统中 UUID 格式的唯一任务标识符

        • path
          类型: array (string | null)[] | null

          URL 路径

        • result
          类型: object | null

          结果数组
          在本例中,该值将为 null

        • result_count
          类型: integer | null 格式: int64

          result 数组中的元素数

        • status_code
          类型: integer | null

          任务的状态码 由 DataForSEO 生成,范围如下:10000-60000 完整响应码列表见此处

        • status_message
          类型: string | null

          任务的信息性消息 完整的一般信息性消息列表见此处

        • time
          类型: string | null

          执行时间,秒

    • tasks_count
      类型: integer | null 格式: int64

      tasks 数组中的任务数

    • tasks_error
      类型: integer | null 格式: int64

      tasks 数组中返回错误的任务数

    • time
      类型: string | null

      总执行时间,秒

    • version
      类型: string | null

      API 的当前版本

    application/json
  • 400

    无法处理该请求。请检查请求参数。

  • 401

    需要有效的 Felo API 密钥。

  • 402

    由于未满足计费要求,请求无法继续。

  • 403

    该账户无权执行此操作。

  • 429

    已达到请求或支出限额。

  • 502

    服务无法完成该请求。

  • 503

    API 或计费服务暂时不可用。

  • 504

    服务在处理请求时超时。

  • default

    错误响应;上游透传响应可能采用提供方格式

    application/json
Request Example for post/v1/beta/dataforseo/keywords_data/google_ads/ad_traffic_by_keywords/task_post
curl https://openapi.felo.ai/v1/beta/dataforseo/keywords_data/google_ads/ad_traffic_by_keywords/task_post \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "language_code": "en",
    "location_code": 2840,
    "bid": 999,
    "match": "exact",
    "keywords": [
      "seo marketing"
    ]
  }
]'
{
  "version": null,
  "status_code": null,
  "status_message": null,
  "time": null,
  "cost": null,
  "tasks_count": null,
  "tasks_error": null,
  "tasks": [
    {
      "id": null,
      "status_code": null,
      "status_message": null,
      "time": null,
      "cost": null,
      "result_count": null,
      "path": [
        null
      ],
      "data": null,
      "result": null
    }
  ]
}
Setting ‘Ad Traffic By Keywords’ Tasks

需要帮助?