gSC ddlZddlZddlZddlZddlZddlZddlmZddl m Z ddl m Z m Z ddlZddlZej j#ej j%ej j'ej j)edej,eZej3ej4GddeZGdd eZGd d eZy) N) params_dictEvent) BaseStore DictStorez..cveZdZdZddefdZdZdZddZdZ d Z dd Z d Z d Z d ZdZdZdZdZdZy) BaseGa4mpa6 Parent class that provides an interface for sending data to Google Analytics, supporting the GA4 Measurement Protocol. Parameters ---------- api_secret : string Generated through the Google Analytics UI. To create a new secret, navigate in the Google Analytics UI to: Admin > Data Streams > [choose your stream] > Measurement Protocol API Secrets > Create See Also -------- * Measurement Protocol (Google Analytics 4): https://developers.google.com/analytics/devguides/collection/protocol/ga4 Examples -------- # Initialize tracking object for gtag usage >>> ga = gtagMP(api_secret = "API_SECRET", measurement_id = "MEASUREMENT_ID", client_id="CLIENT_ID") # Initialize tracking object for Firebase usage >>> ga = firebaseMP(api_secret = "API_SECRET", firebase_app_id = "FIREBASE_APP_ID", app_instance_id="APP_INSTANCE_ID") # Build an event >>> event_type = 'new_custom_event' >>> event_parameters = {'parameter_key_1': 'parameter_1', 'parameter_key_2': 'parameter_2'} >>> event = {'name': event_type, 'params': event_parameters } >>> events = [event] # Send a custom event to GA4 immediately >>> ga.send(events) # Postponed send of a custom event to GA4 >>> ga.send(events, postpone=True) >>> ga.postponed_send() Nstorectj|_||_g|_|t |t sJd|xs t |_|jd|_ d|_ y)Nz3if supplied, store must be an instance of BaseStorez+https://www.google-analytics.com/mp/collectz1https://www.google-analytics.com/debug/mp/collect) time_initialization_time api_secret _event_list isinstancerrr _check_store_requirements _base_domain_validation_domain)selfrr s /opt/Tautulli/lib/ga4mp/ga4mp.py__init__zBaseGa4mp.__init__Asc$(IIK!$} 5) <s>ss<)ik  &&(I"Uc|jjd0|jjdt|j|jjdt|jdzy)N session_idnamevaluelast_interaction_time_msec)r get_session_parameterset_session_parameterintr rs rrz#BaseGa4mp._check_store_requirementsKsd :: + +L 9 A JJ , ,,c$JcJcFd , e ((.JRUVZVoVorvVvRw(xrct|S)N)rr)rrs rcreate_new_eventzBaseGa4mp.create_new_eventRs $rc|j||j||j||durI|D]C}|jt j|d<|j j |Eytdt|dDcgc] }|||dz }}|j|||ycc}w)a  Method to send an http post request to google analytics with the specified events. Parameters ---------- events : List[Dict] A list of dictionaries of the events to be sent to Google Analytics. The list of dictionaries should adhere to the following format: [{'name': 'level_end', 'params' : {'level_name': 'First', 'success': 'True'} }, {'name': 'level_up', 'params': {'character': 'John Madden', 'level': 'First'} }] validation_hit : bool, optional Boolean to depict if events should be tested against the Measurement Protocol Validation Server, by default False postpone : bool, optional Boolean to depict if provided event list should be postponed, by default False date : datetime Python datetime object for sending a historical event at the given date. Date cannot be in the future. T_timestamp_microsr)validation_hitdateN) _check_params_check_date_not_in_future#_add_session_id_and_engagement_time_get_timestampr rappendrangelen _http_post)reventsr(postponer)eventbatched_event_lists rsendzBaseGa4mp.sendUs8 6" &&t, 008 t  /-1-@-@-M)*  ''. / 9>aVb8Q"/4uurz*" " OO">   "sB?c\|jD]}|j|gdg|_y)zX Method to send the events provided to Ga4mp.send(events,postpone=True) T)r3N)rr1)rr4s rpostponed_sendzBaseGa4mp.postponed_sends5 %% 4E OOUGdO 3 4rc.tj|y)a Method to append event name and parameters key-value pairing(s) to parameters dictionary. Parameters ---------- new_name_and_parameters : Dict A dictionary with one key-value pair representing a new type of event to be sent to Google Analytics. The dictionary should adhere to the following format: {'new_name': ['new_param_1', 'new_param_2', 'new_param_3']} N)rupdate)rnew_name_and_parameterss rappend_event_to_params_dictz%BaseGa4mp.append_event_to_params_dicts 23rc|j|d}|j}|dur |j}tj d|d}|D]}|j |} |j |} |j| |r |d|dd n|| d <|ntj d ||d usJd |j|} |j| } t| | d<tj d| d|r|d| d<tjj| } | jddtj | }|j#d}| jdt%|tjj'| |}|j(}tj d|tj d||dz }|S)aR Method to send http POST request to google-analytics. Parameters ---------- batched_event_list : List[List[Dict]] List of List of events. Places initial event payload into a list to send http POST in batches. validation_hit : bool, optional Boolean to depict if events should be tested against the Measurement Protocol Validation Server, by default False postpone : bool, optional Boolean to depict if provided event list should be postponed, by default False date : datetime Python datetime object for sending a historical event at the given date. Date cannot be in the future. Timestamp micros supports up to 48 hours of backdating. If date is specified, postpone must be False or an assertion will be thrown. NTzSending POST to: )domain)batchrparams)rrAr2zSetting event timestamp to: Fz;Cannot send postponed historical hit, ensure postpone=Falsetimestamp_microszTimestamp of request is: r&z Content-Typezapplication/json; charset=utf-8zutf-8zContent-LengthzBatch Number: z Status code: )r+rrloggerinfo _build_url_build_request_add_user_props_to_hit_datetime_to_timestampr-r!urllibrequestRequest add_headerjsondumpsencoder0urlopenstatus)rr5r(r3r) status_coder? batch_numberr@urlrJtsts_microreqjsondatajson_data_as_bytesresults rr1zBaseGa4mp._http_posts" &&t, "" T !,,F 'x01 '& E///0C)))6G  ' ' 0 v%/B H   :4&AB%QPQ%006..r2.1(m*+ 7@R8S7TUV.34G.H*+..((-C NN>+L Mzz'*H!)!9  NN+S1C-D E^^++C1CDF --K KK.7 8 KK- }5 6 A LM& Prc |t|tk(sJd|D]/}t|tsJdd|vsJdd|vr*Jd|D]j}|d}|d}|t j vs$t|D];}||j vst jd|dt|d |d =ly ) aj Method to check whether the provided event payload parameters align with supported parameters. Parameters ---------- events : List[Dict] A list of dictionaries of the events to be sent to Google Analytics. The list of dictionaries should adhere to the following format: [{'name': 'level_end', 'params' : {'level_name': 'First', 'success': 'True'} }, {'name': 'level_up', 'params': {'character': 'John Madden', 'level': 'First'} }] zevents should be a listz0each event should be an instance of a dictionaryrz#each event should have a "name" keyrAz%each event should have a "params" keyz7WARNING: Event parameters do not match event type. For z* event type, the correct parameter(s) are z. The parameter 'z' triggered this warning. For a breakdown of currently supported event types and their parameters go here: https://support.google.com/analytics/answer/9267735 N)typelistrdictrkeysrCwarning)rr2r4e event_name event_params parameters rr*zBaseGa4mp._check_paramss.F|t#>%>># NEeT* ^,^ ^*U? I$I I?u$ M&M M$  N A6JX;L[--//!,Z!8I (9(9(;;VWaVbcMNYZdNeMffxyBxCCde  rcp|D]}ttjdz}|d}d|jvr|jj d|d<d|jvsk|jj d}||kDr||z nd|d<|jj d|y) z` Method to add the session_id and engagement_time_msec parameter to all events. rrArengagement_time_msecrrrN)r!r r_r rr )rr2r4current_time_in_millisecondsrclast_interaction_times rr,z-BaseGa4mp._add_session_id_and_engagement_times xE+.tyy{T/A+B ( ?L<#4#4#66-1ZZ-M-Ml-[ \*%\->->-@@(, (H(HIe(f%pLOdpd7SVk7kjk 34 006RZv0w xrc|jjD]} |dvr-|j||jj|inVd|j vr|jdii|dj|d|jj|iiy#t j d|YxYw)z Method is a helper function to add user properties to outgoing hits. Parameters ---------- hit : dict )user_idnon_personalized_adsuser_propertiesrz-Failed to add user property to outgoing hit: N)r get_all_user_propertiesr:get_user_propertyr_rCrD)rhitkeys rrGz BaseGa4mp._add_user_props_to_hit!s::557 SC S==JJTZZ%A%A#%FGH( : $5r#:;)*11w (D(DS(IJK S S KC5QRs BB))Cct|dzS)z Method returns UNIX timestamp in microseconds for postponed hits. Parameters ---------- None g.A)r!)r timestamps rr-zBaseGa4mp._get_timestamp8s9s?##rcHtj|jS)a Private method to convert a datetime object into a timestamp Parameters ---------- dt : datetime A datetime object in any format Returns ------- timestamp A UNIX timestamp in milliseconds )r mktime timetuple)rdts rrHz BaseGa4mp._datetime_to_timestampBs{{2<<>**rcZ|y|tjjksJdy)z Method to check that provided date is not in the future. Parameters ---------- date : datetime Python datetime object Nz%Provided date cannot be in the future)datetimenow)rr)s rr+z#BaseGa4mp._check_date_not_in_futureRs5 < ))--// 76 7/rctdNzYSubclass should be using this function, but it was called through the base class instead.NotImplementedErrorrr?s rrEzBaseGa4mp._build_urlb!"}~~rctdr{r|rr@s rrFzBaseGa4mp._build_requesterrN)FFN)__name__ __module__ __qualname____doc__rrrr$r6r8r<r1r*r,rGr-rHr+rErFrrr r se"HV)Vy -^ 4 DL+Z xS.$+ 7 rr c4eZdZdZfdZdZdZdZxZS)GtagMPa Subclass for users of gtag. See `Ga4mp` parent class for examples. Parameters ---------- measurement_id : string The identifier for a Data Stream. Found in the Google Analytics UI under: Admin > Data Streams > [choose your stream] > Measurement ID (top-right) client_id : string A unique identifier for a client, representing a specific browser/device. c@t||||_||_yr)superrmeasurement_id client_id)rrrr __class__s rrzGtagMP.__init__ts $,"rc>|d|jd|jS)Nz?measurement_id= &api_secret=)rrr~s rrEzGtagMP._build_urlys&)$*=*=)>l4??J[\\rc |j|dS)N)rr2)rrs rrFzGtagMP._build_request|s!^^u==rcdtjddzdzttt jzS)z Utility function for generating a new client ID matching the typical format of 10 random digits and the UNIX timestamp in seconds, joined by a period. z%0.10drlc( .)randomrandintstrr!r r"s rrandom_client_idzGtagMP.random_client_ids4&..:66Urrc.eZdZdZfdZdZdZxZS) FirebaseMPa. Subclass for users of Firebase. See `Ga4mp` parent class for examples. Parameters ---------- firebase_app_id : string The identifier for a Firebase app. Found in the Firebase console under: Project Settings > General > Your Apps > App ID. app_instance_id : string A unique identifier for a Firebase app instance. * Android - getAppInstanceId() - https://firebase.google.com/docs/reference/android/com/google/firebase/analytics/FirebaseAnalytics#public-taskstring-getappinstanceid * Kotlin - getAppInstanceId() - https://firebase.google.com/docs/reference/kotlin/com/google/firebase/analytics/FirebaseAnalytics#getappinstanceid * Swift - appInstanceID() - https://firebase.google.com/docs/reference/swift/firebaseanalytics/api/reference/Classes/Analytics#appinstanceid * Objective-C - appInstanceID - https://firebase.google.com/docs/reference/ios/firebaseanalytics/api/reference/Classes/FIRAnalytics#+appinstanceid * C++ - GetAnalyticsInstanceId() - https://firebase.google.com/docs/reference/cpp/namespace/firebase/analytics#getanalyticsinstanceid * Unity - GetAnalyticsInstanceIdAsync() - https://firebase.google.com/docs/reference/unity/class/firebase/analytics/firebase-analytics#getanalyticsinstanceidasync c@t||||_||_yr)rrfirebase_app_idapp_instance_id)rrrrrs rrzFirebaseMP.__init__s  $..rc>|d|jd|jS)Nz?firebase_app_id=r)rrr~s rrEzFirebaseMP._build_urls&*4+?+?*@ T__L]^^rc |j|dS)N)rr2)rrs rrFzFirebaseMP._build_requests#'#7#75IIr)rrrrrrErFrrs@rrrs"/ _Jrr)rMloggingurllib.requestrIr rxr ga4mp.utilsr ga4mp.eventr ga4mp.storerrossyspathr.normpathjoindirname__file__ getLoggerrrCsetLevelINFOobjectr rrrrrrs   #,GGRWW\\"''//(";TBC   8 $ JJX UYU:JJr