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.

「キーワード別広告トラフィック」タスクの設定

​

指定した bid と match タイプで keywords のクリック、インプレッション、支出の予測をキューに登録し、タスク 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 USD。
  • 参照用の顧客乗数: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 です
      このパラメーターを使ってタスクを識別し、結果と照合できます
      指定した tag の値は、レスポンスの data オブジェクトに含まれます

レスポンス
  • 200
    型: object | null · Response36Afe1097B20_KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostResponseInfo
    • cost
      型: number | null 形式: double

      タスクの総コスト(USD)

    • status_code
      型: integer | null

      一般的なステータスコード レスポンスコードの完全な一覧はこちらです

    • status_message
      型: string | null

      一般的な情報メッセージ 一般的な情報メッセージの完全な一覧はこちらです

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

      タスクの配列

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

          タスクの総コスト(USD)

        • 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

ヘルプが必要ですか?

  • API・請求・アカウントのご質問はサポートへ。
  • Discord で Felo の開発者と交流できます。
  • 更新履歴 をご覧ください。
  • ボリューム価格や購買についてのご相談は営業窓口へ。
  • LLM での構築をお考えですか?llms.txt をご覧ください。