Method: placements.generatetags

  • This document details how to generate tags for a placement using an HTTP POST request.

  • The request requires a user profile ID as a path parameter and can optionally specify placement IDs, a required campaign ID, and tag formats via query parameters.

  • The request body must be empty.

  • The successful response body contains a list of PlacementTag objects, each including a placement ID and an array of TagData objects with details like format and tag strings.

  • This operation requires the https://www.googleapis.com/auth/dfatrafficking OAuth scope for authorization.

Generates tags for a placement.

HTTP request

POST https://dfareporting.googleapis.com/dfareporting/v5/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
body

object

Empty body
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 (PlacementTagFormat)

Tag formats to generate for these placements.

Note:

PLACEMENT_TAG_STANDARD

can only be generated for 1x1 placements.

Request body

The request body must be empty.

Response body

Placement GenerateTags Response

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

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

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 (PlacementTagFormat),
  "impressionTag": string,
  "clickTag": string,
  "adId": string,
  "creativeId": string
}
Fields
format

enum (PlacementTagFormat)

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

.