list method

Future<ChangeLogsListResponse> list(String profileId, { String? action, List<String>? ids, String? maxChangeTime, int? maxResults, String? minChangeTime, List<String>? objectIds, String? objectType, String? pageToken, String? searchString, List<String>? userProfileIds, String? $fields, })

Retrieves a list of change logs.

This method supports paging.

Request parameters:

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

action - Select only change logs with the specified action. Possible string values are:

• "ACTION_CREATE"
• "ACTION_UPDATE"
• "ACTION_DELETE"
• "ACTION_ENABLE"
• "ACTION_DISABLE"
• "ACTION_ADD"
• "ACTION_REMOVE"
• "ACTION_MARK_AS_DEFAULT"
• "ACTION_ASSOCIATE"
• "ACTION_ASSIGN"
• "ACTION_UNASSIGN"
• "ACTION_SEND"
• "ACTION_LINK"
• "ACTION_UNLINK"
• "ACTION_PUSH"
• "ACTION_EMAIL_TAGS"
• "ACTION_SHARE"

ids - Select only change logs with these IDs.

maxChangeTime - Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.

maxResults - Maximum number of results to return.

minChangeTime - Select only change logs whose change time is after the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.

objectIds - Select only change logs with these object IDs.

objectType - Select only change logs with the specified object type. Possible string values are:

• "OBJECT_ADVERTISER"
• "OBJECT_FLOODLIGHT_CONFIGURATION"
• "OBJECT_AD"
• "OBJECT_FLOODLIGHT_ACTVITY"
• "OBJECT_CAMPAIGN"
• "OBJECT_FLOODLIGHT_ACTIVITY_GROUP"
• "OBJECT_CREATIVE"
• "OBJECT_PLACEMENT"
• "OBJECT_DFA_SITE"
• "OBJECT_USER_ROLE"
• "OBJECT_USER_PROFILE"
• "OBJECT_ADVERTISER_GROUP"
• "OBJECT_ACCOUNT"
• "OBJECT_SUBACCOUNT"
• "OBJECT_RICHMEDIA_CREATIVE"
• "OBJECT_INSTREAM_CREATIVE"
• "OBJECT_MEDIA_ORDER"
• "OBJECT_CONTENT_CATEGORY"
• "OBJECT_PLACEMENT_STRATEGY"
• "OBJECT_SD_SITE"
• "OBJECT_SIZE"
• "OBJECT_CREATIVE_GROUP"
• "OBJECT_CREATIVE_ASSET"
• "OBJECT_USER_PROFILE_FILTER"
• "OBJECT_LANDING_PAGE"
• "OBJECT_CREATIVE_FIELD"
• "OBJECT_REMARKETING_LIST"
• "OBJECT_PROVIDED_LIST_CLIENT"
• "OBJECT_EVENT_TAG"
• "OBJECT_CREATIVE_BUNDLE"
• "OBJECT_BILLING_ACCOUNT_GROUP"
• "OBJECT_BILLING_FEATURE"
• "OBJECT_RATE_CARD"
• "OBJECT_ACCOUNT_BILLING_FEATURE"
• "OBJECT_BILLING_MINIMUM_FEE"
• "OBJECT_BILLING_PROFILE"
• "OBJECT_PLAYSTORE_LINK"
• "OBJECT_TARGETING_TEMPLATE"
• "OBJECT_SEARCH_LIFT_STUDY"
• "OBJECT_FLOODLIGHT_DV360_LINK"
• "OBJECT_ADVERTISER_CUSTOMER_LINK"
• "OBJECT_CONVERSION_DOMAIN"
• "OBJECT_ACCOUNT_CONVERSION_DOMAIN"

pageToken - Value of the nextPageToken from the previous result page.

searchString - Select only change logs whose object ID, user name, old or new values match the search string.

userProfileIds - Select only change logs with these user profile IDs.

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

Completes with a ChangeLogsListResponse.

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<ChangeLogsListResponse> list(
  core.String profileId, {
  core.String? action,
  core.List<core.String>? ids,
  core.String? maxChangeTime,
  core.int? maxResults,
  core.String? minChangeTime,
  core.List<core.String>? objectIds,
  core.String? objectType,
  core.String? pageToken,
  core.String? searchString,
  core.List<core.String>? userProfileIds,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (action != null) 'action': [action],
    if (ids != null) 'ids': ids,
    if (maxChangeTime != null) 'maxChangeTime': [maxChangeTime],
    if (maxResults != null) 'maxResults': ['${maxResults}'],
    if (minChangeTime != null) 'minChangeTime': [minChangeTime],
    if (objectIds != null) 'objectIds': objectIds,
    if (objectType != null) 'objectType': [objectType],
    if (pageToken != null) 'pageToken': [pageToken],
    if (searchString != null) 'searchString': [searchString],
    if (userProfileIds != null) 'userProfileIds': userProfileIds,
    if ($fields != null) 'fields': [$fields],
  };

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

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