docs/dyn/partners_v2.offers.history.html - platform/external/python/google-api-python-client - Git at Google

 <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="partners_v2.html">Google Partners API</a> . <a href="partners_v2.offers.html">offers</a> . <a href="partners_v2.offers.history.html">history</a></h1>
 <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="#list">list(orderBy=None, pageSize=None, requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, pageToken=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, requestMetadata_partnersSessionId=None, entireCompany=None)</a></code></p>
 <p class="firstline">Lists the Historical Offers for the current user (or user's entire company)</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="list">list(orderBy=None, pageSize=None, requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, pageToken=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, requestMetadata_partnersSessionId=None, entireCompany=None)</code>
   <pre>Lists the Historical Offers for the current user (or user's entire company)

 Args:
   orderBy: string, Comma-separated list of fields to order by, e.g.: "foo,bar,baz".
 Use "foo desc" to sort descending.
 List of valid field names is: name, offer_code, expiration_time, status,
     last_modified_time, sender_name, creation_time, country_code,
     offer_type.
   pageSize: integer, Maximum number of rows to return per page.
   requestMetadata_userOverrides_ipAddress: string, IP address to use instead of the user's geo-located IP address.
   requestMetadata_trafficSource_trafficSubId: string, Second level identifier to indicate where the traffic comes from.
 An identifier has multiple letters created by a team which redirected the
 traffic to us.
   requestMetadata_userOverrides_userId: string, Logged-in user ID to impersonate instead of the user's ID.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format
   requestMetadata_locale: string, Locale to use for the current request.
   pageToken: string, Token to retrieve a specific page.
   requestMetadata_experimentIds: string, Experiment IDs the current request belongs to. (repeated)
   requestMetadata_trafficSource_trafficSourceId: string, Identifier to indicate where the traffic comes from.
 An identifier has multiple letters created by a team which redirected the
 traffic to us.
   requestMetadata_partnersSessionId: string, Google Partners session ID.
   entireCompany: boolean, if true, show history for the entire company.  Requires user to be admin.

 Returns:
   An object of the form:

     { # Response for ListOfferHistory.
     "nextPageToken": "A String", # Supply this token in a ListOffersHistoryRequest to retrieve the next page.
     "responseMetadata": { # Common data that is in each API response. # Current response metadata.
       "debugInfo": { # Debug information about this request. # Debug information about this request.
         "serverTraceInfo": "A String", # Server-side debug stack trace.
         "serviceUrl": "A String", # URL of the service that handled this request.
         "serverInfo": "A String", # Info about the server that serviced this request.
       },
     },
     "canShowEntireCompany": True or False, # True if the user has the option to show entire company history.
     "showingEntireCompany": True or False, # True if this response is showing entire company history.
     "offers": [ # Historical offers meeting request.
       { # Historical information about a Google Partners Offer.
         "offerCode": "A String", # Offer code.
         "status": "A String", # Status of the offer.
         "adwordsUrl": "A String", # Client's AdWords page URL.
         "offerCountryCode": "A String", # Country Code for the offer country.
         "creationTime": "A String", # Time offer was first created.
         "clientId": "A String", # ID of client.
         "clientEmail": "A String", # Email address for client.
         "expirationTime": "A String", # Time this offer expires.
         "offerType": "A String", # Type of offer.
         "senderName": "A String", # Name (First + Last) of the partners user to whom the incentive is allocated.
         "lastModifiedTime": "A String", # Time last action was taken.
         "clientName": "A String", # Name of the client.
       },
     ],
     "totalResults": 42, # Number of results across all pages.
   }</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 'execute()' on to request the next
   page. Returns None if there are no more items in the collection.
     </pre>
 </div>

 </body></html>
	<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="partners_v2.html">Google Partners API</a> . <a href="partners_v2.offers.html">offers</a> . <a href="partners_v2.offers.history.html">history</a></h1>
	<h2>Instance Methods</h2>
	<p class="toc_element">
	<code><a href="#list">list(orderBy=None, pageSize=None, requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, pageToken=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, requestMetadata_partnersSessionId=None, entireCompany=None)</a></code></p>
	<p class="firstline">Lists the Historical Offers for the current user (or user's entire company)</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="list">list(orderBy=None, pageSize=None, requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, pageToken=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, requestMetadata_partnersSessionId=None, entireCompany=None)</code>
	<pre>Lists the Historical Offers for the current user (or user's entire company)

	Args:
	orderBy: string, Comma-separated list of fields to order by, e.g.: "foo,bar,baz".
	Use "foo desc" to sort descending.
	List of valid field names is: name, offer_code, expiration_time, status,
	last_modified_time, sender_name, creation_time, country_code,
	offer_type.
	pageSize: integer, Maximum number of rows to return per page.
	requestMetadata_userOverrides_ipAddress: string, IP address to use instead of the user's geo-located IP address.
	requestMetadata_trafficSource_trafficSubId: string, Second level identifier to indicate where the traffic comes from.
	An identifier has multiple letters created by a team which redirected the
	traffic to us.
	requestMetadata_userOverrides_userId: string, Logged-in user ID to impersonate instead of the user's ID.
	x__xgafv: string, V1 error format.
	Allowed values
	1 - v1 error format
	2 - v2 error format
	requestMetadata_locale: string, Locale to use for the current request.
	pageToken: string, Token to retrieve a specific page.
	requestMetadata_experimentIds: string, Experiment IDs the current request belongs to. (repeated)
	requestMetadata_trafficSource_trafficSourceId: string, Identifier to indicate where the traffic comes from.
	An identifier has multiple letters created by a team which redirected the
	traffic to us.
	requestMetadata_partnersSessionId: string, Google Partners session ID.
	entireCompany: boolean, if true, show history for the entire company. Requires user to be admin.

	Returns:
	An object of the form:

	{ # Response for ListOfferHistory.
	"nextPageToken": "A String", # Supply this token in a ListOffersHistoryRequest to retrieve the next page.
	"responseMetadata": { # Common data that is in each API response. # Current response metadata.
	"debugInfo": { # Debug information about this request. # Debug information about this request.
	"serverTraceInfo": "A String", # Server-side debug stack trace.
	"serviceUrl": "A String", # URL of the service that handled this request.
	"serverInfo": "A String", # Info about the server that serviced this request.
	},
	},
	"canShowEntireCompany": True or False, # True if the user has the option to show entire company history.
	"showingEntireCompany": True or False, # True if this response is showing entire company history.
	"offers": [ # Historical offers meeting request.
	{ # Historical information about a Google Partners Offer.
	"offerCode": "A String", # Offer code.
	"status": "A String", # Status of the offer.
	"adwordsUrl": "A String", # Client's AdWords page URL.
	"offerCountryCode": "A String", # Country Code for the offer country.
	"creationTime": "A String", # Time offer was first created.
	"clientId": "A String", # ID of client.
	"clientEmail": "A String", # Email address for client.
	"expirationTime": "A String", # Time this offer expires.
	"offerType": "A String", # Type of offer.
	"senderName": "A String", # Name (First + Last) of the partners user to whom the incentive is allocated.
	"lastModifiedTime": "A String", # Time last action was taken.
	"clientName": "A String", # Name of the client.
	},
	],
	"totalResults": 42, # Number of results across all pages.
	}</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 'execute()' on to request the next
	page. Returns None if there are no more items in the collection.
	</pre>
	</div>

	</body></html>