# `analytics.conf_namespace` - namespace Configuration settings related to Namespaces. Layer: Core Dataset Category: Configuration Status: Published Primary Key: env, env_namespace Other Unique Key(s): env_namespace Partition: None Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = conf_namespace.env_namespace; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `geo_region` | `STRING` | Geographical region of the Namespace (as defined by CitrusAd). | | `local_timezone` | `STRING` | Not in use. | # `analytics.conf_retailer` - namespace - retailer Configuration settings related to Retailers. Layer: Core Dataset Category: Configuration Status: Published Primary Key: env_namespace, retailer_id Other Unique Key(s): None Partition: None Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = conf_retailer.env_namespace; dim_retailer on dim_retailer.env_namespace = conf_retailer.env_namespace and dim_retailer.retailer_id = conf_retailer.retailer_id and dim_retailer.is_current; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `global_suppress_flag` | `STRING` | Flag to indicate Retailer is to be excluded from reporting (eg test data). | | `ads_requested_cap` | `NUMERIC` | Max number of Product Ads that will be considered for reporting purposes per Ad Request (set per Retailer team, no setting means no cap will be imposed). | | `reserved_search_terms` | `STRING` | Not in use. | | `period_start_date` | `STRING` | Not in use. | | `banner_ads_requested_cap` | `NUMERIC` | Max number of Banner Ads that will be considered for reporting purposes per Ad Request (set per Retailer team, no setting means no cap will be imposed). | | `view_attribution_window` | `NUMERIC` | Max number of days allowed between the Order and Realised Ad for View Thru Attribution. | | `click_attribution_window` | `NUMERIC` | Max number of days allowed between the Order and Realised Ad for Halo Click Attribution (1st model). | | `retailer_taxonomy_halo` | `STRING` | Comma separated list of what halo levels will be computed for model 1. | | `enhanced_attribution_flag` | `STRING` | If true, the first enhanced attribution model will be calculated. | | `enhanced_attribution_flag_2` | `STRING` | If true, the second enhanced attribution model will be calculated. | | `view_attribution_window_2` | `NUMERIC` | Max number of days allowed between the Order and Realised Ad for View Thru Attribution (2nd model). | | `click_attribution_window_2` | `NUMERIC` | Max number of days allowed between the Order and Realised Ad for Halo Click Attribution (2nd model). | | `retailer_taxonomy_halo_2` | `STRING` | Comma separated list of what halo levels will be computed for model 2. | | `attribution_time_frame` | `NUMERIC` | Determines how many days of attribution results should be stored for the first model. | | `attribution_time_frame_2` | `NUMERIC` | Determines how many days of attribution results should be stored for the second model. | | `retailer_group_1` | `STRING` | Retailer team group membership #1. | | `retailer_group_2` | `STRING` | Retailer team group membership #2. | # `analytics.conf_supplier` - namespace Configuration settings related to Suppliers. Layer: Core Dataset Category: Configuration Status: Published Primary Key: env_namespace, supplier_id Other Unique Key(s): None Partition: None Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = conf_supplier.env_namespace; dim_supplier on dim_supplier.env_namespace = conf_supplier.env_namespace and dim_supplier.supplier_id = conf_supplier.supplier_id and dim_supplier.is_current; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `supplier_id` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `supplier_group_1` | `STRING` | Supplier team group membership #1. | | `supplier_group_2` | `STRING` | Supplier team group membership #2. | | `supplier_group_3` | `STRING` | Supplier team group membership #3. | | `supplier_group_4` | `STRING` | Supplier team group membership #4. | # `analytics.currency_aud` - namespace - retailer Current conversion rates between the base currency (AUD) to other common currencies. ISO 4217 currency codes used. Layer: Core Dataset Category: Dimension Status: Published Primary Key: currency Other Unique Key(s): None Partition: None Foreign Key(s): None | Column Name | Data Type | Description | |-------------|-----------|-------------| | `currency` | `STRING` | Currency being converted (ISO 4217 currency code). | | `value` | `FLOAT` | Conversion rate to apply. | | `base` | `STRING` | Currency being converted into (AUD). | # `analytics.currency_usd` - namespace - retailer Current conversion rates between the base currency (USD) to other common currencies. ISO 4217 currency codes used. Layer: Core Dataset Category: Dimension Status: Published Primary Key: currency Other Unique Key(s): None Partition: None Foreign Key(s): None | Column Name | Data Type | Description | |-------------|-----------|-------------| | `currency` | `STRING` | Currency being converted (ISO 4217 currency code). | | `value` | `FLOAT` | Conversion rate to apply. | | `base` | `STRING` | Currency being converted into (USD). | # `analytics.dim_campaign` - namespace - retailer Campaign master data dimension. Layer: Core Dataset Category: Dimension Status: Published Primary Key: campaign_id, row_version, env_namespace Other Unique Key(s): campaign_key Partition: None Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = dim_campaign.env_namespace; dim_placement on dim_placement.env_namespace = dim_campaign.env_namespace and dim_placement.placement_id = dim_campaign.placement_id; dim_team on dim_team.env_namespace = dim_campaign.env_namespace and dim_team.team_id = dim_campaign.team_id and dim_team.is_current; dim_wallet on dim_wallet.env_namespace = dim_campaign.env_namespace and dim_wallet.wallet_id = dim_campaign.wallet_id; dim_catalog on dim_catalog.env_namespace = dim_campaign.env_namespace and dim_catalog.catalog_id = dim_campaign.first_catalog_id and dim_catalog.is_current; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `campaign_key` | `STRING` | Unique identifier of the row in this table (surrogate key). | | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `campaign_id` | `STRING` | Internal identifier of the Campaign (from the source system). | | `row_version` | `INTEGER` | Track changes with new row versions (sequentially increasing number to indicate chronology). | | `team_id` | `STRING` | Internal identifier of the Team (from the source system). | | `wallet_id` | `STRING` | Internal identifier of the Wallet (from the source system). | | `placement_id` | `STRING` | Internal identifier of the Placement (from the source system). | | `first_catalog_id` | `STRING` | First Catalog id. | | `campaign_name` | `STRING` | Name of the Campaign. | | `campaign_type` | `STRING` | Type of Campaign (BANNER, BRAND_PAGE, DISPLAY, EMAIL, SHOTGUN_BANNER, WILDCARD) | | `campaign_subtype` | `STRING` | Legacy, superseded by placement. Subtype of the Campaign (SEARCH_ONLY, CATEGORY_ONLY, CATEGORY_AND_SEARCH, BROAD_DISPLAY, CROSS_SELL, UPSELL, RUN_OF_SITE). | | `campaign_start_date` | `TIMESTAMP` | Date the Campaign will begin. | | `campaign_start_date_utc` | `TIMESTAMP` | Currently the same as campaign_start_date since all data is in UTC. | | `campaign_end_date` | `TIMESTAMP` | Date when the Campaign will end. | | `campaign_end_date_utc` | `TIMESTAMP` | Currently the same as campaign_end_date since all data is in UTC. | | `valid_state` | `STRING` | The Campaign's valid state. (APPROVED, PENDING, REJECTED) | | `active_state` | `STRING` | The Campaign's active state as set in the platform. (ACTIVE, PAUSED, DRAFT, ARCHIVED). | | `is_fta` | `STRING` | Flag indicating if the Campaign is Fixed Tenancy Agreement (FTA). | | `catalog_ids` | `STRING` | Catalog ids. | | `search_terms` | `STRING` | Comma separated list of SearchTerms targeted by the Campaign. | | `has_search_terms` | `BOOLEAN` | Flag to indicate if the Campaign is targeting SearchTerms. | | `catalog_products` | `STRING` | The Catalog's Products within the Campaign. | | `placements` | `STRING` | The Campaign's selected Placement. | | `currency_code` | `STRING` | ISO 4217 currency code | | `fta_cost` | `NUMERIC` | Total amount being spent by the given Fixed Tenancy Agreement (FTA) Campaign. | | `max_cost_per_click` | `NUMERIC` | The maximum cost per click set for the Campaign. | | `max_total_spend` | `NUMERIC` | The maximum total spend set for the Campaign. | | `max_daily_spend` | `NUMERIC` | The maximum daily spend set for the Campaign. | | `impression_goal` | `NUMERIC` | The maximum number of impressions a Campaign is aiming for. Only relevant for campaigns with a spend type of Fixed Spend. | | `total_spend` | `NUMERIC` | Total AdSpend to date for the Campaign. | | `retailer_ad_spend_type` | `STRING` | Type of spending if Retailer Campaign (Always On, Daily Spend, Fixed Spend, Fixed Tenancy, Total Spend). | | `supplier_ad_spend_type` | `STRING` | Type of spending if Supplier Campaign (Always On, Daily Spend, Fixed Spend, Fixed Tenancy, Total Spend). | | `budget` | `NUMERIC` | The Campaign's budget as set by the Campaign's manager. | | `targeted_filters` | `STRING` | The filters selected by an advertiser that their campaign will appear for. Used for fixed tenancy campaigns. | | `location_filters` | `STRING` | Filters on the campaign specific to a location if a location filter class is created. | | `filter_whitelists` | `STRING` | The filters selected by an advertiser that the campaign can appear for. The campaign will only appear where eligible regardless of the advertiser's selection. | | `cross_sell_settings` | `STRING` | The cross-sell targeting selection in the campaign. | | `upsell_settings` | `STRING` | The Upsell targeting selection in the campaign if applicable. | | `categories` | `STRING` | Comma separated list of Categories targeted by the Campaign. | | `catalog_count` | `INTEGER` | Number of Catalogs being targeted by the Campaign. | | `last_spend_date` | `DATE` | Most recent date that AdSpend was incurred by the Supplier. | | `product_type_code` | `STRING` | Product type code. | | `namespace` | `STRING` | Name of the Namespace. | | `user_id` | `STRING` | Internal identifier of the User (from the source system). | | `user_email` | `STRING` | User's email address. | | `is_active` | `BOOLEAN` | Flag to indicate that the record is active in the source system. | | `is_deleted` | `BOOLEAN` | Flag to indicate that the record has been soft deleted in the source system. | | `is_current` | `BOOLEAN` | Flag if the row is the latest version in the source system. | | `created_at` | `TIMESTAMP` | Date the record was created in the source system. | | `created_at_utc` | `TIMESTAMP` | Currently the same as created_at since all data is in UTC. | | `updated_at` | `TIMESTAMP` | Date the record was updated in the source system. | | `updated_at_utc` | `TIMESTAMP` | Currently the same as updated_at since all data is in UTC. | | `etl_created_at` | `TIMESTAMP` | Date the row was inserted into this table (not the date the record was created in the source system). | | `etl_modified_at` | `TIMESTAMP` | Date this row was last updated (not the date the record was updated in the source system). | | `cta_text` | `STRING` | CTA text. | | `suggested_search_terms` | `STRING` | Suggested search terms. | | `has_suggested_search_terms` | `BOOLEAN` | Flag to indicate that any suggested search terms exist. | | `product_group_list` | `STRING` | The list of product group ids from Epsilon Digital | | `targeted_keywords` | `RECORD` | Suggested search terms Keywords | | `has_negative_keywords` | `BOOLEAN` | Flag to indicate that any negative search terms exist. | | `negative_keywords` | `RECORD` | Negative search terms Keywords | | `has_keywords` | `BOOLEAN` | Flag to indicate that any targeted keyword exist. | | `suggested_keywords` | `RECORD` | Suggested Keywords Keywords | | `targeted_categories` | `STRING` | List of Targetted Categories | | `has_categories` | `BOOLEAN` | Flag to indicate that any targeted category exist. | | `promoted_products` | `RECORD` | List of advertised Products | | `negative_categories` | `STRING` | List of Excluded Categories | | `has_negative_categories` | `BOOLEAN` | Flag to indicate that any targeted category exist. | | `has_video` | `BOOLEAN` | Flag to indicate if the Campaign has video. | | `has_companion_products` | `BOOLEAN` | Flag to indicate if the Campaign has companion products. | # `analytics.dim_campaign_attr` - namespace - retailer Campaign custom attributes (certain retailers only). Layer: Core Dataset Category: Dimension Status: Published Primary Key: campaign_id, row_version, env_namespace Other Unique Key(s): campaign_attr_key Partition: None Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = dim_campaign_attr.env_namespace; dim_campaign on dim_campaign.env_namespace = dim_campaign_attr.env_namespace and dim_campaign.campaign_id = dim_campaign_attr.campaign_id and dim_campaign.row_version = dim_campaign_attr.row_version; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `campaign_attr_key` | `STRING` | Unique identifier of the row in this table (surrogate key). | | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `campaign_id` | `STRING` | Internal identifier of the Campaign (from the source system). | | `row_version` | `INTEGER` | Track changes with new row versions (sequentially increasing number to indicate chronology). | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `supplier_id` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `attr1` | `STRING` | Campaign user defined attribute value 1. | | `attr2` | `STRING` | Campaign user defined attribute value 2. | | `attr3` | `STRING` | Campaign user defined attribute value 3. | | `attr4` | `STRING` | Campaign user defined attribute value 4. | | `attr5` | `STRING` | Campaign user defined attribute value 5. | | `namespace` | `STRING` | Name of the Namespace. | | `is_active` | `BOOLEAN` | Flag to indicate that the record is active in the source system. | | `is_deleted` | `BOOLEAN` | Flag to indicate that the record has been soft deleted in the source system. | | `is_current` | `BOOLEAN` | Flag if the row is the latest version in the source system. | | `etl_created_at` | `TIMESTAMP` | Date the row was inserted into this table (not the date the record was created in the source system). | | `etl_modified_at` | `TIMESTAMP` | Date this row was last updated (not the date the record was updated in the source system). | # `analytics.dim_catalog` - namespace - retailer Catalog master data dimension. Layer: Core Dataset Category: Dimension Status: Published Primary Key: catalog_id, row_version Other Unique Key(s): catalog_key Partition: None Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = dim_catalog.env_namespace; dim_retailer on dim_retailer.env_namespace = dim_catalog.env_namespace and dim_retailer.retailer_id = dim_catalog.retailer_id and dim_retailer.is_current; currency_aud on currency_aud.currency = dim_catalog.currency_code; currency_usd on currency_usd.currency = dim_catalog.currency_code; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `catalog_key` | `STRING` | Unique identifier of the row in this table (surrogate key). | | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `row_version` | `INTEGER` | Track changes with new row versions (sequentially increasing number to indicate chronology). | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `catalog_name` | `STRING` | Name of the Catalog. | | `currency_code` | `STRING` | ISO 4217 currency code | | `retailer_name` | `STRING` | Name of the Retailer. | | `namespace` | `STRING` | Name of the Namespace. | | `is_active` | `BOOLEAN` | Flag to indicate that the record is active in the source system. | | `is_deleted` | `BOOLEAN` | Flag to indicate that the record has been soft deleted in the source system. | | `is_current` | `BOOLEAN` | Flag if the row is the latest version in the source system. | | `etl_created_at` | `TIMESTAMP` | Date the row was inserted into this table (not the date the record was created in the source system). | | `etl_modified_at` | `TIMESTAMP` | Date this row was last updated (not the date the record was updated in the source system). | | `is_visible` | `BOOLEAN` | Flag to indicate if the catalog is visible in the source system. | | `grace_window_days` | `NUMERIC` | Configured grace window lookback period value in days or part thereof. | | `grace_window_days_display` | `NUMERIC` | ~DEPRECATED - use grace_window_days_display_click instead] Grace window days for display ad type, extracted from grace_window_secs_by_ad_type JSON. | | `grace_window_days_banner` | `NUMERIC` | ~DEPRECATED - use grace_window_days_display_impression instead] Grace window days for banner ad type, extracted from grace_window_secs_by_ad_type JSON. | | `grace_window_days_bannerx` | `NUMERIC` | ~DEPRECATED - use grace_window_days_banner_click instead] Grace window days for bannerx ad type, extracted from grace_window_secs_by_ad_type JSON. | | `grace_window_days_display_click` | `NUMERIC` | Grace window days for display ad type click-based attribution, extracted from grace_window_secs_by_ad_type JSON. | | `grace_window_days_display_impression` | `NUMERIC` | Grace window days for display ad type impression-based attribution, extracted from grace_window_secs_by_ad_type JSON. | | `grace_window_days_banner_click` | `NUMERIC` | Grace window days for banner ad type click-based attribution, extracted from grace_window_secs_by_ad_type JSON. | | `grace_window_days_banner_impression` | `NUMERIC` | Grace window days for banner ad type impression-based attribution, extracted from grace_window_secs_by_ad_type JSON. | | `grace_window_days_bannerx_click` | `NUMERIC` | Grace window days for bannerx ad type click-based attribution, extracted from grace_window_secs_by_ad_type JSON. | | `grace_window_days_bannerx_impression` | `NUMERIC` | Grace window days for bannerx ad type impression-based attribution, extracted from grace_window_secs_by_ad_type JSON. | | `min_bid_display` | `NUMERIC` | Minimum bid for display ads in this catalog (local currency). | | `min_bid_banner` | `NUMERIC` | Minimum bid for banner ads in this catalog (local currency). | | `min_bid_bannerx` | `NUMERIC` | Minimum bid for BannerX ads in this catalog (local currency). | | `grace_window_days_brandpage_impression` | `NUMERIC` | Grace window days for brandpage ad type impression-based attribution, extracted from grace_window_secs_by_ad_type JSON. | # `analytics.dim_category` - namespace - retailer Category dimension. Layer: Core Dataset Category: Dimension Status: Published Primary Key: env_namespace, retailer_id, category_id, namespace Other Unique Key(s): category_key Partition: None Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = dim_category.env_namespace; dim_retailer on dim_retailer.env_namespace = dim_category.env_namespace and dim_retailer.retailer_id = dim_category.retailer_id and dim_retailer.is_current; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `category_key` | `STRING` | Unique identifier of the row in this table (surrogate key). | | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `category_id` | `STRING` | Category being targeted. | | `namespace` | `STRING` | Name of the Namespace. | | `category_label` | `STRING` | Label for the Category (more descriptive than the typical id provided). | | `cat_level_1` | `STRING` | Level 1 component of the category_label (delimited by >). | | `cat_level_2` | `STRING` | Level 2 component of the category_label (delimited by >). | | `cat_level_3` | `STRING` | Level 3 component of the category_label (delimited by >). | | `cat_level_4` | `STRING` | Level 4 component of the category_label (delimited by >). | | `cat_level_5` | `STRING` | Level 5 component of the category_label (delimited by >). | | `cat_level_6` | `STRING` | Level 6 component of the category_label (delimited by >). | | `cat_level_7` | `STRING` | Level 7 component of the category_label (delimited by >). | | `category_label_count` | `INTEGER` | Count(category_label) across env_namespace, retailer_id, category_id. | | `source_name` | `STRING` | Source name. | | `etl_created_at` | `TIMESTAMP` | Date the row was inserted into this table (not the date the record was created in the source system). | | `etl_modified_at` | `TIMESTAMP` | Date this row was last updated (not the date the record was updated in the source system). | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `min_bid_display` | `NUMERIC` | Minimum bid for display ads targeting this category (local currency). | | `min_bid_banner` | `NUMERIC` | Minimum bid for banner ads targeting this category (local currency). | | `min_bid_bannerx` | `NUMERIC` | Minimum bid for BannerX ads targeting this category (local currency). | # `analytics.dim_env_namespace` - namespace - retailer Namespace dimension. Layer: Core Dataset Category: Dimension Status: Published Primary Key: env, env_namespace Other Unique Key(s): env_namespace_key Partition: None Foreign Key(s): None | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env_namespace_key` | `STRING` | Unique identifier of the row in this table (surrogate key). | | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `geo_region` | `STRING` | Geographical region of the Namespace (as defined by CitrusAd). | | `local_timezone` | `STRING` | Not in use. | | `etl_created_at` | `TIMESTAMP` | Date the row was inserted into this table (not the date the record was created in the source system). | | `etl_modified_at` | `TIMESTAMP` | Date this row was last updated (not the date the record was updated in the source system). | | `zone_id` | `STRING` | Timezone (TZ) identifier standardised by IANA time zone database. | | `local_hour` | `NUMERIC` | Local hour. | | `enable_okta_login` | `BOOLEAN` | Flag to indicate if okta login is enabled. | | `enable_credit_card` | `BOOLEAN` | Flag to indicate if credit card transactions are enabled. | | `enabled_spend_types` | `STRING` | Spend types enabled in the system. | | `banner_enable_sales_metrics` | `BOOLEAN` | Flag to indicate if sales metrics are enabled on banner campaigns. | | `banner_enable_tracking_tags` | `BOOLEAN` | Flag to indicate if tracking tags are enabled on banner campaigns. | | `banner_enable_filter_targeting` | `BOOLEAN` | Flag to indicate if filter targeting is enabled on banner campaigns. | | `banner_enable_filter_whitelisting` | `BOOLEAN` | Flag to indicate if filter whitelisting is enabled on banner campaigns. | | `display_enable_sales_metrics` | `BOOLEAN` | Flag to indicate if sales metrics are enabled on display campaigns. | | `display_enable_tracking_tags` | `BOOLEAN` | Flag to indicate if tracking tags are enabled on display campaigns. | | `display_enable_filter_targeting` | `BOOLEAN` | Flag to indicate if filter targeting is enabled on display campaigns. | | `display_enable_filter_whitelisting` | `BOOLEAN` | Flag to indicate if filter whitelisting is enabled on display campaigns. | | `wildcard_enable_sales_metrics` | `BOOLEAN` | Flag to indicate if sales metrics are enabled on wildcard campaigns. | | `wildcard_enable_tracking_tags` | `BOOLEAN` | Flag to indicate if tracking tags are enabled on wildcard campaigns. | | `wildcard_enable_filter_targeting` | `BOOLEAN` | Flag to indicate if filter targeting is enabled on wildcard campaigns. | | `wildcard_enable_filter_whitelisting` | `BOOLEAN` | Flag to indicate if filter whitelisting is enabled on wildcard campaigns. | | `brand_page_enable_sales_metrics` | `BOOLEAN` | Flag to indicate if sales metrics are enabled on brand page campaigns. | | `brand_page_enable_tracking_tags` | `BOOLEAN` | Flag to indicate if tracking tags are enabled on brand page campaigns. | | `brand_page_enable_filter_targeting` | `BOOLEAN` | Flag to indicate if filter targeting is enabled on brand page campaigns. | | `brand_page_enable_filter_whitelisting` | `BOOLEAN` | Flag to indicate if filter whitelisting is enabled on brand page campaigns. | | `shotgun_banner_enable_sales_metrics` | `BOOLEAN` | Flag to indicate if sales metrics are enabled on shotgun banner campaigns. | | `shotgun_banner_enable_tracking_tags` | `BOOLEAN` | Flag to indicate if tracking tags are enabled on shotgun banner campaigns. | | `shotgun_banner_enable_filter_targeting` | `BOOLEAN` | Flag to indicate if filter targeting is enabled on shotgun banner campaigns. | | `shotgun_banner_enable_filter_whitelisting` | `BOOLEAN` | Flag to indicate if filter whitelisting is enabled on shotgun banner campaigns. | | `disabled_demographics` | `STRING` | Disabled Demographics. | | `disabled_economy_level` | `BOOLEAN` | Flag to indicate if economy level is disabled. | | `enable_category_min_bid` | `BOOLEAN` | Flag to indicate if category minimum bid is enabled. | | `include_retailer_t_and_c` | `BOOLEAN` | Flag to indicate if Retailer Terms and Conditions is included. | | `disabled_strategy_types` | `STRING` | Disabled Strategy Types. | | `enable_advanced_reports` | `BOOLEAN` | Flag to indicate if advanced reports are enabled. | | `enable_reporting_upc_fix` | `BOOLEAN` | Flag to indicate if reporting UPC fix is enabled. | | `can_group_products_by_code` | `BOOLEAN` | Flag to indicate if products can be grouped by code. | | `default_reporting_period` | `STRING` | Default reporting period. | | `enable_offsite_campaigns` | `BOOLEAN` | Flag to indicate if offsite Campaigns are enabled. | | `enable_search_term_min_bid` | `BOOLEAN` | Flag to indicate if search term minimum bid is enabled. | | `enable_campaign_templates` | `BOOLEAN` | Flag to indicate if Campaign templates is enabled. | | `enable_language_selection` | `BOOLEAN` | Flag to indicate if language selection is enabled. | | `enable_product_tag_manager` | `BOOLEAN` | Flag to indicate if product tag manager is enabled. | | `enable_daily_spend_rollover` | `BOOLEAN` | Flag to indicate if daily spend rollover is enabled. | | `product_metadata_selection` | `BOOLEAN` | Flag to indicate if metadata selection is enabled. | | `catalog_selection_reporting` | `BOOLEAN` | Flag to indicate if Catalog selection reporting is enabled. | | `enable_campaign_duplication` | `BOOLEAN` | Flag to indicate if campaign duplication is enabled. | | `enable_powered_by_citrus_icon` | `BOOLEAN` | Flag to indicate if Powered by Citrus is enabled. | | `enable_retailer_team_manager` | `BOOLEAN` | Flag to indicate if Retailer Team Manager is enabled. | | `enabled_search_term_measures` | `STRING` | Flag to indicate if search term measures is enabled. | | `max_banner_slots_per_campaign` | `INTEGER` | Maximum banner slots per Campaign. | | `enable_report_table_filtering` | `BOOLEAN` | Flag to indicate if report table filtering enabled. | | `enable_supplier_edit_team_info` | `BOOLEAN` | Flag to indicate if the platform enable Suppliers to edit team info. | | `disabled_search_term_match_type` | `BOOLEAN` | Flag to indicate if search term match type is disabled. | | `enable_search_term_collections` | `BOOLEAN` | Flag to indicate if search term collections is enabled. | | `enable_supplier_wallet_editing` | `BOOLEAN` | Flag to indicate if the platform enables Supplier to edit the wallets. | | `enable_external_user_management` | `BOOLEAN` | Flag to indicate if external user management is enabled. | | `enable_retailer_user_management` | `BOOLEAN` | Flag to indicate if Retailer user management is enabled. | | `enable_retailer_wallet_creation` | `BOOLEAN` | Flag to indicate if the platform enables Retailers to create wallets. | | `enable_supplier_wallet_creation` | `BOOLEAN` | Flag to indicate if the platform enables Supplier to create wallets. | | `enable_retailer_impression_share` | `BOOLEAN` | Flag to indicate if Retailer impression share is enabled. | | `enable_single_campaign_reporting` | `BOOLEAN` | Flag to indicate if single Campaign reporting is enabled. | | `enable_supplier_impression_share` | `BOOLEAN` | Flag to indicate if Supplier impression share is enabled. | | `enable_external_assets_management` | `BOOLEAN` | Flag to indicate if external assets management is enabled. | | `enable_retailer_wallet_management` | `BOOLEAN` | Flag to indicate if Retailer wallet management is enabled. | | `enable_supplier_wallet_daily_budget` | `BOOLEAN` | Flag to indicate if Supplier wallet daily budget is enabled. | | `enable_campaign_media_spend_document` | `BOOLEAN` | Flag to indicate if Campaign media spend document is enabled. | | `enable_retailer_campaign_management` | `BOOLEAN` | Flag to indicate if Retailer Campaign management is enabled. | | `enable_retailer_wallet_external_id_field` | `BOOLEAN` | Flag to indicate if Retailer wallet external ID is enabled. | | `enable_supplier_wallet_external_id_field` | `BOOLEAN` | Flag to indicate if Supplier wallet external ID is enabled. | | `enable_retailer_restricted_team_creation` | `BOOLEAN` | Flag to indicate if Retailer restricted team creation is enabled. | | `enable_report_table_filtering_by_product_tag` | `BOOLEAN` | Flag to indicate if report table filtering by product tag is enabled. | | `enable_retailer_wallet_credit_limit_management` | `BOOLEAN` | Flag to indicate if Retailer wallet credit limit management is enabled. | | `enable_retailer_to_view_supplier_campaign_reports` | `BOOLEAN` | Flag to indicate if the platform enables Retailer to view the Campaign report of Suppliers. | | `min_bid_display` | `NUMERIC` | Default minimum bid for display ads at namespace level (local currency). Used for validation only. | | `min_bid_banner` | `NUMERIC` | Default minimum bid for banner ads at namespace level (local currency). Used for validation only. | | `min_bid_bannerx` | `NUMERIC` | Default minimum bid for BannerX ads at namespace level (local currency). Used for validation only. | # `analytics.dim_placement` - namespace - retailer Placement dimension. Layer: Core Dataset Category: Dimension Status: Published Primary Key: env_namespace, placement_id Other Unique Key(s): placement_key Partition: None Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = dim_placement.env_namespace; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `placement_key` | `STRING` | Unique identifier of the row in this table (surrogate key). | | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `placement_id` | `STRING` | Internal identifier of the Placement (from the source system). | | `ad_gen_id` | `STRING` | Ad gen id. | | `archived` | `STRING` | Archived status of the Placement. | | `display_name` | `STRING` | Display name of the Placement. | | `campaign_target` | `STRING` | Campaign target. | | `catalog_ids` | `STRING` | Catalog ids. | | `campaign_types` | `STRING` | List of applicable campaign types. | | `namespace` | `STRING` | Name of the Namespace. | | `etl_created_at` | `TIMESTAMP` | Date the row was inserted into this table (not the date the record was created in the source system). | | `etl_modified_at` | `TIMESTAMP` | Date this row was last updated (not the date the record was updated in the source system). | | `enable_search_term_suggestions` | `BOOLEAN` | Enable search term suggestions feature flag. | | `allow_custom_search_terms` | `BOOLEAN` | Allow custom search term term feature flag. | | `search_term_type` | `STRING` | Custom search term type (if applicable). | | `search_term_type_label` | `STRING` | Custom search term type label (if applicable). | | `allow_targeted_categories_modified_by_user` | `BOOLEAN` | Feature flag for whether targeted categories are allowed to be modified by user. | | `allow_targeted_locations_modified_by_user` | `BOOLEAN` | Feature flag for whether targeted locations are allowed to be modified by user. | | `min_bid_display` | `NUMERIC` | Minimum bid for display ads on this placement (local currency). | | `min_bid_banner` | `NUMERIC` | Minimum bid for banner ads on this placement (local currency). | | `min_bid_bannerx` | `NUMERIC` | Minimum bid for BannerX ads on this placement (local currency). | | `charging_model` | `STRING` | Placement charging model (DEFAULT, CPI, CPC). | # `analytics.dim_product` - namespace - retailer Product dimension. Layer: Core Dataset Category: Dimension Status: Published Primary Key: normalised_product_code, product_code,catalog_id Other Unique Key(s): product_key Partition: None Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = dim_product.env_namespace; dim_retailer on dim_retailer.env_namespace = dim_product.env_namespace and dim_retailer.retailer_id = dim_product.retailer_id and dim_retailer.is_current; dim_catalog on dim_catalog.env_namespace = dim_product.env_namespace and dim_catalog.catalog_id = dim_product.catalog_id and dim_catalog.is_current; currency_aud on currency_aud.currency = dim_product.currency_code; currency_usd on currency_usd.currency = dim_product.currency_code; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `product_key` | `STRING` | Unique identifier of the row in this table (surrogate key). | | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `normalised_product_code` | `STRING` | Product code prefixed with leading zeros to be 16 characters long. | | `product_code` | `STRING` | Product code. | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `product_name` | `STRING` | Name of the Product. | | `product_type` | `STRING` | Type of the Product. | | `product_image_url` | `STRING` | URL to an image of the Product for the Ad. | | `retailer_name` | `STRING` | Name of the Retailer. | | `currency_code` | `STRING` | ISO 4217 currency code | | `product_tags` | `STRING` | Tags associated with the Product. | | `brand` | `STRING` | Brand of the Product. | | `google_product_taxonomy` | `STRING` | Google taxonomy (product hierarchy) of the Product. Levels of the hierarchy delimited using > symbol. | | `retailer_taxonomy` | `STRING` | Taxonomy (product hierarchy) of the Product as specified by the Retailer. | | `seller_id` | `STRING` | Seller that the Product is applicable for. | | `seller_name` | `STRING` | Name of the Seller id. | | `upc` | `STRING` | UPC of the Product. | | `inventory` | `STRING` | How much of the Product is in stock. | | `namespace` | `STRING` | Name of the Namespace. | | `is_deleted` | `BOOLEAN` | Flag to indicate that the record has been soft deleted in the source system. | | `etl_created_at` | `TIMESTAMP` | Date the row was inserted into this table (not the date the record was created in the source system). | | `etl_modified_at` | `TIMESTAMP` | Date this row was last updated (not the date the record was updated in the source system). | | `product_collection` | `STRING` | Product collections represent the parent product of a given product code. | | `is_product_collection` | `BOOLEAN` | Flag to indicate if product collection. | # `analytics.dim_retailer` - namespace - retailer Retailer dimension. Layer: Core Dataset Category: Dimension Status: Published Primary Key: retailer_id, row_version Other Unique Key(s): retailer_key Partition: None Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = dim_retailer.env_namespace; currency_aud on currency_aud.currency = dim_retailer.currency_code; currency_usd on currency_usd.currency = dim_retailer.currency_code; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `retailer_key` | `STRING` | Unique identifier of the row in this table (surrogate key). | | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `row_version` | `INTEGER` | Track changes with new row versions (sequentially increasing number to indicate chronology). | | `retailer_name` | `STRING` | Name of the Retailer. | | `team_type` | `STRING` | Type of Team (RETAILER). | | `company_name` | `STRING` | Company name of the Retailer. | | `business_identifier` | `STRING` | Implementation specific generic label. | | `industry` | `STRING` | Industry of the Retailer. | | `currency_code` | `STRING` | ISO 4217 currency code | | `ads_requested_cap` | `NUMERIC` | Max number of Product Ads that will be considered for reporting purposes per Ad Request (set per Retailer team, no setting means no cap will be imposed). | | `banner_ads_requested_cap` | `NUMERIC` | Max number of Banner Ads that will be considered for reporting purposes per Ad Request (set per Retailer team, no setting means no cap will be imposed). | | `reserved_search_terms` | `STRING` | Not in use. | | `global_suppress_flag` | `STRING` | Flag to indicate Retailer is to be excluded from reporting (eg test data). | | `view_attribution_window` | `NUMERIC` | Max number of days allowed between the Order and Realised Ad for View Thru Attribution. | | `click_attribution_window` | `NUMERIC` | Max number of days allowed between the Order and Realised Ad for Halo Click Attribution (1st model). | | `retailer_taxonomy_halo` | `STRING` | Comma separated list of what halo levels will be computed for model 1. | | `enhanced_attribution_flag` | `STRING` | If true, the first enhanced attribution model will be calculated. | | `enhanced_attribution_flag_2` | `STRING` | If true, the second enhanced attribution model will be calculated. | | `view_attribution_window_2` | `NUMERIC` | Max number of days allowed between the Order and Realised Ad for View Thru Attribution (2nd model). | | `click_attribution_window_2` | `NUMERIC` | Max number of days allowed between the Order and Realised Ad for Halo Click Attribution (2nd model). | | `retailer_taxonomy_halo_2` | `STRING` | Comma separated list of what halo levels will be computed for model 2. | | `attribution_time_frame` | `NUMERIC` | Determines how many days of attribution results should be stored for the first model. | | `attribution_time_frame_2` | `NUMERIC` | Determines how many days of attribution results should be stored for the second model. | | `retailer_group_1` | `STRING` | Retailer team group membership #1. | | `retailer_group_2` | `STRING` | Retailer team group membership #2. | | `namespace` | `STRING` | Name of the Namespace. | | `is_active` | `BOOLEAN` | Flag to indicate that the record is active in the source system. | | `is_deleted` | `BOOLEAN` | Flag to indicate that the record has been soft deleted in the source system. | | `is_current` | `BOOLEAN` | Flag if the row is the latest version in the source system. | | `created_at` | `TIMESTAMP` | Date the record was created in the source system. | | `created_at_utc` | `TIMESTAMP` | Currently the same as created_at since all data is in UTC. | | `updated_at` | `TIMESTAMP` | Date the record was updated in the source system. | | `updated_at_utc` | `TIMESTAMP` | Currently the same as updated_at since all data is in UTC. | | `etl_created_at` | `TIMESTAMP` | Date the row was inserted into this table (not the date the record was created in the source system). | | `etl_modified_at` | `TIMESTAMP` | Date this row was last updated (not the date the record was updated in the source system). | # `analytics.dim_search_term` - namespace - retailer Search Term dimension. Layer: Core Dataset Category: Dimension Status: Published Primary Key: env_namespace, retailer_id, search_term Other Unique Key(s): search_term_key Partition: None Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = dim_search_term.env_namespace; dim_retailer on dim_retailer.env_namespace = dim_search_term.env_namespace and dim_retailer.retailer_id = dim_search_term.retailer_id and dim_retailer.is_current; currency_aud on currency_aud.currency = dim_search_term.currency_code; currency_usd on currency_usd.currency = dim_search_term.currency_code; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `search_term_key` | `STRING` | Unique identifier of the row in this table (surrogate key). | | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `search_term` | `STRING` | The word/phrase being searched for on the retailer site by the end user. | | `num_ad_requests` | `INTEGER` | Total number of Requests. | | `num_realised_ads` | `INTEGER` | Total number of Ads realised. | | `ad_request_rank` | `INTEGER` | Rank of the Search Term by total Requests. | | `ad_stat_rank` | `INTEGER` | Rank of the Search Term by total Ads realised. | | `etl_created_at` | `TIMESTAMP` | Date the row was inserted into this table (not the date the record was created in the source system). | | `etl_modified_at` | `TIMESTAMP` | Date this row was last updated (not the date the record was updated in the source system). | # `analytics.dim_supplier` - namespace - retailer Supplier dimension. Layer: Core Dataset Category: Dimension Status: Published Primary Key: supplier_id, row_version, env_namespace Other Unique Key(s): supplier_key Partition: None Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = dim_supplier.env_namespace; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `supplier_key` | `STRING` | Unique identifier of the row in this table (surrogate key). | | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `supplier_id` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `row_version` | `INTEGER` | Track changes with new row versions (sequentially increasing number to indicate chronology). | | `supplier_name` | `STRING` | Name of the Supplier. | | `team_type` | `STRING` | Type of Team (SUPPLIER). | | `company_name` | `STRING` | Company name of the Supplier. | | `business_identifier` | `STRING` | Implementation specific generic label. | | `industry` | `STRING` | Industry of the Supplier. | | `supplier_group_1` | `STRING` | Supplier team group membership #1. | | `supplier_group_2` | `STRING` | Supplier team group membership #2. | | `supplier_group_3` | `STRING` | Supplier team group membership #3. | | `supplier_group_4` | `STRING` | Supplier team group membership #4. | | `namespace` | `STRING` | Name of the Namespace. | | `is_active` | `BOOLEAN` | Flag to indicate that the record is active in the source system. | | `is_deleted` | `BOOLEAN` | Flag to indicate that the record has been soft deleted in the source system. | | `is_current` | `BOOLEAN` | Flag if the row is the latest version in the source system. | | `created_at` | `TIMESTAMP` | Date the record was created in the source system. | | `created_at_utc` | `TIMESTAMP` | Currently the same as created_at since all data is in UTC. | | `updated_at` | `TIMESTAMP` | Date the record was updated in the source system. | | `updated_at_utc` | `TIMESTAMP` | Currently the same as updated_at since all data is in UTC. | | `etl_created_at` | `TIMESTAMP` | Date the row was inserted into this table (not the date the record was created in the source system). | | `etl_modified_at` | `TIMESTAMP` | Date this row was last updated (not the date the record was updated in the source system). | # `analytics.dim_team` - namespace - retailer Team dimension. Layer: Core Dataset Category: Dimension Status: Published Primary Key: team_id, row_version, env_namespace Other Unique Key(s): team_key Partition: None Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = dim_team.env_namespace; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `team_key` | `STRING` | Unique identifier of the row in this table (surrogate key). | | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `team_id` | `STRING` | Internal identifier of the Team (from the source system). | | `row_version` | `INTEGER` | Track changes with new row versions (sequentially increasing number to indicate chronology). | | `team_name` | `STRING` | Name of the Team. | | `team_type` | `STRING` | Type of Team (RETAILER or SUPPLIER). | | `company_name` | `STRING` | Company name of the Team. | | `business_identifier` | `STRING` | Implementation specific generic label. | | `industry` | `STRING` | Industry of the Team. | | `user_id` | `STRING` | Internal identifier of the User (from the source system). | | `last_campaign_created_id` | `STRING` | Internal identifier of the Campaign last created by the Team (from the source system). | | `last_campaign_created_date` | `TIMESTAMP` | Date the Team created the most recent Campaign. | | `last_campaign_updated_id` | `STRING` | Internal identifier of the Campaign last modified by the Team (from the source system). | | `last_campaign_updated_date` | `TIMESTAMP` | Date the Team updated the most recent Campaign. | | `total_campaigns` | `INTEGER` | Total number of Campaigns associated with Team (including inactive). | | `total_active_campaigns` | `INTEGER` | Total active Campaigns associated with the Team. | | `total_spend` | `NUMERIC` | Total AdSpend to date for the Team across all Campaigns. | | `last_spend_date` | `DATE` | Most recent date that AdSpend was incurred by the Supplier. | | `namespace` | `STRING` | Name of the Namespace. | | `is_active` | `BOOLEAN` | Flag to indicate that the record is active in the source system. | | `is_deleted` | `BOOLEAN` | Flag to indicate that the record has been soft deleted in the source system. | | `is_current` | `BOOLEAN` | Flag if the row is the latest version in the source system. | | `created_at` | `TIMESTAMP` | Date the record was created in the source system. | | `created_at_utc` | `TIMESTAMP` | Currently the same as created_at since all data is in UTC. | | `updated_at` | `TIMESTAMP` | Date the record was updated in the source system. | | `updated_at_utc` | `TIMESTAMP` | Currently the same as updated_at since all data is in UTC. | | `etl_created_at` | `TIMESTAMP` | Date the row was inserted into this table (not the date the record was created in the source system). | | `etl_modified_at` | `TIMESTAMP` | Date this row was last updated (not the date the record was updated in the source system). | | `phone` | `STRING` | The company phone number | | `company_website` | `STRING` | The company website | | `company_address_line_1` | `STRING` | The company address | | `company_address_post_code` | `STRING` | Post code of the company address | | `contact_email` | `STRING` | Email address of the company contact | | `seller_id` | `STRING` | Retailer managed surrogate id for a supplier team | | `ad_financer` | `STRING` | Entity paying for advertisements (from onBehalfOf in team payload). | # `analytics.dim_user` - namespace - retailer User dimension. Layer: Core Dataset Category: Dimension Status: Published Primary Key: user_id, row_version, env_namespace Other Unique Key(s): user_key Partition: None Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = dim_user.env_namespace; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `user_key` | `STRING` | Unique identifier of the row in this table (surrogate key). | | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `user_id` | `STRING` | Internal identifier of the User (from the source system). | | `row_version` | `INTEGER` | Track changes with new row versions (sequentially increasing number to indicate chronology). | | `admin` | `STRING` | Flag if the User is an administrator. | | `email` | `STRING` | User's email address. | | `user_name` | `STRING` | Name of the User. | | `activated` | `BOOLEAN` | Flag indicating that a User has activated their account. | | `system_permissions` | `STRING` | User system permissions. | | `action_permission` | `STRING` | User action permissions. | | `subject_permission` | `STRING` | User subject permissions. | | `namespace` | `STRING` | Name of the Namespace. | | `is_active` | `BOOLEAN` | Flag to indicate that the record is active in the source system. | | `is_deleted` | `BOOLEAN` | Flag to indicate that the record has been soft deleted in the source system. | | `is_current` | `BOOLEAN` | Flag if the row is the latest version in the source system. | | `created_at` | `TIMESTAMP` | Date the record was created in the source system. | | `created_at_utc` | `TIMESTAMP` | Currently the same as created_at since all data is in UTC. | | `updated_at` | `TIMESTAMP` | Date the record was updated in the source system. | | `updated_at_utc` | `TIMESTAMP` | Currently the same as updated_at since all data is in UTC. | | `etl_created_at` | `TIMESTAMP` | Date the row was inserted into this table (not the date the record was created in the source system). | | `etl_modified_at` | `TIMESTAMP` | Date this row was last updated (not the date the record was updated in the source system). | # `analytics.dim_wallet` - namespace - retailer Wallet dimension. Layer: Core Dataset Category: Dimension Status: Published Primary Key: wallet_id, env_namespace Other Unique Key(s): wallet_key Partition: None Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = dim_wallet.env_namespace; dim_team on dim_team.env_namespace = dim_wallet.env_namespace and dim_team.team_id = dim_wallet.wallet_team_id and dim_team.is_current; currency_aud on currency_aud.currency = dim_wallet.currency_code; currency_usd on currency_usd.currency = dim_wallet.currency_code; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `wallet_key` | `STRING` | Unique identifier of the row in this table (surrogate key). | | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `wallet_id` | `STRING` | Internal identifier of the Wallet (from the source system). | | `wallet_team_id` | `STRING` | Internal identifier of the Team (from the source system). | | `external_id` | `STRING` | Implementation specific generic label. | | `wallet_name` | `STRING` | Name of the Wallet. | | `team_name` | `STRING` | Name of the Team. | | `archived` | `BOOLEAN` | Archived status of the Wallet. | | `credit_limit` | `NUMERIC` | Amount the Wallet may go into credit. | | `currency_code` | `STRING` | ISO 4217 currency code | | `default_wallet` | `BOOLEAN` | Flag indicating if this is the default Wallet. | | `prepaid_balance` | `NUMERIC` | Prepaid balance of the Wallet. | | `available_balance` | `NUMERIC` | Current available balance of the Wallet. | | `total_purchased_credits` | `NUMERIC` | Total credits made to the Wallet. | | `latest_top_up_amount` | `NUMERIC` | Amount of the most recent credit applied to the Wallet. | | `earliest_top_up_amount` | `NUMERIC` | Earliest credit amount made against the Wallet. | | `largest_top_up_amount` | `NUMERIC` | Largest credit amount made against the Wallet. | | `smallest_top_up_amount` | `NUMERIC` | Smallest credit amount made against the Wallet. | | `average_top_up_amount` | `NUMERIC` | Average of credits applied to the Wallet. | | `credit_limit_usd` | `NUMERIC` | credit_limit in USD (current exchange rate only). | | `total_purchased_credits_usd` | `NUMERIC` | total_purchased_credits in USD (current exchange rate only). | | `available_balance_usd` | `NUMERIC` | available_balance in USD (current exchange rate only). | | `prepaid_balance_usd` | `NUMERIC` | prepaid_balance in USD (current exchange rate only). | | `latest_top_up_amount_usd` | `NUMERIC` | latest_top_up_amount in USD (current exchange rate only). | | `earliest_top_up_amount_usd` | `NUMERIC` | earliest_top_up_amount in USD (current exchange rate only). | | `largest_top_up_amount_usd` | `NUMERIC` | largest_top_up_amount in USD (current exchange rate only). | | `smallest_top_up_amount_usd` | `NUMERIC` | smallest_top_up_amount in USD (current exchange rate only). | | `average_top_up_amount_usd` | `NUMERIC` | average_top_up_amount in USD (current exchange rate only). | | `active_campaign_count` | `NUMERIC` | Number of currently active Campaigns associated to the Wallet. | | `active_campaign_max_total_spend` | `NUMERIC` | Aggregate CampaignMaxTotalSpend for all currently active Campaigns associated to the Wallet. | | `namespace` | `STRING` | Name of the Namespace. | | `earliest_credit_date` | `TIMESTAMP` | Most recent date a credit was made to the Wallet. | | `earliest_credit_date_utc` | `TIMESTAMP` | Currently the same as earliest_credit_date since all data is in UTC. | | `latest_credit_date` | `TIMESTAMP` | Date of the most recent credit. | | `latest_credit_date_utc` | `TIMESTAMP` | Currently the same as latest_credit_date since all data is in UTC. | | `wallet_capture_date` | `TIMESTAMP` | Date the Wallet details were captured on. | | `wallet_capture_date_utc` | `TIMESTAMP` | Currently the same as wallet_capture_date since all data is in UTC. | | `etl_created_at` | `TIMESTAMP` | Date the row was inserted into this table (not the date the record was created in the source system). | | `etl_modified_at` | `TIMESTAMP` | Date this row was last updated (not the date the record was updated in the source system). | | `daily_limit` | `NUMERIC` | Amount the Wallet may go into credit in a day. | | `capped_available_balance` | `NUMERIC` | Current capped available balance of the Wallet. | # `analytics.fact_ad_request` - namespace - retailer Request fact (full detail). Layer: Core Dataset Category: Fact Status: Published Primary Key: request_trace_id, request_type Other Unique Key(s): ad_request_key Partition: ingressed_at (by DAY) Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = fact_ad_request.env_namespace; dim_retailer on dim_retailer.env_namespace = fact_ad_request.env_namespace and dim_retailer.retailer_id = fact_ad_request.retailer_id and dim_retailer.is_current; dim_catalog on dim_catalog.env_namespace = fact_ad_request.env_namespace and dim_catalog.catalog_id = fact_ad_request.catalog_id and dim_catalog.is_current; dim_placement on dim_placement.env_namespace = fact_ad_request.env_namespace and dim_placement.placement_id = fact_ad_request.placement_id; dim_search_term on dim_search_term.env_namespace = fact_ad_request.env_namespace and dim_search_term.retailer_id = fact_ad_request.retailer_id and dim_search_term.search_term = fact_ad_request.search_term; dim_category on dim_category.env_namespace=fact_ad_request.env_namespace and dim_category.category_id=fact_ad_request.category and dim_category.retailer_id = fact_ad_request.retailer_id; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `ad_request_key` | `STRING` | Unique identifier of the row in this table (surrogate key). | | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `request_trace_id` | `STRING` | Request trace id. | | `request_type` | `INTEGER` | Request type. | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `customer_id` | `STRING` | Customer identifier as provided by the Retailer (as in loyalty number etc, where available). Sometimes used for Attribution. | | `session_id` | `STRING` | Customer identifier as provided by the Retailer (often tied to a browser session, but is implementation specific). Normally used for Attribution (so must be persistent across the attribution window). | | `placement_id` | `STRING` | Internal identifier of the Placement (from the source system). | | `realised_ad_ids` | `STRING` | Internal identifiers of the Realised Ads associated to the Ad Request (ids from the source system). | | `ingressed_at` | `TIMESTAMP` | Timestamp the Requests were received. | | `ingressed_at_utc` | `TIMESTAMP` | Currently the same as ingressed_at since all data is in UTC. | | `search_term` | `STRING` | The word/phrase being searched for on the retailer site by the end user. | | `reserved_search_term_flag` | `STRING` | Not in use. | | `placement` | `STRING` | Display name of the Placement. | | `platform` | `STRING` | The platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter. | | `page_type` | `INTEGER` | Legacy, superseded by Placement. | | `filter_mode` | `INTEGER` | The filterMode used to structure the productFilters in the ad request. Defaults in OR_AND if not specified. (OR_AND, AND_OR). | | `slot_ids` | `STRING` | Slot ids. | | `category` | `STRING` | Category being targeted. | | `product_type_code` | `STRING` | Product type code. | | `location` | `STRING` | Location. | | `namespace` | `STRING` | Name of the Namespace. | | `experiment_id` | `STRING` | Not in use. | | `num_ads_considered` | `NUMERIC` | Total number of Ad candidates that were considered by relevancy algorithms. | | `num_ads_served` | `NUMERIC` | Total number of Ads that were served back. | | `num_ads_requested` | `NUMERIC` | Total number of Ads that were requested by the Requests. | | `capped_num_ads_served` | `NUMERIC` | Total number of Ads that were served back with Cap applied per Request. | | `capped_num_ads_requested` | `NUMERIC` | Total number of Ads that were requested with Cap applied per Request. | | `capped_num_requests_serving_max_ads` | `NUMERIC` | Total number of Requests where the Capped number of Ads requested was served in full. | | `num_requests_serving_max_ads` | `NUMERIC` | Total number of Requests where the number of Ads requested was served in full. | | `num_ad_requests_serving_no_ads` | `NUMERIC` | Total number of Requests where no Ads were served. | | `num_ad_requests_serving_some_ads` | `NUMERIC` | Total number of Requests where at least 1 Ad was served. | | `num_ad_requests` | `NUMERIC` | Total number of Requests. | | `num_ad_requests_with_saturation` | `NUMERIC` | Total number of Requests that served at least 4 Ads or filled the entire Request (if < 4 were requested). | | `etl_created_at` | `TIMESTAMP` | Date the row was inserted into this table (not the date the record was created in the source system). | | `etl_modified_at` | `TIMESTAMP` | Date this row was last updated (not the date the record was updated in the source system). | | `dtm_cookie_id` | `STRING` | Customer identifier as provided by the Retailer (often tied to a browser cookie, but is implementation specific). Normally used for Attribution (so must be persistent across the attribution window). | | `flattened_filters` | `STRING` | Array of filter values in type:value format (e.g., category:groceries, platform:ios). | | `cap_type` | `STRING` | The type of cap configured for the retailer. | | `cap` | `NUMERIC` | Number of ads that can be requested. | # `analytics.fact_ad_request_agg` - namespace - retailer Request fact (aggregated). Layer: Core Dataset Category: Fact Status: Published Primary Key: ingressed_at, env_namespace, catalog_id, retailer_id, request_type, search_term, reserved_search_term_flag, generic_search_term, placement, platform, page_type, filter_mode, slot_ids, category, placement_id, namespace Other Unique Key(s): ad_request_agg_key Partition: ingressed_at (by DAY) Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = fact_ad_request_agg.env_namespace; dim_retailer on dim_retailer.env_namespace = fact_ad_request_agg.env_namespace and dim_retailer.retailer_id = fact_ad_request_agg.retailer_id and dim_retailer.is_current; dim_catalog on dim_catalog.env_namespace = fact_ad_request_agg.env_namespace and dim_catalog.catalog_id = fact_ad_request_agg.catalog_id and dim_catalog.is_current; dim_placement on dim_placement.env_namespace = fact_ad_request_agg.env_namespace and dim_placement.placement_id = fact_ad_request_agg.placement_id; dim_search_term on dim_search_term.env_namespace = fact_ad_request_agg.env_namespace and dim_search_term.retailer_id = fact_ad_request_agg.retailer_id and dim_search_term.search_term = fact_ad_request_agg.search_term; dim_category on dim_category.env_namespace = fact_ad_request_agg.env_namespace and dim_category.category_id = fact_ad_request_agg.category and dim_category.retailer_id = fact_ad_request_agg.retailer_id Time Series Column: ingressed_at Aggregation Details: Source tables(s): fact_ad_request (group by env, namespace, env_namespace, ingressed_at, retailer_id, catalog_id, search_term, placement, platform, reserved_search_term_flag, generic_search_term, request_type,page_type, filter_mode, slot_ids,category, placement_id) | Column Name | Data Type | Description | |-------------|-----------|-------------| | `ad_request_agg_key` | `STRING` | Unique identifier of the row in this table (surrogate key). | | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `ingressed_at` | `DATE` | Date the Requests were received. | | `request_type` | `INTEGER` | Request type. | | `search_term` | `STRING` | The word/phrase being searched for on the retailer site by the end user. | | `reserved_search_term_flag` | `STRING` | Not in use. | | `generic_search_term` | `STRING` | Same as SearchTerm except leading and trailing whitespace is removed to improve consolidation. | | `placement` | `STRING` | Display name of the Placement. | | `platform` | `STRING` | The platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter. | | `page_type` | `INTEGER` | Legacy, superseded by Placement. | | `filter_mode` | `INTEGER` | The filterMode used to structure the productFilters in the ad request. Defaults in OR_AND if not specified. (OR_AND, AND_OR). | | `slot_ids` | `STRING` | Slot ids. | | `category` | `STRING` | Category being targeted. | | `namespace` | `STRING` | Name of the Namespace. | | `num_ads_considered` | `NUMERIC` | Total number of Ad candidates that were considered by relevancy algorithms. | | `num_ads_served` | `NUMERIC` | Total number of Ads that were served back. | | `num_ads_requested` | `NUMERIC` | Total number of Ads that were requested by the Requests. | | `capped_num_ads_served` | `NUMERIC` | Total number of Ads that were served back with Cap applied per Request. | | `capped_num_ads_requested` | `NUMERIC` | Total number of Ads that were requested with Cap applied per Request. | | `capped_num_requests_serving_max_ads` | `NUMERIC` | Total number of Requests where the number of Ads requested was served in full. | | `num_requests_serving_max_ads` | `NUMERIC` | Total number of Requests where the number of Ads requested was served in full. | | `num_ad_requests_serving_no_ads` | `NUMERIC` | Total number of Requests where no Ads were served. | | `num_ad_requests_serving_some_ads` | `NUMERIC` | Total number of Requests where at least 1 Ad was served. | | `num_ad_requests` | `NUMERIC` | Total number of Requests. | | `num_ad_requests_with_saturation` | `NUMERIC` | Total number of Requests that served at least 4 Ads or filled the entire Request (if < 4 were requested). | | `etl_created_at` | `TIMESTAMP` | Date the row was inserted into this table (not the date the record was created in the source system). | | `etl_modified_at` | `TIMESTAMP` | Date this row was last updated (not the date the record was updated in the source system). | | `placement_id` | `STRING` | Internal identifier of the Placement (from the source system). | # `analytics.fact_ad_request_agg_ltz` - namespace - retailer Request fact (aggregated) in local timezone. Layer: Core Dataset Category: Fact Status: Published Primary Key: ingressed_at, env_namespace, catalog_id, retailer_id, request_type, search_term, reserved_search_term_flag, generic_search_term, placement, platform, page_type, filter_mode, slot_ids, category, placement_id, namespace Other Unique Key(s): ad_request_agg_key Partition: ingressed_at (by DAY) Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = fact_ad_request_agg.env_namespace; dim_retailer on dim_retailer.env_namespace = fact_ad_request_agg.env_namespace and dim_retailer.retailer_id = fact_ad_request_agg.retailer_id and dim_retailer.is_current; dim_catalog on dim_catalog.env_namespace = fact_ad_request_agg.env_namespace and dim_catalog.catalog_id = fact_ad_request_agg.catalog_id and dim_catalog.is_current; dim_placement on dim_placement.env_namespace = fact_ad_request_agg.env_namespace and dim_placement.placement_id = fact_ad_request_agg.placement_id; dim_search_term on dim_search_term.env_namespace = fact_ad_request_agg.env_namespace and dim_search_term.retailer_id = fact_ad_request_agg.retailer_id and dim_search_term.search_term = fact_ad_request_agg.search_term; dim_category on dim_category.env_namespace = fact_ad_request_agg.env_namespace and dim_category.category_id = fact_ad_request_agg.category and dim_category.retailer_id = fact_ad_request_agg.retailer_id Time Series Column: ingressed_at Aggregation Details: Source tables(s): fact_ad_request (group by env, namespace, env_namespace, ingressed_at, retailer_id, catalog_id, search_term, placement, platform, reserved_search_term_flag, generic_search_term, request_type,page_type, filter_mode, slot_ids,category, placement_id) | Column Name | Data Type | Description | |-------------|-----------|-------------| | `ad_request_agg_key` | `STRING` | Unique identifier of the row in this table (surrogate key). | | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `ingressed_at` | `DATE` | Date the Requests were received in local timezone. | | `request_type` | `INTEGER` | Request type. | | `search_term` | `STRING` | The word/phrase being searched for on the retailer site by the end user. | | `reserved_search_term_flag` | `STRING` | Not in use. | | `generic_search_term` | `STRING` | Same as SearchTerm except leading and trailing whitespace is removed to improve consolidation. | | `placement` | `STRING` | Display name of the Placement. | | `platform` | `STRING` | The platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter. | | `page_type` | `INTEGER` | Legacy, superseded by Placement. | | `filter_mode` | `INTEGER` | The filterMode used to structure the productFilters in the ad request. Defaults in OR_AND if not specified. (OR_AND, AND_OR). | | `slot_ids` | `STRING` | Slot ids. | | `category` | `STRING` | Category being targeted. | | `namespace` | `STRING` | Name of the Namespace. | | `num_ads_considered` | `NUMERIC` | Total number of Ad candidates that were considered by relevancy algorithms. | | `num_ads_served` | `NUMERIC` | Total number of Ads that were served back. | | `num_ads_requested` | `NUMERIC` | Total number of Ads that were requested by the Requests. | | `capped_num_ads_served` | `NUMERIC` | Total number of Ads that were served back with Cap applied per Request. | | `capped_num_ads_requested` | `NUMERIC` | Total number of Ads that were requested with Cap applied per Request. | | `capped_num_requests_serving_max_ads` | `NUMERIC` | Total number of Requests where the number of Ads requested was served in full. | | `num_requests_serving_max_ads` | `NUMERIC` | Total number of Requests where the number of Ads requested was served in full. | | `num_ad_requests_serving_no_ads` | `NUMERIC` | Total number of Requests where no Ads were served. | | `num_ad_requests_serving_some_ads` | `NUMERIC` | Total number of Requests where at least 1 Ad was served. | | `num_ad_requests` | `NUMERIC` | Total number of Requests. | | `num_ad_requests_with_saturation` | `NUMERIC` | Total number of Requests that served at least 4 Ads or filled the entire Request (if < 4 were requested). | | `etl_created_at` | `TIMESTAMP` | Date the row was inserted into this table (not the date the record was created in the source system). | | `etl_modified_at` | `TIMESTAMP` | Date this row was last updated (not the date the record was updated in the source system). | | `placement_id` | `STRING` | Internal identifier of the Placement (from the source system). | # `analytics.fact_enhanced_attribution` - namespace - retailer Enhanced Attribution (full detail, first model only). Layer: Core Dataset Category: Fact Status: Published Primary Key: env_namespace, realised_ad_id, retailer_order_id, order_item_id, session_id, campaign_id, category_id, normalised_product_code, product_code, retailer_taxonomy, halo_taxonomy, halo_taxonomy_level Other Unique Key(s): enhanced_attribution_key Partition: ingressed_at (by DAY) Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = fact_enhanced_attribution.env_namespace; dim_retailer on dim_retailer.env_namespace = fact_enhanced_attribution.env_namespace and dim_retailer.retailer_id = fact_enhanced_attribution.retailer_id and dim_retailer.is_current; dim_campaign on dim_campaign.env_namespace = fact_enhanced_attribution.env_namespace and dim_campaign.campaign_id = fact_enhanced_attribution.campaign_id and dim_campaign.is_current; dim_product on dim_product.env_namespace = fact_enhanced_attribution.env_namespace and dim_product.product_code = fact_enhanced_attribution.product_code ; dim_search_term on dim_search_term.env_namespace = fact_enhanced_attribution.env_namespace and dim_search_term.retailer_id = fact_enhanced_attribution.retailer_id and dim_search_term.search_term = fact_enhanced_attribution.search_term; dim_category on dim_category.env_namespace = fact_enhanced_attribution.env_namespace and dim_category.category_id = fact_enhanced_attribution.category and dim_category.retailer_id = fact_enhanced_attribution.retailer_id; dim_placement on dim_placement.env_namespace = fact_enhanced_attribution.env_namespace and dim_placement.placement = fact_enhanced_attribution.placement; fact_realised_ad on fact_realised_ad.env_namespace = fact_enhanced_attribution.env_namespace and fact_realised_ad.realised_ad_id = fact_enhanced_attribution.realised_ad_id; fact_order on on fact_order.env_namespace = fact_enhanced_attribution.env_namespace and fact_order.retailer_order_id = fact_enhanced_attribution.retailer_order_id and fact_order.order_item_id = fact_enhanced_attribution.retailer_order_id ; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `enhanced_attribution_key` | `STRING` | Unique identifier of the row in this table (surrogate key). | | `env` | `STRING` | Environment the Namespace is deployed in. | | `namespace` | `STRING` | Name of the Namespace. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `realised_ad_id` | `STRING` | Internal identifier of the Realised Ad the Conversion is Attributed to. | | `campaign_id` | `STRING` | Internal identifier of the Campaign (from the source system). | | `session_id` | `STRING` | Customer identifier as provided by the Retailer (often tied to a browser session, but is implementation specific). Normally used for Attribution (so must be persistent across the attribution window). | | `normalised_product_code` | `STRING` | Product code prefixed with leading zeros to be 16 characters long. | | `product_code` | `STRING` | Product code. | | `product_name` | `STRING` | Name of the Product. | | `brand` | `STRING` | Brand of the Product. | | `retailer_taxonomy` | `STRING` | Taxonomy (product hierarchy) of the Product as specified by the Retailer. | | `halo_taxonomy` | `STRING` | The portion of the retailer_taxonomy relevant for the given halo_taxonomy_level. Note for halo_taxonomy_level=1 it is null since the Brand is level 1. | | `halo_taxonomy_level` | `INTEGER` | Halo level number (1-9). 1 = Brand level halo, Levels 2-9 are the HaloTaxonomy component, 9 being the specific Product Code (SKU). | | `ingressed_at` | `TIMESTAMP` | Timestamp the Requests were received. | | `impressioned_at` | `TIMESTAMP` | Timestamp the impression occurred. | | `clicked_at` | `TIMESTAMP` | Timestamp of the Click. | | `impressioned` | `BOOLEAN` | Flag indicating an impression. | | `clicked` | `BOOLEAN` | Flag indicating if clicked. | | `purchased` | `BOOLEAN` | Total number of purchases. | | `search_term` | `STRING` | The word/phrase being searched for on the retailer site by the end user. | | `category_id` | `STRING` | Category being targeted. | | `placement` | `STRING` | Display name of the Placement. | | `platform` | `STRING` | The platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter. | | `page_type` | `INTEGER` | Legacy, superseded by Placement. | | `order_date` | `DATE` | Date of the Orders. | | `retailer_order_id` | `STRING` | Identifier of the Order the Conversion is Attributed to. | | `order_item_id` | `STRING` | Line item of the Order the Conversion is Attributed to. | | `order_product_code` | `STRING` | Order Product code. | | `order_normalised_product` | `STRING` | Normalised Product code of the Order. | | `customer_id` | `STRING` | Customer identifier as provided by the Retailer (often tied to a browser session, but is implementation specific). Normally used for Attribution (so must be persistent across the attribution window). | | `order_type` | `STRING` | Type of the Order. | | `impressions` | `NUMERIC` | Total impressions. | | `clicks` | `NUMERIC` | Number of Clicks. | | `ad_spend` | `NUMERIC` | Local currency amount charged by the Retailer to the Supplier for the Realised Ads. | | `direct_unit_sales` | `NUMERIC` | Unit sales from CitrusAd platform Attributions. | | `direct_sales_value` | `NUMERIC` | Revenue from CitrusAd platform Attributions. | | `direct_conversions` | `NUMERIC` | Conversions from CitrusAd platform Attributions. | | `view_through_unit_sales` | `NUMERIC` | Unit sales from Impression View Thru Attributions. | | `view_through_sales_value` | `NUMERIC` | Revenue from Impression View Thru Attributions. | | `view_through_conversions` | `NUMERIC` | Conversions from Impression View Thru Attributions. | | `halo_unit_sales` | `NUMERIC` | Unit sales from halo click Attributions. | | `halo_sales_value` | `NUMERIC` | Revenue from halo click Attributions. | | `halo_conversions` | `NUMERIC` | Conversions from halo click Attributions. | | `row_type` | `STRING` | Row Type. | | `etl_created_at` | `TIMESTAMP` | Date the row was inserted into this table (not the date the record was created in the source system). | | `etl_modified_at` | `TIMESTAMP` | Date this row was last updated (not the date the record was updated in the source system). | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `imp_halo_unit_sales` | `NUMERIC` | Unit sales from halo impression Attributions. | | `imp_halo_sales_value` | `NUMERIC` | Revenue from halo impression Attributions. | | `imp_halo_conversions` | `NUMERIC` | Conversions from halo impression Attributions. | | `keyword` | `STRING` | The word/phrase being targeted by the campaign - set by the advertiser. | | `placement_id` | `STRING` | Internal identifier of the Placement (from the source system). | | `wallet_id` | `STRING` | Internal identifier of the Wallet (from the source system). | | `attributable_impressions` | `NUMERIC` | Subset of impressions that are considered attributable. | | `attributable_clicks` | `NUMERIC` | Subset of clicks that are considered attributable. | | `attributable_ad_spend` | `NUMERIC` | Subset of ad spend that is considered attributable. | | `attribution_type` | `STRING` | The type of attribution applied to the conversion (e.g. click-based, impression-based). | # `analytics.fact_enhanced_attribution_2` - namespace - retailer Enhanced Attribution (full detail, second model only). Layer: Core Dataset Category: Fact Status: Published Primary Key: env_namespace, realised_ad_id, retailer_order_id, order_item_id, session_id, campaign_id, category_id, normalised_product_code, product_code, retailer_taxonomy, halo_taxonomy, halo_taxonomy_level Other Unique Key(s): enhanced_attribution_2_key Partition: ingressed_at (by DAY) Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = fact_enhanced_attribution_2.env_namespace; dim_retailer on dim_retailer.env_namespace = fact_enhanced_attribution_2.env_namespace and dim_retailer.retailer_id = fact_enhanced_attribution_2.retailer_id and dim_retailer.is_current; dim_campaign on dim_campaign.env_namespace = fact_enhanced_attribution_2.env_namespace and dim_campaign.campaign_id = fact_enhanced_attribution_2.campaign_id and dim_campaign.is_current; dim_product on dim_product.env_namespace = fact_enhanced_attribution_2.env_namespace and dim_product.product_code = fact_enhanced_attribution_2.product_code ; dim_search_term on dim_search_term.env_namespace = fact_enhanced_attribution_2.env_namespace and dim_search_term.retailer_id = fact_enhanced_attribution_2.retailer_id and dim_search_term.search_term = fact_enhanced_attribution_2.search_term; dim_category on dim_category.env_namespace = fact_enhanced_attribution_2.env_namespace and dim_category.category_id = fact_enhanced_attribution_2.category and dim_category.retailer_id = fact_enhanced_attribution_2.retailer_id; dim_placement on dim_placement.env_namespace = fact_enhanced_attribution_2.env_namespace and dim_placement.placement = fact_enhanced_attribution_2.placement; fact_realised_ad on fact_realised_ad.env_namespace = fact_enhanced_attribution_2.env_namespace and fact_realised_ad.realised_ad_id = fact_enhanced_attribution_2.realised_ad_id; fact_order on on fact_order.env_namespace = fact_enhanced_attribution_2.env_namespace and fact_order.retailer_order_id = fact_enhanced_attribution_2.retailer_order_id and fact_order.order_item_id = fact_enhanced_attribution_2.retailer_order_id; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `enhanced_attribution_2_key` | `STRING` | Unique identifier of the row in this table (surrogate key). | | `env` | `STRING` | Environment the Namespace is deployed in. | | `namespace` | `STRING` | Name of the Namespace. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `realised_ad_id` | `STRING` | Internal identifier of the Realised Ad the Conversion is Attributed to. | | `campaign_id` | `STRING` | Internal identifier of the Campaign (from the source system). | | `session_id` | `STRING` | Customer identifier as provided by the Retailer (often tied to a browser session, but is implementation specific). Normally used for Attribution (so must be persistent across the attribution window). | | `normalised_product_code` | `STRING` | Product code prefixed with leading zeros to be 16 characters long. | | `product_code` | `STRING` | Product code. | | `product_name` | `STRING` | Name of the Product. | | `brand` | `STRING` | Brand of the Product. | | `retailer_taxonomy` | `STRING` | Taxonomy (product hierarchy) of the Product as specified by the Retailer. | | `halo_taxonomy` | `STRING` | The portion of the retailer_taxonomy relevant for the given halo_taxonomy_level. Note for halo_taxonomy_level=1 it is null since the Brand is level 1. | | `halo_taxonomy_level` | `INTEGER` | Halo level number (1-9). 1 = Brand level halo, Levels 2-9 are the HaloTaxonomy component, 9 being the specific Product Code (SKU). | | `ingressed_at` | `TIMESTAMP` | Timestamp the Requests were received. | | `impressioned_at` | `TIMESTAMP` | Timestamp the impression occurred. | | `clicked_at` | `TIMESTAMP` | Timestamp of the Click. | | `impressioned` | `BOOLEAN` | Flag indicating an impression. | | `clicked` | `BOOLEAN` | Flag indicating if clicked. | | `purchased` | `BOOLEAN` | Total number of purchases. | | `search_term` | `STRING` | The word/phrase being searched for on the retailer site by the end user. | | `category_id` | `STRING` | Category being targeted. | | `placement` | `STRING` | Display name of the Placement. | | `platform` | `STRING` | The platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter. | | `page_type` | `INTEGER` | Legacy, superseded by Placement. | | `order_date` | `DATE` | Date of the Orders. | | `retailer_order_id` | `STRING` | Identifier of the Order the Conversion is Attributed to. | | `order_item_id` | `STRING` | Line item of the Order the Conversion is Attributed to. | | `order_product_code` | `STRING` | Order Product code. | | `order_normalised_product` | `STRING` | Normalised Product code of the Order. | | `customer_id` | `STRING` | Customer identifier as provided by the Retailer (as in loyalty number etc, where available). Sometimes used for Attribution. | | `order_type` | `STRING` | Type of the Order. | | `impressions` | `NUMERIC` | Total impressions. | | `clicks` | `NUMERIC` | Number of Clicks. | | `ad_spend` | `NUMERIC` | Local currency amount charged by the Retailer to the Supplier for the Realised Ads. | | `direct_unit_sales` | `NUMERIC` | Unit sales from CitrusAd platform Attributions. | | `direct_sales_value` | `NUMERIC` | Revenue from CitrusAd platform Attributions. | | `direct_conversions` | `NUMERIC` | Conversions from CitrusAd platform Attributions. | | `view_through_unit_sales` | `NUMERIC` | Unit sales from Impression View Thru Attributions. | | `view_through_sales_value` | `NUMERIC` | Revenue from Impression View Thru Attributions. | | `view_through_conversions` | `NUMERIC` | Conversions from Impression View Thru Attributions. | | `halo_unit_sales` | `NUMERIC` | Unit sales from halo click Attributions. | | `halo_sales_value` | `NUMERIC` | Revenue from halo click Attributions. | | `halo_conversions` | `NUMERIC` | Conversions from halo click Attributions. | | `row_type` | `STRING` | Row Type. | | `etl_created_at` | `TIMESTAMP` | Date the row was inserted into this table (not the date the record was created in the source system). | | `etl_modified_at` | `TIMESTAMP` | Date this row was last updated (not the date the record was updated in the source system). | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `imp_halo_unit_sales` | `NUMERIC` | Unit sales from halo impression Attributions. | | `imp_halo_sales_value` | `NUMERIC` | Revenue from halo impression Attributions. | | `imp_halo_conversions` | `NUMERIC` | Conversions from halo impression Attributions. | | `keyword` | `STRING` | The word/phrase being targeted by the campaign - set by the advertiser. | | `placement_id` | `STRING` | Internal identifier of the Placement (from the source system). | | `wallet_id` | `STRING` | Internal identifier of the Wallet (from the source system). | | `attributable_impressions` | `NUMERIC` | Subset of impressions that are considered attributable. | | `attributable_clicks` | `NUMERIC` | Subset of clicks that are considered attributable. | | `attributable_ad_spend` | `NUMERIC` | Subset of ad spend that is considered attributable. | | `attribution_type` | `STRING` | The type of attribution applied to the conversion (e.g. click-based, impression-based). | # `analytics.fact_enhanced_attribution_agg` - namespace - retailer Enhanced Attribution (aggregated). Layer: Core Dataset Category: Fact Status: Published Primary Key: env_namespace, campaign_id, category_id, normalised_product_code, product_code, product_name, brand,retailer_taxonomy, halo_taxonomy, halo_taxonomy_level, order_date, ingressed_at, search_term, placement, platform, page_type, attribution_model, retailer_id, order_type, keyword, catalog_id Other Unique Key(s): enhanced_attribution_agg_key Partition: ingressed_at (by DAY) Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = fact_enhanced_attribution_agg.env_namespace; dim_retailer on dim_retailer.env_namespace = fact_enhanced_attribution_agg.env_namespace and dim_retailer.retailer_id = fact_enhanced_attribution_agg.retailer_id and dim_retailer.is_current; dim_campaign on dim_campaign.env_namespace = fact_enhanced_attribution_agg.env_namespace and dim_campaign.campaign_id = fact_enhanced_attribution_agg.campaign_id and dim_campaign.is_current; dim_product on dim_product.env_namespace = fact_enhanced_attribution_agg.env_namespace and dim_product.product_code = fact_enhanced_attribution_agg.product_code ; dim_search_term on dim_search_term.env_namespace = fact_enhanced_attribution_agg.env_namespace and dim_search_term.retailer_id = fact_enhanced_attribution_agg.retailer_id and dim_search_term.search_term = fact_enhanced_attribution_agg.search_term; dim_category on dim_category.env_namespace = fact_enhanced_attribution_agg.env_namespace and dim_category.category_id = fact_enhanced_attribution_agg.category and dim_category.retailer_id = fact_enhanced_attribution_agg.retailer_id; dim_placement on dim_placement.env_namespace = fact_enhanced_attribution_agg.env_namespace and dim_placement.placement = fact_enhanced_attribution_agg.placement; Time Series Column: ingressed_at Aggregation Details: Source tables(s): fact_enhanced_attribution (group by env, namespace, env_namespace, campaign_id, category_id, normalised_product_code, product_code, product_name,brand, retailer_taxonomy,halo_taxonomy,halo_taxonomy_level,order_date,ingressed_at,search_term, keyword,placement ,platform ,page_type,attribution_model,retailer_id ,order_type,catalog_id) union fact_enhanced_attribution_2 (group by env, namespace, env_namespace, campaign_id, category_id, normalised_product_code, product_code, product_name,brand, retailer_taxonomy,halo_taxonomy,halo_taxonomy_level,order_date,ingressed_at,search_term, keyword,placement ,platform ,page_type,attribution_model,retailer_id ,order_type,catalog_id) | Column Name | Data Type | Description | |-------------|-----------|-------------| | `enhanced_attribution_agg_key` | `STRING` | Unique identifier of the row in this table (surrogate key). | | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `campaign_id` | `STRING` | Internal identifier of the Campaign (from the source system). | | `category_id` | `STRING` | Category being targeted. | | `normalised_product_code` | `STRING` | Product code prefixed with leading zeros to be 16 characters long. | | `product_code` | `STRING` | Product code. | | `product_name` | `STRING` | Name of the Product. | | `brand` | `STRING` | Brand of the Product. | | `retailer_taxonomy` | `STRING` | Taxonomy (product hierarchy) of the Product as specified by the Retailer. | | `halo_taxonomy` | `STRING` | The portion of the retailer_taxonomy relevant for the given halo_taxonomy_level. Note for halo_taxonomy_level=1 it is null since the Brand is level 1. | | `halo_taxonomy_level` | `INTEGER` | Halo level number (1-9). 1 = Brand level halo, Levels 2-9 are the HaloTaxonomy component, 9 being the specific Product Code (SKU). | | `order_date` | `DATE` | Date of the Orders. | | `ingressed_at` | `DATE` | Date the Ads were realised. | | `search_term` | `STRING` | DEPRECATED. Please switch to using keyword. | | `placement` | `STRING` | Display name of the Placement. | | `platform` | `STRING` | The platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter. | | `page_type` | `INTEGER` | Legacy, superseded by Placement. | | `namespace` | `STRING` | Name of the Namespace. | | `order_type` | `STRING` | Type of the Order. | | `impressions` | `NUMERIC` | Total impressions. | | `clicks` | `NUMERIC` | Number of Clicks. | | `ad_spend` | `NUMERIC` | Local currency amount charged by the Retailer to the Supplier for the Realised Ads. | | `direct_unit_sales` | `NUMERIC` | Unit sales from CitrusAd platform Attributions. | | `direct_sales_value` | `NUMERIC` | Revenue from CitrusAd platform Attributions. | | `direct_conversions` | `NUMERIC` | Conversions from CitrusAd platform Attributions. | | `view_through_unit_sales` | `NUMERIC` | Unit sales from Impression View Thru Attributions. | | `view_through_sales_value` | `NUMERIC` | Revenue from Impression View Thru Attributions. | | `view_through_conversions` | `NUMERIC` | Conversions from Impression View Thru Attributions. | | `halo_unit_sales` | `NUMERIC` | Unit sales from halo click Attributions. | | `halo_sales_value` | `NUMERIC` | Revenue from halo click Attributions. | | `halo_conversions` | `NUMERIC` | Conversions from halo click Attributions. | | `etl_created_at` | `TIMESTAMP` | Date the row was inserted into this table (not the date the record was created in the source system). | | `etl_modified_at` | `TIMESTAMP` | Date this row was last updated (not the date the record was updated in the source system). | | `attribution_model` | `INTEGER` | Indicate if data is from first or second model. | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `imp_halo_unit_sales` | `NUMERIC` | Unit sales from halo impression Attributions. | | `imp_halo_sales_value` | `NUMERIC` | Revenue from halo impression Attributions. | | `imp_halo_conversions` | `NUMERIC` | Conversions from halo impression Attributions. | | `keyword` | `STRING` | The word/phrase being targeted by the campaign - set by the advertiser. | | `attributable_impressions` | `NUMERIC` | Subset of impressions that are considered attributable. | | `attributable_clicks` | `NUMERIC` | Subset of clicks that are considered attributable. | | `attributable_ad_spend` | `NUMERIC` | Subset of ad spend that is considered attributable. | | `attribution_type` | `STRING` | The type of attribution applied to the conversion (e.g. click-based, impression-based). | # `analytics.fact_enhanced_attribution_agg_ltz` - namespace - retailer Enhanced Attribution (aggregated) in local timezone. Layer: Core Dataset Category: Fact Status: Published Primary Key: env_namespace, campaign_id, category_id, normalised_product_code, product_code, product_name, brand,retailer_taxonomy, halo_taxonomy, halo_taxonomy_level, order_date, ingressed_at, search_term, placement, platform, page_type, attribution_model, retailer_id, order_type, keyword, catalog_id Other Unique Key(s): enhanced_attribution_agg_key Partition: ingressed_at (by DAY) Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = fact_enhanced_attribution_agg.env_namespace; dim_retailer on dim_retailer.env_namespace = fact_enhanced_attribution_agg.env_namespace and dim_retailer.retailer_id = fact_enhanced_attribution_agg.retailer_id and dim_retailer.is_current; dim_campaign on dim_campaign.env_namespace = fact_enhanced_attribution_agg.env_namespace and dim_campaign.campaign_id = fact_enhanced_attribution_agg.campaign_id and dim_campaign.is_current; dim_product on dim_product.env_namespace = fact_enhanced_attribution_agg.env_namespace and dim_product.product_code = fact_enhanced_attribution_agg.product_code ; dim_search_term on dim_search_term.env_namespace = fact_enhanced_attribution_agg.env_namespace and dim_search_term.retailer_id = fact_enhanced_attribution_agg.retailer_id and dim_search_term.search_term = fact_enhanced_attribution_agg.search_term; dim_category on dim_category.env_namespace = fact_enhanced_attribution_agg.env_namespace and dim_category.category_id = fact_enhanced_attribution_agg.category and dim_category.retailer_id = fact_enhanced_attribution_agg.retailer_id; dim_placement on dim_placement.env_namespace = fact_enhanced_attribution_agg.env_namespace and dim_placement.placement = fact_enhanced_attribution_agg.placement; Time Series Column: ingressed_at Aggregation Details: Source tables(s): fact_enhanced_attribution (group by env, namespace, env_namespace, campaign_id, category_id, normalised_product_code, product_code, product_name,brand, retailer_taxonomy,halo_taxonomy,halo_taxonomy_level,order_date,ingressed_at,search_term, keyword,placement ,platform ,page_type,attribution_model,retailer_id ,order_type,catalog_id) union fact_enhanced_attribution_2 (group by env, namespace, env_namespace, campaign_id, category_id, normalised_product_code, product_code, product_name,brand, retailer_taxonomy,halo_taxonomy,halo_taxonomy_level,order_date,ingressed_at,search_term, keyword,placement ,platform ,page_type,attribution_model,retailer_id ,order_type,catalog_id) | Column Name | Data Type | Description | |-------------|-----------|-------------| | `enhanced_attribution_agg_key` | `STRING` | Unique identifier of the row in this table (surrogate key). | | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `campaign_id` | `STRING` | Internal identifier of the Campaign (from the source system). | | `category_id` | `STRING` | Category being targeted. | | `normalised_product_code` | `STRING` | Product code prefixed with leading zeros to be 16 characters long. | | `product_code` | `STRING` | Product code. | | `product_name` | `STRING` | Name of the Product. | | `brand` | `STRING` | Brand of the Product. | | `retailer_taxonomy` | `STRING` | Taxonomy (product hierarchy) of the Product as specified by the Retailer. | | `halo_taxonomy` | `STRING` | The portion of the retailer_taxonomy relevant for the given halo_taxonomy_level. Note for halo_taxonomy_level=1 it is null since the Brand is level 1. | | `halo_taxonomy_level` | `INTEGER` | Halo level number (1-9). 1 = Brand level halo, Levels 2-9 are the HaloTaxonomy component, 9 being the specific Product Code (SKU). | | `order_date` | `DATE` | Date of the Orders. | | `ingressed_at` | `DATE` | Date the Ads were realised in local timezone. | | `search_term` | `STRING` | DEPRECATED. Please switch to using keyword. | | `placement` | `STRING` | Display name of the Placement. | | `platform` | `STRING` | The platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter. | | `page_type` | `INTEGER` | Legacy, superseded by Placement. | | `namespace` | `STRING` | Name of the Namespace. | | `order_type` | `STRING` | Type of the Order. | | `impressions` | `NUMERIC` | Total impressions. | | `clicks` | `NUMERIC` | Number of Clicks. | | `ad_spend` | `NUMERIC` | Local currency amount charged by the Retailer to the Supplier for the Realised Ads. | | `direct_unit_sales` | `NUMERIC` | Unit sales from CitrusAd platform Attributions. | | `direct_sales_value` | `NUMERIC` | Revenue from CitrusAd platform Attributions. | | `direct_conversions` | `NUMERIC` | Conversions from CitrusAd platform Attributions. | | `view_through_unit_sales` | `NUMERIC` | Unit sales from Impression View Thru Attributions. | | `view_through_sales_value` | `NUMERIC` | Revenue from Impression View Thru Attributions. | | `view_through_conversions` | `NUMERIC` | Conversions from Impression View Thru Attributions. | | `halo_unit_sales` | `NUMERIC` | Unit sales from halo click Attributions. | | `halo_sales_value` | `NUMERIC` | Revenue from halo click Attributions. | | `halo_conversions` | `NUMERIC` | Conversions from halo click Attributions. | | `etl_created_at` | `TIMESTAMP` | Date the row was inserted into this table (not the date the record was created in the source system). | | `etl_modified_at` | `TIMESTAMP` | Date this row was last updated (not the date the record was updated in the source system). | | `attribution_model` | `INTEGER` | Indicate if data is from first or second model. | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `imp_halo_unit_sales` | `NUMERIC` | Unit sales from halo impression Attributions. | | `imp_halo_sales_value` | `NUMERIC` | Revenue from halo impression Attributions. | | `imp_halo_conversions` | `NUMERIC` | Conversions from halo impression Attributions. | | `keyword` | `STRING` | The word/phrase being targeted by the campaign - set by the advertiser. | | `attributable_impressions` | `NUMERIC` | Subset of impressions that are considered attributable. | | `attributable_clicks` | `NUMERIC` | Subset of clicks that are considered attributable. | | `attributable_ad_spend` | `NUMERIC` | Subset of ad spend that is considered attributable. | | `attribution_type` | `STRING` | The type of attribution applied to the conversion (e.g. click-based, impression-based). | # `analytics.fact_fta_campaign_spend` - namespace - retailer FTA Campaign Spend fact. Layer: Core Dataset Category: Fact Status: Published Primary Key: env_namespace, campaign_id, team_id, wallet_id, search_term, catalog_id, product_code, bucket_date, bucket_date_key, category_id Other Unique Key(s): fta_campaign_spend_key Partition: bucket_date (by DAY) Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = fact_fta_campaign_spend.env_namespace; dim_campaign on dim_campaign.env_namespace = fact_fta_campaign_spend.env_namespace and dim_campaign.campaign_id = fact_fta_campaign_spend.campaign_id and dim_campaign.is_current; dim_team on dim_team.env_namespace = fact_fta_campaign_spend.env_namespace and dim_team.team_id = fact_fta_campaign_spend.team_id and dim_team.is_current; dim_wallet on dim_wallet.env_namespace = fact_fta_campaign_spend.env_namespace and dim_wallet.wallet_id = fact_fta_campaign_spend.wallet_id; dim_catalog on dim_catalog.env_namespace = fact_fta_campaign_spend.env_namespace and dim_catalog.catalog_id = fact_fta_campaign_spend.catalog_id and dim_catalog.is_current; dim_search_term on dim_search_term.env_namespace = fact_fta_campaign_spend.env_namespace and dim_search_term.retailer_id = fact_fta_campaign_spend.retailer_id and dim_search_term.search_term = fact_fta_campaign_spend.search_term; dim_product on dim_product.env_namespace = fact_fta_campaign_spend.env_namespace and dim_product.product_code = fact_fta_campaign_spend.product_code; Time Series Column: bucket_date | Column Name | Data Type | Description | |-------------|-----------|-------------| | `fta_campaign_spend_key` | `STRING` | Unique identifier of the row in this table (surrogate key). | | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `campaign_id` | `STRING` | Internal identifier of the Campaign (from the source system). | | `team_id` | `STRING` | Internal identifier of the Team (from the source system). | | `wallet_id` | `STRING` | Internal identifier of the Wallet (from the source system). | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `search_term` | `STRING` | The word/phrase being searched for on the retailer site by the end user. | | `product_code` | `STRING` | Product code. | | `bucket_date` | `DATE` | Bucket date. | | `bucket_date_key` | `INTEGER` | Unique identifier of the row in this table (surrogate key). | | `namespace` | `STRING` | Name of the Namespace. | | `bucketed_cost` | `NUMERIC` | Bucketed cost. | | `fta_cost` | `NUMERIC` | Total amount being spent by the given Fixed Tenancy Agreement (FTA) Campaign. | | `catalog_cost_percentage` | `NUMERIC` | Catalog cost percentage. | | `num_of_search_terms` | `INTEGER` | Number of Search Terms. | | `num_of_products` | `INTEGER` | Number of Products. | | `num_of_days_in_campaign` | `INTEGER` | Total number of days in the Campaign. | | `etl_created_at` | `TIMESTAMP` | Date the row was inserted into this table (not the date the record was created in the source system). | | `etl_modified_at` | `TIMESTAMP` | Date this row was last updated (not the date the record was updated in the source system). | | `category_id` | `STRING` | Category being targeted. | # `analytics.fact_ledger` - namespace - retailer Ledger fact (full detail). Layer: Core Dataset Category: Fact Status: Published Primary Key: ledger_id Other Unique Key(s): ledger_key Partition: transaction_date (by DAY) Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = fact_ledger.env_namespace; dim_retailer on dim_retailer.env_namespace = fact_ledger.env_namespace and dim_retailer.retailer_id = fact_ledger.retailer_id and dim_retailer.is_current; dim_campaign on dim_campaign.env_namespace = fact_ledger.env_namespace and dim_campaign.campaign_id = fact_ledger.campaign_id and dim_campaign.is_current; dim_team on dim_team.env_namespace = fact_ledger.env_namespace and dim_team.team_id = fact_ledger.team_id and dim_team.is_current; dim_wallet on dim_wallet.env_namespace = fact_ledger.env_namespace and dim_wallet.wallet_id = fact_ledger.wallet_id; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `ledger_key` | `STRING` | Unique identifier of the row in this table (surrogate key). | | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `ledger_id` | `STRING` | Internal identifier of the Ledger transaction (from the source system). | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `team_id` | `STRING` | Internal identifier of the Team (from the source system). | | `wallet_id` | `STRING` | Internal identifier of the Wallet (from the source system). | | `campaign_id` | `STRING` | Internal identifier of the Campaign (from the source system). | | `transaction_date` | `TIMESTAMP` | Date of the transactions. | | `transaction_date_utc` | `TIMESTAMP` | Currently the same as transaction_date since all data is in UTC. | | `ledger_type` | `STRING` | Debit or Credit transaction type. | | `product_type` | `STRING` | Type of the Product. | | `reason` | `STRING` | Reason given for the transaction type. | | `namespace` | `STRING` | Name of the Namespace. | | `amount` | `NUMERIC` | Total of transaction amounts. | | `citrus_gross_margin` | `NUMERIC` | Citrus gross margin. | | `etl_created_at` | `TIMESTAMP` | Date the row was inserted into this table (not the date the record was created in the source system). | | `etl_modified_at` | `TIMESTAMP` | Date this row was last updated (not the date the record was updated in the source system). | | `reason_linkback` | `STRING` | Link back to what the transaction was for. E.g- Ids of the ads that were impressioned/clicked. | # `analytics.fact_ledger_agg` - namespace - retailer Ledger fact (aggregated into UTC+0 day buckets). Layer: Core Dataset Category: Fact Status: Published Primary Key: transaction_date, env_namespace, team_id, wallet_id, campaign_id, ledger_type, product_ledger, reason, retailer_id Other Unique Key(s): ledger_agg_key Partition: transaction_date (by DAY) Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = fact_ledger_agg.env_namespace; dim_retailer on dim_retailer.env_namespace = fact_ledger_agg.env_namespace and dim_retailer.retailer_id = fact_ledger_agg.retailer_id and dim_retailer.is_current; dim_campaign on dim_campaign.env_namespace = fact_ledger_agg.env_namespace and dim_campaign.campaign_id = fact_ledger_agg.campaign_id and dim_campaign.is_current; dim_team on dim_team.env_namespace = fact_ledger_agg.env_namespace and dim_team.team_id = fact_ledger_agg.team_id and dim_team.is_current; dim_wallet on dim_wallet.env_namespace = fact_ledger_agg.env_namespace and dim_wallet.wallet_id = fact_ledger_agg.wallet_id; Time Series Column: transaction_date Aggregation Details: Source tables(s): fact_ledger (group by transaction_date ,date_key ,env ,namespace ,env_namespace ,team_id ,wallet_id ,campaign_id ,ledger_type ,product_ledger ,reason ,retailer_id) | Column Name | Data Type | Description | |-------------|-----------|-------------| | `ledger_agg_key` | `STRING` | Unique identifier of the row in this table (surrogate key). | | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `transaction_date` | `DATE` | Date of the transactions. | | `date_key` | `INTEGER` | Unique identifier of the row in this table (surrogate key). | | `team_id` | `STRING` | Internal identifier of the Team (from the source system). | | `wallet_id` | `STRING` | Internal identifier of the Wallet (from the source system). | | `campaign_id` | `STRING` | Internal identifier of the Campaign (from the source system). | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `ledger_type` | `STRING` | Debit or Credit transaction type. | | `product_ledger` | `STRING` | More detailed transaction type. | | `namespace` | `STRING` | Name of the Namespace. | | `reason` | `STRING` | Reason given for the transaction type. | | `amount` | `NUMERIC` | Total of transaction amounts. | | `transaction_count` | `NUMERIC` | Total transaction count. | | `citrus_gross_margin` | `NUMERIC` | Citrus gross margin. | | `etl_created_at` | `TIMESTAMP` | Date the row was inserted into this table (not the date the record was created in the source system). | | `etl_modified_at` | `TIMESTAMP` | Date this row was last updated (not the date the record was updated in the source system). | # `analytics.fact_ledger_agg_2` - namespace - retailer Ledger fact (aggregated into UTC+0 hourly buckets). Only for current + previous 3 months. Layer: Core Dataset Category: Fact Status: Published Primary Key: transaction_timestamp, env_namespace, team_id, wallet_id, campaign_id, ledger_type, product_ledger, reason, retailer_id Other Unique Key(s): None Partition: transaction_timestamp (by DAY) Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = fact_ledger_agg_2.env_namespace; dim_retailer on dim_retailer.env_namespace = fact_ledger_agg_2.env_namespace and dim_retailer.retailer_id = fact_ledger_agg_2.retailer_id and dim_retailer.is_current; dim_campaign on dim_campaign.env_namespace = fact_ledger_agg_2.env_namespace and dim_campaign.campaign_id = fact_ledger_agg_2.campaign_id and dim_campaign.is_current; dim_team on dim_team.env_namespace = fact_ledger_agg_2.env_namespace and dim_team.team_id = fact_ledger_agg_2.team_id and dim_team.is_current; dim_wallet on dim_wallet.env_namespace = fact_ledger_agg_2.env_namespace and dim_wallet.wallet_id = fact_ledger_agg_2.wallet_id; Time Series Column: transaction_date Aggregation Details: Source tables(s): fact_ledger (env ,namespace ,env_namespace ,transaction_timestamp ,team_id ,wallet_id ,campaign_id ,ledger_type ,product_ledger ,reason ,retailer_id) | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `namespace` | `STRING` | Name of the Namespace. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `transaction_timestamp` | `TIMESTAMP` | Timestamp of the transactions rounded up to the hour | | `team_id` | `STRING` | Internal identifier of the Team (from the source system). | | `wallet_id` | `STRING` | Internal identifier of the Wallet (from the source system). | | `campaign_id` | `STRING` | Internal identifier of the Campaign (from the source system). | | `ledger_type` | `STRING` | Debit or Credit transaction type. | | `product_ledger` | `STRING` | Type of the Product. | | `reason` | `STRING` | Reason given for the transaction type. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `citrus_gross_margin` | `NUMERIC` | Total of Citrus gross margin | | `amount` | `NUMERIC` | Total of transaction amounts. | | `transaction_count` | `INTEGER` | Total number of transactions. | # `analytics.fact_ledger_agg_2_ltz` - namespace - retailer Ledger fact (aggregated into local timezone hourly buckets). Only for current + previous 3 months. Layer: Core Dataset Category: Fact Status: Published Primary Key: transaction_timestamp, env_namespace, team_id, wallet_id, campaign_id, ledger_type, product_ledger, reason, retailer_id Other Unique Key(s): None Partition: transaction_timestamp (by DAY) Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = fact_ledger_agg_2.env_namespace; dim_retailer on dim_retailer.env_namespace = fact_ledger_agg_2.env_namespace and dim_retailer.retailer_id = fact_ledger_agg_2.retailer_id and dim_retailer.is_current; dim_campaign on dim_campaign.env_namespace = fact_ledger_agg_2.env_namespace and dim_campaign.campaign_id = fact_ledger_agg_2.campaign_id and dim_campaign.is_current; dim_team on dim_team.env_namespace = fact_ledger_agg_2.env_namespace and dim_team.team_id = fact_ledger_agg_2.team_id and dim_team.is_current; dim_wallet on dim_wallet.env_namespace = fact_ledger_agg_2.env_namespace and dim_wallet.wallet_id = fact_ledger_agg_2.wallet_id; Time Series Column: transaction_date Aggregation Details: Source tables(s): fact_ledger (env ,namespace ,env_namespace ,transaction_timestamp ,team_id ,wallet_id ,campaign_id ,ledger_type ,product_ledger ,reason ,retailer_id) | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `namespace` | `STRING` | Name of the Namespace. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `transaction_timestamp` | `DATETIME` | Datetime of the transactions rounded up to the hour in local timezone | | `team_id` | `STRING` | Internal identifier of the Team (from the source system). | | `wallet_id` | `STRING` | Internal identifier of the Wallet (from the source system). | | `campaign_id` | `STRING` | Internal identifier of the Campaign (from the source system). | | `ledger_type` | `STRING` | Debit or Credit transaction type. | | `product_ledger` | `STRING` | Type of the Product. | | `reason` | `STRING` | Reason given for the transaction type. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `citrus_gross_margin` | `NUMERIC` | Total of Citrus gross margin | | `amount` | `NUMERIC` | Total of transaction amounts. | | `transaction_count` | `INTEGER` | Total number of transactions. | # `analytics.fact_ledger_agg_ltz` - namespace - retailer Ledger fact (aggregated into local timezone day buckets). Layer: Core Dataset Category: Fact Status: Published Primary Key: transaction_date, env_namespace, team_id, wallet_id, campaign_id, ledger_type, product_ledger, reason, retailer_id Other Unique Key(s): ledger_agg_key Partition: transaction_date (by DAY) Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = fact_ledger_agg.env_namespace; dim_retailer on dim_retailer.env_namespace = fact_ledger_agg.env_namespace and dim_retailer.retailer_id = fact_ledger_agg.retailer_id and dim_retailer.is_current; dim_campaign on dim_campaign.env_namespace = fact_ledger_agg.env_namespace and dim_campaign.campaign_id = fact_ledger_agg.campaign_id and dim_campaign.is_current; dim_team on dim_team.env_namespace = fact_ledger_agg.env_namespace and dim_team.team_id = fact_ledger_agg.team_id and dim_team.is_current; dim_wallet on dim_wallet.env_namespace = fact_ledger_agg.env_namespace and dim_wallet.wallet_id = fact_ledger_agg.wallet_id; Time Series Column: transaction_date Aggregation Details: Source tables(s): fact_ledger (group by transaction_date ,date_key ,env ,namespace ,env_namespace ,team_id ,wallet_id ,campaign_id ,ledger_type ,product_ledger ,reason ,retailer_id) | Column Name | Data Type | Description | |-------------|-----------|-------------| | `ledger_agg_key` | `STRING` | Unique identifier of the row in this table (surrogate key). | | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `transaction_date` | `DATE` | Date of the transactions in local timezone. | | `date_key` | `INTEGER` | Unique identifier of the row in this table (surrogate key). | | `team_id` | `STRING` | Internal identifier of the Team (from the source system). | | `wallet_id` | `STRING` | Internal identifier of the Wallet (from the source system). | | `campaign_id` | `STRING` | Internal identifier of the Campaign (from the source system). | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `ledger_type` | `STRING` | Debit or Credit transaction type. | | `product_ledger` | `STRING` | More detailed transaction type. | | `namespace` | `STRING` | Name of the Namespace. | | `reason` | `STRING` | Reason given for the transaction type. | | `amount` | `NUMERIC` | Total of transaction amounts. | | `transaction_count` | `NUMERIC` | Total transaction count. | | `citrus_gross_margin` | `NUMERIC` | Citrus gross margin. | | `etl_created_at` | `TIMESTAMP` | Date the row was inserted into this table (not the date the record was created in the source system). | | `etl_modified_at` | `TIMESTAMP` | Date this row was last updated (not the date the record was updated in the source system). | # `analytics.fact_order` - namespace - retailer Order fact (full detail). Layer: Core Dataset Category: Fact Status: Published Primary Key: retailer_order_id, sequence_id, retailer_id, row_version, order_item_id, order_type Other Unique Key(s): order_key Partition: order_timestamp (by DAY) Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = fact_order.env_namespace; dim_retailer on dim_retailer.env_namespace = fact_order.env_namespace and dim_retailer.retailer_id = fact_order.retailer_id and dim_retailer.is_current; dim_catalog on dim_catalog.env_namespace = fact_order.env_namespace and dim_catalog.catalog_id = fact_order.catalog_id and dim_catalog.is_current; dim_product on dim_product.env_namespace = fact_order.env_namespace and dim_product.catalog_id = fact_order.catalog_id and dim_product.product_code = fact_order.product_code; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `order_key` | `STRING` | Unique identifier of the row in this table (surrogate key). | | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `sequence_id` | `NUMERIC` | Sequence id. | | `retailer_order_id` | `STRING` | Identifier for the Order from the Retailer. | | `row_version` | `NUMERIC` | Track changes with new row versions (sequentially increasing number to indicate chronology). | | `order_item_id` | `STRING` | Line item of the Order. | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `issuer_team_id` | `STRING` | Internal identifier of the Team (from the source system). | | `namespace` | `STRING` | Name of the Namespace. | | `order_timestamp` | `TIMESTAMP` | Timestamp of the Order. | | `order_timestamp_utc` | `TIMESTAMP` | Currently the same as order_timestamp since all data is in UTC. | | `order_date` | `DATE` | Date of the Orders. | | `order_date_utc` | `DATE` | Currently the same as order_date since all data is in UTC. | | `order_date_key` | `INTEGER` | Unique identifier of the row in this table (surrogate key). | | `realised_ad_id` | `STRING` | Realised Ad the Order is Attributed to (as set by external processes). | | `product_code` | `STRING` | Product code. | | `normalised_product_code` | `STRING` | Product code prefixed with leading zeros to be 16 characters long. | | `session_id` | `STRING` | Customer identifier as provided by the Retailer (often tied to a browser session, but is implementation specific). Normally used for Attribution (so must be persistent across the attribution window). | | `customer_id` | `STRING` | Customer identifier as provided by the Retailer (as in loyalty number etc, where available). Sometimes used for Attribution. | | `currency_code` | `STRING` | ISO 4217 currency code | | `order_type` | `STRING` | Type of the Order. | | `quantity` | `NUMERIC` | Quantity of the Product ordered. | | `total_price` | `NUMERIC` | Total paid for the products ordered. | | `is_active` | `BOOLEAN` | Flag to indicate that the record is active in the source system. | | `is_deleted` | `BOOLEAN` | Flag to indicate that the record has been soft deleted in the source system. | | `is_current` | `BOOLEAN` | Flag if the row is the latest version in the source system. | | `etl_created_at` | `TIMESTAMP` | Date the row was inserted into this table (not the date the record was created in the source system). | | `etl_modified_at` | `TIMESTAMP` | Date this row was last updated (not the date the record was updated in the source system). | | `dtm_cookie_id` | `STRING` | Customer identifier as provided by the Retailer (often tied to a browser cookie, but is implementation specific). Normally used for Attribution (so must be persistent across the attribution window). | | `seller_id` | `STRING` | Retailer managed surrogate id for a supplier team | | `processed_at` | `TIMESTAMP` | Last updated_at in the order | # `analytics.fact_order_agg` - namespace - retailer Order fact (aggregated). Layer: Core Dataset Category: Fact Status: Published Primary Key: env_namespace, order_date, issuer_team_id, retailer_id, catalog_id, product_code, normalised_product_code, order_type Other Unique Key(s): order_agg_key Partition: order_date (by DAY) Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = fact_order_agg.env_namespace; dim_retailer on dim_retailer.env_namespace = fact_order_agg.env_namespace and dim_retailer.retailer_id = fact_order_agg.retailer_id and dim_retailer.is_current; dim_catalog on dim_catalog.env_namespace = fact_order_agg.env_namespace and dim_catalog.catalog_id = fact_order_agg.catalog_id and dim_catalog.is_current; dim_product on dim_product.env_namespace = fact_order_agg.env_namespace and dim_product.catalog_id = fact_order_agg.catalog_id and dim_product.product_code = fact_order_agg.product_code; Time Series Column: order_date Aggregation Details: Source tables(s): fact_order (env ,env_namespace ,retailer_id ,catalog_id ,issuer_team_id ,order_date ,order_date_key ,product_code ,normalised_product_code ,currency_code ,namespace ,order_type) | Column Name | Data Type | Description | |-------------|-----------|-------------| | `order_agg_key` | `STRING` | Unique identifier of the row in this table (surrogate key). | | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `issuer_team_id` | `STRING` | Internal identifier of the Team (from the source system). | | `order_date` | `DATE` | Date of the Orders. | | `order_date_key` | `INTEGER` | Unique identifier of the row in this table (surrogate key). | | `product_code` | `STRING` | Product code. | | `normalised_product_code` | `STRING` | Product code prefixed with leading zeros to be 16 characters long. | | `currency_code` | `STRING` | ISO 4217 currency code | | `namespace` | `STRING` | Name of the Namespace. | | `order_type` | `STRING` | Type of the Order. | | `quantity` | `NUMERIC` | Quantity of the Product ordered. | | `total_price` | `NUMERIC` | Total paid for the products ordered. | | `total_price_usd` | `FLOAT` | total_price in USD (current exchange rate only). | | `order_items` | `NUMERIC` | Total number of items ordered. | | `orders` | `NUMERIC` | Number of Orders made. | | `etl_created_at` | `TIMESTAMP` | Date the row was inserted into this table (not the date the record was created in the source system). | | `etl_modified_at` | `TIMESTAMP` | Date this row was last updated (not the date the record was updated in the source system). | # `analytics.fact_order_agg_ltz` - namespace - retailer Order fact (aggregated in local timezone dates). Layer: Core Dataset Category: Fact Status: Published Primary Key: env_namespace, order_date, issuer_team_id, retailer_id, catalog_id, product_code, normalised_product_code, order_type Other Unique Key(s): order_agg_key Partition: order_date (by DAY) Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = fact_order_agg.env_namespace; dim_retailer on dim_retailer.env_namespace = fact_order_agg.env_namespace and dim_retailer.retailer_id = fact_order_agg.retailer_id and dim_retailer.is_current; dim_catalog on dim_catalog.env_namespace = fact_order_agg.env_namespace and dim_catalog.catalog_id = fact_order_agg.catalog_id and dim_catalog.is_current; dim_product on dim_product.env_namespace = fact_order_agg.env_namespace and dim_product.catalog_id = fact_order_agg.catalog_id and dim_product.product_code = fact_order_agg.product_code; Time Series Column: order_date Aggregation Details: Source tables(s): fact_order (env ,env_namespace ,retailer_id ,catalog_id ,issuer_team_id ,order_date ,order_date_key ,product_code ,normalised_product_code ,currency_code ,namespace ,order_type) | Column Name | Data Type | Description | |-------------|-----------|-------------| | `order_agg_key` | `STRING` | Unique identifier of the row in this table (surrogate key). | | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `issuer_team_id` | `STRING` | Internal identifier of the Team (from the source system). | | `order_date` | `DATE` | Date of the Orders in local timezone. | | `order_date_key` | `INTEGER` | Unique identifier of the row in this table (surrogate key). | | `product_code` | `STRING` | Product code. | | `normalised_product_code` | `STRING` | Product code prefixed with leading zeros to be 16 characters long. | | `currency_code` | `STRING` | ISO 4217 currency code | | `namespace` | `STRING` | Name of the Namespace. | | `order_type` | `STRING` | Type of the Order. | | `quantity` | `NUMERIC` | Quantity of the Product ordered. | | `total_price` | `NUMERIC` | Total paid for the products ordered. | | `total_price_usd` | `FLOAT` | total_price in USD (current exchange rate only). | | `order_items` | `NUMERIC` | Total number of items ordered. | | `orders` | `NUMERIC` | Number of Orders made. | | `etl_created_at` | `TIMESTAMP` | Date the row was inserted into this table (not the date the record was created in the source system). | | `etl_modified_at` | `TIMESTAMP` | Date this row was last updated (not the date the record was updated in the source system). | # `analytics.fact_realised_ad` - namespace - retailer Realised Ad fact (full detail). Layer: Core Dataset Category: Fact Status: Published Primary Key: realised_ad_id Other Unique Key(s): realised_ad_key Partition: ingressed_at (by DAY) Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = fact_realised_ad.env_namespace; dim_retailer on dim_retailer.env_namespace = fact_realised_ad.env_namespace and dim_retailer.retailer_id = fact_realised_ad.retailer_id and dim_retailer.is_current; dim_catalog on dim_catalog.env_namespace = fact_realised_ad.env_namespace and dim_catalog.catalog_id = fact_realised_ad.catalog_id and dim_catalog.is_current; dim_product on dim_product.env_namespace = fact_realised_ad.env_namespace and dim_product.catalog_id = fact_realised_ad.catalog_id and dim_product.normalised_product_code = fact_realised_ad.product_code; dim_supplier on dim_supplier.env_namespace = fact_realised_ad.env_namespace and dim_supplier.supplier_id = fact_realised_ad.supplier_id and dim_supplier.is_current; dim_campaign on dim_campaign.env_namespace = fact_realised_ad.env_namespace and dim_campaign.campaign_id = fact_realised_ad.campaign_id and dim_campaign.is_current; dim_search_term on dim_search_term.env_namespace = fact_realised_ad.env_namespace and dim_search_term.retailer_id = fact_realised_ad.retailer_id and dim_search_term.search_term = fact_realised_ad.search_term; dim_category on dim_category.env_namespace = fact_realised_ad.env_namespace and dim_category.category_id = fact_realised_ad.category and dim_category.retailer_id = fact_realised_ad.retailer_id; dim_placement on dim_placement.env_namespace = fact_realised_ad.env_namespace and dim_placement.placement = fact_realised_ad.placement; fact_order on fact_order.env_namespace = fact_realised_ad.env_namespace and fact_order.order_item_id = fact_realised_ad.order_item_id; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `realised_ad_key` | `STRING` | Unique identifier of the row in this table (surrogate key). | | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `realised_ad_id` | `STRING` | Internal identifier of the Realised Ad (from the source system).. | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `supplier_id` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `campaign_id` | `STRING` | Internal identifier of the Campaign (from the source system). | | `ingressed_at` | `TIMESTAMP` | Timestamp the Requests were received. | | `ingressed_at_utc` | `TIMESTAMP` | Currently the same as ingressed_at since all data is in UTC. | | `purchased_at` | `TIMESTAMP` | Timestamp of the purchase. | | `purchased_at_utc` | `TIMESTAMP` | Currently the same as purchased_at since all data is in UTC. | | `impressioned_at` | `STRING` | String representation of the timestamp when the impression occurred. | | `impressioned_at_utc` | `TIMESTAMP` | Currently the same as impressioned_at since all data is in UTC. | | `clicked_at` | `TIMESTAMP` | Timestamp of the Click. | | `clicked_at_utc` | `TIMESTAMP` | Currently the same as clicked_at since all data is in UTC. | | `served_at` | `TIMESTAMP` | Timestamp when Ads served. | | `served_at_utc` | `TIMESTAMP` | Currently the same as served_at since all data is in UTC. | | `namespace` | `STRING` | Name of the Namespace. | | `ad_type` | `INTEGER` | Type of Ad (0 = Product, 1 = Banner, 4 = BannerX). | | `search_term` | `STRING` | The word/phrase being searched for on the retailer site by the end user. | | `product_code` | `STRING` | Product code. | | `content_standard_id` | `STRING` | ContentStandardId as specified in the Ad Request. | | `slot_id` | `STRING` | Banner SlotId as specified in the Ad Request. | | `session_id` | `STRING` | Customer identifier as provided by the Retailer (often tied to a browser session, but is implementation specific). Normally used for Attribution (so must be persistent across the attribution window). | | `customer_id` | `STRING` | Customer identifier as provided by the Retailer (as in loyalty number etc, where available). Sometimes used for Attribution. | | `target_product_code` | `STRING` | Target Product code. | | `reserved_search_term_flag` | `STRING` | Not in use. | | `category` | `STRING` | Category being targeted. | | `placement` | `STRING` | Display name of the Placement. | | `platform` | `STRING` | The platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter. | | `impressioned` | `BOOLEAN` | Flag indicating an impression. | | `clicked` | `BOOLEAN` | Flag indicating if clicked. | | `purchased` | `BOOLEAN` | Total number of purchases. | | `served` | `BOOLEAN` | Flag indicating Ads were served. | | `click_invalid` | `BOOLEAN` | Flag indicating if the click was invalid. | | `impression_invalid` | `BOOLEAN` | Flag indicating if the impression was invalid. | | `campaign_team_id` | `STRING` | Internal identifier of the Team (from the source system). | | `filter_mode` | `INTEGER` | The filterMode used to structure the productFilters in the ad request. Defaults in OR_AND if not specified. (OR_AND, AND_OR). | | `page_type` | `INTEGER` | Legacy, superseded by Placement. | | `impressions` | `NUMERIC` | Total impressions. | | `clicks` | `NUMERIC` | Number of Clicks. | | `conversions` | `NUMERIC` | Total standard Conversions (purchases of the exact Product in the Ad). | | `unit_sales` | `NUMERIC` | Total number of Products purchased from Conversions. | | `ad_spend` | `NUMERIC` | Local currency amount charged by the Retailer to the Supplier for the Realised Ads. | | `impression_spend` | `NUMERIC` | AdSpend generated by impressions. | | `click_spend` | `NUMERIC` | AdSpend generated by clicks. | | `serve_spend` | `NUMERIC` | Serve spend. | | `serve_price` | `NUMERIC` | Serve price. | | `impression_price` | `NUMERIC` | Price of an impression. | | `click_price` | `NUMERIC` | Click Price. | | `amount_refunded_from_invalid_click` | `NUMERIC` | Refund amount from invalid clicks. | | `amount_refunded_from_invalid_impression` | `NUMERIC` | Refund amount from invalid impressions. | | `ad_revenue` | `NUMERIC` | Portion of Ad spend retained by the Retailer. | | `sales_revenue` | `NUMERIC` | Total sales revenue generated by Conversions. | | `placement_id` | `STRING` | Internal identifier of the Placement (from the source system). | | `product_type_code` | `STRING` | Product type code. | | `location` | `STRING` | Location. | | `order_item_id` | `STRING` | Line item of the Order. | | `position` | `INTEGER` | Position of the Ad. | | `experiment_id` | `STRING` | Not in use. | | `etl_created_at` | `TIMESTAMP` | Date the row was inserted into this table (not the date the record was created in the source system). | | `etl_modified_at` | `TIMESTAMP` | Date this row was last updated (not the date the record was updated in the source system). | | `ad_requester_team_id` | `STRING` | Internal identifier of the Team (from the source system). | | `email_serve_revenue` | `NUMERIC` | Email serve revenue. | | `invalid_ad_revenue` | `NUMERIC` | Total invalid revenue. | | `campaign_type` | `INTEGER` | Type of Campaign (BANNER, BRAND_PAGE, DISPLAY, EMAIL, SHOTGUN_BANNER, WILDCARD) | | `product_collection` | `STRING` | Product collection (parent child sku). | | `cached_ad_id` | `STRING` | Internal identifier of the Cached Ad (from the source system). | | `seller_id` | `STRING` | Internal identifier of the Seller (from the source system). | | `wallet_id` | `STRING` | Internal identifier of the Wallet (from the source system). | | `attribution_type` | `STRING` | The type of attribution applied to the conversion (e.g. click-based, impression-based). | | `is_fta` | `BOOLEAN` | Flag indicating if the Campaign is Fixed Tenancy Agreement (FTA). | | `last_event_loaded_at` | `TIMESTAMP` | Date the row was inserted into the source system. | | `keyword` | `STRING` | The word/phrase being targeted by the campaign - set by the advertiser. | | `keyword_match_type` | `STRING` | Method used in matching the keyword to the user search term i.e. EXACT, PHRASE, etc. | | `impression_at` | `TIMESTAMP` | Timestamp the impression occurred. | | `generic_search_term` | `STRING` | Search term with basic data cleaning applied. | | `dtm_cookie_id` | `STRING` | Customer identifier as provided by the Retailer (often tied to a browser cookie, but is implementation specific). Normally used for Attribution (so must be persistent across the attribution window). | | `ad_request_key` | `STRING` | Unique identifier of the row in this table (surrogate key). | | `base_realised_ad_id` | `STRING` | Realised Ad Id | | `boost_value` | `NUMERIC` | Product boosting value if provided by the retailer and used as part of the ad search. | | `flattened_filters` | `STRING` | Array of filter values in type:value format (e.g., category:groceries, platform:ios). | # `analytics.fact_realised_ad_agg` - namespace - retailer Realised Ad fact (aggregated into UTC+0 day buckets). Layer: Core Dataset Category: Fact Status: Published Primary Key: ingressed_at, env_namespace, catalog_id, retailer_id, supplier_id, campaign_id, ad_type, search_term, generic_search_term, product_code, content_standard_id, slot_id, category, placement, platform, target_product_code, ad_requester_team_id, placement_id, wallet_id, attribution_type, namespace, keyword Other Unique Key(s): realised_ad_agg_key Partition: ingressed_at (by DAY) Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = fact_realised_ad_agg.env_namespace; dim_retailer on dim_retailer.env_namespace = fact_realised_ad_agg.env_namespace and dim_retailer.retailer_id = fact_realised_ad_agg.retailer_id and dim_retailer.is_current; dim_catalog on dim_catalog.env_namespace = fact_realised_ad_agg.env_namespace and dim_catalog.catalog_id = fact_realised_ad_agg.catalog_id and dim_catalog.is_current; dim_product on dim_product.env_namespace = fact_realised_ad_agg.env_namespace and dim_product.catalog_id = fact_realised_ad_agg.catalog_id and dim_product.normalised_product_code = fact_realised_ad_agg.product_code; dim_supplier on dim_supplier.env_namespace = fact_realised_ad_agg.env_namespace and dim_supplier.supplier_id = fact_realised_ad_agg.supplier_id and dim_supplier.is_current; dim_campaign on dim_campaign.env_namespace = fact_realised_ad_agg.env_namespace and dim_campaign.campaign_id = fact_realised_ad_agg.campaign_id and dim_campaign.is_current; dim_search_term on dim_search_term.env_namespace = fact_realised_ad_agg.env_namespace and dim_search_term.retailer_id = fact_realised_ad_agg.retailer_id and dim_search_term.search_term = fact_realised_ad_agg.search_term; dim_category on dim_category.env_namespace = fact_realised_ad_agg.env_namespace and dim_category.category_id = fact_realised_ad_agg.category and dim_category.retailer_id = fact_realised_ad_agg.retailer_id; dim_placement on dim_placement.env_namespace = fact_realised_ad_agg.env_namespace and dim_placement.placement = fact_realised_ad_agg.placement; Time Series Column: ingressed_at Aggregation Details: Source tables(s): fact_realised_ad (ingressed_at ,env ,namespace ,env_namespace ,catalog_id ,retailer_id ,supplier_id ,campaign_id ,ad_type ,search_term ,generic_search_term ,product_code ,content_standard_id ,slot_id ,category ,placement ,platform ,placement_id ,wallet_id, attribution_type ,target_product_code ,keyword ,ad_requester_team_id) | Column Name | Data Type | Description | |-------------|-----------|-------------| | `realised_ad_agg_key` | `STRING` | Unique identifier of the row in this table (surrogate key). | | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `supplier_id` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `campaign_id` | `STRING` | Internal identifier of the Campaign (from the source system). | | `ingressed_at` | `DATE` | Date the Ads were realised. | | `namespace` | `STRING` | Name of the Namespace. | | `ad_type` | `INTEGER` | Type of Ad (0 = Product, 1 = Banner, 4 = BannerX). | | `search_term` | `STRING` | DEPRECATED. Please switch to using keyword. | | `generic_search_term` | `STRING` | DEPRECATED. Please switch to using keyword. | | `product_code` | `STRING` | Product code. | | `content_standard_id` | `STRING` | ContentStandardId as specified in the Ad Request. | | `slot_id` | `STRING` | Banner SlotId as specified in the Ad Request. | | `category` | `STRING` | Category being targeted. | | `placement` | `STRING` | Display name of the Placement. | | `platform` | `STRING` | The platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter. | | `impressions` | `NUMERIC` | Total impressions. | | `clicks` | `NUMERIC` | Number of Clicks. | | `conversions` | `NUMERIC` | Total standard Conversions (purchases of the exact Product in the Ad). | | `unit_sales` | `NUMERIC` | Total number of Products purchased from Conversions. | | `ad_spend` | `NUMERIC` | Local currency amount charged by the Retailer to the Supplier for the Realised Ads. | | `impression_spend` | `NUMERIC` | AdSpend generated by impressions. | | `click_spend` | `NUMERIC` | AdSpend generated by clicks. | | `ad_revenue` | `NUMERIC` | Portion of Ad spend retained by the Retailer. | | `sales_revenue` | `NUMERIC` | Total sales revenue generated by Conversions. | | `target_product_code` | `STRING` | Target Product code. | | `position_sum` | `NUMERIC` | Sum of all postions for the Ads. Used to calculate average ad position (avg position = position_sum / ads_with_position_count). | | `ads_with_position_count` | `NUMERIC` | Total number of Ads that have a position set. avg position = position_sum / ads_with_position_count. | | `etl_created_at` | `TIMESTAMP` | Date the row was inserted into this table (not the date the record was created in the source system). | | `etl_modified_at` | `TIMESTAMP` | Date this row was last updated (not the date the record was updated in the source system). | | `ad_requester_team_id` | `STRING` | Internal identifier of the Team (from the source system). | | `email_serve_revenue` | `NUMERIC` | Email serve revenue. | | `invalid_ad_revenue` | `NUMERIC` | Total invalid revenue. | | `placement_id` | `STRING` | Internal identifier of the Placement (from the source system). | | `wallet_id` | `STRING` | Internal identifier of the Wallet (from the source system). | | `attribution_type` | `STRING` | The type of attribution applied to the conversion (e.g. click-based, impression-based). | | `last_event_loaded_at` | `TIMESTAMP` | Date the row was inserted into the source system. | | `keyword` | `STRING` | The word/phrase being targeted by the campaign - set by the advertiser. | | `attributable_impressions` | `NUMERIC` | Subset of impressions that are considered attributable. | | `attributable_clicks` | `NUMERIC` | Subset of clicks that are considered attributable. | | `attributable_ad_spend` | `NUMERIC` | Subset of ad spend that is considered attributable. | # `analytics.fact_realised_ad_agg_2` - namespace - retailer Realised Ad fact (aggregated, customer centric). Includes customer_id, but no breakdown by Campaign, Placement and Product. Layer: Core Dataset Category: Fact Status: Published Primary Key: ingressed_at, env_namespace, retailer_id, supplier_id, customer_id, search_term,category Other Unique Key(s): realised_ad_agg_2_key Partition: ingressed_at (by DAY) Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = fact_realised_ad_agg_2.env_namespace; dim_retailer on dim_retailer.env_namespace = fact_realised_ad_agg_2.env_namespace and dim_retailer.retailer_id = fact_realised_ad_agg_2.retailer_id and dim_retailer.is_current; dim_supplier on dim_supplier.env_namespace = fact_realised_ad_agg_2.env_namespace and dim_supplier.supplier_id = fact_realised_ad_agg_2.supplier_id and dim_supplier.is_current; dim_search_term on dim_search_term.env_namespace = fact_realised_ad_agg_2.env_namespace and dim_search_term.retailer_id = fact_realised_ad_agg_2.retailer_id and dim_search_term.search_term = fact_realised_ad_agg_2.search_term; dim_category on dim_category.env_namespace = fact_realised_ad_agg_2.env_namespace and dim_category.category_id = fact_realised_ad_agg_2.category and dim_category.retailer_id = fact_realised_ad_agg_2.retailer_id; Time Series Column: ingressed_at Aggregation Details: Source tables(s): fact_realised_ad (customer_id ,env ,namespace ,env_namespace ,ingressed_at ,retailer_id ,supplier_id ,keyword ,search_term ,category) | Column Name | Data Type | Description | |-------------|-----------|-------------| | `realised_ad_agg_2_key` | `STRING` | Unique identifier of the row in this table (surrogate key). | | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `customer_id` | `STRING` | Customer identifier as provided by the Retailer (as in loyalty number etc, where available). Sometimes used for Attribution. | | `ingressed_at` | `DATE` | Date the Ads were realised. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `supplier_id` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `search_term` | `STRING` | DEPRECATED. Please switch to using keyword. | | `category` | `STRING` | Category being targeted. | | `namespace` | `STRING` | Name of the Namespace. | | `impressions` | `NUMERIC` | Total impressions. | | `clicks` | `NUMERIC` | Number of Clicks. | | `conversions` | `NUMERIC` | Total standard Conversions (purchases of the exact Product in the Ad). | | `unit_sales` | `NUMERIC` | Total number of Products purchased from Conversions. | | `etl_created_at` | `TIMESTAMP` | Date the row was inserted into this table (not the date the record was created in the source system). | | `etl_modified_at` | `TIMESTAMP` | Date this row was last updated (not the date the record was updated in the source system). | | `last_event_loaded_at` | `TIMESTAMP` | Date the row was inserted into the source system. | | `keyword` | `STRING` | The word/phrase being targeted by the campaign - set by the advertiser. | # `analytics.fact_realised_ad_agg_3` - namespace - retailer Realised Ad fact (aggregated into UTC+0 hourly buckets). Only for current + previous 3 months. Layer: Core Dataset Category: Fact Status: Published Primary Key: ingressed_at, env_namespace, catalog_id, retailer_id, supplier_id, campaign_id, ad_type, search_term, generic_search_term, product_code, content_standard_id, slot_id, category, placement, platform, target_product_code, placement_id, wallet_id, attribution_type Other Unique Key(s): None Partition: ingressed_at (by DAY) Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = fact_realised_ad_agg_3.env_namespace; dim_retailer on dim_retailer.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_retailer.retailer_id = fact_realised_ad_agg_3.retailer_id and dim_retailer.is_current; dim_catalog on dim_catalog.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_catalog.catalog_id = fact_realised_ad_agg_3.catalog_id and dim_catalog.is_current; dim_product on dim_product.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_product.catalog_id = fact_realised_ad_agg_3.catalog_id and dim_product.normalised_product_code = fact_realised_ad_agg_3.product_code; dim_supplier on dim_supplier.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_supplier.supplier_id = fact_realised_ad_agg_3.supplier_id and dim_supplier.is_current; dim_campaign on dim_campaign.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_campaign.campaign_id = fact_realised_ad_agg_3.campaign_id and dim_campaign.is_current; dim_search_term on dim_search_term.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_search_term.retailer_id = fact_realised_ad_agg_3.retailer_id and dim_search_term.search_term = fact_realised_ad_agg_3.search_term; dim_category on dim_category.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_category.category_id = fact_realised_ad_agg_3.category and dim_category.retailer_id = fact_realised_ad_agg_3.retailer_id; dim_placement on dim_placement.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_placement.placement = fact_realised_ad_agg_3.placement; Time Series Column: ingressed_at Aggregation Details: Source tables(s): fact_realised_ad (ingressed_at ,env ,namespace ,env_namespace ,catalog_id ,retailer_id ,supplier_id ,campaign_id ,ad_type ,search_term ,generic_search_term ,product_code ,content_standard_id ,slot_id ,category ,placement ,platform ,placement_id ,wallet_id, attribution_type ,target_product_code ,keyword ,ad_requester_team_id) | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `namespace` | `STRING` | Name of the Namespace. | | `ingressed_at` | `TIMESTAMP` | Timestamp the Ads were realised. | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `campaign_id` | `STRING` | Internal identifier of the Campaign (from the source system). | | `supplier_id` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `search_term` | `STRING` | DEPRECATED. Please switch to using keyword. | | `generic_search_term` | `STRING` | DEPRECATED and will be removed in the future. Please use keyword instead. | | `product_code` | `STRING` | Product code. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `content_standard_id` | `STRING` | ContentStandardId as specified in the Ad Request. | | `slot_id` | `STRING` | Banner SlotId as specified in the Ad Request. | | `category` | `STRING` | Category being targeted. | | `placement` | `STRING` | Display name of the Placement. | | `platform` | `STRING` | The platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter. | | `ad_type` | `INTEGER` | Type of Ad (0 = Product, 1 = Banner, 4 = BannerX). | | `target_product_code` | `STRING` | Target Product code. | | `has_search_term` | `INTEGER` | Flag to indicate if the Ad is targeting a Search Term. | | `has_category` | `INTEGER` | Flag to indicate if the Ad is targeting a Category. | | `sales_revenue` | `NUMERIC` | Total sales revenue generated by Conversions. | | `ad_revenue` | `NUMERIC` | Portion of Ad spend retained by the Retailer. | | `ad_spend` | `NUMERIC` | Local currency amount charged by the Retailer to the Supplier for the Realised Ads. | | `impressions` | `NUMERIC` | Total impressions. | | `clicks` | `NUMERIC` | Number of Clicks. | | `conversions` | `NUMERIC` | Total standard Conversions (purchases of the exact Product in the Ad). | | `unit_sales` | `NUMERIC` | Total number of Products purchased from Conversions. | | `click_spend` | `NUMERIC` | AdSpend generated by clicks. | | `impression_spend` | `NUMERIC` | AdSpend generated by impressions. | | `wallet_id` | `STRING` | Internal identifier of the Wallet (from the source system). | | `attribution_type` | `STRING` | The type of attribution applied to the conversion (e.g. click-based, impression-based). | | `last_event_loaded_at` | `TIMESTAMP` | Date the row was inserted into the source system. | | `position_sum` | `NUMERIC` | Sum of all postions for the Ads. Used to calculate average ad position (avg position = position_sum / ads_with_position_count). | | `ads_with_position_count` | `NUMERIC` | Total number of Ads that have a position set. avg position = position_sum / ads_with_position_count. | | `keyword` | `STRING` | The word/phrase being targeted by the campaign - set by the advertiser. | | `placement_id` | `STRING` | Internal identifier of the Placement (from the source system). | | `attributable_impressions` | `NUMERIC` | Subset of impressions that are considered attributable. | | `attributable_clicks` | `NUMERIC` | Subset of clicks that are considered attributable. | | `attributable_ad_spend` | `NUMERIC` | Subset of ad spend that is considered attributable. | # `analytics.fact_realised_ad_agg_3_live` - namespace Realised Ad fact (aggregated into UTC+0 hourly buckets). Only for current + previous 2 Days. Layer: Core Dataset Category: Fact Status: Published Primary Key: ingressed_at, env_namespace, catalog_id, retailer_id, supplier_id, campaign_id, ad_type, search_term, generic_search_term, product_code, content_standard_id, slot_id, category, placement, platform, target_product_code, ad_requester_team_id, placement_id, wallet_id, attribution_type Other Unique Key(s): None Partition: ingressed_at (by DAY) Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = fact_realised_ad_agg_3.env_namespace; dim_retailer on dim_retailer.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_retailer.retailer_id = fact_realised_ad_agg_3.retailer_id and dim_retailer.is_current; dim_catalog on dim_catalog.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_catalog.catalog_id = fact_realised_ad_agg_3.catalog_id and dim_catalog.is_current; dim_product on dim_product.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_product.catalog_id = fact_realised_ad_agg_3.catalog_id and dim_product.normalised_product_code = fact_realised_ad_agg_3.product_code; dim_supplier on dim_supplier.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_supplier.supplier_id = fact_realised_ad_agg_3.supplier_id and dim_supplier.is_current; dim_campaign on dim_campaign.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_campaign.campaign_id = fact_realised_ad_agg_3.campaign_id and dim_campaign.is_current; dim_search_term on dim_search_term.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_search_term.retailer_id = fact_realised_ad_agg_3.retailer_id and dim_search_term.search_term = fact_realised_ad_agg_3.search_term; dim_category on dim_category.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_category.category_id = fact_realised_ad_agg_3.category and dim_category.retailer_id = fact_realised_ad_agg_3.retailer_id; dim_placement on dim_placement.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_placement.placement = fact_realised_ad_agg_3.placement; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `namespace` | `STRING` | Name of the Namespace. | | `ingressed_at` | `TIMESTAMP` | Timestamp the Ads were realised. | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `campaign_id` | `STRING` | Internal identifier of the Campaign (from the source system). | | `supplier_id` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `search_term` | `STRING` | DEPRECATED and will be removed in the future. Please use keyword instead. | | `generic_search_term` | `STRING` | DEPRECATED and will be removed in the future. Please use keyword instead. | | `product_code` | `STRING` | Product code. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `content_standard_id` | `STRING` | ContentStandardId as specified in the Ad Request. | | `slot_id` | `STRING` | Banner SlotId as specified in the Ad Request. | | `category` | `STRING` | Category being targeted. | | `placement` | `STRING` | Display name of the Placement. | | `platform` | `STRING` | The platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter. | | `ad_type` | `INTEGER` | Type of Ad (0 = Product, 1 = Banner, 4 = BannerX). | | `target_product_code` | `STRING` | Target Product code. | | `has_search_term` | `INTEGER` | Flag to indicate if the Ad is targeting a Search Term. | | `has_category` | `INTEGER` | Flag to indicate if the Ad is targeting a Category. | | `sales_revenue` | `NUMERIC` | Total sales revenue generated by Conversions. | | `ad_revenue` | `NUMERIC` | Portion of Ad spend retained by the Retailer. | | `ad_spend` | `NUMERIC` | Local currency amount charged by the Retailer to the Supplier for the Realised Ads. | | `impressions` | `NUMERIC` | Total impressions. | | `clicks` | `NUMERIC` | Number of Clicks. | | `conversions` | `NUMERIC` | Total standard Conversions (purchases of the exact Product in the Ad). | | `unit_sales` | `NUMERIC` | Total number of Products purchased from Conversions. | | `click_spend` | `NUMERIC` | AdSpend generated by clicks. | | `impression_spend` | `NUMERIC` | AdSpend generated by impressions. | | `wallet_id` | `STRING` | Internal identifier of the Wallet (from the source system). | | `attribution_type` | `STRING` | The type of attribution applied to the conversion (e.g. click-based, impression-based). | | `last_event_loaded_at` | `TIMESTAMP` | Date the row was inserted into the source system. | | `position_sum` | `NUMERIC` | Sum of all postions for the Ads. Used to calculate average ad position (avg position = position_sum / ads_with_position_count). | | `ads_with_position_count` | `NUMERIC` | Total number of Ads that have a position set. avg position = position_sum / ads_with_position_count. | | `keyword` | `STRING` | The word/phrase being targeted by the campaign - set by the advertiser. | | `attributable_impressions` | `NUMERIC` | Total aatributable impressions. | | `attributable_clicks` | `NUMERIC` | Number of attributable Clicks. | | `attributable_ad_spend` | `NUMERIC` | Subset of ad spend that is considered attributable. | | `placement_id` | `STRING` | Internal identifier of the Placement (from the source system) | # `analytics.fact_realised_ad_agg_3_ltz` - namespace - retailer Realised Ad fact (aggregated into local timezone hourly buckets). Only for current + previous 3 months. Layer: Core Dataset Category: Fact Status: Published Primary Key: ingressed_at, env_namespace, catalog_id, retailer_id, supplier_id, campaign_id, ad_type, search_term, generic_search_term, product_code, content_standard_id, slot_id, category, placement, platform, target_product_code, placement_id, wallet_id, attribution_type Other Unique Key(s): None Partition: ingressed_at (by DAY) Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = fact_realised_ad_agg_3.env_namespace; dim_retailer on dim_retailer.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_retailer.retailer_id = fact_realised_ad_agg_3.retailer_id and dim_retailer.is_current; dim_catalog on dim_catalog.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_catalog.catalog_id = fact_realised_ad_agg_3.catalog_id and dim_catalog.is_current; dim_product on dim_product.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_product.catalog_id = fact_realised_ad_agg_3.catalog_id and dim_product.normalised_product_code = fact_realised_ad_agg_3.product_code; dim_supplier on dim_supplier.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_supplier.supplier_id = fact_realised_ad_agg_3.supplier_id and dim_supplier.is_current; dim_campaign on dim_campaign.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_campaign.campaign_id = fact_realised_ad_agg_3.campaign_id and dim_campaign.is_current; dim_search_term on dim_search_term.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_search_term.retailer_id = fact_realised_ad_agg_3.retailer_id and dim_search_term.search_term = fact_realised_ad_agg_3.search_term; dim_category on dim_category.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_category.category_id = fact_realised_ad_agg_3.category and dim_category.retailer_id = fact_realised_ad_agg_3.retailer_id; dim_placement on dim_placement.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_placement.placement = fact_realised_ad_agg_3.placement; Time Series Column: ingressed_at Aggregation Details: Source tables(s): fact_realised_ad (ingressed_at ,env ,namespace ,env_namespace ,catalog_id ,retailer_id ,supplier_id ,campaign_id ,ad_type ,search_term ,generic_search_term ,product_code ,content_standard_id ,slot_id ,category ,placement ,platform ,placement_id ,wallet_id, attribution_type ,target_product_code ,keyword ,ad_requester_team_id) | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `namespace` | `STRING` | Name of the Namespace. | | `ingressed_at` | `DATETIME` | Datetime the Ads were realised in local timezone. | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `campaign_id` | `STRING` | Internal identifier of the Campaign (from the source system). | | `supplier_id` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `search_term` | `STRING` | DEPRECATED. Please switch to using keyword. | | `generic_search_term` | `STRING` | DEPRECATED and will be removed in the future. Please use keyword instead. | | `product_code` | `STRING` | Product code. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `content_standard_id` | `STRING` | ContentStandardId as specified in the Ad Request. | | `slot_id` | `STRING` | Banner SlotId as specified in the Ad Request. | | `category` | `STRING` | Category being targeted. | | `placement` | `STRING` | Display name of the Placement. | | `platform` | `STRING` | The platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter. | | `ad_type` | `INTEGER` | Type of Ad (0 = Product, 1 = Banner, 4 = BannerX). | | `target_product_code` | `STRING` | Target Product code. | | `has_search_term` | `INTEGER` | Flag to indicate if the Ad is targeting a Search Term. | | `has_category` | `INTEGER` | Flag to indicate if the Ad is targeting a Category. | | `sales_revenue` | `NUMERIC` | Total sales revenue generated by Conversions. | | `ad_revenue` | `NUMERIC` | Portion of Ad spend retained by the Retailer. | | `ad_spend` | `NUMERIC` | Local currency amount charged by the Retailer to the Supplier for the Realised Ads. | | `impressions` | `NUMERIC` | Total impressions. | | `clicks` | `NUMERIC` | Number of Clicks. | | `conversions` | `NUMERIC` | Total standard Conversions (purchases of the exact Product in the Ad). | | `unit_sales` | `NUMERIC` | Total number of Products purchased from Conversions. | | `click_spend` | `NUMERIC` | AdSpend generated by clicks. | | `impression_spend` | `NUMERIC` | AdSpend generated by impressions. | | `wallet_id` | `STRING` | Internal identifier of the Wallet (from the source system). | | `attribution_type` | `STRING` | The type of attribution applied to the conversion (e.g. click-based, impression-based). | | `last_event_loaded_at` | `DATETIME` | Date the row was inserted into the source system. | | `position_sum` | `NUMERIC` | Sum of all postions for the Ads. Used to calculate average ad position (avg position = position_sum / ads_with_position_count). | | `ads_with_position_count` | `NUMERIC` | Total number of Ads that have a position set. avg position = position_sum / ads_with_position_count. | | `keyword` | `STRING` | The word/phrase being targeted by the campaign - set by the advertiser. | | `placement_id` | `STRING` | Internal identifier of the Placement (from the source system). | | `attributable_impressions` | `NUMERIC` | Subset of impressions that are considered attributable. | | `attributable_clicks` | `NUMERIC` | Subset of clicks that are considered attributable. | | `attributable_ad_spend` | `NUMERIC` | Subset of ad spend that is considered attributable. | # `analytics.fact_realised_ad_agg_3_ltz_live` - namespace Realised Ad fact (aggregated into local timezone hourly buckets). Only for current + previous 2 days. Layer: Core Dataset Category: Fact Status: Published Primary Key: ingressed_at, env_namespace, catalog_id, retailer_id, supplier_id, campaign_id, ad_type, search_term, generic_search_term, product_code, content_standard_id, slot_id, category, placement, platform, target_product_code, ad_requester_team_id, placement_id, wallet_id, attribution_type Other Unique Key(s): None Partition: ingressed_at (by DAY) Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = fact_realised_ad_agg_3.env_namespace; dim_retailer on dim_retailer.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_retailer.retailer_id = fact_realised_ad_agg_3.retailer_id and dim_retailer.is_current; dim_catalog on dim_catalog.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_catalog.catalog_id = fact_realised_ad_agg_3.catalog_id and dim_catalog.is_current; dim_product on dim_product.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_product.catalog_id = fact_realised_ad_agg_3.catalog_id and dim_product.normalised_product_code = fact_realised_ad_agg_3.product_code; dim_supplier on dim_supplier.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_supplier.supplier_id = fact_realised_ad_agg_3.supplier_id and dim_supplier.is_current; dim_campaign on dim_campaign.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_campaign.campaign_id = fact_realised_ad_agg_3.campaign_id and dim_campaign.is_current; dim_search_term on dim_search_term.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_search_term.retailer_id = fact_realised_ad_agg_3.retailer_id and dim_search_term.search_term = fact_realised_ad_agg_3.search_term; dim_category on dim_category.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_category.category_id = fact_realised_ad_agg_3.category and dim_category.retailer_id = fact_realised_ad_agg_3.retailer_id; dim_placement on dim_placement.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_placement.placement = fact_realised_ad_agg_3.placement; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `namespace` | `STRING` | Name of the Namespace. | | `ingressed_at` | `DATETIME` | Datetime the Ads were realised in local timezone. | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `campaign_id` | `STRING` | Internal identifier of the Campaign (from the source system). | | `supplier_id` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `search_term` | `STRING` | DEPRECATED. Please switch to using keyword. | | `generic_search_term` | `STRING` | DEPRECATED and will be removed in the future. Please use keyword instead. | | `product_code` | `STRING` | Product code. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `content_standard_id` | `STRING` | ContentStandardId as specified in the Ad Request. | | `slot_id` | `STRING` | Banner SlotId as specified in the Ad Request. | | `category` | `STRING` | Category being targeted. | | `placement` | `STRING` | Display name of the Placement. | | `platform` | `STRING` | The platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter. | | `ad_type` | `INTEGER` | Type of Ad (0 = Product, 1 = Banner, 4 = BannerX). | | `target_product_code` | `STRING` | Target Product code. | | `has_search_term` | `INTEGER` | Flag to indicate if the Ad is targeting a Search Term. | | `has_category` | `INTEGER` | Flag to indicate if the Ad is targeting a Category. | | `sales_revenue` | `NUMERIC` | Total sales revenue generated by Conversions. | | `ad_revenue` | `NUMERIC` | Portion of Ad spend retained by the Retailer. | | `ad_spend` | `NUMERIC` | Local currency amount charged by the Retailer to the Supplier for the Realised Ads. | | `impressions` | `NUMERIC` | Total impressions. | | `clicks` | `NUMERIC` | Number of Clicks. | | `conversions` | `NUMERIC` | Total standard Conversions (purchases of the exact Product in the Ad). | | `unit_sales` | `NUMERIC` | Total number of Products purchased from Conversions. | | `click_spend` | `NUMERIC` | AdSpend generated by clicks. | | `impression_spend` | `NUMERIC` | AdSpend generated by impressions. | | `wallet_id` | `STRING` | Internal identifier of the Wallet (from the source system). | | `attribution_type` | `STRING` | The type of attribution applied to the conversion (e.g. click-based, impression-based). | | `last_event_loaded_at` | `DATETIME` | Date the row was inserted into the source system. | | `position_sum` | `NUMERIC` | Sum of all postions for the Ads. Used to calculate average ad position (avg position = position_sum / ads_with_position_count). | | `ads_with_position_count` | `NUMERIC` | Total number of Ads that have a position set. avg position = position_sum / ads_with_position_count. | | `keyword` | `STRING` | The word/phrase being targeted by the campaign - set by the advertiser. | | `attributable_impressions` | `NUMERIC` | Total aatributable impressions. | | `attributable_clicks` | `NUMERIC` | Number of attributable Clicks. | | `attributable_ad_spend` | `NUMERIC` | Subset of ad spend that is considered attributable. | | `placement_id` | `STRING` | Internal identifier of the Placement (from the source system) | # `analytics.fact_realised_ad_agg_4a` - namespace - retailer Realised Ad fact (aggregated by day). Based on fact_realised_ad with keyword and keyword_matchtype. Includes metrics aggregated at the search term level. The main purpose of this dataset is to analyse the correlation of how end user search terms match with campaign defined keywords. Layer: Core Dataset Category: Fact Status: Published Primary Key: ingressed_at, env_namespace, catalog_id, retailer_id, supplier_id, campaign_id, ad_type, search_term, generic_search_term, product_code, content_standard_id, slot_id, category, placement, platform, target_product_code, placement_id, wallet_id, keyword, keyword_match_type Other Unique Key(s): None Partition: ingressed_at (by DAY) Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = fact_realised_ad_agg_4a.env_namespace; dim_retailer on dim_retailer.env_namespace = fact_realised_ad_agg_4a.env_namespace and dim_retailer.retailer_id = fact_realised_ad_agg_4a.retailer_id and dim_retailer.is_current; dim_catalog on dim_catalog.env_namespace = fact_realised_ad_agg_4a.env_namespace and dim_catalog.catalog_id = fact_realised_ad_agg_4a.catalog_id and dim_catalog.is_current; dim_product on dim_product.env_namespace = fact_realised_ad_agg_4a.env_namespace and dim_product.catalog_id = fact_realised_ad_agg_4a.catalog_id and dim_product.normalised_product_code = fact_realised_ad_agg_4a.product_code; dim_supplier on dim_supplier.env_namespace = fact_realised_ad_agg_4a.env_namespace and dim_supplier.supplier_id = fact_realised_ad_agg_4a.supplier_id and dim_supplier.is_current; dim_campaign on dim_campaign.env_namespace = fact_realised_ad_agg_4a.env_namespace and dim_campaign.campaign_id = fact_realised_ad_agg_4a.campaign_id and dim_campaign.is_current; dim_search_term on dim_search_term.env_namespace = fact_realised_ad_agg_4a.env_namespace and dim_search_term.retailer_id = fact_realised_ad_agg_4a.retailer_id and dim_search_term.search_term = fact_realised_ad_agg_4a.search_term; dim_category on dim_category.env_namespace = fact_realised_ad_agg_4a.env_namespace and dim_category.category_id = fact_realised_ad_agg_4a.category and dim_category.retailer_id = fact_realised_ad_agg_4a.retailer_id; dim_placement on dim_placement.env_namespace = fact_realised_ad_agg_4a.env_namespace and dim_placement.placement = fact_realised_ad_agg_4a.placement; Time Series Column: ingressed_at Aggregation Details: Source tables(s): fact_realised_ad ( env ,namespace ,env_namespace ,ingressed_at ,catalog_id ,campaign_id ,supplier_id ,keyword ,keyword_match_type ,product_code ,retailer_id ,slot_id ,placement ,platform ,ad_type ,target_product_code ,wallet_id ,search_term_metrics ,search_term) | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `namespace` | `STRING` | Name of the Namespace. | | `ingressed_at` | `DATE` | Date the Ads were realised. | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `campaign_id` | `STRING` | Internal identifier of the Campaign (from the source system). | | `supplier_id` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `product_code` | `STRING` | Product code. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `slot_id` | `STRING` | Banner SlotId as specified in the Ad Request. | | `placement` | `STRING` | Display name of the Placement. | | `platform` | `STRING` | The platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter. | | `ad_type` | `INTEGER` | Type of Ad (0 = Product, 1 = Banner, 4 = BannerX). | | `target_product_code` | `STRING` | Target Product code. | | `wallet_id` | `STRING` | Internal identifier of the Wallet (from the source system). | | `keyword` | `STRING` | The word/phrase being targeted by the campaign - set by the advertiser. | | `keyword_match_type` | `STRING` | Method used in matching the keyword to the user search term i.e. EXACT, PHRASE, etc. | | `search_term_metrics` | `RECORD` | Metrics for each search term | | `placement_id` | `STRING` | Internal identifier of the Placement (from the source system). | # `analytics.fact_realised_ad_agg_4a_ltz` - namespace - retailer Realised Ad fact (aggregated by day). Based on fact_realised_ad with keyword and keyword_matchtype. Includes metrics aggregated at the search term level. daily groups by retailer specified local timezone. The main purpose of this dataset is to analyse the correlation of how end user search terms match with campaign defined keywords. Layer: Core Dataset Category: Fact Status: Published Primary Key: ingressed_at, env_namespace, catalog_id, retailer_id, supplier_id, campaign_id, ad_type, search_term, generic_search_term, product_code, content_standard_id, slot_id, category, placement, platform, target_product_code, placement_id, wallet_id, keyword, keyword_match_type Other Unique Key(s): None Partition: ingressed_at (by DAY) Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = fact_realised_ad_agg_4a.env_namespace; dim_retailer on dim_retailer.env_namespace = fact_realised_ad_agg_4a.env_namespace and dim_retailer.retailer_id = fact_realised_ad_agg_4a.retailer_id and dim_retailer.is_current; dim_catalog on dim_catalog.env_namespace = fact_realised_ad_agg_4a.env_namespace and dim_catalog.catalog_id = fact_realised_ad_agg_4a.catalog_id and dim_catalog.is_current; dim_product on dim_product.env_namespace = fact_realised_ad_agg_4a.env_namespace and dim_product.catalog_id = fact_realised_ad_agg_4a.catalog_id and dim_product.normalised_product_code = fact_realised_ad_agg_4a.product_code; dim_supplier on dim_supplier.env_namespace = fact_realised_ad_agg_4a.env_namespace and dim_supplier.supplier_id = fact_realised_ad_agg_4a.supplier_id and dim_supplier.is_current; dim_campaign on dim_campaign.env_namespace = fact_realised_ad_agg_4a.env_namespace and dim_campaign.campaign_id = fact_realised_ad_agg_4a.campaign_id and dim_campaign.is_current; dim_search_term on dim_search_term.env_namespace = fact_realised_ad_agg_4a.env_namespace and dim_search_term.retailer_id = fact_realised_ad_agg_4a.retailer_id and dim_search_term.search_term = fact_realised_ad_agg_4a.search_term; dim_category on dim_category.env_namespace = fact_realised_ad_agg_4a.env_namespace and dim_category.category_id = fact_realised_ad_agg_4a.category and dim_category.retailer_id = fact_realised_ad_agg_4a.retailer_id; dim_placement on dim_placement.env_namespace = fact_realised_ad_agg_4a.env_namespace and dim_placement.placement = fact_realised_ad_agg_4a.placement; Time Series Column: ingressed_at Aggregation Details: Source tables(s): fact_realised_ad ( env ,namespace ,env_namespace ,ingressed_at ,catalog_id ,campaign_id ,supplier_id ,keyword ,keyword_match_type ,product_code ,retailer_id ,slot_id ,placement ,platform ,ad_type ,target_product_code ,wallet_id ,search_term_metrics ,search_term) | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `namespace` | `STRING` | Name of the Namespace. | | `ingressed_at` | `DATE` | Date the Ads were realised. | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `campaign_id` | `STRING` | Internal identifier of the Campaign (from the source system). | | `supplier_id` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `product_code` | `STRING` | Product code. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `slot_id` | `STRING` | Banner SlotId as specified in the Ad Request. | | `placement` | `STRING` | Display name of the Placement. | | `platform` | `STRING` | The platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter. | | `ad_type` | `INTEGER` | Type of Ad (0 = Product, 1 = Banner, 4 = BannerX). | | `target_product_code` | `STRING` | Target Product code. | | `wallet_id` | `STRING` | Internal identifier of the Wallet (from the source system). | | `keyword` | `STRING` | The word/phrase being targeted by the campaign - set by the advertiser. | | `keyword_match_type` | `STRING` | Method used in matching the keyword to the user search term i.e. EXACT, PHRASE, etc. | | `search_term_metrics` | `RECORD` | Metrics for each search term | | `placement_id` | `STRING` | Internal identifier of the Placement (from the source system). | # `analytics.fact_realised_ad_agg_ltz` - namespace - retailer Realised Ad fact (aggregated into local timezone day buckets). Layer: Core Dataset Category: Fact Status: Published Primary Key: ingressed_at, env_namespace, catalog_id, retailer_id, supplier_id, campaign_id, ad_type, search_term, generic_search_term, product_code, content_standard_id, slot_id, category, placement, platform, target_product_code, ad_requester_team_id, placement_id, wallet_id, attribution_type, namespace, keyword Other Unique Key(s): realised_ad_agg_key Partition: ingressed_at (by DAY) Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = fact_realised_ad_agg.env_namespace; dim_retailer on dim_retailer.env_namespace = fact_realised_ad_agg.env_namespace and dim_retailer.retailer_id = fact_realised_ad_agg.retailer_id and dim_retailer.is_current; dim_catalog on dim_catalog.env_namespace = fact_realised_ad_agg.env_namespace and dim_catalog.catalog_id = fact_realised_ad_agg.catalog_id and dim_catalog.is_current; dim_product on dim_product.env_namespace = fact_realised_ad_agg.env_namespace and dim_product.catalog_id = fact_realised_ad_agg.catalog_id and dim_product.normalised_product_code = fact_realised_ad_agg.product_code; dim_supplier on dim_supplier.env_namespace = fact_realised_ad_agg.env_namespace and dim_supplier.supplier_id = fact_realised_ad_agg.supplier_id and dim_supplier.is_current; dim_campaign on dim_campaign.env_namespace = fact_realised_ad_agg.env_namespace and dim_campaign.campaign_id = fact_realised_ad_agg.campaign_id and dim_campaign.is_current; dim_search_term on dim_search_term.env_namespace = fact_realised_ad_agg.env_namespace and dim_search_term.retailer_id = fact_realised_ad_agg.retailer_id and dim_search_term.search_term = fact_realised_ad_agg.search_term; dim_category on dim_category.env_namespace = fact_realised_ad_agg.env_namespace and dim_category.category_id = fact_realised_ad_agg.category and dim_category.retailer_id = fact_realised_ad_agg.retailer_id; dim_placement on dim_placement.env_namespace = fact_realised_ad_agg.env_namespace and dim_placement.placement = fact_realised_ad_agg.placement; Time Series Column: ingressed_at Aggregation Details: Source tables(s): fact_realised_ad (ingressed_at ,env ,namespace ,env_namespace ,catalog_id ,retailer_id ,supplier_id ,campaign_id ,ad_type ,search_term ,generic_search_term ,product_code ,content_standard_id ,slot_id ,category ,placement ,platform ,placement_id ,wallet_id, attribution_type ,target_product_code ,keyword ,ad_requester_team_id) | Column Name | Data Type | Description | |-------------|-----------|-------------| | `realised_ad_agg_key` | `STRING` | Unique identifier of the row in this table (surrogate key). | | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `supplier_id` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `campaign_id` | `STRING` | Internal identifier of the Campaign (from the source system). | | `ingressed_at` | `DATE` | Date the Ads were realised in local timezone. | | `namespace` | `STRING` | Name of the Namespace. | | `ad_type` | `INTEGER` | Type of Ad (0 = Product, 1 = Banner, 4 = BannerX). | | `search_term` | `STRING` | DEPRECATED. Please switch to using keyword. | | `generic_search_term` | `STRING` | DEPRECATED. Please switch to using keyword. | | `product_code` | `STRING` | Product code. | | `content_standard_id` | `STRING` | ContentStandardId as specified in the Ad Request. | | `slot_id` | `STRING` | Banner SlotId as specified in the Ad Request. | | `category` | `STRING` | Category being targeted. | | `placement` | `STRING` | Display name of the Placement. | | `platform` | `STRING` | The platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter. | | `impressions` | `NUMERIC` | Total impressions. | | `clicks` | `NUMERIC` | Number of Clicks. | | `conversions` | `NUMERIC` | Total standard Conversions (purchases of the exact Product in the Ad). | | `unit_sales` | `NUMERIC` | Total number of Products purchased from Conversions. | | `ad_spend` | `NUMERIC` | Local currency amount charged by the Retailer to the Supplier for the Realised Ads. | | `impression_spend` | `NUMERIC` | AdSpend generated by impressions. | | `click_spend` | `NUMERIC` | AdSpend generated by clicks. | | `ad_revenue` | `NUMERIC` | Portion of Ad spend retained by the Retailer. | | `sales_revenue` | `NUMERIC` | Total sales revenue generated by Conversions. | | `target_product_code` | `STRING` | Target Product code. | | `position_sum` | `NUMERIC` | Sum of all postions for the Ads. Used to calculate average ad position (avg position = position_sum / ads_with_position_count). | | `ads_with_position_count` | `NUMERIC` | Total number of Ads that have a position set. avg position = position_sum / ads_with_position_count. | | `etl_created_at` | `TIMESTAMP` | Date the row was inserted into this table (not the date the record was created in the source system). | | `etl_modified_at` | `TIMESTAMP` | Date this row was last updated (not the date the record was updated in the source system). | | `ad_requester_team_id` | `STRING` | Internal identifier of the Team (from the source system). | | `email_serve_revenue` | `NUMERIC` | Email serve revenue. | | `invalid_ad_revenue` | `NUMERIC` | Total invalid revenue. | | `placement_id` | `STRING` | Internal identifier of the Placement (from the source system). | | `wallet_id` | `STRING` | Internal identifier of the Wallet (from the source system). | | `attribution_type` | `STRING` | The type of attribution applied to the conversion (e.g. click-based, impression-based). | | `last_event_loaded_at` | `DATETIME` | Date the row was inserted into the source system. | | `keyword` | `STRING` | The word/phrase being targeted by the campaign - set by the advertiser. | | `attributable_impressions` | `NUMERIC` | Subset of impressions that are considered attributable. | | `attributable_clicks` | `NUMERIC` | Subset of clicks that are considered attributable. | | `attributable_ad_spend` | `NUMERIC` | Subset of ad spend that is considered attributable. | # `analytics.fact_report_request_tracking` - namespace - retailer CitrusAd client reporting usage fact. Layer: Core Dataset Category: Fact Status: Published Primary Key: report_request_tracking_id Other Unique Key(s): report_request_tracking_key Partition: request_date (by DAY) Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = fact_report_request_tracking.env_namespace; dim_team on dim_team.env_namespace = fact_report_request_tracking.env_namespace and dim_team.team_id = fact_report_request_tracking.team_id and dim_team.is_current; dim_user on dim_user.env_namespace = fact_report_request_tracking.env_namespace and dim_user.user_id = fact_report_request_tracking.user_id and dim_user.is_current; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `report_request_tracking_key` | `STRING` | Unique identifier of the row in this table (surrogate key). | | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `report_request_tracking_id` | `STRING` | Internal identifier of the Report Request (from the source system). | | `user_id` | `STRING` | Internal identifier of the User (from the source system). | | `team_id` | `STRING` | Internal identifier of the Team (from the source system). | | `report_type` | `STRING` | Type of report. | | `cache_level` | `STRING` | Cache level. | | `report_span` | `STRING` | Span of report. | | `request_date` | `DATE` | Date of the report request. | | `request_date_key` | `INTEGER` | Unique identifier of the row in this table (surrogate key). | | `request_time` | `TIMESTAMP` | Request time. | | `namespace` | `STRING` | Name of the Namespace. | | `counts_towards_quota` | `BOOLEAN` | Flag indicating of usage counts towards quota. | | `big_query_billed_bytes` | `NUMERIC` | Total bytes billed. | | `big_query_execution_duration_seconds` | `NUMERIC` | Total duration of all queries. | | `big_query_finished_polling_duration_seconds` | `NUMERIC` | Total polling duration of all queries. | | `total_execution_duration_seconds` | `NUMERIC` | Total execution duration of the report. | | `max_billed_bytes_per_day` | `NUMERIC` | Max billed bytes per day. | | `max_billed_bytes_per_month` | `NUMERIC` | Max billed bytes per month. | | `max_uncached_requests_per_day` | `NUMERIC` | Max uncached requests per day. | | `max_uncached_requests_per_month` | `NUMERIC` | Max uncached requests per month. | | `etl_created_at` | `TIMESTAMP` | Date the row was inserted into this table (not the date the record was created in the source system). | | `etl_modified_at` | `TIMESTAMP` | Date this row was last updated (not the date the record was updated in the source system). | # `analytics.fact_user_team` - namespace - retailer List of all Team Users. Layer: Core Dataset Category: Fact Status: Published Primary Key: user_id, team_id, env_namespace Other Unique Key(s): user_team_key Partition: None Foreign Key(s): dim_env_namespace on dim_env_namespace.env_namespace = fact_user_team.env_namespace; dim_team on dim_team.env_namespace = fact_user_team.env_namespace and dim_team.team_id = fact_user_team.team_id and dim_team.is_current; dim_user on dim_user.env_namespace = fact_user_team.env_namespace and dim_user.user_id = fact_user_team.user_id and dim_user.is_current; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `user_team_key` | `STRING` | Unique identifier of the row in this table (surrogate key). | | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `user_id` | `STRING` | Internal identifier of the User (from the source system). | | `team_id` | `STRING` | Internal identifier of the Team (from the source system). | | `role_ids` | `STRING` | Role ids. | | `last_edit_date` | `TIMESTAMP` | Date of the last edit. | | `last_edit_date_utc` | `TIMESTAMP` | Currently the same as last_edit_date since all data is in UTC. | | `etl_created_at` | `TIMESTAMP` | Date the row was inserted into this table (not the date the record was created in the source system). | | `etl_modified_at` | `TIMESTAMP` | Date this row was last updated (not the date the record was updated in the source system). | # `analytics.log_status` - namespace - retailer Logging table. Records when this dataset has been updated (both start time and end time with status). Layer: Core Dataset Category: Logging Status: Published Primary Key: jobid, logging_datetime_utc, status Other Unique Key(s): jobid Partition: None Foreign Key(s): None | Column Name | Data Type | Description | |-------------|-----------|-------------| | `jobid` | `STRING` | Id for the Job being executed. | | `logging_datetime_utc` | `DATETIME` | Date and time the Job log entry was made. | | `job_name` | `STRING` | Label indicating what core dataset the Job is for. | | `status` | `STRING` | Indicate if the Job is running or completed. | | `return_code` | `STRING` | Indicate if the completed status was successful (0) or failed (1). | # `reporting.ad_request__realised_ad_ltz_view` - namespace Union of ad_request_agg_view and realised_ad_agg_view (local timezone). Allows for convenient calculation of measures that require both Request and Realised Ad statistics (for example a ratio of impressions vs ads requested). Layer: Reporting Datamart Category: Fact Decorated View Status: Published Primary Key: Refer to realised_ad_agg_view Other Unique Key(s): Partition: Refer to realised_ad_agg_view Foreign Key(s): Refer to view code | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `ingressed_at` | `DATE` | Date when the ad request and realised ad data was ingested. | | `ad_type` | `INTEGER` | Type identifier for the ad format or placement type. | | `search_term` | `STRING` | The word/phrase being searched for on the retailer site by the end user. | | `generic_search_term` | `STRING` | Generic version of the search term, if applicable. | | `reserved_search_term_flag` | `STRING` | Indicates if the search term is a reserved keyword. | | `placement` | `STRING` | Specific placement or location of the ad. | | `platform` | `STRING` | Platform where the ad is served (e.g., web, mobile). | | `page_type` | `INTEGER` | Identifier for the type of page the ad is displayed on. | | `filter_mode` | `INTEGER` | Mode of filtering applied to the ad request. | | `slot_id` | `STRING` | Identifier for the ad slot. | | `category` | `STRING` | Category of the ad content. | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `catalog_name` | `STRING` | Name of the product catalog. | | `retailer_id` | `STRING` | Internal identifier of the Retailer (from the source system). | | `retailer_name` | `STRING` | Display name of the Retailer. | | `retailer_industry` | `STRING` | Industry category of the retailer. | | `retailer_business_identifier` | `STRING` | Business identifier for the retailer. | | `retailer_company_name` | `STRING` | Company name of the retailer. | | `retailer_group_1` | `STRING` | First level group classification for the retailer. | | `retailer_group_2` | `STRING` | Second level group classification for the retailer. | | `geo_region` | `STRING` | Geographical region of the ad request. | | `local_timezone` | `STRING` | Local timezone of the ad request. | | `has_search_term` | `INTEGER` | Indicates if a search term is present. | | `has_category` | `INTEGER` | Indicates if a category is associated. | | `num_ads_considered` | `NUMERIC` | Number of ads considered for the request. | | `num_ads_served` | `NUMERIC` | Number of ads served. | | `num_ads_requested` | `NUMERIC` | Number of ads requested. | | `capped_num_ads_served` | `NUMERIC` | Capped number of ads served. | | `capped_num_ads_requested` | `NUMERIC` | Capped number of ads requested. | | `capped_num_requests_serving_max_ads` | `NUMERIC` | Capped number of requests serving the maximum number of ads. | | `num_requests_serving_max_ads` | `NUMERIC` | Number of requests serving the maximum number of ads. | | `num_ad_requests_serving_no_ads` | `NUMERIC` | Number of ad requests that served no ads. | | `num_ad_requests_serving_some_ads` | `NUMERIC` | Number of ad requests that served some ads. | | `num_ad_requests` | `NUMERIC` | Total number of ad requests. | | `num_ad_requests_with_saturation` | `NUMERIC` | Number of ad requests with saturation. | | `campaign_id` | `STRING` | Internal identifier of the Campaign (from the source system). | | `campaign_name` | `STRING` | Display name of the Campaign. | | `supplier_id` | `STRING` | Identifier for the supplier. | | `supplier_name` | `STRING` | Name of the supplier. | | `supplier_industry` | `STRING` | Industry category of the supplier. | | `supplier_business_identifier` | `STRING` | Business identifier for the supplier. | | `supplier_company_name` | `STRING` | Company name of the supplier. | | `product_code` | `STRING` | Code identifying the product. | | `content_standard_id` | `STRING` | Identifier for the content standard. | | `target_product_code` | `STRING` | Target product code for the ad. | | `supplier_group_1` | `STRING` | First level group classification for the supplier. | | `supplier_group_2` | `STRING` | Second level group classification for the supplier. | | `supplier_group_3` | `STRING` | Third level group classification for the supplier. | | `supplier_group_4` | `STRING` | Fourth level group classification for the supplier. | | `sales_revenue` | `NUMERIC` | Revenue generated from sales. | | `ad_revenue` | `NUMERIC` | Revenue generated from ads. | | `ad_spend` | `NUMERIC` | Amount spent on ads. | | `impressions` | `NUMERIC` | Number of times ads were displayed. | | `clicks` | `NUMERIC` | Number of times ads were clicked. | | `conversions` | `NUMERIC` | Number of conversions attributed to the ads. | | `unit_sales` | `NUMERIC` | Number of units sold. | | `click_spend` | `NUMERIC` | Amount spent on clicks. | | `impression_spend` | `NUMERIC` | Amount spent per impression. | | `position_sum` | `NUMERIC` | Sum of positions where the ad was displayed. | | `sales_revenue_usd` | `FLOAT` | Revenue generated from sales in USD. | | `ad_revenue_usd` | `FLOAT` | Revenue generated from ads in USD. | | `ad_spend_usd` | `FLOAT` | Amount spent on ads in USD. | | `placement_id` | `STRING` | Identifier for the ad placement. | | `wallet_id` | `STRING` | Identifier for the wallet associated with the ad. | | `last_event_loaded_at` | `DATETIME` | Date the row was inserted into the source system. | | `source_type` | `STRING` | Name of source table. |

SQL Query

```sql select env, env_namespace, ingressed_at, ad_type, search_term, generic_search_term, reserved_search_term_flag, placement, platform, page_type, filter_mode, slot_id, category, catalog_id, catalog_name, retailer_id, retailer_name, retailer_industry, retailer_business_identifier, retailer_company_name, retailer_group_1, retailer_group_2, geo_region, local_timezone, has_search_term, has_category, num_ads_considered, num_ads_served, num_ads_requested, capped_num_ads_served, capped_num_ads_requested, capped_num_requests_serving_max_ads, num_requests_serving_max_ads, num_ad_requests_serving_no_ads, num_ad_requests_serving_some_ads, num_ad_requests, num_ad_requests_with_saturation, null as campaign_id, null as campaign_name, null as supplier_id, null as supplier_name, null as supplier_industry, null as supplier_business_identifier, null as supplier_company_name, null as product_code, null as content_standard_id, null as target_product_code, null as supplier_group_1, null as supplier_group_2, null as supplier_group_3, null as supplier_group_4, null as sales_revenue, null as ad_revenue, null as ad_spend, null as impressions, null as clicks, null as conversions, null as unit_sales, null as click_spend, null as impression_spend, null as position_sum, null as sales_revenue_usd, null as ad_revenue_usd, null as ad_spend_usd, placement_id, null as wallet_id, null as last_event_loaded_at, 'ad_request_agg_ltz' as source_type from reporting.ad_request_agg_ltz_view union all select env, env_namespace, ingressed_at , ad_type, search_term, generic_search_term, null as reserved_search_term_flag, placement, platform, null as page_type, null as filter_mode, slot_id, category, catalog_id, catalog_name, retailer_id, retailer_name, retailer_industry, retailer_business_identifier, retailer_company_name, retailer_group_1, retailer_group_2, geo_region, local_timezone, if(ifnull(search_term,'') <> '', 1, 0) as has_search_term, if(ifnull(category,'')<> '', 1, 0) as has_category, null as num_ads_considered, null as num_ads_served, null as num_ads_requested, null as capped_num_ads_served, null as capped_num_ads_requested, null as capped_num_requests_serving_max_ads, null as num_requests_serving_max_ads, null as num_ad_requests_serving_no_ads, null as num_ad_requests_serving_some_ads, null as num_ad_requests, null as num_ad_requests_with_saturation, campaign_id, campaign_name, supplier_id, supplier_name, supplier_industry, supplier_business_identifier, supplier_company_name, product_code, content_standard_id, target_product_code, supplier_group_1, supplier_group_2, supplier_group_3, supplier_group_4, sales_revenue, ad_revenue, ad_spend, impressions, clicks, conversions, unit_sales, click_spend, impression_spend, position_sum, sales_revenue_usd, ad_revenue_usd, ad_spend_usd, placement_id, wallet_id, last_event_loaded_at, source_type from reporting.realised_ad_agg_ltz_view ```

# `reporting.ad_request__realised_ad_view` - retailer - namespace Union of ad_request_agg_view and realised_ad_agg_view. Allows for convenient calculation of measures that require both Request and Realised Ad statistics (for example a ratio of impressions vs ads requested). Layer: Reporting Datamart Category: Fact Decorated View Status: Published Primary Key: Refer to realised_ad_agg_view Other Unique Key(s): Partition: Refer to realised_ad_agg_view Foreign Key(s): Refer to view code | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `ingressed_at` | `DATE` | Date when the ad request and realised ad data was ingested. | | `ad_type` | `INTEGER` | Type identifier for the ad format or placement type. | | `search_term` | `STRING` | The word/phrase being searched for on the retailer site by the end user. | | `generic_search_term` | `STRING` | Generic version of the search term, if applicable. | | `reserved_search_term_flag` | `STRING` | Indicates if the search term is a reserved keyword. | | `placement` | `STRING` | Specific placement or location of the ad. | | `platform` | `STRING` | Platform where the ad is served (e.g., web, mobile). | | `page_type` | `INTEGER` | Identifier for the type of page the ad is displayed on. | | `filter_mode` | `INTEGER` | Mode of filtering applied to the ad request. | | `slot_id` | `STRING` | Identifier for the ad slot. | | `category` | `STRING` | Category of the ad content. | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `catalog_name` | `STRING` | Name of the product catalog. | | `retailer_id` | `STRING` | Internal identifier of the Retailer (from the source system). | | `retailer_name` | `STRING` | Display name of the Retailer. | | `retailer_industry` | `STRING` | Industry category of the retailer. | | `retailer_business_identifier` | `STRING` | Business identifier for the retailer. | | `retailer_company_name` | `STRING` | Company name of the retailer. | | `retailer_group_1` | `STRING` | First level group classification for the retailer. | | `retailer_group_2` | `STRING` | Second level group classification for the retailer. | | `geo_region` | `STRING` | Geographical region of the ad request. | | `local_timezone` | `STRING` | Local timezone of the ad request. | | `has_search_term` | `INTEGER` | Indicates if a search term is present. | | `has_category` | `INTEGER` | Indicates if a category is associated. | | `num_ads_considered` | `NUMERIC` | Number of ads considered for the request. | | `num_ads_served` | `NUMERIC` | Number of ads served. | | `num_ads_requested` | `NUMERIC` | Number of ads requested. | | `capped_num_ads_served` | `NUMERIC` | Capped number of ads served. | | `capped_num_ads_requested` | `NUMERIC` | Capped number of ads requested. | | `capped_num_requests_serving_max_ads` | `NUMERIC` | Capped number of requests serving the maximum number of ads. | | `num_requests_serving_max_ads` | `NUMERIC` | Number of requests serving the maximum number of ads. | | `num_ad_requests_serving_no_ads` | `NUMERIC` | Number of ad requests that served no ads. | | `num_ad_requests_serving_some_ads` | `NUMERIC` | Number of ad requests that served some ads. | | `num_ad_requests` | `NUMERIC` | Total number of ad requests. | | `num_ad_requests_with_saturation` | `NUMERIC` | Number of ad requests with saturation. | | `campaign_id` | `STRING` | Internal identifier of the Campaign (from the source system). | | `campaign_name` | `STRING` | Display name of the Campaign. | | `supplier_id` | `STRING` | Identifier for the supplier. | | `supplier_name` | `STRING` | Name of the supplier. | | `supplier_industry` | `STRING` | Industry category of the supplier. | | `supplier_business_identifier` | `STRING` | Business identifier for the supplier. | | `supplier_company_name` | `STRING` | Company name of the supplier. | | `product_code` | `STRING` | Code identifying the product. | | `content_standard_id` | `STRING` | Identifier for the content standard. | | `target_product_code` | `STRING` | Target product code for the ad. | | `supplier_group_1` | `STRING` | First level group classification for the supplier. | | `supplier_group_2` | `STRING` | Second level group classification for the supplier. | | `supplier_group_3` | `STRING` | Third level group classification for the supplier. | | `supplier_group_4` | `STRING` | Fourth level group classification for the supplier. | | `sales_revenue` | `NUMERIC` | Revenue generated from sales. | | `ad_revenue` | `NUMERIC` | Revenue generated from ads. | | `ad_spend` | `NUMERIC` | Amount spent on ads. | | `impressions` | `NUMERIC` | Number of times ads were displayed. | | `clicks` | `NUMERIC` | Number of times ads were clicked. | | `conversions` | `NUMERIC` | Number of conversions attributed to the ads. | | `unit_sales` | `NUMERIC` | Number of units sold. | | `click_spend` | `NUMERIC` | Amount spent on clicks. | | `impression_spend` | `NUMERIC` | Amount spent per impression. | | `position_sum` | `NUMERIC` | Sum of positions where the ad was displayed. | | `sales_revenue_usd` | `FLOAT` | Revenue generated from sales in USD. | | `ad_revenue_usd` | `FLOAT` | Revenue generated from ads in USD. | | `ad_spend_usd` | `FLOAT` | Amount spent on ads in USD. | | `placement_id` | `STRING` | Identifier for the ad placement. | | `wallet_id` | `STRING` | Internal identifier of the Wallet (from the source system). | | `last_event_loaded_at` | `TIMESTAMP` | Date the row was inserted into the source system. | | `source_type` | `STRING` | Name of source table. |

SQL Query

```sql select env, env_namespace, ingressed_at, ad_type, search_term, generic_search_term, reserved_search_term_flag, placement, platform, page_type, filter_mode, slot_id, category, catalog_id, catalog_name, retailer_id, retailer_name, retailer_industry, retailer_business_identifier, retailer_company_name, retailer_group_1, retailer_group_2, geo_region, local_timezone, has_search_term, has_category, num_ads_considered, num_ads_served, num_ads_requested, capped_num_ads_served, capped_num_ads_requested, capped_num_requests_serving_max_ads, num_requests_serving_max_ads, num_ad_requests_serving_no_ads, num_ad_requests_serving_some_ads, num_ad_requests, num_ad_requests_with_saturation, null as campaign_id, null as campaign_name, null as supplier_id, null as supplier_name, null as supplier_industry, null as supplier_business_identifier, null as supplier_company_name, null as product_code, null as content_standard_id, null as target_product_code, null as supplier_group_1, null as supplier_group_2, null as supplier_group_3, null as supplier_group_4, null as sales_revenue, null as ad_revenue, null as ad_spend, null as impressions, null as clicks, null as conversions, null as unit_sales, null as click_spend, null as impression_spend, null as position_sum, null as sales_revenue_usd, null as ad_revenue_usd, null as ad_spend_usd, placement_id, null as wallet_id, null as last_event_loaded_at, 'ad_request_agg' as source_type from reporting.ad_request_agg_view union all select env, env_namespace, ingressed_at , ad_type, search_term, generic_search_term, null as reserved_search_term_flag, placement, platform, null as page_type, null as filter_mode, slot_id, category, catalog_id, catalog_name, retailer_id, retailer_name, retailer_industry, retailer_business_identifier, retailer_company_name, retailer_group_1, retailer_group_2, geo_region, local_timezone, if(ifnull(search_term,'') <> '', 1, 0) as has_search_term, if(ifnull(category,'')<> '', 1, 0) as has_category, null as num_ads_considered, null as num_ads_served, null as num_ads_requested, null as capped_num_ads_served, null as capped_num_ads_requested, null as capped_num_requests_serving_max_ads, null as num_requests_serving_max_ads, null as num_ad_requests_serving_no_ads, null as num_ad_requests_serving_some_ads, null as num_ad_requests, null as num_ad_requests_with_saturation, campaign_id, campaign_name, supplier_id, supplier_name, supplier_industry, supplier_business_identifier, supplier_company_name, product_code, content_standard_id, target_product_code, supplier_group_1, supplier_group_2, supplier_group_3, supplier_group_4, sales_revenue, ad_revenue, ad_spend, impressions, clicks, conversions, unit_sales, click_spend, impression_spend, position_sum, sales_revenue_usd, ad_revenue_usd, ad_spend_usd, placement_id, wallet_id, last_event_loaded_at, source_type from reporting.realised_ad_agg_view ```

# `reporting.ad_request_agg` - retailer - namespace Request data (aggregated). Layer: Reporting Datamart Category: Fact Status: Published Primary Key: env_namespace, ingressed_at, retailer_id, catalog_id, search_term, placement, platform, reserved_search_term_flag, generic_search_term, ad_type, page_type, filter_mode, slot_ids, category, has_search_term, has_category Other Unique Key(s): Partition: ingressed_at (by DAY) Foreign Key(s): env_namespace on env_namespace.env_namespace = ad_request_agg.env_namespace; retailer on retailer.env_namespace = ad_request_agg.env_namespace and retailer.retailer_id = ad_request_agg.retailer_id; catalog on catalog.env_namespace = ad_request_agg.env_namespace and catalog.catalog_id = ad_request_agg.catalog_id; placement on placement.env_namespace = ad_request_agg.env_namespace and placement.placement_id = ad_request_agg.placement_id; search_term on search_term.env_namespace = ad_request_agg.env_namespace and search_term.retailer_id = ad_request_agg.retailer_id and search_term.search_term = ad_request_agg.search_term; category on category.env_namespace = ad_request_agg.env_namespace and category.category_id = ad_request_agg.category and category.retailer_id = ad_request_agg.retailer_id; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `ingressed_at` | `DATE` | Date the Requests were received. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `search_term` | `STRING` | The word/phrase being searched for on the retailer site by the end user. | | `placement` | `STRING` | Display name of the Placement. | | `platform` | `STRING` | The platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter. | | `reserved_search_term_flag` | `STRING` | Not in use. | | `generic_search_term` | `STRING` | Same as SearchTerm except leading and trailing whitespace is removed to improve consolidation. | | `ad_type` | `INTEGER` | Type of Ad (0 = Product, 1 = Banner, 4 = BannerX). | | `page_type` | `INTEGER` | Legacy, superseded by Placement. | | `filter_mode` | `INTEGER` | The filterMode used to structure the productFilters in the ad request. Defaults in OR_AND if not specified. (OR_AND, AND_OR). | | `slot_ids` | `STRING` | Slot ids. | | `category` | `STRING` | Category being targeted. | | `has_search_term` | `INTEGER` | Flag to indicate if the Request is targeting a Search Term. | | `has_category` | `INTEGER` | Flag to indicate if the Request is targeting a Category. | | `retailer_group_1` | `STRING` | Retailer group membership #1. | | `retailer_group_2` | `STRING` | Retailer group membership #2. | | `num_ads_considered` | `NUMERIC` | Total number of Ad candidates that were considered by relevancy algorithms. | | `num_ads_served` | `NUMERIC` | Total number of Ads that were served back. | | `num_ads_requested` | `NUMERIC` | Total number of Ads that were requested by the Requests. | | `capped_num_ads_served` | `NUMERIC` | Total number of Ads that were served back with Cap applied per Request. | | `capped_num_ads_requested` | `NUMERIC` | Total number of Ads that were requested with Cap applied per Request. | | `capped_num_requests_serving_max_ads` | `NUMERIC` | Total number of Requests where the number of Ads requested was served in full. | | `num_requests_serving_max_ads` | `NUMERIC` | Total number of Requests where the number of Ads requested was served in full. | | `num_ad_requests_serving_no_ads` | `NUMERIC` | Total number of Requests where no Ads were served. | | `num_ad_requests_serving_some_ads` | `NUMERIC` | Total number of Requests where at least 1 Ad was served. | | `num_ad_requests` | `NUMERIC` | Total number of Requests. | | `num_ad_requests_with_saturation` | `NUMERIC` | Total number of Requests that served at least 4 Ads or filled the entire Request (if < 4 were requested). | | `placement_id` | `STRING` | Internal identifier of the Placement (from the source system). | | `namespace` | `STRING` | Name of the Namespace. | # `reporting.ad_request_agg_ltz_view` - namespace Request view (aggregated in local timezone). Decorated version of ad_request_agg. Layer: Reporting Datamart Category: Fact Decorated View Status: Published Primary Key: Refer to ad_request_agg Other Unique Key(s): Partition: Refer to ad_request_agg Foreign Key(s): Refer to view code | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `ingressed_at` | `DATE` | Date the Ads were realised. | | `ad_type` | `INTEGER` | Type of Ad (0 = Product, 1 = Banner, 4 = BannerX). | | `search_term` | `STRING` | The word/phrase being searched for on the retailer site by the end user. | | `generic_search_term` | `STRING` | Same as SearchTerm except leading and trailing whitespace is removed to improve consolidation. | | `reserved_search_term_flag` | `STRING` | Not in use. | | `placement` | `STRING` | Display name of the Placement. | | `platform` | `STRING` | The platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter. | | `page_type` | `INTEGER` | Legacy, superseded by Placement. | | `filter_mode` | `INTEGER` | The filterMode used to structure the productFilters in the ad request. Defaults in OR_AND if not specified. (OR_AND, AND_OR). | | `slot_id` | `STRING` | Banner SlotId as specified in the Ad Request. | | `category` | `STRING` | Category being targeted. | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `catalog_name` | `STRING` | Name of the Catalog. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `retailer_name` | `STRING` | Name of the Retailer. | | `retailer_industry` | `STRING` | Industry of the Retailer. | | `retailer_business_identifier` | `STRING` | Implementation specific generic label. | | `retailer_company_name` | `STRING` | Company name of the Retailer. | | `retailer_group_1` | `STRING` | Retailer team group membership #1. | | `retailer_group_2` | `STRING` | Retailer team group membership #2. | | `geo_region` | `STRING` | Geographical region of the Namespace (as defined by CitrusAd). | | `local_timezone` | `STRING` | Not in use. | | `has_search_term` | `INTEGER` | Flag to indicate if the Ad is targeting a Search Term. | | `has_category` | `INTEGER` | Flag to indicate if the Ad is targeting a Category. | | `namespace` | `STRING` | Name of the Namespace. | | `ad_type_name` | `STRING` | Human readable name for the ad type | | `num_ads_considered` | `NUMERIC` | Total number of Ad candidates that were considered by relevancy algorithms. | | `num_ads_served` | `NUMERIC` | Total number of Ads that were served back. | | `num_ads_requested` | `NUMERIC` | Total number of Ads that were requested by the Requests. | | `capped_num_ads_served` | `NUMERIC` | Total number of Ads that were served back with Cap applied per Request. | | `capped_num_ads_requested` | `NUMERIC` | Total number of Ads that were requested with Cap applied per Request. | | `capped_num_requests_serving_max_ads` | `NUMERIC` | Total number of Requests where the number of Ads requested was served in full. | | `num_requests_serving_max_ads` | `NUMERIC` | Total number of Requests where the number of Ads requested was served in full. | | `num_ad_requests_serving_no_ads` | `NUMERIC` | Total number of Requests where no Ads were served. | | `num_ad_requests_serving_some_ads` | `NUMERIC` | Total number of Requests where at least 1 Ad was served. | | `num_ad_requests` | `NUMERIC` | Total number of Requests. | | `num_ad_requests_with_saturation` | `NUMERIC` | Total number of Requests that served at least 4 Ads or filled the entire Request (if < 4 were requested). | | `placement_id` | `STRING` | Internal identifier of the Placement (from the source system). |

SQL Query

```sql select far.env env, far.env_namespace env_namespace, far.ingressed_at as ingressed_at, far.ad_type, far.search_term as search_term, far.generic_search_term as generic_search_term, far.reserved_search_term_flag reserved_search_term_flag, far.placement placement, far.platform platform, far.page_type, far.filter_mode, far.slot_ids as slot_id, far.category as category, far.catalog_id catalog_id, dc.catalog_name as catalog_name, far.retailer_id as retailer_id, dr.retailer_name as retailer_name, dr.retailer_industry as retailer_industry, dr.retailer_business_identifier as retailer_business_identifier, dr.retailer_company_name as retailer_company_name, dr.retailer_group_1 as retailer_group_1, dr.retailer_group_2 as retailer_group_2, rn.geo_region as geo_region, rn.local_timezone as local_timezone, if(far.search_term is not null, 1, 0) as has_search_term, if(far.category is not null, 1, 0) as has_category, far.namespace namespace, ifnull(ad.ad_type_name, '') ad_type_name, far.num_ads_considered, far.num_ads_served, far.num_ads_requested, far.capped_num_ads_served, far.capped_num_ads_requested, far.capped_num_requests_serving_max_ads, far.num_requests_serving_max_ads, far.num_ad_requests_serving_no_ads, far.num_ad_requests_serving_some_ads, far.num_ad_requests, far.num_ad_requests_with_saturation, far.placement_id from reporting.ad_request_agg_ltz far left join reporting.catalog dc on far.catalog_id = dc.catalog_id and far.env_namespace = dc.env_namespace left join reporting.retailer dr on far.retailer_id = dr.retailer_id and dr.env_namespace = far.env_namespace left join reporting.env_namespace rn on far.env_namespace = rn.env_namespace left join reporting.view_ad_type ad on far.ad_type = ad.ad_type where far.ingressed_at >= '2000-01-01' ```

# `reporting.ad_request_agg_view` - retailer - namespace Request view (aggregated). Decorated version of ad_request_agg. Layer: Reporting Datamart Category: Fact Decorated View Status: Published Primary Key: Refer to ad_request_agg Other Unique Key(s): Partition: Refer to ad_request_agg Foreign Key(s): Refer to view code | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `ingressed_at` | `DATE` | Date the Ads were realised. | | `ad_type` | `INTEGER` | Type of Ad (0 = Product, 1 = Banner, 4 = BannerX). | | `search_term` | `STRING` | The word/phrase being searched for on the retailer site by the end user. | | `generic_search_term` | `STRING` | Same as SearchTerm except leading and trailing whitespace is removed to improve consolidation. | | `reserved_search_term_flag` | `STRING` | Not in use. | | `placement` | `STRING` | Display name of the Placement. | | `platform` | `STRING` | The platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter. | | `page_type` | `INTEGER` | Legacy, superseded by Placement. | | `filter_mode` | `INTEGER` | The filterMode used to structure the productFilters in the ad request. Defaults in OR_AND if not specified. (OR_AND, AND_OR). | | `slot_id` | `STRING` | Banner SlotId as specified in the Ad Request. | | `category` | `STRING` | Category being targeted. | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `catalog_name` | `STRING` | Name of the Catalog. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `retailer_name` | `STRING` | Name of the Retailer. | | `retailer_industry` | `STRING` | Industry of the Retailer. | | `retailer_business_identifier` | `STRING` | Implementation specific generic label. | | `retailer_company_name` | `STRING` | Company name of the Retailer. | | `retailer_group_1` | `STRING` | Retailer team group membership #1. | | `retailer_group_2` | `STRING` | Retailer team group membership #2. | | `geo_region` | `STRING` | Geographical region of the Namespace (as defined by CitrusAd). | | `local_timezone` | `STRING` | Not in use. | | `has_search_term` | `INTEGER` | Flag to indicate if the Ad is targeting a Search Term. | | `has_category` | `INTEGER` | Flag to indicate if the Ad is targeting a Category. | | `namespace` | `STRING` | Name of the Namespace. | | `ad_type_name` | `STRING` | Human readable name for the ad type | | `num_ads_considered` | `NUMERIC` | Total number of Ad candidates that were considered by relevancy algorithms. | | `num_ads_served` | `NUMERIC` | Total number of Ads that were served back. | | `num_ads_requested` | `NUMERIC` | Total number of Ads that were requested by the Requests. | | `capped_num_ads_served` | `NUMERIC` | Total number of Ads that were served back with Cap applied per Request. | | `capped_num_ads_requested` | `NUMERIC` | Total number of Ads that were requested with Cap applied per Request. | | `capped_num_requests_serving_max_ads` | `NUMERIC` | Total number of Requests where the number of Ads requested was served in full. | | `num_requests_serving_max_ads` | `NUMERIC` | Total number of Requests where the number of Ads requested was served in full. | | `num_ad_requests_serving_no_ads` | `NUMERIC` | Total number of Requests where no Ads were served. | | `num_ad_requests_serving_some_ads` | `NUMERIC` | Total number of Requests where at least 1 Ad was served. | | `num_ad_requests` | `NUMERIC` | Total number of Requests. | | `num_ad_requests_with_saturation` | `NUMERIC` | Total number of Requests that served at least 4 Ads or filled the entire Request (if < 4 were requested). | | `placement_id` | `STRING` | Internal identifier of the Placement (from the source system). |

SQL Query

```sql select far.env env, far.env_namespace env_namespace, far.ingressed_at as ingressed_at, far.ad_type, far.search_term as search_term, far.generic_search_term as generic_search_term, far.reserved_search_term_flag reserved_search_term_flag, far.placement placement, far.platform platform, far.page_type, far.filter_mode, far.slot_ids as slot_id, far.category as category, far.catalog_id catalog_id, dc.catalog_name as catalog_name, far.retailer_id as retailer_id, dr.retailer_name as retailer_name, dr.retailer_industry as retailer_industry, dr.retailer_business_identifier as retailer_business_identifier, dr.retailer_company_name as retailer_company_name, dr.retailer_group_1 as retailer_group_1, dr.retailer_group_2 as retailer_group_2, rn.geo_region as geo_region, rn.local_timezone as local_timezone, if(far.search_term is not null, 1, 0) as has_search_term, if(far.category is not null, 1, 0) as has_category, far.namespace namespace, ifnull(ad.ad_type_name, '') ad_type_name, far.num_ads_considered, far.num_ads_served, far.num_ads_requested, far.capped_num_ads_served, far.capped_num_ads_requested, far.capped_num_requests_serving_max_ads, far.num_requests_serving_max_ads, far.num_ad_requests_serving_no_ads, far.num_ad_requests_serving_some_ads, far.num_ad_requests, far.num_ad_requests_with_saturation, far.placement_id from reporting.ad_request_agg far left join reporting.catalog dc on far.catalog_id = dc.catalog_id and far.env_namespace = dc.env_namespace left join reporting.retailer dr on far.retailer_id = dr.retailer_id and dr.env_namespace = far.env_namespace left join reporting.env_namespace rn on far.env_namespace = rn.env_namespace left join reporting.view_ad_type ad on far.ad_type = ad.ad_type where far.ingressed_at >= '2000-01-01' ```

# `reporting.campaign` - supplier - retailer - namespace Campaign data. Layer: Reporting Datamart Category: Dimension Status: Published Primary Key: campaign_id, env_namespace Other Unique Key(s): Partition: None Foreign Key(s): env_namespace on env_namespace.env_namespace = campaign.env_namespace; retailer on retailer.env_namespace = campaign.env_namespace and retailer.retailer_id = campaign.retailer_id; supplier on supplier.env_namespace = campaign.env_namespace and supplier.supplier_id = campaign.supplier_id; wallet on wallet.env_namespace = campaign.env_namespace and wallet.wallet_id = campaign.wallet_id; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `campaign_id` | `STRING` | Internal identifier of the Campaign (from the source system). | | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `campaign_name` | `STRING` | Name of the Campaign. | | `campaign_type` | `STRING` | Type of Campaign (BANNER, BRAND_PAGE, DISPLAY, EMAIL, SHOTGUN_BANNER, WILDCARD) | | `campaign_subtype` | `STRING` | Legacy, superseded by placement. Subtype of the Campaign (SEARCH_ONLY, CATEGORY_ONLY, CATEGORY_AND_SEARCH, BROAD_DISPLAY, CROSS_SELL, UPSELL, RUN_OF_SITE). | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `supplier_id` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `retailer_name` | `STRING` | Name of the Retailer. | | `supplier_name` | `STRING` | Name of the Supplier. | | `wallet_id` | `STRING` | Internal identifier of the Wallet (from the source system). | | `is_fta` | `STRING` | Flag indicating if the Campaign is Fixed Tenancy Agreement (FTA). | | `fta_cost` | `NUMERIC` | Total amount being spent by the given Fixed Tenancy Agreement (FTA) Campaign. | | `wallet_name` | `STRING` | Name of the Wallet. | | `wallet_external_id` | `STRING` | Implementation specific generic label. | | `wallet_archived` | `BOOLEAN` | Archived status of the Wallet. | | `wallet_credit_limit` | `NUMERIC` | Amount the Wallet may go into credit. | | `wallet_currency_code` | `STRING` | ISO 4217 currency code | | `wallet_total_purchased_credits` | `NUMERIC` | Total credits made to the Wallet. | | `wallet_available_balance` | `NUMERIC` | Current available balance of the Wallet. | | `wallet_credit_limit_usd` | `NUMERIC` | wallet_credit_limit in USD (current exchange rate only). | | `wallet_available_balance_usd` | `NUMERIC` | wallet_available_balance in USD (current exchange rate only). | | `wallet_total_purchased_credits_usd` | `NUMERIC` | wallet_total_purchased_credits in USD (current exchange rate only). | | `campaign_start_date` | `TIMESTAMP` | Date the Campaign will begin. | | `campaign_end_date` | `TIMESTAMP` | Date when the Campaign will end. | | `campaign_valid_state` | `STRING` | The Campaign's valid state. (APPROVED, PENDING, REJECTED) | | `campaign_active_state` | `STRING` | The Campaign's active state as set in the platform. (ACTIVE, PAUSED, DRAFT, ARCHIVED). | | `campaign_created_at` | `TIMESTAMP` | Date the record was created in the source system. | | `campaign_updated_at` | `TIMESTAMP` | Date the record was updated in the source system. | | `campaign_placements` | `STRING` | The Campaign's selected Placement. | | `campaign_total_spend` | `NUMERIC` | Total AdSpend to date for the Campaign. | | `campaign_total_spend_usd` | `NUMERIC` | campaign_total_spend in USD (current exchange rate only). | | `campaign_max_cost_per_click` | `NUMERIC` | The maximum cost per click set for the Campaign. | | `campaign_max_total_spend` | `NUMERIC` | The maximum total spend set for the Campaign. | | `campaign_max_daily_spend` | `NUMERIC` | The maximum daily spend set for the Campaign. | | `campaign_impression_goal` | `NUMERIC` | The maximum number of impressions a Campaign is aiming for. Only relevant for campaigns with a spend type of Fixed Spend. | | `campaign_catalog_products` | `STRING` | The Catalog's Products within the Campaign. | | `campaign_attr_1` | `STRING` | Campaign user defined attribute 1. | | `retailer_group_1` | `STRING` | Retailer group membership #1. | | `retailer_group_2` | `STRING` | Retailer group membership #2. | | `supplier_group_1` | `STRING` | Supplier team group membership #1. | | `supplier_group_2` | `STRING` | Supplier team group membership #2. | | `supplier_group_3` | `STRING` | Supplier team group membership #3. | | `supplier_group_4` | `STRING` | Supplier team group membership #4. | | `team_id` | `STRING` | Internal identifier of the Team (from the source system). | | `retailer_ad_spend_type` | `STRING` | Type of spending if Retailer Campaign (Always On, Daily Spend, Fixed Spend, Fixed Tenancy, Total Spend). | | `supplier_ad_spend_type` | `STRING` | Type of spending if Supplier Campaign (Always On, Daily Spend, Fixed Spend, Fixed Tenancy, Total Spend). | | `budget` | `NUMERIC` | The Campaign's budget as set by the Campaign's manager. | | `targeted_filters` | `STRING` | The filters selected by an advertiser that their campaign will appear for. Used for fixed tenancy campaigns. | | `location_filters` | `STRING` | Filters on the campaign specific to a location if a location filter class is created. | | `filter_whitelists` | `STRING` | The filters selected by an advertiser that the campaign can appear for. The campaign will only appear where eligible regardless of the advertiser's selection. | | `cross_sell_settings` | `STRING` | The cross-sell targeting selection in the campaign. | | `upsell_settings` | `STRING` | The Upsell targeting selection in the campaign if applicable. | | `categories` | `STRING` | Comma separated list of Categories targeted by the Campaign. | | `catalog_count` | `INTEGER` | Number of Catalogs being targeted by the Campaign. | | `catalog_ids` | `STRING` | Catalog ids. | | `search_terms` | `STRING` | Comma separated list of SearchTerms targeted by the Campaign. | | `has_search_terms` | `BOOLEAN` | Flag to indicate if the Campaign is targeting SearchTerms. | | `last_spend_date` | `DATE` | Most recent date that AdSpend was incurred by the Supplier. | | `geo_region` | `STRING` | Geographical region of the Namespace (as defined by CitrusAd). | | `local_timezone` | `STRING` | Not in use. | | `product_type_code` | `STRING` | Product type code. | | `cta_text` | `STRING` | CTA text. | | `suggested_search_terms` | `STRING` | Suggested search terms. | | `has_suggested_search_terms` | `BOOLEAN` | Flag to indicate that any suggested search terms exist. | | `is_current` | `BOOLEAN` | Flag if the row is the latest version in the source system. | | `active_state` | `STRING` | The Campaign's active state as set in the platform. (ACTIVE, PAUSED, DRAFT, ARCHIVED). | | `valid_state` | `STRING` | The Campaign's valid state. (APPROVED, PENDING, REJECTED) | | `namespace` | `STRING` | Name of the Namespace. | | `is_active` | `BOOLEAN` | Flag to indicate that the record is active in the source system. | | `is_deleted` | `BOOLEAN` | Flag to indicate that the record has been soft deleted in the source system. | | `currency_code` | `STRING` | ISO 4217 currency code | | `has_video` | `BOOLEAN` | Flag to indicate if the Campaign has video. | | `has_companion_products` | `BOOLEAN` | Flag to indicate if the Campaign has companion products. | # `reporting.catalog` - retailer - namespace Catalog data. Layer: Reporting Datamart Category: Dimension Status: Published Primary Key: catalog_id, env_namespace Other Unique Key(s): Partition: None Foreign Key(s): env_namespace on env_namespace.env_namespace = catalog.env_namespace; retailer on retailer.env_namespace = catalog.env_namespace and retailer.retailer_id = catalog.retailer_id; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `catalog_name` | `STRING` | Name of the Catalog. | | `retailer_name` | `STRING` | Name of the Retailer. | | `currency_code` | `STRING` | ISO 4217 currency code | | `namespace` | `STRING` | Name of the Namespace. | | `retailer_group_1` | `STRING` | Retailer team group membership #1. | | `retailer_group_2` | `STRING` | Retailer team group membership #2. | | `geo_region` | `STRING` | Geographical region of the Namespace (as defined by CitrusAd). | | `local_timezone` | `STRING` | Not in use. | | `is_active` | `BOOLEAN` | Flag to indicate that the record is active in the source system. | | `is_deleted` | `BOOLEAN` | Flag to indicate that the record has been soft deleted in the source system. | | `is_current` | `BOOLEAN` | Flag if the row is the latest version in the source system. | # `reporting.category` - namespace Category data. Layer: Reporting Datamart Category: Dimension Status: Published Primary Key: env_namespace, retailer_id, category_id Other Unique Key(s): Partition: None Foreign Key(s): env_namespace on env_namespace.env_namespace = category.env_namespace; retailer on retailer.env_namespace = category.env_namespace and retailer.retailer_id = category.retailer_id; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `category_id` | `STRING` | Category being targeted. | | `namespace` | `STRING` | Name of the Namespace. | | `category_label` | `STRING` | Label for the Category (more descriptive than the typical id provided). | | `cat_level_1` | `STRING` | Level 1 component of the category_label (delimited by >). | | `cat_level_2` | `STRING` | Level 2 component of the category_label (delimited by >). | | `cat_level_3` | `STRING` | Level 3 component of the category_label (delimited by >). | | `cat_level_4` | `STRING` | Level 4 component of the category_label (delimited by >). | | `cat_level_5` | `STRING` | Level 5 component of the category_label (delimited by >). | | `cat_level_6` | `STRING` | Level 6 component of the category_label (delimited by >). | | `cat_level_7` | `STRING` | Level 7 component of the category_label (delimited by >). | | `category_label_count` | `INTEGER` | Count(category_label) across env_namespace, retailer_id, category_id. | | `source_name` | `STRING` | Source name. | | `retailer_group_1` | `STRING` | Retailer group membership #1. | | `retailer_group_2` | `STRING` | Retailer group membership #2. | | `retailer_name` | `STRING` | Name of the Retailer. | # `reporting.deduped_product` - retailer - namespace Deduped product data. Layer: Reporting Datamart Category: Dimension Status: Published Primary Key: env_namespace, normalised_product_code Other Unique Key(s): Partition: None Foreign Key(s): env_namespace on env_namespace.env_namespace = deduped_product.env_namespace; catalog on catalog.env_namespace = deduped_product.env_namespace and catalog.catalog_id = deduped_product.catalog_id; retailer on retailer.env_namespace = deduped_product.env_namespace and retailer.retailer_id = deduped_product.retailer_id; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `normalised_product_code` | `STRING` | Product code prefixed with leading zeros to be 16 characters long. | | `product_code` | `STRING` | Product code. | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `product_name` | `STRING` | Name of the Product. | | `product_type` | `STRING` | Type of the Product. | | `retailer_name` | `STRING` | Name of the Retailer. | | `currency_code` | `STRING` | ISO 4217 currency code | | `product_tags` | `STRING` | Tags associated with the Product. | | `product_image_url` | `STRING` | URL to an image of the Product for the Ad. | | `brand` | `STRING` | Brand of the Product. | | `google_product_taxonomy` | `STRING` | Google taxonomy (product hierarchy) of the Product. Levels of the hierarchy delimited using > symbol. | | `retailer_taxonomy` | `STRING` | Taxonomy (product hierarchy) of the Product as specified by the Retailer. | | `namespace` | `STRING` | Name of the Namespace. | | `is_deleted` | `BOOLEAN` | Flag to indicate that the record has been soft deleted in the source system. | | `retailer_group_1` | `STRING` | Retailer group membership #1. | | `retailer_group_2` | `STRING` | Retailer group membership #2. | # `reporting.enhanced_attribution_agg` - retailer - namespace Enhanced Attribution data (aggregated, both models). Layer: Reporting Datamart Category: Fact Status: Published Primary Key: env_namespace, campaign_id, category_id, normalised_product_code, product_code, product_name, brand, retailer_taxonomy, halo_taxonomy, halo_taxonomy_level, order_date, ingressed_at, search_term, placement, platform, page_type, attribution_model, retailer_id, order_type Other Unique Key(s): Partition: ingressed_at (by DAY) Foreign Key(s): env_namespace on env_namespace.env_namespace = enhanced_attribution_agg.env_namespace; retailer on retailer.env_namespace = enhanced_attribution_agg.env_namespace and retailer.retailer_id = enhanced_attribution_agg.retailer_id; campaign on campaign.env_namespace = enhanced_attribution_agg.env_namespace and campaign.campaign_id = enhanced_attribution_agg.campaign_id; product on product.env_namespace = enhanced_attribution_agg.env_namespace and product.product_code = enhanced_attribution_agg.product_code; search_term on search_term.env_namespace = enhanced_attribution_agg.env_namespace and search_term.retailer_id = enhanced_attribution_agg.retailer_id and search_term.search_term = enhanced_attribution_agg.search_term; category on category.env_namespace = enhanced_attribution_agg.env_namespace and category.category_id = enhanced_attribution_agg.category and category.retailer_id = enhanced_attribution_agg.retailer_id; placement on placement.env_namespace = enhanced_attribution_agg.env_namespace and placement.placement = enhanced_attribution_agg.placement; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `namespace` | `STRING` | Name of the Namespace. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `ingressed_at` | `DATE` | Date the Ads were realised. | | `yyyymmdd` | `STRING` | Year+month+day of ingressed_at. | | `yyyymm` | `STRING` | Year+month of ingressed_at. | | `yyyy` | `STRING` | Year of ingressed_at. | | `week_start_date` | `DATE` | First day of the week of the ingressed_at date. | | `order_date` | `DATE` | Date of the Orders. | | `normalised_product_code` | `STRING` | Product code prefixed with leading zeros to be 16 characters long. | | `product_code` | `STRING` | Product code. | | `product_name` | `STRING` | Name of the Product. | | `brand` | `STRING` | Brand of the Product. | | `retailer_taxonomy` | `STRING` | Taxonomy (product hierarchy) of the Product as specified by the Retailer. | | `halo_taxonomy` | `STRING` | The portion of the retailer_taxonomy relevant for the given halo_taxonomy_level. Note for halo_taxonomy_level=1 it is null since the Brand is level 1. | | `halo_taxonomy_level` | `INTEGER` | Halo level number (1-9). 1 = Brand level halo, Levels 2-9 are the HaloTaxonomy component, 9 being the specific Product Code (SKU). | | `campaign_id` | `STRING` | Internal identifier of the Campaign (from the source system). | | `search_term` | `STRING` | DEPRECATED. Please switch to using keyword. | | `category_id` | `STRING` | Category being targeted. | | `placement` | `STRING` | Display name of the Placement. | | `platform` | `STRING` | The platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter. | | `page_type` | `INTEGER` | Legacy, superseded by Placement. | | `attribution_model` | `INTEGER` | Indicate if data is from first or second model. | | `order_type` | `STRING` | Type of the Order. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `impressions` | `NUMERIC` | Total impressions. | | `clicks` | `NUMERIC` | Number of Clicks. | | `ad_spend` | `NUMERIC` | Local currency amount charged by the Retailer to the Supplier for the Realised Ads. | | `direct_unit_sales` | `NUMERIC` | Unit sales from CitrusAd platform Attributions. | | `direct_sales_value` | `NUMERIC` | Revenue from CitrusAd platform Attributions. | | `direct_conversions` | `NUMERIC` | Conversions from CitrusAd platform Attributions. | | `view_through_unit_sales` | `NUMERIC` | Unit sales from Impression View Thru Attributions. | | `view_through_sales_value` | `NUMERIC` | Revenue from Impression View Thru Attributions. | | `view_through_conversions` | `NUMERIC` | Conversions from Impression View Thru Attributions. | | `halo_unit_sales` | `NUMERIC` | Unit sales from halo click Attributions. | | `halo_sales_value` | `NUMERIC` | Revenue from halo click Attributions. | | `halo_conversions` | `NUMERIC` | Conversions from halo click Attributions. | | `total_click_sales` | `NUMERIC` | Direct unit sales + halo unit sales. | | `total_click_sales_value` | `NUMERIC` | Direct sales value + halo sales value. | | `total_unit_sales` | `NUMERIC` | Total click sales + view through unit sales. | | `total_sales_value` | `NUMERIC` | Total click sales value + view through sales value. | | `total_conversions` | `NUMERIC` | Total click conversions + view through conversions. | | `retailer_group_1` | `STRING` | Retailer team group membership #1. | | `retailer_group_2` | `STRING` | Retailer team group membership #2. | | `supplier_group_1` | `STRING` | Supplier team group membership #1. | | `supplier_group_2` | `STRING` | Supplier team group membership #2. | | `supplier_group_3` | `STRING` | Supplier team group membership #3. | | `supplier_group_4` | `STRING` | Supplier team group membership #4. | | `supplier_id` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `enable_sales_metrics` | `BOOLEAN` | Used to set sales metrics to 0 for certain namespace/campaign types if required for reporting | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `imp_halo_unit_sales` | `NUMERIC` | Unit sales from halo impression Attributions. | | `imp_halo_sales_value` | `NUMERIC` | Revenue from halo impression Attributions. | | `imp_halo_conversions` | `NUMERIC` | Conversions from halo impression Attributions. | | `attributable_impressions` | `NUMERIC` | Subset of impressions that are considered attributable. | | `attributable_clicks` | `NUMERIC` | Subset of clicks that are considered attributable. | | `attributable_ad_spend` | `NUMERIC` | Subset of ad spend that is considered attributable. | | `attribution_type` | `STRING` | The type of attribution applied to the conversion (e.g. click-based, impression-based). | # `reporting.enhanced_attribution_agg_ltz_view` - namespace Enhanced Attribution view (aggregated, both models in local timezone). Decorated version of enhanced_attribution_agg. Layer: Reporting Datamart Category: Fact Decorated View Status: Published Primary Key: Refer to enhanced_attribution_agg Other Unique Key(s): Partition: Refer to enhanced_attribution_agg Foreign Key(s): Refer to view code | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `namespace` | `STRING` | Name of the Namespace. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `ingressed_at` | `DATE` | Date the Ads were realised. | | `yyyymmdd` | `STRING` | Year+month+day of ingressed_at. | | `yyyymm` | `STRING` | Year+month of ingressed_at. | | `yyyy` | `STRING` | Year of ingressed_at. | | `week_start_date` | `DATE` | First day of the week of the ingressed_at date. | | `order_date` | `DATE` | Date of the Orders. | | `normalised_product_code` | `STRING` | Product code prefixed with leading zeros to be 16 characters long. | | `product_code` | `STRING` | Product code. | | `product_name` | `STRING` | Name of the Product. | | `brand` | `STRING` | Brand of the Product. | | `retailer_taxonomy` | `STRING` | Taxonomy (product hierarchy) of the Product as specified by the Retailer. | | `halo_taxonomy` | `STRING` | The portion of the retailer_taxonomy relevant for the given halo_taxonomy_level. Note for halo_taxonomy_level=1 it is null since the Brand is level 1. | | `halo_taxonomy_level` | `INTEGER` | Halo level number (1-9). 1 = Brand level halo, Levels 2-9 are the HaloTaxonomy component, 9 being the specific Product Code (SKU). | | `campaign_id` | `STRING` | Internal identifier of the Campaign (from the source system). | | `search_term` | `STRING` | DEPRECATED. Please switch to using keyword. | | `placement` | `STRING` | Display name of the Placement. | | `platform` | `STRING` | The platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter. | | `page_type` | `INTEGER` | Legacy, superseded by Placement. | | `attribution_model` | `INTEGER` | Indicate if data is from first or second model. | | `order_type` | `STRING` | Type of the Order. | | `impressions` | `NUMERIC` | Total impressions. | | `clicks` | `NUMERIC` | Number of Clicks. | | `ad_spend` | `NUMERIC` | Local currency amount charged by the Retailer to the Supplier for the Realised Ads. | | `direct_unit_sales` | `NUMERIC` | Unit sales from CitrusAd platform Attributions. | | `direct_sales_value` | `NUMERIC` | Revenue from CitrusAd platform Attributions. | | `direct_conversions` | `NUMERIC` | Conversions from CitrusAd platform Attributions. | | `view_through_unit_sales` | `NUMERIC` | Unit sales from Impression View Thru Attributions. | | `view_through_sales_value` | `NUMERIC` | Revenue from Impression View Thru Attributions. | | `view_through_conversions` | `NUMERIC` | Conversions from Impression View Thru Attributions. | | `halo_unit_sales` | `NUMERIC` | Unit sales from halo click Attributions. | | `halo_sales_value` | `NUMERIC` | Revenue from halo click Attributions. | | `halo_conversions` | `NUMERIC` | Conversions from halo click Attributions. | | `total_click_sales` | `NUMERIC` | Direct unit sales + halo unit sales. | | `total_click_sales_value` | `NUMERIC` | Direct sales value + halo sales value. | | `total_unit_sales` | `NUMERIC` | Total click sales + view through unit sales. | | `total_sales_value` | `NUMERIC` | Total click sales value + view through sales value. | | `total_conversions` | `NUMERIC` | Total click conversions + view through conversions. | | `retailer_group_1` | `STRING` | Retailer team group membership #1. | | `retailer_group_2` | `STRING` | Retailer team group membership #2. | | `supplier_group_1` | `STRING` | Supplier team group membership #1. | | `supplier_group_2` | `STRING` | Supplier team group membership #2. | | `supplier_group_3` | `STRING` | Supplier team group membership #3. | | `supplier_group_4` | `STRING` | Supplier team group membership #4. | | `enable_sales_metrics` | `BOOLEAN` | Used to set sales metrics to 0 for certain namespace/campaign types if required for reporting | | `category_id` | `STRING` | Category being targeted. | | `campaign_name` | `STRING` | Name of the Campaign. | | `campaign_start_date` | `TIMESTAMP` | Date the Campaign will begin. | | `campaign_end_date` | `TIMESTAMP` | Date when the Campaign will end. | | `campaign_type` | `STRING` | Type of Campaign (BANNER, BRAND_PAGE, DISPLAY, EMAIL, SHOTGUN_BANNER, WILDCARD) | | `campaign_subtype` | `STRING` | Legacy, superseded by placement. Subtype of the Campaign (SEARCH_ONLY, CATEGORY_ONLY, CATEGORY_AND_SEARCH, BROAD_DISPLAY, CROSS_SELL, UPSELL, RUN_OF_SITE). | | `wallet_id` | `STRING` | Internal identifier of the Wallet (from the source system). | | `active_state` | `STRING` | The Campaign's active state as set in the platform. (ACTIVE, PAUSED, DRAFT, ARCHIVED). | | `valid_state` | `STRING` | The Campaign's valid state. (APPROVED, PENDING, REJECTED) | | `cta_text` | `STRING` | CTA text. | | `supplier_id` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `retailer_name` | `STRING` | Name of the Retailer. | | `team_type` | `STRING` | Type of Team (RETAILER or SUPPLIER). | | `company_name` | `STRING` | Company name of the Team. | | `supplier_name` | `STRING` | Name of the Supplier. | | `category_name` | `STRING` | Name of the category. | | `wallet_name` | `STRING` | Name of the Wallet. | | `wallet_available_balance` | `NUMERIC` | Current available balance of the Wallet. | | `supplier_company_name` | `STRING` | Company name of the Supplier. | | `wallet_capture_date` | `DATE` | Date the Wallet details were captured on. | | `geo_region` | `STRING` | Geographical region of the Namespace (as defined by CitrusAd). | | `local_timezone` | `STRING` | Not in use. | | `has_search_term` | `INTEGER` | Flag to indicate if the Ad is targeting a Search Term. | | `has_category` | `INTEGER` | Flag to indicate if the Ad is targeting a Category. | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `catalog_name` | `STRING` | Name of the Catalog. | | `enhanced_attribution_flag` | `STRING` | If true, the first enhanced attribution model will be calculated. | | `enhanced_attribution_flag_2` | `STRING` | If true, the second enhanced attribution model will be calculated. | | `retailer_taxonomy_halo` | `STRING` | Comma separated list of what halo levels will be computed for model 1. | | `retailer_taxonomy_halo_2` | `STRING` | Comma separated list of what halo levels will be computed for model 2. | | `view_attribution_window` | `NUMERIC` | Max number of days allowed between the Order and Realised Ad for View Thru Attribution. | | `view_attribution_window_2` | `NUMERIC` | Max number of days allowed between the Order and Realised Ad for View Thru Attribution (2nd model). | | `click_attribution_window` | `NUMERIC` | Max number of days allowed between the Order and Realised Ad for Halo Click Attribution (1st model). | | `click_attribution_window_2` | `NUMERIC` | Max number of days allowed between the Order and Realised Ad for Halo Click Attribution (2nd model). | | `attribution_time_frame` | `NUMERIC` | Determines how many days of attribution results should be stored for the first model. | | `attribution_time_frame_2` | `NUMERIC` | Determines how many days of attribution results should be stored for the second model. | | `imp_halo_unit_sales` | `NUMERIC` | Unit sales from halo impression Attributions. | | `imp_halo_sales_value` | `NUMERIC` | Revenue from halo impression Attributions. | | `imp_halo_conversions` | `NUMERIC` | Conversions from halo impression Attributions. | | `attributable_impressions` | `NUMERIC` | Subset of impressions that are considered attributable. | | `attributable_clicks` | `NUMERIC` | Subset of clicks that are considered attributable. | | `attributable_ad_spend` | `NUMERIC` | Subset of ad spend that is considered attributable. | | `is_fta` | `BOOLEAN` | Flag indicating if the Campaign is Fixed Tenancy Agreement (FTA). | | `attribution_type` | `STRING` | The type of attribution applied to the conversion (e.g. click-based, impression-based). | | `has_video` | `BOOLEAN` | Flag to indicate if the Campaign has video. | | `has_companion_products` | `BOOLEAN` | Flag to indicate if the Campaign has companion products. |

SQL Query

```sql /* ========================= HALO DATA ========================= */ SELECT DISTINCT halo.env, halo.namespace, halo.env_namespace, halo.ingressed_at, halo.yyyymmdd, halo.yyyymm, halo.yyyy, halo.week_start_date, halo.order_date, halo.normalised_product_code, halo.product_code, halo.product_name, halo.brand, halo.retailer_taxonomy, halo.halo_taxonomy, halo.halo_taxonomy_level, halo.campaign_id, halo.search_term, halo.placement, halo.platform, CAST(halo.page_type AS INT64) AS page_type, CAST(halo.attribution_model AS INT64) AS attribution_model, CAST(halo.order_type AS STRING) AS order_type, CAST(halo.impressions AS NUMERIC) AS impressions, CAST(halo.clicks AS NUMERIC) AS clicks, CAST(halo.ad_spend AS NUMERIC) AS ad_spend, halo.direct_unit_sales, halo.direct_sales_value, halo.direct_conversions, halo.view_through_unit_sales, halo.view_through_sales_value, halo.view_through_conversions, halo.halo_unit_sales, halo.halo_sales_value, halo.halo_conversions, halo.total_click_sales, halo.total_click_sales_value, halo.total_unit_sales, halo.total_sales_value, halo.total_conversions, halo.retailer_group_1, halo.retailer_group_2, halo.supplier_group_1, halo.supplier_group_2, halo.supplier_group_3, halo.supplier_group_4, CAST(halo.enable_sales_metrics AS BOOL) AS enable_sales_metrics, CAST(halo.category_id AS STRING) AS category_id, dc.campaign_name, dc.campaign_start_date, dc.campaign_end_date, dc.campaign_type, dc.campaign_subtype, dc.wallet_id, dc.active_state, dc.valid_state, dc.cta_text, halo.supplier_id, CAST(halo.retailer_id AS STRING) AS retailer_id, dr.retailer_name, dr.team_type, dr.retailer_company_name AS company_name, ds.supplier_name, cat.category_label AS category_name, dw.wallet_name, dw.available_balance AS wallet_available_balance, ds.supplier_company_name, DATE(dw.wallet_capture_date) AS wallet_capture_date, rn.geo_region, rn.local_timezone, IF(IFNULL(halo.search_term, '') <> '', 1, 0) AS has_search_term, IF(IFNULL(cat.category_label, '') <> '', 1, 0) AS has_category, halo.catalog_id, dca.catalog_name, dr.enhanced_attribution_flag, dr.enhanced_attribution_flag_2, dr.retailer_taxonomy_halo, dr.retailer_taxonomy_halo_2, dr.view_attribution_window, dr.view_attribution_window_2, dr.click_attribution_window, dr.click_attribution_window_2, dr.attribution_time_frame, dr.attribution_time_frame_2, halo.imp_halo_unit_sales, halo.imp_halo_sales_value, halo.imp_halo_conversions, halo.attributable_impressions, halo.attributable_clicks, halo.attributable_ad_spend, COALESCE(UPPER(dc.is_fta) = 'TRUE', FALSE) AS is_fta, halo.attribution_type, dc.has_video, dc.has_companion_products FROM reporting.enhanced_attribution_agg_ltz halo LEFT JOIN reporting.campaign dc ON halo.campaign_id = dc.campaign_id AND halo.env_namespace = dc.env_namespace LEFT JOIN reporting.retailer dr ON halo.env_namespace = dr.env_namespace AND halo.retailer_id = dr.retailer_id LEFT JOIN reporting.supplier ds ON halo.env_namespace = ds.env_namespace AND halo.supplier_id = ds.supplier_id LEFT JOIN reporting.category cat ON cat.category_id = halo.category_id AND cat.env_namespace = halo.env_namespace AND cat.retailer_id = dr.retailer_id LEFT JOIN reporting.wallet dw ON dw.env_namespace = dc.env_namespace AND dw.wallet_id = dc.wallet_id LEFT JOIN reporting.env_namespace rn ON halo.env_namespace = rn.env_namespace LEFT JOIN reporting.catalog dca ON halo.catalog_id = dca.catalog_id AND halo.env_namespace = dca.env_namespace AND dca.is_current WHERE rn.geo_region <> 'NotProductionData' UNION ALL /* ========================= FTA DATA ========================= */ SELECT DISTINCT fta.env, fta.namespace, fta.env_namespace, DATE_TRUNC(fta.bucket_date, DAY) AS ingressed_at, FORMAT_DATE('%F', fta.bucket_date) AS yyyymmdd, FORMAT_DATE('%Y-%m', fta.bucket_date) AS yyyymm, FORMAT_DATE('%Y', fta.bucket_date) AS yyyy, DATE_TRUNC(fta.bucket_date, WEEK) AS week_start_date, fta.bucket_date AS order_date, COALESCE(p.normalised_product_code, fta.product_code) AS normalised_product_code, fta.product_code, p.product_name, p.brand, p.retailer_taxonomy, CAST(NULL AS STRING) AS halo_taxonomy, CAST(1 AS INT64) AS halo_taxonomy_level, fta.campaign_id, IFNULL(fta.search_term, '') AS search_term, dc.campaign_placements AS placement, CAST(NULL AS STRING) AS platform, CAST(NULL AS INT64) AS page_type, CAST(1 AS INT64) AS attribution_model, "CitrusAd" AS order_type, CAST(fta.impressions AS NUMERIC) AS impressions, CAST(fta.clicks AS NUMERIC) AS clicks, CAST(fta.bucketed_cost AS NUMERIC) AS ad_spend, CAST(0 AS NUMERIC) AS direct_unit_sales, CAST(0 AS NUMERIC) AS direct_sales_value, CAST(0 AS NUMERIC) AS direct_conversions, CAST(0 AS NUMERIC) AS view_through_unit_sales, CAST(0 AS NUMERIC) AS view_through_sales_value, CAST(0 AS NUMERIC) AS view_through_conversions, CAST(0 AS NUMERIC) AS halo_unit_sales, CAST(0 AS NUMERIC) AS halo_sales_value, CAST(0 AS NUMERIC) AS halo_conversions, CAST(0 AS NUMERIC) AS total_click_sales, CAST(0 AS NUMERIC) AS total_click_sales_value, CAST(0 AS NUMERIC) AS total_unit_sales, CAST(0 AS NUMERIC) AS total_sales_value, CAST(0 AS NUMERIC) AS total_conversions, fta.retailer_group_1, fta.retailer_group_2, fta.supplier_group_1, fta.supplier_group_2, fta.supplier_group_3, fta.supplier_group_4, CAST(fta.enable_sales_metrics AS BOOL) AS enable_sales_metrics, CAST(NULL AS STRING) AS category_id, fta.campaign_name, dc.campaign_start_date, dc.campaign_end_date, dc.campaign_type, dc.campaign_subtype, fta.wallet_id, dc.active_state, dc.valid_state, CAST(NULL AS STRING) AS cta_text, fta.supplier_id, fta.retailer_id, dr.retailer_name, dr.team_type, dr.retailer_company_name AS company_name, fta.supplier_name, CAST(NULL AS STRING) AS category_name, dw.wallet_name, dw.available_balance AS wallet_available_balance, ds.supplier_company_name, DATE(dw.wallet_capture_date) AS wallet_capture_date, rn.geo_region, rn.local_timezone, IF(IFNULL(fta.search_term, '') <> '', 1, 0) AS has_search_term, CAST(0 AS INT64) AS has_category, fta.catalog_id, p.catalog_name, dr.enhanced_attribution_flag, dr.enhanced_attribution_flag_2, dr.retailer_taxonomy_halo, dr.retailer_taxonomy_halo_2, dr.view_attribution_window, dr.view_attribution_window_2, dr.click_attribution_window, dr.click_attribution_window_2, dr.attribution_time_frame, dr.attribution_time_frame_2, CAST(0 AS NUMERIC) AS imp_halo_unit_sales, CAST(0 AS NUMERIC) AS imp_halo_sales_value, CAST(0 AS NUMERIC) AS imp_halo_conversions, CAST(0 AS NUMERIC) AS attributable_impressions, CAST(0 AS NUMERIC) AS attributable_clicks, CAST(0 AS NUMERIC) AS attributable_ad_spend, TRUE AS is_fta, CAST(NULL AS STRING) AS attribution_type, dc.has_video, dc.has_companion_products FROM reporting.fta_campaign_spend_ltz fta JOIN reporting.campaign dc ON fta.env_namespace = dc.env_namespace AND fta.campaign_id = dc.campaign_id LEFT JOIN reporting.env_namespace rn ON rn.env_namespace = fta.env_namespace LEFT JOIN reporting.product p ON fta.env = p.env AND fta.env_namespace = p.env_namespace AND fta.product_code = p.product_code LEFT JOIN reporting.retailer dr ON fta.env = dr.env AND fta.env_namespace = dr.env_namespace AND fta.retailer_id = dr.retailer_id LEFT JOIN reporting.wallet dw ON dw.env_namespace = dc.env_namespace AND dw.wallet_id = dc.wallet_id LEFT JOIN reporting.supplier ds ON fta.env_namespace = ds.env_namespace AND fta.supplier_id = ds.supplier_id WHERE fta.bucket_date < CURRENT_DATE() AND rn.geo_region <> 'NotProductionData'; ```

# `reporting.enhanced_attribution_agg_view` - retailer - namespace Enhanced Attribution view (aggregated, both models). Decorated version of enhanced_attribution_agg. Layer: Reporting Datamart Category: Fact Decorated View Status: Published Primary Key: Refer to enhanced_attribution_agg Other Unique Key(s): Partition: Refer to enhanced_attribution_agg Foreign Key(s): Refer to view code | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `namespace` | `STRING` | Name of the Namespace. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `ingressed_at` | `DATE` | Date when the attribution data was ingested. | | `yyyymmdd` | `STRING` | Year+month+day format of ingressed_at date. | | `yyyymm` | `STRING` | Year+month format of ingressed_at date. | | `yyyy` | `STRING` | Year of the ingressed_at date. | | `week_start_date` | `DATE` | Start date of the week for the ingressed_at date. | | `order_date` | `DATE` | Date of the order. | | `normalised_product_code` | `STRING` | Standardized unique identifier for the Product across catalogs. | | `product_code` | `STRING` | Product code. | | `product_name` | `STRING` | Name of the product. | | `brand` | `STRING` | Brand of the product. | | `retailer_taxonomy` | `STRING` | Retailer taxonomy category. | | `halo_taxonomy` | `STRING` | Halo taxonomy category. | | `halo_taxonomy_level` | `INTEGER` | Level of the halo taxonomy. | | `campaign_id` | `STRING` | ID of the campaign. | | `search_term` | `STRING` | DEPRECATED. Please switch to using keyword. | | `placement` | `STRING` | Placement of the ad. | | `platform` | `STRING` | Platform where the ad is displayed. | | `page_type` | `INTEGER` | Type of the page where the ad is displayed. | | `attribution_model` | `INTEGER` | Model of attribution used. | | `order_type` | `STRING` | Type of the order. | | `impressions` | `NUMERIC` | Number of impressions. | | `clicks` | `NUMERIC` | Number of clicks. | | `ad_spend` | `NUMERIC` | Amount spent on ads. | | `direct_unit_sales` | `NUMERIC` | Direct unit sales. | | `direct_sales_value` | `NUMERIC` | Direct sales value. | | `direct_conversions` | `NUMERIC` | Direct conversions. | | `view_through_unit_sales` | `NUMERIC` | View-through unit sales. | | `view_through_sales_value` | `NUMERIC` | View-through sales value. | | `view_through_conversions` | `NUMERIC` | View-through conversions. | | `halo_unit_sales` | `NUMERIC` | Halo unit sales. | | `halo_sales_value` | `NUMERIC` | Halo sales value. | | `halo_conversions` | `NUMERIC` | Halo conversions. | | `total_click_sales` | `NUMERIC` | Total sales from clicks. | | `total_click_sales_value` | `NUMERIC` | Total sales value from clicks. | | `total_unit_sales` | `NUMERIC` | Total unit sales. | | `total_sales_value` | `NUMERIC` | Total sales value. | | `total_conversions` | `NUMERIC` | Total conversions. | | `retailer_group_1` | `STRING` | First retailer group. | | `retailer_group_2` | `STRING` | Second retailer group. | | `supplier_group_1` | `STRING` | First supplier group. | | `supplier_group_2` | `STRING` | Second supplier group. | | `supplier_group_3` | `STRING` | Third supplier group. | | `supplier_group_4` | `STRING` | Fourth supplier group. | | `enable_sales_metrics` | `BOOLEAN` | Flag to enable sales metrics. | | `category_id` | `STRING` | ID of the category. | | `campaign_name` | `STRING` | Name of the campaign. | | `campaign_start_date` | `TIMESTAMP` | Start date of the campaign. | | `campaign_end_date` | `TIMESTAMP` | End date of the campaign. | | `campaign_type` | `STRING` | Type of the campaign. | | `campaign_subtype` | `STRING` | Subtype of the campaign. | | `wallet_id` | `STRING` | ID of the wallet. | | `active_state` | `STRING` | Active state of the campaign. | | `valid_state` | `STRING` | Valid state of the campaign. | | `cta_text` | `STRING` | Call to action text. | | `supplier_id` | `STRING` | ID of the supplier. | | `retailer_id` | `STRING` | Internal identifier of the Retailer (from the source system). | | `retailer_name` | `STRING` | Display name of the Retailer. | | `team_type` | `STRING` | Type of the team. | | `company_name` | `STRING` | Name of the company. | | `supplier_name` | `STRING` | Name of the supplier. | | `category_name` | `STRING` | Name of the category. | | `wallet_name` | `STRING` | Name of the wallet. | | `wallet_available_balance` | `NUMERIC` | Available balance in the wallet. | | `supplier_company_name` | `STRING` | Company name of the supplier. | | `wallet_capture_date` | `DATE` | Date when the wallet was captured. | | `geo_region` | `STRING` | Geographical region. | | `local_timezone` | `STRING` | Local timezone of the region. | | `has_search_term` | `INTEGER` | Flag indicating presence of search term. | | `has_category` | `INTEGER` | Flag indicating presence of category. | | `catalog_id` | `STRING` | ID of the catalog. | | `catalog_name` | `STRING` | Name of the catalog. | | `enhanced_attribution_flag` | `STRING` | Flag for enhanced attribution. | | `enhanced_attribution_flag_2` | `STRING` | Second flag for enhanced attribution. | | `retailer_taxonomy_halo` | `STRING` | Retailer taxonomy halo category. | | `retailer_taxonomy_halo_2` | `STRING` | Second retailer taxonomy halo category. | | `view_attribution_window` | `NUMERIC` | View attribution window. | | `view_attribution_window_2` | `NUMERIC` | Second view attribution window. | | `click_attribution_window` | `NUMERIC` | Click attribution window. | | `click_attribution_window_2` | `NUMERIC` | Second click attribution window. | | `attribution_time_frame` | `NUMERIC` | Attribution time frame. | | `attribution_time_frame_2` | `NUMERIC` | Second attribution time frame. | | `imp_halo_unit_sales` | `NUMERIC` | Unit sales from halo impression Attributions. | | `imp_halo_sales_value` | `NUMERIC` | Revenue from halo impression Attributions. | | `imp_halo_conversions` | `NUMERIC` | Conversions from halo impression Attributions. | | `attributable_impressions` | `NUMERIC` | Subset of impressions that are considered attributable. | | `attributable_clicks` | `NUMERIC` | Subset of clicks that are considered attributable. | | `attributable_ad_spend` | `NUMERIC` | Subset of ad spend that is considered attributable. | | `is_fta` | `BOOLEAN` | Flag indicating if the Campaign is Fixed Tenancy Agreement (FTA). | | `attribution_type` | `STRING` | The type of attribution applied to the conversion (e.g. click-based, impression-based). | | `has_video` | `BOOLEAN` | Flag to indicate if the Campaign has video. | | `has_companion_products` | `BOOLEAN` | Flag to indicate if the Campaign has companion products. |

SQL Query

```sql /* ========================= HALO DATA ========================= */ SELECT DISTINCT halo.env, halo.namespace, halo.env_namespace, halo.ingressed_at, halo.yyyymmdd, halo.yyyymm, halo.yyyy, halo.week_start_date, halo.order_date, halo.normalised_product_code, halo.product_code, halo.product_name, halo.brand, halo.retailer_taxonomy, halo.halo_taxonomy, halo.halo_taxonomy_level, halo.campaign_id, halo.search_term, halo.placement, halo.platform, CAST(halo.page_type AS INT64) AS page_type, CAST(halo.attribution_model AS INT64) AS attribution_model, CAST(halo.order_type AS STRING) AS order_type, CAST(halo.impressions AS NUMERIC) AS impressions, CAST(halo.clicks AS NUMERIC) AS clicks, CAST(halo.ad_spend AS NUMERIC) AS ad_spend, halo.direct_unit_sales, halo.direct_sales_value, halo.direct_conversions, halo.view_through_unit_sales, halo.view_through_sales_value, halo.view_through_conversions, halo.halo_unit_sales, halo.halo_sales_value, halo.halo_conversions, halo.total_click_sales, halo.total_click_sales_value, halo.total_unit_sales, halo.total_sales_value, halo.total_conversions, halo.retailer_group_1, halo.retailer_group_2, halo.supplier_group_1, halo.supplier_group_2, halo.supplier_group_3, halo.supplier_group_4, CAST(halo.enable_sales_metrics AS BOOL) AS enable_sales_metrics, CAST(halo.category_id AS STRING) AS category_id, dc.campaign_name, dc.campaign_start_date, dc.campaign_end_date, dc.campaign_type, dc.campaign_subtype, dc.wallet_id, dc.active_state, dc.valid_state, dc.cta_text, halo.supplier_id, CAST(halo.retailer_id AS STRING) AS retailer_id, dr.retailer_name, dr.team_type, dr.retailer_company_name AS company_name, ds.supplier_name, cat.category_label AS category_name, dw.wallet_name, dw.available_balance AS wallet_available_balance, ds.supplier_company_name, DATE(dw.wallet_capture_date) AS wallet_capture_date, rn.geo_region, rn.local_timezone, IF(IFNULL(halo.search_term, '') <> '', 1, 0) AS has_search_term, IF(IFNULL(cat.category_label, '') <> '', 1, 0) AS has_category, halo.catalog_id, dca.catalog_name, dr.enhanced_attribution_flag, dr.enhanced_attribution_flag_2, dr.retailer_taxonomy_halo, dr.retailer_taxonomy_halo_2, dr.view_attribution_window, dr.view_attribution_window_2, dr.click_attribution_window, dr.click_attribution_window_2, dr.attribution_time_frame, dr.attribution_time_frame_2, halo.imp_halo_unit_sales, halo.imp_halo_sales_value, halo.imp_halo_conversions, halo.attributable_impressions, halo.attributable_clicks, halo.attributable_ad_spend, COALESCE(UPPER(dc.is_fta) = 'TRUE', FALSE) AS is_fta, halo.attribution_type, dc.has_video, dc.has_companion_products FROM reporting.enhanced_attribution_agg halo LEFT JOIN reporting.campaign dc ON halo.campaign_id = dc.campaign_id AND halo.env_namespace = dc.env_namespace LEFT JOIN reporting.retailer dr ON halo.env_namespace = dr.env_namespace AND halo.retailer_id = dr.retailer_id LEFT JOIN reporting.supplier ds ON halo.env_namespace = ds.env_namespace AND halo.supplier_id = ds.supplier_id LEFT JOIN reporting.category cat ON cat.category_id = halo.category_id AND cat.env_namespace = halo.env_namespace AND cat.retailer_id = dr.retailer_id LEFT JOIN reporting.wallet dw ON dw.env_namespace = dc.env_namespace AND dw.wallet_id = dc.wallet_id LEFT JOIN reporting.env_namespace rn ON halo.env_namespace = rn.env_namespace LEFT JOIN reporting.catalog dca ON halo.catalog_id = dca.catalog_id AND halo.env_namespace = dca.env_namespace AND dca.is_current WHERE rn.geo_region <> 'NotProductionData' UNION ALL /* ========================= FTA DATA ========================= */ SELECT DISTINCT fta.env, fta.namespace, fta.env_namespace, DATE_TRUNC(fta.bucket_date, DAY) AS ingressed_at, FORMAT_DATE('%F', fta.bucket_date) AS yyyymmdd, FORMAT_DATE('%Y-%m', fta.bucket_date) AS yyyymm, FORMAT_DATE('%Y', fta.bucket_date) AS yyyy, DATE_TRUNC(fta.bucket_date, WEEK) AS week_start_date, fta.bucket_date AS order_date, COALESCE(p.normalised_product_code, fta.product_code) AS normalised_product_code, fta.product_code, p.product_name, p.brand, p.retailer_taxonomy, CAST(NULL AS STRING) AS halo_taxonomy, CAST(1 AS INT64) AS halo_taxonomy_level, fta.campaign_id, IFNULL(fta.search_term, '') AS search_term, dc.campaign_placements AS placement, CAST(NULL AS STRING) AS platform, CAST(NULL AS INT64) AS page_type, CAST(1 AS INT64) AS attribution_model, "CitrusAd" AS order_type, CAST(fta.impressions AS NUMERIC) AS impressions, CAST(fta.clicks AS NUMERIC) AS clicks, CAST(fta.bucketed_cost AS NUMERIC) AS ad_spend, CAST(0 AS NUMERIC) AS direct_unit_sales, CAST(0 AS NUMERIC) AS direct_sales_value, CAST(0 AS NUMERIC) AS direct_conversions, CAST(0 AS NUMERIC) AS view_through_unit_sales, CAST(0 AS NUMERIC) AS view_through_sales_value, CAST(0 AS NUMERIC) AS view_through_conversions, CAST(0 AS NUMERIC) AS halo_unit_sales, CAST(0 AS NUMERIC) AS halo_sales_value, CAST(0 AS NUMERIC) AS halo_conversions, CAST(0 AS NUMERIC) AS total_click_sales, CAST(0 AS NUMERIC) AS total_click_sales_value, CAST(0 AS NUMERIC) AS total_unit_sales, CAST(0 AS NUMERIC) AS total_sales_value, CAST(0 AS NUMERIC) AS total_conversions, fta.retailer_group_1, fta.retailer_group_2, fta.supplier_group_1, fta.supplier_group_2, fta.supplier_group_3, fta.supplier_group_4, CAST(fta.enable_sales_metrics AS BOOL) AS enable_sales_metrics, CAST(NULL AS STRING) AS category_id, fta.campaign_name, dc.campaign_start_date, dc.campaign_end_date, dc.campaign_type, dc.campaign_subtype, fta.wallet_id, dc.active_state, dc.valid_state, CAST(NULL AS STRING) AS cta_text, fta.supplier_id, fta.retailer_id, dr.retailer_name, dr.team_type, dr.retailer_company_name AS company_name, fta.supplier_name, CAST(NULL AS STRING) AS category_name, dw.wallet_name, dw.available_balance AS wallet_available_balance, ds.supplier_company_name, DATE(dw.wallet_capture_date) AS wallet_capture_date, rn.geo_region, rn.local_timezone, IF(IFNULL(fta.search_term, '') <> '', 1, 0) AS has_search_term, CAST(0 AS INT64) AS has_category, fta.catalog_id, p.catalog_name, dr.enhanced_attribution_flag, dr.enhanced_attribution_flag_2, dr.retailer_taxonomy_halo, dr.retailer_taxonomy_halo_2, dr.view_attribution_window, dr.view_attribution_window_2, dr.click_attribution_window, dr.click_attribution_window_2, dr.attribution_time_frame, dr.attribution_time_frame_2, CAST(0 AS NUMERIC) AS imp_halo_unit_sales, CAST(0 AS NUMERIC) AS imp_halo_sales_value, CAST(0 AS NUMERIC) AS imp_halo_conversions, CAST(0 AS NUMERIC) AS attributable_impressions, CAST(0 AS NUMERIC) AS attributable_clicks, CAST(0 AS NUMERIC) AS attributable_ad_spend, TRUE AS is_fta, CAST(NULL AS STRING) AS attribution_type, dc.has_video, dc.has_companion_products FROM reporting.fta_campaign_spend fta JOIN reporting.campaign dc ON fta.env_namespace = dc.env_namespace AND fta.campaign_id = dc.campaign_id LEFT JOIN reporting.env_namespace rn ON rn.env_namespace = fta.env_namespace LEFT JOIN reporting.product p ON fta.env = p.env AND fta.env_namespace = p.env_namespace AND fta.product_code = p.product_code LEFT JOIN reporting.retailer dr ON fta.env = dr.env AND fta.env_namespace = dr.env_namespace AND fta.retailer_id = dr.retailer_id LEFT JOIN reporting.wallet dw ON dw.env_namespace = dc.env_namespace AND dw.wallet_id = dc.wallet_id LEFT JOIN reporting.supplier ds ON fta.env_namespace = ds.env_namespace AND fta.supplier_id = ds.supplier_id WHERE fta.bucket_date < CURRENT_DATE() AND rn.geo_region <> 'NotProductionData'; ```

# `reporting.env_namespace` - namespace Namespace data. Layer: Reporting Datamart Category: Dimension Status: Published Primary Key: env_namespace Other Unique Key(s): Partition: None Foreign Key(s): None | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `geo_region` | `STRING` | Geographical region of the Namespace (as defined by CitrusAd). | | `local_timezone` | `STRING` | Not in use. | | `zone_id` | `STRING` | Timezone (TZ) identifier standardised by IANA time zone database. | | `banner_enable_sales_metrics` | `BOOLEAN` | Flag to indicate if sales metrics are enabled on banner campaigns. | | `display_enable_sales_metrics` | `BOOLEAN` | Flag to indicate if sales metrics are enabled on display campaigns. | | `wildcard_enable_sales_metrics` | `BOOLEAN` | Flag to indicate if sales metrics are enabled on wildcard campaigns. | | `brand_page_enable_sales_metrics` | `BOOLEAN` | Flag to indicate if sales metrics are enabled on brand page campaigns. | | `shotgun_banner_enable_sales_metrics` | `BOOLEAN` | Flag to indicate if sales metrics are enabled on shotgun banner campaigns. | # `reporting.external_attribution_agg` - namespace external Attribution data (aggregated, both models). Layer: Reporting Datamart Category: Fact Status: Published Primary Key: env_namespace, campaign_id, category_id, normalised_product_code, product_code, product_name, brand, retailer_taxonomy, halo_taxonomy, halo_taxonomy_level, order_date, ingressed_at, search_term, placement, platform, page_type, attribution_model, retailer_id, order_type Other Unique Key(s): Partition: ingressed_at (by DAY) Foreign Key(s): env_namespace on env_namespace.env_namespace = external_attribution_agg.env_namespace; retailer on retailer.env_namespace = external_attribution_agg.env_namespace and retailer.retailer_id = external_attribution_agg.retailer_id; campaign on campaign.env_namespace = external_attribution_agg.env_namespace and campaign.campaign_id = external_attribution_agg.campaign_id; product on product.env_namespace = external_attribution_agg.env_namespace and product.product_code = external_attribution_agg.product_code; search_term on search_term.env_namespace = external_attribution_agg.env_namespace and search_term.retailer_id = external_attribution_agg.retailer_id and search_term.search_term = external_attribution_agg.search_term; category on category.env_namespace = external_attribution_agg.env_namespace and category.category_id = external_attribution_agg.category and category.retailer_id = external_attribution_agg.retailer_id; placement on placement.env_namespace = external_attribution_agg.env_namespace and placement.placement = external_attribution_agg.placement; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `namespace` | `STRING` | Name of the Namespace. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `ingressed_at` | `DATE` | Date the Ads were realised. | | `yyyymmdd` | `STRING` | Year+month+day of ingressed_at. | | `yyyymm` | `STRING` | Year+month of ingressed_at. | | `yyyy` | `STRING` | Year of ingressed_at. | | `week_start_date` | `DATE` | First day of the week of the ingressed_at date. | | `order_date` | `DATE` | Date of the Orders. | | `normalised_product_code` | `STRING` | Product code prefixed with leading zeros to be 16 characters long. | | `product_code` | `STRING` | Product code. | | `product_name` | `STRING` | Name of the Product. | | `brand` | `STRING` | Brand of the Product. | | `retailer_taxonomy` | `STRING` | Taxonomy (product hierarchy) of the Product as specified by the Retailer. | | `halo_taxonomy` | `STRING` | The portion of the retailer_taxonomy relevant for the given halo_taxonomy_level. Note for halo_taxonomy_level=1 it is null since the Brand is level 1. | | `halo_taxonomy_level` | `INTEGER` | Halo level number (1-9). 1 = Brand level halo, Levels 2-9 are the HaloTaxonomy component, 9 being the specific Product Code (SKU). | | `campaign_id` | `STRING` | Internal identifier of the Campaign (from the source system). | | `search_term` | `STRING` | DEPRECATED. Please switch to using keyword. | | `category_id` | `STRING` | Category being targeted. | | `placement` | `STRING` | Display name of the Placement. | | `platform` | `STRING` | The platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter. | | `page_type` | `INTEGER` | Legacy, superseded by Placement. | | `attribution_model` | `INTEGER` | Indicate if data is from first or second model. | | `order_type` | `STRING` | Type of the Order. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `impressions` | `NUMERIC` | Total impressions. | | `clicks` | `NUMERIC` | Number of Clicks. | | `ad_spend` | `NUMERIC` | Local currency amount charged by the Retailer to the Supplier for the Realised Ads. | | `direct_unit_sales` | `NUMERIC` | Unit sales from CitrusAd platform Attributions. | | `direct_sales_value` | `NUMERIC` | Revenue from CitrusAd platform Attributions. | | `direct_conversions` | `NUMERIC` | Conversions from CitrusAd platform Attributions. | | `view_through_unit_sales` | `NUMERIC` | Unit sales from Impression View Thru Attributions. | | `view_through_sales_value` | `NUMERIC` | Revenue from Impression View Thru Attributions. | | `view_through_conversions` | `NUMERIC` | Conversions from Impression View Thru Attributions. | | `halo_unit_sales` | `NUMERIC` | Unit sales from halo click Attributions. | | `halo_sales_value` | `NUMERIC` | Revenue from halo click Attributions. | | `halo_conversions` | `NUMERIC` | Conversions from halo click Attributions. | | `total_click_sales` | `NUMERIC` | Direct unit sales + halo unit sales. | | `total_click_sales_value` | `NUMERIC` | Direct sales value + halo sales value. | | `total_unit_sales` | `NUMERIC` | Total click sales + view through unit sales. | | `total_sales_value` | `NUMERIC` | Total click sales value + view through sales value. | | `total_conversions` | `NUMERIC` | Total click conversions + view through conversions. | | `imp_halo_unit_sales` | `NUMERIC` | Unit sales from halo click Attributions. | | `imp_halo_sales_value` | `NUMERIC` | Revenue from halo click Attributions. | | `imp_halo_conversions` | `NUMERIC` | Conversions from halo click Attributions. | | `retailer_group_1` | `STRING` | Retailer team group membership #1. | | `retailer_group_2` | `STRING` | Retailer team group membership #2. | | `supplier_group_1` | `STRING` | Supplier team group membership #1. | | `supplier_group_2` | `STRING` | Supplier team group membership #2. | | `supplier_group_3` | `STRING` | Supplier team group membership #3. | | `supplier_group_4` | `STRING` | Supplier team group membership #4. | | `supplier_id` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `enable_sales_metrics` | `BOOLEAN` | Used to set sales metrics to 0 for certain namespace/campaign types if required for reporting | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | # `reporting.external_attribution_agg_ltz` - namespace external Attribution data (aggregated, both models) LTZ Version. Layer: Reporting Datamart Category: Fact Status: Published Primary Key: env_namespace, campaign_id, category_id, normalised_product_code, product_code, product_name, brand, retailer_taxonomy, halo_taxonomy, halo_taxonomy_level, order_date, ingressed_at, search_term, placement, platform, page_type, attribution_model, retailer_id, order_type Other Unique Key(s): Partition: ingressed_at (by DAY) Foreign Key(s): env_namespace on env_namespace.env_namespace = external_attribution_agg_ltz.env_namespace; retailer on retailer.env_namespace = external_attribution_agg_ltz.env_namespace and retailer.retailer_id = external_attribution_agg_ltz.retailer_id; campaign on campaign.env_namespace = external_attribution_agg_ltz.env_namespace and campaign.campaign_id = external_attribution_agg_ltz.campaign_id; product on product.env_namespace = external_attribution_agg_ltz.env_namespace and product.product_code = external_attribution_agg_ltz.product_code; search_term on search_term.env_namespace = external_attribution_agg_ltz.env_namespace and search_term.retailer_id = external_attribution_agg_ltz.retailer_id and search_term.search_term = external_attribution_agg_ltz.search_term; category on category.env_namespace = external_attribution_agg_ltz.env_namespace and category.category_id = external_attribution_agg_ltz.category and category.retailer_id = external_attribution_agg_ltz.retailer_id; placement on placement.env_namespace = external_attribution_agg_ltz.env_namespace and placement.placement = external_attribution_agg_ltz.placement; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `namespace` | `STRING` | Name of the Namespace. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `ingressed_at` | `DATE` | Date the Ads were realised. | | `yyyymmdd` | `STRING` | Year+month+day of ingressed_at. | | `yyyymm` | `STRING` | Year+month of ingressed_at. | | `yyyy` | `STRING` | Year of ingressed_at. | | `week_start_date` | `DATE` | First day of the week of the ingressed_at date. | | `order_date` | `DATE` | Date of the Orders. | | `normalised_product_code` | `STRING` | Product code prefixed with leading zeros to be 16 characters long. | | `product_code` | `STRING` | Product code. | | `product_name` | `STRING` | Name of the Product. | | `brand` | `STRING` | Brand of the Product. | | `retailer_taxonomy` | `STRING` | Taxonomy (product hierarchy) of the Product as specified by the Retailer. | | `halo_taxonomy` | `STRING` | The portion of the retailer_taxonomy relevant for the given halo_taxonomy_level. Note for halo_taxonomy_level=1 it is null since the Brand is level 1. | | `halo_taxonomy_level` | `INTEGER` | Halo level number (1-9). 1 = Brand level halo, Levels 2-9 are the HaloTaxonomy component, 9 being the specific Product Code (SKU). | | `campaign_id` | `STRING` | Internal identifier of the Campaign (from the source system). | | `search_term` | `STRING` | DEPRECATED. Please switch to using keyword. | | `category_id` | `STRING` | Category being targeted. | | `placement` | `STRING` | Display name of the Placement. | | `platform` | `STRING` | The platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter. | | `page_type` | `INTEGER` | Legacy, superseded by Placement. | | `attribution_model` | `INTEGER` | Indicate if data is from first or second model. | | `order_type` | `STRING` | Type of the Order. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `impressions` | `NUMERIC` | Total impressions. | | `clicks` | `NUMERIC` | Number of Clicks. | | `ad_spend` | `NUMERIC` | Local currency amount charged by the Retailer to the Supplier for the Realised Ads. | | `direct_unit_sales` | `NUMERIC` | Unit sales from CitrusAd platform Attributions. | | `direct_sales_value` | `NUMERIC` | Revenue from CitrusAd platform Attributions. | | `direct_conversions` | `NUMERIC` | Conversions from CitrusAd platform Attributions. | | `view_through_unit_sales` | `NUMERIC` | Unit sales from Impression View Thru Attributions. | | `view_through_sales_value` | `NUMERIC` | Revenue from Impression View Thru Attributions. | | `view_through_conversions` | `NUMERIC` | Conversions from Impression View Thru Attributions. | | `halo_unit_sales` | `NUMERIC` | Unit sales from halo click Attributions. | | `halo_sales_value` | `NUMERIC` | Revenue from halo click Attributions. | | `halo_conversions` | `NUMERIC` | Conversions from halo click Attributions. | | `total_click_sales` | `NUMERIC` | Direct unit sales + halo unit sales. | | `total_click_sales_value` | `NUMERIC` | Direct sales value + halo sales value. | | `total_unit_sales` | `NUMERIC` | Total click sales + view through unit sales. | | `total_sales_value` | `NUMERIC` | Total click sales value + view through sales value. | | `total_conversions` | `NUMERIC` | Total click conversions + view through conversions. | | `imp_halo_unit_sales` | `NUMERIC` | Unit sales from halo click Attributions. | | `imp_halo_sales_value` | `NUMERIC` | Revenue from halo click Attributions. | | `imp_halo_conversions` | `NUMERIC` | Conversions from halo click Attributions. | | `retailer_group_1` | `STRING` | Retailer team group membership #1. | | `retailer_group_2` | `STRING` | Retailer team group membership #2. | | `supplier_group_1` | `STRING` | Supplier team group membership #1. | | `supplier_group_2` | `STRING` | Supplier team group membership #2. | | `supplier_group_3` | `STRING` | Supplier team group membership #3. | | `supplier_group_4` | `STRING` | Supplier team group membership #4. | | `supplier_id` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `enable_sales_metrics` | `BOOLEAN` | Used to set sales metrics to 0 for certain namespace/campaign types if required for reporting | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | # `reporting.external_attribution_agg_ltz_view` - namespace External Attribution view (aggregated, both models) LTZ version. Decorated version of external_attribution_agg_ltz. Layer: Reporting Datamart Category: Fact Decorated View Status: Published Primary Key: Refer to external_attribution_agg_ltz Other Unique Key(s): Partition: Refer to external_attribution_agg_ltz Foreign Key(s): Refer to view code | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `namespace` | `STRING` | Name of the Namespace. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `ingressed_at` | `DATE` | Date the Ads were realised. | | `yyyymmdd` | `STRING` | Year+month+day of ingressed_at. | | `yyyymm` | `STRING` | Year+month of ingressed_at. | | `yyyy` | `STRING` | Year of ingressed_at. | | `week_start_date` | `DATE` | First day of the week of the ingressed_at date. | | `order_date` | `DATE` | Date of the Orders. | | `normalised_product_code` | `STRING` | Product code prefixed with leading zeros to be 16 characters long. | | `product_code` | `STRING` | Product code. | | `product_name` | `STRING` | Name of the Product. | | `brand` | `STRING` | Brand of the Product. | | `retailer_taxonomy` | `STRING` | Taxonomy (product hierarchy) of the Product as specified by the Retailer. | | `halo_taxonomy` | `STRING` | The portion of the retailer_taxonomy relevant for the given halo_taxonomy_level. Note for halo_taxonomy_level=1 it is null since the Brand is level 1. | | `halo_taxonomy_level` | `INTEGER` | Halo level number (1-9). 1 = Brand level halo, Levels 2-9 are the HaloTaxonomy component, 9 being the specific Product Code (SKU). | | `campaign_id` | `STRING` | Internal identifier of the Campaign (from the source system). | | `search_term` | `STRING` | DEPRECATED. Please switch to using keyword. | | `placement` | `STRING` | Display name of the Placement. | | `platform` | `STRING` | The platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter. | | `page_type` | `INTEGER` | Legacy, superseded by Placement. | | `attribution_model` | `INTEGER` | Indicate if data is from first or second model. | | `order_type` | `STRING` | Type of the Order. | | `impressions` | `NUMERIC` | Total impressions. | | `clicks` | `NUMERIC` | Number of Clicks. | | `ad_spend` | `NUMERIC` | Local currency amount charged by the Retailer to the Supplier for the Realised Ads. | | `direct_unit_sales` | `NUMERIC` | Unit sales from CitrusAd platform Attributions. | | `direct_sales_value` | `NUMERIC` | Revenue from CitrusAd platform Attributions. | | `direct_conversions` | `NUMERIC` | Conversions from CitrusAd platform Attributions. | | `view_through_unit_sales` | `NUMERIC` | Unit sales from Impression View Thru Attributions. | | `view_through_sales_value` | `NUMERIC` | Revenue from Impression View Thru Attributions. | | `view_through_conversions` | `NUMERIC` | Conversions from Impression View Thru Attributions. | | `halo_unit_sales` | `NUMERIC` | Unit sales from halo click Attributions. | | `halo_sales_value` | `NUMERIC` | Revenue from halo click Attributions. | | `halo_conversions` | `NUMERIC` | Conversions from halo click Attributions. | | `total_click_sales` | `NUMERIC` | Direct unit sales + halo unit sales. | | `total_click_sales_value` | `NUMERIC` | Direct sales value + halo sales value. | | `total_unit_sales` | `NUMERIC` | Total click sales + view through unit sales. | | `total_sales_value` | `NUMERIC` | Total click sales value + view through sales value. | | `total_conversions` | `NUMERIC` | Total click conversions + view through conversions. | | `imp_halo_unit_sales` | `NUMERIC` | Unit sales from halo click Attributions. | | `imp_halo_sales_value` | `NUMERIC` | Revenue from halo click Attributions. | | `imp_halo_conversions` | `NUMERIC` | Conversions from halo click Attributions. | | `retailer_group_1` | `STRING` | Retailer team group membership #1. | | `retailer_group_2` | `STRING` | Retailer team group membership #2. | | `supplier_group_1` | `STRING` | Supplier team group membership #1. | | `supplier_group_2` | `STRING` | Supplier team group membership #2. | | `supplier_group_3` | `STRING` | Supplier team group membership #3. | | `supplier_group_4` | `STRING` | Supplier team group membership #4. | | `enable_sales_metrics` | `BOOLEAN` | Used to set sales metrics to 0 for certain namespace/campaign types if required for reporting | | `category_id` | `STRING` | Category being targeted. | | `campaign_name` | `STRING` | Name of the Campaign. | | `campaign_start_date` | `TIMESTAMP` | Date the Campaign will begin. | | `campaign_end_date` | `TIMESTAMP` | Date when the Campaign will end. | | `campaign_type` | `STRING` | Type of Campaign (BANNER, BRAND_PAGE, DISPLAY, EMAIL, SHOTGUN_BANNER, WILDCARD) | | `campaign_subtype` | `STRING` | Legacy, superseded by placement. Subtype of the Campaign (SEARCH_ONLY, CATEGORY_ONLY, CATEGORY_AND_SEARCH, BROAD_DISPLAY, CROSS_SELL, UPSELL, RUN_OF_SITE). | | `wallet_id` | `STRING` | Internal identifier of the Wallet (from the source system). | | `active_state` | `STRING` | The Campaign's active state as set in the platform. (ACTIVE, PAUSED, DRAFT, ARCHIVED). | | `valid_state` | `STRING` | The Campaign's valid state. (APPROVED, PENDING, REJECTED) | | `cta_text` | `STRING` | CTA text. | | `supplier_id` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `retailer_name` | `STRING` | Name of the Retailer. | | `team_type` | `STRING` | Type of Team (RETAILER or SUPPLIER). | | `company_name` | `STRING` | Company name of the Team. | | `supplier_name` | `STRING` | Name of the Supplier. | | `category_name` | `STRING` | Name of the category. | | `wallet_name` | `STRING` | Name of the Wallet. | | `wallet_available_balance` | `NUMERIC` | Current available balance of the Wallet. | | `supplier_company_name` | `STRING` | Company name of the Supplier. | | `wallet_capture_date` | `DATE` | Date the Wallet details were captured on. | | `geo_region` | `STRING` | Geographical region of the Namespace (as defined by CitrusAd). | | `local_timezone` | `STRING` | Not in use. | | `has_search_term` | `INTEGER` | Flag to indicate if the Ad is targeting a Search Term. | | `has_category` | `INTEGER` | Flag to indicate if the Ad is targeting a Category. | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `catalog_name` | `STRING` | Name of the Catalog. | | `enhanced_attribution_flag` | `STRING` | If true, the first enhanced attribution model will be calculated. | | `enhanced_attribution_flag_2` | `STRING` | If true, the second enhanced attribution model will be calculated. | | `retailer_taxonomy_halo` | `STRING` | Comma separated list of what halo levels will be computed for model 1. | | `retailer_taxonomy_halo_2` | `STRING` | Comma separated list of what halo levels will be computed for model 2. | | `view_attribution_window` | `NUMERIC` | Max number of days allowed between the Order and Realised Ad for View Thru Attribution. | | `view_attribution_window_2` | `NUMERIC` | Max number of days allowed between the Order and Realised Ad for View Thru Attribution (2nd model). | | `click_attribution_window` | `NUMERIC` | Max number of days allowed between the Order and Realised Ad for Halo Click Attribution (1st model). | | `click_attribution_window_2` | `NUMERIC` | Max number of days allowed between the Order and Realised Ad for Halo Click Attribution (2nd model). | | `attribution_time_frame` | `NUMERIC` | Determines how many days of attribution results should be stored for the first model. | | `attribution_time_frame_2` | `NUMERIC` | Determines how many days of attribution results should be stored for the second model. | | `is_fta` | `BOOLEAN` | Flag indicating if the Campaign is Fixed Tenancy Agreement (FTA). | | `has_video` | `BOOLEAN` | Flag to indicate if the Campaign has video. | | `has_companion_products` | `BOOLEAN` | Flag to indicate if the Campaign has companion products. |

SQL Query

```sql select DISTINCT halo.* EXCEPT(catalog_id,category_id,retailer_id,supplier_id), cast(halo.category_id as string) category_id, dc.campaign_name campaign_name, dc.campaign_start_date AS campaign_start_date, dc.campaign_end_date AS campaign_end_date, dc.campaign_type campaign_type, dc.campaign_subtype campaign_subtype, dc.wallet_id wallet_id, dc.active_state active_state, dc.valid_state valid_state, dc.cta_text, halo.supplier_id supplier_id, halo.retailer_id retailer_id, dr.retailer_name, dr.team_type team_type, dr.retailer_company_name company_name, ds.supplier_name supplier_name, cat.category_label AS category_name, dw.wallet_name wallet_name, dw.available_balance AS wallet_available_balance, ds.supplier_company_name AS supplier_company_name, DATE(dw.wallet_capture_date) AS wallet_capture_date, rn.geo_region, rn.local_timezone, if(ifnull(halo.search_term,'')<>'' ,1,0) has_search_term, if(ifnull(cat.category_label,'')<>'' ,1,0) has_category, halo.catalog_id, dca.catalog_name, dr.enhanced_attribution_flag, dr.enhanced_attribution_flag_2, dr.retailer_taxonomy_halo, dr.retailer_taxonomy_halo_2, dr.view_attribution_window, dr.view_attribution_window_2, dr.click_attribution_window, dr.click_attribution_window_2, dr.attribution_time_frame, dr.attribution_time_frame_2, COALESCE(UPPER(dc.is_fta) = 'TRUE', FALSE) AS is_fta, dc.has_video, dc.has_companion_products from reporting.external_attribution_agg_ltz halo left join reporting.campaign dc on halo.campaign_id = dc.campaign_id and halo.env_namespace = dc.env_namespace left join reporting.retailer dr on halo.env_namespace = dr.env_namespace and halo.retailer_id = dr.retailer_id left join reporting.supplier ds on halo.env_namespace = ds.env_namespace and halo.supplier_id = ds.supplier_id left join reporting.category cat on cat.category_id = halo.category_id and cat.env_namespace = halo.env_namespace and cat.retailer_id = dr.retailer_id left join reporting.wallet dw on dw.env_namespace = dc.env_namespace and dw.wallet_id = dc.wallet_id left join reporting.env_namespace rn on halo.env_namespace = rn.env_namespace left join reporting.catalog dca on halo.catalog_id = dca.catalog_id and halo.env_namespace = dca.env_namespace and dca.is_current where rn.geo_region <> 'NotProductionData' and halo.order_date>'2024-12-09' ```

# `reporting.external_attribution_agg_view` - namespace External Attribution view (aggregated, both models). Decorated version of external_attribution_agg. Layer: Reporting Datamart Category: Fact Decorated View Status: Published Primary Key: Refer to external_attribution_agg Other Unique Key(s): Partition: Refer to external_attribution_agg Foreign Key(s): Refer to view code | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `namespace` | `STRING` | Name of the Namespace. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `ingressed_at` | `DATE` | Date the Ads were realised. | | `yyyymmdd` | `STRING` | Year+month+day of ingressed_at. | | `yyyymm` | `STRING` | Year+month of ingressed_at. | | `yyyy` | `STRING` | Year of ingressed_at. | | `week_start_date` | `DATE` | First day of the week of the ingressed_at date. | | `order_date` | `DATE` | Date of the Orders. | | `normalised_product_code` | `STRING` | Product code prefixed with leading zeros to be 16 characters long. | | `product_code` | `STRING` | Product code. | | `product_name` | `STRING` | Name of the Product. | | `brand` | `STRING` | Brand of the Product. | | `retailer_taxonomy` | `STRING` | Taxonomy (product hierarchy) of the Product as specified by the Retailer. | | `halo_taxonomy` | `STRING` | The portion of the retailer_taxonomy relevant for the given halo_taxonomy_level. Note for halo_taxonomy_level=1 it is null since the Brand is level 1. | | `halo_taxonomy_level` | `INTEGER` | Halo level number (1-9). 1 = Brand level halo, Levels 2-9 are the HaloTaxonomy component, 9 being the specific Product Code (SKU). | | `campaign_id` | `STRING` | Internal identifier of the Campaign (from the source system). | | `search_term` | `STRING` | DEPRECATED. Please switch to using keyword. | | `placement` | `STRING` | Display name of the Placement. | | `platform` | `STRING` | The platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter. | | `page_type` | `INTEGER` | Legacy, superseded by Placement. | | `attribution_model` | `INTEGER` | Indicate if data is from first or second model. | | `order_type` | `STRING` | Type of the Order. | | `impressions` | `NUMERIC` | Total impressions. | | `clicks` | `NUMERIC` | Number of Clicks. | | `ad_spend` | `NUMERIC` | Local currency amount charged by the Retailer to the Supplier for the Realised Ads. | | `direct_unit_sales` | `NUMERIC` | Unit sales from CitrusAd platform Attributions. | | `direct_sales_value` | `NUMERIC` | Revenue from CitrusAd platform Attributions. | | `direct_conversions` | `NUMERIC` | Conversions from CitrusAd platform Attributions. | | `view_through_unit_sales` | `NUMERIC` | Unit sales from Impression View Thru Attributions. | | `view_through_sales_value` | `NUMERIC` | Revenue from Impression View Thru Attributions. | | `view_through_conversions` | `NUMERIC` | Conversions from Impression View Thru Attributions. | | `halo_unit_sales` | `NUMERIC` | Unit sales from halo click Attributions. | | `halo_sales_value` | `NUMERIC` | Revenue from halo click Attributions. | | `halo_conversions` | `NUMERIC` | Conversions from halo click Attributions. | | `total_click_sales` | `NUMERIC` | Direct unit sales + halo unit sales. | | `total_click_sales_value` | `NUMERIC` | Direct sales value + halo sales value. | | `total_unit_sales` | `NUMERIC` | Total click sales + view through unit sales. | | `total_sales_value` | `NUMERIC` | Total click sales value + view through sales value. | | `total_conversions` | `NUMERIC` | Total click conversions + view through conversions. | | `imp_halo_unit_sales` | `NUMERIC` | Unit sales from halo click Attributions. | | `imp_halo_sales_value` | `NUMERIC` | Revenue from halo click Attributions. | | `imp_halo_conversions` | `NUMERIC` | Conversions from halo click Attributions. | | `retailer_group_1` | `STRING` | Retailer team group membership #1. | | `retailer_group_2` | `STRING` | Retailer team group membership #2. | | `supplier_group_1` | `STRING` | Supplier team group membership #1. | | `supplier_group_2` | `STRING` | Supplier team group membership #2. | | `supplier_group_3` | `STRING` | Supplier team group membership #3. | | `supplier_group_4` | `STRING` | Supplier team group membership #4. | | `enable_sales_metrics` | `BOOLEAN` | Used to set sales metrics to 0 for certain namespace/campaign types if required for reporting | | `category_id` | `STRING` | Category being targeted. | | `campaign_name` | `STRING` | Name of the Campaign. | | `campaign_start_date` | `TIMESTAMP` | Date the Campaign will begin. | | `campaign_end_date` | `TIMESTAMP` | Date when the Campaign will end. | | `campaign_type` | `STRING` | Type of Campaign (BANNER, BRAND_PAGE, DISPLAY, EMAIL, SHOTGUN_BANNER, WILDCARD) | | `campaign_subtype` | `STRING` | Legacy, superseded by placement. Subtype of the Campaign (SEARCH_ONLY, CATEGORY_ONLY, CATEGORY_AND_SEARCH, BROAD_DISPLAY, CROSS_SELL, UPSELL, RUN_OF_SITE). | | `wallet_id` | `STRING` | Internal identifier of the Wallet (from the source system). | | `active_state` | `STRING` | The Campaign's active state as set in the platform. (ACTIVE, PAUSED, DRAFT, ARCHIVED). | | `valid_state` | `STRING` | The Campaign's valid state. (APPROVED, PENDING, REJECTED) | | `cta_text` | `STRING` | CTA text. | | `supplier_id` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `retailer_name` | `STRING` | Name of the Retailer. | | `team_type` | `STRING` | Type of Team (RETAILER or SUPPLIER). | | `company_name` | `STRING` | Company name of the Team. | | `supplier_name` | `STRING` | Name of the Supplier. | | `category_name` | `STRING` | Name of the category. | | `wallet_name` | `STRING` | Name of the Wallet. | | `wallet_available_balance` | `NUMERIC` | Current available balance of the Wallet. | | `supplier_company_name` | `STRING` | Company name of the Supplier. | | `wallet_capture_date` | `DATE` | Date the Wallet details were captured on. | | `geo_region` | `STRING` | Geographical region of the Namespace (as defined by CitrusAd). | | `local_timezone` | `STRING` | Not in use. | | `has_search_term` | `INTEGER` | Flag to indicate if the Ad is targeting a Search Term. | | `has_category` | `INTEGER` | Flag to indicate if the Ad is targeting a Category. | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `catalog_name` | `STRING` | Name of the Catalog. | | `enhanced_attribution_flag` | `STRING` | If true, the first enhanced attribution model will be calculated. | | `enhanced_attribution_flag_2` | `STRING` | If true, the second enhanced attribution model will be calculated. | | `retailer_taxonomy_halo` | `STRING` | Comma separated list of what halo levels will be computed for model 1. | | `retailer_taxonomy_halo_2` | `STRING` | Comma separated list of what halo levels will be computed for model 2. | | `view_attribution_window` | `NUMERIC` | Max number of days allowed between the Order and Realised Ad for View Thru Attribution. | | `view_attribution_window_2` | `NUMERIC` | Max number of days allowed between the Order and Realised Ad for View Thru Attribution (2nd model). | | `click_attribution_window` | `NUMERIC` | Max number of days allowed between the Order and Realised Ad for Halo Click Attribution (1st model). | | `click_attribution_window_2` | `NUMERIC` | Max number of days allowed between the Order and Realised Ad for Halo Click Attribution (2nd model). | | `attribution_time_frame` | `NUMERIC` | Determines how many days of attribution results should be stored for the first model. | | `attribution_time_frame_2` | `NUMERIC` | Determines how many days of attribution results should be stored for the second model. | | `is_fta` | `BOOLEAN` | Flag indicating if the Campaign is Fixed Tenancy Agreement (FTA). | | `has_video` | `BOOLEAN` | Flag to indicate if the Campaign has video. | | `has_companion_products` | `BOOLEAN` | Flag to indicate if the Campaign has companion products. |

SQL Query

```sql select DISTINCT halo.* EXCEPT(catalog_id,category_id,retailer_id,supplier_id), cast(halo.category_id as string) category_id, dc.campaign_name campaign_name, dc.campaign_start_date AS campaign_start_date, dc.campaign_end_date AS campaign_end_date, dc.campaign_type campaign_type, dc.campaign_subtype campaign_subtype, dc.wallet_id wallet_id, dc.active_state active_state, dc.valid_state valid_state, dc.cta_text, halo.supplier_id supplier_id, halo.retailer_id retailer_id, dr.retailer_name, dr.team_type team_type, dr.retailer_company_name company_name, ds.supplier_name supplier_name, cat.category_label AS category_name, dw.wallet_name wallet_name, dw.available_balance AS wallet_available_balance, ds.supplier_company_name AS supplier_company_name, DATE(dw.wallet_capture_date) AS wallet_capture_date, rn.geo_region, rn.local_timezone, if(ifnull(halo.search_term,'')<>'' ,1,0) has_search_term, if(ifnull(cat.category_label,'')<>'' ,1,0) has_category, halo.catalog_id, dca.catalog_name, dr.enhanced_attribution_flag, dr.enhanced_attribution_flag_2, dr.retailer_taxonomy_halo, dr.retailer_taxonomy_halo_2, dr.view_attribution_window, dr.view_attribution_window_2, dr.click_attribution_window, dr.click_attribution_window_2, dr.attribution_time_frame, dr.attribution_time_frame_2, COALESCE(UPPER(dc.is_fta) = 'TRUE', FALSE) AS is_fta, dc.has_video, dc.has_companion_products from reporting.external_attribution_agg halo left join reporting.campaign dc on halo.campaign_id = dc.campaign_id and halo.env_namespace = dc.env_namespace left join reporting.retailer dr on halo.env_namespace = dr.env_namespace and halo.retailer_id = dr.retailer_id left join reporting.supplier ds on halo.env_namespace = ds.env_namespace and halo.supplier_id = ds.supplier_id left join reporting.category cat on cat.category_id = halo.category_id and cat.env_namespace = halo.env_namespace and cat.retailer_id = dr.retailer_id left join reporting.wallet dw on dw.env_namespace = dc.env_namespace and dw.wallet_id = dc.wallet_id left join reporting.env_namespace rn on halo.env_namespace = rn.env_namespace left join reporting.catalog dca on halo.catalog_id = dca.catalog_id and halo.env_namespace = dca.env_namespace and dca.is_current where rn.geo_region <> 'NotProductionData' and halo.order_date>'2024-12-09' ```

# `reporting.fta_campaign_spend` - supplier - namespace FTA Campaign Spend data. Layer: Reporting Datamart Category: Fact Status: Published Primary Key: env_namespace, campaign_id, wallet_id, search_term, catalog_id, product_code, bucket_date Other Unique Key(s): Partition: None Foreign Key(s): env_namespace on env_namespace.env_namespace = fta_campaign_spend.env_namespace; campaign on campaign.env_namespace = fta_campaign_spend.env_namespace and campaign.campaign_id = fta_campaign_spend.campaign_id; supplier on supplier.env_namespace = fta_campaign_spend.env_namespace and supplier.supplier_id = fta_campaign_spend.supplier_id; retailer on retailer.env_namespace = fta_campaign_spend.env_namespace and retailer.retailer_id = fta_campaign_spend.retailer_id; wallet on wallet.env_namespace = fta_campaign_spend.env_namespace and wallet.wallet_id = fta_campaign_spend.wallet_id; catalog on catalog.env_namespace = fta_campaign_spend.env_namespace and catalog.catalog_id = fta_campaign_spend.catalog_id; search_term on search_term.env_namespace = fta_campaign_spend.env_namespace and search_term.retailer_id = fta_campaign_spend.retailer_id and search_term.search_term = fta_campaign_spend.search_term; product on product.env_namespace = fta_campaign_spend.env_namespace and product.product_code = fta_campaign_spend.product_code; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `namespace` | `STRING` | Name of the Namespace. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `campaign_id` | `STRING` | Internal identifier of the Campaign (from the source system). | | `supplier_id` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `wallet_id` | `STRING` | Internal identifier of the Wallet (from the source system). | | `search_term` | `STRING` | The word/phrase being searched for on the retailer site by the end user. | | `product_code` | `STRING` | Product code. | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `supplier_name` | `STRING` | Name of the Supplier. | | `campaign_name` | `STRING` | Name of the Campaign. | | `ad_type` | `INTEGER` | Type of Ad (0 = Product, 1 = Banner, 4 = BannerX). | | `bucketed_cost` | `NUMERIC` | Bucketed cost. | | `ad_spend` | `NUMERIC` | Local currency amount charged by the Retailer to the Supplier for the Realised Ads. | | `click_spend` | `NUMERIC` | AdSpend generated by clicks. | | `clicks` | `INTEGER` | Number of Clicks. | | `impressions` | `INTEGER` | Total impressions. | | `conversions` | `INTEGER` | Total standard Conversions (purchases of the exact Product in the Ad). | | `sales_revenue` | `INTEGER` | Total sales revenue generated by Conversions. | | `unit_sales` | `INTEGER` | Total number of Products purchased from Conversions. | | `bucket_date` | `DATE` | Bucket date. | | `retailer_group_1` | `STRING` | Retailer group membership #1. | | `retailer_group_2` | `STRING` | Retailer group membership #2. | | `supplier_group_1` | `STRING` | Supplier team group membership #1. | | `supplier_group_2` | `STRING` | Supplier team group membership #2. | | `supplier_group_3` | `STRING` | Supplier team group membership #3. | | `supplier_group_4` | `STRING` | Supplier team group membership #4. | | `enable_sales_metrics` | `BOOLEAN` | Used to set sales metrics to 0 for certain namespace/campaign types if required for reporting | # `reporting.ledger_agg` - supplier - retailer - namespace Ledger data (aggregated into UTC+0 day buckets). Layer: Reporting Datamart Category: Fact Status: Published Primary Key: transaction_date, env_namespace, team_id, wallet_id, campaign_id, ledger_type, product_type, reason, retailer_id Other Unique Key(s): Partition: None Foreign Key(s): env_namespace on env_namespace.env_namespace = ledger_agg.env_namespace; retailer on retailer.env_namespace = ledger_agg.env_namespace and retailer.retailer_id = ledger_agg.retailer_id; campaign on campaign.env_namespace = ledger_agg.env_namespace and campaign.campaign_id = ledger_agg.campaign_id; team on team.env_namespace = ledger_agg.env_namespace and team.team_id = ledger_agg.team_id; wallet on wallet.env_namespace = ledger_agg.env_namespace and wallet.wallet_id = ledger_agg.wallet_id; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `team_id` | `STRING` | Internal identifier of the Team (from the source system). | | `supplier_id` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `wallet_id` | `STRING` | Internal identifier of the Wallet (from the source system). | | `campaign_id` | `STRING` | Internal identifier of the Campaign (from the source system). | | `team_name` | `STRING` | Name of the Team. | | `supplier_name` | `STRING` | Name of the Supplier. | | `supplier_company_name` | `STRING` | Company name of the Supplier. | | `retailer_name` | `STRING` | Name of the Retailer. | | `retailer_company_name` | `STRING` | Company name of the Retailer. | | `wallet_name` | `STRING` | Name of the Wallet. | | `wallet_currency_code` | `STRING` | ISO 4217 currency code | | `wallet_external_id` | `STRING` | Implementation specific generic label. | | `campaign_name` | `STRING` | Name of the Campaign. | | `campaign_type` | `STRING` | Type of Campaign (BANNER, BRAND_PAGE, DISPLAY, EMAIL, SHOTGUN_BANNER, WILDCARD) | | `namespace` | `STRING` | Name of the Namespace. | | `ledger_type` | `STRING` | Debit or Credit transaction type. | | `product_type` | `STRING` | Type of the Product. | | `reason` | `STRING` | Reason given for the transaction type. | | `wallet_archived` | `BOOLEAN` | Archived status of the Wallet. | | `transaction_date` | `DATE` | Date of the transactions. | | `campaign_start_date` | `TIMESTAMP` | Date the Campaign will begin. | | `campaign_end_date` | `TIMESTAMP` | Date when the Campaign will end. | | `campaign_valid_state` | `STRING` | The Campaign's valid state. (APPROVED, PENDING, REJECTED) | | `campaign_active_state` | `STRING` | The Campaign's active state as set in the platform. (ACTIVE, PAUSED, DRAFT, ARCHIVED). | | `campaign_is_fta` | `STRING` | Flag indicating if the Campaign is Fixed Tenancy Agreement (FTA). | | `amount` | `NUMERIC` | Total of transaction amounts. | | `campaign_fta_cost` | `NUMERIC` | Total amount being spent by the given Fixed Tenancy (FTA) Campaign. | | `campaign_max_cost_per_click` | `NUMERIC` | The maximum cost per click set for the Campaign. | | `campaign_max_total_spend` | `NUMERIC` | The maximum total spend set for the Campaign. | | `campaign_max_daily_spend` | `NUMERIC` | The maximum daily spend set for the Campaign. | | `campaign_total_spend` | `NUMERIC` | Total AdSpend to date for the Campaign. | | `wallet_active_campaign_count` | `NUMERIC` | Number of currently active Campaigns associated to the Wallet. | | `wallet_active_campaign_max_total_spend` | `NUMERIC` | Aggregate CampaignMaxTotalSpend for all currently active Campaigns associated to the Wallet. | | `currency_value` | `FLOAT` | Local currency to USD conversion rate (current rate only). | | `retailer_group_1` | `STRING` | Retailer team group membership #1. | | `retailer_group_2` | `STRING` | Retailer team group membership #2. | | `supplier_group_1` | `STRING` | Supplier team group membership #1. | | `supplier_group_2` | `STRING` | Supplier team group membership #2. | | `supplier_group_3` | `STRING` | Supplier team group membership #3. | | `supplier_group_4` | `STRING` | Supplier team group membership #4. | | `geo_region` | `STRING` | Geographical region of the Namespace (as defined by CitrusAd). | | `local_timezone` | `STRING` | Not in use. | | `transaction_count` | `NUMERIC` | Total transaction count. | # `reporting.ledger_agg_2` - supplier - retailer - namespace Ledger data (aggregated into UTC+0 hourly buckets). Only for current + previous 3 months. Layer: Reporting Datamart Category: Fact Status: Published Primary Key: transaction_date, env_namespace, team_id, wallet_id, campaign_id, ledger_type, product_ledger, reason, retailer_id Other Unique Key(s): Partition: None Foreign Key(s): env_namespace on env_namespace.env_namespace = ledger_agg_2.env_namespace; retailer on retailer.env_namespace = ledger_agg_2.env_namespace and retailer.retailer_id = ledger_agg_2.retailer_id; campaign on campaign.env_namespace = ledger_agg_2.env_namespace and campaign.campaign_id = ledger_agg_2.campaign_id; team on team.env_namespace = ledger_agg_2.env_namespace and team.team_id = ledger_agg_2.team_id; wallet on wallet.env_namespace = ledger_agg_2.env_namespace and wallet.wallet_id = ledger_agg_2.wallet_id; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `team_id` | `STRING` | Internal identifier of the Team (from the source system). | | `supplier_id` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `wallet_id` | `STRING` | Internal identifier of the Wallet (from the source system). | | `campaign_id` | `STRING` | Internal identifier of the Campaign (from the source system). | | `team_name` | `STRING` | Name of the Team. | | `supplier_name` | `STRING` | Name of the Supplier. | | `supplier_company_name` | `STRING` | Company name of the Supplier. | | `retailer_name` | `STRING` | Name of the Retailer. | | `retailer_company_name` | `STRING` | Company name of the Retailer. | | `wallet_name` | `STRING` | Name of the Wallet. | | `wallet_currency_code` | `STRING` | ISO 4217 currency code | | `wallet_external_id` | `STRING` | Implementation specific generic label. | | `campaign_name` | `STRING` | Name of the Campaign. | | `campaign_type` | `STRING` | Type of Campaign (BANNER, BRAND_PAGE, DISPLAY, EMAIL, SHOTGUN_BANNER, WILDCARD) | | `namespace` | `STRING` | Name of the Namespace. | | `ledger_type` | `STRING` | Debit or Credit transaction type. | | `product_type` | `STRING` | Type of the Product. | | `reason` | `STRING` | Reason given for the transaction type. | | `wallet_archived` | `BOOLEAN` | Archived status of the Wallet. | | `transaction_timestamp` | `TIMESTAMP` | Timestamp of the transactions rounded up to the hour | | `campaign_start_date` | `TIMESTAMP` | Date the Campaign will begin. | | `campaign_end_date` | `TIMESTAMP` | Date when the Campaign will end. | | `campaign_valid_state` | `STRING` | The Campaign's valid state. (APPROVED, PENDING, REJECTED) | | `campaign_active_state` | `STRING` | The Campaign's active state as set in the platform. (ACTIVE, PAUSED, DRAFT, ARCHIVED). | | `campaign_is_fta` | `STRING` | Flag indicating if the Campaign is Fixed Tenancy Agreement (FTA). | | `amount` | `NUMERIC` | Total of transaction amounts. | | `campaign_fta_cost` | `NUMERIC` | Total amount being spent by the given Fixed Tenancy (FTA) Campaign. | | `campaign_max_cost_per_click` | `NUMERIC` | The maximum cost per click set for the Campaign. | | `campaign_max_total_spend` | `NUMERIC` | The maximum total spend set for the Campaign. | | `campaign_max_daily_spend` | `NUMERIC` | The maximum daily spend set for the Campaign. | | `campaign_total_spend` | `NUMERIC` | Total AdSpend to date for the Campaign. | | `wallet_active_campaign_count` | `NUMERIC` | Number of currently active Campaigns associated to the Wallet. | | `wallet_active_campaign_max_total_spend` | `NUMERIC` | Aggregate CampaignMaxTotalSpend for all currently active Campaigns associated to the Wallet. | | `currency_value` | `FLOAT` | Local currency to USD conversion rate (current rate only). | | `retailer_group_1` | `STRING` | Retailer team group membership #1. | | `retailer_group_2` | `STRING` | Retailer team group membership #2. | | `supplier_group_1` | `STRING` | Supplier team group membership #1. | | `supplier_group_2` | `STRING` | Supplier team group membership #2. | | `supplier_group_3` | `STRING` | Supplier team group membership #3. | | `supplier_group_4` | `STRING` | Supplier team group membership #4. | | `geo_region` | `STRING` | Geographical region of the Namespace (as defined by CitrusAd). | | `local_timezone` | `STRING` | Not in use. | | `transaction_count` | `INTEGER` | Total transaction count. | # `reporting.order_ad_stats` - retailer - namespace Order and Realised Ad statistics data (aggregated). Layer: Reporting Datamart Category: Fact Status: Published Primary Key: env_namespace, retailer_id, order_date, product_code, normalised_product_code Other Unique Key(s): Partition: None Foreign Key(s): env_namespace on env_namespace.env_namespace = order_ad_stats.env_namespace; retailer on retailer.env_namespace = order_ad_stats.env_namespace and retailer.retailer_id = order_ad_stats.retailer_id; catalog on catalog.env_namespace = order_ad_stats.env_namespace and catalog.catalog_id = order_ad_stats.catalog_id; product on product.env_namespace = order_ad_stats.env_namespace and product.catalog_id = order_ad_stats.catalog_id and product.product_code = order_ad_stats.product_code; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `namespace` | `STRING` | Name of the Namespace. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `product_code` | `STRING` | Product code. | | `normalised_product_code` | `STRING` | Product code prefixed with leading zeros to be 16 characters long. | | `ad_stats_product_code` | `STRING` | Product code. | | `order_date` | `DATE` | Date of the Orders. | | `conversions_from_ads` | `NUMERIC` | Total Conversions occuring from CitrusAd Ads. | | `unit_sales_from_ads` | `NUMERIC` | Total number of Products purchased from Conversions. | | `total_price` | `NUMERIC` | Total paid for the products ordered. | | `quantity` | `NUMERIC` | Quantity of the Product ordered. | | `order_items` | `NUMERIC` | Total number of items ordered. | | `orders` | `NUMERIC` | Number of Orders made. | | `product_name` | `STRING` | Name of the Product. | | `brand` | `STRING` | Brand of the Product. | | `product_type` | `STRING` | Type of the Product. | | `product_tags` | `STRING` | Tags associated with the Product. | | `currency_code` | `STRING` | ISO 4217 currency code | | `retailer_name` | `STRING` | Name of the Retailer. | | `currency_value` | `FLOAT` | Local currency to USD conversion rate (current rate only). | | `geo_region` | `STRING` | Geographical region of the Namespace (as defined by CitrusAd). | | `local_timezone` | `STRING` | Not in use. | | `retailer_group_1` | `STRING` | Retailer group membership #1. | | `retailer_group_2` | `STRING` | Retailer group membership #2. | # `reporting.order_agg` - retailer - namespace Order data (aggregated). Layer: Reporting Datamart Category: Fact Status: Published Primary Key: env_namespace, order_date, issuer_team_id, retailer_id, catalog_id, product_code, normalised_product_code, order_type Other Unique Key(s): Partition: order_date (by DAY) Foreign Key(s): env_namespace on env_namespace.env_namespace = order_agg.env_namespace; retailer on retailer.env_namespace = order_agg.env_namespace and retailer.retailer_id = order_agg.retailer_id; catalog on catalog.env_namespace = order_agg.env_namespace and catalog.catalog_id = order_agg.catalog_id; product on product.env_namespace = order_agg.env_namespace and product.catalog_id = order_agg.catalog_id and product.product_code = order_agg.product_code; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `normalised_product_code` | `STRING` | Product code prefixed with leading zeros to be 16 characters long. | | `product_code` | `STRING` | Product code. | | `issuer_team_id` | `STRING` | Internal identifier of the Team (from the source system). | | `product_name` | `STRING` | Name of the Product. | | `brand` | `STRING` | Brand of the Product. | | `product_type` | `STRING` | Type of the Product. | | `product_tags` | `STRING` | Tags associated with the Product. | | `retailer_name` | `STRING` | Name of the Retailer. | | `currency_code` | `STRING` | ISO 4217 currency code | | `namespace` | `STRING` | Name of the Namespace. | | `retailer_group_1` | `STRING` | Retailer team group membership #1. | | `retailer_group_2` | `STRING` | Retailer team group membership #2. | | `order_type` | `STRING` | Type of the Order. | | `order_date` | `DATE` | Date of the Orders. | | `total_price` | `NUMERIC` | Total paid for the products ordered. | | `total_price_usd` | `FLOAT` | total_price in USD (current exchange rate only). | | `quantity` | `NUMERIC` | Quantity of the Product ordered. | | `order_items` | `NUMERIC` | Total number of items ordered. | | `orders` | `NUMERIC` | Number of Orders made. | # `reporting.placement` - namespace Placement data. Layer: Reporting Datamart Category: Dimension Status: Published Primary Key: env_namespace, placement_id Other Unique Key(s): Partition: None Foreign Key(s): env_namespace on env_namespace.env_namespace = placement.env_namespace; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `placement_id` | `STRING` | Internal identifier of the Placement (from the source system). | | `ad_gen_id` | `STRING` | Ad gen id. | | `catalog_ids` | `STRING` | Catalog ids. | | `display_name` | `STRING` | Display name of the Placement. | | `campaign_target` | `STRING` | Campaign target. | | `campaign_types` | `STRING` | List of applicable campaign types. | | `namespace` | `STRING` | Name of the Namespace. | | `archived` | `STRING` | Archived status of the Placement. | # `reporting.product` - retailer - namespace Product data. Layer: Reporting Datamart Category: Dimension Status: Published Primary Key: env_namespace, normalised_product_code, product_code, catalog_id Other Unique Key(s): Partition: None Foreign Key(s): env_namespace on env_namespace.env_namespace = product.env_namespace; catalog on catalog.env_namespace = product.env_namespace and catalog.catalog_id = product.catalog_id; retailer on retailer.env_namespace = product.env_namespace and retailer.retailer_id = product.retailer_id; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `normalised_product_code` | `STRING` | Product code prefixed with leading zeros to be 16 characters long. | | `product_code` | `STRING` | Product code. | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `product_name` | `STRING` | Name of the Product. | | `product_type` | `STRING` | Type of the Product. | | `retailer_name` | `STRING` | Name of the Retailer. | | `currency_code` | `STRING` | ISO 4217 currency code | | `product_tags` | `STRING` | Tags associated with the Product. | | `product_image_url` | `STRING` | URL to an image of the Product for the Ad. | | `brand` | `STRING` | Brand of the Product. | | `google_product_taxonomy` | `STRING` | Google taxonomy (product hierarchy) of the Product. Levels of the hierarchy delimited using > symbol. | | `retailer_taxonomy` | `STRING` | Taxonomy (product hierarchy) of the Product as specified by the Retailer. | | `namespace` | `STRING` | Name of the Namespace. | | `is_deleted` | `BOOLEAN` | Flag to indicate that the record has been soft deleted in the source system. | | `catalog_name` | `STRING` | Name of the Catalog. | | `type` | `STRING` | Type of Product. | | `retailer_group_1` | `STRING` | Retailer team group membership #1. | | `retailer_group_2` | `STRING` | Retailer team group membership #2. | | `seller_id` | `STRING` | Seller that the Product is applicable for. | | `upc` | `STRING` | UPC of the Product. | | `inventory` | `STRING` | How much of the Product is in stock. | | `geo_region` | `STRING` | Geographical region of the Namespace (as defined by CitrusAd). | | `local_timezone` | `STRING` | Not in use. | # `reporting.realised_ad_agg` - supplier Realised Ad data (aggregated into UTC+0 day buckets). Layer: Reporting Datamart Category: Fact Status: Published Primary Key: ingressed_at, env_namespace, catalog_id, retailer_id, supplier_id, campaign_id, ad_type, search_term, generic_search_term, product_code, content_standard_id, slot_id, category, placement, platform, target_product_code Other Unique Key(s): Partition: ingressed_at (by DAY) Foreign Key(s): env_namespace on env_namespace.env_namespace = realised_ad_agg.env_namespace; retailer on retailer.env_namespace = realised_ad_agg.env_namespace and retailer.retailer_id = realised_ad_agg.retailer_id; catalog on catalog.env_namespace = realised_ad_agg.env_namespace and catalog.catalog_id = realised_ad_agg.catalog_id; product on product.env_namespace = realised_ad_agg.env_namespace and product.catalog_id = realised_ad_agg.catalog_id and product.normalised_product_code = realised_ad_agg.product_code; supplier on supplier.env_namespace = realised_ad_agg.env_namespace and supplier.supplier_id = realised_ad_agg.supplier_id; campaign on campaign.env_namespace = realised_ad_agg.env_namespace and campaign.campaign_id = realised_ad_agg.campaign_id; category on category.env_namespace = realised_ad_agg.env_namespace and category.retailer_id = realised_ad_agg.retailer_id and category.category_id = realised_ad_agg.category | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `ingressed_at` | `DATE` | Date the Ads were realised. | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `campaign_id` | `STRING` | Internal identifier of the Campaign (from the source system). | | `supplier_id` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `search_term` | `STRING` | DEPRECATED. Please switch to using keyword. | | `generic_search_term` | `STRING` | DEPRECATED. Please switch to using keyword. | | `product_code` | `STRING` | Product code. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `content_standard_id` | `STRING` | ContentStandardId as specified in the Ad Request. | | `slot_id` | `STRING` | Banner SlotId as specified in the Ad Request. | | `category` | `STRING` | Category being targeted. | | `placement` | `STRING` | Display name of the Placement. | | `platform` | `STRING` | The platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter. | | `ad_type` | `INTEGER` | Type of Ad (0 = Product, 1 = Banner, 4 = BannerX). | | `target_product_code` | `STRING` | Target Product code. | | `has_search_term` | `INTEGER` | Flag to indicate if the Ad is targeting a Search Term. | | `has_category` | `INTEGER` | Flag to indicate if the Ad is targeting a Category. | | `retailer_group_1` | `STRING` | Retailer group membership #1. | | `retailer_group_2` | `STRING` | Retailer group membership #2. | | `supplier_group_1` | `STRING` | Supplier team group membership #1. | | `supplier_group_2` | `STRING` | Supplier team group membership #2. | | `supplier_group_3` | `STRING` | Supplier team group membership #3. | | `supplier_group_4` | `STRING` | Supplier team group membership #4. | | `sales_revenue` | `NUMERIC` | Total sales revenue generated by Conversions. | | `ad_revenue` | `NUMERIC` | Portion of Ad spend retained by the Retailer. | | `ad_spend` | `NUMERIC` | Local currency amount charged by the Retailer to the Supplier for the Realised Ads. | | `impressions` | `NUMERIC` | Total impressions. | | `clicks` | `NUMERIC` | Number of Clicks. | | `conversions` | `NUMERIC` | Total standard Conversions (purchases of the exact Product in the Ad). | | `unit_sales` | `NUMERIC` | Total number of Products purchased from Conversions. | | `click_spend` | `NUMERIC` | AdSpend generated by clicks. | | `impression_spend` | `NUMERIC` | AdSpend generated by impressions. | | `position_sum` | `NUMERIC` | Sum of all postions for the Ads. Used to calculate average ad position (avg position = position_sum / ads_with_position_count). | | `placement_id` | `STRING` | Internal identifier of the Placement (from the source system). | | `namespace` | `STRING` | Name of the Namespace. | | `ads_with_position_count` | `NUMERIC` | Total number of Ads that have a position set. avg position = position_sum / ads_with_position_count. | | `enable_sales_metrics` | `BOOLEAN` | Used to set sales metrics to 0 for certain namespace/campaign types if required for reporting | | `wallet_id` | `STRING` | Internal identifier of the Wallet (from the source system) | | `attributable_impressions` | `NUMERIC` | Subset of impressions that are considered attributable. | | `attributable_clicks` | `NUMERIC` | Subset of clicks that are considered attributable. | | `attributable_ad_spend` | `NUMERIC` | Subset of ad spend that is considered attributable. | | `last_event_loaded_at` | `TIMESTAMP` | Date the row was inserted into the source system. | | `attribution_type` | `STRING` | The type of attribution applied to the conversion (e.g. click-based, impression-based). | # `reporting.realised_ad_agg_2` - namespace Realised Ad data (aggregated by customerid). Includes customer_id, but no breakdown by Campaign, Placement and Product. Layer: Reporting Datamart Category: Fact Status: Published Primary Key: ingressed_at, env_namespace, retailer_id, supplier_id, customer_id, search_term, category Other Unique Key(s): Partition: ingressed_at (by DAY) Foreign Key(s): env_namespace on env_namespace.env_namespace = realised_ad_agg_2.env_namespace; retailer on retailer.env_namespace = realised_ad_agg_2.env_namespace and retailer.retailer_id = realised_ad_agg_2.retailer_id; supplier on supplier.env_namespace = realised_ad_agg_2.env_namespace and supplier.supplier_id = realised_ad_agg_2.supplier_id; search_term on search_term.env_namespace = realised_ad_agg_2.env_namespace and search_term.retailer_id = realised_ad_agg_2.retailer_id and search_term.search_term = realised_ad_agg_2.search_term; category on category.env_namespace = realised_ad_agg_2.env_namespace and category.category_id = realised_ad_agg_2.category and category.retailer_id = realised_ad_agg_2.retailer_id; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `customer_id` | `STRING` | Customer identifier as provided by the Retailer (as in loyalty number etc, where available). Sometimes used for Attribution. | | `ingressed_at` | `DATE` | Date the Ads were realised. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `supplier_id` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `search_term` | `STRING` | DEPRECATED. Please switch to using keyword. | | `category` | `STRING` | Category being targeted. | | `namespace` | `STRING` | Name of the Namespace. | | `impressions` | `NUMERIC` | Total impressions. | | `clicks` | `NUMERIC` | Number of Clicks. | | `conversions` | `NUMERIC` | Total standard Conversions (purchases of the exact Product in the Ad). | | `unit_sales` | `NUMERIC` | Total number of Products purchased from Conversions. | | `retailer_name` | `STRING` | Name of the Retailer. | | `retailer_group_1` | `STRING` | Retailer group membership #1. | | `retailer_group_2` | `STRING` | Retailer group membership #2. | | `supplier_name` | `STRING` | Name of the Supplier. | | `supplier_group_1` | `STRING` | Supplier team group membership #1. | | `supplier_group_2` | `STRING` | Supplier team group membership #2. | | `supplier_group_3` | `STRING` | Supplier team group membership #3. | | `supplier_group_4` | `STRING` | Supplier team group membership #4. | | `last_event_loaded_at` | `TIMESTAMP` | Date the row was inserted into the source system. | | `has_search_term` | `INTEGER` | has_search_term | | `has_category` | `INTEGER` | has_category | # `reporting.realised_ad_agg_3` - supplier Realised Ad data (aggregated into UTC+0 hourly buckets). Only for current + previous 3 months. Layer: Reporting Datamart Category: Fact Status: Published Primary Key: ingressed_at, env_namespace, catalog_id, retailer_id, supplier_id, campaign_id, ad_type, search_term, generic_search_term, product_code, content_standard_id, slot_id, category, placement, platform, target_product_code Other Unique Key(s): Partition: ingressed_at (by DAY) Foreign Key(s): env_namespace on env_namespace.env_namespace = realised_ad_agg_3.env_namespace; retailer on retailer.env_namespace = realised_ad_agg_3.env_namespace and retailer.retailer_id = realised_ad_agg_3.retailer_id; catalog on catalog.env_namespace = realised_ad_agg_3.env_namespace and catalog.catalog_id = realised_ad_agg_3.catalog_id; product on product.env_namespace = realised_ad_agg_3.env_namespace and product.catalog_id = realised_ad_agg_3.catalog_id and product.normalised_product_code = realised_ad_agg_3.product_code; supplier on supplier.env_namespace = realised_ad_agg_3.env_namespace and supplier.supplier_id = realised_ad_agg_3.supplier_id; campaign on campaign.env_namespace = realised_ad_agg_3.env_namespace and campaign.campaign_id = realised_ad_agg_3.campaign_id; category on category.env_namespace = realised_ad_agg_3.env_namespace and category.retailer_id = realised_ad_agg_3.retailer_id and category.category_id = realised_ad_agg_3.category; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `ingressed_at` | `TIMESTAMP` | Timestamp the Ads were realised. | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `campaign_id` | `STRING` | Internal identifier of the Campaign (from the source system). | | `supplier_id` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `search_term` | `STRING` | DEPRECATED. Please switch to using keyword. | | `generic_search_term` | `STRING` | DEPRECATED. Please switch to using keyword. | | `product_code` | `STRING` | Product code. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `content_standard_id` | `STRING` | ContentStandardId as specified in the Ad Request. | | `slot_id` | `STRING` | Banner SlotId as specified in the Ad Request. | | `category` | `STRING` | Category being targeted. | | `placement` | `STRING` | Display name of the Placement. | | `platform` | `STRING` | The platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter. | | `ad_type` | `INTEGER` | Type of Ad (0 = Product, 1 = Banner, 4 = BannerX). | | `target_product_code` | `STRING` | Target Product code. | | `has_search_term` | `INTEGER` | Flag to indicate if the Ad is targeting a Search Term. | | `has_category` | `INTEGER` | Flag to indicate if the Ad is targeting a Category. | | `sales_revenue` | `NUMERIC` | Total sales revenue generated by Conversions. | | `ad_revenue` | `NUMERIC` | Portion of Ad spend retained by the Retailer. | | `ad_spend` | `NUMERIC` | Local currency amount charged by the Retailer to the Supplier for the Realised Ads. | | `impressions` | `NUMERIC` | Total impressions. | | `clicks` | `NUMERIC` | Number of Clicks. | | `conversions` | `NUMERIC` | Total standard Conversions (purchases of the exact Product in the Ad). | | `unit_sales` | `NUMERIC` | Total number of Products purchased from Conversions. | | `click_spend` | `NUMERIC` | AdSpend generated by clicks. | | `impression_spend` | `NUMERIC` | AdSpend generated by impressions. | | `retailer_name` | `STRING` | Name of the Retailer. | | `retailer_group_1` | `STRING` | Retailer group membership #1. | | `retailer_group_2` | `STRING` | Retailer group membership #2. | | `supplier_name` | `STRING` | Name of the Supplier. | | `supplier_group_1` | `STRING` | Supplier team group membership #1. | | `supplier_group_2` | `STRING` | Supplier team group membership #2. | | `supplier_group_3` | `STRING` | Supplier team group membership #3. | | `supplier_group_4` | `STRING` | Supplier team group membership #4. | | `enable_sales_metrics` | `BOOLEAN` | Used to set sales metrics to 0 for certain namespace/campaign types if required for reporting | | `wallet_id` | `STRING` | Internal identifier of the Wallet (from the source system) | | `attributable_impressions` | `NUMERIC` | Subset of impressions that are considered attributable. | | `attributable_clicks` | `NUMERIC` | Subset of clicks that are considered attributable. | | `attributable_ad_spend` | `NUMERIC` | Subset of ad spend that is considered attributable. | | `last_event_loaded_at` | `TIMESTAMP` | Date the row was inserted into the source system. | | `attribution_type` | `STRING` | The type of attribution applied to the conversion (e.g. click-based, impression-based). | | `has_video` | `BOOLEAN` | Flag to indicate if the Campaign has video. | | `has_companion_products` | `BOOLEAN` | Flag to indicate if the Campaign has companion products. | # `reporting.realised_ad_agg_ltz_view` - namespace Realised Ad view (aggregated in local timezone) + FTA Campaign spend data. Union of realised_ad_agg and fta_campaign_spend. Layer: Reporting Datamart Category: Fact Decorated View Status: Published Primary Key: Refer to realised_ad_agg Other Unique Key(s): Partition: Refer to realised_ad_agg Foreign Key(s): Refer to view code | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `ingressed_at` | `DATE` | Date the Ads were realised. | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `campaign_id` | `STRING` | Internal identifier of the Campaign (from the source system). | | `supplier_id` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `search_term` | `STRING` | DEPRECATED. Please switch to using keyword. | | `generic_search_term` | `STRING` | DEPRECATED. Please switch to using keyword. | | `product_code` | `STRING` | Product code. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `content_standard_id` | `STRING` | ContentStandardId as specified in the Ad Request. | | `slot_id` | `STRING` | Banner SlotId as specified in the Ad Request. | | `category` | `STRING` | Category being targeted. | | `placement` | `STRING` | Display name of the Placement. | | `platform` | `STRING` | The platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter. | | `ad_type` | `INTEGER` | Type of Ad (0 = Product, 1 = Banner, 4 = BannerX). | | `target_product_code` | `STRING` | Target Product code. | | `sales_revenue` | `NUMERIC` | Total sales revenue generated by Conversions. | | `ad_revenue` | `NUMERIC` | Portion of Ad spend retained by the Retailer. | | `ad_spend` | `NUMERIC` | Local currency amount charged by the Retailer to the Supplier for the Realised Ads. | | `impressions` | `NUMERIC` | Total impressions. | | `clicks` | `NUMERIC` | Number of Clicks. | | `conversions` | `NUMERIC` | Total standard Conversions (purchases of the exact Product in the Ad). | | `unit_sales` | `NUMERIC` | Total number of Products purchased from Conversions. | | `click_spend` | `NUMERIC` | AdSpend generated by clicks. | | `impression_spend` | `NUMERIC` | AdSpend generated by impressions. | | `position_sum` | `NUMERIC` | Sum of all postions for the Ads. Used to calculate average ad position (avg position = position_sum / ads_with_position_count). | | `ads_with_position_count` | `NUMERIC` | Total number of Ads that have a position set. avg position = position_sum / ads_with_position_count. | | `namespace` | `STRING` | Name of the Namespace. | | `enable_sales_metrics` | `BOOLEAN` | Used to set sales metrics to 0 for certain namespace/campaign types if required for reporting | | `ad_type_name` | `STRING` | Human readable name for the ad type | | `catalog_name` | `STRING` | Name of the Catalog. | | `supplier_name` | `STRING` | Name of the Supplier. | | `supplier_industry` | `STRING` | Industry of the Supplier. | | `supplier_business_identifier` | `STRING` | Implementation specific generic label. | | `supplier_company_name` | `STRING` | Company name of the Supplier. | | `retailer_name` | `STRING` | Name of the Retailer. | | `retailer_industry` | `STRING` | Industry of the Retailer. | | `retailer_business_identifier` | `STRING` | Implementation specific generic label. | | `retailer_company_name` | `STRING` | Company name of the Retailer. | | `retailer_group_1` | `STRING` | Retailer team group membership #1. | | `retailer_group_2` | `STRING` | Retailer team group membership #2. | | `supplier_group_1` | `STRING` | Supplier team group membership #1. | | `supplier_group_2` | `STRING` | Supplier team group membership #2. | | `supplier_group_3` | `STRING` | Supplier team group membership #3. | | `supplier_group_4` | `STRING` | Supplier team group membership #4. | | `campaign_name` | `STRING` | Name of the Campaign. | | `campaign_total_spend` | `NUMERIC` | Total AdSpend to date for the Campaign. | | `currency_code` | `STRING` | ISO 4217 currency code | | `is_fta` | `STRING` | Flag indicating if the Campaign is Fixed Tenancy Agreement (FTA). | | `wallet_available_balance` | `NUMERIC` | Current available balance of the Wallet. | | `campaign_active_state` | `STRING` | The Campaign's active state as set in the platform. (ACTIVE, PAUSED, DRAFT, ARCHIVED). | | `campaign_placements` | `STRING` | The Campaign's selected Placement. | | `campaign_type` | `STRING` | Type of Campaign (BANNER, BRAND_PAGE, DISPLAY, EMAIL, SHOTGUN_BANNER, WILDCARD) | | `wallet_name` | `STRING` | Name of the Wallet. | | `campaign_start_date` | `TIMESTAMP` | Date the Campaign will begin. | | `campaign_max_total_spend` | `NUMERIC` | The maximum total spend set for the Campaign. | | `campaign_created_at` | `TIMESTAMP` | Date the record was created in the source system. | | `campaign_max_cost_per_click` | `NUMERIC` | The maximum cost per click set for the Campaign. | | `campaign_end_date` | `TIMESTAMP` | Date when the Campaign will end. | | `wallet_id` | `STRING` | Internal identifier of the Wallet (from the source system). | | `campaign_catalog_products` | `STRING` | The Catalog's Products within the Campaign. | | `wallet_total_purchased_credits` | `NUMERIC` | Total credits made to the Wallet. | | `campaign_subtype` | `STRING` | Legacy, superseded by placement. Subtype of the Campaign (SEARCH_ONLY, CATEGORY_ONLY, CATEGORY_AND_SEARCH, BROAD_DISPLAY, CROSS_SELL, UPSELL, RUN_OF_SITE). | | `campaign_valid_state` | `STRING` | The Campaign's valid state. (APPROVED, PENDING, REJECTED) | | `campaign_impression_goal` | `NUMERIC` | The maximum number of impressions a Campaign is aiming for. Only relevant for campaigns with a spend type of Fixed Spend. | | `fta_cost` | `NUMERIC` | Total amount being spent by the given Fixed Tenancy Agreement (FTA) Campaign. | | `wallet_archived` | `BOOLEAN` | Archived status of the Wallet. | | `campaign_max_daily_spend` | `NUMERIC` | The maximum daily spend set for the Campaign. | | `campaign_total_spend_usd` | `NUMERIC` | campaign_total_spend in USD (current exchange rate only). | | `wallet_external_id` | `STRING` | Implementation specific generic label. | | `campaign_updated_at` | `TIMESTAMP` | Date the record was updated in the source system. | | `wallet_credit_limit` | `NUMERIC` | Amount the Wallet may go into credit. | | `campaign_attr_1` | `STRING` | Campaign user defined attribute 1. | | `cta_text` | `STRING` | CTA text. | | `wallet_team_name` | `STRING` | Team name associated with the wallet. | | `wallet_capture_date` | `TIMESTAMP` | Date the Wallet details were captured on. | | `earliest_top_up_amount_usd` | `NUMERIC` | earliest_top_up_amount in USD (current exchange rate only). | | `category_label` | `STRING` | Label for the Category (more descriptive than the typical id provided). | | `product_name` | `STRING` | Name of the Product. | | `product_type` | `STRING` | Type of the Product. | | `product_tags` | `STRING` | Tags associated with the Product. | | `brand` | `STRING` | Brand of the Product. | | `type` | `STRING` | Type of Product. | | `upc` | `STRING` | UPC of the Product. | | `geo_region` | `STRING` | Geographical region of the Namespace (as defined by CitrusAd). | | `local_timezone` | `STRING` | Not in use. | | `sales_revenue_usd` | `FLOAT` | Revenue generated from sales in USD. | | `ad_revenue_usd` | `FLOAT` | Revenue generated from ads in USD. | | `ad_spend_usd` | `FLOAT` | Amount spent on ads in USD. | | `placement_id` | `STRING` | Internal identifier of the Placement (from the source system). | | `attributable_impressions` | `NUMERIC` | Subset of impressions that are considered attributable. | | `attributable_clicks` | `NUMERIC` | Subset of clicks that are considered attributable. | | `attributable_ad_spend` | `NUMERIC` | Subset of ad spend that is considered attributable. | | `last_event_loaded_at` | `DATETIME` | Date the row was inserted into the source system. | | `source_type` | `STRING` | Name of source table. | | `has_search_term` | `INTEGER` | has_search_term | | `has_category` | `INTEGER` | has_category | | `attribution_type` | `STRING` | The type of attribution applied to the conversion (e.g. click-based, impression-based). | | `has_video` | `BOOLEAN` | Flag to indicate if the Campaign has video. | | `has_companion_products` | `BOOLEAN` | Flag to indicate if the Campaign has companion products. |

SQL Query

```sql with ads as ( select faa.env, faa.env_namespace, faa.ingressed_at, faa.catalog_id, faa.campaign_id, faa.supplier_id, faa.search_term, faa.generic_search_term, faa.product_code, faa.retailer_id, faa.content_standard_id, faa.slot_id, faa.category, faa.placement, faa.platform, faa.ad_type, faa.target_product_code, faa.sales_revenue, faa.ad_revenue, faa.ad_spend, faa.impressions, faa.clicks, faa.conversions, faa.unit_sales, faa.click_spend, faa.impression_spend, faa.position_sum, faa.ads_with_position_count, faa.namespace, faa.enable_sales_metrics, faa.placement_id, faa.wallet_id, faa.attributable_impressions, faa.attributable_clicks, faa.attributable_ad_spend, faa.last_event_loaded_at, faa.attribution_type, 'realised_ad_agg_ltz' as source_type, faa.has_search_term, faa.has_category from reporting.realised_ad_agg_ltz faa where faa.ingressed_at >= '2000-01-01' union all select fta.env, fta.env_namespace, fta.bucket_date ingressed_at, fta.catalog_id, fta.campaign_id, fta.supplier_id, fta.search_term, '' as generic_search_term, fta.product_code, fta.retailer_id, cast('' AS string) as content_standard_id, cast('' AS string) slot_id, cast('' AS string) category, cast('' AS string) placement, cast('' AS string) platform, fta.ad_type, cast('' AS string) target_product_code, 0 as sales_revenue, 0 as ad_revenue, fta.bucketed_cost ad_spend, NULL as impressions, NULL as clicks, 0 as conversions, 0 as unit_sales, fta.bucketed_cost click_spend, 0 as impression_spend, 0 as position_sum, 0 as ads_with_position_count, fta.namespace, fta.enable_sales_metrics, null as placement_id, null as wallet_id, 0 as attributable_impressions, 0 as attributable_clicks, 0 as attributable_ad_spend, null as last_event_loaded_at, '' as attribution_type, 'fta_campaign_spend' as source_type, if(ifnull(fta.search_term, '') <> '', 1, 0) as has_search_term, 0 as has_category from reporting.fta_campaign_spend fta ) select ads.* EXCEPT (wallet_id,placement_id,attributable_impressions,attributable_clicks,attributable_ad_spend,last_event_loaded_at,attribution_type,source_type,has_search_term,has_category), ad.ad_type_name, dctl.catalog_name, ds.supplier_name, ds.supplier_industry, ds.supplier_business_identifier, ds.supplier_company_name, dr.retailer_name, dr.retailer_industry, dr.retailer_business_identifier, dr.retailer_company_name, dr.retailer_group_1, dr.retailer_group_2, ds.supplier_group_1, ds.supplier_group_2, ds.supplier_group_3, ds.supplier_group_4, dcmp.campaign_name, /*domo specific*/ dcmp.campaign_total_spend, dcmp.currency_code, dcmp .is_fta, dcmp.wallet_available_balance, dcmp.campaign_active_state, dcmp.campaign_placements, dcmp.campaign_type, dcmp.wallet_name, dcmp.campaign_start_date, dcmp.campaign_max_total_spend, dcmp.campaign_created_at, dcmp.campaign_max_cost_per_click, dcmp.campaign_end_date, ads.wallet_id, dcmp.campaign_catalog_products, dcmp.wallet_total_purchased_credits, dcmp.campaign_subtype, dcmp.campaign_valid_state, dcmp.campaign_impression_goal, dcmp.fta_cost, dcmp.wallet_archived, dcmp.campaign_max_daily_spend, dcmp.campaign_total_spend_usd, dcmp.wallet_external_id, dcmp.campaign_updated_at, dcmp.wallet_credit_limit, dcmp.campaign_attr_1, dcmp.cta_text, w.team_name wallet_team_name, w.wallet_capture_date, w.earliest_top_up_amount_usd, ca.category_label, p.product_name, p.product_type, p.product_tags, p.brand, p.type, p.upc, rn.geo_region as geo_region, rn.local_timezone as local_timezone, ads.sales_revenue/currency.value sales_revenue_usd, ads.ad_revenue/currency.value ad_revenue_usd, ads.ad_spend/currency.value ad_spend_usd, ads.placement_id, ads.attributable_impressions, ads.attributable_clicks, ads.attributable_ad_spend, ads.last_event_loaded_at, ads.source_type, if(ifnull(ads.search_term, '') <> '', 1, 0) as has_search_term, ads.has_category, ads.attribution_type, dcmp.has_video, dcmp.has_companion_products from ads left join reporting.catalog dctl on dctl.catalog_id = ads.catalog_id and dctl.env_namespace = ads.env_namespace left join reporting.campaign dcmp on dcmp.campaign_id = ads.campaign_id and dcmp.env_namespace = ads.env_namespace left join reporting.retailer dr on dr.retailer_id = ads.retailer_id and dr.env_namespace = ads.env_namespace left join reporting.supplier ds on ds.supplier_id = ads.supplier_id and ds.env_namespace = ads.env_namespace left join reporting.view_ad_type ad on ads.ad_type = ad.ad_type left join reporting.wallet w on ads.env_namespace = w.env_namespace and ads.wallet_id = w.wallet_id left join reporting.category ca on ads.env_namespace = ca.env_namespace and ads.category = ca.category_id and ads.retailer_id = ca.retailer_id left join reporting.product p on ads.env_namespace = p.env_namespace and ads.catalog_id = p.catalog_id and ads.product_code = p.normalised_product_code left join reporting.env_namespace rn on ads.env_namespace = rn.env_namespace left join reporting.currency currency on dcmp.currency_code =currency.currency and currency.base='USD' ```

# `reporting.realised_ad_agg_view` - retailer - namespace Realised Ad view (aggregated) + FTA Campaign spend data. Union of realised_ad_agg and fta_campaign_spend. Layer: Reporting Datamart Category: Fact Decorated View Status: Published Primary Key: Refer to realised_ad_agg Other Unique Key(s): Partition: Refer to realised_ad_agg Foreign Key(s): Refer to view code | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `ingressed_at` | `DATE` | Date the Ads were realised. | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `campaign_id` | `STRING` | Internal identifier of the Campaign (from the source system). | | `supplier_id` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `search_term` | `STRING` | DEPRECATED. Please switch to using keyword. | | `generic_search_term` | `STRING` | DEPRECATED. Please switch to using keyword. | | `product_code` | `STRING` | Product code. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `content_standard_id` | `STRING` | ContentStandardId as specified in the Ad Request. | | `slot_id` | `STRING` | Banner SlotId as specified in the Ad Request. | | `category` | `STRING` | Category being targeted. | | `placement` | `STRING` | Display name of the Placement. | | `platform` | `STRING` | The platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter. | | `ad_type` | `INTEGER` | Type of Ad (0 = Product, 1 = Banner, 4 = BannerX). | | `target_product_code` | `STRING` | Target Product code. | | `sales_revenue` | `NUMERIC` | Total sales revenue generated by Conversions. | | `ad_revenue` | `NUMERIC` | Portion of Ad spend retained by the Retailer. | | `ad_spend` | `NUMERIC` | Local currency amount charged by the Retailer to the Supplier for the Realised Ads. | | `impressions` | `NUMERIC` | Total impressions. | | `clicks` | `NUMERIC` | Number of Clicks. | | `conversions` | `NUMERIC` | Total standard Conversions (purchases of the exact Product in the Ad). | | `unit_sales` | `NUMERIC` | Total number of Products purchased from Conversions. | | `click_spend` | `NUMERIC` | AdSpend generated by clicks. | | `impression_spend` | `NUMERIC` | AdSpend generated by impressions. | | `position_sum` | `NUMERIC` | Sum of all postions for the Ads. Used to calculate average ad position (avg position = position_sum / ads_with_position_count). | | `ads_with_position_count` | `NUMERIC` | Total number of Ads that have a position set. avg position = position_sum / ads_with_position_count. | | `namespace` | `STRING` | Name of the Namespace. | | `enable_sales_metrics` | `BOOLEAN` | Used to set sales metrics to 0 for certain namespace/campaign types if required for reporting | | `ad_type_name` | `STRING` | Human readable name for the ad type | | `catalog_name` | `STRING` | Name of the Catalog. | | `supplier_name` | `STRING` | Name of the Supplier. | | `supplier_industry` | `STRING` | Industry of the Supplier. | | `supplier_business_identifier` | `STRING` | Implementation specific generic label. | | `supplier_company_name` | `STRING` | Company name of the Supplier. | | `retailer_name` | `STRING` | Name of the Retailer. | | `retailer_industry` | `STRING` | Industry of the Retailer. | | `retailer_business_identifier` | `STRING` | Implementation specific generic label. | | `retailer_company_name` | `STRING` | Company name of the Retailer. | | `retailer_group_1` | `STRING` | Retailer team group membership #1. | | `retailer_group_2` | `STRING` | Retailer team group membership #2. | | `supplier_group_1` | `STRING` | Supplier team group membership #1. | | `supplier_group_2` | `STRING` | Supplier team group membership #2. | | `supplier_group_3` | `STRING` | Supplier team group membership #3. | | `supplier_group_4` | `STRING` | Supplier team group membership #4. | | `campaign_name` | `STRING` | Name of the Campaign. | | `campaign_total_spend` | `NUMERIC` | Total AdSpend to date for the Campaign. | | `currency_code` | `STRING` | ISO 4217 currency code | | `is_fta` | `STRING` | Flag indicating if the Campaign is Fixed Tenancy Agreement (FTA). | | `wallet_available_balance` | `NUMERIC` | Current available balance of the Wallet. | | `campaign_active_state` | `STRING` | The Campaign's active state as set in the platform. (ACTIVE, PAUSED, DRAFT, ARCHIVED). | | `campaign_placements` | `STRING` | The Campaign's selected Placement. | | `campaign_type` | `STRING` | Type of Campaign (BANNER, BRAND_PAGE, DISPLAY, EMAIL, SHOTGUN_BANNER, WILDCARD) | | `wallet_name` | `STRING` | Name of the Wallet. | | `campaign_start_date` | `TIMESTAMP` | Date the Campaign will begin. | | `campaign_max_total_spend` | `NUMERIC` | The maximum total spend set for the Campaign. | | `campaign_created_at` | `TIMESTAMP` | Date the record was created in the source system. | | `campaign_max_cost_per_click` | `NUMERIC` | The maximum cost per click set for the Campaign. | | `campaign_end_date` | `TIMESTAMP` | Date when the Campaign will end. | | `wallet_id` | `STRING` | Internal identifier of the Wallet (from the source system). | | `campaign_catalog_products` | `STRING` | The Catalog's Products within the Campaign. | | `wallet_total_purchased_credits` | `NUMERIC` | Total credits made to the Wallet. | | `campaign_subtype` | `STRING` | Legacy, superseded by placement. Subtype of the Campaign (SEARCH_ONLY, CATEGORY_ONLY, CATEGORY_AND_SEARCH, BROAD_DISPLAY, CROSS_SELL, UPSELL, RUN_OF_SITE). | | `campaign_valid_state` | `STRING` | The Campaign's valid state. (APPROVED, PENDING, REJECTED) | | `campaign_impression_goal` | `NUMERIC` | The maximum number of impressions a Campaign is aiming for. Only relevant for campaigns with a spend type of Fixed Spend. | | `fta_cost` | `NUMERIC` | Total amount being spent by the given Fixed Tenancy Agreement (FTA) Campaign. | | `wallet_archived` | `BOOLEAN` | Archived status of the Wallet. | | `campaign_max_daily_spend` | `NUMERIC` | The maximum daily spend set for the Campaign. | | `campaign_total_spend_usd` | `NUMERIC` | campaign_total_spend in USD (current exchange rate only). | | `wallet_external_id` | `STRING` | Implementation specific generic label. | | `campaign_updated_at` | `TIMESTAMP` | Date the record was updated in the source system. | | `wallet_credit_limit` | `NUMERIC` | Amount the Wallet may go into credit. | | `campaign_attr_1` | `STRING` | Campaign user defined attribute 1. | | `cta_text` | `STRING` | CTA text. | | `wallet_team_name` | `STRING` | Team name associated with the wallet. | | `wallet_capture_date` | `TIMESTAMP` | Date the Wallet details were captured on. | | `earliest_top_up_amount_usd` | `NUMERIC` | earliest_top_up_amount in USD (current exchange rate only). | | `category_label` | `STRING` | Label for the Category (more descriptive than the typical id provided). | | `product_name` | `STRING` | Name of the Product. | | `product_type` | `STRING` | Type of the Product. | | `product_tags` | `STRING` | Tags associated with the Product. | | `brand` | `STRING` | Brand of the Product. | | `type` | `STRING` | Type of Product. | | `upc` | `STRING` | UPC of the Product. | | `geo_region` | `STRING` | Geographical region of the Namespace (as defined by CitrusAd). | | `local_timezone` | `STRING` | Not in use. | | `sales_revenue_usd` | `FLOAT` | Revenue generated from sales in USD. | | `ad_revenue_usd` | `FLOAT` | Revenue generated from ads in USD. | | `ad_spend_usd` | `FLOAT` | Amount spent on ads in USD. | | `placement_id` | `STRING` | Internal identifier of the Placement (from the source system) | | `attributable_impressions` | `NUMERIC` | Subset of impressions that are considered attributable. | | `attributable_clicks` | `NUMERIC` | Subset of clicks that are considered attributable. | | `attributable_ad_spend` | `NUMERIC` | Subset of ad spend that is considered attributable. | | `last_event_loaded_at` | `TIMESTAMP` | Date the row was inserted into the source system. | | `source_type` | `STRING` | Name of source table. | | `has_search_term` | `INTEGER` | has_search_term | | `has_category` | `INTEGER` | has_category | | `attribution_type` | `STRING` | The type of attribution applied to the conversion (e.g. click-based, impression-based). | | `has_video` | `BOOLEAN` | Flag to indicate if the Campaign has video. | | `has_companion_products` | `BOOLEAN` | Flag to indicate if the Campaign has companion products. |

SQL Query

```sql with ads as ( select faa.env, faa.env_namespace, faa.ingressed_at, faa.catalog_id, faa.campaign_id, faa.supplier_id, faa.search_term, faa.generic_search_term, faa.product_code, faa.retailer_id, faa.content_standard_id, faa.slot_id, faa.category, faa.placement, faa.platform, faa.ad_type, faa.target_product_code, faa.sales_revenue, faa.ad_revenue, faa.ad_spend, faa.impressions, faa.clicks, faa.conversions, faa.unit_sales, faa.click_spend, faa.impression_spend, faa.position_sum, faa.ads_with_position_count, faa.namespace, faa.enable_sales_metrics, faa.placement_id, faa.wallet_id, faa.attributable_impressions, faa.attributable_clicks, faa.attributable_ad_spend, faa.last_event_loaded_at, faa.attribution_type, 'realised_ad_agg' as source_type, faa.has_search_term, faa.has_category from reporting.realised_ad_agg faa where faa.ingressed_at >= '2000-01-01' union all select fta.env, fta.env_namespace, fta.bucket_date ingressed_at, fta.catalog_id, fta.campaign_id, fta.supplier_id, fta.search_term, '' as generic_search_term, fta.product_code, fta.retailer_id, cast('' AS string) as content_standard_id, cast('' AS string) slot_id, cast('' AS string) category, cast('' AS string) placement, cast('' AS string) platform, fta.ad_type, cast('' AS string) target_product_code, 0 as sales_revenue, 0 as ad_revenue, fta.bucketed_cost ad_spend, NULL as impressions, NULL as clicks, 0 as conversions, 0 as unit_sales, fta.bucketed_cost click_spend, 0 as impression_spend, 0 as position_sum, 0 as ads_with_position_count, fta.namespace, fta.enable_sales_metrics, null as placement_id, null as wallet_id, 0 as attributable_impressions, 0 as attributable_clicks, 0 as attributable_ad_spend, null as last_event_loaded_at, '' as attribution_type, 'fta_campaign_spend' as source_type, if(ifnull(fta.search_term, '') <> '', 1, 0) as has_search_term, 0 as has_category from reporting.fta_campaign_spend fta ) select ads.* EXCEPT (wallet_id,placement_id,attributable_impressions,attributable_clicks,attributable_ad_spend,last_event_loaded_at,attribution_type,source_type,has_search_term,has_category), ad.ad_type_name, dctl.catalog_name, ds.supplier_name, ds.supplier_industry, ds.supplier_business_identifier, ds.supplier_company_name, dr.retailer_name, dr.retailer_industry, dr.retailer_business_identifier, dr.retailer_company_name, dr.retailer_group_1, dr.retailer_group_2, ds.supplier_group_1, ds.supplier_group_2, ds.supplier_group_3, ds.supplier_group_4, dcmp.campaign_name, /*domo specific*/ dcmp.campaign_total_spend, dcmp.currency_code, dcmp .is_fta, w.available_balance as wallet_available_balance, dcmp.campaign_active_state, dcmp.campaign_placements, dcmp.campaign_type, w.wallet_name, dcmp.campaign_start_date, dcmp.campaign_max_total_spend, dcmp.campaign_created_at, dcmp.campaign_max_cost_per_click, dcmp.campaign_end_date, ads.wallet_id, dcmp.campaign_catalog_products, w.total_purchased_credits as wallet_total_purchased_credits, dcmp.campaign_subtype, dcmp.campaign_valid_state, dcmp.campaign_impression_goal, dcmp.fta_cost, w.archived as wallet_archived, dcmp.campaign_max_daily_spend, dcmp.campaign_total_spend_usd, w.external_id as wallet_external_id, dcmp.campaign_updated_at, w.credit_limit as wallet_credit_limit, dcmp.campaign_attr_1, dcmp.cta_text, w.team_name wallet_team_name, w.wallet_capture_date, w.earliest_top_up_amount_usd, ca.category_label, p.product_name, p.product_type, p.product_tags, p.brand, p.type, p.upc, rn.geo_region as geo_region, rn.local_timezone as local_timezone, ads.sales_revenue/currency.value sales_revenue_usd, ads.ad_revenue/currency.value ad_revenue_usd, ads.ad_spend/currency.value ad_spend_usd, ads.placement_id, ads.attributable_impressions, ads.attributable_clicks, ads.attributable_ad_spend, ads.last_event_loaded_at, ads.source_type, ads.has_search_term, ads.has_category, ads.attribution_type, dcmp.has_video, dcmp.has_companion_products from ads left join reporting.catalog dctl on dctl.catalog_id = ads.catalog_id and dctl.env_namespace = ads.env_namespace left join reporting.campaign dcmp on dcmp.campaign_id = ads.campaign_id and dcmp.env_namespace = ads.env_namespace left join reporting.retailer dr on dr.retailer_id = ads.retailer_id and dr.env_namespace = ads.env_namespace left join reporting.supplier ds on ds.supplier_id = ads.supplier_id and ds.env_namespace = ads.env_namespace left join reporting.view_ad_type ad on ads.ad_type = ad.ad_type left join reporting.wallet w on ads.env_namespace = w.env_namespace and ads.wallet_id = w.wallet_id left join reporting.category ca on ads.env_namespace = ca.env_namespace and ads.category = ca.category_id and ads.retailer_id = ca.retailer_id left join reporting.product p on ads.env_namespace = p.env_namespace and ads.catalog_id = p.catalog_id and ads.product_code = p.normalised_product_code left join reporting.env_namespace rn on ads.env_namespace = rn.env_namespace left join reporting.currency currency on dcmp.currency_code =currency.currency and currency.base='USD' ```

# `reporting.retailer` - retailer - namespace Retailer data. Layer: Reporting Datamart Category: Dimension Status: Published Primary Key: env_namespace, retailer_id Other Unique Key(s): Partition: None Foreign Key(s): env_namespace on env_namespace.env_namespace = retailer.env_namespace; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `retailer_name` | `STRING` | Name of the Retailer. | | `team_type` | `STRING` | Type of Team (RETAILER). | | `retailer_company_name` | `STRING` | Company name of the Retailer. | | `retailer_business_identifier` | `STRING` | Implementation specific generic label. | | `retailer_industry` | `STRING` | Industry of the Retailer. | | `currency_code` | `STRING` | ISO 4217 currency code | | `namespace` | `STRING` | Name of the Namespace. | | `ads_requested_cap` | `NUMERIC` | Max number of Product Ads that will be considered for reporting purposes per Ad Request (set per Retailer team, no setting means no cap will be imposed). | | `banner_ads_requested_cap` | `NUMERIC` | Max number of Banner Ads that will be considered for reporting purposes per Ad Request (set per Retailer team, no setting means no cap will be imposed). | | `reserved_search_terms` | `STRING` | Not in use. | | `global_suppress_flag` | `STRING` | Flag to indicate Retailer is to be excluded from reporting (eg test data). | | `retailer_group_1` | `STRING` | Retailer team group membership #1. | | `retailer_group_2` | `STRING` | Retailer team group membership #2. | | `geo_region` | `STRING` | Geographical region of the Namespace (as defined by CitrusAd). | | `local_timezone` | `STRING` | Not in use. | | `is_active` | `BOOLEAN` | Flag to indicate that the record is active in the source system. | | `is_deleted` | `BOOLEAN` | Flag to indicate that the record has been soft deleted in the source system. | | `is_current` | `BOOLEAN` | Flag if the row is the latest version in the source system. | | `created_at` | `TIMESTAMP` | Date the record was created in the source system. | | `updated_at` | `TIMESTAMP` | Date the record was updated in the source system. | | `enhanced_attribution_flag` | `STRING` | If true, the first enhanced attribution model will be calculated. | | `enhanced_attribution_flag_2` | `STRING` | If true, the second enhanced attribution model will be calculated. | | `retailer_taxonomy_halo` | `STRING` | Comma separated list of what halo levels will be computed for model 1. | | `retailer_taxonomy_halo_2` | `STRING` | Comma separated list of what halo levels will be computed for model 2. | | `view_attribution_window` | `NUMERIC` | Max number of days allowed between the Order and Realised Ad for View Thru Attribution (1st model). | | `view_attribution_window_2` | `NUMERIC` | Max number of days allowed between the Order and Realised Ad for View Thru Attribution (2nd model). | | `click_attribution_window` | `NUMERIC` | Max number of days allowed between the Order and Realised Ad for Halo Click Attribution (1st model). | | `click_attribution_window_2` | `NUMERIC` | Max number of days allowed between the Order and Realised Ad for Halo Click Attribution (2nd model). | | `attribution_time_frame` | `NUMERIC` | Determines how many days of attribution results should be stored for the first model. | | `attribution_time_frame_2` | `NUMERIC` | Determines how many days of attribution results should be stored for the second model. | # `reporting.retailer_supplier` - retailer Retailer centric Supplier data (only relevant Suppliers as referenced within Realised Ads generated against the Retailer's Catalogs). Layer: Reporting Datamart Category: Dimension Status: Published Primary Key: env_namespace, supplier_id Other Unique Key(s): Partition: None Foreign Key(s): Not Applicable | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `retailer_group_1` | `STRING` | Retailer group membership #1. | | `retailer_group_2` | `STRING` | Retailer group membership #2. | | `supplier_id` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `supplier_group_1` | `STRING` | Supplier group membership #1. | | `supplier_group_2` | `STRING` | Supplier group membership #2. | | `supplier_group_3` | `STRING` | Supplier group membership #3. | | `supplier_group_4` | `STRING` | Supplier group membership #4. | | `supplier_name` | `STRING` | Name of the Supplier. | | `supplier_company_name` | `STRING` | Company name of the Supplier. | | `supplier_business_identifier` | `STRING` | Implementation specific generic label. | | `supplier_industry` | `STRING` | Industry of the Supplier. | | `geo_region` | `STRING` | Geographical region of the Namespace (as defined by CitrusAd). | | `local_timezone` | `STRING` | Not in use. | # `reporting.search_term` - namespace Search Term data. Layer: Reporting Datamart Category: Dimension Status: Published Primary Key: env_namespace, retailer_id, search_term Other Unique Key(s): Partition: None Foreign Key(s): env_namespace on env_namespace.env_namespace = search_term.env_namespace; retailer on retailer.env_namespace = search_term.env_namespace and retailer.retailer_id = search_term.retailer_id; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `retailer_name` | `STRING` | Name of the Retailer. | | `search_term` | `STRING` | The word/phrase being searched for on the retailer site by the end user. | | `num_ad_requests` | `INTEGER` | Total number of Requests. | | `num_realised_ads` | `INTEGER` | Total number of Ads realised. | | `ad_request_rank` | `INTEGER` | Rank of the Search Term by total Requests. | | `ad_stat_rank` | `INTEGER` | Rank of the Search Term by total Ads realised. | | `retailer_group_1` | `STRING` | Retailer group membership #1. | | `retailer_group_2` | `STRING` | Retailer group membership #2. | # `reporting.supplier` - supplier - namespace Supplier data. Layer: Reporting Datamart Category: Dimension Status: Published Primary Key: env_namespace, supplier_id Other Unique Key(s): Partition: None Foreign Key(s): env_namespace on env_namespace.env_namespace = supplier.env_namespace; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `supplier_id` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `supplier_name` | `STRING` | Name of the Supplier. | | `team_type` | `STRING` | Type of Team (SUPPLIER). | | `supplier_company_name` | `STRING` | Company name of the Supplier. | | `supplier_business_identifier` | `STRING` | Implementation specific generic label. | | `supplier_industry` | `STRING` | Industry of the Supplier. | | `namespace` | `STRING` | Name of the Namespace. | | `supplier_group_1` | `STRING` | Supplier team group membership #1. | | `supplier_group_2` | `STRING` | Supplier team group membership #2. | | `supplier_group_3` | `STRING` | Supplier team group membership #3. | | `supplier_group_4` | `STRING` | Supplier team group membership #4. | | `created_at` | `TIMESTAMP` | Date the record was created in the source system. | | `updated_at` | `TIMESTAMP` | Date the record was updated in the source system. | | `last_campaign_created_id` | `STRING` | Internal identifier of the Campaign last created by the Supplier Team (from the source system). | | `last_campaign_created_date` | `TIMESTAMP` | Date the Supplier created the most recent Campaign. | | `last_campaign_updated_id` | `STRING` | Internal identifier of the Campaign last modified by the Supplier Team (from the source system). | | `last_campaign_updated_date` | `TIMESTAMP` | Date the Supplier updated the most recent Campaign. | | `total_campaigns` | `INTEGER` | Total number of Campaigns associated with Supplier (including inactive). | | `total_active_campaigns` | `INTEGER` | Total active Campaigns associated with the Supplier. | | `total_spend` | `NUMERIC` | Total AdSpend to date for the Supplier across all Campaigns. | | `last_spend_date` | `DATE` | Most recent date that AdSpend was incurred by the Supplier. | | `geo_region` | `STRING` | Geographical region of the Namespace (as defined by CitrusAd). | | `local_timezone` | `STRING` | Not in use. | | `is_active` | `BOOLEAN` | Flag to indicate that the record is active in the source system. | | `is_deleted` | `BOOLEAN` | Flag to indicate that the record has been soft deleted in the source system. | | `is_current` | `BOOLEAN` | Flag if the row is the latest version in the source system. | # `reporting.supplier_product` - supplier Supplier centric Product data (only relevant Products as referenced within Realised Ads generated by Supplier Campaigns). Layer: Reporting Datamart Category: Dimension Status: Published Primary Key: env_namespace, normalised_product_code, product_code, catalog_id Other Unique Key(s): Partition: None Foreign Key(s): Not Applicable | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `supplier_id` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `supplier_group_1` | `STRING` | Supplier group membership #1. | | `supplier_group_2` | `STRING` | Supplier group membership #2. | | `supplier_group_3` | `STRING` | Supplier group membership #3. | | `supplier_group_4` | `STRING` | Supplier group membership #4. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `product_code` | `STRING` | Product code. | | `product_name` | `STRING` | Name of the Product. | | `product_type` | `STRING` | Type of the Product. | | `retailer_taxonomy` | `STRING` | Taxonomy (product hierarchy) of the Product as specified by the Retailer. | | `google_product_taxonomy` | `STRING` | Google taxonomy (product hierarchy) of the Product. Levels of the hierarchy delimited using > symbol. | | `catalog_id` | `STRING` | Internal identifier of the Catalog (from the source system). | | `catalog_name` | `STRING` | Name of the Catalog. | | `product_image_url` | `STRING` | URL to an image of the Product for the Ad. | | `brand` | `STRING` | Brand of the Product. | # `reporting.supplier_retailer` - supplier Supplier centric Retailer data (only relevant Retailers as referenced within Realised Ads generated by Supplier Campaigns). Layer: Reporting Datamart Category: Dimension Status: Published Primary Key: env_namespace, retailer_id, category_id Other Unique Key(s): Partition: None Foreign Key(s): Not Applicable | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `supplier_id` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `supplier_group_1` | `STRING` | Retailer group membership #1. | | `supplier_group_2` | `STRING` | Retailer group membership #2. | | `supplier_group_3` | `STRING` | Retailer group membership #3. | | `supplier_group_4` | `STRING` | Retailer group membership #4. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `retailer_group_1` | `STRING` | Retailer group membership #1. | | `retailer_group_2` | `STRING` | Retailer group membership #2. | | `retailer_name` | `STRING` | Name of the Retailer. | | `retailer_company_name` | `STRING` | Company name of the Retailer. | | `retailer_business_identifier` | `STRING` | Implementation specific generic label. | | `retailer_industry` | `STRING` | Industry of the Retailer. | | `currency_code` | `STRING` | ISO 4217 currency code | | `geo_region` | `STRING` | Geographical region of the Namespace (as defined by CitrusAd). | | `local_timezone` | `STRING` | Not in use. | | `supplier_name` | `STRING` | Name of the Supplier. | | `enhanced_attribution_flag` | `STRING` | If true, the first enhanced attribution model will be calculated. | | `enhanced_attribution_flag_2` | `STRING` | If true, the second enhanced attribution model will be calculated. | | `retailer_taxonomy_halo` | `STRING` | Comma separated list of what halo levels will be computed for model 1. | | `retailer_taxonomy_halo_2` | `STRING` | Comma separated list of what halo levels will be computed for model 2. | | `view_attribution_window` | `NUMERIC` | Max number of days allowed between the Order and Realised Ad for View Thru Attribution. | | `view_attribution_window_2` | `NUMERIC` | Max number of days allowed between the Order and Realised Ad for View Thru Attribution (2nd model). | | `click_attribution_window` | `NUMERIC` | Max number of days allowed between the Order and Realised Ad for Halo Click Attribution (1st model). | | `click_attribution_window_2` | `NUMERIC` | Max number of days allowed between the Order and Realised Ad for Halo Click Attribution (2nd model). | # `reporting.team` - supplier - retailer - namespace Team data. Layer: Reporting Datamart Category: Dimension Status: Published Primary Key: env_namespace, team_id Other Unique Key(s): Partition: None Foreign Key(s): env_namespace on env_namespace.env_namespace = team.env_namespace; retailer on retailer.env_namespace = team.env_namespace and retailer.retailer_id = team.retailer_id; supplier on supplier.env_namespace = team.env_namespace and supplier.supplier_id = team.supplier_id; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `team_id` | `STRING` | Internal identifier of the Team (from the source system). | | `team_name` | `STRING` | Name of the Team. | | `team_type` | `STRING` | Type of Team (RETAILER or SUPPLIER). | | `company_name` | `STRING` | Company name of the Team. | | `business_identifier` | `STRING` | Implementation specific generic label. | | `industry` | `STRING` | Industry of the Team. | | `user_id` | `STRING` | Internal identifier of the User (from the source system). | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `supplier_id` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `retailer_group_1` | `STRING` | Retailer team group membership #1. | | `retailer_group_2` | `STRING` | Retailer team group membership #2. | | `supplier_group_1` | `STRING` | Supplier team group membership #1. | | `supplier_group_2` | `STRING` | Supplier team group membership #2. | | `supplier_group_3` | `STRING` | Supplier team group membership #3. | | `supplier_group_4` | `STRING` | Supplier team group membership #4. | | `supplier_name` | `STRING` | Name of the Supplier. | | `namespace` | `STRING` | Name of the Namespace. | | `created_at` | `TIMESTAMP` | Date the record was created in the source system. | | `updated_at` | `TIMESTAMP` | Date the record was updated in the source system. | | `last_campaign_created_id` | `STRING` | Internal identifier of the Campaign last created by the Team (from the source system). | | `last_campaign_created_date` | `TIMESTAMP` | Date the Team created the most recent Campaign. | | `last_campaign_updated_id` | `STRING` | Internal identifier of the Campaign last modified by the Team (from the source system). | | `last_campaign_updated_date` | `TIMESTAMP` | Date the Team updated the most recent Campaign. | | `total_campaigns` | `INTEGER` | Total number of Campaigns associated with Team (including inactive). | | `total_active_campaigns` | `INTEGER` | Total active Campaigns associated with the Team. | | `total_spend` | `NUMERIC` | Total AdSpend to date for the Team across all Campaigns. | | `last_spend_date` | `DATE` | Most recent date that AdSpend was incurred by the Supplier. | | `geo_region` | `STRING` | Geographical region of the Namespace (as defined by CitrusAd). | | `local_timezone` | `STRING` | Not in use. | | `is_active` | `BOOLEAN` | Flag to indicate that the record is active in the source system. | | `is_deleted` | `BOOLEAN` | Flag to indicate that the record has been soft deleted in the source system. | | `is_current` | `BOOLEAN` | Flag if the row is the latest version in the source system. | | `phone` | `STRING` | The company phone number | | `company_website` | `STRING` | The company website | | `company_address_line_1` | `STRING` | The company address | | `company_address_post_code` | `STRING` | Post code of the company address | | `contact_email` | `STRING` | Email address of the company contact | # `reporting.user` - namespace User data. Layer: Reporting Datamart Category: Dimension Status: Published Primary Key: env_namespace, user_id Other Unique Key(s): Partition: None Foreign Key(s): env_namespace on env_namespace.env_namespace = user.env_namespace; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `user_id` | `STRING` | Internal identifier of the User (from the source system). | | `user_name` | `STRING` | Name of the User. | | `email` | `STRING` | User's email address. | | `admin` | `STRING` | Flag if the User is an administrator. | | `activated` | `BOOLEAN` | Flag indicating that a User has activated their account. | | `system_permissions` | `STRING` | User system permissions. | | `action_permission` | `STRING` | User action permissions. | | `subject_permission` | `STRING` | User subject permissions. | | `namespace` | `STRING` | Name of the Namespace. | | `created_at` | `TIMESTAMP` | Date the record was created in the source system. | | `updated_at` | `TIMESTAMP` | Date the record was updated in the source system. | | `geo_region` | `STRING` | Geographical region of the Namespace (as defined by CitrusAd). | | `local_timezone` | `STRING` | Not in use. | | `is_active` | `BOOLEAN` | Flag to indicate that the record is active in the source system. | | `is_deleted` | `BOOLEAN` | Flag to indicate that the record has been soft deleted in the source system. | | `is_current` | `BOOLEAN` | Flag if the row is the latest version in the source system. | # `reporting.user_team` - namespace Team users data. Layer: Reporting Datamart Category: Dimension Status: Published Primary Key: env_namespace, team_id, user_id Other Unique Key(s): Partition: None Foreign Key(s): env_namespace on env_namespace.env_namespace = user_team.env_namespace; retailer on retailer.env_namespace = user_team.env_namespace and retailer.retailer_id = user_team.retailer_id; supplier on supplier.env_namespace = user_team.env_namespace and supplier.supplier_id = user_team.supplier_id; user on user.env_namespace = user_team.env_namespace and user.user_id = user_team.user_id; team on team.env_namespace = user_team.env_namespace and team.team_id = user_team.team_id; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `team_id` | `STRING` | Internal identifier of the Team (from the source system). | | `user_id` | `STRING` | Internal identifier of the User (from the source system). | | `user_name` | `STRING` | Name of the User. | | `team_name` | `STRING` | Name of the Team. | | `team_type` | `STRING` | Type of Team (RETAILER or SUPPLIER). | | `namespace` | `STRING` | Name of the Namespace. | | `company_name` | `STRING` | Company name of the Team. | | `industry` | `STRING` | Industry of the Team. | | `email` | `STRING` | User's email address. | | `admin` | `BOOLEAN` | Flag if the User is an administrator. | | `activated` | `BOOLEAN` | Flag indicating that a User has activated their account. | | `system_permissions` | `STRING` | User system permissions. | | `action_permission` | `STRING` | User action permissions. | | `subject_permission` | `STRING` | User subject permissions. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `supplier_id` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `retailer_group_1` | `STRING` | Retailer team group membership #1. | | `retailer_group_2` | `STRING` | Retailer team group membership #2. | | `supplier_group_1` | `STRING` | Supplier team group membership #1. | | `supplier_group_2` | `STRING` | Supplier team group membership #2. | | `supplier_group_3` | `STRING` | Supplier team group membership #3. | | `supplier_group_4` | `STRING` | Supplier team group membership #4. | | `supplier_name` | `STRING` | Name of the Supplier. | | `geo_region` | `STRING` | Geographical region of the Namespace (as defined by CitrusAd). | | `local_timezone` | `STRING` | Not in use. | # `reporting.viz_global_campaign_out` - supplier - retailer - namespace Campaign data. Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is campaign. Layer: Visualisation Category: View Status: Internal Only Primary Key: RegionNamespace, CampaignId Other Unique Key(s): Partition: None Foreign Key(s): Not Applicable | Column Name | Data Type | Description | |-------------|-----------|-------------| | `CampaignId` | `STRING` | Unique identifier for the advertising campaign | | `CampaignName` | `STRING` | Display name of the advertising campaign | | `CampaignType` | `STRING` | Primary classification of the campaign (e.g., sponsored products, display ads) | | `CampaignSubtype` | `STRING` | Secondary classification of the campaign providing additional categorization | | `RetailerId` | `STRING` | Unique identifier of the retailer associated with this campaign | | `SupplierId` | `STRING` | Unique identifier of the supplier running this campaign | | `RetailerName` | `STRING` | Display name of the retailer associated with this campaign | | `SupplierName` | `STRING` | Display name of the supplier running this campaign | | `WalletId` | `STRING` | Identifier of the wallet funding this campaign | | `IsFta` | `STRING` | Indicates if this is a first-time advertiser (FTA) campaign | | `FtaCost` | `NUMERIC` | Cost allocated for first-time advertiser benefits | | `WalletName` | `STRING` | Display name of the wallet funding this campaign | | `WalletExternalId` | `STRING` | External system identifier for the wallet | | `WalletArchived` | `BOOL` | Indicates if the associated wallet has been archived | | `WalletCreditLimit` | `NUMERIC` | Maximum credit amount allowed for the associated wallet | | `WalletCurrencyCode` | `STRING` | Three-letter ISO currency code for the wallet | | `WalletTotalPurchasedCredits` | `NUMERIC` | Total amount of credits purchased for the wallet | | `WalletAvailableBalance` | `NUMERIC` | Current available balance in the wallet's currency | | `WalletCreditLimitUsd` | `NUMERIC` | Maximum credit amount allowed for the wallet in USD | | `WalletAvailableBalanceUsd` | `NUMERIC` | Current available balance converted to USD | | `WalletTotalPurchasedCreditsUsd` | `NUMERIC` | Total amount of credits purchased converted to USD | | `CampaignStartDate` | `TIMESTAMP` | Date and time when the campaign begins or began running | | `CampaignEndDate` | `TIMESTAMP` | Date and time when the campaign stops or stopped running | | `CampaignValidState` | `STRING` | Validation status of the campaign (e.g., valid, invalid) | | `CampaignActiveState` | `STRING` | Current activity state of the campaign (e.g., active, paused, completed) | | `CampaignCreatedAt` | `TIMESTAMP` | Timestamp when the campaign was created | | `CampaignUpdatedAt` | `TIMESTAMP` | Timestamp when the campaign was last modified | | `CampaignPlacements` | `STRING` | List of advertising placement locations for this campaign | | `CampaignTotalSpend` | `NUMERIC` | Total amount spent by this campaign in campaign currency | | `CampaignTotalSpendUsd` | `NUMERIC` | Total amount spent by this campaign converted to USD | | `CampaignMaxCostPerClick` | `NUMERIC` | Maximum allowed cost per click for this campaign | | `CampaignMaxTotalSpend` | `NUMERIC` | Maximum total budget allocated for this campaign | | `CampaignMaxDailySpend` | `NUMERIC` | Maximum amount that can be spent per day on this campaign | | `CampaignImpressionGoal` | `NUMERIC` | Target number of impressions for the campaign | | `CampaignCatalogProducts` | `STRING` | List of product identifiers included in this campaign | | `CampaignAttr1` | `STRING` | Custom attribute for campaign categorization | | `RetailerGroup1` | `STRING` | Primary grouping category for retailer | | `RetailerGroup2` | `STRING` | Secondary grouping category for retailer | | `SupplierGroup1` | `STRING` | Primary grouping category for supplier | | `SupplierGroup2` | `STRING` | Secondary grouping category for supplier | | `SupplierGroup3` | `STRING` | Tertiary grouping category for supplier | | `SupplierGroup4` | `STRING` | Quaternary grouping category for supplier | | `TeamId` | `STRING` | Identifier of the team that owns this campaign | | `RetailerAdSpendType` | `STRING` | Classification of ad spend type from retailer perspective | | `SupplierAdSpendType` | `STRING` | Classification of ad spend type from supplier perspective | | `Budget` | `NUMERIC` | Total budget allocated for the campaign | | `TargetedFilters` | `STRING` | Targeting criteria applied to the campaign | | `LocationFilters` | `STRING` | Geographic targeting filters applied to the campaign | | `FilterWhitelists` | `STRING` | Approved list of targeting exceptions for the campaign | | `CrossSellSettings` | `STRING` | Configuration for cross-sell product recommendations | | `UpsellSettings` | `STRING` | Configuration for upsell product recommendations | | `Categories` | `STRING` | List of product categories targeted by this campaign | | `CatalogCount` | `INT64` | Number of products in the campaign catalog | | `CatalogIds` | `STRING` | List of catalog identifiers associated with this campaign | | `SearchTerms` | `STRING` | List of search terms targeted by this campaign | | `HasSearchTerms` | `BOOL` | Indicates if the campaign targets specific search terms | | `LastSpendDate` | `DATE` | Most recent date when the campaign incurred spend | | `GeoRegion` | `STRING` | Geographic region where the campaign is running | | `LocalTimezone` | `STRING` | Local timezone identifier for the campaign | | `ProductTypeCode` | `STRING` | Classification code for the type of products in the campaign | | `CtaText` | `STRING` | Call-to-action text used in the campaign | | `SuggestedSearchTerms` | `STRING` | System-recommended search terms for the campaign | | `HasSuggestedSearchTerms` | `BOOL` | Indicates if the campaign has system-suggested search terms | | `IsCurrent` | `BOOL` | Indicates if this is the current active version of the campaign | | `ActiveState` | `STRING` | Current activity state of the campaign | | `ValidState` | `STRING` | Current validation state of the campaign | | `Region` | `STRING` | System region identifier for the campaign | | `RegionNamespace` | `STRING` | Combined region and namespace identifier for the campaign | | `WalletAvaliableBalance` | `NUMERIC` | Current available balance in the wallet (alternate field) | | `Retailer` | `STRING` | Retailer identifier (alternate field) | | `Supplier` | `STRING` | Supplier identifier (alternate field) | | `CurrencyCode` | `STRING` | Three-letter ISO currency code for the campaign | | `CatalogProducts` | `STRING` | List of product identifiers in the campaign (alternate field) | | `CreatedAt` | `TIMESTAMP` | Timestamp when the campaign was created (alternate field) | | `UpdatedAt` | `TIMESTAMP` | Timestamp when the campaign was last modified (alternate field) | | `StartDate` | `TIMESTAMP` | Campaign start date and time (alternate field) | | `EndDate` | `TIMESTAMP` | Campaign end date and time (alternate field) | | `ID` | `STRING` | Unique identifier for the campaign (alternate field) | | `Name` | `STRING` | Display name of the campaign (alternate field) | | `ImpressionGoal` | `NUMERIC` | Target number of impressions (alternate field) | | `MaxCostPerClick` | `NUMERIC` | Maximum allowed cost per click (alternate field) | | `MaxTotalSpend` | `NUMERIC` | Maximum total budget (alternate field) | | `MaxDailySpend` | `NUMERIC` | Maximum daily spend limit (alternate field) | | `Placements` | `STRING` | Ad placement locations (alternate field) | | `TotalSpend` | `NUMERIC` | Total campaign spend (alternate field) | | `TotalSpendUsd` | `NUMERIC` | Total campaign spend in USD (alternate field) | | `Namespace` | `STRING` | System namespace identifier (alternate field) | | `IsActive` | `BOOL` | Indicates if the campaign is currently active | | `IsDeleted` | `BOOL` | Indicates if the campaign has been deleted | # `reporting.viz_global_catalog_out` - retailer - namespace Catalog data. Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is catalog. Layer: Visualisation Category: View Status: Internal Only Primary Key: RegionNamespace, CatalogId Other Unique Key(s): Partition: None Foreign Key(s): Not Applicable | Column Name | Data Type | Description | |-------------|-----------|-------------| | `CatalogId` | `STRING` | Internal identifier of the Catalog (from the source system). | | `RetailerId` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `CatalogName` | `STRING` | Name of the Catalog. | | `RetailerName` | `STRING` | Name of the Retailer. | | `CurrencyCode` | `STRING` | ISO currency code for the catalog. | | `Namespace` | `STRING` | Name of the Namespace. | | `RetailerGroup1` | `STRING` | Primary grouping category for the Retailer. | | `RetailerGroup2` | `STRING` | Secondary grouping category for the Retailer. | | `GeoRegion` | `STRING` | Geographic region where the catalog is used. | | `LocalTimezone` | `STRING` | Local timezone of the catalog's primary region. | | `IsActive` | `BOOL` | Indicates if the catalog is currently active. | | `IsDeleted` | `BOOL` | Indicates if the catalog has been deleted. | | `IsCurrent` | `BOOL` | Indicates if this is the current version of the catalog record. | | `Region` | `STRING` | Geographic region identifier. | | `RegionNamespace` | `STRING` | Namespace specific to the geographic region. | | `ID` | `STRING` | Alternative identifier for the catalog. | | `Name` | `STRING` | Alternative name for the catalog. | | `Retailer` | `STRING` | Alternative retailer identifier or name. | | `Supplier` | `STRING` | Associated supplier identifier or name if applicable. | # `reporting.viz_global_category_out` - supplier - retailer - namespace Category data. Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is category. Layer: Visualisation Category: View Status: Internal Only Primary Key: RegionNamespace, RetailerId, CategoryId Other Unique Key(s): Partition: None Foreign Key(s): Not Applicable | Column Name | Data Type | Description | |-------------|-----------|-------------| | `RetailerId` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `CategoryId` | `STRING` | Identifier for the category. | | `Namespace` | `STRING` | Name of the business namespace. | | `CategoryLabel` | `STRING` | Label for the category. | | `CatLevel1` | `STRING` | Category level 1. | | `CatLevel2` | `STRING` | Category level 2. | | `CatLevel3` | `STRING` | Category level 3. | | `CatLevel4` | `STRING` | Category level 4. | | `CatLevel5` | `STRING` | Category level 5. | | `CatLevel6` | `STRING` | Category level 6. | | `CatLevel7` | `STRING` | Category level 7. | | `CategoryLabelCount` | `INT64` | Count of labels in the category. | | `Region` | `STRING` | Geographical region of the ad request. | | `RegionNamespace` | `STRING` | Namespace prefixed with the region. | # `reporting.viz_global_daily_wallet_balance` - supplier - retailer - namespace Daily wallet balance data. Layer: Visualisation Category: View Status: Internal Only Primary Key: env_namespace, wallet_id, date Other Unique Key(s): Partition: date (by DAY) Foreign Key(s): env_namespace on env_namespace.env_namespace = wallet_balance.env_namespace; team on team.env_namespace = wallet_balance.env_namespace and team.team_id = wallet_balance.wallet_team_id; wallet on wallet.env_namespace = wallet_balance.env_namespace and wallet.wallet_id = wallet_balance.wallet_id; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `Date` | `DATE` | The date of the wallet balance record | | `EarliestCreditDate` | `TIMESTAMP` | Timestamp of the earliest credit transaction for this wallet | | `LatestCreditDate` | `TIMESTAMP` | Timestamp of the most recent credit transaction for this wallet | | `PreviousDate` | `DATE` | The previous day's date for balance comparison | | `ExpectedWalletEmptyDate` | `DATE` | Projected date when the wallet balance will reach zero based on current spend rate | | `Region` | `STRING` | Geographic region identifier | | `Namespace` | `STRING` | System namespace identifier | | `RegionNamespace` | `STRING` | Combined region and namespace identifier | | `WalletId` | `STRING` | Internal identifier of the wallet (from the source system) | | `WalletTeamId` | `STRING` | Internal identifier of the team that owns the wallet | | `ExternalId` | `STRING` | External system identifier for the wallet | | `CurrencyCode` | `STRING` | Three-letter ISO currency code for the wallet (e.g., USD, AUD) | | `WalletName` | `STRING` | Display name of the wallet | | `Archived` | `BOOL` | Indicates if the wallet has been archived | | `TeamName` | `STRING` | Display name of the team that owns the wallet | | `Retailer` | `STRING` | Identifier of the associated retailer | | `Supplier` | `STRING` | Identifier of the associated supplier | | `AvailableBalance` | `NUMERIC` | Current available balance in the wallet's currency | | `PrepaidBalance` | `NUMERIC` | Prepaid amount available in the wallet's currency | | `CreditLimit` | `NUMERIC` | Maximum credit amount allowed for this wallet | | `ActiveCampaignCount` | `NUMERIC` | Number of currently active advertising campaigns | | `ActiveCampaignMaxTotalSpend` | `NUMERIC` | Sum of maximum spend limits across all active campaigns | | `TotalPurchasedCredits` | `NUMERIC` | Total amount of credits purchased for this wallet | | `PreviousAvailableBalance` | `NUMERIC` | Available balance from the previous day in wallet's currency | | `PreviousAvailableBalanceUSD` | `NUMERIC` | Available balance from the previous day converted to USD | | `TotalPurchasedCreditsUSD` | `NUMERIC` | Total amount of credits purchased converted to USD | | `CreditLimitUSD` | `NUMERIC` | Maximum credit amount allowed converted to USD | | `AvailableBalanceUSD` | `NUMERIC` | Current available balance converted to USD | | `PrepaidBalanceUSD` | `NUMERIC` | Prepaid amount available converted to USD | | `BurnRatePerDay` | `NUMERIC` | Average daily spend rate in wallet's currency | | `BurnRatePerDayUSD` | `NUMERIC` | Average daily spend rate converted to USD | | `TotalAdSpend` | `NUMERIC` | Total advertising spend within the considered period | | `AdSpendConsideredFrom` | `DATE` | Start date of the period considered for ad spend calculations | | `AdSpendConsideredTo` | `DATE` | End date of the period considered for ad spend calculations | | `Id` | `STRING` | Unique identifier for this daily wallet balance record | | `Name` | `STRING` | Display name associated with this balance record | | `TeamId` | `STRING` | Internal identifier of the team associated with this wallet | | `GeoRegion` | `STRING` | Geographic region identifier for the wallet | | `LocalTimezone` | `STRING` | Local timezone identifier for the wallet | | `IsCurrentRow` | `STRING` | Flag indicating if this is the current active record | # `reporting.viz_global_decorated_ad__adrequest_stats_out` - retailer - namespace Request and Realised Ad data (aggregated and unioned). Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is ad_request__realised_ad_view. Layer: Visualisation Category: View Status: Internal Only Primary Key: RegionNamespace, Date, CatalogId, RetailerId, SupplierId, CampaignId, AdType, SearchTerm, GenericSearchTerm, ProductCode, ContentStandardId, SlotId, Category, Placement, Platform Other Unique Key(s): Partition: Refer to ad_request__realised_ad_view Foreign Key(s): Not Applicable | Column Name | Data Type | Description | |-------------|-----------|-------------| | `Region` | `STRING` | Geographical region of the ad request. | | `Namespace` | `STRING` | Name of the business namespace. | | `RegionNamespace` | `STRING` | Namespace prefixed with the region. | | `Date` | `DATE` | Date of the ad request. | | `CatalogId` | `STRING` | Internal identifier of the Catalog (from the source system). | | `CampaignStartDate` | `TIMESTAMP` | Start date and time of the campaign. | | `CampaignCreatedAt` | `TIMESTAMP` | Date and time when the campaign was created. | | `CampaignEndDate` | `TIMESTAMP` | End date and time of the campaign. | | `CampaignUpdatedAt` | `TIMESTAMP` | Date and time when the campaign was last updated. | | `WalletCaptureDate` | `TIMESTAMP` | Date and time when the wallet was captured. | | `SearchTerm` | `STRING` | Search term entered by the customer. | | `Placement` | `STRING` | Display name of the ad placement. | | `Platform` | `STRING` | Platform where the ad is served (e.g., web, mobile). | | `Category` | `STRING` | Category being targeted. | | `GenericSearchTerm` | `STRING` | Normalized version of the search term. | | `AdTypeName` | `STRING` | Name of the ad type. | | `CatalogName` | `STRING` | Name of the catalog. | | `Retailer` | `STRING` | Retailer associated with the ad request. | | `Supplier` | `STRING` | Supplier associated with the ad request. | | `RetailerId` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `RetailerName` | `STRING` | Name of the retailer. | | `RetailerIndustry` | `STRING` | Industry category of the retailer. | | `RetailerBusinessIdentifier` | `STRING` | Business identifier for the retailer. | | `RetailerCompanyName` | `STRING` | Company name of the retailer. | | `RetailerGroup1` | `STRING` | First level group classification for the retailer. | | `RetailerGroup2` | `STRING` | Second level group classification for the retailer. | | `SupplierGroup1` | `STRING` | Supplier group membership #1. | | `SupplierGroup2` | `STRING` | Supplier group membership #2. | | `SupplierGroup3` | `STRING` | Supplier group membership #3. | | `SupplierGroup4` | `STRING` | Supplier group membership #4. | | `GeoRegion` | `STRING` | Geographical region of the Namespace (as defined by CitrusAd). | | `LocalTimezone` | `STRING` | Not in use. | | `TeamName` | `STRING` | Name of the team managing the campaign. | | `CategoryLabel` | `STRING` | Label for the category. | | `CampaignId` | `STRING` | Internal identifier of the Campaign (from the source system). | | `SupplierId` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `ProductCode` | `STRING` | Product code (from the source system). | | `ContentStandardId` | `STRING` | Content standard identifier. | | `SlotId` | `STRING` | Identifier for the ad slot. | | `SupplierName` | `STRING` | Name of the Supplier. | | `SupplierCompanyName` | `STRING` | Registered company name of the Supplier. | | `SupplierBusinessIdentifier` | `STRING` | Business identifier of the Supplier. | | `SupplierIndustry` | `STRING` | Industry classification of the Supplier. | | `CurrencyCode` | `STRING` | Currency code for the monetary values. | | `IsFTA` | `STRING` | Indicates if the campaign is FTA (Free Trade Agreement) eligible. | | `CampaignActiveState` | `STRING` | Current active state of the campaign. | | `CampaignPlacements` | `STRING` | Details of placements for the campaign. | | `CampaignType` | `STRING` | Type of the campaign. | | `WalletName` | `STRING` | Name of the wallet used. | | `WalletId` | `STRING` | Identifier of the wallet. | | `CampaignName` | `STRING` | Name of the campaign. | | `CampaignCatalogProducts` | `STRING` | Products associated with the campaign. | | `CampaignSubtype` | `STRING` | Subtype of the campaign. | | `CampaignValidState` | `STRING` | Validity state of the campaign. | | `WalletArchived` | `BOOL` | Indicates if the wallet is archived. | | `WalletExternalId` | `STRING` | External identifier for the wallet. | | `CampaignAttr1` | `STRING` | Custom attribute 1 for the campaign. | | `CTAText` | `STRING` | Call to action text for the ad. | | `ProductName` | `STRING` | Name of the product. | | `ProductType` | `STRING` | Type of the product. | | `ProductTags` | `STRING` | Tags associated with the product. | | `Brand` | `STRING` | Brand name of the product. | | `Type` | `STRING` | Type classification of the product. | | `UPC` | `STRING` | Universal Product Code (UPC) of the product. | | `AdType` | `INT64` | Type identifier for the ad format or placement type. | | `HasSearchTerm` | `INT64` | Indicates if there is a search term available. | | `HasCategory` | `INT64` | Indicates if there is a category available. | | `SalesRevenue` | `NUMERIC` | Total revenue generated from sales. | | `AdRevenue` | `NUMERIC` | Total revenue generated from ads. | | `AdSpend` | `NUMERIC` | Total amount spent on ads. | | `Impressions` | `NUMERIC` | Number of times ads were shown. | | `Clicks` | `NUMERIC` | Number of times ads were clicked. | | `Conversions` | `NUMERIC` | Number of ad conversions. | | `UnitSales` | `NUMERIC` | Number of units sold. | | `ClickSpend` | `NUMERIC` | Amount spent per click. | | `ImpressionSpend` | `NUMERIC` | Amount spent per impression. | | `PositionSum` | `NUMERIC` | Sum of positions for the ad. | | `AdsWithPositionCount` | `NUMERIC` | Count of ads with position data. | | `MaxCpc` | `NUMERIC` | Maximum cost per click across ads. | | `MinCpc` | `NUMERIC` | Minimum cost per click across ads. | | `StdDevCpc` | `FLOAT64` | Standard deviation of cost per click. | | `VarianceCpc` | `FLOAT64` | Variance of cost per click. | | `MaxCpi` | `NUMERIC` | Maximum cost per impression across ads. | | `MinCpi` | `NUMERIC` | Minimum cost per impression across ads. | | `StdDevCpi` | `FLOAT64` | Standard deviation of cost per impression. | | `VarianceCpi` | `FLOAT64` | Variance of cost per impression. | | `SalesRevenueUSD` | `FLOAT64` | Sales revenue in USD. | | `AdRevenueUSD` | `FLOAT64` | Ad revenue in USD. | | `AdSpendUSD` | `FLOAT64` | Ad spend in USD. | | `CampaignTotalSpend` | `NUMERIC` | Total amount spent on the campaign. | | `WalletAvailableBalance` | `NUMERIC` | Available balance in the wallet. | | `CampaignMaxTotalSpend` | `NUMERIC` | Maximum total spend limit for the campaign. | | `CampaignMaxCostPerClick` | `NUMERIC` | Maximum cost per click for the campaign. | | `WalletTotalPurchasedCredits` | `NUMERIC` | Total purchased credits in the wallet. | | `CampaignImpressionGoal` | `NUMERIC` | Impression goal set for the campaign. | | `FTACost` | `NUMERIC` | Cost associated with FTA. | | `CampaignMaxDailySpend` | `NUMERIC` | Maximum daily spend limit for the campaign. | | `CampaignTotalSpendUSD` | `NUMERIC` | Total spend in USD for the campaign. | | `WalletAvaliableBalance` | `NUMERIC` | Available balance in the wallet (duplicate field). | | `WalletCreditLimit` | `NUMERIC` | Credit limit for the wallet. | | `EarliestTopUpAmountUSD` | `NUMERIC` | Earliest top-up amount in USD. | | `AvailableBalance` | `NUMERIC` | Current available balance in the wallet's currency | | `WalletTeamId` | `STRING` | Internal identifier of the team that owns the wallet | | `ExternalId` | `STRING` | External system identifier for the wallet | | `Archived` | `BOOL` | Indicates if the wallet has been archived | | `EarliestCreditDate` | `TIMESTAMP` | Timestamp of the earliest credit transaction for this wallet | | `LatestCreditDate` | `TIMESTAMP` | Timestamp of the most recent credit transaction for this wallet | | `PreviousDate` | `DATE` | The previous day's date for balance comparison | | `ExpectedWalletEmptyDate` | `DATE` | Projected date when the wallet balance will reach zero based on current spend rate | | `PrepaidBalance` | `NUMERIC` | Prepaid amount available in the wallet's currency | | `CreditLimit` | `NUMERIC` | Maximum credit amount allowed for this wallet | | `ActiveCampaignCount` | `NUMERIC` | Number of currently active advertising campaigns | | `ActiveCampaignMaxTotalSpend` | `NUMERIC` | Sum of maximum spend limits across all active campaigns | | `TotalPurchasedCredits` | `NUMERIC` | Total amount of credits purchased for this wallet | | `PreviousAvailableBalance` | `NUMERIC` | Available balance from the previous day in wallet's currency | | `TotalPurchasedCreditsUSD` | `NUMERIC` | Total amount of credits purchased converted to USD | | `CreditLimitUSD` | `NUMERIC` | Maximum credit amount allowed converted to USD | | `AvailableBalanceUSD` | `NUMERIC` | Current available balance converted to USD | | `PrepaidBalanceUSD` | `NUMERIC` | Prepaid amount available converted to USD | | `BurnRatePerDay` | `NUMERIC` | Average daily spend rate in wallet's currency | | `CurrencyValue` | `NUMERIC` | Value of the currency used. | | `ReservedSearchTermFlag` | `STRING` | Flag for reserved search terms. | | `CatLevel1` | `STRING` | Category level 1. | | `CatLevel2` | `STRING` | Category level 2. | | `CatLevel3` | `STRING` | Category level 3. | | `CatLevel4` | `STRING` | Category level 4. | | `CatLevel5` | `STRING` | Category level 5. | | `CatLevel6` | `STRING` | Category level 6. | | `CatLevel7` | `STRING` | Category level 7. | | `PageType` | `NUMERIC` | Identifier for the type of page the ad is displayed on. | | `NumAdsConsidered` | `NUMERIC` | Number of ads considered for the request. | | `NumAdsServed` | `NUMERIC` | Number of ads served. | | `NumAdsRequested` | `NUMERIC` | Number of ads requested. | | `CappedNumAdsServed` | `NUMERIC` | Capped number of ads served. | | `CappedNumAdsRequested` | `NUMERIC` | Capped number of ads requested. | | `CappedNumRequestsServingMaxAds` | `NUMERIC` | Capped number of requests serving the maximum number of ads. | | `NumRequestsServingMaxAds` | `NUMERIC` | Number of requests serving the maximum number of ads. | | `NumAdRequestsServingNoAds` | `NUMERIC` | Number of ad requests where no ads were served. | | `NumAdRequestsServingSomeAds` | `NUMERIC` | Number of ad requests where at least one ad was served. | | `NumAdRequests` | `NUMERIC` | Total number of ad requests. | | `NumAdRequestsWithSaturation` | `NUMERIC` | Number of ad requests that served at least 4 ads or filled the entire request. | | `FilterMode` | `INTEGER` | Mode of filtering applied to the ad request. | # `reporting.viz_global_decorated_ad_stats_out` - supplier Realised Ad (aggregated) data. Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is realised_ad_agg_view. Layer: Visualisation Category: View Status: Internal Only Primary Key: RegionNamespace, Date, CatalogId, RetailerId, SupplierId, CampaignId, AdType, SearchTerm, GenericSearchTerm, ProductCode, ContentStandardId, SlotId, Category, Placement, Platform Other Unique Key(s): Partition: Refer to realised_ad_agg_view Foreign Key(s): Not Applicable | Column Name | Data Type | Description | |-------------|-----------|-------------| | `Region` | `STRING` | Geographical region of the ad request. | | `Namespace` | `STRING` | Name of the business namespace. | | `RegionNamespace` | `STRING` | Namespace prefixed with the region. | | `Date` | `DATE` | Date of the ad event. | | `CatalogId` | `STRING` | Internal identifier of the Catalog (from the source system). | | `CampaignId` | `STRING` | Internal identifier of the Campaign (from the source system). | | `SupplierId` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `SearchTerm` | `STRING` | Search term that triggered the ad request. | | `GenericSearchTerm` | `STRING` | Generic version of the search term, if applicable. | | `ProductCode` | `STRING` | Product code (from the source system). | | `RetailerId` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `ContentStandardId` | `STRING` | Content standard identifier. | | `SlotId` | `STRING` | Identifier for the ad slot. | | `Category` | `STRING` | Category being targeted. | | `Placement` | `STRING` | Display name of the Placement. | | `Platform` | `STRING` | Platform where the ad is served (e.g., web, mobile). | | `AdType` | `INTEGER` | Type identifier for the ad format or placement type. | | `CatalogName` | `STRING` | Name of the catalog. | | `AdTypeName` | `STRING` | Name of the ad type. | | `GeoRegion` | `STRING` | Geographical region targeting for the ad. | | `LocalTimezone` | `STRING` | Local timezone of the retailer. | | `Retailer` | `STRING` | Retailer associated with the ad. | | `RetailerIndustry` | `STRING` | Industry category of the retailer. | | `RetailerCompanyName` | `STRING` | Company name of the retailer. | | `RetailerName` | `STRING` | Name of the retailer. | | `RetailerBusinessIdentifier` | `STRING` | Business identifier for the retailer. | | `Supplier` | `STRING` | Supplier associated with the ad. | | `SupplierName` | `STRING` | Name of the supplier. | | `SupplierCompanyName` | `STRING` | Company name of the supplier. | | `SupplierBusinessIdentifier` | `STRING` | Business identifier for the supplier. | | `SupplierIndustry` | `STRING` | Industry category of the supplier. | | `CampaignTotalSpend` | `NUMERIC` | Total amount spent on the campaign. | | `CurrencyCode` | `STRING` | Currency code for the monetary values. | | `IsFTA` | `STRING` | Indicates if the campaign is FTA (Free Trade Agreement) eligible. | | `WalletAvailableBalance` | `NUMERIC` | Available balance in the wallet. | | `CampaignActiveState` | `STRING` | Current active state of the campaign. | | `CampaignPlacements` | `STRING` | Details of placements for the campaign. | | `CampaignType` | `STRING` | Type of the campaign. | | `WalletName` | `STRING` | Name of the wallet used. | | `CampaignStartDate` | `TIMESTAMP` | Start date and time of the campaign. | | `CampaignMaxTotalSpend` | `NUMERIC` | Maximum total spend limit for the campaign. | | `CampaignCreatedAt` | `TIMESTAMP` | Creation date and time of the campaign. | | `CampaignMaxCostPerClick` | `NUMERIC` | Maximum cost per click for the campaign. | | `CampaignEndDate` | `TIMESTAMP` | End date and time of the campaign. | | `WalletId` | `STRING` | Identifier of the wallet. | | `CampaignName` | `STRING` | Name of the campaign. | | `CampaignCatalogProducts` | `STRING` | Products associated with the campaign. | | `WalletTotalPurchasedCredits` | `NUMERIC` | Total purchased credits in the wallet. | | `CampaignSubtype` | `STRING` | Subtype of the campaign. | | `CampaignValidState` | `STRING` | Validity state of the campaign. | | `CampaignImpressionGoal` | `NUMERIC` | Impression goal set for the campaign. | | `FTACost` | `NUMERIC` | Cost associated with FTA. | | `WalletArchived` | `BOOLEAN` | Indicates if the wallet is archived. | | `CampaignMaxDailySpend` | `NUMERIC` | Maximum daily spend limit for the campaign. | | `CampaignTotalSpendUSD` | `NUMERIC` | Total spend in USD for the campaign. | | `WalletExternalId` | `STRING` | External identifier for the wallet. | | `CampaignUpdatedAt` | `TIMESTAMP` | Last updated date and time of the campaign. | | `WalletAvaliableBalance` | `NUMERIC` | Available balance in the wallet (duplicate field). | | `WalletCreditLimit` | `NUMERIC` | Credit limit for the wallet. | | `CampaignAttr1` | `STRING` | Custom attribute 1 for the campaign. | | `CTAText` | `STRING` | Call to action text for the ad. | | `TeamName` | `STRING` | Name of the team managing the campaign. | | `WalletCaptureDate` | `TIMESTAMP` | Date when the wallet was captured. | | `EarliestTopUpAmountUSD` | `NUMERIC` | Earliest top-up amount in USD. | | `CategoryLabel` | `STRING` | Label for the category. | | `ProductName` | `STRING` | Name of the product. | | `ProductType` | `STRING` | Type of the product. | | `ProductTags` | `STRING` | Tags associated with the product. | | `Brand` | `STRING` | Brand name of the product. | | `Type` | `STRING` | Type classification of the product. | | `UPC` | `STRING` | Universal Product Code (UPC) of the product. | | `RetailerGroup1` | `STRING` | First group classification for the retailer. | | `RetailerGroup2` | `STRING` | Second group classification for the retailer. | | `SupplierGroup1` | `STRING` | First group classification for the supplier. | | `SupplierGroup2` | `STRING` | Second group classification for the supplier. | | `SupplierGroup3` | `STRING` | Third group classification for the supplier. | | `SupplierGroup4` | `STRING` | Fourth group classification for the supplier. | | `HasSearchTerm` | `INTEGER` | Indicates if there is a search term available. | | `HasCategory` | `INTEGER` | Indicates if there is a category available. | | `SalesRevenue` | `NUMERIC` | Revenue generated from sales. | | `AdRevenue` | `NUMERIC` | Revenue generated from ads. | | `AdSpend` | `NUMERIC` | Amount spent on ads. | | `Impressions` | `NUMERIC` | Number of times the ad was displayed. | | `Clicks` | `NUMERIC` | Number of times the ad was clicked. | | `Conversions` | `NUMERIC` | Number of conversions attributed to the ad. | | `UnitSales` | `NUMERIC` | Number of units sold. | | `ClickSpend` | `NUMERIC` | Amount spent per click. | | `ImpressionSpend` | `NUMERIC` | Amount spent per impression. | | `PositionSum` | `NUMERIC` | Sum of positions for the ad. | | `AdsWithPositionCount` | `NUMERIC` | Count of ads with position data. | | `MaxCpc` | `NUMERIC` | Maximum cost per click across ads. | | `MinCpc` | `NUMERIC` | Minimum cost per click across ads. | | `StdDevCpc` | `FLOAT` | Standard deviation of cost per click. | | `VarianceCpc` | `FLOAT` | Variance of cost per click. | | `MaxCpi` | `NUMERIC` | Maximum cost per impression across ads. | | `MinCpi` | `NUMERIC` | Minimum cost per impression across ads. | | `StdDevCpi` | `FLOAT` | Standard deviation of cost per impression. | | `VarianceCpi` | `FLOAT` | Variance of cost per impression. | | `SalesRevenueUSD` | `FLOAT` | Sales revenue in USD. | | `AdRevenueUSD` | `FLOAT` | Ad revenue in USD. | | `AdSpendUSD` | `FLOAT` | Ad spend in USD. | | `EnableSalesMetrics` | `BOOLEAN` | Flag to enable sales metrics. | # `reporting.viz_global_decorated_adrequests_stats_out` - retailer - namespace Request (aggregated) data. Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is ad_request_agg_view. Layer: Visualisation Category: View Status: Internal Only Primary Key: RegionNamespace, Date, RetailerId, CatalogId, RequestTypeName, SearchTerm, ReservedSearchTermFlag, GenericSearchTerm, Placement, Platform, PageType, FilterMode, SlotId, Category Other Unique Key(s): Partition: Refer to ad_request_agg_view Foreign Key(s): Not Applicable | Column Name | Data Type | Description | |-------------|-----------|-------------| | `SearchTerm` | `STRING` | Search term that triggered the ad request. | | `GenericSearchTerm` | `STRING` | Generic version of the search term, if applicable. | | `SlotId` | `STRING` | Identifier for the ad slot. | | `Category` | `STRING` | Category being targeted. | | `CatLevel1` | `STRING` | Category level 1. | | `CatLevel2` | `STRING` | Category level 2. | | `CatLevel3` | `STRING` | Category level 3. | | `CatLevel4` | `STRING` | Category level 4. | | `CatLevel5` | `STRING` | Category level 5. | | `CatLevel6` | `STRING` | Category level 6. | | `CatLevel7` | `STRING` | Category level 7. | | `CategoryLabel` | `STRING` | Label for the category. | | `AdType` | `INT64` | Type identifier for the ad format or placement type. | | `ReservedSearchTermFlag` | `STRING` | Flag for reserved search terms. | | `Placement` | `STRING` | Display name of the Placement. | | `Platform` | `STRING` | Platform where the ad is served (e.g., web, mobile). | | `PageType` | `INT64` | Identifier for the type of page the ad is displayed on. | | `FilterMode` | `INT64` | Mode of filtering applied to the ad request. | | `CatalogId` | `STRING` | Internal identifier of the Catalog (from the source system). | | `CatalogName` | `STRING` | Name of the catalog. | | `RetailerId` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `RetailerName` | `STRING` | Name of the Retailer. | | `RetailerIndustry` | `STRING` | Industry category of the retailer. | | `RetailerBusinessIdentifier` | `STRING` | Business identifier for the retailer. | | `RetailerCompanyName` | `STRING` | Company name of the retailer. | | `RetailerGroup1` | `STRING` | First level group classification for the retailer. | | `RetailerGroup2` | `STRING` | Second level group classification for the retailer. | | `GeoRegion` | `STRING` | Geographical region of the Namespace (as defined by CitrusAd). | | `LocalTimezone` | `STRING` | Not in use. | | `HasSearchTerm` | `INT64` | Indicates if there is a search term available. | | `HasCategory` | `INT64` | Indicates if there is a category available. | | `Region` | `STRING` | Geographical region of the ad request. | | `RegionNamespace` | `STRING` | Namespace prefixed with the region. | | `Date` | `DATE` | Date of the ad request. | | `AdTypeName` | `STRING` | Name of the ad type. | | `RequestTypeName` | `STRING` | Name of the ad request type. | | `Namespace` | `STRING` | Name of the business namespace. | | `Retailer` | `STRING` | Retailer associated with the ad request. | | `Supplier` | `STRING` | Supplier associated with the ad request. | | `SupplierGroup1` | `STRING` | Supplier group membership #1. | | `SupplierGroup2` | `STRING` | Supplier group membership #2. | | `SupplierGroup3` | `STRING` | Supplier group membership #3. | | `SupplierGroup4` | `STRING` | Supplier group membership #4. | | `NumAdsConsidered` | `NUMERIC` | Number of ads considered for the request. | | `NumAdsServed` | `NUMERIC` | Number of ads served. | | `NumAdsRequested` | `NUMERIC` | Number of ads requested. | | `CappedNumAdsServed` | `NUMERIC` | Capped number of ads served. | | `CappedNumAdsRequested` | `NUMERIC` | Capped number of ads requested. | | `CappedNumRequestsServingMaxAds` | `NUMERIC` | Capped number of requests serving the maximum number of ads. | | `NumRequestsServingMaxAds` | `NUMERIC` | Number of requests serving the maximum number of ads. | | `NumAdRequestsServingNoAds` | `NUMERIC` | Number of ad requests where no ads were served. | | `NumAdRequestsServingSomeAds` | `NUMERIC` | Number of ad requests where at least one ad was served. | | `NumAdRequests` | `NUMERIC` | Total number of ad requests. | | `NumAdRequestsWithSaturation` | `NUMERIC` | Number of ad requests that served at least 4 ads or filled the entire request. | # `reporting.viz_global_decorated_bucketed_order_ad_stats_out` - retailer - namespace Order and Realised Ad (aggregated) data. Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is order_ad_stats. Layer: Visualisation Category: View Status: Internal Only Primary Key: RegionNamespace, RetailerId, OrderDate, ProductCode, NormalisedProductCode, CatalogId Other Unique Key(s): Partition: Refer to order_ad_stats Foreign Key(s): Not Applicable | Column Name | Data Type | Description | |-------------|-----------|-------------| | `RetailerId` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `OrderDate` | `DATE` | Date of the order. | | `Region` | `STRING` | Geographical region of the ad request. | | `Namespace` | `STRING` | Name of the business namespace. | | `RegionNamespace` | `STRING` | Namespace prefixed with the region. | | `ProductCode` | `STRING` | Product code (from the source system). | | `NormalisedProductCode` | `STRING` | Standardized product code used for consistent identification. | | `CatalogId` | `STRING` | Internal identifier of the Catalog (from the source system). | | `AdStatsProductCode` | `STRING` | Product code associated with ad statistics. | | `ConversionsFromAds` | `NUMERIC` | Number of conversions from ads. | | `UnitSalesFromAds` | `NUMERIC` | Number of unit sales from ads. | | `TotalPrice` | `NUMERIC` | Total price of the transaction. | | `Quantity` | `NUMERIC` | Quantity of items. | | `OrderItems` | `NUMERIC` | Items in the order. | | `Orders` | `NUMERIC` | List of orders. | | `ProductName` | `STRING` | Name of the product. | | `Brand` | `STRING` | Brand name of the product. | | `ProductType` | `STRING` | Type of the product. | | `Type` | `STRING` | Type classification of the product. | | `ProductTags` | `STRING` | Tags associated with the product. | | `Supplier` | `STRING` | Supplier associated with the ad request. | | `CurrencyCode` | `STRING` | Currency code for the monetary values. | | `RetailerName` | `STRING` | Name of the Retailer. | | `Retailer` | `STRING` | Retailer associated with the ad request. | | `CurrencyValue` | `FLOAT64` | Value of the currency used. | | `GeoRegion` | `STRING` | Geographical region of the Namespace (as defined by CitrusAd). | | `LocalTimezone` | `STRING` | Not in use. | # `reporting.viz_global_decorated_report_request_tracking_out` - namespace CitrusAd client reporting usage (aggregated) data. Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is report_request_tracking. Layer: Visualisation Category: View Status: Internal Only Primary Key: RegionNamespace,TeamId,UserId,RequestDate,RequestType,CacheLevel,CountTowardsQuota,ReportSpan,MaxBilledBytesPerDay,MaxUncachedRequestsPerDay Other Unique Key(s): Partition: Refer to report_request_tracking Foreign Key(s): Not Applicable | Column Name | Data Type | Description | |-------------|-----------|-------------| | `Namespace` | `STRING` | Name of the business namespace. | | `TeamId` | `STRING` | Internal identifier of the team associated with this wallet | | `UserId` | `STRING` | Identifier of a user associated with the Team. | | `RequestDate` | `DATE` | Date of the request. | | `ReportType` | `STRING` | Type of report generated. | | `CacheLevel` | `STRING` | Level of caching applied. | | `CountsTowardsQuota` | `BOOL` | Indicates if the amount counts towards quota. | | `ReportSpan` | `STRING` | Span of the report. | | `ReportSpanSeconds` | `NUMERIC` | Span of the report in seconds. | | `MaxBilledBytesPerDay` | `NUMERIC` | Maximum bytes billed per day. | | `MaxUncachedRequestsPerDay` | `NUMERIC` | Maximum uncached requests per day. | | `MaxBilledBytesPerMonth` | `NUMERIC` | Maximum bytes billed per month. | | `MaxUncachedRequestsPerMonth` | `NUMERIC` | Maximum uncached requests per month. | | `TeamName` | `STRING` | Name of the team managing the campaign. | | `UserName` | `STRING` | Name of the user. | | `UserEmail` | `STRING` | Email address of the user. | | `UserIsAdmin` | `STRING` | Indicates if the user is an admin. | | `Region` | `STRING` | Geographical region of the ad request. | | `RegionNamespace` | `STRING` | Namespace prefixed with the region. | | `Retailer` | `STRING` | Retailer associated with the ad request. | | `Supplier` | `STRING` | Supplier associated with the ad request. | | `BigQueryBilledBytes` | `NUMERIC` | Number of bytes billed by BigQuery. | | `RequestCount` | `INT64` | Number of requests made. | # `reporting.viz_global_halo_attribution_out` - supplier Enhanced Attribution (aggregated, both models) data. Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is enhanced_attribution_agg_view. Layer: Visualisation Category: View Status: Internal Only Primary Key: RegionNamespace, CampaignId, CategoryId, ProductCode, HaloTaxonomyLevel, OrderDate, IngressedAt, SearchTerm, Placement, Platform, PageType, AttributionModel, RetailerId, OrderType, NormalisedProductCode, ProductName, Brand, RetailerTaxonomy, HaloTaxonomy Other Unique Key(s): Partition: Refer to enhanced_attribution_agg_view Foreign Key(s): Not Applicable | Column Name | Data Type | Description | |-------------|-----------|-------------| | `Namespace` | `STRING` | Name of the business namespace. | | `IngressedAt` | `DATE` | The timestamp when Ad was requested and created. | | `YYYYMMDD` | `STRING` | Year, month, and day in YYYYMMDD format. | | `YYYYMM` | `STRING` | Year and month in YYYYMM format. | | `YYYY` | `STRING` | Year in four-digit format. | | `WeekStartDate` | `DATE` | Start date of the week. | | `OrderDate` | `DATE` | Date of the order. | | `NormalisedProductCode` | `STRING` | Standardized product code used for consistent identification. | | `ProductCode` | `STRING` | Product code (from the source system). | | `ProductName` | `STRING` | Name of the product. | | `Brand` | `STRING` | Brand name of the product. | | `RetailerTaxonomy` | `STRING` | Retailer's own product taxonomy classification. | | `HaloTaxonomy` | `STRING` | Halo taxonomy. | | `HaloTaxonomyLevel` | `INT64` | Level of halo taxonomy. | | `CampaignId` | `STRING` | Internal identifier of the Campaign (from the source system). | | `SearchTerm` | `STRING` | Search term that triggered the ad request. | | `Placement` | `STRING` | Display name of the Placement. | | `Platform` | `STRING` | Platform where the ad is served (e.g., web, mobile). | | `PageType` | `INT64` | Identifier for the type of page the ad is displayed on. | | `AttributionModel` | `INT64` | Model used for attribution. | | `OrderType` | `STRING` | Type of the order. | | `CategoryId` | `STRING` | Identifier for the category. | | `CampaignName` | `STRING` | Name of the campaign. | | `CampaignStartDate` | `TIMESTAMP` | Start date and time of the campaign. | | `CampaignEndDate` | `TIMESTAMP` | End date and time of the campaign. | | `CampaignType` | `STRING` | Type of the campaign. | | `CampaignSubtype` | `STRING` | Subtype of the campaign. | | `WalletId` | `STRING` | Identifier of the wallet. | | `SupplierId` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `RetailerId` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `TeamType` | `STRING` | Type of Team (SUPPLIER or RETAILER). | | `SupplierName` | `STRING` | Name of the Supplier. | | `CategoryName` | `STRING` | Name of the category. | | `WalletName` | `STRING` | Name of the wallet used. | | `WalletAvailableBalance` | `NUMERIC` | Available balance in the wallet. | | `WalletCaptureDate` | `DATE` | Date when the wallet was captured. | | `RetailerGroup1` | `STRING` | First level group classification for the retailer. | | `RetailerGroup2` | `STRING` | Second level group classification for the retailer. | | `SupplierGroup1` | `STRING` | Supplier group membership #1. | | `SupplierGroup2` | `STRING` | Supplier group membership #2. | | `SupplierGroup3` | `STRING` | Supplier group membership #3. | | `SupplierGroup4` | `STRING` | Supplier group membership #4. | | `GeoRegion` | `STRING` | Geographical region of the Namespace (as defined by CitrusAd). | | `LocalTimezone` | `STRING` | Not in use. | | `HasSearchTerm` | `INT64` | Indicates if there is a search term available. | | `HasCategory` | `INT64` | Indicates if there is a category available. | | `Region` | `STRING` | Geographical region of the ad request. | | `RegionNamespace` | `STRING` | Namespace prefixed with the region. | | `ActiveState` | `STRING` | Current activity state of the campaign | | `ValidState` | `STRING` | Current validation state of the campaign | | `CTAText` | `STRING` | Call to action text for the ad. | | `CompanyName` | `STRING` | Registered company name of the Team. | | `RetailerName` | `STRING` | Name of the Retailer. | | `SupplierCompanyName` | `STRING` | Registered company name of the Supplier. | | `Impressions` | `NUMERIC` | Number of times ads were shown. | | `Clicks` | `NUMERIC` | Number of times ads were clicked. | | `AdSpend` | `NUMERIC` | Total amount spent on ads. | | `DirectUnitSales` | `NUMERIC` | Number of direct unit sales. | | `DirectSalesValue` | `NUMERIC` | Value of direct sales. | | `DirectConversions` | `NUMERIC` | Number of direct conversions. | | `ViewThroughUnitSales` | `NUMERIC` | Number of view-through unit sales. | | `ViewThroughSalesValue` | `NUMERIC` | Value of view-through sales. | | `ViewThroughConversions` | `NUMERIC` | Number of view-through conversions. | | `HaloUnitSales` | `NUMERIC` | Number of halo unit sales. | | `HaloSalesValue` | `NUMERIC` | Value of halo sales. | | `HaloConversions` | `NUMERIC` | Number of halo conversions. | | `TotalClickSales` | `NUMERIC` | Total sales from clicks. | | `TotalClickSalesValue` | `NUMERIC` | Total value of sales from clicks. | | `TotalUnitSales` | `NUMERIC` | Total number of unit sales. | | `TotalSalesValue` | `NUMERIC` | Total sales value. | | `TotalConversions` | `NUMERIC` | Total number of conversions. | | `EnableSalesMetrics` | `BOOLEAN` | Flag to enable sales metrics. | | `CatalogId` | `STRING` | Internal identifier of the Catalog (from the source system). | | `CatalogName` | `STRING` | Name of the catalog. | | `ImpHaloUnitSales` | `NUMERIC` | Number of implied halo unit sales. | | `ImpHaloSalesValue` | `NUMERIC` | Value of implied halo sales. | | `ImpHaloConversions` | `NUMERIC` | Number of implied halo conversions. | | `AttributableImpressions` | `NUMERIC` | Subset of impressions that are considered attributable. | | `AttributableClicks` | `NUMERIC` | Subset of clicks that are considered attributable. | | `AttributableAdSpend` | `NUMERIC` | Subset of ad spend that is considered attributable. | | `IsFTA` | `BOOLEAN` | Flag indicating if the Campaign is Fixed Tenancy Agreement (FTA). | | `AttributionType` | `STRING` | The type of attribution applied to the conversion (e.g. click-based, impression-based). | | `HasVideo` | `BOOLEAN` | Flag to indicate if the Campaign has video. | | `HasCompanionProducts` | `BOOLEAN` | Flag to indicate if the Campaign has companion products. | # `reporting.viz_global_ledger_out` - supplier - retailer - namespace Ledger (aggregated) data. Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is ledger_agg. Layer: Visualisation Category: View Status: Internal Only Primary Key: RegionNamespace, WalletId, TeamId, TransactionDate, CampaignId, LedgerType, ProductLedger, Reason, RetailerId Other Unique Key(s): Partition: Refer to ledger_agg Foreign Key(s): Not Applicable | Column Name | Data Type | Description | |-------------|-----------|-------------| | `TeamId` | `STRING` | Internal identifier of the team associated with this wallet | | `SupplierId` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `RetailerId` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `WalletId` | `STRING` | Identifier of the wallet. | | `CampaignId` | `STRING` | Internal identifier of the Campaign (from the source system). | | `TeamName` | `STRING` | Name of the team managing the campaign. | | `SupplierName` | `STRING` | Name of the Supplier. | | `SupplierCompanyName` | `STRING` | Registered company name of the Supplier. | | `RetailerName` | `STRING` | Name of the Retailer. | | `RetailerCompanyName` | `STRING` | Company name of the retailer. | | `WalletName` | `STRING` | Name of the wallet used. | | `CurrencyCode` | `STRING` | Currency code for the monetary values. | | `ExternalId` | `STRING` | External system identifier for the wallet | | `CampaignName` | `STRING` | Name of the campaign. | | `CampaignType` | `STRING` | Type of the campaign. | | `Namespace` | `STRING` | Name of the business namespace. | | `LedgerType` | `STRING` | Type of ledger used. | | `Reason` | `STRING` | Reason for the transaction. | | `Archived` | `BOOL` | Indicates if the wallet has been archived | | `TransactionDate` | `DATE` | Date of the transaction. | | `CampaignStartDate` | `TIMESTAMP` | Start date and time of the campaign. | | `CampaignEndDate` | `TIMESTAMP` | End date and time of the campaign. | | `ValidState` | `STRING` | Current validation state of the campaign | | `ActiveState` | `STRING` | Current activity state of the campaign | | `IsFTA` | `STRING` | Indicates if the campaign is FTA (Free Trade Agreement) eligible. | | `Amount` | `NUMERIC` | Monetary amount involved in the transaction. | | `FTACost` | `NUMERIC` | Cost associated with FTA. | | `MaxCostPerClick` | `NUMERIC` | Maximum allowed cost per click (alternate field) | | `MaxTotalSpend` | `NUMERIC` | Maximum total budget (alternate field) | | `MaxDailySpend` | `NUMERIC` | Maximum daily spend limit (alternate field) | | `TotalSpend` | `NUMERIC` | Total spend by the Team. | | `ActiveCampaignCount` | `NUMERIC` | Number of currently active advertising campaigns | | `ActiveCampaignMaxTotalSpend` | `NUMERIC` | Sum of maximum spend limits across all active campaigns | | `CurrencyValue` | `FLOAT64` | Value of the currency used. | | `RetailerGroup1` | `STRING` | First level group classification for the retailer. | | `RetailerGroup2` | `STRING` | Second level group classification for the retailer. | | `SupplierGroup1` | `STRING` | Supplier group membership #1. | | `SupplierGroup2` | `STRING` | Supplier group membership #2. | | `SupplierGroup3` | `STRING` | Supplier group membership #3. | | `SupplierGroup4` | `STRING` | Supplier group membership #4. | | `GeoRegion` | `STRING` | Geographical region of the Namespace (as defined by CitrusAd). | | `LocalTimezone` | `STRING` | Not in use. | | `Region` | `STRING` | Geographical region of the ad request. | | `RegionNamespace` | `STRING` | Namespace prefixed with the region. | | `ProductLedger` | `STRING` | Ledger for product transactions. | | `Retailer` | `STRING` | Retailer associated with the ad request. | | `Supplier` | `STRING` | Supplier associated with the ad request. | | `TransactionCount` | `STRING` | Total number of transactions. | # `reporting.viz_global_product_out` - retailer - namespace Product data. Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is product. Layer: Visualisation Category: View Status: Internal Only Primary Key: RegionNamespace, CatalogId, ProductCode Other Unique Key(s): Partition: None Foreign Key(s): Not Applicable | Column Name | Data Type | Description | |-------------|-----------|-------------| | `NormalisedProductCode` | `STRING` | Standardized product code used for consistent identification. | | `ProductCode` | `STRING` | Original product code from the source system. | | `CatalogId` | `STRING` | Internal identifier of the Catalog (from the source system). | | `RetailerId` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `ProductName` | `STRING` | Name of the product. | | `ProductType` | `STRING` | Type or category of the product. | | `RetailerName` | `STRING` | Name of the retailer offering the product. | | `CurrencyCode` | `STRING` | Currency code for the product price (ISO 4217). | | `ProductTags` | `STRING` | Tags or labels associated with the product. | | `ProductImageUrl` | `STRING` | URL of the product image. | | `Brand` | `STRING` | Brand of the product. | | `GoogleProductTaxonomy` | `STRING` | Google product taxonomy classification. | | `RetailerTaxonomy` | `STRING` | Retailer's own product taxonomy classification. | | `Namespace` | `STRING` | Namespace or environment for the product (e.g., production, staging). | | `IsDeleted` | `BOOL` | Whether the product is deleted or inactive. | | `CatalogName` | `STRING` | Name of the catalog containing the product. | | `Type` | `STRING` | Type or classification of the product (alternate field). | | `RetailerGroup1` | `STRING` | Retailer group classification 1 for the product. | | `RetailerGroup2` | `STRING` | Retailer group classification 2 for the product. | | `SellerId` | `STRING` | Identifier of the seller for the product. | | `Upc` | `STRING` | Universal Product Code (UPC) for the product. | | `Inventory` | `STRING` | Inventory status or quantity for the product. | | `GeoRegion` | `STRING` | Geographical region for the product. | | `LocalTimezone` | `STRING` | Local timezone for the product. | | `Region` | `STRING` | Region for the product. | | `RegionNamespace` | `STRING` | Namespace for the region of the product. | | `Retailer` | `STRING` | Name of the retailer associated with the product. | | `Supplier` | `STRING` | Name of the supplier associated with the product. | # `reporting.viz_global_retailer_out` - retailer - namespace Product data. Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is retailer. Layer: Visualisation Category: View Status: Internal Only Primary Key: RegionNamespace, RetailerId Other Unique Key(s): Partition: None Foreign Key(s): Not Applicable | Column Name | Data Type | Description | |-------------|-----------|-------------| | `RetailerId` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `RetailerName` | `STRING` | Name of the Retailer. | | `TeamType` | `STRING` | Type of Team (SUPPLIER or RETAILER). | | `RetailerCompanyName` | `STRING` | Company name of the retailer. | | `RetailerBusinessIdentifier` | `STRING` | Business identifier for the retailer. | | `RetailerIndustry` | `STRING` | Industry category of the retailer. | | `CurrencyCode` | `STRING` | Currency code for the monetary values. | | `Namespace` | `STRING` | Name of the business namespace. | | `AdsRequestedCap` | `NUMERIC` | Maximum number of ads that can be requested. | | `BannerAdsRequestedCap` | `NUMERIC` | Maximum number of banner ads that can be requested. | | `ReservedSearchTerms` | `STRING` | List of reserved search terms. | | `GlobalSuppressFlag` | `STRING` | Global suppress flag. | | `RetailerGroup1` | `STRING` | First level group classification for the retailer. | | `RetailerGroup2` | `STRING` | Second level group classification for the retailer. | | `GeoRegion` | `STRING` | Geographical region of the Namespace (as defined by CitrusAd). | | `LocalTimezone` | `STRING` | Not in use. | | `IsActive` | `BOOL` | Indicates if the catalog is currently active. | | `IsDeleted` | `BOOL` | Indicates if the catalog has been deleted. | | `IsCurrent` | `BOOL` | Indicates if this is the current version of the catalog record. | | `CreatedAt` | `TIMESTAMP` | Timestamp when the Team was created. | | `UpdatedAt` | `TIMESTAMP` | Timestamp when the Team was last updated. | | `Region` | `STRING` | Geographical region of the ad request. | | `RegionNamespace` | `STRING` | Namespace prefixed with the region. | | `CompanyName` | `STRING` | Registered company name of the Team. | | `BusinessIdentifier` | `STRING` | Business identifier for the Team. | | `Industry` | `STRING` | Industry sector of the Team. | | `Retailer` | `STRING` | Retailer associated with the ad request. | | `Supplier` | `STRING` | Supplier associated with the ad request. | # `reporting.viz_global_sov_category_mth_out` - namespace Share of voice by Category data (month buckets). Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is insights_sov_category. Layer: Visualisation Category: View Status: Internal Only Primary Key: RegionNamespace,RetailerId,SupplierId,Category,IngressedAt Other Unique Key(s): Partition: Refer to insights_sov_category Foreign Key(s): Not Applicable | Column Name | Data Type | Description | |-------------|-----------|-------------| | `IngressedAt` | `DATE` | The timestamp when Ad was requested and created. | | `Region` | `STRING` | Geographical region of the ad event. | | `RegionNamespace` | `STRING` | Namespace prefixed with the region. | | `RetailerId` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `RetailerName` | `STRING` | Name of the Retailer. | | `SupplierId` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `SupplierName` | `STRING` | Name of the Supplier. | | `Category` | `STRING` | Category being targeted. | | `Impressions` | `NUMERIC` | Number of ad impressions. | | `Clicks` | `NUMERIC` | Number of ad clicks. | | `Conversions` | `NUMERIC` | Total standard conversions (purchases of the exact product in the ad). | | `UnitSales` | `NUMERIC` | Total number of products purchased from conversions. | | `AdSpend` | `NUMERIC` | Total ad spend. | | `AdRevenue` | `NUMERIC` | Portion of ad spend retained by the retailer. | | `SalesRevenue` | `NUMERIC` | Total sales revenue generated by conversions. | | `ImpressionsByRetailer` | `NUMERIC` | Number of ad impressions by retailer. | | `ClicksByRetailer` | `NUMERIC` | Number of ad clicks by retailer. | | `ConversionsByRetailer` | `NUMERIC` | Number of conversions by retailer. | | `UnitSalesByRetailer` | `NUMERIC` | Number of unit sales by retailer. | | `AdSpendByRetailer` | `NUMERIC` | Ad spend attributed to each retailer. | | `AdRevenueByRetailer` | `NUMERIC` | Ad revenue attributed to each retailer. | | `SalesRevenueByRetailer` | `NUMERIC` | Sales revenue attributed to each retailer. | | `ImpressionsByNamespace` | `NUMERIC` | Number of ad impressions by namespace. | | `ClicksByNamespace` | `NUMERIC` | Number of ad clicks by namespace. | | `ConversionsByNamespace` | `NUMERIC` | Number of conversions by namespace. | | `UnitSalesByNamespace` | `NUMERIC` | Number of unit sales by namespace. | | `AdSpendByNamespace` | `NUMERIC` | Ad spend attributed to each namespace. | | `AdRevenueByNamespace` | `NUMERIC` | Ad revenue attributed to each namespace. | | `SalesRevenueByNamespace` | `NUMERIC` | Sales revenue attributed to each namespace. | # `reporting.viz_global_sov_category_week_out` - namespace Share of voice by Category data (weekly buckets). Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is insights_sov_category. Layer: Visualisation Category: View Status: Internal Only Primary Key: RegionNamespace,RetailerId,SupplierId,Category,IngressedAt Other Unique Key(s): Partition: Refer to insights_sov_category Foreign Key(s): Not Applicable | Column Name | Data Type | Description | |-------------|-----------|-------------| | `IngressedAt` | `DATE` | The timestamp when Ad was requested and created. | | `Region` | `STRING` | Geographical region of the ad request. | | `RegionNamespace` | `STRING` | Namespace prefixed with the region. | | `RetailerId` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `RetailerName` | `STRING` | Name of the Retailer. | | `SupplierId` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `SupplierName` | `STRING` | Name of the Supplier. | | `Category` | `STRING` | Category being targeted. | | `Impressions` | `NUMERIC` | Number of times ads were shown. | | `Clicks` | `NUMERIC` | Number of times ads were clicked. | | `Conversions` | `NUMERIC` | Number of ad conversions. | | `UnitSales` | `NUMERIC` | Number of units sold. | | `AdSpend` | `NUMERIC` | Total amount spent on ads. | | `AdRevenue` | `NUMERIC` | Total revenue generated from ads. | | `SalesRevenue` | `NUMERIC` | Total revenue generated from sales. | | `ImpressionsByRetailer` | `NUMERIC` | Number of ad impressions by retailer. | | `ClicksByRetailer` | `NUMERIC` | Number of ad clicks by retailer. | | `ConversionsByRetailer` | `NUMERIC` | Number of conversions by retailer. | | `UnitSalesByRetailer` | `NUMERIC` | Number of unit sales by retailer. | | `AdSpendByRetailer` | `NUMERIC` | Ad spend attributed to each retailer. | | `AdRevenueByRetailer` | `NUMERIC` | Ad revenue attributed to each retailer. | | `SalesRevenueByRetailer` | `NUMERIC` | Sales revenue attributed to each retailer. | | `ImpressionsByNamespace` | `NUMERIC` | Number of ad impressions by namespace. | | `ClicksByNamespace` | `NUMERIC` | Number of ad clicks by namespace. | | `ConversionsByNamespace` | `NUMERIC` | Number of conversions by namespace. | | `UnitSalesByNamespace` | `NUMERIC` | Number of unit sales by namespace. | | `AdSpendByNamespace` | `NUMERIC` | Ad spend attributed to each namespace. | | `AdRevenueByNamespace` | `NUMERIC` | Ad revenue attributed to each namespace. | | `SalesRevenueByNamespace` | `NUMERIC` | Sales revenue attributed to each namespace. | # `reporting.viz_global_sov_search_term_mth_out` - namespace Share of voice by Search Term data (month buckets). Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is insights_sov_search_term. Layer: Visualisation Category: View Status: Internal Only Primary Key: RegionNamespace,RetailerId,SupplierId,SearchTerm,IngressedAt Other Unique Key(s): Partition: Refer to insights_sov_search_term Foreign Key(s): Not Applicable | Column Name | Data Type | Description | |-------------|-----------|-------------| | `IngressedAt` | `DATE` | The timestamp when Ad was requested and created. | | `Region` | `STRING` | Geographical region of the ad request. | | `RegionNamespace` | `STRING` | Namespace prefixed with the region. | | `RetailerId` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `RetailerName` | `STRING` | Name of the Retailer. | | `SupplierId` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `SupplierName` | `STRING` | Name of the Supplier. | | `SearchTerm` | `STRING` | Search term that triggered the ad request. | | `Impressions` | `NUMERIC` | Number of times ads were shown. | | `Clicks` | `NUMERIC` | Number of times ads were clicked. | | `Conversions` | `NUMERIC` | Number of ad conversions. | | `UnitSales` | `NUMERIC` | Number of units sold. | | `AdSpend` | `NUMERIC` | Total amount spent on ads. | | `AdRevenue` | `NUMERIC` | Total revenue generated from ads. | | `SalesRevenue` | `NUMERIC` | Total revenue generated from sales. | | `ImpressionsByRetailer` | `NUMERIC` | Number of ad impressions by retailer. | | `ClicksByRetailer` | `NUMERIC` | Number of ad clicks by retailer. | | `ConversionsByRetailer` | `NUMERIC` | Number of conversions by retailer. | | `UnitSalesByRetailer` | `NUMERIC` | Number of unit sales by retailer. | | `AdSpendByRetailer` | `NUMERIC` | Ad spend attributed to each retailer. | | `AdRevenueByRetailer` | `NUMERIC` | Ad revenue attributed to each retailer. | | `SalesRevenueByRetailer` | `NUMERIC` | Sales revenue attributed to each retailer. | | `ImpressionsByNamespace` | `NUMERIC` | Number of ad impressions by namespace. | | `ClicksByNamespace` | `NUMERIC` | Number of ad clicks by namespace. | | `ConversionsByNamespace` | `NUMERIC` | Number of conversions by namespace. | | `UnitSalesByNamespace` | `NUMERIC` | Number of unit sales by namespace. | | `AdSpendByNamespace` | `NUMERIC` | Ad spend attributed to each namespace. | | `AdRevenueByNamespace` | `NUMERIC` | Ad revenue attributed to each namespace. | | `SalesRevenueByNamespace` | `NUMERIC` | Sales revenue attributed to each namespace. | # `reporting.viz_global_supplier_out` - supplier - namespace Supplier data. Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is supplier. Layer: Visualisation Category: View Status: Internal Only Primary Key: RegionNamespace, SupplierId Other Unique Key(s): Partition: None Foreign Key(s): Not Applicable | Column Name | Data Type | Description | |-------------|-----------|-------------| | `SupplierId` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `SupplierName` | `STRING` | Name of the Supplier. | | `TeamType` | `STRING` | Type of Team (SUPPLIER). | | `SupplierCompanyName` | `STRING` | Registered company name of the Supplier. | | `SupplierBusinessIdentifier` | `STRING` | Business identifier of the Supplier. | | `SupplierIndustry` | `STRING` | Industry classification of the Supplier. | | `Namespace` | `STRING` | Name of the Namespace. | | `SupplierGroup1` | `STRING` | Primary grouping category for the Supplier. | | `SupplierGroup2` | `STRING` | Secondary grouping category for the Supplier. | | `SupplierGroup3` | `STRING` | Tertiary grouping category for the Supplier. | | `SupplierGroup4` | `STRING` | Quaternary grouping category for the Supplier. | | `CreatedAt` | `TIMESTAMP` | Timestamp when the Supplier record was created. | | `UpdatedAt` | `TIMESTAMP` | Timestamp when the Supplier record was last updated. | | `LastCampaignCreatedId` | `STRING` | Identifier of the most recently created campaign for this Supplier. | | `LastCampaignCreatedDate` | `TIMESTAMP` | Timestamp when the most recent campaign was created. | | `LastCampaignUpdatedId` | `STRING` | Identifier of the most recently updated campaign for this Supplier. | | `LastCampaignUpdatedDate` | `TIMESTAMP` | Timestamp when the most recent campaign was updated. | | `TotalCampaigns` | `INT64` | Total number of campaigns associated with this Supplier. | | `TotalActiveCampaigns` | `INT64` | Total number of active campaigns for this Supplier. | | `TotalSpend` | `NUMERIC` | Total amount spent by this Supplier on campaigns. | | `LastSpendDate` | `DATE` | Date of the most recent spend by this Supplier. | | `GeoRegion` | `STRING` | Geographic region where the Supplier operates. | | `LocalTimezone` | `STRING` | Local timezone of the Supplier's primary location. | | `IsActive` | `BOOL` | Indicates if the Supplier account is currently active. | | `IsDeleted` | `BOOL` | Indicates if the Supplier account has been deleted. | | `IsCurrent` | `BOOL` | Indicates if this is the current version of the Supplier record. | | `Region` | `STRING` | Geographic region identifier. | | `RegionNamespace` | `STRING` | Namespace specific to the geographic region. | | `CompanyName` | `STRING` | Registered name of the Supplier company. | | `BusinessIdentifier` | `STRING` | Business registration identifier for the Supplier. | | `Industry` | `STRING` | Industry sector of the Supplier. | | `Retailer` | `STRING` | Associated retailer name if applicable. | | `Supplier` | `STRING` | Alternative supplier name or identifier. | # `reporting.viz_global_team_out` - supplier - retailer - namespace Team data. Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is team. Layer: Visualisation Category: View Status: Internal Only Primary Key: RegionNamespace, TeamId Other Unique Key(s): Partition: None Foreign Key(s): Not Applicable | Column Name | Data Type | Description | |-------------|-----------|-------------| | `TeamId` | `STRING` | Internal identifier of the Team (from the source system). | | `TeamName` | `STRING` | Name of the Team. | | `TeamType` | `STRING` | Type of Team (SUPPLIER or RETAILER). | | `CompanyName` | `STRING` | Registered company name of the Team. | | `BusinessIdentifier` | `STRING` | Business identifier for the Team. | | `Industry` | `STRING` | Industry sector of the Team. | | `UserId` | `STRING` | Identifier of a user associated with the Team. | | `RetailerId` | `STRING` | Identifier of the Retailer associated with the Team. | | `SupplierId` | `STRING` | Identifier of the Supplier associated with the Team. | | `RetailerGroup1` | `STRING` | Retailer group classification 1 for the Team. | | `RetailerGroup2` | `STRING` | Retailer group classification 2 for the Team. | | `SupplierGroup1` | `STRING` | Supplier group classification 1 for the Team. | | `SupplierGroup2` | `STRING` | Supplier group classification 2 for the Team. | | `SupplierGroup3` | `STRING` | Supplier group classification 3 for the Team. | | `SupplierGroup4` | `STRING` | Supplier group classification 4 for the Team. | | `SupplierName` | `STRING` | Name of the Supplier associated with the Team. | | `Namespace` | `STRING` | Namespace or environment for the Team (e.g., production, staging). | | `CreatedAt` | `TIMESTAMP` | Timestamp when the Team was created. | | `UpdatedAt` | `TIMESTAMP` | Timestamp when the Team was last updated. | | `LastCampaignCreatedId` | `STRING` | Identifier of the last campaign created by the Team. | | `LastCampaignCreatedDate` | `TIMESTAMP` | Timestamp of the last campaign created by the Team. | | `LastCampaignUpdatedId` | `STRING` | Identifier of the last campaign updated by the Team. | | `LastCampaignUpdatedDate` | `TIMESTAMP` | Timestamp of the last campaign updated by the Team. | | `TotalCampaigns` | `INT64` | Total number of campaigns created by the Team. | | `TotalActiveCampaigns` | `INT64` | Total number of active campaigns for the Team. | | `TotalSpend` | `NUMERIC` | Total spend by the Team. | | `LastSpendDate` | `DATE` | Date of the last spend by the Team. | | `GeoRegion` | `STRING` | Geographical region of the Team. | | `LocalTimezone` | `STRING` | Local timezone of the Team. | | `IsActive` | `BOOL` | Whether the Team is currently active. | | `IsDeleted` | `BOOL` | Whether the Team is deleted or inactive. | | `IsCurrent` | `BOOL` | Whether the Team is the current version (for slowly changing dimensions). | | `Region` | `STRING` | Region of the Team. | | `RegionNamespace` | `STRING` | Namespace for the region of the Team. | | `Retailer` | `STRING` | Name of the Retailer associated with the Team. | | `Supplier` | `STRING` | Name of the Supplier associated with the Team. | # `reporting.viz_global_team_user_out` - namespace Team Users data. Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is user_team. Layer: Visualisation Category: View Status: Internal Only Primary Key: RegionNamespace, TeamId, UserId Other Unique Key(s): Partition: None Foreign Key(s): Not Applicable | Column Name | Data Type | Description | |-------------|-----------|-------------| | `TeamId` | `STRING` | Internal identifier of the team associated with this wallet | | `UserId` | `STRING` | Identifier of a user associated with the Team. | | `UserName` | `STRING` | Name of the user. | | `TeamName` | `STRING` | Name of the team managing the campaign. | | `TeamType` | `STRING` | Type of Team (SUPPLIER or RETAILER). | | `Namespace` | `STRING` | Name of the business namespace. | | `CompanyName` | `STRING` | Registered company name of the Team. | | `Industry` | `STRING` | Industry sector of the Team. | | `Email` | `STRING` | Email address of the user. | | `Admin` | `BOOL` | Indicates if the user has admin privileges. | | `Activated` | `BOOL` | Indicates if the entity is activated. | | `SystemPermissions` | `STRING` | List of system permissions. | | `ActionPermission` | `STRING` | Permission related to a specific action. | | `SubjectPermission` | `STRING` | Permission related to the subject. | | `RetailerId` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `SupplierId` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `RetailerGroup1` | `STRING` | First level group classification for the retailer. | | `RetailerGroup2` | `STRING` | Second level group classification for the retailer. | | `SupplierGroup1` | `STRING` | Supplier group membership #1. | | `SupplierGroup2` | `STRING` | Supplier group membership #2. | | `SupplierGroup3` | `STRING` | Supplier group membership #3. | | `SupplierGroup4` | `STRING` | Supplier group membership #4. | | `SupplierName` | `STRING` | Name of the Supplier. | | `GeoRegion` | `STRING` | Geographical region of the Namespace (as defined by CitrusAd). | | `LocalTimezone` | `STRING` | Not in use. | | `Region` | `STRING` | Geographical region of the ad request. | | `RegionNamespace` | `STRING` | Namespace prefixed with the region. | | `Retailer` | `STRING` | Retailer associated with the ad request. | | `Supplier` | `STRING` | Supplier associated with the ad request. | # `reporting.viz_global_wallet_balance_out` - supplier - retailer - namespace Wallet balance (daily) data. Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is wallet_balance. Layer: Visualisation Category: View Status: Internal Only Primary Key: RegionNamespace, WalletId, TransactionDate Other Unique Key(s): Partition: Refer to wallet_balance Foreign Key(s): Not Applicable | Column Name | Data Type | Description | |-------------|-----------|-------------| | `TransactionDate` | `DATE` | Date of the transaction. | | `Region` | `STRING` | Geographical region of the ad request. | | `Namespace` | `STRING` | Name of the business namespace. | | `RegionNamespace` | `STRING` | Namespace prefixed with the region. | | `WalletId` | `STRING` | Identifier of the wallet. | | `WalletName` | `STRING` | Name of the wallet used. | | `CreditLimit` | `NUMERIC` | Maximum credit amount allowed for this wallet | | `Archived` | `BOOL` | Indicates if the wallet has been archived | | `RetailerName` | `STRING` | Name of the Retailer. | | `RetailerCompanyName` | `STRING` | Company name of the retailer. | | `SupplierName` | `STRING` | Name of the Supplier. | | `SupplierCompanyName` | `STRING` | Registered company name of the Supplier. | | `RetailerGroup1` | `STRING` | First level group classification for the retailer. | | `RetailerGroup2` | `STRING` | Second level group classification for the retailer. | | `SupplierGroup1` | `STRING` | Supplier group membership #1. | | `SupplierGroup2` | `STRING` | Supplier group membership #2. | | `SupplierGroup3` | `STRING` | Supplier group membership #3. | | `SupplierGroup4` | `STRING` | Supplier group membership #4. | | `SupplierId` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `DebitTransactions` | `INT64` | List of debit transactions. | | `CreditTransactions` | `INT64` | List of credit transactions. | | `Amount` | `NUMERIC` | Monetary amount involved in the transaction. | | `AmountDebit` | `NUMERIC` | Amount debited. | | `AmountCredit` | `NUMERIC` | Amount credited. | | `AmountUSD` | `FLOAT64` | Monetary amount in USD. | | `AmountDebitUSD` | `FLOAT64` | Amount debited in USD. | | `AmountCreditUSD` | `FLOAT64` | Amount credited in USD. | | `DailyLimit` | `NUMERIC` | Daily spending limit for the Wallet. | | `Balance` | `NUMERIC` | Current balance. | | `BalanceUSD` | `FLOAT64` | Current balance in USD. | | `Retailer` | `STRING` | Retailer associated with the ad request. | | `Supplier` | `STRING` | Supplier associated with the ad request. | | `WalletExternalId` | `STRING` | External identifier for the wallet. | # `reporting.viz_global_wallet_out` - supplier - retailer - namespace Wallet data. Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is wallet. Layer: Visualisation Category: View Status: Internal Only Primary Key: RegionNamespace, WalletId Other Unique Key(s): Partition: None Foreign Key(s): Not Applicable | Column Name | Data Type | Description | |-------------|-----------|-------------| | `WalletId` | `STRING` | Internal identifier of the Wallet (from the source system). | | `WalletTeamId` | `STRING` | Internal identifier of the Team that owns the Wallet. | | `ExternalId` | `STRING` | External identifier for the Wallet. | | `DealId` | `STRING` | Identifier of the associated Deal. | | `WalletName` | `STRING` | Name of the Wallet. | | `TeamName` | `STRING` | Name of the Team that owns the Wallet. | | `TeamType` | `STRING` | Type of Team (SUPPLIER or RETAILER). | | `Archived` | `BOOL` | Whether the Wallet is archived (no longer active). | | `CurrencyCode` | `STRING` | Currency code of the Wallet (ISO 4217). | | `Namespace` | `STRING` | Namespace or environment for the Wallet (e.g., production, staging). | | `CreditLimit` | `NUMERIC` | Credit limit of the Wallet in its native currency. | | `PrepaidBalance` | `NUMERIC` | Prepaid balance of the Wallet in its native currency. | | `TotalPurchasedCredits` | `NUMERIC` | Total purchased credits in the Wallet's native currency. | | `AvailableBalance` | `NUMERIC` | Available balance in the Wallet's native currency. | | `LatestTopUpAmount` | `NUMERIC` | Amount of the latest top-up in the Wallet's native currency. | | `EarliestTopUpAmount` | `NUMERIC` | Amount of the earliest top-up in the Wallet's native currency. | | `LargestTopUpAmount` | `NUMERIC` | Largest top-up amount in the Wallet's native currency. | | `SmallestTopUpAmount` | `NUMERIC` | Smallest top-up amount in the Wallet's native currency. | | `AverageTopUpAmount` | `NUMERIC` | Average top-up amount in the Wallet's native currency. | | `CreditLimitUsd` | `NUMERIC` | Credit limit of the Wallet in USD. | | `AvailableBalanceUsd` | `NUMERIC` | Available balance in the Wallet in USD. | | `PrepaidBalanceUsd` | `NUMERIC` | Prepaid balance of the Wallet in USD. | | `TotalPurchasedCreditsUsd` | `NUMERIC` | Total purchased credits in the Wallet in USD. | | `LatestTopUpAmountUsd` | `NUMERIC` | Amount of the latest top-up in the Wallet in USD. | | `EarliestTopUpAmountUsd` | `NUMERIC` | Amount of the earliest top-up in the Wallet in USD. | | `LargestTopUpAmountUsd` | `NUMERIC` | Largest top-up amount in the Wallet in USD. | | `SmallestTopUpAmountUsd` | `NUMERIC` | Smallest top-up amount in the Wallet in USD. | | `AverageTopUpAmountUsd` | `NUMERIC` | Average top-up amount in the Wallet in USD. | | `EarliestCreditDate` | `TIMESTAMP` | Timestamp of the earliest credit to the Wallet. | | `LatestCreditDate` | `TIMESTAMP` | Timestamp of the latest credit to the Wallet. | | `WalletCaptureDate` | `TIMESTAMP` | Timestamp when the Wallet data was captured. | | `ActiveCampaignCount` | `NUMERIC` | Number of active campaigns associated with the Wallet. | | `ActiveCampaignMaxTotalSpend` | `NUMERIC` | Maximum total spend among active campaigns for the Wallet. | | `DailyLimit` | `NUMERIC` | Daily spending limit for the Wallet. | | `CappedAvailableBalance` | `NUMERIC` | Available balance after applying any caps or limits. | | `AvailableBalanceAud` | `NUMERIC` | Available balance in the Wallet in AUD. | | `AverageTopUpAmountAud` | `NUMERIC` | Average top-up amount in the Wallet in AUD. | | `CreditLimitAud` | `NUMERIC` | Credit limit of the Wallet in AUD. | | `EarliestTopUpAmountAud` | `NUMERIC` | Amount of the earliest top-up in the Wallet in AUD. | | `LargestTopUpAmountAud` | `NUMERIC` | Largest top-up amount in the Wallet in AUD. | | `LatestTopUpAmountAud` | `NUMERIC` | Amount of the latest top-up in the Wallet in AUD. | | `PrepaidBalanceAud` | `NUMERIC` | Prepaid balance of the Wallet in AUD. | | `SmallestTopUpAmountAud` | `NUMERIC` | Smallest top-up amount in the Wallet in AUD. | | `TotalPurchasedCreditsAud` | `NUMERIC` | Total purchased credits in the Wallet in AUD. | | `RetailerId` | `STRING` | Internal identifier of the Retailer associated with the Wallet. | | `SupplierId` | `STRING` | Internal identifier of the Supplier associated with the Wallet. | | `RetailerGroup1` | `STRING` | Retailer group classification 1 for the Wallet. | | `RetailerGroup2` | `STRING` | Retailer group classification 2 for the Wallet. | | `SupplierGroup1` | `STRING` | Supplier group classification 1 for the Wallet. | | `SupplierGroup2` | `STRING` | Supplier group classification 2 for the Wallet. | | `SupplierGroup3` | `STRING` | Supplier group classification 3 for the Wallet. | | `SupplierGroup4` | `STRING` | Supplier group classification 4 for the Wallet. | | `GeoRegion` | `STRING` | Geographical region of the Wallet. | | `LocalTimezone` | `STRING` | Local timezone of the Wallet. | | `Region` | `STRING` | Region of the Wallet. | | `RegionNamespace` | `STRING` | Namespace for the region of the Wallet. | | `Retailer` | `STRING` | Name of the Retailer associated with the Wallet. | | `Supplier` | `STRING` | Name of the Supplier associated with the Wallet. | | `Id` | `STRING` | Unique identifier for the Wallet record. | | `TeamId` | `STRING` | Identifier of the Team associated with the Wallet. | | `Name` | `STRING` | Name of the Wallet (duplicate of WalletName for compatibility). | # `reporting.wallet` - supplier - retailer - namespace Wallet data. Layer: Reporting Datamart Category: Dimension Status: Published Primary Key: env_namespace, wallet_id Other Unique Key(s): Partition: None Foreign Key(s): env_namespace on env_namespace.env_namespace = wallet.env_namespace; retailer on retailer.env_namespace = wallet.env_namespace and retailer.retailer_id = wallet.retailer_id; supplier on supplier.env_namespace = wallet.env_namespace and supplier.supplier_id = wallet.supplier_id; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `env` | `STRING` | Environment the Namespace is deployed in. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `wallet_id` | `STRING` | Internal identifier of the Wallet (from the source system). | | `wallet_team_id` | `STRING` | Internal identifier of the Team (from the source system). | | `external_id` | `STRING` | Implementation specific generic label. | | `deal_id` | `STRING` | Deal id. | | `wallet_name` | `STRING` | Name of the Wallet. | | `team_name` | `STRING` | Name of the Team. | | `team_type` | `STRING` | Type of Team (SUPPLIER). | | `archived` | `BOOLEAN` | Archived status of the Wallet. | | `currency_code` | `STRING` | ISO 4217 currency code | | `namespace` | `STRING` | Name of the Namespace. | | `credit_limit` | `NUMERIC` | Amount the Wallet may go into credit. | | `prepaid_balance` | `NUMERIC` | Prepaid balance of the Wallet. | | `total_purchased_credits` | `NUMERIC` | Total credits made to the Wallet. | | `available_balance` | `NUMERIC` | Current available balance of the Wallet. | | `latest_top_up_amount` | `NUMERIC` | Amount of the most recent credit applied to the Wallet. | | `earliest_top_up_amount` | `NUMERIC` | Earliest credit amount made against the Wallet. | | `largest_top_up_amount` | `NUMERIC` | Largest credit amount made against the Wallet. | | `smallest_top_up_amount` | `NUMERIC` | Smallest credit amount made against the Wallet. | | `average_top_up_amount` | `NUMERIC` | Average of credits applied to the Wallet. | | `credit_limit_usd` | `NUMERIC` | credit_limit in USD (current exchange rate only). | | `available_balance_usd` | `NUMERIC` | available_balance in USD (current exchange rate only). | | `prepaid_balance_usd` | `NUMERIC` | prepaid_balance in USD (current exchange rate only). | | `total_purchased_credits_usd` | `NUMERIC` | total_purchased_credits in USD (current exchange rate only). | | `latest_top_up_amount_usd` | `NUMERIC` | latest_top_up_amount in USD (current exchange rate only). | | `earliest_top_up_amount_usd` | `NUMERIC` | earliest_top_up_amount in USD (current exchange rate only). | | `largest_top_up_amount_usd` | `NUMERIC` | largest_top_up_amount in USD (current exchange rate only). | | `smallest_top_up_amount_usd` | `NUMERIC` | smallest_top_up_amount in USD (current exchange rate only). | | `average_top_up_amount_usd` | `NUMERIC` | average_top_up_amount in USD (current exchange rate only). | | `earliest_credit_date` | `TIMESTAMP` | Most recent date a credit was made to the Wallet. | | `latest_credit_date` | `TIMESTAMP` | Date of the most recent credit. | | `wallet_capture_date` | `TIMESTAMP` | Date the Wallet details were captured on. | | `active_campaign_count` | `NUMERIC` | Number of currently active Campaigns associated to the Wallet. | | `active_campaign_max_total_spend` | `NUMERIC` | Aggregate CampaignMaxTotalSpend for all currently active Campaigns associated to the Wallet. | | `daily_limit` | `NUMERIC` | Amount the Wallet may go into credit in a day. | | `capped_available_balance` | `NUMERIC` | Current capped available balance of the Wallet. | | `available_balance_aud` | `NUMERIC` | available_balance in AUD (current exchange rate only). | | `average_top_up_amount_aud` | `NUMERIC` | average_top_up_amount in AUD (current exchange rate only). | | `credit_limit_aud` | `NUMERIC` | credit_limit in AUD (current exchange rate only). | | `earliest_top_up_amount_aud` | `NUMERIC` | earliest_top_up_amount_aud in AUD (current exchange rate only). | | `largest_top_up_amount_aud` | `NUMERIC` | largest_top_up_amount in AUD (current exchange rate only). | | `latest_top_up_amount_aud` | `NUMERIC` | latest_top_up_amount in AUD (current exchange rate only). | | `prepaid_balance_aud` | `NUMERIC` | prepaid_balance in AUD (current exchange rate only). | | `smallest_top_up_amount_aud` | `NUMERIC` | smallest_top_up_amount in AUD (current exchange rate only). | | `total_purchased_credits_aud` | `NUMERIC` | total_purchased_credits in AUD (current exchange rate only). | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `supplier_id` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `retailer_group_1` | `STRING` | Retailer team group membership #1. | | `retailer_group_2` | `STRING` | Retailer team group membership #2. | | `supplier_group_1` | `STRING` | Supplier team group membership #1. | | `supplier_group_2` | `STRING` | Supplier team group membership #2. | | `supplier_group_3` | `STRING` | Supplier team group membership #3. | | `supplier_group_4` | `STRING` | Supplier team group membership #4. | | `geo_region` | `STRING` | Geographical region of the Namespace (as defined by CitrusAd). | | `local_timezone` | `STRING` | Not in use. | # `reporting.wallet_balance` - supplier - retailer - namespace Wallet balance data. Layer: Reporting Datamart Category: Fact Status: Published Primary Key: env_namespace, wallet_id, date Other Unique Key(s): Partition: date (by DAY) Foreign Key(s): env_namespace on env_namespace.env_namespace = wallet_balance.env_namespace; retailer on retailer.env_namespace = wallet_balance.env_namespace and retailer.retailer_id = wallet_balance.retailer_id; supplier on supplier.env_namespace = wallet_balance.env_namespace and supplier.supplier_id = wallet_balance.supplier_id; team on team.env_namespace = wallet_balance.env_namespace and team.team_id = wallet_balance.wallet_team_id; wallet on wallet.env_namespace = wallet_balance.env_namespace and wallet.wallet_id = wallet_balance.wallet_id; | Column Name | Data Type | Description | |-------------|-----------|-------------| | `wallet_id` | `STRING` | Internal identifier of the Wallet (from the source system). | | `wallet_team_id` | `STRING` | Internal identifier of the Team (from the source system). | | `external_id` | `STRING` | Implementation specific generic label. | | `currency_code` | `STRING` | ISO 4217 currency code | | `env` | `STRING` | Environment the Namespace is deployed in. | | `namespace` | `STRING` | Name of the Namespace. | | `env_namespace` | `STRING` | Namespace prefixed with the Environment it is deployed in. | | `wallet_name` | `STRING` | Name of the Wallet. | | `archived` | `BOOLEAN` | Archived status of the Wallet. | | `date` | `DATE` | Effective date of the record. | | `credit_limit` | `NUMERIC` | Amount the Wallet may go into credit. | | `balance` | `NUMERIC` | Closing balance of the Wallet on that day. | | `retailer_id` | `STRING` | Internal identifier of the Retailer team (from the source system). | | `supplier_id` | `STRING` | Internal identifier of the Supplier team (from the source system). | | `retailer_group_1` | `STRING` | Retailer team group membership #1. | | `retailer_group_2` | `STRING` | Retailer team group membership #2. | | `supplier_group_1` | `STRING` | Supplier team group membership #1. | | `supplier_group_2` | `STRING` | Supplier team group membership #2. | | `supplier_group_3` | `STRING` | Supplier team group membership #3. | | `supplier_group_4` | `STRING` | Supplier team group membership #4. | | `geo_region` | `STRING` | Geographical region of the Namespace (as defined by CitrusAd). | | `local_timezone` | `STRING` | Not in use. | | `daily_limit` | `NUMERIC` | Amount the Wallet may go into credit in a day. | Version: 1ace13f