PPNA-5915 exporter columns section

conf.py

@@ -71,7 +71,8 @@
     'sphinx.ext.todo',
     'sphinx.ext.mathjax',
     'opengraphext',
-    'sphinx_tabs.tabs']
+    'sphinx_tabs.tabs',
+    'sphinx_copybutton']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

custom_reports/columns.rst

@@ -47,3 +47,62 @@ dimensions to metrics or different dimensions.
 
 .. include:: columns__dimension_to_metric_transformations.rst
 .. include:: columns__dimension_to_dimension_transformations.rst
+
+Exporter
+--------
+
+The tables in the following sections shows all columns that may be easily used in Exporter config.
+For sessions and events scope there is preferred list of columns due to performance and reliability reasons.
+
+.. note::
+    The table below presents a short description of the selected fields.
+
++--------------------------------+-------------------------------------------------------+
+| Column                         | Description                                           |
++================================+=======================================================+
+| app_uuid                       | Binary format (16 bytes).                             |
++--------------------------------+-------------------------------------------------------+
+| server_time                    | In UTC.                                               |
++--------------------------------+-------------------------------------------------------+
+| location_ipv4                  | May be partially anonymized. Binary format (4 bytes). |
++--------------------------------+-------------------------------------------------------+
+| location_ipv6                  | May be partially anonymized. Binary format (16 bytes).|
++--------------------------------+-------------------------------------------------------+
+| session_custom_dimension_1     | Number of custom dimension slots is configurable.     |
++--------------------------------+-------------------------------------------------------+
+| event_custom_dimension_1       | Number of custom dimension slots is configurable.     |
++--------------------------------+-------------------------------------------------------+
+| session_custom_variable_key_1  | Number of custom variable slots is configurable.      |
++--------------------------------+-------------------------------------------------------+
+| event_custom_variable_key_1    | Number of custom variable slots is configurable.      |
++--------------------------------+-------------------------------------------------------+
+| event_index                    | Starts from 0.                                        |
++--------------------------------+-------------------------------------------------------+
+| page_view_index                | Starts from 0.                                        |
++--------------------------------+-------------------------------------------------------+
+
+
+Sessions scope - preferred
+``````````````````````````
+
+.. include:: columns__exporter_preferred_sessions_columns.rst
+
+Sessions scope
+``````````````
+
+.. include:: columns__exporter_all_sessions_columns.rst
+
+Events scope - preferred
+````````````````````````
+
+.. include:: columns__exporter_preferred_events_columns.rst
+
+Events scope
+````````````
+
+.. include:: columns__exporter_all_events_columns.rst
+
+Google Ads scope
+````````````````
+
+.. include:: columns__exporter_all_google_ads_columns.rst

custom_reports/columns__exporter_all_google_ads_columns.rst

@@ -0,0 +1,7 @@
+.. code-block:: json
+
+    "columns": [
+        "device_type", "google_ads_ad_group_ad_id", "google_ads_ad_group_id", "google_ads_ad_group_name", "google_ads_ad_network_type", "google_ads_average_cpc", "google_ads_campaign_id",
+        "google_ads_campaign_name", "google_ads_clicks", "google_ads_cost", "google_ads_ctr", "google_ads_customer_id", "google_ads_customer_name", "google_ads_impressions", "keyword", "medium",
+        "server_date", "session_entry_url", "source", "source_medium", "website_name"
+    ]

custom_reports/columns__exporter_all_sessions_columns.rst

