Scribd
Upload
2 views8 pages

Recommendation Engine Data Schema Documentation

The table nyx-agents.reporting.recomm_engine_combined contains daily performance and configuration data for individual ads, including metrics such as impressions, clicks, and spend. It includes various metadata from campaigns, ad groups, and creatives, and is intended for reporting, analysis, optimization, and recommendation purposes. Each row represents a snapshot of an ad's performance on a specific day.

Uploaded by

shikharagarwal197
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
2 views8 pages

Recommendation Engine Data Schema Documentation

The table nyx-agents.reporting.recomm_engine_combined contains daily performance and configuration data for individual ads, including metrics such as impressions, clicks, and spend. It includes various metadata from campaigns, ad groups, and creatives, and is intended for reporting, analysis, optimization, and recommendation purposes. Each row represents a snapshot of an ad's performance on a specific day.

Uploaded by

shikharagarwal197
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
You are on page 1/ 8

───────────────────────────────────────────────

Table Documentation: nyx-agents.reporting.recomm_engine_combined

───────────────────────────────────────────────

Overview:

------------

The table nyx-agents.reporting.recomm_engine_combined stores daily


details for individual ads. Each row represents performance and
configuration data for a particular ad on a given day. This includes
metadata from various entities (such as campaigns, ad groups, and ad
creatives) as well as performance metrics (such as impressions, clicks,
spend, etc.). The data can be used for reporting, analysis, optimization,
and recommendation engine purposes.

Schema Details:

----------------

1. platform (STRING, NULLABLE)

• Description: Identifies the advertising platform from which the data


originates (for example, "Google").

• Example: "Google"

2. account_id (STRING, NULLABLE)

• Description: A unique identifier for the account managing the ad.

• Example: "1234567890"

3. account_name (STRING, NULLABLE)

• Description: The name associated with the advertising account.

• Example: "Nyxify"
4. campaign_id (STRING, NULLABLE)

• Description: A unique identifier for the campaign under which the ad is


running.

• Example: "001234"

5. campaign_name (STRING, NULLABLE)

• Description: The name of the campaign.

• Example: " Campaign test"

6. ad_group_id (STRING, NULLABLE)

• Description: A unique identifier for the ad group within the campaign.

• Example: "9876589756"

7. ad_group_name (STRING, NULLABLE)

• Description: The name of the ad group.

• Example: "test Group"

8. ad_id (STRING, NULLABLE)

• Description: The unique identifier for the ad creative.

• Example: "4545754321"

9. ad_name (STRING, NULLABLE)

• Description: The name of the ad creative.

• Example: "Display Ad - Product Launch"

10. date (DATE, NULLABLE)

• Description: The date for which the metrics are captured.

• Example: 2023-10-02
11. ad_status (STRING, NULLABLE)

• Description: The current status of the ad (e.g., enabled, paused,


removed).

• Example: "ENABLED"

12. ad_group_status (STRING, NULLABLE)

• Description: The status of the containing ad group.

• Example: "PAUSED"

13. campaign_status (STRING, NULLABLE)

• Description: The status of the campaign (e.g., active, paused, ended).

• Example: "ACTIVE"

14. campaign_start_date (STRING, NULLABLE)

• Description: The start date of the campaign as defined in the


campaign settings.

• Example: "2023-09-01"

15. campaign_end_date (STRING, NULLABLE)

• Description: The end date of the campaign; can be NULL if ongoing.

• Example: "2023-12-31"

16. campaign_objective (STRING, NULLABLE)

• Description: The primary objective of the campaign (e.g., brand


awareness, leads, conversions).

• Example: "SALES"

17. age_range (STRING, NULLABLE)

• Description: Indicates the targeted or observed age range of the


audience for the ad.
• Example: "18-24"

18. gender (STRING, NULLABLE)

• Description: Indicates the targeted or observed gender of the


audience (or differentiates creative performance by gender).

• Example: "FEMALE"

19. device (STRING, NULLABLE)

• Description: Identifies the device type on which the ad was viewed or


targeted (such as mobile, desktop, tablet).

• Example: "MOBILE"

20. ad_type (STRING, NULLABLE)

• Description: Indicates the type of ad format (e.g., responsive, display,


search).

