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.leads.html">leads</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)</a></code></p> 79 <p class="firstline">Lists advertiser leads for a user's associated 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)</code> 86 <pre>Lists advertiser leads for a user's associated company. 87 Should only be called within the context of an authorized logged in user. 88 89 Args: 90 orderBy: string, How to order Leads. Currently, only `create_time` 91 and `create_time desc` are supported 92 pageSize: integer, Requested page size. Server may return fewer leads than requested. 93 If unspecified, server picks an appropriate default. 94 requestMetadata_userOverrides_ipAddress: string, IP address to use instead of the user's geo-located IP address. 95 requestMetadata_trafficSource_trafficSubId: string, Second level identifier to indicate where the traffic comes from. 96 An identifier has multiple letters created by a team which redirected the 97 traffic to us. 98 requestMetadata_userOverrides_userId: string, Logged-in user ID to impersonate instead of the user's ID. 99 x__xgafv: string, V1 error format. 100 Allowed values 101 1 - v1 error format 102 2 - v2 error format 103 requestMetadata_locale: string, Locale to use for the current request. 104 pageToken: string, A token identifying a page of results that the server returns. 105 Typically, this is the value of `ListLeadsResponse.next_page_token` 106 returned from the previous call to 107 ListLeads. 108 requestMetadata_experimentIds: string, Experiment IDs the current request belongs to. (repeated) 109 requestMetadata_trafficSource_trafficSourceId: string, Identifier to indicate where the traffic comes from. 110 An identifier has multiple letters created by a team which redirected the 111 traffic to us. 112 requestMetadata_partnersSessionId: string, Google Partners session ID. 113 114 Returns: 115 An object of the form: 116 117 { # Response message for ListLeads. 118 "nextPageToken": "A String", # A token to retrieve next page of results. 119 # Pass this value in the `ListLeadsRequest.page_token` field in the 120 # subsequent call to 121 # ListLeads to retrieve the 122 # next page of results. 123 "totalSize": 42, # The total count of leads for the given company. 124 "leads": [ # The list of leads. 125 { # A lead resource that represents an advertiser contact for a `Company`. These 126 # are usually generated via Google Partner Search (the advertiser portal). 127 "marketingOptIn": True or False, # Whether or not the lead signed up for marketing emails 128 "languageCode": "A String", # Language code of the lead's language preference, as defined by 129 # <a href="https://tools.ietf.org/html/bcp47">BCP 47</a> 130 # (IETF BCP 47, "Tags for Identifying Languages"). 131 "type": "A String", # Type of lead. 132 "familyName": "A String", # Last name of lead source. 133 "minMonthlyBudget": { # Represents an amount of money with its currency type. # The minimum monthly budget lead source is willing to spend. 134 "nanos": 42, # Number of nano (10^-9) units of the amount. 135 # The value must be between -999,999,999 and +999,999,999 inclusive. 136 # If `units` is positive, `nanos` must be positive or zero. 137 # If `units` is zero, `nanos` can be positive, zero, or negative. 138 # If `units` is negative, `nanos` must be negative or zero. 139 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. 140 "units": "A String", # The whole units of the amount. 141 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. 142 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. 143 }, 144 "comments": "A String", # Comments lead source gave. 145 "createTime": "A String", # Timestamp of when this lead was created. 146 "websiteUrl": "A String", # Website URL of lead source. 147 "email": "A String", # Email address of lead source. 148 "state": "A String", # The lead's state in relation to the company. 149 "phoneNumber": "A String", # Phone number of lead source. 150 "gpsMotivations": [ # List of reasons for using Google Partner Search and creating a lead. 151 "A String", 152 ], 153 "givenName": "A String", # First name of lead source. 154 "adwordsCustomerId": "A String", # The AdWords Customer ID of the lead. 155 "id": "A String", # ID of the lead. 156 }, 157 ], 158 "responseMetadata": { # Common data that is in each API response. # Current response metadata. 159 "debugInfo": { # Debug information about this request. # Debug information about this request. 160 "serverTraceInfo": "A String", # Server-side debug stack trace. 161 "serviceUrl": "A String", # URL of the service that handled this request. 162 "serverInfo": "A String", # Info about the server that serviced this request. 163 }, 164 }, 165 }</pre> 166 </div> 167 168 <div class="method"> 169 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 170 <pre>Retrieves the next page of results. 171 172 Args: 173 previous_request: The request for the previous page. (required) 174 previous_response: The response from the request for the previous page. (required) 175 176 Returns: 177 A request object that you can call 'execute()' on to request the next 178 page. Returns None if there are no more items in the collection. 179 </pre> 180 </div> 181 182 </body></html>
