Network.Google.Resource.Partners.Companies.List

Lists companies.

See: Google Partners API Reference for partners.companies.list.

REST Resource

type CompaniesListResource = "v2" :> ("companies" :> (QueryParams "languageCodes" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "maxMonthlyBudget.units" (Textual Int64) :> (QueryParam "upload_protocol" Text :> (QueryParam "orderBy" Text :> (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 :> (QueryParams "specializations" 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))))))))))))))))))))))))))))))))

A resource alias for partners.companies.list method which the CompaniesList request conforms to.

Creating a Request

companiesList :: CompaniesList

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
• clCompanyName
• clAccessToken
• clUploadType
• clAddress
• clMinMonthlyBudgetNanos
• clIndustries
• clRequestMetadataPartnersSessionId
• clSpecializations
• clMaxMonthlyBudgetNanos
• clRequestMetadataLocale
• clView
• clRequestMetadataExperimentIds
• clRequestMetadataUserOverridesIPAddress
• clMaxMonthlyBudgetCurrencyCode
• clWebsiteURL
• clPageToken
• clRequestMetadataTrafficSourceTrafficSubId
• clGpsMotivations
• clPageSize
• clMinMonthlyBudgetCurrencyCode
• clServices
• clRequestMetadataUserOverridesUserId
• clMinMonthlyBudgetUnits
• clRequestMetadataTrafficSourceTrafficSourceId
• clCallback

data CompaniesList

Lists companies.

See: companiesList smart constructor.

Instances

Eq CompaniesList

Defined in Network.Google.Resource.Partners.Companies.List

Methods

(==) :: CompaniesList -> CompaniesList -> Bool

(/=) :: CompaniesList -> CompaniesList -> Bool

Data CompaniesList

Defined in Network.Google.Resource.Partners.Companies.List

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CompaniesList -> c CompaniesList

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CompaniesList

toConstr :: CompaniesList -> Constr

dataTypeOf :: CompaniesList -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CompaniesList)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CompaniesList)

gmapT :: (forall b. Data b => b -> b) -> CompaniesList -> CompaniesList

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CompaniesList -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CompaniesList -> r

gmapQ :: (forall d. Data d => d -> u) -> CompaniesList -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CompaniesList -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CompaniesList -> m CompaniesList

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CompaniesList -> m CompaniesList

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CompaniesList -> m CompaniesList

Show CompaniesList

Defined in Network.Google.Resource.Partners.Companies.List

Methods

showsPrec :: Int -> CompaniesList -> ShowS

show :: CompaniesList -> String

showList :: [CompaniesList] -> ShowS

Generic CompaniesList

Defined in Network.Google.Resource.Partners.Companies.List

Associated Types

type Rep CompaniesList :: Type -> Type

Methods

from :: CompaniesList -> Rep CompaniesList x

to :: Rep CompaniesList x -> CompaniesList

GoogleRequest CompaniesList

Defined in Network.Google.Resource.Partners.Companies.List

Associated Types

type Rs CompaniesList :: Type

type Scopes CompaniesList :: [Symbol]

Methods

requestClient :: CompaniesList -> GClient (Rs CompaniesList)

type Rep CompaniesList

Defined in Network.Google.Resource.Partners.Companies.List

