Bug 1334110 - Add campaignId in core-ping document. r=bsmedberg,frank,sebastian

MozReview-Commit-ID: BPbw0uc9wr7
This commit is contained in:
Nevin Chen
2017-04-07 15:25:13 +08:00
parent d46ee879e0
commit 0825e078d8

View File

@@ -43,6 +43,7 @@ Structure:
"defaultSearch": <string>, // Identifier of the default search engine,
// e.g. "yahoo".
"distributionId": <string>, // Distribution identifier (optional)
"campaignId": <string>, // Adjust's campaign identifier (optional)
"created": <string>, // date the ping was created
// in local time, "yyyy-mm-dd"
"tz": <integer>, // timezone offset (in minutes) of the
@@ -78,6 +79,14 @@ can be found `here <https://wiki.mozilla.org/Mobile/Distribution_Files>`_.
It is optional.
campaignId
~~~~~~~~~~~~~~
The ``campaignId`` contains the campaign identifier like '3ly8t0'.
It's generated by `Adjust<https://docs.adjust.com/en/tracker-generation/#segmenting-users-dynamically-with-campaign-structure-parameters>`_,
It can only used to identify a campaign, but can't target to a specific user.
It is optional because not everyone has a campaign to begin with.
defaultSearch
~~~~~~~~~~~~~
On Android, this field may be ``null``. To get the engine, we rely on
@@ -158,9 +167,10 @@ et al (e.g. "Tue, 01 Feb 2011 14:00:00 GMT").
Version history
---------------
* v9: changed ``arch`` to contain device arch rather than the one we built against
* v8: added ``flashUsage``
* v7: added ``sessionCount`` & ``sessionDuration``
* v7: added ``sessionCount`` & ``sessionDuration`` & ``campaignId``
* v6: added ``searches``
* v5: added ``created`` & ``tz``
* v4: ``profileDate`` will return package install time when times.json is not available