Paramétrez Openflow Connector for Amazon Ads¶

Note

Le connecteur est soumis aux conditions d’utilisation du connecteur.

Cette rubrique décrit les étapes pour paramétrer Openflow Connector for Amazon Ads.

Conditions préalables¶

Assurez-vous d’avoir consulté À propos de Openflow Connector for Amazon Ads.
Assurez-vous d’avoir Configuration d’Openflow - BYOC ou Configuration d’Openflow - Déploiement Snowflake - Vue d’ensemble des tâches.

Obtenir les identifiants de connexion¶

En tant qu’administrateur Amazon Ads, effectuez les actions suivantes :

Assurez-vous d’avoir accès à un compte Amazon Ads.
Obtenez l’accès à l’API Amazon Ads et compléter le processus d’onboarding.
Obtenez l’ID client et le secret du client.
Créez une autorisation et récupérez un jeton d’actualisation.
Examinez les régions disponibles et obtenez une URL de base utilisée pour les requêtes en fonction de la région dans laquelle vous faites de la publicité.
Récupérez les IDs de profil pour la configuration du rapport.

Paramétrage du compte Snowflake¶

En tant qu’administrateur de compte Snowflake, effectuez les tâches suivantes :

Créez un nouveau rôle ou utilisez un rôle existant et accordez le Privilèges de base de données.
Créez un nouvel utilisateur du service Snowflake avec le type SERVICE.
Autorisez l’utilisateur du service Snowflake le rôle que vous avez créé dans les étapes précédentes.
Configurez avec l’authentification par paire de clés pour l’utilisateur de Snowflake SERVICE de l’étape 2.
Snowflake recommande vivement cette étape. Configurez un gestionnaire de secrets pris en charge par Openflow, par exemple AWS, Azure et Hashicorp, et stockez les clés publiques et privées dans le magasin de secrets.

Note

Si, pour une raison quelconque, vous ne souhaitez pas utiliser un gestionnaire de secrets, il vous incombe de protéger les fichiers de clés publiques et privées utilisés pour l’authentification par paires de clés conformément aux politiques de sécurité de votre organisation.
1. Une fois le gestionnaire de secrets configuré, déterminez comment vous vous y authentifierez. Sur AWS, il est recommandé d’utiliser le rôle de l’instance EC2 associée à Openflow, car de cette manière, aucun autre secret ne doit être conservé.
2. Dans Openflow, configurez un fournisseur de paramètres associé à ce gestionnaire de secrets, à partir du menu hamburger en haut à droite. Naviguez jusqu’à Controller Settings » Parameter Provider, puis récupérez vos valeurs de paramètres.
3. À ce stade, tous les identifiants peuvent être référencés avec les chemins de paramètres associés et aucune valeur sensible ne doit être conservée dans Openflow.
Si d’autres utilisateurs de Snowflake ont besoin d’accéder aux documents bruts ingérés et aux tables ingérées par le connecteur (par exemple, pour un traitement personnalisé dans Snowflake), accordez à ces utilisateurs le rôle créé à l’étape 1.
Désignez un entrepôt à utiliser par le connecteur. Commencez par la taille d’entrepôt la plus petite, puis faites des essais en fonction du nombre de tables répliquées et de la quantité de données transférées. Les tables de grande taille s’adaptent généralement mieux aux entrepôts multi-clusters, plutôt qu’aux entrepôts de grande taille.

Définir le connecteur¶

En tant qu’ingénieur des données, effectuez les tâches suivantes pour installer et configurer le connecteur :

Installer le connecteur¶

Naviguez jusqu’à la page d’aperçu d’Openflow. Dans la section Featured connectors, sélectionnez View more connectors.
Sur la page des connecteurs Openflow, trouvez le connecteur et sélectionnez Add to runtime.
Dans la boîte de dialogue Select runtime, sélectionnez votre environnement d’exécution dans la liste déroulante Available runtimes.
Sélectionnez Add.

Note

Avant d’installer le connecteur, assurez-vous que vous avez créé une base de données et un schéma dans Snowflake pour que le connecteur puisse stocker les données ingérées.
Authentifiez-vous au déploiement avec les identifiants de votre compte Snowflake et sélectionnez Allow lorsque vous êtes invité à autoriser l’application d’exécution à accéder à votre compte Snowflake. Le processus d’installation du connecteur prend quelques minutes.
Authentifiez-vous auprès de l’environnement d’exécution avec les identifiants de votre compte Snowflake.

