gogol-partners-0.0.1: Google Partners SDK.

Copyright(c) 2015 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.Partners.Types

Contents

Description

 

Synopsis

Service Configuration

partnersService :: Service Source

Default request referring to version v2 of the Google Partners API. This contains the host and root path used as a starting point for constructing service requests.

LatLng

data LatLng Source

An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. Example of normalization code in Python: def NormalizeLongitude(longitude): """Wrapsdecimal degrees longitude to [-180.0, 180.0].""" q, r = divmod(longitude, 360.0) if r > 180.0 or (r == 180.0 and q <= -1.0): return r - 360.0 return r def NormalizeLatLng(latitude, longitude): """Wraps decimal degrees latitude and longitude to [-180.0, 180.0] and [-90.0, 90.0], respectively.""" r = latitude % 360.0 if r = 270.0: return r - 360, NormalizeLongitude(longitude) else: return 180 - r, NormalizeLongitude(longitude + 180.0) assert 180.0 == NormalizeLongitude(180.0) assert -180.0 == NormalizeLongitude(-180.0) assert -179.0 == NormalizeLongitude(181.0) assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)

See: latLng smart constructor.

latLng :: LatLng Source

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

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

llLatitude :: Lens' LatLng (Maybe Double) Source

The latitude in degrees. It must be in the range [-90.0, +90.0].

llLongitude :: Lens' LatLng (Maybe Double) Source

The longitude in degrees. It must be in the range [-180.0, +180.0].

ListUserStatesResponse

listUserStatesResponse :: ListUserStatesResponse Source

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

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

EventData

eventData :: EventData Source

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

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

RequestMetadata

requestMetadata :: RequestMetadata Source

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

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

rmExperimentIds :: Lens' RequestMetadata [Text] Source

Experiment IDs the current request belongs to.

rmTrafficSource :: Lens' RequestMetadata (Maybe TrafficSource) Source

Source of traffic for the current request.

rmLocale :: Lens' RequestMetadata (Maybe Text) Source

Locale to use for the current request.

rmUserOverrides :: Lens' RequestMetadata (Maybe UserOverrides) Source

Values to use instead of the user's respective defaults for the current request. These are only honored by whitelisted products.

rmPartnersSessionId :: Lens' RequestMetadata (Maybe Text) Source

Google Partners session ID.

CertificationStatus

certificationStatus :: CertificationStatus Source

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

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

csIsCertified :: Lens' CertificationStatus (Maybe Bool) Source

Whether certification is passing.

csType :: Lens' CertificationStatus (Maybe Text) Source

The type of the certification.

csExamStatuses :: Lens' CertificationStatus [CertificationExamStatus] Source

List of certification exam statuses.

DebugInfo

data DebugInfo Source

Debug information about this request.

See: debugInfo smart constructor.

debugInfo :: DebugInfo Source

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

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

diServiceURL :: Lens' DebugInfo (Maybe Text) Source

URL of the service that handled this request.

diServerTraceInfo :: Lens' DebugInfo (Maybe Text) Source

Server-side debug stack trace.

diServerInfo :: Lens' DebugInfo (Maybe Text) Source

Info about the server that serviced this request.

GetCompanyResponse

getCompanyResponse :: GetCompanyResponse Source

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

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

PublicProFile

publicProFile :: PublicProFile Source

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

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

ppfURL :: Lens' PublicProFile (Maybe Text) Source

The URL of the public profile.

ppfDisplayImageURL :: Lens' PublicProFile (Maybe Text) Source

The URL to the main display image of the public profile.

ppfDisplayName :: Lens' PublicProFile (Maybe Text) Source

The display name of the public profile.

ppfId :: Lens' PublicProFile (Maybe Text) Source

The ID which can be used to retrieve more details about the public profile.

CertificationExamStatus

certificationExamStatus :: CertificationExamStatus Source

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

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

cesNumberUsersPass :: Lens' CertificationExamStatus (Maybe Int32) Source

The number of people who have passed the certification exam.

cesType :: Lens' CertificationExamStatus (Maybe Text) Source

The type of certification exam.

Location

data Location Source

A location with address and geographic coordinates.

See: location smart constructor.

location :: Location Source

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

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

lLatLng :: Lens' Location (Maybe LatLng) Source

The latitude and longitude of the location, in degrees.

lAddress :: Lens' Location (Maybe Text) Source

The complete address of the location.

TrafficSource

trafficSource :: TrafficSource Source

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

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

tsTrafficSubId :: Lens' TrafficSource (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.

tsTrafficSourceId :: Lens' TrafficSource (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.

Money

data Money Source

Represents an amount of money with its currency type.

See: money smart constructor.

money :: Money Source

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

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

mCurrencyCode :: Lens' Money (Maybe Text) Source

The 3-letter currency code defined in ISO 4217.

mNanos :: Lens' Money (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.

mUnits :: Lens' Money (Maybe Int64) Source

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

ListCompaniesResponse

listCompaniesResponse :: ListCompaniesResponse Source

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

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

lcrNextPageToken :: Lens' ListCompaniesResponse (Maybe Text) Source

A token to retrieve next page of results. Pass this value in the `ListCompaniesRequest.page_token` field in the subsequent call to ListCompanies to retrieve the next page of results.

RecaptchaChallenge

recaptchaChallenge :: RecaptchaChallenge Source

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

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

rcResponse :: Lens' RecaptchaChallenge (Maybe Text) Source

The response to the reCaptcha challenge.

rcId :: Lens' RecaptchaChallenge (Maybe Text) Source

The ID of the reCaptcha challenge.

CreateLeadResponse

createLeadResponse :: CreateLeadResponse Source

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

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

