5. DPA Rules¶

DPA rules require that you have implemented a dot pixel tag, as described in DPA Dot Tag Instrumentation. Using DPA rules you can make POST and PUT calls to the endpoint specified below.

Important

If you don’t implement DPA rules, your product catalog will not serve.

Fields¶

DPA rules contain the following fields:

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

Endpoint¶

Resource URI

https://api.gemini.yahoo.com/v3/rest/dparule

Operations¶

DPA rules support full Create and Update operations, including POST and PUT calls.

To create a DPA rule, for example, make a POST call:

Example:

{
    "tagId":10001537,
    "advertiserId":22,
    "productIdExtractName":"pid",
    "eventActionExtractName":"ea"

}

Note

Only one DPA rule can be created.

To update a DPA rule, for example, make a PUT call:

Example:

{
    "tagId":10001537,
    "advertiserId":22,
    "productIdExtractName":"product_id",
    "eventActionExtractName":"event_action"
}