1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
<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.companies.html">companies</a> . <a href="partners_v2.companies.leads.html">leads</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(companyId, body, x__xgafv=None)</a></code></p>
<p class="firstline">Creates an advertiser lead for the given company ID.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(companyId, body, x__xgafv=None)</code>
<pre>Creates an advertiser lead for the given company ID.
Args:
companyId: string, The ID of the company to contact. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Request message for CreateLead.
"requestMetadata": { # Common data that is in each API request. # Current request metadata.
"locale": "A String", # Locale to use for the current request.
"partnersSessionId": "A String", # Google Partners session ID.
"trafficSource": { # Source of traffic for the current request. # Source of traffic for the current request.
"trafficSubId": "A 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.
"trafficSourceId": "A String", # Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.
},
"userOverrides": { # Values to use instead of the user's respective defaults. These are only honored by whitelisted products. # Values to use instead of the user's respective defaults for the current request. These are only honored by whitelisted products.
"userId": "A String", # Logged-in user ID to impersonate instead of the user's ID.
"ipAddress": "A String", # IP address to use instead of the user's geo-located IP address.
},
"experimentIds": [ # Experiment IDs the current request belongs to.
"A String",
],
},
"recaptchaChallenge": { # reCaptcha challenge info. # reCaptcha challenge info.
"id": "A String", # The ID of the reCaptcha challenge.
"response": "A String", # The response to the reCaptcha challenge.
},
"lead": { # A lead resource that represents an advertiser contact for a `Company`. These are usually generated via Google Partner Search (the advertiser portal). # The lead resource. The `LeadType` must not be `LEAD_TYPE_UNSPECIFIED` and either `email` or `phone_number` must be provided.
"gpsMotivations": [ # List of reasons for using Google Partner Search and creating a lead.
"A String",
],
"familyName": "A String", # Last name of lead source.
"minMonthlyBudget": { # Represents an amount of money with its currency type. # The minimum monthly budget lead source is willing to spend.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
"comments": "A String", # Comments lead source gave.
"email": "A String", # Email address of lead source.
"websiteUrl": "A String", # Website URL of lead source.
"phoneNumber": "A String", # Phone number of lead source.
"givenName": "A String", # First name of lead source.
"type": "A String", # Type of lead.
"id": "A String", # ID of the lead.
},
}
x__xgafv: string, V1 error format.
Returns:
An object of the form:
{ # Response message for CreateLead. Debug information about this request.
"recaptchaStatus": "A String", # The outcome of reCaptcha validation.
"lead": { # A lead resource that represents an advertiser contact for a `Company`. These are usually generated via Google Partner Search (the advertiser portal). # Lead that was created depending on the outcome of reCaptcha validation.
"gpsMotivations": [ # List of reasons for using Google Partner Search and creating a lead.
"A String",
],
"familyName": "A String", # Last name of lead source.
"minMonthlyBudget": { # Represents an amount of money with its currency type. # The minimum monthly budget lead source is willing to spend.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
"comments": "A String", # Comments lead source gave.
"email": "A String", # Email address of lead source.
"websiteUrl": "A String", # Website URL of lead source.
"phoneNumber": "A String", # Phone number of lead source.
"givenName": "A String", # First name of lead source.
"type": "A String", # Type of lead.
"id": "A String", # ID of the lead.
},
"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.
},
},
}</pre>
</div>
</body></html>
|
