B h1@s`ddlZddlZddlZddlZddlZddlmZejej de e Z Gddde ZdS)N) params_dict)levelc@steZdZdZddZdddZdd Zd d Zdd d ZddZ ddZ ddZ ddZ ddZ ddZddZdS)Ga4mpaj Class that provides an interface for sending data to Google Analytics, supporting the GA4 Measurement Protocol. 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 api_secret : string Generated throught the Google Analytics UI. To create a new secret, navigate in the Google Analytics UI to: Admin > Data Streams > choose your stream > Measurement Protocol > Create client_id : string Getting your Google API client ID: https://developers.google.com/identity/one-tap/web/guides/get-google-api-clientid See Also -------- * Measurement Protocol (Google Analytics 4): https://developers.google.com/analytics/devguides/collection/protocol/ga4 Examples -------- >>> ga = Ga4mp(measurement_id = "MEASUREMENT_ID", api_secret = "API_SECRET", client_id="CLIENT_ID") >>> event_type = 'new_custom_event' >>> event_parameters = {'paramater_key_1': 'parameter_1', 'paramater_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() cCs.||_||_||_g|_i|_d|_d|_dS)Nz+https://www.google-analytics.com/mp/collectz1https://www.google-analytics.com/debug/mp/collect)measurement_id api_secret client_id _event_list_user_properties _base_domain_validation_domain)selfrrrr HC:\Users\sanjo\AppData\Local\Qlobot\Launcher\ext_packages\ga4mp\ga4mp.py__init__:szGa4mp.__init__FNcs|||||dkrJxZD]"}|t|d<|j|q"Wn.fddtdtdD}|j|||ddS) 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_microscsg|]}||dqS)r ).0event)eventsr r jszGa4mp.send..rr)validation_hitdateN) _check_params_check_date_not_in_future_get_timestamptimerappendrangelen _http_post)r rrpostponerrbatched_event_listr )rrsendCs   z Ga4mp.sendcCs*x|jD]}|j|gddqWg|_dS)zX Method to send the events provided to Ga4mp.send(events,postpone=True) T)r N)rr)r rr r rpostponed_sendqs zGa4mp.postponed_sendcCst|dS)a Method to append event name and parameters key-value pair 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)r Znew_name_and_parametersr r rappend_event_to_params_dict|sz!Ga4mp.append_event_to_params_dictcCs|||d}|j}|dkr"|j}td|d}x>|D]4}|d|jd|j} |j|d} || |r|d|d d n|| d <|dk rtd ||d kst d| |} | | } t | | d<td| d|r|d| d<t j| } | ddt| }|d}| dt|t j| |}|j}td|td||d7}q>W|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: z?measurement_id=z &api_secret=)rrnameparams)r'r(rzSetting event timestamp to: Fz;Cannot send postponed historical hit, ensure postpone=FalseZtimestamp_microszTimestamp of request is: rz Content-Typezapplication/json; charset=utf-8zutf-8zContent-LengthzBatch Number: z Status code: )rr r loggerinforrr_add_user_props_to_hitAssertionError_datetime_to_timestamprinturllibrequestRequest add_headerjsondumpsencoderurlopenstatus)r r!rr r status_codedomainZ batch_numberbatchurlr0tsZts_microreqZjsondataZjson_data_as_bytesresultr r rrsD             zGa4mp._http_postc Cst|tkstdx@|D]8}t|tks2tdd|ksBtdd|kstdqWxb|D]Z}|d}|d}|tkr\x8t|D],}||krtd|dt|d qWq\Wd S) af Method to check whether the event payload parameters provided meets 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 listz!each event should be a dictionaryr'z#each event should have a "name" keyr(z%each event should have a "params" keyz7WARNING: Event parameters do not match event type. For z* event type, the correct parameter(s) are z. For a breakdown of currently supported event types and their parameters go here: https://support.google.com/analytics/answer/9267735 N)typelistr,dictrkeysr)warning)r rreZ event_nameZ event_paramsZ parameterr r rrs    zGa4mp._check_paramscCs|j||idS)z Method to set user_id, user_properties, non_personalized_ads Parameters ---------- property : string value: dependent on property (user_id, user_properties - string, non_personalized_ads - bool) N)r r$)r propertyvaluer r rset_user_propertys zGa4mp.set_user_propertycCs@y||jkr|j|Wntd|YnXdS)z Method to remove user_id, user_properties, non_personalized_ads Parameters ---------- property : string z Failed to delete user property: N)r rBpopr)r*)r rEr r rdelete_user_property s zGa4mp.delete_user_propertycCsx|jD]z}yX|dkr,|||j|in6d|krF|dii|d|d|j|iiWqtd|YqXqWdS)z Method is a helper function to add user properties to outgoing hits. Parameters ---------- hit : dict )Zuser_idZnon_personalized_adsZuser_propertiesrFz-Failed to add user property to outgoing hit: N)r r$rBr)r*)r hitkeyr r rr+s  zGa4mp._add_user_props_to_hitcCs t|dS)z Method returns UNIX timestamp in microseconds for postponed hits. Parameters ---------- None g.A)r.)r timestampr r rr1szGa4mp._get_timestampcCst|S)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 )rmktime timetuple)r dtr r rr-;szGa4mp._datetime_to_timestampcCs$|dkr n|tjks tddS)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)datetimenowr,)r rr r rrKs zGa4mp._check_date_not_in_future)FFN)FFN)__name__ __module__ __qualname____doc__rr"r#r%rrrGrIr+rr-rr r r rrs# .  F-  r)r3loggingurllib.requestr/rrPZ ga4mp.utilsr basicConfigINFO getLoggerrRr)objectrr r r r s