Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 36e41bc9e5f0c6e6d5920ae4a5c9802ca63554e2 / . / docs / dyn / partners_v2.companies.leads.html
blob: 021e490fb8fde08fc6a8723c6c36927fc931dc9c [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.
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. An identifier has multiple letters created by a team which redirected the traffic to us.
96 "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.
97 },
98 "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.
99 "userId": "A String", # Logged-in user ID to impersonate instead of the user's ID.
100 "ipAddress": "A String", # IP address to use instead of the user's geo-located IP address.
101 },
102 "experimentIds": [ # Experiment IDs the current request belongs to.
103 "A String",
104 ],
105 },
106 "recaptchaChallenge": { # reCaptcha challenge info. # reCaptcha challenge info.
107 "id": "A String", # The ID of the reCaptcha challenge.
108 "response": "A String", # The response to the reCaptcha challenge.
109 },
110 "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.
111 "gpsMotivations": [ # List of reasons for using Google Partner Search and creating a lead.
112 "A String",
113 ],
114 "familyName": "A String", # Last name of lead source.
115 "minMonthlyBudget": { # Represents an amount of money with its currency type. # The minimum monthly budget lead source is willing to spend.
116 "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
117 "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.
118 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
119 },
120 "comments": "A String", # Comments lead source gave.
121 "email": "A String", # Email address of lead source.
122 "websiteUrl": "A String", # Website URL of lead source.
123 "phoneNumber": "A String", # Phone number of lead source.
124 "givenName": "A String", # First name of lead source.
125 "type": "A String", # Type of lead.
126 "id": "A String", # ID of the lead.
127 },
128 }
129
130 x__xgafv: string, V1 error format.
131
132Returns:
133 An object of the form:
134
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]135 { # Response message for CreateLead. Debug information about this request.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]136 "recaptchaStatus": "A String", # The outcome of reCaptcha validation.
137 "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.
138 "gpsMotivations": [ # List of reasons for using Google Partner Search and creating a lead.
139 "A String",
140 ],
141 "familyName": "A String", # Last name of lead source.
142 "minMonthlyBudget": { # Represents an amount of money with its currency type. # The minimum monthly budget lead source is willing to spend.
143 "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
144 "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.
145 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
146 },
147 "comments": "A String", # Comments lead source gave.
148 "email": "A String", # Email address of lead source.
149 "websiteUrl": "A String", # Website URL of lead source.
150 "phoneNumber": "A String", # Phone number of lead source.
151 "givenName": "A String", # First name of lead source.
152 "type": "A String", # Type of lead.
153 "id": "A String", # ID of the lead.
154 },
155 "responseMetadata": { # Common data that is in each API response. # Current response metadata.
156 "debugInfo": { # Debug information about this request. # Debug information about this request.
157 "serverTraceInfo": "A String", # Server-side debug stack trace.
158 "serviceUrl": "A String", # URL of the service that handled this request.
159 "serverInfo": "A String", # Info about the server that serviced this request.
160 },
161 },
162 }</pre>
163</div>
164
165</body></html>