• Example: "RESPONSIVE_DISPLAY"

21. bid_strategy (STRING, NULLABLE)

• Description: The bidding strategy used for the campaign/ad group


(e.g., manual CPC, maximize clicks).

• Example: "MANUAL_CPC"

22. budget (FLOAT, NULLABLE)

• Description: The budget allocated to the campaign

• Example: 5000.00

23. meta_regions (JSON, NULLABLE)

• Description: JSON-formatted meta’s data for regions targeted for the


ad.

• Example: {"regions": ["California", "New York"]}


24. meta_cities (JSON, NULLABLE)

• Description: JSON-formatted information regarding the cities for


region-based targeting for meta.

• Example: {"cities": ["Los Angeles", "San Francisco"]}

25. meta_countries (JSON, NULLABLE)

• Description: JSON data that contains information of the countries


relevant to the ad targeting.

• Example: {"countries": ["USA"]}

26. meta_custom_locations (JSON, NULLABLE)

• Description: JSON-formatted details for any custom location


parameters defined in the targeting settings.

• Example: {"custom_locations": ["Downtown", "Suburbs"]}

27. google_location_type (STRING, NULLABLE)

• Description: The type classification for the location data as provided


by Google (for example, locality or postal code).

• Example: "locality"

28. google_location_name (STRING, NULLABLE)

• Description: The name of the location as recognized in Google’s


system.

• Example: "San Francisco"

29. google_country (STRING, NULLABLE)

• Description: Country information provided by Google for the targeted


location.

• Example: "USA"

30. impressions (INTEGER, NULLABLE)


• Description: The total number of times the ad was displayed.

• Example: 15000

31. conversions (NUMERIC, NULLABLE)

• Description: The value representing the conversions driven by the ad.


Depending on configuration, it could be count-based or value-based.

• Example: 75

32. clicks (INTEGER, NULLABLE)

• Description: The total number of clicks received on the ad.

• Example: 1234

33. reach (INTEGER, NULLABLE)

• Description: An estimate of the total number of unique users who saw


the ad.

• Example: 8000

34. roas (NUMERIC, NULLABLE)

• Description: Return on Ad Spend. This metric measures revenue


earned for every dollar spent.

• Example: 1.5

35. spend (NUMERIC, NULLABLE)

• Description: The total amount spent on the ad for the day.

• Example: 250.75

36. views (NUMERIC, NULLABLE)

• Description: The count of video views (or other view-based


interactions) depending on the ad format.

• Example: 500
37. cpc (NUMERIC, NULLABLE)

• Description: Cost per click – the average cost incurred for each click
on the ad.

• Example: 0.20

38. cpm (NUMERIC, NULLABLE)

• Description: Cost per thousand impressions – the cost incurred for


every 1,000 impressions.

• Example: 2.50

39. ctr (NUMERIC, NULLABLE)

• Description: Click-through rate – usually represented as a percentage


or decimal fraction that indicates the ratio of clicks to impressions.

• Example: 0.082 (or 8.2%)

40. city_1 (STRING, NULLABLE)


• Description: Contains the top (highest-ranked) city for the ad
based on the chosen metric.
• Example: "San Francisco"
41. city_2 (STRING, NULLABLE)
• Description: Contains the second-ranked city for the ad.
• Example: "Los Angeles"
42. city_3 (STRING, NULLABLE)
• Description: Contains the third-ranked city for the ad.
• Example: "New York"
43. city_4 (STRING, NULLABLE)
• Description: Contains the fourth-ranked city for the ad.
• Example: "Chicago"
44. city_5 (STRING, NULLABLE)
• Description: Contains the fifth-ranked city for the ad.
• Example: "Houston"
45. country_1 (STRING, NULLABLE)
• Description: Contains the top (highest-ranked) country for the ad
based on the performance metric chosen during aggregation.
• Example: "USA"
46. country_2 (STRING, NULLABLE)
• Description: Contains the second-ranked country for the ad.
• Example: "Canada"
47. country_3 (STRING, NULLABLE)
• Description: Contains the third-ranked country for the ad.
• Example: "United Kingdom"

Usage Considerations:

----------------------

• Daily Granularity: Each row in the table represents a snapshot


of an ad’s performance on a given day.

You might also like