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