Method: dynamicTargetingKeys.insert

  • This document explains how to insert a new dynamic targeting key using the DFA Reporting API.

  • Dynamic targeting keys must be created at the advertiser level and have limits on the number of keys per advertiser and per ad, creative, or placement.

  • The HTTP request uses a POST method to a specific URL with a profileId path parameter.

  • The request body contains a DynamicTargetingKey instance, and a successful response body returns a newly created DynamicTargetingKey instance.

  • Authorization requires the https://www.googleapis.com/auth/dfatrafficking OAuth scope.

Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement.

HTTP request

POST https://dfareporting.googleapis.com/dfareporting/v5/userprofiles/{profileId}/dynamicTargetingKeys

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
profileId

string (int64 format)

User profile ID associated with this request.

Request body

The request body contains an instance of DynamicTargetingKey.

Response body

If successful, the response body contains a newly created instance of DynamicTargetingKey.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/dfatrafficking