gogol-partners-0.4.0: Google Partners SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.Partners.Companies.Get

Contents

Description

Gets a company.

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

Synopsis

REST Resource

type CompaniesGetResource = "v2" :> ("companies" :> (Capture "companyId" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "currencyCode" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "orderBy" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "address" Text :> (QueryParam "requestMetadata.partnersSessionId" Text :> (QueryParam "requestMetadata.locale" Text :> (QueryParam "view" Text :> (QueryParams "requestMetadata.experimentIds" Text :> (QueryParam "requestMetadata.userOverrides.ipAddress" Text :> (QueryParam "requestMetadata.trafficSource.trafficSubId" Text :> (QueryParam "requestMetadata.userOverrides.userId" Text :> (QueryParam "requestMetadata.trafficSource.trafficSourceId" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] GetCompanyResponse))))))))))))))))))) Source #

A resource alias for partners.companies.get method which the CompaniesGet request conforms to.

Creating a Request

data CompaniesGet Source #

Gets a company.

See: companiesGet smart constructor.

Instances
Eq CompaniesGet Source # 
Instance details

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

Data CompaniesGet Source # 
Instance details

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

Methods

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

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

toConstr :: CompaniesGet -> Constr #

dataTypeOf :: CompaniesGet -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> CompaniesGet -> CompaniesGet #

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

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

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

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

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

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

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

Show CompaniesGet Source # 
Instance details

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

Generic CompaniesGet Source # 
Instance details

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

Associated Types

type Rep CompaniesGet :: Type -> Type #

GoogleRequest CompaniesGet Source # 
Instance details

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

Associated Types

type Rs CompaniesGet :: Type #

type Scopes CompaniesGet :: [Symbol] #

type Rep CompaniesGet Source # 
Instance details

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

type Rep CompaniesGet = D1 (MetaData "CompaniesGet" "Network.Google.Resource.Partners.Companies.Get" "gogol-partners-0.4.0-39sg3ZvEDoCEu9a3s5sq6U" False) (C1 (MetaCons "CompaniesGet'" PrefixI True) ((((S1 (MetaSel (Just "_cgXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: S1 (MetaSel (Just "_cgCurrencyCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_cgUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cgCompanyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :*: ((S1 (MetaSel (Just "_cgOrderBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cgAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_cgUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cgAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 (MetaSel (Just "_cgRequestMetadataPartnersSessionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cgRequestMetadataLocale") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_cgView") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cgRequestMetadataExperimentIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))) :*: ((S1 (MetaSel (Just "_cgRequestMetadataUserOverridesIPAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cgRequestMetadataTrafficSourceTrafficSubId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_cgRequestMetadataUserOverridesUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_cgRequestMetadataTrafficSourceTrafficSourceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cgCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))))
type Scopes CompaniesGet Source # 
Instance details

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

type Scopes CompaniesGet = ([] :: [Symbol])
type Rs CompaniesGet Source # 
Instance details

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

Request Lenses

cgCurrencyCode :: Lens' CompaniesGet (Maybe Text) Source #

If the company's budget is in a different currency code than this one, then the converted budget is converted to this currency code.

cgUploadProtocol :: Lens' CompaniesGet (Maybe Text) Source #

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

cgCompanyId :: Lens' CompaniesGet Text Source #

The ID of the company to retrieve.

cgOrderBy :: Lens' CompaniesGet (Maybe Text) Source #

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.

cgUploadType :: Lens' CompaniesGet (Maybe Text) Source #

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

cgAddress :: Lens' CompaniesGet (Maybe Text) Source #

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.

cgRequestMetadataLocale :: Lens' CompaniesGet (Maybe Text) Source #

Locale to use for the current request.

cgView :: Lens' CompaniesGet (Maybe Text) Source #

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

cgRequestMetadataExperimentIds :: Lens' CompaniesGet [Text] Source #

Experiment IDs the current request belongs to.

cgRequestMetadataUserOverridesIPAddress :: Lens' CompaniesGet (Maybe Text) Source #

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

cgRequestMetadataTrafficSourceTrafficSubId :: Lens' CompaniesGet (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.

cgRequestMetadataUserOverridesUserId :: Lens' CompaniesGet (Maybe Text) Source #

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

cgRequestMetadataTrafficSourceTrafficSourceId :: Lens' CompaniesGet (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.