Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / e833b79ffee531ae64e11175718bb2fffc504950 / . / docs / dyn / partners_v2.v2.html
blob: 22270a4e1fe2559b202d2edcf863125dd1fb366a [file] [log] [blame]
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[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.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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]140 "nanos": 42, # Number of nano (10^-9) units of the amount.
141 # The value must be between -999,999,999 and +999,999,999 inclusive.
142 # If `units` is positive, `nanos` must be positive or zero.
143 # If `units` is zero, `nanos` can be positive, zero, or negative.
144 # If `units` is negative, `nanos` must be negative or zero.
145 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]146 "units": "A String", # The whole units of the amount.
147 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]148 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
149 },
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]150 "publicProfile": { # Basic information from a public profile. # Basic information from the company's public profile.
151 "url": "A String", # The URL of the public profile.
152 "profileImage": "A String", # The URL to the main profile image of the public profile.
153 "displayImageUrl": "A String", # The URL to the main display image of the public profile. Being deprecated.
154 "displayName": "A String", # The display name of the public profile.
155 "id": "A String", # The ID which can be used to retrieve more details about the public profile.
156 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]157 "name": "A String", # The name of the company.
158 "badgeTier": "A String", # Partner badge tier
159 "localizedInfos": [ # The list of localized info for the company.
160 { # The localized company information.
161 "countryCodes": [ # List of country codes for the localized company info.
162 "A String",
163 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]164 "languageCode": "A String", # Language code of the localized company info, as defined by
165 # <a href="https://tools.ietf.org/html/bcp47">BCP 47</a>
166 # (IETF BCP 47, "Tags for Identifying Languages").
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]167 "displayName": "A String", # Localized display name.
168 "overview": "A String", # Localized brief description that the company uses to advertise themselves.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]169 },
170 ],
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]171 "autoApprovalEmailDomains": [ # Email domains that allow users with a matching email address to get
172 # auto-approved for associating with this company.
173 "A String",
174 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]175 "locations": [ # The list of all company locations.
176 # If set, must include the
177 # primary_location
178 # in the list.
179 { # A location with address and geographic coordinates. May optionally contain a
180 # detailed (multi-field) version of the address.
181 "languageCode": "A String", # Language code of the address. Should be in BCP 47 format.
182 "addressLine": [ # The following address lines represent the most specific part of any
183 # address.
184 "A String",
185 ],
186 "dependentLocality": "A String", # Dependent locality or sublocality. Used for UK dependent localities, or
187 # neighborhoods or boroughs in other locations.
188 "sortingCode": "A String", # Use of this code is very country-specific, but will refer to a secondary
189 # classification code for sorting mail.
190 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # The latitude and longitude of the location, in degrees.
191 # of doubles representing degrees latitude and degrees longitude. Unless
192 # specified otherwise, this must conform to the
193 # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
194 # standard</a>. Values must be within normalized ranges.
195 #
196 # Example of normalization code in Python:
197 #
198 # def NormalizeLongitude(longitude):
199 # """Wraps decimal degrees longitude to [-180.0, 180.0]."""
200 # q, r = divmod(longitude, 360.0)
201 # if r > 180.0 or (r == 180.0 and q <= -1.0):
202 # return r - 360.0
203 # return r
204 #
205 # def NormalizeLatLng(latitude, longitude):
206 # """Wraps decimal degrees latitude and longitude to
207 # [-90.0, 90.0] and [-180.0, 180.0], respectively."""
208 # r = latitude % 360.0
209 # if r <= 90.0:
210 # return r, NormalizeLongitude(longitude)
211 # elif r >= 270.0:
212 # return r - 360, NormalizeLongitude(longitude)
213 # else:
214 # return 180 - r, NormalizeLongitude(longitude + 180.0)
215 #
216 # assert 180.0 == NormalizeLongitude(180.0)
217 # assert -180.0 == NormalizeLongitude(-180.0)
218 # assert -179.0 == NormalizeLongitude(181.0)
219 # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
220 # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
221 # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
222 # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
223 # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
224 # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
225 # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
226 # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
227 # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
228 # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
229 #
230 # The code in logs/storage/validator/logs_validator_traits.cc treats this type
231 # as if it were annotated as ST_LOCATION.
232 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
233 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
234 },
235 "locality": "A String", # Generally refers to the city/town portion of an address.
236 "regionCode": "A String", # CLDR (Common Locale Data Repository) region code .
237 "administrativeArea": "A String", # Top-level administrative subdivision of this country.
238 "address": "A String", # The single string version of the address.
239 "postalCode": "A String", # Values are frequently alphanumeric.
240 },
241 ],
242 "websiteUrl": "A String", # URL of the company's website.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]243 "services": [ # Services the company can help with.
244 "A String",
245 ],
246 "additionalWebsites": [ # URL of the company's additional websites used to verify the dynamic badges.
247 # These are stored as full URLs as entered by the user, but only the TLD will
248 # be used for the actual verification.
249 "A String",
250 ],
251 "profileStatus": "A String", # The public viewability status of the company's profile.
252 "ranks": [ # Information related to the ranking of the company within the list of
253 # companies.
254 { # Information related to ranking of results.
255 "type": "A String", # The type of rank.
256 "value": 3.14, # The numerical value of the rank.
257 },
258 ],
259 "primaryAdwordsManagerAccountId": "A String", # The Primary AdWords Manager Account id.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]260 "primaryLocation": { # A location with address and geographic coordinates. May optionally contain a # The primary location of the company.
261 # detailed (multi-field) version of the address.
262 "languageCode": "A String", # Language code of the address. Should be in BCP 47 format.
263 "addressLine": [ # The following address lines represent the most specific part of any
264 # address.
265 "A String",
266 ],
267 "dependentLocality": "A String", # Dependent locality or sublocality. Used for UK dependent localities, or
268 # neighborhoods or boroughs in other locations.
269 "sortingCode": "A String", # Use of this code is very country-specific, but will refer to a secondary
270 # classification code for sorting mail.
271 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # The latitude and longitude of the location, in degrees.
272 # of doubles representing degrees latitude and degrees longitude. Unless
273 # specified otherwise, this must conform to the
274 # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
275 # standard</a>. Values must be within normalized ranges.
276 #
277 # Example of normalization code in Python:
278 #
279 # def NormalizeLongitude(longitude):
280 # """Wraps decimal degrees longitude to [-180.0, 180.0]."""
281 # q, r = divmod(longitude, 360.0)
282 # if r > 180.0 or (r == 180.0 and q <= -1.0):
283 # return r - 360.0
284 # return r
285 #
286 # def NormalizeLatLng(latitude, longitude):
287 # """Wraps decimal degrees latitude and longitude to
288 # [-90.0, 90.0] and [-180.0, 180.0], respectively."""
289 # r = latitude % 360.0
290 # if r <= 90.0:
291 # return r, NormalizeLongitude(longitude)
292 # elif r >= 270.0:
293 # return r - 360, NormalizeLongitude(longitude)
294 # else:
295 # return 180 - r, NormalizeLongitude(longitude + 180.0)
296 #
297 # assert 180.0 == NormalizeLongitude(180.0)
298 # assert -180.0 == NormalizeLongitude(-180.0)
299 # assert -179.0 == NormalizeLongitude(181.0)
300 # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
301 # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
302 # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
303 # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
304 # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
305 # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
306 # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
307 # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
308 # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
309 # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
310 #
311 # The code in logs/storage/validator/logs_validator_traits.cc treats this type
312 # as if it were annotated as ST_LOCATION.
313 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
314 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
315 },
316 "locality": "A String", # Generally refers to the city/town portion of an address.
317 "regionCode": "A String", # CLDR (Common Locale Data Repository) region code .
318 "administrativeArea": "A String", # Top-level administrative subdivision of this country.
319 "address": "A String", # The single string version of the address.
320 "postalCode": "A String", # Values are frequently alphanumeric.
321 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]322 "certificationStatuses": [ # The list of Google Partners certification statuses for the company.
323 { # Google Partners certification status.
324 "type": "A String", # The type of the certification.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]325 "userCount": 42, # Number of people who are certified,
326 "isCertified": True or False, # Whether certification is passing.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]327 "examStatuses": [ # List of certification exam statuses.
328 { # Status for a Google Partners certification exam.
329 "numberUsersPass": 42, # The number of people who have passed the certification exam.
330 "type": "A String", # The type of certification exam.
331 },
332 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]333 },
334 ],
335 "companyTypes": [ # Company type labels listed on the company's profile.
336 "A String",
337 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]340 "nanos": 42, # Number of nano (10^-9) units of the amount.
341 # The value must be between -999,999,999 and +999,999,999 inclusive.
342 # If `units` is positive, `nanos` must be positive or zero.
343 # If `units` is zero, `nanos` can be positive, zero, or negative.
344 # If `units` is negative, `nanos` must be negative or zero.
345 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]346 "units": "A String", # The whole units of the amount.
347 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]390 "nanos": 42, # Number of nano (10^-9) units of the amount.
391 # The value must be between -999,999,999 and +999,999,999 inclusive.
392 # If `units` is positive, `nanos` must be positive or zero.
393 # If `units` is zero, `nanos` can be positive, zero, or negative.
394 # If `units` is negative, `nanos` must be negative or zero.
395 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]396 "units": "A String", # The whole units of the amount.
397 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]398 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
399 },
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]400 "publicProfile": { # Basic information from a public profile. # Basic information from the company's public profile.
401 "url": "A String", # The URL of the public profile.
402 "profileImage": "A String", # The URL to the main profile image of the public profile.
403 "displayImageUrl": "A String", # The URL to the main display image of the public profile. Being deprecated.
404 "displayName": "A String", # The display name of the public profile.
405 "id": "A String", # The ID which can be used to retrieve more details about the public profile.
406 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]407 "name": "A String", # The name of the company.
408 "badgeTier": "A String", # Partner badge tier
409 "localizedInfos": [ # The list of localized info for the company.
410 { # The localized company information.
411 "countryCodes": [ # List of country codes for the localized company info.
412 "A String",
413 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]414 "languageCode": "A String", # Language code of the localized company info, as defined by
415 # <a href="https://tools.ietf.org/html/bcp47">BCP 47</a>
416 # (IETF BCP 47, "Tags for Identifying Languages").
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]417 "displayName": "A String", # Localized display name.
418 "overview": "A String", # Localized brief description that the company uses to advertise themselves.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]419 },
420 ],
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]421 "autoApprovalEmailDomains": [ # Email domains that allow users with a matching email address to get
422 # auto-approved for associating with this company.
423 "A String",
424 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]425 "locations": [ # The list of all company locations.
426 # If set, must include the
427 # primary_location
428 # in the list.
429 { # A location with address and geographic coordinates. May optionally contain a
430 # detailed (multi-field) version of the address.
431 "languageCode": "A String", # Language code of the address. Should be in BCP 47 format.
432 "addressLine": [ # The following address lines represent the most specific part of any
433 # address.
434 "A String",
435 ],
436 "dependentLocality": "A String", # Dependent locality or sublocality. Used for UK dependent localities, or
437 # neighborhoods or boroughs in other locations.
438 "sortingCode": "A String", # Use of this code is very country-specific, but will refer to a secondary
439 # classification code for sorting mail.
440 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # The latitude and longitude of the location, in degrees.
441 # of doubles representing degrees latitude and degrees longitude. Unless
442 # specified otherwise, this must conform to the
443 # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
444 # standard</a>. Values must be within normalized ranges.
445 #
446 # Example of normalization code in Python:
447 #
448 # def NormalizeLongitude(longitude):
449 # """Wraps decimal degrees longitude to [-180.0, 180.0]."""
450 # q, r = divmod(longitude, 360.0)
451 # if r > 180.0 or (r == 180.0 and q <= -1.0):
452 # return r - 360.0
453 # return r
454 #
455 # def NormalizeLatLng(latitude, longitude):
456 # """Wraps decimal degrees latitude and longitude to
457 # [-90.0, 90.0] and [-180.0, 180.0], respectively."""
458 # r = latitude % 360.0
459 # if r <= 90.0:
460 # return r, NormalizeLongitude(longitude)
461 # elif r >= 270.0:
462 # return r - 360, NormalizeLongitude(longitude)
463 # else:
464 # return 180 - r, NormalizeLongitude(longitude + 180.0)
465 #
466 # assert 180.0 == NormalizeLongitude(180.0)
467 # assert -180.0 == NormalizeLongitude(-180.0)
468 # assert -179.0 == NormalizeLongitude(181.0)
469 # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
470 # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
471 # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
472 # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
473 # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
474 # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
475 # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
476 # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
477 # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
478 # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
479 #
480 # The code in logs/storage/validator/logs_validator_traits.cc treats this type
481 # as if it were annotated as ST_LOCATION.
482 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
483 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
484 },
485 "locality": "A String", # Generally refers to the city/town portion of an address.
486 "regionCode": "A String", # CLDR (Common Locale Data Repository) region code .
487 "administrativeArea": "A String", # Top-level administrative subdivision of this country.
488 "address": "A String", # The single string version of the address.
489 "postalCode": "A String", # Values are frequently alphanumeric.
490 },
491 ],
492 "websiteUrl": "A String", # URL of the company's website.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]493 "services": [ # Services the company can help with.
494 "A String",
495 ],
496 "additionalWebsites": [ # URL of the company's additional websites used to verify the dynamic badges.
497 # These are stored as full URLs as entered by the user, but only the TLD will
498 # be used for the actual verification.
499 "A String",
500 ],
501 "profileStatus": "A String", # The public viewability status of the company's profile.
502 "ranks": [ # Information related to the ranking of the company within the list of
503 # companies.
504 { # Information related to ranking of results.
505 "type": "A String", # The type of rank.
506 "value": 3.14, # The numerical value of the rank.
507 },
508 ],
509 "primaryAdwordsManagerAccountId": "A String", # The Primary AdWords Manager Account id.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]510 "primaryLocation": { # A location with address and geographic coordinates. May optionally contain a # The primary location of the company.
511 # detailed (multi-field) version of the address.
512 "languageCode": "A String", # Language code of the address. Should be in BCP 47 format.
513 "addressLine": [ # The following address lines represent the most specific part of any
514 # address.
515 "A String",
516 ],
517 "dependentLocality": "A String", # Dependent locality or sublocality. Used for UK dependent localities, or
518 # neighborhoods or boroughs in other locations.
519 "sortingCode": "A String", # Use of this code is very country-specific, but will refer to a secondary
520 # classification code for sorting mail.
521 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # The latitude and longitude of the location, in degrees.
522 # of doubles representing degrees latitude and degrees longitude. Unless
523 # specified otherwise, this must conform to the
524 # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
525 # standard</a>. Values must be within normalized ranges.
526 #
527 # Example of normalization code in Python:
528 #
529 # def NormalizeLongitude(longitude):
530 # """Wraps decimal degrees longitude to [-180.0, 180.0]."""
531 # q, r = divmod(longitude, 360.0)
532 # if r > 180.0 or (r == 180.0 and q <= -1.0):
533 # return r - 360.0
534 # return r
535 #
536 # def NormalizeLatLng(latitude, longitude):
537 # """Wraps decimal degrees latitude and longitude to
538 # [-90.0, 90.0] and [-180.0, 180.0], respectively."""
539 # r = latitude % 360.0
540 # if r <= 90.0:
541 # return r, NormalizeLongitude(longitude)
542 # elif r >= 270.0:
543 # return r - 360, NormalizeLongitude(longitude)
544 # else:
545 # return 180 - r, NormalizeLongitude(longitude + 180.0)
546 #
547 # assert 180.0 == NormalizeLongitude(180.0)
548 # assert -180.0 == NormalizeLongitude(-180.0)
549 # assert -179.0 == NormalizeLongitude(181.0)
550 # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
551 # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
552 # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
553 # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
554 # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
555 # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
556 # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
557 # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
558 # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
559 # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
560 #
561 # The code in logs/storage/validator/logs_validator_traits.cc treats this type
562 # as if it were annotated as ST_LOCATION.
563 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
564 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
565 },
566 "locality": "A String", # Generally refers to the city/town portion of an address.
567 "regionCode": "A String", # CLDR (Common Locale Data Repository) region code .
568 "administrativeArea": "A String", # Top-level administrative subdivision of this country.
569 "address": "A String", # The single string version of the address.
570 "postalCode": "A String", # Values are frequently alphanumeric.
571 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]572 "certificationStatuses": [ # The list of Google Partners certification statuses for the company.
573 { # Google Partners certification status.
574 "type": "A String", # The type of the certification.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]575 "userCount": 42, # Number of people who are certified,
576 "isCertified": True or False, # Whether certification is passing.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]577 "examStatuses": [ # List of certification exam statuses.
578 { # Status for a Google Partners certification exam.
579 "numberUsersPass": 42, # The number of people who have passed the certification exam.
580 "type": "A String", # The type of certification exam.
581 },
582 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]583 },
584 ],
585 "companyTypes": [ # Company type labels listed on the company's profile.
586 "A String",
587 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]590 "nanos": 42, # Number of nano (10^-9) units of the amount.
591 # The value must be between -999,999,999 and +999,999,999 inclusive.
592 # If `units` is positive, `nanos` must be positive or zero.
593 # If `units` is zero, `nanos` can be positive, zero, or negative.
594 # If `units` is negative, `nanos` must be negative or zero.
595 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]596 "units": "A String", # The whole units of the amount.
597 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]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").
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]627 "gpsMotivations": [ # List of reasons for using Google Partner Search and creating a lead.
628 "A String",
629 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]630 "familyName": "A String", # Last name of lead source.
631 "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]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.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]638 "units": "A String", # The whole units of the amount.
639 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]640 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
641 },
642 "comments": "A String", # Comments lead source gave.
643 "email": "A String", # Email address of lead source.
644 "websiteUrl": "A String", # Website URL of lead source.
645 "state": "A String", # The lead's state in relation to the company.
646 "phoneNumber": "A String", # Phone number of lead source.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]647 "adwordsCustomerId": "A String", # The AdWords Customer ID of the lead.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]648 "id": "A String", # ID of the lead.
649 "givenName": "A String", # First name of lead source.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]650 "type": "A String", # Type of lead.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]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").
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]682 "gpsMotivations": [ # List of reasons for using Google Partner Search and creating a lead.
683 "A String",
684 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]685 "familyName": "A String", # Last name of lead source.
686 "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]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.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]693 "units": "A String", # The whole units of the amount.
694 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]695 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
696 },
697 "comments": "A String", # Comments lead source gave.
698 "email": "A String", # Email address of lead source.
699 "websiteUrl": "A String", # Website URL of lead source.
700 "state": "A String", # The lead's state in relation to the company.
701 "phoneNumber": "A String", # Phone number of lead source.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]702 "adwordsCustomerId": "A String", # The AdWords Customer ID of the lead.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]703 "id": "A String", # ID of the lead.
704 "givenName": "A String", # First name of lead source.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]705 "type": "A String", # Type of lead.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]706 "createTime": "A String", # Timestamp of when this lead was created.
707 }</pre>
708</div>
709
710</body></html>