Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 386cc8b06b57c3d4a564fe0ab0d1e51fc34270a8 / . / docs / dyn / partners_v2.companies.html
blob: 533d90d0829f5f9fec75aa8353519b4053e26d3d [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">
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, websiteUrl=None, requestMetadata_partnersSessionId=None, minMonthlyBudget_units=None, view=None)</a></code></p>
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)
98 orderBy: string, How to order addresses within the returned company. Currently, only `address` and `address desc` is supported which will sorted by closest to farthest in distance from given address and farthest to closest distance from given address respectively.
99 requestMetadata_userOverrides_ipAddress: string, IP address to use instead of the user's geo-located IP address.
100 requestMetadata_trafficSource_trafficSubId: string, Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.
101 requestMetadata_userOverrides_userId: string, Logged-in user ID to impersonate instead of the user's ID.
102 x__xgafv: string, V1 error format.
103 currencyCode: string, If the company's budget is in a different currency code than this one, then the converted budget is converted to this currency code.
104 address: string, The address to use for sorting the company's addresses by proximity. If not given, the geo-located address of the request is used. Used when order_by is set.
105 requestMetadata_locale: string, Locale to use for the current request.
106 requestMetadata_experimentIds: string, Experiment IDs the current request belongs to. (repeated)
107 requestMetadata_trafficSource_trafficSourceId: string, Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.
108 requestMetadata_partnersSessionId: string, Google Partners session ID.
109 view: string, The view of `Company` resource to be returned. This must not be `COMPANY_VIEW_UNSPECIFIED`.
110
111Returns:
112 An object of the form:
113
114 { # Response message for [GetCompany][google.partners.v2.Partner.GetCompany].
115 "company": { # A company resource in the Google Partners API. Once certified, it qualifies for being searched by advertisers. # The company.
116 "industries": [ # Industries the company can help with.
117 "A String",
118 ],
119 "originalMinMonthlyBudget": { # Represents an amount of money with its currency type. # The unconverted minimum monthly budget that the company accepts for partner business.
120 "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
121 "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
122 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
123 },
124 "publicProfile": { # Basic information from a public profile. # Basic information from the company's public profile.
125 "url": "A String", # The URL of the public profile.
126 "displayImageUrl": "A String", # The URL to the main display image of the public profile.
127 "displayName": "A String", # The display name of the public profile.
128 "id": "A String", # The ID which can be used to retrieve more details about the public profile.
129 },
130 "name": "A String", # The name of the company.
131 "localizedInfos": [ # The list of localized info for the company.
132 { # The localized company information.
133 "countryCodes": [ # List of country codes for the localized company info.
134 "A String",
135 ],
136 "languageCode": "A String", # Language code of the localized company info, as defined by BCP 47 (IETF BCP 47, "Tags for Identifying Languages").
137 "displayName": "A String", # Localized display name.
138 "overview": "A String", # Localized brief description that the company uses to advertise themselves.
139 },
140 ],
141 "locations": [ # The list of company locations.
142 { # A location with address and geographic coordinates.
143 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. Example of normalization code in Python: def NormalizeLongitude(longitude): """Wrapsdecimal degrees longitude to [-180.0, 180.0].""" q, r = divmod(longitude, 360.0) if r > 180.0 or (r == 180.0 and q <= -1.0): return r - 360.0 return r def NormalizeLatLng(latitude, longitude): """Wraps decimal degrees latitude and longitude to [-180.0, 180.0] and [-90.0, 90.0], respectively.""" r = latitude % 360.0 if r = 270.0: return r - 360, NormalizeLongitude(longitude) else: return 180 - r, NormalizeLongitude(longitude + 180.0) assert 180.0 == NormalizeLongitude(180.0) assert -180.0 == NormalizeLongitude(-180.0) assert -179.0 == NormalizeLongitude(181.0) assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) # The latitude and longitude of the location, in degrees.
144 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
145 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
146 },
147 "address": "A String", # The complete address of the location.
148 },
149 ],
150 "websiteUrl": "A String", # URL of the company's website.
151 "ranks": [ # Information related to the ranking of the company within the list of companies.
152 { # Information related to ranking of results.
153 "type": "A String", # The type of rank.
154 "value": 3.14, # The numerical value of the rank.
155 },
156 ],
157 "services": [ # Services the company can help with.
158 "A String",
159 ],
160 "certificationStatuses": [ # The list of Google Partners certification statuses for the company.
161 { # Google Partners certification status.
162 "isCertified": True or False, # Whether certification is passing.
163 "type": "A String", # The type of the certification.
164 "examStatuses": [ # List of certification exam statuses.
165 { # Status for a Google Partners certification exam.
166 "numberUsersPass": 42, # The number of people who have passed the certification exam.
167 "type": "A String", # The type of certification exam.
168 },
169 ],
170 },
171 ],
172 "convertedMinMonthlyBudget": { # Represents an amount of money with its currency type. # The minimum monthly budget that the company accepts for partner business, converted to the requested currency code.
173 "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
174 "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
175 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
176 },
177 "id": "A String", # The ID of the company.
178 },
179 "responseMetadata": { # Common data that is in each API response. # Current response metadata.
180 "debugInfo": { # Debug information about this request. # Debug information about this request.
181 "serverTraceInfo": "A String", # Server-side debug stack trace.
182 "serviceUrl": "A String", # URL of the service that handled this request.
183 "serverInfo": "A String", # Info about the server that serviced this request.
184 },
185 },
186 }</pre>
187</div>
188
189<div class="method">
190 <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, websiteUrl=None, requestMetadata_partnersSessionId=None, minMonthlyBudget_units=None, view=None)</code>
191 <pre>Lists companies.
192
193Args:
194 orderBy: string, How to order addresses within the returned companies. Currently, only `address` and `address desc` is supported which will sorted by closest to farthest in distance from given address and farthest to closest distance from given address respectively.
195 maxMonthlyBudget_units: string, The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
196 requestMetadata_userOverrides_userId: string, Logged-in user ID to impersonate instead of the user's ID.
197 pageSize: integer, Requested page size. Server may return fewer companies than requested. If unspecified, server picks an appropriate default.
198 requestMetadata_userOverrides_ipAddress: string, IP address to use instead of the user's geo-located IP address.
199 maxMonthlyBudget_currencyCode: string, The 3-letter currency code defined in ISO 4217.
200 minMonthlyBudget_nanos: integer, Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
201 languageCodes: string, List of language codes that company can support. Only primary language subtags are accepted as defined by BCP 47 (IETF BCP 47, "Tags for Identifying Languages"). (repeated)
202 x__xgafv: string, V1 error format.
203 industries: string, List of industries the company can help with. (repeated)
204 requestMetadata_locale: string, Locale to use for the current request.
205 pageToken: string, A token identifying a page of results that the server returns. Typically, this is the value of `ListCompaniesResponse.next_page_token` returned from the previous call to [ListCompanies][google.partners.v2.Partner.ListCompanies].
206 minMonthlyBudget_currencyCode: string, The 3-letter currency code defined in ISO 4217.
207 companyName: string, Company name to search for.
208 maxMonthlyBudget_nanos: integer, Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
209 requestMetadata_trafficSource_trafficSubId: string, Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.
210 address: string, The address to use when searching for companies. If not given, the geo-located address of the request is used.
211 services: string, List of services the company can help with. (repeated)
212 gpsMotivations: string, List of reasons for using Google Partner Search to get companies. (repeated)
213 requestMetadata_experimentIds: string, Experiment IDs the current request belongs to. (repeated)
214 requestMetadata_trafficSource_trafficSourceId: string, Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.
215 websiteUrl: string, Website URL that will help to find a better matched company. .
216 requestMetadata_partnersSessionId: string, Google Partners session ID.
217 minMonthlyBudget_units: string, The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
218 view: string, The view of the `Company` resource to be returned. This must not be `COMPANY_VIEW_UNSPECIFIED`.
219
220Returns:
221 An object of the form:
222
223 { # Response message for [ListCompanies][google.partners.v2.Partner.ListCompanies].
224 "nextPageToken": "A String", # A token to retrieve next page of results. Pass this value in the `ListCompaniesRequest.page_token` field in the subsequent call to [ListCompanies][google.partners.v2.Partner.ListCompanies] to retrieve the next page of results.
225 "companies": [ # The list of companies.
226 { # A company resource in the Google Partners API. Once certified, it qualifies for being searched by advertisers.
227 "industries": [ # Industries the company can help with.
228 "A String",
229 ],
230 "originalMinMonthlyBudget": { # Represents an amount of money with its currency type. # The unconverted minimum monthly budget that the company accepts for partner business.
231 "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
232 "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
233 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
234 },
235 "publicProfile": { # Basic information from a public profile. # Basic information from the company's public profile.
236 "url": "A String", # The URL of the public profile.
237 "displayImageUrl": "A String", # The URL to the main display image of the public profile.
238 "displayName": "A String", # The display name of the public profile.
239 "id": "A String", # The ID which can be used to retrieve more details about the public profile.
240 },
241 "name": "A String", # The name of the company.
242 "localizedInfos": [ # The list of localized info for the company.
243 { # The localized company information.
244 "countryCodes": [ # List of country codes for the localized company info.
245 "A String",
246 ],
247 "languageCode": "A String", # Language code of the localized company info, as defined by BCP 47 (IETF BCP 47, "Tags for Identifying Languages").
248 "displayName": "A String", # Localized display name.
249 "overview": "A String", # Localized brief description that the company uses to advertise themselves.
250 },
251 ],
252 "locations": [ # The list of company locations.
253 { # A location with address and geographic coordinates.
254 "latLng": { # An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. Example of normalization code in Python: def NormalizeLongitude(longitude): """Wrapsdecimal degrees longitude to [-180.0, 180.0].""" q, r = divmod(longitude, 360.0) if r > 180.0 or (r == 180.0 and q <= -1.0): return r - 360.0 return r def NormalizeLatLng(latitude, longitude): """Wraps decimal degrees latitude and longitude to [-180.0, 180.0] and [-90.0, 90.0], respectively.""" r = latitude % 360.0 if r = 270.0: return r - 360, NormalizeLongitude(longitude) else: return 180 - r, NormalizeLongitude(longitude + 180.0) assert 180.0 == NormalizeLongitude(180.0) assert -180.0 == NormalizeLongitude(-180.0) assert -179.0 == NormalizeLongitude(181.0) assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) # The latitude and longitude of the location, in degrees.
255 "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
256 "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
257 },
258 "address": "A String", # The complete address of the location.
259 },
260 ],
261 "websiteUrl": "A String", # URL of the company's website.
262 "ranks": [ # Information related to the ranking of the company within the list of companies.
263 { # Information related to ranking of results.
264 "type": "A String", # The type of rank.
265 "value": 3.14, # The numerical value of the rank.
266 },
267 ],
268 "services": [ # Services the company can help with.
269 "A String",
270 ],
271 "certificationStatuses": [ # The list of Google Partners certification statuses for the company.
272 { # Google Partners certification status.
273 "isCertified": True or False, # Whether certification is passing.
274 "type": "A String", # The type of the certification.
275 "examStatuses": [ # List of certification exam statuses.
276 { # Status for a Google Partners certification exam.
277 "numberUsersPass": 42, # The number of people who have passed the certification exam.
278 "type": "A String", # The type of certification exam.
279 },
280 ],
281 },
282 ],
283 "convertedMinMonthlyBudget": { # Represents an amount of money with its currency type. # The minimum monthly budget that the company accepts for partner business, converted to the requested currency code.
284 "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
285 "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
286 "currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
287 },
288 "id": "A String", # The ID of the company.
289 },
290 ],
291 "responseMetadata": { # Common data that is in each API response. # Current response metadata.
292 "debugInfo": { # Debug information about this request. # Debug information about this request.
293 "serverTraceInfo": "A String", # Server-side debug stack trace.
294 "serviceUrl": "A String", # URL of the service that handled this request.
295 "serverInfo": "A String", # Info about the server that serviced this request.
296 },
297 },
298 }</pre>
299</div>
300
301<div class="method">
302 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
303 <pre>Retrieves the next page of results.
304
305Args:
306 previous_request: The request for the previous page. (required)
307 previous_response: The response from the request for the previous page. (required)
308
309Returns:
310 A request object that you can call 'execute()' on to request the next
311 page. Returns None if there are no more items in the collection.
312 </pre>
313</div>
314
315</body></html>