The DCM/DFA Reporting and Trafficking API v2.7 is deprecated and will be sunset on December 7th, 2017. All users must migrate to a newer API version by that date.

Placements: generatetags

Requires authorization

Generates tags for a placement.

Request

HTTP request

POST https://www.googleapis.com/dfareporting/v2.8/userprofiles/profileId/placements/generatetags

Parameters

Parameter name Value Description
Path parameters
profileId long User profile ID associated with this request.
Optional query parameters
campaignId long Generate placements belonging to this campaign. This is a required field.
placementIds long Generate tags for these placements.
tagFormats string Tag formats to generate for these placements.

Note: PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements.

Acceptable values are:
  • "PLACEMENT_TAG_CLICK_COMMANDS"
  • "PLACEMENT_TAG_IFRAME_ILAYER"
  • "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
  • "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY"
  • "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
  • "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3"
  • "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4"
  • "PLACEMENT_TAG_INTERNAL_REDIRECT"
  • "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
  • "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY"
  • "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
  • "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
  • "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY"
  • "PLACEMENT_TAG_JAVASCRIPT"
  • "PLACEMENT_TAG_JAVASCRIPT_LEGACY"
  • "PLACEMENT_TAG_STANDARD"
  • "PLACEMENT_TAG_TRACKING"
  • "PLACEMENT_TAG_TRACKING_IFRAME"
  • "PLACEMENT_TAG_TRACKING_JAVASCRIPT"

Authorization

This request requires authorization with the following scope (read more about authentication and authorization).

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

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{
  "kind": "dfareporting#placementsGenerateTagsResponse",
  "placementTags": [
    {
      "placementId": long,
      "tagDatas": [
        {
          "format": string,
          "impressionTag": string,
          "clickTag": string,
          "adId": long,
          "creativeId": long
        }
      ]
    }
  ]
}
Property name Value Description Notes
kind string Identifies what kind of resource this is. Value: the fixed string "dfareporting#placementsGenerateTagsResponse".
placementTags[] list Set of generated tags for the specified placements.
placementTags[].placementId long Placement ID
placementTags[].tagDatas[] list Tags generated for this placement.
placementTags[].tagDatas[].format string TagData tag format of this tag.

Acceptable values are:
  • "PLACEMENT_TAG_CLICK_COMMANDS"
  • "PLACEMENT_TAG_IFRAME_ILAYER"
  • "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
  • "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY"
  • "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
  • "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3"
  • "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4"
  • "PLACEMENT_TAG_INTERNAL_REDIRECT"
  • "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
  • "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY"
  • "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
  • "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
  • "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY"
  • "PLACEMENT_TAG_JAVASCRIPT"
  • "PLACEMENT_TAG_JAVASCRIPT_LEGACY"
  • "PLACEMENT_TAG_STANDARD"
  • "PLACEMENT_TAG_TRACKING"
  • "PLACEMENT_TAG_TRACKING_IFRAME"
  • "PLACEMENT_TAG_TRACKING_JAVASCRIPT"
placementTags[].tagDatas[].impressionTag string Tag string for serving an ad.
placementTags[].tagDatas[].clickTag string Tag string to record a click.
placementTags[].tagDatas[].adId long Ad associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING.
placementTags[].tagDatas[].creativeId long Creative associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING.

Send feedback about...

DoubleClick Campaign Manager
DoubleClick Campaign Manager