Method: dynamicTargetingKeys.list

  • Retrieves a list of dynamic targeting keys for a specified user profile using the provided profileId.

  • Allows filtering of dynamic targeting keys by name, object type, object ID, and advertiser ID using query parameters.

  • The response includes a collection of dynamic targeting keys matching the specified criteria, along with resource kind information.

  • Requires authorization with the dfatrafficking scope for access.

  • The request body should be empty for this GET request.

Retrieves a list of dynamic targeting keys.

HTTP request

GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/dynamicTargetingKeys

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
profileId

string (int64 format)

User profile ID associated with this request.

Query parameters

Parameters
names[]

string

Select only dynamic targeting keys exactly matching these names.

objectType

enum (ObjectType)

Select only dynamic targeting keys with this object type.

objectId

string (int64 format)

Select only dynamic targeting keys with this object ID.

advertiserId

string (int64 format)

Select only dynamic targeting keys whose object has this advertiser ID.

Request body

The request body must be empty.

Response body

Dynamic Targeting Key dynamicTargetingKeys.list Response

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

JSON representation
{
  "kind": string,
  "dynamicTargetingKeys": [
    {
      object (DynamicTargetingKey)
    }
  ]
}
Fields
kind

string

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

"dfareporting#dynamicTargetingKeysListResponse"

.

dynamicTargetingKeys[]

object (DynamicTargetingKey)

Dynamic targeting key collection.

Authorization scopes

Requires the following OAuth scope:

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