type Rep CompaniesList = D1 (MetaData "CompaniesList" "Network.Google.Resource.Partners.Companies.List" "gogol-partners-0.4.0-39sg3ZvEDoCEu9a3s5sq6U" False) (C1 (MetaCons "CompaniesList'" PrefixI True) ((((S1 (MetaSel (Just "_clLanguageCodes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 (MetaSel (Just "_clXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: S1 (MetaSel (Just "_clMaxMonthlyBudgetUnits") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64))))) :*: ((S1 (MetaSel (Just "_clUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_clOrderBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_clCompanyName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_clAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 (MetaSel (Just "_clUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_clAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_clMinMonthlyBudgetNanos") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_clIndustries") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))) :*: ((S1 (MetaSel (Just "_clRequestMetadataPartnersSessionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_clSpecializations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 (MetaSel (Just "_clMaxMonthlyBudgetNanos") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_clRequestMetadataLocale") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 (MetaSel (Just "_clView") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_clRequestMetadataExperimentIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_clRequestMetadataUserOverridesIPAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_clMaxMonthlyBudgetCurrencyCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_clWebsiteURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_clPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_clRequestMetadataTrafficSourceTrafficSubId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 (MetaSel (Just "_clGpsMotivations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_clPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))) :*: (S1 (MetaSel (Just "_clMinMonthlyBudgetCurrencyCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_clServices") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))) :*: ((S1 (MetaSel (Just "_clRequestMetadataUserOverridesUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_clMinMonthlyBudgetUnits") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64)))) :*: (S1 (MetaSel (Just "_clRequestMetadataTrafficSourceTrafficSourceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_clCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))))

type Scopes CompaniesList

Defined in Network.Google.Resource.Partners.Companies.List

type Scopes CompaniesList = ([] :: [Symbol])

type Rs CompaniesList

Defined in Network.Google.Resource.Partners.Companies.List

type Rs CompaniesList = ListCompaniesResponse

Request Lenses

clLanguageCodes :: Lens' CompaniesList [Text]

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").

clXgafv :: Lens' CompaniesList (Maybe Xgafv)

V1 error format.

clMaxMonthlyBudgetUnits :: Lens' CompaniesList (Maybe Int64)

The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

clUploadProtocol :: Lens' CompaniesList (Maybe Text)

Upload protocol for media (e.g. "raw", "multipart").

clOrderBy :: Lens' CompaniesList (Maybe Text)

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.

clCompanyName :: Lens' CompaniesList (Maybe Text)

Company name to search for.

clAccessToken :: Lens' CompaniesList (Maybe Text)

OAuth access token.

clUploadType :: Lens' CompaniesList (Maybe Text)

Legacy upload protocol for media (e.g. "media", "multipart").

clAddress :: Lens' CompaniesList (Maybe Text)

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)

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]

List of industries the company can help with.

clRequestMetadataPartnersSessionId :: Lens' CompaniesList (Maybe Text)

Google Partners session ID.

clSpecializations :: Lens' CompaniesList [Text]

List of specializations that the returned agencies should provide. If this is not empty, any returned agency must have at least one of these specializations, or one of the services in the "services" field.

clMaxMonthlyBudgetNanos :: Lens' CompaniesList (Maybe Int32)

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)

Locale to use for the current request.

clView :: Lens' CompaniesList (Maybe Text)

The view of the `Company` resource to be returned. This must not be `COMPANY_VIEW_UNSPECIFIED`.

clRequestMetadataExperimentIds :: Lens' CompaniesList [Text]

Experiment IDs the current request belongs to.

clRequestMetadataUserOverridesIPAddress :: Lens' CompaniesList (Maybe Text)

IP address to use instead of the user's geo-located IP address.

clMaxMonthlyBudgetCurrencyCode :: Lens' CompaniesList (Maybe Text)

The 3-letter currency code defined in ISO 4217.

clWebsiteURL :: Lens' CompaniesList (Maybe Text)

Website URL that will help to find a better matched company. .

clPageToken :: Lens' CompaniesList (Maybe Text)

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)

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]

List of reasons for using Google Partner Search to get companies.

clPageSize :: Lens' CompaniesList (Maybe Int32)

Requested page size. Server may return fewer companies than requested. If unspecified, server picks an appropriate default.

clMinMonthlyBudgetCurrencyCode :: Lens' CompaniesList (Maybe Text)

The 3-letter currency code defined in ISO 4217.

clServices :: Lens' CompaniesList [Text]

List of services that the returned agencies should provide. If this is not empty, any returned agency must have at least one of these services, or one of the specializations in the "specializations" field.

clRequestMetadataUserOverridesUserId :: Lens' CompaniesList (Maybe Text)

Logged-in user ID to impersonate instead of the user's ID.

clMinMonthlyBudgetUnits :: Lens' CompaniesList (Maybe Int64)

The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.

clRequestMetadataTrafficSourceTrafficSourceId :: Lens' CompaniesList (Maybe Text)

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)

JSONP