blob: 9a1cbfbc79114a41b1ce8c2230d8c225b2e3023d [file] [log] [blame]
Takashi Matsuo06694102015-09-11 13:55:40 -07001<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 -040086 <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 -070087<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 -040098 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 -0700102 requestMetadata_userOverrides_ipAddress: string, IP address to use instead of the user's geo-located IP address.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400103 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 -0700106 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 -0400108 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 -0700116 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 -0400118 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 -0700121 requestMetadata_partnersSessionId: string, Google Partners session ID.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400122 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 -0700124
125Returns:
126 An object of the form:
127
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800128 { # Response message for GetCompany.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400129 "company": { # A company resource in the Google Partners API. Once certified, it qualifies # The company.
130 # for being searched by advertisers.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400131 "companyTypes": [ # Company type labels listed on the company's profile.
Takashi Matsuo06694102015-09-11 13:55:40 -0700132 "A String",
133 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400134 "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 -0400136 "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 -0700142 "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 -0700144 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
145 },
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700146 "autoApprovalEmailDomains": [ # Email domains that allow users with a matching email address to get
147 # auto-approved for associating with this company.
148 "A String",
149 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400150 "specializationStatus": [ # The list of Google Partners specialization statuses for the company.
151 { # Agency specialization status
152 "badgeSpecialization": "A String", # The specialization this status is for.
153 "badgeSpecializationState": "A String", # State of agency specialization.
154 },
155 ],
156 "ranks": [ # Information related to the ranking of the company within the list of
157 # companies.
158 { # Information related to ranking of results.
159 "type": "A String", # The type of rank.
160 "value": 3.14, # The numerical value of the rank.
161 },
162 ],
163 "primaryAdwordsManagerAccountId": "A String", # The Primary AdWords Manager Account id.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400164 "locations": [ # The list of all company locations.
165 # If set, must include the
166 # primary_location
167 # in the list.
168 { # A location with address and geographic coordinates. May optionally contain a
169 # detailed (multi-field) version of the address.
170 "languageCode": "A String", # Language code of the address. Should be in BCP 47 format.
171 "addressLine": [ # The following address lines represent the most specific part of any
172 # address.
173 "A String",
174 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400175 "dependentLocality": "A String", # Dependent locality or sublocality. Used for UK dependent localities, or
176 # neighborhoods or boroughs in other locations.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400177 "sortingCode": "A String", # Use of this code is very country-specific, but will refer to a secondary
178 # classification code for sorting mail.
179 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # The latitude and longitude of the location, in degrees.
180 # of doubles representing degrees latitude and degrees longitude. Unless
181 # specified otherwise, this must conform to the
182 # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
183 # standard</a>. Values must be within normalized ranges.
184 #
185 # Example of normalization code in Python:
186 #
187 # def NormalizeLongitude(longitude):
188 # """Wraps decimal degrees longitude to [-180.0, 180.0]."""
189 # q, r = divmod(longitude, 360.0)
190 # if r > 180.0 or (r == 180.0 and q <= -1.0):
191 # return r - 360.0
192 # return r
193 #
194 # def NormalizeLatLng(latitude, longitude):
195 # """Wraps decimal degrees latitude and longitude to
196 # [-90.0, 90.0] and [-180.0, 180.0], respectively."""
197 # r = latitude % 360.0
198 # if r <= 90.0:
199 # return r, NormalizeLongitude(longitude)
200 # elif r >= 270.0:
201 # return r - 360, NormalizeLongitude(longitude)
202 # else:
203 # return 180 - r, NormalizeLongitude(longitude + 180.0)
204 #
205 # assert 180.0 == NormalizeLongitude(180.0)
206 # assert -180.0 == NormalizeLongitude(-180.0)
207 # assert -179.0 == NormalizeLongitude(181.0)
208 # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
209 # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
210 # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
211 # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
212 # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
213 # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
214 # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
215 # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
216 # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
217 # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
Takashi Matsuo06694102015-09-11 13:55:40 -0700218 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
219 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
220 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400221 "locality": "A String", # Generally refers to the city/town portion of an address.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400222 "regionCode": "A String", # CLDR (Common Locale Data Repository) region code .
223 "administrativeArea": "A String", # Top-level administrative subdivision of this country.
224 "address": "A String", # The single string version of the address.
225 "postalCode": "A String", # Values are frequently alphanumeric.
Takashi Matsuo06694102015-09-11 13:55:40 -0700226 },
227 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400228 "id": "A String", # The ID of the company.
229 "badgeTier": "A String", # Partner badge tier
230 "services": [ # Services the company can help with.
231 "A String",
232 ],
233 "additionalWebsites": [ # URL of the company's additional websites used to verify the dynamic badges.
234 # These are stored as full URLs as entered by the user, but only the TLD will
235 # be used for the actual verification.
236 "A String",
237 ],
238 "profileStatus": "A String", # The public viewability status of the company's profile.
239 "industries": [ # Industries the company can help with.
240 "A String",
241 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400242 "primaryLocation": { # A location with address and geographic coordinates. May optionally contain a # The primary location of the company.
243 # detailed (multi-field) version of the address.
244 "languageCode": "A String", # Language code of the address. Should be in BCP 47 format.
245 "addressLine": [ # The following address lines represent the most specific part of any
246 # address.
247 "A String",
248 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400249 "dependentLocality": "A String", # Dependent locality or sublocality. Used for UK dependent localities, or
250 # neighborhoods or boroughs in other locations.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400251 "sortingCode": "A String", # Use of this code is very country-specific, but will refer to a secondary
252 # classification code for sorting mail.
253 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # The latitude and longitude of the location, in degrees.
254 # of doubles representing degrees latitude and degrees longitude. Unless
255 # specified otherwise, this must conform to the
256 # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
257 # standard</a>. Values must be within normalized ranges.
258 #
259 # Example of normalization code in Python:
260 #
261 # def NormalizeLongitude(longitude):
262 # """Wraps decimal degrees longitude to [-180.0, 180.0]."""
263 # q, r = divmod(longitude, 360.0)
264 # if r > 180.0 or (r == 180.0 and q <= -1.0):
265 # return r - 360.0
266 # return r
267 #
268 # def NormalizeLatLng(latitude, longitude):
269 # """Wraps decimal degrees latitude and longitude to
270 # [-90.0, 90.0] and [-180.0, 180.0], respectively."""
271 # r = latitude % 360.0
272 # if r <= 90.0:
273 # return r, NormalizeLongitude(longitude)
274 # elif r >= 270.0:
275 # return r - 360, NormalizeLongitude(longitude)
276 # else:
277 # return 180 - r, NormalizeLongitude(longitude + 180.0)
278 #
279 # assert 180.0 == NormalizeLongitude(180.0)
280 # assert -180.0 == NormalizeLongitude(-180.0)
281 # assert -179.0 == NormalizeLongitude(181.0)
282 # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
283 # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
284 # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
285 # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
286 # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
287 # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
288 # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
289 # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
290 # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
291 # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400292 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
293 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
294 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400295 "locality": "A String", # Generally refers to the city/town portion of an address.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400296 "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 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400301 "websiteUrl": "A String", # URL of the company's website.
Takashi Matsuo06694102015-09-11 13:55:40 -0700302 "certificationStatuses": [ # The list of Google Partners certification statuses for the company.
303 { # Google Partners certification status.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700304 "isCertified": True or False, # Whether certification is passing.
Thomas Coffee2f245372017-03-27 10:39:26 -0700305 "userCount": 42, # Number of people who are certified,
306 "type": "A String", # The type of the certification.
Takashi Matsuo06694102015-09-11 13:55:40 -0700307 "examStatuses": [ # List of certification exam statuses.
308 { # Status for a Google Partners certification exam.
309 "numberUsersPass": 42, # The number of people who have passed the certification exam.
310 "type": "A String", # The type of certification exam.
311 },
312 ],
313 },
314 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400315 "publicProfile": { # Basic information from a public profile. # Basic information from the company's public profile.
316 "url": "A String", # The URL of the public profile.
317 "profileImage": "A String", # The URL to the main profile image of the public profile.
318 "displayImageUrl": "A String", # The URL to the main display image of the public profile. Being deprecated.
319 "displayName": "A String", # The display name of the public profile.
320 "id": "A String", # The ID which can be used to retrieve more details about the public profile.
321 },
322 "localizedInfos": [ # The list of localized info for the company.
323 { # The localized company information.
324 "countryCodes": [ # List of country codes for the localized company info.
325 "A String",
326 ],
327 "languageCode": "A String", # Language code of the localized company info, as defined by
328 # <a href="https://tools.ietf.org/html/bcp47">BCP 47</a>
329 # (IETF BCP 47, "Tags for Identifying Languages").
330 "displayName": "A String", # Localized display name.
331 "overview": "A String", # Localized brief description that the company uses to advertise themselves.
332 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400333 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400334 "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 -0400336 "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 -0700342 "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 -0700344 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
345 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400346 "primaryLanguageCode": "A String", # The primary language code of the company, as defined by
347 # <a href="https://tools.ietf.org/html/bcp47">BCP 47</a>
348 # (IETF BCP 47, "Tags for Identifying Languages").
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400349 "name": "A String", # The name of the company.
Takashi Matsuo06694102015-09-11 13:55:40 -0700350 },
351 "responseMetadata": { # Common data that is in each API response. # Current response metadata.
352 "debugInfo": { # Debug information about this request. # Debug information about this request.
353 "serverTraceInfo": "A String", # Server-side debug stack trace.
354 "serviceUrl": "A String", # URL of the service that handled this request.
355 "serverInfo": "A String", # Info about the server that serviced this request.
356 },
357 },
358 }</pre>
359</div>
360
361<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400362 <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 -0700363 <pre>Lists companies.
364
365Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400366 orderBy: string, How to order addresses within the returned companies. Currently, only
367`address` and `address desc` is supported which will sorted by closest to
368farthest in distance from given address and farthest to closest distance
369from given address respectively.
370 maxMonthlyBudget_units: string, The whole units of the amount.
371For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
Takashi Matsuo06694102015-09-11 13:55:40 -0700372 requestMetadata_userOverrides_userId: string, Logged-in user ID to impersonate instead of the user's ID.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400373 pageSize: integer, Requested page size. Server may return fewer companies than requested.
374If unspecified, server picks an appropriate default.
Takashi Matsuo06694102015-09-11 13:55:40 -0700375 requestMetadata_userOverrides_ipAddress: string, IP address to use instead of the user's geo-located IP address.
376 maxMonthlyBudget_currencyCode: string, The 3-letter currency code defined in ISO 4217.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400377 minMonthlyBudget_nanos: integer, Number of nano (10^-9) units of the amount.
378The value must be between -999,999,999 and +999,999,999 inclusive.
379If `units` is positive, `nanos` must be positive or zero.
380If `units` is zero, `nanos` can be positive, zero, or negative.
381If `units` is negative, `nanos` must be negative or zero.
382For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
383 languageCodes: string, List of language codes that company can support. Only primary language
384subtags are accepted as defined by
385<a href="https://tools.ietf.org/html/bcp47">BCP 47</a>
386(IETF BCP 47, "Tags for Identifying Languages"). (repeated)
Takashi Matsuo06694102015-09-11 13:55:40 -0700387 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400388 Allowed values
389 1 - v1 error format
390 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700391 industries: string, List of industries the company can help with. (repeated)
392 requestMetadata_locale: string, Locale to use for the current request.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400393 pageToken: string, A token identifying a page of results that the server returns.
394Typically, this is the value of `ListCompaniesResponse.next_page_token`
395returned from the previous call to
396ListCompanies.
Takashi Matsuo06694102015-09-11 13:55:40 -0700397 minMonthlyBudget_currencyCode: string, The 3-letter currency code defined in ISO 4217.
398 companyName: string, Company name to search for.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400399 maxMonthlyBudget_nanos: integer, Number of nano (10^-9) units of the amount.
400The value must be between -999,999,999 and +999,999,999 inclusive.
401If `units` is positive, `nanos` must be positive or zero.
402If `units` is zero, `nanos` can be positive, zero, or negative.
403If `units` is negative, `nanos` must be negative or zero.
404For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
405 requestMetadata_trafficSource_trafficSubId: string, Second level identifier to indicate where the traffic comes from.
406An identifier has multiple letters created by a team which redirected the
407traffic to us.
408 address: string, The address to use when searching for companies.
409If not given, the geo-located address of the request is used.
410 services: string, List of services that the returned agencies should provide. If this is
411not empty, any returned agency must have at least one of these services,
412or one of the specializations in the "specializations" field. (repeated)
Takashi Matsuo06694102015-09-11 13:55:40 -0700413 gpsMotivations: string, List of reasons for using Google Partner Search to get companies. (repeated)
414 requestMetadata_experimentIds: string, Experiment IDs the current request belongs to. (repeated)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400415 requestMetadata_trafficSource_trafficSourceId: string, Identifier to indicate where the traffic comes from.
416An identifier has multiple letters created by a team which redirected the
417traffic to us.
418 specializations: string, List of specializations that the returned agencies should provide. If this
419is not empty, any returned agency must have at least one of these
420specializations, or one of the services in the "services" field. (repeated)
421 websiteUrl: string, Website URL that will help to find a better matched company.
422.
Takashi Matsuo06694102015-09-11 13:55:40 -0700423 requestMetadata_partnersSessionId: string, Google Partners session ID.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400424 minMonthlyBudget_units: string, The whole units of the amount.
425For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
426 view: string, The view of the `Company` resource to be returned. This must not be
427`COMPANY_VIEW_UNSPECIFIED`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700428
429Returns:
430 An object of the form:
431
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400432 { # Response message for
433 # ListCompanies.
434 "nextPageToken": "A String", # A token to retrieve next page of results.
435 # Pass this value in the `ListCompaniesRequest.page_token` field in the
436 # subsequent call to
437 # ListCompanies to retrieve the
438 # next page of results.
Takashi Matsuo06694102015-09-11 13:55:40 -0700439 "companies": [ # The list of companies.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400440 { # A company resource in the Google Partners API. Once certified, it qualifies
441 # for being searched by advertisers.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400442 "companyTypes": [ # Company type labels listed on the company's profile.
Takashi Matsuo06694102015-09-11 13:55:40 -0700443 "A String",
444 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400445 "originalMinMonthlyBudget": { # Represents an amount of money with its currency type. # The unconverted minimum monthly budget that the company accepts for partner
446 # business.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400447 "nanos": 42, # Number of nano (10^-9) units of the amount.
448 # The value must be between -999,999,999 and +999,999,999 inclusive.
449 # If `units` is positive, `nanos` must be positive or zero.
450 # If `units` is zero, `nanos` can be positive, zero, or negative.
451 # If `units` is negative, `nanos` must be negative or zero.
452 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700453 "units": "A String", # The whole units of the amount.
454 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
Takashi Matsuo06694102015-09-11 13:55:40 -0700455 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
456 },
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700457 "autoApprovalEmailDomains": [ # Email domains that allow users with a matching email address to get
458 # auto-approved for associating with this company.
459 "A String",
460 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400461 "specializationStatus": [ # The list of Google Partners specialization statuses for the company.
462 { # Agency specialization status
463 "badgeSpecialization": "A String", # The specialization this status is for.
464 "badgeSpecializationState": "A String", # State of agency specialization.
465 },
466 ],
467 "ranks": [ # Information related to the ranking of the company within the list of
468 # companies.
469 { # Information related to ranking of results.
470 "type": "A String", # The type of rank.
471 "value": 3.14, # The numerical value of the rank.
472 },
473 ],
474 "primaryAdwordsManagerAccountId": "A String", # The Primary AdWords Manager Account id.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400475 "locations": [ # The list of all company locations.
476 # If set, must include the
477 # primary_location
478 # in the list.
479 { # A location with address and geographic coordinates. May optionally contain a
480 # detailed (multi-field) version of the address.
481 "languageCode": "A String", # Language code of the address. Should be in BCP 47 format.
482 "addressLine": [ # The following address lines represent the most specific part of any
483 # address.
484 "A String",
485 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400486 "dependentLocality": "A String", # Dependent locality or sublocality. Used for UK dependent localities, or
487 # neighborhoods or boroughs in other locations.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400488 "sortingCode": "A String", # Use of this code is very country-specific, but will refer to a secondary
489 # classification code for sorting mail.
490 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # The latitude and longitude of the location, in degrees.
491 # of doubles representing degrees latitude and degrees longitude. Unless
492 # specified otherwise, this must conform to the
493 # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
494 # standard</a>. Values must be within normalized ranges.
495 #
496 # Example of normalization code in Python:
497 #
498 # def NormalizeLongitude(longitude):
499 # """Wraps decimal degrees longitude to [-180.0, 180.0]."""
500 # q, r = divmod(longitude, 360.0)
501 # if r > 180.0 or (r == 180.0 and q <= -1.0):
502 # return r - 360.0
503 # return r
504 #
505 # def NormalizeLatLng(latitude, longitude):
506 # """Wraps decimal degrees latitude and longitude to
507 # [-90.0, 90.0] and [-180.0, 180.0], respectively."""
508 # r = latitude % 360.0
509 # if r <= 90.0:
510 # return r, NormalizeLongitude(longitude)
511 # elif r >= 270.0:
512 # return r - 360, NormalizeLongitude(longitude)
513 # else:
514 # return 180 - r, NormalizeLongitude(longitude + 180.0)
515 #
516 # assert 180.0 == NormalizeLongitude(180.0)
517 # assert -180.0 == NormalizeLongitude(-180.0)
518 # assert -179.0 == NormalizeLongitude(181.0)
519 # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
520 # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
521 # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
522 # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
523 # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
524 # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
525 # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
526 # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
527 # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
528 # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
Takashi Matsuo06694102015-09-11 13:55:40 -0700529 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
530 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
531 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400532 "locality": "A String", # Generally refers to the city/town portion of an address.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400533 "regionCode": "A String", # CLDR (Common Locale Data Repository) region code .
534 "administrativeArea": "A String", # Top-level administrative subdivision of this country.
535 "address": "A String", # The single string version of the address.
536 "postalCode": "A String", # Values are frequently alphanumeric.
Takashi Matsuo06694102015-09-11 13:55:40 -0700537 },
538 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400539 "id": "A String", # The ID of the company.
540 "badgeTier": "A String", # Partner badge tier
541 "services": [ # Services the company can help with.
542 "A String",
543 ],
544 "additionalWebsites": [ # URL of the company's additional websites used to verify the dynamic badges.
545 # These are stored as full URLs as entered by the user, but only the TLD will
546 # be used for the actual verification.
547 "A String",
548 ],
549 "profileStatus": "A String", # The public viewability status of the company's profile.
550 "industries": [ # Industries the company can help with.
551 "A String",
552 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400553 "primaryLocation": { # A location with address and geographic coordinates. May optionally contain a # The primary location of the company.
554 # detailed (multi-field) version of the address.
555 "languageCode": "A String", # Language code of the address. Should be in BCP 47 format.
556 "addressLine": [ # The following address lines represent the most specific part of any
557 # address.
558 "A String",
559 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400560 "dependentLocality": "A String", # Dependent locality or sublocality. Used for UK dependent localities, or
561 # neighborhoods or boroughs in other locations.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400562 "sortingCode": "A String", # Use of this code is very country-specific, but will refer to a secondary
563 # classification code for sorting mail.
564 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair # The latitude and longitude of the location, in degrees.
565 # of doubles representing degrees latitude and degrees longitude. Unless
566 # specified otherwise, this must conform to the
567 # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
568 # standard</a>. Values must be within normalized ranges.
569 #
570 # Example of normalization code in Python:
571 #
572 # def NormalizeLongitude(longitude):
573 # """Wraps decimal degrees longitude to [-180.0, 180.0]."""
574 # q, r = divmod(longitude, 360.0)
575 # if r > 180.0 or (r == 180.0 and q <= -1.0):
576 # return r - 360.0
577 # return r
578 #
579 # def NormalizeLatLng(latitude, longitude):
580 # """Wraps decimal degrees latitude and longitude to
581 # [-90.0, 90.0] and [-180.0, 180.0], respectively."""
582 # r = latitude % 360.0
583 # if r <= 90.0:
584 # return r, NormalizeLongitude(longitude)
585 # elif r >= 270.0:
586 # return r - 360, NormalizeLongitude(longitude)
587 # else:
588 # return 180 - r, NormalizeLongitude(longitude + 180.0)
589 #
590 # assert 180.0 == NormalizeLongitude(180.0)
591 # assert -180.0 == NormalizeLongitude(-180.0)
592 # assert -179.0 == NormalizeLongitude(181.0)
593 # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
594 # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
595 # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
596 # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
597 # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
598 # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
599 # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
600 # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
601 # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
602 # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400603 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
604 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
605 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400606 "locality": "A String", # Generally refers to the city/town portion of an address.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400607 "regionCode": "A String", # CLDR (Common Locale Data Repository) region code .
608 "administrativeArea": "A String", # Top-level administrative subdivision of this country.
609 "address": "A String", # The single string version of the address.
610 "postalCode": "A String", # Values are frequently alphanumeric.
611 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400612 "websiteUrl": "A String", # URL of the company's website.
Takashi Matsuo06694102015-09-11 13:55:40 -0700613 "certificationStatuses": [ # The list of Google Partners certification statuses for the company.
614 { # Google Partners certification status.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700615 "isCertified": True or False, # Whether certification is passing.
Thomas Coffee2f245372017-03-27 10:39:26 -0700616 "userCount": 42, # Number of people who are certified,
617 "type": "A String", # The type of the certification.
Takashi Matsuo06694102015-09-11 13:55:40 -0700618 "examStatuses": [ # List of certification exam statuses.
619 { # Status for a Google Partners certification exam.
620 "numberUsersPass": 42, # The number of people who have passed the certification exam.
621 "type": "A String", # The type of certification exam.
622 },
623 ],
624 },
625 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400626 "publicProfile": { # Basic information from a public profile. # Basic information from the company's public profile.
627 "url": "A String", # The URL of the public profile.
628 "profileImage": "A String", # The URL to the main profile image of the public profile.
629 "displayImageUrl": "A String", # The URL to the main display image of the public profile. Being deprecated.
630 "displayName": "A String", # The display name of the public profile.
631 "id": "A String", # The ID which can be used to retrieve more details about the public profile.
632 },
633 "localizedInfos": [ # The list of localized info for the company.
634 { # The localized company information.
635 "countryCodes": [ # List of country codes for the localized company info.
636 "A String",
637 ],
638 "languageCode": "A String", # Language code of the localized company info, as defined by
639 # <a href="https://tools.ietf.org/html/bcp47">BCP 47</a>
640 # (IETF BCP 47, "Tags for Identifying Languages").
641 "displayName": "A String", # Localized display name.
642 "overview": "A String", # Localized brief description that the company uses to advertise themselves.
643 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400644 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400645 "convertedMinMonthlyBudget": { # Represents an amount of money with its currency type. # The minimum monthly budget that the company accepts for partner business,
646 # converted to the requested currency code.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400647 "nanos": 42, # Number of nano (10^-9) units of the amount.
648 # The value must be between -999,999,999 and +999,999,999 inclusive.
649 # If `units` is positive, `nanos` must be positive or zero.
650 # If `units` is zero, `nanos` can be positive, zero, or negative.
651 # If `units` is negative, `nanos` must be negative or zero.
652 # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700653 "units": "A String", # The whole units of the amount.
654 # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
Takashi Matsuo06694102015-09-11 13:55:40 -0700655 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
656 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400657 "primaryLanguageCode": "A String", # The primary language code of the company, as defined by
658 # <a href="https://tools.ietf.org/html/bcp47">BCP 47</a>
659 # (IETF BCP 47, "Tags for Identifying Languages").
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400660 "name": "A String", # The name of the company.
Takashi Matsuo06694102015-09-11 13:55:40 -0700661 },
662 ],
663 "responseMetadata": { # Common data that is in each API response. # Current response metadata.
664 "debugInfo": { # Debug information about this request. # Debug information about this request.
665 "serverTraceInfo": "A String", # Server-side debug stack trace.
666 "serviceUrl": "A String", # URL of the service that handled this request.
667 "serverInfo": "A String", # Info about the server that serviced this request.
668 },
669 },
670 }</pre>
671</div>
672
673<div class="method">
674 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
675 <pre>Retrieves the next page of results.
676
677Args:
678 previous_request: The request for the previous page. (required)
679 previous_response: The response from the request for the previous page. (required)
680
681Returns:
682 A request object that you can call 'execute()' on to request the next
683 page. Returns None if there are no more items in the collection.
684 </pre>
685</div>
686
687</body></html>