Home | History | Annotate | Download | only in dyn 
      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="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>
     76 <h2>Instance Methods</h2>
     77 <p class="toc_element">
     78   <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>
     79 <p class="firstline">Lists the Historical Offers for the current user (or user's entire company)</p>
     80 <p class="toc_element">
     81   <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
     82 <p class="firstline">Retrieves the next page of results.</p>
     83 <h3>Method Details</h3>
     84 <div class="method">
     85     <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>
     86   <pre>Lists the Historical Offers for the current user (or user's entire company)
     87 
     88 Args:
     89   orderBy: string, Comma-separated list of fields to order by, e.g.: "foo,bar,baz".
     90 Use "foo desc" to sort descending.
     91 List of valid field names is: name, offer_code, expiration_time, status,
     92     last_modified_time, sender_name, creation_time, country_code,
     93     offer_type.
     94   pageSize: integer, Maximum number of rows to return per page.
     95   requestMetadata_userOverrides_ipAddress: string, IP address to use instead of the user's geo-located IP address.
     96   requestMetadata_trafficSource_trafficSubId: string, Second level identifier to indicate where the traffic comes from.
     97 An identifier has multiple letters created by a team which redirected the
     98 traffic to us.
     99   requestMetadata_userOverrides_userId: string, Logged-in user ID to impersonate instead of the user's ID.
    100   x__xgafv: string, V1 error format.
    101     Allowed values
    102       1 - v1 error format
    103       2 - v2 error format
    104   requestMetadata_locale: string, Locale to use for the current request.
    105   pageToken: string, Token to retrieve a specific page.
    106   requestMetadata_experimentIds: string, Experiment IDs the current request belongs to. (repeated)
    107   requestMetadata_trafficSource_trafficSourceId: string, Identifier to indicate where the traffic comes from.
    108 An identifier has multiple letters created by a team which redirected the
    109 traffic to us.
    110   requestMetadata_partnersSessionId: string, Google Partners session ID.
    111   entireCompany: boolean, if true, show history for the entire company.  Requires user to be admin.
    112 
    113 Returns:
    114   An object of the form:
    115 
    116     { # Response for ListOfferHistory.
    117     "nextPageToken": "A String", # Supply this token in a ListOffersHistoryRequest to retrieve the next page.
    118     "responseMetadata": { # Common data that is in each API response. # Current response metadata.
    119       "debugInfo": { # Debug information about this request. # Debug information about this request.
    120         "serverTraceInfo": "A String", # Server-side debug stack trace.
    121         "serviceUrl": "A String", # URL of the service that handled this request.
    122         "serverInfo": "A String", # Info about the server that serviced this request.
    123       },
    124     },
    125     "canShowEntireCompany": True or False, # True if the user has the option to show entire company history.
    126     "showingEntireCompany": True or False, # True if this response is showing entire company history.
    127     "offers": [ # Historical offers meeting request.
    128       { # Historical information about a Google Partners Offer.
    129         "offerCode": "A String", # Offer code.
    130         "status": "A String", # Status of the offer.
    131         "adwordsUrl": "A String", # Client's AdWords page URL.
    132         "offerCountryCode": "A String", # Country Code for the offer country.
    133         "creationTime": "A String", # Time offer was first created.
    134         "clientId": "A String", # ID of client.
    135         "clientEmail": "A String", # Email address for client.
    136         "expirationTime": "A String", # Time this offer expires.
    137         "offerType": "A String", # Type of offer.
    138         "senderName": "A String", # Name (First + Last) of the partners user to whom the incentive is allocated.
    139         "lastModifiedTime": "A String", # Time last action was taken.
    140         "clientName": "A String", # Name of the client.
    141       },
    142     ],
    143     "totalResults": 42, # Number of results across all pages.
    144   }</pre>
    145 </div>
    146 
    147 <div class="method">
    148     <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
    149   <pre>Retrieves the next page of results.
    150 
    151 Args:
    152   previous_request: The request for the previous page. (required)
    153   previous_response: The response from the request for the previous page. (required)
    154 
    155 Returns:
    156   A request object that you can call 'execute()' on to request the next
    157   page. Returns None if there are no more items in the collection.
    158     </pre>
    159 </div>
    160 
    161 </body></html>