Funnel Targeting

This article describes resources that enable advertisers to read and define funnel targeting.

Overview

Funnel targeting retargets users by allowing advertisers to specify the last number of days from today’s date in which a user might have viewed, purchased, or added a specific product to their online shopping cart.

The Yahoo DSP supports TARGET_PRODUCT_FUNNEL targeting for lines serving DPA ads.

Endpoint

/traffic/lines/{id}/targeting

Resources

The targeting resource is the standard Yahoo DSP resource for targeting consumers based on their profiles, behaviors, and ad content.

The resource is defined by the following TARGET_PRODUCT_FUNNEL targeting type-specific fields that are required for funnel targeting:

Field

Description

Data Type

id

Specifies the line ID

integer

types

Specifies an array of targeting types to target. For funnel targeting efforts, the TARGET_PRODUCT_FUNNEL targeting type must be specified.

To learn more, refer to About Targeting.

array

funnelAttributes

A read-only array that displays the attributes of engagement events used during any funnel targeting efforts to retarget users with specific product sets. Refer to the Funnel Attributes Array section below for more details on these attributes.

array

Funnel Attributes Array

The funnelAttributes array shows the attributes of engagement events used during any funnel targeting efforts to retarget users with specific product sets.

Name

Description

Data Type

lookBack

Specifies the last number of days from today’s date in which a user might have viewed, purchased, or added a specific product to their online shopping cart. Note that this field is specific to dynamic product ad lines.

integer

funnelType

Specifies one of three product set targets used during any funnel targeting efforts to retarget users:

  • ViewProduct: enables the option to retarget known users who have signaled interest in a specific product.

  • AddToCart: enables the option to retarget known users who have added a specific product to their online shopping cart.

  • Purchase: enables the to retarget known users who purchased a specific product.

Note that this field is specific to dynamic product ad lines.

string

productSetId

Specifies the id for the product set focused on during funnel targeting. Note that this field is specific to dynamic product ad lines.

integer

exclude

Specifies whether any users were excluded for retargeting during any funnel targeting efforts. For example, an advertiser might retarget users who viewed a specific product in the last 15 days but exclude any users who did not purchase that product in the last 30 days. Note that this field is specific to dynamic product ad lines.

boolean

Note

For a complete list of targeting resource fields, refer to Targeting Object described in About Targeting.

Sample Payload

"funnelAttributes": [
            {
                "lookBack": 25,
                "funnelType": "ViewProduct",
                "productSetId": 1000389012,
                "exclude": false
            },
            {
                "lookBack": 30,
                "funnelType": "AddToCart",
                "productSetId": 1000389012,
                "exclude": false
            },
            {
                "lookBack": 10,
                "funnelType": "Purchase",
                "productSetId": 1000389012,
                "exclude": false
            }
        ]

Add/Update Funnel Targeting

To add or update funnel targeting for a specific line, make a POST call to this endpoint:

POST traffic/lines/{id}/targeting/

Parameters

The line ID is specified in the path of the URL. All other parameters are specified in the body of the application/json payload.

Sample Request URL

POST https://dspapi.admanagerplus.yahoo.com/traffic/lines/365277/targeting/

Sample Request Body

{
    "types": [
        {
            "isTargeted": true,
            "name": "TARGET_PRODUCT_FUNNEL"
        }
    ],
    "funnelAttributes": [
        {
            "lookBack": 22,
            "funnelType": "ViewProduct",
            "productSetId": 1009006036,
            "exclude": false
        },
        {
            "lookBack": 23,
            "funnelType": "AddToCart",
            "productSetId": 1009006036,
            "exclude": false
        },
        {
            "lookBack": 24,
            "funnelType": "Purchase",
            "productSetId": 1009006036,
            "exclude": false
        }
    ]
}

Sample Response

{
    "response": {
        "types": [
                    {
                "isTargeted": true,
                "name": "TARGET_PRODUCT_FUNNEL"
            }
        ],
        "funnelAttributes": [
            {
                "lookBack": 22,
                "funnelType": "ViewProduct",
                "productSetId": 1009006036,
                "exclude": false
            },
            {
                "lookBack": 23,
                "funnelType": "AddToCart",
                "productSetId": 1009006036,
                "exclude": false
            },
            {
                "lookBack": 24,
                "funnelType": "Purchase",
                "productSetId": 1009006036,
                "exclude": false
            }
        ]
    },
    "errors": null,
    "timeStamp": "2021-09-11T22:05:36.860Z"
}

Read Funnel Targeting

Returns a list of targets for the specified line.

GET /traffic/lines/{id}/targeting

The resource returns information about all of the target types enabled and all of the targets specified for the line, including funnelAttributes.

Parameters

The line ID is specified in the path of the URL.

Sample Request URL

GET https://dspapi.admanagerplus.yahoo.com/traffic/lines/365277/targeting

Sample Response

{
   "response": {
        "types": [
            {
                "isTargeted": true,
                "name": "TARGET_PRODUCT_FUNNEL"
            }
        ],
        "funnelAttributes": [
            {
                "lookBack": 30,
                "funnelType": "ViewProduct",
                "productSetId": 1002830000,
                "exclude": false
            },
            {
                "lookBack": 30,
                "funnelType": "AddToCart",
                "productSetId": 1002830000,
                "exclude": false
            },
            {
                "lookBack": 30,
                "funnelType": "Purchase",
                "productSetId": 1002830000,
                "exclude": false
            }
        ]
    },
    "errors": null,
    "timeStamp": "2021-09-11T22:00:02.710Z"
}