feedMappingSetting Object – API Help Center

Related Entities

Endpoints Using the feedMappingSetting Object

Dynamic Creative Feed Resource

Parent Objects

Dynamic Creative Feed Object

feedMappingSetting 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	FeedMappingSetting
feedFieldMappings	Array of feed field mapping objects.	Array of feedFieldMappings Object	Required	At least one object is required.
uniqueFieldMapping	Object that describes the unique fields per version.	uniqueFieldMapping Object	Optional
autoMatch	Automatically maps all data feed fields that have the same name as platform fields.	Boolean	Required

Object JSON Example

...},
    "feedMappingSetting": {
      "type": "FeedMappingSetting",
      "feedFieldMappings": [
        {
          "type": "GeneralFieldMapping",
          "inputField": "ClickthroughURL",
          "outputField": "ClickthroughURL"
        },
        {
          "type": "GeneralFieldMapping",
          "inputField": "ThirdPartyClickthroughURL",
          "outputField": null
        },
        {
          "type": "GeneralFieldMapping",
          "inputField": "Name",
          "outputField": "Name"
        },
        {
          "type": "GeneralFieldMapping",
          "inputField": "Preferred",
          "outputField": "Preferred"
        },
        {
          "type": "GeneralFieldMapping",
          "inputField": "image3",
          "outputField": null
        },
        {
          "type": "GeneralFieldMapping",
          "inputField": "text2",
          "outputField": null
        },
        {
          "type": "GeneralFieldMapping",
          "inputField": "text1",
          "outputField": null
        },
        {
          "type": "GeneralFieldMapping",
          "inputField": "Sheet1",
          "outputField": null
        },
        {
          "type": "GeneralFieldMapping",
          "inputField": "UniqueID",
          "outputField": null
        },
        {
          "type": "GeneralFieldMapping",
          "inputField": "Locktype",
          "outputField": "LockType"
        },
        {
          "type": "GeneralFieldMapping",
          "inputField": "ThirdPartyImpressionURL",
          "outputField": null
        },
        {
          "type": "GeneralFieldMapping",
          "inputField": "Active",
          "outputField": null
        }
      ],
      "uniqueFieldMapping": {
        "type": "GeneralFieldMapping",
        "inputField": "UniqueID",
        "outputField": "ExternalId"
      },
      "autoMatch": false
    },...

feedFieldMappings Object

feedFieldMappings 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 object.	String	Required	GeneralFieldMapping
inputField	Parameters defined in the platform for the version.	String	Optional
outputField	Fields defined in the data feed file for the version.	String	Optional

Object JSON Example

...,
 "feedFieldMappings": [
        {
          "type": "GeneralFieldMapping",
          "inputField": "ClickthroughURL",
          "outputField": "ClickthroughURL"
        },
        {
          "type": "GeneralFieldMapping",
          "inputField": "ThirdPartyClickthroughURL",
          "outputField": null
        },
        {
          "type": "GeneralFieldMapping",
          "inputField": "Name",
          "outputField": "Name"
        },
        {
          "type": "GeneralFieldMapping",
          "inputField": "Preferred",
          "outputField": "Preferred"
        },
        {
          "type": "GeneralFieldMapping",
          "inputField": "image3",
          "outputField": null
        },
        {
          "type": "GeneralFieldMapping",
          "inputField": "text2",
          "outputField": null
        },
        {
          "type": "GeneralFieldMapping",
          "inputField": "text1",
          "outputField": null
        },
        {
          "type": "GeneralFieldMapping",
          "inputField": "Sheet1",
          "outputField": null
        },
        {
          "type": "GeneralFieldMapping",
          "inputField": "UniqueID",
          "outputField": null
        },
        {
          "type": "GeneralFieldMapping",
          "inputField": "Locktype",
          "outputField": "LockType"
        },
        {
          "type": "GeneralFieldMapping",
          "inputField": "ThirdPartyImpressionURL",
          "outputField": null
        },
        {
          "type": "GeneralFieldMapping",
          "inputField": "Active",
          "outputField": null
        }
      ],...

uniqueFieldMapping Object

uniqueFieldMapping 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	Read-only	GeneralFieldMapping
inputField	Name of the desired unique field from the feed file.	String	Required
outputField	External ID for the version. Used for updating the version in a future feed fetch.	String	Required	Optional values: ExternalId

Object JSON Example

Related Entities

Endpoints Using the feedMappingSetting Object

Parent Objects

feedMappingSetting Object Definition

Note

Object JSON Example

feedFieldMappings Object

feedFieldMappings Object Definition

Note

Object JSON Example

uniqueFieldMapping Object

uniqueFieldMapping Object Definition

Note

Object JSON Example

Comments