Skip to content

Commit

Permalink
Merge pull request #1072 from PiwikPRO/analytics/extract-columns-part2
Browse files Browse the repository at this point in the history
  • Loading branch information
@mrfijas
mrfijas authored Sep 22, 2023
2 parents e5f1f75 + 76b3259 commit fdf7e71
Show file tree
Hide file tree
Showing 16 changed files with 260 additions and 255 deletions.
4 changes: 1 addition & 3 deletions Dockerfile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,4 @@ RUN python -m pip install --requirement requirements.local.txt && \
rm requirements.local.txt && \
rm requirements.txt

# Ignored files should be the auto generated json files in _static/api directory,
# but it doesn't look like sphinx-autobuild allows such fine grained control over what is ignored.
CMD ["sphinx-autobuild", "--host", "0.0.0.0", "--port", "8080", "--ignore", "*.json", "/app", "/home/python/docs/_build/html"]
CMD ["sphinx-autobuild", "--host", "0.0.0.0", "--port", "8080", "--ignore", "/app/_static/api/*", "--ignore", "/app/.idea/*", "/app", "/home/python/docs/_build/html"]
6 changes: 3 additions & 3 deletions custom_reports/columns.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Metrics
The table below lists core metrics that may be used in queries.
Additional metrics may be created using dimension transformations.

.. include:: columns_metrics.rst
.. include:: columns__metrics.rst

Dimensions
----------
Expand All @@ -27,7 +27,7 @@ The table below lists core dimensions that may be used in queries.

Note: "Database type" column presents the type of source column of the dimension (in case of enum - type of the ID, in case of dynamic dimensions - not applicable).

.. include:: columns_dimensions.rst
.. include:: columns__dimensions.rst

