Method: dynamicTargetingKeys.list

  • This API call retrieves a list of dynamic targeting keys.

  • The request uses a GET HTTP method and includes the user profile ID as a path parameter.

  • Optional query parameters can be used to filter the results by names, object type, object ID, or advertiser ID.

  • The request body must be empty, and the successful response contains a list of dynamic targeting keys.

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

Retrieves a list of dynamic targeting keys.

HTTP request

GET 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.

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