diff --git a/docs/404.html b/docs/404.html index 2aa4c5b4..a7079363 100644 --- a/docs/404.html +++ b/docs/404.html @@ -1,84 +1,40 @@ - - - - + + + + - Page not found (404) • googleAnalyticsR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - + + + - - - -
-
- + +
+ + + - - -
+

Page not found (404)

@@ -293,31 +249,31 @@

Page not found (404)

+
-
+ + - - diff --git a/docs/CODE_OF_CONDUCT.html b/docs/CODE_OF_CONDUCT.html index 3be6d94d..2709bd4f 100644 --- a/docs/CODE_OF_CONDUCT.html +++ b/docs/CODE_OF_CONDUCT.html @@ -1,84 +1,18 @@ - - - - - - - -Contributor Covenant Code of Conduct • googleAnalyticsR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Contributor Covenant Code of Conduct • googleAnalyticsR - - - - - - - - + gtag('config', 'G-43MDXK6CLZ'); + + -
-
- -
- -
+

Contributor Covenant Code of Conduct

@@ -290,83 +209,69 @@

Contributor Covenant Code of Conduct

-
-

-Our Pledge

+
+

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

-
-

-Our Standards

+
+

Our Standards

Examples of behavior that contributes to creating a positive environment include:

-
    -
  • Using welcoming and inclusive language
    • +
    • Using welcoming and inclusive language
    • Being respectful of differing viewpoints and experiences
    • Gracefully accepting constructive criticism
    • Focusing on what is best for the community
    • Showing empathy towards other community members
      • -
    -

    Examples of unacceptable behavior by participants include:

    -
      -
    • The use of sexualized language or imagery and unwelcome sexual attention or advances
      • +

    Examples of unacceptable behavior by participants include:

    +
    • The use of sexualized language or imagery and unwelcome sexual attention or advances
    • Trolling, insulting/derogatory comments, and personal or political attacks
    • Public or private harassment
    • Publishing others’ private information, such as a physical or electronic address, without explicit permission
    • Other conduct which could reasonably be considered inappropriate in a professional setting
      • -
    -
-
-

-Our Responsibilities

+
+
+

Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

-
-

-Scope

+
+

Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

-
-

-Enforcement

+
+

Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at . The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project’s leadership.

-
-

-Attribution

-

This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4

+
+

Attribution

+

This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4

+
-
-
-

Developed by Mark Edmondson.

+
+

Developed by Mark Edmondson.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - + + diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html index 78a256d4..7613e815 100644 --- a/docs/LICENSE-text.html +++ b/docs/LICENSE-text.html @@ -1,84 +1,18 @@ - - - - - - - -License • googleAnalyticsR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -License • googleAnalyticsR - - - - - - - - + gtag('config', 'G-43MDXK6CLZ'); + + -
-
- -
- -
+

License

@@ -295,31 +214,27 @@

License

+
-
-
-

Developed by Mark Edmondson.

+
+

Developed by Mark Edmondson.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - + + diff --git a/docs/articles/big-query.html b/docs/articles/big-query.html index 4cd5a941..20613fa5 100644 --- a/docs/articles/big-query.html +++ b/docs/articles/big-query.html @@ -23,15 +23,17 @@ + +
+

Big Query Exports from Google Analytics 360 to R

- Source: vignettes/big-query.Rmd + Source: vignettes/big-query.Rmd
@@ -253,41 +255,41 @@

Big Query Exports from Google Analytics 360 to R

Limited support for more user friendly calls to BigQuery Google Analytics 360 exports.

This is intended for users who may be familar with Google Analytics but not with SQL necessary to extract equivalent data from a BigQuery export of Google Analytics 360 data.

google_analytics_bq parses your metrics and dimensions into BigQuery queries.

-
-

-Setup

-

To use, you need to also install the bigQueryR library.

+
+

Setup +

+

To use, you need to also install the bigQueryR library.

Stable version is on CRAN:

-install.packages("bigQueryR")
+install.packages("bigQueryR")

Development version on devtools:

-devtools::install_github("MarkEdmondson1234/bigQueryR")
+devtools::install_github("MarkEdmondson1234/bigQueryR")

Once installed, authenticate to BigQuery:

-library(bigQueryR)
+library(bigQueryR)
 
 ## go through Google oAuth2 flow
 ## needs email that has access to the BigQuery dataset
-bqr_auth()
+bqr_auth()
 
 ## get lists of your project and datasets
-bqr_list_projects()
-bqr_list_datasets("project-id")
-

If you want to authenticate with Google Analytics and BigQuery in the same session (or others) then its best to authenticate with googleAuthR::gar_auth() with the appropriate scopes set. The below lets you authenticate with Google Analytics, Google Cloud Storage and BigQuery:

+bqr_list_projects() +bqr_list_datasets("project-id")
+

If you want to authenticate with Google Analytics and BigQuery in the same session (or others) then its best to authenticate with googleAuthR::gar_auth() with the appropriate scopes set. The below lets you authenticate with Google Analytics, Google Cloud Storage and BigQuery:

-options(googleAuthR.scopes.selected = c("https://www.googleapis.com/auth/analytics",
+options(googleAuthR.scopes.selected = c("https://www.googleapis.com/auth/analytics",
                                         "https://www.googleapis.com/auth/cloud-platform",
                                         "https://www.googleapis.com/auth/bigquery"))
-googleAuthR::gar_auth()
+googleAuthR::gar_auth()

You may also want to use a JSON file to authenticate with BigQuery. Make sure to add the service email to the users of the Google project, and then download the JSON file and authenticate via:

-googleAuthR::gar_auth_service("gwt-download-XXXX.json")
-

See googleAuthR help for more details.

+googleAuthR::gar_auth_service("gwt-download-XXXX.json")
+

See googleAuthR help for more details.

-
-

-Exporting data

+
+

Exporting data +

For BigQuery Google Analytics 360 exports, the dataset is the same as the GA View ID you are exporting.

You can then export BigQuery data via:

bq <- google_analytics_bq("project-id", "dataset-id-ga-viewid", 
@@ -312,9 +314,9 @@ 

 > Error in google_analytics_bq("project-id", "dataset-id-ga-viewid", start = "2016-01-01",  : 
   dimension not yet supported. Must be one of referralPath, campaign, source, medium, keyword, adContent, adwordsCampaignID, adwordsAdGroupID, transactionId, date, visitorId, visitId, visitStartTime, visitNumber
-
-

-Raw BigQuery SQL

+
+

Raw BigQuery SQL +

You can query the BigQuery table directly using the query parameter.

This is just as you would in the BigQuery interface, and allows queries you can also do there.

@@ -335,7 +337,7 @@ 

 just_query <- google_analytics_bq("project-id", "dataset-id-ga-viewid", 
                                   start = "2016-01-01", end = "2016-02-01", 
                                   metrics = "users", 
-                                  dimensions = c("source","medium"),
+                                  dimensions = c("source","medium"),
                                   return_query_only = TRUE)
 just_query
 # [1] "SELECT trafficSource.source as source, trafficSource.medium as medium, COUNT(fullVisitorId) as users 
@@ -343,12 +345,12 @@ 

 # TIMESTAMP('2016-02-01'))) GROUP BY source, medium  LIMIT 100"

You could then paste this query into the BigQuery interface, or modify it and send it back in via google_analytics_bq.

-
-

-Implemented metrics and dimensions

+
+

Implemented metrics and dimensions +

The metrics and dimensions implemented so far are in the two lookups below.

They include the BigQuery exclusive hitTimestamp, fullVisitorId, visitId etc.

-

Read the full Google Analytics 360 BigQuery data schema for an idea on what can be queried.

+

Read the full Google Analytics 360 BigQuery data schema for an idea on what can be queried.

lookup_bq_query_m <- c(visits = "SUM(totals.visits) as sessions",
                        sessions = "SUM(totals.visits) as sessions",
                        pageviews = "SUM(totals.pageviews) as pageviews",
@@ -419,11 +421,13 @@ 

 
 
       

-  
Developed by Mark Edmondson.

+  

+
Developed by Mark Edmondson.

 

 
 

-  
Site built with pkgdown 1.6.1.

+  

+
Site built with pkgdown 2.0.1.

 

 
       

@@ -432,5 +436,7 @@ 

   
 
 
+  
+
   
 
diff --git a/docs/articles/faq.html b/docs/articles/faq.html
index 0c8ea334..0758dfb0 100644
--- a/docs/articles/faq.html
+++ b/docs/articles/faq.html
@@ -23,15 +23,17 @@
 
 
 
+    
+
     

       

+      

   

     

       
FAQs

             
       
-      Source: vignettes/faq.Rmd
+      Source: vignettes/faq.Rmd
       
 
     

@@ -251,68 +253,68 @@ 
FAQs

     
     
 
googleAnalyticsR provides convenient access to the Google Analytics API, helping analysts and developers programatically access Google Analytics data, automate Google Analytics related workflows and benefit from working with data in larger volumes and finer granularity. The FAQ below provides some context around the library especially for those new to R, to the Google Analytics API or both.

-

-

-In which way will the use of this library help me ?

+

+
In which way will the use of this library help me ?
+

 
Connecting and interacting with an API involves a number of steps including authentication, passing data and instructions back and forth between server and client following protocol specifics etc. This can add a level of complexity to the interaction with a web API.

 
    
 
  • googleAnalyticsR intermediates between the user and the API, abstracting out the low level details of the interactions with the API. This involves providing a friendly method to authenticate and query the API and convert API data in a convenient format (typically an R data frame) that’s easy to work with directly.
    • 
-
  • Additionally the library provides many advanced functionalities which are developed on top of the Google Analytics API, for example the possibility to overcome the commonly experienced issue of sampling. Check out the homepage for a detailed list of these functionalities.
    • 
+
  • Additionally the library provides many advanced functionalities which are developed on top of the Google Analytics API, for example the possibility to overcome the commonly experienced issue of sampling. Check out the homepage for a detailed list of these functionalities.
    • 
 

 

-

-

-How much R do I need to know before getting started ?

-
Having a very basic knowledge of R is sufficient for anyone who wants to start using this library to automate access to Google Analytics data. Dartistics.com offers a very accessible R guide with special focus on R’s applications for digital analytics.

+

+
How much R do I need to know before getting started ?
+

+
Having a very basic knowledge of R is sufficient for anyone who wants to start using this library to automate access to Google Analytics data. Dartistics.com offers a very accessible R guide with special focus on R’s applications for digital analytics.

 

-

-

-What if R is not my main programming language ?

+

+
What if R is not my main programming language ?
+

 
In this case you might still find it convenient to access the Google Analytics data using the library and then continue working with the obtained dataset in a different programming language.

 

-

-

-Does knowing SQL help ?

+

+
Does knowing SQL help ?
+

 
Familiarity with the basic concepts of SQL will be useful. In many ways the process of querying the Google Analytics API via this library resembles that of querying a database.

 

-

-

-How much of the Google Analytics API functionality is covered by the library ?

-
The library is actively developed and now covers all key functionalities of the API and even most of the less commonly used ones. Check out the news section to see the progress of the library in time. Practically speaking the vast majority of tasks that one can perform via the Google Analytics UI, it’s possible to do programatically using the API and the library.

+

+
How much of the Google Analytics API functionality is covered by the library ?
+

+
The library is actively developed and now covers all key functionalities of the API and even most of the less commonly used ones. Check out the news section to see the progress of the library in time. Practically speaking the vast majority of tasks that one can perform via the Google Analytics UI, it’s possible to do programatically using the API and the library.

 

-

-

-I notice some similar functionality but for different versions of the API such as v3 and v4. Why is that ? Which API version should I prefer ?

-
As the GA API evolves over time, different versions of it become available. The library includes functions for the two latest versions, v3 and v4. All the new API features will become available only for the v4 API so becoming familiar with the v4 functions could be beneficial in this respect. (There are two basic features not available currently for version 4 which are discussed in the v4 API section)

+

+
I notice some similar functionality but for different versions of the API such as v3 and v4. Why is that ? Which API version should I prefer ?
+

+
As the GA API evolves over time, different versions of it become available. The library includes functions for the two latest versions, v3 and v4. All the new API features will become available only for the v4 API so becoming familiar with the v4 functions could be beneficial in this respect. (There are two basic features not available currently for version 4 which are discussed in the v4 API section)

 

-

-

-The documentation refers to various APIs such as the Reporting API and Management API - What’s the difference and which API should I look at first ?

-
The “GA API” is essentially is a set of distinct but related APIs such as the ones mentioned above. More information about the distinction here Depending on the nature of the request one API or another is responsible to handle it. For instance: The Management API is associated mainly with the types of actions one would normally perform on the admin section of a Google Analytics account. It can help automate account configuration and provide access to configuration data.

+

+
The documentation refers to various APIs such as the Reporting API and Management API - What’s the difference and which API should I look at first ?
+

+
The “GA API” is essentially is a set of distinct but related APIs such as the ones mentioned above. More information about the distinction here Depending on the nature of the request one API or another is responsible to handle it. For instance: The Management API is associated mainly with the types of actions one would normally perform on the admin section of a Google Analytics account. It can help automate account configuration and provide access to configuration data.

 
Practically for most users the reporting API is the one that is most commonly used as it allows access to the metrics, dimensions, segments and related data associated with the user navigation through a web property.

 

-

-

-What are some common workflows using googleAnalyticsR ?

+

+
What are some common workflows using googleAnalyticsR ?
+

 
A typical basic workflow is to use the library for easy authentication to the Google Analytics API and then use the reporting API to collect -unsampled- data from your Google Analytics account.

 
More advanced workflows (once the data is retrieved) could involve:

 
 

-

-

-Questions/Suggestions/Issues ?

+

+
Questions/Suggestions/Issues ?
+

 
    
-
  • If you wish to contribute code/documentation or if you ’d like to report a bug please read the contributing page on github
    • 
-
  • You can also ask a question on Stackoverflow using the appropriate tags and there is a good chance someone will answer it for you.
    • 
-
  • You can as well join an active slack community of users of the library, where you can post questions or suggestions or answer questions of others. See top of homepage for more info.
    • 
+
  • If you wish to contribute code/documentation or if you ’d like to report a bug please read the contributing page on github
    • 
+
  • You can also ask a question on Stackoverflow using the appropriate tags and there is a good chance someone will answer it for you.
    • 
+
  • You can as well join an active slack community of users of the library, where you can post questions or suggestions or answer questions of others. See top of homepage for more info.
    • 
 

-
For feature requests please visit the feature request guide on github

+
For feature requests please visit the feature request guide on github

 

   

 
@@ -325,11 +327,13 @@ 

 
 
       

-  
Developed by Mark Edmondson.

+  

+
Developed by Mark Edmondson.

 

 
 

-  
Site built with pkgdown 1.6.1.

+  

+
Site built with pkgdown 2.0.1.

 

 
       

@@ -338,5 +342,7 @@ 

   
 
 
+  
+
   
 
diff --git a/docs/articles/ganalytics.html b/docs/articles/ganalytics.html
index 9953e9c2..444ecf2a 100644
--- a/docs/articles/ganalytics.html
+++ b/docs/articles/ganalytics.html
@@ -23,15 +23,17 @@
 
 
 
+    
+
     

       

+      

   

     

       
ganalytics - Advanced dynamic segment and Filter examples

-                        
Johann de Boer

+                        
Johann de Boer

             
       
-      Source: vignettes/ganalytics.Rmd
+      Source: vignettes/ganalytics.Rmd
       
 
     

 
     
     
-
ganalytics provides functions that makes it easy to define filters and segments using natural R language comparison and logical operators. This example demonstrates how to define dynamic segments using functions from the ganalytics package and using those segments with the googleAnalyticsR package. You need googleAnalyticsR>=0.6.0 and ganalytics>=0.10.6.

-
More examples are available at the ganalytics README.

-

-

-Setup

+
ganalytics provides functions that makes it easy to define filters and segments using natural R language comparison and logical operators. This example demonstrates how to define dynamic segments using functions from the ganalytics package and using those segments with the googleAnalyticsR package. You need googleAnalyticsR>=0.6.0 and ganalytics>=0.10.6.

+
More examples are available at the ganalytics README.

+

+
Setup
+

 
Load the ganalytics library as well as googleAnalyticsR to make use of the new syntax.

 
-library(googleAnalyticsR)
-library(ganalytics)
+library(googleAnalyticsR)
+library(ganalytics)
 
 # authenticate
 ga_auth()
@@ -267,9 +269,9 @@ 

 # set to your view Id
 view_id <- 81416156

 

-

-

-Advanced Filter syntax

+

+
Advanced Filter syntax
+

 
In this example, we’ll define the following filters:

 
    
 
  • Device category is desktop or tablet - a dimension filter using an OR condition.
    • 
@@ -279,20 +281,20 @@ 
    
 
    The above list of filters will be defined using ganalytics expressions as follows:
    
 
     # Device category is desktop or tablet - a dimension filter using an OR condition.
-desktop_or_mobile <- Expr(~deviceCategory == "desktop") | Expr(~deviceCategory == "tablet")
+desktop_or_mobile <- Expr(~deviceCategory == "desktop") | Expr(~deviceCategory == "tablet")
 
 # New visitors using either a desktop or tablet device - a dimension filter involving both an AND and an OR condition.
-new_desktop_and_mobile_visitors <- Expr(~userType == "new") & desktop_or_mobile
+new_desktop_and_mobile_visitors <- Expr(~userType == "new") & desktop_or_mobile
 
 # At least one goal completion or transaction - a metric filter using an OR condition.
-at_least_one_conversion <- Expr(~goalCompletionsAll > 0) | Expr(~transactions > 0)
    
+at_least_one_conversion <- Expr(~goalCompletionsAll > 0) | Expr(~transactions > 0)

We can now use googleAnalyticsR to query the data with the above filters:

 results <- google_analytics(
   viewId = view_id,
-  date_range = c("30daysAgo", "yesterday"),
-  metrics = c("users", "sessions", "goalCompletionsAll"),
-  dimensions = c("deviceCategory", "userType"),
+  date_range = c("30daysAgo", "yesterday"),
+  metrics = c("users", "sessions", "goalCompletionsAll"),
+  dimensions = c("deviceCategory", "userType"),
   dim_filters = new_desktop_and_mobile_visitors,
   met_filters = at_least_one_conversion
 )
@@ -302,9 +304,9 @@ 

 #1        desktop New Visitor  2721     2726                600
 #2         tablet New Visitor    67       67                 13
-
-

-Advanced Segment Syntax

+
+

Advanced Segment Syntax +

In this example, we’ll define a list of six segments:

  • Bounced sessions: Sessions where the bounces metric is not zero.
    • @@ -313,23 +315,23 @@

The above list of dynamic segments is defined using ganalytics expressions as follows:

-bounces <- Expr(~bounces != 0)
+bounces <- Expr(~bounces != 0)
 
-mobile_or_tablet <- Expr(~deviceCategory %in% c("mobile", "tablet"))
+mobile_or_tablet <- Expr(~deviceCategory %in% c("mobile", "tablet"))
 
-multi_session_users <- Include(PerUser(Expr(~sessions > 1)), scope = "users")
+multi_session_users <- Include(PerUser(Expr(~sessions > 1)), scope = "users")
 
-my_segment_list <- list(
-    bounced_sessions = PerSession(bounces),
+my_segment_list <- list(
+    bounced_sessions = PerSession(bounces),
     mobile_or_tablet = mobile_or_tablet,
     multi_session_users = multi_session_users)
 
 results <- google_analytics(
     viewId = view_id,
-    date_range = c("30daysAgo", "yesterday"),
-    metrics = c("users", "sessions"),
-    dimensions = c("segment"),
-    segments = Segments(my_segment_list)
+    date_range = c("30daysAgo", "yesterday"),
+    metrics = c("users", "sessions"),
+    dimensions = c("segment"),
+    segments = Segments(my_segment_list)
   )
 
 results
@@ -337,24 +339,24 @@ 

 #1    bounced_sessions  3080     4070
 #2    mobile_or_tablet   631      899
 #3 multi_session_users    45      84
-
-

-More than 4 segments

+
+

More than 4 segments +

The Google Analytics Reporting API can only be used to query 4 segments at a time, so if you have more than 4 you need to break the list segments into chunks:

-segment_chunks <- split(my_segment_list, (seq_along(my_segment_list) - 1L) %/% 4L)
+segment_chunks <- split(my_segment_list, (seq_along(my_segment_list) - 1L) %/% 4L)

We can now use googleAnalyticsR to query each chunk of segments and bind the results into a single data.frame. For each segment, we will request a count of users and sessions.

-library(purrr)
-library(dplyr)
+library(purrr)
+library(dplyr)
 
-results <- map_df(segment_chunks, function(chunk) {
+results <- map_df(segment_chunks, function(chunk) {
   google_analytics(
     viewId = view_id,
-    date_range = c(start_date, end_date),
-    metrics = c("users", "sessions"),
-    dimensions = c("segment"),
-    segments = Segments(chunk)
+    date_range = c(start_date, end_date),
+    metrics = c("users", "sessions"),
+    dimensions = c("segment"),
+    segments = Segments(chunk)
   )
 })
@@ -372,11 +374,13 @@

-

Developed by Mark Edmondson.

+

+

Developed by Mark Edmondson.

-

Site built with pkgdown 1.6.1.

+

+

Site built with pkgdown 2.0.1.

@@ -385,5 +389,7 @@

+ + diff --git a/docs/articles/index.html b/docs/articles/index.html index d3ca462a..efee3f3f 100644 --- a/docs/articles/index.html +++ b/docs/articles/index.html @@ -1,84 +1,18 @@ - - - - - - - -Articles • googleAnalyticsR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Articles • googleAnalyticsR - - - - - - - - + gtag('config', 'G-43MDXK6CLZ'); + + -
-
- -
- -
+

Articles

@@ -292,59 +211,55 @@

Articles

All vignettes

-
-
Big Query Exports from Google Analytics 360 to R
-
-
FAQs
-
-
ganalytics - Advanced dynamic segment and Filter examples
-
-
Management API
-
-
Measurement Protocol v2
-
-
Automatic Shiny apps with Google Analytics data
-
-
Statistical models and visualisations with Google Analytics data
-
-
Practical Tips
-
-
Data API for Google Analytics 4 (App+Web)
-
-
RMarkdown reports with Google Analytics API data
-
-
Setting up Google Analytics API downloads to R
-
-
Shiny Apps that call Google Analytics API data
-
-
User Activity API
-
-
Google Analytics Reporting API v3 R functions
-
-
Google Analytics Reporting API v4 in R Examples
-
-
-
+
Big Query Exports from Google Analytics 360 to R
+
+
FAQs
+
+
ganalytics - Advanced dynamic segment and Filter examples
+
+
Management API
+
+
Measurement Protocol v2
+
+
Automatic Shiny apps with Google Analytics data
+
+
Statistical models and visualisations with Google Analytics data
+
+
Practical Tips
+
+
Data API for Google Analytics 4 (App+Web)
+
+
RMarkdown reports with Google Analytics API data
+
+
Setting up Google Analytics API downloads to R
+
+
Shiny Apps that call Google Analytics API data
+
+
User Activity API
+
+
Google Analytics Reporting API v3 R functions
+
+
Google Analytics Reporting API v4 in R Examples
+
+
-
-
-

Developed by Mark Edmondson.

+
+

Developed by Mark Edmondson.

-

Site built with pkgdown 1.6.1.

+

Site built with pkgdown 2.0.1.

-
-
+
- - + + diff --git a/docs/articles/management.html b/docs/articles/management.html index 0a1472fd..5455d446 100644 --- a/docs/articles/management.html +++ b/docs/articles/management.html @@ -23,15 +23,17 @@ + +
+

Management API

- Source: vignettes/management.Rmd + Source: vignettes/management.Rmd
@@ -251,9 +253,9 @@

Management API

The Management API v3 covers all API calls that are not data reporting related and are for getting meta information about your Google Analytics account or to change account settings.

-
-

-Account structure

+
+

Account structure +

Shows the details for your account structure (Accounts > Web-properties > Views (profiles)) including creation time, user permissions etc.

The most day-to-day useful function is ga_account_list() which summarises all account web properties and views available to your user.

    @@ -274,193 +276,193 @@ 

     # ga_account_list is most commonly used
 # (restricted to top 10 with the head() function)
-head(ga_account_list(), n = 10)
    -
    ## # A tibble: 10 x 11
-##    accountId accountName internalWebProp… level websiteUrl type  starred
-##    <chr>     <chr>       <chr>            <chr> <chr>      <chr> <lgl>  
-##  1 79301104  cloudyr     118427305        STAN… http://cl… WEB   NA     
-##  2 54516992  Demo Accou… 87479473         STAN… https://s… WEB   NA     
-##  3 54516992  Demo Accou… 87479473         STAN… https://s… WEB   NA     
-##  4 54516992  Demo Accou… 87479473         STAN… https://s… WEB   NA     
-##  5 47480439  MarkEdmond… 78737968         STAN… http://ma… WEB   NA     
-##  6 47480439  MarkEdmond… 78742336         STAN… http://ma… WEB   NA     
-##  7 54019251  Sunholo We… 86845257         STAN… https://g… WEB   NA     
-##  8 54019251  Sunholo We… 86845257         STAN… https://g… WEB   NA     
-##  9 54019251  Sunholo We… 94325478         PREM… http://ma… WEB   NA     
-## 10 54019251  Sunholo We… 94325478         PREM… http://ma… WEB   TRUE   
-## # … with 4 more variables: webPropertyId <chr>, webPropertyName <chr>, viewId <chr>,
-## #   viewName <chr>
    +head(ga_account_list(), n = 10)

+
## # A tibble: 10 x 11
+##    accountId accountName internalWebProp… level websiteUrl type  starred
+##    <chr>     <chr>       <chr>            <chr> <chr>      <chr> <lgl>  
+##  1 79301104  cloudyr     118427305        STAN… http://cl… WEB   NA     
+##  2 54516992  Demo Accou… 87479473         STAN… https://s… WEB   NA     
+##  3 54516992  Demo Accou… 87479473         STAN… https://s… WEB   NA     
+##  4 54516992  Demo Accou… 87479473         STAN… https://s… WEB   NA     
+##  5 47480439  MarkEdmond… 78737968         STAN… http://ma… WEB   NA     
+##  6 47480439  MarkEdmond… 78742336         STAN… http://ma… WEB   NA     
+##  7 54019251  Sunholo We… 86845257         STAN… https://g… WEB   NA     
+##  8 54019251  Sunholo We… 86845257         STAN… https://g… WEB   NA     
+##  9 54019251  Sunholo We… 94325478         PREM… http://ma… WEB   NA     
+## 10 54019251  Sunholo We… 94325478         PREM… http://ma… WEB   TRUE   
+## # … with 4 more variables: webPropertyId <chr>, webPropertyName <chr>, viewId <chr>,
+## #   viewName <chr>
 # this only lists account meta-data
 ga_accounts()
-
##         id             name             created             updated
-## 1 47480439    MarkEdmondson 2014-01-25 12:17:05 2019-06-01 08:09:58
-## 2 54019251 Sunholo Websites 2014-08-20 19:17:05 2019-07-31 18:51:55
-## 3 54516992     Demo Account 2014-09-06 17:53:33 2019-06-10 17:56:03
-## 4 79301104          cloudyr 2016-06-14 14:29:50 2016-06-14 14:29:50
-##                            permissions.effective
-## 1 COLLABORATE,EDIT,MANAGE_USERS,READ_AND_ANALYZE
-## 2 COLLABORATE,EDIT,MANAGE_USERS,READ_AND_ANALYZE
-## 3                               READ_AND_ANALYZE
-## 4
+
##         id             name             created             updated
+## 1 47480439    MarkEdmondson 2014-01-25 12:17:05 2019-06-01 08:09:58
+## 2 54019251 Sunholo Websites 2014-08-20 19:17:05 2019-07-31 18:51:55
+## 3 54516992     Demo Account 2014-09-06 17:53:33 2019-06-10 17:56:03
+## 4 79301104          cloudyr 2016-06-14 14:29:50 2016-06-14 14:29:50
+##                            permissions.effective
+## 1 COLLABORATE,EDIT,MANAGE_USERS,READ_AND_ANALYZE
+## 2 COLLABORATE,EDIT,MANAGE_USERS,READ_AND_ANALYZE
+## 3                               READ_AND_ANALYZE
+## 4
 # this gives meta-data for all web-properties for this accountId
 ga_webproperty_list(47480439)
-
##              id accountId internalWebPropertyId                name
-## 1 UA-47480439-1  47480439              78742336    markedmondson.me
-## 2 UA-47480439-2  47480439              78737968 MarkEdmondson oldGA
-##                websiteUrl    level profileCount    industryVertical dataRetentionTtl
-## 1 http://markedmondson.me STANDARD            1 HOBBIES_AND_LEISURE        MONTHS_26
-## 2 http://markedmondson.me STANDARD            1 HOBBIES_AND_LEISURE       INDEFINITE
-##   dataRetentionResetOnNewActivity             created             updated
-## 1                            TRUE 2014-01-25 12:17:05 2014-01-25 12:17:06
-## 2                            TRUE 2014-01-25 12:19:20 2018-04-12 11:37:38
-##   defaultProfileId                          permissions.effective
-## 1             <NA> COLLABORATE,EDIT,MANAGE_USERS,READ_AND_ANALYZE
-## 2         81416156 COLLABORATE,EDIT,MANAGE_USERS,READ_AND_ANALYZE
+
##              id accountId internalWebPropertyId                name
+## 1 UA-47480439-1  47480439              78742336    markedmondson.me
+## 2 UA-47480439-2  47480439              78737968 MarkEdmondson oldGA
+##                websiteUrl    level profileCount    industryVertical dataRetentionTtl
+## 1 http://markedmondson.me STANDARD            1 HOBBIES_AND_LEISURE        MONTHS_26
+## 2 http://markedmondson.me STANDARD            1 HOBBIES_AND_LEISURE       INDEFINITE
+##   dataRetentionResetOnNewActivity             created             updated
+## 1                            TRUE 2014-01-25 12:17:05 2014-01-25 12:17:06
+## 2                            TRUE 2014-01-25 12:19:20 2018-04-12 11:37:38
+##   defaultProfileId                          permissions.effective
+## 1             <NA> COLLABORATE,EDIT,MANAGE_USERS,READ_AND_ANALYZE
+## 2         81416156 COLLABORATE,EDIT,MANAGE_USERS,READ_AND_ANALYZE
 # this is meta-data for one particular web-property
 ga_webproperty(accountId = 47480439, webPropertyId = "UA-47480439-1")
-
## $id
-## [1] "UA-47480439-1"
-## 
-## $kind
-## [1] "analytics#webproperty"
-## 
-## $selfLink
-## [1] "https://www.googleapis.com/analytics/v3/management/accounts/47480439/webproperties/UA-47480439-1"
-## 
-## $accountId
-## [1] "47480439"
-## 
-## $internalWebPropertyId
-## [1] "78742336"
-## 
-## $name
-## [1] "markedmondson.me"
-## 
-## $websiteUrl
-## [1] "http://markedmondson.me"
-## 
-## $level
-## [1] "STANDARD"
-## 
-## $profileCount
-## [1] 1
-## 
-## $industryVertical
-## [1] "HOBBIES_AND_LEISURE"
-## 
-## $dataRetentionTtl
-## [1] "MONTHS_26"
-## 
-## $dataRetentionResetOnNewActivity
-## [1] TRUE
-## 
-## $permissions
-## $permissions$effective
-## [1] "COLLABORATE"      "EDIT"             "MANAGE_USERS"     "READ_AND_ANALYZE"
-## 
-## 
-## $created
-## [1] "2014-01-25T12:17:05.492Z"
-## 
-## $updated
-## [1] "2014-01-25T12:17:06.625Z"
-## 
-## $parentLink
-## $parentLink$type
-## [1] "analytics#account"
-## 
-## $parentLink$href
-## [1] "https://www.googleapis.com/analytics/v3/management/accounts/47480439"
-## 
-## 
-## $childLink
-## $childLink$type
-## [1] "analytics#profiles"
-## 
-## $childLink$href
-## [1] "https://www.googleapis.com/analytics/v3/management/accounts/47480439/webproperties/UA-47480439-1/profiles"
+
## $id
+## [1] "UA-47480439-1"
+## 
+## $kind
+## [1] "analytics#webproperty"
+## 
+## $selfLink
+## [1] "https://www.googleapis.com/analytics/v3/management/accounts/47480439/webproperties/UA-47480439-1"
+## 
+## $accountId
+## [1] "47480439"
+## 
+## $internalWebPropertyId
+## [1] "78742336"
+## 
+## $name
+## [1] "markedmondson.me"
+## 
+## $websiteUrl
+## [1] "http://markedmondson.me"
+## 
+## $level
+## [1] "STANDARD"
+## 
+## $profileCount
+## [1] 1
+## 
+## $industryVertical
+## [1] "HOBBIES_AND_LEISURE"
+## 
+## $dataRetentionTtl
+## [1] "MONTHS_26"
+## 
+## $dataRetentionResetOnNewActivity
+## [1] TRUE
+## 
+## $permissions
+## $permissions$effective
+## [1] "COLLABORATE"      "EDIT"             "MANAGE_USERS"     "READ_AND_ANALYZE"
+## 
+## 
+## $created
+## [1] "2014-01-25T12:17:05.492Z"
+## 
+## $updated
+## [1] "2014-01-25T12:17:06.625Z"
+## 
+## $parentLink
+## $parentLink$type
+## [1] "analytics#account"
+## 
+## $parentLink$href
+## [1] "https://www.googleapis.com/analytics/v3/management/accounts/47480439"
+## 
+## 
+## $childLink
+## $childLink$type
+## [1] "analytics#profiles"
+## 
+## $childLink$href
+## [1] "https://www.googleapis.com/analytics/v3/management/accounts/47480439/webproperties/UA-47480439-1/profiles"
 # this is meta-data for the views under this accountId/webPropertyId
 ga_view_list(accountId = 47480439, webPropertyId = "UA-47480439-1")
-
##         id accountId webPropertyId internalWebPropertyId              name currency
-## 1 81416941  47480439 UA-47480439-1              78742336 All Web Site Data      USD
-##            timezone              websiteUrl type             created
-## 1 Europe/Copenhagen http://markedmondson.me  WEB 2014-01-25 12:17:05
-##               updated eCommerceTracking
-## 1 2015-06-14 13:18:53             FALSE
-##                            permissions.effective
-## 1 COLLABORATE,EDIT,MANAGE_USERS,READ_AND_ANALYZE
+
##         id accountId webPropertyId internalWebPropertyId              name currency
+## 1 81416941  47480439 UA-47480439-1              78742336 All Web Site Data      USD
+##            timezone              websiteUrl type             created
+## 1 Europe/Copenhagen http://markedmondson.me  WEB 2014-01-25 12:17:05
+##               updated eCommerceTracking
+## 1 2015-06-14 13:18:53             FALSE
+##                            permissions.effective
+## 1 COLLABORATE,EDIT,MANAGE_USERS,READ_AND_ANALYZE
 # this is meta-data for this particular viewId (profileId)
 ga_view(accountId = 47480439, webPropertyId = "UA-47480439-1", profileId = 81416941)
-
## $id
-## [1] "81416941"
-## 
-## $kind
-## [1] "analytics#profile"
-## 
-## $selfLink
-## [1] "https://www.googleapis.com/analytics/v3/management/accounts/47480439/webproperties/UA-47480439-1/profiles/81416941"
-## 
-## $accountId
-## [1] "47480439"
-## 
-## $webPropertyId
-## [1] "UA-47480439-1"
-## 
-## $internalWebPropertyId
-## [1] "78742336"
-## 
-## $name
-## [1] "All Web Site Data"
-## 
-## $currency
-## [1] "USD"
-## 
-## $timezone
-## [1] "Europe/Copenhagen"
-## 
-## $websiteUrl
-## [1] "http://markedmondson.me"
-## 
-## $type
-## [1] "WEB"
-## 
-## $permissions
-## $permissions$effective
-## [1] "COLLABORATE"      "EDIT"             "MANAGE_USERS"     "READ_AND_ANALYZE"
-## 
-## 
-## $created
-## [1] "2014-01-25T12:17:05.492Z"
-## 
-## $updated
-## [1] "2015-06-14T13:18:53.638Z"
-## 
-## $eCommerceTracking
-## [1] FALSE
-## 
-## $parentLink
-## $parentLink$type
-## [1] "analytics#webproperty"
-## 
-## $parentLink$href
-## [1] "https://www.googleapis.com/analytics/v3/management/accounts/47480439/webproperties/UA-47480439-1"
-## 
-## 
-## $childLink
-## $childLink$type
-## [1] "analytics#goals"
-## 
-## $childLink$href
-## [1] "https://www.googleapis.com/analytics/v3/management/accounts/47480439/webproperties/UA-47480439-1/profiles/81416941/goals"
+
## $id
+## [1] "81416941"
+## 
+## $kind
+## [1] "analytics#profile"
+## 
+## $selfLink
+## [1] "https://www.googleapis.com/analytics/v3/management/accounts/47480439/webproperties/UA-47480439-1/profiles/81416941"
+## 
+## $accountId
+## [1] "47480439"
+## 
+## $webPropertyId
+## [1] "UA-47480439-1"
+## 
+## $internalWebPropertyId
+## [1] "78742336"
+## 
+## $name
+## [1] "All Web Site Data"
+## 
+## $currency
+## [1] "USD"
+## 
+## $timezone
+## [1] "Europe/Copenhagen"
+## 
+## $websiteUrl
+## [1] "http://markedmondson.me"
+## 
+## $type
+## [1] "WEB"
+## 
+## $permissions
+## $permissions$effective
+## [1] "COLLABORATE"      "EDIT"             "MANAGE_USERS"     "READ_AND_ANALYZE"
+## 
+## 
+## $created
+## [1] "2014-01-25T12:17:05.492Z"
+## 
+## $updated
+## [1] "2015-06-14T13:18:53.638Z"
+## 
+## $eCommerceTracking
+## [1] FALSE
+## 
+## $parentLink
+## $parentLink$type
+## [1] "analytics#webproperty"
+## 
+## $parentLink$href
+## [1] "https://www.googleapis.com/analytics/v3/management/accounts/47480439/webproperties/UA-47480439-1"
+## 
+## 
+## $childLink
+## $childLink$type
+## [1] "analytics#goals"
+## 
+## $childLink$href
+## [1] "https://www.googleapis.com/analytics/v3/management/accounts/47480439/webproperties/UA-47480439-1/profiles/81416941/goals"
-
-

-Helper functions

+
+

Helper functions +

These are helper utility functions to work with Google Analytics data.

  • @@ -469,24 +471,24 @@ 

     # you can just use `meta` as is to get the available metrics,
 # here we just return the first 5 columns and rows for brevity
-head(meta[,1:5])
    -
    ##                      name      type dataType group     status
-## 1             ga:userType DIMENSION   STRING  User     PUBLIC
-## 2          ga:visitorType DIMENSION   STRING  User DEPRECATED
-## 3         ga:sessionCount DIMENSION   STRING  User     PUBLIC
-## 4           ga:visitCount DIMENSION   STRING  User DEPRECATED
-## 5 ga:daysSinceLastSession DIMENSION   STRING  User     PUBLIC
-## 6     ga:userDefinedValue DIMENSION   STRING  User     PUBLIC
    +head(meta[,1:5])

+
##                      name      type dataType group     status
+## 1             ga:userType DIMENSION   STRING  User     PUBLIC
+## 2          ga:visitorType DIMENSION   STRING  User DEPRECATED
+## 3         ga:sessionCount DIMENSION   STRING  User     PUBLIC
+## 4           ga:visitCount DIMENSION   STRING  User DEPRECATED
+## 5 ga:daysSinceLastSession DIMENSION   STRING  User     PUBLIC
+## 6     ga:userDefinedValue DIMENSION   STRING  User     PUBLIC
 # or ensure an up to date version by calling the metadata API.
-head(ga_meta())[,1:5]
-
##                      name      type dataType group     status
-## 1             ga:userType DIMENSION   STRING  User     PUBLIC
-## 2          ga:visitorType DIMENSION   STRING  User DEPRECATED
-## 3         ga:sessionCount DIMENSION   STRING  User     PUBLIC
-## 4           ga:visitCount DIMENSION   STRING  User DEPRECATED
-## 5 ga:daysSinceLastSession DIMENSION   STRING  User     PUBLIC
-## 6     ga:userDefinedValue DIMENSION   STRING  User     PUBLIC
+head(ga_meta())[,1:5]
+
##                      name      type dataType group     status
+## 1             ga:userType DIMENSION   STRING  User     PUBLIC
+## 2          ga:visitorType DIMENSION   STRING  User DEPRECATED
+## 3         ga:sessionCount DIMENSION   STRING  User     PUBLIC
+## 4           ga:visitCount DIMENSION   STRING  User DEPRECATED
+## 5 ga:daysSinceLastSession DIMENSION   STRING  User     PUBLIC
+## 6     ga:userDefinedValue DIMENSION   STRING  User     PUBLIC
  • ga_aggregate - aggregate data down to the dimensions you specify, treating metrics correctly regarding if they should be averaged or summed. This is used internally when using anti-sampling, and is also useful to respond to dimension selections in Shiny dashboards, where you don’t want to perform a new API call each time you need aggregated data. Download all data first in a more unaggregated form, then use this function.
    • @@ -494,67 +496,67 @@ 

     # use `aggregateGAData` so you can on the fly create summary data
 ga_data <- google_analytics(81416156, 
-                            date_range = c("10daysAgo", "yesterday"),
-                            metrics = c("sessions","bounceRate"), dimensions = c("hour","date"))
    -
    ## [36mℹ[39m 2020-05-26 11:40:05 > Downloaded [ 240 ] rows from a total of [ 240 ].
    + date_range = c("10daysAgo", "yesterday"), + metrics = c("sessions","bounceRate"), dimensions = c("hour","date"))

+
## [36mℹ[39m 2020-05-26 11:40:05 > Downloaded [ 240 ] rows from a total of [ 240 ].
-head(ga_data)
-
##   hour       date sessions bounceRate
-## 1   00 2020-05-16       10   60.00000
-## 2   00 2020-05-17        8   37.50000
-## 3   00 2020-05-18        9   44.44444
-## 4   00 2020-05-19        8   50.00000
-## 5   00 2020-05-20       11   63.63636
-## 6   00 2020-05-21        8   50.00000
+head(ga_data)
+
##   hour       date sessions bounceRate
+## 1   00 2020-05-16       10   60.00000
+## 2   00 2020-05-17        8   37.50000
+## 3   00 2020-05-18        9   44.44444
+## 4   00 2020-05-19        8   50.00000
+## 5   00 2020-05-20       11   63.63636
+## 6   00 2020-05-21        8   50.00000
 # if we want totals per hour over the dates:
-ga_aggregate(ga_data[,c("hour","sessions")], agg_names = "hour")
-
## # A tibble: 24 x 2
-##    hour  sessions
-##    <chr>    <dbl>
-##  1 00          92
-##  2 01          64
-##  3 02          58
-##  4 03          64
-##  5 04          70
-##  6 05          74
-##  7 06          59
-##  8 07          66
-##  9 08          82
-## 10 09          89
-## # … with 14 more rows
+ga_aggregate(ga_data[,c("hour","sessions")], agg_names = "hour")
+
## # A tibble: 24 x 2
+##    hour  sessions
+##    <chr>    <dbl>
+##  1 00          92
+##  2 01          64
+##  3 02          58
+##  4 03          64
+##  5 04          70
+##  6 05          74
+##  7 06          59
+##  8 07          66
+##  9 08          82
+## 10 09          89
+## # … with 14 more rows
 # it knows not to sum metrics that are rates:
-ga_aggregate(ga_data[,c("hour","bounceRate")], agg_names = "hour")
-
## # A tibble: 24 x 2
-##    hour  bounceRate
-##    <chr>      <dbl>
-##  1 00          53.4
-##  2 01          65.1
-##  3 02          69.3
-##  4 03          60.5
-##  5 04          65.4
-##  6 05          79.9
-##  7 06          78.8
-##  8 07          66.1
-##  9 08          75.4
-## 10 09          66.3
-## # … with 14 more rows
+ga_aggregate(ga_data[,c("hour","bounceRate")], agg_names = "hour")
+
## # A tibble: 24 x 2
+##    hour  bounceRate
+##    <chr>      <dbl>
+##  1 00          53.4
+##  2 01          65.1
+##  3 02          69.3
+##  4 03          60.5
+##  5 04          65.4
+##  6 05          79.9
+##  7 06          78.8
+##  8 07          66.1
+##  9 08          75.4
+## 10 09          66.3
+## # … with 14 more rows
  • ga_allowed_metric_dim() - Create named list of allowed GA metrics/dimensions. This is useful to have nice looking labels for dimension and metric selection pickers, or to create lookup tables.
 amd <- ga_allowed_metric_dim()
-head(amd)
-
##                   Users               New Users          % New Sessions 
-##              "ga:users"           "ga:newUsers" "ga:percentNewSessions" 
-##      1 Day Active Users      7 Day Active Users     14 Day Active Users 
-##          "ga:1dayUsers"          "ga:7dayUsers"         "ga:14dayUsers"
+head(amd)

+
##                   Users               New Users          % New Sessions 
+##              "ga:users"           "ga:newUsers" "ga:percentNewSessions" 
+##      1 Day Active Users      7 Day Active Users     14 Day Active Users 
+##          "ga:1dayUsers"          "ga:7dayUsers"         "ga:14dayUsers"
-
-

-User management

+
+

User management +

-

User management follows the recommended workflows outlined in this Google reference article.

+

User management follows the recommended workflows outlined in this Google reference article.

The ga_users_* functions use the management APIs batching endpoint, to take advantage of the special increased quota limits when dealing with User management that API offers. For example, every 30 API calls that are batched that deal with user management only increments one API call against your management API quota. You can have 300 API calls in one batch (e.g. that costs 10 API calls against the quota), and googleAnalyticsR will split any list of emails into 300 emails per batch for you, so you can send in all emails you have.

By default, each Google Cloud Project gets 50 write requests per project per day, which if using batching means 1500 write/delete/update user operations per day.

-

You will need to use your own Google Cloud Platform project if using any write API operations seriously, otherwise you will be at the mercy of the shared googleAnalyticsR’s quota limits. See the section in the Setup page on how to setup using your own Google Project

+

You will need to use your own Google Cloud Platform project if using any write API operations seriously, otherwise you will be at the mercy of the shared googleAnalyticsR’s quota limits. See the section in the Setup page on how to setup using your own Google Project

To see which users are attached, use ga_users_list(). Each user email is referenced under the userRef.email column, whereas the unique IDs used to see which user is linked to where is the linkId which is unique to each user and link to your account, web property or view/profile.

Users can be attached at various levels in the hierarchy so you can call the function at various viewing angles.

@@ -588,7 +590,7 @@

Users can be attached at account, web-property and view level.

Batching is incorporated for adding users, so you can pass in a vector of emails to add.

-ga_users_add(c("the_email@company.com", "another_email@company.com"), 
+ga_users_add(c("the_email@company.com", "another_email@company.com"), 
              permissions = "EDIT", accountId = 47480439)

To delete a user from all accounts, web-properties and views takes a few API calls to ga_users_list() to find all the possible links, which is done behind the scenes of ga_users_delete(). You can pass the function multiple emails to delete many at once, which is done via batching:

@@ -597,7 +599,7 @@ 

 ga_users_delete("the_email@company.com", 47480439)
 
 # delete many emails at once
-ga_users_delete(c("the_email@company.com", "another_email@company.com"), accountId = 47480439)
+ga_users_delete(c("the_email@company.com", "another_email@company.com"), accountId = 47480439)

For more fine grained control, the below examples shows a workflow to list and delete user access for one user at View level using the linkId.

 # get the linkId for the user you want to delete
@@ -613,7 +615,7 @@ 

 
You can also modify existing users via ga_users_update() - the below modifies on the web property level:

 
 # the update to perform
-o <- list(permissions = list(local = list("EDIT")))
+o <- list(permissions = list(local = list("EDIT")))
 
 ga_users_update("UA-123456-1:1111222233334444",
                 update_object = o,
@@ -621,9 +623,9 @@ 

                 webPropertyId = "UA-123456-1")

 
When using linkIds, make sure to use the correct linkId for the level of account, web-property or view you are operating on - the linkId starts with the accountId, UA code of web property, or ViewId number to distinguish between the various types.
-
-

-Custom variables

+
+

Custom variables +

Custom variable management for a Google Analytics property.

-

Using these you can scale setting up custom dimensions across your Google Analytics web properties. Custom dimension updates are governed by the same rules as when you create them in the web interface, as this Google article on custom dimensions and metrics explains.

+

Using these you can scale setting up custom dimensions across your Google Analytics web properties. Custom dimension updates are governed by the same rules as when you create them in the web interface, as this Google article on custom dimensions and metrics explains.

You can’t delete custom dimensions, you can only de-activate them for reuse later on.

A workflow is shown below that creates, then updates a custom variable to a new name.

@@ -661,9 +663,9 @@ 

 # view custom dimensions again to see change
 ga_custom_vars_list(54019251, webPropertyId = "UA-54019251-4", type = "customDimensions")
-
-

-AdWords

+
+

AdWords +

  • ga_adwords() Get Google Analytics - AdWords Link meta data
    • @@ -695,9 +697,9 @@

    #check that the link has been removed ga_adwords_list(accountId = 65973592, webPropertyId = "UA-65973592-1")

-
-

-Custom Data Sources

+
+

Custom Data Sources +

See and upload custom data sources to Google Analytics

-
-

-Experiments

+
+

Experiments +

-
-

-View Filters

+
+

View Filters +

The filter edit functions are contributed by @zselinger which allow you to update filters for your Google Analytics views at scale.

-
-

-Goals

+
+

Goals +

-
-

-Example: Copying GA goals

+
+

Example: Copying GA goals +

We can programatically copy goal configurations from any GA view (the source) to another GA view (the destination) within an entirely separate property. This can be helpful to maintain standardised goal configurations for multiple properties, and also for GA migrations.

-

This example will first copy a single goal from one property to another, then use the map() function from purrr to copy multiple goals at once.

-

We use the Google Analytics demo account as the source view for this example - you can read more about the demo account here.

+

This example will first copy a single goal from one property to another, then use the map() function from purrr to copy multiple goals at once.

+

We use the Google Analytics demo account as the source view for this example - you can read more about the demo account here.

-
-

-Auth and setup

-

We authenticate and load the necessary packages, following the instructions from the documentation.

+
+

Auth and setup +

+

We authenticate and load the necessary packages, following the instructions from the documentation.

-
## Error in library(rlist): there is no package called 'rlist'
+library(tidyverse) +library(stringr) +library(rlist)
+
## Error in library(rlist): there is no package called 'rlist'
-
-

-Copying a single goal

+
+

Copying a single goal +

For this first section, we copy a single Goal from one view to another. To achieve this, we will:

  1. Retrieve the accountId, webPropertyId and viewId from our source GA view (the one where our goal to be copied over currently exists).
    2. @@ -787,95 +789,95 @@

  2. Get the configuration details of a single goal to be copied.
  3. Submit the goal details to our destination property.

-
-

-1. Retrieve the accountId, webPropertyId and viewId from our source GA view

-

We use the ga_account_list() function, which returns an account summary for all available accounts as a dataframe. Then, we filter the dataframe down to a specific account and view name using the filter() and str_detect() functions from the tidyverse.

+
+

1. Retrieve the accountId, webPropertyId and viewId from our source GA view +

+

We use the ga_account_list() function, which returns an account summary for all available accounts as a dataframe. Then, we filter the dataframe down to a specific account and view name using the filter() and str_detect() functions from the tidyverse.

You can supply your own filter conditions as necessary, to locate your desired view information.

 # Account info and list of goals for source, to be copied
-source_account <- ga_account_list() %>% 
-  filter(str_detect(accountName, "Demo Account"), str_detect(viewName, "Master"))
+source_account <- ga_account_list() %>% 
+  filter(str_detect(accountName, "Demo Account"), str_detect(viewName, "Master"))
 source_account
-
## # A tibble: 1 x 11
-##   accountId accountName internalWebProp… level websiteUrl type  starred webPropertyId
-##   <chr>     <chr>       <chr>            <chr> <chr>      <chr> <lgl>   <chr>        
-## 1 54516992  Demo Accou… 87479473         STAN… https://s… WEB   NA      UA-54516992-1
-## # … with 3 more variables: webPropertyName <chr>, viewId <chr>, viewName <chr>
+
## # A tibble: 1 x 11
+##   accountId accountName internalWebProp… level websiteUrl type  starred webPropertyId
+##   <chr>     <chr>       <chr>            <chr> <chr>      <chr> <lgl>   <chr>        
+## 1 54516992  Demo Accou… 87479473         STAN… https://s… WEB   NA      UA-54516992-1
+## # … with 3 more variables: webPropertyName <chr>, viewId <chr>, viewName <chr>
-
-

-2. Get a list of the goals currently configured from our source GA view

+
+

2. Get a list of the goals currently configured from our source GA view +

Now that we have the account summary, we can use the view details to get a list of goal data, with each item in the list showing goal details.

 source_goals <- ga_goal_list(source_account$accountId, source_account$webPropertyId, source_account$viewId)
 source_goals
-
##   id accountId webPropertyId internalWebPropertyId profileId               name
-## 1  1  54516992 UA-54516992-1              87479473  92320289 Purchase Completed
-## 2  2  54516992 UA-54516992-1              87479473  92320289      Engaged Users
-## 3  3  54516992 UA-54516992-1              87479473  92320289      Registrations
-## 4  4  54516992 UA-54516992-1              87479473  92320289   Entered Checkout
-##   value active            type             created             updated
-## 1     0   TRUE URL_DESTINATION 2014-10-10 20:13:47 2016-11-10 23:07:35
-## 2     0   TRUE VISIT_NUM_PAGES 2015-02-23 16:18:06 2015-04-14 12:02:21
-## 3     0   TRUE URL_DESTINATION 2015-02-27 12:15:01 2016-07-26 16:14:09
-## 4     0   TRUE URL_DESTINATION 2015-07-20 23:57:22 2016-07-26 16:19:40
-##                                 urlDestinationDetails.url
-## 1                                  /ordercompleted\\.html
-## 2                                                    <NA>
-## 3                                 /registersuccess\\.html
-## 4 /yourinfo\\.html|/guestregister\\.html|/shipping\\.html
-##   urlDestinationDetails.caseSensitive urlDestinationDetails.matchType
-## 1                               FALSE                           REGEX
-## 2                                  NA                            <NA>
-## 3                               FALSE                           REGEX
-## 4                               FALSE                           REGEX
-##   urlDestinationDetails.firstStepRequired
-## 1                                    TRUE
-## 2                                      NA
-## 3                                   FALSE
-## 4                                   FALSE
-##                                                                                                                            urlDestinationDetails.steps
-## 1 1:4,c("Cart", "Billing and Shipping", "Payment", "Review"),c("/basket\\\\.html", "/yourinfo\\\\.html", "/payment\\\\.html", "/revieworder\\\\.html")
-## 2                                                                                                                                                     
-## 3                                                                                                                                                     
-## 4                                                                                                                                                     
-##   visitNumPagesDetails.comparisonType visitNumPagesDetails.comparisonValue
-## 1                                <NA>                                 <NA>
-## 2                        GREATER_THAN                                   10
-## 3                                <NA>                                 <NA>
-## 4                                <NA>                                 <NA>
+
##   id accountId webPropertyId internalWebPropertyId profileId               name
+## 1  1  54516992 UA-54516992-1              87479473  92320289 Purchase Completed
+## 2  2  54516992 UA-54516992-1              87479473  92320289      Engaged Users
+## 3  3  54516992 UA-54516992-1              87479473  92320289      Registrations
+## 4  4  54516992 UA-54516992-1              87479473  92320289   Entered Checkout
+##   value active            type             created             updated
+## 1     0   TRUE URL_DESTINATION 2014-10-10 20:13:47 2016-11-10 23:07:35
+## 2     0   TRUE VISIT_NUM_PAGES 2015-02-23 16:18:06 2015-04-14 12:02:21
+## 3     0   TRUE URL_DESTINATION 2015-02-27 12:15:01 2016-07-26 16:14:09
+## 4     0   TRUE URL_DESTINATION 2015-07-20 23:57:22 2016-07-26 16:19:40
+##                                 urlDestinationDetails.url
+## 1                                  /ordercompleted\\.html
+## 2                                                    <NA>
+## 3                                 /registersuccess\\.html
+## 4 /yourinfo\\.html|/guestregister\\.html|/shipping\\.html
+##   urlDestinationDetails.caseSensitive urlDestinationDetails.matchType
+## 1                               FALSE                           REGEX
+## 2                                  NA                            <NA>
+## 3                               FALSE                           REGEX
+## 4                               FALSE                           REGEX
+##   urlDestinationDetails.firstStepRequired
+## 1                                    TRUE
+## 2                                      NA
+## 3                                   FALSE
+## 4                                   FALSE
+##                                                                                                                            urlDestinationDetails.steps
+## 1 1:4,c("Cart", "Billing and Shipping", "Payment", "Review"),c("/basket\\\\.html", "/yourinfo\\\\.html", "/payment\\\\.html", "/revieworder\\\\.html")
+## 2                                                                                                                                                     
+## 3                                                                                                                                                     
+## 4                                                                                                                                                     
+##   visitNumPagesDetails.comparisonType visitNumPagesDetails.comparisonValue
+## 1                                <NA>                                 <NA>
+## 2                        GREATER_THAN                                   10
+## 3                                <NA>                                 <NA>
+## 4                                <NA>                                 <NA>
-
-

-3. Retrieve the accountId, webPropertyId and viewId from our destination GA view

+
+

3. Retrieve the accountId, webPropertyId and viewId from our destination GA view +

We again filter the results from ga_account_list(), to get account information for our destination GA property. In this example, we filter for “Your_Account” and the view called “Filtered”.

The dest_account dataframe should contain the same columns and data types as your source_account dataframe.

 # Account info for destination account
-dest_account <- ga_account_list() %>% 
-  filter(str_detect(accountName, "Your_Account"), str_detect(viewName, "Filtered"))
+dest_account <- ga_account_list() %>% + filter(str_detect(accountName, "Your_Account"), str_detect(viewName, "Filtered"))
-
-

-4. Get the configuration details of a single goal to be copied.

-

For this first example, we add a single goal (ID 1) to the destination view, passed as a list to the ga_goal_add() function.

+
+

4. Get the configuration details of a single goal to be copied. +

+

For this first example, we add a single goal (ID 1) to the destination view, passed as a list to the ga_goal_add() function.

We now use the ga_goal() function to retrieve the goal specifications as a list. We use ga_goal() because it provides the goal configuration data in the necessary format for our goal_add() request.

In the example below, we retrieve the details for the goal in slot 1.

 # Get goal ID 1
 goal_one <- ga_goal(source_account$accountId, source_account$webPropertyId, source_account$viewId, 
-                    goalId = 1) %>% 
+                    goalId = 1) %>% 
   # Strip out instance-specific metadata (property, profile, view data and original creation dates)
-  list.remove( c("accountId", "webPropertyId", "selfLink", "internalWebPropertyId", "profileId", "parentLink", "created", "updated"))
-
## Error in list.remove(., c("accountId", "webPropertyId", "selfLink", "internalWebPropertyId", : could not find function "list.remove"
+ list.remove( c("accountId", "webPropertyId", "selfLink", "internalWebPropertyId", "profileId", "parentLink", "created", "updated"))
+
## Error in list.remove(., c("accountId", "webPropertyId", "selfLink", "internalWebPropertyId", : could not find function "list.remove"
 goal_one
-
## Error in eval(expr, envir, enclos): object 'goal_one' not found
+
## Error in eval(expr, envir, enclos): object 'goal_one' not found
-
-

-5. Submit the goal details to our destination property.

+
+

5. Submit the goal details to our destination property. +

We can then use the goal details contained in goal_one to submit a ga_goal_add() request to our destination property.

 ga_goal_add(goal_one, dest_account$accountId, dest_account$webPropertyId, dest_account$viewId)
@@ -884,16 +886,16 @@

-
-

-Copying multiple goals

-

Using the map() function from the tidyverse, we can quickly scale up this approach. We can copy all goals from a view at once, rather than one at a time.

+
+

Copying multiple goals +

+

Using the map() function from the tidyverse, we can quickly scale up this approach. We can copy all goals from a view at once, rather than one at a time.

First, we define a function to copy a single goal, given a goal ID, details of the source view ID and destination view IDs. In effect, we make a function to perform steps 1-5 from the “Copying a single goal” section in this page.

 # Takes a goal ID, source account information & dest account information, copies goal over
 copy_goal <- function(goal_id, source_df, dest_df) {
-  source_goal <- ga_goal(source_df$accountId, source_df$webPropertyId, source_df$viewId, goal_id) %>% 
-    list.remove( c("accountId", "webPropertyId", "selfLink", "internalWebPropertyId", "profileId", "parentLink", "created", "updated")) 
+  source_goal <- ga_goal(source_df$accountId, source_df$webPropertyId, source_df$viewId, goal_id) %>% 
+    list.remove( c("accountId", "webPropertyId", "selfLink", "internalWebPropertyId", "profileId", "parentLink", "created", "updated")) 
   ga_goal_add(source_goal, dest_df$accountId, dest_df$webPropertyId, dest_df$viewId)
 }

Having our goal-copying function defined, it is a simple step to apply it across all goal IDs from the source view.

@@ -901,17 +903,17 @@ 

 # For each goal ID in our source view, apply the copy_goal function, 
 # using source_account and dest_account account parameters as fixed 2nd / third arguments
-map(source_goals$id, copy_goal, source_account, dest_account)
+map(source_goals$id, copy_goal, source_account, dest_account)

-
-

-Write request limits

+
+

Write request limits +

At the time of writing, there is a daily limit of 50 write requests per day, per Google Cloud project, which restricts the number of times this can be performed. However, it is possible to request that this limit be increased.

-

For more information, check the Google documentation at https://developers.google.com/analytics/devguides/config/mgmt/v3/limits-quotas#write_requests.

+

For more information, check the Google documentation at https://developers.google.com/analytics/devguides/config/mgmt/v3/limits-quotas#write_requests.

-
-

-Remarketing segments

+
+

Remarketing segments +

Remarketing segments lets you target users in Google Ads from Google Analytics segments.

  • @@ -948,9 +950,9 @@

    include = my_remarketing1, exclude = my_remarketing2, audienceType = "STATE_BASED", name = "my_remarketing_seg1")

-
-

-Unsampled reports

+
+

Unsampled reports +

Available only for GA360 accounts, you will need to authenticate with the Google drive scope to get download access. The download functions are contributed by @j450h1

-
-

-Users

+
+

Users +

  • ga_clientid_hash() - Creates the clientID hash that is used in BigQuery GA360 exports
    • @@ -984,11 +986,13 @@

    -

    Developed by Mark Edmondson.

    +

    +

    Developed by Mark Edmondson.

    -

    Site built with pkgdown 1.6.1.

    +

    +

    Site built with pkgdown 2.0.1.

    @@ -997,5 +1001,7 @@

    + + diff --git a/docs/articles/measurement-protocol-v2.html b/docs/articles/measurement-protocol-v2.html index 271995eb..e63ba190 100644 --- a/docs/articles/measurement-protocol-v2.html +++ b/docs/articles/measurement-protocol-v2.html @@ -23,15 +23,17 @@ + +

  • - + @@ -237,39 +239,39 @@ -
    +

    Measurement Protocol v2

    - Source: vignettes/measurement-protocol-v2.Rmd + Source: vignettes/measurement-protocol-v2.Rmd
    -
    -

    -Sending hits from R to Google Analytics 4 properties via the Measurement Protocol v2

    -

    From the Google docs:

    +
    +

    Sending hits from R to Google Analytics 4 properties via the Measurement Protocol v2 +

    +

    From the Google docs:

    The Google Analytics Measurement Protocol for Google Analytics 4 allows developers to make HTTP requests to send events directly to Google Analytics servers. This allows developers to measure how users interact with their business from any HTTP-enabled environment. Notably, this makes it easy to measure interactions that happen server-to-server.

    -
    -

    -library(measurementProtocol)

    -

    The measurementProtocol library is the one actually making the hits, with googleAnalyticsR calling the same functions. Use library(measurementProtocol) directly if you don’t need the rest of the googleAnalyticsR functions and would like a lighter package to work with.

    +
    +

    library(measurementProtocol) +

    +

    The measurementProtocol library is the one actually making the hits, with googleAnalyticsR calling the same functions. Use library(measurementProtocol) directly if you don’t need the rest of the googleAnalyticsR functions and would like a lighter package to work with.

    -
    -

    -Usage

    +
    +

    Usage +

    Using the ga_mp_send() function you can send tracking hits from any R environment that is connected to HTTP. This can be used in variety of ways including R package tracking; extracting user data then running statistical analysis on GA4 user data and sending it back into GA4; server side tracking implementations of R web apps such as Shiny.

    -

    googleAnalyticsR includes opt-in GA4 tracking of the package usage via the ga_trackme() function.

    +

    googleAnalyticsR includes opt-in GA4 tracking of the package usage via the ga_trackme() function.

    -
    -

    -Sending GA4 hits from R

    +
    +

    Sending GA4 hits from R +

    To send hits you need:

    1. A GA4 account
      2. @@ -291,7 +293,7 @@

      An example is shown then example below:

       # preferably set this in .Renviron
-Sys.setenv(GA_MP_SECRET="MY_SECRET")
+Sys.setenv(GA_MP_SECRET="MY_SECRET")
 
 # your GA4 settings
 my_measurement_id <- "G-43MDXK6CLZ"
@@ -310,7 +312,7 @@ 
      
 another <- ga_mp_event("another_event")
 
 # send a real hit - batched together
-ga_mp_send(list(event, another), 
+ga_mp_send(list(event, another), 
            a_client_id, my_measurement_id)
 
 # you can see sent events in the real-time reports to check its working
@@ -319,22 +321,22 @@ 
      
         dimensions = "eventName", 
         metrics = "eventCount", 
         dimensionFilter = ga_data_filter(
-           eventName == c("an_event","another_event")),
+           eventName == c("an_event","another_event")),
         realtime = TRUE)
      -
      -

      -Configuration of GA4

      +
      +

      Configuration of GA4 +

      Once the API secret is created you can put it in an .Renviron file for the GA_MP_SECRET so you do not need to supply it in the R code for security.

      You also need a clientId, which is the ID associated with the user creating the hits. Be aware of privacy laws when creating this - for example ePrivacy in the EU dictates you must get consent to associate an ID with a user. If the clientId is the same as other streams into your GA4 account (e.g. website, mobile apps), the hits you send will be associated with the same user.

      Once you have those then you need to decide what event you want to send in. To see event parameters in your GA4 reports, create custom fields in your GA4 account first, after which you can see them in your reports 24hrs after you send them - - dimension name will be the label in the reports, event parameter will be the parameter you have sent in with the event.

      -
      -

      -Creating the connection object

      +
      +

      Creating the connection object +

      The connection is configured with the API secret and your measurementId. Ideally the API secret should be set in your .Renviron file via environment argument MP_SECRET

       # preferably set this in .Renviron
-Sys.setenv(MP_SECRET="MY_SECRET")
+Sys.setenv(MP_SECRET="MY_SECRET")
 
 # your GA4 settings
 my_measurement_id <- "G-1234"
@@ -349,18 +351,18 @@ 
      
     preview_header = "ZW52LTV8OWdPOExNWFkYjA0Njk4NmQ="
 )
      -
      -

      -Sending the GA4 hit via R

      -

      You construct an event via ga_mp_event() - a simple one may be ga_mp_event("an_event")

      +
      +

      Sending the GA4 hit via R +

      +

      You construct an event via ga_mp_event() - a simple one may be ga_mp_event("an_event")

       ga_mp_event("an_event")
      -
      ## 
-## ==GA4 MP Event
-## {
-##   "name": "an_event"
-## }
      -

      Refer to the Events documentation on what you can send in.

      +
      ## 
+## ==GA4 MP Event
+## {
+##   "name": "an_event"
+## }
      +

      Refer to the Events documentation on what you can send in.

      Once you have an event you can test it will show up when you send via ga_mp_send() by setting debug_call=TRUE

       my_connection <- ga_mp_connection("G-1234")
@@ -368,69 +370,69 @@ 
      
 
 event <- ga_mp_event("an_event")
 ga_mp_send(event, a_client_id, my_connection, debug_call = TRUE)
      -
      ## ℹ 2021-10-05 19:17:42 > MP Request: https://www.google-analytics.com/debug/mp/collect?measurement_id=G-1234&api_secret=MY_SECRET 
-##  {
-##   "client_id": "31761835.1633461463",
-##   "non_personalized_ads": true,
-##   "events": [
-##     {
-##       "name": "an_event"
-##     }
-##   ]
-## }
      -
      ## ℹ 2021-10-05 19:17:42 > Response:  200
      -
      ## ℹ 2021-10-05 19:17:42 > No validation messages found
      -
      ## [1] TRUE
      +
      ## ℹ 2022-01-13 13:01:31 > MP Request: https://www.google-analytics.com/debug/mp/collect?measurement_id=G-1234&api_secret=MY_SECRET 
+##  {
+##   "client_id": "96343037.1642078892",
+##   "non_personalized_ads": true,
+##   "events": [
+##     {
+##       "name": "an_event"
+##     }
+##   ]
+## }
      +
      ## ℹ 2022-01-13 13:01:31 > Response:  200
      +
      ## ℹ 2022-01-13 13:01:31 > No validation messages found
      +
      ## [1] TRUE

      You can send many events in on send:

       another <- ga_mp_event("another_event")
-ga_mp_send(list(event, another), 
+ga_mp_send(list(event, another), 
            a_client_id, 
            my_connection, 
            debug_call = TRUE)
      -
      ## ℹ 2021-10-05 19:17:43 > MP Request: https://www.google-analytics.com/debug/mp/collect?measurement_id=G-1234&api_secret=MY_SECRET 
-##  {
-##   "client_id": "31761835.1633461463",
-##   "non_personalized_ads": true,
-##   "events": [
-##     {
-##       "name": "an_event"
-##     },
-##     {
-##       "name": "another_event"
-##     }
-##   ]
-## }
      -
      ## ℹ 2021-10-05 19:17:43 > Response:  200
      -
      ## ℹ 2021-10-05 19:17:43 > No validation messages found
      -
      ## [1] TRUE
      +
      ## ℹ 2022-01-13 13:01:31 > MP Request: https://www.google-analytics.com/debug/mp/collect?measurement_id=G-1234&api_secret=MY_SECRET 
+##  {
+##   "client_id": "96343037.1642078892",
+##   "non_personalized_ads": true,
+##   "events": [
+##     {
+##       "name": "an_event"
+##     },
+##     {
+##       "name": "another_event"
+##     }
+##   ]
+## }
      +
      ## ℹ 2022-01-13 13:01:32 > Response:  200
      +
      ## ℹ 2022-01-13 13:01:32 > No validation messages found
      +
      ## [1] TRUE

      Events are flexible with the number of parameters you send with the event name - this allows for rich data streams. The data parameters can be added via the params argument and accepts (nested) named R lists:

      -ga_mp_event("event_with_params", params = list(my_param = "hello", my_param2 = "mum"))
      -
      ## 
-## ==GA4 MP Event
-## {
-##   "name": "event_with_params",
-##   "params": {
-##     "my_param": "hello",
-##     "my_param2": "mum"
-##   }
-## }
      +ga_mp_event("event_with_params", params = list(my_param = "hello", my_param2 = "mum"))
      +
      ## 
+## ==GA4 MP Event
+## {
+##   "name": "event_with_params",
+##   "params": {
+##     "my_param": "hello",
+##     "my_param2": "mum"
+##   }
+## }

      If you are making product item style hits, the helper function ga_mp_event_item() helps you construct them:

       # one item
 ga_mp_event_item(item_name = "jeggings", 
                  price = 8.88, 
                  item_variant = "Black")
      -
      ## ==GA4 MP Event Item
-## {
-##   "item_name": "jeggings",
-##   "item_variant": "Black",
-##   "price": 8.88
-## }
      +
      ## ==GA4 MP Event Item
+## {
+##   "item_name": "jeggings",
+##   "item_variant": "Black",
+##   "price": 8.88
+## }
       # many items in a list
-items <- list(
+items <- list(
   ga_mp_event_item(item_id = "SKU_12345", 
                    price = 9.99, 
                    item_brand = "Gucci"), 
@@ -440,67 +442,67 @@ 
      
                    
 # construct an event with its own fields
 ga_mp_event("add_payment_info", 
-            params = list(coupon = "SUMMER_FUN", 
+            params = list(coupon = "SUMMER_FUN", 
                           payment_type = "Credit Card", 
                           value = 7.77, 
                           currency = "USD"), 
             items = items)
      -
      ## 
-## ==GA4 MP Event
-## {
-##   "name": "add_payment_info",
-##   "params": {
-##     "coupon": "SUMMER_FUN",
-##     "payment_type": "Credit Card",
-##     "value": 7.77,
-##     "currency": "USD",
-##     "items": [
-##       {
-##         "item_id": "SKU_12345",
-##         "item_brand": "Gucci",
-##         "price": 9.99
-##       },
-##       {
-##         "item_name": "jeggings",
-##         "item_variant": "Black",
-##         "price": 8.88
-##       }
-##     ]
-##   }
-## }
      +
      ## 
+## ==GA4 MP Event
+## {
+##   "name": "add_payment_info",
+##   "params": {
+##     "coupon": "SUMMER_FUN",
+##     "payment_type": "Credit Card",
+##     "value": 7.77,
+##     "currency": "USD",
+##     "items": [
+##       {
+##         "item_id": "SKU_12345",
+##         "item_brand": "Gucci",
+##         "price": 9.99
+##       },
+##       {
+##         "item_name": "jeggings",
+##         "item_variant": "Black",
+##         "price": 8.88
+##       }
+##     ]
+##   }
+## }
      -
      -

      -googleAnalyticsR package tracking with ga_trackme

      +
      +

      googleAnalyticsR package tracking with ga_trackme +

      googleAnalyticsR uses the above to provide opt-in tracking of what systems its running on.

      -

      ga_trackme() is send on package load if consent is given in the form of a file saved on the user’s computer (much like a website cookie).

      +

      ga_trackme() is send on package load if consent is given in the form of a file saved on the user’s computer (much like a website cookie).

      You can see what is sent with the debug_call=TRUE flag - the below is sent when this RMarkdown file renders:

      -ga_trackme_event(debug_call = TRUE, say_hello = "Documentation is a feature")
      -
      ## Warning in file(con, "r"): cannot open file '/builder/home/.config/
-## googleAnalyticsR/optin-tracking': No such file or directory
      -
      ## ℹ 2021-10-05 19:17:43 > MP Request: https://www.google-analytics.com/debug/mp/collect?measurement_id=G-43MDXK6CLZ&api_secret=_hS_7VJARhqbCq9mF3oiNg 
-##  {
-##   "client_id": "12345678.987654",
-##   "non_personalized_ads": true,
-##   "events": [
-##     {
-##       "name": "r_package_loaded",
-##       "params": {
-##         "r_version": "R version 4.0.5 (2021-03-31)",
-##         "r_platform": "x86_64-pc-linux-gnu (64-bit)",
-##         "r_locale": "LC_CTYPE=en_US.UTF-8;LC_NUMERIC=C;LC_TIME=en_US.UTF-8;LC_COLLATE=en_US.UTF-8;LC_MONETARY=en_US.UTF-8;LC_MESSAGES=C;LC_PAPER=en_US.UTF-8;LC_NAME=C;LC_ADDRESS=C;LC_TELEPHONE=C;LC_MEASUREMENT=en_US.UTF-8;LC_IDENTIFICATION=C",
-##         "r_system": "Ubuntu 20.04 LTS",
-##         "say_hello": "Documentation is a feature",
-##         "package": "googleAnalyticsR 1.0.1"
-##       }
-##     }
-##   ]
-## }
      -
      ## ℹ 2021-10-05 19:17:43 > Response:  200
      -
      ## ℹ 2021-10-05 19:17:43 > No validation messages found
      -
      ## [1] TRUE
      +ga_trackme_event(debug_call = TRUE, say_hello = "Documentation is a feature")
      +
      ## Warning in file(con, "r"): cannot open file '/builder/home/.config/
+## googleAnalyticsR/optin-tracking': No such file or directory
      +
      ## ℹ 2022-01-13 13:01:32 > MP Request: https://www.google-analytics.com/debug/mp/collect?measurement_id=G-43MDXK6CLZ&api_secret=_hS_7VJARhqbCq9mF3oiNg 
+##  {
+##   "client_id": "12345678.987654",
+##   "non_personalized_ads": true,
+##   "events": [
+##     {
+##       "name": "r_package_loaded",
+##       "params": {
+##         "r_version": "R version 4.1.2 (2021-11-01)",
+##         "r_platform": "x86_64-pc-linux-gnu (64-bit)",
+##         "r_locale": "LC_CTYPE=en_US.UTF-8;LC_NUMERIC=C;LC_TIME=en_US.UTF-8;LC_COLLATE=en_US.UTF-8;LC_MONETARY=en_US.UTF-8;LC_MESSAGES=en_US.UTF-8;LC_PAPER=en_US.UTF-8;LC_NAME=C;LC_ADDRESS=C;LC_TELEPHONE=C;LC_MEASUREMENT=en_US.UTF-8;LC_IDENTIFICATION=C",
+##         "r_system": "Ubuntu 20.04.3 LTS",
+##         "say_hello": "Documentation is a feature",
+##         "package": "googleAnalyticsR 1.0.1"
+##       }
+##     }
+##   ]
+## }
      +
      ## ℹ 2022-01-13 13:01:32 > Response:  200
      +
      ## ℹ 2022-01-13 13:01:32 > No validation messages found
      +
      ## [1] TRUE

      Send your own messages if you like! I will read them in the GA4 interface.

      @@ -516,11 +518,13 @@

      -

      Developed by Mark Edmondson.

      +

      +

      Developed by Mark Edmondson.

      -

      Site built with pkgdown 1.6.1.

      +

      +

      Site built with pkgdown 2.0.1.

      @@ -529,5 +533,7 @@

      + + diff --git a/docs/articles/model-templates.html b/docs/articles/model-templates.html index dcb5b75e..637f3927 100644 --- a/docs/articles/model-templates.html +++ b/docs/articles/model-templates.html @@ -23,15 +23,17 @@ + +

  • - + @@ -237,13 +239,13 @@ -
    +

    Automatic Shiny apps with Google Analytics data

    - Source: vignettes/model-templates.Rmd + Source: vignettes/model-templates.Rmd
    @@ -262,14 +264,14 @@

    Automatic Shiny apps with Google Analytics data

  • Support for GA4 and Universal Analytics account pickers
  • Multiple models can be viewed in one Shiny app
-

For authentication, you will need to create a Web based Client ID JSON file (as opposed to the Desktop app JSON file for local use) at https://console.cloud.google.com/apis/credentials and add an Authorised redirect URI - for local testing http://localhost:1221 is helpful if you have set your Shiny apps to a static port via options(shiny.port = 1221). See the googleAuthR website for details.

-
-

-Example Template Outputs

+

For authentication, you will need to create a Web based Client ID JSON file (as opposed to the Desktop app JSON file for local use) at https://console.cloud.google.com/apis/credentials and add an Authorised redirect URI - for local testing http://localhost:1221 is helpful if you have set your Shiny apps to a static port via options(shiny.port = 1221). See the googleAuthR website for details.

+
+

Example Template Outputs +

These are just demos, and the main point is that the templates can be configured to be anyway you like.

-
-

-The Basic (default)

+
+

The Basic (default) +

For quick iteration through models

 model <- ga_model_example("decomp_ga.gamr")
@@ -278,10 +280,10 @@ 

 
The basic
-
-

-Gentelella

-

Using a custom theme from https://github.com/MarkEdmondson1234/gentelellaShiny and a ga_model() using CausalImpact and dygraphs

+
+

Gentelella +

+

Using a custom theme from https://github.com/MarkEdmondson1234/gentelellaShiny and a ga_model() using CausalImpact and dygraphs

 model <- ga_model_example("ga-effect.gamr")
 ga_model_shiny(model, auth_dropdown = "universal",
@@ -290,10 +292,10 @@ 

 
Using gentellela theme
-
-

-argonDash

-

Mobile friendly Shiny themes from https://rinterface.github.io/argonDash/

+
+

argonDash +

+

Mobile friendly Shiny themes from https://rinterface.github.io/argonDash/

 model <- ga_model_example("ga-effect.gamr")
 
@@ -306,16 +308,16 @@ 

 
Using argonDash
-
-

-Shinythemes

-

Using https://rstudio.github.io/shinythemes/

+
+

Shinythemes +

+

Using https://rstudio.github.io/shinythemes/

Themes can be configured to support multiple models

 m3 <- ga_model_example("time-normalised.gamr")
 m4 <- ga_model_example("ga-effect.gamr")
 
-ga_model_shiny(list(m4, m3), 
+ga_model_shiny(list(m4, m3), 
                auth_dropdown = "universal", 
                template = ga_model_shiny_template("shinythemes"), 
                theme = "cerulean")
@@ -323,7 +325,7 @@

Using shinythemes with theme=‘cerulean’

-ga_model_shiny(list(m4, m3), 
+ga_model_shiny(list(m4, m3), 
                auth_dropdown = "universal", 
                template = ga_model_shiny_template("shinythemes"), 
                theme = "yeti")
@@ -331,27 +333,27 @@

Using shinythemes with theme=‘yeti’

-
-

-BS LIB

-

Custom bootstrap themes via https://rstudio.github.io/bslib/

+
+

BS LIB +

+

Custom bootstrap themes via https://rstudio.github.io/bslib/

 m3 <- ga_model_example("time-normalised.gamr")
 m4 <- ga_model_example("ga-effect.gamr")
 
-ga_model_shiny(list(m4, m3), auth_dropdown = "universal",
+ga_model_shiny(list(m4, m3), auth_dropdown = "universal",
                template = ga_model_shiny_template("basic_bslib"), 
                bg = "white", fg = "red", primary = "grey")

Using bslib with custom bootstrap css

-
-

-Shinydashboard

-

Using shinydashboard https://rstudio.github.io/shinydashboard/

+
+

Shinydashboard +

+

Using shinydashboard https://rstudio.github.io/shinydashboard/

-ga_model_shiny(list(m4, m3), auth_dropdown = "universal", 
+ga_model_shiny(list(m4, m3), auth_dropdown = "universal", 
                template = ga_model_shiny_template("shinydashboard"), 
                skin = "blue")
@@ -359,29 +361,29 @@

-
-

-The templates

+
+

The templates +

A list of currently available template folders you can base your own upon is here:

 # current templates available in inst/models/shiny_templates
 ga_model_shiny_template()
-
##  [1] "argonDash/ui.R"                      
-##  [2] "basic_app/app.R"                     
-##  [3] "basic_bslib/ui.R"                    
-##  [4] "basic/ui.R"                          
-##  [5] "boilerplate/deploy.R"                
-##  [6] "boilerplate/Dockerfile_app"          
-##  [7] "boilerplate/Dockerfile_ui_server"    
-##  [8] "boilerplate/header_boilerplate.R"    
-##  [9] "boilerplate/server_app_boilerplate.R"
-## [10] "boilerplate/server_boilerplate.R"    
-## [11] "gentelella/ui.R"                     
-## [12] "html_based/template.html"            
-## [13] "html_based/ui.R"                     
-## [14] "html_based/www/dummy.js"             
-## [15] "shinydashboard/ui.R"                 
-## [16] "shinythemes/ui.R"
+
##  [1] "argonDash/ui.R"                      
+##  [2] "basic_app/app.R"                     
+##  [3] "basic_bslib/ui.R"                    
+##  [4] "basic/ui.R"                          
+##  [5] "boilerplate/deploy.R"                
+##  [6] "boilerplate/Dockerfile_app"          
+##  [7] "boilerplate/Dockerfile_ui_server"    
+##  [8] "boilerplate/header_boilerplate.R"    
+##  [9] "boilerplate/server_app_boilerplate.R"
+## [10] "boilerplate/server_boilerplate.R"    
+## [11] "gentelella/ui.R"                     
+## [12] "html_based/template.html"            
+## [13] "html_based/ui.R"                     
+## [14] "html_based/www/dummy.js"             
+## [15] "shinydashboard/ui.R"                 
+## [16] "shinythemes/ui.R"

To use, supply a model and a template to the ga_model_shiny() function:

 # A Shiny app using "decomp_ga.gamr" model with the "shinythemes" template
@@ -391,19 +393,19 @@ 

   template = ga_model_shiny_template("shinythemes"))

If a server.R file is not supplied, then it will take the default server.R from bootstrap files.

-
-

-Creating templates

+
+

Creating templates +

You can read existing template files using the read_lines=TRUE flag:

 ga_model_shiny_template("basic/ui.R", read_lines = TRUE)
-
## [1] "## basic ui.R"                           
-## [2] "fluidPage(title = \"{{ shiny_title }}\","
-## [3] "                {{ auth_ui }},"          
-## [4] "                {{{ date_range }}},"     
-## [5] "                h2(\"Model Output\"),"   
-## [6] "{{{ model_ui }}}"                        
-## [7] ")"
+
## [1] "## basic ui.R"                           
+## [2] "fluidPage(title = \"{{ shiny_title }}\","
+## [3] "                {{ auth_ui }},"          
+## [4] "                {{{ date_range }}},"     
+## [5] "                h2(\"Model Output\"),"   
+## [6] "{{{ model_ui }}}"                        
+## [7] ")"

You can also print out the entire app rather than launching it by supplying a folder to write out the Shiny code:

 ga_model_shiny(
@@ -411,9 +413,9 @@ 

     auth_dropdown = "universal", 
     local_folder = "my_app")

Use this to help craft your own templates.

-
-

-Template macro variables

+
+

Template macro variables +

Put these macros within the ui.R or server.R shiny files to import them when loading via ga_model_shiny()

  • {{{ model_libraries }}} - Adds library() calls based on models$required_packages

    • @@ -433,23 +435,23 @@

  • {{{ your_argument }}} - You can pass in your own custom variables to the template via the … argument of this function if they are named the same as the template macro variable

-
-

-Boilerplate files

+
+

Boilerplate files +

There are some common shared code that is available in the boilerplate files.

  • header_boilerplate.R - for loading the models and libraries in a UI
 # ---start header_boilerplate.R
-library(shiny)
-library(googleAuthR)
-library(googleAnalyticsR)
+library(shiny)
+library(googleAuthR)
+library(googleAnalyticsR)
 {{{ model_libraries }}}
 
-gar_set_client(web_json = "{{ web_json }}",
+gar_set_client(web_json = "{{ web_json }}",
                scopes = "{{ scopes }}")
-options(googleAuthR.redirect = "{{ deployed_url }}")
+options(googleAuthR.redirect = "{{ deployed_url }}")
 
 # loads pre-existing models
 {{{ model_load }}}
@@ -461,7 +463,7 @@ 

 # ---start server_app_boilerplate.R
 server <- function(input, output, session){
   
-  token <- gar_shiny_auth(session)
+  token <- gar_shiny_auth(session)
   
   {{{ auth_accounts }}}
   
@@ -473,7 +475,7 @@ 

   
 }
 
-shinyApp(gar_shiny_ui(ui, login_ui = silent_auth), server)
+shinyApp(gar_shiny_ui(ui, login_ui = silent_auth), server)
 # ---end server_app_boilerplate.R
  • server_boilerplate.R - for a Shiny app using multiple files (ui.R, server.R, etc.)
    • @@ -482,7 +484,7 @@

    # ---start server_boilerplate.R function(input, output, session){ - token <- gar_shiny_auth(session) + token <- gar_shiny_auth(session) {{{ auth_accounts }}} @@ -496,10 +498,10 @@

    # ---end server_boilerplate.R

-
-

-Deploying Shiny apps

-

By default the Shiny app will run locally but you can also deploy them to Shiny hosting services such as shinyapps.io or a Shiny Server running on Cloud Run. googleCloudRunner includes functions for easier deployment of Shiny apps to Cloud Run.

+
+

Deploying Shiny apps +

+

By default the Shiny app will run locally but you can also deploy them to Shiny hosting services such as shinyapps.io or a Shiny Server running on Cloud Run. googleCloudRunner includes functions for easier deployment of Shiny apps to Cloud Run.

For deployment, you will need:

  1. Ensure you have your web_json clientId file available
    2. @@ -509,14 +511,14 @@

  2. Update your ClientId’s permitted redirect URL to the app URL from step 3
  3. Re-deploy the app

-
-

-Deployment options

+
+

Deployment options +

If deploying to shinyapps.io or a local RStudio Connect instance you can use the “Deploy” button within RStudio.

If deploying to another environment you may want a Dockerfile holding your Shiny app, which is added to the deployment folder.

-

To deploy to Cloud Run using googleCloudRunner the below code is an example:

+

To deploy to Cloud Run using googleCloudRunner the below code is an example:

-library(googleAnalyticsR)
+library(googleAnalyticsR)
 
 # create the Shiny app - first time without deployed_url, second time with
 ga_model_shiny(
@@ -527,12 +529,12 @@ 

     local_folder = "cloudrun_test")
     
 # deploy the cloudrun_test folder that contains a Dockerfile
-library(googleCloudRunner)
+library(googleCloudRunner)
 
 # run two times, first to generate the URL, the second to deploy the final app
 cr_deploy_run("cloudrun_test/",
               remote = "cloudrun_test",
-              tag = c("latest","$BUILD_ID"),
+              tag = c("latest","$BUILD_ID"),
               max_instances = 1, # required for shiny
               concurrency = 80, 
               launch_browser = FALSE)
@@ -548,10 +550,10 @@ 

 COPY . /srv/shiny-server/

Modify the Dockerfile to include any dependencies you may need for your app (e.g. dygraphs if using a dygraph enabled model)

-
-

-Helper Docker file - googleanalytics-shiny-cloudrun

-

The gcr.io/gcer-public/googleanalyticsr-shiny-cloudrun image is one that installed googleAnalyticsR on top or rocker/shiny and configures Shiny for use within Cloud Run. See the Deploying Shiny to Cloud Run use case on the googleCloudRunner website for details.

+
+

Helper Docker file - googleanalytics-shiny-cloudrun +

+

The gcr.io/gcer-public/googleanalyticsr-shiny-cloudrun image is one that installed googleAnalyticsR on top or rocker/shiny and configures Shiny for use within Cloud Run. See the Deploying Shiny to Cloud Run use case on the googleCloudRunner website for details.

The Dockerfile for that image is below:

FROM rocker/shiny
 
@@ -590,11 +592,13 @@ 

 
 
       

-  
Developed by Mark Edmondson.

+  

+
Developed by Mark Edmondson.

 

 
 

-  
Site built with pkgdown 1.6.1.

+  

+
Site built with pkgdown 2.0.1.

 

 
       

@@ -603,5 +607,7 @@ 

   
 
 
+  
+
   
 
diff --git a/docs/articles/models.html b/docs/articles/models.html
index cd7055a4..7164186e 100644
--- a/docs/articles/models.html
+++ b/docs/articles/models.html
@@ -23,15 +23,17 @@
 
 
 
+    
+
     

       

+      

   

     

       
Statistical models and visualisations with Google Analytics data

             
       
-      Source: vignettes/models.Rmd
+      Source: vignettes/models.Rmd
       
 
     

@@ -257,13 +259,13 @@ 
Statistical models and visualisations with Google Analytics da
 
.gamr files also includes the ability to create Shiny modules which you can use to quickly create online Shiny dashboards displaying the model results, and which can switch to users own Google Analytics data using the multi-user login capabilities.

 
The .gamr file format can be shared with others online or within your organisation.

 
You can also use model objects to create Shiny apps - see Model Shiny Templates

-

-

-A simple example loading a model directly

+

+
A simple example loading a model directly
+

 
The above loads models within a wrapper function, but you can also load model objects yourself via ga_model_load(). Included within the package are some simple models to demonstrate its use which use ga_model_load() to load from the package examples, via ga_model_example()

 
The example below performs decomposition on the sessions to your website. Behind the scenes the model downloads your data with the right columns, applies the decomposition model then plots it, returning the data plotted for you to work with later:

 
-library(googleAnalyticsR)  # load library
+library(googleAnalyticsR)  # load library
 
 # your own Google Analytics viewID
 my_viewid <- 81416156
@@ -279,53 +281,53 @@ 

 
This model allows you to alter the date range of the data fetched:

 
 # change default date range to 20 days ago to yesterday
-d2 <- ga_model(my_viewid, model = decomp_ga, date_range = c("20daysAgo","yesterday"))

+d2 <- ga_model(my_viewid, model = decomp_ga, date_range = c("20daysAgo","yesterday"))

 

 
plot of chunk unnamed-chunk-2

 

 
You can examine the properties of the model and the arguments it was sent via its print method:

 
 decomp_ga

-
## ==ga_model object==
-## Description:  Performs decomposition and creates a plot 
-## Data args:    viewId date_range 
-## Input data:   date sessions 
-## Model args:   df 
-## Output args:  x y 
-## Packages:

+
## ==ga_model object==
+## Description:  Performs decomposition and creates a plot 
+## Data args:    viewId date_range 
+## Input data:   date sessions 
+## Model args:   df 
+## Output args:  x y 
+## Packages:

 
You can also see an overview on how a particular call to a model was created by printing out the model’s result directly to console:

 
 d2

-
## ==ga_model_result object==
-## Input names:        date sessions 
-## Input dimensions:   20 2 
-## Output names:       x seasonal trend random figure type 
-## Plot class:         NULL 
-## Model args passed:  date_range = c("20daysAgo", "yesterday") 
-## ==ga_model object==
-## Description:  Performs decomposition and creates a plot 
-## Data args:    viewId date_range 
-## Input data:   date sessions 
-## Model args:   df 
-## Output args:  x y 
-## Packages:

+
## ==ga_model_result object==
+## Input names:        date sessions 
+## Input dimensions:   20 2 
+## Output names:       x seasonal trend random figure type 
+## Plot class:         NULL 
+## Model args passed:  date_range = c("20daysAgo", "yesterday") 
+## ==ga_model object==
+## Description:  Performs decomposition and creates a plot 
+## Data args:    viewId date_range 
+## Input data:   date sessions 
+## Model args:   df 
+## Output args:  x y 
+## Packages:

 
And if you want to review the code of the model, use ga_model_write() to write the functions out to a file.

 
 ga_model_write(decomp_ga, "my_model.R")

 

-

-

-Shiny templates for ga_model objects

+

+
Shiny templates for ga_model objects
+

 
There are Shiny templates available that can be used with model objects to quickly create Shiny apps for users. For example:

 
 ga_model_shiny("inst/models/decomp_ga.gamr", template = ga_model_shiny_template("template1"))

 
Templates can be created and parsed via {{ var }} templating rules. The default variables used in all templates are web_json, scopes (for Google auth), and title. You can pass other template specific ones via the ... argument. The ga_model argument is used to load the previously created ga_model object into the Shiny app.

 
-library(shiny)
-library(googleAuthR)
-library(googleAnalyticsR)
+library(shiny)
+library(googleAuthR)
+library(googleAnalyticsR)
 
-gar_set_client(web_json = "{{ web_json }}",
+gar_set_client(web_json = "{{ web_json }}",
                scopes = "{{ scopes }}")
 
 # loads a pre-existing model
@@ -335,11 +337,11 @@ 

 modelServer <- model$shiny_module$server
 
 ## ui.R
-ui <- fluidPage(title = "{{ shiny_title }}",
+ui <- fluidPage(title = "{{ shiny_title }}",
                 authDropdownUI("auth_menu"),
-                h2("Model Description"),
-                textOutput("model_description"),
-                h2("Model Output"),
+                h2("Model Description"),
+                textOutput("model_description"),
+                h2("Model Output"),
                 modelUi("{{ ga_model_name }}")
                 
 )
@@ -347,26 +349,26 @@ 

 ## server.R
 server <- function(input, output, session){
   
-  token <- gar_shiny_auth(session)
+  token <- gar_shiny_auth(session)
   
-  al <- reactive({
-    req(token)
+  al <- reactive({
+    req(token)
     ga_account_list()
   })
   
   # module for authentication
-  view_id <- callModule(authDropdown, "auth_menu", ga.table = al)
-  output$model_description <- renderText(model$description)
+  view_id <- callModule(authDropdown, "auth_menu", ga.table = al)
+  output$model_description <- renderText(model$description)
   
   # module to display model results
   modelServer("{{ ga_model_name }}", view_id = view_id)
   
 }
 
-shinyApp(gar_shiny_ui(ui, login_ui = silent_auth), server)

-

-

-Models and Templates included with googleAnalyticsR

+shinyApp(gar_shiny_ui(ui, login_ui = silent_auth), server)
+
+

Models and Templates included with googleAnalyticsR +

There are some pre-created models and templates to help inspire your own. At the moment these are:

Models - accessed via ga_model_example()

    @@ -384,13 +386,13 @@

  • "template_ua" - A basic Shiny dashboard with an account selector for UA
  • -"shinydashboard_ga4" - Account selector for GA4 plus date picker using library(shinydashboard) styling.
    • +"shinydashboard_ga4" - Account selector for GA4 plus date picker using library(shinydashboard) styling.

-
-

-Creating model .gamr objects

+
+

Creating model .gamr objects +

To create your own models, you need to predefine all the functions to look after the fetching, modelling and viewing of the data. You then pass those functions to the ga_model_make() function.

The functions need to follow these specifications:

    @@ -424,7 +426,7 @@

    To create the decomposition example model, this was applied as shown below:

     get_model_data <- function(viewId,
-                           date_range = c(Sys.Date()- 300, Sys.Date()),
+                           date_range = c(Sys.Date()- 300, Sys.Date()),
                            ...){
    google_analytics(viewId,
                     date_range = date_range,
@@ -434,25 +436,25 @@ 
    
  }
 
 decompose_sessions <- function(df, ...){
-   decompose(ts(df$sessions, frequency = 7))
+   decompose(ts(df$sessions, frequency = 7))
  }
  
 decomp_ga <- ga_model_make(get_model_data,
-                           required_columns = c("date", "sessions"),
+                           required_columns = c("date", "sessions"),
                            model_f = decompose_sessions,
-                           output_f = graphics::plot,
+                           output_f = graphics::plot,
                            description = "Performs decomposition and creates a plot",
-                           outputShiny = shiny::plotOutput,
-                           renderShiny = shiny::renderPlot)
    + outputShiny = shiny::plotOutput, + renderShiny = shiny::renderPlot)

-
-

-Advanced use

+
+

Advanced use +

The more arguments you provide to the model creation functions, the more complicated it is for the end user, but the more flexible the model. It is suggested making several narrow usage models is better than one complicated one.

For instance, you could modify the above model to allow the end user to specify the metric, timespan and seasonality of the decomposition:

 get_model_data <- function(viewId,
-                           date_range = c(Sys.Date()- 300, Sys.Date()),
+                           date_range = c(Sys.Date()- 300, Sys.Date()),
                            metric,
                            ...){
    o <- google_analytics(viewId,
@@ -468,35 +470,35 @@ 

  }
 
 decompose_sessions <- function(df, frequency, ...){
-   decompose(ts(df$the_metric, frequency = frequency))
+   decompose(ts(df$the_metric, frequency = frequency))
  }
  
 decomp_ga_advanced <- ga_model_make(get_model_data,
-                           required_columns = c("date"), # less restriction on column
+                           required_columns = c("date"), # less restriction on column
                            model_f = decompose_sessions,
-                           output_f = graphics::plot,
+                           output_f = graphics::plot,
                            description = "Performs decomposition and creates a plot",
-                           outputShiny = shiny::plotOutput,
-                           renderShiny = shiny::renderPlot)
+ outputShiny = shiny::plotOutput, + renderShiny = shiny::renderPlot)

It would then be used via:

 result <- ga_model(81416156, decomp_ga_advanced, metric="users", frequency = 30)

plot of chunk unnamed-chunk-6

-
-

-Working with the model object

+
+

Working with the model object +

The model objects prints to console in a friendly manner:

 decomp_ga_advanced
-
## ==ga_model object==
-## Description:  Performs decomposition and creates a plot 
-## Data args:    viewId date_range metric 
-## Input data:   date 
-## Model args:   df frequency 
-## Output args:  x y 
-## Packages:
+
## ==ga_model object==
+## Description:  Performs decomposition and creates a plot 
+## Data args:    viewId date_range metric 
+## Input data:   date 
+## Model args:   df frequency 
+## Output args:  x y 
+## Packages:

You can save and load model objects from a file. It is suggested to save them with the .gamr suffix.

 # save model to a file
@@ -510,72 +512,72 @@ 

 
If you need to change parts of a model, ga_model_edit() lets you change individual aspects:

 
 ga_model_edit(decomp_ga_advanced, description = "New description")

-
## ==ga_model object==
-## Description:  New description 
-## Data args:    viewId date_range metric 
-## Input data:   date 
-## Model args:   df frequency 
-## Packages:

+
## ==ga_model object==
+## Description:  New description 
+## Data args:    viewId date_range metric 
+## Input data:   date 
+## Model args:   df frequency 
+## Packages:

 
You can also pass it the filename, which will load, make the edit, then save the model to disk again:

 
 ga_model_edit("my_model.gamr", description = "New description")

-
If you want to examine or change the functions in a model, you can use ga_model_write() to write them to a file, or examine them directly from the model object. The structure of the model object can be examined using str():

+
If you want to examine or change the functions in a model, you can use ga_model_write() to write them to a file, or examine them directly from the model object. The structure of the model object can be examined using str():

 
-str(decomp_ga_advanced, give.attr = FALSE)

-
## List of 7
-##  $ data_f           :function (viewId, date_range = c(Sys.Date() - 300, Sys.Date()), metric, ...)  
-##  $ required_columns : chr "date"
-##  $ model_f          :function (df, frequency, ...)  
-##  $ output_f         :function (x, y, ...)  
-##  $ required_packages: NULL
-##  $ description      : chr "Performs decomposition and creates a plot"
-##  $ shiny_module     :List of 2
-##   ..$ ui    :function (id, ...)  
-##   ..$ server:function (input, output, session, view_id, ...)

+str(decomp_ga_advanced, give.attr = FALSE)
+
## List of 7
+##  $ data_f           :function (viewId, date_range = c(Sys.Date() - 300, Sys.Date()), metric, ...)  
+##  $ required_columns : chr "date"
+##  $ model_f          :function (df, frequency, ...)  
+##  $ output_f         :function (x, y, ...)  
+##  $ required_packages: NULL
+##  $ description      : chr "Performs decomposition and creates a plot"
+##  $ shiny_module     :List of 2
+##   ..$ ui    :function (id, ...)  
+##   ..$ server:function (input, output, session, view_id, ...)

And you can access various elements by the usual list methods:

 decomp_ga_advanced$data_f
-
## function(viewId,
-##                            date_range = c(Sys.Date()- 300, Sys.Date()),
-##                            metric,
-##                            ...){
-##    o <- google_analytics(viewId,
-##                     date_range = date_range,
-##                     metrics = metric,
-##                     dimensions = "date",
-##                     max = -1)
-##     # rename the metric column so its found for modelling
-##     o$the_metric <- o[, metric]
-##     
-##     o
-##     
-##  }
+
## function(viewId,
+##                            date_range = c(Sys.Date()- 300, Sys.Date()),
+##                            metric,
+##                            ...){
+##    o <- google_analytics(viewId,
+##                     date_range = date_range,
+##                     metrics = metric,
+##                     dimensions = "date",
+##                     max = -1)
+##     # rename the metric column so its found for modelling
+##     o$the_metric <- o[, metric]
+##     
+##     o
+##     
+##  }
 decomp_ga_advanced$description
-
## [1] "Performs decomposition and creates a plot"
+
## [1] "Performs decomposition and creates a plot"
-
-

-GA Effect with ga_models

-

To make your own portable GA Effect, this model uses the CausalImpact and dygraphs libraries to make a plot of your GA data.

-

This example model is available via ga_model_example("ga-effect.gamr")

-
-

-Get data

+
+

GA Effect with ga_models +

+

To make your own portable GA Effect, this model uses the CausalImpact and dygraphs libraries to make a plot of your GA data.

+

This example model is available via ga_model_example("ga-effect.gamr")

+
+

Get data +

The data will focus on sessions per channel grouping. For this example the end user can select the date range, but we set a default of the last 600 days.

 get_ci_data <- function(viewId, 
-                        date_range = c(Sys.Date()-600, Sys.Date()),
+                        date_range = c(Sys.Date()-600, Sys.Date()),
                         ...){
   
   google_analytics(viewId, 
                    date_range = date_range,
                    metrics = "sessions",
-                   dimensions = c("date", "channelGrouping"), 
+                   dimensions = c("date", "channelGrouping"), 
                    max = -1)
 }
-

The modelling step is copied over from the dartistics.com time-services example.

+

The modelling step is copied over from the dartistics.com time-services example.

The function transforms the data into the right shape, and performs the CausalImpact model. The user can select the event date to examine, the channel to test (response) and possible predictors to help the model.

 # response_dim is the channel to predict.
@@ -583,36 +585,36 @@ 

 do_ci <- function(df, 
                   event_date,
                   response = "Organic Search",
-                  predictors = c("Video","Social","Direct"),
+                  predictors = c("Video","Social","Direct"),
                   ...){
   
-  message("CausalImpact input data columns: ", paste(names(df), collapse = " "))
+  message("CausalImpact input data columns: ", paste(names(df), collapse = " "))
   # restrict to one response 
-  stopifnot(is.character(response), 
-            length(response) == 1,
-            assertthat::is.date(event_date),
-            is.character(predictors))
+  stopifnot(is.character(response), 
+            length(response) == 1,
+            assertthat::is.date(event_date),
+            is.character(predictors))
   
-  pivoted <- df %>% 
-    tidyr::spread(channelGrouping, sessions)
+  pivoted <- df %>% 
+    tidyr::spread(channelGrouping, sessions)
   
-  stopifnot(response %in% names(pivoted))
+  stopifnot(response %in% names(pivoted))
   
   ## create a time-series zoo object
-  web_data_xts <- xts::xts(pivoted[-1], order.by = as.Date(pivoted$date), frequency = 7)
+  web_data_xts <- xts::xts(pivoted[-1], order.by = as.Date(pivoted$date), frequency = 7)
   
-  pre.period <- as.Date(c(min(df$date), event_date))
-  post.period <- as.Date(c(event_date + 1, max(df$date)))
+  pre.period <- as.Date(c(min(df$date), event_date))
+  post.period <- as.Date(c(event_date + 1, max(df$date)))
   
-  predictors <- intersect(predictors, names(web_data_xts))
+  predictors <- intersect(predictors, names(web_data_xts))
 
   ## data in order of response, predictor1, predictor2, etc.
-  model_data <- web_data_xts[,c(response,predictors)]
+  model_data <- web_data_xts[,c(response,predictors)]
   
   # deal with names
-  names(model_data) <- make.names(names(model_data))
+  names(model_data) <- make.names(names(model_data))
   # remove any NAs
-  model_data[is.na(model_data)] <- 0
+  model_data[is.na(model_data)] <- 0
 
   CausalImpact::CausalImpact(model_data,  pre.period, post.period)
 
@@ -627,21 +629,21 @@ 

   ci <- xts::xts(ci)
 
   ## the dygraph output
-  dygraph(data=ci[,c('response', 
+  dygraph(data=ci[,c('response', 
                      'point.pred', 'point.pred.lower', 'point.pred.upper')], 
-          main="Expected (95% confidence level) vs Observed", group="ci") %>%
-    dyEvent(x = event_date, "Event") %>%
-    dySeries(c('point.pred.lower', 'point.pred','point.pred.upper'), 
-             label='Expected') %>%
+          main="Expected (95% confidence level) vs Observed", group="ci") %>%
+    dyEvent(x = event_date, "Event") %>%
+    dySeries(c('point.pred.lower', 'point.pred','point.pred.upper'), 
+             label='Expected') %>%
     dySeries('response', label="Observed")
 }

The main functions done, we now specify which R packages the model needs the user to load.

-req_packs <- c("CausalImpact", "xts", "tidyr", "googleAnalyticsR", "assertthat", "dygraphs")
+req_packs <- c("CausalImpact", "xts", "tidyr", "googleAnalyticsR", "assertthat", "dygraphs")

Finally we make the model, specifying which columns we expect the data to fetch, a description and specifying which Shiny functions are needed to show the dygraph if the model is used in a Shiny app.

 ci_model <- ga_model_make(get_ci_data,
-                          required_columns = c("date","channelGrouping","sessions"),
+                          required_columns = c("date","channelGrouping","sessions"),
                           model_f = do_ci,
                           output_f = dygraph_plot,
                           required_packages = req_packs,
@@ -650,25 +652,25 @@ 

                           renderShiny = dygraphs::renderDygraph)
 # print out model details
 ci_model
-
## ==ga_model object==
-## Description:  Causal Impact on channelGrouping data 
-## Data args:    viewId date_range 
-## Input data:   date channelGrouping sessions 
-## Model args:   df event_date response predictors 
-## Output args:  impact event_date 
-## Packages:     CausalImpact xts tidyr googleAnalyticsR assertthat dygraphs
+
## ==ga_model object==
+## Description:  Causal Impact on channelGrouping data 
+## Data args:    viewId date_range 
+## Input data:   date channelGrouping sessions 
+## Model args:   df event_date response predictors 
+## Output args:  impact event_date 
+## Packages:     CausalImpact xts tidyr googleAnalyticsR assertthat dygraphs
 # save it to a file for use later
 ga_model_save(ci_model, "causalImpact_model.gamr")

To use and make an interactive plot:

-library(googleAnalyticsR)
-library(CausalImpact)
-library(xts)
-library(tidyr)
-library(dygraphs)
+library(googleAnalyticsR)
+library(CausalImpact)
+library(xts)
+library(tidyr)
+library(dygraphs)
 
-ci <- ga_model(81416156, ci_model, event_date = as.Date("2019-01-01"))
+ci <- ga_model(81416156, ci_model, event_date = as.Date("2019-01-01"))
 
 # print to show the plot object
 ci$plot
@@ -692,11 +694,13 @@

-

Developed by Mark Edmondson.

+

+

Developed by Mark Edmondson.

-

Site built with pkgdown 1.6.1.

+

+

Site built with pkgdown 2.0.1.

@@ -705,5 +709,7 @@

+ + diff --git a/docs/articles/practical-tips.html b/docs/articles/practical-tips.html index acd317f4..f9a08d21 100644 --- a/docs/articles/practical-tips.html +++ b/docs/articles/practical-tips.html @@ -23,15 +23,17 @@ + +
+

Practical Tips

- Source: vignettes/practical-tips.Rmd + Source: vignettes/practical-tips.Rmd
-
-

-Keep metrics and dimensions within easy reach

+
+

Keep metrics and dimensions within easy reach +

With several hundreds of metrics and dimensions available in GA it can be handy to have a reference of what’s what within easy reach. The ga_meta() function returns a table containing a list of all GA metrics and dimensions along with their definitions and other useful meta data.

If offline, this data is also available by typing meta, although it won’t be quite as up to date.
-(The meta data does not include multi-channel as they are not available, for those see the online version. )

+(The meta data does not include multi-channel as they are not available, for those see the online version. )

-
-

-Access information rapidly about your web properties and views

+
+

Access information rapidly about your web properties and views +

In a similar fashion, using the function ga_account_list() summarises all account web properties and views available to your user for a handy reference.

-
-

-Authenticate with the shared project intially -then consider setting up your own GCP project

-

There is detailed information about authentication options in the setup section, but as a rule of thumb:

+
+

Authenticate with the shared project intially -then consider setting up your own GCP project +

+

There is detailed information about authentication options in the setup section, but as a rule of thumb:

  • if you are experimenting or just making casual use of the library, then use the shared project option, which essentially requires no special setup.

  • if you use the API consistently and your work depends on it, then its preferable to set up your own Google Cloud Platform project.

  • If you are a developer working with machine to machine applications, then the service account is probably the most suitable option for you.

-
-

-Work with segments hybridly sometimes

-

To make the process of working with segments easier, googleAnalyticsR provides several options. These are examined in more detail in the API v4 section Sometimes it is also helpful to create a segment within the UI first and then refer to it by ID when working with the googleAnalyticsR library -especially when some quick experimentation is needed before deciding on the exact segment definition.

+
+

Work with segments hybridly sometimes +

+

To make the process of working with segments easier, googleAnalyticsR provides several options. These are examined in more detail in the API v4 section Sometimes it is also helpful to create a segment within the UI first and then refer to it by ID when working with the googleAnalyticsR library -especially when some quick experimentation is needed before deciding on the exact segment definition.

-
-

-Explore the user activity API for more data analysis options

-

Several types of statistical analysis require access to more fine grained data than what’s typically available via the Google Analytics standard version. The release of the user API has removed this constraint, so if you wish to explore a broader range of analysis methods you can now access the Google Analytics equivalent of a clickstream.

+
+

Explore the user activity API for more data analysis options +

+

Several types of statistical analysis require access to more fine grained data than what’s typically available via the Google Analytics standard version. The release of the user API has removed this constraint, so if you wish to explore a broader range of analysis methods you can now access the Google Analytics equivalent of a clickstream.

@@ -294,11 +296,13 @@

-

Developed by Mark Edmondson.

+

+

Developed by Mark Edmondson.

-

Site built with pkgdown 1.6.1.

+

+

Site built with pkgdown 2.0.1.

@@ -307,5 +311,7 @@

+ + diff --git a/docs/articles/reporting-ga4.html b/docs/articles/reporting-ga4.html index 0ca5edf0..29007640 100644 --- a/docs/articles/reporting-ga4.html +++ b/docs/articles/reporting-ga4.html @@ -23,15 +23,17 @@ + +
+

Data API for Google Analytics 4 (App+Web)

- Source: vignettes/reporting-ga4.Rmd + Source: vignettes/reporting-ga4.Rmd
-

The Data API and Google Analytics Admin API are used with the Google Analytics 4 properties, the newest version of Google Analytics and evolution from Universal Analytics.

-
-

-Google Analytics 4 - Data API Features

+

The Data API and Google Analytics Admin API are used with the Google Analytics 4 properties, the newest version of Google Analytics and evolution from Universal Analytics.

+
+

Google Analytics 4 - Data API Features +

  • Only API to fetch data from Google Analytics 4 properties
  • No sampling
    • @@ -264,25 +266,25 @@

  • Improved filter syntax

-
-

-Demo video

-

See a demo video on GA4 and some of the new ga_data() features in this GA4 API FTW YouTube video.

+
+

Demo video +

+

See a demo video on GA4 and some of the new ga_data() features in this GA4 API FTW YouTube video.

-
-

-GA4 enabled properties

-

You can see the GA4 accounts you have access to under your authentication via ga_account_list("ga4")

+
+

GA4 enabled properties +

+

You can see the GA4 accounts you have access to under your authentication via ga_account_list("ga4")

-
-

-Meta data for GA4

+
+

Meta data for GA4 +

Universal metadata for what you can query via the Data API can be found by specifying that API in the ga_meta() function:

 metadata <- ga_meta(version = "data")
@@ -292,9 +294,9 @@

ga_meta("data", propertyId = 206670707)

Custom events and user scoped custom dimensions have names starting with customEvent: and customUser: respectively. Include them in your reports with the prefix.

-
-

-Fetching GA4 Data into R

+
+

Fetching GA4 Data into R +

Make sure to authenticate first using ga_auth() or otherwise.

The primary data fetching function is ga_data()

You need your propertyId to query data, and then at least a metric and date range:

@@ -303,8 +305,8 @@

my_property_id <- 206670707 basic <- ga_data( my_property_id, - metrics = c("activeUsers","sessions"), - date_range = c("2020-03-31", "2020-04-27") + metrics = c("activeUsers","sessions"), + date_range = c("2020-03-31", "2020-04-27") ) basic @@ -317,9 +319,9 @@

# split out metrics by the dimensions specified dimensions <- ga_data( my_property_id, - metrics = c("activeUsers","sessions"), - dimensions = c("date","city","dayOfWeek"), - date_range = c("2020-03-31", "2020-04-27") + metrics = c("activeUsers","sessions"), + dimensions = c("date","city","dayOfWeek"), + date_range = c("2020-03-31", "2020-04-27") ) dimensions @@ -337,9 +339,9 @@

# 9 2020-04-08 Bologna 4 7 7 #10 2020-04-07 (not set) 3 6 7 # … with 90 more rows

-
-

-Event counts and names

+
+

Event counts and names +

Some of the most useful dimensions and metrics to fetch are eventName and eventCount, which is effectively the most granular report given the new GA4 data model. Combined with filters (see below) this can get you to useful conversion events.

 # if you set metrics=NULL you will get only the distinct events
@@ -347,7 +349,7 @@ 

     my_property_id, 
     metrics = NULL,
     dimensions = "eventName",
-    date_range = c("2020-03-31", "2020-04-27")
+    date_range = c("2020-03-31", "2020-04-27")
 )
 ## A tibble: 9 x 1
 #  eventName      
@@ -365,9 +367,9 @@ 

 # eventsCounts per eventName 
 events <- ga_data(
     my_property_id,
-    metrics = c("eventCount"),
-    dimensions = c("date","eventName"),
-    date_range = c("2020-03-31", "2020-04-27")
+    metrics = c("eventCount"),
+    dimensions = c("date","eventName"),
+    date_range = c("2020-03-31", "2020-04-27")
 )
 events
 ## A tibble: 100 x 3
@@ -383,7 +385,7 @@ 

     my_property_id, 
     metrics = "eventCount",
     dimensions = "eventName",
-    date_range = c("2020-03-31", "2020-04-27"),
+    date_range = c("2020-03-31", "2020-04-27"),
     dim_filters = ga_data_filter(eventName=="video_start")
 )
 ## A tibble: 1 x 2
@@ -391,16 +393,16 @@ 

 #  <chr>            <dbl>
 #1 video_start          4
-
-

-Row limits

+
+

Row limits +

By default the API returns 100 results. Add the limit parameter to change the number of results returned. To get all results, use -1

 only_5 <- ga_data(
     my_property_id,
-    metrics = c("activeUsers","sessions"),
-    dimensions = c("date","city","dayOfWeek"),
-    date_range = c("2020-03-31", "2020-04-27"),
+    metrics = c("activeUsers","sessions"),
+    dimensions = c("date","city","dayOfWeek"),
+    date_range = c("2020-03-31", "2020-04-27"),
     limit = 5
 )
 
@@ -416,9 +418,9 @@ 

 
 all_results <- ga_data(
     my_property_id,
-    metrics = c("activeUsers","sessions"),
-    dimensions = c("date","city","dayOfWeek"),
-    date_range = c("2020-03-31", "2020-04-27"),
+    metrics = c("activeUsers","sessions"),
+    dimensions = c("date","city","dayOfWeek"),
+    date_range = c("2020-03-31", "2020-04-27"),
     limit = -1
 )
 
@@ -442,9 +444,9 @@ 

 # get all results, but page every 500 rows
 all_results_paged <- ga_data(
   my_property_id,
-  metrics = c("activeUsers","sessions"),
-  dimensions = c("date","city","dayOfWeek"),
-  date_range = c("2020-03-31", "2020-04-27"),
+  metrics = c("activeUsers","sessions"),
+  dimensions = c("date","city","dayOfWeek"),
+  date_range = c("2020-03-31", "2020-04-27"),
   limit = -1,
   page_size = 500L
 )
@@ -459,9 +461,9 @@ 

 # get 510 rows, page every 500 rows (so 2 total)
 top510_paged500 <- ga_data(
   my_property_id,
-  metrics = c("activeUsers","sessions"),
-  dimensions = c("date","city","dayOfWeek"),
-  date_range = c("2020-03-31", "2020-04-27"),
+  metrics = c("activeUsers","sessions"),
+  dimensions = c("date","city","dayOfWeek"),
+  date_range = c("2020-03-31", "2020-04-27"),
   limit = 510,
   page_size = 500L
 )
@@ -469,24 +471,24 @@ 

 #ℹ 2021-02-20 12:26:45 > Paging API from offset [ 500 ]
 #ℹ 2021-02-20 12:26:46 > Downloaded [ 10 ] of total [ 1763 ] rows
-
-

-Custom definitions

-

When fetching custom dimensions and metrics, specify the prefix as you read it in the meta data table. See this Google article on custom definitions for details.

+
+

Custom definitions +

+

When fetching custom dimensions and metrics, specify the prefix as you read it in the meta data table. See this Google article on custom definitions for details.

 # will include your custom data
 my_meta <- ga_meta("data", propertyId = 206670707)
 
 custom <- ga_data(
     my_property_id,
-    metrics = c("customEvent:credits_spent"),
-    dimensions = c("date","customUser:last_level","customEvent:achievement_id"),
-    date_range = c("2020-03-31", "2020-04-27"),
+    metrics = c("customEvent:credits_spent"),
+    dimensions = c("date","customUser:last_level","customEvent:achievement_id"),
+    date_range = c("2020-03-31", "2020-04-27"),
     limit = -1
 )
-
-

-Calculated fields

+
+

Calculated fields +

You can also create custom metrics and dimensions on the fly with calculated metrics. These let you send in combinations of metrics or dimensions:

 # metric and dimension expressions
@@ -494,9 +496,9 @@ 

 # create your own named metrics
 ga_data(
    my_property_id,
-   metrics = c("activeUsers","sessions",sessionsPerUser = "sessions/activeUsers"),
-   dimensions = c("date","city","dayOfWeek"),
-   date_range = c("2020-03-31", "2020-04-27"),
+   metrics = c("activeUsers","sessions",sessionsPerUser = "sessions/activeUsers"),
+   dimensions = c("date","city","dayOfWeek"),
+   date_range = c("2020-03-31", "2020-04-27"),
    limit = 100
    )
 ## A tibble: 100 x 6
@@ -511,9 +513,9 @@ 

 # create your own aggregation dimensions
 ga_data(
    my_property_id,
-   metrics = c("activeUsers","sessions"),
-   dimensions = c("date","city","dayOfWeek", cdow = "city/dayOfWeek"),
-   date_range = c("2020-03-31", "2020-04-27"),
+   metrics = c("activeUsers","sessions"),
+   dimensions = c("date","city","dayOfWeek", cdow = "city/dayOfWeek"),
+   date_range = c("2020-03-31", "2020-04-27"),
    limit = 100
    )
 ## A tibble: 100 x 6
@@ -526,9 +528,9 @@ 

 # useful for creating referral data
 ga_data(
     my_property_id,
-    metrics = c("activeUsers","sessions"),
-    dimensions = c("date", sessionMediumSource = "sessionMedium/sessionSource"),
-    date_range = c("2020-03-31", "2020-04-27"),
+    metrics = c("activeUsers","sessions"),
+    dimensions = c("date", sessionMediumSource = "sessionMedium/sessionSource"),
+    date_range = c("2020-03-31", "2020-04-27"),
     limit = 100
 )
 ## A tibble: 100 x 4
@@ -540,16 +542,16 @@
-
-

-Date Ranges

+
+

Date Ranges +

You can send in up to 4 date ranges, via a vector of dates:

 date_range4 <- ga_data(
     my_property_id,
-    metrics = c("activeUsers","sessions"),
-    dimensions = c("date","city","dayOfWeek"),
-    date_range = c("2020-03-31", "2020-04-06", 
+    metrics = c("activeUsers","sessions"),
+    dimensions = c("date","city","dayOfWeek"),
+    date_range = c("2020-03-31", "2020-04-06", 
                    "2020-04-07", "2020-04-14", 
                    "2020-04-15", "2020-04-22", 
                    "2020-04-23", "2020-04-30"),
@@ -568,18 +570,18 @@ 

 # 5 2020-04-16 Charlottesville 5         date_range_2           1        1
 # 6 2020-04-25 Fulshear        7         date_range_3           1        1
 # … with 7,938 more rows
-

You can send in dates as strings in YYYY-MM-DD format; as R Dates (e.g. Sys.Date()) or via the API keywords “today”, “yesterday”, or “NdaysAgo”)

+

You can send in dates as strings in YYYY-MM-DD format; as R Dates (e.g. Sys.Date()) or via the API keywords “today”, “yesterday”, or “NdaysAgo”)

 # use R to make useful date vectors
-dates <- rev(seq(Sys.Date(), by = -7, length.out = 8))
+dates <- rev(seq(Sys.Date(), by = -7, length.out = 8))
 dates
 #[1] "2020-10-19" "2020-10-26" "2020-11-02" "2020-11-09" "2020-11-16" "2020-11-23" "2020-11-30" "2020-12-07"
 
 # r dates
 ga_data(
     my_property_id,
-    metrics = c("activeUsers","sessions"),
-    dimensions = c("date","city","dayOfWeek"),
+    metrics = c("activeUsers","sessions"),
+    dimensions = c("date","city","dayOfWeek"),
     date_range = dates,
     limit = -1
 )
@@ -588,22 +590,22 @@ 

 # text dates
 ga_data(
     my_property_id,
-    metrics = c("activeUsers","sessions"),
-    dimensions = c("date","city","dayOfWeek"),
-    date_range = c("yesterday","today","3daysAgo","2daysAgo"),
+    metrics = c("activeUsers","sessions"),
+    dimensions = c("date","city","dayOfWeek"),
+    date_range = c("yesterday","today","3daysAgo","2daysAgo"),
     limit = -1)
-
-

-Filters

+
+

Filters +

Filters are simpler to create but more flexible than in Universal Analytics.

There is now only one filter function - ga_data_filter(). As was the case for google_analytics() , you use the filter function to construct metric filters or dimension filters in the dim_filters or met_filters parameters in your ga_data() call.

 ga_data(
    206670707,
-   metrics = c("activeUsers","sessions"),
-   dimensions = c("date","city","dayOfWeek"),
-   date_range = c("2020-03-31", "2020-04-27"),
+   metrics = c("activeUsers","sessions"),
+   dimensions = c("date","city","dayOfWeek"),
+   date_range = c("2020-03-31", "2020-04-27"),
    dim_filters = ga_data_filter(city=="Copenhagen"),
    limit = 100
    )
@@ -615,33 +617,33 @@ 

 # 3 2020-04-15 Copenhagen 4                   2        2
 # 4 2020-04-17 Copenhagen 6                   2        2
 # ...
-
-

-Making filter elements

+
+

Making filter elements +

The base object is ga_data_filter() - this holds the logic for the specific metric or dimension you are using. The function uses a new DSL for GA4 filters, the syntax rules are detailed below:

  • A single filter, or multiple filters within a filter expression can be passed in to ga_data()
  • The single filter syntax is (field) (operator) (value) e.g. city=="Copenhagen"
    • -
  • (field) is a dimension or metric for your web property, which you can review via ga_meta("data") +
  • (field) is a dimension or metric for your web property, which you can review via ga_meta("data")
  • (field) can be quoted ("city", "session"), or unquoted ( city or session) if you want to use validation.
    • -
  • (field) validation for unquoted fields is available if using default metadata (e.g. city or session), or you have fetched your custom fields via ga_meta("data", propertyId=123456) +
  • (field) validation for unquoted fields is available if using default metadata (e.g. city or session), or you have fetched your custom fields via ga_meta("data", propertyId=123456)
  • (operator) can be one of ==, >, >=, <, <= for metrics
  • (operator) can be one of ==, %begins%, %ends%, %contains%, %contains%, %regex%, %regex_partial% for dimensions
  • dimension (operator) are by default case sensitive. Make them case insensitive by using UPPER case variations %BEGINS%, %ENDS% etc. or %==% for case insensitive exact matches
    • -
  • (value) can be strings ("dim1"), numerics (55), string vectors (c("dim1", "dim2")), numeric vectors (c(1,2,3)) or NULL (NULL) which will correspond to different types of filters
    • +
  • (value) can be strings ("dim1"), numerics (55), string vectors (c("dim1", "dim2")), numeric vectors (c(1,2,3)) or NULL (NULL) which will correspond to different types of filters
  • Filter expressions for multiple filters when using the operators: &, |, ! which correspond to AND, OR and NOT respectively.
-
-

-Filter Fields

-

Fields are metrics and dimensions that are available to your GA4 implementation, including custom fields. You can see what is available by calling the ga_meta("data") function.

+
+

Filter Fields +

+

Fields are metrics and dimensions that are available to your GA4 implementation, including custom fields. You can see what is available by calling the ga_meta("data") function.

Do not construct metric filters and use in the dim_filters argument or vice-versa.

You can use quoted ("city", "session") or unquoted fields ( city or session) which will check the field is valid before you send it to the API.

-

If you want to use custom fields from your property, do a call to ga_meta("data", propertyId=1234546) replacing your propertyId for the GA4 property that has the custom fields. Once fetched, they will be placed in your local environment for all future calls to ga_data_filter() - use the custom events with a cust_ prefix e.g.

+

If you want to use custom fields from your property, do a call to ga_meta("data", propertyId=1234546) replacing your propertyId for the GA4 property that has the custom fields. Once fetched, they will be placed in your local environment for all future calls to ga_data_filter() - use the custom events with a cust_ prefix e.g.

 # gets fields including custom event field "customEvent:test_dim"
 my_meta <- ga_meta("data", propertyId = 206670707)
@@ -649,39 +651,39 @@ 

 # use the custom event in a filter
 ga_data_filter(cust_test_dim == "test")
-
-

-Filter Values

+
+

Filter Values +

Values are checked in the filter object based on the R class of the object you are passing in as its value:

  • character: stringFilter - e.g. "Copenhagen"
  • -character vector: inListFilter e.g. c("Copenhagen","London","New York") +character vector: inListFilter e.g. c("Copenhagen","London","New York")
  • numeric: NumericFilter e.g. 5
  • -numeric 2-length vector: BetweenFilter e.g. c(5, 10) +numeric 2-length vector: BetweenFilter e.g. c(5, 10)
  • -NULL: Will filter for NULL e.g. city==NULL - often used with ! (not NULL)
    • +NULL: Will filter for NULL e.g. city==NULL - often used with ! (not NULL)
-

e.g. if you pass in a character of length one ("Copenhagen") then it will assume to be a class StringFilter (all dimensions that match “Copenhagen”) if you pass in a character of length greater than one c("Copenhagen","London","New York"), then it assume to be a class InListFilter (dimensions must match one in the list)

+

e.g. if you pass in a character of length one ("Copenhagen") then it will assume to be a class StringFilter (all dimensions that match “Copenhagen”) if you pass in a character of length greater than one c("Copenhagen","London","New York"), then it assume to be a class InListFilter (dimensions must match one in the list)

-
-

-Examples Using GA4 Filters

+
+

Examples Using GA4 Filters +

All filters are made up of filter expressions using ga_data_filter():

 simple_filter <- ga_data(
    206670707,
-   metrics = c("activeUsers","sessions"),
-   dimensions = c("date","city","dayOfWeek"),
-   date_range = c("2020-03-31", "2020-04-27"),
+   metrics = c("activeUsers","sessions"),
+   dimensions = c("date","city","dayOfWeek"),
+   date_range = c("2020-03-31", "2020-04-27"),
    dim_filters = ga_data_filter(city=="Copenhagen"),
    limit = 100
    )
@@ -700,99 +702,99 @@ 

 ## filter clauses
 # OR string filter
 ga_data_filter(city=="Copenhagen" | city == "London")
-
## ===orGroup:  
-## [[1]]
-## --GA4 Filter:  
-## --| city 
-## ----stringFilter:  
-## value:  Copenhagen | matchType:  EXACT | caseSensitive:  TRUE
-## [[2]]
-## --GA4 Filter:  
-## --| city 
-## ----stringFilter:  
-## value:  London | matchType:  EXACT | caseSensitive:  TRUE
+
## ===orGroup:  
+## [[1]]
+## --GA4 Filter:  
+## --| city 
+## ----stringFilter:  
+## value:  Copenhagen | matchType:  EXACT | caseSensitive:  TRUE
+## [[2]]
+## --GA4 Filter:  
+## --| city 
+## ----stringFilter:  
+## value:  London | matchType:  EXACT | caseSensitive:  TRUE
 # inlist string filter - equivalent to above
-ga_data_filter(city==c("Copenhagen","London"))
-
## --| city 
-## ----inListFilter:  
-## values:  Copenhagen London 
-## caseSensitive:  TRUE
+ga_data_filter(city==c("Copenhagen","London"))
+
## --| city 
+## ----inListFilter:  
+## values:  Copenhagen London 
+## caseSensitive:  TRUE
 # AND string filters
 ga_data_filter(city=="Copenhagen" & dayOfWeek == "5")
-
## ===andGroup:  
-## [[1]]
-## --GA4 Filter:  
-## --| city 
-## ----stringFilter:  
-## value:  Copenhagen | matchType:  EXACT | caseSensitive:  TRUE
-## [[2]]
-## --GA4 Filter:  
-## --| dayOfWeek 
-## ----stringFilter:  
-## value:  5 | matchType:  EXACT | caseSensitive:  TRUE
+
## ===andGroup:  
+## [[1]]
+## --GA4 Filter:  
+## --| city 
+## ----stringFilter:  
+## value:  Copenhagen | matchType:  EXACT | caseSensitive:  TRUE
+## [[2]]
+## --GA4 Filter:  
+## --| dayOfWeek 
+## ----stringFilter:  
+## value:  5 | matchType:  EXACT | caseSensitive:  TRUE
 # NOT string filter
 ga_data_filter(!(city=="Copenhagen" | city == "London"))
-
## ===notExpression:  
-## ===orGroup:  
-## [[1]]
-## --GA4 Filter:  
-## --| city 
-## ----stringFilter:  
-## value:  Copenhagen | matchType:  EXACT | caseSensitive:  TRUE
-## [[2]]
-## --GA4 Filter:  
-## --| city 
-## ----stringFilter:  
-## value:  London | matchType:  EXACT | caseSensitive:  TRUE
+
## ===notExpression:  
+## ===orGroup:  
+## [[1]]
+## --GA4 Filter:  
+## --| city 
+## ----stringFilter:  
+## value:  Copenhagen | matchType:  EXACT | caseSensitive:  TRUE
+## [[2]]
+## --GA4 Filter:  
+## --| city 
+## ----stringFilter:  
+## value:  London | matchType:  EXACT | caseSensitive:  TRUE
 # multiple filter clauses
-ga_data_filter(city==c("Copenhagen","London","Paris","New York") &
+ga_data_filter(city==c("Copenhagen","London","Paris","New York") &
                  (dayOfWeek=="5" | dayOfWeek=="6"))
-
## =======andGroup:  
-## [[1]]
-## --GA4 Filter:  
-## --| city 
-## ----inListFilter:  
-## values:  Copenhagen London Paris New York 
-## caseSensitive:  TRUE 
-## 
-## [[2]]
-## ===orGroup:  
-## [[1]]
-## --GA4 Filter:  
-## --| dayOfWeek 
-## ----stringFilter:  
-## value:  5 | matchType:  EXACT | caseSensitive:  TRUE
-## [[2]]
-## --GA4 Filter:  
-## --| dayOfWeek 
-## ----stringFilter:  
-## value:  6 | matchType:  EXACT | caseSensitive:  TRUE
-
-

-Filter field validation

+
## =======andGroup:  
+## [[1]]
+## --GA4 Filter:  
+## --| city 
+## ----inListFilter:  
+## values:  Copenhagen London Paris New York 
+## caseSensitive:  TRUE 
+## 
+## [[2]]
+## ===orGroup:  
+## [[1]]
+## --GA4 Filter:  
+## --| dayOfWeek 
+## ----stringFilter:  
+## value:  5 | matchType:  EXACT | caseSensitive:  TRUE
+## [[2]]
+## --GA4 Filter:  
+## --| dayOfWeek 
+## ----stringFilter:  
+## value:  6 | matchType:  EXACT | caseSensitive:  TRUE
+
+

Filter field validation +

Validation is carried out if the field is unquoted. If you don’t want validation use quotes.

 # validation of fields - correct
 ga_data_filter(city=="Copenhagen")
-
## --| city 
-## ----stringFilter:  
-## value:  Copenhagen | matchType:  EXACT | caseSensitive:  TRUE
+
## --| city 
+## ----stringFilter:  
+## value:  Copenhagen | matchType:  EXACT | caseSensitive:  TRUE
 # validation of fields - error
-tryCatch(ga_data_filter(cittty=="Copenhagen"), 
+tryCatch(ga_data_filter(cittty=="Copenhagen"), 
          error = function(err) err$message)
-
## [1] "object 'cittty' not found"
+
## [1] "object 'cittty' not found"
 # avoid validation by quoting
 ga_data_filter("cittty"=="Copenhagen")
-
## --| cittty 
-## ----stringFilter:  
-## value:  Copenhagen | matchType:  EXACT | caseSensitive:  TRUE
-

For custom fields use ga_meta("data", propertyId=12345) first to fetch them.

+
## --| cittty 
+## ----stringFilter:  
+## value:  Copenhagen | matchType:  EXACT | caseSensitive:  TRUE
+

For custom fields use ga_meta("data", propertyId=12345) first to fetch them.

 # gets fields including custom event field "customEvent:test_dim"
 my_meta <- ga_meta("data", propertyId = 206670707)
@@ -800,17 +802,16 @@ 

 # use the custom event in a filter
 ga_data_filter(cust_test_dim == "test")
-
-

-Numeric filters for use in met_filters +
+

Numeric filters for use in met_filters

An example of metric filters are below:

 metric_filter <- ga_data(
    206670707,
-   metrics = c("activeUsers","sessions"),
-   dimensions = c("date","city","dayOfWeek"),
-   date_range = c("2020-03-31", "2020-04-27"),
+   metrics = c("activeUsers","sessions"),
+   dimensions = c("date","city","dayOfWeek"),
+   date_range = c("2020-03-31", "2020-04-27"),
    met_filters = ga_data_filter(sessions>10),
    limit = 100
    )
@@ -828,165 +829,164 @@ 

 ## numeric filter types
 # numeric equal filter
 ga_data_filter(sessions==5)
-
## --| sessions 
-## ----numericFilter:  
-## operation:  EQUAL | value:      5
+
## --| sessions 
+## ----numericFilter:  
+## operation:  EQUAL | value:      5
 # between numeric filter
-ga_data_filter(sessions==c(5,6))
-
## --| sessions 
-## ----betweenFilter:  
-## from:  5  to:  6
+ga_data_filter(sessions==c(5,6))
+
## --| sessions 
+## ----betweenFilter:  
+## from:  5  to:  6
 # greater than numeric
 ga_data_filter(sessions > 0)
-
## --| sessions 
-## ----numericFilter:  
-## operation:  GREATER_THAN | value:      0
+
## --| sessions 
+## ----numericFilter:  
+## operation:  GREATER_THAN | value:      0
 # greater than or equal
 ga_data_filter(sessions >= 1)
-
## --| sessions 
-## ----numericFilter:  
-## operation:  GREATER_THAN_OR_EQUAL | value:      1
+
## --| sessions 
+## ----numericFilter:  
+## operation:  GREATER_THAN_OR_EQUAL | value:      1
 # less than numeric
 ga_data_filter(sessions < 100)
-
## --| sessions 
-## ----numericFilter:  
-## operation:  LESS_THAN | value:      100
+
## --| sessions 
+## ----numericFilter:  
+## operation:  LESS_THAN | value:      100
 # less than or equal numeric
 ga_data_filter(sessions <= 100)
-
## --| sessions 
-## ----numericFilter:  
-## operation:  LESS_THAN_OR_EQUAL | value:      100
+
## --| sessions 
+## ----numericFilter:  
+## operation:  LESS_THAN_OR_EQUAL | value:      100

-
-

-Dimension filters for use in dim_filters +
+

Dimension filters for use in dim_filters

All the string filters that can be used are below:

 ## string filter types
 # begins with string
 ga_data_filter(city %begins% "Cope")
-
## --| city 
-## ----stringFilter:  
-## value:  Cope | matchType:  BEGINS_WITH | caseSensitive:  TRUE
+
## --| city 
+## ----stringFilter:  
+## value:  Cope | matchType:  BEGINS_WITH | caseSensitive:  TRUE
 # ends with string
 ga_data_filter(city %ends% "hagen")
-
## --| city 
-## ----stringFilter:  
-## value:  hagen | matchType:  ENDS_WITH | caseSensitive:  TRUE
+
## --| city 
+## ----stringFilter:  
+## value:  hagen | matchType:  ENDS_WITH | caseSensitive:  TRUE
 # contains string
-ga_data_filter(city %contains% "ope")
-
## --| city 
-## ----stringFilter:  
-## value:  ope | matchType:  CONTAINS | caseSensitive:  TRUE
+ga_data_filter(city %contains% "ope")
+
## --| city 
+## ----stringFilter:  
+## value:  ope | matchType:  CONTAINS | caseSensitive:  TRUE
 # regex (full) string
 ga_data_filter(city %regex% "^Cope")
-
## --| city 
-## ----stringFilter:  
-## value:  ^Cope | matchType:  FULL_REGEXP | caseSensitive:  TRUE
+
## --| city 
+## ----stringFilter:  
+## value:  ^Cope | matchType:  FULL_REGEXP | caseSensitive:  TRUE
 # regex (partial) string
 ga_data_filter(city %regex_partial% "ope")
-
## --| city 
-## ----stringFilter:  
-## value:  ope | matchType:  PARTIAL_REGEXP | caseSensitive:  TRUE
+
## --| city 
+## ----stringFilter:  
+## value:  ope | matchType:  PARTIAL_REGEXP | caseSensitive:  TRUE

By default string filters are case sensitive. Use UPPERCASE operator to make then case insensitive

 # begins with string (case insensitive)
 ga_data_filter(city %BEGINS% "cope")
-
## --| city 
-## ----stringFilter:  
-## value:  cope | matchType:  BEGINS_WITH | caseSensitive:  FALSE
+
## --| city 
+## ----stringFilter:  
+## value:  cope | matchType:  BEGINS_WITH | caseSensitive:  FALSE
 # ends with string (case insensitive)
 ga_data_filter(city %ENDS% "Hagen")
-
## --| city 
-## ----stringFilter:  
-## value:  Hagen | matchType:  ENDS_WITH | caseSensitive:  FALSE
+
## --| city 
+## ----stringFilter:  
+## value:  Hagen | matchType:  ENDS_WITH | caseSensitive:  FALSE
 # case insensitive exact match
 ga_data_filter(city %==% "copeNHAGen")
-
## --| city 
-## ----stringFilter:  
-## value:  copeNHAGen | matchType:  EXACT | caseSensitive:  FALSE
+
## --| city 
+## ----stringFilter:  
+## value:  copeNHAGen | matchType:  EXACT | caseSensitive:  FALSE

-
-

-Complex filters

+
+

Complex filters +

You can also recursively nest filter expressions to make more complicated ones.

The filter below looks for visitors from Copenhagen, London, Paris or New York who arrived on day 5 or 6 of the week, or from Google referrers but not including Google Ads.

 # use previously created filters to build another filter expression:
 # multiple filter clauses
-f1 <- ga_data_filter(city==c("Copenhagen","London","Paris","New York") &
+f1 <- ga_data_filter(city==c("Copenhagen","London","Paris","New York") &
                        (dayOfWeek=="5" | dayOfWeek=="6")) 
 
 # build up complicated filters
 f2 <- ga_data_filter(f1 | sessionSource=="google" & !city=="(not set)")
 f3 <- ga_data_filter(f2 & !sessionMedium=="cpc")
 f3
-
## ===============andGroup:  
-## [[1]]
-## ===========orGroup:  
-## [[1]]
-## =======andGroup:  
-## [[1]]
-## --GA4 Filter:  
-## --| city 
-## ----inListFilter:  
-## values:  Copenhagen London Paris New York 
-## caseSensitive:  TRUE 
-## 
-## [[2]]
-## ===orGroup:  
-## [[1]]
-## --GA4 Filter:  
-## --| dayOfWeek 
-## ----stringFilter:  
-## value:  5 | matchType:  EXACT | caseSensitive:  TRUE
-## [[2]]
-## --GA4 Filter:  
-## --| dayOfWeek 
-## ----stringFilter:  
-## value:  6 | matchType:  EXACT | caseSensitive:  TRUE
-## 
-## 
-## [[2]]
-## ===andGroup:  
-## [[1]]
-## --GA4 Filter:  
-## --| sessionSource 
-## ----stringFilter:  
-## value:  google | matchType:  EXACT | caseSensitive:  TRUE
-## [[2]]
-## notExpression:  
-## --GA4 Filter:  
-## --| city 
-## ----stringFilter:  
-## value:  (not set) | matchType:  EXACT | caseSensitive:  TRUE
-## 
-## 
-## [[2]]
-## notExpression:  
-## --GA4 Filter:  
-## --| sessionMedium 
-## ----stringFilter:  
-## value:  cpc | matchType:  EXACT | caseSensitive:  TRUE
+
## ===============andGroup:  
+## [[1]]
+## ===========orGroup:  
+## [[1]]
+## =======andGroup:  
+## [[1]]
+## --GA4 Filter:  
+## --| city 
+## ----inListFilter:  
+## values:  Copenhagen London Paris New York 
+## caseSensitive:  TRUE 
+## 
+## [[2]]
+## ===orGroup:  
+## [[1]]
+## --GA4 Filter:  
+## --| dayOfWeek 
+## ----stringFilter:  
+## value:  5 | matchType:  EXACT | caseSensitive:  TRUE
+## [[2]]
+## --GA4 Filter:  
+## --| dayOfWeek 
+## ----stringFilter:  
+## value:  6 | matchType:  EXACT | caseSensitive:  TRUE
+## 
+## 
+## [[2]]
+## ===andGroup:  
+## [[1]]
+## --GA4 Filter:  
+## --| sessionSource 
+## ----stringFilter:  
+## value:  google | matchType:  EXACT | caseSensitive:  TRUE
+## [[2]]
+## notExpression:  
+## --GA4 Filter:  
+## --| city 
+## ----stringFilter:  
+## value:  (not set) | matchType:  EXACT | caseSensitive:  TRUE
+## 
+## 
+## [[2]]
+## notExpression:  
+## --GA4 Filter:  
+## --| sessionMedium 
+## ----stringFilter:  
+## value:  cpc | matchType:  EXACT | caseSensitive:  TRUE

You can use filter expression objects above directly like so:

 complex_filter <- ga_data(
    206670707,
-   metrics = c("activeUsers","sessions"),
-   dimensions = c("date","city","dayOfWeek"),
-   date_range = c("2020-03-31", "2020-04-27"),
+   metrics = c("activeUsers","sessions"),
+   dimensions = c("date","city","dayOfWeek"),
+   date_range = c("2020-03-31", "2020-04-27"),
    dim_filters = f3,
    limit = 100
    )
@@ -1003,58 +1003,58 @@
-
-

-Ordering

+
+

Ordering +

You can order or sort results using a new DSL via the function ga_data_order() that operate on the fields (dimensions/metrics) in your returned data.

-

The DSL will validate the fields you are sending in are valid. You then prefix the field with a + for ascending order or - for descending order like so:

+

The DSL will validate the fields you are sending in are valid. You then prefix the field with a + for ascending order or - for descending order like so:

 # session in descending order
 ga_data_order(-sessions)
-
## [[1]]
-## ==GA4 OrderBy==
-## Metric:        sessions 
-## Descending:    TRUE
+
## [[1]]
+## ==GA4 OrderBy==
+## Metric:        sessions 
+## Descending:    TRUE
 # city dimension in ascending alphanumeric order
 ga_data_order(+city)
-
## [[1]]
-## ==GA4 OrderBy==
-## Dimension:     city 
-## OrderType:     ALPHANUMERIC 
-## Descending:    FALSE
+
## [[1]]
+## ==GA4 OrderBy==
+## Dimension:     city 
+## OrderType:     ALPHANUMERIC 
+## Descending:    FALSE

You can have multiple orders - add the -/+{field} after the former without commas:

 # as above plus sessions in descending order
 ga_data_order(+city -sessions)
-
## [[1]]
-## ==GA4 OrderBy==
-## Dimension:     city 
-## OrderType:     ALPHANUMERIC 
-## Descending:    FALSE 
-## 
-## [[2]]
-## ==GA4 OrderBy==
-## Metric:        sessions 
-## Descending:    TRUE
+
## [[1]]
+## ==GA4 OrderBy==
+## Dimension:     city 
+## OrderType:     ALPHANUMERIC 
+## Descending:    FALSE 
+## 
+## [[2]]
+## ==GA4 OrderBy==
+## Metric:        sessions 
+## Descending:    TRUE
 # as above plus activeUsers in ascending order
 ga_data_order(+city -sessions +activeUsers)
-
## [[1]]
-## ==GA4 OrderBy==
-## Dimension:     city 
-## OrderType:     ALPHANUMERIC 
-## Descending:    FALSE 
-## 
-## [[2]]
-## ==GA4 OrderBy==
-## Metric:        sessions 
-## Descending:    TRUE 
-## 
-## [[3]]
-## ==GA4 OrderBy==
-## Metric:        activeUsers 
-## Descending:    FALSE
+
## [[1]]
+## ==GA4 OrderBy==
+## Dimension:     city 
+## OrderType:     ALPHANUMERIC 
+## Descending:    FALSE 
+## 
+## [[2]]
+## ==GA4 OrderBy==
+## Metric:        sessions 
+## Descending:    TRUE 
+## 
+## [[3]]
+## ==GA4 OrderBy==
+## Metric:        activeUsers 
+## Descending:    FALSE

For dimensions, you have a choice on what type of sort is available:

  • @@ -1068,9 +1068,9 @@ 

     ga_data(
   206670707,
-  metrics = c("activeUsers","sessions"),
-  dimensions = c("date","city","dayOfWeek"),
-  date_range = c("2020-03-31", "2020-04-27"),
+  metrics = c("activeUsers","sessions"),
+  dimensions = c("date","city","dayOfWeek"),
+  date_range = c("2020-03-31", "2020-04-27"),
   orderBys = ga_data_order(-sessions -dayOfWeek)
   )
 ## A tibble: 100 x 5
@@ -1084,17 +1084,17 @@ 
    
 # 6 2020-04-21 Amsterdam      3                   3       11
 # 7 2020-04-27 (not set)      2                   9       11
 # ...
    -

    You can also combine ga_data_order() objects with c()

    +

    You can also combine ga_data_order() objects with c()

     a <- ga_data_order(-sessions)
 b <- ga_data_order(-dayOfWeek, type = "NUMERIC")
 
 ga_data(
     206670707,
-    metrics = c("activeUsers","sessions"),
-    dimensions = c("date","city","dayOfWeek"),
-    date_range = c("2020-03-31", "2020-04-27"),
-    orderBys = c(a, b),
+    metrics = c("activeUsers","sessions"),
+    dimensions = c("date","city","dayOfWeek"),
+    date_range = c("2020-03-31", "2020-04-27"),
+    orderBys = c(a, b),
     limit = 100
 )
 ## A tibble: 100 x 5
@@ -1108,19 +1108,19 @@ 
    
 # 6 2020-04-21 Amsterdam      3                   3       11
 # 7 2020-04-27 (not set)      2                   9       11
 # ...
    -
    -

    -Order Fields

    -

    Fields are metrics and dimensions that are available to your GA4 implementation, including custom fields. You can see what is available by calling the ga_meta("data") function.

    +
    +

    Order Fields +

    +

    Fields are metrics and dimensions that are available to your GA4 implementation, including custom fields. You can see what is available by calling the ga_meta("data") function.

    You can use quoted ("city", "session") or unquoted fields ( city or session) which will check the field is valid before you send it to the API.

    -

    If you want to use custom fields from your property, do a call to ga_meta("data", propertyId=1234546) similar to the filter fields explained above, and prefix the custom field with cust_

    +

    If you want to use custom fields from your property, do a call to ga_meta("data", propertyId=1234546) similar to the filter fields explained above, and prefix the custom field with cust_

    -
    -

    -Real Time Data

    +
    +

    Real Time Data +

    Real-time data can be fetched with the same function as the regular Data API, but it is calling another endpoint. Add the realtime=TRUE argument to the function.

    -

    A limited subset of dimensions and metrics are available in the real-time API. Date ranges are ignored.

    +

    A limited subset of dimensions and metrics are available in the real-time API. Date ranges are ignored.

     # run a real-time report 
 realtime <- ga_data(
@@ -1131,16 +1131,16 @@ 
    
   limit = 100,
   realtime = TRUE)
    -
    -

    -Metric Aggregations

    -

    Each API call includes the TOTAL, MAXIMUM and MINIMUM metric aggregations in the returned data.frame’s metadata. You can access this data using base R’s attr() function or use ga_data_aggregations() to extract the data.frames:

    +
    +

    Metric Aggregations +

    +

    Each API call includes the TOTAL, MAXIMUM and MINIMUM metric aggregations in the returned data.frame’s metadata. You can access this data using base R’s attr() function or use ga_data_aggregations() to extract the data.frames:

     aggs <- ga_data(
       206670707, 
-      date_range = c(Sys.Date() - 4, Sys.Date() - 1),
+      date_range = c(Sys.Date() - 4, Sys.Date() - 1),
       metrics = "activeUsers",
-      dimensions = c("city","unifiedScreenName"),
+      dimensions = c("city","unifiedScreenName"),
       limit = 100)
       
 all_aggs <- ga_data_aggregations(aggs, type = "all")
@@ -1180,7 +1180,7 @@ 
    
 
    If you request more than one date range, the aggregations will be calculated for each one:
    
 
     # use R to generate some dates
-dates <- rev(seq(Sys.Date(), by = -7, length.out = 8))
+dates <- rev(seq(Sys.Date(), by = -7, length.out = 8))
 dates
 #[1] "2020-10-19" "2020-10-26" "2020-11-02" "2020-11-09" "2020-11-16" "2020-11-23" "2020-11-30" "2020-12-07"
 
@@ -1188,7 +1188,7 @@ 
    
     206670707, 
     date_range = dates,
     metrics = "activeUsers",
-    dimensions = c("city","unifiedScreenName"),
+    dimensions = c("city","unifiedScreenName"),
     limit = 100)
     
 # get the totals
@@ -1201,27 +1201,27 @@ 
    
 #3 RESERVED_TOTAL RESERVED_TOTAL    date_range_2           2
 #4 RESERVED_TOTAL RESERVED_TOTAL    date_range_3         399
    -
    -

    -Quotas

    -

    There is no sampling but there are token quotas for API fetches on a per-project basis. Normally these are not visible until you are close to the quota limits, but you can see them if you set the googleAuthR verbose level below 3 (options(googleAuthR.verbose=2))) or if the API call costs more than 50 units.

    +
    +

    Quotas +

    +

    There is no sampling but there are token quotas for API fetches on a per-project basis. Normally these are not visible until you are close to the quota limits, but you can see them if you set the googleAuthR verbose level below 3 (options(googleAuthR.verbose=2))) or if the API call costs more than 50 units.

    The bigger and more complex the query you make, the more tokens you use.

    -

    See this Google guide on how API quotas are assigned. The quotas are on a per GCP project and Ga4 web property level, and you get more if on GA360.

    +

    See this Google guide on how API quotas are assigned. The quotas are on a per GCP project and Ga4 web property level, and you get more if on GA360.

    An example taken from above:

    -options(googleAuthR.verbose=2)
+options(googleAuthR.verbose=2)
 complex_filter <- ga_data(
      206670707,
-     metrics = c("activeUsers","sessions"),
-     dimensions = c("date","city","dayOfWeek"),
-     date_range = c("2020-03-31", "2020-04-06", 
+     metrics = c("activeUsers","sessions"),
+     dimensions = c("date","city","dayOfWeek"),
+     date_range = c("2020-03-31", "2020-04-06", 
                     "2020-04-07", "2020-04-14", 
                     "2020-04-15", "2020-04-22", 
                     "2020-04-23", "2020-04-30"),
-     metricAggregations = c("TOTAL","MINIMUM","MAXIMUM"),
+     metricAggregations = c("TOTAL","MINIMUM","MAXIMUM"),
      orderBys = ga_data_order(-sessions +city),
      dim_filters = ga_data_filter(
-              city==c("Copenhagen","London","Paris","New York") &
+              city==c("Copenhagen","London","Paris","New York") &
               (dayOfWeek=="5" | dayOfWeek=="6")),
      limit = -1
 )
@@ -1241,11 +1241,11 @@ 
    
 serverErrorsPerProjectPerHour - how many bad API calls you can make per project/hr

-
-

-Debugging and Raw JSON requests

-

If you ever need to inspect the API request, set options(googleAuthR.verbose=2) to see the request JSON. This is helpful in bug reports.

-

If you use the raw_json argument only in ga_data() to send in a string of the JSON as specified by the runReport object, this can be used to fetch unimplemented API features or buggy requests to help debugging.

+
+

Debugging and Raw JSON requests +

+

If you ever need to inspect the API request, set options(googleAuthR.verbose=2) to see the request JSON. This is helpful in bug reports.

+

If you use the raw_json argument only in ga_data() to send in a string of the JSON as specified by the runReport object, this can be used to fetch unimplemented API features or buggy requests to help debugging.

 ga_data(206670707, raw_json = '{"metrics":[{"name":"sessions"}],"orderBys":[{"dimension":{"orderType":"ALPHANUMERIC","dimensionName":"date"},"desc":false}],"dimensions":[{"name":"date"}],"dateRanges":[{"startDate":"2021-01-01","endDate":"2021-01-07"}],"keepEmptyRows":true,"limit":100,"returnPropertyQuota":true}')
 # ℹ 2021-04-13 10:50:17 > Making API request with raw JSON:  {"metrics":[{"name":"sessions"}],"orderBys":[{"dimension":{"orderType":"ALPHANUMERIC","dimensionName":"date"},"desc":false}],"dimensions":[{"name":"date"}],"dateRanges":[{"startDate":"2021-01-01","endDate":"2021-01-07"}],"keepEmptyRows":true,"limit":100,"returnPropertyQuota":true}
@@ -1274,7 +1274,7 @@ 

 #  activeUsers
 #        <dbl>
 #1           2
-

If you pass in an R list instead of raw JSON string that will be converted into JSON via jsonlite::fromJSON()

+

If you pass in an R list instead of raw JSON string that will be converted into JSON via jsonlite::fromJSON()

@@ -1289,11 +1289,13 @@

-

Developed by Mark Edmondson.

+

+

Developed by Mark Edmondson.

-

Site built with pkgdown 1.6.1.

+

+

Site built with pkgdown 2.0.1.

@@ -1302,5 +1304,7 @@

+ + diff --git a/docs/articles/rmarkdown.html b/docs/articles/rmarkdown.html index fd27b810..846b267b 100644 --- a/docs/articles/rmarkdown.html +++ b/docs/articles/rmarkdown.html @@ -23,15 +23,17 @@ + +
+

RMarkdown reports with Google Analytics API data

- Source: vignettes/rmarkdown.Rmd + Source: vignettes/rmarkdown.Rmd
@@ -252,19 +254,19 @@

RMarkdown reports with Google Analytics API data

googleAnalyticsR can be used to generate reports in RMarkdown documents.

The default clientId that comes with the package can not be used for non-interactive use such as server scripts or RMarkdown. This is due to abuse of the free quota that used up the quota for everyone. This means you will need to set up your own clientId.

-

See setting up your own Google Project - the easiest method is to use ga_auth_setup().

-
-

-RMarkdown Authentication

-
-

-Using your cached email

+

See setting up your own Google Project - the easiest method is to use ga_auth_setup().

+
+

RMarkdown Authentication +

+
+

Using your cached email +

If you are building Rmd’s in the same environment as you use interactively, then the Rmd can reuse that.

-

You need to avoid the interactive menu when using RMarkdown - so you will need your own clientId and to specify the email you have authenticated with that clientId to skip it e.g. ga_auth(email="me@work.com")

+

You need to avoid the interactive menu when using RMarkdown - so you will need your own clientId and to specify the email you have authenticated with that clientId to skip it e.g. ga_auth(email="me@work.com")

-
-

-Example using an email cached on your computer

+
+

Example using an email cached on your computer +


 ---
 title: "Google Analytics Report"
@@ -285,9 +287,9 @@
-
-

-Using Rmd outside of your interactive environment

+
+

Using Rmd outside of your interactive environment +

Two files are usually needed when authenticating in a server:

  • Client ID JSON file - this is useful for interactive use anyhow as specifies your own GCP project and will take you off the default GCP project that comes with the package
    • @@ -299,15 +301,15 @@

  • Run ga_auth_setup() option 3 to generate a service key file from the clientId file you created in step 1. Put this is a safe location out of your project folder. Note the email you created for your service key file - it will look like {the_name}@{your-project-id}.iam.gserviceaccount.com
  • Run ga_auth_setup() option 5 to add the service email from step 2 ({the_name}@{your-project-id}.iam.gserviceaccount.com) as a user for your Google Analytics account.
    • -
  • Create your Rmd report using ga_auth(json_file="auth_file.json") +
  • Create your Rmd report using ga_auth(json_file="auth_file.json")

-
-

-Example using a service auth key

+
+

Example using a service auth key +

Use ga_auth_setup() to create a client.id and auth service key.

-

Use the service key file location via ga_auth(json_file="your_key.json") to authenticate instead of an email.

+

Use the service key file location via ga_auth(json_file="your_key.json") to authenticate instead of an email.


 
 ```{r}
@@ -325,14 +327,14 @@
-
-

-Uploading RMarkdown files to Shinyapps.io/Shiny Server

+
+

Uploading RMarkdown files to Shinyapps.io/Shiny Server +

To see the reports online, you can upload RMarkdown documents to Shiny servers or shinyapps.io, to perhaps run on a schedule.

-

The recommend method for authentication is to use service accounts and ga_auth(json_file="your_key.json") since this is easier and more secure in the long run.

+

The recommend method for authentication is to use service accounts and ga_auth(json_file="your_key.json") since this is easier and more secure in the long run.

However, if you want to continue using your email cached credentials, you need to ensure that the authentication cache file is present when uploaded. This can be specified in the meta data via resource_files in the Rmd yaml.

Since the token is not saved at a project level since v0.7.0 you will need to move or specify the cache folder for the tokens. The cache folder is usually at the global location ~/.R/gargle/gargle-oauth. Via gargle options, this needs to be changed for a project folder via:

-

options(gargle_oauth_cache = ".secrets")

+

options(gargle_oauth_cache = ".secrets")

This will then create a project folder containing cache. Upload this to the server.


 ---
@@ -346,8 +348,8 @@

Then when you upload to Shiny Server or shinyapps.io, you should see the file in your upload choices:

-

See details on gargle vignette

-

However, the recommend method is to use service accounts and ga_auth(json_file="auth_key.json") when using a server since this is easier and more secure in the long run. Upload the service JSON file instead of the cache folder.

+

See details on gargle vignette

+

However, the recommend method is to use service accounts and ga_auth(json_file="auth_key.json") when using a server since this is easier and more secure in the long run. Upload the service JSON file instead of the cache folder.

@@ -362,11 +364,13 @@

-

Developed by Mark Edmondson.

+

+

Developed by Mark Edmondson.

-

Site built with pkgdown 1.6.1.

+

+

Site built with pkgdown 2.0.1.

@@ -375,5 +379,7 @@

+ + diff --git a/docs/articles/setup.html b/docs/articles/setup.html index ad8f88b3..7e64ba61 100644 --- a/docs/articles/setup.html +++ b/docs/articles/setup.html @@ -23,15 +23,17 @@ + +
+

Setting up Google Analytics API downloads to R

- Source: vignettes/setup.Rmd + Source: vignettes/setup.Rmd
@@ -253,14 +255,14 @@

Setting up Google Analytics API downloads to R

This guide will walk you through the steps required to properly set up googleAnalyticsR in terms of installation and authentication.

It assumes you have R installed on your machine and access rights to one or more Google Analytics accounts. In this case it will only take a few lines of R code to make a first test call to the GA API following the examples below.

The rest of this guide will give you an overview of the available set up options and cover some good practices to follow under different scenarios of use.

-
-

-0. Quickstart RStudio Cloud Project

+
+

0. Quickstart RStudio Cloud Project +

If you wish to try out the library before installation, an RStudio Cloud project is available that has the library pre-installed.

-

Click this link and log in to RStudio Cloud to try it out.

+

Click this link and log in to RStudio Cloud to try it out.

Once you are logged in, issue the following two R commands in the R console bottom-left:

Select 1: Yes to say you wish to keep your OAuth access credentials.

The library should then launch a browser window and ask you to login to Google - log in with an email that has access to your Google Analytics - it will take you to a screen with an OOB token. Copy-paste that token back into RStudio:

@@ -269,29 +271,29 @@

You should then be authenticated and ready to use the functions in the package. Try ga_account_list() as a way to check you are authenticated correctly:

-
-

-1. Install

+
+

1. Install +

The latest stable version of googleAnalyticsR is available on CRAN. CRAN

-install.packages("googleAnalyticsR", dependencies = TRUE)
-
-

-Development version off GitHub

+install.packages("googleAnalyticsR", dependencies = TRUE)
+
+

Development version off GitHub +

You may prefer to use the latest development version on GitHub which you can install via the below.

Build status: CloudBuild

-remotes::install_github("MarkEdmondson1234/googleAnalyticsR")
+remotes::install_github("MarkEdmondson1234/googleAnalyticsR")

Check out the NEWS to see what is currently available in each version and the development version of the website here which carries experimental documentation.

-
-

-Optional opt-in tracking of library use

+
+

Optional opt-in tracking of library use +

If you are not opted in and its an interactive session, this message appears on first startup:

-library(googleAnalyticsR)
+library(googleAnalyticsR)
 #You can opt in to tracking of your use of googleAnalyticsR - see ?ga_trackme for details.
-

If you run ga_trackme() then you get this dialogue:

+

If you run ga_trackme() then you get this dialogue:

> ga_trackme()
 
 ── Tracking Consent for googleAnalyticsR usage ──────────────────────
@@ -303,19 +305,19 @@ 

 3: Yeah

If you opt-in it creates an .optin-googleanalyticsr file with your client.id (the ID associated with you)

✓ Thanks! Your consent and an ID will be marked by the presence of the file .optin-googleanalyticsr.  Delete it or run this function again to remove consent.
-

When opted-in, on library load it sends a hit via the function ga_trackme_event()

+

When opted-in, on library load it sends a hit via the function ga_trackme_event()

library(googleAnalyticsR)
 ✓ Sent library load tracking event
-

You can examine what is sent in that hit by looking at ga_trackme_event(debug=TRUE)

+

You can examine what is sent in that hit by looking at ga_trackme_event(debug=TRUE)

Its sending your R session info (no personal data) to my GA4 account.

You can send your own message to the analytics with the say_hello argument:

 # use debug=TRUE to see what would be sent, debug=FALSE will send it
-ga_trackme_event(debug = TRUE, say_hello = "I love you")
+ga_trackme_event(debug = TRUE, say_hello = "I love you")
-
-

-Docker image

+
+

Docker image +

If you know docker, then a public image is available at gcr.io/gcer-public/googleanalyticsr

  • @@ -324,10 +326,10 @@

    gcr.io/gcer-public/googleanalyticsr:CRAN will be the last CRAN version

-
-

-Dependencies

-

googleAnalyticsR requires the packages described in the Imports field of the DESCRIPTION file to be installed first, which it will do via install.packages("googleAnalyticsR", dependencies = TRUE)

+
+

Dependencies +

+

googleAnalyticsR requires the packages described in the Imports field of the DESCRIPTION file to be installed first, which it will do via install.packages("googleAnalyticsR", dependencies = TRUE)

The dependencies are roughly split into the following roles:

  • @@ -336,17 +338,17 @@

    jsonlite, httr work with API responses

  • Tidyverse packages such as dplyr and purrr are used to make outputs easy to use (clean data.frames rather than nested lists)
-

Note that on linux systems, due to its reliance on httr and in turn curl, it may require installation of these dependencies via apt-get or similar: libssl-dev and libcurl4-openssl-dev.

+

Note that on linux systems, due to its reliance on httr and in turn curl, it may require installation of these dependencies via apt-get or similar: libssl-dev and libcurl4-openssl-dev.

If you install httpuv then the authentication flows will occur behind the scenes - this is normally installed by default but if you do not include it you will need to use the more manual OOB method to generate authentication tokens.

-
-

-2. Make your first API call

+
+

2. Make your first API call +

Once you have installed the package you can make a first call to the GA API to test the connection.

 ## setup
-library(googleAnalyticsR)
+library(googleAnalyticsR)
 
 ## This should send you to your browser to authenticate your email. 
 # Authenticate with an email that has access to the 
@@ -364,43 +366,43 @@ 

 
 ## simple query to test connection, get 10 rows
 google_analytics(ga_id,
-                 date_range = c("2017-01-01", "2017-03-01"),
+                 date_range = c("2017-01-01", "2017-03-01"),
                  metrics = "sessions",
                  dimensions = "date",
                  max = 10)
-

You can find more code examples to query the API in v4 API and v3 API sections of the site.

+

You can find more code examples to query the API in v4 API and v3 API sections of the site.

-
-

-3. Choose authentication method

-
-

-TL;DR

+
+

3. Choose authentication method +

+
+

TL;DR +

Use ga_auth_setup() to configure your own GCP project and set up auto-authentication options.

Recommended long term defaults are:

  1. Create your own GCP project, download the client JSON and save to a global location, which you point to via a environment argument GAR_CLIENT_JSON in an .Renviron file e.g. GAR_CLIENT_JSON=~/dev/auth/client.json
    2. -
  2. Authenticate with ga_auth(email="your@email.com") to create an authentication token cache, and repeat the ga_auth(email="your@email.com") call to default to that email in future API calls
    3. +
  3. Authenticate with ga_auth(email="your@email.com") to create an authentication token cache, and repeat the ga_auth(email="your@email.com") call to default to that email in future API calls
  4. Set an environment argument GARGLE_EMAIL in the same .Renviron file to your email to auto-authenticate on package load e.g. GARGLE_EMAIL=your@email.com
-
-

-Details

+
+

Details +

To access the GA API authentication is required.

The example in the previous section used the simplest among the three available ways to authenticate to the API. If you are planning to make systematic use of the API however, it’s worth to know all the available options in order to choose the most suitable.

-

Note that no matter which method you use, the authentication is actually done via the googleAuthR package. In its documentation pages you can read more about advanced use cases.

+

Note that no matter which method you use, the authentication is actually done via the googleAuthR package. In its documentation pages you can read more about advanced use cases.

To authenticate you need a client project (that authentication is performed through) and the user email to authenticate with (that gives access to that user’s Google Analytics accounts)

-
-

-Email authentication

-

As of version googleAnalyticsR>=0.6.0.9000 authentication is done via the gargle package. This creates a global cache that is accessed via the email you authenticate with.

+
+

Email authentication +

+

As of version googleAnalyticsR>=0.6.0.9000 authentication is done via the gargle package. This creates a global cache that is accessed via the email you authenticate with.

If you use ga_auth() the first time then it will ask you to create email credentials. You can then authenticate in the browser via your email. The next time you wish to authenticate, ga_auth() will give you an option to use those credentials again:

-library(googleAnalyticsR)
+library(googleAnalyticsR)
 ga_auth()
 #>The googleAnalyticsR package is requesting access to your Google account. 
 #> Select a pre-authorised account or enter '0' to obtain a new token. Press  #>Esc/Ctrl + C to abort.
@@ -414,21 +416,21 @@ 

 
e.g. in .Renviron

 
GARGLE_EMAIL=your@email.com
-
-

-‘Try-it-out’ mode: The default googleAnalyticsR project

+
+

‘Try-it-out’ mode: The default googleAnalyticsR project +

The fast authentication way of the previous section worked via the default Google Cloud Project for googleAnalyticsR which is shared with all googleAnalyticsR users. Even though it is a shared project other package users are not able to see and access your GA data.

However since Google has changed verification processes, the consent screen for the default googleAnalyticsR library may warn of ‘danger’, which you will need to trust and accept if you want to continue using the default project. It is preferred to use your own and get your own verificataion process.

You can not use the default project for scheduled scripts on servers - only interactivly. The default library is only intended for users to get to know the library looking for data as quickly as possible.

With the amount of API calls possible with this library via batching and walking, its more likely the default shared Google API project will hit the 50,000 calls per day quota.

However, using the default project means you will not need to go through the process outlined below to create your own Google Cloud Platform credentials and you can directly authenticate using the ga_auth() function and your browser as soon as the library is downloaded.

-
-

-ga_auth_setup()

+
+

ga_auth_setup() +

A new setup function is available in versions >0.7.2 - use this to launch a wizard that will help you walk through some of the more advanced authentication setups detailed below. You will need to create your own Google Cloud Project and download a client Id file to get started.

-library(googleAnalyticsR)
+library(googleAnalyticsR)
 ga_auth_setup()
 #ℹ ==Welcome to googleAnalyticsR v0.7.1.9000 setup==
 #This wizard will scan your system for setup options and help you with any that are missing. 
@@ -440,14 +442,14 @@ 

 #4: Setup auto-authentication (JSON service account key)
 #5: Add a service account email or another email to your GA account
-
-

-‘Professional’ mode: Your own Google Project

+
+

‘Professional’ mode: Your own Google Project +

To mitigate all the above, use your own Google Developer Console client ID, so it is not shared across all users of this library.

The easiest way to set this up is to create your own Google Cloud Platform project and then in R use the ga_auth_setup() function and select option 1.

-
-

-Setting up clientId manually

+
+

Setting up clientId manually +

The setup function goes through the steps below.

  1. Download your Google Cloud Project client JSON and place it in a location pointed to via the GAR_CLIENT_JSON environment argument.
    2. @@ -459,33 +461,33 @@ 

# In your .Renviron
 GAR_CLIENT_JSON=~/dev/auth/gcp_client.json
-

You can also set your clientID before the library is available via googleAuthR::gar_set_client()

+

You can also set your clientID before the library is available via googleAuthR::gar_set_client()

  1. Once you have set the credentials for your project set these options before any call to ga_auth() or other data fetching calls.

If set via environment argument, restart R and then load the library:

 #Setting client.id from gar_auth_configure(path = json)
-library(googleAnalyticsR)
+library(googleAnalyticsR)
 ga_auth()
-

If setting in the script via googleAuthR::gar_set_client() then it will look like this:

+

If setting in the script via googleAuthR::gar_set_client() then it will look like this:

-library(googleAnalyticsR)
-googleAuthR::gar_set_client("~/dev/auth/gcp_client.json")
+library(googleAnalyticsR)
+googleAuthR::gar_set_client("~/dev/auth/gcp_client.json")
 ga_auth()
-

The oldest method (deprecated) - Donal Phipps has very kindly created a screencast on how to set this up that you can find embedded below and via this link.

+

The oldest method (deprecated) - Donal Phipps has very kindly created a screencast on how to set this up that you can find embedded below and via this link.

-options(googleAuthR.client_id = "uxxxxxxx2fd4kesu6.apps.googleusercontent.com")
-options(googleAuthR.client_secret = "3JhLa_GxxxxxCQYLe31c64")
-options(googleAuthR.scopes.selected = "https://www.googleapis.com/auth/analytics")
+options(googleAuthR.client_id = "uxxxxxxx2fd4kesu6.apps.googleusercontent.com") +options(googleAuthR.client_secret = "3JhLa_GxxxxxCQYLe31c64") +options(googleAuthR.scopes.selected = "https://www.googleapis.com/auth/analytics")
-
-

-clientId examples

-

In the next example, the scopes are also set so a user can authenticate with searchConsoleR at the same time, which is possible as they both use googleAuthR as a backend.

+
+

clientId examples +

+

In the next example, the scopes are also set so a user can authenticate with searchConsoleR at the same time, which is possible as they both use googleAuthR as a backend.

googleAuthR::gar_set_client("~/dev/auth/gcp_client.json"
             scopes = c("https://www.googleapis.com/auth/analytics",
                        "https://www.googleapis.com/auth/webmasters"))
@@ -497,25 +499,25 @@

Note: With either the default or your own GCP projects using the ga_auth() function, you can specify the email you will use by passing that to the ga_auth() function e.g. ga_auth(email="my@email.com). This will skip the interactive menu choice for authentication. This can be useful when authenticating within an Rmarkdown document in which case it is recommended to specify your email (an Rmarkdown document can change the working directory during knitting).

-
-

-‘Server’ mode: Google Cloud service account

-

You can alternatively authenticate by downloading a JSON file attached to a Google Cloud service account. More details on how to do that are on the googleAuthR website.

+
+

‘Server’ mode: Google Cloud service account +

+

You can alternatively authenticate by downloading a JSON file attached to a Google Cloud service account. More details on how to do that are on the googleAuthR website.

A service authentication file then needs to be created that has edit access to the GA account. It is recommended to make a dedicated service account if you don’t need it for anything else.

The easiest way is to use ga_auth_setup() and select option 3 to create the file for you using your own details for authorization, then option 5 to add it to the GA account you need.

In your R script you can then authorize via:

-library(googleAnalyticsR)
+library(googleAnalyticsR)
 ga_auth(json_file="service-key.json")

…or if you have set the environment arg GA_AUTH_FILE to the service key filepath, simply loading the library to enact auto-authenticataion.

This is helpful for Docker contaienrs where you don’t want to usually include any authentication files, but can specify them via environment arguments when launching the container.

-
-

-Manual setup

+
+

Manual setup +

If you want to set it up yourself, the setup wizard goes through these steps:

  1. Create your own Google Cloud Project or use an existing one.
    2. -
  2. Set your own client.id/secret via googleAuthR::gar_set_client() +
  3. Set your own client.id/secret via googleAuthR::gar_set_client()
  4. Service accounts for your project can be created at this link: https://console.cloud.google.com/iam-admin/serviceaccounts/create
    5. @@ -529,22 +531,22 @@

You should now be able to use the JSON auth file to authenticate with Google Analytics API via:

-library(googleAnalyticsR)
+library(googleAnalyticsR)
 ga_auth(json_file = "your_auth_file.json")
 
 # test authentication
 al <- ga_account_list()
-

Note: A service account is a special type of account that belongs to an application rather than an individual user. If you should use this option, chances are you are already familiar with how they work. If however you wish to find out more about when and how to use service accounts, follow the link to the Google Cloud documentation page on Understanding Service Accounts

+

Note: A service account is a special type of account that belongs to an application rather than an individual user. If you should use this option, chances are you are already familiar with how they work. If however you wish to find out more about when and how to use service accounts, follow the link to the Google Cloud documentation page on Understanding Service Accounts

-
-

-4 (optional): Review useful auth options

+
+

4 (optional): Review useful auth options +

This section covers some other aspects of authentication under various scenarios of use. This information is useful especially if you work systematically with Google Analytics and possibly other Google products too.

-
-

-Auto-authentication

+
+

Auto-authentication +

To save authenticating and setting your GCP client each R session, you can specify the files/email in an .Renviron file that will be looked for each time you load library(googleAnalyticsR)

  • @@ -554,46 +556,46 @@

  • GA_AUTH_FILE is an optional argument if you have a service JSON key

-

You can set environment arguments via Sys.setenv() or using an .Renviron file saved in your home directory, but the recommended way is to use ga_auth_setup() and select option 2 (for OAuth2 email) or 4 (for JSON service account keys)

+

You can set environment arguments via Sys.setenv() or using an .Renviron file saved in your home directory, but the recommended way is to use ga_auth_setup() and select option 2 (for OAuth2 email) or 4 (for JSON service account keys)

# In your .Renviron
 GAR_CLIENT_JSON=~/dev/auth/gcp_client.json
 GARGLE_EMAIL=my-email@me.com
 GA_AUTH_FILE=/Users/me/dev/auth/keys/googleanalyticsr-auth-key.json

Restart your R session to enact the arguments created in .Renviron - when you load the library they will be loaded in.

-
-

-Multiple API authentification

-

If you are using more than one API for authentication (such as Search Console), then authenticate using googleAuthR::gar_auth() instead, to ensure you authenticate with the correct scopes. See the multiple authentication section on the googleAuthR website for details.

-

If you have set up a personal project then you can use the options() function as shown in the previous section

+
+

Multiple API authentification +

+

If you are using more than one API for authentication (such as Search Console), then authenticate using googleAuthR::gar_auth() instead, to ensure you authenticate with the correct scopes. See the multiple authentication section on the googleAuthR website for details.

+

If you have set up a personal project then you can use the options() function as shown in the previous section

-
-

-Multiple GA accounts

+
+

Multiple GA accounts +

Using gargle means that you get a menu option to choose which email to authenticate with each time you issue ga_auth(). This makes working with multiple GA accounts a lot easier to work with.

-library(googleAnalyticsR)
+library(googleAnalyticsR)
 ga_auth(email="mark@work.com")
 client_one <- google_analytics(ga_id_one, 
                                date_range = my_date_range,
                                metrics = "sessions", 
-                               dimensions = c("date", "medium"))
+                               dimensions = c("date", "medium"))
 
 ga_auth(email="mark@work3.com")
 client_one <- google_analytics(ga_id_two, 
                                date_range = my_date_range,
                                metrics = "sessions", 
-                               dimensions = c("date", "medium"))
+ dimensions = c("date", "medium"))
-
-

-Authentication with shiny and Rmarkdown

-

More details about these special cases of authentication are available on the corresponding sections of this site for Shiny and Rmarkdown

+
+

Authentication with shiny and Rmarkdown +

+

More details about these special cases of authentication are available on the corresponding sections of this site for Shiny and Rmarkdown

-
-

-Where to go from here ?

-

Once the set up is complete you are ready to start using the package to access your GA data. To give you some ideas the v4 API page of this site provides several examples of key functionalities provided by the package.

+
+

Where to go from here ? +

+

Once the set up is complete you are ready to start using the package to access your GA data. To give you some ideas the v4 API page of this site provides several examples of key functionalities provided by the package.

@@ -609,11 +611,13 @@

-

Developed by Mark Edmondson.

+

+

Developed by Mark Edmondson.

-

Site built with pkgdown 1.6.1.

+

+

Site built with pkgdown 2.0.1.

@@ -622,5 +626,7 @@

+ + diff --git a/docs/articles/shiny.html b/docs/articles/shiny.html index 201f1c69..d76da28a 100644 --- a/docs/articles/shiny.html +++ b/docs/articles/shiny.html @@ -23,15 +23,17 @@ + +
+

Shiny Apps that call Google Analytics API data

- Source: vignettes/shiny.Rmd + Source: vignettes/shiny.Rmd
-

To use in Shiny with a multi-user login, use googleAuth’s with_shiny. See the googleAuthR readme for details on general Google authentication with Shiny.

-

A video tutorial on how to create a Shiny app with googleAnalyticsR is available below. The first 20 mins creates a basic Shiny app fetching data, the last 20 mins go into combining with other libraries and using custom HTML templates:

+

To use in Shiny with a multi-user login, use googleAuth’s with_shiny. See the googleAuthR readme for details on general Google authentication with Shiny.

+

A video tutorial on how to create a Shiny app with googleAnalyticsR is available below. The first 20 mins creates a basic Shiny app fetching data, the last 20 mins go into combining with other libraries and using custom HTML templates:

 ## in server.R
-library(googleAuthR)
-library(googleAnalyticsR)
-library(shiny)
+library(googleAuthR)
+library(googleAnalyticsR)
+library(shiny)
 
-shinyServer(function(input, output, session){
+shinyServer(function(input, output, session){
   
   ## Get auth code from return URL
-  access_token  <- callModule(googleAuth, "auth1")
+  access_token  <- callModule(googleAuth, "auth1")
 
-  gadata <- reactive({
+  gadata <- reactive({
 
-    with_shiny(google_analytics_3,
+    with_shiny(google_analytics_3,
                id = "222222", ## replace with your View ID
                start="2015-08-01", end="2015-08-02", 
-               metrics = c("sessions", "bounceRate"), 
-               dimensions = c("source", "medium"),
+               metrics = c("sessions", "bounceRate"), 
+               dimensions = c("source", "medium"),
                shiny_access_token = access_token())
   })
   
-  output$something <- renderPlot({
+  output$something <- renderPlot({
   
     ## only trigger once authenticated
-    req(access_token())
+    req(access_token())
     
     gadata <- gadata()
     
-    plot(gadata)
+    plot(gadata)
   
   })
   
 })
 
 ## ui.R
-library(googleAuthR)
-library(shiny)
+library(googleAuthR)
+library(shiny)
 
-shinyUI(fluidPage(
+shinyUI(fluidPage(
 
-  googleAuthUI("auth1"),
-  plotOutput("something")
+  googleAuthUI("auth1"),
+  plotOutput("something")
 
 ))
-

To aid with creating Shiny apps using this package, some Shiny modules are available.

-
-

-Authentication modules

+

To aid with creating Shiny apps using this package, some Shiny modules are available.

+
+

Authentication modules +

authDropdown and authDropdownUI create a row of selects to help with choosing a GA View.

Make sure to authenticate with at least https://www.googleapis.com/auth/analytics.edit scopes since this is needed for listing GA accounts.

@@ -314,64 +316,64 @@

(...) -token <- callModule(googleAuth, "login") +token <- callModule(googleAuth, "login") -ga_accounts <- reactive({ - validate( - need(token(), "Authenticate") +ga_accounts <- reactive({ + validate( + need(token(), "Authenticate") ) - with_shiny(ga_account_list, shiny_access_token = token()) + with_shiny(ga_account_list, shiny_access_token = token()) }) -selected_id <- callModule(authDropdown, "auth_menu", ga.table = ga_accounts) +selected_id <- callModule(authDropdown, "auth_menu", ga.table = ga_accounts) (...)

-
-

-Google Analytics 4 Account Picker

-

GA4 has different data model and account structure, so it has its own account picker module at accountPicker() - this also uses the more modern Shiny module style. GA4 only has accounts and web propertyId, not viewIds.

+
+

Google Analytics 4 Account Picker +

+

GA4 has different data model and account structure, so it has its own account picker module at accountPicker() - this also uses the more modern Shiny module style. GA4 only has accounts and web propertyId, not viewIds.

A minimal example on how to use it is shown below:

-library(shiny)
-library(googleAnalyticsR) # for accountPicker
-library(googleAuthR)      # for gar_shiny_ui
+library(shiny)
+library(googleAnalyticsR) # for accountPicker
+library(googleAuthR)      # for gar_shiny_ui
 
-ui <- fluidPage(title = "Shiny App",
-                accountPickerUI("auth_menu", inColumns = TRUE))
+ui <- fluidPage(title = "Shiny App",
+                accountPickerUI("auth_menu", inColumns = TRUE))
 server <- function(input, output, session){
-  token <- gar_shiny_auth(session)
+  token <- gar_shiny_auth(session)
   
-  accs <- reactive({
-    req(token)
+  accs <- reactive({
+    req(token)
     ga_account_list("ga4")
   })
   
   # module for authentication
-  property_id <- accountPicker("auth_menu", ga_table = accs, id_only = TRUE)
+  property_id <- accountPicker("auth_menu", ga_table = accs, id_only = TRUE)
 }
 
-shinyApp(gar_shiny_ui(ui, login_ui = silent_auth), server)
+shinyApp(gar_shiny_ui(ui, login_ui = silent_auth), server)
-
-

-Parameter selects

-
-

-Universal Analytics

+
+

Parameter selects +

+
+

Universal Analytics +

multiSelect and multiSelectUI create select dropdowns with the GA API parameters filled in, taken from the meta API.

### GA4

-

Google Analytics 4 allows you to download your custom events, so needs a new metric/dimension field picker, available as metricDimensionSelect()

-

To use custom fields, you need to pass in meta data from ga_meta("data") with your propertyId.

+

Google Analytics 4 allows you to download your custom events, so needs a new metric/dimension field picker, available as metricDimensionSelect()

+

To use custom fields, you need to pass in meta data from ga_meta("data") with your propertyId.

An example of its use with and without custom fields is shown below:

-library(shiny)
-library(googleAuthR)
-library(googleAnalyticsR)
+library(shiny)
+library(googleAuthR)
+library(googleAnalyticsR)
 
-gar_set_client(
+gar_set_client(
   web_json = "/Users/mark/dev/auth/mark-edmondson-gde-web-client.json",
   scopes = "https://www.googleapis.com/auth/analytics.readonly")
 
@@ -383,39 +385,39 @@ 

 modelServer <- model$shiny_module$server
 
 ## ui.R
-ui <- fluidPage(
+ui <- fluidPage(
   title = "GA4 Shiny",
-  h1("GA4 Shiny App"),
-  accountPickerUI("auth_menu", inColumns = TRUE),
-  h2("Pick metrics and dimensions"),
-  metricDimensionSelectUI("mets1"),
-  metricDimensionSelectUI("dims_custom", "Dimensions"),
-  h2("Model results"),
+  h1("GA4 Shiny App"),
+  accountPickerUI("auth_menu", inColumns = TRUE),
+  h2("Pick metrics and dimensions"),
+  metricDimensionSelectUI("mets1"),
+  metricDimensionSelectUI("dims_custom", "Dimensions"),
+  h2("Model results"),
   modelUi("model1")
 )
 
 ## server.R
 server <- function(input, output, session){
   
-  token <- gar_shiny_auth(session)
+  token <- gar_shiny_auth(session)
   
-  ga_accounts <- reactive({
-    req(token)
+  ga_accounts <- reactive({
+    req(token)
     ga_account_list("ga4")
   })
   
-  property_id <- accountPicker("auth_menu",
+  property_id <- accountPicker("auth_menu",
                                ga_table = ga_accounts,
                                id_only = TRUE)
 
-  meta <- reactive({
-    req(property_id())
+  meta <- reactive({
+    req(property_id())
     
     ga_meta("data", propertyId = property_id())
   })
 
-  metrics <- metricDimensionSelect("mets1", default = "sessions")
-  dims_custom <- metricDimensionSelect("dims_custom",
+  metrics <- metricDimensionSelect("mets1", default = "sessions")
+  dims_custom <- metricDimensionSelect("dims_custom",
                                        field_type = "dimension",
                                        custom_meta = meta())  
   
@@ -424,78 +426,78 @@ 

   
 }
 
-shinyApp(gar_shiny_ui(ui), server)
+shinyApp(gar_shiny_ui(ui), server)
-
-

-Segment helper

+
+

Segment helper +

segmentBuilder and segmentBuilderUI creates a segment builder interface. This is also available as an RStudio gadget to help create segments more easily.

-
-

-Example

+
+

Example +

An example of a Shiny app is shown below, that allows users to login in, select an account using the modules above, and then see their data via Highcharts

The code for the explorer is included below:

-
-

-ui.R

+
+

ui.R +

 ## ui.R
-library(googleAuthR)
-library(googleAnalyticsR)
-library(shiny)
-library(highcharter)
-
-shinyUI(
-  fluidPage(
-    googleAuthUI("login"),
+library(googleAuthR)
+library(googleAnalyticsR)
+library(shiny)
+library(highcharter)
+
+shinyUI(
+  fluidPage(
+    googleAuthUI("login"),
     authDropdownUI("auth_menu"),
     highchartOutput("something")
     
   ))
-
-

-server.R

+
+

server.R +

 ## in server.R
-library(googleAuthR)
-library(googleAnalyticsR)
-library(shiny)
-library(highcharter)
+library(googleAuthR)
+library(googleAnalyticsR)
+library(shiny)
+library(highcharter)
 
 function(input, output, session){
   
   ## Get auth code from return URL
-  token <- callModule(googleAuth, "login")
+  token <- callModule(googleAuth, "login")
   
-  ga_accounts <- reactive({
-    req(token())
+  ga_accounts <- reactive({
+    req(token())
     
-    with_shiny(ga_account_list, shiny_access_token = token())
+    with_shiny(ga_account_list, shiny_access_token = token())
     
   })
   
-  selected_id <- callModule(authDropdown, "auth_menu", ga.table = ga_accounts)
+  selected_id <- callModule(authDropdown, "auth_menu", ga.table = ga_accounts)
   
-  gadata <- reactive({
+  gadata <- reactive({
     
-    req(selected_id())
+    req(selected_id())
     gaid <- selected_id()
-    with_shiny(google_analytics_3,
+    with_shiny(google_analytics_3,
                id = gaid,
                start="2015-08-01", end="2017-08-02", 
-               metrics = c("sessions"), 
-               dimensions = c("date"),
+               metrics = c("sessions"), 
+               dimensions = c("date"),
                shiny_access_token = token())
   })
   
   output$something <- renderHighchart({
     
     ## only trigger once authenticated
-    req(gadata())
+    req(gadata())
     
     gadata <- gadata()
     
@@ -520,11 +522,13 @@ 

 
 
       

-  
Developed by Mark Edmondson.

+  

+
Developed by Mark Edmondson.

 

 
 

-  
Site built with pkgdown 1.6.1.

+  

+
Site built with pkgdown 2.0.1.

 

 
       

@@ -533,5 +537,7 @@ 

   
 
 
+  
+
   
 
diff --git a/docs/articles/user-activity.html b/docs/articles/user-activity.html
index 9300f1e4..f55e2555 100644
--- a/docs/articles/user-activity.html
+++ b/docs/articles/user-activity.html
@@ -23,15 +23,17 @@
 
 
 
+    
+
     

       

+      

   

     

       
User Activity API

             
       
-      Source: vignettes/user-activity.Rmd
+      Source: vignettes/user-activity.Rmd
       
 
     

 
     
     
-
The User Activity API lets you query an individual user’s movement through your website, by sending in the individual clientId or userId. It is accessed via the ga_clientid_activity() function.

+
The User Activity API lets you query an individual user’s movement through your website, by sending in the individual clientId or userId. It is accessed via the ga_clientid_activity() function.

 
Use Activity is available in version of googleAnalyticsR >= 0.6.9000 and needs googleAuthR >= 0.7.0.9000 so install via:

 
-remotes::install_github("MarkEdmondson1234/googleAuthR")
-remotes::install_github("MarkEdmondson1234/googleAnalyticsR")

-

-

-User Activity API example

+remotes::install_github("MarkEdmondson1234/googleAuthR")
+remotes::install_github("MarkEdmondson1234/googleAnalyticsR")
+
+

User Activity API example +

You first need to have a clientId or userId to query. You can now get this from the reporting API via the dimension ga:clientId.

Its also available via the User Explorer report in the Web UI, or via a BigQuery export, or you may be capturing the ID in a custom dimension.

Once you have an ID, specify the Google Analytics view that user was browsing and the data range of the activity you want to query:

 viewId <- 123456
-date_range <- c("yesterday","yesterday")
+date_range <- c("yesterday","yesterday")
 cids <- google_analytics(viewId, date_range = date_range, 
                          metrics = "sessions", dimensions = "clientId")
 users <- ga_clientid_activity(cids$clientId,
@@ -275,19 +277,19 @@ 

 #> 2019-08-15 10:43:17> Fetching id: 21123.1565123
 #> ..etc..
-
-

-Multiple ids

+
+

Multiple ids +

You can send in multiple IDs of the same type in a vector:

-two_clientIds <- c("1106980347.1461227730", "476443645.1541099566")
+two_clientIds <- c("1106980347.1461227730", "476443645.1541099566")
 two_users <- ga_clientid_activity(two_clientIds,
                                   viewId = 81416156, 
-                                  date_range = c("2019-01-01","2019-02-01"))
+ date_range = c("2019-01-01","2019-02-01"))
-
-

-Return format

+
+

Return format +

The API returns two types of data: session level and activity hit level. Access it via $sessions or $hits:

 two_users$sessions
@@ -308,7 +310,7 @@ 

 # ...

The amount of data returned is rich for the activity, the data columns are shown below (Although some will be empty for some rows if not applicable).

-names(two_users$hits)
+names(two_users$hits)
 # [1] "sessionId"            "activityTime"         "source"               "medium"              
 # [5] "channelGrouping"      "campaign"             "keyword"              "hostname"            
 # [9] "landingPagePath"      "activityType"         "customDimension"      "pagePath"            
@@ -317,26 +319,26 @@ 

 #[21] "eventCategory"        "eventAction"          "eventLabel"           "eventValue"          
 #[25] "eventCount"           "id"

The data.frames returned include the ID you sent in as the $id column so you can distinguish between users.

-
-

-Nested columns

-

The output uses nested columns for some values so you may want to get familiar with the tidyr::unnest() function when working with the data.

+
+

Nested columns +

+

The output uses nested columns for some values so you may want to get familiar with the tidyr::unnest() function when working with the data.

The nested columns are hits$customDimension, hits$ecommerce and hits$goals.

The nesting is necessary as you can have multiple of these events per hit, and expanding them in the response would make a very large data.frame to work with.

An example on how to unnest goals is shown below:

-library(tidyr)
-library(purrr)
-library(dplyr)
+library(tidyr)
+library(purrr)
+library(dplyr)
 
-a_user$hits %>% 
-  filter(has_goal) %>% # filter to just hits with goals
-  select(id, sessionId, activityTime, goals) %>% 
-  unnest(goals) %>% # unnest the goals list column
-  mutate(goalIndex = map_chr(goals, "goalIndex"), 
-         goalName = map_chr(goals, "goalName"), 
-         goalCompletionLocation = map_chr(goals, "goalCompletionLocation")) %>%
-  select(-goals)
+a_user$hits %>% 
+  filter(has_goal) %>% # filter to just hits with goals
+  select(id, sessionId, activityTime, goals) %>% 
+  unnest(goals) %>% # unnest the goals list column
+  mutate(goalIndex = map_chr(goals, "goalIndex"), 
+         goalName = map_chr(goals, "goalName"), 
+         goalCompletionLocation = map_chr(goals, "goalCompletionLocation")) %>%
+  select(-goals)
 ## A tibble: 4 x 6
 #  id                  sessionId  activityTime        goalIndex goalName           goalCompletionLocation                
 #  <chr>               <chr>      <dttm>              <chr>     <chr>              <chr>                                 
@@ -346,58 +348,58 @@ 

 #4 1106980347.1461227… 1546467261 2019-01-02 23:15:50 1         Time over a minut… /googleAnalyticsR/

To unnest custom dimensions, some example code is below:

-library(tidyr) # devtools::install_github("tidyverse/tidyr")
-library(purrr)
-library(dplyr)
+library(tidyr) # devtools::install_github("tidyverse/tidyr")
+library(purrr)
+library(dplyr)
 
-a_user$hits %>% 
-  select(id, sessionId, activityTime, customDimension) %>% 
-  unnest(customDimension) %>% 
-  mutate(cd_index = map_chr(customDimension, "index"), 
-         cd_value = map_chr(customDimension, ~ .$value %||% NA_character_)) %>%
-  filter(!is.na(cd_value)) %>%
-  select(-customDimension) %>%
-  distinct() %>%
-  pivot_wider(names_from = cd_index, values_from = cd_value, names_prefix = "customDim")
+a_user$hits %>% + select(id, sessionId, activityTime, customDimension) %>% + unnest(customDimension) %>% + mutate(cd_index = map_chr(customDimension, "index"), + cd_value = map_chr(customDimension, ~ .$value %||% NA_character_)) %>% + filter(!is.na(cd_value)) %>% + select(-customDimension) %>% + distinct() %>% + pivot_wider(names_from = cd_index, values_from = cd_value, names_prefix = "customDim")

To unnest ecommerce and filter to only transactions, an example is shown below:

-a_user$hits %>%
-  filter(activityType == "ECOMMERCE") %>%
-  select(id, sessionId, activityTime, ecommerce) %>%
-  mutate(transaction = map(ecommerce, "transaction"),
-         transactionRevenue = map_dbl(transaction, ~.[["transactionRevenue"]] %||% NA),
-         transactionId = map_chr(transaction, ~.[["transactionId"]] %||% NA)) %>%
-  filter(!is.na(transactionRevenue)) %>%
-  select(-transaction, -ecommerce)
+a_user$hits %>% + filter(activityType == "ECOMMERCE") %>% + select(id, sessionId, activityTime, ecommerce) %>% + mutate(transaction = map(ecommerce, "transaction"), + transactionRevenue = map_dbl(transaction, ~.[["transactionRevenue"]] %||% NA), + transactionId = map_chr(transaction, ~.[["transactionId"]] %||% NA)) %>% + filter(!is.na(transactionRevenue)) %>% + select(-transaction, -ecommerce)

To get the traffic sources per hit, you only need the first hit per session so can compute via:

-a_user$hits %>%
-  filter(activityType == "PAGEVIEW") %>%
-  select(id, sessionId, activityTime, 
+a_user$hits %>%
+  filter(activityType == "PAGEVIEW") %>%
+  select(id, sessionId, activityTime, 
          source, medium, 
          channelGrouping, campaign, 
-         keyword, landingPagePath) %>%
-  group_by(id, sessionId) %>%
-  summarise_all(min)
+ keyword, landingPagePath) %>% + group_by(id, sessionId) %>% + summarise_all(min)
-
-

-Filtering the response

+
+

Filtering the response +

If you specify the activity_type parameter, you can filter down the response to only the events you include in a vector.

-

The permitted types are: c("PAGEVIEW","SCREENVIEW","GOAL","ECOMMERCE","EVENT") - include some of these to specify which you would like to see.

+

The permitted types are: c("PAGEVIEW","SCREENVIEW","GOAL","ECOMMERCE","EVENT") - include some of these to specify which you would like to see.

 only_goals <- ga_clientid_activity(two_clientIds,
                                    viewId = 81416156, 
-                                   date_range = c("2019-01-01","2019-02-01"),
+                                   date_range = c("2019-01-01","2019-02-01"),
                                    activity_types = "GOAL")
-
-

-Example calling users via a custom dimension

+
+

Example calling users via a custom dimension +

If you are capturing Google Analytics cookie ID or a userId in a custom dimension then the below workflow shows how you can use the standard reporting API to fetch more detail on the users:

-library(googleAnalyticsR)
+library(googleAnalyticsR)
 
 al <- ga_account_list()
 
@@ -414,7 +416,7 @@ 

 #In this example, user.id is in ga:dimension2
 
 # date range of ids to query
-dates <- c(Sys.Date() - 30, Sys.Date() - 1)
+dates <- c(Sys.Date() - 30, Sys.Date() - 1)
 
 # download all client.ids who had a pageview in last 30 days
 # change this query to a segment of users you are interested in
@@ -428,10 +430,10 @@ 

                                         viewId = viewId,
                                         date_range = dates)
-
-

-Sampled response

-

The API response may be sampled - it will send a message if this happens. If it does, follow the advice on the API documentation such as splitting up the call into smaller date ranges.

+
+

Sampled response +

+

The API response may be sampled - it will send a message if this happens. If it does, follow the advice on the API documentation such as splitting up the call into smaller date ranges.

Also bear in mind each API call counts against your Analytics Reporting v4 API quota which by default is 50k per day, so you won’t be able to fetch more user activity than that without increasing your API quota.

@@ -447,11 +449,13 @@

-

Developed by Mark Edmondson.

+

+

Developed by Mark Edmondson.

-

Site built with pkgdown 1.6.1.

+

+

Site built with pkgdown 2.0.1.

@@ -460,5 +464,7 @@

+ + diff --git a/docs/articles/v3.html b/docs/articles/v3.html index df7a20be..d88460f4 100644 --- a/docs/articles/v3.html +++ b/docs/articles/v3.html @@ -23,15 +23,17 @@ + +
+

Google Analytics Reporting API v3 R functions

- Source: vignettes/v3.Rmd + Source: vignettes/v3.Rmd
@@ -251,9 +253,9 @@

Google Analytics Reporting API v3 R functions

New API features will no longer occur for the v3 API, but it still carries a lot of useful capabilties, such as the multi-channel API, and multi-account batching.

-
-

-Google Anaytics V3 API examples

+
+

Google Anaytics V3 API examples +

Consult ?google_analytics_3 and see examples below:

library(googleAnalyticsR)
 
@@ -325,11 +327,11 @@ 

 attr(gadata, "profileInfo")
 attr(gadata, "dateRange")
-
-

-Other details

-

For syntax of filters and dimensions, this library parses in exactly as specified in the Google Analytics v3 API docs, so check those out.

-

Note you do not need to encode symbols if passed into metrics or dimensions parameters, but may have to encode URLs if you are filtering for those in say ga:pagePath via utils::URLencode(url, reserved = TRUE)

+
+

Other details +

+

For syntax of filters and dimensions, this library parses in exactly as specified in the Google Analytics v3 API docs, so check those out.

+

Note you do not need to encode symbols if passed into metrics or dimensions parameters, but may have to encode URLs if you are filtering for those in say ga:pagePath via utils::URLencode(url, reserved = TRUE)

@@ -344,11 +346,13 @@

-

Developed by Mark Edmondson.

+

+

Developed by Mark Edmondson.

-

Site built with pkgdown 1.6.1.

+

+

Site built with pkgdown 2.0.1.

@@ -357,5 +361,7 @@

+ + diff --git a/docs/articles/v4.html b/docs/articles/v4.html index 620f6516..af589b29 100644 --- a/docs/articles/v4.html +++ b/docs/articles/v4.html @@ -23,15 +23,17 @@ + +
+

Google Analytics Reporting API v4 in R Examples

- Source: vignettes/v4.Rmd + Source: vignettes/v4.Rmd
@@ -261,14 +263,14 @@

Google Analytics Reporting API v4 in R Examples

  • Quota system for GA360
  • Caching
    • -

    Check out more examples on using the API in actual use cases on the www.dartistics.com website.

    -
    -

    -Getting started

    +

    Check out more examples on using the API in actual use cases on the www.dartistics.com website.

    +
    +

    Getting started +

    To get started refer to the tutorials linked on the homepage, consult ?google_analytics when within R to see the documentation, and see these example queries:

     ## setup
-library(googleAnalyticsR)
+library(googleAnalyticsR)
 
 ## authenticate
 ga_auth()
@@ -284,35 +286,35 @@ 
    
 
 ## simple query to test connection
 google_analytics(ga_id, 
-                 date_range = c("2017-01-01", "2017-03-01"), 
+                 date_range = c("2017-01-01", "2017-03-01"), 
                  metrics = "sessions", 
                  dimensions = "date")
    -

    Jeff Swanson has made a video guide that goes into more detail about the above examples (Digital Marketing in R: How to Connect to Google Analytics API) and is embedded below, many thanks to Jeff.

    +

    Jeff Swanson has made a video guide that goes into more detail about the above examples (Digital Marketing in R: How to Connect to Google Analytics API) and is embedded below, many thanks to Jeff.

    -
    -

    -Number of results

    +
    +

    Number of results +

    By default the function will return 1000 results. If you want to fetch all rows, set max = -1

    You don’t have to worry about paging through the API results, the library deals with that for you.

     # 1000 rows only
 thousand <- google_analytics(ga_id, 
-                             date_range = c("2017-01-01", "2017-03-01"), 
+                             date_range = c("2017-01-01", "2017-03-01"), 
                              metrics = "sessions", 
                              dimensions = "date")
 
 # 2000 rows
 twothousand <- google_analytics(ga_id, 
-                             date_range = c("2017-01-01", "2017-03-01"), 
+                             date_range = c("2017-01-01", "2017-03-01"), 
                              metrics = "sessions", 
                              dimensions = "date",
                              max = 2000)  
 
 # All rows
 alldata <- google_analytics(ga_id, 
-                             date_range = c("2017-01-01", "2017-03-01"), 
+                             date_range = c("2017-01-01", "2017-03-01"), 
                              metrics = "sessions", 
                              dimensions = "date",
                              max = -1)
    @@ -320,83 +322,83 @@ 

     ## anti_sample gets all results (max = -1)
 gadata <- google_analytics(myID,
-                      date_range = c(start_date, end_date),
+                      date_range = c(start_date, end_date),
                       metrics = "pageviews",
                       dimensions = "pageTitle",
                       segments = myseg,
                       anti_sample = TRUE)
 
 ## limit to top 25
-top_25 <- head(gadata[order(gadata$pageviews, decreasing = TRUE), ] , 25)
    +top_25 <- head(gadata[order(gadata$pageviews, decreasing = TRUE), ] , 25)

    -
    -

    -Date Ranges

    +
    +

    Date Ranges +

    You can send in dates in YYYY-MM-DD format:

    -google_analytics(868768, date_range = c("2016-12-31", "2017-02-01"), metrics = "sessions")
    +google_analytics(868768, date_range = c("2016-12-31", "2017-02-01"), metrics = "sessions")

    Character strings are converted into Date class objects, so you can also use R’s native Date object handling to specify rolling dates:

    -yesterday <- Sys.Date() - 1
-ThreedaysAgo <- Sys.Date() - 3
+yesterday <- Sys.Date() - 1
+ThreedaysAgo <- Sys.Date() - 3
 
-google_analytics(868768, date_range = c(ThreedaysAgo, yesterday), metrics = "sessions")
    +google_analytics(868768, date_range = c(ThreedaysAgo, yesterday), metrics = "sessions")

    Or use the v4 API shortcuts directly such as "yesterday", "today" or "XDaysAgo":

    -google_analytics(868768, date_range = c("5daysAgo", "yesterday"), metrics = "sessions")
    -
    -

    -Compare date ranges

    +google_analytics(868768, date_range = c("5daysAgo", "yesterday"), metrics = "sessions")
    +
    +

    Compare date ranges +

    In v4 you can compare date ranges and return the two data sets in one call. Send in a 4-length vector of dates in the form (range1_start, range1_end, range2_start, range2_end)

     google_analytics(868768, 
-                   date_range = c("16daysAgo", "9daysAgo", "8daysAgo", "yesterday"), 
+                   date_range = c("16daysAgo", "9daysAgo", "8daysAgo", "yesterday"), 
                    metrics = "sessions")
    -

    When requesting multiple date ranges, you can use a new ordering feature of v4 to find the 10 most changed dimensions, rather than just say the top 10. An article about using this feature can be found here.

    +

    When requesting multiple date ranges, you can use a new ordering feature of v4 to find the 10 most changed dimensions, rather than just say the top 10. An article about using this feature can be found here.

    An example is shown below, using the order_type function to sort by the change (DELTA) between dates:

     delta_sess <- order_type("sessions","DESCENDING", "DELTA")
 
 ## find top 20 landing pages that changed most in sessions comparing this week and last week
 gadata <- google_analytics(gaid,
-                             date_range = c("16daysAgo", "9daysAgo", "8daysAgo", "yesterday"),
-                             metrics = c("sessions"),
-                             dimensions = c("landingPagePath"),
+                             date_range = c("16daysAgo", "9daysAgo", "8daysAgo", "yesterday"),
+                             metrics = c("sessions"),
+                             dimensions = c("landingPagePath"),
                              order = delta_sess,
                              max = 20)
    -
    -

    -Anti-sampling

    +
    +

    Anti-sampling +

    Anti-sampling is a common use case for using the API.

    -

    Sampling is due to your API request being over the session limits outlined in this Google article. This limit is higher for Google Analytics 360.

    +

    Sampling is due to your API request being over the session limits outlined in this Google article. This limit is higher for Google Analytics 360.

    If you split up your API request so that the number of sessions falls under these limits, sampling will not occur.

    -
    -

    -Sampled data example

    +
    +

    Sampled data example +

    If you have sampling in your data request, googleAnalyticsR reports it back to you in the console when making the request.

    -library(googleAnalyticsR)
+library(googleAnalyticsR)
 ga_auth()
 sampled_data_fetch <- google_analytics(id, 
-                                         date_range = c("2015-01-01","2015-06-21"), 
-                                         metrics = c("users","sessions","bounceRate"), 
-                                         dimensions = c("date","landingPagePath","source"))
+                                         date_range = c("2015-01-01","2015-06-21"), 
+                                         metrics = c("users","sessions","bounceRate"), 
+                                         dimensions = c("date","landingPagePath","source"))
 #Calling APIv4....
 #Data is sampled, based on 39.75% of visits.
    -
    -

    -Unsampled data example

    +
    +

    Unsampled data example +

    Setting the argument anti_sample=TRUE in a google_analytics() request causes the calls to be split up into small enough chunks to avoid sampling. This uses more API calls so the data will reach you slower, but it should hold more detail.

    -library(googleAnalyticsR)
+library(googleAnalyticsR)
 ga_auth()
 unsampled_data_fetch <- google_analytics(id, 
-                                         date_range = c("2015-01-01","2015-06-21"), 
-                                         metrics = c("users","sessions","bounceRate"), 
-                                         dimensions = c("date","landingPagePath","source"),
+                                         date_range = c("2015-01-01","2015-06-21"), 
+                                         metrics = c("users","sessions","bounceRate"), 
+                                         dimensions = c("date","landingPagePath","source"),
                                          anti_sample = TRUE)
 
 #anti_sample set to TRUE. Mitigating sampling via multiple API calls.
@@ -416,46 +418,46 @@ 
    
 #Successfully avoided sampling

    The sequence involves a couple of exploratory API calls to determine the best split. This method will adjust the time periods to have the batch sizes large enough to not take too long, but small enough to have unsampled data.

    -
    -

    -Auto-anti sampling failure

    +
    +

    Auto-anti sampling failure +

    In some cases the anti-sampling won’t work. This will mainly be due to filters for the View you are using meaning that the calculation for the sampling sessions are incorrect - Google Analytics vanilla samples on a property level (whilst GA360 samples on a View level).

    Try using a raw profile if you can, otherwise you can set your own sample period by using the anti_sample_batches flag to indicate the sample size. Pick a number that is a little lower than the smallest period you saw in the auto-sample batches. If in doubt, setting anti_sample_batches to 1 will make a daily fetch.

     ## example setting your own anti_sample_batch to 5 days per batch
 unsampled_data_fetch <- google_analytics(id, 
-                                             date_range = c("2015-01-01","2015-06-21"), 
-                                             metrics = c("users","sessions","bounceRate"), 
-                                             dimensions = c("date","landingPagePath","source"),
+                                             date_range = c("2015-01-01","2015-06-21"), 
+                                             metrics = c("users","sessions","bounceRate"), 
+                                             dimensions = c("date","landingPagePath","source"),
                                              anti_sample = TRUE,
                                              anti_sample_batch = 5)
    -
    -

    -Filters

    +
    +

    Filters +

    -

    Note these are different from account filters, which you can manipulate using the management API using the ga_filter family of functions. See the Management API

    +

    Note these are different from account filters, which you can manipulate using the management API using the ga_filter family of functions. See the Management API

    Filters need to be built up from the met_filter and dim_filter R objects.

    -

    These then need to be wrapped in filter_clause_ga4 function, which lets you specify the combination rules (AND or OR). The met_filter and dim_filter you pass in should be wrapped in a list() - see examples:

    -
    -

    -One filter

    +

    These then need to be wrapped in filter_clause_ga4 function, which lets you specify the combination rules (AND or OR). The met_filter and dim_filter you pass in should be wrapped in a list() - see examples:

    +
    +

    One filter +

     campaign_filter <- dim_filter(dimension="campaign",operator="REGEXP",expressions="welcome")
 
-my_filter_clause <- filter_clause_ga4(list(campaign_filter))
+my_filter_clause <- filter_clause_ga4(list(campaign_filter))
 
-data_fetch <- google_analytics(ga_id,date_range = c("2016-01-01","2016-12-31"),
-                                 metrics = c("itemRevenue","itemQuantity"),
-                                 dimensions = c("campaign","transactionId","dateHour"),
+data_fetch <- google_analytics(ga_id,date_range = c("2016-01-01","2016-12-31"),
+                                 metrics = c("itemRevenue","itemQuantity"),
+                                 dimensions = c("campaign","transactionId","dateHour"),
                                  dim_filters = my_filter_clause,
                                  anti_sample = TRUE)
    -
    -

    -Multiple filters

    +
    +

    Multiple filters +

     ## create filters on metrics
 mf <- met_filter("bounces", "GREATER_THAN", 0)
@@ -466,14 +468,14 @@ 
    
 df2 <- dim_filter("source","BEGINS_WITH","a",not = TRUE)
 
 ## construct filter objects
-fc2 <- filter_clause_ga4(list(df, df2), operator = "AND")
-fc <- filter_clause_ga4(list(mf, mf2), operator = "AND")
+fc2 <- filter_clause_ga4(list(df, df2), operator = "AND")
+fc <- filter_clause_ga4(list(mf, mf2), operator = "AND")
 
 ## make v4 request
 ga_data1 <- google_analytics(ga_id, 
-                              date_range = c("2015-07-30","2015-10-01"),
-                              dimensions=c('source','medium'), 
-                              metrics = c('sessions','bounces'), 
+                              date_range = c("2015-07-30","2015-10-01"),
+                              dimensions=c('source','medium'), 
+                              metrics = c('sessions','bounces'), 
                               met_filters = fc, 
                               dim_filters = fc2, 
                               filtersExpression = "ga:source!=(direct)")
@@ -494,38 +496,38 @@ 
    
 # 11              zapmeta.se referral        6       4
    -
    -

    -Multiple reports

    +
    +

    Multiple reports +

    Using v4’s batching ability, you can send in multiple types of API requests at the same time (up to 5). The reports need to be for the same ViewID and date range.

    To use, you need to create your API requests first using make_ga_4_req(), then make the actual call using fetch_google_analytics(). For the common use case of only requesting one type of request, this is what google_analytics() is doing behind the scenes.

    -
    -

    -Demo of querying two API requests

    +
    +

    Demo of querying two API requests +

    The below example requests with two date ranges and two reports.

    -

    When fetching multiple reports, you need to wrap the make_ga_4_req() created objects in a list()

    +

    When fetching multiple reports, you need to wrap the make_ga_4_req() created objects in a list()

     ## First request we make via make_ga_4_req()
 multidate_test <- make_ga_4_req(ga_id, 
-                                date_range = c("2015-07-30",
+                                date_range = c("2015-07-30",
                                                "2015-10-01",
                                                "2014-07-30",
                                                "2014-10-01"),
-                                dimensions = c('source','medium'), 
-                                metrics = c('sessions','bounces'),
+                                dimensions = c('source','medium'), 
+                                metrics = c('sessions','bounces'),
                                 order = order_type("sessions", "DESCENDING", "DELTA"))
 
 ## Second request - same date ranges and ID required, but different dimensions/metrics/order.
 multi_test2 <- make_ga_4_req(ga_id,
-                                date_range = c("2015-07-30",
+                                date_range = c("2015-07-30",
                                                "2015-10-01",
                                                "2014-07-30",
                                                "2014-10-01"),
-                             dimensions=c('hour','medium'), 
-                             metrics = c('visitors','bounces'))
+                             dimensions=c('hour','medium'), 
+                             metrics = c('visitors','bounces'))
 
 ## Request the two calls by wrapping them in a list() and passing to fetch_google_analytics()
-ga_data3 <- fetch_google_analytics(list(multidate_test, multi_test2)) 
+ga_data3 <- fetch_google_analytics(list(multidate_test, multi_test2)) 
 ga_data3
 # [[1]]
 #                     source   medium sessions.d1 bounces.d1 sessions.d2 bounces.d2
@@ -549,16 +551,16 @@
    -
    -

    -Metric expressions

    +
    +

    Metric expressions +

    Metric expressions are custom calculated metrics that can be calculated on the fly when you supply a named vector with the name of your created custom metric, and the calculation expression you are performing. These are different from the calculated metrics you can create in the web UI.

    You need to use the ga: prefix when creating custom metrics, unlike normal API requests

    -my_custom_metric <- c(visitPerVisitor = "ga:visits/ga:visitors")
    -

    Use metric expressions as you would other metrics within the metrics argument, but you also need to supply a metricFormat (see docs) vector the same length which specifies the type of the metric you have calculated. These can be:

    +my_custom_metric <- c(visitPerVisitor = "ga:visits/ga:visitors")
    +

    Use metric expressions as you would other metrics within the metrics argument, but you also need to supply a metricFormat (see docs) vector the same length which specifies the type of the metric you have calculated. These can be:

    • METRIC_TYPE_UNSPECIFIED
    • INTEGER
      • @@ -571,28 +573,28 @@

    An example is shown below, where a calculated metric is combined with a normal metric, bounces, which is type integer. You can lookup what the default metrics types are in the meta lookup table.

    -my_custom_metric <- c(visitPerVisitor = "ga:visits/ga:visitors")
+my_custom_metric <- c(visitPerVisitor = "ga:visits/ga:visitors")
 ga_data4 <- google_analytics(ga_id,
-                               date_range = c("2015-07-30",
+                               date_range = c("2015-07-30",
                                               "2015-10-01"),
-                              dimensions=c('medium'), 
-                              metrics = c(my_custom_metric,
+                              dimensions=c('medium'), 
+                              metrics = c(my_custom_metric,
                                           'bounces'), 
-                              metricFormat = c("FLOAT","INTEGER"))
+                              metricFormat = c("FLOAT","INTEGER"))
 ga_data4
 #     medium visitsPerVisitor bounces
 # 1   (none)         1.000000     117
 # 2  organic         1.075137     612
 # 3 referral         1.012500      71
    -
    -

    -Segments v4

    +
    +

    Segments v4 +

    Segments are more complex to configure that v3, but more powerful and in line to how you configure them in the UI.

    A lot of feedback is about how to get the sample syntax right, so the examples below try to cover common scenarios.

    -
    -

    -v3 segments

    +
    +

    v3 segments +

    You can choose to create segments via the v4 syntax or the v3 syntax for backward compatibility.

    If you want to use v3 segments, then they can be used in the segment_id argument of the segment_ga4() function.

    You can view the segment Ids by using ga_segment_list()

    @@ -621,10 +623,10 @@

    ## make the segment call segmented_ga1 <- google_analytics(ga_id, - c("2015-07-30","2015-10-01"), - dimensions=c('source','medium','segment'), + c("2015-07-30","2015-10-01"), + dimensions=c('source','medium','segment'), segments = seg_obj, - metrics = c('sessions','bounces') + metrics = c('sessions','bounces') )

    …or you can pass the v3 syntax for dynamic segments found from the $definition column:

    @@ -637,15 +639,15 @@

    ## make the segment call segmented_ga1 <- google_analytics(ga_id, - c("2015-07-30","2015-10-01"), - dimensions=c('source','medium','segment'), + c("2015-07-30","2015-10-01"), + dimensions=c('source','medium','segment'), segments = seg_obj, - metrics = c('sessions','bounces') + metrics = c('sessions','bounces') )

    -
    -

    -v4 segment syntax

    +
    +

    v4 segment syntax +

    Its recommended you embrace the new v4 syntax, as its more flexible and powerful in the long run.

    The hierarachy of the segment elements you will need are:

      @@ -661,9 +663,9 @@

    -
    -

    -Demo: simple segment

    +
    +

    Demo: simple segment +

     se <- segment_element("sessions", 
                       operator = "GREATER_THAN", 
@@ -678,12 +680,12 @@ 
    
 
 ## choose between segment_vector_simple or segment_vector_sequence
 ## Elements can be combined into clauses, which can then be combined into OR filter clauses
-sv_simple <- segment_vector_simple(list(list(se)))
+sv_simple <- segment_vector_simple(list(list(se)))
 
-sv_simple2 <- segment_vector_simple(list(list(se2)))
+sv_simple2 <- segment_vector_simple(list(list(se2)))
 
 ## Each segment vector can then be combined into a logical AND
-seg_defined <- segment_define(list(sv_simple, sv_simple2))
+seg_defined <- segment_define(list(sv_simple, sv_simple2))
 
 ## Each segement defintion can apply to users, sessions or both.
 ## You can pass a list of several segments
@@ -691,10 +693,10 @@ 
    
 
 ## Add the segments to the segments param
 segment_example <- google_analytics(ga_id, 
-                                      c("2015-07-30","2015-10-01"), 
-                                      dimensions=c('source','medium','segment'), 
+                                      c("2015-07-30","2015-10-01"), 
+                                      dimensions=c('source','medium','segment'), 
                                       segments = segment4, 
-                                      metrics = c('sessions','bounces')
+                                      metrics = c('sessions','bounces')
                                       )
 
 segment_example
@@ -709,10 +711,10 @@ 
    
 
 ## Add the segments to the segments param
 segment_example2 <- google_analytics(ga_id, 
-                                      c("2015-07-30","2015-10-01"), 
-                                      dimensions=c('source','medium','segment'), 
-                                      segments = list(segment4, segment4_again),
-                                      metrics = c('sessions','bounces')
+                                      c("2015-07-30","2015-10-01"), 
+                                      dimensions=c('source','medium','segment'), 
+                                      segments = list(segment4, segment4_again),
+                                      metrics = c('sessions','bounces')
                                       )
 #                source   medium  segment sessions bounces
 #1             (direct)   (none)   simple       30      22
@@ -723,52 +725,52 @@ 
    
 #6  analyticsforfun.com referral simple_2        5       1
 #...
    -
    -

    -Demo: Sequence segment

    -
    se2 <- segment_element("medium", 
-                       operator = "EXACT", 
-                       type = "DIMENSION", 
-                       expressions = "organic")
+
    
+
    Demo: Sequence segment
+
    
+
    se2 <- segment_element("medium", 
+                       operator = "EXACT", 
+                       type = "DIMENSION", 
+                       expressions = "organic")
   
-se3 <- segment_element("medium",
-                       operator = "EXACT",
-                       type = "DIMENSION",
-                       not = TRUE,
-                       expressions = "organic")
+se3 <- segment_element("medium",
+                       operator = "EXACT",
+                       type = "DIMENSION",
+                       not = TRUE,
+                       expressions = "organic")
   
-## step sequence
-## users who arrived via organic then via referral
-sv_sequence <- segment_vector_sequence(list(list(se2), 
-                                              list(se3)))
+## step sequence
+## users who arrived via organic then via referral
+sv_sequence <- segment_vector_sequence(list(list(se2), 
+                                              list(se3)))
   
-seq_defined2 <- segment_define(list(sv_sequence))
+seq_defined2 <- segment_define(list(sv_sequence))
   
-segment4_seq <- segment_ga4("sequence", user_segment = seq_defined2)
+segment4_seq <- segment_ga4("sequence", user_segment = seq_defined2)
   
-## Add the segments to the segments param
-segment_seq_example <- google_analytics(ga_id, 
-                                        c("2016-01-01","2016-03-01"), 
-                                        dimensions=c('source','segment'), 
-                                        segments = segment4_seq,
-                                        metrics = c('sessions','bounces')
-                                        )
+## Add the segments to the segments param
+segment_seq_example <- google_analytics(ga_id, 
+                                        c("2016-01-01","2016-03-01"), 
+                                        dimensions=c('source','segment'), 
+                                        segments = segment4_seq,
+                                        metrics = c('sessions','bounces')
+                                        )
   
-segment_seq_example
-#                                source  segment sessions bounces
-# 1                                 aol sequence        1       0
-# 2                                 ask sequence        5       1
-# 3      bestbackpackersinsurance.co.uk sequence        9       6
-# 4                                bing sequence       22       2
    
+segment_seq_example
+#                                source  segment sessions bounces
+# 1                                 aol sequence        1       0
+# 2                                 ask sequence        5       1
+# 3      bestbackpackersinsurance.co.uk sequence        9       6
+# 4                                bing sequence       22       2

    Some more examples, using different match types, contributed by Pawel Kapuscinski:

    -con1 <-segment_vector_simple(list(list(segment_element("ga:dimension1", 
+con1 <-segment_vector_simple(list(list(segment_element("ga:dimension1", 
                       operator = "REGEXP", 
                       type = "DIMENSION", 
                       expressions = ".*", 
                       scope = "SESSION"))))
 
-con2 <-segment_vector_simple(list(list(segment_element("ga:deviceCategory", 
+con2 <-segment_vector_simple(list(list(segment_element("ga:deviceCategory", 
                       operator = "EXACT", 
                       type = "DIMENSION", 
                       expressions = "Desktop", 
@@ -788,15 +790,15 @@ 
    
                          scope = "SESSION",
                          matchType = "IMMEDIATELY_PRECEDES")
 
-allSEQ <- segment_vector_sequence(list(list(seq1), list(seq2)))
+allSEQ <- segment_vector_sequence(list(list(seq1), list(seq2)))
 
 results <- google_analytics(ga_id, 
-                             date_range = c("2016-08-08","2016-09-08"),
+                             date_range = c("2016-08-08","2016-09-08"),
                              segments = segment_ga4("sequence+condition",
-                                                    user_segment = segment_define(list(con1,con2,allSEQ))
+                                                    user_segment = segment_define(list(con1,con2,allSEQ))
                                                     ),
-                             metrics = c('ga:users'),
-                             dimensions = c('ga:segment'))
+                             metrics = c('ga:users'),
+                             dimensions = c('ga:segment'))
 
 # Users whose first session to website was social:
 seg_social <- segment_element("channelGrouping",
@@ -808,20 +810,20 @@ 
    
                                    type = "DIMENSION",
                                    expressions = "1")
 # social referrral followed by first sessionCount
-segment_social_first <- segment_vector_sequence(list(list(seg_social), list(seg_first_visit)))
-sd_segment <- segment_define(list(segment_social_first))
+segment_social_first <- segment_vector_sequence(list(list(seg_social), list(seg_first_visit)))
+sd_segment <- segment_define(list(segment_social_first))
 segment_social <- segment_ga4("social_first", user_segment = sd_segment)
 segment_data <- google_analytics_4(my_viewId,
-                                   date_range = c("8daysAgo", "yesterday"),
-                                   metrics = c("sessions", "users", sessions_per_user = "ga:sessions/ga:users"),
-                                   dimensions = c("date", "country", "channelGrouping", "sessionCount"),
+                                   date_range = c("8daysAgo", "yesterday"),
+                                   metrics = c("sessions", "users", sessions_per_user = "ga:sessions/ga:users"),
+                                   dimensions = c("date", "country", "channelGrouping", "sessionCount"),
                                    segments = segment_social,
-                                   metricFormat = c("FLOAT", "INTEGER", "INTEGER"))
    -

    If you are still struggling with segment syntax, you may want to try the ganalytics package by Johann de Boer which has developed a domain specific language for making segments and may be easier to parse.

    + metricFormat = c("FLOAT", "INTEGER", "INTEGER"))
    +

    If you are still struggling with segment syntax, you may want to try the ganalytics package by Johann de Boer which has developed a domain specific language for making segments and may be easier to parse.

    -
    -

    -RStudio Addin: Segment helper

    +
    +

    RStudio Addin: Segment helper +

    There is an RStudio Addin to help create segments via a UI rather than the lists above.

    You can call it via googleAnalyticsR:::gadget_GASegment() or within the RStudio interface like displayed below:

    @@ -829,30 +831,30 @@

    -
    -

    -Cohort reports

    -

    Details on cohort reports and LTV can be found here and via the examples below.

    +
    +

    Cohort reports +

    +

    Details on cohort reports and LTV can be found here and via the examples below.

     ## first make a cohort group
-cohort4 <- make_cohort_group(list("Jan2016" = c("2016-01-01", "2016-01-31"), 
-                                "Feb2016" = c("2016-02-01","2016-02-28")))
+cohort4 <- make_cohort_group(list("Jan2016" = c("2016-01-01", "2016-01-31"), 
+                                "Feb2016" = c("2016-02-01","2016-02-28")))
 
 ## then call cohort report.  No date_range and must include metrics and dimensions
 ##   from the cohort list
 cohort_example <- google_analytics(ga_id, 
-                                     dimensions=c('cohort'), 
+                                     dimensions=c('cohort'), 
                                      cohort = cohort4, 
-                                     metrics = c('cohortTotalUsers'))
+                                     metrics = c('cohortTotalUsers'))
 
 cohort_example
 #    cohort cohortTotalUsers
 # 1 Feb2016            19040
 # 2 Jan2016            23378
    -
    -

    -Pivot Requests

    +
    +

    Pivot Requests +

    These change the shape of the returned data, which you could probably do in R anyway but it gives you another option when you make the request.

     
@@ -861,61 +863,61 @@ 
    
                                 "REGEXP",
                                 "organic|social|email|cpc")
                                 
-pivot_dim_clause <- filter_clause_ga4(list(pivot_dim_filter1))
+pivot_dim_clause <- filter_clause_ga4(list(pivot_dim_filter1))
 
 pivme <- pivot_ga4("medium",
-                   metrics = c("sessions"), 
+                   metrics = c("sessions"), 
                    maxGroupCount = 4, 
                    dim_filter_clause = pivot_dim_clause)
 
 pivtest1 <- google_analytics(ga_id, 
-                               c("2016-01-30","2016-10-01"), 
-                               dimensions=c('source'), 
-                               metrics = c('sessions'), 
-                               pivots = list(pivme))
+                               c("2016-01-30","2016-10-01"), 
+                               dimensions=c('source'), 
+                               metrics = c('sessions'), 
+                               pivots = list(pivme))
 
 
-names(pivtest1)
+names(pivtest1)
 #  [1] "source"                      "sessions"                    "medium.referral.sessions"   
 #  [4] "medium..none..sessions"      "medium.cpc.sessions"         "medium.email.sessions"      
 #  [7] "medium.social.sessions"      "medium.twitter.sessions"     "medium.socialMedia.sessions"
 # [10] "medium.Social.sessions"      "medium.linkedin.sessions"
    -
    -

    -GA360 Quota System

    -

    If you have GA360, you have access to resource based quotas that increase the number of sessions before sampling kicks in from 1 to 100 million sessions.

    +
    +

    GA360 Quota System +

    +

    If you have GA360, you have access to resource based quotas that increase the number of sessions before sampling kicks in from 1 to 100 million sessions.

    To access this quota, set useResourceQuotas = TRUE in the command.

     google_analytics(ga_id, 
-                 date_range = c("2017-01-01", "2017-03-01"), 
+                 date_range = c("2017-01-01", "2017-03-01"), 
                  metrics = "sessions", 
                  dimensions = "date",
                  max = -1,
                  useResourceQuotas = TRUE)
    -
    -

    -Customising API fetches

    +
    +

    Customising API fetches +

    googleAnalyticsR has some techniques implemented to get the data as quickly as possible. This includes:

    -
    -

    -Batching large results

    +
    +

    Batching large results +

    The v4 API allows you to send 5 batched calls at once in one API request, meaning by default 50,000 rows will be requested per API call. However, since this puts additional strain on the Google servers, for complicated queries (i.e. lots of segments or dimensions) this may fail with a 500 error. If that happens, the library will fall back to the slower fetching of 10,000 rows per API call.

    If you want to default to the slower fetching, set slow_fetch=TRUE in your request e.g.

     google_analytics(ga_id, 
-                 date_range = c("2017-01-01", "2017-03-01"), 
+                 date_range = c("2017-01-01", "2017-03-01"), 
                  metrics = "sessions", 
                  dimensions = "date",
                  max = -1,
                  slow_fetch = TRUE)
    -
    -

    -Caching

    +
    +

    Caching +

    Local caching is enabled that will mean if you make the exact same API request with all arguments the same, the result will come from memory rather than the API. By default this is within the RAM of the same R session so will reset when you restart R, but if you want you can set this to save the cache to disk using the ga_cache_call() function. Use this to point to a folder to store the cache files, and the cache will then be available inbetween R sessions.

    -

    A demo on using caching is in the video here: googleAnalyticsR - caching and is embedded below:.

    +

    A demo on using caching is in the video here: googleAnalyticsR - caching and is embedded below:.

    e.g.

    @@ -924,29 +926,29 @@

    ## will make the call and save files to my_cache_folder google_analytics(ga_id, - date_range = c("2017-01-01", "2017-03-01"), + date_range = c("2017-01-01", "2017-03-01"), metrics = "sessions", dimensions = "date", max = -1) ## making the same exact call again will read from disk, and be much quicker google_analytics(ga_id, - date_range = c("2017-01-01", "2017-03-01"), + date_range = c("2017-01-01", "2017-03-01"), metrics = "sessions", dimensions = "date", max = -1)

    This means that repeated long fetches can be much quicker as older requests will read from disk.

    If you are running long repeated calls over time, this is a good strategy to only fetch the latest data from the API, relying on the cache for historic data - for instance, set a loop that requests each month’s worth of data - for the month’s you already have the requests will come from disk, but for the most recent month it will fetch from the API.

    -
    -

    -Rows Per call

    +
    +

    Rows Per call +

    The API lets you call up to 100,000 rows, which coupled with the batching above means potentially 500,000 rows can be called per API call. In reality, this many rows will probably be too heavy for the Google servers, so you may want to experiment using increased row per calls but with slow_fetch=TRUE to find the optimum.

    e.g.

     ## making the same exact call again will read from disk, and be much quicker
 google_analytics(ga_id, 
-                 date_range = c("2017-01-01", "2017-03-01"), 
+                 date_range = c("2017-01-01", "2017-03-01"), 
                  metrics = "sessions", 
                  dimensions = "date",
                  rows_per_call = 40000,
@@ -955,26 +957,26 @@ 
    
 
    The defaults are 10,000 rows per call (50,000 per batch) and slow_fetch = FALSE which suit for most cases.
    -
    -

    -Fetching from multiple views

    -

    Whilst the v3 multi account batching feature isn’t available for multi-accounts in v4, by using future.apply you can launch multiple R sessions that will fetch the API in parallel. An example is shown below, that fetches from three View IDs at once.

    -

    The limiting factor will then be the v4 API limits, which are currently 1000 requests per 100 seconds per user, per Google API project (e.g. you will probably want to setup your own Google project if making a lot of requests)

    +
    +

    Fetching from multiple views +

    +

    Whilst the v3 multi account batching feature isn’t available for multi-accounts in v4, by using future.apply you can launch multiple R sessions that will fetch the API in parallel. An example is shown below, that fetches from three View IDs at once.

    +

    The limiting factor will then be the v4 API limits, which are currently 1000 requests per 100 seconds per user, per Google API project (e.g. you will probably want to setup your own Google project if making a lot of requests)

    -library(googleAnalyticsR)
-library(future.apply)
+library(googleAnalyticsR)
+library(future.apply)
 
 ## setup multisession R for your parallel data fetches 
 plan(multisession)
 
 ## the ViewIds to fetch all at once
-gaids <- c(12345634, 9888890,10624323)
+gaids <- c(12345634, 9888890,10624323)
 
 my_fetch <- function(x) {
   google_analytics(x, 
-                   date_range = c("2017-01-01","yesterday"), 
+                   date_range = c("2017-01-01","yesterday"), 
                    metrics = "sessions", 
-                   dimensions = c("date","medium"))
+                   dimensions = c("date","medium"))
 }
 
 ## makes 3 API calls at once
@@ -993,11 +995,13 @@ 
    
 
 
       
    
-  
    Developed by Mark Edmondson.
    
+  
    
+
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    
+
    Site built with pkgdown 2.0.1.
    
 
    
 
       
    
@@ -1006,5 +1010,7 @@ 
    
   
 
 
+  
+
   
 
diff --git a/docs/authors.html b/docs/authors.html
index 728491f1..b3324ac4 100644
--- a/docs/authors.html
+++ b/docs/authors.html
@@ -1,84 +1,18 @@
-
 
-
-  
-  
-
-
-
-Authors • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Authors and Citation • googleAnalyticsR
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
-    
    
-      
    
-      
    
-
-
    
+      
    
   
    
-    
    
-      
    Authors
    
+    
    
+      
    
+        
    Authors
    
+      
    
+
+      
+      
    • 
+          
      Mark Edmondson. Author, maintainer. 
+          
      
+        
      • 
+        
    • 
+          
      Artem Klevtsov. Contributor. 
+          
      
+        
      • 
+        
    • 
+          
      Johann deBoer. Contributor. 
+          
      
+        
      • 
+        
    • 
+          
      David Watkins. Contributor. 
+          
      
+        
      • 
+        
    • 
+          
      Olivia Brode-Roger. Contributor. 
+          
      
+        
      • 
+        
    • 
+          
      Jas Sohi. Contributor. 
+          
      
+        
      • 
+        
    • 
+          
      Zoran Selinger. Contributor. 
+          
      
+        
      • 
+        
    • 
+          
      Octavian Corlade. Contributor. 
+          
      
+        
      • 
+        
    • 
+          
      Maegan Whytock. Contributor. 
+          
      
+        
      • 
+      
    
+    
    
+    
    
+      
    Citation
    
+      Source: DESCRIPTION
     
    
+    
    
+
 
-    
      
-      
    • 
-        
      Mark Edmondson. Author, maintainer. 
-        
      
-      
      • 
-      
    • 
-        
      Artem Klevtsov. Contributor. 
-        
      
-      
      • 
-      
    • 
-        
      Johann deBoer. Contributor. 
-        
      
-      
      • 
-      
    • 
-        
      David Watkins. Contributor. 
-        
      
-      
      • 
-      
    • 
-        
      Olivia Brode-Roger. Contributor. 
-        
      
-      
      • 
-      
    • 
-        
      Jas Sohi. Contributor. 
-        
      
-      
      • 
-      
    • 
-        
      Zoran Selinger. Contributor. 
-        
      
-      
      • 
-      
    • 
-        
      Octavian Corlade. Contributor. 
-        
      
-      
      • 
-      
    • 
-        
      Maegan Whytock. Contributor. 
-        
      
-      
      • 
-    
    
+    
    Edmondson M (2022).
+googleAnalyticsR: Google Analytics API into R.
+R package version 1.0.1, https://code.markedmondson.me/googleAnalyticsR/. 
+
    
+    
    @Manual{,
+  title = {googleAnalyticsR: Google Analytics API into R},
+  author = {Mark Edmondson},
+  year = {2022},
+  note = {R package version 1.0.1},
+  url = {https://code.markedmondson.me/googleAnalyticsR/},
+}
    
 
   
    
 
@@ -333,22 +272,20 @@ 
    Authors
    
 
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/index.html b/docs/index.html
index 331d1064..037ccd35 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -26,15 +26,17 @@
 
 
 
+    
+
     
    
       
    
   
    
-
    
+
    
 
 
 
-
    
-
    
-googleAnalyticsR
    
-
    Welcome to the website for googleAnalyticsR, an R library for working with Google Analytics data.
    
+
    
+
    googleAnalyticsR
+
    
+
    Welcome to the website for googleAnalyticsR, an R library for working with Google Analytics data.
    
 
    
-
    Follow development on the project’s Github development site. or browse the development documentation of googleAnalyticsR which is subject to change.
    
-
    The Slack group googleAuthRverse includes a #googleAnalyticsR channel. For news, chat and support join via this request form.
    
+
    Follow development on the project’s Github development site. or browse the development documentation of googleAnalyticsR which is subject to change.
    
+
    The Slack group googleAuthRverse includes a #googleAnalyticsR channel. For news, chat and support join via this request form.
    
 
    Collaboration is welcomed and encouraged, if you are interested get in touch.
    
 
    
-
    
-
    
-Features
    
+
    
+
    Features
+
    
 
 
    
-
    
-
    
-Thanks
    
+
    
+
    Thanks
+
    
 
    These are all great libraries that also work with Google Analytics data in R, that I have taken inspiration from.
    
 
 
    Thanks also to the many contributors to the package that have been creating features, finding and fixing bugs and giving feedback. They have all helped create the package as it is today. In particular Jas Sohi (@j450h1) and Zoran Selinger (@zselinger) for their work on new management API features.
    
 
    
-
    
-
    
-Tutorials
    
+
    
+
    Tutorials
+
    
 
    If you have used the package and published online then get in touch and I’ll list it here so others can benefit.
    
 
 
    
-
    
-
    
-My website
    
-
    There are some blog posts on using googleAnalyticsR and various other data science code for digital marketing on my blog: Mark Edmondson’s Blog.
    
-
    There you can also see other R packages working with digital marketing applications such as searchConsoleR, bigQueryR and googleMeasureR.
    
+
    
+
    My website
+
    
+
    There are some blog posts on using googleAnalyticsR and various other data science code for digital marketing on my blog: Mark Edmondson’s Blog.
    
+
    There you can also see other R packages working with digital marketing applications such as searchConsoleR, bigQueryR and googleMeasureR.
    
 
    
 
    
   
    
 
   
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/pkgdown.css b/docs/pkgdown.css
index 1273238d..80ea5b83 100644
--- a/docs/pkgdown.css
+++ b/docs/pkgdown.css
@@ -56,8 +56,10 @@ img.icon {
   float: right;
 }
 
-img {
+/* Ensure in-page images don't run outside their container */
+.contents img {
   max-width: 100%;
+  height: auto;
 }
 
 /* Fix bug in bootstrap (only seen in firefox) */
@@ -78,11 +80,10 @@ dd {
 /* Section anchors ---------------------------------*/
 
 a.anchor {
-  margin-left: -30px;
-  display:inline-block;
-  width: 30px;
-  height: 30px;
-  visibility: hidden;
+  display: none;
+  margin-left: 5px;
+  width: 20px;
+  height: 20px;
 
   background-image: url(./link.svg);
   background-repeat: no-repeat;
@@ -90,17 +91,15 @@ a.anchor {
   background-position: center center;
 }
 
-.hasAnchor:hover a.anchor {
-  visibility: visible;
-}
-
-@media (max-width: 767px) {
-  .hasAnchor:hover a.anchor {
-    visibility: hidden;
-  }
+h1:hover .anchor,
+h2:hover .anchor,
+h3:hover .anchor,
+h4:hover .anchor,
+h5:hover .anchor,
+h6:hover .anchor {
+  display: inline-block;
 }
 
-
 /* Fixes for fixed navbar --------------------------*/
 
 .contents h1, .contents h2, .contents h3, .contents h4 {
@@ -264,31 +263,26 @@ table {
 
 /* Syntax highlighting ---------------------------------------------------- */
 
-pre {
-  word-wrap: normal;
-  word-break: normal;
-  border: 1px solid #eee;
-}
-
-pre, code {
+pre, code, pre code {
   background-color: #f8f8f8;
   color: #333;
 }
+pre, pre code {
+  white-space: pre-wrap;
+  word-break: break-all;
+  overflow-wrap: break-word;
+}
 
-pre code {
-  overflow: auto;
-  word-wrap: normal;
-  white-space: pre;
+pre {
+  border: 1px solid #eee;
 }
 
-pre .img {
+pre .img, pre .r-plt {
   margin: 5px 0;
 }
 
-pre .img img {
+pre .img img, pre .r-plt img {
   background-color: #fff;
-  display: block;
-  height: auto;
 }
 
 code a, pre a {
@@ -305,9 +299,8 @@ a.sourceLine:hover {
 .kw      {color: #264D66;} /* keyword */
 .co      {color: #888888;} /* comment */
 
-.message { color: black;   font-weight: bolder;}
-.error   { color: orange;  font-weight: bolder;}
-.warning { color: #6A0366; font-weight: bolder;}
+.error   {font-weight: bolder;}
+.warning {font-weight: bolder;}
 
 /* Clipboard --------------------------*/
 
@@ -365,3 +358,27 @@ mark {
     content: "";
   }
 }
+
+/* Section anchors ---------------------------------
+   Added in pandoc 2.11: https://github.com/jgm/pandoc-templates/commit/9904bf71
+*/
+
+div.csl-bib-body { }
+div.csl-entry {
+  clear: both;
+}
+.hanging-indent div.csl-entry {
+  margin-left:2em;
+  text-indent:-2em;
+}
+div.csl-left-margin {
+  min-width:2em;
+  float:left;
+}
+div.csl-right-inline {
+  margin-left:2em;
+  padding-left:1em;
+}
+div.csl-indent {
+  margin-left: 2em;
+}
diff --git a/docs/pkgdown.js b/docs/pkgdown.js
index 7e7048fa..6f0eee40 100644
--- a/docs/pkgdown.js
+++ b/docs/pkgdown.js
@@ -80,7 +80,7 @@
     $(document).ready(function() {
       var copyButton = "";
 
-      $(".examples, div.sourceCode").addClass("hasCopyButton");
+      $("div.sourceCode").addClass("hasCopyButton");
 
       // Insert copy buttons:
       $(copyButton).prependTo(".hasCopyButton");
@@ -91,7 +91,7 @@
       // Initialize clipboard:
       var clipboardBtnCopies = new ClipboardJS('[data-clipboard-copy]', {
         text: function(trigger) {
-          return trigger.parentNode.textContent;
+          return trigger.parentNode.textContent.replace(/\n#>[^\n]*/g, "");
         }
       });
 
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
index 8d5d1a4a..f7b49fc9 100644
--- a/docs/pkgdown.yml
+++ b/docs/pkgdown.yml
@@ -1,5 +1,5 @@
-pandoc: 2.11.4
-pkgdown: 1.6.1
+pandoc: 2.14.0.3
+pkgdown: 2.0.1
 pkgdown_sha: ~
 articles:
   big-query: big-query.html
@@ -17,8 +17,8 @@ articles:
   user-activity: user-activity.html
   v3: v3.html
   v4: v4.html
-last_built: 2021-10-05T19:17Z
+last_built: 2022-01-13T13:00Z
 urls:
-  reference: https://code.markedmondson.me/googleAnalyticsR//reference
-  article: https://code.markedmondson.me/googleAnalyticsR//articles
+  reference: https://code.markedmondson.me/googleAnalyticsR/reference
+  article: https://code.markedmondson.me/googleAnalyticsR/articles
 
diff --git a/docs/reference/accountPicker.html b/docs/reference/accountPicker.html
index eb7f9b02..4688f41e 100644
--- a/docs/reference/accountPicker.html
+++ b/docs/reference/accountPicker.html
@@ -1,86 +1,19 @@
-
 
-
-  
-  
-
-
-
-accountPicker UI Shiny Module - pick GA4 accounts/webProperties in Shiny — accountPickerUI • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-accountPicker UI Shiny Module - pick GA4 accounts/webProperties in Shiny — accountPickerUI • googleAnalyticsR
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    accountPicker UI Shiny Module - pick GA4 accounts/webProperties in Shiny
    
-    Source: R/shiny-modules-new.R
+    Source: R/shiny-modules-new.R
     
     
    
 
@@ -297,94 +215,84 @@ 
    accountPicker UI Shiny Module - pick GA4 accounts/webProperties in Shiny
    Shiny Module for use with accountPickerUI
    
     
    
 
-    
    accountPickerUI(id, width = NULL, inColumns = FALSE)
-
-accountPicker(id, ga_table, id_only = TRUE)
    
+    
    
+    
    accountPickerUI(id, width = NULL, inColumns = FALSE)
 
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    id
    Shiny id
    width
    The width of the input
    inColumns
    Whether to wrap selectInputs in width=4 columns
    ga_table
    A table GA4 accounts/web properties from ga_account_summary("ga4")
    id_only
    Whether to return just the id, not the row
    
-
-    
    Value
    
-
-    
    If id_only=FALSE, the row of ga_table for the selected GA4 web property e.g. use ga_table$propertyId to send to ga_data calls.  If id_only=TRUE, just the propertyId
    
-    
    See also
    
-
-    
    Other Shiny modules: 
-authDropdownUI(),
-authDropdown(),
-metricDimensionSelectUI(),
-multi_selectUI(),
-multi_select()
    
-
-    
    Examples
    
-    
    
-if (FALSE) {
+accountPicker(id, ga_table, id_only = TRUE)
    
+    
    
 
-ui <- fluidPage(title = "Shiny App",
-                 accountPickerUI("auth_menu", inColumns = TRUE))
-server <- function(input, output, session){
-  token <- gar_shiny_auth(session)
-  
-  accs <- reactive({
-    req(token)
-    ga_account_list("ga4")
-   })
-   
-  # module for authentication
-  property_id <- accountPicker("auth_menu", ga_table = accs, id_only = TRUE)
- }
- 
- shinyApp(gar_shiny_ui(ui, login_ui = silent_auth), server)
+    
    
+    
    Arguments
    
+    
    id
    
+
    Shiny id
    
+
    width
    
+
    The width of the input
    
+
    inColumns
    
+
    Whether to wrap selectInputs in width=4 columns
    
+
    ga_table
    
+
    A table GA4 accounts/web properties from ga_account_summary("ga4")
    
+
    id_only
    
+
    Whether to return just the id, not the row
    
+
    
+    
    
+    
    Value
    
+    
    If id_only=FALSE, the row of ga_table for the selected GA4 web property e.g. use ga_table$propertyId to send to ga_data calls.  If id_only=TRUE, just the propertyId
    
+    
    
+    
    
+    
    See also
    
+    
    Other Shiny modules: 
+authDropdownUI(),
+authDropdown(),
+metricDimensionSelectUI(),
+multi_selectUI(),
+multi_select()
    
+    
    
 
-}
-
    +
    +

    Examples

    + 
    
+if (FALSE) {
+
+ui <- fluidPage(title = "Shiny App",
+                 accountPickerUI("auth_menu", inColumns = TRUE))
+server <- function(input, output, session){
+  token <- gar_shiny_auth(session)
+  
+  accs <- reactive({
+    req(token)
+    ga_account_list("ga4")
+   })
+   
+  # module for authentication
+  property_id <- accountPicker("auth_menu", ga_table = accs, id_only = TRUE)
+ }
+ 
+ shinyApp(gar_shiny_ui(ui, login_ui = silent_auth), server)
+
+}
+
    +
    +
    -
    -
    -

    Developed by Mark Edmondson.

    +
    +

    Developed by Mark Edmondson.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - + + diff --git a/docs/reference/authDropdown.html b/docs/reference/authDropdown.html index 040b9ddd..f0de6dd3 100644 --- a/docs/reference/authDropdown.html +++ b/docs/reference/authDropdown.html @@ -1,85 +1,18 @@ - - - - - - - -authDropdown Shiny Module — authDropdown • googleAnalyticsR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -authDropdown Shiny Module — authDropdown • googleAnalyticsR - - - - - - + gtag('config', 'G-43MDXK6CLZ'); + + - - -
    -
    - -
    - -
    +

    authDropdown Shiny Module

    - Source: R/shiny-modules.R + Source: R/shiny-modules.R
    -

    Shiny Module for use with authDropdownUI

    +

    Shiny Module for use with authDropdownUI

    - 
    authDropdown(input, output, session, ga.table, viewIdOnly = TRUE, rmNA = TRUE)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - - - - - -
    input

    shiny input

    output

    shiny output

    session

    shiny session

    ga.table

    A table of GA tables

    viewIdOnly

    Default only returns the viewId, set to FALSE to return the row of ga.table satisfying the selections

    rmNA

    Will remove any rows that have NA listed for the columns. Set to FALSE to return all rows.

    - -

    Value

    +
    + 
    authDropdown(input, output, session, ga.table, viewIdOnly = TRUE, rmNA = TRUE)
    +
    +
    +

    Arguments

    +
    input
    +

    shiny input

    +
    output
    +

    shiny output

    +
    session
    +

    shiny session

    +
    ga.table
    +

    A table of GA tables

    +
    viewIdOnly
    +

    Default only returns the viewId, set to FALSE to return the row of ga.table satisfying the selections

    +
    rmNA
    +

    Will remove any rows that have NA listed for the columns. Set to FALSE to return all rows.

    +
    +
    +

    Value

    GA View Id selected

    -

    Details

    - -

    Call via shiny::callModule(authDropdown, "your_id")

    -

    See also

    - -

    Other Shiny modules: -accountPickerUI(), -authDropdownUI(), -metricDimensionSelectUI(), -multi_selectUI(), -multi_select()

    +
    +
    +

    Details

    +

    Call via shiny::callModule(authDropdown, "your_id")

    +
    +
    +

    See also

    +

    Other Shiny modules: +accountPickerUI(), +authDropdownUI(), +metricDimensionSelectUI(), +multi_selectUI(), +multi_select()

    +
    +
    -
    -
    -

    Developed by Mark Edmondson.

    +
    +

    Developed by Mark Edmondson.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - + + diff --git a/docs/reference/authDropdownUI.html b/docs/reference/authDropdownUI.html index 8b9a4ed1..0f0a2216 100644 --- a/docs/reference/authDropdownUI.html +++ b/docs/reference/authDropdownUI.html @@ -1,85 +1,18 @@ - - - - - - - -authDropdown UI Shiny Module — authDropdownUI • googleAnalyticsR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -authDropdown UI Shiny Module — authDropdownUI • googleAnalyticsR - - - - - + gtag('config', 'G-43MDXK6CLZ'); + + - - - -
    -
    - -
    - -
    +

    authDropdown UI Shiny Module

    - Source: R/shiny-modules.R + Source: R/shiny-modules.R
    @@ -295,63 +213,55 @@

    authDropdown UI Shiny Module

    Makes a dropdown row for use for authentication.

    - 
    authDropdownUI(id, width = NULL, inColumns = FALSE)
    - -

    Arguments

    - - - - - - - - - - - - - - -
    id

    Shiny id.

    width

    The width of the input

    inColumns

    whether to wrap selectInputs in width=4 columns.

    -

    Shiny Module for use with authDropdown.

    - -

    Value

    +
    + 
    authDropdownUI(id, width = NULL, inColumns = FALSE)
    +
    +
    +

    Arguments

    +
    id
    +

    Shiny id.

    +
    width
    +

    The width of the input

    +
    inColumns
    +

    whether to wrap selectInputs in width=4 columns.

    +

    Shiny Module for use with authDropdown.

    +
    +
    +

    Value

    Shiny UI

    -

    See also

    - -

    Other Shiny modules: -accountPickerUI(), -authDropdown(), -metricDimensionSelectUI(), -multi_selectUI(), -multi_select()

    +
    +
    +

    See also

    +

    Other Shiny modules: +accountPickerUI(), +authDropdown(), +metricDimensionSelectUI(), +multi_selectUI(), +multi_select()

    +
    +
    -
    -
    -

    Developed by Mark Edmondson.

    +
    +

    Developed by Mark Edmondson.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - + + diff --git a/docs/reference/dim_fil_ga4-class.html b/docs/reference/dim_fil_ga4-class.html index e37e1475..e32d2fe9 100644 --- a/docs/reference/dim_fil_ga4-class.html +++ b/docs/reference/dim_fil_ga4-class.html @@ -1,85 +1,18 @@ - - - - - - - -dim_fil_ga4 class. — dim_fil_ga4-class • googleAnalyticsR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -dim_fil_ga4 class. — dim_fil_ga4-class • googleAnalyticsR - - - - - - - - + gtag('config', 'G-43MDXK6CLZ'); + + -
    -
    - -
    - -
    +

    dim_fil_ga4 class.

    - Source: R/ga_v4_objects.R + Source: R/ga_v4_objects.R
    @@ -297,32 +215,27 @@

    dim_fil_ga4 class.

    -
    +
    -
    -
    -

    Developed by Mark Edmondson.

    +
    +

    Developed by Mark Edmondson.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - + + diff --git a/docs/reference/dim_filter.html b/docs/reference/dim_filter.html index c5b8deae..2344582f 100644 --- a/docs/reference/dim_filter.html +++ b/docs/reference/dim_filter.html @@ -1,85 +1,18 @@ - - - - - - - -Make a dimension filter object — dim_filter • googleAnalyticsR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Make a dimension filter object — dim_filter • googleAnalyticsR - - - - - - - - + gtag('config', 'G-43MDXK6CLZ'); + + -
    -
    - -
    - -
    +

    Make a dimension filter object

    - Source: R/filters.R + Source: R/filters.R
    @@ -295,114 +213,104 @@

    Make a dimension filter object

    Make a dimension filter object

    - 
    dim_filter(
-  dimension,
-  operator = c("REGEXP", "BEGINS_WITH", "ENDS_WITH", "PARTIAL", "EXACT",
-    "NUMERIC_EQUAL", "NUMERIC_GREATER_THAN", "NUMERIC_LESS_THAN", "IN_LIST"),
-  expressions,
-  caseSensitive = FALSE,
-  not = FALSE
-)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - -
    dimension

    dimension name to filter on.

    operator

    How to match the dimension.

    expressions

    What to match. A character vector if operator is "IN_LIST"

    caseSensitive

    Boolean.

    not

    Logical NOT operator. Boolean.

    - -

    Value

    - -

    An object of class dim_fil_ga4 for use in filter_clause_ga4()

    -

    See also

    - -

    Other filter functions: -filter_clause_ga4(), -met_filter()

    - -

    Examples

    - 
    
-if (FALSE) {
-library(googleAnalyticsR)
-
-## authenticate,
-## or use the RStudio Addin "Google API Auth" with analytics scopes set
-ga_auth()
-
-## get your accounts
-account_list <- google_analytics_account_list()
-
-## pick a profile with data to query
-
-ga_id <- account_list[23,'viewId']
-
-## create filters on metrics
-mf <- met_filter("bounces", "GREATER_THAN", 0)
-mf2 <- met_filter("sessions", "GREATER", 2)
-
-## create filters on dimensions
-df <- dim_filter("source","BEGINS_WITH","1",not = TRUE)
-df2 <- dim_filter("source","BEGINS_WITH","a",not = TRUE)
-
-## construct filter objects
-fc2 <- filter_clause_ga4(list(df, df2), operator = "AND")
-fc <- filter_clause_ga4(list(mf, mf2), operator = "AND")
-
-## make v4 request
-ga_data1 <- google_analytics_4(ga_id,
-                               date_range = c("2015-07-30","2015-10-01"),
-                               dimensions=c('source','medium'),
-                               metrics = c('sessions','bounces'),
-                               met_filters = fc,
-                               dim_filters = fc2,
-                               filtersExpression = "ga:source!=(direct)")
+    
    
+    
    dim_filter(
+  dimension,
+  operator = c("REGEXP", "BEGINS_WITH", "ENDS_WITH", "PARTIAL", "EXACT",
+    "NUMERIC_EQUAL", "NUMERIC_GREATER_THAN", "NUMERIC_LESS_THAN", "IN_LIST"),
+  expressions,
+  caseSensitive = FALSE,
+  not = FALSE
+)
    
+    
    
 
-}
+    
    
+    
    Arguments
    
+    
    dimension
    
+
    dimension name to filter on.
    
+
    operator
    
+
    How to match the dimension.
    
+
    expressions
    
+
    What to match.  A character vector if operator is "IN_LIST"
    
+
    caseSensitive
    
+
    Boolean.
    
+
    not
    
+
    Logical NOT operator. Boolean.
    
+
    
+    
    
+    
    Value
    
+    
    An object of class dim_fil_ga4 for use in filter_clause_ga4()
    
+    
    
+    
    
+    
    See also
    
+    
    Other filter functions: 
+filter_clause_ga4(),
+met_filter()
    
+    
    
 
-
    +
    +

    Examples

    + 
    
+if (FALSE) {
+library(googleAnalyticsR)
+
+## authenticate,
+## or use the RStudio Addin "Google API Auth" with analytics scopes set
+ga_auth()
+
+## get your accounts
+account_list <- google_analytics_account_list()
+
+## pick a profile with data to query
+
+ga_id <- account_list[23,'viewId']
+
+## create filters on metrics
+mf <- met_filter("bounces", "GREATER_THAN", 0)
+mf2 <- met_filter("sessions", "GREATER", 2)
+
+## create filters on dimensions
+df <- dim_filter("source","BEGINS_WITH","1",not = TRUE)
+df2 <- dim_filter("source","BEGINS_WITH","a",not = TRUE)
+
+## construct filter objects
+fc2 <- filter_clause_ga4(list(df, df2), operator = "AND")
+fc <- filter_clause_ga4(list(mf, mf2), operator = "AND")
+
+## make v4 request
+ga_data1 <- google_analytics_4(ga_id,
+                               date_range = c("2015-07-30","2015-10-01"),
+                               dimensions=c('source','medium'),
+                               metrics = c('sessions','bounces'),
+                               met_filters = fc,
+                               dim_filters = fc2,
+                               filtersExpression = "ga:source!=(direct)")
+
+}
+
+
    +
    +
    -
    -
    -

    Developed by Mark Edmondson.

    +
    +

    Developed by Mark Edmondson.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - + + diff --git a/docs/reference/dim_ga4-class.html b/docs/reference/dim_ga4-class.html index 5e169416..9dd4894a 100644 --- a/docs/reference/dim_ga4-class.html +++ b/docs/reference/dim_ga4-class.html @@ -1,85 +1,18 @@ - - - - - - - -dim_ga4 class. — dim_ga4-class • googleAnalyticsR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -dim_ga4 class. — dim_ga4-class • googleAnalyticsR - - - - - - - - + gtag('config', 'G-43MDXK6CLZ'); + + -
    -
    - -
    - -
    +

    dim_ga4 class.

    - Source: R/ga_v4_objects.R + Source: R/ga_v4_objects.R
    @@ -297,32 +215,27 @@

    dim_ga4 class.

    -
    +
    -
    -
    -

    Developed by Mark Edmondson.

    +
    +

    Developed by Mark Edmondson.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - + + diff --git a/docs/reference/dynamicSegment_ga4-class.html b/docs/reference/dynamicSegment_ga4-class.html index dc3cd5f9..354f4d37 100644 --- a/docs/reference/dynamicSegment_ga4-class.html +++ b/docs/reference/dynamicSegment_ga4-class.html @@ -1,85 +1,18 @@ - - - - - - - -dynamicSegment_ga4 class. — dynamicSegment_ga4-class • googleAnalyticsR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -dynamicSegment_ga4 class. — dynamicSegment_ga4-class • googleAnalyticsR - - - - - - - - + gtag('config', 'G-43MDXK6CLZ'); + + -
    -
    - -
    - -
    +

    dynamicSegment_ga4 class.

    - Source: R/ga_v4_objects.R + Source: R/ga_v4_objects.R
    @@ -297,32 +215,27 @@

    dynamicSegment_ga4 class.

    -
    +
    -
    -
    -

    Developed by Mark Edmondson.

    +
    +

    Developed by Mark Edmondson.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - + + diff --git a/docs/reference/filter_clause_ga4.html b/docs/reference/filter_clause_ga4.html index 5b372890..3bbc5a87 100644 --- a/docs/reference/filter_clause_ga4.html +++ b/docs/reference/filter_clause_ga4.html @@ -1,85 +1,18 @@ - - - - - - - -Make a dimension or metric filter clause object — filter_clause_ga4 • googleAnalyticsR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Make a dimension or metric filter clause object — filter_clause_ga4 • googleAnalyticsR - - - - - + gtag('config', 'G-43MDXK6CLZ'); + + - - - -
    -
    - -
    - -
    +

    Make a dimension or metric filter clause object

    - Source: R/filters.R + Source: R/filters.R
    @@ -295,100 +213,97 @@

    Make a dimension or metric filter clause object

    Make a dimension or metric filter clause object

    - 
    filter_clause_ga4(filters, operator = c("OR", "AND"))
    - -

    Arguments

    - - - - - - - - - - -
    filters

    a list of dim_filter or met_filter. Only one type allowed.

    operator

    combination of filter.

    - -

    Value

    +
    + 
    filter_clause_ga4(filters, operator = c("OR", "AND"))
    +
    +
    +

    Arguments

    +
    filters
    +

    a list of dim_filter or met_filter. Only one type allowed.

    +
    operator
    +

    combination of filter.

    +
    +
    +

    Value

    An object of class dim_fil_ga4 or met_fil_ga4

    -

    Details

    - +
    +
    +

    Details

    If you have dimension and metric filters, make the clauses in two separate calls

    -

    See also

    - -

    Other filter functions: -dim_filter(), -met_filter()

    - -

    Examples

    - 
    
-if (FALSE) {
-library(googleAnalyticsR)
-
-## authenticate,
-## or use the RStudio Addin "Google API Auth" with analytics scopes set
-ga_auth()
-
-## get your accounts
-account_list <- google_analytics_account_list()
-
-## pick a profile with data to query
-
-ga_id <- account_list[23,'viewId']
-
-## create filters on metrics
-mf <- met_filter("bounces", "GREATER_THAN", 0)
-mf2 <- met_filter("sessions", "GREATER", 2)
-
-## create filters on dimensions
-df <- dim_filter("source","BEGINS_WITH","1",not = TRUE)
-df2 <- dim_filter("source","BEGINS_WITH","a",not = TRUE)
-
-## construct filter objects
-fc2 <- filter_clause_ga4(list(df, df2), operator = "AND")
-fc <- filter_clause_ga4(list(mf, mf2), operator = "AND")
-
-## make v4 request
-ga_data1 <- google_analytics(ga_id,
-                             date_range = c("2015-07-30","2015-10-01"),
-                             dimensions=c('source','medium'),
-                             metrics = c('sessions','bounces'),
-                             met_filters = fc,
-                             dim_filters = fc2,
-                             filtersExpression = "ga:source!=(direct)")
-
-}
-
+    
    
+    
    
+    
    See also
    
+    
    Other filter functions: 
+dim_filter(),
+met_filter()
    
+    
    
 
-
    +
    +

    Examples

    + 
    
+if (FALSE) {
+library(googleAnalyticsR)
+
+## authenticate,
+## or use the RStudio Addin "Google API Auth" with analytics scopes set
+ga_auth()
+
+## get your accounts
+account_list <- google_analytics_account_list()
+
+## pick a profile with data to query
+
+ga_id <- account_list[23,'viewId']
+
+## create filters on metrics
+mf <- met_filter("bounces", "GREATER_THAN", 0)
+mf2 <- met_filter("sessions", "GREATER", 2)
+
+## create filters on dimensions
+df <- dim_filter("source","BEGINS_WITH","1",not = TRUE)
+df2 <- dim_filter("source","BEGINS_WITH","a",not = TRUE)
+
+## construct filter objects
+fc2 <- filter_clause_ga4(list(df, df2), operator = "AND")
+fc <- filter_clause_ga4(list(mf, mf2), operator = "AND")
+
+## make v4 request
+ga_data1 <- google_analytics(ga_id,
+                             date_range = c("2015-07-30","2015-10-01"),
+                             dimensions=c('source','medium'),
+                             metrics = c('sessions','bounces'),
+                             met_filters = fc,
+                             dim_filters = fc2,
+                             filtersExpression = "ga:source!=(direct)")
+
+}
+
+
+
    +
    +
    -
    -
    -

    Developed by Mark Edmondson.

    +
    +

    Developed by Mark Edmondson.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - + + diff --git a/docs/reference/filter_clauses_ga4-class.html b/docs/reference/filter_clauses_ga4-class.html index 54833b21..7d7341c0 100644 --- a/docs/reference/filter_clauses_ga4-class.html +++ b/docs/reference/filter_clauses_ga4-class.html @@ -1,85 +1,18 @@ - - - - - - - -.filter_clauses_ga4 class. — .filter_clauses_ga4-class • googleAnalyticsR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -.filter_clauses_ga4 class. — .filter_clauses_ga4-class • googleAnalyticsR - - - - - - - - + gtag('config', 'G-43MDXK6CLZ'); + + -
    -
    - -
    - -
    +

    .filter_clauses_ga4 class.

    - Source: R/ga_v4_objects.R + Source: R/ga_v4_objects.R
    @@ -297,32 +215,27 @@

    .filter_clauses_ga4 class.

    -
    +
    -
    -
    -

    Developed by Mark Edmondson.

    +
    +

    Developed by Mark Edmondson.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - + + diff --git a/docs/reference/ga_account_list.html b/docs/reference/ga_account_list.html index 33bf8571..3ca7de1e 100644 --- a/docs/reference/ga_account_list.html +++ b/docs/reference/ga_account_list.html @@ -1,85 +1,18 @@ - - - - - - - -Account summary for all accounts available to your user — ga_account_list • googleAnalyticsR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Account summary for all accounts available to your user — ga_account_list • googleAnalyticsR - - - - - - - - + gtag('config', 'G-43MDXK6CLZ'); + + -
    -
    - -
    - -
    +

    Account summary for all accounts available to your user

    - Source: R/accounts.R + Source: R/accounts.R
    -

    This is the recommended way to get all your account details for your user, including the web property and View IDs. The $viewId column contains the ID you need for the data fetching functions such as google_analytics.

    +

    This is the recommended way to get all your account details for your user, including the web property and View IDs. The $viewId column contains the ID you need for the data fetching functions such as google_analytics.

    - 
    ga_account_list(type = c("universal", "ga4", "data"))
    - -

    Arguments

    - - - - - - -
    type

    Whether to get account summary from universal analytics of GA4 (App_Web) properties

    - -

    Value

    +
    + 
    ga_account_list(type = c("universal", "ga4", "data"))
    +
    +
    +

    Arguments

    +
    type
    +

    Whether to get account summary from universal analytics of GA4 (App_Web) properties

    +
    +
    +

    Value

    a dataframe of all account, webproperty and view data

    -

    Details

    - +
    +
    +

    Details

    Get a summary of all your accounts, web properties and views your authenticated user can see.

    -

    See also

    - -

    https://developers.google.com/analytics/devguides/config/mgmt/v3/mgmtReference/management/accountSummaries/list

    +
    +
    +

    See also

    +

    https://developers.google.com/analytics/devguides/config/mgmt/v3/mgmtReference/management/accountSummaries/list

    Other account structure functions: -ga_accounts(), -ga_view_list(), -ga_view(), -ga_webproperty_list(), -ga_webproperty()

    - -

    Examples

    - 
    
-if (FALSE) {
-
-library(googleAnalyticsR)
-ga_auth()
-al <- ga_account_list()
-al$viewId
+ga_accounts(),
+ga_view_list(),
+ga_view(),
+ga_webproperty_list(),
+ga_webproperty()
    
+
    -## get account summary of GA4 properties -ga_account_list("ga4") -} -
    +
    +

    Examples

    + 
    
+if (FALSE) {
+
+library(googleAnalyticsR)
+ga_auth()
+al <- ga_account_list()
+al$viewId
+
+## get account summary of GA4 properties
+ga_account_list("ga4")
+}
+
    +
    +
    -
    -
    -

    Developed by Mark Edmondson.

    +
    +

    Developed by Mark Edmondson.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - + + diff --git a/docs/reference/ga_accounts.html b/docs/reference/ga_accounts.html index 614e666e..49b3c42b 100644 --- a/docs/reference/ga_accounts.html +++ b/docs/reference/ga_accounts.html @@ -1,85 +1,18 @@ - - - - - - - -List account metadata — ga_accounts • googleAnalyticsR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -List account metadata — ga_accounts • googleAnalyticsR - - - - - - - - + gtag('config', 'G-43MDXK6CLZ'); + + -
    -
    - -
    - -
    +

    List account metadata

    - Source: R/accounts.R + Source: R/accounts.R
    @@ -295,60 +213,62 @@

    List account metadata

    This gets a list of account meta data, that can be used in other management API functions.

    - 
    ga_accounts()
    - - -

    Value

    +
    + 
    ga_accounts()
    +
    +
    +

    Value

    A data.frame with accountid, name, an R datetime object (POSIXct) when the account was created and last updated, and the effective permissions your user has for those accounts.

    -

    Details

    - +
    +
    +

    Details

    This gets the meta data associated with the accounts you have access to with your user. -If you want all information such as web properties and viewIds, use ga_account_list instead.

    -

    See also

    - -

    Other account structure functions: -ga_account_list(), -ga_view_list(), -ga_view(), -ga_webproperty_list(), -ga_webproperty()

    - -

    Examples

    - 
    
-if (FALSE) {
-
-library(googleAnalyticsR)
-ga_auth()
-ga_accounts()
+If you want all information such as web properties and viewIds, use ga_account_list instead.
    
+    
    
+    
    
+    
    See also
    
+    
    Other account structure functions: 
+ga_account_list(),
+ga_view_list(),
+ga_view(),
+ga_webproperty_list(),
+ga_webproperty()
    
+    
    
 
-}
-
    +
    +

    Examples

    + 
    
+if (FALSE) {
+
+library(googleAnalyticsR)
+ga_auth()
+ga_accounts()
+
+}
+
    +
    +
    -
    -
    -

    Developed by Mark Edmondson.

    +
    +

    Developed by Mark Edmondson.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - + + diff --git a/docs/reference/ga_adwords.html b/docs/reference/ga_adwords.html index 473d3e7f..772580f5 100644 --- a/docs/reference/ga_adwords.html +++ b/docs/reference/ga_adwords.html @@ -1,85 +1,18 @@ - - - - - - - -Get AdWords Link meta data — ga_adwords • googleAnalyticsR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Get AdWords Link meta data — ga_adwords • googleAnalyticsR - - - - - + gtag('config', 'G-43MDXK6CLZ'); + + - - - -
    -
    - -
    - -
    +

    Get AdWords Link meta data

    - Source: R/adwords.R + Source: R/adwords.R
    @@ -295,60 +213,52 @@

    Get AdWords Link meta data

    Get AdWords Link meta data

    - 
    ga_adwords(accountId, webPropertyId, webPropertyAdWordsLinkId)
    - -

    Arguments

    - - - - - - - - - - - - - - -
    accountId

    Account Id

    webPropertyId

    Web Property Id

    webPropertyAdWordsLinkId

    AdWords Link Id

    - -

    Value

    +
    + 
    ga_adwords(accountId, webPropertyId, webPropertyAdWordsLinkId)
    +
    +
    +

    Arguments

    +
    accountId
    +

    Account Id

    +
    webPropertyId
    +

    Web Property Id

    +
    webPropertyAdWordsLinkId
    +

    AdWords Link Id

    +
    +
    +

    Value

    AdWords Meta data

    -

    See also

    - -

    Other Google Ad management functions: -ga_adwords_add_linkid(), -ga_adwords_delete_linkid(), -ga_adwords_list()

    +
    +
    +

    See also

    +

    Other Google Ad management functions: +ga_adwords_add_linkid(), +ga_adwords_delete_linkid(), +ga_adwords_list()

    +
    +
    -
    -
    -

    Developed by Mark Edmondson.

    +
    +

    Developed by Mark Edmondson.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - + + diff --git a/docs/reference/ga_adwords_add_linkid.html b/docs/reference/ga_adwords_add_linkid.html index 440830fd..cad8a9b4 100644 --- a/docs/reference/ga_adwords_add_linkid.html +++ b/docs/reference/ga_adwords_add_linkid.html @@ -1,85 +1,18 @@ - - - - - - - -Creates a Google Analytics webProperty-Google Ads link — ga_adwords_add_linkid • googleAnalyticsR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Creates a Google Analytics webProperty-Google Ads link — ga_adwords_add_linkid • googleAnalyticsR - - - - - - + gtag('config', 'G-43MDXK6CLZ'); + + - - -
    -
    - -
    - -
    +

    Creates a Google Analytics webProperty-Google Ads link

    - Source: R/adwords.R + Source: R/adwords.R
    @@ -295,75 +213,67 @@

    Creates a Google Analytics webProperty-Google Ads link

    Creates a link between and Adwords (Google ads) account and a Google Analytics property so that Adwords data can be accessed via Google Analytics and vice versa.

    - 
    ga_adwords_add_linkid(adwordsAccountId, linkName, accountId, webPropertyId)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - -
    adwordsAccountId

    the customer id of the Adwords account visible within the Adwords account UI on the top right corner -or accessible via the Adwords API

    linkName

    a user defined way to call the link between the Adwords and Google Analytics accounts

    accountId

    Account Id

    webPropertyId

    Web Property Id

    - -

    Value

    +
    + 
    ga_adwords_add_linkid(adwordsAccountId, linkName, accountId, webPropertyId)
    +
    +
    +

    Arguments

    +
    adwordsAccountId
    +

    the customer id of the Adwords account visible within the Adwords account UI on the top right corner -or accessible via the Adwords API

    +
    linkName
    +

    a user defined way to call the link between the Adwords and Google Analytics accounts

    +
    accountId
    +

    Account Id

    +
    webPropertyId
    +

    Web Property Id

    +
    +
    +

    Value

    confirmation message if successful

    -

    See also

    - -

    Google documentation

    +
    +
    +

    See also

    +

    Google documentation

    Other Google Ad management functions: -ga_adwords_delete_linkid(), -ga_adwords_list(), -ga_adwords()

    - -

    Examples

    - 
    
-if (FALSE) {
-library(googleAnalyticsR)
-ga_auth()
-
-ga_adwords_add_linkid("280-234-7592", "Google Ads Link", "65973592", "UA-65973592-1")
-}
+ga_adwords_delete_linkid(),
+ga_adwords_list(),
+ga_adwords()
    
+
    -
    +
    +

    Examples

    + 
    
+if (FALSE) {
+library(googleAnalyticsR)
+ga_auth()
+
+ga_adwords_add_linkid("280-234-7592", "Google Ads Link", "65973592", "UA-65973592-1")
+}
+
+
    +
    +
    -
    -
    -

    Developed by Mark Edmondson.

    +
    +

    Developed by Mark Edmondson.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - + + diff --git a/docs/reference/ga_adwords_delete_linkid.html b/docs/reference/ga_adwords_delete_linkid.html index ff4fd166..0ef99fea 100644 --- a/docs/reference/ga_adwords_delete_linkid.html +++ b/docs/reference/ga_adwords_delete_linkid.html @@ -1,85 +1,18 @@ - - - - - - - -Deletes a Google Analytics webProperty-Google Ads link — ga_adwords_delete_linkid • googleAnalyticsR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Deletes a Google Analytics webProperty-Google Ads link — ga_adwords_delete_linkid • googleAnalyticsR - - - - - + gtag('config', 'G-43MDXK6CLZ'); + + - - - -
    -
    - -
    - -
    +

    Deletes a Google Analytics webProperty-Google Ads link

    - Source: R/adwords.R + Source: R/adwords.R
    @@ -295,80 +213,74 @@

    Deletes a Google Analytics webProperty-Google Ads link

    Removes a link between and Adwords (Google ads) account and a Google Analytics property

    - 
    ga_adwords_delete_linkid(accountId, webPropertyId, webPropertyAdWordsLinkId)
    - -

    Arguments

    - - - - - - - - - - - - - - -
    accountId

    Account Id

    webPropertyId

    Web Property Id

    webPropertyAdWordsLinkId

    webPropertyAdWordsLinkId

    - -

    Value

    +
    + 
    ga_adwords_delete_linkid(accountId, webPropertyId, webPropertyAdWordsLinkId)
    +
    +
    +

    Arguments

    +
    accountId
    +

    Account Id

    +
    webPropertyId
    +

    Web Property Id

    +
    webPropertyAdWordsLinkId
    +

    webPropertyAdWordsLinkId

    +
    +
    +

    Value

    HTTP Status Code 204 with empty response body, if successful

    -

    See also

    - -

    Google documentation

    +
    +
    +

    See also

    +

    Google documentation

    Other Google Ad management functions: -ga_adwords_add_linkid(), -ga_adwords_list(), -ga_adwords()

    - -

    Examples

    - 
    
-if (FALSE) {
-
-library(googleAnalyticsR)
-ga_auth()
-
-# get the ID of the Adwords- Google Analytics link that you want to delete 
-# ID corresponding to the webPropertyAdWordsLinkId field
-ga_adwords_list(65973592, "UA-65973592-1") 
- 
-ga_adwords_delete_linkid(65973592, "UA-65973592-1", "ezW2dyaiQcGheWRAo69nCw")
-
-
-# check its gone
-ga_adwords_list(65973592, "UA-65973592-1")
-}
+ga_adwords_add_linkid(),
+ga_adwords_list(),
+ga_adwords()
    
+
    -
    +
    +

    Examples

    + 
    
+if (FALSE) {
+
+library(googleAnalyticsR)
+ga_auth()
+
+# get the ID of the Adwords- Google Analytics link that you want to delete 
+# ID corresponding to the webPropertyAdWordsLinkId field
+ga_adwords_list(65973592, "UA-65973592-1") 
+ 
+ga_adwords_delete_linkid(65973592, "UA-65973592-1", "ezW2dyaiQcGheWRAo69nCw")
+
+
+# check its gone
+ga_adwords_list(65973592, "UA-65973592-1")
+}
+
+
    +
    +
    -
    -
    -

    Developed by Mark Edmondson.

    +
    +

    Developed by Mark Edmondson.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - + + diff --git a/docs/reference/ga_adwords_list.html b/docs/reference/ga_adwords_list.html index f4eaf2f0..c4e16f7e 100644 --- a/docs/reference/ga_adwords_list.html +++ b/docs/reference/ga_adwords_list.html @@ -1,85 +1,18 @@ - - - - - - - -List AdWords — ga_adwords_list • googleAnalyticsR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -List AdWords — ga_adwords_list • googleAnalyticsR - - - - - + gtag('config', 'G-43MDXK6CLZ'); + + - - - -
    -
    - -
    - -
    +

    List AdWords

    - Source: R/adwords.R + Source: R/adwords.R
    @@ -295,56 +213,50 @@

    List AdWords

    List AdWords

    - 
    ga_adwords_list(accountId, webPropertyId)
    - -

    Arguments

    - - - - - - - - - - -
    accountId

    Account Id

    webPropertyId

    Web Property Id

    - -

    Value

    +
    + 
    ga_adwords_list(accountId, webPropertyId)
    +
    +
    +

    Arguments

    +
    accountId
    +

    Account Id

    +
    webPropertyId
    +

    Web Property Id

    +
    +
    +

    Value

    AdWords Links

    -

    See also

    - -

    Other Google Ad management functions: -ga_adwords_add_linkid(), -ga_adwords_delete_linkid(), -ga_adwords()

    +
    +
    +

    See also

    +

    Other Google Ad management functions: +ga_adwords_add_linkid(), +ga_adwords_delete_linkid(), +ga_adwords()

    +
    +
    -
    -
    -

    Developed by Mark Edmondson.

    +
    +

    Developed by Mark Edmondson.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - + + diff --git a/docs/reference/ga_aggregate.html b/docs/reference/ga_aggregate.html index 47a1825a..c44762e5 100644 --- a/docs/reference/ga_aggregate.html +++ b/docs/reference/ga_aggregate.html @@ -1,85 +1,18 @@ - - - - - - - -Aggregate a Google Analytics dataframe over inputted columns — ga_aggregate • googleAnalyticsR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Aggregate a Google Analytics dataframe over inputted columns — ga_aggregate • googleAnalyticsR - - - - - - + gtag('config', 'G-43MDXK6CLZ'); + + - - -
    -
    - -
    - -
    +

    Aggregate a Google Analytics dataframe over inputted columns

    - Source: R/aggregate.R + Source: R/aggregate.R
    @@ -295,78 +213,71 @@

    Aggregate a Google Analytics dataframe over inputted columns

    A helper function to aggregate over dimensions

    - 
    ga_aggregate(
-  ga_data,
-  agg_names = NULL,
-  mean_regex = "^avg|^percent|Rate$|^CPC$|^CTR$|^CPM$|^RPC$|^ROI$|^ROAS$|Per"
-)
    - -

    Arguments

    - - - - - - - - - - - - - - -
    ga_data

    A dataframe of data to aggregate

    agg_names

    The columns to aggregate over

    mean_regex

    The regex for column names to do mean() rather than sum()

    - -

    Details

    +
    + 
    ga_aggregate(
+  ga_data,
+  agg_names = NULL,
+  mean_regex = "^avg|^percent|Rate$|^CPC$|^CTR$|^CPM$|^RPC$|^ROI$|^ROAS$|Per"
+)
    +
    +
    +

    Arguments

    +
    ga_data
    +

    A dataframe of data to aggregate

    +
    agg_names
    +

    The columns to aggregate over

    +
    mean_regex
    +

    The regex for column names to do mean() rather than sum()

    +
    +
    +

    Details

    Will auto select metrics if they are numeric class columns. Will auto perform mean aggregation it metric names match mean_regex argument If agg_names is NULL will aggregate over all

    +
    -

    Examples

    - 
    
-if (FALSE) {
-
-# use `aggregateGAData` so you can on the fly create summary data
-ga_data <- google_analytics(81416156, 
-                            date_range = c("10daysAgo", "yesterday"),
-                            metrics = "sessions", dimensions = c("hour","date"))
-                            
-# if we want totals per hour over the dates:
-ga_aggregate(ga_data[,c("hour","sessions")], agg_names = "hour")
-
-# it knows not to sum metrics that are rates:
-ga_aggregate(ga_data[,c("hour","bounceRate")], agg_names = "hour")
-
-
-}
-
    +
    +

    Examples

    + 
    
+if (FALSE) {
+
+# use `aggregateGAData` so you can on the fly create summary data
+ga_data <- google_analytics(81416156, 
+                            date_range = c("10daysAgo", "yesterday"),
+                            metrics = "sessions", dimensions = c("hour","date"))
+                            
+# if we want totals per hour over the dates:
+ga_aggregate(ga_data[,c("hour","sessions")], agg_names = "hour")
+
+# it knows not to sum metrics that are rates:
+ga_aggregate(ga_data[,c("hour","bounceRate")], agg_names = "hour")
+
+
+}
+
    +
    +
    -
    -
    -

    Developed by Mark Edmondson.

    +
    +

    Developed by Mark Edmondson.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - + + diff --git a/docs/reference/ga_allowed_metric_dim.html b/docs/reference/ga_allowed_metric_dim.html index 4a3abacd..14338d14 100644 --- a/docs/reference/ga_allowed_metric_dim.html +++ b/docs/reference/ga_allowed_metric_dim.html @@ -1,85 +1,18 @@ - - - - - - - -Create named list of allowed GA metrics/dimensions — ga_allowed_metric_dim • googleAnalyticsR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Create named list of allowed GA metrics/dimensions — ga_allowed_metric_dim • googleAnalyticsR - - - - - - - - + gtag('config', 'G-43MDXK6CLZ'); + + -
    -
    - -
    - -
    +

    Create named list of allowed GA metrics/dimensions

    - Source: R/custom_dims_mets.R + Source: R/custom_dims_mets.R
    @@ -295,61 +213,52 @@

    Create named list of allowed GA metrics/dimensions

    Create named list of allowed GA metrics/dimensions

    - 
    ga_allowed_metric_dim(
-  type = c("METRIC", "DIMENSION"),
-  subType = c("all", "segment", "cohort"),
-  callAPI = FALSE
-)
    +
    + 
    ga_allowed_metric_dim(
+  type = c("METRIC", "DIMENSION"),
+  subType = c("all", "segment", "cohort"),
+  callAPI = FALSE
+)
    +
    -

    Arguments

    - - - - - - - - - - - - - - -
    type

    Type of parameter to create

    subType

    to restrict to only those in this type

    callAPI

    This will update the meta table (Requires online authorization)

    +
    +

    Arguments

    +
    type
    +

    Type of parameter to create

    +
    subType
    +

    to restrict to only those in this type

    +
    callAPI
    +

    This will update the meta table (Requires online authorization)

    This is useful to expand goalXCompletions to all the possibilities, as well as restricting to those that variables that work with your API call.

    -

    Use internal meta table, but you have option to update to the latest version.

    - -

    Value

    - +

    Use internal meta table, but you have option to update to the latest version.

    +
    +
    +

    Value

    A named list of parameters for use in API calls

    +
    +
    -
    -
    -

    Developed by Mark Edmondson.

    +
    +

    Developed by Mark Edmondson.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - + + diff --git a/docs/reference/ga_auth.html b/docs/reference/ga_auth.html index 934ad80d..daf0b94c 100644 --- a/docs/reference/ga_auth.html +++ b/docs/reference/ga_auth.html @@ -1,85 +1,18 @@ - - - - - - - -Authenticate with Google Analytics OAuth2 — ga_auth • googleAnalyticsR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Authenticate with Google Analytics OAuth2 — ga_auth • googleAnalyticsR - - - - - - - - + gtag('config', 'G-43MDXK6CLZ'); + + -
    -
    - -
    - -
    +

    Authenticate with Google Analytics OAuth2

    - Source: R/auth.R + Source: R/auth.R
    -

    A wrapper for gar_auth and gar_auth_service

    +

    A wrapper for gar_auth and gar_auth_service

    - 
    ga_auth(token = NULL, email = NULL, json_file = NULL)
    - -

    Arguments

    - - - - - - - - - - - - - - -
    token

    An existing token or file location of a token to authenticate with

    email

    An existing cached email to authenticate with or TRUE to authenticate with only email available. If not set then you will get an interactive prompt asking you to choose which email to authenticate with.

    json_file

    Authentication service key you have downloaded from your Google Project - an alternative to OAuth2 email authentication

    - -

    Value

    +
    + 
    ga_auth(token = NULL, email = NULL, json_file = NULL)
    +
    +
    +

    Arguments

    +
    token
    +

    An existing token or file location of a token to authenticate with

    +
    email
    +

    An existing cached email to authenticate with or TRUE to authenticate with only email available. If not set then you will get an interactive prompt asking you to choose which email to authenticate with.

    +
    json_file
    +

    Authentication service key you have downloaded from your Google Project - an alternative to OAuth2 email authentication

    +
    +
    +

    Value

    Invisibly, the token that has been saved to the session

    -

    Details

    - +
    +
    +

    Details

    Run this function first time to authenticate with Google in your browser.

    After initial authentication, your authentication details will be kept globally for use later, tied to your email, and the next time you authenticate you will be given a prompt to choose which email to authentcate from. Set email="your@email.com" to skip the interactive prompt.

    -

    Multiple accounts

    - +
    +
    +

    Multiple accounts

    You can authenticate with a new email for each account. Supply a different email to use those details for your session.

    -

    Service accounts

    - +
    +
    +

    Service accounts

    If you use the service account JSON, you will need to add the service account email to your Google Analytics users to see data e.g. xxxx@yyyyyy.iam.gserviceaccount.com

    -

    Auto-authentication

    - +
    +
    +

    Auto-authentication

    You can choose to auto-authenticate by creating a Google OAuth service account JSON file.

    -

    Specify an environment variable in R via a .Renviron file or using Sys.setenv which points to the file location of your chosen authentication file. See Startup

    +

    Specify an environment variable in R via a .Renviron file or using Sys.setenv which points to the file location of your chosen authentication file. See Startup

    Once you have set the environment variable GA_AUTH_FILE to a valid file location, the function will look there for authentication details upon loading the library meaning you will not need to call ga_auth() yourself as you would normally.

    An example .Renviron file is below:

    GA_AUTH_FILE = "/Users/bob/auth/googleAnalyticsR.json"

    GA_AUTH_FILE can be a service account JSON ending with file extension .json. Make sure to give the service account email access to your Google Analytics account as mentioned above.

    -

    Your own Google Project

    - +
    +
    +

    Your own Google Project

    Be default the Google Project used is shared by all users, so you may find it runs out of API calls. To mitigate that, create your own Google Project and turn on the Analytics APIs.

    -

    The best way to do this is to use gar_set_client by downloading your JSON client credentials and setting them to be found on package startup via the GAR_CLIENT_JSON environment argument. See ?googleAuthR::gar_set_client function help pages for details.

    +

    The best way to do this is to use gar_set_client by downloading your JSON client credentials and setting them to be found on package startup via the GAR_CLIENT_JSON environment argument. See ?googleAuthR::gar_set_client function help pages for details.

    Or you can then copy your Google Cloud Project's client ID and client secret, to place in options or environment arguments (whichever is easiest)

    The environment args are below. Similar to auto-authentication, you can place your entries in an .Renviron file

    GA_CLIENT_ID="XXXX" GA_CLIENT_SECRET="XXX" GA_WEB_CLIENT_ID="XXX" GA_WEB_CLIENT_SECRET="XXX"

    +
    -

    Examples

    - 
    
-if (FALSE) {
-
-# to use default package credentials (for testing)
-library(googleAnalyticsR)
-ga_auth()
-
-# to use your own Google Cloud Project credentials
-# go to GCP console and download client credentials JSON 
-# ideally set this in .Renviron file, not here but just for demonstration
-Sys.setenv("GAR_CLIENT_JSON" = "location/of/file.json")
-library(googleAnalyticsR)
-# should now be able to log in via your own GCP project
-ga_auth()
-
-# reauthentication
-# Once you have authenticated, set email to skip the interactive message
-ga_auth(email = "my@email.com")
-
-# or leave unset to bring up menu on which email to auth with
-ga_auth()
-# The googleAnalyticsR package is requesting access to your Google account. 
-# Select a pre-authorised account or enter '0' to obtain a new token.
-# Press Esc/Ctrl + C to abort.
-#1: my@email.com
-#2: work@mybusiness.com
-# you can set authentication for many emails, then switch between them e.g.
-ga_auth(email = "my@email.com")
-ga_account_list() # lists one set of accounts
-ga_auth(email = "work@mybusiness.com") 
-ga_account_list() # lists second set of accounts
-
-# or authenticate via the service key, that has been added to the GA as a user
-ga_auth(json_file = "service-key.json")
-
-}
-
-
    +
    +

    Examples

    + 
    
+if (FALSE) {
+
+# to use default package credentials (for testing)
+library(googleAnalyticsR)
+ga_auth()
+
+# to use your own Google Cloud Project credentials
+# go to GCP console and download client credentials JSON 
+# ideally set this in .Renviron file, not here but just for demonstration
+Sys.setenv("GAR_CLIENT_JSON" = "location/of/file.json")
+library(googleAnalyticsR)
+# should now be able to log in via your own GCP project
+ga_auth()
+
+# reauthentication
+# Once you have authenticated, set email to skip the interactive message
+ga_auth(email = "my@email.com")
+
+# or leave unset to bring up menu on which email to auth with
+ga_auth()
+# The googleAnalyticsR package is requesting access to your Google account. 
+# Select a pre-authorised account or enter '0' to obtain a new token.
+# Press Esc/Ctrl + C to abort.
+#1: my@email.com
+#2: work@mybusiness.com
+# you can set authentication for many emails, then switch between them e.g.
+ga_auth(email = "my@email.com")
+ga_account_list() # lists one set of accounts
+ga_auth(email = "work@mybusiness.com") 
+ga_account_list() # lists second set of accounts
+
+# or authenticate via the service key, that has been added to the GA as a user
+ga_auth(json_file = "service-key.json")
+
+}
+
+
    +
    +
    -
    -
    -

    Developed by Mark Edmondson.

    +
    +

    Developed by Mark Edmondson.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - + + diff --git a/docs/reference/ga_auth_setup.html b/docs/reference/ga_auth_setup.html index 7de95b6c..ef2ffae0 100644 --- a/docs/reference/ga_auth_setup.html +++ b/docs/reference/ga_auth_setup.html @@ -1,85 +1,18 @@ - - - - - - - -Setup wizard for authentication options — ga_auth_setup • googleAnalyticsR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Setup wizard for authentication options — ga_auth_setup • googleAnalyticsR - - - - - - + gtag('config', 'G-43MDXK6CLZ'); + + - - -
    -
    - -
    - -
    +

    Setup wizard for authentication options

    - Source: R/setup_service.R + Source: R/setup_service.R
    @@ -295,35 +213,32 @@

    Setup wizard for authentication options

    Setup wizard for authentication options

    - 
    ga_auth_setup()
    - +
    + 
    ga_auth_setup()
    +
    +
    -
    -
    -

    Developed by Mark Edmondson.

    +
    +

    Developed by Mark Edmondson.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - + + diff --git a/docs/reference/ga_cache_call.html b/docs/reference/ga_cache_call.html index e72d8c01..eeaf9fa4 100644 --- a/docs/reference/ga_cache_call.html +++ b/docs/reference/ga_cache_call.html @@ -1,85 +1,18 @@ - - - - - - - -Setup caching of API calls — ga_cache_call • googleAnalyticsR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Setup caching of API calls — ga_cache_call • googleAnalyticsR - - - - - - - - + gtag('config', 'G-43MDXK6CLZ'); + + -
    -
    - -
    - -
    +

    Setup caching of API calls

    - Source: R/cache.R + Source: R/cache.R
    @@ -295,47 +213,42 @@

    Setup caching of API calls

    Lets you cache API calls to disk

    - 
    ga_cache_call(cache_location)
    - -

    Arguments

    - - - - - - -
    cache_location

    If RAM will save to memory, or specify a file folder location

    - -

    Details

    +
    + 
    ga_cache_call(cache_location)
    +
    +
    +

    Arguments

    +
    cache_location
    +

    If RAM will save to memory, or specify a file folder location

    +
    +
    +

    Details

    By default this is turned on upon package load to RAM. Should you want to cache calls to a folder then run this function to specify where.

    +
    +
    -
    -
    -

    Developed by Mark Edmondson.

    +
    +

    Developed by Mark Edmondson.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - + + diff --git a/docs/reference/ga_clientid_activity.html b/docs/reference/ga_clientid_activity.html index 2478f1f6..279ae2bd 100644 --- a/docs/reference/ga_clientid_activity.html +++ b/docs/reference/ga_clientid_activity.html @@ -1,85 +1,18 @@ - - - - - - - -User Activity Request — ga_clientid_activity • googleAnalyticsR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -User Activity Request — ga_clientid_activity • googleAnalyticsR - - - - - + gtag('config', 'G-43MDXK6CLZ'); + + - - - -
    -
    - -
    - -
    +

    User Activity Request

    - Source: R/user-activity.R + Source: R/user-activity.R
    @@ -295,126 +213,117 @@

    User Activity Request

    Get activity on an individual user

    - 
    ga_clientid_activity(
-  ids,
-  viewId,
-  id_type = c("CLIENT_ID", "USER_ID"),
-  activity_type = NULL,
-  date_range = NULL
-)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - -
    ids

    The userId or clientId. You can send in a vector of them

    viewId

    The viewId

    id_type

    Whether its userId or clientId

    activity_type

    If specified, filters down response to the activity type. Choice between "PAGEVIEW","SCREENVIEW","GOAL","ECOMMERCE","EVENT"

    date_range

    A vector of start and end dates. If not used will default to a week.

    - -

    Value

    +
    + 
    ga_clientid_activity(
+  ids,
+  viewId,
+  id_type = c("CLIENT_ID", "USER_ID"),
+  activity_type = NULL,
+  date_range = NULL
+)
    +
    +
    +

    Arguments

    +
    ids
    +

    The userId or clientId. You can send in a vector of them

    +
    viewId
    +

    The viewId

    +
    id_type
    +

    Whether its userId or clientId

    +
    activity_type
    +

    If specified, filters down response to the activity type. Choice between "PAGEVIEW","SCREENVIEW","GOAL","ECOMMERCE","EVENT"

    +
    date_range
    +

    A vector of start and end dates. If not used will default to a week.

    +
    +
    +

    Value

    A list of data.frames: $sessions contains session level data. $hits contains individual activity data

    -

    Details

    - +
    +
    +

    Details

    The User Activity API lets you query an individual user's movement through your website, by sending in the individual clientId or userId.

    Bear in mind each call will count against your API quota, so fetching a large amount of client ids will be limited by that.

    -

    Use ga_clientid_activity_unnest to unnest deeply nested data in the hits data.

    -

    The timestamps are available to millisecond level but you will need to set your R options to see them e.g. options(digits.secs=3)

    -

    See also

    - -

    https://developers.google.com/analytics/devguides/reporting/core/v4/rest/v4/userActivity/search

    +

    Use ga_clientid_activity_unnest to unnest deeply nested data in the hits data.

    +

    The timestamps are available to millisecond level but you will need to set your R options to see them e.g. options(digits.secs=3)

    +
    +
    +

    See also

    +

    https://developers.google.com/analytics/devguides/reporting/core/v4/rest/v4/userActivity/search

    Other clientid functions: -ga_clientid_activity_unnest(), -ga_clientid_deletion(), -ga_clientid_hash()

    - -

    Examples

    - 
    
-if (FALSE) {
-
-# access data for individual users
-uar <- ga_clientid_activity(c("1106980347.1461227730", "476443645.1541099566"),
-                         viewId = 81416156, 
-                         date_range = c("2019-01-01","2019-02-01"))
-                         
-# access clientIds for users who have transacted
-viewId <- 106249469
-date_range <- c("2019-01-01","2019-02-01")
-cids <- google_analytics(viewId, 
-                         date_range = date_range, 
-                         metrics = "sessions", 
-                         dimensions = "clientId", 
-                         met_filters = filter_clause_ga4(
-                           list(met_filter("transactions", 
-                                           "GREATER_THAN", 
-                                           0)
-                                )))
-transactors <- ga_clientid_activity(cids$clientId,
-                                    viewId = viewId, 
-                                    date_range = date_range)
-
-# access the data.frames returned:
-
-# the session level data for the users passed in
-uar$sessions
-
-# the hit level activity for the users passed in
-uar$hits
-
-# filter the response to only include certain activity types, such as goals:
-
-only_goals <- ga_clientid_activity(c("1106980347.1461227730", 
-                                     "476443645.1541099566"),
-                     viewId = 81416156, 
-                     date_range = c("2019-01-01","2019-02-01"),
-                     activity_types = "GOAL") 
-
-
+ga_clientid_activity_unnest(),
+ga_clientid_deletion(),
+ga_clientid_hash()
    
+
    -} -
    +
    +

    Examples

    + 
    
+if (FALSE) {
+
+# access data for individual users
+uar <- ga_clientid_activity(c("1106980347.1461227730", "476443645.1541099566"),
+                         viewId = 81416156, 
+                         date_range = c("2019-01-01","2019-02-01"))
+                         
+# access clientIds for users who have transacted
+viewId <- 106249469
+date_range <- c("2019-01-01","2019-02-01")
+cids <- google_analytics(viewId, 
+                         date_range = date_range, 
+                         metrics = "sessions", 
+                         dimensions = "clientId", 
+                         met_filters = filter_clause_ga4(
+                           list(met_filter("transactions", 
+                                           "GREATER_THAN", 
+                                           0)
+                                )))
+transactors <- ga_clientid_activity(cids$clientId,
+                                    viewId = viewId, 
+                                    date_range = date_range)
+
+# access the data.frames returned:
+
+# the session level data for the users passed in
+uar$sessions
+
+# the hit level activity for the users passed in
+uar$hits
+
+# filter the response to only include certain activity types, such as goals:
+
+only_goals <- ga_clientid_activity(c("1106980347.1461227730", 
+                                     "476443645.1541099566"),
+                     viewId = 81416156, 
+                     date_range = c("2019-01-01","2019-02-01"),
+                     activity_types = "GOAL") 
+
+
+
+}
+
    +
    +
    -
    -
    -

    Developed by Mark Edmondson.

    +
    +

    Developed by Mark Edmondson.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - + + diff --git a/docs/reference/ga_clientid_activity_unnest.html b/docs/reference/ga_clientid_activity_unnest.html index 795f0a8c..b4abee4e 100644 --- a/docs/reference/ga_clientid_activity_unnest.html +++ b/docs/reference/ga_clientid_activity_unnest.html @@ -1,86 +1,19 @@ - - - - - - - -Unnest user activity columns — ga_clientid_activity_unnest • googleAnalyticsR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Unnest user activity columns — ga_clientid_activity_unnest • googleAnalyticsR - - - - - + gtag('config', 'G-43MDXK6CLZ'); + + - - - -
    -
    - -
    - -
    +

    Unnest user activity columns

    - Source: R/user-activity.R + Source: R/user-activity.R
    @@ -297,93 +215,90 @@

    Unnest user activity columns

    Thanks to @jimmyg3g on GitHub for help with the ecommerce parsing.

    - 
    ga_clientid_activity_unnest(
-  hits,
-  column = c("customDimension", "ecommerce", "goals")
-)
    - -

    Arguments

    - - - - - - - - - - -
    hits

    The hits data.frame with the columns to expand

    column

    Which column to expand - one of "customDimension","ecommerce","goals"

    - -

    Value

    +
    + 
    ga_clientid_activity_unnest(
+  hits,
+  column = c("customDimension", "ecommerce", "goals")
+)
    +
    +
    +

    Arguments

    +
    hits
    +

    The hits data.frame with the columns to expand

    +
    column
    +

    Which column to expand - one of "customDimension","ecommerce","goals"

    +
    +
    +

    Value

    An unnested data.frame tibble for all hits that matches the column

    -

    Details

    - -

    A function to help expand data out of nested columns returned by ga_clientid_activity

    -

    See also

    - -

    Other clientid functions: -ga_clientid_activity(), -ga_clientid_deletion(), -ga_clientid_hash()

    - -

    Examples

    - 
    
-if (FALSE) {
-# access clientIds for users who have transacted
-viewId <- 106249469
-date_range <- c("2019-01-01","2019-02-01")
-cids <- google_analytics(viewId, 
-                         date_range = date_range, 
-                         metrics = "sessions", 
-                         dimensions = "clientId", 
-                         met_filters = filter_clause_ga4(
-                           list(met_filter("transactions", 
-                                           "GREATER_THAN", 
-                                           0)
-                                )))
-                                
-transactors <- ga_clientid_activity(cids$clientId,
-                                    viewId = viewId, 
-                                    date_range = date_range)
-
-# unnest ecommerce activity hits from users
-ga_clientid_activity_unnest(transactors$hits, "ecommerce")   
-
-# unnest goal activity hits from users
-ga_clientid_activity_unnest(transactors$hits, "goals") 
-
-# unnest custom dimension activity hits from users
-ga_clientid_activity_unnest(transactors$hits, "customDimension") 
+    
    
+    
    
+    
    Details
    
+    
    A function to help expand data out of nested columns returned by ga_clientid_activity
    
+    
    
+    
    
+    
    See also
    
+    
    Other clientid functions: 
+ga_clientid_activity(),
+ga_clientid_deletion(),
+ga_clientid_hash()
    
+    
    
 
-}
-
    +
    +

    Examples

    + 
    
+if (FALSE) {
+# access clientIds for users who have transacted
+viewId <- 106249469
+date_range <- c("2019-01-01","2019-02-01")
+cids <- google_analytics(viewId, 
+                         date_range = date_range, 
+                         metrics = "sessions", 
+                         dimensions = "clientId", 
+                         met_filters = filter_clause_ga4(
+                           list(met_filter("transactions", 
+                                           "GREATER_THAN", 
+                                           0)
+                                )))
+                                
+transactors <- ga_clientid_activity(cids$clientId,
+                                    viewId = viewId, 
+                                    date_range = date_range)
+
+# unnest ecommerce activity hits from users
+ga_clientid_activity_unnest(transactors$hits, "ecommerce")   
+
+# unnest goal activity hits from users
+ga_clientid_activity_unnest(transactors$hits, "goals") 
+
+# unnest custom dimension activity hits from users
+ga_clientid_activity_unnest(transactors$hits, "customDimension") 
+
+}
+
    +
    +
    -
    -
    -

    Developed by Mark Edmondson.

    +
    +

    Developed by Mark Edmondson.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - + + diff --git a/docs/reference/ga_clientid_deletion.html b/docs/reference/ga_clientid_deletion.html index 70d0fe72..ed8faf81 100644 --- a/docs/reference/ga_clientid_deletion.html +++ b/docs/reference/ga_clientid_deletion.html @@ -1,85 +1,18 @@ - - - - - - - -Create or update a user deletion request — ga_clientid_deletion • googleAnalyticsR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Create or update a user deletion request — ga_clientid_deletion • googleAnalyticsR - - - - - - + gtag('config', 'G-43MDXK6CLZ'); + + - - -
    -
    - -
    - -
    +

    Create or update a user deletion request

    - Source: R/client_id.R + Source: R/client_id.R
    @@ -295,96 +213,89 @@

    Create or update a user deletion request

    The Google Analytics User Deletion API allows customers to process deletions of data associated with a given user identifier.

    - 
    ga_clientid_deletion(
-  userId,
-  propertyId,
-  idType = c("CLIENT_ID", "USER_ID", "APP_INSTANCE_ID"),
-  propertyType = c("ga", "firebase")
-)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - -
    userId

    A character vector of user ID's

    propertyId

    The Google Analytics Web property or Firebase ProjectId you are deleting the user from.

    idType

    Type of user. One of APP_INSTANCE_ID, CLIENT_ID or USER_ID.

    propertyType

    Firebase or Google Analytics

    - -

    Value

    +
    + 
    ga_clientid_deletion(
+  userId,
+  propertyId,
+  idType = c("CLIENT_ID", "USER_ID", "APP_INSTANCE_ID"),
+  propertyType = c("ga", "firebase")
+)
    +
    +
    +

    Arguments

    +
    userId
    +

    A character vector of user ID's

    +
    propertyId
    +

    The Google Analytics Web property or Firebase ProjectId you are deleting the user from.

    +
    idType
    +

    Type of user. One of APP_INSTANCE_ID, CLIENT_ID or USER_ID.

    +
    propertyType
    +

    Firebase or Google Analytics

    +
    +
    +

    Value

    a data.frame with a row for each userID you sent in, plus a column with its deletionRequestTime

    -

    Details

    - +
    +
    +

    Details

    The user explorer report in Google Analytics can give you the client.id you need to test.

    A data deletion request can be applied to either a Google Analytics web property (specified by propertyType="ga") or Firebase application (propertyType="firebase"). A user whose data will be deleted can be specified by setting one of the identifiers the userId field. The type of the identifier must be specified inside idType field.

    There is a quota of 500 queries per day per cloud project.

    The API returns a User Deletion Request Resource with deletionRequestTime field set. This field is the point in time up to which all user data will be deleted. This means that all user data for the specified user identifier and Google Analytics property or Firebase project will be deleted up to this date and time - if the user with the same identifier returns after this date/time, they will reappear in reporting.

    -

    See also

    - -

    https://developers.google.com/analytics/devguides/config/userdeletion/v3/

    +
    +
    +

    See also

    +

    https://developers.google.com/analytics/devguides/config/userdeletion/v3/

    Other clientid functions: -ga_clientid_activity_unnest(), -ga_clientid_activity(), -ga_clientid_hash()

    - -

    Examples

    - 
    
-if (FALSE) {
-
-# make sure you are authenticated with user deletion scopes
-options(googleAuthR.scopes.selected = "https://www.googleapis.com/auth/analytics.user.deletion")
-ga_auth()
-
-# a vector of ids
-ids <- c("1489547420.1526330722", "1138076389.1526568883")
-
-# do the deletions
-ga_clientid_deletion(ids, "UA-1234-2")
-#                 userId   id_type  property      deletionRequestTime
-#1 1489547420.1526330722 CLIENT_ID UA-1234-2 2018-05-20T19:43:33.540Z
-#2 1138076389.1526568883 CLIENT_ID UA-1234-2 2018-05-20T19:43:36.218Z
-
-}
+ga_clientid_activity_unnest(),
+ga_clientid_activity(),
+ga_clientid_hash()
    
+
    -
    +
    +

    Examples

    + 
    
+if (FALSE) {
+
+# make sure you are authenticated with user deletion scopes
+options(googleAuthR.scopes.selected = "https://www.googleapis.com/auth/analytics.user.deletion")
+ga_auth()
+
+# a vector of ids
+ids <- c("1489547420.1526330722", "1138076389.1526568883")
+
+# do the deletions
+ga_clientid_deletion(ids, "UA-1234-2")
+#                 userId   id_type  property      deletionRequestTime
+#1 1489547420.1526330722 CLIENT_ID UA-1234-2 2018-05-20T19:43:33.540Z
+#2 1138076389.1526568883 CLIENT_ID UA-1234-2 2018-05-20T19:43:36.218Z
+
+}
+
+
    +
    +
    -
    -
    -

    Developed by Mark Edmondson.

    +
    +

    Developed by Mark Edmondson.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - + + diff --git a/docs/reference/ga_clientid_hash.html b/docs/reference/ga_clientid_hash.html index 79ecc8cd..9b3caf66 100644 --- a/docs/reference/ga_clientid_hash.html +++ b/docs/reference/ga_clientid_hash.html @@ -1,85 +1,18 @@ - - - - - - - -Get hashed version of client id (also known as hashClientId, hashedClientId, or BigQuery's fullVisitorId) — ga_clientid_hash • googleAnalyticsR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Get hashed version of client id (also known as hashClientId, hashedClientId, or BigQuery's fullVisitorId) — ga_clientid_hash • googleAnalyticsR - - - - - + gtag('config', 'G-43MDXK6CLZ'); + + - - - -
    -
    - -
    - -
    +

    Get hashed version of client id (also known as hashClientId, hashedClientId, or BigQuery's fullVisitorId)

    - Source: R/client_id.R + Source: R/client_id.R
    @@ -295,56 +213,50 @@

    Get hashed version of client id (also known as hashClientId, hashedClientId,

    Get hashed version of client id (also known as hashClientId, hashedClientId, or BigQuery's fullVisitorId)

    - 
    ga_clientid_hash(webPropertyId, clientId)
    - -

    Arguments

    - - - - - - - - - - -
    webPropertyId

    Web Property Id

    clientId

    Client Id

    - -

    Value

    +
    + 
    ga_clientid_hash(webPropertyId, clientId)
    +
    +
    +

    Arguments

    +
    webPropertyId
    +

    Web Property Id

    +
    clientId
    +

    Client Id

    +
    +
    +

    Value

    hashedClientId object list

    -

    See also

    - -

    Other clientid functions: -ga_clientid_activity_unnest(), -ga_clientid_activity(), -ga_clientid_deletion()

    +
    +
    +

    See also

    +

    Other clientid functions: +ga_clientid_activity_unnest(), +ga_clientid_activity(), +ga_clientid_deletion()

    +
    +
    -
    -
    -

    Developed by Mark Edmondson.

    +
    +

    Developed by Mark Edmondson.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - + + diff --git a/docs/reference/ga_custom_datasource.html b/docs/reference/ga_custom_datasource.html index cb3207bb..a479fe4f 100644 --- a/docs/reference/ga_custom_datasource.html +++ b/docs/reference/ga_custom_datasource.html @@ -1,85 +1,18 @@ - - - - - - - -List Custom Data Sources — ga_custom_datasource • googleAnalyticsR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -List Custom Data Sources — ga_custom_datasource • googleAnalyticsR - - - - - - + gtag('config', 'G-43MDXK6CLZ'); + + - - -
    -
    - -
    - -
    +

    List Custom Data Sources

    - Source: R/custom_data_source.R + Source: R/custom_data_source.R
    @@ -295,60 +213,55 @@

    List Custom Data Sources

    Get a list of custom data sources you have configured in Google Analytics web UI.

    - 
    ga_custom_datasource(accountId, webPropertyId)
    - -

    Arguments

    - - - - - - - - - - -
    accountId

    Account Id

    webPropertyId

    Web Property Id

    - -

    Value

    +
    + 
    ga_custom_datasource(accountId, webPropertyId)
    +
    +
    +

    Arguments

    +
    accountId
    +

    Account Id

    +
    webPropertyId
    +

    Web Property Id

    +
    +
    +

    Value

    Custom Data Source

    -

    Details

    - -

    You primarily need this to get the customDataSourceId for the uploads via ga_custom_upload_file

    -

    See also

    - -

    Other custom datasource functions: -ga_custom_upload_delete(), -ga_custom_upload_file(), -ga_custom_upload_list(), -ga_custom_upload()

    +
    +
    +

    Details

    +

    You primarily need this to get the customDataSourceId for the uploads via ga_custom_upload_file

    +
    +
    +

    See also

    +

    Other custom datasource functions: +ga_custom_upload_delete(), +ga_custom_upload_file(), +ga_custom_upload_list(), +ga_custom_upload()

    +
    +
    -
    -
    -

    Developed by Mark Edmondson.

    +
    +

    Developed by Mark Edmondson.

    -

    Site built with pkgdown 1.6.1.

    +

    Site built with pkgdown 2.0.1.

    -
    -
    +
    - - + + diff --git a/docs/reference/ga_custom_upload.html b/docs/reference/ga_custom_upload.html index 52202615..8e346ece 100644 --- a/docs/reference/ga_custom_upload.html +++ b/docs/reference/ga_custom_upload.html @@ -1,85 +1,18 @@ - - - - - - - -Custom Data Source Upload Status — ga_custom_upload • googleAnalyticsR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Custom Data Source Upload Status — ga_custom_upload • googleAnalyticsR - - - - - - + gtag('config', 'G-43MDXK6CLZ'); + + - - -
    -
    - -
    - -
    +

    Custom Data Source Upload Status

    - Source: R/custom_data_source.R + Source: R/custom_data_source.R
    @@ -295,80 +213,71 @@

    Custom Data Source Upload Status

    Get the status of a custom upload

    - 
    ga_custom_upload(
-  accountId,
-  webPropertyId,
-  customDataSourceId,
-  uploadId,
-  upload_object
-)
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - - - - - -
    accountId

    Account Id

    webPropertyId

    Web Property Id

    customDataSourceId

    Custom data source Id

    uploadId

    upload Id

    upload_object

    A custom upload Id object. Supply this or the other arguments.

    - -

    Value

    +
    + 
    ga_custom_upload(
+  accountId,
+  webPropertyId,
+  customDataSourceId,
+  uploadId,
+  upload_object
+)
    +
    +
    +

    Arguments

    +
    accountId
    +

    Account Id

    +
    webPropertyId
    +

    Web Property Id

    +
    customDataSourceId
    +

    Custom data source Id

    +
    uploadId
    +

    upload Id

    +
    upload_object
    +

    A custom upload Id object. Supply this or the other arguments.

    +
    +
    +

    Value

    An object of class ga_custom_data_source_upload

    -

    Details

    - -

    You can supply either upload_object generated via function or ga_custom_upload_file, or make an

    -

    See also

    - -

    Other custom datasource functions: -ga_custom_datasource(), -ga_custom_upload_delete(), -ga_custom_upload_file(), -ga_custom_upload_list()

    +
    +
    +

    Details

    +

    You can supply either upload_object generated via function or ga_custom_upload_file, or make an

    +
    +
    +

    See also

    +

    Other custom datasource functions: +ga_custom_datasource(), +ga_custom_upload_delete(), +ga_custom_upload_file(), +ga_custom_upload_list()

    +
    -

    Examples

    - 
    
+    
    
+    
    Examples
    
+    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_custom_upload_delete.html b/docs/reference/ga_custom_upload_delete.html
index a5e09bc5..117f958c 100644
--- a/docs/reference/ga_custom_upload_delete.html
+++ b/docs/reference/ga_custom_upload_delete.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Deletes custom upload files for a given ids vector — ga_custom_upload_delete • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Deletes custom upload files for a given ids vector — ga_custom_upload_delete • googleAnalyticsR
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Deletes custom upload files for a given ids vector
    
-    Source: R/custom_data_source.R
+    Source: R/custom_data_source.R
     
     
    
 
@@ -295,68 +213,57 @@ 
    Deletes custom upload files for a given ids vector
    
     
    Deletes custom upload files for a given ids vector
    
     
    
 
-    
    ga_custom_upload_delete(
-  accountId,
-  webPropertyId,
-  customDataSourceId,
-  customDataImportUids
-)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    accountId
    Account Id
    webPropertyId
    Web Property Id
    customDataSourceId
    Custom data source Id
    customDataImportUids
    vector of file upload ids.
    
-
-    
    See also
    
+    
    
+    
    ga_custom_upload_delete(
+  accountId,
+  webPropertyId,
+  customDataSourceId,
+  customDataImportUids
+)
    
+    
    
 
-    
    https://developers.google.com/analytics/devguides/config/mgmt/v3/mgmtReference/management/uploads/deleteUploadData
    
+    
    
+    
    Arguments
    
+    
    accountId
    
+
    Account Id
    
+
    webPropertyId
    
+
    Web Property Id
    
+
    customDataSourceId
    
+
    Custom data source Id
    
+
    customDataImportUids
    
+
    vector of file upload ids.
    
+
    
+    
    
+    
    See also
    
+    
    https://developers.google.com/analytics/devguides/config/mgmt/v3/mgmtReference/management/uploads/deleteUploadData
    
 
    Other custom datasource functions: 
-ga_custom_datasource(),
-ga_custom_upload_file(),
-ga_custom_upload_list(),
-ga_custom_upload()
    
+ga_custom_datasource(),
+ga_custom_upload_file(),
+ga_custom_upload_list(),
+ga_custom_upload()
    
+    
    
 
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_custom_upload_file.html b/docs/reference/ga_custom_upload_file.html
index c4218c8e..540026e8 100644
--- a/docs/reference/ga_custom_upload_file.html
+++ b/docs/reference/ga_custom_upload_file.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Upload data to Google Analytics — ga_custom_upload_file • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Upload data to Google Analytics — ga_custom_upload_file • googleAnalyticsR
-
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Upload data to Google Analytics
    
-    Source: R/custom_data_source.R
+    Source: R/custom_data_source.R
     
     
    
 
@@ -295,76 +213,69 @@ 
    Upload data to Google Analytics
    
     
    Upload external data up to 1GB to Google Analytics via the management API.
    
     
    
 
-    
    ga_custom_upload_file(accountId, webPropertyId, customDataSourceId, upload)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    accountId
    Account Id
    webPropertyId
    Web Property Id
    customDataSourceId
    Custom data source Id
    upload
    An R data.frame or a file path location (character)
    
-
-    
    Value
    
+    
    
+    
    ga_custom_upload_file(accountId, webPropertyId, customDataSourceId, upload)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    accountId
    
+
    Account Id
    
+
    webPropertyId
    
+
    Web Property Id
    
+
    customDataSourceId
    
+
    Custom data source Id
    
+
    upload
    
+
    An R data.frame or a file path location (character)
    
+
    
+    
    
+    
    Value
    
     
    An object of class ga_custom_data_source_upload
    
-    
    Details
    
-
+    
    
+    
    
+    
    Details
    
     
    You need to create a custom data source in the web UI first.
    
 
    If you are uploading an R data frame, the function will prefix the column names with "ga:" for you if necessary.
    
-
    After upload check the status by querying data sources using ga_custom_upload
+
    After upload check the status by querying data sources using ga_custom_upload
 and examining the status field.
    
 
    Currently only supports simple uploads (not resumable).
    
-    
    See also
    
-
-    
    A guide for preparing the data is available: from Google here.
    
-
    The dev guide for this function: Data Import Developer Guide
    
+    
    
+    
    
+    
    See also
    
+    
    A guide for preparing the data is available: from Google here.
    
+
    The dev guide for this function: Data Import Developer Guide
    
 
    Other custom datasource functions: 
-ga_custom_datasource(),
-ga_custom_upload_delete(),
-ga_custom_upload_list(),
-ga_custom_upload()
    
+ga_custom_datasource(),
+ga_custom_upload_delete(),
+ga_custom_upload_list(),
+ga_custom_upload()
    
+    
    
 
-    
    Examples
    
-    
    
+    
    
+    
    Examples
    
+    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_custom_upload_list.html b/docs/reference/ga_custom_upload_list.html
index d22d6729..6ece2528 100644
--- a/docs/reference/ga_custom_upload_list.html
+++ b/docs/reference/ga_custom_upload_list.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-List Custom Data Source Uploads — ga_custom_upload_list • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-List Custom Data Source Uploads — ga_custom_upload_list • googleAnalyticsR
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    List Custom Data Source Uploads
    
-    Source: R/custom_data_source.R
+    Source: R/custom_data_source.R
     
     
    
 
@@ -295,61 +213,53 @@ 
    List Custom Data Source Uploads
    
     
    List Custom Data Source Uploads
    
     
    
 
-    
    ga_custom_upload_list(accountId, webPropertyId, customDataSourceId)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    accountId
    Account Id
    webPropertyId
    Web Property Id
    customDataSourceId
    Custom data source Id
    
-
-    
    Value
    
+    
    
+    
    ga_custom_upload_list(accountId, webPropertyId, customDataSourceId)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    accountId
    
+
    Account Id
    
+
    webPropertyId
    
+
    Web Property Id
    
+
    customDataSourceId
    
+
    Custom data source Id
    
+
    
+    
    
+    
    Value
    
     
    Custom Data Source Uploads List
    
-    
    See also
    
-
-    
    Other custom datasource functions: 
-ga_custom_datasource(),
-ga_custom_upload_delete(),
-ga_custom_upload_file(),
-ga_custom_upload()
    
+    
    
+    
    
+    
    See also
    
+    
    Other custom datasource functions: 
+ga_custom_datasource(),
+ga_custom_upload_delete(),
+ga_custom_upload_file(),
+ga_custom_upload()
    
+    
    
 
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_custom_vars.html b/docs/reference/ga_custom_vars.html
index 01263ffe..af42a062 100644
--- a/docs/reference/ga_custom_vars.html
+++ b/docs/reference/ga_custom_vars.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Get Custom Dimensions or Metrics — ga_custom_vars • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Get Custom Dimensions or Metrics — ga_custom_vars • googleAnalyticsR
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Get Custom Dimensions or Metrics
    
-    Source: R/custom_dims_mets.R
+    Source: R/custom_dims_mets.R
     
     
    
 
@@ -295,69 +213,59 @@ 
    Get Custom Dimensions or Metrics
    
     
    Get Custom Dimensions or Metrics
    
     
    
 
-    
    ga_custom_vars(
-  accountId,
-  webPropertyId,
-  type = c("customMetrics", "customDimensions"),
-  customId
-)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    accountId
    Account Id
    webPropertyId
    Web Property Id
    type
    A customMetric or customDimension
    customId
    The customMetricId or customDimensionId
    
-
-    
    Value
    
+    
    
+    
    ga_custom_vars(
+  accountId,
+  webPropertyId,
+  type = c("customMetrics", "customDimensions"),
+  customId
+)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    accountId
    
+
    Account Id
    
+
    webPropertyId
    
+
    Web Property Id
    
+
    type
    
+
    A customMetric or customDimension
    
+
    customId
    
+
    The customMetricId or customDimensionId
    
+
    
+    
    
+    
    Value
    
     
    Custom Metric or Dimension meta data
    
-    
    See also
    
-
-    
    Other custom variable functions: 
-ga_custom_vars_create(),
-ga_custom_vars_list(),
-ga_custom_vars_patch()
    
+    
    
+    
    
+    
    See also
    
+    
    Other custom variable functions: 
+ga_custom_vars_create(),
+ga_custom_vars_list(),
+ga_custom_vars_patch()
    
+    
    
 
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_custom_vars_create.html b/docs/reference/ga_custom_vars_create.html
index 4cf5d79f..1f6482a5 100644
--- a/docs/reference/ga_custom_vars_create.html
+++ b/docs/reference/ga_custom_vars_create.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Create a custom dimension — ga_custom_vars_create • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Create a custom dimension — ga_custom_vars_create • googleAnalyticsR
-
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Create a custom dimension
    
-    Source: R/custom_dims_mets.R
+    Source: R/custom_dims_mets.R
     
     
    
 
@@ -295,96 +213,83 @@ 
    Create a custom dimension
    
     
    Create a dimension by specifying its attributes.
    
     
    
 
-    
    ga_custom_vars_create(
-  name,
-  index,
-  accountId,
-  webPropertyId,
-  active,
-  scope = c("HIT", "SESSION", "USER", "PRODUCT")
-)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    name
    Name of custom dimension
    index
    Index of custom dimension - integer between 1 and 20 (200 for GA360)
    accountId
    AccountId of the custom dimension
    webPropertyId
    WebPropertyId of the custom dimension
    active
    TRUE or FALSE if custom dimension is active or not
    scope
    Scope of custom dimension - one of "HIT","SESSION","USER","PRODUCT"
    
-
-    
    See also
    
+    
    
+    
    ga_custom_vars_create(
+  name,
+  index,
+  accountId,
+  webPropertyId,
+  active,
+  scope = c("HIT", "SESSION", "USER", "PRODUCT")
+)
    
+    
    
 
-    
    Custom dimensions support article
    
+    
    
+    
    Arguments
    
+    
    name
    
+
    Name of custom dimension
    
+
    index
    
+
    Index of custom dimension - integer between 1 and 20 (200 for GA360)
    
+
    accountId
    
+
    AccountId of the custom dimension
    
+
    webPropertyId
    
+
    WebPropertyId of the custom dimension
    
+
    active
    
+
    TRUE or FALSE if custom dimension is active or not
    
+
    scope
    
+
    Scope of custom dimension - one of "HIT","SESSION","USER","PRODUCT"
    
+
    
+    
    
+    
    See also
    
+    
    Custom dimensions support article
    
 
    Other custom variable functions: 
-ga_custom_vars_list(),
-ga_custom_vars_patch(),
-ga_custom_vars()
    
-
-    
    Examples
    
-    
    
-if (FALSE) {
-library(googleAnalyticsR)
-ga_auth()
-
-# create custom var
-ga_custom_vars_create("my_custom_dim",
-                      index = 15,
-                      accountId = 54019251,
-                      webPropertyId = "UA-54019251-4",
-                      scope = "HIT",
-                      active = FALSE)
-
-# view custom dimension in list
-ga_custom_vars_list(54019251, webPropertyId = "UA-54019251-4", type = "customDimensions")
+ga_custom_vars_list(),
+ga_custom_vars_patch(),
+ga_custom_vars()
    
+    
    
 
-}
-
    
+    
    
+    
    Examples
    
+    
    
+if (FALSE) {
+library(googleAnalyticsR)
+ga_auth()
+
+# create custom var
+ga_custom_vars_create("my_custom_dim",
+                      index = 15,
+                      accountId = 54019251,
+                      webPropertyId = "UA-54019251-4",
+                      scope = "HIT",
+                      active = FALSE)
+
+# view custom dimension in list
+ga_custom_vars_list(54019251, webPropertyId = "UA-54019251-4", type = "customDimensions")
+
+}
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_custom_vars_list.html b/docs/reference/ga_custom_vars_list.html
index e88acd1a..0eca5786 100644
--- a/docs/reference/ga_custom_vars_list.html
+++ b/docs/reference/ga_custom_vars_list.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-List Custom Dimensions or Metrics — ga_custom_vars_list • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-List Custom Dimensions or Metrics — ga_custom_vars_list • googleAnalyticsR
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    List Custom Dimensions or Metrics
    
-    Source: R/custom_dims_mets.R
+    Source: R/custom_dims_mets.R
     
     
    
 
@@ -295,79 +213,74 @@ 
    List Custom Dimensions or Metrics
    
     
    List Custom Dimensions or Metrics
    
     
    
 
-    
    ga_custom_vars_list(
-  accountId,
-  webPropertyId,
-  type = c("customDimensions", "customMetrics")
-)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    accountId
    Account Id
    webPropertyId
    Web Property Id
    type
    A customMetric or customDimension
    
-
-    
    Value
    
+    
    
+    
    ga_custom_vars_list(
+  accountId,
+  webPropertyId,
+  type = c("customDimensions", "customMetrics")
+)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    accountId
    
+
    Account Id
    
+
    webPropertyId
    
+
    Web Property Id
    
+
    type
    
+
    A customMetric or customDimension
    
+
    
+    
    
+    
    Value
    
     
    Custom Metric or Dimension List
    
-    
    Details
    
-
+    
    
+    
    
+    
    Details
    
     
    This function lists all the existing custom dimensions or metrics for the web property.
    
-    
    See also
    
-
-    
    Other custom variable functions: 
-ga_custom_vars_create(),
-ga_custom_vars_patch(),
-ga_custom_vars()
    
-
-    
    Examples
    
-    
    
-if (FALSE) {
-library(googleAnalyticsR)
-ga_auth()
-
-ga_custom_vars_list(54019251, webPropertyId = "UA-54019251-4", type = "customDimensions")
-
-ga_custom_vars_list(54019251, webPropertyId = "UA-54019251-4", type = "customMetrics")
+    
    
+    
    
+    
    See also
    
+    
    Other custom variable functions: 
+ga_custom_vars_create(),
+ga_custom_vars_patch(),
+ga_custom_vars()
    
+    
    
 
-}
-
    
+    
    
+    
    Examples
    
+    
    
+if (FALSE) {
+library(googleAnalyticsR)
+ga_auth()
+
+ga_custom_vars_list(54019251, webPropertyId = "UA-54019251-4", type = "customDimensions")
+
+ga_custom_vars_list(54019251, webPropertyId = "UA-54019251-4", type = "customMetrics")
+
+}
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_custom_vars_patch.html b/docs/reference/ga_custom_vars_patch.html
index 7dbf3655..59c2a05f 100644
--- a/docs/reference/ga_custom_vars_patch.html
+++ b/docs/reference/ga_custom_vars_patch.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Modify a custom dimension — ga_custom_vars_patch • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Modify a custom dimension — ga_custom_vars_patch • googleAnalyticsR
-
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Modify a custom dimension
    
-    Source: R/custom_dims_mets.R
+    Source: R/custom_dims_mets.R
     
     
    
 
@@ -295,111 +213,96 @@ 
    Modify a custom dimension
    
     
    Modify existing custom dimensions
    
     
    
 
-    
    ga_custom_vars_patch(
-  id,
-  accountId,
-  webPropertyId,
-  name = NULL,
-  active = NULL,
-  scope = NULL,
-  ignoreCustomDataSourceLinks = FALSE
-)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    id
    The id of the custom dimension
    accountId
    AccountId of the custom dimension
    webPropertyId
    WebPropertyId of the custom dimension
    name
    Name of custom dimension
    active
    TRUE or FALSE if custom dimension is active or not
    scope
    Scope of custom dimension - one of "HIT","SESSION","USER","PRODUCT"
    ignoreCustomDataSourceLinks
    Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.
    
-
-    
    See also
    
+    
    
+    
    ga_custom_vars_patch(
+  id,
+  accountId,
+  webPropertyId,
+  name = NULL,
+  active = NULL,
+  scope = NULL,
+  ignoreCustomDataSourceLinks = FALSE
+)
    
+    
    
 
-    
    Custom dimensions support article
    
+    
    
+    
    Arguments
    
+    
    id
    
+
    The id of the custom dimension
    
+
    accountId
    
+
    AccountId of the custom dimension
    
+
    webPropertyId
    
+
    WebPropertyId of the custom dimension
    
+
    name
    
+
    Name of custom dimension
    
+
    active
    
+
    TRUE or FALSE if custom dimension is active or not
    
+
    scope
    
+
    Scope of custom dimension - one of "HIT","SESSION","USER","PRODUCT"
    
+
    ignoreCustomDataSourceLinks
    
+
    Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.
    
+
    
+    
    
+    
    See also
    
+    
    Custom dimensions support article
    
 
    Other custom variable functions: 
-ga_custom_vars_create(),
-ga_custom_vars_list(),
-ga_custom_vars()
    
-
-    
    Examples
    
-    
    
-if (FALSE) {
-library(googleAnalyticsR)
-ga_auth()
-
-# create custom var
-ga_custom_vars_create("my_custom_dim",
-                      index = 7,
-                      accountId = 54019251,
-                      webPropertyId = "UA-54019251-4",
-                      scope = "HIT",
-                      active = FALSE)
-
-# view custom dimension in list
-ga_custom_vars_list(54019251, webPropertyId = "UA-54019251-4", type = "customDimensions")
-
-# change a custom dimension
-ga_custom_vars_patch("ga:dimension7",
-                     accountId = 54019251,
-                     webPropertyId = "UA-54019251-4",
-                     name = "my_custom_dim2",
-                     active = TRUE)
-                     
-# view custom dimensions again to see change
-ga_custom_vars_list(54019251, webPropertyId = "UA-54019251-4", type = "customDimensions")
+ga_custom_vars_create(),
+ga_custom_vars_list(),
+ga_custom_vars()
    
+    
    
 
-}
-
    
+    
    
+    
    Examples
    
+    
    
+if (FALSE) {
+library(googleAnalyticsR)
+ga_auth()
+
+# create custom var
+ga_custom_vars_create("my_custom_dim",
+                      index = 7,
+                      accountId = 54019251,
+                      webPropertyId = "UA-54019251-4",
+                      scope = "HIT",
+                      active = FALSE)
+
+# view custom dimension in list
+ga_custom_vars_list(54019251, webPropertyId = "UA-54019251-4", type = "customDimensions")
+
+# change a custom dimension
+ga_custom_vars_patch("ga:dimension7",
+                     accountId = 54019251,
+                     webPropertyId = "UA-54019251-4",
+                     name = "my_custom_dim2",
+                     active = TRUE)
+                     
+# view custom dimensions again to see change
+ga_custom_vars_list(54019251, webPropertyId = "UA-54019251-4", type = "customDimensions")
+
+}
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_data.html b/docs/reference/ga_data.html
index 2135a45c..9e20302a 100644
--- a/docs/reference/ga_data.html
+++ b/docs/reference/ga_data.html
@@ -1,86 +1,19 @@
-
 
-
-  
-  
-
-
-
-Google Analytics Data for GA4 (App+Web) — ga_data • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Google Analytics Data for GA4 (App+Web) — ga_data • googleAnalyticsR
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Google Analytics Data for GA4 (App+Web)
    
-    Source: R/ga_data.R
+    Source: R/ga_data.R
     
     
    
 
     
    
-    
    [Experimental]
    
+    
    [Experimental]
    
 
    Fetches Google Analytics from the Data API for Google Analytics 4 (Previously App+Web)
    
     
    
 
-    
    ga_data(
-  propertyId,
-  metrics,
-  date_range = NULL,
-  dimensions = NULL,
-  dim_filters = NULL,
-  dimensionDelimiter = "/",
-  met_filters = NULL,
-  orderBys = NULL,
-  limit = 100,
-  page_size = 100000L,
-  realtime = FALSE,
-  raw_json = NULL
-)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    propertyId
    A GA4 property Id
    metrics
    The metrics to request - see ga_meta - set to NULL to only see dimensions
    date_range
    A vector with start and end dates in YYYY-MM-DD format - can send in up to four date ranges at once
    dimensions
    The dimensions to request - see ga_meta
    dim_filters
    Filter on the dimensions of the request - a filter object created by ga_data_filter
    dimensionDelimiter
    If combining dimensions in one column, the delimiter for the value field
    met_filters
    Filter on the metrics of the request - a filter object created by ga_data_filter
    orderBys
    How to order the response - an order object created by ga_data_order
    limit
    The number of rows to return - use -1 to return all rows
    page_size
    The size of API pages - default is 100000L rows
    realtime
    If TRUE then will call the real-time reports, that have a more limited set of dimensions/metrics - see valid real-time dimensions
    raw_json
    You can send in the raw JSON string for a Data API request which will skip all checks
    
-
-    
    Value
    
-
-    
    A data.frame tibble, including attributes metadata, metricAggregations and rowCount.  Use ga_data_aggregations to extract the data.frames of metricAggregations
    
-    
    Details
    
+    
    
+    
    ga_data(
+  propertyId,
+  metrics,
+  date_range = NULL,
+  dimensions = NULL,
+  dim_filters = NULL,
+  dimensionDelimiter = "/",
+  met_filters = NULL,
+  orderBys = NULL,
+  limit = 100,
+  page_size = 100000L,
+  realtime = FALSE,
+  raw_json = NULL
+)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    propertyId
    
+
    A GA4 property Id
    
+
    metrics
    
+
    The metrics to request - see ga_meta - set to NULL to only see dimensions
    
+
    date_range
    
+
    A vector with start and end dates in YYYY-MM-DD format - can send in up to four date ranges at once
    
+
    dimensions
    
+
    The dimensions to request - see ga_meta
    
+
    dim_filters
    
+
    Filter on the dimensions of the request - a filter object created by ga_data_filter
    
+
    dimensionDelimiter
    
+
    If combining dimensions in one column, the delimiter for the value field
    
+
    met_filters
    
+
    Filter on the metrics of the request - a filter object created by ga_data_filter
    
+
    orderBys
    
+
    How to order the response - an order object created by ga_data_order
    
+
    limit
    
+
    The number of rows to return - use -1 to return all rows
    
+
    page_size
    
+
    The size of API pages - default is 100000L rows
    
+
    realtime
    
+
    If TRUE then will call the real-time reports, that have a more limited set of dimensions/metrics - see valid real-time dimensions
    
+
    raw_json
    
+
    You can send in the raw JSON string for a Data API request which will skip all checks
    
+
    
+    
    
+    
    Value
    
+    
    A data.frame tibble, including attributes metadata, metricAggregations and rowCount.  Use ga_data_aggregations to extract the data.frames of metricAggregations
    
+    
    
+    
    
+    
    Details
    
     
    This is the main function to call the Google Analytics 4 Data API.
    
-    
    See also
    
-
-    
    Documentation on Data API
    
+    
    
+    
    
+    
    See also
    
+    
    Documentation on Data API
    
 
    Other GA4 functions: 
-ga_data_filter(),
-ga_data_order()
    
-
-    
    Examples
    
-    
    
-if (FALSE) {
-
-# send up to 4 date ranges
-multi_date <- ga_data(
-  206670707,
-  metrics = c("activeUsers","sessions"),
-  dimensions = c("date","city","dayOfWeek"),
-  date_range = c("2020-03-31", "2020-04-27", "2020-04-30", "2020-05-27"),
-  dim_filters = ga_data_filter("city"=="Copenhagen"),
-  limit = 100
-  )
-
-
-# metric and dimension expressions
-
-# create your own named metrics
-met_expression <- ga_data(
-  206670707,
-  metrics = c("activeUsers","sessions",sessionsPerUser = "sessions/activeUsers"),
-  dimensions = c("date","city","dayOfWeek"),
-  date_range = c("2020-03-31", "2020-04-27"),
-  limit = 100
-  )
-
-# create your own aggregation dimensions
-dim_expression <- ga_data(
-  206670707,
-  metrics = c("activeUsers","sessions"),
-  dimensions = c("date","city","dayOfWeek", cdow = "city/dayOfWeek"),
-  date_range = c("2020-03-31", "2020-04-27"),
-  limit = 100
-  )
-  
-# run a real-time report (no date dimension allowed)
-realtime <- ga_data(
-  206670707,
-  metrics = "activeUsers",
-  dimensions = c("city","unifiedScreenName"),
-  limit = 100,
-  realtime = TRUE)
-
-# extract meta data from the table
-ga_data_aggregations(realtime)
-
-# add ordering
-a <- ga_data_order(-sessions)
-b <- ga_data_order(-dayOfWeek, type = "NUMERIC")
+ga_data_filter(),
+ga_data_order()
    
+    
    
 
-ga_data(
-  206670707,
-  metrics = c("activeUsers","sessions"),
-  dimensions = c("date","city","dayOfWeek"),
-  date_range = c("2020-03-31", "2020-04-27"),
-  orderBys = c(a, b)
-  )
-}
-
    
+    
    
+    
    Examples
    
+    
    
+if (FALSE) {
+
+# send up to 4 date ranges
+multi_date <- ga_data(
+  206670707,
+  metrics = c("activeUsers","sessions"),
+  dimensions = c("date","city","dayOfWeek"),
+  date_range = c("2020-03-31", "2020-04-27", "2020-04-30", "2020-05-27"),
+  dim_filters = ga_data_filter("city"=="Copenhagen"),
+  limit = 100
+  )
+
+
+# metric and dimension expressions
+
+# create your own named metrics
+met_expression <- ga_data(
+  206670707,
+  metrics = c("activeUsers","sessions",sessionsPerUser = "sessions/activeUsers"),
+  dimensions = c("date","city","dayOfWeek"),
+  date_range = c("2020-03-31", "2020-04-27"),
+  limit = 100
+  )
+
+# create your own aggregation dimensions
+dim_expression <- ga_data(
+  206670707,
+  metrics = c("activeUsers","sessions"),
+  dimensions = c("date","city","dayOfWeek", cdow = "city/dayOfWeek"),
+  date_range = c("2020-03-31", "2020-04-27"),
+  limit = 100
+  )
+  
+# run a real-time report (no date dimension allowed)
+realtime <- ga_data(
+  206670707,
+  metrics = "activeUsers",
+  dimensions = c("city","unifiedScreenName"),
+  limit = 100,
+  realtime = TRUE)
+
+# extract meta data from the table
+ga_data_aggregations(realtime)
+
+# add ordering
+a <- ga_data_order(-sessions)
+b <- ga_data_order(-dayOfWeek, type = "NUMERIC")
+
+ga_data(
+  206670707,
+  metrics = c("activeUsers","sessions"),
+  dimensions = c("date","city","dayOfWeek"),
+  date_range = c("2020-03-31", "2020-04-27"),
+  orderBys = c(a, b)
+  )
+}
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_data_aggregations.html b/docs/reference/ga_data_aggregations.html
index 5f96f1d9..29f87837 100644
--- a/docs/reference/ga_data_aggregations.html
+++ b/docs/reference/ga_data_aggregations.html
@@ -1,86 +1,19 @@
-
 
-
-  
-  
-
-
-
-Extract metric aggregations from a ga_data result — ga_data_aggregations • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Extract metric aggregations from a ga_data result — ga_data_aggregations • googleAnalyticsR
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
-    
    Extract metric aggregations from a ga_data result
    
-    Source: R/ga_data.R
+    
    Extract metric aggregations from a ga_data result
    
+    Source: R/ga_data.R
     
     
    
 
     
    
-    
    [Experimental]
    
+    
    [Experimental]
    
 
    Metric aggregations are available in all requests.  This function lets you easily access the data.frames
    
     
    
 
-    
    ga_data_aggregations(
-  df,
-  type = c("all", "totals", "maximums", "minimums", "count")
-)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    df
    A data.frame result from ga_data
    type
    totals, maximums, minimums, counts (if available) or all
    
-
-
-    
    Examples
    
-    
    
-if (FALSE) {
-#' # send up to 4 date ranges
-multi_date <- ga_data(
-  206670707,
-  metrics = c("activeUsers","sessions"),
-  dimensions = c("date","city","dayOfWeek"),
-  date_range = c("2020-03-31", "2020-04-27", "2020-04-30", "2020-05-27"),
-  dim_filters = ga_data_filter("city"=="Copenhagen"),
-  limit = 100
-  )
-
-# metric aggregations for each date range
-ga_data_aggregations(multi_date, type = "all")
-
-# specify type
-ga_data_aggregations(multi_date, type = "maximums")
+    
    
+    
    ga_data_aggregations(
+  df,
+  type = c("all", "totals", "maximums", "minimums", "count")
+)
    
+    
    
 
-}
-
    
+    
    
+    
    Arguments
    
+    
    df
    
+
    A data.frame result from ga_data
    
+
    type
    
+
    totals, maximums, minimums, counts (if available) or all
    
+
    
+
+    
    
+    
    Examples
    
+    
    
+if (FALSE) {
+#' # send up to 4 date ranges
+multi_date <- ga_data(
+  206670707,
+  metrics = c("activeUsers","sessions"),
+  dimensions = c("date","city","dayOfWeek"),
+  date_range = c("2020-03-31", "2020-04-27", "2020-04-30", "2020-05-27"),
+  dim_filters = ga_data_filter("city"=="Copenhagen"),
+  limit = 100
+  )
+
+# metric aggregations for each date range
+ga_data_aggregations(multi_date, type = "all")
+
+# specify type
+ga_data_aggregations(multi_date, type = "maximums")
+
+}
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_data_filter.html b/docs/reference/ga_data_filter.html
index 7a205787..26f868e1 100644
--- a/docs/reference/ga_data_filter.html
+++ b/docs/reference/ga_data_filter.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Filter DSL for GA4 filters — ga_data_filter • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Filter DSL for GA4 filters — ga_data_filter • googleAnalyticsR
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Filter DSL for GA4 filters
    
-    Source: R/ga_data_filter.R
+    Source: R/ga_data_filter.R
     
     
    
 
     
    
-    
    Use with ga_data to create filters
    
+    
    Use with ga_data to create filters
    
     
    
 
-    
    ga_data_filter(x)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
    x
    Filter DSL enabled syntax or the output of a previous call to this function - see examples
    
-
-    
    Value
    
-
-    
    A FilterExpression object suitable for use in ga_data
    
-    
    Details
    
+    
    
+    
    ga_data_filter(x)
    
+    
    
 
-    
    This uses a specific filter DSL syntax to create GA4 filters that can be passed to ga_data arguments dim_filters or met_filters. Ensure that the fields you use are either all metrics or all dimensions.
    
+    
    
+    
    Arguments
    
+    
    x
    
+
    Filter DSL enabled syntax or the output of a previous call to this function - see examples
    
+
    
+    
    
+    
    Value
    
+    
    A FilterExpression object suitable for use in ga_data
    
+    
    
+    
    
+    
    Details
    
+    
    This uses a specific filter DSL syntax to create GA4 filters that can be passed to ga_data arguments dim_filters or met_filters. Ensure that the fields you use are either all metrics or all dimensions.
    
 
    The syntax uses operators and the class of the value you are setting (string, numeric or logical) to construct the filter expression object.
    
-
    Fields including custom fields for your propertyId can be imported if you fetch them via ga_meta("data", propertyId = 12345) before you construct a filter.  If you do not want filters to be validated, then send them in as strings ("field").
    
+
    Fields including custom fields for your propertyId can be imported if you fetch them via ga_meta("data", propertyId = 12345) before you construct a filter.  If you do not want filters to be validated, then send them in as strings ("field").
    
 
    The DSL rules are:
    
-
      
-
    • Single filters can be used without wrapping in filter expressions
      • 
+
      • Single filters can be used without wrapping in filter expressions
        • 
 
      • A single filter syntax is (field) (operator) (value)
        • 
-
      • (field) is a dimension or metric for your web property, which you can review via ga_meta
        • 
+
      • (field) is a dimension or metric for your web property, which you can review via ga_meta
        • 
 
      • (field) can be validated if you fetch metadata before you construct the filter.  If you do this, you can call the fields without quote strings e.g. city and not "city"
        • 
 
      • (operator) for metrics can be one of: ==, >, >=, <, <=
        • 
 
      • (operator) for dimensions can be one of: ==, \%begins\%, \%ends\%, \%contains\%, \%in\%, \%regex\%, \%regex_partial\% for dimensions
        • 
 
      • dimension (operator) are by default case sensitive.  Make them case insensitive by using UPPER case variations \%BEGINS\%, \%ENDS\%, ... or === for exact matches
        • 
-
      • (value) can be strings ("dim1"), numerics (55), string vectors (c("dim1", "dim2")), numeric vectors (c(1,2,3)) or boolean (TRUE) - the type will created different types of filters - see examples
        • 
+
      • (value) can be strings ("dim1"), numerics (55), string vectors (c("dim1", "dim2")), numeric vectors (c(1,2,3)) or boolean (TRUE) - the type will created different types of filters - see examples
        • 
 
      • Create filter expressions for multiple filters when using the operators: &, |, ! for logical combinations of AND, OR and NOT respectively.
        • 
-
      
-
-    
      See also
      
-
-    
      Other GA4 functions: 
-ga_data_order(),
-ga_data()
      
-
-    
      Examples
      
-    
      
-if (FALSE) {
-# start by calling ga_meta("data") to put valid field names in your environment
-meta <- ga_meta("data")
-
-# if you have custom fields, supply your propertyId to ga_meta()
-custom_meta <- ga_meta("data", propertyId = 206670707)
-custom_meta[grepl("^customEvent", custom_meta$apiName),]
-}
-## filter clauses
-# OR string filter
-ga_data_filter(city=="Copenhagen" | city == "London")
-
      #> ===orGroup:  
-#> [[1]]
-#> --GA4 Filter:  
-#> --| city 
-#> ----stringFilter:  
-#> value:  Copenhagen | matchType:  EXACT | caseSensitive:  TRUE
-#> [[2]]
-#> --GA4 Filter:  
-#> --| city 
-#> ----stringFilter:  
-#> value:  London | matchType:  EXACT | caseSensitive:  TRUE
      # inlist string filter
-ga_data_filter(city==c("Copenhagen","London"))
-
      #> --| city 
-#> ----inListFilter:  
-#> values:  Copenhagen London 
-#> caseSensitive:  TRUE 
      # AND string filters
-ga_data_filter(city=="Copenhagen" & dayOfWeek == "5")
-
      #> ===andGroup:  
-#> [[1]]
-#> --GA4 Filter:  
-#> --| city 
-#> ----stringFilter:  
-#> value:  Copenhagen | matchType:  EXACT | caseSensitive:  TRUE
-#> [[2]]
-#> --GA4 Filter:  
-#> --| dayOfWeek 
-#> ----stringFilter:  
-#> value:  5 | matchType:  EXACT | caseSensitive:  TRUE
      # ! - invert string filter
-ga_data_filter(!(city=="Copenhagen" | city == "London"))
-
      #> ===notExpression:  
-#> ===orGroup:  
-#> [[1]]
-#> --GA4 Filter:  
-#> --| city 
-#> ----stringFilter:  
-#> value:  Copenhagen | matchType:  EXACT | caseSensitive:  TRUE
-#> [[2]]
-#> --GA4 Filter:  
-#> --| city 
-#> ----stringFilter:  
-#> value:  London | matchType:  EXACT | caseSensitive:  TRUE
      
-# multiple filter clauses
-f1 <- ga_data_filter(city==c("Copenhagen","London","Paris","New York") &
-               (dayOfWeek=="5" | dayOfWeek=="6")) 
-               
-# build up complicated filters
-f2 <- ga_data_filter(f1 | sessionSource=="google")
-f3 <- ga_data_filter(f2 & !sessionMedium=="cpc")
-f3
-
      #> ===============andGroup:  
-#> [[1]]
-#> ===========orGroup:  
-#> [[1]]
-#> =======andGroup:  
-#> [[1]]
-#> --GA4 Filter:  
-#> --| city 
-#> ----inListFilter:  
-#> values:  Copenhagen London Paris New York 
-#> caseSensitive:  TRUE 
-#> 
-#> [[2]]
-#> ===orGroup:  
-#> [[1]]
-#> --GA4 Filter:  
-#> --| dayOfWeek 
-#> ----stringFilter:  
-#> value:  5 | matchType:  EXACT | caseSensitive:  TRUE
-#> [[2]]
-#> --GA4 Filter:  
-#> --| dayOfWeek 
-#> ----stringFilter:  
-#> value:  6 | matchType:  EXACT | caseSensitive:  TRUE
-#> 
-#> 
-#> [[2]]
-#> --GA4 Filter:  
-#> --| sessionSource 
-#> ----stringFilter:  
-#> value:  google | matchType:  EXACT | caseSensitive:  TRUE
-#> 
-#> [[2]]
-#> notExpression:  
-#> --GA4 Filter:  
-#> --| sessionMedium 
-#> ----stringFilter:  
-#> value:  cpc | matchType:  EXACT | caseSensitive:  TRUE
      
-## numeric filter types
-# numeric equal filter
-ga_data_filter(sessions==5)
-
      #> --| sessions 
-#> ----numericFilter:  
-#> operation:  EQUAL | value:      5
      # between numeric filter
-ga_data_filter(sessions==c(5,6))
-
      #> --| sessions 
-#> ----betweenFilter:  
-#> from:  5  to:  6
      # greater than numeric
-ga_data_filter(sessions > 0)
-
      #> --| sessions 
-#> ----numericFilter:  
-#> operation:  GREATER_THAN | value:      0
      # greater than or equal
-ga_data_filter(sessions >= 1)
-
      #> --| sessions 
-#> ----numericFilter:  
-#> operation:  GREATER_THAN_OR_EQUAL | value:      1
      # less than numeric
-ga_data_filter(sessions < 100)
-
      #> --| sessions 
-#> ----numericFilter:  
-#> operation:  LESS_THAN | value:      100
      # less than or equal numeric
-ga_data_filter(sessions <= 100)
-
      #> --| sessions 
-#> ----numericFilter:  
-#> operation:  LESS_THAN_OR_EQUAL | value:      100
      
-## string filter types
-# begins with string
-ga_data_filter(city %begins% "Cope")
-
      #> --| city 
-#> ----stringFilter:  
-#> value:  Cope | matchType:  BEGINS_WITH | caseSensitive:  TRUE
      # ends with string
-ga_data_filter(city %ends% "hagen")
-
      #> --| city 
-#> ----stringFilter:  
-#> value:  hagen | matchType:  ENDS_WITH | caseSensitive:  TRUE
      # contains string
-ga_data_filter(city %contains% "ope")
-
      #> --| city 
-#> ----stringFilter:  
-#> value:  ope | matchType:  CONTAINS | caseSensitive:  TRUE
      # regex (full) string
-ga_data_filter(city %regex% "^Cope")
-
      #> --| city 
-#> ----stringFilter:  
-#> value:  ^Cope | matchType:  FULL_REGEXP | caseSensitive:  TRUE
      # regex (partial) string
-ga_data_filter(city %regex_partial% "ope")
-
      #> --| city 
-#> ----stringFilter:  
-#> value:  ope | matchType:  PARTIAL_REGEXP | caseSensitive:  TRUE
      
-# by default string filters are case sensitive.  
-# Use UPPERCASE operator to make then case insensitive
+
    
+    
    
+    
    See also
    
+    
    Other GA4 functions: 
+ga_data_order(),
+ga_data()
    
+    
    
 
-# begins with string (case insensitive)
-ga_data_filter(city %BEGINS% "cope")
-
    #> --| city 
-#> ----stringFilter:  
-#> value:  cope | matchType:  BEGINS_WITH | caseSensitive:  FALSE
    # ends with string (case insensitive)
-ga_data_filter(city %ENDS% "Hagen")
-
    #> --| city 
-#> ----stringFilter:  
-#> value:  Hagen | matchType:  ENDS_WITH | caseSensitive:  FALSE
    # case insensitive exact
-ga_data_filter(city %==%"coPENGhagen")
-
    #> --| city 
-#> ----stringFilter:  
-#> value:  coPENGhagen | matchType:  EXACT | caseSensitive:  FALSE
    
-# avoid validation by making fields strings
-ga_data_filter("city" %==%"coPENGhagen")
-
    #> --| city 
-#> ----stringFilter:  
-#> value:  coPENGhagen | matchType:  EXACT | caseSensitive:  FALSE
    
-
    
+    
    
+    
    Examples
    
+    
    
+if (FALSE) {
+# start by calling ga_meta("data") to put valid field names in your environment
+meta <- ga_meta("data")
+
+# if you have custom fields, supply your propertyId to ga_meta()
+custom_meta <- ga_meta("data", propertyId = 206670707)
+custom_meta[grepl("^customEvent", custom_meta$apiName),]
+}
+## filter clauses
+# OR string filter
+ga_data_filter(city=="Copenhagen" | city == "London")
+#> ===orGroup:  
+#> [[1]]
+#> --GA4 Filter:  
+#> --| city 
+#> ----stringFilter:  
+#> value:  Copenhagen | matchType:  EXACT | caseSensitive:  TRUE
+#> [[2]]
+#> --GA4 Filter:  
+#> --| city 
+#> ----stringFilter:  
+#> value:  London | matchType:  EXACT | caseSensitive:  TRUE
+# inlist string filter
+ga_data_filter(city==c("Copenhagen","London"))
+#> --| city 
+#> ----inListFilter:  
+#> values:  Copenhagen London 
+#> caseSensitive:  TRUE 
+# AND string filters
+ga_data_filter(city=="Copenhagen" & dayOfWeek == "5")
+#> ===andGroup:  
+#> [[1]]
+#> --GA4 Filter:  
+#> --| city 
+#> ----stringFilter:  
+#> value:  Copenhagen | matchType:  EXACT | caseSensitive:  TRUE
+#> [[2]]
+#> --GA4 Filter:  
+#> --| dayOfWeek 
+#> ----stringFilter:  
+#> value:  5 | matchType:  EXACT | caseSensitive:  TRUE
+# ! - invert string filter
+ga_data_filter(!(city=="Copenhagen" | city == "London"))
+#> ===notExpression:  
+#> ===orGroup:  
+#> [[1]]
+#> --GA4 Filter:  
+#> --| city 
+#> ----stringFilter:  
+#> value:  Copenhagen | matchType:  EXACT | caseSensitive:  TRUE
+#> [[2]]
+#> --GA4 Filter:  
+#> --| city 
+#> ----stringFilter:  
+#> value:  London | matchType:  EXACT | caseSensitive:  TRUE
+
+# multiple filter clauses
+f1 <- ga_data_filter(city==c("Copenhagen","London","Paris","New York") &
+               (dayOfWeek=="5" | dayOfWeek=="6")) 
+               
+# build up complicated filters
+f2 <- ga_data_filter(f1 | sessionSource=="google")
+f3 <- ga_data_filter(f2 & !sessionMedium=="cpc")
+f3
+#> ===============andGroup:  
+#> [[1]]
+#> ===========orGroup:  
+#> [[1]]
+#> =======andGroup:  
+#> [[1]]
+#> --GA4 Filter:  
+#> --| city 
+#> ----inListFilter:  
+#> values:  Copenhagen London Paris New York 
+#> caseSensitive:  TRUE 
+#> 
+#> [[2]]
+#> ===orGroup:  
+#> [[1]]
+#> --GA4 Filter:  
+#> --| dayOfWeek 
+#> ----stringFilter:  
+#> value:  5 | matchType:  EXACT | caseSensitive:  TRUE
+#> [[2]]
+#> --GA4 Filter:  
+#> --| dayOfWeek 
+#> ----stringFilter:  
+#> value:  6 | matchType:  EXACT | caseSensitive:  TRUE
+#> 
+#> 
+#> [[2]]
+#> --GA4 Filter:  
+#> --| sessionSource 
+#> ----stringFilter:  
+#> value:  google | matchType:  EXACT | caseSensitive:  TRUE
+#> 
+#> [[2]]
+#> notExpression:  
+#> --GA4 Filter:  
+#> --| sessionMedium 
+#> ----stringFilter:  
+#> value:  cpc | matchType:  EXACT | caseSensitive:  TRUE
+
+## numeric filter types
+# numeric equal filter
+ga_data_filter(sessions==5)
+#> --| sessions 
+#> ----numericFilter:  
+#> operation:  EQUAL | value:      5
+# between numeric filter
+ga_data_filter(sessions==c(5,6))
+#> --| sessions 
+#> ----betweenFilter:  
+#> from:  5  to:  6
+# greater than numeric
+ga_data_filter(sessions > 0)
+#> --| sessions 
+#> ----numericFilter:  
+#> operation:  GREATER_THAN | value:      0
+# greater than or equal
+ga_data_filter(sessions >= 1)
+#> --| sessions 
+#> ----numericFilter:  
+#> operation:  GREATER_THAN_OR_EQUAL | value:      1
+# less than numeric
+ga_data_filter(sessions < 100)
+#> --| sessions 
+#> ----numericFilter:  
+#> operation:  LESS_THAN | value:      100
+# less than or equal numeric
+ga_data_filter(sessions <= 100)
+#> --| sessions 
+#> ----numericFilter:  
+#> operation:  LESS_THAN_OR_EQUAL | value:      100
+
+## string filter types
+# begins with string
+ga_data_filter(city %begins% "Cope")
+#> --| city 
+#> ----stringFilter:  
+#> value:  Cope | matchType:  BEGINS_WITH | caseSensitive:  TRUE
+# ends with string
+ga_data_filter(city %ends% "hagen")
+#> --| city 
+#> ----stringFilter:  
+#> value:  hagen | matchType:  ENDS_WITH | caseSensitive:  TRUE
+# contains string
+ga_data_filter(city %contains% "ope")
+#> --| city 
+#> ----stringFilter:  
+#> value:  ope | matchType:  CONTAINS | caseSensitive:  TRUE
+# regex (full) string
+ga_data_filter(city %regex% "^Cope")
+#> --| city 
+#> ----stringFilter:  
+#> value:  ^Cope | matchType:  FULL_REGEXP | caseSensitive:  TRUE
+# regex (partial) string
+ga_data_filter(city %regex_partial% "ope")
+#> --| city 
+#> ----stringFilter:  
+#> value:  ope | matchType:  PARTIAL_REGEXP | caseSensitive:  TRUE
+
+# by default string filters are case sensitive.  
+# Use UPPERCASE operator to make then case insensitive
+
+# begins with string (case insensitive)
+ga_data_filter(city %BEGINS% "cope")
+#> --| city 
+#> ----stringFilter:  
+#> value:  cope | matchType:  BEGINS_WITH | caseSensitive:  FALSE
+# ends with string (case insensitive)
+ga_data_filter(city %ENDS% "Hagen")
+#> --| city 
+#> ----stringFilter:  
+#> value:  Hagen | matchType:  ENDS_WITH | caseSensitive:  FALSE
+# case insensitive exact
+ga_data_filter(city %==%"coPENGhagen")
+#> --| city 
+#> ----stringFilter:  
+#> value:  coPENGhagen | matchType:  EXACT | caseSensitive:  FALSE
+
+# avoid validation by making fields strings
+ga_data_filter("city" %==%"coPENGhagen")
+#> --| city 
+#> ----stringFilter:  
+#> value:  coPENGhagen | matchType:  EXACT | caseSensitive:  FALSE
+
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_data_order.html b/docs/reference/ga_data_order.html
index 5a7276bb..8538bdcd 100644
--- a/docs/reference/ga_data_order.html
+++ b/docs/reference/ga_data_order.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Order DSL for GA4 OrderBy — ga_data_order • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Order DSL for GA4 OrderBy — ga_data_order • googleAnalyticsR
-
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Order DSL for GA4 OrderBy
    
-    Source: R/ga_data_order.R
+    Source: R/ga_data_order.R
     
     
    
 
     
    
-    
    Use with ga_data to create orderBys
    
+    
    Use with ga_data to create orderBys
    
     
    
 
-    
    ga_data_order(
-  x,
-  type = c("ALPHANUMERIC", "CASE_INSENSITIVE_ALPHANUMERIC", "NUMERIC")
-)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    x
    Order DSL enabled syntax
    type
    Order Type
    
-
-    
    Value
    
-
-    
    A list of OrderBy objects suitable for use in ga_data
    
-    
    Details
    
+    
    
+    
    ga_data_order(
+  x,
+  type = c("ALPHANUMERIC", "CASE_INSENSITIVE_ALPHANUMERIC", "NUMERIC")
+)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    x
    
+
    Order DSL enabled syntax
    
+
    type
    
+
    Order Type
    
+
    
+    
    
+    
    Value
    
+    
    A list of OrderBy objects suitable for use in ga_data
    
+    
    
+    
    
+    
    Details
    
     
    The DSL rules are:
    
-
      
-
    • Fields can be quoted or unquoted.  If unquoted they will be validated
      • 
+
      • Fields can be quoted or unquoted.  If unquoted they will be validated
        • 
 
      • Use + as a prefix to indicate ascending order e.g. +sessions
        • 
 
      • Use - as a prefix to indicate decreasing order e.g. -sessions
        • 
 
      • Combine order fields without commas e.g. +sessions -city
        • 
 
      • Ordering of dimensions can also specify a type of ordering: ALPHANUMERIC, CASE_INSENSITIVE_ALPHANUMERIC, NUMERIC
        • 
-
      
-
-
      The dimension ordering have these effects:
      
-
        
-
      • ALPHANUMERIC For example, "2" < "A" < "X" < "b" < "z"
        • 
+
      The dimension ordering have these effects:
      
+
      • ALPHANUMERIC For example, "2" < "A" < "X" < "b" < "z"
        • 
 
      • CASE_INSENSITIVE_ALPHANUMERIC Case insensitive alphanumeric sort by lower case Unicode code point. For example, "2" < "A" < "b" < "X" < "z"
        • 
 
      • NUMERIC Dimension values are converted to numbers before sorting. For example in NUMERIC sort, "25" < "100", and in ALPHANUMERIC sort, "100" < "25". Non-numeric dimension values all have equal ordering value below all numeric values
        • 
-
      
-
-    
      See also
      
-
-    
      https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1alpha/OrderBy
      
+
    
+    
    
+    
    See also
    
+    
    https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1alpha/OrderBy
    
 
    Other GA4 functions: 
-ga_data_filter(),
-ga_data()
    
-
-    
    Examples
    
-    
    
-
-# session in descending order
-ga_data_order(-sessions)
-
    #> [[1]]
-#> ==GA4 OrderBy==
-#> Metric:        sessions 
-#> Descending:    TRUE 
-#> 
    
-# city dimension in ascending alphanumeric order
-ga_data_order(+city)
-
    #> [[1]]
-#> ==GA4 OrderBy==
-#> Dimension:     city 
-#> OrderType:     ALPHANUMERIC 
-#> Descending:    FALSE 
-#> 
    
-# as above plus sessions in descending order
-ga_data_order(+city -sessions)
-
    #> [[1]]
-#> ==GA4 OrderBy==
-#> Dimension:     city 
-#> OrderType:     ALPHANUMERIC 
-#> Descending:    FALSE 
-#> 
-#> [[2]]
-#> ==GA4 OrderBy==
-#> Metric:        sessions 
-#> Descending:    TRUE 
-#> 
    
-# as above plus activeUsers in ascending order
-ga_data_order(+city -sessions +activeUsers)
-
    #> [[1]]
-#> ==GA4 OrderBy==
-#> Dimension:     city 
-#> OrderType:     ALPHANUMERIC 
-#> Descending:    FALSE 
-#> 
-#> [[2]]
-#> ==GA4 OrderBy==
-#> Metric:        sessions 
-#> Descending:    TRUE 
-#> 
-#> [[3]]
-#> ==GA4 OrderBy==
-#> Metric:        activeUsers 
-#> Descending:    FALSE 
-#> 
    
-# dayOfWeek dimension in ascending numeric order
-ga_data_order(+dayOfWeek, type = "NUMERIC")
-
    #> [[1]]
-#> ==GA4 OrderBy==
-#> Dimension:     dayOfWeek 
-#> OrderType:     NUMERIC 
-#> Descending:    FALSE 
-#> 
    
-# you can also combine them with c()
-a <- ga_data_order(-sessions)
-b <- ga_data_order(-dayOfWeek, type = "NUMERIC")
-c(a, b)
-
    #> [[1]]
-#> ==GA4 OrderBy==
-#> Metric:        sessions 
-#> Descending:    TRUE 
-#> 
-#> [[2]]
-#> ==GA4 OrderBy==
-#> Dimension:     dayOfWeek 
-#> OrderType:     NUMERIC 
-#> Descending:    TRUE 
-#> 
    
-if (FALSE) {
-# example of use
-ga_data(
-  206670707,
-  metrics = c("activeUsers","sessions"),
-  dimensions = c("date","city","dayOfWeek"),
-  date_range = c("2020-03-31", "2020-04-27"),
-  orderBys = ga_data_order(-sessions -dayOfWeek)
-  )
-
-
-}
-
+ga_data_filter(),
+ga_data()
    
+    
    
 
-
    
+    
    
+    
    Examples
    
+    
    
+
+# session in descending order
+ga_data_order(-sessions)
+#> [[1]]
+#> ==GA4 OrderBy==
+#> Metric:        sessions 
+#> Descending:    TRUE 
+#> 
+
+# city dimension in ascending alphanumeric order
+ga_data_order(+city)
+#> [[1]]
+#> ==GA4 OrderBy==
+#> Dimension:     city 
+#> OrderType:     ALPHANUMERIC 
+#> Descending:    FALSE 
+#> 
+
+# as above plus sessions in descending order
+ga_data_order(+city -sessions)
+#> [[1]]
+#> ==GA4 OrderBy==
+#> Dimension:     city 
+#> OrderType:     ALPHANUMERIC 
+#> Descending:    FALSE 
+#> 
+#> [[2]]
+#> ==GA4 OrderBy==
+#> Metric:        sessions 
+#> Descending:    TRUE 
+#> 
+
+# as above plus activeUsers in ascending order
+ga_data_order(+city -sessions +activeUsers)
+#> [[1]]
+#> ==GA4 OrderBy==
+#> Dimension:     city 
+#> OrderType:     ALPHANUMERIC 
+#> Descending:    FALSE 
+#> 
+#> [[2]]
+#> ==GA4 OrderBy==
+#> Metric:        sessions 
+#> Descending:    TRUE 
+#> 
+#> [[3]]
+#> ==GA4 OrderBy==
+#> Metric:        activeUsers 
+#> Descending:    FALSE 
+#> 
+
+# dayOfWeek dimension in ascending numeric order
+ga_data_order(+dayOfWeek, type = "NUMERIC")
+#> [[1]]
+#> ==GA4 OrderBy==
+#> Dimension:     dayOfWeek 
+#> OrderType:     NUMERIC 
+#> Descending:    FALSE 
+#> 
+
+# you can also combine them with c()
+a <- ga_data_order(-sessions)
+b <- ga_data_order(-dayOfWeek, type = "NUMERIC")
+c(a, b)
+#> [[1]]
+#> ==GA4 OrderBy==
+#> Metric:        sessions 
+#> Descending:    TRUE 
+#> 
+#> [[2]]
+#> ==GA4 OrderBy==
+#> Dimension:     dayOfWeek 
+#> OrderType:     NUMERIC 
+#> Descending:    TRUE 
+#> 
+
+if (FALSE) {
+# example of use
+ga_data(
+  206670707,
+  metrics = c("activeUsers","sessions"),
+  dimensions = c("date","city","dayOfWeek"),
+  date_range = c("2020-03-31", "2020-04-27"),
+  orderBys = ga_data_order(-sessions -dayOfWeek)
+  )
+
+
+}
+
+
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_experiment.html b/docs/reference/ga_experiment.html
index ad8af65a..8aa5884f 100644
--- a/docs/reference/ga_experiment.html
+++ b/docs/reference/ga_experiment.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Experiments Meta data — ga_experiment • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Experiments Meta data — ga_experiment • googleAnalyticsR
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Experiments Meta data
    
-    Source: R/experiments.R
+    Source: R/experiments.R
     
     
    
 
@@ -295,67 +213,57 @@ 
    Experiments Meta data
    
     
    Experiments Meta data
    
     
    
 
-    
    ga_experiment(accountId, webPropertyId, profileId, experimentId)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    accountId
    Account Id
    webPropertyId
    Web Property Id
    profileId
    Profile Id
    experimentId
    Experiment Id
    
-
-    
    Value
    
+    
    
+    
    ga_experiment(accountId, webPropertyId, profileId, experimentId)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    accountId
    
+
    Account Id
    
+
    webPropertyId
    
+
    Web Property Id
    
+
    profileId
    
+
    Profile Id
    
+
    experimentId
    
+
    Experiment Id
    
+
    
+    
    
+    
    Value
    
     
    Experiment Meta Data
    
-    
    See also
    
-
-    
    Other managementAPI functions: 
-ga_experiment_list(),
-ga_filter_add(),
-ga_filter_apply_to_view(),
-ga_filter_update_filter_link(),
-ga_filter_update(),
-ga_segment_list()
    
+    
    
+    
    
+    
    See also
    
+    
    Other managementAPI functions: 
+ga_experiment_list(),
+ga_filter_add(),
+ga_filter_apply_to_view(),
+ga_filter_update_filter_link(),
+ga_filter_update(),
+ga_segment_list()
    
+    
    
 
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_experiment_list.html b/docs/reference/ga_experiment_list.html
index a7cb60d4..389dc811 100644
--- a/docs/reference/ga_experiment_list.html
+++ b/docs/reference/ga_experiment_list.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-List Experiments — ga_experiment_list • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-List Experiments — ga_experiment_list • googleAnalyticsR
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    List Experiments
    
-    Source: R/experiments.R
+    Source: R/experiments.R
     
     
    
 
@@ -295,63 +213,55 @@ 
    List Experiments
    
     
    List Experiments
    
     
    
 
-    
    ga_experiment_list(accountId, webPropertyId, profileId)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    accountId
    Account Id
    webPropertyId
    Web Property Id
    profileId
    Profile Id
    
-
-    
    Value
    
+    
    
+    
    ga_experiment_list(accountId, webPropertyId, profileId)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    accountId
    
+
    Account Id
    
+
    webPropertyId
    
+
    Web Property Id
    
+
    profileId
    
+
    Profile Id
    
+
    
+    
    
+    
    Value
    
     
    Experiments List
    
-    
    See also
    
-
-    
    Other managementAPI functions: 
-ga_experiment(),
-ga_filter_add(),
-ga_filter_apply_to_view(),
-ga_filter_update_filter_link(),
-ga_filter_update(),
-ga_segment_list()
    
+    
    
+    
    
+    
    See also
    
+    
    Other managementAPI functions: 
+ga_experiment(),
+ga_filter_add(),
+ga_filter_apply_to_view(),
+ga_filter_update_filter_link(),
+ga_filter_update(),
+ga_segment_list()
    
+    
    
 
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_filter.html b/docs/reference/ga_filter.html
index a207fd60..132a297d 100644
--- a/docs/reference/ga_filter.html
+++ b/docs/reference/ga_filter.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Get specific filter for account — ga_filter • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Get specific filter for account — ga_filter • googleAnalyticsR
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Get specific filter for account
    
-    Source: R/filter_management.R
+    Source: R/filter_management.R
     
     
    
 
@@ -295,57 +213,51 @@ 
    Get specific filter for account
    
     
    Get specific filter for account
    
     
    
 
-    
    ga_filter(accountId, filterId)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    accountId
    Account Id
    filterId
    Filter Id
    
-
-    
    Value
    
+    
    
+    
    ga_filter(accountId, filterId)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    accountId
    
+
    Account Id
    
+
    filterId
    
+
    Filter Id
    
+
    
+    
    
+    
    Value
    
     
    filter list
    
-    
    See also
    
-
-    
    Other filter management functions: 
-ga_filter_delete(),
-ga_filter_list(),
-ga_filter_view_list(),
-ga_filter_view()
    
+    
    
+    
    
+    
    See also
    
+    
    Other filter management functions: 
+ga_filter_delete(),
+ga_filter_list(),
+ga_filter_view_list(),
+ga_filter_view()
    
+    
    
 
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_filter_add.html b/docs/reference/ga_filter_add.html
index e91bfe5b..016eea26 100644
--- a/docs/reference/ga_filter_add.html
+++ b/docs/reference/ga_filter_add.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Create a new filter and add it to the view (optional). — ga_filter_add • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Create a new filter and add it to the view (optional). — ga_filter_add • googleAnalyticsR
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Create a new filter and add it to the view (optional).
    
-    Source: R/filter_management.R
+    Source: R/filter_management.R
     
     
    
 
@@ -295,152 +213,143 @@ 
    Create a new filter and add it to the view (optional).
    
     
    Take a filter object and add and/or apply it so its live.
    
     
    
 
-    
    ga_filter_add(
-  Filter,
-  accountId,
-  webPropertyId = NULL,
-  viewId = NULL,
-  linkFilter = FALSE
-)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    Filter
    The Filter object to be added to the account or view.  See examples.
    accountId
    Account Id of the account to add the Filter to
    webPropertyId
    Property Id of the property to add the Filter to
    viewId
    View Id of the view to add the Filter to
    linkFilter
    If TRUE will apply the Filter to the view. Needs propetyId and viewId to be set.
    
-
-    
    Value
    
+    
    
+    
    ga_filter_add(
+  Filter,
+  accountId,
+  webPropertyId = NULL,
+  viewId = NULL,
+  linkFilter = FALSE
+)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    Filter
    
+
    The Filter object to be added to the account or view.  See examples.
    
+
    accountId
    
+
    Account Id of the account to add the Filter to
    
+
    webPropertyId
    
+
    Property Id of the property to add the Filter to
    
+
    viewId
    
+
    View Id of the view to add the Filter to
    
+
    linkFilter
    
+
    If TRUE will apply the Filter to the view. Needs propetyId and viewId to be set.
    
+
    
+    
    
+    
    Value
    
     
    The filterId created if linkFilter=FALSE or a Filter object if linkFilter=TRUE
    
-    
    Details
    
-
+    
    
+    
    
+    
    Details
    
     
    If you don't set linkFilter=TRUE then the filter will only be created but not applied.
-You will find it listed in the admin panel Account > All Filters.  You can then use ga_filter_apply_to_view to apply later on.
    
-    
    See also
    
-
-    
    https://developers.google.com/analytics/devguides/config/mgmt/v3/mgmtReference/#Filters
    
+You will find it listed in the admin panel Account > All Filters.  You can then use ga_filter_apply_to_view to apply later on.
    
+    
    
+    
    
+    
    See also
    
+    
    https://developers.google.com/analytics/devguides/config/mgmt/v3/mgmtReference/#Filters
    
 
    Other managementAPI functions: 
-ga_experiment_list(),
-ga_experiment(),
-ga_filter_apply_to_view(),
-ga_filter_update_filter_link(),
-ga_filter_update(),
-ga_segment_list()
    
-
-    
    Examples
    
-    
    
-if (FALSE) {
-## Create a filter object for adding an IP exclusion:
-Filter <- list(
-               name = 'Exclude Internal Traffic',
-               type = 'EXCLUDE',
-               excludeDetails = list(
-                   field = 'GEO_IP_ADDRESS',
-                   matchType = 'EQUAL',
-                   expressionValue = '199.04.123.1',
-                   caseSensitive = 'False'
-                                    )
-              )
-
-# create and add the filter to the view specified      
-my_filter <- ga_filter_add(Filter, 
-                           accountId = 12345, 
-                           webPropertyId = "UA-12345-1", 
-                           viewId = 654321,
-                           linkFilter = TRUE)
-
-# only create the filter, don't apply it to any view - returns filterId for use later
-my_filter <- ga_filter_add(Filter, 
-                           accountId = 12345, 
-                           linkFilter = FALSE)                          
-
-## Other examples of filters you can create below:
-## Create a filter object for making campaign medium lowercase
-Filter <- list(
-               name = 'Lowercase Campaign Medium',
-               type = 'LOWERCASE',
-               lowercaseDetails = list(
-                   field = 'CAMPAIGN_MEDIUM'
-                                    )
-              )
-
-## Create a filter object to append hostname to URI
-Filter <- list(
-               name = 'Append hostname to URI',
-               type = 'ADVANCED',
-               advancedDetails = list(
-                   fieldA = 'PAGE_HOSTNAME',
-                   extractA = '(.*)',
-                   fieldARequired = 'True',
-                   fieldB = 'PAGE_REQUEST_URI',
-                   extractB = '(.*)',
-                   fieldBRequired = 'False',
-                   outputConstructor = '$A1$B1',
-                   outputToField = 'PAGE_REQUEST_URI',
-                   caseSensitive = 'False',
-                   overrideOutputField = 'True'
-                                    )
-              )
-
-## Create a filter object to add www hostname without it
-Filter <- list(
-               name = 'Search and Replace www',
-               type = 'SEARCH_AND_REPLACE',
-               searchAndReplaceDetails = list(
-                   field = 'PAGE_HOSTNAME',
-                   searchString = '^exampleUSA\\.com$',
-                   replaceString = 'www.exampleUSA.com',
-                   caseSensitive = 'False'
-                                    )
-              )
-
-}
+ga_experiment_list(),
+ga_experiment(),
+ga_filter_apply_to_view(),
+ga_filter_update_filter_link(),
+ga_filter_update(),
+ga_segment_list()
    
+    
    
 
-
    
+    
    
+    
    Examples
    
+    
    
+if (FALSE) {
+## Create a filter object for adding an IP exclusion:
+Filter <- list(
+               name = 'Exclude Internal Traffic',
+               type = 'EXCLUDE',
+               excludeDetails = list(
+                   field = 'GEO_IP_ADDRESS',
+                   matchType = 'EQUAL',
+                   expressionValue = '199.04.123.1',
+                   caseSensitive = 'False'
+                                    )
+              )
+
+# create and add the filter to the view specified      
+my_filter <- ga_filter_add(Filter, 
+                           accountId = 12345, 
+                           webPropertyId = "UA-12345-1", 
+                           viewId = 654321,
+                           linkFilter = TRUE)
+
+# only create the filter, don't apply it to any view - returns filterId for use later
+my_filter <- ga_filter_add(Filter, 
+                           accountId = 12345, 
+                           linkFilter = FALSE)                          
+
+## Other examples of filters you can create below:
+## Create a filter object for making campaign medium lowercase
+Filter <- list(
+               name = 'Lowercase Campaign Medium',
+               type = 'LOWERCASE',
+               lowercaseDetails = list(
+                   field = 'CAMPAIGN_MEDIUM'
+                                    )
+              )
+
+## Create a filter object to append hostname to URI
+Filter <- list(
+               name = 'Append hostname to URI',
+               type = 'ADVANCED',
+               advancedDetails = list(
+                   fieldA = 'PAGE_HOSTNAME',
+                   extractA = '(.*)',
+                   fieldARequired = 'True',
+                   fieldB = 'PAGE_REQUEST_URI',
+                   extractB = '(.*)',
+                   fieldBRequired = 'False',
+                   outputConstructor = '$A1$B1',
+                   outputToField = 'PAGE_REQUEST_URI',
+                   caseSensitive = 'False',
+                   overrideOutputField = 'True'
+                                    )
+              )
+
+## Create a filter object to add www hostname without it
+Filter <- list(
+               name = 'Search and Replace www',
+               type = 'SEARCH_AND_REPLACE',
+               searchAndReplaceDetails = list(
+                   field = 'PAGE_HOSTNAME',
+                   searchString = '^exampleUSA\\.com$',
+                   replaceString = 'www.exampleUSA.com',
+                   caseSensitive = 'False'
+                                    )
+              )
+
+}
+
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_filter_apply_to_view.html b/docs/reference/ga_filter_apply_to_view.html
index 6f66711a..71f41eaa 100644
--- a/docs/reference/ga_filter_apply_to_view.html
+++ b/docs/reference/ga_filter_apply_to_view.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Apply an existing filter to view. — ga_filter_apply_to_view • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Apply an existing filter to view. — ga_filter_apply_to_view • googleAnalyticsR
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Apply an existing filter to view.
    
-    Source: R/filter_management.R
+    Source: R/filter_management.R
     
     
    
 
@@ -295,67 +213,57 @@ 
    Apply an existing filter to view.
    
     
    Apply an existing filter to view.
    
     
    
 
-    
    ga_filter_apply_to_view(filterId, accountId, webPropertyId, viewId)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    filterId
    The id of the filter to be added to profile/view
    accountId
    Account Id of the account that contains the filter
    webPropertyId
    Web property Id to create profile filter link for
    viewId
    Profile/view Id to create profile filter link for
    
-
-    
    Value
    
+    
    
+    
    ga_filter_apply_to_view(filterId, accountId, webPropertyId, viewId)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    filterId
    
+
    The id of the filter to be added to profile/view
    
+
    accountId
    
+
    Account Id of the account that contains the filter
    
+
    webPropertyId
    
+
    Web property Id to create profile filter link for
    
+
    viewId
    
+
    Profile/view Id to create profile filter link for
    
+
    
+    
    
+    
    Value
    
     
    A profileFilterLink object
    
-    
    See also
    
-
-    
    Other managementAPI functions: 
-ga_experiment_list(),
-ga_experiment(),
-ga_filter_add(),
-ga_filter_update_filter_link(),
-ga_filter_update(),
-ga_segment_list()
    
+    
    
+    
    
+    
    See also
    
+    
    Other managementAPI functions: 
+ga_experiment_list(),
+ga_experiment(),
+ga_filter_add(),
+ga_filter_update_filter_link(),
+ga_filter_update(),
+ga_segment_list()
    
+    
    
 
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_filter_delete.html b/docs/reference/ga_filter_delete.html
index a1348aec..e22fc561 100644
--- a/docs/reference/ga_filter_delete.html
+++ b/docs/reference/ga_filter_delete.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Delete a filter from account or remove from view. — ga_filter_delete • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Delete a filter from account or remove from view. — ga_filter_delete • googleAnalyticsR
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Delete a filter from account or remove from view.
    
-    Source: R/filter_management.R
+    Source: R/filter_management.R
     
     
    
 
@@ -295,75 +213,63 @@ 
    Delete a filter from account or remove from view.
    
     
    Delete a filter from account or remove from view.
    
     
    
 
-    
    ga_filter_delete(
-  accountId,
-  webPropertyId = NULL,
-  viewId = NULL,
-  filterId,
-  removeFromView = FALSE
-)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    accountId
    Account Id of the account that contains the filter
    webPropertyId
    Property Id of the property that contains the filter
    viewId
    View Id of the view that contains the filter
    filterId
    Filter Id of the filter to be deleted
    removeFromView
    Default if FALSE. If TRUE, deletes the filter from the view
    
-
-    
    Value
    
+    
    
+    
    ga_filter_delete(
+  accountId,
+  webPropertyId = NULL,
+  viewId = NULL,
+  filterId,
+  removeFromView = FALSE
+)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    accountId
    
+
    Account Id of the account that contains the filter
    
+
    webPropertyId
    
+
    Property Id of the property that contains the filter
    
+
    viewId
    
+
    View Id of the view that contains the filter
    
+
    filterId
    
+
    Filter Id of the filter to be deleted
    
+
    removeFromView
    
+
    Default if FALSE. If TRUE, deletes the filter from the view
    
+
    
+    
    
+    
    Value
    
     
    TRUE if successful
    
-    
    See also
    
-
-    
    Other filter management functions: 
-ga_filter_list(),
-ga_filter_view_list(),
-ga_filter_view(),
-ga_filter()
    
+    
    
+    
    
+    
    See also
    
+    
    Other filter management functions: 
+ga_filter_list(),
+ga_filter_view_list(),
+ga_filter_view(),
+ga_filter()
    
+    
    
 
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_filter_list.html b/docs/reference/ga_filter_list.html
index b0fa3c7f..f2ad2bea 100644
--- a/docs/reference/ga_filter_list.html
+++ b/docs/reference/ga_filter_list.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-List filters for account — ga_filter_list • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-List filters for account — ga_filter_list • googleAnalyticsR
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    List filters for account
    
-    Source: R/filter_management.R
+    Source: R/filter_management.R
     
     
    
 
@@ -295,53 +213,49 @@ 
    List filters for account
    
     
    List filters for account
    
     
    
 
-    
    ga_filter_list(accountId)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
    accountId
    Account Id
    
-
-    
    Value
    
+    
    
+    
    ga_filter_list(accountId)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    accountId
    
+
    Account Id
    
+
    
+    
    
+    
    Value
    
     
    filter list
    
-    
    See also
    
-
-    
    Other filter management functions: 
-ga_filter_delete(),
-ga_filter_view_list(),
-ga_filter_view(),
-ga_filter()
    
+    
    
+    
    
+    
    See also
    
+    
    Other filter management functions: 
+ga_filter_delete(),
+ga_filter_view_list(),
+ga_filter_view(),
+ga_filter()
    
+    
    
 
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_filter_update.html b/docs/reference/ga_filter_update.html
index 92562cd7..86edb8be 100644
--- a/docs/reference/ga_filter_update.html
+++ b/docs/reference/ga_filter_update.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Updates an existing filter. — ga_filter_update • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Updates an existing filter. — ga_filter_update • googleAnalyticsR
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Updates an existing filter.
    
-    Source: R/filter_management.R
+    Source: R/filter_management.R
     
     
    
 
@@ -295,101 +213,93 @@ 
    Updates an existing filter.
    
     
    Updates an existing filter.
    
     
    
 
-    
    ga_filter_update(Filter, accountId, filterId, method = c("PUT", "PATCH"))
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    Filter
    The Filter object to be updated
-See examples from ga_filter_add()
    accountId
    Account Id of the account that contains the filter
    filterId
    The id of the filter to be modified
    method
    PUT by default. For patch semantics use PATCH
    
-
-    
    Value
    
+    
    
+    
    ga_filter_update(Filter, accountId, filterId, method = c("PUT", "PATCH"))
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    Filter
    
+
    The Filter object to be updated
+See examples from ga_filter_add()
    
+
    accountId
    
+
    Account Id of the account that contains the filter
    
+
    filterId
    
+
    The id of the filter to be modified
    
+
    method
    
+
    PUT by default. For patch semantics use PATCH
    
+
    
+    
    
+    
    Value
    
     
    A filterManagement object
    
-    
    See also
    
-
-    
    https://developers.google.com/analytics/devguides/config/mgmt/v3/mgmtReference/#Filters
    
+    
    
+    
    
+    
    See also
    
+    
    https://developers.google.com/analytics/devguides/config/mgmt/v3/mgmtReference/#Filters
    
 
    Other managementAPI functions: 
-ga_experiment_list(),
-ga_experiment(),
-ga_filter_add(),
-ga_filter_apply_to_view(),
-ga_filter_update_filter_link(),
-ga_segment_list()
    
-
-    
    Examples
    
-    
    
-if (FALSE) {
-
-# create a filter object
-Filter <- list(
-    name = 'googleAnalyticsR test1: Exclude Internal Traffic',
-    type = 'EXCLUDE',
-    excludeDetails = list(
-                      field = 'GEO_IP_ADDRESS',
-                      matchType = 'EQUAL',
-                      expressionValue = '199.04.123.1',
-                      caseSensitive = 'False'
-                      )
-                 )
- # add a filter (but don't link to a View)               
- filterId <- ga_filter_add(Filter, 
-                           accountId = 123456, 
-                           linkFilter = FALSE)
- 
- # change the name of the filter                    
- change_name <- "googleAnalyticsR test2: Changed name via PATCH"
- 
- # using PATCH semantics, only need to construct what you want to change
- filter_to_update <- list(name = test_name)
- 
- # update the filter using the filterId 
- ga_filter_update(filter_to_update, accountId2, filterId, method = "PATCH")
-
-}
+ga_experiment_list(),
+ga_experiment(),
+ga_filter_add(),
+ga_filter_apply_to_view(),
+ga_filter_update_filter_link(),
+ga_segment_list()
    
+    
    
 
-
    
+    
    
+    
    Examples
    
+    
    
+if (FALSE) {
+
+# create a filter object
+Filter <- list(
+    name = 'googleAnalyticsR test1: Exclude Internal Traffic',
+    type = 'EXCLUDE',
+    excludeDetails = list(
+                      field = 'GEO_IP_ADDRESS',
+                      matchType = 'EQUAL',
+                      expressionValue = '199.04.123.1',
+                      caseSensitive = 'False'
+                      )
+                 )
+ # add a filter (but don't link to a View)               
+ filterId <- ga_filter_add(Filter, 
+                           accountId = 123456, 
+                           linkFilter = FALSE)
+ 
+ # change the name of the filter                    
+ change_name <- "googleAnalyticsR test2: Changed name via PATCH"
+ 
+ # using PATCH semantics, only need to construct what you want to change
+ filter_to_update <- list(name = test_name)
+ 
+ # update the filter using the filterId 
+ ga_filter_update(filter_to_update, accountId2, filterId, method = "PATCH")
+
+}
+
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_filter_update_filter_link.html b/docs/reference/ga_filter_update_filter_link.html
index 735f2488..c670d92e 100644
--- a/docs/reference/ga_filter_update_filter_link.html
+++ b/docs/reference/ga_filter_update_filter_link.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Update an existing profile filter link. Patch semantics supported — ga_filter_update_filter_link • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Update an existing profile filter link. Patch semantics supported — ga_filter_update_filter_link • googleAnalyticsR
-
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Update an existing profile filter link. Patch semantics supported
    
-    Source: R/filter_management.R
+    Source: R/filter_management.R
     
     
    
 
@@ -295,116 +213,103 @@ 
    Update an existing profile filter link. Patch semantics supported
    
     
    Update an existing profile filter link. Patch semantics supported
    
     
    
 
-    
    ga_filter_update_filter_link(
-  viewFilterLink,
-  accountId,
-  webPropertyId,
-  viewId,
-  linkId,
-  method = c("PUT", "PATCH")
-)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    viewFilterLink
    The profileFilterLink object
    accountId
    Account Id of the account that contains the filter
    webPropertyId
    Web property Id to which the profile filter link belongs
    viewId
    View Id to which the profile filter link belongs
    linkId
    The id of the profile filter link to be updated
    method
    PUT by default. Supports patch semantics when set to PATCH
    
-
-    
    See also
    
+    
    
+    
    ga_filter_update_filter_link(
+  viewFilterLink,
+  accountId,
+  webPropertyId,
+  viewId,
+  linkId,
+  method = c("PUT", "PATCH")
+)
    
+    
    
 
-    
    https://developers.google.com/analytics/devguides/config/mgmt/v3/mgmtReference/management/profileFilterLinks
    
+    
    
+    
    Arguments
    
+    
    viewFilterLink
    
+
    The profileFilterLink object
    
+
    accountId
    
+
    Account Id of the account that contains the filter
    
+
    webPropertyId
    
+
    Web property Id to which the profile filter link belongs
    
+
    viewId
    
+
    View Id to which the profile filter link belongs
    
+
    linkId
    
+
    The id of the profile filter link to be updated
    
+
    method
    
+
    PUT by default. Supports patch semantics when set to PATCH
    
+
    
+    
    
+    
    See also
    
+    
    https://developers.google.com/analytics/devguides/config/mgmt/v3/mgmtReference/management/profileFilterLinks
    
 
    Other managementAPI functions: 
-ga_experiment_list(),
-ga_experiment(),
-ga_filter_add(),
-ga_filter_apply_to_view(),
-ga_filter_update(),
-ga_segment_list()
    
-
-    
    Examples
    
-    
    
-if (FALSE) {
-
-# create a filter object
-Filter <- list(
- name = 'googleAnalyticsR test: Exclude Internal Traffic',
- type = 'EXCLUDE',
- excludeDetails = list(
-   field = 'GEO_IP_ADDRESS',
-   matchType = 'EQUAL',
-   expressionValue = '199.04.123.1',
-   caseSensitive = 'False'
-   )
- )
- 
- # link Filter to a View
- response <- ga_filter_add(Filter, 
-                           accountId = 12345, 
-                           webPropertyId = "UA-12345-1", 
-                           viewId = 654321, 
-                           linkFilter = TRUE)
-                           
-# create Filter patch to move existing filter up to rank 1
-viewFilterLink <- list(rank = 1)
-
-# use the linkId given in response$id to update to new rank 1
-response2 <- ga_filter_update_filter_link(viewFilterLink, 
-                                          accountId = 12345, 
-                                          webPropertyId = "UA-12345-1", 
-                                          viewId = 654321,  
-                                          linkId = response$id)
-
-}
+ga_experiment_list(),
+ga_experiment(),
+ga_filter_add(),
+ga_filter_apply_to_view(),
+ga_filter_update(),
+ga_segment_list()
    
+    
    
 
-
    
+    
    
+    
    Examples
    
+    
    
+if (FALSE) {
+
+# create a filter object
+Filter <- list(
+ name = 'googleAnalyticsR test: Exclude Internal Traffic',
+ type = 'EXCLUDE',
+ excludeDetails = list(
+   field = 'GEO_IP_ADDRESS',
+   matchType = 'EQUAL',
+   expressionValue = '199.04.123.1',
+   caseSensitive = 'False'
+   )
+ )
+ 
+ # link Filter to a View
+ response <- ga_filter_add(Filter, 
+                           accountId = 12345, 
+                           webPropertyId = "UA-12345-1", 
+                           viewId = 654321, 
+                           linkFilter = TRUE)
+                           
+# create Filter patch to move existing filter up to rank 1
+viewFilterLink <- list(rank = 1)
+
+# use the linkId given in response$id to update to new rank 1
+response2 <- ga_filter_update_filter_link(viewFilterLink, 
+                                          accountId = 12345, 
+                                          webPropertyId = "UA-12345-1", 
+                                          viewId = 654321,  
+                                          linkId = response$id)
+
+}
+
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_filter_view.html b/docs/reference/ga_filter_view.html
index 88aa2c53..b64cf7cf 100644
--- a/docs/reference/ga_filter_view.html
+++ b/docs/reference/ga_filter_view.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Get specific filter for view (profile) — ga_filter_view • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Get specific filter for view (profile) — ga_filter_view • googleAnalyticsR
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Get specific filter for view (profile)
    
-    Source: R/filter_management.R
+    Source: R/filter_management.R
     
     
    
 
@@ -295,65 +213,55 @@ 
    Get specific filter for view (profile)
    
     
    Get specific filter for view (profile)
    
     
    
 
-    
    ga_filter_view(accountId, webPropertyId, viewId, linkId)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    accountId
    Account Id
    webPropertyId
    Web Property Id
    viewId
    Profile Id
    linkId
    Link Id
    
-
-    
    Value
    
+    
    
+    
    ga_filter_view(accountId, webPropertyId, viewId, linkId)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    accountId
    
+
    Account Id
    
+
    webPropertyId
    
+
    Web Property Id
    
+
    viewId
    
+
    Profile Id
    
+
    linkId
    
+
    Link Id
    
+
    
+    
    
+    
    Value
    
     
    filter list
    
-    
    See also
    
-
-    
    Other filter management functions: 
-ga_filter_delete(),
-ga_filter_list(),
-ga_filter_view_list(),
-ga_filter()
    
+    
    
+    
    
+    
    See also
    
+    
    Other filter management functions: 
+ga_filter_delete(),
+ga_filter_list(),
+ga_filter_view_list(),
+ga_filter()
    
+    
    
 
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_filter_view_list.html b/docs/reference/ga_filter_view_list.html
index 1d82234b..f814c3c2 100644
--- a/docs/reference/ga_filter_view_list.html
+++ b/docs/reference/ga_filter_view_list.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-List filters for view (profile) — ga_filter_view_list • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-List filters for view (profile) — ga_filter_view_list • googleAnalyticsR
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    List filters for view (profile)
    
-    Source: R/filter_management.R
+    Source: R/filter_management.R
     
     
    
 
@@ -295,61 +213,53 @@ 
    List filters for view (profile)
    
     
    List filters for view (profile)
    
     
    
 
-    
    ga_filter_view_list(accountId, webPropertyId, viewId)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    accountId
    Account Id
    webPropertyId
    Web Property Id
    viewId
    Profile Id
    
-
-    
    Value
    
+    
    
+    
    ga_filter_view_list(accountId, webPropertyId, viewId)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    accountId
    
+
    Account Id
    
+
    webPropertyId
    
+
    Web Property Id
    
+
    viewId
    
+
    Profile Id
    
+
    
+    
    
+    
    Value
    
     
    filter list
    
-    
    See also
    
-
-    
    Other filter management functions: 
-ga_filter_delete(),
-ga_filter_list(),
-ga_filter_view(),
-ga_filter()
    
+    
    
+    
    
+    
    See also
    
+    
    Other filter management functions: 
+ga_filter_delete(),
+ga_filter_list(),
+ga_filter_view(),
+ga_filter()
    
+    
    
 
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_goal.html b/docs/reference/ga_goal.html
index 146673df..6a7061a1 100644
--- a/docs/reference/ga_goal.html
+++ b/docs/reference/ga_goal.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Get goal — ga_goal • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Get goal — ga_goal • googleAnalyticsR
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Get goal
    
-    Source: R/goal_management.R
+    Source: R/goal_management.R
     
     
    
 
@@ -295,64 +213,54 @@ 
    Get goal
    
     
    Get goal
    
     
    
 
-    
    ga_goal(accountId, webPropertyId, profileId, goalId)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    accountId
    Account Id
    webPropertyId
    Web Property Id
    profileId
    Profile Id
    goalId
    Goal Id
    
-
-    
    Value
    
+    
    
+    
    ga_goal(accountId, webPropertyId, profileId, goalId)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    accountId
    
+
    Account Id
    
+
    webPropertyId
    
+
    Web Property Id
    
+
    profileId
    
+
    Profile Id
    
+
    goalId
    
+
    Goal Id
    
+
    
+    
    
+    
    Value
    
     
    Goal meta data
    
-    
    See also
    
-
-    
    Other goal management functions: 
-ga_goal_add(),
-ga_goal_list(),
-ga_goal_update()
    
+    
    
+    
    
+    
    See also
    
+    
    Other goal management functions: 
+ga_goal_add(),
+ga_goal_list(),
+ga_goal_update()
    
+    
    
 
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_goal_add.html b/docs/reference/ga_goal_add.html
index 89c80a61..1783e9f8 100644
--- a/docs/reference/ga_goal_add.html
+++ b/docs/reference/ga_goal_add.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Create a new goal. — ga_goal_add • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Create a new goal. — ga_goal_add • googleAnalyticsR
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Create a new goal.
    
-    Source: R/goal_management.R
+    Source: R/goal_management.R
     
     
    
 
@@ -295,164 +213,156 @@ 
    Create a new goal.
    
     
    Create a new goal.
    
     
    
 
-    
    ga_goal_add(Goal, accountId, webPropertyId, viewId)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    Goal
    The Goal object to be added to the view.  See examples.
    accountId
    Account Id of the account to add the Goal to
    webPropertyId
    Property Id of the property to add the Goal to
    viewId
    View Id of the view to add the Goal to
    
-
-    
    Value
    
+    
    
+    
    ga_goal_add(Goal, accountId, webPropertyId, viewId)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    Goal
    
+
    The Goal object to be added to the view.  See examples.
    
+
    accountId
    
+
    Account Id of the account to add the Goal to
    
+
    webPropertyId
    
+
    Property Id of the property to add the Goal to
    
+
    viewId
    
+
    View Id of the view to add the Goal to
    
+
    
+    
    
+    
    Value
    
     
    The Goal object
    
-    
    See also
    
-
-    
    https://developers.google.com/analytics/devguides/config/mgmt/v3/mgmtReference/#Goals
    
+    
    
+    
    
+    
    See also
    
+    
    https://developers.google.com/analytics/devguides/config/mgmt/v3/mgmtReference/#Goals
    
 
    Other goal management functions: 
-ga_goal_list(),
-ga_goal_update(),
-ga_goal()
    
-
-    
    Examples
    
-    
    
-if (FALSE) {
-
-## Create a Goal object based on destination:
-Goal <- list(
-  id = '17',
-  active = TRUE,
-  name = 'Checkout',
-  type = 'URL_DESTINATION',
-  urlDestinationDetails = list(
-    url = '\\/checkout\\/thank_you',
-    matchType = 'REGEX',
-    caseSensitive = FALSE,
-    firstStepRequired = FALSE,
-    steps = list(
-      list(
-        number = 1,
-        name = 'Product',
-        url = '\\/products\\/'
-      ),
-      list(
-        number = 2,
-        name = 'Cart',
-        url = '\\/cart'
-      ),
-      list(
-        number = 3,
-        name = 'Contact',
-        url = '\\/checkout\\/contact_information'
-      ),
-      list(
-        number = 4,
-        name = 'Shipping',
-        url = '\\/checkout\\/shipping'
-      ),
-      list(
-        number = 5,
-        name = 'Payment',
-        url = '\\/checkout\\/payment'
-      ),
-      list(
-        number = 6,
-        name = 'Processing',
-        url = '\\/checkout\\/processing'
-      )
-    )
-  )
-)
+ga_goal_list(),
+ga_goal_update(),
+ga_goal()
    
+    
    
 
-## Create a Goal object based on an event:
-Goal <- list(
-  id = '9',
-  active = TRUE,
-  name = 'PDF Download',
-  type = 'EVENT',
-  eventDetails = list(
-    useEventValue = TRUE,
-    eventConditions = list(
-      list(
-        type = 'CATEGORY',
-        matchType = 'EXACT',
-        expression = 'PDF Download'
-        ),
-      list(
-        type = 'LABEL',
-        matchType = 'EXACT',
-        expression = 'January brochure'
-        )
-      )
-    )
-  )
-  
-## Create a Goal object based on a number of pages visitied in a session:  
-Goal <- list(
-  id = '10',
-  active = TRUE,
-  name = 'Visited more than 3 pages',
-  type = 'VISIT_NUM_PAGES',
-  visitNumPagesDetails = list(
-    comparisonType = 'GREATER_THAN',
-    comparisonValue = 3
-  )
-)
-  
-## Create a Goal object based on the number of seconds spent on the site  
-Goal <- list(
-  id = '11',
-  active = TRUE,
-  name = 'Stayed for more than 2 minutes',
-  type = 'VISIT_TIME_ON_SITE',
-  visitTimeOnSiteDetails = list(
-    comparisonType = 'GREATER_THAN',
-    comparisonValue = 120
-  )
-)
-}
-  
-
    
+    
    
+    
    Examples
    
+    
    
+if (FALSE) {
+
+## Create a Goal object based on destination:
+Goal <- list(
+  id = '17',
+  active = TRUE,
+  name = 'Checkout',
+  type = 'URL_DESTINATION',
+  urlDestinationDetails = list(
+    url = '\\/checkout\\/thank_you',
+    matchType = 'REGEX',
+    caseSensitive = FALSE,
+    firstStepRequired = FALSE,
+    steps = list(
+      list(
+        number = 1,
+        name = 'Product',
+        url = '\\/products\\/'
+      ),
+      list(
+        number = 2,
+        name = 'Cart',
+        url = '\\/cart'
+      ),
+      list(
+        number = 3,
+        name = 'Contact',
+        url = '\\/checkout\\/contact_information'
+      ),
+      list(
+        number = 4,
+        name = 'Shipping',
+        url = '\\/checkout\\/shipping'
+      ),
+      list(
+        number = 5,
+        name = 'Payment',
+        url = '\\/checkout\\/payment'
+      ),
+      list(
+        number = 6,
+        name = 'Processing',
+        url = '\\/checkout\\/processing'
+      )
+    )
+  )
+)
+
+## Create a Goal object based on an event:
+Goal <- list(
+  id = '9',
+  active = TRUE,
+  name = 'PDF Download',
+  type = 'EVENT',
+  eventDetails = list(
+    useEventValue = TRUE,
+    eventConditions = list(
+      list(
+        type = 'CATEGORY',
+        matchType = 'EXACT',
+        expression = 'PDF Download'
+        ),
+      list(
+        type = 'LABEL',
+        matchType = 'EXACT',
+        expression = 'January brochure'
+        )
+      )
+    )
+  )
+  
+## Create a Goal object based on a number of pages visitied in a session:  
+Goal <- list(
+  id = '10',
+  active = TRUE,
+  name = 'Visited more than 3 pages',
+  type = 'VISIT_NUM_PAGES',
+  visitNumPagesDetails = list(
+    comparisonType = 'GREATER_THAN',
+    comparisonValue = 3
+  )
+)
+  
+## Create a Goal object based on the number of seconds spent on the site  
+Goal <- list(
+  id = '11',
+  active = TRUE,
+  name = 'Stayed for more than 2 minutes',
+  type = 'VISIT_TIME_ON_SITE',
+  visitTimeOnSiteDetails = list(
+    comparisonType = 'GREATER_THAN',
+    comparisonValue = 120
+  )
+)
+}
+  
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_goal_list.html b/docs/reference/ga_goal_list.html
index 62338efe..b4343e46 100644
--- a/docs/reference/ga_goal_list.html
+++ b/docs/reference/ga_goal_list.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-List goals — ga_goal_list • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-List goals — ga_goal_list • googleAnalyticsR
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    List goals
    
-    Source: R/goal_management.R
+    Source: R/goal_management.R
     
     
    
 
@@ -295,60 +213,52 @@ 
    List goals
    
     
    List goals
    
     
    
 
-    
    ga_goal_list(accountId, webPropertyId, profileId)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    accountId
    Account Id
    webPropertyId
    Web Property Id
    profileId
    Profile Id
    
-
-    
    Value
    
+    
    
+    
    ga_goal_list(accountId, webPropertyId, profileId)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    accountId
    
+
    Account Id
    
+
    webPropertyId
    
+
    Web Property Id
    
+
    profileId
    
+
    Profile Id
    
+
    
+    
    
+    
    Value
    
     
    Goal list
    
-    
    See also
    
-
-    
    Other goal management functions: 
-ga_goal_add(),
-ga_goal_update(),
-ga_goal()
    
+    
    
+    
    
+    
    See also
    
+    
    Other goal management functions: 
+ga_goal_add(),
+ga_goal_update(),
+ga_goal()
    
+    
    
 
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_goal_update.html b/docs/reference/ga_goal_update.html
index f91cef23..b201918d 100644
--- a/docs/reference/ga_goal_update.html
+++ b/docs/reference/ga_goal_update.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Updates an existing goal. — ga_goal_update • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Updates an existing goal. — ga_goal_update • googleAnalyticsR
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Updates an existing goal.
    
-    Source: R/goal_management.R
+    Source: R/goal_management.R
     
     
    
 
@@ -295,110 +213,98 @@ 
    Updates an existing goal.
    
     
    Updates an existing goal.
    
     
    
 
-    
    ga_goal_update(
-  Goal,
-  accountId,
-  webPropertyId,
-  viewId,
-  goalId,
-  method = c("PUT", "PATCH")
-)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    Goal
    The Goal object to be updated
-See examples from ga_goal_add()
    accountId
    Account Id of the account in which to modify the Goal
    webPropertyId
    Property Id of the property in which to modify the Goal
    viewId
    View Id of the view in which to modify the Goal
    goalId
    The id of the goal to be modified
    method
    PUT by default. For patch semantics use PATCH
    
-
-    
    Value
    
+    
    
+    
    ga_goal_update(
+  Goal,
+  accountId,
+  webPropertyId,
+  viewId,
+  goalId,
+  method = c("PUT", "PATCH")
+)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    Goal
    
+
    The Goal object to be updated
+See examples from ga_goal_add()
    
+
    accountId
    
+
    Account Id of the account in which to modify the Goal
    
+
    webPropertyId
    
+
    Property Id of the property in which to modify the Goal
    
+
    viewId
    
+
    View Id of the view in which to modify the Goal
    
+
    goalId
    
+
    The id of the goal to be modified
    
+
    method
    
+
    PUT by default. For patch semantics use PATCH
    
+
    
+    
    
+    
    Value
    
     
    A goalManagement object
    
-    
    See also
    
-
-    
    https://developers.google.com/analytics/devguides/config/mgmt/v3/mgmtReference/#Goals
    
+    
    
+    
    
+    
    See also
    
+    
    https://developers.google.com/analytics/devguides/config/mgmt/v3/mgmtReference/#Goals
    
 
    Other goal management functions: 
-ga_goal_add(),
-ga_goal_list(),
-ga_goal()
    
-
-    
    Examples
    
-    
    
-if (FALSE) {
-
-# Change the goal 11 to visits over 3 minutes
-Goal <- list(
-  active = TRUE,
-  name = 'Stayed for more than 3 minutes',
-  type = 'VISIT_TIME_ON_SITE',
-  visitTimeOnSiteDetails = list(
-    comparisonType = 'GREATER_THAN',
-    comparisonValue = 180
-  )
-)
-ga_goal_update(Goal, accountId, propertyId, viewId, 11)
-
-# Change destination url for goal 17
-Goal <- list(
-    urlDestinationDetails = list(
-      url = '\\/checkout\\/success'
-    )
-  )
+ga_goal_add(),
+ga_goal_list(),
+ga_goal()
    
+    
    
 
-# Only the fields we're changing required because we're using PATCH method  
-ga_goal_update(Goal, accountId, propertyId, viewId, 17, method = "PATCH")
-  
-}
-  
-
    
+    
    
+    
    Examples
    
+    
    
+if (FALSE) {
+
+# Change the goal 11 to visits over 3 minutes
+Goal <- list(
+  active = TRUE,
+  name = 'Stayed for more than 3 minutes',
+  type = 'VISIT_TIME_ON_SITE',
+  visitTimeOnSiteDetails = list(
+    comparisonType = 'GREATER_THAN',
+    comparisonValue = 180
+  )
+)
+ga_goal_update(Goal, accountId, propertyId, viewId, 11)
+
+# Change destination url for goal 17
+Goal <- list(
+    urlDestinationDetails = list(
+      url = '\\/checkout\\/success'
+    )
+  )
+
+# Only the fields we're changing required because we're using PATCH method  
+ga_goal_update(Goal, accountId, propertyId, viewId, 17, method = "PATCH")
+  
+}
+  
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_meta.html b/docs/reference/ga_meta.html
index ff2da605..c48c69b7 100644
--- a/docs/reference/ga_meta.html
+++ b/docs/reference/ga_meta.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Get current dimensions and metrics available in GA API. — ga_meta • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Get current dimensions and metrics available in GA API. — ga_meta • googleAnalyticsR
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Get current dimensions and metrics available in GA API.
    
-    Source: R/meta.R
+    Source: R/meta.R
     
     
    
 
@@ -295,81 +213,73 @@ 
    Get current dimensions and metrics available in GA API.
    
     
    Get current dimensions and metrics available in GA API.
    
     
    
 
-    
    ga_meta(
-  version = c("universal", "data"),
-  propertyId = NULL,
-  cached = TRUE,
-  no_api = FALSE
-)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    version
    The Google Analytics API metadata to fetch - "universal" for Universal and earlier versions, "data" for Google Analytics 4
    propertyId
    If requesting from Google Analytics 4, pass the propertyId to get metadata specific to that property.  Leaving it NULL or 0 will return universal metadata
    cached
    Whether to use a cached version or to use the API to fetch the results again
    no_api
    Don't call the API, just return googleAnalyticsR::meta4
    
-
-    
    Value
    
+    
    
+    
    ga_meta(
+  version = c("universal", "data"),
+  propertyId = NULL,
+  cached = TRUE,
+  no_api = FALSE
+)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    version
    
+
    The Google Analytics API metadata to fetch - "universal" for Universal and earlier versions, "data" for Google Analytics 4
    
+
    propertyId
    
+
    If requesting from Google Analytics 4, pass the propertyId to get metadata specific to that property.  Leaving it NULL or 0 will return universal metadata
    
+
    cached
    
+
    Whether to use a cached version or to use the API to fetch the results again
    
+
    no_api
    
+
    Don't call the API, just return googleAnalyticsR::meta4
    
+
    
+    
    
+    
    Value
    
     
    dataframe of dimensions and metrics available to use
    
-    
    See also
    
-
-    
    https://developers.google.com/analytics/devguides/reporting/metadata/v3/reference/metadata/columns/list, https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1alpha/properties/getMetadata
    
-
-    
    Examples
    
-    
    
-if (FALSE) {
-
-# universal analytics
-ga_meta()
-
-# Google Analytics 4 metadata from the Data API
-ga_meta("data")
-
-# Google Analytics 4 metadata for a particular Web Property
-ga_meta("data", propertyId = 206670707)
+    
    
+    
 
-}
-
    
+    
    
+    
    Examples
    
+    
    
+if (FALSE) {
+
+# universal analytics
+ga_meta()
+
+# Google Analytics 4 metadata from the Data API
+ga_meta("data")
+
+# Google Analytics 4 metadata for a particular Web Property
+ga_meta("data", propertyId = 206670707)
+
+}
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_model.html b/docs/reference/ga_model.html
index b12ece48..2d844d3e 100644
--- a/docs/reference/ga_model.html
+++ b/docs/reference/ga_model.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Use a model — ga_model • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Use a model — ga_model • googleAnalyticsR
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Use a model
    
-    Source: R/models.R
+    Source: R/models.R
     
     
    
 
     
    
-    
    Use a model created by ga_model_make
    
+    
    Use a model created by ga_model_make
    
     
    
 
-    
    ga_model(viewId, model, load_libs = TRUE, ...)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    viewId
    The GA viewId to operate on
    model
    A file location of a model object or a model object
-created by ga_model_make
    load_libs
    Whether to load the library requirements into your namespace
    ...
    Other arguments to pass into the model as needed
    
-
-    
    See also
    
-
-    
    Other GA modelling functions: 
-ga_model_edit(),
-ga_model_example(),
-ga_model_load(),
-ga_model_make(),
-ga_model_save(),
-ga_model_shiny_load(),
-ga_model_shiny_template(),
-ga_model_shiny(),
-ga_model_write()
    
-
-    
    Examples
    
-    
    
-# models that come with the package
-ga_model_example()
-
    #> [1] "decomp_ga_advanced.gamr" "decomp_ga.gamr"         
-#> [3] "ga-effect.gamr"          "ga4-trend.gamr"         
-#> [5] "market-basket.gamr"      "time-normalised.gamr"   
    if (FALSE) {
-
-# your own Google Analytics viewID
-my_viewid <- 81416156
-
-# load the model (equivalent to ga_model_load())
-decomp_ga <- ga_model_example("decomp_ga.gamr")
-
-# apply model to your data
-d1 <- ga_model(my_viewid, model = decomp_ga)
-
-# change default date range to 20 days ago to yesterday
-d2 <- ga_model(my_viewid, model = decomp_ga, 
-               date_range = c("20daysAgo","yesterday"))
+    
    
+    
    ga_model(viewId, model, load_libs = TRUE, ...)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    viewId
    
+
    The GA viewId to operate on
    
+
    model
    
+
    A file location of a model object or a model object
+created by ga_model_make
    
+
    load_libs
    
+
    Whether to load the library requirements into your namespace
    
+
    ...
    
+
    Other arguments to pass into the model as needed
    
+
    
+    
 
-}
-
    
+    
    
+    
    Examples
    
+    
    
+# models that come with the package
+ga_model_example()
+#> [1] "decomp_ga.gamr"          "decomp_ga_advanced.gamr"
+#> [3] "ga-effect.gamr"          "ga4-trend.gamr"         
+#> [5] "market-basket.gamr"      "time-normalised.gamr"   
+if (FALSE) {
+
+# your own Google Analytics viewID
+my_viewid <- 81416156
+
+# load the model (equivalent to ga_model_load())
+decomp_ga <- ga_model_example("decomp_ga.gamr")
+
+# apply model to your data
+d1 <- ga_model(my_viewid, model = decomp_ga)
+
+# change default date range to 20 days ago to yesterday
+d2 <- ga_model(my_viewid, model = decomp_ga, 
+               date_range = c("20daysAgo","yesterday"))
+
+
+}
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_model_edit.html b/docs/reference/ga_model_edit.html
index e7f77807..cc72f99d 100644
--- a/docs/reference/ga_model_edit.html
+++ b/docs/reference/ga_model_edit.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Edit a created ga_model — ga_model_edit • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Edit a created ga_model — ga_model_edit • googleAnalyticsR
-
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Edit a created ga_model
    
-    Source: R/models.R
+    Source: R/models.R
     
     
    
 
@@ -295,116 +213,95 @@ 
    Edit a created ga_model
    
     
    Change features of a model by changing the functions within it.
    
     
    
 
-    
    ga_model_edit(
-  model,
-  data_f = NULL,
-  required_columns = NULL,
-  model_f = NULL,
-  required_packages = NULL,
-  description = NULL,
-  outputShiny = shiny::plotOutput,
-  renderShiny = shiny::renderPlot,
-  inputShiny = NULL,
-  output_f = NULL
-)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    model
    The model to edit - if a filepath will load model and
-save back edited model to the same file
    data_f
    A function that gets the data
    required_columns
    What dimensions and metrics are required
    model_f
    A function that inputs data, and outputs a list of assets -
-must take data from result of data_f in first argument
    required_packages
    The packages needed for data_f and model_f to work
    description
    An optional description of what the model does
    outputShiny
    A shiny UI output function that will display the results renderShiny
    renderShiny
    A shiny render function that will create the output for outputShiny from output_f
    inputShiny
    Optional input shiny functions (like dateInput()) that will be used within the model's Shiny module.  The id should be exactly the same as one of the variables in the model functions.
    output_f
    A function that inputs the output from model_f, outputs a visualisation
    
-
-    
    See also
    
-
-    
    Other GA modelling functions: 
-ga_model_example(),
-ga_model_load(),
-ga_model_make(),
-ga_model_save(),
-ga_model_shiny_load(),
-ga_model_shiny_template(),
-ga_model_shiny(),
-ga_model_write(),
-ga_model()
    
-
-    
    Examples
    
-    
    
-if (FALSE) {
-
-decomp_ga <- ga_model_example("decomp_ga.gamr")
-decomp_ga
+    
    
+    
    ga_model_edit(
+  model,
+  data_f = NULL,
+  required_columns = NULL,
+  model_f = NULL,
+  required_packages = NULL,
+  description = NULL,
+  outputShiny = shiny::plotOutput,
+  renderShiny = shiny::renderPlot,
+  inputShiny = NULL,
+  output_f = NULL
+)
    
+    
    
 
-# edit its description
-ga_model_edit(decomp_ga, description = "Changed")
+    
    
+    
    Arguments
    
+    
    model
    
+
    The model to edit - if a filepath will load model and
+save back edited model to the same file
    
+
    data_f
    
+
    A function that gets the data
    
+
    required_columns
    
+
    What dimensions and metrics are required
    
+
    model_f
    
+
    A function that inputs data, and outputs a list of assets -
+must take data from result of data_f in first argument
    
+
    required_packages
    
+
    The packages needed for data_f and model_f to work
    
+
    description
    
+
    An optional description of what the model does
    
+
    outputShiny
    
+
    A shiny UI output function that will display the results renderShiny
    
+
    renderShiny
    
+
    A shiny render function that will create the output for outputShiny from output_f
    
+
    inputShiny
    
+
    Optional input shiny functions (like dateInput()) that will be used within the model's Shiny module.  The id should be exactly the same as one of the variables in the model functions.
    
+
    output_f
    
+
    A function that inputs the output from model_f, outputs a visualisation
    
+
    
+    
    
+    
    See also
    
+    
    Other GA modelling functions: 
+ga_model_example(),
+ga_model_load(),
+ga_model_make(),
+ga_model_save(),
+ga_model_shiny_load(),
+ga_model_shiny_template(),
+ga_model_shiny(),
+ga_model_write(),
+ga_model()
    
+    
    
 
-}
-
    
+    
    
+    
    Examples
    
+    
    
+if (FALSE) {
+
+decomp_ga <- ga_model_example("decomp_ga.gamr")
+decomp_ga
+
+# edit its description
+ga_model_edit(decomp_ga, description = "Changed")
+
+}
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_model_example.html b/docs/reference/ga_model_example.html
index e64e0476..1b259461 100644
--- a/docs/reference/ga_model_example.html
+++ b/docs/reference/ga_model_example.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Load an example model — ga_model_example • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Load an example model — ga_model_example • googleAnalyticsR
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Load an example model
    
-    Source: R/models.R
+    Source: R/models.R
     
     
    
 
@@ -295,71 +213,70 @@ 
    Load an example model
    
     
    Load an example model
    
     
    
 
-    
    ga_model_example(name = "list")
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
    name
    name of the model - set to "list" to show available files
    
-
-    
    See also
    
+    
    
+    
    ga_model_example(name = "list")
    
+    
    
 
-    
    Other GA modelling functions: 
-ga_model_edit(),
-ga_model_load(),
-ga_model_make(),
-ga_model_save(),
-ga_model_shiny_load(),
-ga_model_shiny_template(),
-ga_model_shiny(),
-ga_model_write(),
-ga_model()
    
+    
    
+    
    Arguments
    
+    
    name
    
+
    name of the model - set to "list" to show available files
    
+
    
+    
    
+    
    See also
    
+    
    Other GA modelling functions: 
+ga_model_edit(),
+ga_model_load(),
+ga_model_make(),
+ga_model_save(),
+ga_model_shiny_load(),
+ga_model_shiny_template(),
+ga_model_shiny(),
+ga_model_write(),
+ga_model()
    
+    
    
 
-    
    Examples
    
-    
    
-# example .gamr files included with the package
-ga_model_example()
-
    #> [1] "decomp_ga_advanced.gamr" "decomp_ga.gamr"         
-#> [3] "ga-effect.gamr"          "ga4-trend.gamr"         
-#> [5] "market-basket.gamr"      "time-normalised.gamr"   
    
-# load one example
-ga_model_example("ga4-trend.gamr")
-
    #> ==ga_model object==
-#> Description:  GA4 Metric Trend 
-#> Data args:    view_id date_range metrics 
-#> Input data:   date 
-#> Model args:   df 
-#> Output args:  df 
-#> Packages:     xts dygraphs 
    
+    
    
+    
    Examples
    
+    
    
+# example .gamr files included with the package
+ga_model_example()
+#> [1] "decomp_ga.gamr"          "decomp_ga_advanced.gamr"
+#> [3] "ga-effect.gamr"          "ga4-trend.gamr"         
+#> [5] "market-basket.gamr"      "time-normalised.gamr"   
+
+# load one example
+ga_model_example("ga4-trend.gamr")
+#> ==ga_model object==
+#> Description:  GA4 Metric Trend 
+#> Data args:    view_id date_range metrics 
+#> Input data:   date 
+#> Model args:   df 
+#> Output args:  df 
+#> Packages:     xts dygraphs 
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_model_load.html b/docs/reference/ga_model_load.html
index de08b789..dbfbd858 100644
--- a/docs/reference/ga_model_load.html
+++ b/docs/reference/ga_model_load.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Load a created model — ga_model_load • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Load a created model — ga_model_load • googleAnalyticsR
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Load a created model
    
-    Source: R/models.R
+    Source: R/models.R
     
     
    
 
@@ -295,69 +213,67 @@ 
    Load a created model
    
     
    Load a created model
    
     
    
 
-    
    ga_model_load(filename = "my-model.gamr")
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
    filename
    name to load model from
    
-
-    
    See also
    
-
-    
    Other GA modelling functions: 
-ga_model_edit(),
-ga_model_example(),
-ga_model_make(),
-ga_model_save(),
-ga_model_shiny_load(),
-ga_model_shiny_template(),
-ga_model_shiny(),
-ga_model_write(),
-ga_model()
    
+    
    
+    
    ga_model_load(filename = "my-model.gamr")
    
+    
    
 
-    
    Examples
    
-    
    
-# models used in ga_model_example() are here:
-location <- system.file("models","examples","decomp_ga.gamr", 
-                        package = "googleAnalyticsR")
+    
    
+    
    Arguments
    
+    
    filename
    
+
    name to load model from
    
+
    
+    
    
+    
    See also
    
+    
    Other GA modelling functions: 
+ga_model_edit(),
+ga_model_example(),
+ga_model_make(),
+ga_model_save(),
+ga_model_shiny_load(),
+ga_model_shiny_template(),
+ga_model_shiny(),
+ga_model_write(),
+ga_model()
    
+    
    
 
-ga_model_load(location)
-
    #> ==ga_model object==
-#> Description:  Perform decomposition on your GA sessions 
-#> Data args:    view_id date_range 
-#> Input data:   date sessions 
-#> Model args:   df 
-#> Output args:  df 
-#> Packages:     googleAnalyticsR 
    
+    
    
+    
    Examples
    
+    
    
+# models used in ga_model_example() are here:
+location <- system.file("models","examples","decomp_ga.gamr", 
+                        package = "googleAnalyticsR")
+
+ga_model_load(location)
+#> ==ga_model object==
+#> Description:  Perform decomposition on your GA sessions 
+#> Data args:    view_id date_range 
+#> Input data:   date sessions 
+#> Model args:   df 
+#> Output args:  df 
+#> Packages:     googleAnalyticsR 
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_model_make.html b/docs/reference/ga_model_make.html
index 330efca7..168d3c22 100644
--- a/docs/reference/ga_model_make.html
+++ b/docs/reference/ga_model_make.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Modelling function factory for Google Analytics data — ga_model_make • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Modelling function factory for Google Analytics data — ga_model_make • googleAnalyticsR
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Modelling function factory for Google Analytics data
    
-    Source: R/models.R
+    Source: R/models.R
     
     
    
 
@@ -295,155 +213,138 @@ 
    Modelling function factory for Google Analytics data
    
     
    Create ga_model objects for easy application of models to data
    
     
    
 
-    
    ga_model_make(
-  data_f,
-  required_columns,
-  model_f,
-  output_f = function(df, ...) {     plot(df) },
-  required_packages = NULL,
-  description = NULL,
-  outputShiny = shiny::plotOutput,
-  renderShiny = shiny::renderPlot,
-  inputShiny = shiny::tagList()
-)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    data_f
    A function that gets the data
    required_columns
    What dimensions and metrics are required
    model_f
    A function that inputs data, and outputs a list of assets -
-must take data from result of data_f in first argument
    output_f
    A function that inputs the output from model_f, outputs a visualisation
    required_packages
    The packages needed for data_f and model_f to work
    description
    An optional description of what the model does
    outputShiny
    A shiny UI output function that will display the results renderShiny
    renderShiny
    A shiny render function that will create the output for outputShiny from output_f
    inputShiny
    Optional input shiny functions (like dateInput()) that will be used within the model's Shiny module.  The id should be exactly the same as one of the variables in the model functions.
    
-
-    
    Value
    
-
-    
    A ga_model object to pass to ga_model
    
-    
    Details
    
+    
    
+    
    ga_model_make(
+  data_f,
+  required_columns,
+  model_f,
+  output_f = function(df, ...) {     plot(df) },
+  required_packages = NULL,
+  description = NULL,
+  outputShiny = shiny::plotOutput,
+  renderShiny = shiny::renderPlot,
+  inputShiny = shiny::tagList()
+)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    data_f
    
+
    A function that gets the data
    
+
    required_columns
    
+
    What dimensions and metrics are required
    
+
    model_f
    
+
    A function that inputs data, and outputs a list of assets -
+must take data from result of data_f in first argument
    
+
    output_f
    
+
    A function that inputs the output from model_f, outputs a visualisation
    
+
    required_packages
    
+
    The packages needed for data_f and model_f to work
    
+
    description
    
+
    An optional description of what the model does
    
+
    outputShiny
    
+
    A shiny UI output function that will display the results renderShiny
    
+
    renderShiny
    
+
    A shiny render function that will create the output for outputShiny from output_f
    
+
    inputShiny
    
+
    Optional input shiny functions (like dateInput()) that will be used within the model's Shiny module.  The id should be exactly the same as one of the variables in the model functions.
    
+
    
+    
    
+    
    Value
    
+    
    A ga_model object to pass to ga_model
    
+    
    
+    
    
+    
    Details
    
     
    The passed functions should all have ... to make them flexible
 in what arguments can be added.  Do not have the same argument names in both functions.
 The data_f function result will feed to model_f
    
-    
    See also
    
-
-    
    Other GA modelling functions: 
-ga_model_edit(),
-ga_model_example(),
-ga_model_load(),
-ga_model_save(),
-ga_model_shiny_load(),
-ga_model_shiny_template(),
-ga_model_shiny(),
-ga_model_write(),
-ga_model()
    
-
-    
    Examples
    
-    
    
-if (FALSE) {
-
- get_model_data <- function(viewId,
-                           date_range = c(Sys.Date()- 300, Sys.Date()),
-                           ...){
-   google_analytics(viewId,
-                    date_range = date_range,
-                    metrics = "sessions",
-                    dimensions = "date",
-                    max = -1)
- }
-
- decompose_sessions <- function(df, ...){
-   decompose(ts(df$sessions, frequency = 7))
- }
-
- decomp_ga <- ga_model_make(get_model_data,
-                            required_columns = c("date", "sessions"),
-                            model_f = decompose_sessions,
-                            description = "Performs decomposition and creates plot")
-
- # fetches data and outputs decomposition
- ga_model(81416156, decomp_ga)
-
- # save the model for later
- model_location <- "decomp_ga.gamr"
- ga_model_save(decomp_ga, filename = model_location)
-
- # can load model from file
- ga_model(81416156, model_location)
-
- # or load model to an object and use 
- model2 <- ga_model_load(model_location)
-
- ga_model(81416156, model2)
- 
- # for shiny include functions for the UI and server rendering
- decomp_ga <- ga_model_make(get_model_data,
-                            required_columns = c("date", "sessions"),
-                            model_f = decompose_sessions,
-                            output_f = function(df, ...){graphics::plot(df)},
-                            description = "Performs decomposition and creates a plot",
-                            outputShiny = shiny::plotOutput,
-                            renderShiny = shiny::renderPlot)
+    
    
+    
    
+    
    See also
    
+    
    Other GA modelling functions: 
+ga_model_edit(),
+ga_model_example(),
+ga_model_load(),
+ga_model_save(),
+ga_model_shiny_load(),
+ga_model_shiny_template(),
+ga_model_shiny(),
+ga_model_write(),
+ga_model()
    
+    
    
 
-}
-
    
+    
    
+    
    Examples
    
+    
    
+if (FALSE) {
+
+ get_model_data <- function(viewId,
+                           date_range = c(Sys.Date()- 300, Sys.Date()),
+                           ...){
+   google_analytics(viewId,
+                    date_range = date_range,
+                    metrics = "sessions",
+                    dimensions = "date",
+                    max = -1)
+ }
+
+ decompose_sessions <- function(df, ...){
+   decompose(ts(df$sessions, frequency = 7))
+ }
+
+ decomp_ga <- ga_model_make(get_model_data,
+                            required_columns = c("date", "sessions"),
+                            model_f = decompose_sessions,
+                            description = "Performs decomposition and creates plot")
+
+ # fetches data and outputs decomposition
+ ga_model(81416156, decomp_ga)
+
+ # save the model for later
+ model_location <- "decomp_ga.gamr"
+ ga_model_save(decomp_ga, filename = model_location)
+
+ # can load model from file
+ ga_model(81416156, model_location)
+
+ # or load model to an object and use 
+ model2 <- ga_model_load(model_location)
+
+ ga_model(81416156, model2)
+ 
+ # for shiny include functions for the UI and server rendering
+ decomp_ga <- ga_model_make(get_model_data,
+                            required_columns = c("date", "sessions"),
+                            model_f = decompose_sessions,
+                            output_f = function(df, ...){graphics::plot(df)},
+                            description = "Performs decomposition and creates a plot",
+                            outputShiny = shiny::plotOutput,
+                            renderShiny = shiny::renderPlot)
+
+}
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_model_refresh.html b/docs/reference/ga_model_refresh.html
index ee010df7..a4673f26 100644
--- a/docs/reference/ga_model_refresh.html
+++ b/docs/reference/ga_model_refresh.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Refresh a model — ga_model_refresh • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Refresh a model — ga_model_refresh • googleAnalyticsR
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Refresh a model
    
-    Source: R/models.R
+    Source: R/models.R
     
     
    
 
@@ -295,52 +213,48 @@ 
    Refresh a model
    
     
    Sometimes necessary if functions were created under differing package versions
    
     
    
 
-    
    ga_model_refresh(model)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
    model
    Model or file location of model .gamr file
    
-
-
-    
    Examples
    
-    
    
-if (FALSE) {
-
-decomp_ga <- ga_model_example("decomp_ga.gamr")
-decomp_ga <- ga_model_refresh(decomp_ga)
+    
    
+    
    ga_model_refresh(model)
    
+    
    
 
-}
-
    
+    
    
+    
    Arguments
    
+    
    model
    
+
    Model or file location of model .gamr file
    
+
    
+
+    
    
+    
    Examples
    
+    
    
+if (FALSE) {
+
+decomp_ga <- ga_model_example("decomp_ga.gamr")
+decomp_ga <- ga_model_refresh(decomp_ga)
+
+}
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_model_save.html b/docs/reference/ga_model_save.html
index 832c6942..d768712e 100644
--- a/docs/reference/ga_model_save.html
+++ b/docs/reference/ga_model_save.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Save a created model — ga_model_save • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Save a created model — ga_model_save • googleAnalyticsR
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Save a created model
    
-    Source: R/models.R
+    Source: R/models.R
     
     
    
 
@@ -295,70 +213,65 @@ 
    Save a created model
    
     
    Save a created model
    
     
    
 
-    
    ga_model_save(model, filename = "my-model.gamr")
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    model
    model to save
    filename
    name to save model under
    
-
-    
    See also
    
-
-    
    Other GA modelling functions: 
-ga_model_edit(),
-ga_model_example(),
-ga_model_load(),
-ga_model_make(),
-ga_model_shiny_load(),
-ga_model_shiny_template(),
-ga_model_shiny(),
-ga_model_write(),
-ga_model()
    
-
-    
    Examples
    
-    
    
-if (FALSE) {
-# load the model (equivalent to ga_model_load())
-decomp_ga <- ga_model_example("decomp_ga.gamr")
+    
    
+    
    ga_model_save(model, filename = "my-model.gamr")
    
+    
    
 
-# save it somewhere else
-ga_model_save(decomp_ga, "somewhereelse.gamr")
+    
    
+    
    Arguments
    
+    
    model
    
+
    model to save
    
+
    filename
    
+
    name to save model under
    
+
    
+    
    
+    
    See also
    
+    
    Other GA modelling functions: 
+ga_model_edit(),
+ga_model_example(),
+ga_model_load(),
+ga_model_make(),
+ga_model_shiny_load(),
+ga_model_shiny_template(),
+ga_model_shiny(),
+ga_model_write(),
+ga_model()
    
+    
    
 
-}
-
    
+    
    
+    
    Examples
    
+    
    
+if (FALSE) {
+# load the model (equivalent to ga_model_load())
+decomp_ga <- ga_model_example("decomp_ga.gamr")
+
+# save it somewhere else
+ga_model_save(decomp_ga, "somewhereelse.gamr")
+
+}
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_model_shiny.html b/docs/reference/ga_model_shiny.html
index d876f233..f0fdce71 100644
--- a/docs/reference/ga_model_shiny.html
+++ b/docs/reference/ga_model_shiny.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Create a Shiny app from a ga_model file — ga_model_shiny • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Create a Shiny app from a ga_model file — ga_model_shiny • googleAnalyticsR
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Create a Shiny app from a ga_model file
    
-    Source: R/model_shiny_templates.R
+    Source: R/model_shiny_templates.R
     
     
    
 
@@ -295,277 +213,256 @@ 
    Create a Shiny app from a ga_model file
    
     
    Create a Shiny app from a ga_model file
    
     
    
 
-    
    ga_model_shiny(
-  models,
-  template = ga_model_shiny_template("basic"),
-  header_boilerplate = TRUE,
-  title = "ga_model_shiny",
-  auth_dropdown = c("ga4", "universal", "none"),
-  web_json = Sys.getenv("GAR_CLIENT_WEB_JSON"),
-  date_range = TRUE,
-  scopes = "https://www.googleapis.com/auth/analytics.readonly",
-  deployed_url = "",
-  local_folder = "",
-  ...
-)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    models
    The ga_model file location ("my_model.gamr") or a ga_model object - can pass in multiple as a list
    template
    The template Shiny files for the Shiny app - passed to shiny::runApp()
    header_boilerplate
    Whether to add header boilerplate to the template
    title
    The title of the Shiny app
    auth_dropdown
    What type of account picker to include
    web_json
    The client.id json file for Web
    date_range
    Most templates support a  date_range  global input for the data import functions, set this to FALSE to remove it
    scopes
    The scope the API requests will be under
    deployed_url
    If deploying Shiny app to a server, put the URL of the deployed app here so the authentication will redirect to the correct place
    local_folder
    If not empty, will not launch Shiny app but write code to the folder location you put here
    ...
    Extra macro variables the template may support: a named list with the name being a template variable
    
-
-    
    Details
    
+    
    
+    
    ga_model_shiny(
+  models,
+  template = ga_model_shiny_template("basic"),
+  header_boilerplate = TRUE,
+  title = "ga_model_shiny",
+  auth_dropdown = c("ga4", "universal", "none"),
+  web_json = Sys.getenv("GAR_CLIENT_WEB_JSON"),
+  date_range = TRUE,
+  scopes = "https://www.googleapis.com/auth/analytics.readonly",
+  deployed_url = "",
+  local_folder = "",
+  ...
+)
    
+    
    
 
-    
    As ga_model objects have standardised code, they can be used to build standard templated Shiny apps.  Templates are made using the whisker.render function
    
-
    Some templates are included with the package, seen via ga_model_shiny_template("list")
    
-
    Templates hold macro variables indicated via  {{ macro_name }}  in the Shiny app template code. See ga_model_shiny_template("basic_app", TRUE) for an example showing a minimal viable app.  Templates can be files such as ui.R or app.R files; folders containing ui.R, app.R files; or ui.R with html files for advanced themes - see Shiny HTML templates. All additional files that may be in the folder are also copied over (such as global.R or www/ folders)
    
+    
    
+    
    Arguments
    
+    
    models
    
+
    The ga_model file location ("my_model.gamr") or a ga_model object - can pass in multiple as a list
    
+
    template
    
+
    The template Shiny files for the Shiny app - passed to shiny::runApp()
    
+
    header_boilerplate
    
+
    Whether to add header boilerplate to the template
    
+
    title
    
+
    The title of the Shiny app
    
+
    auth_dropdown
    
+
    What type of account picker to include
    
+
    web_json
    
+
    The client.id json file for Web
    
+
    date_range
    
+
    Most templates support a  date_range  global input for the data import functions, set this to FALSE to remove it
    
+
    scopes
    
+
    The scope the API requests will be under
    
+
    deployed_url
    
+
    If deploying Shiny app to a server, put the URL of the deployed app here so the authentication will redirect to the correct place
    
+
    local_folder
    
+
    If not empty, will not launch Shiny app but write code to the folder location you put here
    
+
    ...
    
+
    Extra macro variables the template may support: a named list with the name being a template variable
    
+
    
+    
    
+    
    Details
    
+    
    As ga_model objects have standardised code, they can be used to build standard templated Shiny apps.  Templates are made using the whisker.render function
    
+
    Some templates are included with the package, seen via ga_model_shiny_template("list")
    
+
    Templates hold macro variables indicated via  {{ macro_name }}  in the Shiny app template code. See ga_model_shiny_template("basic_app", TRUE) for an example showing a minimal viable app.  Templates can be files such as ui.R or app.R files; folders containing ui.R, app.R files; or ui.R with html files for advanced themes - see Shiny HTML templates. All additional files that may be in the folder are also copied over (such as global.R or www/ folders)
    
 
    Templates contain code to allow multi-user login via Google OAuth2.
    
-
    If your template is pointing at a file such as ui.R or app.R it will create an app.R Shiny object.  If your template is pointing at a directory it will check for the presence of ui.R within the folder.  In either case if the server.R is missing it will use the boilerplate version from ga_model_shiny_template("boilerplate")
    
+
    If your template is pointing at a file such as ui.R or app.R it will create an app.R Shiny object.  If your template is pointing at a directory it will check for the presence of ui.R within the folder.  In either case if the server.R is missing it will use the boilerplate version from ga_model_shiny_template("boilerplate")
    
 
    By default the Shiny app is launched which in most cases will prompt authorisation for your Google Analytics.  You can instead write the app out using local_folder to a valid location for deployment later.
    
-    
    Template macro variables
    
-
+    
    
+    
    
+    
    Template macro variables
    
     
 
 
-
      
-
    • {{{ model_libraries }}}- Adds library() calls based on models$required_packages
      • 
+
      • {{{ model_libraries }}}- Adds library() calls based on models$required_packages
        • 
 
      • {{{ web_json }}}- Adds Google OAuth2 client for web applications
        • 
 
      • {{{ scopes }}}- Adds Google OAuth2 scopes for the API calls
        • 
-
      • {{{ deployed_url }}}- Adds option(googleAuthR.redirect) option for deployed Shiny apps
        • 
-
      • {{{ model_load }}}- Adds ga_model_load calls loading all models in the list passed to this function's models argument.  It creates R objects called 'model1', 'model2' etc. in the Shiny app code
        • 
+
      • {{{ deployed_url }}}- Adds option(googleAuthR.redirect) option for deployed Shiny apps
        • 
+
      • {{{ model_load }}}- Adds ga_model_load calls loading all models in the list passed to this function's models argument.  It creates R objects called 'model1', 'model2' etc. in the Shiny app code
        • 
 
      • {{{ model_list }}}- Adds a list of the model objects after model_load.  Useful for creating custom functions in themes that can loop over model objects
        • 
 
      • {{{ shiny_title }}}- Adds the title to the Shiny app
        • 
 
      • {{{ auth_ui }}}- Adds the correct dropdown Shiny module for picking a GA4 or Universal Analytics properties
        • 
-
      • {{{ date_range }}}- Adds a shiny::dateInput() date selector with id "date_range" for use in model's data fetching functions
        • 
-
      • {{{ model_ui }}}- Adds the models UI elements as configured in the ga_model object.  It uses the object loaded above via the model_load macro.  It looks like model1$ui('model1') in the code.
        • 
+
      • {{{ date_range }}}- Adds a shiny::dateInput() date selector with id "date_range" for use in model's data fetching functions
        • 
+
      • {{{ model_ui }}}- Adds the models UI elements as configured in the ga_model object.  It uses the object loaded above via the model_load macro.  It looks like model1$ui('model1') in the code.
        • 
 
      • {{{ auth_server }}}- Adds the authentication module's server side function
        • 
-
      • {{{ auth_accounts }}}- Adds a call to ga_account_list for the appropriate GA account type (GA4 or Universal)
        • 
-
      • {{{ model_server }}}- Adds the server side module for the models as configured in the ga_model configuration. It uses the object loaded above via the model_load macro.  It looks like model1$server('model1') in the code.
        • 
-
      • {{{ model1 }}}- Alternative to model_load, this will load the model file location instead, which you can pass to ga_model_load() in the template.  model1 is the first model passed, model2 the second, etc.
        • 
+
      • {{{ auth_accounts }}}- Adds a call to ga_account_list for the appropriate GA account type (GA4 or Universal)
        • 
+
      • {{{ model_server }}}- Adds the server side module for the models as configured in the ga_model configuration. It uses the object loaded above via the model_load macro.  It looks like model1$server('model1') in the code.
        • 
+
      • {{{ model1 }}}- Alternative to model_load, this will load the model file location instead, which you can pass to ga_model_load() in the template.  model1 is the first model passed, model2 the second, etc.
        • 
 
      • {{{ your_argument }}}- You can pass in your own custom variables to the template via the ... argument of this function if they are named the same as the template macro variable
        • 
-
      
-
-    
      See also
      
-
-    
      Other GA modelling functions: 
-ga_model_edit(),
-ga_model_example(),
-ga_model_load(),
-ga_model_make(),
-ga_model_save(),
-ga_model_shiny_load(),
-ga_model_shiny_template(),
-ga_model_write(),
-ga_model()
      
-
-    
      Examples
      
-    
      
-# see Shiny templates included with the package
-ga_model_shiny_template("list")
-
      #>  [1] "argonDash/ui.R"                      
-#>  [2] "basic_app/app.R"                     
-#>  [3] "basic_bslib/ui.R"                    
-#>  [4] "basic/ui.R"                          
-#>  [5] "boilerplate/deploy.R"                
-#>  [6] "boilerplate/Dockerfile_app"          
-#>  [7] "boilerplate/Dockerfile_ui_server"    
-#>  [8] "boilerplate/header_boilerplate.R"    
-#>  [9] "boilerplate/server_app_boilerplate.R"
-#> [10] "boilerplate/server_boilerplate.R"    
-#> [11] "gentelella/ui.R"                     
-#> [12] "html_based/template.html"            
-#> [13] "html_based/ui.R"                     
-#> [14] "html_based/www/dummy.js"             
-#> [15] "shinydashboard/ui.R"                 
-#> [16] "shinythemes/ui.R"                    
      
-# see an example of an ui.R template with macros
-ga_model_shiny_template("basic/ui.R", read_lines = TRUE)
-
      #> [1] "## basic ui.R"                           
-#> [2] "fluidPage(title = \"{{ shiny_title }}\","
-#> [3] "                {{ auth_ui }},"          
-#> [4] "                {{{ date_range }}},"     
-#> [5] "                h2(\"Model Output\"),"   
-#> [6] "{{{ model_ui }}}"                        
-#> [7] ")"                                       
      
-# see an example of an app.R template with macros
-ga_model_shiny_template("basic_app/app.R", read_lines = TRUE)
-
      #>  [1] "## basic_full ui.R"                                        
-#>  [2] "library(shiny)"                                            
-#>  [3] "library(googleAuthR)"                                      
-#>  [4] "library(googleAnalyticsR)"                                 
-#>  [5] "{{{ model_libraries }}}"                                   
-#>  [6] ""                                                          
-#>  [7] "gar_set_client(web_json = \"{{ web_json }}\","             
-#>  [8] "               scopes = \"{{ scopes }}\", "                
-#>  [9] "               activate = \"web\")"                        
-#> [10] "options(googleAuthR.redirect = \"{{ deployed_url }}\")"    
-#> [11] ""                                                          
-#> [12] "# loads pre-existing models"                               
-#> [13] "{{{ model_load }}}"                                        
-#> [14] ""                                                          
-#> [15] "## ui.R"                                                   
-#> [16] "ui <- fluidPage(title = \"{{ shiny_title }}\","            
-#> [17] "                {{ auth_ui }},"                            
-#> [18] "                {{{ date_range }}},"                       
-#> [19] "                h2(\"Model Output\"),"                     
-#> [20] "{{{ model_ui }}}"                                          
-#> [21] "                "                                          
-#> [22] ")"                                                         
-#> [23] ""                                                          
-#> [24] "server <- function(input, output, session){"               
-#> [25] "  "                                                        
-#> [26] "  token <- gar_shiny_auth(session)"                        
-#> [27] "  "                                                        
-#> [28] "  {{{ auth_accounts }}}"                                   
-#> [29] "  "                                                        
-#> [30] "  # module for authentication"                             
-#> [31] "  view_id <- {{ auth_server }}"                            
-#> [32] "  "                                                        
-#> [33] "  # module to display model results"                       
-#> [34] "  {{{ model_server }}}"                                    
-#> [35] "  "                                                        
-#> [36] "}"                                                         
-#> [37] ""                                                          
-#> [38] "shinyApp(gar_shiny_ui(ui, login_ui = silent_auth), server)"
      
-if (FALSE) {
-
-# a universal analytics model using default template "basic"
-ga_model_shiny(
-  ga_model_example("decomp_ga.gamr"), 
-  auth_dropdown = "universal")
-
-# a template from a directory holding an app.R file
-ga_model_shiny(
-  ga_model_example("decomp_ga.gamr"), 
-  auth_dropdown = "universal",
-  template = ga_model_shiny_template("basic_app"))
-  
-  
-# a template from only an ui.R file that will import boilerplate server.R
-ga_model_shiny(
-  ga_model_example("decomp_ga.gamr"), 
-  auth_dropdown = "universal",
-  template = ga_model_shiny_template("basic/ui.R"))
-
-# a template from a custom html based theme
-ga_model_shiny(
-  ga_model_example("decomp_ga.gamr"), 
-  auth_dropdown = "universal",
-  template = ga_model_shiny_template("html_based"))
-
-# a template using library(argonDash)
-ga_model_shiny(
-  ga_model_example("ga-effect.gamr"), 
-  title = "Argon Demo",
-  auth_dropdown = "universal",
-  template = ga_model_shiny_template("argonDash") )
-
-# multiple models
-m3 <- ga_model_example("time-normalised.gamr")
-m4 <- ga_model_example("ga-effect.gamr")
-
-# launch in gentelella template
-ga_model_shiny(list(m4, m3), auth_dropdown = "universal",
-              template = ga_model_shiny_template("gentelella"))
-
-     
-# you can make custom ui embedded within the template file
-# use {{{ model_list }}} to work with the models in the ui.R
-
-# below adds custom macro 'theme' and a custom ui in box tabs
-ga_model_shiny(list(m4, m3), auth_dropdown = "universal", 
-               template = ga_model_shiny_template("shinythemes"), 
-               theme = "yeti")
-
-# shinydashboard's custom ui functions put a model in each side tab      
-ga_model_shiny(list(m4, m3), auth_dropdown = "universal", 
-               template = ga_model_shiny_template("shinydashboard"), 
-               skin = "green")
-               
-# send in lots of theme variables to bslib in shiny > 1.6.0
-ga_model_shiny(list(m4, m3), auth_dropdown = "universal",
-               template = ga_model_shiny_template("basic_bslib"), 
-               bg = "white", fg = "red", primary = "grey")
- 
-# write out an app to a local folder
-ga_model_shiny(list(m4, m3), auth_dropdown = "universal",
-               template = ga_model_shiny_template("basic_bslib"), 
-               bg = "white", fg = "red", primary = "grey",
-               local_folder = "deploy_shiny")
-}
-
-
+
    
+    
    
+    
    See also
    
+    
    Other GA modelling functions: 
+ga_model_edit(),
+ga_model_example(),
+ga_model_load(),
+ga_model_make(),
+ga_model_save(),
+ga_model_shiny_load(),
+ga_model_shiny_template(),
+ga_model_write(),
+ga_model()
    
+    
    
 
-
    
+    
    
+    
    Examples
    
+    
    
+# see Shiny templates included with the package
+ga_model_shiny_template("list")
+#>  [1] "argonDash/ui.R"                      
+#>  [2] "basic/ui.R"                          
+#>  [3] "basic_app/app.R"                     
+#>  [4] "basic_bslib/ui.R"                    
+#>  [5] "boilerplate/Dockerfile_app"          
+#>  [6] "boilerplate/Dockerfile_ui_server"    
+#>  [7] "boilerplate/deploy.R"                
+#>  [8] "boilerplate/header_boilerplate.R"    
+#>  [9] "boilerplate/server_app_boilerplate.R"
+#> [10] "boilerplate/server_boilerplate.R"    
+#> [11] "gentelella/ui.R"                     
+#> [12] "html_based/template.html"            
+#> [13] "html_based/ui.R"                     
+#> [14] "html_based/www/dummy.js"             
+#> [15] "shinydashboard/ui.R"                 
+#> [16] "shinythemes/ui.R"                    
+
+# see an example of an ui.R template with macros
+ga_model_shiny_template("basic/ui.R", read_lines = TRUE)
+#> [1] "## basic ui.R"                           
+#> [2] "fluidPage(title = \"{{ shiny_title }}\","
+#> [3] "                {{ auth_ui }},"          
+#> [4] "                {{{ date_range }}},"     
+#> [5] "                h2(\"Model Output\"),"   
+#> [6] "{{{ model_ui }}}"                        
+#> [7] ")"                                       
+
+# see an example of an app.R template with macros
+ga_model_shiny_template("basic_app/app.R", read_lines = TRUE)
+#>  [1] "## basic_full ui.R"                                        
+#>  [2] "library(shiny)"                                            
+#>  [3] "library(googleAuthR)"                                      
+#>  [4] "library(googleAnalyticsR)"                                 
+#>  [5] "{{{ model_libraries }}}"                                   
+#>  [6] ""                                                          
+#>  [7] "gar_set_client(web_json = \"{{ web_json }}\","             
+#>  [8] "               scopes = \"{{ scopes }}\", "                
+#>  [9] "               activate = \"web\")"                        
+#> [10] "options(googleAuthR.redirect = \"{{ deployed_url }}\")"    
+#> [11] ""                                                          
+#> [12] "# loads pre-existing models"                               
+#> [13] "{{{ model_load }}}"                                        
+#> [14] ""                                                          
+#> [15] "## ui.R"                                                   
+#> [16] "ui <- fluidPage(title = \"{{ shiny_title }}\","            
+#> [17] "                {{ auth_ui }},"                            
+#> [18] "                {{{ date_range }}},"                       
+#> [19] "                h2(\"Model Output\"),"                     
+#> [20] "{{{ model_ui }}}"                                          
+#> [21] "                "                                          
+#> [22] ")"                                                         
+#> [23] ""                                                          
+#> [24] "server <- function(input, output, session){"               
+#> [25] "  "                                                        
+#> [26] "  token <- gar_shiny_auth(session)"                        
+#> [27] "  "                                                        
+#> [28] "  {{{ auth_accounts }}}"                                   
+#> [29] "  "                                                        
+#> [30] "  # module for authentication"                             
+#> [31] "  view_id <- {{ auth_server }}"                            
+#> [32] "  "                                                        
+#> [33] "  # module to display model results"                       
+#> [34] "  {{{ model_server }}}"                                    
+#> [35] "  "                                                        
+#> [36] "}"                                                         
+#> [37] ""                                                          
+#> [38] "shinyApp(gar_shiny_ui(ui, login_ui = silent_auth), server)"
+
+if (FALSE) {
+
+# a universal analytics model using default template "basic"
+ga_model_shiny(
+  ga_model_example("decomp_ga.gamr"), 
+  auth_dropdown = "universal")
+
+# a template from a directory holding an app.R file
+ga_model_shiny(
+  ga_model_example("decomp_ga.gamr"), 
+  auth_dropdown = "universal",
+  template = ga_model_shiny_template("basic_app"))
+  
+  
+# a template from only an ui.R file that will import boilerplate server.R
+ga_model_shiny(
+  ga_model_example("decomp_ga.gamr"), 
+  auth_dropdown = "universal",
+  template = ga_model_shiny_template("basic/ui.R"))
+
+# a template from a custom html based theme
+ga_model_shiny(
+  ga_model_example("decomp_ga.gamr"), 
+  auth_dropdown = "universal",
+  template = ga_model_shiny_template("html_based"))
+
+# a template using library(argonDash)
+ga_model_shiny(
+  ga_model_example("ga-effect.gamr"), 
+  title = "Argon Demo",
+  auth_dropdown = "universal",
+  template = ga_model_shiny_template("argonDash") )
+
+# multiple models
+m3 <- ga_model_example("time-normalised.gamr")
+m4 <- ga_model_example("ga-effect.gamr")
+
+# launch in gentelella template
+ga_model_shiny(list(m4, m3), auth_dropdown = "universal",
+              template = ga_model_shiny_template("gentelella"))
+
+     
+# you can make custom ui embedded within the template file
+# use {{{ model_list }}} to work with the models in the ui.R
+
+# below adds custom macro 'theme' and a custom ui in box tabs
+ga_model_shiny(list(m4, m3), auth_dropdown = "universal", 
+               template = ga_model_shiny_template("shinythemes"), 
+               theme = "yeti")
+
+# shinydashboard's custom ui functions put a model in each side tab      
+ga_model_shiny(list(m4, m3), auth_dropdown = "universal", 
+               template = ga_model_shiny_template("shinydashboard"), 
+               skin = "green")
+               
+# send in lots of theme variables to bslib in shiny > 1.6.0
+ga_model_shiny(list(m4, m3), auth_dropdown = "universal",
+               template = ga_model_shiny_template("basic_bslib"), 
+               bg = "white", fg = "red", primary = "grey")
+ 
+# write out an app to a local folder
+ga_model_shiny(list(m4, m3), auth_dropdown = "universal",
+               template = ga_model_shiny_template("basic_bslib"), 
+               bg = "white", fg = "red", primary = "grey",
+               local_folder = "deploy_shiny")
+}
+
+
+
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_model_shiny_load.html b/docs/reference/ga_model_shiny_load.html
index cb0777ab..a84b6918 100644
--- a/docs/reference/ga_model_shiny_load.html
+++ b/docs/reference/ga_model_shiny_load.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Load one model into a Shiny template — ga_model_shiny_load • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Load one model into a Shiny template — ga_model_shiny_load • googleAnalyticsR
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Load one model into a Shiny template
    
-    Source: R/model_shiny_templates.R
+    Source: R/model_shiny_templates.R
     
     
    
 
@@ -295,59 +213,52 @@ 
    Load one model into a Shiny template
    
     
    Load one model into a Shiny template
    
     
    
 
-    
    ga_model_shiny_load(model_n, ...)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    model_n
    The templated name of a model e.g. 'model1'
    ...
    Other arguments passed from shiny server
    
-
-    
    See also
    
+    
    
+    
    ga_model_shiny_load(model_n, ...)
    
+    
    
 
-    
    Other GA modelling functions: 
-ga_model_edit(),
-ga_model_example(),
-ga_model_load(),
-ga_model_make(),
-ga_model_save(),
-ga_model_shiny_template(),
-ga_model_shiny(),
-ga_model_write(),
-ga_model()
    
+    
    
+    
    Arguments
    
+    
    model_n
    
+
    The templated name of a model e.g. 'model1'
    
+
    ...
    
+
    Other arguments passed from shiny server
    
+
    
+    
    
+    
    See also
    
+    
    Other GA modelling functions: 
+ga_model_edit(),
+ga_model_example(),
+ga_model_load(),
+ga_model_make(),
+ga_model_save(),
+ga_model_shiny_template(),
+ga_model_shiny(),
+ga_model_write(),
+ga_model()
    
+    
    
 
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_model_shiny_template.html b/docs/reference/ga_model_shiny_template.html
index 93b2b645..bc92ec2b 100644
--- a/docs/reference/ga_model_shiny_template.html
+++ b/docs/reference/ga_model_shiny_template.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Get a Shiny template file — ga_model_shiny_template • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Get a Shiny template file — ga_model_shiny_template • googleAnalyticsR
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Get a Shiny template file
    
-    Source: R/model_shiny_templates.R
+    Source: R/model_shiny_templates.R
     
     
    
 
@@ -295,59 +213,52 @@ 
    Get a Shiny template file
    
     
    Gets a pre-created template from the googleAnalyticsR samples
    
     
    
 
-    
    ga_model_shiny_template(name = "list", read_lines = FALSE)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    name
    the template name
    read_lines
    If TRUE will use readLines() to print out the template contents
    
-
-    
    See also
    
+    
    
+    
    ga_model_shiny_template(name = "list", read_lines = FALSE)
    
+    
    
 
-    
    Other GA modelling functions: 
-ga_model_edit(),
-ga_model_example(),
-ga_model_load(),
-ga_model_make(),
-ga_model_save(),
-ga_model_shiny_load(),
-ga_model_shiny(),
-ga_model_write(),
-ga_model()
    
+    
    
+    
    Arguments
    
+    
    name
    
+
    the template name
    
+
    read_lines
    
+
    If TRUE will use readLines() to print out the template contents
    
+
    
+    
    
+    
    See also
    
+    
    Other GA modelling functions: 
+ga_model_edit(),
+ga_model_example(),
+ga_model_load(),
+ga_model_make(),
+ga_model_save(),
+ga_model_shiny_load(),
+ga_model_shiny(),
+ga_model_write(),
+ga_model()
    
+    
    
 
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_model_write.html b/docs/reference/ga_model_write.html
index e0e46205..d5757e4b 100644
--- a/docs/reference/ga_model_write.html
+++ b/docs/reference/ga_model_write.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Write the ga_model functions to a file — ga_model_write • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Write the ga_model functions to a file — ga_model_write • googleAnalyticsR
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Write the ga_model functions to a file
    
-    Source: R/models.R
+    Source: R/models.R
     
     
    
 
@@ -295,67 +213,62 @@ 
    Write the ga_model functions to a file
    
     
    Write the ga_model functions to a file
    
     
    
 
-    
    ga_model_write(model, filepath = "ga_model.R")
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    model
    The ga_model object to extract functions from to write, or a filepath to a model
    filepath
    The filepath to write the functions to
    
-
-    
    See also
    
-
-    
    Other GA modelling functions: 
-ga_model_edit(),
-ga_model_example(),
-ga_model_load(),
-ga_model_make(),
-ga_model_save(),
-ga_model_shiny_load(),
-ga_model_shiny_template(),
-ga_model_shiny(),
-ga_model()
    
+    
    
+    
    ga_model_write(model, filepath = "ga_model.R")
    
+    
    
 
-    
    Examples
    
-    
    
-if (FALSE) {
+    
    
+    
    Arguments
    
+    
    model
    
+
    The ga_model object to extract functions from to write, or a filepath to a model
    
+
    filepath
    
+
    The filepath to write the functions to
    
+
    
+    
    
+    
    See also
    
+    
    Other GA modelling functions: 
+ga_model_edit(),
+ga_model_example(),
+ga_model_load(),
+ga_model_make(),
+ga_model_save(),
+ga_model_shiny_load(),
+ga_model_shiny_template(),
+ga_model_shiny(),
+ga_model()
    
+    
    
 
-decomp_ga <- ga_model_example("decomp_ga.gamr")
-ga_model_write(decomp_ga, "a_file.R")
-}
-
    
+    
    
+    
    Examples
    
+    
    
+if (FALSE) {
+
+decomp_ga <- ga_model_example("decomp_ga.gamr")
+ga_model_write(decomp_ga, "a_file.R")
+}
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_mp_cid.html b/docs/reference/ga_mp_cid.html
index 4d86a228..0f067e61 100644
--- a/docs/reference/ga_mp_cid.html
+++ b/docs/reference/ga_mp_cid.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Generate a random client_id — ga_mp_cid • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Generate a random client_id — ga_mp_cid • googleAnalyticsR
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Generate a random client_id
    
-    Source: R/measurement_protocol.R
+    Source: R/measurement_protocol.R
     
     
    
 
@@ -295,49 +213,44 @@ 
    Generate a random client_id
    
     
    This has a random number plus a timestamp
    
     
    
 
-    
    ga_mp_cid(seed = NULL)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
    seed
    If you set a seed, then the random number will be the same for each value
    
-
-    
    See also
    
+    
    
+    
    ga_mp_cid(seed = NULL)
    
+    
    
 
-    
    Other Measurement Protocol functions: 
-ga_mp_event_item(),
-ga_mp_event(),
-ga_mp_send()
    
+    
    
+    
    Arguments
    
+    
    seed
    
+
    If you set a seed, then the random number will be the same for each value
    
+
    
+    
    
+    
    See also
    
+    
    Other Measurement Protocol functions: 
+ga_mp_event_item(),
+ga_mp_event(),
+ga_mp_send()
    
+    
    
 
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_mp_event.html b/docs/reference/ga_mp_event.html
index 5f5940de..52fa1fdc 100644
--- a/docs/reference/ga_mp_event.html
+++ b/docs/reference/ga_mp_event.html
@@ -1,86 +1,19 @@
-
 
-
-  
-  
-
-
-
-Create a Measurement Protocol Event — ga_mp_event • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Create a Measurement Protocol Event — ga_mp_event • googleAnalyticsR
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Create a Measurement Protocol Event
    
-    Source: R/measurement_protocol.R
+    Source: R/measurement_protocol.R
     
     
    
 
     
    
-    
    [Experimental]
-This creates an event to send via ga_mp_send
    
+    
    [Experimental]
+This creates an event to send via ga_mp_send
    
     
    
 
-    
    ga_mp_event(name, params = NULL, items = NULL)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    name
    The event name to send in
    params
    Optional event parameters sent in as a named list
    items
    Optional items created via ga_mp_event_item
    
-
-    
    See also
    
+    
    
+    
    ga_mp_event(name, params = NULL, items = NULL)
    
+    
    
 
-    
    Other Measurement Protocol functions: 
-ga_mp_cid(),
-ga_mp_event_item(),
-ga_mp_send()
    
+    
    
+    
    Arguments
    
+    
    name
    
+
    The event name to send in
    
+
    params
    
+
    Optional event parameters sent in as a named list
    
+
    items
    
+
    Optional items created via ga_mp_event_item
    
+
    
+    
    
+    
    See also
    
+    
    Other Measurement Protocol functions: 
+ga_mp_cid(),
+ga_mp_event_item(),
+ga_mp_send()
    
+    
    
 
-    
    Examples
    
-    
    
-ga_mp_event("custom_event")
-
    #> 
-#> ==GA4 MP Event
-#> {
-#>   "name": "custom_event"
-#> } 
    ga_mp_event("custom_event", params = list(my_param = "SUPER"))
-
    #> 
-#> ==GA4 MP Event
-#> {
-#>   "name": "custom_event",
-#>   "params": {
-#>     "my_param": "SUPER"
-#>   }
-#> } 
    
+    
    
+    
    Examples
    
+    
    
+ga_mp_event("custom_event")
+#> 
+#> ==GA4 MP Event
+#> {
+#>   "name": "custom_event"
+#> } 
+ga_mp_event("custom_event", params = list(my_param = "SUPER"))
+#> 
+#> ==GA4 MP Event
+#> {
+#>   "name": "custom_event",
+#>   "params": {
+#>     "my_param": "SUPER"
+#>   }
+#> } 
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_mp_event_item.html b/docs/reference/ga_mp_event_item.html
index 5ee52616..1cac90d0 100644
--- a/docs/reference/ga_mp_event_item.html
+++ b/docs/reference/ga_mp_event_item.html
@@ -1,86 +1,19 @@
-
 
-
-  
-  
-
-
-
-Create an Measurement Protocol Item Property for an Event — ga_mp_event_item • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Create an Measurement Protocol Item Property for an Event — ga_mp_event_item • googleAnalyticsR
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Create an Measurement Protocol Item Property for an Event
    
-    Source: R/measurement_protocol.R
+    Source: R/measurement_protocol.R
     
     
    
 
     
    
-    
    [Experimental]
+    
    [Experimental]
 Some events work with item properties
    
     
    
 
-    
    ga_mp_event_item(
-  item_id = NULL,
-  item_name = NULL,
-  coupon = NULL,
-  discount = NULL,
-  affiliation = NULL,
-  item_brand = NULL,
-  item_category = NULL,
-  item_variant = NULL,
-  price = NULL,
-  currency = NULL
-)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    item_id
    Item ID
    item_name
    Item Name
    coupon
    Coupon
    discount
    Discount
    affiliation
    Affiliation
    item_brand
    Brand
    item_category
    Category
    item_variant
    Variant
    price
    Price
    currency
    Currency
    
-
-    
    See also
    
+    
    
+    
    ga_mp_event_item(
+  item_id = NULL,
+  item_name = NULL,
+  coupon = NULL,
+  discount = NULL,
+  affiliation = NULL,
+  item_brand = NULL,
+  item_category = NULL,
+  item_variant = NULL,
+  price = NULL,
+  currency = NULL
+)
    
+    
    
 
-    
    Other Measurement Protocol functions: 
-ga_mp_cid(),
-ga_mp_event(),
-ga_mp_send()
    
+    
    
+    
    Arguments
    
+    
    item_id
    
+
    Item ID
    
+
    item_name
    
+
    Item Name
    
+
    coupon
    
+
    Coupon
    
+
    discount
    
+
    Discount
    
+
    affiliation
    
+
    Affiliation
    
+
    item_brand
    
+
    Brand
    
+
    item_category
    
+
    Category
    
+
    item_variant
    
+
    Variant
    
+
    price
    
+
    Price
    
+
    currency
    
+
    Currency
    
+
    
+    
    
+    
    See also
    
+    
    Other Measurement Protocol functions: 
+ga_mp_cid(),
+ga_mp_event(),
+ga_mp_send()
    
+    
    
 
-    
    Examples
    
-    
    # one item
-ga_mp_event_item(item_name = "jeggings", 
-                 price = 8.88, 
-                 item_variant = "Black")
-
    #> ==GA4 MP Event Item
-#> {
-#>   "item_name": "jeggings",
-#>   "item_variant": "Black",
-#>   "price": 8.88
-#> } 
                     
-# many items in a list
-items <- list(
-  ga_mp_event_item(item_id = "SKU_12345", 
-                   price = 9.99, 
-                   item_brand = "Gucci"), 
-  ga_mp_event_item(item_name = "jeggings", 
-                   price = 8.88, 
-                   item_variant = "Black"))
-                   
-# construct an event with its own fields
-ga_mp_event("add_payment_info", 
-            params = list(coupon = "SUMMER_FUN", 
-                          payment_type = "Credit Card", 
-                          value = 7.77, 
-                          currency = "USD"), 
-            items = items)
-
    #> 
-#> ==GA4 MP Event
-#> {
-#>   "name": "add_payment_info",
-#>   "params": {
-#>     "coupon": "SUMMER_FUN",
-#>     "payment_type": "Credit Card",
-#>     "value": 7.77,
-#>     "currency": "USD",
-#>     "items": [
-#>       {
-#>         "item_id": "SKU_12345",
-#>         "item_brand": "Gucci",
-#>         "price": 9.99
-#>       },
-#>       {
-#>         "item_name": "jeggings",
-#>         "item_variant": "Black",
-#>         "price": 8.88
-#>       }
-#>     ]
-#>   }
-#> } 
    
+    
    
+    
    Examples
    
+    
    # one item
+ga_mp_event_item(item_name = "jeggings", 
+                 price = 8.88, 
+                 item_variant = "Black")
+#> ==GA4 MP Event Item
+#> {
+#>   "item_name": "jeggings",
+#>   "item_variant": "Black",
+#>   "price": 8.88
+#> } 
+                 
+# many items in a list
+items <- list(
+  ga_mp_event_item(item_id = "SKU_12345", 
+                   price = 9.99, 
+                   item_brand = "Gucci"), 
+  ga_mp_event_item(item_name = "jeggings", 
+                   price = 8.88, 
+                   item_variant = "Black"))
+                   
+# construct an event with its own fields
+ga_mp_event("add_payment_info", 
+            params = list(coupon = "SUMMER_FUN", 
+                          payment_type = "Credit Card", 
+                          value = 7.77, 
+                          currency = "USD"), 
+            items = items)
+#> 
+#> ==GA4 MP Event
+#> {
+#>   "name": "add_payment_info",
+#>   "params": {
+#>     "coupon": "SUMMER_FUN",
+#>     "payment_type": "Credit Card",
+#>     "value": 7.77,
+#>     "currency": "USD",
+#>     "items": [
+#>       {
+#>         "item_id": "SKU_12345",
+#>         "item_brand": "Gucci",
+#>         "price": 9.99
+#>       },
+#>       {
+#>         "item_name": "jeggings",
+#>         "item_variant": "Black",
+#>         "price": 8.88
+#>       }
+#>     ]
+#>   }
+#> } 
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_mp_send.html b/docs/reference/ga_mp_send.html
index e26ee723..d64df172 100644
--- a/docs/reference/ga_mp_send.html
+++ b/docs/reference/ga_mp_send.html
@@ -1,87 +1,20 @@
-
 
-
-  
-  
-
-
-
-Make a Measurement Protocol v2 request — ga_mp_send • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Make a Measurement Protocol v2 request — ga_mp_send • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Make a Measurement Protocol v2 request
    
-    Source: R/measurement_protocol.R
+    Source: R/measurement_protocol.R
     
     
    
 
     
    
-    
    [Experimental]
+    
    [Experimental]
 Create a server side call to Google Analytics 4 via its Measurement Protocol
    
 
    Use ga_mp_connection to set up the Measurement Protocol connections to pass to ga_mp_send.  If using Google Tag Manager Server-Side, you can also set up a custom endpoint.
    
     
    
 
-    
    ga_mp_send(
-  events,
-  client_id,
-  connection,
-  user_id = NULL,
-  debug_call = FALSE,
-  timestamp_micros = NULL,
-  user_properties = NULL,
-  non_personalized_ads = TRUE
-)
-
-ga_mp_connection(
-  measurement_id,
-  api_secret = Sys.getenv("MP_SECRET"),
-  endpoint = NULL,
-  preview_header = NULL
-)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    events
    The events to send
    client_id
    The client_id to associate with the event
    connection
    The connection details created by ga_mp_connection
    user_id
    Optional. Unique id for the user
    debug_call
    Send hits to the Google debug endpoint to validate hits.
    timestamp_micros
    Optional. A Unix timestamp (in microseconds) for the time to associate with the event.
    user_properties
    Optional. The user properties for the measurement sent in as a named list.
    non_personalized_ads
    Optional. Set to true to indicate these events should not be used for personalized ads.
    measurement_id
    The measurement ID associated with a stream
    api_secret
    The secret generated in the GA4 UI - by default will look for environment arg MP_SECRET
    endpoint
    If NULL will use Google default, otherwise set to the URL of your Measurement Protocol custom endpoint
    preview_header
    Only needed for custom endpoints. The X-Gtm-Server-Preview HTTP Header found in your GTM debugger
    
-
-    
    Value
    
+    
    
+    
    ga_mp_send(
+  events,
+  client_id,
+  connection,
+  user_id = NULL,
+  debug_call = FALSE,
+  timestamp_micros = NULL,
+  user_properties = NULL,
+  non_personalized_ads = TRUE
+)
+
+ga_mp_connection(
+  measurement_id,
+  api_secret = Sys.getenv("MP_SECRET"),
+  endpoint = NULL,
+  preview_header = NULL
+)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    events
    
+
    The events to send
    
+
    client_id
    
+
    The client_id to associate with the event
    
+
    connection
    
+
    The connection details created by ga_mp_connection
    
+
    user_id
    
+
    Optional. Unique id for the user
    
+
    debug_call
    
+
    Send hits to the Google debug endpoint to validate hits.
    
+
    timestamp_micros
    
+
    Optional. A Unix timestamp (in microseconds) for the time to associate with the event.
    
+
    user_properties
    
+
    Optional. The user properties for the measurement sent in as a named list.
    
+
    non_personalized_ads
    
+
    Optional. Set to true to indicate these events should not be used for personalized ads.
    
+
    measurement_id
    
+
    The measurement ID associated with a stream
    
+
    api_secret
    
+
    The secret generated in the GA4 UI - by default will look for environment arg MP_SECRET
    
+
    endpoint
    
+
    If NULL will use Google default, otherwise set to the URL of your Measurement Protocol custom endpoint
    
+
    preview_header
    
+
    Only needed for custom endpoints. The X-Gtm-Server-Preview HTTP Header found in your GTM debugger
    
+
    
+    
    
+    
    Value
    
     
    TRUE if successful, if debug_call=TRUE then validation messages if not a valid hit.
    
-    
    Details
    
-
+    
    
+    
    
+    
    Details
    
     
    Create an API secret via Admin > Data Streams > choose your stream > Measurement Protocol > Create
    
 
    To see event parameters, create custom fields in your GA4 account first, to see them in your reports 24hrs after you send them in with this function via Custom definitions > Create custom dimensions - dimension name will be how it looks like in the reports, event parameter will be the parameter you have sent in with the event.
    
-
    user_id can be used for cross-platform analysis
    
+
    user_id can be used for cross-platform analysis
    
 
    timestamp_micros should only be set to record events that happened in the past. This value can be overridden via user_property or event timestamps. Events can be backdated up to 48 hours. Note microseconds, not milliseconds.
    
-
    user_properties - describe segments of your user base, such as language preference or geographic location.  See User properties
    
-
    Ensure you also have user permission as specified in the feature policy
    
+
    user_properties - describe segments of your user base, such as language preference or geographic location.  See User properties
    
+
    Ensure you also have user permission as specified in the feature policy
    
 
    Invalid events are silently rejected with a 204 response, so use debug_call=TRUE to validate your events first.
    
-    
    See also
    
-
-    
    Measurement Protocol (Google Analytics 4)
    
+    
    
+    
    
+    
    See also
    
+    
    Measurement Protocol (Google Analytics 4)
    
 
    Other Measurement Protocol functions: 
-ga_mp_cid(),
-ga_mp_event_item(),
-ga_mp_event()
    
-
-    
    Examples
    
-    
    # preferably set this in .Renviron
-Sys.setenv(MP_SECRET="MY_SECRET")
-
-# your GA4 settings
-my_measurement_id <- "G-1234"
-
-my_connection <- ga_mp_connection(my_measurement_id)
-
-a_client_id <- 123.456
-event <- ga_mp_event("an_event")
-ga_mp_send(event, a_client_id, my_connection, debug_call = TRUE)
-
    #> ℹ 2021-10-05 19:17:23 > MP Request: https://www.google-analytics.com/debug/mp/collect?measurement_id=G-1234&api_secret=MY_SECRET 
-#>  {
-#>   "client_id": "123.456",
-#>   "non_personalized_ads": true,
-#>   "events": [
-#>     {
-#>       "name": "an_event"
-#>     }
-#>   ]
-#> }
    #> 
    #> ℹ 2021-10-05 19:17:23 > Response:  200
    #> ℹ 2021-10-05 19:17:23 > No validation messages found
    #> [1] TRUE
    
-# multiple events at same time in a batch
-another <- ga_mp_event("another_event")
-
-ga_mp_send(list(event, another), 
-           a_client_id, 
-           my_connection,
-           debug_call = TRUE)
-
    #> ℹ 2021-10-05 19:17:23 > MP Request: https://www.google-analytics.com/debug/mp/collect?measurement_id=G-1234&api_secret=MY_SECRET 
-#>  {
-#>   "client_id": "123.456",
-#>   "non_personalized_ads": true,
-#>   "events": [
-#>     {
-#>       "name": "an_event"
-#>     },
-#>     {
-#>       "name": "another_event"
-#>     }
-#>   ]
-#> }
    #> 
    #> ℹ 2021-10-05 19:17:23 > Response:  200
    #> ℹ 2021-10-05 19:17:23 > No validation messages found
    #> [1] TRUE
    if (FALSE) {
-# you can see sent events in the real-time reports
-my_property_id <- 206670707
-ga_data(my_property_id, 
-        dimensions = "eventName", 
-        metrics = "eventCount", 
-        dim_filters = ga_data_filter(
-           eventName == c("an_event","another_event")),
-        realtime = TRUE)
-
-}
+ga_mp_cid(),
+ga_mp_event_item(),
+ga_mp_event()
    
+    
    
 
-# custom GTM server side endpoint
-my_custom_connection <- ga_mp_connection(
-   my_measurement_id,
-   endpoint = "https://gtm.example.com",
-   preview_header = "ZW52LTV8OWdPOExNWFkYjA0Njk4NmQ="
- )
- 
-
    
+    
    
+    
    Examples
    
+    
    # preferably set this in .Renviron
+Sys.setenv(MP_SECRET="MY_SECRET")
+
+# your GA4 settings
+my_measurement_id <- "G-1234"
+
+my_connection <- ga_mp_connection(my_measurement_id)
+
+a_client_id <- 123.456
+event <- ga_mp_event("an_event")
+
+if (FALSE) {
+#' ga_mp_send(event, a_client_id, my_connection, debug_call = TRUE)
+
+# multiple events at same time in a batch
+another <- ga_mp_event("another_event")
+
+ga_mp_send(list(event, another), 
+           a_client_id, 
+           my_connection,
+           debug_call = TRUE)
+           
+# you can see sent events in the real-time reports
+my_property_id <- 206670707
+ga_data(my_property_id, 
+        dimensions = "eventName", 
+        metrics = "eventCount", 
+        dim_filters = ga_data_filter(
+           eventName == c("an_event","another_event")),
+        realtime = TRUE)
+
+}
+
+# custom GTM server side endpoint
+my_custom_connection <- ga_mp_connection(
+   my_measurement_id,
+   endpoint = "https://gtm.example.com",
+   preview_header = "ZW52LTV8OWdPOExNWFkYjA0Njk4NmQ="
+ )
+ 
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_remarketing_build.html b/docs/reference/ga_remarketing_build.html
index 41dc7f85..b7bd2ff6 100644
--- a/docs/reference/ga_remarketing_build.html
+++ b/docs/reference/ga_remarketing_build.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Create a remarketing audience for creation — ga_remarketing_build • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Create a remarketing audience for creation — ga_remarketing_build • googleAnalyticsR
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Create a remarketing audience for creation
    
-    Source: R/remarketingAudiences.R
+    Source: R/remarketingAudiences.R
     
     
    
 
     
    
-    
    Create definitions to be used within ga_remarketing_create
    
+    
    Create definitions to be used within ga_remarketing_create
    
     
    
 
-    
    ga_remarketing_build(
-  segment,
-  membershipDurationDays = NULL,
-  daysToLookBack = NULL,
-  state_duration = c("TEMPORARY", "PERMANENT")
-)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    segment
    The definition of the segment (v3 syntax)
    membershipDurationDays
    Number of days (in the range 1 to 540) a user remains in the audience.
    daysToLookBack
    The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience.
    state_duration
    If to be used in a state based audience, whether to make the segment temporary or permanent.
    
-
-    
    Details
    
+    
    
+    
    ga_remarketing_build(
+  segment,
+  membershipDurationDays = NULL,
+  daysToLookBack = NULL,
+  state_duration = c("TEMPORARY", "PERMANENT")
+)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    segment
    
+
    The definition of the segment (v3 syntax)
    
+
    membershipDurationDays
    
+
    Number of days (in the range 1 to 540) a user remains in the audience.
    
+
    daysToLookBack
    
+
    The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience.
    
+
    state_duration
    
+
    If to be used in a state based audience, whether to make the segment temporary or permanent.
    
+
    
+    
    
+    
    Details
    
     
    The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.
    
-    
    See also
    
-
-    
    Other remarketing management functions: 
-ga_remarketing_create(),
-ga_remarketing_estimate(),
-ga_remarketing_get(),
-ga_remarketing_list()
    
-
-    
    Examples
    
-    
    
-if (FALSE) {
-adword_list <- ga_adwords_list(123456, "UA-123456-1")
-
-adword_link <- ga_adword(adword_list$id[[1]])
-
-segment_list <- ga_segment_list()$items$definition
-
-my_remarketing1 <- ga_remarketing_build(segment_list[[1]], 
-                    state_duration = "TEMPORARY",
-                    membershipDurationDays = 90, 
-                    daysToLookBack = 14)
-                    
-my_remarketing2 <- ga_remarketing_build(segment_list[[2]], 
-                     state_duration = "PERMANENT",
-                     membershipDurationDays = 7, 
-                     daysToLookBack = 31)
-                     
-# state based only can include exclusions
-ga_remarketing_create(adwords_link = adword_link,
-                     include = my_remarketing1, 
-                     exclude = my_remarketing2,
-                     audienceType = "STATE_BASED", 
-                     name = "my_remarketing_seg1")
+    
    
+    
    
+    
    See also
    
+    
    Other remarketing management functions: 
+ga_remarketing_create(),
+ga_remarketing_estimate(),
+ga_remarketing_get(),
+ga_remarketing_list()
    
+    
    
 
-}
-
    
+    
    
+    
    Examples
    
+    
    
+if (FALSE) {
+adword_list <- ga_adwords_list(123456, "UA-123456-1")
+
+adword_link <- ga_adword(adword_list$id[[1]])
+
+segment_list <- ga_segment_list()$items$definition
+
+my_remarketing1 <- ga_remarketing_build(segment_list[[1]], 
+                    state_duration = "TEMPORARY",
+                    membershipDurationDays = 90, 
+                    daysToLookBack = 14)
+                    
+my_remarketing2 <- ga_remarketing_build(segment_list[[2]], 
+                     state_duration = "PERMANENT",
+                     membershipDurationDays = 7, 
+                     daysToLookBack = 31)
+                     
+# state based only can include exclusions
+ga_remarketing_create(adwords_link = adword_link,
+                     include = my_remarketing1, 
+                     exclude = my_remarketing2,
+                     audienceType = "STATE_BASED", 
+                     name = "my_remarketing_seg1")
+
+}
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_remarketing_create.html b/docs/reference/ga_remarketing_create.html
index 8da22760..ffced672 100644
--- a/docs/reference/ga_remarketing_create.html
+++ b/docs/reference/ga_remarketing_create.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Create a new remarketing audience — ga_remarketing_create • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Create a new remarketing audience — ga_remarketing_create • googleAnalyticsR
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Create a new remarketing audience
    
-    Source: R/remarketingAudiences.R
+    Source: R/remarketingAudiences.R
     
     
    
 
     
    
-    
    Create a remarketing audiences built via ga_remarketing_build
    
+    
    Create a remarketing audiences built via ga_remarketing_build
    
     
    
 
-    
    ga_remarketing_create(
-  adwordsLinkId,
-  include,
-  exclude = NULL,
-  audienceType = c("SIMPLE", "STATE_BASED"),
-  name = NULL
-)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    adwordsLinkId
    The adwords link to add the remarketing audience to
    include
    A ga4_remarketing_segment object to include via ga_remarketing_build
    exclude
    If audienceType="STATE_BASED", a ga4_remarketing_segment object to exclude via ga_remarketing_build
    audienceType
    SIMPLE or STATE_BASED
    name
    An optional name, if not supplied one will be generated
    
-
-    
    Details
    
+    
    
+    
    ga_remarketing_create(
+  adwordsLinkId,
+  include,
+  exclude = NULL,
+  audienceType = c("SIMPLE", "STATE_BASED"),
+  name = NULL
+)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    adwordsLinkId
    
+
    The adwords link to add the remarketing audience to
    
+
    include
    
+
    A ga4_remarketing_segment object to include via ga_remarketing_build
    
+
    exclude
    
+
    If audienceType="STATE_BASED", a ga4_remarketing_segment object to exclude via ga_remarketing_build
    
+
    audienceType
    
+
    SIMPLE or STATE_BASED
    
+
    name
    
+
    An optional name, if not supplied one will be generated
    
+
    
+    
    
+    
    Details
    
     
    This builds and calls the API to create the remarketing audience based on the segments you have defined.
    
-    
    See also
    
-
-    
    Other remarketing management functions: 
-ga_remarketing_build(),
-ga_remarketing_estimate(),
-ga_remarketing_get(),
-ga_remarketing_list()
    
-
-    
    Examples
    
-    
    
-if (FALSE) {
-adword_list <- ga_adwords_list(123456, "UA-123456-1")
-
-adword_link <- ga_adword(adword_list$id[[1]])
-
-segment_list <- ga_segment_list()$items$definition
-
-my_remarketing1 <- ga_remarketing_build(segment_list[[1]], 
-                    state_duration = "TEMPORARY",
-                    membershipDurationDays = 90, 
-                    daysToLookBack = 14)
-                    
-my_remarketing2 <- ga_remarketing_build(segment_list[[2]], 
-                     state_duration = "PERMANENT",
-                     membershipDurationDays = 7, 
-                     daysToLookBack = 31)
-                     
-# state based only can include exclusions
-ga_remarketing_create(adwords_link = adword_link,
-                     include = my_remarketing1, 
-                     exclude = my_remarketing2,
-                     audienceType = "STATE_BASED", 
-                     name = "my_remarketing_seg1")
+    
    
+    
    
+    
    See also
    
+    
    Other remarketing management functions: 
+ga_remarketing_build(),
+ga_remarketing_estimate(),
+ga_remarketing_get(),
+ga_remarketing_list()
    
+    
    
 
-}
-
    
+    
    
+    
    Examples
    
+    
    
+if (FALSE) {
+adword_list <- ga_adwords_list(123456, "UA-123456-1")
+
+adword_link <- ga_adword(adword_list$id[[1]])
+
+segment_list <- ga_segment_list()$items$definition
+
+my_remarketing1 <- ga_remarketing_build(segment_list[[1]], 
+                    state_duration = "TEMPORARY",
+                    membershipDurationDays = 90, 
+                    daysToLookBack = 14)
+                    
+my_remarketing2 <- ga_remarketing_build(segment_list[[2]], 
+                     state_duration = "PERMANENT",
+                     membershipDurationDays = 7, 
+                     daysToLookBack = 31)
+                     
+# state based only can include exclusions
+ga_remarketing_create(adwords_link = adword_link,
+                     include = my_remarketing1, 
+                     exclude = my_remarketing2,
+                     audienceType = "STATE_BASED", 
+                     name = "my_remarketing_seg1")
+
+}
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_remarketing_estimate.html b/docs/reference/ga_remarketing_estimate.html
index 9e8a2fa9..9d7cc5f9 100644
--- a/docs/reference/ga_remarketing_estimate.html
+++ b/docs/reference/ga_remarketing_estimate.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Estimate number of users added to the segment yesterday — ga_remarketing_estimate • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Estimate number of users added to the segment yesterday — ga_remarketing_estimate • googleAnalyticsR
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Estimate number of users added to the segment yesterday
    
-    Source: R/remarketingAudiences.R
+    Source: R/remarketingAudiences.R
     
     
    
 
@@ -295,57 +213,53 @@ 
    Estimate number of users added to the segment yesterday
    
     
    Estimate number of users added to the segment yesterday
    
     
    
 
-    
    ga_remarketing_estimate(remarketingAudience)
    
+    
    
+    
    ga_remarketing_estimate(remarketingAudience)
    
+    
    
 
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
    remarketingAudience
    A remarketing audience object from ga_remarketing_get
    
+    
    
+    
    Arguments
    
+    
    remarketingAudience
    
+
    A remarketing audience object from ga_remarketing_get
    
 
    Takes the segment definition from a remarketing audiences and runs
 it against the viewId to see current estimated users
    
-
    The total audience size is this figure for every membershipDurationDay from yesterday
    
-
-    
    Value
    
-
+
    The total audience size is this figure for every membershipDurationDay from yesterday
    
+
    
+    
 
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_remarketing_get.html b/docs/reference/ga_remarketing_get.html
index 251fc194..b247c335 100644
--- a/docs/reference/ga_remarketing_get.html
+++ b/docs/reference/ga_remarketing_get.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Get a remarketing audience — ga_remarketing_get • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Get a remarketing audience — ga_remarketing_get • googleAnalyticsR
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Get a remarketing audience
    
-    Source: R/remarketingAudiences.R
+    Source: R/remarketingAudiences.R
     
     
    
 
@@ -295,62 +213,54 @@ 
    Get a remarketing audience
    
     
    Get a remarketing audience
    
     
    
 
-    
    ga_remarketing_get(accountId, webPropertyId, remarketingAudienceId)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    accountId
    Account Id
    webPropertyId
    Web Property Id
    remarketingAudienceId
    The ID of the remarketing audience to retrieve.
    
-
-    
    Value
    
+    
    
+    
    ga_remarketing_get(accountId, webPropertyId, remarketingAudienceId)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    accountId
    
+
    Account Id
    
+
    webPropertyId
    
+
    Web Property Id
    
+
    remarketingAudienceId
    
+
    The ID of the remarketing audience to retrieve.
    
+
    
+    
    
+    
    Value
    
     
    Remarketing Audience object
    
-    
    See also
    
-
-    
    About remarketing audiences
    
+    
    
+    
+    
    
 
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_remarketing_list.html b/docs/reference/ga_remarketing_list.html
index cd9ee9ae..98331745 100644
--- a/docs/reference/ga_remarketing_list.html
+++ b/docs/reference/ga_remarketing_list.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-List remarketing audiences — ga_remarketing_list • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-List remarketing audiences — ga_remarketing_list • googleAnalyticsR
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    List remarketing audiences
    
-    Source: R/remarketingAudiences.R
+    Source: R/remarketingAudiences.R
     
     
    
 
@@ -295,58 +213,52 @@ 
    List remarketing audiences
    
     
    List remarketing audiences
    
     
    
 
-    
    ga_remarketing_list(accountId, webPropertyId)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    accountId
    Account Id
    webPropertyId
    Web Property Id
    
-
-    
    Value
    
+    
    
+    
    ga_remarketing_list(accountId, webPropertyId)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    accountId
    
+
    Account Id
    
+
    webPropertyId
    
+
    Web Property Id
    
+
    
+    
    
+    
    Value
    
     
    Remarketing audience list
    
-    
    See also
    
-
-    
    About remarketing audiences
    
+    
    
+    
+    
    
 
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_segment_list.html b/docs/reference/ga_segment_list.html
index 915cb12f..51352c52 100644
--- a/docs/reference/ga_segment_list.html
+++ b/docs/reference/ga_segment_list.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Get segments user has access to — ga_segment_list • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Get segments user has access to — ga_segment_list • googleAnalyticsR
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Get segments user has access to
    
-    Source: R/segments.R
+    Source: R/segments.R
     
     
    
 
@@ -295,47 +213,46 @@ 
    Get segments user has access to
    
     
    Get segments user has access to
    
     
    
 
-    
    ga_segment_list()
    
-
-
-    
    Value
    
+    
    
+    
    ga_segment_list()
    
+    
    
 
+    
    
+    
    Value
    
     
    Segment list
    
-    
    See also
    
-
-    
    Other managementAPI functions: 
-ga_experiment_list(),
-ga_experiment(),
-ga_filter_add(),
-ga_filter_apply_to_view(),
-ga_filter_update_filter_link(),
-ga_filter_update()
    
+    
    
+    
    
+    
    See also
    
+    
    Other managementAPI functions: 
+ga_experiment_list(),
+ga_experiment(),
+ga_filter_add(),
+ga_filter_apply_to_view(),
+ga_filter_update_filter_link(),
+ga_filter_update()
    
+    
    
 
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_trackme_event.html b/docs/reference/ga_trackme_event.html
index 3e506016..d216598e 100644
--- a/docs/reference/ga_trackme_event.html
+++ b/docs/reference/ga_trackme_event.html
@@ -1,86 +1,19 @@
-
 
-
-  
-  
-
-
-
-Opt in or out of googleAnalyticsR usage tracking — ga_trackme • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Opt in or out of googleAnalyticsR usage tracking — ga_trackme • googleAnalyticsR
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Opt in or out of googleAnalyticsR usage tracking
    
-    Source: R/measurement_protocol.R
+    Source: R/measurement_protocol.R
     
     
    
 
@@ -297,101 +215,110 @@ 
    Opt in or out of googleAnalyticsR usage tracking
    
 
    If you opt in, ga_trackme_event() is the function that fires.  You can use debug_call=TRUE to see what would be sent before opting in or out.
    
     
    
 
-    
    ga_trackme()
-
-ga_trackme_event(debug_call = FALSE, say_hello = NULL)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    debug_call
    Set as a debug event to see what would be sent
    say_hello
    If you want to add your own custom message to the event sent, add it here!
    
-
-    
    Details
    
+    
    
+    
    ga_trackme()
 
-    
    Running ga_trackme_event() function will send a Measurement Protocol hit via ga_mp_send only if the ~/.R/optin-googleanalyticsr file is present
    
+ga_trackme_event(debug_call = FALSE, say_hello = NULL)
    
+    
    
 
-    
    Examples
    
-    
    
-# control your tracking choices via a menu if in interactive session
-if(interactive()){
-  ga_trackme()
-}
+    
    
+    
    Arguments
    
+    
    debug_call
    
+
    Set as a debug event to see what would be sent
    
+
    say_hello
    
+
    If you want to add your own custom message to the event sent, add it here!
    
+
    
+    
    
+    
    Details
    
+    
    Running ga_trackme_event() function will send a Measurement Protocol hit via ga_mp_send only if the ~/.R/optin-googleanalyticsr file is present
    
+    
    
 
-# this only works with a valid opt-in file present 
-ga_trackme_event()
-
    #> ℹ 2021-10-05 19:17:24 > No consent file found
    #> [1] FALSE
    
-# see what data is sent
-ga_trackme_event(debug_call=TRUE)
-
    #> Warning: cannot open file '/builder/home/.config/googleAnalyticsR/optin-tracking': No such file or directory
    #> ℹ 2021-10-05 19:17:24 > MP Request: https://www.google-analytics.com/debug/mp/collect?measurement_id=G-43MDXK6CLZ&api_secret=_hS_7VJARhqbCq9mF3oiNg 
-#>  {
-#>   "client_id": "12345678.987654",
-#>   "non_personalized_ads": true,
-#>   "events": [
-#>     {
-#>       "name": "r_package_loaded",
-#>       "params": {
-#>         "r_version": "R version 4.0.5 (2021-03-31)",
-#>         "r_platform": "x86_64-pc-linux-gnu (64-bit)",
-#>         "r_locale": "LC_CTYPE=en_US.UTF-8;LC_NUMERIC=C;LC_TIME=en_US.UTF-8;LC_COLLATE=en_US.UTF-8;LC_MONETARY=en_US.UTF-8;LC_MESSAGES=C;LC_PAPER=en_US.UTF-8;LC_NAME=C;LC_ADDRESS=C;LC_TELEPHONE=C;LC_MEASUREMENT=en_US.UTF-8;LC_IDENTIFICATION=C",
-#>         "r_system": "Ubuntu 20.04 LTS",
-#>         "package": "googleAnalyticsR 1.0.1"
-#>       }
-#>     }
-#>   ]
-#> }
    #> 
    #> ℹ 2021-10-05 19:17:24 > Response:  200
    #> ℹ 2021-10-05 19:17:24 > No validation messages found
    #> [1] TRUE
    
-# add your own message!
-ga_trackme_event(debug_call = TRUE, say_hello = "err hello Mark")
-
    #> Warning: cannot open file '/builder/home/.config/googleAnalyticsR/optin-tracking': No such file or directory
    #> ℹ 2021-10-05 19:17:24 > MP Request: https://www.google-analytics.com/debug/mp/collect?measurement_id=G-43MDXK6CLZ&api_secret=_hS_7VJARhqbCq9mF3oiNg 
-#>  {
-#>   "client_id": "12345678.987654",
-#>   "non_personalized_ads": true,
-#>   "events": [
-#>     {
-#>       "name": "r_package_loaded",
-#>       "params": {
-#>         "r_version": "R version 4.0.5 (2021-03-31)",
-#>         "r_platform": "x86_64-pc-linux-gnu (64-bit)",
-#>         "r_locale": "LC_CTYPE=en_US.UTF-8;LC_NUMERIC=C;LC_TIME=en_US.UTF-8;LC_COLLATE=en_US.UTF-8;LC_MONETARY=en_US.UTF-8;LC_MESSAGES=C;LC_PAPER=en_US.UTF-8;LC_NAME=C;LC_ADDRESS=C;LC_TELEPHONE=C;LC_MEASUREMENT=en_US.UTF-8;LC_IDENTIFICATION=C",
-#>         "r_system": "Ubuntu 20.04 LTS",
-#>         "say_hello": "err hello Mark",
-#>         "package": "googleAnalyticsR 1.0.1"
-#>       }
-#>     }
-#>   ]
-#> }
    #> 
    #> ℹ 2021-10-05 19:17:24 > Response:  200
    #> ℹ 2021-10-05 19:17:24 > No validation messages found
    #> [1] TRUE
    
+    
    
+    
    Examples
    
+    
    
+# control your tracking choices via a menu if in interactive session
+if(interactive()){
+  ga_trackme()
+}
+
+# this only works with a valid opt-in file present 
+ga_trackme_event()
+#> ℹ 2022-01-13 13:01:07 > No consent file found
+#> [1] FALSE
+
+# see what data is sent
+ga_trackme_event(debug_call=TRUE)
+#> Warning: cannot open file '/builder/home/.config/googleAnalyticsR/optin-tracking': No such file or directory
+#> ℹ 2022-01-13 13:01:07 > MP Request: https://www.google-analytics.com/debug/mp/collect?measurement_id=G-43MDXK6CLZ&api_secret=_hS_7VJARhqbCq9mF3oiNg 
+#>  {
+#>   "client_id": "12345678.987654",
+#>   "non_personalized_ads": true,
+#>   "events": [
+#>     {
+#>       "name": "r_package_loaded",
+#>       "params": {
+#>         "r_version": "R version 4.1.2 (2021-11-01)",
+#>         "r_platform": "x86_64-pc-linux-gnu (64-bit)",
+#>         "r_locale": "LC_CTYPE=en_US.UTF-8;LC_NUMERIC=C;LC_TIME=en_US.UTF-8;LC_COLLATE=C;LC_MONETARY=en_US.UTF-8;LC_MESSAGES=en_US.UTF-8;LC_PAPER=en_US.UTF-8;LC_NAME=C;LC_ADDRESS=C;LC_TELEPHONE=C;LC_MEASUREMENT=en_US.UTF-8;LC_IDENTIFICATION=C",
+#>         "r_system": "Ubuntu 20.04.3 LTS",
+#>         "package": "googleAnalyticsR 1.0.1"
+#>       }
+#>     }
+#>   ]
+#> }
+#> 
+#> ℹ 2022-01-13 13:01:07 > Response:  200
+#> ℹ 2022-01-13 13:01:07 > No validation messages found
+#> [1] TRUE
+
+# add your own message!
+ga_trackme_event(debug_call = TRUE, say_hello = "err hello Mark")
+#> Warning: cannot open file '/builder/home/.config/googleAnalyticsR/optin-tracking': No such file or directory
+#> ℹ 2022-01-13 13:01:08 > MP Request: https://www.google-analytics.com/debug/mp/collect?measurement_id=G-43MDXK6CLZ&api_secret=_hS_7VJARhqbCq9mF3oiNg 
+#>  {
+#>   "client_id": "12345678.987654",
+#>   "non_personalized_ads": true,
+#>   "events": [
+#>     {
+#>       "name": "r_package_loaded",
+#>       "params": {
+#>         "r_version": "R version 4.1.2 (2021-11-01)",
+#>         "r_platform": "x86_64-pc-linux-gnu (64-bit)",
+#>         "r_locale": "LC_CTYPE=en_US.UTF-8;LC_NUMERIC=C;LC_TIME=en_US.UTF-8;LC_COLLATE=C;LC_MONETARY=en_US.UTF-8;LC_MESSAGES=en_US.UTF-8;LC_PAPER=en_US.UTF-8;LC_NAME=C;LC_ADDRESS=C;LC_TELEPHONE=C;LC_MEASUREMENT=en_US.UTF-8;LC_IDENTIFICATION=C",
+#>         "r_system": "Ubuntu 20.04.3 LTS",
+#>         "say_hello": "err hello Mark",
+#>         "package": "googleAnalyticsR 1.0.1"
+#>       }
+#>     }
+#>   ]
+#> }
+#> 
+#> ℹ 2022-01-13 13:01:08 > Response:  200
+#> ℹ 2022-01-13 13:01:08 > No validation messages found
+#> [1] TRUE
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_unsampled.html b/docs/reference/ga_unsampled.html
index d25fe318..c0adbcbe 100644
--- a/docs/reference/ga_unsampled.html
+++ b/docs/reference/ga_unsampled.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Get Unsampled Report Meta Data — ga_unsampled • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Get Unsampled Report Meta Data — ga_unsampled • googleAnalyticsR
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Get Unsampled Report Meta Data
    
-    Source: R/unsampled.R
+    Source: R/unsampled.R
     
     
    
 
@@ -295,63 +213,53 @@ 
    Get Unsampled Report Meta Data
    
     
    Get Unsampled Report Meta Data
    
     
    
 
-    
    ga_unsampled(accountId, webPropertyId, profileId, unsampledReportId)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    accountId
    Account Id
    webPropertyId
    Web Property Id
    profileId
    Profile Id
    unsampledReportId
    Unsampled Report Id
    
-
-    
    Value
    
+    
    
+    
    ga_unsampled(accountId, webPropertyId, profileId, unsampledReportId)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    accountId
    
+
    Account Id
    
+
    webPropertyId
    
+
    Web Property Id
    
+
    profileId
    
+
    Profile Id
    
+
    unsampledReportId
    
+
    Unsampled Report Id
    
+
    
+    
    
+    
    Value
    
     
    Unsampled Report Meta Data
    
-    
    See also
    
-
-    
    Other unsampled download functions: 
-ga_unsampled_download(),
-ga_unsampled_list()
    
+    
    
+    
    
+    
    See also
    
+    
    Other unsampled download functions: 
+ga_unsampled_download(),
+ga_unsampled_list()
    
+    
    
 
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_unsampled_download.html b/docs/reference/ga_unsampled_download.html
index 24545d82..47689dcc 100644
--- a/docs/reference/ga_unsampled_download.html
+++ b/docs/reference/ga_unsampled_download.html
@@ -1,91 +1,24 @@
-
 
-
-  
-  
-
-
-
-Download Unsampled Report from Google Drive. You must be authenticated with the
+<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>Download Unsampled Report from Google Drive. You must be authenticated with the
 same account that you setup the unsampled report. This means service account
-authentication is not supported. — ga_unsampled_download • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Download Unsampled Report from Google Drive. You must be authenticated with the
 same account that you setup the unsampled report. This means service account
 authentication is not supported.
    
-    Source: R/unsampled.R
+    Source: R/unsampled.R
     
     
    
 
@@ -305,100 +223,90 @@ 
    Download Unsampled Report from Google Drive. You must be authenticated with
 authentication is not supported.
    
     
    
 
-    
    ga_unsampled_download(
-  reportTitle,
-  accountId,
-  webPropertyId,
-  profileId,
-  downloadFile = TRUE
-)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    reportTitle
    Title of Unsampled Report (case-sensitive)
    accountId
    Account Id
    webPropertyId
    Web Property Id
    profileId
    Profile Id
    downloadFile
    Default TRUE, whether to download, if FALSE returns a dataframe instead
    
-
-    
    Value
    
+    
    
+    
    ga_unsampled_download(
+  reportTitle,
+  accountId,
+  webPropertyId,
+  profileId,
+  downloadFile = TRUE
+)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    reportTitle
    
+
    Title of Unsampled Report (case-sensitive)
    
+
    accountId
    
+
    Account Id
    
+
    webPropertyId
    
+
    Web Property Id
    
+
    profileId
    
+
    Profile Id
    
+
    downloadFile
    
+
    Default TRUE, whether to download, if FALSE returns a dataframe instead
    
+
    
+    
    
+    
    Value
    
     
    file location if downloadFile is TRUE, else a data.frame of download
    
-    
    See also
    
-
-    
    Other unsampled download functions: 
-ga_unsampled_list(),
-ga_unsampled()
    
-
-    
    Examples
    
-    
    
-if (FALSE) {
-
-    # get data.frame of unsampled reports you have available
-    unsample_list <- ga_unsampled_list(accountId = "12345", 
-                                       webPropertyId = "UA-12345-4", 
-                                       profileId = "129371234")
-                                       
-    # loop through unsampled reports and download as a list of data.frames
-    dl <- lapply(unsample_list$title, ga_unsampled_download, 
-                 accountId = "12345", 
-                 webPropertyId = "UA-12345-4", 
-                 profileId = "129371234", 
-                 downloadFile = FALSE)
-                 
-    # inspect first data.frame
-    dl[[1]]
-    
-    # download unsampled report to csv file
-    ga_unsampled_download("my_report_title", 
-                          accountId = "12345", 
-                          webPropertyId = "UA-12345-4", 
-                          profileId = "129371234")
+    
    
+    
    
+    
    See also
    
+    
    Other unsampled download functions: 
+ga_unsampled_list(),
+ga_unsampled()
    
+    
    
 
-}
-
    
+    
    
+    
    Examples
    
+    
    
+if (FALSE) {
+
+    # get data.frame of unsampled reports you have available
+    unsample_list <- ga_unsampled_list(accountId = "12345", 
+                                       webPropertyId = "UA-12345-4", 
+                                       profileId = "129371234")
+                                       
+    # loop through unsampled reports and download as a list of data.frames
+    dl <- lapply(unsample_list$title, ga_unsampled_download, 
+                 accountId = "12345", 
+                 webPropertyId = "UA-12345-4", 
+                 profileId = "129371234", 
+                 downloadFile = FALSE)
+                 
+    # inspect first data.frame
+    dl[[1]]
+    
+    # download unsampled report to csv file
+    ga_unsampled_download("my_report_title", 
+                          accountId = "12345", 
+                          webPropertyId = "UA-12345-4", 
+                          profileId = "129371234")
+
+}
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_unsampled_list.html b/docs/reference/ga_unsampled_list.html
index 512014c7..fa7fe53d 100644
--- a/docs/reference/ga_unsampled_list.html
+++ b/docs/reference/ga_unsampled_list.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-List Unsampled Reports — ga_unsampled_list • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-List Unsampled Reports — ga_unsampled_list • googleAnalyticsR
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    List Unsampled Reports
    
-    Source: R/unsampled.R
+    Source: R/unsampled.R
     
     
    
 
@@ -295,89 +213,83 @@ 
    List Unsampled Reports
    
     
    List Unsampled Reports
    
     
    
 
-    
    ga_unsampled_list(accountId, webPropertyId, profileId)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    accountId
    Account Id
    webPropertyId
    Web Property Id
    profileId
    Profile Id
    
-
-    
    Value
    
+    
    
+    
    ga_unsampled_list(accountId, webPropertyId, profileId)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    accountId
    
+
    Account Id
    
+
    webPropertyId
    
+
    Web Property Id
    
+
    profileId
    
+
    Profile Id
    
+
    
+    
    
+    
    Value
    
     
    Unsampled Reports List
    
-    
    See also
    
-
-    
    Other unsampled download functions: 
-ga_unsampled_download(),
-ga_unsampled()
    
-
-    
    Examples
    
-    
    
-if (FALSE) {
-
-    # get data.frame of unsampled reports you have available
-    unsample_list <- ga_unsampled_list(accountId = "12345", 
-                                       webPropertyId = "UA-12345-4", 
-                                       profileId = "129371234")
-                                       
-    # loop through unsampled reports and download as a list of data.frames
-    dl <- lapply(unsample_list$title, ga_unsampled_download, 
-                 accountId = "12345", 
-                 webPropertyId = "UA-12345-4", 
-                 profileId = "129371234", 
-                 downloadFile = FALSE)
-                 
-    # inspect first data.frame
-    dl[[1]]
-    
-    # download unsampled report to csv file
-    ga_unsampled_download("my_report_title", 
-                          accountId = "12345", 
-                          webPropertyId = "UA-12345-4", 
-                          profileId = "129371234")
-
-}
-
-
+    
    
+    
    
+    
    See also
    
+    
    Other unsampled download functions: 
+ga_unsampled_download(),
+ga_unsampled()
    
+    
    
 
-
    
+    
    
+    
    Examples
    
+    
    
+if (FALSE) {
+
+    # get data.frame of unsampled reports you have available
+    unsample_list <- ga_unsampled_list(accountId = "12345", 
+                                       webPropertyId = "UA-12345-4", 
+                                       profileId = "129371234")
+                                       
+    # loop through unsampled reports and download as a list of data.frames
+    dl <- lapply(unsample_list$title, ga_unsampled_download, 
+                 accountId = "12345", 
+                 webPropertyId = "UA-12345-4", 
+                 profileId = "129371234", 
+                 downloadFile = FALSE)
+                 
+    # inspect first data.frame
+    dl[[1]]
+    
+    # download unsampled report to csv file
+    ga_unsampled_download("my_report_title", 
+                          accountId = "12345", 
+                          webPropertyId = "UA-12345-4", 
+                          profileId = "129371234")
+
+}
+
+
+
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_users_add.html b/docs/reference/ga_users_add.html
index c7ad22de..2bddd949 100644
--- a/docs/reference/ga_users_add.html
+++ b/docs/reference/ga_users_add.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Create or update user access to Google Analytics — ga_users_add • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Create or update user access to Google Analytics — ga_users_add • googleAnalyticsR
-
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Create or update user access to Google Analytics
    
-    Source: R/users.R
+    Source: R/users.R
     
     
    
 
     
    
-    
    If you supply more than one email, then batch processing will be applied.  Batching has special rules that give you 30 operations for the cost of one API call against your quota. When batching you will only get a TRUE result on successful batch, but individual entries may have failed.  Check via ga_users_list afterwards and try to add individual linkIds to get more descriptive error messages.
    
+    
    If you supply more than one email, then batch processing will be applied.  Batching has special rules that give you 30 operations for the cost of one API call against your quota. When batching you will only get a TRUE result on successful batch, but individual entries may have failed.  Check via ga_users_list afterwards and try to add individual linkIds to get more descriptive error messages.
    
     
    
 
-    
    ga_users_add(
-  email,
-  permissions,
-  accountId,
-  webPropertyId = NULL,
-  viewId = NULL
-)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    email
    The email(s) of the user(s) to add.  Has to have a Google account.
    permissions
    Which permissions to add as a vector - "MANAGE_USERS","EDIT","COLLABORATE","READ_AND_ANALYZE"
    accountId
    Account Id
    webPropertyId
    Web Property Id - set to NULL to operate on account level only
    viewId
    viewId - set to NULL to operate on webProperty level only
    
-
-    
    Value
    
+    
    
+    
    ga_users_add(
+  email,
+  permissions,
+  accountId,
+  webPropertyId = NULL,
+  viewId = NULL
+)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    email
    
+
    The email(s) of the user(s) to add.  Has to have a Google account.
    
+
    permissions
    
+
    Which permissions to add as a vector - "MANAGE_USERS","EDIT","COLLABORATE","READ_AND_ANALYZE"
    
+
    accountId
    
+
    Account Id
    
+
    webPropertyId
    
+
    Web Property Id - set to NULL to operate on account level only
    
+
    viewId
    
+
    viewId - set to NULL to operate on webProperty level only
    
+
    
+    
    
+    
    Value
    
     
    TRUE if successful
    
-    
    See also
    
-
-    
    Google help article on user permissions
    
+    
    
+    
    
+    
    See also
    
+    
    Google help article on user permissions
    
 
    Other User management functions: 
-ga_users_delete_linkid(),
-ga_users_delete(),
-ga_users_list(),
-ga_users_update()
    
-
-    
    Examples
    
-    
    
-if (FALSE) {
-library(googleAnalyticsR)
-ga_auth()
-
-ga_users_add(c("the_email@company.com", "another_email@company.com"), 
-             permissions = "EDIT", accountId = 47480439)
+ga_users_delete_linkid(),
+ga_users_delete(),
+ga_users_list(),
+ga_users_update()
    
+    
    
 
-}
-
    
+    
    
+    
    Examples
    
+    
    
+if (FALSE) {
+library(googleAnalyticsR)
+ga_auth()
+
+ga_users_add(c("the_email@company.com", "another_email@company.com"), 
+             permissions = "EDIT", accountId = 47480439)
+
+}
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_users_delete.html b/docs/reference/ga_users_delete.html
index 8f88bd98..dfb204ae 100644
--- a/docs/reference/ga_users_delete.html
+++ b/docs/reference/ga_users_delete.html
@@ -1,86 +1,19 @@
-
 
-
-  
-  
-
-
-
-Delete all user access for an email — ga_users_delete • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Delete all user access for an email — ga_users_delete • googleAnalyticsR
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Delete all user access for an email
    
-    Source: R/users.R
+    Source: R/users.R
     
     
    
 
     
    
-    
    This is a wrapper around calls to ga_users_list and ga_users_delete_linkid.  If you want more fine-grained control look at those functions.
    
+    
    This is a wrapper around calls to ga_users_list and ga_users_delete_linkid.  If you want more fine-grained control look at those functions.
    
 
    The user email is deleted from all web properties and views underneath the accountId you provide.
    
     
    
 
-    
    ga_users_delete(email, accountId)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    email
    The email of the user to delete
    accountId
    The accountId that the user will be deleted from including all web properties and Views underneath.
    
-
-    
    Details
    
+    
    
+    
    ga_users_delete(email, accountId)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    email
    
+
    The email of the user to delete
    
+
    accountId
    
+
    The accountId that the user will be deleted from including all web properties and Views underneath.
    
+
    
+    
    
+    
    Details
    
     
    This deletes a user via their email reference for all webproperties and views for the account given.
    
-    
    See also
    
-
-    
    Google Documentation
    
+    
    
+    
    
+    
    See also
    
+    
    Google Documentation
    
 
    Other User management functions: 
-ga_users_add(),
-ga_users_delete_linkid(),
-ga_users_list(),
-ga_users_update()
    
-
-    
    Examples
    
-    
    
-if (FALSE) {
-
-library(googleAnalyticsR)
-ga_auth()
-ga_users_delete("brian@agency.com", 12345678)
-
-# multiple emails
-ga_users_delete(c("brian@agency.com", "bill@benland.com"), 1234567)
+ga_users_add(),
+ga_users_delete_linkid(),
+ga_users_list(),
+ga_users_update()
    
+    
    
 
-}
-
    
+    
    
+    
    Examples
    
+    
    
+if (FALSE) {
+
+library(googleAnalyticsR)
+ga_auth()
+ga_users_delete("brian@agency.com", 12345678)
+
+# multiple emails
+ga_users_delete(c("brian@agency.com", "bill@benland.com"), 1234567)
+
+}
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_users_delete_linkid.html b/docs/reference/ga_users_delete_linkid.html
index 895fc6bf..fd042990 100644
--- a/docs/reference/ga_users_delete_linkid.html
+++ b/docs/reference/ga_users_delete_linkid.html
@@ -1,87 +1,20 @@
-
 
-
-  
-  
-
-
-
-Delete users access from account, webproperty or view level — ga_users_delete_linkid • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Delete users access from account, webproperty or view level — ga_users_delete_linkid • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Delete users access from account, webproperty or view level
    
-    Source: R/users.R
+    Source: R/users.R
     
     
    
 
     
    
     
    The linkId is in the form of the accountId/webPropertyId/viewId colon separated from a link unique Id.
    
 
    Delete user access by supplying the linkId for that user at the level they have been given access.  It won't work to delete user links at account level if they have been assigned at web property or view level - you will need to get the linkId for that level instead. e.g. a user needs permissions.local to be non-NULL to be deleted at that level.  The parameter check will do this check before deletion and throw an error if they can not be deleted.   Set this to check=FALSE to suppress this behaviour.
    
-
    If you supply more than one linkId, then batch processing will be applied.  Batching has special rules that give you 30 operations for the cost of one API call against your quota. When batching you will only get a TRUE result on successful batch, but individual linkIds may have failed.  Check via ga_users_list afterwards and try to delete individual linkIds to get more descriptive error messages.
    
+
    If you supply more than one linkId, then batch processing will be applied.  Batching has special rules that give you 30 operations for the cost of one API call against your quota. When batching you will only get a TRUE result on successful batch, but individual linkIds may have failed.  Check via ga_users_list afterwards and try to delete individual linkIds to get more descriptive error messages.
    
     
    
 
-    
    ga_users_delete_linkid(
-  linkId,
-  accountId,
-  webPropertyId = NULL,
-  viewId = NULL,
-  check = TRUE
-)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    linkId
    The linkId(s) that is available using ga_users_list e.g. 47480439:104185380183364788718
    accountId
    Account Id
    webPropertyId
    Web Property Id - set to NULL to operate on account level only
    viewId
    viewId - set to NULL to operate on webProperty level only
    check
    If the default TRUE will check that the user has user access at the level you are trying to delete them from - if not will throw an error.
    
-
-    
    Value
    
+    
    
+    
    ga_users_delete_linkid(
+  linkId,
+  accountId,
+  webPropertyId = NULL,
+  viewId = NULL,
+  check = TRUE
+)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    linkId
    
+
    The linkId(s) that is available using ga_users_list e.g. 47480439:104185380183364788718
    
+
    accountId
    
+
    Account Id
    
+
    webPropertyId
    
+
    Web Property Id - set to NULL to operate on account level only
    
+
    viewId
    
+
    viewId - set to NULL to operate on webProperty level only
    
+
    check
    
+
    If the default TRUE will check that the user has user access at the level you are trying to delete them from - if not will throw an error.
    
+
    
+    
    
+    
    Value
    
     
    TRUE if the deletion is successful, an error if not.
    
-    
    See also
    
-
-    
    Google Documentation
    
+    
    
+    
    
+    
    See also
    
+    
    Google Documentation
    
 
    Other User management functions: 
-ga_users_add(),
-ga_users_delete(),
-ga_users_list(),
-ga_users_update()
    
-
-    
    Examples
    
-    
    
-if (FALSE) {
-
-library(googleAnalyticsR)
-ga_auth()
-
-# get the linkId for the user you want to delete
-ga_users_list(47480439, webPropertyId = "UA-47480439-2", viewId = 81416156)
-ga_users_delete_linkid("81416156:114834495587136933146", 
-                       accountId = 47480439, 
-                       webPropertyId = "UA-47480439-2", 
-                       viewId = 81416156)
-
-# check its gone
-ga_users_list(47480439, webPropertyId = "UA-47480439-2", viewId = 81416156)
-
-# can only delete at level user has access, the above deletion woud have failed if via:
-ga_users_delete_linkid("47480439:114834495587136933146", 47480439)
+ga_users_add(),
+ga_users_delete(),
+ga_users_list(),
+ga_users_update()
    
+    
    
 
-}
-
    
+    
    
+    
    Examples
    
+    
    
+if (FALSE) {
+
+library(googleAnalyticsR)
+ga_auth()
+
+# get the linkId for the user you want to delete
+ga_users_list(47480439, webPropertyId = "UA-47480439-2", viewId = 81416156)
+ga_users_delete_linkid("81416156:114834495587136933146", 
+                       accountId = 47480439, 
+                       webPropertyId = "UA-47480439-2", 
+                       viewId = 81416156)
+
+# check its gone
+ga_users_list(47480439, webPropertyId = "UA-47480439-2", viewId = 81416156)
+
+# can only delete at level user has access, the above deletion woud have failed if via:
+ga_users_delete_linkid("47480439:114834495587136933146", 47480439)
+
+}
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_users_list.html b/docs/reference/ga_users_list.html
index 2b92657e..cecb8554 100644
--- a/docs/reference/ga_users_list.html
+++ b/docs/reference/ga_users_list.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-List Users — ga_users_list • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-List Users — ga_users_list • googleAnalyticsR
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    List Users
    
-    Source: R/users.R
+    Source: R/users.R
     
     
    
 
@@ -295,79 +213,74 @@ 
    List Users
    
     
    Get a list of Account level user links, or if you supply the webPropertyId or viewId it will show user links at that level
    
     
    
 
-    
    ga_users_list(accountId, webPropertyId = "~all", viewId = "~all")
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    accountId
    Account Id
    webPropertyId
    Web Property Id - set to NULL to operate on account level only
    viewId
    viewId - set to NULL to operate on webProperty level only
    
-
-    
    Value
    
+    
    
+    
    ga_users_list(accountId, webPropertyId = "~all", viewId = "~all")
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    accountId
    
+
    Account Id
    
+
    webPropertyId
    
+
    Web Property Id - set to NULL to operate on account level only
    
+
    viewId
    
+
    viewId - set to NULL to operate on webProperty level only
    
+
    
+    
    
+    
    Value
    
     
    A data.frame of user entity links including the linkId, email and permissions
    
-    
    Details
    
-
+    
    
+    
    
+    
    Details
    
     
    Will list users on an account, webproperty or view level
    
-    
    See also
    
-
-    
    Account User Links Google Documentation
    
+    
    
+    
    
+    
    See also
    
+    
    Account User Links Google Documentation
    
 
    Other User management functions: 
-ga_users_add(),
-ga_users_delete_linkid(),
-ga_users_delete(),
-ga_users_update()
    
-
-    
    Examples
    
-    
    
-if (FALSE) {
-
-library(googleAnalyticsR)
-ga_auth()
-ga_users_list(47480439)
-ga_users_list(47480439, webPropertyId = "UA-47480439-2")
-ga_users_list(47480439, webPropertyId = "UA-47480439-2", viewId = 81416156)
+ga_users_add(),
+ga_users_delete_linkid(),
+ga_users_delete(),
+ga_users_update()
    
+    
    
 
-# use NULL to only list linkids for that level
-ga_users_list(47480439, webPropertyId = NULL, viewId = NULL)
-}
-
    
+    
    
+    
    Examples
    
+    
    
+if (FALSE) {
+
+library(googleAnalyticsR)
+ga_auth()
+ga_users_list(47480439)
+ga_users_list(47480439, webPropertyId = "UA-47480439-2")
+ga_users_list(47480439, webPropertyId = "UA-47480439-2", viewId = 81416156)
+
+# use NULL to only list linkids for that level
+ga_users_list(47480439, webPropertyId = NULL, viewId = NULL)
+}
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_users_update.html b/docs/reference/ga_users_update.html
index 416d19d5..6c10a64a 100644
--- a/docs/reference/ga_users_update.html
+++ b/docs/reference/ga_users_update.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Update a user access in Google Analytics — ga_users_update • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Update a user access in Google Analytics — ga_users_update • googleAnalyticsR
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Update a user access in Google Analytics
    
-    Source: R/users.R
+    Source: R/users.R
     
     
    
 
@@ -295,93 +213,83 @@ 
    Update a user access in Google Analytics
    
     
    This is for altering existing user access.
    
     
    
 
-    
    ga_users_update(
-  linkId,
-  update_object,
-  accountId,
-  webPropertyId = NULL,
-  viewId = NULL
-)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    linkId
    The linkId to update
    update_object
    A list that will be turned into JSON that represents the new configuration for this linkId
    accountId
    Account Id
    webPropertyId
    Web Property Id - set to NULL to operate on account level only
    viewId
    viewId - set to NULL to operate on webProperty level only
    
-
-    
    Value
    
+    
    
+    
    ga_users_update(
+  linkId,
+  update_object,
+  accountId,
+  webPropertyId = NULL,
+  viewId = NULL
+)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    linkId
    
+
    The linkId to update
    
+
    update_object
    
+
    A list that will be turned into JSON that represents the new configuration for this linkId
    
+
    accountId
    
+
    Account Id
    
+
    webPropertyId
    
+
    Web Property Id - set to NULL to operate on account level only
    
+
    viewId
    
+
    viewId - set to NULL to operate on webProperty level only
    
+
    
+    
    
+    
    Value
    
     
    The new user object that has been altered.
    
-    
    See also
    
-
-    
    Google help article on user permissions
    
+    
    
+    
    
+    
    See also
    
+    
    Google help article on user permissions
    
 
    Other User management functions: 
-ga_users_add(),
-ga_users_delete_linkid(),
-ga_users_delete(),
-ga_users_list()
    
-
-    
    Examples
    
-    
    
-if (FALSE) {
-
-library(googleAnalyticsR)
-ga_auth()
-
-# the update to perform
-o <- list(permissions = list(local = list("EDIT")))
+ga_users_add(),
+ga_users_delete_linkid(),
+ga_users_delete(),
+ga_users_list()
    
+    
    
 
-ga_users_update("UA-123456-1:1111222233334444",
-                update_object = o,
-                accountId = 47480439,
-                webPropertyId = "UA-123456-1")
-                
-}
-
    
+    
    
+    
    Examples
    
+    
    
+if (FALSE) {
+
+library(googleAnalyticsR)
+ga_auth()
+
+# the update to perform
+o <- list(permissions = list(local = list("EDIT")))
+
+ga_users_update("UA-123456-1:1111222233334444",
+                update_object = o,
+                accountId = 47480439,
+                webPropertyId = "UA-123456-1")
+                
+}
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_view.html b/docs/reference/ga_view.html
index bcc5821e..378bda95 100644
--- a/docs/reference/ga_view.html
+++ b/docs/reference/ga_view.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Get single View (Profile) — ga_view • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Get single View (Profile) — ga_view • googleAnalyticsR
-
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Get single View (Profile)
    
-    Source: R/views.R
+    Source: R/views.R
     
     
    
 
@@ -295,71 +213,65 @@ 
    Get single View (Profile)
    
     
    Gets meta-data for a particular View/Profile
    
     
    
 
-    
    ga_view(accountId, webPropertyId, profileId)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    accountId
    Account Id
    webPropertyId
    Web Property Id
    profileId
    Profile (View) Id
    
-
-    
    Value
    
+    
    
+    
    ga_view(accountId, webPropertyId, profileId)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    accountId
    
+
    Account Id
    
+
    webPropertyId
    
+
    Web Property Id
    
+
    profileId
    
+
    Profile (View) Id
    
+
    
+    
    
+    
    Value
    
     
    A list of the Views meta-data.
    
-    
    See also
    
-
-    
    Other account structure functions: 
-ga_account_list(),
-ga_accounts(),
-ga_view_list(),
-ga_webproperty_list(),
-ga_webproperty()
    
-
-    
    Examples
    
-    
    
-if (FALSE) {
+    
    
+    
    
+    
    See also
    
+    
    Other account structure functions: 
+ga_account_list(),
+ga_accounts(),
+ga_view_list(),
+ga_webproperty_list(),
+ga_webproperty()
    
+    
    
 
-library(googleAnalyticsR)
-ga_auth()
-ga_view(1058095, webPropertyId = "UA-1058095-1", profileId = 1855267)
-}
-
    
+    
    
+    
    Examples
    
+    
    
+if (FALSE) {
+
+library(googleAnalyticsR)
+ga_auth()
+ga_view(1058095, webPropertyId = "UA-1058095-1", profileId = 1855267)
+}
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_view_list.html b/docs/reference/ga_view_list.html
index d3a1347a..fb78be1c 100644
--- a/docs/reference/ga_view_list.html
+++ b/docs/reference/ga_view_list.html
@@ -1,86 +1,19 @@
-
 
-
-  
-  
-
-
-
-List View (Profile) — ga_view_list • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-List View (Profile) — ga_view_list • googleAnalyticsR
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    List View (Profile)
    
-    Source: R/views.R
+    Source: R/views.R
     
     
    
 
     
    
     
    This gets the meta data associated with the Google Analytics Views for a particular accountId and webPropertyId.
-If you want all viewId information for all accounts you have access to, use ga_account_list instead.
    
+If you want all viewId information for all accounts you have access to, use ga_account_list instead.
    
     
    
 
-    
    ga_view_list(accountId, webPropertyId)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    accountId
    Account Id
    webPropertyId
    Web Property Id e.g. UA-12345-1
    
-
-    
    Value
    
+    
    
+    
    ga_view_list(accountId, webPropertyId)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    accountId
    
+
    Account Id
    
+
    webPropertyId
    
+
    Web Property Id e.g. UA-12345-1
    
+
    
+    
    
+    
    Value
    
     
    A data.frame of meta-data for the views
    
-    
    See also
    
-
-    
    Other account structure functions: 
-ga_account_list(),
-ga_accounts(),
-ga_view(),
-ga_webproperty_list(),
-ga_webproperty()
    
+    
    
+    
    
+    
    See also
    
+    
    Other account structure functions: 
+ga_account_list(),
+ga_accounts(),
+ga_view(),
+ga_webproperty_list(),
+ga_webproperty()
    
+    
    
 
-    
    Examples
    
-    
    
-if (FALSE) {
-library(googleAnalyticsR)
-ga_auth()
-views <- ga_view_list(1058095, "UA-1058095-1")
-}
-
    
+    
    
+    
    Examples
    
+    
    
+if (FALSE) {
+library(googleAnalyticsR)
+ga_auth()
+views <- ga_view_list(1058095, "UA-1058095-1")
+}
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_webproperty.html b/docs/reference/ga_webproperty.html
index 4b566a02..b6010d66 100644
--- a/docs/reference/ga_webproperty.html
+++ b/docs/reference/ga_webproperty.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Get a web property — ga_webproperty • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Get a web property — ga_webproperty • googleAnalyticsR
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Get a web property
    
-    Source: R/webprops.R
+    Source: R/webprops.R
     
     
    
 
@@ -295,66 +213,62 @@ 
    Get a web property
    
     
    Gets metadata for one particular web property
    
     
    
 
-    
    ga_webproperty(accountId, webPropertyId)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    accountId
    Account Id
    webPropertyId
    Web Property Id e.g. UA-12345-1
    
-
-    
    Value
    
+    
    
+    
    ga_webproperty(accountId, webPropertyId)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    accountId
    
+
    Account Id
    
+
    webPropertyId
    
+
    Web Property Id e.g. UA-12345-1
    
+
    
+    
    
+    
    Value
    
     
    webproperty
    
-    
    See also
    
-
-    
    Other account structure functions: 
-ga_account_list(),
-ga_accounts(),
-ga_view_list(),
-ga_view(),
-ga_webproperty_list()
    
+    
    
+    
    
+    
    See also
    
+    
    Other account structure functions: 
+ga_account_list(),
+ga_accounts(),
+ga_view_list(),
+ga_view(),
+ga_webproperty_list()
    
+    
    
 
-    
    Examples
    
-    
    
-if (FALSE) {
-library(googleAnalyticsR)
-ga_auth()
-wp <- ga_webproperty(1058095, "UA-1058095-1")
-}
-
    
+    
    
+    
    Examples
    
+    
    
+if (FALSE) {
+library(googleAnalyticsR)
+ga_auth()
+wp <- ga_webproperty(1058095, "UA-1058095-1")
+}
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/ga_webproperty_list.html b/docs/reference/ga_webproperty_list.html
index 3b988a38..6a7ddb1c 100644
--- a/docs/reference/ga_webproperty_list.html
+++ b/docs/reference/ga_webproperty_list.html
@@ -1,86 +1,19 @@
-
 
-
-  
-  
-
-
-
-List web properties — ga_webproperty_list • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-List web properties — ga_webproperty_list • googleAnalyticsR
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    List web properties
    
-    Source: R/webprops.R
+    Source: R/webprops.R
     
     
    
 
     
    
     
    This gets the meta data for web properties associated with a particular accountId.
-If you want all information available to your user, use ga_account_list instead.
    
+If you want all information available to your user, use ga_account_list instead.
    
     
    
 
-    
    ga_webproperty_list(accountId)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
    accountId
    Account Id
    
-
-    
    Value
    
+    
    
+    
    ga_webproperty_list(accountId)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    accountId
    
+
    Account Id
    
+
    
+    
    
+    
    Value
    
     
    A data.frame of webproperty meta-data
    
-    
    See also
    
-
-    
    Other account structure functions: 
-ga_account_list(),
-ga_accounts(),
-ga_view_list(),
-ga_view(),
-ga_webproperty()
    
+    
    
+    
    
+    
    See also
    
+    
    Other account structure functions: 
+ga_account_list(),
+ga_accounts(),
+ga_view_list(),
+ga_view(),
+ga_webproperty()
    
+    
    
 
-    
    Examples
    
-    
    
-if (FALSE) {
-library(googleAnalyticsR)
-ga_auth()
-aa <- ga_accounts()
-wp <- ga_webproperty_list(aa$id[1])
-}
-
    
+    
    
+    
    Examples
    
+    
    
+if (FALSE) {
+library(googleAnalyticsR)
+ga_auth()
+aa <- ga_accounts()
+wp <- ga_webproperty_list(aa$id[1])
+}
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/googleAnalyticsR.html b/docs/reference/googleAnalyticsR.html
index 64b1e0c3..5b0fae50 100644
--- a/docs/reference/googleAnalyticsR.html
+++ b/docs/reference/googleAnalyticsR.html
@@ -1,86 +1,19 @@
-
 
-
-  
-  
-
-
-
-Library for getting Google Analytics data into R — googleAnalyticsR • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Library for getting Google Analytics data into R — googleAnalyticsR • googleAnalyticsR
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Library for getting Google Analytics data into R
    
-    Source: R/googleAnalyticsR.R
+    Source: R/googleAnalyticsR.R
     
     
    
 
     
    
-    
    googleAnalyticsR
    
-
    Follow the online documentation here: https://code.markedmondson.me/googleAnalyticsR/
    
+    
    googleAnalyticsR
    
+
    Follow the online documentation here: https://code.markedmondson.me/googleAnalyticsR/
    
     
    
 
 
 
-
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/google_analytics.html b/docs/reference/google_analytics.html
index 24addf35..e2358181 100644
--- a/docs/reference/google_analytics.html
+++ b/docs/reference/google_analytics.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Get Google Analytics v4 data — google_analytics • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Get Google Analytics v4 data — google_analytics • googleAnalyticsR
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Get Google Analytics v4 data
    
-    Source: R/ga_v4_get.R
+    Source: R/ga_v4_get.R
     
     
    
 
     
    
-    
    Fetch Google Analytics data using the v4 API.  For the v3 API use google_analytics_3, for GA4's Data API use ga_data.  See website help for lots of examples: Google Analytics Reporting API v4 in R
    
+    
    Fetch Google Analytics data using the v4 API.  For the v3 API use google_analytics_3, for GA4's Data API use ga_data.  See website help for lots of examples: Google Analytics Reporting API v4 in R
    
     
    
 
-    
    google_analytics(
-  viewId,
-  date_range = NULL,
-  metrics = NULL,
-  dimensions = NULL,
-  dim_filters = NULL,
-  met_filters = NULL,
-  filtersExpression = NULL,
-  order = NULL,
-  segments = NULL,
-  pivots = NULL,
-  cohorts = NULL,
-  max = 1000,
-  samplingLevel = c("DEFAULT", "SMALL", "LARGE"),
-  metricFormat = NULL,
-  histogramBuckets = NULL,
-  anti_sample = FALSE,
-  anti_sample_batches = "auto",
-  slow_fetch = FALSE,
-  useResourceQuotas = NULL,
-  rows_per_call = 10000L
-)
-
-google_analytics_4(...)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    viewId
    viewId of data to get.
    date_range
    character or date vector of format c(start, end) or
-for two date ranges: c(start1,end1,start2,end2)
    metrics
    Metric(s) to fetch as a character vector.  You do not need to
-supply the "ga:" prefix.  See meta for a list of dimensons
-and metrics the API supports. Also supports your own calculated metrics.
    dimensions
    Dimension(s) to fetch as a character vector. You do not need to
-supply the "ga:" prefix. See meta for a list of dimensons
-and metrics the API supports.
    dim_filters
    A filter_clause_ga4 wrapping dim_filter
    met_filters
    A filter_clause_ga4 wrapping met_filter
    filtersExpression
    A v3 API style simple filter string. Not used with other filters.
    order
    An order_type object
    segments
    List of segments as created by segment_ga4
    pivots
    Pivots of the data as created by pivot_ga4
    cohorts
    Cohorts created by make_cohort_group
    max
    Maximum number of rows to fetch. Defaults at 1000. Use -1 to fetch all results. Ignored when anti_sample=TRUE.
    samplingLevel
    Sample level
    metricFormat
    If supplying calculated metrics, specify the metric type
    histogramBuckets
    For numeric dimensions such as hour, a list of buckets of data.
    anti_sample
    If TRUE will split up the call to avoid sampling.
    anti_sample_batches
    "auto" default, or set to number of days per batch. 1 = daily.
    slow_fetch
    For large, complicated API requests this bypasses some API hacks that may result in 500 errors.  For smaller queries, leave this as FALSE for quicker data fetching.
    useResourceQuotas
    If using GA360, access increased sampling limits.
-Default NULL, set to TRUE or FALSE if you have access to this feature.
    rows_per_call
    Set how many rows are requested by the API per call, up to a maximum of 100000.
    ...
    Arguments passed to google_analytics
    
-
-    
    Value
    
+    
    
+    
    google_analytics(
+  viewId,
+  date_range = NULL,
+  metrics = NULL,
+  dimensions = NULL,
+  dim_filters = NULL,
+  met_filters = NULL,
+  filtersExpression = NULL,
+  order = NULL,
+  segments = NULL,
+  pivots = NULL,
+  cohorts = NULL,
+  max = 1000,
+  samplingLevel = c("DEFAULT", "SMALL", "LARGE"),
+  metricFormat = NULL,
+  histogramBuckets = NULL,
+  anti_sample = FALSE,
+  anti_sample_batches = "auto",
+  slow_fetch = FALSE,
+  useResourceQuotas = NULL,
+  rows_per_call = 10000L
+)
+
+google_analytics_4(...)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    viewId
    
+
    viewId of data to get.
    
+
    date_range
    
+
    character or date vector of format c(start, end) or
+for two date ranges: c(start1,end1,start2,end2)
    
+
    metrics
    
+
    Metric(s) to fetch as a character vector.  You do not need to
+supply the "ga:" prefix.  See meta for a list of dimensons
+and metrics the API supports. Also supports your own calculated metrics.
    
+
    dimensions
    
+
    Dimension(s) to fetch as a character vector. You do not need to
+supply the "ga:" prefix. See meta for a list of dimensons
+and metrics the API supports.
    
+
    dim_filters
    
+
    A filter_clause_ga4 wrapping dim_filter
    
+
    met_filters
    
+
    A filter_clause_ga4 wrapping met_filter
    
+
    filtersExpression
    
+
    A v3 API style simple filter string. Not used with other filters.
    
+
    order
    
+
    An order_type object
    
+
    segments
    
+
    List of segments as created by segment_ga4
    
+
    pivots
    
+
    Pivots of the data as created by pivot_ga4
    
+
    cohorts
    
+
    Cohorts created by make_cohort_group
    
+
    max
    
+
    Maximum number of rows to fetch. Defaults at 1000. Use -1 to fetch all results. Ignored when anti_sample=TRUE.
    
+
    samplingLevel
    
+
    Sample level
    
+
    metricFormat
    
+
    If supplying calculated metrics, specify the metric type
    
+
    histogramBuckets
    
+
    For numeric dimensions such as hour, a list of buckets of data.
    
+
    anti_sample
    
+
    If TRUE will split up the call to avoid sampling.
    
+
    anti_sample_batches
    
+
    "auto" default, or set to number of days per batch. 1 = daily.
    
+
    slow_fetch
    
+
    For large, complicated API requests this bypasses some API hacks that may result in 500 errors.  For smaller queries, leave this as FALSE for quicker data fetching.
    
+
    useResourceQuotas
    
+
    If using GA360, access increased sampling limits.
+Default NULL, set to TRUE or FALSE if you have access to this feature.
    
+
    rows_per_call
    
+
    Set how many rows are requested by the API per call, up to a maximum of 100000.
    
+
    ...
    
+
    Arguments passed to google_analytics
    
+
    
+    
    
+    
    Value
    
     
    A Google Analytics data.frame, with attributes showing row totals, sampling etc.
    
-    
    Row requests
    
-
+    
    
+    
    
+    
    Row requests
    
     
 
 
 
    By default the API call will use v4 batching that splits requests into 5 separate calls of 10k rows each.  This can go up to 100k, so this means up to 500k rows can be fetched per API call, however the API servers will fail with a 500 error if the query is too complicated as the processing time at Google's end gets too long.  In this case, you may want to tweak the rows_per_call argument downwards, or fall back to using slow_fetch = FALSE which will send an API request one at a time.  If fetching data via scheduled scripts this is recommended as the default.
    
-    
    Anti-sampling
    
-
+    
    
+    
    
+    
    Anti-sampling
    
     
 
 
 
    anti_sample being TRUE ignores max as the API call is split over days
 to mitigate the sampling session limit, in which case a row limit won't work.  Take the top rows
-of the result yourself instead e.g. head(ga_data_unsampled, 50300)
    
+of the result yourself instead e.g. head(ga_data_unsampled, 50300)
    
 
    anti_sample being TRUE will also set samplingLevel='LARGE' to minimise
 the number of calls.
    
-    
    Resource Quotas
    
-
+    
    
+    
    
+    
    Resource Quotas
    
     
 
 
 
    If you are on GA360 and have access to resource quotas,
 set the useResourceQuotas=TRUE and set the Google Cloud
 client ID to the project that has resource quotas activated,
-via gar_set_client or options.
    
-    
    Caching
    
-
+via gar_set_client or options.
    
+    
    
+    
    
+    
    Caching
    
     
 
 
 
    By default local caching is turned on for v4 API requests.  This means that
 making the same request as one this session will read from memory and not
 make an API call. You can also set the cache to disk via
-the ga_cache_call function.  This can be useful
+the ga_cache_call function.  This can be useful
 when running RMarkdown reports using data.
    
-    
    Metrics
    
-
+    
    
+    
    
+    
    Metrics
    
     
 
 
    Metrics support calculated metrics like ga:users / ga:sessions if you supply
@@ -466,8 +347,9 @@ 
    Metrics
 the same length as the metrics.  metricFormat can be:
 METRIC_TYPE_UNSPECIFIED, INTEGER, FLOAT, CURRENCY, PERCENT, TIME
    
 
    All metrics are currently parsed to as.numeric when in R.
    
-    
    Dimensions
    
-
+    
    
+    
    
+    
    Dimensions
    
     
 
 
@@ -483,78 +365,74 @@ 
    D
 the "last" bucket includes all values up to infinity.
 Dimension values that fall in a bucket get transformed to a new dimension
 value. For example, if one gives a list of "0, 1, 3, 4, 7", then we
-return the following buckets: -
      
-
    • bucket #1: values < 0, dimension value "<0"
      • 
+return the following buckets: -
      • bucket #1: values < 0, dimension value "<0"
        • 
 
      • bucket #2: values in [0,1), dimension value "0"
        • 
 
      • bucket #3: values in [1,3), dimension value "1-2"
        • 
 
      • bucket #4: values in [3,4), dimension value "3"
        • 
 
      • bucket #5: values in [4,7), dimension value "4-6"
        • 
 
      • bucket #6: values >= 7, dimension value "7+"
        • 
-
      
-
-
-    
      Examples
      
-    
      
-if (FALSE) {
-library(googleAnalyticsR)
-
-## authenticate, or use the RStudio Addin "Google API Auth" with analytics scopes set
-
-ga_auth()
-
-## get your accounts
-
-account_list <- ga_account_list()
-
-## account_list will have a column called "viewId"
-account_list$viewId
-
-## View account_list and pick the viewId you want to extract data from
-ga_id <- 123456
-
-# examine the meta table to see metrics and dimensions you can query
-meta
-
-## simple query to test connection
-google_analytics(ga_id, 
-                 date_range = c("2017-01-01", "2017-03-01"), 
-                 metrics = "sessions", 
-                 dimensions = "date")
-
-## change the quotaUser to fetch under
-google_analytics(1234567, date_range = c("30daysAgo", "yesterday"), metrics = "sessions")
-
-options("googleAnalyticsR.quotaUser" = "test_user")
-google_analytics(1234567, date_range = c("30daysAgo", "yesterday"), metrics = "sessions")
-
-}
-
-
      
+
    
+
+    
    
+    
    Examples
    
+    
    
+if (FALSE) {
+library(googleAnalyticsR)
+
+## authenticate, or use the RStudio Addin "Google API Auth" with analytics scopes set
+
+ga_auth()
+
+## get your accounts
+
+account_list <- ga_account_list()
+
+## account_list will have a column called "viewId"
+account_list$viewId
+
+## View account_list and pick the viewId you want to extract data from
+ga_id <- 123456
+
+# examine the meta table to see metrics and dimensions you can query
+meta
+
+## simple query to test connection
+google_analytics(ga_id, 
+                 date_range = c("2017-01-01", "2017-03-01"), 
+                 metrics = "sessions", 
+                 dimensions = "date")
+
+## change the quotaUser to fetch under
+google_analytics(1234567, date_range = c("30daysAgo", "yesterday"), metrics = "sessions")
+
+options("googleAnalyticsR.quotaUser" = "test_user")
+google_analytics(1234567, date_range = c("30daysAgo", "yesterday"), metrics = "sessions")
+
+}
+
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/google_analytics_3.html b/docs/reference/google_analytics_3.html
index 35cd4212..ca76dcf9 100644
--- a/docs/reference/google_analytics_3.html
+++ b/docs/reference/google_analytics_3.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Get Google Analytics v3 data (formerly google_analytics()) — google_analytics_3 • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Get Google Analytics v3 data (formerly google_analytics()) — google_analytics_3 • googleAnalyticsR
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Get Google Analytics v3 data (formerly google_analytics())
    
-    Source: R/ga_v3_get.R
+    Source: R/ga_v3_get.R
     
     
    
 
     
    
-    
    Legacy v3 API, for more modern API use google_analytics.
    
+    
    Legacy v3 API, for more modern API use google_analytics.
    
     
    
 
-    
    google_analytics_3(
-  id,
-  start,
-  end,
-  metrics = c("sessions", "bounceRate"),
-  dimensions = NULL,
-  sort = NULL,
-  filters = NULL,
-  segment = NULL,
-  samplingLevel = c("DEFAULT", "FASTER", "HIGHER_PRECISION"),
-  max_results = 100,
-  type = c("ga", "mcf")
-)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    id
    A character vector of View Ids to fetch from.
    start
    Start date in YYY-MM-DD format.
    end
    End date in YYY-MM-DD format.
    metrics
    A character vector of metrics. With or without ga: prefix.
    dimensions
    A character vector of dimensions. With or without ga: prefix.
    sort
    How to sort the results, in form 'ga:sessions,-ga:bounceRate'
    filters
    Filters for the result, in form 'ga:sessions>0;ga:pagePath=~blah'
    segment
    How to segment.
    samplingLevel
    Choose "WALK" to mitigate against sampling.
    max_results
    Default 100. If greater than 10,000 then will batch GA calls.
    type
    ga = Google Analytics v3; mcf = Multi-Channel Funels.
    
-
-    
    Value
    
+    
    
+    
    google_analytics_3(
+  id,
+  start,
+  end,
+  metrics = c("sessions", "bounceRate"),
+  dimensions = NULL,
+  sort = NULL,
+  filters = NULL,
+  segment = NULL,
+  samplingLevel = c("DEFAULT", "FASTER", "HIGHER_PRECISION"),
+  max_results = 100,
+  type = c("ga", "mcf")
+)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    id
    
+
    A character vector of View Ids to fetch from.
    
+
    start
    
+
    Start date in YYY-MM-DD format.
    
+
    end
    
+
    End date in YYY-MM-DD format.
    
+
    metrics
    
+
    A character vector of metrics. With or without ga: prefix.
    
+
    dimensions
    
+
    A character vector of dimensions. With or without ga: prefix.
    
+
    sort
    
+
    How to sort the results, in form 'ga:sessions,-ga:bounceRate'
    
+
    filters
    
+
    Filters for the result, in form 'ga:sessions>0;ga:pagePath=~blah'
    
+
    segment
    
+
    How to segment.
    
+
    samplingLevel
    
+
    Level of precision of the API requests
    
+
    max_results
    
+
    Default 100. If greater than 10,000 then will batch GA calls.
    
+
    type
    
+
    ga = Google Analytics v3; mcf = Multi-Channel Funels.
    
+
    
+    
    
+    
    Value
    
     
    For one id a data.frame of data, with meta-data in attributes.
    
-    
    See also
    
-
-    
    https://developers.google.com/analytics/devguides/reporting/core/v3/
    
-
-    
    Examples
    
-    
    
-if (FALSE) {
-
-library(googleAnalyticsR)
-
-## Authenticate in Google OAuth2
-## this also sets options
-ga_auth()
-
-## if you need to re-authenticate use ga_auth(new_user=TRUE)
-## if you have your own Google Dev console project keys,
-## then don't run ga_auth() as that will set to the defaults.
-## instead put your options here, and run googleAuthR::gar_auth()
-
-## get account info, including View Ids
-account_list <- ga_account_list()
-ga_id <- account_list$viewId[1]
-
-## get a list of what metrics and dimensions you can use
-
-meta <- ga_meta()
-head(meta)
-
-## pick the account_list$viewId you want to see data for.
-## metrics and dimensions can have or have not "ga:" prefix
-
-gadata <- google_analytics_3(id = ga_id,
-                           start="2015-08-01", end="2015-08-02",
-                           metrics = c("sessions", "bounceRate"),
-                           dimensions = c("source", "medium"))
-                       
-                                
-## if more than 10000 rows in results, auto batching
-## example is setting lots of dimensions to try and create big sampled data
-batch_gadata <- google_analytics_3(id = ga_id,
-                                 start="2014-08-01", end="2015-08-02",
-                                 metrics = c("sessions", "bounceRate"),
-                                 dimensions = c("source", "medium", 
-                                               "landingPagePath",
-                                               "hour","minute"),
-                                max=99999999)
-
-## mitigate sampling by setting samplingLevel="WALK"
-## this will send lots and lots of calls to the Google API limits, beware
-walk_gadata <- google_analytics_3(id = ga_id,
-                                start="2014-08-01", end="2015-08-02",
-                                metrics = c("sessions", "bounceRate"),
-                                dimensions = c("source", "medium", "landingPagePath"),
-                                max=99999999, samplingLevel="WALK")
-                                
-## multi-channel funnels set type="mcf"
-mcf_gadata <- google_analytics_3(id = ga_id,
-                               start="2015-08-01", end="2015-08-02",
-                               metrics = c("totalConversions"),
-                               dimensions = c("sourcePath"),
-                               type="mcf")
-
-
-## reach meta-data via attr()
-attr(gadata, "profileInfo")
-attr(gadata, "dateRange")
-
-
-}
+    
    
+    
    
+    
    See also
    
+    
    https://developers.google.com/analytics/devguides/reporting/core/v3/
    
+    
    
 
-
    
+    
    
+    
    Examples
    
+    
    
+if (FALSE) {
+
+library(googleAnalyticsR)
+
+## Authenticate in Google OAuth2
+## this also sets options
+ga_auth()
+
+## if you need to re-authenticate use ga_auth(new_user=TRUE)
+## if you have your own Google Dev console project keys,
+## then don't run ga_auth() as that will set to the defaults.
+## instead put your options here, and run googleAuthR::gar_auth()
+
+## get account info, including View Ids
+account_list <- ga_account_list()
+ga_id <- account_list$viewId[1]
+
+## get a list of what metrics and dimensions you can use
+
+meta <- ga_meta()
+head(meta)
+
+## pick the account_list$viewId you want to see data for.
+## metrics and dimensions can have or have not "ga:" prefix
+
+gadata <- google_analytics_3(id = ga_id,
+                           start="2015-08-01", end="2015-08-02",
+                           metrics = c("sessions", "bounceRate"),
+                           dimensions = c("source", "medium"))
+                       
+                                
+## if more than 10000 rows in results, auto batching
+## example is setting lots of dimensions to try and create big sampled data
+batch_gadata <- google_analytics_3(id = ga_id,
+                                 start="2014-08-01", end="2015-08-02",
+                                 metrics = c("sessions", "bounceRate"),
+                                 dimensions = c("source", "medium", 
+                                               "landingPagePath",
+                                               "hour","minute"),
+                                max=99999999)
+
+## mitigate sampling by setting samplingLevel="WALK"
+## this will send lots and lots of calls to the Google API limits, beware
+walk_gadata <- google_analytics_3(id = ga_id,
+                                start="2014-08-01", end="2015-08-02",
+                                metrics = c("sessions", "bounceRate"),
+                                dimensions = c("source", "medium", "landingPagePath"),
+                                max=99999999, samplingLevel="WALK")
+                                
+## multi-channel funnels set type="mcf"
+mcf_gadata <- google_analytics_3(id = ga_id,
+                               start="2015-08-01", end="2015-08-02",
+                               metrics = c("totalConversions"),
+                               dimensions = c("sourcePath"),
+                               type="mcf")
+
+
+## reach meta-data via attr()
+attr(gadata, "profileInfo")
+attr(gadata, "dateRange")
+
+
+}
+
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/google_analytics_bq.html b/docs/reference/google_analytics_bq.html
index bfb8e3f7..6b900ba0 100644
--- a/docs/reference/google_analytics_bq.html
+++ b/docs/reference/google_analytics_bq.html
@@ -1,86 +1,19 @@
-
 
-
-  
-  
-
-
-
-Get Google Analytics 360 BigQuery data — google_analytics_bq • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Get Google Analytics 360 BigQuery data — google_analytics_bq • googleAnalyticsR
-
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Get Google Analytics 360 BigQuery data
    
-    Source: R/bigQuery.R
+    Source: R/bigQuery.R
     
     
    
 
@@ -297,124 +215,97 @@ 
    Get Google Analytics 360 BigQuery data
    
 Used with Google Analytics 360 BigQuery exports.
    
     
    
 
-    
    google_analytics_bq(
-  projectId,
-  datasetId,
-  start = NULL,
-  end = NULL,
-  metrics = NULL,
-  dimensions = NULL,
-  sort = NULL,
-  filters = NULL,
-  max_results = 100,
-  query = NULL,
-  return_query_only = FALSE,
-  bucket = NULL,
-  download_file = NULL
-)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    projectId
    The Google project Id where the BigQuery exports sit
    datasetId
    DatasetId of GA export.  This should match the GA View ID
    start
    start date
    end
    end date
    metrics
    metrics to query
    dimensions
    dimensions to query
    sort
    metric to sort by
    filters
    filter results
    max_results
    How many results to fetch
    query
    If query is non-NULL then it will use that and ignore above
    return_query_only
    Only return the constructed query, don't call BigQuery
    bucket
    if over 100000 results, specify a Google Cloud bucket to send data to
    download_file
    Where to save asynch files.  If NULL saves to current working directory.
    
-
-    
    Value
    
+    
    
+    
    google_analytics_bq(
+  projectId,
+  datasetId,
+  start = NULL,
+  end = NULL,
+  metrics = NULL,
+  dimensions = NULL,
+  sort = NULL,
+  filters = NULL,
+  max_results = 100,
+  query = NULL,
+  return_query_only = FALSE,
+  bucket = NULL,
+  download_file = NULL
+)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    projectId
    
+
    The Google project Id where the BigQuery exports sit
    
+
    datasetId
    
+
    DatasetId of GA export.  This should match the GA View ID
    
+
    start
    
+
    start date
    
+
    end
    
+
    end date
    
+
    metrics
    
+
    metrics to query
    
+
    dimensions
    
+
    dimensions to query
    
+
    sort
    
+
    metric to sort by
    
+
    filters
    
+
    filter results
    
+
    max_results
    
+
    How many results to fetch
    
+
    query
    
+
    If query is non-NULL then it will use that and ignore above
    
+
    return_query_only
    
+
    Only return the constructed query, don't call BigQuery
    
+
    bucket
    
+
    if over 100000 results, specify a Google Cloud bucket to send data to
    
+
    download_file
    
+
    Where to save asynch files.  If NULL saves to current working directory.
    
+
    
+    
    
+    
    Value
    
     
    data.frame of results
    
-    
    Details
    
-
+    
    
+    
    
+    
    Details
    
     
    All data will be unsampled, and requests will cost money against your BigQuery quota.
    
 
    Requires installation of bigQueryR and authentication under ga_bq_auth()
 or googleAuthR::gar_auth() with BigQuery scope set.
-View your projectIds upon authentication via bigQueryR::bqr_list_projects()
    
+View your projectIds upon authentication via bigQueryR::bqr_list_projects()
    
 
    No segments for now.
    
 
    Goals are not specified in BQ exports, so you need to look at how you define them and replicate per view
 e.g. unique pageviews or unique events.
    
 
    Custom dimensions can be specified as session or hit level, so ignoring the setting in GA interface.
    
 
    You can get a sample Google Analytics dataset in bigquery by following the instructions
-here: https://support.google.com/analytics/answer/3416091?hl=en
    
-    
    See also
    
-
-    
    https://support.google.com/analytics/answer/4419694?hl=en
-https://support.google.com/analytics/answer/3437719?hl=en
    
+here: https://support.google.com/analytics/answer/3416091?hl=en
    
+    
    
+    
 
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/google_analytics_bq_asynch.html b/docs/reference/google_analytics_bq_asynch.html
index 2172684e..d7e5bba3 100644
--- a/docs/reference/google_analytics_bq_asynch.html
+++ b/docs/reference/google_analytics_bq_asynch.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Asynch fetch — google_analytics_bq_asynch • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Asynch fetch — google_analytics_bq_asynch • googleAnalyticsR
-
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Asynch fetch
    
-    Source: R/bigQuery.R
+    Source: R/bigQuery.R
     
     
    
 
@@ -295,35 +213,32 @@ 
    Asynch fetch
    
     
    Asynch fetch
    
     
    
 
-    
    google_analytics_bq_asynch(projectId, datasetId, query, bucket, download_file)
    
-
+    
    
+    
    google_analytics_bq_asynch(projectId, datasetId, query, bucket, download_file)
    
+    
    
 
 
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/index.html b/docs/reference/index.html
index 6b95d68d..b4a042c0 100644
--- a/docs/reference/index.html
+++ b/docs/reference/index.html
@@ -1,84 +1,18 @@
-
 
-
-  
-  
-
-
-
-Function reference • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Function reference • googleAnalyticsR
-
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
       
    Reference
    
     
    
 
-    
-
-    -      
-      -      -    
-
-    
-      
-        
    



    
-          
    Authentication and Setup
    
-          
    Setting up your environment so you can connect to the API
    
+    
-      
-      
-      
-    
-      
-      
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-    
-      
-        
-      
-      
-      
-    
-      
-      
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-    
-      
-        
-      
-      
-      
-    
-      
-      
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-    
-      
-        
-      
-      
-      
-    
-      
-      
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-    
-      
-        
-      
-      
-      
-    
-      
-      
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-    
-      
-        
-      
-      
-      
-    
-      
-      
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-    
-      
-        
-      
-      
-      
-    
-      
-      
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-    
-      
-        
-      
-      
-      
-    
-      
-      
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-    
-      
-        
-      
-      
-      
-    
-      
-      
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-    
-      
-        
-      
-      
-      
-    
-      
-      
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-    
-      
-        
-      
-      
-      
-    
-      
-      
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-    
-      
-        
-      
-      
-      
-    
-      
-      
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-    
-      
-        
-      
-      
-      
-    
-      
-      
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-    
-      
-        
-      
-      
-      
-    
-      
-      
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-    
-      
-        
-      
-      
-      
-    
-      
-      
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-    
-      
-        
-      
-      
-      
-    
-      
-      
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-    
-      
-        
-      
-      
-      
-    
-      
-      
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-    
-      
-        
-      
-      
-      
-    
-      
-      
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-        
-        
-      
-    
-      
-        
-      
-      
-      
-    
-      
-      
-      
-        
-        
-      
-        
-        
-      
-    
-    
    
+          
    Authentication and Setup 
    
+          
    Setting up your environment so you can connect to the API
    
         
    
+      
    
           
    ga_auth() 
    
             		
         
    Authenticate with Google Analytics OAuth2
    
+      
    
           
    ga_auth_setup() 
    
             		
         
    Setup wizard for authentication options
    
+      
    
           
    ga_cache_call() 
    
             		
         
    Setup caching of API calls
    
-          
    Reporting API
    
-          
    Getting data from your Google Analytics account
    
+      
    
+          
    Reporting API 
    
+          
    Getting data from your Google Analytics account
    
         
    
+      
    
           
    google_analytics() google_analytics_4() 
    
             		
         
    Get Google Analytics v4 data
    
+      
    
           
    ga_data() 
    
             		
         
    Google Analytics Data for GA4 (App+Web)
    
+      
    
           
    google_analytics_3() 
    
             		
         
    Get Google Analytics v3 data (formerly google_analytics())
    
+      
    
           
    google_analytics_bq() 
    
             		
         
    Get Google Analytics 360 BigQuery data
    
-          
    Data API - Google Analytics 4
    
-          
    Working with the Data API (App+Web) for Google Analytics 4
    
+      
    
+          
    Data API - Google Analytics 4 
    
+          
    Working with the Data API (App+Web) for Google Analytics 4
    
         
    
+      
    
           
    ga_data() 
    
             		
         
    Google Analytics Data for GA4 (App+Web)
    
+      
    
           
    ga_data_filter() 
    
             		
         
    Filter DSL for GA4 filters
    
+      
    
           
    ga_data_aggregations() 
    
             		
         
    Extract metric aggregations from a ga_data result
    
+      
    
           
    ga_data_order() 
    
             		
         
    Order DSL for GA4 OrderBy
    
-          
    Measurement Protocol v2
    
-          
    Send data into GA4 with the Measurement Protocol
    
+      
    
+          
    Measurement Protocol v2 
    
+          
    Send data into GA4 with the Measurement Protocol
    
         
    
+      
    
           
    ga_mp_cid() 
    
             		
         
    Generate a random client_id
    
+      
    
           
    ga_mp_event() 
    
             		
         
    Create a Measurement Protocol Event
    
+      
    
           
    ga_mp_event_item() 
    
             		
         
    Create an Measurement Protocol Item Property for an Event
    
+      
    
           
    ga_mp_send() ga_mp_connection() 
    
             		
         
    Make a Measurement Protocol v2 request
    
+      
    
           
    ga_trackme() ga_trackme_event() 
    
             		
         
    Opt in or out of googleAnalyticsR usage tracking
    
-          
    Reporting API v4 objects
    
-          
    Creating objects for more advanced v4 Reporting API fetches
    
+      
    
+          
    Reporting API v4 objects 
    
+          
    Creating objects for more advanced v4 Reporting API fetches
    
         
    
+      
    
           
    filter_clause_ga4() 
    
             		
         
    Make a dimension or metric filter clause object
    
+      
    
           
    dim_filter() 
    
             		
         
    Make a dimension filter object
    
+      
    
           
    met_filter() 
    
             		
         
    Make a metric filter object
    
+      
    
           
    order_type() 
    
             		
         
    Make an OrderType object
    
+      
    
           
    pivot_ga4() 
    
             		
         
    Make a pivot object
    
+      
    
           
    make_cohort_group() 
    
             		
         
    Create a cohort group
    
-          
    Segment API v4 objects
    
-          
    Creating segments for v4 reporting API fetches
    
+      
    
+          
    Segment API v4 objects 
    
+          
    Creating segments for v4 reporting API fetches
    
         
    
+      
    
           
    segment_ga4() 
    
             		
         
    Make a segment object for use
    
+      
    
           
    segment_define() 
    
             		
         
    Make a segment definition
    
+      
    
           
    segment_element() 
    
             		
         
    Make a segment element
    
+      
    
           
    segment_vector_sequence() 
    
             		
         
    Make sequenceSegment
    
+      
    
           
    segment_vector_simple() 
    
             		
         
    Make a simple segment vector
    
-          
    Helpers
    
-          
    Useful functions for working with the Google Analytics data
    
+      
    
+          
    Helpers 
    
+          
    Useful functions for working with the Google Analytics data
    
         
    
+      
    
           
    ga_aggregate() 
    
             		
         
    Aggregate a Google Analytics dataframe over inputted columns
    
+      
    
           
    ga_allowed_metric_dim() 
    
             		
         
    Create named list of allowed GA metrics/dimensions
    
+      
    
           
    ga_meta() 
    
             		
         
    Get current dimensions and metrics available in GA API.
    
+      
    
           
    meta 
    
             		
         
    Google Analytics API metadata
    
+      
    
           
    meta4 
    
             		
         
    Google Analytics API metadata
    
-          
    Shiny modules
    
-          
    Using Google Analytics with Shiny
    
+      
    
+          
    Shiny modules 
    
+          
    Using Google Analytics with Shiny
    
         
    
+      
    
           
    accountPickerUI() accountPicker() 
    
             		
         
    accountPicker UI Shiny Module - pick GA4 accounts/webProperties in Shiny
    
+      
    
           
    authDropdown() 
    
             		
         
    authDropdown Shiny Module
    
+      
    
           
    authDropdownUI() 
    
             		
         
    authDropdown UI Shiny Module
    
+      
    
           
    multi_select() 
    
             		
         
    multi_select Shiny Module
    
+      
    
           
    multi_selectUI() 
    
             		
         
    multi_select UI Shiny Module
    
+      
    
           
    metricDimensionSelectUI() metricDimensionSelect() 
    
             		
         
    metricDimensionSelectUI - GA4 Shiny Module
    
+      
    
           
    segmentBuilder() 
    
             		
         
    Create a GAv4 Segment Builder
    
+      
    
           
    segmentBuilderUI() 
    
             		
         
    Create a GAv4 Segment Builder
    
-          
    Model functions
    
-          
    Functions to create and use models with your Google Analytics data
    
+      
    
+          
    Model functions 
    
+          
    Functions to create and use models with your Google Analytics data
    
         
    
+      
    
           
    ga_model() 
    
             		
         
    Use a model
    
+      
    
           
    ga_model_edit() 
    
             		
         
    Edit a created ga_model
    
+      
    
           
    ga_model_example() 
    
             		
         
    Load an example model
    
+      
    
           
    ga_model_load() 
    
             		
         
    Load a created model
    
+      
    
           
    ga_model_make() 
    
             		
         
    Modelling function factory for Google Analytics data
    
+      
    
           
    ga_model_refresh() 
    
             		
         
    Refresh a model
    
+      
    
           
    ga_model_save() 
    
             		
         
    Save a created model
    
+      
    
           
    ga_model_shiny() 
    
             		
         
    Create a Shiny app from a ga_model file
    
+      
    
           
    ga_model_shiny_load() 
    
             		
         
    Load one model into a Shiny template
    
+      
    
           
    ga_model_shiny_template() 
    
             		
         
    Get a Shiny template file
    
+      
    
           
    ga_model_write() 
    
             		
         
    Write the ga_model functions to a file
    
-          
    Account structure
    
-          
    Viewing the account > webproperty > view structure
    
+      
    
+          
    Account structure 
    
+          
    Viewing the account > webproperty > view structure
    
         
    
+      
    
           
    ga_account_list() 
    
             		
         
    Account summary for all accounts available to your user
    
+      
    
           
    ga_accounts() 
    
             		
         
    List account metadata
    
+      
    
           
    ga_webproperty_list() 
    
             		
         
    List web properties
    
+      
    
           
    ga_webproperty() 
    
             		
         
    Get a web property
    
+      
    
           
    ga_view_list() 
    
             		
         
    List View (Profile)
    
+      
    
           
    ga_view() 
    
             		
         
    Get single View (Profile)
    
-          
    AdWords and remarketing segments
    
-          
    Tools to work with the AdWords integrations of Google Analytics
    
+      
    
+          
    AdWords and remarketing segments 
    
+          
    Tools to work with the AdWords integrations of Google Analytics
    
         
    
+      
    
           
    ga_segment_list() 
    
             		
         
    Get segments user has access to
    
+      
    
           
    ga_adwords_list() 
    
             		
         
    List AdWords
    
+      
    
           
    ga_adwords() 
    
             		
         
    Get AdWords Link meta data
    
+      
    
           
    ga_adwords_add_linkid() 
    
             		
         
    Creates a Google Analytics webProperty-Google Ads link
    
+      
    
           
    ga_adwords_delete_linkid() 
    
             		
         
    Deletes a Google Analytics webProperty-Google Ads link
    
+      
    
           
    ga_remarketing_list() 
    
             		
         
    List remarketing audiences
    
+      
    
           
    ga_remarketing_build() 
    
             		
         
    Create a remarketing audience for creation
    
+      
    
           
    ga_remarketing_create() 
    
             		
         
    Create a new remarketing audience
    
+      
    
           
    ga_remarketing_estimate() 
    
             		
         
    Estimate number of users added to the segment yesterday
    
+      
    
           
    ga_remarketing_get() 
    
             		
         
    Get a remarketing audience
    
-          
    Custom Datasource uploads
    
-          
    Uploading data to your Google Analytics web property
    
+      
    
+          
    Custom Datasource uploads 
    
+          
    Uploading data to your Google Analytics web property
    
         
    
+      
    
           
    ga_custom_datasource() 
    
             		
         
    List Custom Data Sources
    
+      
    
           
    ga_custom_upload_list() 
    
             		
         
    List Custom Data Source Uploads
    
+      
    
           
    ga_custom_upload() 
    
             		
         
    Custom Data Source Upload Status
    
+      
    
           
    ga_custom_upload_file() 
    
             		
         
    Upload data to Google Analytics
    
+      
    
           
    ga_custom_upload_delete() 
    
             		
         
    Deletes custom upload files for a given ids vector
    
-          
    Setting up View filters
    
-          
    Manipulate the filters that are applied to your Google Analytics Views
    
+      
    
+          
    Setting up View filters 
    
+          
    Manipulate the filters that are applied to your Google Analytics Views
    
         
    
+      
    
           
    ga_filter_list() 
    
             		
         
    List filters for account
    
+      
    
           
    ga_filter() 
    
             		
         
    Get specific filter for account
    
+      
    
           
    ga_filter_add() 
    
             		
         
    Create a new filter and add it to the view (optional).
    
+      
    
           
    ga_filter_apply_to_view() 
    
             		
         
    Apply an existing filter to view.
    
+      
    
           
    ga_filter_delete() 
    
             		
         
    Delete a filter from account or remove from view.
    
+      
    
           
    ga_filter_update() 
    
             		
         
    Updates an existing filter.
    
+      
    
           
    ga_filter_update_filter_link() 
    
             		
         
    Update an existing profile filter link. Patch semantics supported
    
+      
    
           
    ga_filter_view_list() 
    
             		
         
    List filters for view (profile)
    
+      
    
           
    ga_filter_view() 
    
             		
         
    Get specific filter for view (profile)
    
-          
    Setting up Goals
    
-          
    Manipulate the goals defined for your Google Analytics Views
    
+      
    
+          
    Setting up Goals 
    
+          
    Manipulate the goals defined for your Google Analytics Views
    
         
    
+      
    
           
    ga_goal_list() 
    
             		
         
    List goals
    
+      
    
           
    ga_goal() 
    
             		
         
    Get goal
    
+      
    
           
    ga_goal_add() 
    
             		
         
    Create a new goal.
    
+      
    
           
    ga_goal_update() 
    
             		
         
    Updates an existing goal.
    
-          
    Unsampled Reports [GA360]
    
-          
    Get your GA360 unsampled reports
    
+      
    
+          
    Unsampled Reports [GA360] 
    
+          
    Get your GA360 unsampled reports
    
         
    
+      
    
           
    ga_unsampled_list() 
    
             		
         
    List Unsampled Reports
    
+      
    
           
    ga_unsampled() 
    
             		
         
    Get Unsampled Report Meta Data
    
+      
    
           
    ga_unsampled_download() 
    
             		
         
    Download Unsampled Report from Google Drive. You must be authenticated with the
 same account that you setup the unsampled report. This means service account
 authentication is not supported.
    
-          
    User management
    
-          
    Work with users of your Google Analytics account
    
+      
    
+          
    User management 
    
+          
    Work with users of your Google Analytics account
    
         
    
+      
    
           
    ga_users_list() 
    
             		
         
    List Users
    
+      
    
           
    ga_users_add() 
    
             		
         
    Create or update user access to Google Analytics
    
+      
    
           
    ga_users_delete() 
    
             		
         
    Delete all user access for an email
    
+      
    
           
    ga_users_delete_linkid() 
    
             		
         
    Delete users access from account, webproperty or view level
    
+      
    
           
    ga_users_update() 
    
             		
         
    Update a user access in Google Analytics
    
-          
    VisitorID management
    
-          
    Work with individual website visitor IDs
    
+      
    
+          
    VisitorID management 
    
+          
    Work with individual website visitor IDs
    
         
    
+      
    
           
    ga_clientid_activity() 
    
             		
         
    User Activity Request
    
+      
    
           
    ga_clientid_deletion() 
    
             		
         
    Create or update a user deletion request
    
+      
    
           
    ga_clientid_hash() 
    
             		
         
    Get hashed version of client id (also known as hashClientId, hashedClientId, or BigQuery's fullVisitorId)
    
+      
    
           
    ga_clientid_activity_unnest() 
    
             		
         
    Unnest user activity columns
    
-          
    Custom variables
    
-          
    Work with custom dimensions and metrics for your Google Analytics account
    
+      
    
+          
    Custom variables 
    
+          
    Work with custom dimensions and metrics for your Google Analytics account
    
         
    
+      
    
           
    ga_custom_vars_list() 
    
             		
         
    List Custom Dimensions or Metrics
    
+      
    
           
    ga_custom_vars() 
    
             		
         
    Get Custom Dimensions or Metrics
    
+      
    
           
    ga_custom_vars_create() 
    
             		
         
    Create a custom dimension
    
+      
    
           
    ga_custom_vars_patch() 
    
             		
         
    Modify a custom dimension
    
-          
    Experiments
    
-          
    Work with experiment objects
    
+      
    
+          
    Experiments 
    
+          
    Work with experiment objects
    
         
    
+      
    
           
    ga_experiment_list() 
    
             		
         
    List Experiments
    
+      
    
           
    ga_experiment() 
    
             		
         
    Experiments Meta data
    
-  
+      
    
 
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/make_cohort_group.html b/docs/reference/make_cohort_group.html
index 38b3c875..aef4809c 100644
--- a/docs/reference/make_cohort_group.html
+++ b/docs/reference/make_cohort_group.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Create a cohort group — make_cohort_group • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Create a cohort group — make_cohort_group • googleAnalyticsR
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Create a cohort group
    
-    Source: R/cohorts.R
+    Source: R/cohorts.R
     
     
    
 
@@ -295,111 +213,106 @@ 
    Create a cohort group
    
     
    Create a cohort group
    
     
    
 
-    
    make_cohort_group(cohorts, lifetimeValue = FALSE, cohort_types = NULL)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    cohorts
    A named list of start/end date pairs
    lifetimeValue
    lifetimeValue TRUE or FALSE.  Only works for webapps.
    cohort_types
    placeholder, does nothing as only FIRST_VISIT_DATE supported.
    
-
-    
    Value
    
+    
    
+    
    make_cohort_group(cohorts, lifetimeValue = FALSE, cohort_types = NULL)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    cohorts
    
+
    A named list of start/end date pairs
    
+
    lifetimeValue
    
+
    lifetimeValue TRUE or FALSE.  Only works for webapps.
    
+
    cohort_types
    
+
    placeholder, does nothing as only FIRST_VISIT_DATE supported.
    
+
    
+    
    
+    
    Value
    
     
    A cohortGroup object
    
-    
    Details
    
-
-    
    Example: list("cohort 1" = c("2015-08-01", "2015-08-01"),  "cohort 2" = c("2015-07-01","2015-07-01"))
    
-    
    See also
    
-
-    
    https://developers.google.com/analytics/devguides/reporting/core/v4/advanced#cohort_and_lifetime_value_ltv_dimensions_and_metrics
    
-
-    
    Examples
    
-    
    
-if (FALSE) {
-library(googleAnalyticsR)
-
-## authenticate, 
-## or use the RStudio Addin "Google API Auth" with analytics scopes set
-ga_auth()
-
-## get your accounts
-account_list <- google_analytics_account_list()
-
-## pick a profile with data to query
-
-ga_id <- account_list[23,'viewId']
-
-
-## first make a cohort group
-
-cohort4 <- make_cohort_group(list("cohort 1" = c("2015-08-01", "2015-08-01"), 
-                                  "cohort 2" = c("2015-07-01","2015-07-01")))
-                                  
-## then call cohort report.  No date_range and must include metrics and dimensions
-##   from the cohort list
-cohort_example <- google_analytics(ga_id, 
-                                   dimensions=c('cohort'), 
-                                   cohort = cohort4, 
-                                   metrics = c('cohortTotalUsers'))
-                                     
-                                     
-### Lifetime Value report - just a variation of the cohort report 
-# with lifetimeValue = TRUE
-### and ltv specific metrics
-### The view MUST be an app view at the moment
- 
-## make a cohort group with lifetimeValue = TRUE
- 
-cohort_ltv <- make_cohort_group(list("cohort 1" = c("2018-12-01", "2018-12-31"), 
-                                     "cohort 2" = c("2019-01-01", "2019-01-31")),
-                                     lifetimeValue = TRUE)
-                                     
-## call a cohort report with ltv metrics
-
-ltv_example <- google_analytics(ga_id, 
-     dimensions = c('cohort', "acquisitionTrafficChannel"), 
-     cohorts = cohort_ltv, 
-     metrics = c("cohortGoalCompletionsPerUserWithLifetimeCriteria"))              
-                                    
-}
+    
    
+    
    
+    
    Details
    
+    
    Example: list("cohort 1" = c("2015-08-01", "2015-08-01"),  "cohort 2" = c("2015-07-01","2015-07-01"))
    
+    
    
+    
 
-
    
+    
    
+    
    Examples
    
+    
    
+if (FALSE) {
+library(googleAnalyticsR)
+
+## authenticate, 
+## or use the RStudio Addin "Google API Auth" with analytics scopes set
+ga_auth()
+
+## get your accounts
+account_list <- google_analytics_account_list()
+
+## pick a profile with data to query
+
+ga_id <- account_list[23,'viewId']
+
+
+## first make a cohort group
+
+cohort4 <- make_cohort_group(list("cohort 1" = c("2015-08-01", "2015-08-01"), 
+                                  "cohort 2" = c("2015-07-01","2015-07-01")))
+                                  
+## then call cohort report.  No date_range and must include metrics and dimensions
+##   from the cohort list
+cohort_example <- google_analytics(ga_id, 
+                                   dimensions=c('cohort'), 
+                                   cohort = cohort4, 
+                                   metrics = c('cohortTotalUsers'))
+                                     
+                                     
+### Lifetime Value report - just a variation of the cohort report 
+# with lifetimeValue = TRUE
+### and ltv specific metrics
+### The view MUST be an app view at the moment
+ 
+## make a cohort group with lifetimeValue = TRUE
+ 
+cohort_ltv <- make_cohort_group(list("cohort 1" = c("2018-12-01", "2018-12-31"), 
+                                     "cohort 2" = c("2019-01-01", "2019-01-31")),
+                                     lifetimeValue = TRUE)
+                                     
+## call a cohort report with ltv metrics
+
+ltv_example <- google_analytics(ga_id, 
+     dimensions = c('cohort', "acquisitionTrafficChannel"), 
+     cohorts = cohort_ltv, 
+     metrics = c("cohortGoalCompletionsPerUserWithLifetimeCriteria"))              
+                                    
+}
+
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/met_fil_ga4-class.html b/docs/reference/met_fil_ga4-class.html
index cf67e7aa..0009850f 100644
--- a/docs/reference/met_fil_ga4-class.html
+++ b/docs/reference/met_fil_ga4-class.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-met_fil_ga4 class. — met_fil_ga4-class • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-met_fil_ga4 class. — met_fil_ga4-class • googleAnalyticsR
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    met_fil_ga4 class.
    
-    Source: R/ga_v4_objects.R
+    Source: R/ga_v4_objects.R
     
     
    
 
@@ -297,32 +215,27 @@ 
    met_fil_ga4 class.
    
 
 
 
-
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/met_filter.html b/docs/reference/met_filter.html
index 2dd2de83..8876b6de 100644
--- a/docs/reference/met_filter.html
+++ b/docs/reference/met_filter.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Make a metric filter object — met_filter • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Make a metric filter object — met_filter • googleAnalyticsR
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Make a metric filter object
    
-    Source: R/filters.R
+    Source: R/filters.R
     
     
    
 
@@ -295,108 +213,100 @@ 
    Make a metric filter object
    
     
    Make a metric filter object
    
     
    
 
-    
    met_filter(
-  metric,
-  operator = c("EQUAL", "LESS_THAN", "GREATER_THAN", "IS_MISSING"),
-  comparisonValue,
-  not = FALSE
-)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    metric
    metric name to filter on.
    operator
    How to match the dimension.
    comparisonValue
    What to match.
    not
    Logical NOT operator. Boolean.
    
-
-    
    Value
    
-
-    
    An object of class met_fil_ga4 for use in filter_clause_ga4()
    
-    
    See also
    
-
-    
    Other filter functions: 
-dim_filter(),
-filter_clause_ga4()
    
-
-    
    Examples
    
-    
    
-if (FALSE) {
-library(googleAnalyticsR)
-
-## authenticate,
-## or use the RStudio Addin "Google API Auth" with analytics scopes set
-ga_auth()
-
-## get your accounts
-account_list <- google_analytics_account_list()
-
-## pick a profile with data to query
-
-ga_id <- account_list[23,'viewId']
-
-## create filters on metrics
-mf <- met_filter("bounces", "GREATER_THAN", 0)
-mf2 <- met_filter("sessions", "GREATER", 2)
-
-## create filters on dimensions
-df <- dim_filter("source","BEGINS_WITH","1",not = TRUE)
-df2 <- dim_filter("source","BEGINS_WITH","a",not = TRUE)
-
-## construct filter objects
-fc2 <- filter_clause_ga4(list(df, df2), operator = "AND")
-fc <- filter_clause_ga4(list(mf, mf2), operator = "AND")
-
-## make v4 request
-ga_data1 <- google_analytics_4(ga_id,
-                               date_range = c("2015-07-30","2015-10-01"),
-                               dimensions=c('source','medium'),
-                               metrics = c('sessions','bounces'),
-                               met_filters = fc,
-                               dim_filters = fc2,
-                               filtersExpression = "ga:source!=(direct)")
+    
    
+    
    met_filter(
+  metric,
+  operator = c("EQUAL", "LESS_THAN", "GREATER_THAN", "IS_MISSING"),
+  comparisonValue,
+  not = FALSE
+)
    
+    
    
 
-}
+    
    
+    
    Arguments
    
+    
    metric
    
+
    metric name to filter on.
    
+
    operator
    
+
    How to match the dimension.
    
+
    comparisonValue
    
+
    What to match.
    
+
    not
    
+
    Logical NOT operator. Boolean.
    
+
    
+    
    
+    
    Value
    
+    
    An object of class met_fil_ga4 for use in filter_clause_ga4()
    
+    
    
+    
    
+    
    See also
    
+    
    Other filter functions: 
+dim_filter(),
+filter_clause_ga4()
    
+    
    
 
-
    
+    
    
+    
    Examples
    
+    
    
+if (FALSE) {
+library(googleAnalyticsR)
+
+## authenticate,
+## or use the RStudio Addin "Google API Auth" with analytics scopes set
+ga_auth()
+
+## get your accounts
+account_list <- google_analytics_account_list()
+
+## pick a profile with data to query
+
+ga_id <- account_list[23,'viewId']
+
+## create filters on metrics
+mf <- met_filter("bounces", "GREATER_THAN", 0)
+mf2 <- met_filter("sessions", "GREATER", 2)
+
+## create filters on dimensions
+df <- dim_filter("source","BEGINS_WITH","1",not = TRUE)
+df2 <- dim_filter("source","BEGINS_WITH","a",not = TRUE)
+
+## construct filter objects
+fc2 <- filter_clause_ga4(list(df, df2), operator = "AND")
+fc <- filter_clause_ga4(list(mf, mf2), operator = "AND")
+
+## make v4 request
+ga_data1 <- google_analytics_4(ga_id,
+                               date_range = c("2015-07-30","2015-10-01"),
+                               dimensions=c('source','medium'),
+                               metrics = c('sessions','bounces'),
+                               met_filters = fc,
+                               dim_filters = fc2,
+                               filtersExpression = "ga:source!=(direct)")
+
+}
+
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/met_ga4-class.html b/docs/reference/met_ga4-class.html
index 3ef53e58..219000e7 100644
--- a/docs/reference/met_ga4-class.html
+++ b/docs/reference/met_ga4-class.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-met_ga4 class. — met_ga4-class • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-met_ga4 class. — met_ga4-class • googleAnalyticsR
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    met_ga4 class.
    
-    Source: R/ga_v4_objects.R
+    Source: R/ga_v4_objects.R
     
     
    
 
@@ -297,32 +215,27 @@ 
    met_ga4 class.
    
 
 
 
-
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/meta.html b/docs/reference/meta.html
index 3ac1af8f..64fd3200 100644
--- a/docs/reference/meta.html
+++ b/docs/reference/meta.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Google Analytics API metadata — meta • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Google Analytics API metadata — meta • googleAnalyticsR
-
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Google Analytics API metadata
    
-    Source: R/data.R
+    Source: R/data.R
     
     
    
 
     
    
-    
    This is a local copy of the data provided by ga_meta
    
+    
    This is a local copy of the data provided by ga_meta
    
     
    
 
-    
    meta
    
-
-
-    
    Format
    
+    
    
+    
    meta
    
+    
    
 
+    
    
+    
    Format
    
     
    A data frame containing metric and dimensions that
 you can query the Reporting API with.
    
-    
    Source
    
-
-    
    https://ga-dev-tools.appspot.com/dimensions-metrics-explorer/
    
-    
    Details
    
-
+    
    
+    
+    
    
+    
    Details
    
     
    Running your own call will be more up to date, but this is here in case.
    
 
    It does not include the multi-channel or cohort variables.
    
+    
    
 
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/meta4.html b/docs/reference/meta4.html
index 0665c73d..c49b5875 100644
--- a/docs/reference/meta4.html
+++ b/docs/reference/meta4.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Google Analytics API metadata — meta4 • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Google Analytics API metadata — meta4 • googleAnalyticsR
-
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Google Analytics API metadata
    
-    Source: R/data.R
+    Source: R/data.R
     
     
    
 
     
    
-    
    This is a local copy of the data provided by ga_meta("data")
    
+    
    This is a local copy of the data provided by ga_meta("data")
    
     
    
 
-    
    meta4
    
-
-
-    
    Format
    
+    
    
+    
    meta4
    
+    
    
 
+    
    
+    
    Format
    
     
    A data frame containing metric and dimensions that
 you can query the Data API with.
    
-    
    Source
    
-
-    
    https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema
    
-    
    Details
    
-
+    
    
+    
+    
    
+    
    Details
    
     
    Running your own call will be more up to date, but this is here in case.
    
+    
    
 
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/metricDimensionSelect.html b/docs/reference/metricDimensionSelect.html
index 3398c8b4..14da09d6 100644
--- a/docs/reference/metricDimensionSelect.html
+++ b/docs/reference/metricDimensionSelect.html
@@ -1,86 +1,19 @@
-
 
-
-  
-  
-
-
-
-metricDimensionSelectUI - GA4 Shiny Module — metricDimensionSelectUI • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-metricDimensionSelectUI - GA4 Shiny Module — metricDimensionSelectUI • googleAnalyticsR
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    metricDimensionSelectUI - GA4 Shiny Module
    
-    Source: R/shiny-modules-new.R
+    Source: R/shiny-modules-new.R
     
     
    
 
     
    
     
    Create a Google Analytics variable selector
    
-
    Shiny Module for use with GA4 metric and dimension fields fetched via ga_meta("ga4")
    
+
    Shiny Module for use with GA4 metric and dimension fields fetched via ga_meta("ga4")
    
     
    
 
-    
    metricDimensionSelectUI(id, label = "Metric", multiple = TRUE, width = NULL)
-
-metricDimensionSelect(
-  id,
-  field_type = c("metric", "dimension"),
-  custom_meta = NULL,
-  default = NULL
-)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    id
    The Shiny id
    label
    label
    multiple
    multiple select
    width
    width of select
    field_type
    metric or dimension
    custom_meta
    Pass a meta field table from ga_meta("ga4") to get custom fields from GA4 (reactive)
    default
    The default selected choice. First element if NULL
    
+    
    
+    
    metricDimensionSelectUI(id, label = "Metric", multiple = TRUE, width = NULL)
 
-    
    Value
    
-
-    
    Shiny UI
    
-
    the selected variable
    
-    
    See also
    
+metricDimensionSelect(
+  id,
+  field_type = c("metric", "dimension"),
+  custom_meta = NULL,
+  default = NULL
+)
    
+    
    
 
-    
    Other Shiny modules: 
-accountPickerUI(),
-authDropdownUI(),
-authDropdown(),
-multi_selectUI(),
-multi_select()
    
+    
    
+    
    Arguments
    
+    
    id
    
+
    The Shiny id
    
+
    label
    
+
    label
    
+
    multiple
    
+
    multiple select
    
+
    width
    
+
    width of select
    
+
    field_type
    
+
    metric or dimension
    
+
    custom_meta
    
+
    Pass a meta field table from ga_meta("ga4") to get custom fields from GA4 (reactive)
    
+
    default
    
+
    The default selected choice. First element if NULL
    
+
    
+    
    
+    
    Value
    
+    
    Shiny UI
+the selected variable
    
+    
    
+    
    
+    
    See also
    
+    
    Other Shiny modules: 
+accountPickerUI(),
+authDropdownUI(),
+authDropdown(),
+multi_selectUI(),
+multi_select()
    
+    
    
 
-    
    Examples
    
-    
    
+    
    
+    
    Examples
    
+    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/multi_select.html b/docs/reference/multi_select.html
index c6640d2c..1364d0a4 100644
--- a/docs/reference/multi_select.html
+++ b/docs/reference/multi_select.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-multi_select Shiny Module — multi_select • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-multi_select Shiny Module — multi_select • googleAnalyticsR
-
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    multi_select Shiny Module
    
-    Source: R/shiny-modules.R
+    Source: R/shiny-modules.R
     
     
    
 
     
    
-    
    Shiny Module for use with multi_selectUI
    
+    
    Shiny Module for use with multi_selectUI
    
     
    
 
-    
    multi_select(
-  input,
-  output,
-  session,
-  type = c("METRIC", "DIMENSION"),
-  subType = c("all", "segment", "cohort"),
-  default = NULL
-)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    input
    shiny input
    output
    shiny output
    session
    shiny session
    type
    metric or dimension
    subType
    Limit selections to those relevant
    default
    The default selected choice. First element if NULL
    
-
-    
    Value
    
+    
    
+    
    multi_select(
+  input,
+  output,
+  session,
+  type = c("METRIC", "DIMENSION"),
+  subType = c("all", "segment", "cohort"),
+  default = NULL
+)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    input
    
+
    shiny input
    
+
    output
    
+
    shiny output
    
+
    session
    
+
    shiny session
    
+
    type
    
+
    metric or dimension
    
+
    subType
    
+
    Limit selections to those relevant
    
+
    default
    
+
    The default selected choice. First element if NULL
    
+
    
+    
    
+    
    Value
    
     
    the selected variable
    
-    
    Details
    
-
-    
    Call via shiny::callModule(multi_select, "your_id")
    
-    
    See also
    
-
-    
    Other Shiny modules: 
-accountPickerUI(),
-authDropdownUI(),
-authDropdown(),
-metricDimensionSelectUI(),
-multi_selectUI()
    
+    
    
+    
    
+    
    Details
    
+    
    Call via shiny::callModule(multi_select, "your_id")
    
+    
    
+    
    
+    
    See also
    
+    
    Other Shiny modules: 
+accountPickerUI(),
+authDropdownUI(),
+authDropdown(),
+metricDimensionSelectUI(),
+multi_selectUI()
    
+    
    
 
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/multi_selectUI.html b/docs/reference/multi_selectUI.html
index bc574b87..4606f937 100644
--- a/docs/reference/multi_selectUI.html
+++ b/docs/reference/multi_selectUI.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-multi_select UI Shiny Module — multi_selectUI • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-multi_select UI Shiny Module — multi_selectUI • googleAnalyticsR
-
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    multi_select UI Shiny Module
    
-    Source: R/shiny-modules.R
+    Source: R/shiny-modules.R
     
     
    
 
     
    
-    
    Shiny Module for use with multi_select
    
+    
    Shiny Module for use with multi_select
    
     
    
 
-    
    multi_selectUI(id, label = "Metric", multiple = TRUE, width = NULL)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    id
    Shiny id
    label
    label
    multiple
    multiple select
    width
    width of select
    
-
-    
    Value
    
+    
    
+    
    multi_selectUI(id, label = "Metric", multiple = TRUE, width = NULL)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    id
    
+
    Shiny id
    
+
    label
    
+
    label
    
+
    multiple
    
+
    multiple select
    
+
    width
    
+
    width of select
    
+
    
+    
    
+    
    Value
    
     
    Shiny UI
    
-    
    Details
    
-
+    
    
+    
    
+    
    Details
    
     
    Create a Google Analytics variable selector
    
-    
    See also
    
-
-    
    Other Shiny modules: 
-accountPickerUI(),
-authDropdownUI(),
-authDropdown(),
-metricDimensionSelectUI(),
-multi_select()
    
+    
    
+    
    
+    
    See also
    
+    
    Other Shiny modules: 
+accountPickerUI(),
+authDropdownUI(),
+authDropdown(),
+metricDimensionSelectUI(),
+multi_select()
    
+    
    
 
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/orFiltersForSegment_ga4-class.html b/docs/reference/orFiltersForSegment_ga4-class.html
index 137706bf..5d629896 100644
--- a/docs/reference/orFiltersForSegment_ga4-class.html
+++ b/docs/reference/orFiltersForSegment_ga4-class.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-orFiltersForSegment_ga4 class. — orFiltersForSegment_ga4-class • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-orFiltersForSegment_ga4 class. — orFiltersForSegment_ga4-class • googleAnalyticsR
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    orFiltersForSegment_ga4 class.
    
-    Source: R/ga_v4_objects.R
+    Source: R/ga_v4_objects.R
     
     
    
 
@@ -297,32 +215,27 @@ 
    orFiltersForSegment_ga4 class.
    
 
 
 
-
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/order_type.html b/docs/reference/order_type.html
index 30ba038f..6f75dd62 100644
--- a/docs/reference/order_type.html
+++ b/docs/reference/order_type.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Make an OrderType object — order_type • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Make an OrderType object — order_type • googleAnalyticsR
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Make an OrderType object
    
-    Source: R/ga_v4_objects.R
+    Source: R/ga_v4_objects.R
     
     
    
 
@@ -295,61 +213,53 @@ 
    Make an OrderType object
    
     
    Make an OrderType object
    
     
    
 
-    
    order_type(
-  field,
-  sort_order = c("ASCENDING", "DESCENDING"),
-  orderType = c("VALUE", "DELTA", "SMART", "HISTOGRAM_BUCKET", "DIMENSION_AS_INTEGER")
-)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    field
    One field to sort by
    sort_order
    ASCENDING or DESCENDING
    orderType
    Type of ordering
    
-
-    
    Value
    
+    
    
+    
    order_type(
+  field,
+  sort_order = c("ASCENDING", "DESCENDING"),
+  orderType = c("VALUE", "DELTA", "SMART", "HISTOGRAM_BUCKET", "DIMENSION_AS_INTEGER")
+)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    field
    
+
    One field to sort by
    
+
    sort_order
    
+
    ASCENDING or DESCENDING
    
+
    orderType
    
+
    Type of ordering
    
+
    
+    
    
+    
    Value
    
     
    A order_type_ga4 object for use in GAv4 fetch
    
-    
    Details
    
-
+    
    
+    
    
+    
    Details
    
     
    For multiple order sorting, create separate OrderType objects to pass
    
+    
    
 
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/order_type_ga4-class.html b/docs/reference/order_type_ga4-class.html
index 4a0c9ad3..f77fe553 100644
--- a/docs/reference/order_type_ga4-class.html
+++ b/docs/reference/order_type_ga4-class.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-order_type_ga4 class. — order_type_ga4-class • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-order_type_ga4 class. — order_type_ga4-class • googleAnalyticsR
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    order_type_ga4 class.
    
-    Source: R/ga_v4_objects.R
+    Source: R/ga_v4_objects.R
     
     
    
 
@@ -297,32 +215,27 @@ 
    order_type_ga4 class.
    
 
 
 
-
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/parse_ga_account_summary.html b/docs/reference/parse_ga_account_summary.html
index ebed8709..7c6792af 100644
--- a/docs/reference/parse_ga_account_summary.html
+++ b/docs/reference/parse_ga_account_summary.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-New parse GA account summary — parse_ga_account_summary • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-New parse GA account summary — parse_ga_account_summary • googleAnalyticsR
-
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    New parse GA account summary
    
-    Source: R/parse_functions.R
+    Source: R/parse_functions.R
     
     
    
 
@@ -295,43 +213,37 @@ 
    New parse GA account summary
    
     
    New parse GA account summary
    
     
    
 
-    
    parse_ga_account_summary(x)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
    x
    The account summary items
    
+    
    
+    
    parse_ga_account_summary(x)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    x
    
+
    The account summary items
    
+
    
 
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/pivot_ga4.html b/docs/reference/pivot_ga4.html
index be25d1f1..8f31963a 100644
--- a/docs/reference/pivot_ga4.html
+++ b/docs/reference/pivot_ga4.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Make a pivot object — pivot_ga4 • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Make a pivot object — pivot_ga4 • googleAnalyticsR
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Make a pivot object
    
-    Source: R/pivots.R
+    Source: R/pivots.R
     
     
    
 
@@ -295,111 +213,101 @@ 
    Make a pivot object
    
     
    Make a pivot object
    
     
    
 
-    
    pivot_ga4(
-  pivot_dim,
-  metrics,
-  dim_filter_clause = NULL,
-  startGroup = 0,
-  maxGroupCount = 5
-)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    pivot_dim
    A character vector of dimensions
    metrics
    Metrics to aggregate and return.
    dim_filter_clause
    Only data included in filter included.
    startGroup
    which groups of k columns are included in response (0 indexed).
    maxGroupCount
    Maximum number of groups to return.
    
-
-    
    Value
    
-
-    
    pivot object of class pivot_ga4 for use in filter_clause_ga4()
    
-    
    Details
    
+    
    
+    
    pivot_ga4(
+  pivot_dim,
+  metrics,
+  dim_filter_clause = NULL,
+  startGroup = 0,
+  maxGroupCount = 5
+)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    pivot_dim
    
+
    A character vector of dimensions
    
+
    metrics
    
+
    Metrics to aggregate and return.
    
+
    dim_filter_clause
    
+
    Only data included in filter included.
    
+
    startGroup
    
+
    which groups of k columns are included in response (0 indexed).
    
+
    maxGroupCount
    
+
    Maximum number of groups to return.
    
+
    
+    
    
+    
    Value
    
+    
    pivot object of class pivot_ga4 for use in filter_clause_ga4()
    
+    
    
+    
    
+    
    Details
    
     
    If maxGroupCount is set to -1 returns all groups.
    
+    
    
 
-    
    Examples
    
-    
    
-if (FALSE) {
-library(googleAnalyticsR)
-
-## authenticate, 
-## or use the RStudio Addin "Google API Auth" with analytics scopes set
-ga_auth()
-
-## get your accounts
-account_list <- google_analytics_account_list()
-
-## pick a profile with data to query
-
-ga_id <- account_list[23,'viewId']
-
-## filter pivot results to 
-pivot_dim_filter1 <- dim_filter("medium",
-                                "REGEXP",
-                                "organic|social|email|cpc")
-                                
-                                
-pivot_dim_clause <- filter_clause_ga4(list(pivot_dim_filter1))
-
-pivme <- pivot_ga4("medium",
-                   metrics = c("sessions"), 
-                   maxGroupCount = 4, 
-                  dim_filter_clause = pivot_dim_clause)
-                  
-                  
-pivtest <- google_analytics(ga_id, 
-                            c("2016-01-30","2016-10-01"), 
-                            dimensions=c('source'), 
-                            metrics = c('sessions'), 
-                            pivots = list(pivme))
-
-}
-
-
-
    
+    
    
+    
    Examples
    
+    
    
+if (FALSE) {
+library(googleAnalyticsR)
+
+## authenticate, 
+## or use the RStudio Addin "Google API Auth" with analytics scopes set
+ga_auth()
+
+## get your accounts
+account_list <- google_analytics_account_list()
+
+## pick a profile with data to query
+
+ga_id <- account_list[23,'viewId']
+
+## filter pivot results to 
+pivot_dim_filter1 <- dim_filter("medium",
+                                "REGEXP",
+                                "organic|social|email|cpc")
+                                
+                                
+pivot_dim_clause <- filter_clause_ga4(list(pivot_dim_filter1))
+
+pivme <- pivot_ga4("medium",
+                   metrics = c("sessions"), 
+                   maxGroupCount = 4, 
+                  dim_filter_clause = pivot_dim_clause)
+                  
+                  
+pivtest <- google_analytics(ga_id, 
+                            c("2016-01-30","2016-10-01"), 
+                            dimensions=c('source'), 
+                            metrics = c('sessions'), 
+                            pivots = list(pivme))
+
+}
+
+
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/segmentBuilder.html b/docs/reference/segmentBuilder.html
index 5fce3261..e91d761f 100644
--- a/docs/reference/segmentBuilder.html
+++ b/docs/reference/segmentBuilder.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Create a GAv4 Segment Builder — segmentBuilder • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Create a GAv4 Segment Builder — segmentBuilder • googleAnalyticsR
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Create a GAv4 Segment Builder
    
-    Source: R/shiny-modules-segments.R
+    Source: R/shiny-modules-segments.R
     
     
    
 
     
    
-    
    Shiny Module for use with segmentBuilderUI
    
+    
    Shiny Module for use with segmentBuilderUI
    
     
    
 
-    
    segmentBuilder(input, output, session)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    input
    shiny input
    output
    shiny output
    session
    shiny session
    
-
-    
    Value
    
+    
    
+    
    segmentBuilder(input, output, session)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    input
    
+
    shiny input
    
+
    output
    
+
    shiny output
    
+
    session
    
+
    shiny session
    
+
    
+    
    
+    
    Value
    
     
    A segment definition
    
-    
    Details
    
-
-    
    Call via shiny::callModule(segmentBuilder, "your_id")
    
+    
    
+    
    
+    
    Details
    
+    
    Call via shiny::callModule(segmentBuilder, "your_id")
    
+    
    
 
-    
    Examples
    
-    
    
+    
    
+    
    Examples
    
+    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/segmentBuilderUI.html b/docs/reference/segmentBuilderUI.html
index a48bb68b..5718879f 100644
--- a/docs/reference/segmentBuilderUI.html
+++ b/docs/reference/segmentBuilderUI.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-Create a GAv4 Segment Builder — segmentBuilderUI • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Create a GAv4 Segment Builder — segmentBuilderUI • googleAnalyticsR
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Create a GAv4 Segment Builder
    
-    Source: R/shiny-modules-segments.R
+    Source: R/shiny-modules-segments.R
     
     
    
 
     
    
-    
    Shiny Module for use with segmentBuilder
    
+    
    Shiny Module for use with segmentBuilder
    
     
    
 
-    
    segmentBuilderUI(id)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
    id
    Shiny id
    
-
-    
    Value
    
+    
    
+    
    segmentBuilderUI(id)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    id
    
+
    Shiny id
    
+
    
+    
    
+    
    Value
    
     
    Shiny UI for use in app
    
+    
    
 
-    
    Examples
    
-    
    
+    
    
+    
    Examples
    
+    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/segmentDef_ga4-class.html b/docs/reference/segmentDef_ga4-class.html
index bca6f240..8540904f 100644
--- a/docs/reference/segmentDef_ga4-class.html
+++ b/docs/reference/segmentDef_ga4-class.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-segmentDef_ga4 class. — segmentDef_ga4-class • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-segmentDef_ga4 class. — segmentDef_ga4-class • googleAnalyticsR
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    segmentDef_ga4 class.
    
-    Source: R/ga_v4_objects.R
+    Source: R/ga_v4_objects.R
     
     
    
 
@@ -297,32 +215,27 @@ 
    segmentDef_ga4 class.
    
 
 
 
-
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/segmentFilterClause_ga4-class.html b/docs/reference/segmentFilterClause_ga4-class.html
index 86ae7435..c8f57c8d 100644
--- a/docs/reference/segmentFilterClause_ga4-class.html
+++ b/docs/reference/segmentFilterClause_ga4-class.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-segmentFilterClause_ga4 class. — segmentFilterClause_ga4-class • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-segmentFilterClause_ga4 class. — segmentFilterClause_ga4-class • googleAnalyticsR
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    segmentFilterClause_ga4 class.
    
-    Source: R/ga_v4_objects.R
+    Source: R/ga_v4_objects.R
     
     
    
 
@@ -297,32 +215,27 @@ 
    segmentFilterClause_ga4 class.
    
 
 
 
-
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/segmentFilter_ga4-class.html b/docs/reference/segmentFilter_ga4-class.html
index b1cf1f46..08e61feb 100644
--- a/docs/reference/segmentFilter_ga4-class.html
+++ b/docs/reference/segmentFilter_ga4-class.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-segmentFilter_ga4 class. — segmentFilter_ga4-class • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-segmentFilter_ga4 class. — segmentFilter_ga4-class • googleAnalyticsR
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    segmentFilter_ga4 class.
    
-    Source: R/ga_v4_objects.R
+    Source: R/ga_v4_objects.R
     
     
    
 
@@ -297,32 +215,27 @@ 
    segmentFilter_ga4 class.
    
 
 
 
-
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/segmentSequenceStep_ga4-class.html b/docs/reference/segmentSequenceStep_ga4-class.html
index 32127746..85a20b00 100644
--- a/docs/reference/segmentSequenceStep_ga4-class.html
+++ b/docs/reference/segmentSequenceStep_ga4-class.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-segmentSequenceStep_ga4 class. — segmentSequenceStep_ga4-class • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-segmentSequenceStep_ga4 class. — segmentSequenceStep_ga4-class • googleAnalyticsR
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    segmentSequenceStep_ga4 class.
    
-    Source: R/ga_v4_objects.R
+    Source: R/ga_v4_objects.R
     
     
    
 
@@ -297,32 +215,27 @@ 
    segmentSequenceStep_ga4 class.
    
 
 
 
-
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/segment_define.html b/docs/reference/segment_define.html
index e39ba321..b2eac990 100644
--- a/docs/reference/segment_define.html
+++ b/docs/reference/segment_define.html
@@ -1,92 +1,25 @@
-
 
-
-  
-  
-
-
-
-Make a segment definition — segment_define • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Make a segment definition — segment_define • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Make a segment definition
    
-    Source: R/segments.R
+    Source: R/segments.R
     
     
    
 
     
    
     
    Defines the segment to be a set of SegmentFilters
 which are combined together with a logical AND operation.
    
-
    segment_define is in the hierarchy of segment creation, for which you will also need:
    
+
    segment_define is in the hierarchy of segment creation, for which you will also need:
    
 
+    
    
+    
    segment_define(segment_filters, not_vector = NULL)
    
     
    
 
-    
    segment_define(segment_filters, not_vector = NULL)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    segment_filters
    A list of segment_vector_simple and segment_vector_sequence
    not_vector
    Boolean applied to each segmentFilter step.
-If NULL, assumed FALSE
    
-
-    
    Value
    
-
-    
    segmentDefinition object for segment_ga4
    
-    
    See also
    
-
-    
    Other v4 segment functions: 
-segment_element(),
-segment_ga4,
-segment_vector_sequence(),
-segment_vector_simple()
    
+    
    
+    
    Arguments
    
+    
    segment_filters
    
+
    A list of segment_vector_simple and segment_vector_sequence
    
+
    not_vector
    
+
    Boolean applied to each segmentFilter step.
+If NULL, assumed FALSE
    
+
    
+    
    
+    
    Value
    
+    
    segmentDefinition object for segment_ga4
    
+    
    
+    
    
+    
    See also
    
+    
    Other v4 segment functions: 
+segment_element(),
+segment_ga4,
+segment_vector_sequence(),
+segment_vector_simple()
    
+    
    
 
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/segment_element.html b/docs/reference/segment_element.html
index ef4ce36e..37e57b92 100644
--- a/docs/reference/segment_element.html
+++ b/docs/reference/segment_element.html
@@ -1,90 +1,23 @@
-
 
-
-  
-  
-
-
-
-Make a segment element — segment_element • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Make a segment element — segment_element • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Make a segment element
    
-    Source: R/segments.R
+    Source: R/segments.R
     
     
    
 
     
    
-    
    segment_element is the lowest hierarchy of segment creation, for which you will also need:
    
+
+    
    
+    
    segment_element(
+  name,
+  operator = c("REGEXP", "BEGINS_WITH", "ENDS_WITH", "PARTIAL", "EXACT", "IN_LIST",
+    "NUMERIC_LESS_THAN", "NUMERIC_GREATER_THAN", "NUMERIC_BETWEEN", "LESS_THAN",
+    "GREATER_THAN", "EQUAL", "BETWEEN"),
+  type = c("METRIC", "DIMENSION"),
+  not = FALSE,
+  expressions = NULL,
+  caseSensitive = NULL,
+  minComparisonValue = NULL,
+  maxComparisonValue = NULL,
+  scope = c("SESSION", "USER", "HIT", "PRODUCT"),
+  comparisonValue = NULL,
+  matchType = c("PRECEDES", "IMMEDIATELY_PRECEDES")
+)
    
     
    
 
-    
    segment_element(
-  name,
-  operator = c("REGEXP", "BEGINS_WITH", "ENDS_WITH", "PARTIAL", "EXACT", "IN_LIST",
-    "NUMERIC_LESS_THAN", "NUMERIC_GREATER_THAN", "NUMERIC_BETWEEN", "LESS_THAN",
-    "GREATER_THAN", "EQUAL", "BETWEEN"),
-  type = c("METRIC", "DIMENSION"),
-  not = FALSE,
-  expressions = NULL,
-  caseSensitive = NULL,
-  minComparisonValue = NULL,
-  maxComparisonValue = NULL,
-  scope = c("SESSION", "USER", "HIT", "PRODUCT"),
-  comparisonValue = NULL,
-  matchType = c("PRECEDES", "IMMEDIATELY_PRECEDES")
-)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    name
    Name of the GA metric or dimension to segment on
    operator
    How name shall operate on expression or comparisonValue
    type
    A metric or dimension based segment element
    not
    Should the element be the negation of what is defined
    expressions
    dim What the name shall compare to
    caseSensitive
    dim Whether to be case sensitive
    minComparisonValue
    dim Minimum comparison values for BETWEEN
    maxComparisonValue
    Max comparison value for BETWEEN operator
    scope
    met Scope of the metric value
    comparisonValue
    met What the name shall compare to
    matchType
    If used in sequence segment, what behaviour
    
-
-    
    Value
    
-
+    
    
+    
    Arguments
    
+    
    name
    
+
    Name of the GA metric or dimension to segment on
    
+
    operator
    
+
    How name shall operate on expression or comparisonValue
    
+
    type
    
+
    A metric or dimension based segment element
    
+
    not
    
+
    Should the element be the negation of what is defined
    
+
    expressions
    
+
    dim What the name shall compare to
    
+
    caseSensitive
    
+
    dim Whether to be case sensitive
    
+
    minComparisonValue
    
+
    dim Minimum comparison values for BETWEEN
    
+
    maxComparisonValue
    
+
    Max comparison value for BETWEEN operator
    
+
    scope
    
+
    met Scope of the metric value
    
+
    comparisonValue
    
+
    met What the name shall compare to
    
+
    matchType
    
+
    If used in sequence segment, what behaviour
    
+
    
+    
    
+    
    Value
    
     
    A SegmentFilterClause object
    
-    
    See also
    
-
-    
    Other v4 segment functions: 
-segment_define(),
-segment_ga4,
-segment_vector_sequence(),
-segment_vector_simple()
    
+    
    
+    
    
+    
    See also
    
+    
    Other v4 segment functions: 
+segment_define(),
+segment_ga4,
+segment_vector_sequence(),
+segment_vector_simple()
    
+    
    
 
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/segment_ga4-class.html b/docs/reference/segment_ga4-class.html
index 961f8cf9..119c8a85 100644
--- a/docs/reference/segment_ga4-class.html
+++ b/docs/reference/segment_ga4-class.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-segment_ga4 class. — segment_ga4-class • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-segment_ga4 class. — segment_ga4-class • googleAnalyticsR
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    segment_ga4 class.
    
-    Source: R/ga_v4_objects.R
+    Source: R/ga_v4_objects.R
     
     
    
 
@@ -297,32 +215,27 @@ 
    segment_ga4 class.
    
 
 
 
-
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/segment_ga4.html b/docs/reference/segment_ga4.html
index cbd4b699..ab5532b7 100644
--- a/docs/reference/segment_ga4.html
+++ b/docs/reference/segment_ga4.html
@@ -1,87 +1,20 @@
-
 
-
-  
-  
-
-
-
-Make a segment object for use — segment_ga4 • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Make a segment object for use — segment_ga4 • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Make a segment object for use
    
-    Source: R/segments.R
+    Source: R/segments.R
     
     
    
 
@@ -299,172 +217,162 @@ 
    Make a segment object for use
    
 might be users from a particular country or city.
    
     
    
 
-    
    segment_ga4(
-  name,
-  segment_id = NULL,
-  user_segment = NULL,
-  session_segment = NULL
-)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    name
    The name of the segment for the reports.
    segment_id
    The segment ID of a built in or custom segment e.g. gaid::-3
    user_segment
    A list of segment_define's that apply to users
    session_segment
    A list of segment_define's that apply to sessions
    
-
-    
    Value
    
+    
    
+    
    segment_ga4(
+  name,
+  segment_id = NULL,
+  user_segment = NULL,
+  session_segment = NULL
+)
    
+    
    
 
+    
    
+    
    Arguments
    
+    
    name
    
+
    The name of the segment for the reports.
    
+
    segment_id
    
+
    The segment ID of a built in or custom segment e.g. gaid::-3
    
+
    user_segment
    
+
    A list of segment_define's that apply to users
    
+
    session_segment
    
+
    A list of segment_define's that apply to sessions
    
+
    
+    
    
+    
    Value
    
     
    a segmentFilter object. You can pass a list of these to the request.
    
-    
    Details
    
-
-    
    segment_ga4 is the top hierarchy of segment creation, for which you will also need:
    
-
-    
    See also
    
-
-    
    Other v4 segment functions: 
-segment_define(),
-segment_element(),
-segment_vector_sequence(),
-segment_vector_simple()
    
-
-    
    Examples
    
-    
    
-if (FALSE) {
-library(googleAnalyticsR)
-
-## authenticate, 
-## or use the RStudio Addin "Google API Auth" with analytics scopes set
-ga_auth()
-
-## get your accounts
-account_list <- google_analytics_account_list()
-
-## pick a profile with data to query
-
-ga_id <- account_list[23,'viewId']
-
-
-## make a segment element
-se <- segment_element("sessions", 
-                      operator = "GREATER_THAN", 
-                      type = "METRIC", 
-                      comparisonValue = 1, 
-                      scope = "USER")
-                      
-                      
-se2 <- segment_element("medium", 
-                       operator = "EXACT", 
-                       type = "DIMENSION", 
-                       expressions = "organic")
-                       
-                       
-## choose between segment_vector_simple or segment_vector_sequence
-## Elements can be combined into clauses, which can then be 
-##    combined into OR filter clauses
-sv_simple <- segment_vector_simple(list(list(se)))
-
-sv_simple2 <- segment_vector_simple(list(list(se2)))
-
-## Each segment vector can then be combined into a logical AND
-
-seg_defined <- segment_define(list(sv_simple, sv_simple2))
-
-## if only one AND definition, you can leave out wrapper list()
-
-seg_defined_one <- segment_define(sv_simple)
-
-## Each segement defintion can apply to users, sessions or both.
-## You can pass a list of several segments
-
-segment4 <- segment_ga4("simple", user_segment = seg_defined)
-## Add the segments to the segments param
-
-segment_example <- google_analytics(ga_id, 
-                                    c("2015-07-30","2015-10-01"), 
-                                    dimensions=c('source','medium','segment'), 
-                                    segments = segment4, 
-                                    metrics = c('sessions','bounces')
-                                     )
-                                     
-                                     
-## Sequence segment
-
-se2 <- segment_element("medium", 
-                       operator = "EXACT", 
-                       type = "DIMENSION", 
-                       expressions = "organic")
-                       
-se3 <- segment_element("medium",
-                       operator = "EXACT",
-                       type = "DIMENSION",
-                       not = TRUE,
-                      expressions = "organic")
-                      
-## step sequence
-## users who arrived via organic then via referral
-sv_sequence <- segment_vector_sequence(list(list(se2), 
-                                            list(se3)))
-                                            
-seq_defined2 <- segment_define(list(sv_sequence))
-
-segment4_seq <- segment_ga4("sequence", user_segment = seq_defined2)
-
-## Add the segments to the segments param
-
-segment_seq_example <- google_analytics(ga_id, 
-                                        c("2016-04-01","2016-05-01"), 
-                                        dimensions=c('source','segment'), 
-                                        segments = segment4_seq,
-                                        metrics = c('sessions','bounces')
-                                         )
-                                     
-}
+    
    
+    
    
+    
    Details
    
+    
    segment_ga4 is the top hierarchy of segment creation, for which you will also need:
    
+    
    
+    
    See also
    
+    
    Other v4 segment functions: 
+segment_define(),
+segment_element(),
+segment_vector_sequence(),
+segment_vector_simple()
    
+    
    
 
-
    
+    
    
+    
    Examples
    
+    
    
+if (FALSE) {
+library(googleAnalyticsR)
+
+## authenticate, 
+## or use the RStudio Addin "Google API Auth" with analytics scopes set
+ga_auth()
+
+## get your accounts
+account_list <- google_analytics_account_list()
+
+## pick a profile with data to query
+
+ga_id <- account_list[23,'viewId']
+
+
+## make a segment element
+se <- segment_element("sessions", 
+                      operator = "GREATER_THAN", 
+                      type = "METRIC", 
+                      comparisonValue = 1, 
+                      scope = "USER")
+                      
+                      
+se2 <- segment_element("medium", 
+                       operator = "EXACT", 
+                       type = "DIMENSION", 
+                       expressions = "organic")
+                       
+                       
+## choose between segment_vector_simple or segment_vector_sequence
+## Elements can be combined into clauses, which can then be 
+##    combined into OR filter clauses
+sv_simple <- segment_vector_simple(list(list(se)))
+
+sv_simple2 <- segment_vector_simple(list(list(se2)))
+
+## Each segment vector can then be combined into a logical AND
+
+seg_defined <- segment_define(list(sv_simple, sv_simple2))
+
+## if only one AND definition, you can leave out wrapper list()
+
+seg_defined_one <- segment_define(sv_simple)
+
+## Each segement defintion can apply to users, sessions or both.
+## You can pass a list of several segments
+
+segment4 <- segment_ga4("simple", user_segment = seg_defined)
+## Add the segments to the segments param
+
+segment_example <- google_analytics(ga_id, 
+                                    c("2015-07-30","2015-10-01"), 
+                                    dimensions=c('source','medium','segment'), 
+                                    segments = segment4, 
+                                    metrics = c('sessions','bounces')
+                                     )
+                                     
+                                     
+## Sequence segment
+
+se2 <- segment_element("medium", 
+                       operator = "EXACT", 
+                       type = "DIMENSION", 
+                       expressions = "organic")
+                       
+se3 <- segment_element("medium",
+                       operator = "EXACT",
+                       type = "DIMENSION",
+                       not = TRUE,
+                      expressions = "organic")
+                      
+## step sequence
+## users who arrived via organic then via referral
+sv_sequence <- segment_vector_sequence(list(list(se2), 
+                                            list(se3)))
+                                            
+seq_defined2 <- segment_define(list(sv_sequence))
+
+segment4_seq <- segment_ga4("sequence", user_segment = seq_defined2)
+
+## Add the segments to the segments param
+
+segment_seq_example <- google_analytics(ga_id, 
+                                        c("2016-04-01","2016-05-01"), 
+                                        dimensions=c('source','segment'), 
+                                        segments = segment4_seq,
+                                        metrics = c('sessions','bounces')
+                                         )
+                                     
+}
+
+
    
+    
    
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/segment_vector_sequence.html b/docs/reference/segment_vector_sequence.html
index d5d3cc60..329fc3fd 100644
--- a/docs/reference/segment_vector_sequence.html
+++ b/docs/reference/segment_vector_sequence.html
@@ -1,90 +1,23 @@
-
 
-
-  
-  
-
-
-
-Make sequenceSegment — segment_vector_sequence • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Make sequenceSegment — segment_vector_sequence • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Make sequenceSegment
    
-    Source: R/segments.R
+    Source: R/segments.R
     
     
    
 
     
    
-    
    segment_vector_sequence is in the hierarchy of segment creation, for which you will also need:
    
+    
    segment_vector_sequence is in the hierarchy of segment creation, for which you will also need:
    
 
+    
    
+    
    segment_vector_sequence(segment_elements, firstStepMatch = FALSE)
    
     
    
 
-    
    segment_vector_sequence(segment_elements, firstStepMatch = FALSE)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
-      
-      
-    
-    
    segment_elements
    a list of OR lists of segment elements
    firstStepMatch
    FALSE default
    
-
-    
    See also
    
-
-    
    Other v4 segment functions: 
-segment_define(),
-segment_element(),
-segment_ga4,
-segment_vector_simple()
    
+    
    
+    
    Arguments
    
+    
    segment_elements
    
+
    a list of OR lists of segment elements
    
+
    firstStepMatch
    
+
    FALSE default
    
+
    
+    
    
+    
    See also
    
+    
    Other v4 segment functions: 
+segment_define(),
+segment_element(),
+segment_ga4,
+segment_vector_simple()
    
+    
    
 
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/segment_vector_simple.html b/docs/reference/segment_vector_simple.html
index bc75d7dc..5e3518cc 100644
--- a/docs/reference/segment_vector_simple.html
+++ b/docs/reference/segment_vector_simple.html
@@ -1,90 +1,23 @@
-
 
-
-  
-  
-
-
-
-Make a simple segment vector — segment_vector_simple • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Make a simple segment vector — segment_vector_simple • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-
-  
-
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    Make a simple segment vector
    
-    Source: R/segments.R
+    Source: R/segments.R
     
     
    
 
     
    
-    
    segment_vector_simple is in the hierarchy of segment creation, for which you will also need:
    
+    
    segment_vector_simple is in the hierarchy of segment creation, for which you will also need:
    
 
+    
    
+    
    segment_vector_simple(segment_elements)
    
     
    
 
-    
    segment_vector_simple(segment_elements)
    
-
-    
    Arguments
    
-    
-    
-    
-      
-      
-    
-    
    segment_elements
    A list of OR lists of segment_element
    
-
-    
    Value
    
-
-    
    A segment vector you can put in a list for use in segment_ga4
    
-    
    See also
    
-
-    
    Other v4 segment functions: 
-segment_define(),
-segment_element(),
-segment_ga4,
-segment_vector_sequence()
    
+    
    
+    
    Arguments
    
+    
    segment_elements
    
+
    A list of OR lists of segment_element
    
+
    
+    
    
+    
    Value
    
+    
    A segment vector you can put in a list for use in segment_ga4
    
+    
    
+    
    
+    
    See also
    
+    
    Other v4 segment functions: 
+segment_define(),
+segment_element(),
+segment_ga4,
+segment_vector_sequence()
    
+    
    
 
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/sequenceSegment_ga4-class.html b/docs/reference/sequenceSegment_ga4-class.html
index e558e5ec..f3f4c68f 100644
--- a/docs/reference/sequenceSegment_ga4-class.html
+++ b/docs/reference/sequenceSegment_ga4-class.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-sequenceSegment_ga4 class. — sequenceSegment_ga4-class • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-sequenceSegment_ga4 class. — sequenceSegment_ga4-class • googleAnalyticsR
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    sequenceSegment_ga4 class.
    
-    Source: R/ga_v4_objects.R
+    Source: R/ga_v4_objects.R
     
     
    
 
@@ -297,32 +215,27 @@ 
    sequenceSegment_ga4 class.
    
 
 
 
-
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/reference/simpleSegment_ga4-class.html b/docs/reference/simpleSegment_ga4-class.html
index 2d33e61f..2761eebb 100644
--- a/docs/reference/simpleSegment_ga4-class.html
+++ b/docs/reference/simpleSegment_ga4-class.html
@@ -1,85 +1,18 @@
-
 
-
-  
-  
-
-
-
-simpleSegment_ga4 class. — simpleSegment_ga4-class • googleAnalyticsR
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-simpleSegment_ga4 class. — simpleSegment_ga4-class • googleAnalyticsR
-
-
-
-
-
-
-
-  
+  gtag('config', 'G-43MDXK6CLZ');
+
+    
 
-  
     
    
-      
    
-      
 
       
 
-      
    
-
-
    
+      
    
   
    
     
    
     
    simpleSegment_ga4 class.
    
-    Source: R/ga_v4_objects.R
+    Source: R/ga_v4_objects.R
     
     
    
 
@@ -297,32 +215,27 @@ 
    simpleSegment_ga4 class.
    
 
 
 
-
   
    
   
+    
    
 
    
 
 
-      
    
-      
    
-  
    Developed by Mark Edmondson.
    
+      
    
+  
    Developed by Mark Edmondson.
    
 
    
 
 
    
-  
    Site built with pkgdown 1.6.1.
    
+  
    Site built with pkgdown 2.0.1.
    
 
    
 
-      
    
-   
    
+      
    
 
   
 
 
-  
-
+  
 
+  
 
diff --git a/docs/sitemap.xml b/docs/sitemap.xml
index b5b6bbba..f1450be1 100644
--- a/docs/sitemap.xml
+++ b/docs/sitemap.xml
@@ -1,411 +1,666 @@
 
 
   
-    https://code.markedmondson.me/googleAnalyticsR//index.html
+    https://code.markedmondson.me/googleAnalyticsR/404.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/accountPicker.html
+    https://code.markedmondson.me/googleAnalyticsR/CODE_OF_CONDUCT.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/authDropdown.html
+    https://code.markedmondson.me/googleAnalyticsR/LICENSE-text.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/authDropdownUI.html
+    https://code.markedmondson.me/googleAnalyticsR/articles/big-query.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/dim_fil_ga4-class.html
+    https://code.markedmondson.me/googleAnalyticsR/articles/faq.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/dim_filter.html
+    https://code.markedmondson.me/googleAnalyticsR/articles/ganalytics.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/dim_ga4-class.html
+    https://code.markedmondson.me/googleAnalyticsR/articles/googleAnalyticsR.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/dynamicSegment_ga4-class.html
+    https://code.markedmondson.me/googleAnalyticsR/articles/index.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/filter_clause_ga4.html
+    https://code.markedmondson.me/googleAnalyticsR/articles/management.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/filter_clauses_ga4-class.html
+    https://code.markedmondson.me/googleAnalyticsR/articles/measurement-protocol-v2.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_account_list.html
+    https://code.markedmondson.me/googleAnalyticsR/articles/model-templates.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_accounts.html
+    https://code.markedmondson.me/googleAnalyticsR/articles/models.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_adwords.html
+    https://code.markedmondson.me/googleAnalyticsR/articles/practical-tips.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_adwords_add_linkid.html
+    https://code.markedmondson.me/googleAnalyticsR/articles/reporting-ga4.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_adwords_delete_linkid.html
+    https://code.markedmondson.me/googleAnalyticsR/articles/rmarkdown.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_adwords_list.html
+    https://code.markedmondson.me/googleAnalyticsR/articles/setup.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_aggregate.html
+    https://code.markedmondson.me/googleAnalyticsR/articles/shiny.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_allowed_metric_dim.html
+    https://code.markedmondson.me/googleAnalyticsR/articles/user-activity.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_auth.html
+    https://code.markedmondson.me/googleAnalyticsR/articles/v3.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_auth_setup.html
+    https://code.markedmondson.me/googleAnalyticsR/articles/v4.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_cache_call.html
+    https://code.markedmondson.me/googleAnalyticsR/authors.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_clientid_activity.html
+    https://code.markedmondson.me/googleAnalyticsR/index.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_clientid_activity_unnest.html
+    https://code.markedmondson.me/googleAnalyticsR/issue_template.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_clientid_deletion.html
+    https://code.markedmondson.me/googleAnalyticsR/news/index.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_clientid_hash.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/BatchRunReportsRequest.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_custom_datasource.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/BetweenFilter.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_custom_upload.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/Dimension.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_custom_upload_delete.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/DimensionExpression.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_custom_upload_file.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/DimensionOrderBy.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_custom_upload_list.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/Entity.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_custom_vars.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/FilterExpression.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_custom_vars_create.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/FilterExpressionList.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_custom_vars_list.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/Filter_aw.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_custom_vars_patch.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/InListFilter.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_data.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/Metric.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_data_aggregations.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/NumericFilter.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_data_filter.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/OrderBy.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_data_order.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/PivotObject.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_experiment.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/PivotOrderBy.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_experiment_list.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/RunReportRequest.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_filter.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/StringFilter.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_filter_add.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/accountPicker.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_filter_apply_to_view.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/aggregateGAData.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_filter_delete.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/allowed_metric_dim.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_filter_list.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/anti_sample.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_filter_update.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/authDropdown.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_filter_update_filter_link.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/authDropdownUI.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_filter_view.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/cat0.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_filter_view_list.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/checkPrefix.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_goal.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/chunkify.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_goal_add.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/cohort.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_goal_list.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/cohortGroup.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_goal_update.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/cohort_dimension_check.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_meta.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/cohort_metric_check.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_model.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/customDimension.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_model_edit.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/date_ga4.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_model_example.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/dim_fil_ga4-class.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_model_load.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/dim_filter.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_model_make.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/dim_ga4-class.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_model_refresh.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/dimension_ga4.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_model_save.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/dynamicSegment.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_model_shiny.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/dynamicSegment_ga4-class.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_model_shiny_load.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/error.message.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_model_shiny_template.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/expect_null_or_s3_class.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_model_write.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/expect_null_or_type.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_mp_cid.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/fetch_google_analytics_4.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_mp_event.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/fetch_google_analytics_4_slow.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_mp_event_item.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/filter_clause_ga4.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_mp_send.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/filter_clauses_ga4-class.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_remarketing_build.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_account_list.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_remarketing_create.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_accounts.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_remarketing_estimate.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_admin_account_summary.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_remarketing_get.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_adwords.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_remarketing_list.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_adwords_add_linkid.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_segment_list.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_adwords_delete_linkid.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_trackme_event.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_adwords_list.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_unsampled.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_aggregate.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_unsampled_download.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_allowed_metric_dim.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_unsampled_list.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_auth.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_users_add.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_auth_setup.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_users_delete.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_aw_filter.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_users_delete_linkid.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_aw_filter_expr.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_users_list.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_cache_call.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_users_update.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_clientid_activity.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_view.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_clientid_activity_unnest.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_view_list.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_clientid_deletion.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_webproperty.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_clientid_hash.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/ga_webproperty_list.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_custom_datasource.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/googleAnalyticsR.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_custom_upload.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/google_analytics.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_custom_upload_delete.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/google_analytics_3.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_custom_upload_file.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/google_analytics_bq.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_custom_upload_list.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/google_analytics_bq_asynch.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_custom_vars.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/make_cohort_group.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_custom_vars_create.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/met_fil_ga4-class.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_custom_vars_list.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/met_filter.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_custom_vars_patch.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/met_ga4-class.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_data.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/meta.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_data_aggregations.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/meta4.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_data_filter.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/metricDimensionSelect.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_data_order.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/multi_select.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_data_pivot.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/multi_selectUI.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_experiment.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/orFiltersForSegment_ga4-class.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_experiment_list.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/order_type.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_filter.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/order_type_ga4-class.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_filter_add.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/parse_ga_account_summary.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_filter_apply_to_view.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/pivot_ga4.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_filter_delete.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/segmentBuilder.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_filter_list.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/segmentBuilderUI.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_filter_update.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/segmentDef_ga4-class.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_filter_update_filter_link.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/segmentFilterClause_ga4-class.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_filter_view.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/segmentFilter_ga4-class.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_filter_view_list.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/segmentSequenceStep_ga4-class.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_goal.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/segment_define.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_goal_add.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/segment_element.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_goal_list.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/segment_ga4-class.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_goal_update.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/segment_ga4.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_meta.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/segment_vector_sequence.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_model.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/segment_vector_simple.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_model_edit.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/sequenceSegment_ga4-class.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_model_example.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//reference/simpleSegment_ga4-class.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_model_load.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//articles/big-query.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_model_make.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//articles/faq.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_model_refresh.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//articles/ganalytics.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_model_save.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//articles/management.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_model_shiny.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//articles/measurement-protocol-v2.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_model_shiny_load.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//articles/model-templates.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_model_shiny_template.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//articles/models.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_model_tweet.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//articles/practical-tips.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_model_write.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//articles/reporting-ga4.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_mp_cid.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//articles/rmarkdown.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_mp_event.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//articles/setup.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_mp_event_item.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//articles/shiny.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_mp_send.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//articles/user-activity.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_remarketing_build.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//articles/v3.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_remarketing_create.html
   
   
-    https://code.markedmondson.me/googleAnalyticsR//articles/v4.html
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_remarketing_estimate.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_remarketing_get.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_remarketing_list.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_segment_list.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_trackme_event.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_unsampled.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_unsampled_download.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_unsampled_list.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_user_deletion.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_users_add.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_users_delete.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_users_delete_linkid.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_users_list.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_users_update.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_view.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_view_list.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_webproperty.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/ga_webproperty_list.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/getColNameOfClass.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/googleAnalyticsR.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/google_analytics.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/google_analytics_3.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/google_analytics_4_parse.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/google_analytics_aw.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/google_analytics_bq.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/google_analytics_bq_asynch.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/google_analytics_meta.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/idempotency.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/index.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/is.NullOb.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/is.error.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/listNameToDFCol.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/makeOrFilters.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/makePivotData.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/makePivotNames.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/make_cohort_group.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/make_ga_4_req.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/met_fil_ga4-class.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/met_filter.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/met_ga4-class.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/meta.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/meta4.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/metricDimensionSelect.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/metric_ga4.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/multi_select.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/multi_selectUI.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/myMessage.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/orFiltersForSegment.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/orFiltersForSegment_ga4-class.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/order_type.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/order_type_ga4-class.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/parse_ga_account_summary.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/parse_realtime.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/pivot_ga4.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/pivot_ga4_parse.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/print.ga_model_result.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/reexports.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/rmNullObs.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/segmentBuilder.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/segmentBuilderUI.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/segmentChain.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/segmentChainUI.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/segmentDef_ga4-class.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/segmentDefinition.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/segmentDimensionFilter.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/segmentElementUI.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/segmentFilter.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/segmentFilterClause.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/segmentFilterClause_ga4-class.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/segmentFilter_ga4-class.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/segmentMetricFilter.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/segmentObj_ga4.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/segmentSequenceStep.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/segmentSequenceStep_ga4-class.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/segment_define.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/segment_element.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/segment_ga4-class.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/segment_ga4.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/segment_vector_sequence.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/segment_vector_simple.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/sequenceSegment.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/sequenceSegment_ga4-class.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/simpleSegment.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/simpleSegment_ga4-class.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/timestamp_to_r.html
+  
+  
+    https://code.markedmondson.me/googleAnalyticsR/reference/unitToList.html