Copyright | (c) 2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Lists companies.
See: Google Partners API Reference for partners.companies.list
.
- type CompaniesListResource = "v2" :> ("companies" :> (QueryParams "languageCodes" Text :> (QueryParam "$.xgafv" Text :> (QueryParam "maxMonthlyBudget.units" (Textual Int64) :> (QueryParam "upload_protocol" Text :> (QueryParam "orderBy" Text :> (QueryParam "pp" Bool :> (QueryParam "companyName" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "address" Text :> (QueryParam "minMonthlyBudget.nanos" (Textual Int32) :> (QueryParams "industries" Text :> (QueryParam "requestMetadata.partnersSessionId" Text :> (QueryParam "bearer_token" Text :> (QueryParam "maxMonthlyBudget.nanos" (Textual Int32) :> (QueryParam "requestMetadata.locale" Text :> (QueryParam "view" Text :> (QueryParams "requestMetadata.experimentIds" Text :> (QueryParam "requestMetadata.userOverrides.ipAddress" Text :> (QueryParam "maxMonthlyBudget.currencyCode" Text :> (QueryParam "websiteUrl" Text :> (QueryParam "pageToken" Text :> (QueryParam "requestMetadata.trafficSource.trafficSubId" Text :> (QueryParams "gpsMotivations" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "minMonthlyBudget.currencyCode" Text :> (QueryParams "services" Text :> (QueryParam "requestMetadata.userOverrides.userId" Text :> (QueryParam "minMonthlyBudget.units" (Textual Int64) :> (QueryParam "requestMetadata.trafficSource.trafficSourceId" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get `[JSON]` ListCompaniesResponse)))))))))))))))))))))))))))))))))
- companiesList :: CompaniesList
- data CompaniesList
- clLanguageCodes :: Lens' CompaniesList [Text]
- clXgafv :: Lens' CompaniesList (Maybe Text)
- clMaxMonthlyBudgetUnits :: Lens' CompaniesList (Maybe Int64)
- clUploadProtocol :: Lens' CompaniesList (Maybe Text)
- clOrderBy :: Lens' CompaniesList (Maybe Text)
- clPp :: Lens' CompaniesList Bool
- clCompanyName :: Lens' CompaniesList (Maybe Text)
- clAccessToken :: Lens' CompaniesList (Maybe Text)
- clUploadType :: Lens' CompaniesList (Maybe Text)
- clAddress :: Lens' CompaniesList (Maybe Text)
- clMinMonthlyBudgetNanos :: Lens' CompaniesList (Maybe Int32)
- clIndustries :: Lens' CompaniesList [Text]
- clRequestMetadataPartnersSessionId :: Lens' CompaniesList (Maybe Text)
- clBearerToken :: Lens' CompaniesList (Maybe Text)
- clMaxMonthlyBudgetNanos :: Lens' CompaniesList (Maybe Int32)
- clRequestMetadataLocale :: Lens' CompaniesList (Maybe Text)
- clView :: Lens' CompaniesList (Maybe Text)
- clRequestMetadataExperimentIds :: Lens' CompaniesList [Text]
- clRequestMetadataUserOverridesIPAddress :: Lens' CompaniesList (Maybe Text)
- clMaxMonthlyBudgetCurrencyCode :: Lens' CompaniesList (Maybe Text)
- clWebsiteURL :: Lens' CompaniesList (Maybe Text)
- clPageToken :: Lens' CompaniesList (Maybe Text)
- clRequestMetadataTrafficSourceTrafficSubId :: Lens' CompaniesList (Maybe Text)
- clGpsMotivations :: Lens' CompaniesList [Text]
- clPageSize :: Lens' CompaniesList (Maybe Int32)
- clMinMonthlyBudgetCurrencyCode :: Lens' CompaniesList (Maybe Text)
- clServices :: Lens' CompaniesList [Text]
- clRequestMetadataUserOverridesUserId :: Lens' CompaniesList (Maybe Text)
- clMinMonthlyBudgetUnits :: Lens' CompaniesList (Maybe Int64)
- clRequestMetadataTrafficSourceTrafficSourceId :: Lens' CompaniesList (Maybe Text)
- clCallback :: Lens' CompaniesList (Maybe Text)
REST Resource
type CompaniesListResource = "v2" :> ("companies" :> (QueryParams "languageCodes" Text :> (QueryParam "$.xgafv" Text :> (QueryParam "maxMonthlyBudget.units" (Textual Int64) :> (QueryParam "upload_protocol" Text :> (QueryParam "orderBy" Text :> (QueryParam "pp" Bool :> (QueryParam "companyName" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "address" Text :> (QueryParam "minMonthlyBudget.nanos" (Textual Int32) :> (QueryParams "industries" Text :> (QueryParam "requestMetadata.partnersSessionId" Text :> (QueryParam "bearer_token" Text :> (QueryParam "maxMonthlyBudget.nanos" (Textual Int32) :> (QueryParam "requestMetadata.locale" Text :> (QueryParam "view" Text :> (QueryParams "requestMetadata.experimentIds" Text :> (QueryParam "requestMetadata.userOverrides.ipAddress" Text :> (QueryParam "maxMonthlyBudget.currencyCode" Text :> (QueryParam "websiteUrl" Text :> (QueryParam "pageToken" Text :> (QueryParam "requestMetadata.trafficSource.trafficSubId" Text :> (QueryParams "gpsMotivations" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "minMonthlyBudget.currencyCode" Text :> (QueryParams "services" Text :> (QueryParam "requestMetadata.userOverrides.userId" Text :> (QueryParam "minMonthlyBudget.units" (Textual Int64) :> (QueryParam "requestMetadata.trafficSource.trafficSourceId" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get `[JSON]` ListCompaniesResponse))))))))))))))))))))))))))))))))) Source
A resource alias for partners.companies.list
method which the
CompaniesList
request conforms to.
Creating a Request
companiesList :: CompaniesList Source
Creates a value of CompaniesList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
clLanguageCodes
clXgafv
clMaxMonthlyBudgetUnits
clUploadProtocol
clOrderBy
clPp
clCompanyName
clAccessToken
clUploadType
clAddress
clMinMonthlyBudgetNanos
clIndustries
clRequestMetadataPartnersSessionId
clBearerToken
clMaxMonthlyBudgetNanos
clRequestMetadataLocale
clView
clRequestMetadataExperimentIds
clRequestMetadataUserOverridesIPAddress
clMaxMonthlyBudgetCurrencyCode
clWebsiteURL
clPageToken
clRequestMetadataTrafficSourceTrafficSubId
clGpsMotivations
clPageSize
clMinMonthlyBudgetCurrencyCode
clServices
clRequestMetadataUserOverridesUserId
clMinMonthlyBudgetUnits
clRequestMetadataTrafficSourceTrafficSourceId
clCallback
data CompaniesList Source
Lists companies.
See: companiesList
smart constructor.
Request Lenses
clLanguageCodes :: Lens' CompaniesList [Text] Source
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").
clMaxMonthlyBudgetUnits :: Lens' CompaniesList (Maybe Int64) Source
The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
clUploadProtocol :: Lens' CompaniesList (Maybe Text) Source
Upload protocol for media (e.g. "raw", "multipart").
clOrderBy :: Lens' CompaniesList (Maybe Text) Source
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.
clPp :: Lens' CompaniesList Bool Source
Pretty-print response.
clCompanyName :: Lens' CompaniesList (Maybe Text) Source
Company name to search for.
clAccessToken :: Lens' CompaniesList (Maybe Text) Source
OAuth access token.
clUploadType :: Lens' CompaniesList (Maybe Text) Source
Legacy upload protocol for media (e.g. "media", "multipart").
clAddress :: Lens' CompaniesList (Maybe Text) Source
The address to use when searching for companies. If not given, the geo-located address of the request is used.
clMinMonthlyBudgetNanos :: Lens' CompaniesList (Maybe Int32) Source
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.
clIndustries :: Lens' CompaniesList [Text] Source
List of industries the company can help with.
clRequestMetadataPartnersSessionId :: Lens' CompaniesList (Maybe Text) Source
Google Partners session ID.
clBearerToken :: Lens' CompaniesList (Maybe Text) Source
OAuth bearer token.
clMaxMonthlyBudgetNanos :: Lens' CompaniesList (Maybe Int32) Source
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.
clRequestMetadataLocale :: Lens' CompaniesList (Maybe Text) Source
Locale to use for the current request.
clView :: Lens' CompaniesList (Maybe Text) Source
The view of the `Company` resource to be returned. This must not be `COMPANY_VIEW_UNSPECIFIED`.
clRequestMetadataExperimentIds :: Lens' CompaniesList [Text] Source
Experiment IDs the current request belongs to.
clRequestMetadataUserOverridesIPAddress :: Lens' CompaniesList (Maybe Text) Source
IP address to use instead of the user's geo-located IP address.
clMaxMonthlyBudgetCurrencyCode :: Lens' CompaniesList (Maybe Text) Source
The 3-letter currency code defined in ISO 4217.
clWebsiteURL :: Lens' CompaniesList (Maybe Text) Source
Website URL that will help to find a better matched company. .
clPageToken :: Lens' CompaniesList (Maybe Text) Source
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.
clRequestMetadataTrafficSourceTrafficSubId :: Lens' CompaniesList (Maybe Text) Source
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.
clGpsMotivations :: Lens' CompaniesList [Text] Source
List of reasons for using Google Partner Search to get companies.
clPageSize :: Lens' CompaniesList (Maybe Int32) Source
Requested page size. Server may return fewer companies than requested. If unspecified, server picks an appropriate default.
clMinMonthlyBudgetCurrencyCode :: Lens' CompaniesList (Maybe Text) Source
The 3-letter currency code defined in ISO 4217.
clServices :: Lens' CompaniesList [Text] Source
List of services the company can help with.
clRequestMetadataUserOverridesUserId :: Lens' CompaniesList (Maybe Text) Source
Logged-in user ID to impersonate instead of the user's ID.
clMinMonthlyBudgetUnits :: Lens' CompaniesList (Maybe Int64) Source
The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
clRequestMetadataTrafficSourceTrafficSourceId :: Lens' CompaniesList (Maybe Text) Source
Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.
clCallback :: Lens' CompaniesList (Maybe Text) Source
JSONP