kalnyc67 / analytics-issues

Automatically exported from code.google.com/p/analytics-issues
0 stars 0 forks source link

GAITracker.h documentation comments incredibly unclear #559

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago
Name of affected component: Mobile Tracking

Name of related library and version, if applicable (e.g. Android, iOS,
Snippets, etc.): iOS SDK

Issue summary:

/*!
 Set a tracking parameter.

 @param parameterName The parameter name.

 @param value The value to set for the parameter. If this is nil, the
 value for the parameter will be cleared.
 */

As someone starting out with Google Analytics what [GAITracker set:value:] does 
is _incredibly_ unclear from the comments. "Set a tracking parameter"? What is 
a tracking parameter. Is something that is sent immediately? Is it applied to 
calls to [GAITracker send:]? Does it get cleared when the session changes? What 
happens when you send a dictionary that contains the same parameters? 

I couldn't find this really basic thing explained anywhere in the SDK or online 
documentation. Custom dimensions' 4 different scopes (product, hit, session, 
and user) just adds to the confusion. Only until I looked at the JS 
documentation did I figure out what it does.

Original issue reported on code.google.com by over...@gmail.com on 28 Dec 2014 at 8:15