API de reporting
Aperçu
L'API de reporting Rokt permet aux annonceurs et aux partenaires de récupérer leurs données de performance à partir de la plateforme Rokt pour créer leurs propres rapports et tableaux de bord. Il s'agit d'une API basée sur HTTP qui peut être utilisée pour interroger et intégrer de manière programmatique les données Rokt dans des applications métier externes. L'API fonctionne avec n'importe quel langage prenant en charge les requêtes HTTP. Presque toutes les requêtes sont transmises à l'URL de l'hôte https://api.rokt.com.
Pour garantir la sécurité de vos données, l'API de reporting Rokt utilise des jetons d'accès pour authentifier les requêtes. Les jetons d'accès permettent à Rokt d'identifier les applications clientes et le type de données auxquelles elles accèdent, ainsi que d'empêcher les applications malveillantes d'accéder à des données qu'elles ne devraient pas pouvoir voir.
L'authentification à l'API s'effectue via OAuth 2.0. Pour effectuer un appel API réussi, vous devez utiliser un ID d'application et un secret d'application pour obtenir un jeton d'accès. Les requêtes API sans authentification échoueront. L'API de reporting Rokt vous permet uniquement de récupérer des données des comptes auxquels vos informations d'identification utilisateur ont accès.
Version
Pour les premiers utilisateurs de la version Alpha de l'API, assurez-vous d'utiliser "rokt-version":"alpha-20200701" dans l'en-tête de votre requête API afin de minimiser les éventuels changements de rupture. Si aucun en-tête rokt-version n'est utilisé, votre requête d'endpoint pointera toujours vers la version LATEST de l'API de reporting Rokt.
Authentification
L'API de reporting Rokt utilise l'approche OAuth 2.0 pour l'intégration du client. Consultez le flux de l'authentification OAuth 2.0 pour plus de détails. Vous devez utiliser votre ID d'application Rokt et votre secret d'application pour accéder à l'API de reporting Rokt.
Les étapes pour générer l'ID d'application et le secret d'application sont expliquées ci-dessous. Vous pouvez générer des informations d'identification pour l'API d'événement Rokt avec ces mêmes étapes.
Vous devez utiliser ces informations d'identification de l'application cliente dans les interactions REST avec l'API de reporting Rokt.
Génération de l'ID de l'application et du secret de l'application
Connectez-vous à One Platform sur my.rokt.com.
Accédez à Paramètres du profil sous l'icône de votre compte en bas à gauche.
Faites défiler jusqu'à la section Générer les informations d'identification de l'API personnelle.
Entrez le nom de votre application.
Cliquez sur Générer.
Vos informations d'identification pour l'API de reporting et l'API d'événement seront générées immédiatement et ressembleront à ceci :
AppId: "40svbin0d194subpohl079rhck"
AppSecret: "1dimhvr1v6skae9uhvtgs3chs2astnjf0469df6ul9hurubtoovn"Stockez l'ID de l'application et le secret de l'application dans un endroit sécurisé. Vous n'aurez plus accès au secret de l'application après cette session.
Vous pouvez utiliser ces informations d'identification immédiatement.
Vous devez garder ces informations confidentielles afin de protéger votre compte et ne jamais les envoyer par e-mail. Ne les partagez pas en dehors de votre organisation, même si une demande semble provenir de Rokt. Personne représentant légitimement Rokt ne vous demandera jamais votre secret d'application.
Obtenir un jeton d'accès
Un jeton d'accès est nécessaire pour appeler n'importe quel point de terminaison de l'API de reporting Rokt. Les jetons d'accès permettent à Rokt d'identifier les applications clientes, le type de données que chaque application cliente accède et d'empêcher les applications malveillantes d'accéder à des données auxquelles elles n'ont pas accès.
L'authentification à l'API est effectuée via OAuth 2.0. Pour effectuer un appel API réussi, vous devrez utiliser un ID d'application et un secret d'application pour obtenir un jeton d'accès qui devra être utilisé dans tous les appels API. L'ID d'application et le secret d'application peuvent être générés sur la page Paramètres du profil dans One Platform comme décrit ci-dessus.
Les demandes d'API sans authentification ou avec une authentification incorrecte échoueront. L'API renverra soit un code d'erreur 400, soit un code d'erreur 403. À partir de l'API de reporting Rokt, vous ne pouvez récupérer des données que des comptes auxquels vos informations d'identification utilisateur ont accès.
Les jetons d'accès sont générés en fonction de l'ID d'application et du secret d'application créés à l'étape précédente. Le jeton d'accès dure une heure. Pendant cette heure, le jeton d'accès peut être utilisé pour appeler tous les points de terminaison de l'API de reporting Rokt. Avant son expiration, vous devez régénérer le jeton d'accès en fonction des informations d'identification de l'application cliente.
Pour obtenir le jeton d'accès, un point de terminaison est exposé dans l'API de reporting Rokt:
POST https://api.rokt.com/auth/oauth2/token
Paramètres de requête dans l'en-tête
| Clé | Dans | Description | Requis? | Exemple |
|---|---|---|---|---|
Authorization | en-tête | app_id et app_secret doivent être transmis dans l'en-tête d'autorisation via l'autorisation HTTP de base et peuvent être générés dans Paramètres du profil sur One Platform ; le contenu de l'en-tête est Basic base64encode(app_id:app_secret) | Oui | Basic base64encocde(12345:abcde) |
Content-Type | en-tête | Le type de média de la requête doit toujours être application/x-www-form-urlencoded | Oui | application/x-www-form-urlencoded |
Paramètres de requête dans le corps
| Clé | Dans | Description | Obligatoire? | Exemple |
|---|---|---|---|---|
grant_type | corps | Doit être client_credentials | Oui | client_credentials |
Exemple de requête réussie
Requête d'exemple:
POST https://api.rokt.com/auth/oauth2/token&
Content-Type='application/x-www-form-urlencoded'&
Authorization=Basic xxx
grant_type=authorization_code
Réponse d'exemple:
{
"access_token": "eyJraWQiOiJPVUpHT1RjM09FWXROakkzUlMwME5UUkJMVGxCTkRrdFJqWXdOVVV3UkRNNE1FTTJDZz09IiwiYWxnIjoiSFMyNTYifQ.eyJzdWIiOiJkZW1vIiwidG9rZW5fdXNlIjoiYWNjZXNzIiwic2NvcGUiOiJyZXBvcnQtYXBpL3JlYWQtcmVwb3J0LWFwaSIsImF1dGhfdGltZSI6MTU4NTExMDA0MSwiaXNzIjoiaHR0cHM6Ly9jb2duaXRvLWlkcC51cy13ZXN0LTIuYW1hem9uYXdzLmNvbS91cy13ZXN0LTJfZG93Tlp1elRYIiwiZXhwIjoxNTg1MTEzNjQxLCJpYXQiOjE1ODUxMTAwNDEsInZlcnNpb24iOjIsImp0aSI6IkYwNzY5RDVDLTRDNTAtNDVDOC04OTcyLTI4MkUwODlDMkFFOSIsImNsaWVudF9pZCI6ImRlbW8ifQ.NOJIx7qLHFVXqKNZfJKsJlwitOvbHOLdknQ\_D33WjYe8O9ZE08t7LFgs7ANiwBicN5ejmdS7iND0cth5ViUWK5MKZxvLKI6dPG5RljegfpZJtGKqDT\_MFfpayvcOlkkZc5yRw9Bcgz\_fW2ha7q6BGRsUb-e9DZ0Pcb5zL\_HbRLbnvlhYCYi9rPmYOYG6BronvLwB8sg2kVubLQGn\_ASbK\_FW8bKPhqH4BL2\_JunGBzUKJPL9yNvOnFy7VKwlvH1OKUqKlCYbewOtUd1utcMNIb\_AbSGRtzJKslbE5VwQtL5bZ34kOCNH07gSolSGvqqw4dyxU4l0QSVXVmqgVYdKfA",
"expires_in": 3600,
"token_type": "Bearer"
}
Points de terminaison de l'API
Appeler un point de terminaison de l'API
En utilisant le jeton d'accès de l'étape précédente, vous pouvez maintenant appeler des points de terminaison sur l'API de reporting de Rokt. Notez que le jeton doit être envoyé en tant que jeton "Bearer" dans l'en-tête "Authorization".
Exemple de requête API :
GET https://api.rokt.com/reporting/performance-reports/partner/1/stats?dateStart=2020-02-05&dateEnd=2020-02-12&
Authorization=Bearer "eyJraWQiOiJNMDJyQmZzT3pNKzRVMjhHRjVuaDdIREphWlIwaytDMlwvNFl5dXYxZ2N0ST0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0MHN2YmluMGQxOTRzdWJwb2hsMDc5cmhjayIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoicmVwb3J0LWFwaVwvcmVhZC1yZXBvcnQtYXBpIiwiYXV0aF90aW1lIjoxNTg1MTEwMDQxLCJpc3MiOiJodHRwczpcL1wvY29nbml0by1pZHAudXMtd2VzdC0yLmFtYXpvbmF3cy5jb21cL3VzLXdlc3QtMl9kb3dOWnV6VFgiLCJleHAiOjE1ODUxMTM2NDEsImlhdCI6MTU4NTExMDA0MSwidmVyc2lvbiI6MiwianRpIjoiZDFlNjgyMDYtNWVlNy00NThjLTkwODYtZjAwYjhiMjEzYjJhIiwiY2xpZW50X2lkIjoiNDBzdmJpbjBkMTk0c3VicG9obDA3OXJoY2sifQ.NOJIx7qLHFVXqKNZfJKsJlwitOvbHOLdknQ_D33WjYe8O9ZE08t7LFgs7ANiwBicN5ejmdS7iND0cth5ViUWK5MKZxvLKI6dPG5RljegfpZJtGKqDT_MFfpayvcOlkkZc5yRw9Bcgz_fW2ha7q6BGRsUb-e9DZ0Pcb5zL_HbRLbnvlhYCYi9rPmYOYG6BronvLwB8sg2kVubLQGn_ASbK_FW8bKPhqH4BL2_JunGBzUKJPL9yNvOnFy7VKwlvH1OKUqKlCYbewOtUd1utcMNIb_AbSGRtzJKslbE5VwQtL5bZ34kOCNH07gSolSGvqqw4dyxU4l0QSVXVmqgVYdKfA"
Obtenir un aperçu des campagnes de compte
Renvoie les métriques de performance pour l'activité totale d'un compte sur une période donnée, un fuseau horaire et une devise. Le résultat est par défaut ventilé par campagne, mais peut également être ventilé par pays.
Description
Appelez cette API pour recevoir les métriques de performance au niveau du compte, telles que les impressions, les références, les conversions, ventilées par camapignid pour une période de temps, un fuseau horaire et une devise spécifiés.
Requête
Chemin
GET /reporting/accounts/{accountId}/campaigns/overview
Paramètres
| Nom | Type | Dans | Description | Requis | Exemple |
|---|---|---|---|---|---|
dateStart | String | query | Heure de début de la plage de date/heure demandée | vrai | dateStart=2020-03-01T00:00:00.000 |
dateEnd | String | query | Heure de fin de la plage de date/heure demandée | vrai | dateEnd=2020-03-31T23:59:59.000 |
currency | Enum: AUD CAD EUR GBP JPY NZD SGD USD KRW CNY | query | Code de devise dans lequel vous recevrez les mesures monétaires. | vrai | currency=USD |
timeZoneVariation | Enum: America/Chicago Pacific/Honolulu Australia/Sydney | query | Le fuseau horaire souhaité peut être transmis via ce paramètre. Il doit être au format Olson. | vrai | timeZoneVariation=Australia/Sydney |
groupBy | Enum: country campaign audience creative | query | Le critère sur lequel les résultats seront décomposés. Par défaut, il s'agit de 'campaign'. | vrai | campaign |
accountId | String | path | vrai |
Réponse
200 OK
{
"acquisitionsByConversionDate": 0,
"acquisitionsByReferralDate": 0,
"audiences": 0,
"campaignCountries": 0,
"campaignId": "string",
"campaignName": "string",
"campaigns": 0,
"creatives": 0,
"grossCost": 0,
"impressions": 0,
"netCost": 0,
"referrals": 0,
}
GET Détails des campagnes du compte
Renvoie les métriques de performance pour l'activité totale d'un compte annonceur Rokt Ads pour une période donnée, un fuseau horaire et une devise. Par défaut, le résultat est décomposé par campagne, mais vous pouvez également décomposer l'activité par pays.
Description
Appelez cet endpoint API pour recevoir des données au niveau du compte, décomposées par camapignid pour une période de temps spécifiée, un fuseau horaire et une devise. Les attributs qui peuvent être appelés via le paramètre "groupby" incluent :
- pays
Requête
Chemin
GET /reporting/accounts/{accountId}/campaigns/breakdown
Paramètres
| Nom | Type | Dans | Description | Requis | Exemple |
|---|---|---|---|---|---|
dateStart | String | query | Heure de début de la plage de dates/heures demandée | true | dateStart=2020-03-01T00:00:00.000 |
dateEnd | String | query | Heure de fin de la plage de dates/heures demandée | true | dateEnd=2020-03-31T23:59:59.000 |
currency | Enum: AUD CAD EUR GBP JPY NZD SGD USD KRW CNY | query | Code de devise dans lequel vous recevrez les métriques monétaires | true | currency=USD |
timeZoneVariation | Enum: America/Chicago Pacific/Honolulu Australia/Sydney | query | Fuseau horaire souhaité au format Olson | true | timeZoneVariation=Australia/Sydney |
accountId | String | path | Votre identifiant de compte Rokt. Trouvé dans One Platform ou fourni par votre gestionnaire de compte. | true |
Réponse
200 OK
{
"groupByValue": "string",
"grossCost": 0,
"netCost": 0,
"impressions": 0,
"referrals": 0,
"campaignCountries": 0,
"campaigns": 0,
"acquisitionsByConversionDate": 0,
"acquisitionsByReferralDate": 0,
"creatives": 0,
"Audiences": 0,
"campaignName": "string"
}
GET Résumé du compte
Renvoie les métriques de performance pour l'activité totale d'un compte pour une période donnée, un fuseau horaire et une devise. Ce point de terminaison API peut être utilisé à la fois pour les données de compte partenaire Rokt Ecommerce et les données de compte annonceur Rokt Ads.
Description
Appelez cet endpoint API pour recevoir les métriques de performance au niveau du compte pour une période de temps, un fuseau horaire et une devise spécifiés.
Request
Path
GET /reporting/accounts/{accountId}/summary
Parameters
| Nom | Type | In | Description | Requis | Exemple |
|---|---|---|---|---|---|
dateStart | String | query | Heure de début de la plage de date/heure demandée | true | dateStart=2020-03-01T00:00:00.000 |
dateEnd | String | query | Heure de fin de la plage de date/heure demandée | true | dateEnd=2020-03-31T23:59:59.000 |
currency | Enum: AUD CAD EUR GBP JPY NZD SGD USD KRW CNY | query | Code de devise dans lequel vous recevrez les métriques monétaires. | true | currency=USD |
timeZoneVariation | Enum: America/Chicago Pacific/Honolulu Australia/Sydney | query | Le fuseau horaire souhaité peut être passé par ce paramètre. Il doit être au format Olson. | true | timeZoneVariation=Australia/Sydney |
accountId | String | path | true |
Réponse
200 OK
{
"campaignsSummary": {
"grossCost": 0,
"netCost": 0,
"impressions": 0,
"referrals": 0,
"acquisitionsByConversionDate": 0,
"acquisitionsByReferralDate": 0,
"campaigns": 0,
"creatives": 0,
"audiences": 0,
"campaignCountries": 0
},
"transactionsSummary": {
"revenue": 0,
"transactions": 0,
"placementImpressions": 0,
"impressions": 0,
"referrals": 0,
"rpt": 0,
"rpm": 0,
"positivePlacementEngagements": 0,
"purchases": 0
}
}
Obtenir un aperçu des transactions du compte
Renvoie les métriques de performance pour un compte partenaire Rokt Ecommerce sur une période donnée, un fuseau horaire et une devise.
Description
Appelez ce point de terminaison de l'API pour recevoir des métriques de transaction au niveau du compte telles que les impressions de placement, les références et les revenus pour une période, un fuseau horaire et une devise spécifiés.
Requête
Chemin
GET /reporting/accounts/{accountId}/transactions/overview
Paramètres
| Nom | Type | Emplacement | Description | Requis | Exemple |
|---|---|---|---|---|---|
dateStart | String | query | Heure de début de la plage de dates/heure demandée | true | dateStart=2020-03-01T00:00:00.000 |
dateEnd | String | query | Heure de fin de la plage de dates/heure demandée | true | dateEnd=2020-03-31T23:59:59.000 |
currency | Enum: AUD CAD EUR GBP JPY NZD SGD USD KRW CNY | query | Code de devise dans lequel vous recevrez les métriques monétaires. | true | currency=USD |
timeZoneVariation | Enum: America/Chicago Pacific/Honolulu Australia/Sydney | query | Le fuseau horaire souhaité peut être transmis via ce paramètre. Il doit être au format Olson. | true | timeZoneVariation=Australia/Sydney |
accountId | String | path | true |
Réponse
200 OK
{
"revenue": 0,
"transactions": 0,
"placementImpressions": 0,
"impressions": 0,
"referrals": 0,
"rpt": 0,
"rpm": 0,
"positivePlacementEngagements": 0,
"purchases": 0
}
GET Détails des transactions du compte
Renvoie les métriques de performance pour un compte partenaire Rokt Ecommerce décomposées par attribut pour une période de temps donnée, un fuseau horaire et une devise.
Description
Appelez ce point de terminaison de l'API pour recevoir les métriques de transaction au niveau du compte décomposées par un attribut spécifié dans la chaîne de requête pour une période de temps, un fuseau horaire et une devise spécifiés. Les attributs qui peuvent être appelés via le paramètre "groupby" incluent :
- âge
- genre
- page
- type de page
- placement
- position
La ventilation par placement ne renvoie pas de résultats pour les métriques au niveau de la page, y compris les transactions, les achats ou le RPT.
Demande
Chemin
GET /reporting/accounts/{accountId}/transactions/breakdown
Paramètres
| Nom | Type | Emplacement | Description |
|---|---|---|---|
dateStart | String | query | Heure de début de la plage de dates/heures demandée |
dateEnd | String | query | Heure de fin de la plage de dates/heures demandée |
currency | Enum: AUD CAD EUR GBP JPY NZD SGD USD KRW CNY | query | Code de devise dans lequel vous recevrez les mesures monétaires. |
timeZoneVariation | Enum: America/Chicago Pacific/Honolulu Australia/Sydney | query | Le fuseau horaire souhaité peut être transmis via ce paramètre. Il doit être au format Olson. |
accountId | String | path |
Réponse
200 OK
{
"groupByValue": "string",
"revenue": 0,
"transactions": 0,
"placementImpressions": 0,
"impressions": 0,
"referrals": 0,
"purchases": 0,
"positivePlacementEngagements": 0,
"rpt": 0,
"rpm": 0
}
OBTENIR les métadonnées de l'audience
Description
Appelez ce point de terminaison de l'API pour recevoir les métadonnées de l'audience, telles que le nom de l'audience, la tranche d'âge, le sexe et l'appareil.
Requête
Chemin
GET /metadata/accounts/{accountId}/campaigns/{campaignId}/audiences/{audienceId}
Paramètres
| Nom | Type | Dans | Requis |
|---|---|---|---|
accountId | String | path | true |
campaignId | String | path | true |
audienceId | String | path | true |
Réponse
200 OK
{
"accountId": "string",
"campaignId": "string",
"audienceId": "string",
"name": "string",
"ageRange": {
"min": 0,
"max": 0
},
"device": {
"desktop": true,
"tablet": true,
"mobile": true
},
"gender": "string"
}
Obtenir un aperçu de la campagne
Renvoie les métriques de performance d'une campagne pour une période de temps, un fuseau horaire et une devise spécifiés.
Description
Appelez ce point de terminaison de l'API pour recevoir les métriques de performance au niveau de la campagne, telles que les impressions, les références et les conversions, pour une période de temps, un fuseau horaire et une devise spécifiés.
Requête
Chemin
GET /reporting/accounts/{accountId}/campaigns/{campaignId}/overview
Paramètres
| Nom | Type | Emplacement | Description | Requis | Exemple |
|---|---|---|---|---|---|
dateStart | String | query | Heure de début de la plage de dates/heure demandée | vrai | dateStart=2020-03-01T00:00:00.000 |
dateEnd | String | query | Heure de fin de la plage de dates/heure demandée | vrai | dateEnd=2020-03-31T23:59:59.000 |
currency | Enum: AUD CAD EUR GBP JPY NZD SGD USD KRW CNY | query | Code de devise dans lequel vous recevrez les métriques monétaires. | vrai | currency=USD |
timeZoneVariation | Enum: America/Chicago Pacific/Honolulu Australia/Sydney | query | Le fuseau horaire souhaité peut être transmis via ce paramètre. Il doit être au format Olson. | vrai | timeZoneVariation=Australia/Sydney |
accountId | String | path | vrai | ||
campaignId | String | path | vrai |
Réponse
200 OK
{
"coût brut": 0,
"coût net": 0,
"impressions": 0,
"références": 0,
"acquisitions par date de conversion": 0,
"acquisitions par date de référence": 0,
"campagnes": 0,
"créations": 0,
"audiences": 0,
"pays de campagne": 0
}
GET Détails de la campagne
Renvoie les métriques de performance d'une campagne décomposées par pays, campagne, audience ou création pour une période de temps, un fuseau horaire ou une devise spécifiés.
Description
Appelez ce point de terminaison de l'API pour recevoir des données au niveau de la campagne décomposées par un attribut spécifié dans la chaîne de requête pour une période de temps, un fuseau horaire ou une devise spécifiés. Les attributs qui peuvent être appelés via le paramètre "groupby" incluent :
- pays ;
- campagne ;
- audience ; ou
- création.
Demande
Chemin
GET /reporting/accounts/{accountId}/campaigns/{campaignId}/breakdown?groupby=creative
Paramètres
| Nom | Type | Emplacement | Description | Requis | Exemple |
|---|---|---|---|---|---|
dateStart | String | query | Heure de début de la plage de dates/heures demandée | vrai | dateStart=2020-03-01T00:00:00.000 |
dateEnd | String | query | Heure de fin de la plage de dates/heures demandée | vrai | dateEnd=2020-03-31T23:59:59.000 |
currency | Enum: AUD CAD EUR GBP JPY NZD SGD USD KRW CNY | query | Code de devise dans lequel vous recevrez les mesures monétaires. | vrai | currency=USD |
timeZoneVariation | Enum: America/Chicago Pacific/Honolulu Australia/Sydney | query | Fuseau horaire souhaité peut être passé par ce paramètre. Il doit être au format Olson. | vrai | timeZoneVariation=Australia/Sydney |
accountId | String | path | vrai | ||
campaignId | String | path | vrai |
Réponse
200 OK
{
"groupByValue": "string",
"grossCost": 0,
"netCost": 0,
"impressions": 0,
"referrals": 0,
"acquisitionsByConversionDate": 0,
"acquisitionsByReferralDate": 0,
"campaigns": 0,
"creatives": 0,
"audiences": 0,
"campaignCountries": 0,
"creativeName": "string"
}
GET Histogramme de campagne
Renvoie les métriques de performance d'une campagne pour une période donnée, un fuseau horaire et une devise, ventilées par période.
Description
Appelez ce point de terminaison de l'API pour recevoir un histogramme des métriques de performance d'une campagne, telles que les impressions, les références ou les conversions, pour une période de temps, un fuseau horaire et une devise spécifiés.
Demande
Chemin
GET /reporting/accounts/{accountId}/campaigns/{campaignId}/histogram
Paramètres
| Nom | Type | Emplacement | Description |
|---|---|---|---|
dateStart | String | query | Heure de début de la plage de date/heure demandée |
dateEnd | String | query | Heure de fin de la plage de date/heure demandée |
currency | Enum: AUD CAD EUR GBP JPY NZD SGD USD KRW CNY | query | Code de devise dans lequel vous recevrez les mesures monétaires. |
timeZoneVariation | Enum: America/Chicago Pacific/Honolulu Australia/Sydney | query | Le fuseau horaire souhaité peut être transmis via ce paramètre. Il doit être au format Olson. |
accountId | String | path | |
campaignId | String | path |
Réponse
200 OK
{
"intervalTimestamp": "string",
"grossCost": 0,
"netCost": 0,
"impressions": 0,
"referrals": 0,
"acquisitionsByConversionDate": 0,
"acquisitionsByReferralDate": 0,
"campaigns": 0,
"creatives": 0,
"audiences": 0,
"campaignCountries": 0
},
{
"intervalTimestamp": "string",
"grossCost": 0,
"netCost": 0,
"impressions": 0,
"referrals": 0,
"acquisitionsByConversionDate": 0,
"acquisitionsByReferralDate": 0,
"campaigns": 0,
"creatives": 0,
"audiences": 0,
"campaignCountries": 0
}
Obtenir les métadonnées de la campagne
Description
Appelez cet endpoint API pour recevoir les métadonnées d'une campagne spécifique.
Requête
Chemin
GET /metadata/accounts/{accountId}/campaigns/{campaignId}
Paramètres
| Nom | Type | Emplacement | Requis |
|---|---|---|---|
accountId | String | chemin | true |
campaignId | String | chemin | true |
Réponse
200 OK
{
"accountId": "string",
"campaignId": "string",
"campaignName": "string",
"campaignType": "string",
"campaignObjective": "string",
"countryCode": "string",
"status": "string"
}
Obtenir un aperçu créatif
Renvoie les métriques de performance d'un créatif pour une période donnée, un fuseau horaire et une devise donnés.
Description
Appelez cet endpoint API pour obtenir les métriques de performance au niveau du créatif, telles que les impressions, les références et les conversions pour une période, un fuseau horaire et une devise spécifiés.
Requête
Chemin
GET /reporting/accounts/{accountId}/campaigns/{campaignId}/creatives/{creativeId}/overview
Paramètres
| Nom | Type | Emplacement | Description | Requis | Exemple |
|---|---|---|---|---|---|
| dateStart | String | query | Heure de début de la plage de date/heure demandée | true | dateStart=2020-03-01T00:00:00.000 |
| dateEnd | String | query | Heure de fin de la plage de date/heure demandée | true | dateEnd=2020-03-31T23:59:59.000 |
| currency | Enum: AUD CAD EUR GBP JPY NZD SGD USD KRW CNY | query | Code de devise dans lequel vous recevrez les métriques monétaires. | true | currency=USD |
| timeZoneVariation | Enum: America/Chicago Pacific/Honolulu Australia/Sydney | query | Le fuseau horaire souhaité peut être transmis via ce paramètre. Il doit être au format Olson. | true | timeZoneVariation=Australia/Sydney |
| accountId | String | path | true | ||
| campaignId | String | path | true | ||
| creativeId | String | path | true |
Réponse
200 OK
{
"coût brut": 0,
"coût net": 0,
"impressions": 0,
"références": 0,
"références uniques": 0,
"acquisitions par date de conversion": 0,
"acquisitions par date de référence": 0,
"créations": 0,
"audiences": 0
}
GET Détails de la création
Renvoie les métriques de performance pour une création décomposée par un attribut pour une période de temps spécifiée, un fuseau horaire et une devise.
Description
Appelez ce point de terminaison de l'API pour obtenir des détails sur une création spécifique décomposée par un attribut spécifié dans la chaîne de requête pour une période de temps spécifiée, un fuseau horaire et une devise. Les attributs qui peuvent être appelés via le paramètre "groupby" sont :
- audience;
Demande
Chemin
GET /reporting/accounts/{accountId}/campaigns/{campaignId}/creatives/{creativeId}/breakdown
Paramètres
| Nom | Type | Emplacement | Description | Requis | Exemple |
|---|---|---|---|---|---|
dateStart | String | query | Heure de début de la plage de dates/heures demandée | true | dateStart=2020-03-01T00:00:00.000 |
dateEnd | String | query | Heure de fin de la plage de dates/heures demandée | true | dateEnd=2020-03-31T23:59:59.000 |
currency | Enum: AUD CAD EUR GBP JPY NZD SGD USD KRW CNY | query | Code de devise dans lequel vous recevrez les mesures monétaires. | true | currency=USD |
timeZoneVariation | Enum: America/Chicago Pacific/Honolulu Australia/Sydney | query | Fuseau horaire souhaité qui peut être transmis via ce paramètre. Il doit être au format Olson. | true | timeZoneVariation=Australia/Sydney |
accountId | String | path | true | ||
campaignId | String | path | true | ||
creativeId | String | path | true |
Réponse
200 OK
{
"groupByValue": "string",
"grossCost": 0,
"netCost": 0,
"impressions": 0,
"uniqueReferrals": 0,
"referrals": 0,
"acquisitionsByConversionDate": 0,
"acquisitionsByReferralDate": 0,
"creatives": 0,
"audiences": 0
}
Obtenir les métadonnées de la création
Description
Appelez ce point de terminaison de l'API pour recevoir les métadonnées de la création, y compris le nom de la création, le titre, le sous-titre, le texte, les réponses et le statut.
Requête
Chemin
GET /metadata/accounts/{accountId}/campaigns/{campaignId}/creatives/{creativeId}
Paramètres
| Nom | Type | Emplacement | Requis |
|---|---|---|---|
accountId | String | chemin | true |
campaignId | String | chemin | true |
creativeId | String | chemin | true |
Réponse
200 OK
{
"accountId": "string",
"campaignId": "string",
"creativeId": "string",
"name": "string",
"title": "string",
"subtitle": "string",
"text": "string",
"responses": [
"string"
],
"status": "string"
}