DPA Rule Operations¶

This article describes DPA rule operations that you can use to make POST and GET calls.

Important

DPA rules require that you have implemented a dot pixel tag. If you don’t implement DPA rules, including dot pixel tags, your product catalog will not serve.

To learn more, see Beacon Targeting.

Fields¶

DPA rules contain the following fields:

Name	Description	Add
`pixelId`	The id of the Dot pixel placed on the DPA product page.	Required
`productKey`	The product id	Required
`productIdExtractName`	Use this to populate the product id in the pixel code. If not specified, it defaults to the `product_id`.	Optional
`engagementTypeKey`	Use this to extract the event action. If not specified, it defaults to the `ea` parameter.	Optional

Endpoint¶

Resource URI

https://dspapi.admanagerplus.yahoo.com/traffic/dparule?accountId={accountId}

Operations¶

DPA rules support full Create and Read operations, including POST and GET calls.

To create a DPA rule with an account ID, for example, make a POST call:

POST /traffic/dparule?accountId={accountId}

Payload:

{
    "productKey": "product_id",
    "engagementTypeKey": "ea",
    "pixelId": "10063754"
}

Note

Only one DPA rule can be created.

To get a DPA rule by Account ID, for example, make a GET call:

Example:

GET /traffic/dparule?accountId={accountId}

{
        "response": {
            "pixelId": 10063754,
            "productKey": "product_id",
            "engagementTypeKey": "ea",
            "supplyType": "ALL"
        },
        "errors": null,
        "timeStamp": "2021-07-27T18:10:09.097Z"
}