Network.Google.Resource.Partners.Companies.Get

Gets a company.

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

REST Resource

type CompaniesGetResource = "v2" :> ("companies" :> (Capture "companyId" Text :> (QueryParam "$.xgafv" Text :> (QueryParam "currencyCode" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "orderBy" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "address" Text :> (QueryParam "requestMetadata.partnersSessionId" Text :> (QueryParam "bearer_token" 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)))))))))))))))))))))

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

Creating a Request

companiesGet

Arguments

:: Text

cgCompanyId

-> CompaniesGet

Creates a value of CompaniesGet with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cgXgafv
• cgCurrencyCode
• cgUploadProtocol
• cgCompanyId
• cgOrderBy
• cgPp
• cgAccessToken
• cgUploadType
• cgAddress
• cgRequestMetadataPartnersSessionId
• cgBearerToken
• cgRequestMetadataLocale
• cgView
• cgRequestMetadataExperimentIds
• cgRequestMetadataUserOverridesIPAddress
• cgRequestMetadataTrafficSourceTrafficSubId
• cgRequestMetadataUserOverridesUserId
• cgRequestMetadataTrafficSourceTrafficSourceId
• cgCallback

data CompaniesGet

Gets a company.

See: companiesGet smart constructor.

Instances

Eq CompaniesGet

Methods

(==) :: CompaniesGet -> CompaniesGet -> Bool

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

Data CompaniesGet

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

Methods

showsPrec :: Int -> CompaniesGet -> ShowS

show :: CompaniesGet -> String

showList :: [CompaniesGet] -> ShowS

Generic CompaniesGet

Associated Types

type Rep CompaniesGet :: * -> *

Methods

from :: CompaniesGet -> Rep CompaniesGet x

to :: Rep CompaniesGet x -> CompaniesGet

GoogleRequest CompaniesGet

Associated Types

type Rs CompaniesGet :: *

type Scopes CompaniesGet :: [Symbol]

Methods

requestClient :: CompaniesGet -> Client (Rs CompaniesGet)

type Rep CompaniesGet

type Rep CompaniesGet = D1 (MetaData "CompaniesGet" "Network.Google.Resource.Partners.Companies.Get" "gogol-partners-0.3.0-kLBNdDdn4TDRNW5i5DyWg" False) (C1 (MetaCons "CompaniesGet'" PrefixI True) ((:*:) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cgXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cgCurrencyCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_cgUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cgCompanyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cgOrderBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cgPp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool))) ((:*:) (S1 (MetaSel (Just Symbol "_cgAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_cgUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cgAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cgRequestMetadataPartnersSessionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cgBearerToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_cgRequestMetadataLocale") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_cgView") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cgRequestMetadataExperimentIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cgRequestMetadataUserOverridesIPAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cgRequestMetadataTrafficSourceTrafficSubId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_cgRequestMetadataUserOverridesUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_cgRequestMetadataTrafficSourceTrafficSourceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cgCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))))

type Scopes CompaniesGet

type Scopes CompaniesGet = [] Symbol

type Rs CompaniesGet

type Rs CompaniesGet = GetCompanyResponse

Request Lenses

cgXgafv :: Lens' CompaniesGet (Maybe Text)

V1 error format.

cgCurrencyCode :: Lens' CompaniesGet (Maybe Text)

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)

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

cgCompanyId :: Lens' CompaniesGet Text

The ID of the company to retrieve.

cgOrderBy :: Lens' CompaniesGet (Maybe Text)

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.

cgPp :: Lens' CompaniesGet Bool

Pretty-print response.

cgAccessToken :: Lens' CompaniesGet (Maybe Text)

OAuth access token.

cgUploadType :: Lens' CompaniesGet (Maybe Text)

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

cgAddress :: Lens' CompaniesGet (Maybe Text)

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.

cgRequestMetadataPartnersSessionId :: Lens' CompaniesGet (Maybe Text)

Google Partners session ID.

cgBearerToken :: Lens' CompaniesGet (Maybe Text)

OAuth bearer token.

cgRequestMetadataLocale :: Lens' CompaniesGet (Maybe Text)

Locale to use for the current request.

cgView :: Lens' CompaniesGet (Maybe Text)

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

cgRequestMetadataExperimentIds :: Lens' CompaniesGet [Text]

Experiment IDs the current request belongs to.

cgRequestMetadataUserOverridesIPAddress :: Lens' CompaniesGet (Maybe Text)

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

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

cgRequestMetadataUserOverridesUserId :: Lens' CompaniesGet (Maybe Text)

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

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

cgCallback :: Lens' CompaniesGet (Maybe Text)

JSONP