Method: changeLogs.list

  • This method retrieves a list of change logs and supports paging.

  • The HTTP request uses a GET method with a specific URL structure including a profile ID.

  • Various query parameters are available to filter the change logs by criteria such as IDs, user profile IDs, search string, object type, action, and change time.

  • The response body contains a list of change logs, along with pagination information.

  • Authorization requires the https://www.googleapis.com/auth/dfatrafficking OAuth scope.

Retrieves a list of change logs. This method supports paging.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
profileId

string (int64 format)

User profile ID associated with this request.

Query parameters

Parameters
ids[]

string (int64 format)

Select only change logs with these IDs.
userProfileIds[]

string (int64 format)

Select only change logs with these user profile IDs.
searchString

string

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

enum (ObjectType)

Select only change logs with the specified object type.
action

enum (Action)

Select only change logs with the specified action.
minChangeTime

string

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

integer

Maximum number of results to return.
maxChangeTime

string

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.
objectIds[]

string (int64 format)

Select only change logs with these object IDs.
pageToken

string

Value of the

nextPageToken

from the previous result page.

Request body

The request body must be empty.

Response body

Change Log changeLogs.list Response

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

JSON representation 
{
  "kind": string,
  "nextPageToken": string,
  "changeLogs": [
    {
      object (ChangeLog)
    }
  ]
}
Fields
kind

string

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

"dfareporting#changeLogsListResponse"

.
nextPageToken

string

Pagination token to be used for the next list operation.
changeLogs[]

object (ChangeLog)

Change log collection.

Authorization scopes

Requires the following OAuth scope:

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