.. note::
Please note that the number of available custom slots (dimensions,
Expand All @@ -39,4 +39,4 @@ Transformations
The tables below list all transformations that may be used to transform
dimensions to metrics or different dimensions.

.. include:: columns_transformations.rst
.. include:: columns__transformations.rst
0 custom_reports/columns_dimensions.rst → custom_reports/columns__dimensions.rst
View file
File renamed without changes.
0 custom_reports/columns_metrics.rst → custom_reports/columns__metrics.rst
View file
File renamed without changes.
0 custom_reports/columns_transformations.rst → custom_reports/columns__transformations.rst
View file
File renamed without changes.
97 changes: 3 additions & 94 deletions custom_reports/integrations/google_ads.rst
View file

Large diffs are not rendered by default.

37 changes: 37 additions & 0 deletions custom_reports/integrations/google_ads__common_dimensions.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
.. table:: Common Dimensions

+-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+
| Dimension Name | Column ID | Scope | Type |Database Type |Nullable| Notes |
+=====================================+==========================+=======+==========+==============+========+================================================================================================+
|Source |source |session|str |string |False | |
+-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+
|Medium |medium |session|str |string |False | |
+-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+
|Source/Medium |source_medium |session|str |string |False | |
+-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+
|Keyword |keyword |session|str |string |False | |
+-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+
|Device type |device_type |session|[int, str]|uint8 |True |:download:`device_type.json </_static/json/enum/device_type.json>` |
+-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+
|Session entry URL |session_entry_url |session|str |string |False | |
+-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+
|Timestamp |timestamp |session|date |not applicable|False |by default in Raw data API |
+-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+
|Website Name |website_name |session|[str, str]|not applicable|False |website UUID |
+-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+
|Customer ID (Google Ads) |google_ads_customer_id |session|str_id |string |False | |
+-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+
|Customer Name (Google Ads) |google_ads_customer_name |session|[str, str]|not applicable|False | |
+-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+
|Campaign ID (Google Ads) |google_ads_campaign_id |session|int_id |int64 |False | |
+-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+
|Campaign Name (Google Ads) |google_ads_campaign_name |session|[int, str]|not applicable|False | |
+-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+
|Ad Group ID (Google Ads) |google_ads_ad_group_id |session|int_id |int64 |False | |
+-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+
|Ad Group Name (Google Ads) |google_ads_ad_group_name |session|[int, str]|not applicable|False | |
+-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+
|Ad Group Ad ID (Google Ads) |google_ads_ad_group_ad_id |session|str_id |string |False | |
+-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+
|Ad Group Ad Network Type (Google Ads)|google_ads_ad_network_type|session|[str, str]|string |False |:download:`google_ads_ad_network_type.json </_static/json/enum/google_ads_ad_network_type.json>`|
+-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+
39 changes: 39 additions & 0 deletions custom_reports/integrations/google_ads__dimensions.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
.. table:: Google Ads Dimensions

+----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+
| Dimension Name | Column ID | Scope | Type |Database Type |Nullable| Notes |
+========================================+=============================+========+==========+==============+========+=====================================================================================================================================+
|Source |source |session |str |string |False | |
+----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+
|Medium |medium |session |str |string |False | |
+----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+
|Source/Medium |source_medium |session |str |string |False | |
+----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+
|Keyword |keyword |session |str |string |False | |
+----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+
|Device type |device_type |session |[int, str]|uint8 |True |:download:`device_type.json </_static/json/enum/device_type.json>` |
+----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+
|Session entry URL |session_entry_url |session |str |string |False | |
+----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+
|Timestamp |timestamp |session |date |not applicable|False |by default in Raw data API |
+----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+
|Website Name |website_name |session |[str, str]|not applicable|False |website UUID |
+----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+
|Customer ID (Google Ads) |google_ads_customer_id |session |str_id |string |False | |
+----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+
|Customer Name (Google Ads) |google_ads_customer_name |session |[str, str]|not applicable|False | |
+----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+
|Campaign ID (Google Ads) |google_ads_campaign_id |session |int_id |int64 |False | |
+----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+
|Campaign Name (Google Ads) |google_ads_campaign_name |session |[int, str]|not applicable|False | |
+----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+
|Ad Group ID (Google Ads) |google_ads_ad_group_id |session |int_id |int64 |False | |
+----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+
|Ad Group Name (Google Ads) |google_ads_ad_group_name |session |[int, str]|not applicable|False | |
+----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+
|Ad Group Ad ID (Google Ads) |google_ads_ad_group_ad_id |session |str_id |string |False | |
+----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+
|Ad Group Ad Network Type (Google Ads) |google_ads_ad_network_type |session |[str, str]|string |False |:download:`google_ads_ad_network_type.json </_static/json/enum/google_ads_ad_network_type.json>` |
+----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+
|Ad Group Keyword Match Type (Google Ads)|google_ads_keyword_match_type|external|[str, str]|string |False |:download:`google_ads_keyword_match_type.json </_static/json/enum/google_ads_keyword_match_type.json>`, not available in Raw data API|
+----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+
17 changes: 17 additions & 0 deletions custom_reports/integrations/google_ads__metrics.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
.. table:: Google Ads Metrics

+------------------------+----------------------+--------+-----+
| Metric Name | Column ID | Scope |Type |
+========================+======================+========+=====+
|Impressions (Google Ads)|google_ads_impressions|external|int |
+------------------------+----------------------+--------+-----+
|Clicks (Google Ads) |google_ads_clicks |external|int |
+------------------------+----------------------+--------+-----+
|Cost (Google Ads) |google_ads_cost |external|float|
+------------------------+----------------------+--------+-----+
|Average CPC (Google Ads)|google_ads_average_cpc|external|float|
+------------------------+----------------------+--------+-----+
|CTR (Google Ads) |google_ads_ctr |external|float|
+------------------------+----------------------+--------+-----+
|ROAS (Google Ads) |google_ads_roas |session |float|
+------------------------+----------------------+--------+-----+
Loading

0 comments on commit fdf7e71

Please sign in to comment.