Felo API PlatformFelo API Platform
Tous les endpoints DataForSEO
v0.2.0-beta
OpenAPI 3.1.0

Configurer les tâches ‘Ad Traffic By Keywords’

Serveur:https://openapi.felo.ai
Bibliothèques clientes

DataForSEO

​

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

Configurer les tâches ‘Ad Traffic By Keywords’

​

Met en file d'attente une prévision de clics, d'impressions et de dépenses pour des keywords à un bid et un type de match donnés, et renvoie un id de tâche. search_partners inclut le réseau de partenaires de Google. Enveloppé dans l'enveloppe DataForSEO : les données dans tasks[0].result, l'issue dans tasks[0].status_code — une requête rejetée renvoie tout de même HTTP 200. C'est le seul point de terminaison Google Ads ici sans variante en temps réel — la prévision passe toujours par la file. Récupérez avec get_dataforseo_keywords_gads_ad_traffic_fetch.

Référence tarifaire

  • Mesure : coût de réponse déclaré.
  • Estimation de référence par requête : USD 0.09.
  • Multiplicateur de référence client : 1.0. Ne pas l'appliquer à nouveau à un montant client déjà réglé.

Métadonnées de référence uniquement, et non un devis de compte, un prix garanti ou un plafond de dépenses. Les crédits de ressources ne sont pas des crédits Felo. Les débits définitifs suivent les enregistrements de facturation Felo.

Corps
application/json
  • Type: array (object | null)[]
    • bid
      Type: number

      l'enchère personnalisée maximale
      champ obligatoire
      les données collectées seront basées sur cette valeur
      elle correspond au prix que vous êtes prêt à payer pour une annonce ; plus la valeur indiquée ici est élevée, plus les valeurs des métriques renvoyées seront élevées
      en savoir plus dans cet article du centre d'aide

    • date_from
      Type: string

      date de début de la plage de prévision
      champ obligatoire si vous indiquez date_to
      si vous indiquez date_from et date_to, vous n'avez pas besoin de spécifier date_interval
      la valeur minimale est la date de demain
      la valeur indiquée dans date_from ne doit pas être postérieure à date_to
      format de date : "yyyy-mm-dd"
      exemple :
      "2021-10-30"si le point de terminaison Status renvoie false dans le champ actual_data, date_from peut être défini au mois d'avant-dernier et avant ;
      si le point de terminaison Status renvoie true dans le champ actual_data, date_from peut être défini au mois dernier et avant

    • date_interval
      Type: string | null

      intervalle de dates de la prévision
      champ facultatif
      si vous indiquez date_interval, vous n'avez pas besoin d'indiquer date_from et date_to
      valeurs possibles : next_week, next_month, next_quarter
      valeur par défaut : next_month

    • date_to
      Type: string

      date de fin de la plage de prévision
      champ obligatoire si vous indiquez date_from
      si vous indiquez date_from et date_to, vous n'avez pas besoin de spécifier date_interval
      la valeur minimale est date_from +1 jour
      la valeur maximale est le jour et le mois actuels de l'année suivante
      format de date : "yyyy-mm-dd"
      exemple :
      "2022-10-30"

    • keywords
      Type: array string[]

      mots-clés
      champ obligatoire
      Le nombre maximal de mots-clés que vous pouvez indiquer : 1000
      Le nombre maximal de caractères par mot-clé : 80
      Le nombre maximal de mots par expression de mot-clé : 10
      les mots-clés que vous indiquez seront convertis en minuscules
      Remarque n° 1 : Google Ads peut ne renvoyer aucune donnée pour certains groupes de mots-clés ;
      Remarque n° 2 : Google Ads fournit des valeurs de volume de recherche combinées pour des groupes de mots-clés similaires
      pour obtenir le volume de recherche de mots-clés similaires, nous recommandons d'envoyer ces mots-clés dans des requêtes distinctes ;
      Remarque n° 3 : Google Ads n'autorise pas l'utilisation de certains symboles et caractères (par exemple, symboles UTF, emojis), vous ne pouvez donc pas les utiliser lors de la définition d'une tâche ;
      pour en savoir plus sur les symboles et caractères utilisables, consultez cet article

      en savoir plus sur les règles et limites des champs keyword et keywords dans les API DataForSEO dans cet article du centre d'aide

    • language_code
      Type: string | null

      code de langue du moteur de recherche
      champ facultatif
      vous pouvez obtenir la liste des langues disponibles du moteur de recherche avec leur language_code en effectuant une requête distincte sur https://api.dataforseo.com/v3/keywords_data/google_ads/languages
      exemple :
      en

    • language_name
      Type: string | null

      nom complet de la langue du moteur de recherche
      champ facultatif
      vous pouvez obtenir la liste des langues disponibles du moteur de recherche avec leur language_name en effectuant une requête distincte sur https://api.dataforseo.com/v3/keywords_data/google_ads/languages
      exemple :
      English

    • location_code
      Type: integer | null

      code d'emplacement du moteur de recherche
      champ facultatif
      si vous n'indiquez pas l'emplacement, vous recevrez des résultats mondiaux, c'est-à-dire pour tous les emplacements disponibles ;
      si vous utilisez ce champ, vous n'avez pas besoin de spécifier location_name ni location_coordinate ;
      vous pouvez obtenir la liste des emplacements disponibles des moteurs de recherche avec leur location_code en effectuant une requête distincte sur https://api.dataforseo.com/v3/keywords_data/google_ads/locations
      exemple :
      2840

    • location_coordinate
      Type: string | null

      coordonnées GPS d'un emplacement
      champ facultatif
      si vous n'indiquez pas l'emplacement, vous recevrez des résultats mondiaux, c'est-à-dire pour tous les emplacements disponibles ;
      si vous utilisez ce champ, vous n'avez pas besoin de spécifier location_name ni location_code ;
      le paramètre location_coordinate doit être indiqué au format "latitude,longitude" ;
      les données seront fournies pour le pays auquel appartiennent les coordonnées indiquées ;
      exemple :
      52.6178549,-155.352142

    • location_name
      Type: string | null

      nom complet de l'emplacement du moteur de recherche
      champ facultatif
      si vous n'indiquez pas l'emplacement, vous recevrez des résultats mondiaux, c'est-à-dire pour tous les emplacements disponibles ;
      si vous utilisez ce champ, vous n'avez pas besoin de spécifier location_code ni location_coordinate
      vous pouvez obtenir la liste des emplacements disponibles du moteur de recherche avec leur location_name en effectuant une requête distincte sur https://api.dataforseo.com/v3/keywords_data/google_ads/locations
      exemple :
      London,England,United Kingdom

    • match
      Type: string

      type de correspondance des mots-clés
      champ obligatoire
      peut prendre les valeurs suivantes : exact, broad, phrase

    • pingback_url
      Type: string | null

      URL de notification d'une tâche terminée
      champ facultatif
      lorsqu'une tâche est terminée, nous vous en informons par une requête GET envoyée à l'URL que vous avez spécifiée
      vous pouvez utiliser la chaîne ‘$id’ comme variable $id et ‘$tag’ comme variable $tag encodée pour URL. Nous définirons les valeurs nécessaires avant d'envoyer la requête.
      exemple :
      http://your-server.com/pingscript?id=$id
      http://your-server.com/pingscript?id=$id&tag=$tag
      Remarque : les caractères spéciaux de pingback_url seront encodés pour URL ;
      notamment, le caractère # sera encodé en %23

      en savoir plus dans notre centre d'aide

    • postback_url
      Type: string | null

      URL d'envoi des résultats de la tâche
      champ facultatif
      une fois la tâche terminée, nous enverrons une requête POST avec ses résultats compressés au format gzip à l'adresse postback_url que vous avez spécifiée
      vous pouvez utiliser la chaîne ‘$id’ comme variable $id et ‘$tag’ comme variable $tag encodée pour URL. Nous définirons les valeurs nécessaires avant d'envoyer la requête.
      exemple :
      http://your-server.com/postbackscript?id=$id
      http://your-server.com/postbackscript?id=$id&tag=$tag
      Remarque : les caractères spéciaux de postback_url seront encodés pour URL ;
      notamment, le caractère # sera encodé en %23

      en savoir plus dans notre centre d'aide

    • sort_by
      Type: string | null

      paramètres de tri des résultats
      champ facultatif
      Utilisez ces paramètres pour trier les résultats par relevance, average_cpc, cost ou clicks par ordre décroissant
      valeur par défaut : relevance

    • tag
      Type: string | null

      identifiant de tâche défini par l'utilisateur
      champ facultatif
      la limite est de 255 caractères
      vous pouvez utiliser ce paramètre pour identifier la tâche et l'associer au résultat
      vous trouverez la valeur tag spécifiée dans l'objet data de la réponse

