conversionActivity Object – API Help Center

Related Entities

Endpoints Using the converstionActivity Object

conversionActivity Resource

ConversionActivity Object Definition

Note

Note: The Required column includes the following values:

Required: The field must be included in the POST call.
Read-only: The field is received in the GET call and required in the PUT call. It is not required in the POST call. You cannot edit this field.
Optional: If the field was received in the GET call, include it in the PUT call. This field is editable.
Internal: (For Amazon Ad Server (AAS) internal use) If the field was received in the GET call, include it in the PUT call.

NAME	DESCRIPTION	TYPE	REQUIRED	NOTES
type	Type of entity.	String	Required	ConversionActivity
name	Name of the entity.	String	Required
advertiserId	ID of the advertiser.	Integer	Required
activityType	Type of conversion activity.	String	Required	View values ConversionCounter ConversionSale
accessLevel	Internal.	Internal	Internal
conversion	Object that determines the information that is collected for the conversion activity.	conversion Object	Required
activityParameter	Array of objects whose type is activity parameters.	activityParameter Object	Optional
thirdPartyIds	Array of 3rd party IDs.	Array	Optional
brandIds	Array of brand IDs.	Array	Optional
advertiserName	Name of advertiser.	String	Optional
globalData	Includes data about the advertiser, if it is a global advertiser or a local advertiser and which advertisers are global or local.	globalData Object	Optional
conversionGlobalData	Internal.	Internal	Internal

Object JSON Example

{"result": {
        
        "type": "ConversionActivity",
        "name": "conversion",
        "advertiserId": "1083762300",
        "activityType": "ConversionCounter",
        "accessLevel": "Full",
        "conversion": {
            "type": "Conversion",
            "conversionCountingGroup": "Always",
            "currency": {
                "type": "Currency",
                "id": 1,
                "name": "USD",
                "currencyLetters": "USD",
                "value": null
            },
            "conversionGroup1": "111",
            "conversionGroup2": "222",
            "conversionGroup3": null,
            "conversionGroup4": null,
            "conversionGroup5": null,
            "value": 3
        },
        "activityParameter": [{
            "type": "ActivityParameter",
            "value": 1083753345,
            "name": "111",
            "rowId": "0"
        }],
        "thirdPartyIds": [
            1083878971
        ],
        "brandIds": [
            1083775029
        ],
        "advertiserName": "adv3333",
        "globalData": {
            "global": {
                "localAdvertisers": [{
                    "hasGlobalAdvertiserPermissionAccess": false,
                    "hasGlobalTagManagerPermissionAccess": true,
                    "id": 1073747300,
                    "name": "Advertiser",
                    "type": "AdvertiserIdName",
                    "accountId": 1073746500,
                    "accountName": "Testing Account"
                }],
                "type": "GlobalEntityData",
                "allowUserAccessToLocalAdvertisers": false
            },
            "local": null,
            "status": "Global",
            "type": "GlobalData"
        },
        "conversionGlobalData": []

    }
}

Related Entities

Endpoints Using the converstionActivity Object

ConversionActivity Object Definition

Note

Object JSON Example

Comments