| 1 |
<html><body> |
| 2 |
<style> |
| 3 |
|
| 4 |
body, h1, h2, h3, div, span, p, pre, a { |
| 5 |
margin: 0; |
| 6 |
padding: 0; |
| 7 |
border: 0; |
| 8 |
font-weight: inherit; |
| 9 |
font-style: inherit; |
| 10 |
font-size: 100%; |
| 11 |
font-family: inherit; |
| 12 |
vertical-align: baseline; |
| 13 |
} |
| 14 |
|
| 15 |
body { |
| 16 |
font-size: 13px; |
| 17 |
padding: 1em; |
| 18 |
} |
| 19 |
|
| 20 |
h1 { |
| 21 |
font-size: 26px; |
| 22 |
margin-bottom: 1em; |
| 23 |
} |
| 24 |
|
| 25 |
h2 { |
| 26 |
font-size: 24px; |
| 27 |
margin-bottom: 1em; |
| 28 |
} |
| 29 |
|
| 30 |
h3 { |
| 31 |
font-size: 20px; |
| 32 |
margin-bottom: 1em; |
| 33 |
margin-top: 1em; |
| 34 |
} |
| 35 |
|
| 36 |
pre, code { |
| 37 |
line-height: 1.5; |
| 38 |
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 |
} |
| 40 |
|
| 41 |
pre { |
| 42 |
margin-top: 0.5em; |
| 43 |
} |
| 44 |
|
| 45 |
h1, h2, h3, p { |
| 46 |
font-family: Arial, sans serif; |
| 47 |
} |
| 48 |
|
| 49 |
h1, h2, h3 { |
| 50 |
border-bottom: solid #CCC 1px; |
| 51 |
} |
| 52 |
|
| 53 |
.toc_element { |
| 54 |
margin-top: 0.5em; |
| 55 |
} |
| 56 |
|
| 57 |
.firstline { |
| 58 |
margin-left: 2 em; |
| 59 |
} |
| 60 |
|
| 61 |
.method { |
| 62 |
margin-top: 1em; |
| 63 |
border: solid 1px #CCC; |
| 64 |
padding: 1em; |
| 65 |
background: #EEE; |
| 66 |
} |
| 67 |
|
| 68 |
.details { |
| 69 |
font-weight: bold; |
| 70 |
font-size: 14px; |
| 71 |
} |
| 72 |
|
| 73 |
</style> |
| 74 |
|
| 75 |
<h1><a href="dfareporting_v5.html">Campaign Manager 360 API</a> . <a href="dfareporting_v5.changeLogs.html">changeLogs</a></h1> |
| 76 |
<h2>Instance Methods</h2> |
| 77 |
<p class="toc_element"> |
| 78 |
<code><a href="#close">close()</a></code></p> |
| 79 |
<p class="firstline">Close httplib2 connections.</p> |
| 80 |
<p class="toc_element"> |
| 81 |
<code><a href="#get">get(profileId, id, x__xgafv=None)</a></code></p> |
| 82 |
<p class="firstline">Gets one change log by ID.</p> |
| 83 |
<p class="toc_element"> |
| 84 |
<code><a href="#list">list(profileId, action=None, ids=None, maxChangeTime=None, maxResults=None, minChangeTime=None, objectIds=None, objectType=None, pageToken=None, searchString=None, userProfileIds=None, x__xgafv=None)</a></code></p> |
| 85 |
<p class="firstline">Retrieves a list of change logs. This method supports paging.</p> |
| 86 |
<p class="toc_element"> |
| 87 |
<code><a href="#list_next">list_next()</a></code></p> |
| 88 |
<p class="firstline">Retrieves the next page of results.</p> |
| 89 |
<h3>Method Details</h3> |
| 90 |
<div class="method"> |
| 91 |
<code class="details" id="close">close()</code> |
| 92 |
<pre>Close httplib2 connections.</pre> |
| 93 |
</div> |
| 94 |
|
| 95 |
<div class="method"> |
| 96 |
<code class="details" id="get">get(profileId, id, x__xgafv=None)</code> |
| 97 |
<pre>Gets one change log by ID. |
| 98 |
|
| 99 |
Args: |
| 100 |
profileId: string, User profile ID associated with this request. (required) |
| 101 |
id: string, Change log ID. (required) |
| 102 |
x__xgafv: string, V1 error format. |
| 103 |
Allowed values |
| 104 |
1 - v1 error format |
| 105 |
2 - v2 error format |
| 106 |
|
| 107 |
Returns: |
| 108 |
An object of the form: |
| 109 |
|
| 110 |
{ # Describes a change that a user has made to a resource. |
| 111 |
"accountId": "A String", # Account ID of the modified object. |
| 112 |
"action": "A String", # Action which caused the change. |
| 113 |
"changeTime": "A String", |
| 114 |
"fieldName": "A String", # Field name of the object which changed. |
| 115 |
"id": "A String", # ID of this change log. |
| 116 |
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLog". |
| 117 |
"newValue": "A String", # New value of the object field. |
| 118 |
"objectId": "A String", # ID of the object of this change log. The object could be a campaign, placement, ad, or other type. |
| 119 |
"objectType": "A String", # Object type of the change log. |
| 120 |
"oldValue": "A String", # Old value of the object field. |
| 121 |
"subaccountId": "A String", # Subaccount ID of the modified object. |
| 122 |
"transactionId": "A String", # Transaction ID of this change log. When a single API call results in many changes, each change will have a separate ID in the change log but will share the same transactionId. |
| 123 |
"userProfileId": "A String", # ID of the user who modified the object. |
| 124 |
"userProfileName": "A String", # User profile name of the user who modified the object. |
| 125 |
}</pre> |
| 126 |
</div> |
| 127 |
|
| 128 |
<div class="method"> |
| 129 |
<code class="details" id="list">list(profileId, action=None, ids=None, maxChangeTime=None, maxResults=None, minChangeTime=None, objectIds=None, objectType=None, pageToken=None, searchString=None, userProfileIds=None, x__xgafv=None)</code> |
| 130 |
<pre>Retrieves a list of change logs. This method supports paging. |
| 131 |
|
| 132 |
Args: |
| 133 |
profileId: string, User profile ID associated with this request. (required) |
| 134 |
action: string, Select only change logs with the specified action. |
| 135 |
Allowed values |
| 136 |
ACTION_CREATE - |
| 137 |
ACTION_UPDATE - |
| 138 |
ACTION_DELETE - |
| 139 |
ACTION_ENABLE - |
| 140 |
ACTION_DISABLE - |
| 141 |
ACTION_ADD - |
| 142 |
ACTION_REMOVE - |
| 143 |
ACTION_MARK_AS_DEFAULT - |
| 144 |
ACTION_ASSOCIATE - |
| 145 |
ACTION_ASSIGN - |
| 146 |
ACTION_UNASSIGN - |
| 147 |
ACTION_SEND - |
| 148 |
ACTION_LINK - |
| 149 |
ACTION_UNLINK - |
| 150 |
ACTION_PUSH - |
| 151 |
ACTION_EMAIL_TAGS - |
| 152 |
ACTION_SHARE - |
| 153 |
ids: string, Select only change logs with these IDs. (repeated) |
| 154 |
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. |
| 155 |
maxResults: integer, Maximum number of results to return. |
| 156 |
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. |
| 157 |
objectIds: string, Select only change logs with these object IDs. (repeated) |
| 158 |
objectType: string, Select only change logs with the specified object type. |
| 159 |
Allowed values |
| 160 |
OBJECT_ADVERTISER - |
| 161 |
OBJECT_FLOODLIGHT_CONFIGURATION - |
| 162 |
OBJECT_AD - |
| 163 |
OBJECT_FLOODLIGHT_ACTVITY - |
| 164 |
OBJECT_CAMPAIGN - |
| 165 |
OBJECT_FLOODLIGHT_ACTIVITY_GROUP - |
| 166 |
OBJECT_CREATIVE - |
| 167 |
OBJECT_PLACEMENT - |
| 168 |
OBJECT_DFA_SITE - |
| 169 |
OBJECT_USER_ROLE - |
| 170 |
OBJECT_USER_PROFILE - |
| 171 |
OBJECT_ADVERTISER_GROUP - |
| 172 |
OBJECT_ACCOUNT - |
| 173 |
OBJECT_SUBACCOUNT - |
| 174 |
OBJECT_RICHMEDIA_CREATIVE - |
| 175 |
OBJECT_INSTREAM_CREATIVE - |
| 176 |
OBJECT_MEDIA_ORDER - |
| 177 |
OBJECT_CONTENT_CATEGORY - |
| 178 |
OBJECT_PLACEMENT_STRATEGY - |
| 179 |
OBJECT_SD_SITE - |
| 180 |
OBJECT_SIZE - |
| 181 |
OBJECT_CREATIVE_GROUP - |
| 182 |
OBJECT_CREATIVE_ASSET - |
| 183 |
OBJECT_USER_PROFILE_FILTER - |
| 184 |
OBJECT_LANDING_PAGE - |
| 185 |
OBJECT_CREATIVE_FIELD - |
| 186 |
OBJECT_REMARKETING_LIST - |
| 187 |
OBJECT_PROVIDED_LIST_CLIENT - |
| 188 |
OBJECT_EVENT_TAG - |
| 189 |
OBJECT_CREATIVE_BUNDLE - |
| 190 |
OBJECT_BILLING_ACCOUNT_GROUP - |
| 191 |
OBJECT_BILLING_FEATURE - |
| 192 |
OBJECT_RATE_CARD - |
| 193 |
OBJECT_ACCOUNT_BILLING_FEATURE - |
| 194 |
OBJECT_BILLING_MINIMUM_FEE - |
| 195 |
OBJECT_BILLING_PROFILE - |
| 196 |
OBJECT_PLAYSTORE_LINK - |
| 197 |
OBJECT_TARGETING_TEMPLATE - |
| 198 |
OBJECT_SEARCH_LIFT_STUDY - |
| 199 |
OBJECT_FLOODLIGHT_DV360_LINK - |
| 200 |
OBJECT_ADVERTISER_CUSTOMER_LINK - |
| 201 |
OBJECT_CONVERSION_DOMAIN - |
| 202 |
OBJECT_ACCOUNT_CONVERSION_DOMAIN - |
| 203 |
pageToken: string, Value of the nextPageToken from the previous result page. |
| 204 |
searchString: string, Select only change logs whose object ID, user name, old or new values match the search string. |
| 205 |
userProfileIds: string, Select only change logs with these user profile IDs. (repeated) |
| 206 |
x__xgafv: string, V1 error format. |
| 207 |
Allowed values |
| 208 |
1 - v1 error format |
| 209 |
2 - v2 error format |
| 210 |
|
| 211 |
Returns: |
| 212 |
An object of the form: |
| 213 |
|
| 214 |
{ # Change Log List Response |
| 215 |
"changeLogs": [ # Change log collection. |
| 216 |
{ # Describes a change that a user has made to a resource. |
| 217 |
"accountId": "A String", # Account ID of the modified object. |
| 218 |
"action": "A String", # Action which caused the change. |
| 219 |
"changeTime": "A String", |
| 220 |
"fieldName": "A String", # Field name of the object which changed. |
| 221 |
"id": "A String", # ID of this change log. |
| 222 |
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLog". |
| 223 |
"newValue": "A String", # New value of the object field. |
| 224 |
"objectId": "A String", # ID of the object of this change log. The object could be a campaign, placement, ad, or other type. |
| 225 |
"objectType": "A String", # Object type of the change log. |
| 226 |
"oldValue": "A String", # Old value of the object field. |
| 227 |
"subaccountId": "A String", # Subaccount ID of the modified object. |
| 228 |
"transactionId": "A String", # Transaction ID of this change log. When a single API call results in many changes, each change will have a separate ID in the change log but will share the same transactionId. |
| 229 |
"userProfileId": "A String", # ID of the user who modified the object. |
| 230 |
"userProfileName": "A String", # User profile name of the user who modified the object. |
| 231 |
}, |
| 232 |
], |
| 233 |
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#changeLogsListResponse". |
| 234 |
"nextPageToken": "A String", # Pagination token to be used for the next list operation. |
| 235 |
}</pre> |
| 236 |
</div> |
| 237 |
|
| 238 |
<div class="method"> |
| 239 |
<code class="details" id="list_next">list_next()</code> |
| 240 |
<pre>Retrieves the next page of results. |
| 241 |
|
| 242 |
Args: |
| 243 |
previous_request: The request for the previous page. (required) |
| 244 |
previous_response: The response from the request for the previous page. (required) |
| 245 |
|
| 246 |
Returns: |
| 247 |
A request object that you can call 'execute()' on to request the next |
| 248 |
page. Returns None if there are no more items in the collection. |
| 249 |
</pre> |
| 250 |
</div> |
| 251 |
|
| 252 |
</body></html> |