blob: ec81678e7509d065fd37f9398743b74be8ee5e8f [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="dfareporting_v3_3.html">Campaign Manager 360 API</a> . <a href="dfareporting_v3_3.changeLogs.html">changeLogs</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(profileId, id, x__xgafv=None)</a></code></p>
<p class="firstline">Gets one change log by ID.</p>
<p class="toc_element">
<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>
<p class="firstline">Retrieves a list of change logs. This method supports paging.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(profileId, id, x__xgafv=None)</code>
<pre>Gets one change log by ID.
Args:
profileId: string, User profile ID associated with this request. (required)
id: string, Change log ID. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Describes a change that a user has made to a resource.
&quot;accountId&quot;: &quot;A String&quot;, # Account ID of the modified object.
&quot;action&quot;: &quot;A String&quot;, # Action which caused the change.
&quot;changeTime&quot;: &quot;A String&quot;,
&quot;fieldName&quot;: &quot;A String&quot;, # Field name of the object which changed.
&quot;id&quot;: &quot;A String&quot;, # ID of this change log.
&quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#changeLog&quot;.
&quot;newValue&quot;: &quot;A String&quot;, # New value of the object field.
&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.
&quot;objectType&quot;: &quot;A String&quot;, # Object type of the change log.
&quot;oldValue&quot;: &quot;A String&quot;, # Old value of the object field.
&quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of the modified object.
&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.
&quot;userProfileId&quot;: &quot;A String&quot;, # ID of the user who modified the object.
&quot;userProfileName&quot;: &quot;A String&quot;, # User profile name of the user who modified the object.
}</pre>
</div>
<div class="method">
<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>
<pre>Retrieves a list of change logs. This method supports paging.
Args:
profileId: string, User profile ID associated with this request. (required)
action: string, Select only change logs with the specified action.
Allowed values
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: string, Select only change logs with these IDs. (repeated)
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.
maxResults: integer, Maximum number of results to return.
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.
objectIds: string, Select only change logs with these object IDs. (repeated)
objectType: string, Select only change logs with the specified object type.
Allowed values
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 -
pageToken: string, Value of the nextPageToken from the previous result page.
searchString: string, Select only change logs whose object ID, user name, old or new values match the search string.
userProfileIds: string, Select only change logs with these user profile IDs. (repeated)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Change Log List Response
&quot;changeLogs&quot;: [ # Change log collection.
{ # Describes a change that a user has made to a resource.
&quot;accountId&quot;: &quot;A String&quot;, # Account ID of the modified object.
&quot;action&quot;: &quot;A String&quot;, # Action which caused the change.
&quot;changeTime&quot;: &quot;A String&quot;,
&quot;fieldName&quot;: &quot;A String&quot;, # Field name of the object which changed.
&quot;id&quot;: &quot;A String&quot;, # ID of this change log.
&quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#changeLog&quot;.
&quot;newValue&quot;: &quot;A String&quot;, # New value of the object field.
&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.
&quot;objectType&quot;: &quot;A String&quot;, # Object type of the change log.
&quot;oldValue&quot;: &quot;A String&quot;, # Old value of the object field.
&quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of the modified object.
&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.
&quot;userProfileId&quot;: &quot;A String&quot;, # ID of the user who modified the object.
&quot;userProfileName&quot;: &quot;A String&quot;, # User profile name of the user who modified the object.
},
],
&quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#changeLogsListResponse&quot;.
&quot;nextPageToken&quot;: &quot;A String&quot;, # Pagination token to be used for the next list operation.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>