Réponses
  • 200
    Type: object | null · Response36Afe1097B20_KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostResponseInfo
    • cost
      Type: number | null Format: double

      coût total des tâches, USD

    • status_code
      Type: integer | null

      code d'état général vous pouvez trouver la liste complète des codes de réponse ici

    • status_message
      Type: string | null

      message d'information général vous pouvez trouver la liste complète des messages d'information généraux ici

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

      tableau de tâches

      • Type: object | null · Response36Afe1097B20_KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostTaskInfo
        • cost
          Type: number | null Format: double

          coût total des tâches, USD

        • data
          Type: object | null

          contient les mêmes paramètres que ceux spécifiés dans la requête POST

          • propertyName
            Type: object | null
        • id
          Type: string | null

          identifiant de la tâche identifiant unique de la tâche dans notre système au format UUID

        • path
          Type: array (string | null)[] | null

          chemin de l'URL

        • result
          Type: object | null

          tableau de résultats
          dans ce cas, la valeur sera null

        • result_count
          Type: integer | null Format: int64

          nombre d'éléments dans le tableau de résultats

        • status_code
          Type: integer | null

          code d'état de la tâche généré par DataForSEO ; peut être compris dans la plage suivante : 10000-60000 vous pouvez trouver la liste complète des codes de réponse ici

        • status_message
          Type: string | null

          message d'information de la tâche vous pouvez trouver la liste complète des messages d'information généraux ici

        • time
          Type: string | null

          temps d'exécution, en secondes

    • tasks_count
      Type: integer | null Format: int64

      le nombre de tâches dans le tableau de tâches

    • tasks_error
      Type: integer | null Format: int64

      le nombre de tâches dans le tableau de tâches renvoyées avec une erreur

    • time
      Type: string | null

      temps d'exécution total, en secondes

    • version
      Type: string | null

      la version actuelle de l'API

    application/json
  • 400

    La requête n'a pas pu être traitée. Vérifiez les paramètres de la requête.

  • 401

    Une clé API Felo valide est requise.

  • 402

    La requête ne peut pas aboutir car une condition de facturation n'est pas remplie.

  • 403

    Le compte n'est pas autorisé à effectuer cette opération.

  • 429

    Une limite de requêtes ou de dépenses a été atteinte.

  • 502

    Le service n'a pas pu terminer la requête.

  • 503

    L'API ou le service de facturation est temporairement indisponible.

  • 504

    Le service a expiré lors du traitement de la requête.

  • default

    Réponse d'erreur ; les réponses transmises depuis l'upstream peuvent utiliser les formats du fournisseur

    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