Reporting API
Vue d'ensemble
L'API de Reporting Rokt permet aux annonceurs et 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 programmétiquement les données Rokt dans des applications métier externes. L'API fonctionne avec n'importe quel langage qui prend en charge les requêtes HTTP. Presque toutes les requêtes sont envoyées à l'URL hôte https://api.rokt.com.
Pour que vos données restent sûres et sécurisé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 consultées, 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 est effectuée via OAuth 2.0. Pour effectuer un appel d'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 d'API sans authentification échoueront. L'API de Reporting Rokt vous permet uniquement de récupérer des données des comptes auxquels vos identifiants utilisateur ont accès.
Version
Pour les premiers adopteurs utilisant la version Alpha Release de l'API, assurez-vous que "rokt-version":"alpha-20200701" est utilisé dans votre en-tête de requête API pour minimiser les changements susceptibles de causer des problèmes. Si aucun en-tête rokt-version n'est utilisé, votre requête de point d'accès 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 client. Consultez le Flux d'informations d'identification OAuth 2.0 pour plus de détails. Vous devez utiliser votre Rokt App ID et App Secret pour accéder à l'API de reporting Rokt.
Les étapes pour générer l'App ID et l'App Secret sont expliquées ci-dessous. Vous pouvez générer des informations d'identification pour l'API d'événements Rokt avec ces mêmes étapes.
Vous devez utiliser ces informations d'identification de l'application client dans les interactions REST avec l'API de reporting Rokt.
Génération de l'ID d'application et du Secret d'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 des identifiants API personnels.
Saisissez le nom de votre application.
Cliquez sur Générer.
Vos identifiants pour l'API de Reporting et l'API d'Événement seront immédiatement générés et ressembleront à ceci :
AppId: "40svbin0d194subpohl079rhck"
AppSecret: "1dimhvr1v6skae9uhvtgs3chs2astnjf0469df6ul9hurubtoovn"Stockez l'ID d'application et le Secret d'application dans un endroit sécurisé. Vous n'aurez plus accès au Secret d'application après cette session.
Vous pouvez utiliser ces identifiants immédiatement.
Vous devez garder les identifiants confidentiels 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 auquel 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 exécuter un appel d'API réussi, vous devrez utiliser un identifiant d'application et un secret d'application pour obtenir un jeton d'accès qui devra être utilisé dans tous les appels d'API. L'identifiant d'application et le secret d'application peuvent être générés sur la page Paramètres de 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 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'identifiant 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 qu'il n'expire, 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 la requête dans l'en-tête
| Key | In | Description | Obligatoire? | Exemple |
|---|---|---|---|---|
Authorization | header | app_id et app_secret doivent être passés dans l'en-tête d'autorisation via l'autorisation HTTP Basique 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 | header | 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 la requête dans le corps
| Key | In | Description | Obligatoire? | Exemple |
|---|---|---|---|---|
grant_type | body | Doit être client_credentials | Oui | client_credentials |
Exemple de requête réussie
Exemple de requête:
curl -vX POST https://api.rokt.com/auth/oauth2/token \
-H 'Authorization: Basic ${AuthToken}' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'grant_type=client_credentials'
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 API
Appeler un point de terminaison 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 la ventilation des campagnes de compte
Retourne les métriques de performance pour l'activité totale du compte annonceur Rokt Ads pour une période donnée, un fuseau horaire et une devise. Par défaut, le résultat est divisé par campagne, mais vous pouvez également ventiler l'activité par pays.
Description
Appelez ce point de terminaison API pour recevoir des données au niveau du compte ventilées par camapignid pour une période, un fuseau horaire et une devise spécifiés. Les attributs pouvant ê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 | Chaîne | requête | Heure de début de l'intervalle de date/heure demandé | vrai | dateStart=2020-03-01T00:00:00.000 |
dateEnd | Chaîne | requête | Heure de fin de l'intervalle de date/heure demandé | vrai | dateEnd=2020-03-31T23:59:59.000 |
currency | Enum: AUD CAD EUR GBP JPY NZD SGD USD KRW CNY | requête | Code de devise dans lequel vous recevrez les métriques monétaires | vrai | currency=USD |
timeZoneVariation | Enum: America/Chicago Pacific/Honolulu Australia/Sydney | requête | Fuseau horaire souhaité au format Olson | vrai | timeZoneVariation=Australia/Sydney |
accountId | Chaîne | chemin | Votre ID de compte Rokt. Trouvé dans One Platform ou fourni par votre responsable de compte. | vrai |
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écapitulatif du Compte
Renvoie des indicateurs de performance pour l'activité totale d'un compte sur une période donnée, fuseau horaire et 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 ce point de terminaison de l'API pour recevoir des indicateurs de performance au niveau du compte pour une période, un fuseau horaire et une devise spécifiés.
Requête
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 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 devise dans laquelle vous recevrez les indicateurs monétaires. | true | currency=USD |
timeZoneVariation | Enum: America/Chicago Pacific/Honolulu Australia/Sydney | query | Le fuseau horaire désiré 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
}
}
GET Aperçu des Transactions de Compte
Retourne les métriques de performance pour un compte partenaire de Rokt Ecommerce sur une période donnée, un fuseau horaire et une devise.
Description
Appelez ce point de terminaison API pour recevoir des métriques de transaction au niveau du compte telles que les impressions de placement, les références et le revenu pour une période de temps, un fuseau horaire et une devise spécifiés.
Requête
Chemin
GET /reporting/accounts/{accountId}/transactions/overview
Paramètres
| Nom | Type | Dans | Description | Requis | Exemple |
|---|---|---|---|---|---|
dateStart | String | query | Heure de début de l'intervalle de date/heure demandé | true | dateStart=2020-03-01T00:00:00.000 |
dateEnd | String | query | Heure de fin de l'intervalle de date/heure demandé | 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 des métriques monétaires. | true | currency=USD |
timeZoneVariation | Enum: America/Chicago Pacific/Honolulu Australia/Sydney | query | Le fuseau horaire souhaité peut être transmis par 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
}
OBTENIR Répartition des Transactions de Compte
Renvoie 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 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 :
- age
- gender
- page
- pagetype
- placement
- position
La répartition 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.
Requête
Chemin
GET /reporting/accounts/{accountId}/transactions/breakdown
Paramètres
| Nom | Type | Dans | Description | Requis | Exemple |
|---|---|---|---|---|---|
dateStart | String | query | Heure de début de l'intervalle de date/heure demandé | true | dateStart=2020-03-01T00:00:00.000 |
dateEnd | String | query | Heure de fin de l'intervalle de date/heure demandé | 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 indicateurs monétaires. | true | currency=USD |
timeZoneVariation | Enum: America/Chicago Pacific/Honolulu Australia/Sydney | query | Le fuseau horaire souhaité peut être passé avec 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
}
GET Audience Metadata
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"
}
GET Aperçu de la Campagne
Renvoie les 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.
Requête
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 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 passé par ce paramètre. Il doit être au format Olson. | true | timeZoneVariation=Australia/Sydney |
accountId | String | path | true | ||
campaignId | String | path | true |
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 Répartition de la Campagne
Retourne les métriques de performance d'une campagne ventilées par pays, campagne, audience ou créatif pour une période, 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 ventilées par un attribut spécifié dans la chaîne de requête pour une période, 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 ;
- créatif ; ou
- sous-vertical.
Requête
Chemin
GET /reporting/accounts/{accountId}/campaigns/{campaignId}/breakdown?groupby=creative
Paramètres
| Nom | Type | Dans | Description | Obligatoire | Exemple |
|---|---|---|---|---|---|
dateStart | String | query | Heure de début de la plage de dates/horaires demandée | true | dateStart=2020-03-01T00:00:00.000 |
dateEnd | String | query | Heure de fin de la plage de dates/horaires 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 transmis par ce paramètre. Il doit être au format Olson. | true | timeZoneVariation=Australia/Sydney |
accountId | String | path | true | ||
campaignId | String | 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"
}
GET Histogramme de Campagne
Renvoie des métriques de performance pour une campagne pour une période, un fuseau horaire et une devise donnés, répartis 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 renvois, 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 l'intervalle de date/heure demandé | true | dateStart=2020-03-01T00:00:00.000 |
dateEnd | String | query | Heure de fin de l'intervalle de date/heure demandé | 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 | ||
campaignId | String | path | true |
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
}
GET Métadonnées de Campagne
Description
Appelez ce point de terminaison de l'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 | Dans | Requis |
|---|---|---|---|
accountId | String | path | true |
campaignId | String | path | true |
Réponse
200 OK
{
"accountId": "string",
"campaignId": "string",
"campaignName": "string",
"campaignType": "string",
"campaignObjective": "string",
"countryCode": "string",
"status": "string"
}
GET Aperçu Créatif
Renvoie 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 obtenir des indicateurs de performance au niveau créatif, comme les impressions, les référencements 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 | Dans | Description | Obligatoire | 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 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 | ||
| campaignId | String | path | true | ||
| creativeId | String | chemin | true |
Réponse
200 OK
{
"grossCost": 0,
"netCost": 0,
"impressions": 0,
"referrals": 0,
"uniqueReferrals": 0,
"acquisitionsByConversionDate": 0,
"acquisitionsByReferralDate": 0,
"creatives": 0,
"audiences": 0
}
GET Creative Breakdown
Retourne les mesures de performance pour une création décomposées par un attribut 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 obtenir des détails sur une création spécifique, décomposés 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 ;
Requête
Chemin
GET /reporting/accounts/{accountId}/campaigns/{campaignId}/creatives/{creativeId}/breakdown
Paramètres
| Nom | Type | Dans | Description | Requis | Exemple |
|---|---|---|---|---|---|
dateStart | String | query | Heure de début de l'intervalle de date/heure demandé | true | dateStart=2020-03-01T00:00:00.000 |
dateEnd | String | query | Heure de fin de l'intervalle de date/heure demandé | 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 par 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
}
GET Métadonnées Créatives
Description
Appelez ce point de terminaison API pour recevoir les métadonnées créatives, y compris le nom créatif, 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 | 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"
}