Le canevas Openflow apparaît avec le groupe de processus du connecteur ajouté.

Configuration du connecteur¶

Cliquez avec le bouton droit de la souris sur le groupe de processus importé et sélectionnez Parameters.
Renseignez les valeurs des paramètres requis comme décrit dans Paramètres de débit.

Paramètres de débit¶

Cette section décrit les paramètres de flux que vous pouvez configurer en fonction des contextes de paramètres suivants :

Paramètres source Amazon Ads : utilisés pour établir une connexion avec les API Amazon Ads.
Paramètres de destination Amazon Ads : utilisés pour établir une connexion avec Snowflake.
Paramètres d’ingestion Amazon Ads : utilisés pour définir la configuration des données téléchargées à partir d’Amazon Ads.

Paramètres source Amazon Ads¶

Paramètre	Description
ID de client	ID Client du compte Amazon Advertising
Secret du client	Secret du client du compte Amazon Advertising
URL de base OAuth	L’URL du serveur d’autorisation qui délivre le jeton d’accès Valeurs possibles : https://api.amazon.com/auth/o2/token https://api.amazon.co.uk/auth/o2/token https://api.amazon.co.jp/auth/o2/token
Jeton d’actualisation	Jeton d’actualisation pour l’API Amazon Ads
Region	Environnement à partir duquel les données publicitaires sont téléchargées Valeurs possibles : NA EU FE

Paramètres de destination Amazon Ads¶

Paramètre	Description	Obligatoire
Base de données de destination	La base de données dans laquelle les données seront conservées. Elle doit déjà exister dans Snowflake. Le nom est sensible à la casse. Pour les identificateurs sans guillemets, indiquez le nom en majuscules.	Oui
Schéma de destination	Le schéma dans lequel les données seront conservées, qui doit déjà exister dans Snowflake. Le nom est sensible à la casse. Pour les identificateurs sans guillemets, indiquez le nom en majuscules. Voir l’exemple suivant : `CREATE SCHEMA SCHEMA_NAME` ou `CREATE SCHEMA schema_name` : utilisez `SCHEMA_NAME`. `CREATE SCHEMA "schema_name"` ou `CREATE SCHEMA "SCHEMA_NAME"` : utilisez `schema_name` ou `SCHEMA_NAME`, respectivement.	Oui
Identificateur de compte Snowflake	Lorsque vous utilisez : Stratégie d’authentification par jeton de session : doit être vide. KEY_PAIR : nom du compte Snowflake au format [nom-organisation]-[nom-compte] où les données seront conservées.	Oui
Stratégie d’authentification Snowflake	Lorsque vous utilisez : Déploiement Snowflake Openflow : Utilisez SNOWFLAKE_SESSION_TOKEN. Ce jeton est géré automatiquement par Snowflake. BYOC : utilisez KEY_PAIR comme valeur pour la stratégie d’authentification.	Oui
Clé privée de Snowflake	Lorsque vous utilisez : Stratégie d’authentification par jeton de session : doit être vide. KEY_PAIR : Doit correspondre à la clé privée RSA utilisée pour l’authentification. La clé RSA doit être formatée conformément aux normes PKCS8 et posséder des en-têtes et des pieds de page PEM standards. Notez que le fichier de la clé privée Snowflake ou que la clé privée Snowflake doit être défini.	Non
Fichier de clé privée de Snowflake	Lorsque vous utilisez : Stratégie d’authentification par jeton de session : Le fichier de la clé privée doit être vide. KEY_PAIR : Chargez le fichier qui contient la clé privée RSA utilisée pour l’authentification auprès de Snowflake, formatée conformément aux normes PKCS8 et possédant des en-têtes et des pieds de page PEM standards. La ligne d’en-tête commence par `-----BEGIN PRIVATE`. Pour charger le fichier de la clé privée, cochez la case Reference asset.	Non
Mot de passe de la clé privée de Snowflake	Lorsque vous utilisez : Stratégie d’authentification par jeton de session : doit être vide. KEY_PAIR : fournissez le mot de passe associé au fichier de la clé privée Snowflake.	Non
Rôle Snowflake	Lorsque vous utilisez : Stratégie d’authentification par jeton de session : Utilisez votre rôle d’exécution. Vous pouvez trouver votre rôle d’exécution dans l’UI d’Openflow, en naviguant jusqu’à View Details pour votre exécution. Stratégie d’authentification KEY_PAIR : Utilisez un rôle valide configuré pour votre utilisateur de service.	Oui
Nom d’utilisateur Snowflake	Lorsque vous utilisez : Stratégie d’authentification par jeton de session : doit être vide. KEY_PAIR : indiquez le nom d’utilisateur utilisé pour vous connecter à l’instance Snowflake.	Oui
Entrepôt Snowflake	Entrepôt Snowflake utilisé pour exécuter des requêtes.	Oui

