Ingérer des données depuis Google Search Console

info

Bêta

Cette fonctionnalité est en version bêta. Les administrateurs de Workspace peuvent contrôler l’accès à cette fonctionnalité depuis la page Aperçus . Consultez Gérer les aperçus Databricks.

Cette page explique comment créer un pipeline d'ingestion Google Search Console géré à l'aide de Lakeflow Connect.

Exigences

• Pour créer un pipeline d'ingestion, remplissez d'abord les conditions suivantes :

  • Votre workspace doit être activé pour Unity Catalog.

  • Le compute serverless doit être activé pour votre workspace. Voir les exigences du compute serverless.

  • Pour créer une nouvelle connexion, vous devez disposer des privilèges CREATE CONNECTION sur le métastore. Consultez Gérer les privilèges dans Unity Catalog.

    Si le connecteur prend en charge la création de pipeline via l'interface utilisateur, un administrateur peut créer la connexion et le pipeline en même temps en suivant les étapes indiquées sur cette page. Cependant, si les utilisateurs qui créent des pipelines utilisent la création de pipeline basée sur l'API ou ne sont pas des administrateurs, un administrateur doit d'abord créer la connexion dans Catalog Explorer. Voir Connecter à des sources d'ingestion gérées.

  • Pour utiliser une connexion existante, vous devez disposer des privilèges USE CONNECTION ou ALL PRIVILEGES sur l’objet de connexion.

  • Vous devez disposer des privilèges USE CATALOG sur le catalogue cible.

  • Vous devez disposer des privilèges USE SCHEMA et CREATE TABLE sur un schéma existant ou des privilèges CREATE SCHEMA sur le catalogue cible.

• Pour ingérer des données depuis Google Search Console, configurez d'abord l'authentification depuis Databricks et créez une connexion. Consultez Configure authentication to Google Search Console et Create a Google Search Console connection.

Options du connecteur

Définissez les options au niveau du pipeline dans source_configurations et les options au niveau de la table sur l’objet individuel. Voir les exemples pour l’utilisation.

