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.companies.html">companies</a> . <a href="partners_v2.companies.leads.html">leads</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#create">create(companyId, body, x__xgafv=None)</a></code></p> 79 <p class="firstline">Creates an advertiser lead for the given company ID.</p> 80 <h3>Method Details</h3> 81 <div class="method"> 82 <code class="details" id="create">create(companyId, body, x__xgafv=None)</code> 83 <pre>Creates an advertiser lead for the given company ID. 84 85 Args: 86 companyId: string, The ID of the company to contact. (required) 87 body: object, The request body. (required) 88 The object takes the form of: 89 90 { # Request message for CreateLead. 91 "requestMetadata": { # Common data that is in each API request. # Current request metadata. 92 "locale": "A String", # Locale to use for the current request. 93 "partnersSessionId": "A String", # Google Partners session ID. 94 "trafficSource": { # Source of traffic for the current request. # Source of traffic for the current request. 95 "trafficSubId": "A 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 "trafficSourceId": "A String", # Identifier to indicate where the traffic comes from. 99 # An identifier has multiple letters created by a team which redirected the 100 # traffic to us. 101 }, 102 "userOverrides": { # Values to use instead of the user's respective defaults. These are only # Values to use instead of the user's respective defaults for the current 103 # request. These are only honored by whitelisted products. 104 # honored by whitelisted products. 105 "userId": "A String", # Logged-in user ID to impersonate instead of the user's ID. 106 "ipAddress": "A String", # IP address to use instead of the user's geo-located IP address. 107 }, 108 "experimentIds": [ # Experiment IDs the current request belongs to. 109 "A String", 110 ], 111 }, 112 "recaptchaChallenge": { # <a href="https://www.google.com/recaptcha/">reCaptcha</a> challenge info. # <a href="https://www.google.com/recaptcha/">reCaptcha</a> challenge info. 113 "id": "A String", # The ID of the reCaptcha challenge. 114 "response": "A String", # The response to the reCaptcha challenge. 115 }, 116 "lead": { # A lead resource that represents an advertiser contact for a `Company`. These # The lead resource. The `LeadType` must not be `LEAD_TYPE_UNSPECIFIED` 117 # and either `email` or `phone_number` must be provided. 118 # are usually generated via Google Partner Search (the advertiser portal). 119 "marketingOptIn": True or False, # Whether or not the lead signed up for marketing emails 120 "languageCode": "A String", # Language code of the lead's language preference, as defined by 121 # <a href="https://tools.ietf.org/html/bcp47">BCP 47</a> 122 # (IETF BCP 47, "Tags for Identifying Languages"). 123 "type": "A String", # Type of lead. 124 "familyName": "A String", # Last name of lead source. 125 "minMonthlyBudget": { # Represents an amount of money with its currency type. # The minimum monthly budget lead source is willing to spend. 126 "nanos": 42, # Number of nano (10^-9) units of the amount. 127 # The value must be between -999,999,999 and +999,999,999 inclusive. 128 # If `units` is positive, `nanos` must be positive or zero. 129 # If `units` is zero, `nanos` can be positive, zero, or negative. 130 # If `units` is negative, `nanos` must be negative or zero. 131 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. 132 "units": "A String", # The whole units of the amount. 133 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. 134 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. 135 }, 136 "comments": "A String", # Comments lead source gave. 137 "createTime": "A String", # Timestamp of when this lead was created. 138 "websiteUrl": "A String", # Website URL of lead source. 139 "email": "A String", # Email address of lead source. 140 "state": "A String", # The lead's state in relation to the company. 141 "phoneNumber": "A String", # Phone number of lead source. 142 "gpsMotivations": [ # List of reasons for using Google Partner Search and creating a lead. 143 "A String", 144 ], 145 "givenName": "A String", # First name of lead source. 146 "adwordsCustomerId": "A String", # The AdWords Customer ID of the lead. 147 "id": "A String", # ID of the lead. 148 }, 149 } 150 151 x__xgafv: string, V1 error format. 152 Allowed values 153 1 - v1 error format 154 2 - v2 error format 155 156 Returns: 157 An object of the form: 158 159 { # Response message for CreateLead. 160 "recaptchaStatus": "A String", # The outcome of <a href="https://www.google.com/recaptcha/">reCaptcha</a> 161 # validation. 162 "lead": { # A lead resource that represents an advertiser contact for a `Company`. These # Lead that was created depending on the outcome of 163 # <a href="https://www.google.com/recaptcha/">reCaptcha</a> validation. 164 # are usually generated via Google Partner Search (the advertiser portal). 165 "marketingOptIn": True or False, # Whether or not the lead signed up for marketing emails 166 "languageCode": "A String", # Language code of the lead's language preference, as defined by 167 # <a href="https://tools.ietf.org/html/bcp47">BCP 47</a> 168 # (IETF BCP 47, "Tags for Identifying Languages"). 169 "type": "A String", # Type of lead. 170 "familyName": "A String", # Last name of lead source. 171 "minMonthlyBudget": { # Represents an amount of money with its currency type. # The minimum monthly budget lead source is willing to spend. 172 "nanos": 42, # Number of nano (10^-9) units of the amount. 173 # The value must be between -999,999,999 and +999,999,999 inclusive. 174 # If `units` is positive, `nanos` must be positive or zero. 175 # If `units` is zero, `nanos` can be positive, zero, or negative. 176 # If `units` is negative, `nanos` must be negative or zero. 177 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. 178 "units": "A String", # The whole units of the amount. 179 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. 180 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217. 181 }, 182 "comments": "A String", # Comments lead source gave. 183 "createTime": "A String", # Timestamp of when this lead was created. 184 "websiteUrl": "A String", # Website URL of lead source. 185 "email": "A String", # Email address of lead source. 186 "state": "A String", # The lead's state in relation to the company. 187 "phoneNumber": "A String", # Phone number of lead source. 188 "gpsMotivations": [ # List of reasons for using Google Partner Search and creating a lead. 189 "A String", 190 ], 191 "givenName": "A String", # First name of lead source. 192 "adwordsCustomerId": "A String", # The AdWords Customer ID of the lead. 193 "id": "A String", # ID of the lead. 194 }, 195 "responseMetadata": { # Common data that is in each API response. # Current response metadata. 196 "debugInfo": { # Debug information about this request. # Debug information about this request. 197 "serverTraceInfo": "A String", # Server-side debug stack trace. 198 "serviceUrl": "A String", # URL of the service that handled this request. 199 "serverInfo": "A String", # Info about the server that serviced this request. 200 }, 201 }, 202 }</pre> 203 </div> 204 205 </body></html>
