blob: abd52943c67c5d605174e2c5bf8cd7fd025f868a [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -07001<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070075<h1><a href="dfareporting_v3_4.html">Campaign Manager 360 API</a> . <a href="dfareporting_v3_4.changeLogs.html">changeLogs</a></h1>
Bu Sun Kim65020912020-05-20 12:08:20 -070076<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <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>
Bu Sun Kim65020912020-05-20 12:08:20 -070082<p class="firstline">Gets one change log by ID.</p>
83<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080084 <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>
Bu Sun Kim65020912020-05-20 12:08:20 -070085<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(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<h3>Method Details</h3>
90<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070091 <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>
Bu Sun Kim65020912020-05-20 12:08:20 -070097 <pre>Gets one change log by ID.
98
99Args:
100 profileId: string, User profile ID associated with this request. (required)
101 id: string, Change log ID. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700102 x__xgafv: string, V1 error format.
103 Allowed values
104 1 - v1 error format
105 2 - v2 error format
Bu Sun Kim65020912020-05-20 12:08:20 -0700106
107Returns:
108 An object of the form:
109
110 { # Describes a change that a user has made to a resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800111 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of the modified object.
112 &quot;action&quot;: &quot;A String&quot;, # Action which caused the change.
113 &quot;changeTime&quot;: &quot;A String&quot;,
114 &quot;fieldName&quot;: &quot;A String&quot;, # Field name of the object which changed.
115 &quot;id&quot;: &quot;A String&quot;, # ID of this change log.
116 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#changeLog&quot;.
117 &quot;newValue&quot;: &quot;A String&quot;, # New value of the object field.
118 &quot;objectId&quot;: &quot;A String&quot;, # ID of the object of this change log. The object could be a campaign, placement, ad, or other type.
119 &quot;objectType&quot;: &quot;A String&quot;, # Object type of the change log.
120 &quot;oldValue&quot;: &quot;A String&quot;, # Old value of the object field.
121 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of the modified object.
122 &quot;transactionId&quot;: &quot;A String&quot;, # 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 &quot;userProfileId&quot;: &quot;A String&quot;, # ID of the user who modified the object.
124 &quot;userProfileName&quot;: &quot;A String&quot;, # User profile name of the user who modified the object.
125}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700126</div>
127
128<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800129 <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>
Bu Sun Kim65020912020-05-20 12:08:20 -0700130 <pre>Retrieves a list of change logs. This method supports paging.
131
132Args:
133 profileId: string, User profile ID associated with this request. (required)
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800134 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 -
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800153 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 &quot;2015-07-18T22:54:00-04:00&quot;. 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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800156 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 &quot;2015-07-18T22:54:00-04:00&quot;. In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800157 objectIds: string, Select only change logs with these object IDs. (repeated)
Bu Sun Kim65020912020-05-20 12:08:20 -0700158 objectType: string, Select only change logs with the specified object type.
159 Allowed values
Bu Sun Kim65020912020-05-20 12:08:20 -0700160 OBJECT_ADVERTISER -
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700161 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 -
Bu Sun Kim65020912020-05-20 12:08:20 -0700171 OBJECT_ADVERTISER_GROUP -
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700172 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 -
Bu Sun Kim65020912020-05-20 12:08:20 -0700190 OBJECT_BILLING_ACCOUNT_GROUP -
191 OBJECT_BILLING_FEATURE -
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700192 OBJECT_RATE_CARD -
193 OBJECT_ACCOUNT_BILLING_FEATURE -
Bu Sun Kim65020912020-05-20 12:08:20 -0700194 OBJECT_BILLING_MINIMUM_FEE -
195 OBJECT_BILLING_PROFILE -
Bu Sun Kim65020912020-05-20 12:08:20 -0700196 OBJECT_PLAYSTORE_LINK -
Bu Sun Kim65020912020-05-20 12:08:20 -0700197 OBJECT_TARGETING_TEMPLATE -
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700198 OBJECT_SEARCH_LIFT_STUDY -
199 OBJECT_FLOODLIGHT_DV360_LINK -
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800200 pageToken: string, Value of the nextPageToken from the previous result page.
201 searchString: string, Select only change logs whose object ID, user name, old or new values match the search string.
202 userProfileIds: string, Select only change logs with these user profile IDs. (repeated)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700203 x__xgafv: string, V1 error format.
204 Allowed values
205 1 - v1 error format
206 2 - v2 error format
Bu Sun Kim65020912020-05-20 12:08:20 -0700207
208Returns:
209 An object of the form:
210
211 { # Change Log List Response
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800212 &quot;changeLogs&quot;: [ # Change log collection.
213 { # Describes a change that a user has made to a resource.
214 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of the modified object.
215 &quot;action&quot;: &quot;A String&quot;, # Action which caused the change.
216 &quot;changeTime&quot;: &quot;A String&quot;,
217 &quot;fieldName&quot;: &quot;A String&quot;, # Field name of the object which changed.
218 &quot;id&quot;: &quot;A String&quot;, # ID of this change log.
219 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#changeLog&quot;.
220 &quot;newValue&quot;: &quot;A String&quot;, # New value of the object field.
221 &quot;objectId&quot;: &quot;A String&quot;, # ID of the object of this change log. The object could be a campaign, placement, ad, or other type.
222 &quot;objectType&quot;: &quot;A String&quot;, # Object type of the change log.
223 &quot;oldValue&quot;: &quot;A String&quot;, # Old value of the object field.
224 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of the modified object.
225 &quot;transactionId&quot;: &quot;A String&quot;, # 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.
226 &quot;userProfileId&quot;: &quot;A String&quot;, # ID of the user who modified the object.
227 &quot;userProfileName&quot;: &quot;A String&quot;, # User profile name of the user who modified the object.
228 },
229 ],
230 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#changeLogsListResponse&quot;.
231 &quot;nextPageToken&quot;: &quot;A String&quot;, # Pagination token to be used for the next list operation.
232}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700233</div>
234
235<div class="method">
236 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
237 <pre>Retrieves the next page of results.
238
239Args:
240 previous_request: The request for the previous page. (required)
241 previous_response: The response from the request for the previous page. (required)
242
243Returns:
244 A request object that you can call &#x27;execute()&#x27; on to request the next
245 page. Returns None if there are no more items in the collection.
246 </pre>
247</div>
248
249</body></html>