blob: 36130c66b7b14f8b36a6c46e6d9a11ef5103588d [file] [log] [blame]
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001<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.v2.html">v2</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#getPartnersstatus">getPartnersstatus(requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, requestMetadata_partnersSessionId=None)</a></code></p>
79<p class="firstline">Gets Partners Status of the logged in user's agency.</p>
80<p class="toc_element">
81 <code><a href="#updateCompanies">updateCompanies(body, requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, updateMask=None, requestMetadata_partnersSessionId=None)</a></code></p>
82<p class="firstline">Update company.</p>
83<p class="toc_element">
84 <code><a href="#updateLeads">updateLeads(body, requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, updateMask=None, requestMetadata_partnersSessionId=None)</a></code></p>
85<p class="firstline">Updates the specified lead.</p>
86<h3>Method Details</h3>
87<div class="method">
88 <code class="details" id="getPartnersstatus">getPartnersstatus(requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, requestMetadata_partnersSessionId=None)</code>
89 <pre>Gets Partners Status of the logged in user's agency.
90Should only be called if the logged in user is the admin of the agency.
91
92Args:
93 requestMetadata_userOverrides_ipAddress: string, IP address to use instead of the user's geo-located IP address.
94 requestMetadata_trafficSource_trafficSubId: string, Second level identifier to indicate where the traffic comes from.
95An identifier has multiple letters created by a team which redirected the
96traffic to us.
97 requestMetadata_userOverrides_userId: string, Logged-in user ID to impersonate instead of the user's ID.
98 x__xgafv: string, V1 error format.
99 Allowed values
100 1 - v1 error format
101 2 - v2 error format
102 requestMetadata_locale: string, Locale to use for the current request.
103 requestMetadata_experimentIds: string, Experiment IDs the current request belongs to. (repeated)
104 requestMetadata_trafficSource_trafficSourceId: string, Identifier to indicate where the traffic comes from.
105An identifier has multiple letters created by a team which redirected the
106traffic to us.
107 requestMetadata_partnersSessionId: string, Google Partners session ID.
108
109Returns:
110 An object of the form:
111
112 { # Response message for
113 # GetPartnersStatus.
114 "responseMetadata": { # Common data that is in each API response. # Current response metadata.
115 "debugInfo": { # Debug information about this request. # Debug information about this request.
116 "serverTraceInfo": "A String", # Server-side debug stack trace.
117 "serviceUrl": "A String", # URL of the service that handled this request.
118 "serverInfo": "A String", # Info about the server that serviced this request.
119 },
120 },
121 }</pre>
122</div>
123
124<div class="method">
125 <code class="details" id="updateCompanies">updateCompanies(body, requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, updateMask=None, requestMetadata_partnersSessionId=None)</code>
126 <pre>Update company.
127Should only be called within the context of an authorized logged in user.
128
129Args:
130 body: object, The request body. (required)
131 The object takes the form of:
132
133{ # A company resource in the Google Partners API. Once certified, it qualifies
134 # for being searched by advertisers.
135 "industries": [ # Industries the company can help with.
136 "A String",
137 ],
138 "originalMinMonthlyBudget": { # Represents an amount of money with its currency type. # The unconverted minimum monthly budget that the company accepts for partner
139 # business.
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 "nanos": 42, # Number of nano (10^-9) units of the amount.
143 # The value must be between -999,999,999 and +999,999,999 inclusive.
144 # If `units` is positive, `nanos` must be positive or zero.
145 # If `units` is zero, `nanos` can be positive, zero, or negative.
146 # If `units` is negative, `nanos` must be negative or zero.
147 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
148 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
149 },
150 "autoApprovalEmailDomains": [ # Email domains that allow users with a matching email address to get
151 # auto-approved for associating with this company.
152 "A String",
153 ],
154 "name": "A String", # The name of the company.
155 "badgeTier": "A String", # Partner badge tier
156 "localizedInfos": [ # The list of localized info for the company.
157 { # The localized company information.
158 "countryCodes": [ # List of country codes for the localized company info.
159 "A String",
160 ],
161 "overview": "A String", # Localized brief description that the company uses to advertise themselves.
162 "displayName": "A String", # Localized display name.
163 "languageCode": "A String", # Language code of the localized company info, as defined by
164 # <a href="https://tools.ietf.org/html/bcp47">BCP 47</a>
165 # (IETF BCP 47, "Tags for Identifying Languages").
166 },
167 ],
168 "locations": [ # The list of all company locations.
169 # If set, must include the
170 # primary_location
171 # in the list.
172 { # A location with address and geographic coordinates. May optionally contain a
173 # detailed (multi-field) version of the address.
174 "languageCode": "A String", # Language code of the address. Should be in BCP 47 format.
175 "addressLine": [ # The following address lines represent the most specific part of any
176 # address.
177 "A String",
178 ],
179 "dependentLocality": "A String", # Dependent locality or sublocality. Used for UK dependent localities, or
180 # neighborhoods or boroughs in other locations.
181 "sortingCode": "A String", # Use of this code is very country-specific, but will refer to a secondary
182 # classification code for sorting mail.
183 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # The latitude and longitude of the location, in degrees.
184 # of doubles representing degrees latitude and degrees longitude. Unless
185 # specified otherwise, this must conform to the
186 # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
187 # standard</a>. Values must be within normalized ranges.
188 #
189 # Example of normalization code in Python:
190 #
191 # def NormalizeLongitude(longitude):
192 # """Wraps decimal degrees longitude to [-180.0, 180.0]."""
193 # q, r = divmod(longitude, 360.0)
194 # if r > 180.0 or (r == 180.0 and q <= -1.0):
195 # return r - 360.0
196 # return r
197 #
198 # def NormalizeLatLng(latitude, longitude):
199 # """Wraps decimal degrees latitude and longitude to
200 # [-90.0, 90.0] and [-180.0, 180.0], respectively."""
201 # r = latitude % 360.0
202 # if r <= 90.0:
203 # return r, NormalizeLongitude(longitude)
204 # elif r >= 270.0:
205 # return r - 360, NormalizeLongitude(longitude)
206 # else:
207 # return 180 - r, NormalizeLongitude(longitude + 180.0)
208 #
209 # assert 180.0 == NormalizeLongitude(180.0)
210 # assert -180.0 == NormalizeLongitude(-180.0)
211 # assert -179.0 == NormalizeLongitude(181.0)
212 # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
213 # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
214 # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
215 # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
216 # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
217 # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
218 # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
219 # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
220 # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
221 # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
222 #
223 # The code in logs/storage/validator/logs_validator_traits.cc treats this type
224 # as if it were annotated as ST_LOCATION.
225 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
226 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
227 },
228 "locality": "A String", # Generally refers to the city/town portion of an address.
229 "regionCode": "A String", # CLDR (Common Locale Data Repository) region code .
230 "administrativeArea": "A String", # Top-level administrative subdivision of this country.
231 "address": "A String", # The single string version of the address.
232 "postalCode": "A String", # Values are frequently alphanumeric.
233 },
234 ],
235 "websiteUrl": "A String", # URL of the company's website.
236 "primaryLocation": { # A location with address and geographic coordinates. May optionally contain a # The primary location of the company.
237 # detailed (multi-field) version of the address.
238 "languageCode": "A String", # Language code of the address. Should be in BCP 47 format.
239 "addressLine": [ # The following address lines represent the most specific part of any
240 # address.
241 "A String",
242 ],
243 "dependentLocality": "A String", # Dependent locality or sublocality. Used for UK dependent localities, or
244 # neighborhoods or boroughs in other locations.
245 "sortingCode": "A String", # Use of this code is very country-specific, but will refer to a secondary
246 # classification code for sorting mail.
247 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # The latitude and longitude of the location, in degrees.
248 # of doubles representing degrees latitude and degrees longitude. Unless
249 # specified otherwise, this must conform to the
250 # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
251 # standard</a>. Values must be within normalized ranges.
252 #
253 # Example of normalization code in Python:
254 #
255 # def NormalizeLongitude(longitude):
256 # """Wraps decimal degrees longitude to [-180.0, 180.0]."""
257 # q, r = divmod(longitude, 360.0)
258 # if r > 180.0 or (r == 180.0 and q <= -1.0):
259 # return r - 360.0
260 # return r
261 #
262 # def NormalizeLatLng(latitude, longitude):
263 # """Wraps decimal degrees latitude and longitude to
264 # [-90.0, 90.0] and [-180.0, 180.0], respectively."""
265 # r = latitude % 360.0
266 # if r <= 90.0:
267 # return r, NormalizeLongitude(longitude)
268 # elif r >= 270.0:
269 # return r - 360, NormalizeLongitude(longitude)
270 # else:
271 # return 180 - r, NormalizeLongitude(longitude + 180.0)
272 #
273 # assert 180.0 == NormalizeLongitude(180.0)
274 # assert -180.0 == NormalizeLongitude(-180.0)
275 # assert -179.0 == NormalizeLongitude(181.0)
276 # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
277 # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
278 # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
279 # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
280 # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
281 # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
282 # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
283 # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
284 # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
285 # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
286 #
287 # The code in logs/storage/validator/logs_validator_traits.cc treats this type
288 # as if it were annotated as ST_LOCATION.
289 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
290 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
291 },
292 "locality": "A String", # Generally refers to the city/town portion of an address.
293 "regionCode": "A String", # CLDR (Common Locale Data Repository) region code .
294 "administrativeArea": "A String", # Top-level administrative subdivision of this country.
295 "address": "A String", # The single string version of the address.
296 "postalCode": "A String", # Values are frequently alphanumeric.
297 },
298 "additionalWebsites": [ # URL of the company's additional websites used to verify the dynamic badges.
299 # These are stored as full URLs as entered by the user, but only the TLD will
300 # be used for the actual verification.
301 "A String",
302 ],
303 "profileStatus": "A String", # The public viewability status of the company's profile.
304 "ranks": [ # Information related to the ranking of the company within the list of
305 # companies.
306 { # Information related to ranking of results.
307 "type": "A String", # The type of rank.
308 "value": 3.14, # The numerical value of the rank.
309 },
310 ],
311 "primaryAdwordsManagerAccountId": "A String", # The Primary AdWords Manager Account id.
312 "services": [ # Services the company can help with.
313 "A String",
314 ],
315 "certificationStatuses": [ # The list of Google Partners certification statuses for the company.
316 { # Google Partners certification status.
317 "type": "A String", # The type of the certification.
318 "examStatuses": [ # List of certification exam statuses.
319 { # Status for a Google Partners certification exam.
320 "numberUsersPass": 42, # The number of people who have passed the certification exam.
321 "type": "A String", # The type of certification exam.
322 },
323 ],
324 "isCertified": True or False, # Whether certification is passing.
325 "userCount": 42, # Number of people who are certified,
326 },
327 ],
328 "companyTypes": [ # Company type labels listed on the company's profile.
329 "A String",
330 ],
331 "publicProfile": { # Basic information from a public profile. # Basic information from the company's public profile.
332 "url": "A String", # The URL of the public profile.
333 "profileImage": "A String", # The URL to the main profile image of the public profile.
334 "displayImageUrl": "A String", # The URL to the main display image of the public profile. Being deprecated.
335 "displayName": "A String", # The display name of the public profile.
336 "id": "A String", # The ID which can be used to retrieve more details about the public profile.
337 },
338 "convertedMinMonthlyBudget": { # Represents an amount of money with its currency type. # The minimum monthly budget that the company accepts for partner business,
339 # converted to the requested currency code.
340 "units": "A String", # The whole units of the amount.
341 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
342 "nanos": 42, # Number of nano (10^-9) units of the amount.
343 # The value must be between -999,999,999 and +999,999,999 inclusive.
344 # If `units` is positive, `nanos` must be positive or zero.
345 # If `units` is zero, `nanos` can be positive, zero, or negative.
346 # If `units` is negative, `nanos` must be negative or zero.
347 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
348 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
349 },
350 "id": "A String", # The ID of the company.
351 "primaryLanguageCode": "A String", # The primary language code of the company, as defined by
352 # <a href="https://tools.ietf.org/html/bcp47">BCP 47</a>
353 # (IETF BCP 47, "Tags for Identifying Languages").
354 "specializationStatus": [ # The list of Google Partners specialization statuses for the company.
355 { # Agency specialization status
356 "badgeSpecialization": "A String", # The specialization this status is for.
357 "badgeSpecializationState": "A String", # State of agency specialization.
358 },
359 ],
360}
361
362 requestMetadata_userOverrides_ipAddress: string, IP address to use instead of the user's geo-located IP address.
363 requestMetadata_trafficSource_trafficSubId: string, Second level identifier to indicate where the traffic comes from.
364An identifier has multiple letters created by a team which redirected the
365traffic to us.
366 requestMetadata_userOverrides_userId: string, Logged-in user ID to impersonate instead of the user's ID.
367 x__xgafv: string, V1 error format.
368 Allowed values
369 1 - v1 error format
370 2 - v2 error format
371 requestMetadata_locale: string, Locale to use for the current request.
372 requestMetadata_experimentIds: string, Experiment IDs the current request belongs to. (repeated)
373 requestMetadata_trafficSource_trafficSourceId: string, Identifier to indicate where the traffic comes from.
374An identifier has multiple letters created by a team which redirected the
375traffic to us.
376 updateMask: string, Standard field mask for the set of fields to be updated.
377Required with at least 1 value in FieldMask's paths.
378 requestMetadata_partnersSessionId: string, Google Partners session ID.
379
380Returns:
381 An object of the form:
382
383 { # A company resource in the Google Partners API. Once certified, it qualifies
384 # for being searched by advertisers.
385 "industries": [ # Industries the company can help with.
386 "A String",
387 ],
388 "originalMinMonthlyBudget": { # Represents an amount of money with its currency type. # The unconverted minimum monthly budget that the company accepts for partner
389 # business.
390 "units": "A String", # The whole units of the amount.
391 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
392 "nanos": 42, # Number of nano (10^-9) units of the amount.
393 # The value must be between -999,999,999 and +999,999,999 inclusive.
394 # If `units` is positive, `nanos` must be positive or zero.
395 # If `units` is zero, `nanos` can be positive, zero, or negative.
396 # If `units` is negative, `nanos` must be negative or zero.
397 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
398 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
399 },
400 "autoApprovalEmailDomains": [ # Email domains that allow users with a matching email address to get
401 # auto-approved for associating with this company.
402 "A String",
403 ],
404 "name": "A String", # The name of the company.
405 "badgeTier": "A String", # Partner badge tier
406 "localizedInfos": [ # The list of localized info for the company.
407 { # The localized company information.
408 "countryCodes": [ # List of country codes for the localized company info.
409 "A String",
410 ],
411 "overview": "A String", # Localized brief description that the company uses to advertise themselves.
412 "displayName": "A String", # Localized display name.
413 "languageCode": "A String", # Language code of the localized company info, as defined by
414 # <a href="https://tools.ietf.org/html/bcp47">BCP 47</a>
415 # (IETF BCP 47, "Tags for Identifying Languages").
416 },
417 ],
418 "locations": [ # The list of all company locations.
419 # If set, must include the
420 # primary_location
421 # in the list.
422 { # A location with address and geographic coordinates. May optionally contain a
423 # detailed (multi-field) version of the address.
424 "languageCode": "A String", # Language code of the address. Should be in BCP 47 format.
425 "addressLine": [ # The following address lines represent the most specific part of any
426 # address.
427 "A String",
428 ],
429 "dependentLocality": "A String", # Dependent locality or sublocality. Used for UK dependent localities, or
430 # neighborhoods or boroughs in other locations.
431 "sortingCode": "A String", # Use of this code is very country-specific, but will refer to a secondary
432 # classification code for sorting mail.
433 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # The latitude and longitude of the location, in degrees.
434 # of doubles representing degrees latitude and degrees longitude. Unless
435 # specified otherwise, this must conform to the
436 # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
437 # standard</a>. Values must be within normalized ranges.
438 #
439 # Example of normalization code in Python:
440 #
441 # def NormalizeLongitude(longitude):
442 # """Wraps decimal degrees longitude to [-180.0, 180.0]."""
443 # q, r = divmod(longitude, 360.0)
444 # if r > 180.0 or (r == 180.0 and q <= -1.0):
445 # return r - 360.0
446 # return r
447 #
448 # def NormalizeLatLng(latitude, longitude):
449 # """Wraps decimal degrees latitude and longitude to
450 # [-90.0, 90.0] and [-180.0, 180.0], respectively."""
451 # r = latitude % 360.0
452 # if r <= 90.0:
453 # return r, NormalizeLongitude(longitude)
454 # elif r >= 270.0:
455 # return r - 360, NormalizeLongitude(longitude)
456 # else:
457 # return 180 - r, NormalizeLongitude(longitude + 180.0)
458 #
459 # assert 180.0 == NormalizeLongitude(180.0)
460 # assert -180.0 == NormalizeLongitude(-180.0)
461 # assert -179.0 == NormalizeLongitude(181.0)
462 # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
463 # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
464 # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
465 # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
466 # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
467 # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
468 # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
469 # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
470 # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
471 # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
472 #
473 # The code in logs/storage/validator/logs_validator_traits.cc treats this type
474 # as if it were annotated as ST_LOCATION.
475 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
476 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
477 },
478 "locality": "A String", # Generally refers to the city/town portion of an address.
479 "regionCode": "A String", # CLDR (Common Locale Data Repository) region code .
480 "administrativeArea": "A String", # Top-level administrative subdivision of this country.
481 "address": "A String", # The single string version of the address.
482 "postalCode": "A String", # Values are frequently alphanumeric.
483 },
484 ],
485 "websiteUrl": "A String", # URL of the company's website.
486 "primaryLocation": { # A location with address and geographic coordinates. May optionally contain a # The primary location of the company.
487 # detailed (multi-field) version of the address.
488 "languageCode": "A String", # Language code of the address. Should be in BCP 47 format.
489 "addressLine": [ # The following address lines represent the most specific part of any
490 # address.
491 "A String",
492 ],
493 "dependentLocality": "A String", # Dependent locality or sublocality. Used for UK dependent localities, or
494 # neighborhoods or boroughs in other locations.
495 "sortingCode": "A String", # Use of this code is very country-specific, but will refer to a secondary
496 # classification code for sorting mail.
497 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # The latitude and longitude of the location, in degrees.
498 # of doubles representing degrees latitude and degrees longitude. Unless
499 # specified otherwise, this must conform to the
500 # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
501 # standard</a>. Values must be within normalized ranges.
502 #
503 # Example of normalization code in Python:
504 #
505 # def NormalizeLongitude(longitude):
506 # """Wraps decimal degrees longitude to [-180.0, 180.0]."""
507 # q, r = divmod(longitude, 360.0)
508 # if r > 180.0 or (r == 180.0 and q <= -1.0):
509 # return r - 360.0
510 # return r
511 #
512 # def NormalizeLatLng(latitude, longitude):
513 # """Wraps decimal degrees latitude and longitude to
514 # [-90.0, 90.0] and [-180.0, 180.0], respectively."""
515 # r = latitude % 360.0
516 # if r <= 90.0:
517 # return r, NormalizeLongitude(longitude)
518 # elif r >= 270.0:
519 # return r - 360, NormalizeLongitude(longitude)
520 # else:
521 # return 180 - r, NormalizeLongitude(longitude + 180.0)
522 #
523 # assert 180.0 == NormalizeLongitude(180.0)
524 # assert -180.0 == NormalizeLongitude(-180.0)
525 # assert -179.0 == NormalizeLongitude(181.0)
526 # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
527 # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
528 # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
529 # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
530 # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
531 # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
532 # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
533 # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
534 # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
535 # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
536 #
537 # The code in logs/storage/validator/logs_validator_traits.cc treats this type
538 # as if it were annotated as ST_LOCATION.
539 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
540 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
541 },
542 "locality": "A String", # Generally refers to the city/town portion of an address.
543 "regionCode": "A String", # CLDR (Common Locale Data Repository) region code .
544 "administrativeArea": "A String", # Top-level administrative subdivision of this country.
545 "address": "A String", # The single string version of the address.
546 "postalCode": "A String", # Values are frequently alphanumeric.
547 },
548 "additionalWebsites": [ # URL of the company's additional websites used to verify the dynamic badges.
549 # These are stored as full URLs as entered by the user, but only the TLD will
550 # be used for the actual verification.
551 "A String",
552 ],
553 "profileStatus": "A String", # The public viewability status of the company's profile.
554 "ranks": [ # Information related to the ranking of the company within the list of
555 # companies.
556 { # Information related to ranking of results.
557 "type": "A String", # The type of rank.
558 "value": 3.14, # The numerical value of the rank.
559 },
560 ],
561 "primaryAdwordsManagerAccountId": "A String", # The Primary AdWords Manager Account id.
562 "services": [ # Services the company can help with.
563 "A String",
564 ],
565 "certificationStatuses": [ # The list of Google Partners certification statuses for the company.
566 { # Google Partners certification status.
567 "type": "A String", # The type of the certification.
568 "examStatuses": [ # List of certification exam statuses.
569 { # Status for a Google Partners certification exam.
570 "numberUsersPass": 42, # The number of people who have passed the certification exam.
571 "type": "A String", # The type of certification exam.
572 },
573 ],
574 "isCertified": True or False, # Whether certification is passing.
575 "userCount": 42, # Number of people who are certified,
576 },
577 ],
578 "companyTypes": [ # Company type labels listed on the company's profile.
579 "A String",
580 ],
581 "publicProfile": { # Basic information from a public profile. # Basic information from the company's public profile.
582 "url": "A String", # The URL of the public profile.
583 "profileImage": "A String", # The URL to the main profile image of the public profile.
584 "displayImageUrl": "A String", # The URL to the main display image of the public profile. Being deprecated.
585 "displayName": "A String", # The display name of the public profile.
586 "id": "A String", # The ID which can be used to retrieve more details about the public profile.
587 },
588 "convertedMinMonthlyBudget": { # Represents an amount of money with its currency type. # The minimum monthly budget that the company accepts for partner business,
589 # converted to the requested currency code.
590 "units": "A String", # The whole units of the amount.
591 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
592 "nanos": 42, # Number of nano (10^-9) units of the amount.
593 # The value must be between -999,999,999 and +999,999,999 inclusive.
594 # If `units` is positive, `nanos` must be positive or zero.
595 # If `units` is zero, `nanos` can be positive, zero, or negative.
596 # If `units` is negative, `nanos` must be negative or zero.
597 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
598 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
599 },
600 "id": "A String", # The ID of the company.
601 "primaryLanguageCode": "A String", # The primary language code of the company, as defined by
602 # <a href="https://tools.ietf.org/html/bcp47">BCP 47</a>
603 # (IETF BCP 47, "Tags for Identifying Languages").
604 "specializationStatus": [ # The list of Google Partners specialization statuses for the company.
605 { # Agency specialization status
606 "badgeSpecialization": "A String", # The specialization this status is for.
607 "badgeSpecializationState": "A String", # State of agency specialization.
608 },
609 ],
610 }</pre>
611</div>
612
613<div class="method">
614 <code class="details" id="updateLeads">updateLeads(body, requestMetadata_userOverrides_ipAddress=None, requestMetadata_trafficSource_trafficSubId=None, requestMetadata_userOverrides_userId=None, x__xgafv=None, requestMetadata_locale=None, requestMetadata_experimentIds=None, requestMetadata_trafficSource_trafficSourceId=None, updateMask=None, requestMetadata_partnersSessionId=None)</code>
615 <pre>Updates the specified lead.
616
617Args:
618 body: object, The request body. (required)
619 The object takes the form of:
620
621{ # A lead resource that represents an advertiser contact for a `Company`. These
622 # are usually generated via Google Partner Search (the advertiser portal).
623 "marketingOptIn": True or False, # Whether or not the lead signed up for marketing emails
624 "languageCode": "A String", # Language code of the lead's language preference, as defined by
625 # <a href="https://tools.ietf.org/html/bcp47">BCP 47</a>
626 # (IETF BCP 47, "Tags for Identifying Languages").
627 "type": "A String", # Type of lead.
628 "familyName": "A String", # Last name of lead source.
629 "minMonthlyBudget": { # Represents an amount of money with its currency type. # The minimum monthly budget lead source is willing to spend.
630 "units": "A String", # The whole units of the amount.
631 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
632 "nanos": 42, # Number of nano (10^-9) units of the amount.
633 # The value must be between -999,999,999 and +999,999,999 inclusive.
634 # If `units` is positive, `nanos` must be positive or zero.
635 # If `units` is zero, `nanos` can be positive, zero, or negative.
636 # If `units` is negative, `nanos` must be negative or zero.
637 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
638 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
639 },
640 "comments": "A String", # Comments lead source gave.
641 "email": "A String", # Email address of lead source.
642 "websiteUrl": "A String", # Website URL of lead source.
643 "state": "A String", # The lead's state in relation to the company.
644 "phoneNumber": "A String", # Phone number of lead source.
645 "gpsMotivations": [ # List of reasons for using Google Partner Search and creating a lead.
646 "A String",
647 ],
648 "id": "A String", # ID of the lead.
649 "givenName": "A String", # First name of lead source.
650 "adwordsCustomerId": "A String", # The AdWords Customer ID of the lead.
651 "createTime": "A String", # Timestamp of when this lead was created.
652}
653
654 requestMetadata_userOverrides_ipAddress: string, IP address to use instead of the user's geo-located IP address.
655 requestMetadata_trafficSource_trafficSubId: string, Second level identifier to indicate where the traffic comes from.
656An identifier has multiple letters created by a team which redirected the
657traffic to us.
658 requestMetadata_userOverrides_userId: string, Logged-in user ID to impersonate instead of the user's ID.
659 x__xgafv: string, V1 error format.
660 Allowed values
661 1 - v1 error format
662 2 - v2 error format
663 requestMetadata_locale: string, Locale to use for the current request.
664 requestMetadata_experimentIds: string, Experiment IDs the current request belongs to. (repeated)
665 requestMetadata_trafficSource_trafficSourceId: string, Identifier to indicate where the traffic comes from.
666An identifier has multiple letters created by a team which redirected the
667traffic to us.
668 updateMask: string, Standard field mask for the set of fields to be updated.
669Required with at least 1 value in FieldMask's paths.
670Only `state` and `adwords_customer_id` are currently supported.
671 requestMetadata_partnersSessionId: string, Google Partners session ID.
672
673Returns:
674 An object of the form:
675
676 { # A lead resource that represents an advertiser contact for a `Company`. These
677 # are usually generated via Google Partner Search (the advertiser portal).
678 "marketingOptIn": True or False, # Whether or not the lead signed up for marketing emails
679 "languageCode": "A String", # Language code of the lead's language preference, as defined by
680 # <a href="https://tools.ietf.org/html/bcp47">BCP 47</a>
681 # (IETF BCP 47, "Tags for Identifying Languages").
682 "type": "A String", # Type of lead.
683 "familyName": "A String", # Last name of lead source.
684 "minMonthlyBudget": { # Represents an amount of money with its currency type. # The minimum monthly budget lead source is willing to spend.
685 "units": "A String", # The whole units of the amount.
686 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
687 "nanos": 42, # Number of nano (10^-9) units of the amount.
688 # The value must be between -999,999,999 and +999,999,999 inclusive.
689 # If `units` is positive, `nanos` must be positive or zero.
690 # If `units` is zero, `nanos` can be positive, zero, or negative.
691 # If `units` is negative, `nanos` must be negative or zero.
692 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
693 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
694 },
695 "comments": "A String", # Comments lead source gave.
696 "email": "A String", # Email address of lead source.
697 "websiteUrl": "A String", # Website URL of lead source.
698 "state": "A String", # The lead's state in relation to the company.
699 "phoneNumber": "A String", # Phone number of lead source.
700 "gpsMotivations": [ # List of reasons for using Google Partner Search and creating a lead.
701 "A String",
702 ],
703 "id": "A String", # ID of the lead.
704 "givenName": "A String", # First name of lead source.
705 "adwordsCustomerId": "A String", # The AdWords Customer ID of the lead.
706 "createTime": "A String", # Timestamp of when this lead was created.
707 }</pre>
708</div>
709
710</body></html>