Paramètres d’ingestion Amazon Ads¶

Paramètre	Description
Report Name	Nom du rapport à utiliser comme nom de table de destination. Le nom doit être unique dans le schéma de destination.
Report Ad Product	Type de produit publicitaire faisant l’objet d’un rapport Valeurs possibles : SPONSORED_PRODUCTS SPONSORED_BRANDS SPONSORED_DISPLAY SPONSORED_TELEVISION DEMAND_SIDE_PLATFORM
Report Columns	Ensemble des colonnes qui seront présentes dans le rapport final. La liste des colonnes disponibles dépend du type de rapport et se trouve dans la documentation de l’APIAmazon Ads. Par exemple, pour le type de rapport `spCampaigns`, la liste des colonnes disponibles se trouve dans la documentation sur les produits désignés.
Report Filters	Ensemble de filtres utilisés pour réduire les données renvoyées. La liste des filtres disponibles dépend du type de rapport et se trouve dans la documentation de l’APIAmazon Ads. Par exemple, pour le type de rapport `spCampaigns`, la liste des filtres disponibles se trouve dans la documentation sur les produits désignés. Les filtres doivent être au format `columnName=filterValue` et les valeurs doivent être séparées par une virgule (`,`). Par exemple, `campaignStatus=ENABLED,PAUSED`.
Report Group By	Détermine le niveau de granularité et la manière dont les données du rapport seront agrégées et présentées. La liste des groupes disponibles par colonnes dépend du type de rapport et se trouve dans la documentation de l’API Amazon Ads. Par exemple, pour le type de rapport `spCampaigns`, la liste du groupe disponible par colonnes se trouve dans la documentation sur les produits désignés.
Report Ingestion Strategy	Mode de récupération des données, instantané ou incrémental Valeurs possibles : `SNAPSHOT` `INCREMENTAL`
Report Ingestion Window	Spécifie le nombre de jours dont les données doivent être téléchargées lors de l’ingestion incrémentielle. Par exemple, avec une fenêtre d’ingestion de rapports de 30 jours, une charge incrémentielle commence l’ingestion 30 jours avant la dernière date d’ingestion réussie, à moins que cette date calculée ne soit antérieure à la date de début globale, auquel cas l’ingestion commence à partir de la date de début globale. Si la stratégie d’ingestion `SNAPSHOT` est utilisée, toutes les données disponibles de la date de début à la date actuelle sont téléchargées, de sorte qu’il n’est pas nécessaire d’utiliser une fenêtre d’ingestion de rapport.
Report Profile ID	L”ID de profil associé à un compte publicitaire dans un marketplace spécifique
Report Time Unit	Agrégation des dates Valeurs possibles : `DAILY`: chaque jour est représenté par une ligne `SUMMARY`: l’ensemble de la période ingérée est représentée par une ligne
Report Type	L’API Amazon Ads prend en charge un certain nombre de types de rapport. Par exemple : sbAds et spCampaigns. Copiez la valeur de `reportTypeId` dans la documentation et collez-la dans la valeur du paramètre.
Report Start Date	Date de début à partir de laquelle l’ingestion doit avoir lieu. Le format de la date est le suivant : YYYY-MM-DD.
Planification du rapport	Prévoyez du temps pour la création des rapports du processeur. Par exemple, `8 h` ou `1 d`. Le `h` représente les heures et le `d` les jours.

Note

La conservation des données dans l’API Amazon Ads correspond à un délai spécifique, allant de 60 à 365 jours selon le type de rapport, pendant lequel les données historiques des performances publicitaires sont stockées et accessibles pour être récupérées. Après cette période, il se peut que les données plus anciennes ne soient plus disponibles.

Exécutez le flux¶

Cliquez avec le bouton droit de la souris sur l’avion et sélectionnez Enable all Controller Services.
Cliquez avec le bouton droit sur le groupe de processus importé et sélectionnez Start.

Le connecteur démarre l’ingestion des données.