| 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 |
Network.Google.Resource.Partners.Companies.Get
Description
Gets a company.
See: Google Partners API Reference for partners.companies.get.
- 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)))))))))))))))))))))
- companiesGet :: Text -> CompaniesGet
- data CompaniesGet
- cgXgafv :: Lens' CompaniesGet (Maybe Text)
- cgCurrencyCode :: Lens' CompaniesGet (Maybe Text)
- cgUploadProtocol :: Lens' CompaniesGet (Maybe Text)
- cgCompanyId :: Lens' CompaniesGet Text
- cgOrderBy :: Lens' CompaniesGet (Maybe Text)
- cgPp :: Lens' CompaniesGet Bool
- cgAccessToken :: Lens' CompaniesGet (Maybe Text)
- cgUploadType :: Lens' CompaniesGet (Maybe Text)
- cgAddress :: Lens' CompaniesGet (Maybe Text)
- cgRequestMetadataPartnersSessionId :: Lens' CompaniesGet (Maybe Text)
- cgBearerToken :: Lens' CompaniesGet (Maybe Text)
- cgRequestMetadataLocale :: Lens' CompaniesGet (Maybe Text)
- cgView :: Lens' CompaniesGet (Maybe Text)
- cgRequestMetadataExperimentIds :: Lens' CompaniesGet [Text]
- cgRequestMetadataUserOverridesIPAddress :: Lens' CompaniesGet (Maybe Text)
- cgRequestMetadataTrafficSourceTrafficSubId :: Lens' CompaniesGet (Maybe Text)
- cgRequestMetadataUserOverridesUserId :: Lens' CompaniesGet (Maybe Text)
- cgRequestMetadataTrafficSourceTrafficSourceId :: Lens' CompaniesGet (Maybe Text)
- cgCallback :: Lens' CompaniesGet (Maybe Text)
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))))))))))))))))))))) Source
A resource alias for partners.companies.get method which the
CompaniesGet request conforms to.
Creating a Request
Arguments
| :: Text | |
| -> 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:
cgXgafvcgCurrencyCodecgUploadProtocolcgCompanyIdcgOrderBycgPpcgAccessTokencgUploadTypecgAddresscgRequestMetadataPartnersSessionIdcgBearerTokencgRequestMetadataLocalecgViewcgRequestMetadataExperimentIdscgRequestMetadataUserOverridesIPAddresscgRequestMetadataTrafficSourceTrafficSubIdcgRequestMetadataUserOverridesUserIdcgRequestMetadataTrafficSourceTrafficSourceIdcgCallback
data CompaniesGet Source
Gets a company.
See: companiesGet smart constructor.
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.
cgPp :: Lens' CompaniesGet Bool Source
Pretty-print response.
cgAccessToken :: Lens' CompaniesGet (Maybe Text) Source
OAuth access token.
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.
cgRequestMetadataPartnersSessionId :: Lens' CompaniesGet (Maybe Text) Source
Google Partners session ID.
cgBearerToken :: Lens' CompaniesGet (Maybe Text) Source
OAuth bearer token.
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.
cgCallback :: Lens' CompaniesGet (Maybe Text) Source
JSONP