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 depuis la plateforme Rokt pour créer leurs propres rapports et tableaux de bord. C'est 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 commerciales externes. L'API fonctionne avec n'importe quel langage qui supporte les requêtes HTTP. Presque toutes les requêtes sont envoyées à l'URL d'hôte https://api.rokt.com.
Pour garder vos données en sécurité, 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 client et le type de données auxquelles il est accédé, tout en empêchant les applications malveillantes d'accéder à des données qu'elles ne devraient pas voir.
L'authentification à l'API se fait 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 ne vous permet de récupérer des données que des comptes auxquels vos identifiants utilisateur ont accès.
Version
Pour les premiers utilisateurs utilisant la version Alpha Release de l'API, assurez-vous que "rokt-version":"alpha-20200701" est utilisé dans l'en-tête de votre requête API pour minimiser les changements de rupture possibles. Si aucun en-tête rokt-version n'est utilisé, votre requête d'endpoint pointera toujours vers la version LATEST de l'API Rokt Reporting.
Authentification
L'API Rokt Reporting utilise l'approche OAuth 2.0 pour l'intégration des clients. Consultez le Flux de Crédentiels OAuth 2.0 pour plus de détails. Vous devez utiliser votre Rokt App ID et App Secret pour accéder à l'API Rokt Reporting.
Les étapes pour générer l'App ID et l'App Secret sont expliquées ci-dessous. Vous pouvez générer des identifiants pour l'API Événement Rokt avec ces mêmes étapes.
Vous devez utiliser ces identifiants d'application client dans les interactions REST avec l'API Rokt Reporting.
Générer l'App ID et l'App Secret
Connectez-vous à One Platform sur my.rokt.com.
Accédez aux Paramètres du profil sous l'icône de votre compte en bas à gauche.
Faites défiler vers le bas jusqu'à la section Générer des identifiants API personnels.
Entrez le nom de votre application.
Cliquez sur Générer.
Vos identifiants pour l'API Reporting et l'API Event seront générés immédiatement et ressembleront à ceci :
AppId: "40svbin0d194subpohl079rhck"
AppSecret: "1dimhvr1v6skae9uhvtgs3chs2astnjf0469df6ul9hurubtoovn"Conservez l'App ID et l'App Secret dans un endroit sûr. Vous n'aurez plus accès à l'App Secret après cette session.
Vous pouvez utiliser ces identifiants immédiatement.
Vous devez garder les identifiants confidentiels pour 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 qui représente légitimement Rokt ne vous demandera jamais votre App Secret.
Obtention d'un jeton d'accès
Un jeton d'accès est nécessaire pour appeler tout point de terminaison sur l'API de reporting Rokt. Les jetons d'accès permettent à Rokt d'identifier les applications clientes, le type de données auquel chaque application cliente accède, et d'empêcher les applications malveillantes d'accéder aux données auxquelles elles n'ont pas accès.
L'authentification à l'API s'effectue 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 requêtes API sans authentification ou avec une authentification incorrecte échoueront. L'API renverra soit un code d'erreur 400, soit un code d'erreur 403. Depuis l'API de reporting Rokt, vous ne pouvez récupérer des données que pour les comptes auxquels vos identifiants d'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 dans 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 qu'il n'expire, vous devez re-générer le jeton d'accès en fonction des identifiants 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 passés dans l'en-tête d'autorisation via l'autorisation HTTP de base et peuvent être générés sous Paramètres du profil dans 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 | Requis? | Exemple |
|---|---|---|---|---|
grant_type | corps | Doit être client_credentials | Oui | client_credentials |
Exemple de requête réussie
Exemple de requête:
POST https://api.rokt.com/auth/oauth2/token&
Content-Type='application/x-www-form-urlencoded'&
Authorization=Basic xxx
grant_type=authorization_code
Exemple de réponse:
{
"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 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 la Répartition des Campagnes de Compte
Renvoie des mesures de performance pour l'activité totale d'un compte annonceur Rokt Ads sur une période de temps donnée, un fuseau horaire et une devise. Par défaut, le résultat est réparti par campagne, mais vous pouvez également décomposer l'activité par pays.
Description
Appelez ce point de terminaison API pour recevoir des données au niveau du compte réparties 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
Demande
Chemin
GET /reporting/accounts/{accountId}/campaigns/breakdown
Paramètres
| Nom | Type | Dans | Description | Obligatoire | Exemple |
|---|---|---|---|---|---|
dateStart | Chaîne | query | Heure de début de la plage de date/heure demandée | true | dateStart=2020-03-01T00:00:00.000 |
dateEnd | Chaîne | 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 la devise dans laquelle vous recevrez des mesures 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 | Chaîne | path | Votre ID de compte Rokt. Trouvé dans One Platform ou fourni par votre responsable 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"
}
Récupérer le résumé du compte
Renvoie des indicateurs 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é pour les données du compte partenaire Rokt Ecommerce et les données du compte annonceur Rokt Ads.
Description
Appelez ce point de terminaison API pour recevoir des indicateurs de performance au niveau du compte pour une période, un fuseau horaire et une devise spécifiés.
Demande
Chemin
GET /reporting/accounts/{accountId}/summary
Paramètres
| Nom | Type | Dans | 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 la devise dans laquelle vous recevrez des indicateurs 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 de compte
Retourne les indicateurs 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 API pour recevoir les indicateurs de transaction au niveau du compte comme les impressions de placement, les références et les revenus pour une période de temps, un fuseau horaire et une devise spécifiés.
Demande
Chemin
GET /reporting/accounts/{accountId}/transactions/overview
Paramètres
| Nom | Type | Dans | Description | Requis | Exemples |
|---|---|---|---|---|---|
dateStart | Chaîne | query | Date/heure de début de la plage de dates demandée | vrai | dateStart=2020-03-01T00:00:00.000 |
dateEnd | Chaîne | query | Date/heure de fin de la plage de dates 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 indicateurs monétaires. | vrai | 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. | vrai | timeZoneVariation=Australia/Sydney |
accountId | Chaîne | path | vrai |
Réponse
200 OK
{
"revenue": 0,
"transactions": 0,
"placementImpressions": 0,
"impressions": 0,
"referrals": 0,
"rpt": 0,
"rpm": 0,
"positivePlacementEngagements": 0,
"purchases": 0
}
Récupérer le Détail des Transactions du Compte
Retourne les métriques de performance pour un compte partenaire Rokt Ecommerce, décomposées par un 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 des métriques de transactions 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
- typeDePage
- placement
- position
La décomposition des placements ne retourne 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 | Dans | 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 la monnaie dans laquelle 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
{
"groupByValue": "string",
"revenue": 0,
"transactions": 0,
"placementImpressions": 0,
"impressions": 0,
"referrals": 0,
"purchases": 0,
"positivePlacementEngagements": 0,
"rpt": 0,
"rpm": 0
}
OBTENIR Métadonnées d'Audience
Description
Appelez ce point d'extrémité de l'API pour recevoir des métadonnées d'audience, comme le nom de l'audience, la tranche d'âge, le sexe et l'appareil.
Demande
Chemin
GET /metadata/accounts/{accountId}/campaigns/{campaignId}/audiences/{audienceId}
Paramètres
| Nom | Type | Dans | Requis |
|---|---|---|---|
accountId | String | chemin | vrai |
campaignId | String | chemin | vrai |
audienceId | String | chemin | vrai |
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
Retourne des métriques de performance pour une campagne pour une période de temps, un fuseau horaire et une devise spécifiés.
Description
Appelez ce point de terminaison API pour recevoir des métriques de performance au niveau de la campagne, comme les impressions, les références et 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}/overview
Paramètres
| Nom | Type | Dans | Description | Requis | Exemple |
|---|---|---|---|---|---|
dateStart | String | query | Heure de début de la plage date/heure demandée | vrai | dateStart=2020-03-01T00:00:00.000 |
dateEnd | String | query | Heure de fin de la plage 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 la devise dans laquelle vous recevrez des métriques monétaires. | vrai | 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. | vrai | timeZoneVariation=Australia/Sydney |
accountId | String | path | vrai | ||
campaignId | String | path | vrai |
Réponse
200 OK
{
"grossCost": 0,
"netCost": 0,
"impressions": 0,
"referrals": 0,
"acquisitionsByConversionDate": 0,
"acquisitionsByReferralDate": 0,
"campaigns": 0,
"creatives": 0,
"audiences": 0,
"campaignCountries": 0
}
OBTENIR Analyse de Campagne
Renvoie des indicateurs de performance pour une campagne, décomposés par pays, campagne, audience ou créatif pour une période de temps, un fuseau horaire ou une devise spécifiés.
Description
Appelez ce point de terminaison 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 donnés. Les attributs qui peuvent être appelés via le paramètre "groupby" incluent :
- pays ;
- campagne ;
- audience ;
- créatif ; ou
- sous-vertical.
Demande
Chemin
GET /reporting/accounts/{accountId}/campaigns/{campaignId}/breakdown?groupby=creative
Paramètres
| Nom | Type | Dans | Description | Requis | Exemple |
|---|---|---|---|---|---|
dateStart | Chaîne | query | Heure de début de la plage de dates/heure demandée | true | dateStart=2020-03-01T00:00:00.000 |
dateEnd | Chaîne | 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 la devise dans laquelle 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 | Chaîne | path | true | ||
campaignId | Chaîne | path | true |
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"
}
OBTENIR Histogramme de Campagne
Retourne des métriques de performance pour une campagne pour une période donnée, un fuseau horaire et une devise décomposés par période.
Description
Appelez ce point de terminaison API pour recevoir un histogramme des métriques de performance d'une campagne, comme les impressions, les références ou les conversions pour une période, un fuseau horaire et une devise spécifiés.
Requête
Chemin
GET /reporting/accounts/{accountId}/campaigns/{campaignId}/histogram
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 des métriques monétaires. | vrai | 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. | vrai | timeZoneVariation=Australia/Sydney |
accountId | String | path | vrai | ||
campaignId | String | path | vrai |
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 Métadonnées de Campagne
Description
Appelez ce point de terminaison API pour recevoir des métadonnées pour une campagne spécifique.
Demande
Chemin
GET /metadata/accounts/{accountId}/campaigns/{campaignId}
Paramètres
| Nom | Type | Dans | Requis |
|---|---|---|---|
accountId | Chaîne | chemin | vrai |
campaignId | Chaîne | chemin | vrai |
Réponse
200 OK
{
"accountId": "string",
"campaignId": "string",
"campaignName": "string",
"campaignType": "string",
"campaignObjective": "string",
"countryCode": "string",
"status": "string"
}
RÉCUPÉRER Aperçu Créatif
Retourne les indicateurs de performance pour un créatif pour une période donnée, un fuseau horaire et une devise.
Description
Appelez ce point de terminaison API pour des indicateurs de performance au niveau créatif, comme les impressions, les références et les conversions pour une période spécifiée, un fuseau horaire et une devise.
Demande
Chemin
GET /reporting/accounts/{accountId}/campaigns/{campaignId}/creatives/{creativeId}/overview
Paramètres
| Nom | Type | Dans | 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 la devise dans laquelle vous recevrez les indicateurs monétaires. | vrai | 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. | vrai | timeZoneVariation=Australia/Sydney |
| accountId | String | path | vrai | ||
| campaignId | String | path | vrai | ||
| creativeId | String | path | true |
Réponse
200 OK
{
"grossCost": 0,
"netCost": 0,
"impressions": 0,
"referrals": 0,
"uniqueReferrals": 0,
"acquisitionsByConversionDate": 0,
"acquisitionsByReferralDate": 0,
"creatives": 0,
"audiences": 0
}
Récapitulatif Créatif GET
Renvoie des métriques de performance pour un créatif décomposé par un attribut pour une période de temps, un fuseau horaire et une devise spécifiés.
Description
Appelez ce point de terminaison API pour des détails sur un créatif spécifique décomposé 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" sont :
- audience;
Demande
Chemin
GET /reporting/accounts/{accountId}/campaigns/{campaignId}/creatives/{creativeId}/breakdown
Paramètres
| Nom | Type | Dans | Description | Requis | Exemple |
|---|---|---|---|---|---|
dateStart | Chaîne | query | Heure de début de la plage de dates/temps demandée | vrai | dateStart=2020-03-01T00:00:00.000 |
dateEnd | Chaîne | query | Heure de fin de la plage de dates/temps 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 la monnaie dans laquelle vous recevrez des métriques monétaires. | vrai | 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. | vrai | timeZoneVariation=Australia/Sydney |
accountId | Chaîne | path | vrai | ||
campaignId | Chaîne | path | vrai | ||
creativeId | Chaîne | path | vrai |
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 Métadonnées Créatives
Description
Appelez ce point de terminaison API pour recevoir des métadonnées créatives, y compris le nom créatif, le titre, le sous-titre, le texte, les réponses et le statut.
Demande
Chemin
GET /metadata/accounts/{accountId}/campaigns/{campaignId}/creatives/{creativeId}
Paramètres
| Nom | Type | Dans | Requis |
|---|---|---|---|
accountId | String | path | true |
campaignId | String | path | true |
creativeId | String | path | true |
Réponse
200 OK
{
"accountId": "string",
"campaignId": "string",
"creativeId": "string",
"name": "string",
"title": "string",
"subtitle": "string",
"text": "string",
"responses": [
"string"
],
"status": "string"
}