clrRecaptchaStatus :: Lens' CreateLeadResponse (Maybe Text) Source

The outcome of reCaptcha validation.

clrLead :: Lens' CreateLeadResponse (Maybe Lead) Source

Lead that was created depending on the outcome of reCaptcha validation.

UserOverrides

data UserOverrides Source

Values to use instead of the user's respective defaults. These are only honored by whitelisted products.

See: userOverrides smart constructor.

userOverrides :: UserOverrides Source

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

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

uoIPAddress :: Lens' UserOverrides (Maybe Text) Source

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

uoUserId :: Lens' UserOverrides (Maybe Text) Source

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

ResponseMetadata

responseMetadata :: ResponseMetadata Source

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

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

rmDebugInfo :: Lens' ResponseMetadata (Maybe DebugInfo) Source

Debug information about this request.

LogMessageRequest

logMessageRequest :: LogMessageRequest Source

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

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

lmrClientInfo :: Lens' LogMessageRequest (Maybe LogMessageRequestClientInfo) Source

Map of client info, such as URL, browser navigator, browser platform, etc.

lmrDetails :: Lens' LogMessageRequest (Maybe Text) Source

Details about the client message.

lmrLevel :: Lens' LogMessageRequest (Maybe Text) Source

Message level of client message.

LocalizedCompanyInfo

localizedCompanyInfo :: LocalizedCompanyInfo Source

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

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

lciLanguageCode :: Lens' LocalizedCompanyInfo (Maybe Text) Source

Language code of the localized company info, as defined by BCP 47 (IETF BCP 47, "Tags for Identifying Languages").

lciOverview :: Lens' LocalizedCompanyInfo (Maybe Text) Source

Localized brief description that the company uses to advertise themselves.

lciCountryCodes :: Lens' LocalizedCompanyInfo [Text] Source

List of country codes for the localized company info.

LogMessageRequestClientInfo

logMessageRequestClientInfo Source

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

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

Lead

data Lead Source

A lead resource that represents an advertiser contact for a `Company`. These are usually generated via Google Partner Search (the advertiser portal).

See: lead smart constructor.

lead :: Lead Source

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

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

lGivenName :: Lens' Lead (Maybe Text) Source

First name of lead source.

lEmail :: Lens' Lead (Maybe Text) Source

Email address of lead source.

lFamilyName :: Lens' Lead (Maybe Text) Source

Last name of lead source.

lPhoneNumber :: Lens' Lead (Maybe Text) Source

Phone number of lead source.

lMinMonthlyBudget :: Lens' Lead (Maybe Money) Source

The minimum monthly budget lead source is willing to spend.

lId :: Lens' Lead (Maybe Text) Source

ID of the lead.

lComments :: Lens' Lead (Maybe Text) Source

Comments lead source gave.

lWebsiteURL :: Lens' Lead (Maybe Text) Source

Website URL of lead source.

lType :: Lens' Lead (Maybe Text) Source

Type of lead.

lGpsMotivations :: Lens' Lead [Text] Source

List of reasons for using Google Partner Search and creating a lead.

LogMessageResponse

logMessageResponse :: LogMessageResponse Source

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

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

Company

data Company Source

A company resource in the Google Partners API. Once certified, it qualifies for being searched by advertisers.

See: company smart constructor.

company :: Company Source

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

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

cPublicProFile :: Lens' Company (Maybe PublicProFile) Source

Basic information from the company's public profile.

cOriginalMinMonthlyBudget :: Lens' Company (Maybe Money) Source

The unconverted minimum monthly budget that the company accepts for partner business.

cIndustries :: Lens' Company [Text] Source

Industries the company can help with.

cConvertedMinMonthlyBudget :: Lens' Company (Maybe Money) Source

The minimum monthly budget that the company accepts for partner business, converted to the requested currency code.

cName :: Lens' Company (Maybe Text) Source

The name of the company.

cLocalizedInfos :: Lens' Company [LocalizedCompanyInfo] Source

The list of localized info for the company.

cCertificationStatuses :: Lens' Company [CertificationStatus] Source

The list of Google Partners certification statuses for the company.

cRanks :: Lens' Company [Rank] Source

Information related to the ranking of the company within the list of companies.

cId :: Lens' Company (Maybe Text) Source

The ID of the company.

cWebsiteURL :: Lens' Company (Maybe Text) Source

URL of the company's website.

cLocations :: Lens' Company [Location] Source

The list of company locations.

cServices :: Lens' Company [Text] Source

Services the company can help with.

LogUserEventResponse

logUserEventResponse :: LogUserEventResponse Source

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

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

LogUserEventRequest

logUserEventRequest :: LogUserEventRequest Source

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

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

luerEventCategory :: Lens' LogUserEventRequest (Maybe Text) Source

The category the action belongs to.

luerURL :: Lens' LogUserEventRequest (Maybe Text) Source

The URL where the event occurred.

luerLead :: Lens' LogUserEventRequest (Maybe Lead) Source

Advertiser lead information.

luerEventDatas :: Lens' LogUserEventRequest [EventData] Source

List of event data for the event.

Rank

data Rank Source

Information related to ranking of results.

See: rank smart constructor.

rank :: Rank Source

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

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

rValue :: Lens' Rank (Maybe Double) Source

The numerical value of the rank.

rType :: Lens' Rank (Maybe Text) Source

The type of rank.

CreateLeadRequest

createLeadRequest :: CreateLeadRequest Source

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

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

cLead :: Lens' CreateLeadRequest (Maybe Lead) Source

The lead resource. The `LeadType` must not be `LEAD_TYPE_UNSPECIFIED` and either `email` or `phone_number` must be provided.