Option	Périmètre	Obligatoire	S'applique à	Description
site_urls	Pipeline	Oui	Toutes les tables	Une ou plusieurs URL de propriété Google Search Console vérifiées à ingérer (par exemple, https://example.com/ ou sc-domain:example.com). Chaque URL doit être une propriété vérifiée dans Google Search Console.
start_date	Pipeline	Non	Toutes les tables incrémentielles (search_analytics_*, hourly_search_analytics_*)	Date la plus ancienne à partir de laquelle ingérer des données, au format yyyy-MM-dd. Default à 500 jours avant la première synchronisation. N’a aucun effet sur sites ou sitemaps.
data_state	Table	Non	Tables de performance de recherche quotidienne uniquement (search_analytics_*)	Récence des données pour les tables de performance de recherche quotidiennes. all (« default ») inclut des données finalisées et récentes. final inclut uniquement des données finalisées. Définissez-le uniquement sur les objets search_analytics_*. Les tables sites, sitemaps et hourly_search_analytics_* n'acceptent pas cette option.

Option	Périmètre	Obligatoire	S'applique à	Description
site_urls	Pipeline	Oui	Toutes les tables	Une ou plusieurs URL de propriété Google Search Console vérifiées à ingérer (par exemple, https://example.com/ ou sc-domain:example.com). Chaque URL doit être une propriété vérifiée dans Google Search Console.
start_date	Pipeline	Non	Toutes les tables incrémentielles (search_analytics_*, hourly_search_analytics_*)	Date la plus ancienne à partir de laquelle ingérer des données, au format yyyy-MM-dd. Default à 500 jours avant la première synchronisation. N’a aucun effet sur sites ou sitemaps.
data_state	Table	Non	Tables de performance de recherche quotidienne uniquement (search_analytics_*)	Récence des données pour les tables de performance de recherche quotidiennes. all (« default ») inclut des données finalisées et récentes. final inclut uniquement des données finalisées. Définissez-le uniquement sur les objets search_analytics_*. Les tables sites, sitemaps et hourly_search_analytics_* n'acceptent pas cette option.

Créer un pipeline d'ingestion

Pour obtenir la liste des tables sources prises en charge, consultez Tables sources prises en charge.

Declarative Automation Bundles

Utilisez les Declarative Automation Bundles pour gérer les pipelines Google Search Console en tant que code. Les bundles peuvent contenir des définitions YAML de Jobs et de tâches, sont gérés à l'aide de la CLI Databricks et peuvent être partagés et exécutés dans différents Workspace cibles (tels que le développement, la pré-production et la production). Pour plus d'informations, consultez Que sont les Declarative Automation Bundles ?.

1. Créez un bundle à l'aide de la CLI Databricks :

   Bash

   databricks bundle init

2. Ajoutez deux nouveaux fichiers de ressources au bundle :

   • Un fichier de définition de pipeline (par exemple, resources/google_search_console_pipeline.yml). Voir pipeline.ingestion_definition et Exemples.
   • Un fichier de définition de job qui contrôle la fréquence d’ingestion des données (par exemple, resources/google_search_console_job.yml).

3. Déployez le pipeline à l’aide de la CLI Databricks :

   Bash

   databricks bundle deploy

Databricks notebook

1. Importez le notebook suivant dans votre Databricks Workspace :

Ouvrir le notebook dans un nouvel ongletOuvrir dans Databricks

2. Laissez les cellules un et deux telles quelles. Ne pas modifier.

3. Modifiez la troisième cellule avec les détails de configuration de votre pipeline. Voir pipeline.ingestion_definition et Exemples.

4. Configurez éventuellement les paramètres avancés du pipeline. Consultez Modèles courants pour les pipelines d'ingestion gérés.

5. Cliquez sur Exécuter tout .

Exemples

Le connecteur Google Search Console met à disposition les tables sources suivantes sous le schéma source default :

Type de table	Tables
Tables de site	sites, sitemaps
Tables de rapport de performance de recherche quotidienne	search_analytics_all_fields, search_analytics_by_country, search_analytics_by_date, search_analytics_by_device, search_analytics_by_page, search_analytics_by_query, search_analytics_page_report, search_analytics_site_report_by_page, search_analytics_site_report_by_site
Tableaux de rapport de performances de recherche horaire	hourly_search_analytics_page_report, hourly_search_analytics_site_report_by_page, hourly_search_analytics_site_report_by_site

Type de table	Tables
Tables de site	sites, sitemaps
Tables de rapport de performance de recherche quotidienne	search_analytics_all_fields, search_analytics_by_country, search_analytics_by_date, search_analytics_by_device, search_analytics_by_page, search_analytics_by_query, search_analytics_page_report, search_analytics_site_report_by_page, search_analytics_site_report_by_site
Tableaux de rapport de performances de recherche horaire	hourly_search_analytics_page_report, hourly_search_analytics_site_report_by_page, hourly_search_analytics_site_report_by_site

Pour plus de détails sur le schéma, consultez Tables sources prises en charge.

Ingérer une table de rapport de performance de recherche

L’exemple suivant ingère search_analytics_all_fields, qui renvoie des données de performance quotidiennes agrégées sur les cinq dimensions (date, pays, appareil, page, query).

Declarative Automation Bundles

YAML

resources:
  pipelines:
    google_search_console_pipeline:
      name: google_search_console_pipeline
      catalog: 'main'
      target: 'google_search_console_data'
      ingestion_definition:
        connection_name: google_search_console_connection
        source_configurations:
          - api_source_connector_config:
              configs:
                site_urls: '["<site-url>"]'
                start_date: '<start-date>'
        objects:
          - table:
              source_schema: 'default'
              source_table: 'search_analytics_all_fields'
              destination_catalog: 'main'
              destination_schema: 'google_search_console_data'
              destination_table: 'search_analytics_all_fields'
              connector_options:
                api_source_connector_options:
                  options:
                    data_state: 'all'

Databricks notebook

Python

pipeline_spec = {
  "name": "<pipeline-name>",
  "catalog": "<catalog-name-for-event-logs>",
  "schema": "<schema-name-for-event-logs>",
  "ingestion_definition": {
    "connection_name": "<connection-name>",
    "source_configurations": [
      {
        "api_source_connector_config": {
          "configs": {
            "site_urls": "[\"<site-url>\"]",
            "start_date": "<start-date>"
          }
        }
      }
    ],
    "objects": [
      {
        "table": {
          "source_schema": "default",
          "source_table": "search_analytics_all_fields",
          "destination_catalog": "<destination-catalog>",
          "destination_schema": "<destination-schema>",
          "destination_table": "search_analytics_all_fields",
          "connector_options": {
            "api_source_connector_options": {
              "options": {
                "data_state": "all"
              }
            }
          }
        }
      }
    ]
  }
}
json_payload = json.dumps(pipeline_spec, indent=2)
create_pipeline(json_payload)

Ingérer une table de site

L’exemple suivant ingère sites, qui renvoie des métadonnées sur vos propriétés Google Search Console vérifiées. Les tables de site sont entièrement actualisées à chaque exécution du pipeline ; start_date n’a donc aucun effet sur elles et elles n’acceptent pas data_state.

Declarative Automation Bundles

YAML

resources:
  pipelines:
    google_search_console_pipeline:
      name: google_search_console_pipeline
      catalog: 'main'
      target: 'google_search_console_data'
      ingestion_definition:
        connection_name: google_search_console_connection
        source_configurations:
          - api_source_connector_config:
              configs:
                site_urls: '["<site-url>"]'
        objects:
          - table:
              source_schema: 'default'
              source_table: 'sites'
              destination_catalog: 'main'
              destination_schema: 'google_search_console_data'
              destination_table: 'sites'

Databricks notebook

Python

pipeline_spec = {
  "name": "<pipeline-name>",
  "catalog": "<catalog-name-for-event-logs>",
  "schema": "<schema-name-for-event-logs>",
  "ingestion_definition": {
    "connection_name": "<connection-name>",
    "source_configurations": [
      {
        "api_source_connector_config": {
          "configs": {
            "site_urls": "[\"<site-url>\"]"
          }
        }
      }
    ],
    "objects": [
      {
        "table": {
          "source_schema": "default",
          "source_table": "sites",
          "destination_catalog": "<destination-catalog>",
          "destination_schema": "<destination-schema>",
          "destination_table": "sites"
        }
      }
    ]
  }
}
json_payload = json.dumps(pipeline_spec, indent=2)
create_pipeline(json_payload)

Ingérer ensemble les tables de performance du site et de recherche

L'exemple suivant combine une table de site et une table de rapport de performances de recherche au sein d'un même pipeline.

Declarative Automation Bundles

YAML

resources:
  pipelines:
    google_search_console_pipeline:
      name: google_search_console_pipeline
      catalog: 'main'
      target: 'google_search_console_data'
      ingestion_definition:
        connection_name: google_search_console_connection
        source_configurations:
          - api_source_connector_config:
              configs:
                site_urls: '["<site-url>"]'
                start_date: '<start-date>'
        objects:
          # sites does not accept data_state, so it has no connector_options block.
          - table:
              source_schema: 'default'
              source_table: 'sites'
              destination_catalog: 'main'
              destination_schema: 'google_search_console_data'
              destination_table: 'sites'
          - table:
              source_schema: 'default'
              source_table: 'search_analytics_by_page'
              destination_catalog: 'main'
              destination_schema: 'google_search_console_data'
              destination_table: 'search_analytics_by_page'
              connector_options:
                api_source_connector_options:
                  options:
                    data_state: 'final'

Databricks notebook

Python

pipeline_spec = {
  "name": "<pipeline-name>",
  "catalog": "<catalog-name-for-event-logs>",
  "schema": "<schema-name-for-event-logs>",
  "ingestion_definition": {
    "connection_name": "<connection-name>",
    "source_configurations": [
      {
        "api_source_connector_config": {
          "configs": {
            "site_urls": "[\"<site-url>\"]",
            "start_date": "<start-date>"
          }
        }
      }
    ],
    "objects": [
      {
        "table": {
          "source_schema": "default",
          "source_table": "sites",
          "destination_catalog": "<destination-catalog>",
          "destination_schema": "<destination-schema>",
          "destination_table": "sites"
        }
      },
      {
        "table": {
          "source_schema": "default",
          "source_table": "search_analytics_by_page",
          "destination_catalog": "<destination-catalog>",
          "destination_schema": "<destination-schema>",
          "destination_table": "search_analytics_by_page",
          "connector_options": {
            "api_source_connector_options": {
              "options": {
                "data_state": "final"
              }
            }
          }
        }
      }
    ]
  }
}
json_payload = json.dumps(pipeline_spec, indent=2)
create_pipeline(json_payload)

Fichier de définition de job Declarative Automation Bundles

Voici un exemple de fichier de définition de job à utiliser avec les Declarative Automation Bundles. Le job s'exécute quotidiennement.

Declarative Automation Bundles

YAML

resources:
  jobs:
    google_search_console_job:
      name: google_search_console_job
      schedule:
        quartz_cron_expression: '0 0 0 * * ?'
        timezone_id: 'UTC'
      tasks:
        - task_key: google_search_console_ingestion
          pipeline_task:
            pipeline_id: ${resources.pipelines.google_search_console_pipeline.id}

Modèles courants

Pour des configurations de pipeline avancées, consultez Modèles courants pour les pipelines d'ingestion gérés.

Étapes suivantes

Start, planifiez et définissez des alertes sur votre pipeline. Voir Tâches courantes de maintenance des pipelines.

Ressources supplémentaires

• FAQ sur le connecteur Google Search Console
• Limitations du connecteur Google Search Console
• Référence du connecteur Google Search Console
• Dépanner le connecteur Google Search Console