activityRelation Object – API Help Center

Related Entities

Endpoints Using the activityRelation Object

Activity Rule Resource

Parent Objects

Activity Rule Object

activityRelation 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	Array of objects whose type is ActivityRelation.	String	Required	ActivityRelation
id	ID of activity rule.	Long	Read-only
entityType	Type of activity.	String	Required	View values conversionRelations retargetingRelations thirdPartyRelations siteActivityRelations
name	Name of activity.	String	Required
tagType	Internal.	Internal	Internal	Used when entityType is retargetingRelations.
overridingActivityValues	Array of objects whose type is overriding activity values.	overridingActivityValues Object	Optional	Used when entityType is retargetingRelations.

Object JSON Example

..., 
"conversionRelations": [{
    "type": "ActivityRelation",
    "id": 1083729900,
    "entityType": "ConversionActivity",
    "name": "rtt test",   
}],
"retargetingRelations": [{
    "type": "ActivityRelation",
    "id": 1091028600,
    "entityType": "RetargetingActivity",
    "name": "rtt tm",   
}],
retargetingRelations”: [{
    “
    type”: “ActivityRelation”,
    “id”: 1102959400,
    “entityType”: “RetargetingActivity”,
    “name”: “test123 Retargeting”,
    “tagType”: “Dynamic”,
    “overridingActivityValues”: [{
        “
        type”: “OverridingActivityValue”,
        “name”: null,
        “variableOrRetargetingDataId”: 1102985625,
        “overridingValue”: “valA”
    }, {
        “
        type”: “OverridingActivityValue”,
        “name”: null,
        “variableOrRetargetingDataId”: 1102958526,
        “overridingValue”: “valb”
    }]
}]
"thirdPartyRelations": [{
    "type": "ActivityRelation",
    "id": 1083854600,
    "entityType": "ThirdPartyActivity",
    "name": "rule all types 3rd Party",  
}],
"siteActivityRelations": [{
    "type": "ActivityRelation",
    "id": 1083835200,
    "entityType": "SiteActivity",
    "name": "Other",
}],...

overridingActivityValues Object

overridingActivityValues 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
type	Array of objects whose type is overriding activity values.	Object	Optional
name	Name of required value.	String	Required
variableOrRetargetingDataId	ID as defined in retargeting activity.	Long	Required
overridingValue	Value to set in retargeting activity when rule is fired.	String	Required

Object JSON Example

...
retargetingRelations”: [{
    “
    type”: “ActivityRelation”,
    “id”: 1102949624,
    “entityType”: “RetargetingActivity”,
    “name”: “test123 Retargeting”,
    “tagType”: “Dynamic”,
    “overridingActivityValues”: [{
        “
        type”: “OverridingActivityValue”,
        “name”: null,
        “variableOrRetargetingDataId”: 1102949625,
        “overridingValue”: “valA”
    }, {
        “
        type”: “OverridingActivityValue”,
        “name”: null,
        “variableOrRetargetingDataId”: 1102954626,
        “overridingValue”: “valb”
    }]
}]
...

Related Entities

Endpoints Using the activityRelation Object

Parent Objects

activityRelation Object Definition

Note

Object JSON Example

overridingActivityValues Object

overridingActivityValues Object Definition

Note

Object JSON Example

Comments