list method

Future<DynamicTargetingKeysListResponse> list(
  1. String profileId, {
  2. String? advertiserId,
  3. List<String>? names,
  4. String? objectId,
  5. String? objectType,
  6. String? $fields,
})

Retrieves a list of dynamic targeting keys.

Request parameters:

profileId - User profile ID associated with this request. Value must have pattern ^\[^/\]+$.

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

names - Select only dynamic targeting keys exactly matching these names.

objectId - Select only dynamic targeting keys with this object ID.

objectType - Select only dynamic targeting keys with this object type. Possible string values are:

  • "OBJECT_ADVERTISER"
  • "OBJECT_AD"
  • "OBJECT_CREATIVE"
  • "OBJECT_PLACEMENT"

$fields - Selector specifying which fields to include in a partial response.

Completes with a DynamicTargetingKeysListResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<DynamicTargetingKeysListResponse> list(
  core.String profileId, {
  core.String? advertiserId,
  core.List<core.String>? names,
  core.String? objectId,
  core.String? objectType,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (advertiserId != null) 'advertiserId': [advertiserId],
    if (names != null) 'names': names,
    if (objectId != null) 'objectId': [objectId],
    if (objectType != null) 'objectType': [objectType],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'userprofiles/' +
      core.Uri.encodeFull('$profileId') +
      '/dynamicTargetingKeys';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return DynamicTargetingKeysListResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}