{"title":"Google Analytics Query","nodeType":"Manipulator","id":"*BkUhsCiz_xuaE_IY","factoryName":"org.knime.google.api.analytics.ga4.node.query.GAQueryFactory","factoryId":"org.knime.google.api.analytics.ga4.node.query.GAQueryFactory","path":["Tools & Services","Google Analytics"],"owner":"knime","ownerAccountId":"account:team:b5f0848f-496d-4e6a-b869-fa3532248db7","description":"<p>This node queries a connected Google Analytics 4 property using the <a href=\"https://developers.google.com/analytics/devguides/reporting/data/v1?hl&#61;en\" rel=\"ugc nofollow noopener noreferrer\">Google Analytics Data API v1</a> .</p>\n            \n            <p>The node supports building a <a href=\"https://support.google.com/analytics/answer/9212670?hl&#61;en&amp;ref_topic&#61;13395703\" rel=\"ugc nofollow noopener noreferrer\">Report</a> by specifying <a href=\"https://support.google.com/analytics/answer/9143382?hl&#61;en&amp;ref_topic&#61;11151952\" rel=\"ugc nofollow noopener noreferrer\"> metrics, dimensions</a> , and date ranges.</p>\n            \n            <p>In order to find available metrics and dimensions, you can use the <a href=\"https://ga-dev-tools.google/ga4/dimensions-metrics-explorer/\" rel=\"ugc nofollow noopener noreferrer\">GA4 Dimensions &amp; Metrics Explorer</a> offered by Google.</p>\n            \n            <p><b>Note:</b> This node can only be used to connect with Google Analytics 4 properties and is not compatible with Universal Analytics. To migrate a website using Universal Analytics to Google Analytics 4, you can find more information in the <a href=\"https://support.google.com/analytics/answer/10759417?hl&#61;en\" rel=\"ugc nofollow noopener noreferrer\">official migration guide</a> .</p>\n            \n        \n        ","shortDescription":"Query a connected Google Analytics 4 property.","keywords":[],"deprecated":false,"streamable":false,"tags":["Tools & Services","Google Analytics"],"icon":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyhpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuNi1jMTExIDc5LjE1ODMyNSwgMjAxNS8wOS8xMC0wMToxMDoyMCAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENDIDIwMTUgKE1hY2ludG9zaCkiIHhtcE1NOkluc3RhbmNlSUQ9InhtcC5paWQ6MUUxQ0M5Q0VFOUZBMTFFNThBQkRBNzhEMDJCMkE2OTEiIHhtcE1NOkRvY3VtZW50SUQ9InhtcC5kaWQ6MUUxQ0M5Q0ZFOUZBMTFFNThBQkRBNzhEMDJCMkE2OTEiPiA8eG1wTU06RGVyaXZlZEZyb20gc3RSZWY6aW5zdGFuY2VJRD0ieG1wLmlpZDoxRTFDQzlDQ0U5RkExMUU1OEFCREE3OEQwMkIyQTY5MSIgc3RSZWY6ZG9jdW1lbnRJRD0ieG1wLmRpZDoxRTFDQzlDREU5RkExMUU1OEFCREE3OEQwMkIyQTY5MSIvPiA8L3JkZjpEZXNjcmlwdGlvbj4gPC9yZGY6UkRGPiA8L3g6eG1wbWV0YT4gPD94cGFja2V0IGVuZD0iciI/PuAN+hUAAAEBSURBVHjaYvz//z8DJYCJgULAAmP8XyL3i+HLY1aidPEq/maMvseG6gJiNYPAv1+s5HuBW5qB0e8AmWEA08yvQsAATnH8ms/sxG0Ao+00BsaQMwwMfMo4Nf/vS8FuAKP1RAYG7UygKDsDo0oExBBsmv/+RmgCJSQwPtf+Hww+vvn/b57X/3/74v////L4//8PtyHip3f8/xcp8/9fmDgYw/QhXGBYwcDw6S3D/6ZgBoad5xkYX3IBbZfBbTN6QoJrfnwD4rINGxgYZZwZGDh4cGoGexuWF/6XOPyHaUbIAh3IxIxVM+PKF4yogfjtE6aq//+w2yws+RfDBQOWGwECDADY6IXVTm4wKAAAAABJRU5ErkJggg==","sinceVersion":"5.1.0","views":[],"inPorts":[{"objectClass":"org.knime.google.api.analytics.ga4.port.GAConnectionPortObject","color":"de5246","dataType":"Google Analytics","optional":false,"name":"Google Analytics Connection","description":"The connection to a Google Analytics 4 property."}],"outPorts":[{"objectClass":"org.knime.core.node.BufferedDataTable","color":"000000","dataType":"Table","optional":false,"name":"Google Analytics data","description":"A table with data according to the query."}],"dynInPorts":[],"dynOutPorts":[],"additionalSiteInformation":{"url":"https://update.knime.com/analytics-platform/5.12","trusted":true,"enabledByDefault":true,"name":"KNIME Analytics Platform 5.12 Update Site","version":"5.12.0"},"dialog":[{"sectionName":"Options","fields":[{"name":"Metrics","description":"<p>Metrics are quantitative measurements of event data for your Google Analytics property.</p>\n<p>Specify at least one and up to ten metrics to include in your query. Metrics can be specified by name and either be built-in metrics or custom metrics defined in your property.</p>\n<p>Built-in metrics can be seen in the <a href=\"https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema?hl&#61;en#metrics\" rel=\"ugc nofollow noopener noreferrer\">list of metrics</a> under the column &#34;API Name&#34;.</p>\n<ul><li><b>Metric</b> : Specify the name of the metric. For example, the metric &#34;eventCount&#34; is the total number of events. Available metric names can be seen in the <a href=\"https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema?hl&#61;en#metrics\" rel=\"ugc nofollow noopener noreferrer\">list of metrics</a> under the column &#34;API Name&#34;.</li></ul>","optional":false},{"name":"Dimensions","description":"<p>Dimensions are attributes of the event data and their values are always strings.</p>\n<p>Specify up to nine dimensions by name. Available dimension names can be seen in the <a href=\"https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema?hl&#61;en#dimensions\" rel=\"ugc nofollow noopener noreferrer\">list of dimensions</a> under the column &#34;API Name&#34;.</p>\n<ul><li><b>Dimension</b> : Specify the name of the dimension to request. For example, the dimension &#34;city&#34; indicates the city from which an event originates. Dimension values in report data are always strings; for example, the city could be &#34;Paris&#34; or &#34;New York&#34;. Available names can be seen in the <a href=\"https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema?hl&#61;en#dimensions\" rel=\"ugc nofollow noopener noreferrer\">list of dimensions</a> under the column &#34;API Name&#34;.</li></ul>","optional":false},{"name":"Date ranges","description":"<p>A date range specifies the range of dates for which to request event data from Google Analytics.</p>\n<p>Specify at least one and up to four date ranges for which event data will be requested. The custom name given to a date range replaces the date range name which is auto-generated by Google Analytics.</p>\n<ul><li><b>From date</b> : The inclusive start date for the query, not after the end date.</li><li><b>To date</b> : The inclusive end date for the query, not before the start date.</li><li><b>Name (optional)</b> : A custom name for the date range to which the dimension <tt>dateRange</tt> is valued. If no name is given, Google Analytics automatically names each date range based on their index: <tt>date_range_0</tt> , <tt>date_range_1</tt> , etc. <b>Note:</b> The custom name must not start with &#34;date_range_&#34; or &#34;RESERVED_&#34;.</li></ul>","optional":false},{"name":"Include date range name column","description":"<p>Include a column containing date range names. If a date range is not given a name explicitly, Google Analytics will auto-generate a unique name for each date range.</p>","optional":false},{"name":"Filter if matched by","description":"Output the event if it is matched by: \n<ul><li><b>All criteria</b> : an event is included if it is matched by <i>all</i> of the criteria (intersection of matches)</li><li><b>Any criterion</b> : an event is included if it is matched by <i>at least one</i> of the criteria (union of matches)</li></ul>","optional":false},{"name":"Dimension filter","description":"<p>Data can be filtered by comparing dimension values to strings or based on list inclusion.</p>\n<p>Each filter criterion can be negated to invert its results, for example to <i>exclude</i> results whose dimension values are in the specified list. The dimension filter can be configured such that <i>all</i> criteria must match for a result to be returned, or such that <i>any</i> criterion must match.</p>\n<ul><li><b>Dimension</b> : The name of the dimension to filter on.</li><li><b>Invert matches</b> : Invert results matched by the criterion in order to <i>exclude</i> certain events from the result.</li><li><b>Case handling</b> : Specifies whether strings should be matched case-insensitive or case-sensitive.</li><li><b>String matching</b> : Specify how the string value is matched with the dimension value. \n  <ul><li><b>Exact:</b> the string value must match the dimension value exactly</li><li><b>Begins with:</b> the dimension value must begin with the string value</li><li><b>Ends with:</b> the dimension value must end with the string value</li><li><b>Contains:</b> the dimension value must contain the string value</li><li><b>Regular expression (full match):</b> the string value is interpreted as a regular expression and must match the dimension value completely</li><li><b>Regular expression (partial match):</b> the string value is interpreted as a regular expression and must match the dimension value at least partially</li></ul></li><li><b>String value</b> : Specify the string value to match to the dimension value.</li></ul>","optional":false},{"name":"Currency code","description":"<p>Specify the currency code to use for currency returning metrics, to be stated in three letter ISO-4217 format. If it is left empty, the report uses the property&#39;s default currency.</p>","optional":false},{"name":"Keep empty rows","description":"If enabled, rows will also be returned if all their metrics are equal to 0. Otherwise they are omitted from the result.","optional":false},{"name":"Output response metadata as flow variables","description":"<p>If enabled, outputs response metadata from the Google Analytics API as flow variables. In particular, the following fields are returned: <tt>dataLossFromOtherRow</tt> , <tt>currencyCode</tt> , <tt>timeZone</tt> , <tt>emptyReason</tt> , <tt>subjectToThresholding</tt> . The format of the flow variable name follows the pattern <tt>analytics.response.$FIELD</tt> , where <tt>$FIELD</tt> specifies the field name.</p>\n<p>More information can be obtained from the <a href=\"https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/ResponseMetaData?hl&#61;en\" rel=\"ugc nofollow noopener noreferrer\">API documentation</a> .</p>","optional":false},{"name":"Output property quotas as flow variables","description":"<p>If enabled, outputs the Google Analytics property quotas as flow variables. Each quota will indicate the &#34;consumed&#34; and &#34;remaining&#34; tokens after the last API request made by the node. The format of the flow variable name follows the pattern <tt>analytics.quota.$QUOTA.$TYPE</tt> , where <tt>$QUOTA</tt> specifies the quota and <tt>$TYPE</tt> is either &#34;consumed&#34; or &#34;remaining&#34;. Available quotas can be seen in the <a href=\"https://developers.google.com/analytics/devguides/reporting/data/v1/quotas?hl&#61;en\" rel=\"ugc nofollow noopener noreferrer\">API documentation</a> .</p>\n<p><b>Note:</b> Retrieving a lot of data (many rows, many columns, or long date ranges) or specifying complex filter criteria may be responsible for consumption of many tokens per node execution.</p>","optional":false}]}],"links":[],"kudos":[],"kudosCount":0,"bundleInformation":{"bundleVersion":"5.4.3.v202503031608","bundleName":"KNIME Google API Nodes","bundleSymbolicName":"org.knime.google.api","bundleVendor":"KNIME AG, Zurich, Switzerland","featureSymbolicName":"org.knime.features.google.api","featureName":"KNIME Google Connectors","featureVersion":"5.12.0.v202605041104","featureVendor":"KNIME AG, Zurich, Switzerland","extensionId":"*9KacbeCTeoRZrjhi"},"frequentSuccessors":[]}
