Ingérer des données depuis Google Search Console

info

Bêta

Cette fonctionnalité est en version bêta. Pour l’utiliser, un administrateur du workspace doit activer Lakeflow Connect for Google Search Console depuis la page Previews . 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_`, `custom_report`)	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 performances de recherche quotidiennes (`search_analytics_*`) et `custom_report`	Fraîcheur des données pour les tables quotidiennes de performances de recherche et `custom_report`. `all` (default) inclut les données finalisées et fraîches. `final` inclut uniquement les données finalisées. Définissez-la uniquement sur les objets `search_analytics_` et `custom_report`. Les tables `sites`, `sitemaps` et `hourly_search_analytics_` n’acceptent pas cette option.
`dimensions`	Table	Oui	`custom_report` uniquement	Les dimensions par lesquelles regrouper le rapport, par exemple `'["country", "device"]'`. Les valeurs autorisées sont `date`, `country`, `device`, `page` et `query`. Le connecteur inclut `date` même si vous ne le listez pas.
`search_types`	Table	Oui	`custom_report` uniquement	Les types de recherche pour lesquels exécuter le rapport, par exemple `'["web", "image"]'`. Les valeurs autorisées sont `web`, `image`, `video`, `news`, `discover` et `googleNews`.
`aggregation_type`	Table	Non	`custom_report` uniquement	Comment Google Search Console agrège les métriques. L’une des valeurs `auto` (default), `byPage` ou `byProperty`. `byProperty` ne prend pas en charge la dimension `page` ou les types de recherche `discover` et `googleNews`.

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_`, `custom_report`)	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 performances de recherche quotidiennes (`search_analytics_*`) et `custom_report`	Fraîcheur des données pour les tables quotidiennes de performances de recherche et `custom_report`. `all` (default) inclut les données finalisées et fraîches. `final` inclut uniquement les données finalisées. Définissez-la uniquement sur les objets `search_analytics_` et `custom_report`. Les tables `sites`, `sitemaps` et `hourly_search_analytics_` n’acceptent pas cette option.
`dimensions`	Table	Oui	`custom_report` uniquement	Les dimensions par lesquelles regrouper le rapport, par exemple `'["country", "device"]'`. Les valeurs autorisées sont `date`, `country`, `device`, `page` et `query`. Le connecteur inclut `date` même si vous ne le listez pas.
`search_types`	Table	Oui	`custom_report` uniquement	Les types de recherche pour lesquels exécuter le rapport, par exemple `'["web", "image"]'`. Les valeurs autorisées sont `web`, `image`, `video`, `news`, `discover` et `googleNews`.
`aggregation_type`	Table	Non	`custom_report` uniquement	Comment Google Search Console agrège les métriques. L’une des valeurs `auto` (default), `byPage` ou `byProperty`. `byProperty` ne prend pas en charge la dimension `page` ou les types de recherche `discover` et `googleNews`.

Créer un pipeline d'ingestion

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

Databricks UI
Declarative Automation Bundles
Databricks notebook

Dans la barre latérale du Databricks Workspace, cliquez sur Ingestion de données .
Sur la page Ajouter des données , sous Connecteurs Databricks , cliquez sur Google Search Console .
Sur la page Connexion de l'assistant d'ingestion, sélectionnez la connexion qui stocke vos identifiants Google Search Console. Si vous disposez du privilège CREATE CONNECTION sur le metastore, cliquez sur Créer une connexion pour créer une connexion avec les identifiants de Configurer l'authentification à Google Search Console.
Cliquez sur Suivant .
Sur la page Configuration de l’ingestion , saisissez un nom pour le pipeline.
Sélectionnez un catalogue et un schéma dans lesquels écrire les logs d’événements. Si vous disposez des privilèges USE CATALOG et CREATE SCHEMA sur le catalogue, cliquez sur Créer un schéma dans le menu déroulant pour créer un schéma.
Pour URLs du site , saisissez une ou plusieurs URLs de propriété vérifiées de Google Search Console à ingérer. Optionnellement, définissez une Date de start . Voir Options du connecteur.
Cliquez sur Créer un pipeline et continuer .
Sur la page Source , sélectionnez les tables à ingérer. Optionnellement, définissez l' État des données pour les tables de performance de recherche quotidienne (search_analytics_*).
Cliquez sur Enregistrer et continuer .
Sur la page Destination , sélectionnez un catalogue et un schéma dans lesquels charger les données. Si vous avez les privilèges USE CATALOG et CREATE SCHEMA sur le catalogue, cliquez sur Créer un schéma dans le menu déroulant pour créer un schéma.
Cliquez sur Enregistrer et continuer .
(Facultatif) Sur la page Programmes et notifications , cliquez sur Créer un programme . Définissez la fréquence de refresh des tables de destination.
(Facultatif) Cliquez sur Ajouter une notification pour définir les notifications par e-mail en cas de succès ou d’échec de l’opération du pipeline, puis cliquez sur Enregistrer et exécuter le pipeline .

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 ?.

Créez un bundle à l'aide de la CLI Databricks :
Bash
```
databricks bundle init
```
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).
Déployez le pipeline à l’aide de la CLI Databricks :
Bash
```
databricks bundle deploy
```

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`
Tableau de rapport personnalisé	`custom_report`

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`
Tableau de rapport personnalisé	`custom_report`

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
Databricks notebook

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'

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
Databricks notebook

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'

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 un rapport personnalisé

L’exemple suivant ingère un rapport personnalisé qui agrège les performances quotidiennes de recherche sur le Web et sur les images par query et par pays. Pour ingérer plus d’un rapport personnalisé dans le même pipeline, ajoutez un objet custom_report pour chaque rapport, chacun avec un destination_table différent. Pour les options, voir Rapports personnalisés.

Declarative Automation Bundles
Databricks notebook

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: 'custom_report'
              destination_catalog: 'main'
              destination_schema: 'google_search_console_data'
              destination_table: 'search_performance_by_query_and_country'
              connector_options:
                api_source_connector_options:
                  options:
                    dimensions: '["query", "country"]'
                    search_types: '["web", "image"]'
                    aggregation_type: 'auto'
                    data_state: 'final'

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": "custom_report",
          "destination_catalog": "<destination-catalog>",
          "destination_schema": "<destination-schema>",
          "destination_table": "search_performance_by_query_and_country",
          "connector_options": {
            "api_source_connector_options": {
              "options": {
                "dimensions": "[\"query\", \"country\"]",
                "search_types": "[\"web\", \"image\"]",
                "aggregation_type": "auto",
                "data_state": "final"
              }
            }
          }
        }
      }
    ]
  }
}
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
Databricks notebook

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'

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.

Exigences​

Options du connecteur​

Créer un pipeline d'ingestion​

Exemples​

Ingérer une table de rapport de performance de recherche​

Ingérer une table de site​

Ingérer un rapport personnalisé​

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

Fichier de définition de job Declarative Automation Bundles​

Modèles courants​

Étapes suivantes​

Ressources supplémentaires​