Method: placements.generatetags

Generates tags for a placement.

HTTP request

POST https://dfareporting.googleapis.com/dfareporting/v3.3/userprofiles/{profileId}/placements/generatetags

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
profileId

string (int64 format)

User profile ID associated with this request.

Query parameters

Parameters
placementIds[]

string (int64 format)

Generate tags for these placements.
campaignId

string (int64 format)

Generate placements belonging to this campaign. This is a required field.
tagFormats[]

enum (TagFormats)

Tag formats to generate for these placements.

Note:

PLACEMENT_TAG_STANDARD

can only be generated for 1x1 placements.

Request body

The request body contains an instance of Empty.

Response body

If successful, the response body contains data with the following structure:

Placement GenerateTags Response

JSON representation 
{
  "placementTags": [
    {
      object (PlacementTag)
    }
  ],
  "kind": string
}
Fields
placementTags[]

object (PlacementTag)

Set of generated tags for the specified placements.
kind

string

Identifies what kind of resource this is. Value: the fixed string

"dfareporting#placementsGenerateTagsResponse"

.

Authorization Scopes

Requires the following OAuth scope:

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

TagFormats

Enums
PLACEMENT_TAG_STANDARD
PLACEMENT_TAG_IFRAME_JAVASCRIPT
PLACEMENT_TAG_IFRAME_ILAYER
PLACEMENT_TAG_INTERNAL_REDIRECT
PLACEMENT_TAG_JAVASCRIPT
PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT
PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT
PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT
PLACEMENT_TAG_CLICK_COMMANDS
PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH
PLACEMENT_TAG_TRACKING
PLACEMENT_TAG_TRACKING_IFRAME
PLACEMENT_TAG_TRACKING_JAVASCRIPT
PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3
PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY
PLACEMENT_TAG_JAVASCRIPT_LEGACY
PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY
PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY
PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4

PlacementTag

Placement Tag

JSON representation 
{
  "placementId": string,
  "tagDatas": [
    {
      object (TagData)
    }
  ]
}
Fields
placementId

string (int64 format)

Placement ID
tagDatas[]

object (TagData)

Tags generated for this placement.

TagData

Placement Tag Data

JSON representation 
{
  "format": enum (Format),
  "impressionTag": string,
  "clickTag": string,
  "adId": string,
  "creativeId": string
}
Fields
format

enum (Format)

TagData tag format of this tag.
impressionTag

string

Tag string for serving an ad.
clickTag

string

Tag string to record a click.
adId

string (int64 format)

Ad associated with this placement tag. Applicable only when

format

is

PLACEMENT_TAG_TRACKING

.
creativeId

string (int64 format)

Creative associated with this placement tag. Applicable only when

format

is

PLACEMENT_TAG_TRACKING

.

Format

Enums
PLACEMENT_TAG_STANDARD
PLACEMENT_TAG_IFRAME_JAVASCRIPT
PLACEMENT_TAG_IFRAME_ILAYER
PLACEMENT_TAG_INTERNAL_REDIRECT
PLACEMENT_TAG_JAVASCRIPT
PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT
PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT
PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT
PLACEMENT_TAG_CLICK_COMMANDS
PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH
PLACEMENT_TAG_TRACKING
PLACEMENT_TAG_TRACKING_IFRAME
PLACEMENT_TAG_TRACKING_JAVASCRIPT
PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3
PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY
PLACEMENT_TAG_JAVASCRIPT_LEGACY
PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY
PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY
PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4