Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c1cd5cc298b6feffb41977ded6560094e4da40d9 / . / docs / dyn / partners_v2.companies.leads.html
blob: 16800cbc81bbfc8c148aeddf7949b4e3085f7745 [file] [log] [blame]
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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
85Args:
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
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]90{ # Request message for CreateLead.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]91 "requestMetadata": { # Common data that is in each API request. # Current request metadata.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]92 "locale": "A String", # Locale to use for the current request.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]93 "partnersSessionId": "A String", # Google Partners session ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]94 "trafficSource": { # Source of traffic for the current request. # Source of traffic for the current request.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]101 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]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 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]111 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]112 "recaptchaChallenge": { # <a href="https://www.google.com/recaptcha/">reCaptcha</a> challenge info. # <a href="https://www.google.com/recaptcha/">reCaptcha</a> challenge info.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]113 "id": "A String", # The ID of the reCaptcha challenge.
114 "response": "A String", # The response to the reCaptcha challenge.
115 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]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").
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]123 "type": "A String", # Type of lead.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]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.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]132 "units": "A String", # The whole units of the amount.
133 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]134 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
135 },
136 "comments": "A String", # Comments lead source gave.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]137 "createTime": "A String", # Timestamp of when this lead was created.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]138 "websiteUrl": "A String", # Website URL of lead source.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]139 "email": "A String", # Email address of lead source.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]140 "state": "A String", # The lead's state in relation to the company.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]141 "phoneNumber": "A String", # Phone number of lead source.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]142 "gpsMotivations": [ # List of reasons for using Google Partner Search and creating a lead.
143 "A String",
144 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]145 "givenName": "A String", # First name of lead source.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]146 "adwordsCustomerId": "A String", # The AdWords Customer ID of the lead.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]147 "id": "A String", # ID of the lead.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]148 },
149 }
150
151 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]152 Allowed values
153 1 - v1 error format
154 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]155
156Returns:
157 An object of the form:
158
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]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").
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]169 "type": "A String", # Type of lead.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]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.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]178 "units": "A String", # The whole units of the amount.
179 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]180 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
181 },
182 "comments": "A String", # Comments lead source gave.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]183 "createTime": "A String", # Timestamp of when this lead was created.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]184 "websiteUrl": "A String", # Website URL of lead source.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]185 "email": "A String", # Email address of lead source.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]186 "state": "A String", # The lead's state in relation to the company.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]187 "phoneNumber": "A String", # Phone number of lead source.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]188 "gpsMotivations": [ # List of reasons for using Google Partner Search and creating a lead.
189 "A String",
190 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]191 "givenName": "A String", # First name of lead source.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]192 "adwordsCustomerId": "A String", # The AdWords Customer ID of the lead.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]193 "id": "A String", # ID of the lead.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]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>