@@ -0,0 +1,57 @@
+.. code-block:: json
+
+    "columns": [
+        "browser_engine", "browser_fingerprint", "browser_language_iso639", "browser_name", "browser_version", "campaign_content", "campaign_gclid", "campaign_id", "campaign_name", "cookie_id",
+        "device_brand", "device_model", "device_type", "google_ads_ad_group_ad_id", "google_ads_ad_group_id", "google_ads_ad_group_name", "google_ads_ad_network_type", "google_ads_campaign_id",
+        "google_ads_campaign_name", "google_ads_customer_id", "google_ads_customer_name", "ipv4_address", "ipv6_address", "is_bounce", "keyword", "local_hour", "location_city_name",
+        "location_continent_iso_code", "location_country_name", "location_latitude", "location_longitude", "location_metro_code", "location_organization", "location_provider",
+        "location_subdivision_1_name", "location_subdivision_2_name", "medium", "operating_system", "operating_system_version", "plugin_cookie", "plugin_director", "plugin_flash", "plugin_gears",
+        "plugin_java", "plugin_pdf", "plugin_quicktime", "plugin_realplayer", "plugin_silverlight", "plugin_windowsmedia", "referrer_type", "referrer_url", "resolution", "resolution_height",
+        "resolution_width", "session_custom_dimension_1", "session_custom_dimension_2", "session_custom_dimension_3", "session_custom_dimension_4", "session_custom_dimension_5",
+        "session_custom_dimension_6", "session_custom_dimension_7", "session_custom_dimension_8", "session_custom_dimension_9", "session_custom_dimension_10", "session_custom_dimension_11",
+        "session_custom_dimension_12", "session_custom_dimension_13", "session_custom_dimension_14", "session_custom_dimension_15", "session_custom_dimension_16", "session_custom_dimension_17",
+        "session_custom_dimension_18", "session_custom_dimension_19", "session_custom_dimension_20", "session_custom_dimension_21", "session_custom_dimension_22", "session_custom_dimension_23",
+        "session_custom_dimension_24", "session_custom_dimension_25", "session_custom_dimension_26", "session_custom_dimension_27", "session_custom_dimension_28", "session_custom_dimension_29",
+        "session_custom_dimension_30", "session_custom_dimension_31", "session_custom_dimension_32", "session_custom_dimension_33", "session_custom_dimension_34", "session_custom_dimension_35",
+        "session_custom_dimension_36", "session_custom_dimension_37", "session_custom_dimension_38", "session_custom_dimension_39", "session_custom_dimension_40", "session_custom_dimension_41",
+        "session_custom_dimension_42", "session_custom_dimension_43", "session_custom_dimension_44", "session_custom_dimension_45", "session_custom_dimension_46", "session_custom_dimension_47",
+        "session_custom_dimension_48", "session_custom_dimension_49", "session_custom_dimension_50", "session_custom_dimension_51", "session_custom_dimension_52", "session_custom_dimension_53",
+        "session_custom_dimension_54", "session_custom_dimension_55", "session_custom_dimension_56", "session_custom_dimension_57", "session_custom_dimension_58", "session_custom_dimension_59",
+        "session_custom_dimension_60", "session_custom_dimension_61", "session_custom_dimension_62", "session_custom_dimension_63", "session_custom_dimension_64", "session_custom_dimension_65",
+        "session_custom_dimension_66", "session_custom_dimension_67", "session_custom_dimension_68", "session_custom_dimension_69", "session_custom_dimension_70", "session_custom_dimension_71",
+        "session_custom_dimension_72", "session_custom_dimension_73", "session_custom_dimension_74", "session_custom_dimension_75", "session_custom_dimension_76", "session_custom_dimension_77",
+        "session_custom_dimension_78", "session_custom_dimension_79", "session_custom_dimension_80", "session_custom_dimension_81", "session_custom_dimension_82", "session_custom_dimension_83",
+        "session_custom_dimension_84", "session_custom_dimension_85", "session_custom_dimension_86", "session_custom_dimension_87", "session_custom_dimension_88", "session_custom_dimension_89",
+        "session_custom_dimension_90", "session_custom_dimension_91", "session_custom_dimension_92", "session_custom_dimension_93", "session_custom_dimension_94", "session_custom_dimension_95",
+        "session_custom_dimension_96", "session_custom_dimension_97", "session_custom_dimension_98", "session_custom_dimension_99", "session_custom_dimension_100", "session_custom_dimension_101",
+        "session_custom_dimension_102", "session_custom_dimension_103", "session_custom_dimension_104", "session_custom_dimension_105", "session_custom_dimension_106", "session_custom_dimension_107",
+        "session_custom_dimension_108", "session_custom_dimension_109", "session_custom_dimension_110", "session_custom_dimension_111", "session_custom_dimension_112", "session_custom_dimension_113",
+        "session_custom_dimension_114", "session_custom_dimension_115", "session_custom_dimension_116", "session_custom_dimension_117", "session_custom_dimension_118", "session_custom_dimension_119",
+        "session_custom_dimension_120", "session_custom_dimension_121", "session_custom_dimension_122", "session_custom_dimension_123", "session_custom_dimension_124", "session_custom_dimension_125",
+        "session_custom_dimension_126", "session_custom_dimension_127", "session_custom_dimension_128", "session_custom_dimension_129", "session_custom_dimension_130", "session_custom_dimension_131",
+        "session_custom_dimension_132", "session_custom_dimension_133", "session_custom_dimension_134", "session_custom_dimension_135", "session_custom_dimension_136", "session_custom_dimension_137",
+        "session_custom_dimension_138", "session_custom_dimension_139", "session_custom_dimension_140", "session_custom_dimension_141", "session_custom_dimension_142", "session_custom_dimension_143",
+        "session_custom_dimension_144", "session_custom_dimension_145", "session_custom_dimension_146", "session_custom_dimension_147", "session_custom_dimension_148", "session_custom_dimension_149",
+        "session_custom_dimension_150", "session_custom_dimension_151", "session_custom_dimension_152", "session_custom_dimension_153", "session_custom_dimension_154", "session_custom_dimension_155",
+        "session_custom_dimension_156", "session_custom_dimension_157", "session_custom_dimension_158", "session_custom_dimension_159", "session_custom_dimension_160", "session_custom_dimension_161",
+        "session_custom_dimension_162", "session_custom_dimension_163", "session_custom_dimension_164", "session_custom_dimension_165", "session_custom_dimension_166", "session_custom_dimension_167",
+        "session_custom_dimension_168", "session_custom_dimension_169", "session_custom_dimension_170", "session_custom_dimension_171", "session_custom_dimension_172", "session_custom_dimension_173",
+        "session_custom_dimension_174", "session_custom_dimension_175", "session_custom_dimension_176", "session_custom_dimension_177", "session_custom_dimension_178", "session_custom_dimension_179",
+        "session_custom_dimension_180", "session_custom_dimension_181", "session_custom_dimension_182", "session_custom_dimension_183", "session_custom_dimension_184", "session_custom_dimension_185",
+        "session_custom_dimension_186", "session_custom_dimension_187", "session_custom_dimension_188", "session_custom_dimension_189", "session_custom_dimension_190", "session_custom_dimension_191",
+        "session_custom_dimension_192", "session_custom_dimension_193", "session_custom_dimension_194", "session_custom_dimension_195", "session_custom_dimension_196", "session_custom_dimension_197",
+        "session_custom_dimension_198", "session_custom_dimension_199", "session_custom_dimension_200", "session_custom_variable_key_1", "session_custom_variable_key_2", "session_custom_variable_key_3",
+        "session_custom_variable_key_4", "session_custom_variable_key_5", "session_custom_variable_key_6", "session_custom_variable_key_7", "session_custom_variable_key_8",
+        "session_custom_variable_key_9", "session_custom_variable_key_10", "session_custom_variable_value_1", "session_custom_variable_value_2", "session_custom_variable_value_3",
+        "session_custom_variable_value_4", "session_custom_variable_value_5", "session_custom_variable_value_6", "session_custom_variable_value_7", "session_custom_variable_value_8",
+        "session_custom_variable_value_9", "session_custom_variable_value_10", "session_ecommerce_status", "session_entry_title", "session_entry_url", "session_exit_title", "session_exit_url",
+        "session_goal_uuids", "session_goals", "session_second_title", "session_second_url", "session_total_abandoned_carts", "session_total_cart_additions", "session_total_cart_removals",
+        "session_total_content_impressions", "session_total_content_interactions", "session_total_custom_events", "session_total_downloads", "session_total_ecommerce_conversions", "session_total_events",
+        "session_total_goal_conversions", "session_total_outlinks", "session_total_page_views", "session_total_product_detail_views", "session_total_sharepoint_comments",
+        "session_total_sharepoint_creations", "session_total_sharepoint_deletions", "session_total_sharepoint_edits", "session_total_sharepoint_item_attachment_views",
+        "session_total_sharepoint_item_shares", "session_total_sharepoint_item_views", "session_total_sharepoint_likes", "session_total_sharepoint_opens", "session_total_sharepoint_promotions",
+        "session_total_sharepoint_shares", "session_total_sharepoint_uploads", "session_total_site_searches", "session_total_time", "session_unique_content_impressions",
+        "session_unique_content_interactions", "session_unique_custom_events", "session_unique_downloads", "session_unique_outlinks", "session_unique_page_views", "session_unique_searches",
+        "sharepoint_department", "sharepoint_display_name", "sharepoint_job_title", "sharepoint_office", "source", "source_medium", "user_id", "visitor_days_since_first_session",
+        "visitor_days_since_last_session", "visitor_days_since_order", "visitor_returning", "visitor_session_number", "website_name"
+    ]