diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ ## Version -`0.3.0` +`0.5.0` ## Description diff --git a/gen/Network/Google/DFAReporting.hs b/gen/Network/Google/DFAReporting.hs --- a/gen/Network/Google/DFAReporting.hs +++ b/gen/Network/Google/DFAReporting.hs @@ -277,12 +277,6 @@ -- ** dfareporting.dimensionValues.query , module Network.Google.Resource.DFAReporting.DimensionValues.Query - -- ** dfareporting.directorySiteContacts.get - , module Network.Google.Resource.DFAReporting.DirectorySiteContacts.Get - - -- ** dfareporting.directorySiteContacts.list - , module Network.Google.Resource.DFAReporting.DirectorySiteContacts.List - -- ** dfareporting.directorySites.get , module Network.Google.Resource.DFAReporting.DirectorySites.Get @@ -811,11 +805,8 @@ , directorySiteSettings , dssInterstitialPlacementAccepted , dssInstreamVideoPlacementAccepted - , dssVerificationTagOptOut , dssActiveViewOptOut , dssDfpSettings - , dssVideoActiveViewOptOut - , dssNielsenOCROptOut -- ** TargetableRemarketingListsListSortOrder , TargetableRemarketingListsListSortOrder (..) @@ -839,9 +830,6 @@ -- ** PlacementVpaidAdapterChoice , PlacementVpaidAdapterChoice (..) - -- ** DirectorySiteContactAssignmentVisibility - , DirectorySiteContactAssignmentVisibility (..) - -- ** SizesListResponse , SizesListResponse , sizesListResponse @@ -919,6 +907,15 @@ -- ** AdSlotCompatibility , AdSlotCompatibility (..) + -- ** SiteVideoSettings + , SiteVideoSettings + , siteVideoSettings + , svsKind + , svsCompanionSettings + , svsTranscodeSettings + , svsOrientation + , svsSkippableSettings + -- ** ListPopulationTerm , ListPopulationTerm , listPopulationTerm @@ -950,20 +947,6 @@ -- ** VideoSettingsOrientation , VideoSettingsOrientation (..) - -- ** DirectorySiteContact - , DirectorySiteContact - , directorySiteContact - , dscEmail - , dscPhone - , dscLastName - , dscKind - , dscAddress - , dscRole - , dscFirstName - , dscId - , dscTitle - , dscType - -- ** RegionsListResponse , RegionsListResponse , regionsListResponse @@ -992,7 +975,6 @@ -- ** DirectorySite , DirectorySite , directorySite - , dsCurrencyId , dsSettings , dsInterstitialTagFormats , dsKind @@ -1002,10 +984,6 @@ , dsActive , dsName , dsId - , dsCountryId - , dsContactAssignments - , dsDescription - , dsParentId -- ** CreativeAssetMetadataDetectedFeaturesItem , CreativeAssetMetadataDetectedFeaturesItem (..) @@ -1144,6 +1122,12 @@ , cocOptimizationActivitys , cocId + -- ** SiteTranscodeSetting + , SiteTranscodeSetting + , siteTranscodeSetting + , stsKind + , stsEnabledVideoFormats + -- ** CreativeClickThroughURL , CreativeClickThroughURL , creativeClickThroughURL @@ -1493,6 +1477,14 @@ , llrKind , llrLanguages + -- ** CustomViewabilityMetricConfiguration + , CustomViewabilityMetricConfiguration + , customViewabilityMetricConfiguration + , cvmcViewabilityPercent + , cvmcTimePercent + , cvmcAudible + , cvmcTimeMillis + -- ** UserRolesListSortOrder , UserRolesListSortOrder (..) @@ -1660,7 +1652,6 @@ , creLastModifiedInfo , creId , creAuthoringSource - , crePoliteLoadAssetId , creStudioAdvertiserId , creCreativeAssets , creSubAccountId @@ -1679,6 +1670,14 @@ , creRedirectURL , creCreativeFieldAssignments + -- ** SiteCompanionSetting + , SiteCompanionSetting + , siteCompanionSetting + , scsKind + , scsImageOnly + , scsCompanionsDisabled + , scsEnabledSizes + -- ** SiteContact , SiteContact , siteContact @@ -1734,6 +1733,14 @@ -- ** PlacementPaymentSource , PlacementPaymentSource (..) + -- ** SiteSkippableSetting + , SiteSkippableSetting + , siteSkippableSetting + , sssSkipOffSet + , sssProgressOffSet + , sssKind + , sssSkippable + -- ** Rule , Rule , rule @@ -1758,7 +1765,6 @@ , camAdvertiserIdDimensionValue , camIdDimensionValue , camEventTagOverrides - , camLookbackConfiguration , camStartDate , camAccountId , camName @@ -1798,9 +1804,6 @@ -- ** PopupWindowPropertiesPositionType , PopupWindowPropertiesPositionType (..) - -- ** DirectorySiteContactRole - , DirectorySiteContactRole (..) - -- ** ClickThroughURL , ClickThroughURL , clickThroughURL @@ -1848,11 +1851,9 @@ , ssDisableNewCookie , ssVideoActiveViewOptOutTemplate , ssAdBlockingOptOut - , ssLookbackConfiguration , ssTagSetting , ssActiveViewOptOut , ssVpaidAdapterChoiceTemplate - , ssCreativeSettings -- ** PlacementStrategiesListSortField , PlacementStrategiesListSortField (..) @@ -2313,9 +2314,6 @@ -- ** FloodlightActivityFloodlightActivityGroupType , FloodlightActivityFloodlightActivityGroupType (..) - -- ** DirectorySiteContactsListSortOrder - , DirectorySiteContactsListSortOrder (..) - -- ** PricingGroupType , PricingGroupType (..) @@ -2386,9 +2384,6 @@ -- ** FloodlightActivityGroupType , FloodlightActivityGroupType (..) - -- ** DirectorySiteContactType - , DirectorySiteContactType (..) - -- ** EventTagOverride , EventTagOverride , eventTagOverride @@ -2686,13 +2681,6 @@ -- ** SubAccountsListSortOrder , SubAccountsListSortOrder (..) - -- ** DirectorySiteContactsListResponse - , DirectorySiteContactsListResponse - , directorySiteContactsListResponse - , dsclrNextPageToken - , dsclrKind - , dsclrDirectorySiteContacts - -- ** Region , Region , region @@ -2771,6 +2759,7 @@ , fcNATuralSearchConversionAttributionOption , fcUserDefinedVariableConfigurations , fcSubAccountId + , fcCustomViewabilityMetric , fcFirstDayOfWeek , fcOmnitureSettings @@ -2841,6 +2830,13 @@ -- ** AdvertisersListStatus , AdvertisersListStatus (..) + -- ** CustomViewabilityMetric + , CustomViewabilityMetric + , customViewabilityMetric + , cvmName + , cvmId + , cvmConfiguration + -- ** DimensionValueMatchType , DimensionValueMatchType (..) @@ -2893,6 +2889,7 @@ , creativeAsset , caaZIndex , caaPushdown + , caaFrameRate , caaOriginalBackup , caaWindowMode , caaFlashVersion @@ -2925,10 +2922,13 @@ , caaDisplayType , caaChildAssetType , caaCollapsedSize + , caaAudioSampleRate , caaId , caaBitRate + , caaPoliteLoad , caaCustomStartTimeValue , caaStartTimeType + , caaAudioBitRate , caaDuration , caaOrientation , caaArtworkType @@ -3034,9 +3034,6 @@ -- ** TargetWindowTargetWindowOption , TargetWindowTargetWindowOption (..) - -- ** DirectorySiteContactsListSortField - , DirectorySiteContactsListSortField (..) - -- ** PlacementsListPricingTypes , PlacementsListPricingTypes (..) @@ -3052,6 +3049,7 @@ -- ** Site , Site , site + , sitiVideoSettings , sitiKind , sitiKeyName , sitiSiteContacts @@ -3155,12 +3153,6 @@ , filId , filFileName - -- ** CreativeSettings - , CreativeSettings - , creativeSettings - , csIFrameHeader - , csIFrameFooter - -- ** DynamicTargetingKeyObjectType , DynamicTargetingKeyObjectType (..) @@ -3302,12 +3294,6 @@ , fagtrFloodlightActivityTag , fagtrKind - -- ** DirectorySiteContactAssignment - , DirectorySiteContactAssignment - , directorySiteContactAssignment - , dscaVisibility - , dscaContactId - -- ** AdSlot , AdSlot , adSlot @@ -3326,6 +3312,9 @@ , tptuURL , tptuThirdPartyURLType + -- ** SiteVideoSettingsOrientation + , SiteVideoSettingsOrientation (..) + -- ** PricingCapCostType , PricingCapCostType (..) @@ -3566,8 +3555,6 @@ import Network.Google.Resource.DFAReporting.Creatives.Patch import Network.Google.Resource.DFAReporting.Creatives.Update import Network.Google.Resource.DFAReporting.DimensionValues.Query -import Network.Google.Resource.DFAReporting.DirectorySiteContacts.Get -import Network.Google.Resource.DFAReporting.DirectorySiteContacts.List import Network.Google.Resource.DFAReporting.DirectorySites.Get import Network.Google.Resource.DFAReporting.DirectorySites.Insert import Network.Google.Resource.DFAReporting.DirectorySites.List @@ -3896,8 +3883,6 @@ :<|> AdvertiserGroupsGetResource :<|> AdvertiserGroupsDeleteResource :<|> AdvertiserGroupsUpdateResource - :<|> DirectorySiteContactsListResource - :<|> DirectorySiteContactsGetResource :<|> FloodlightActivityGroupsInsertResource :<|> FloodlightActivityGroupsListResource :<|> FloodlightActivityGroupsPatchResource diff --git a/gen/Network/Google/DFAReporting/Types.hs b/gen/Network/Google/DFAReporting/Types.hs --- a/gen/Network/Google/DFAReporting/Types.hs +++ b/gen/Network/Google/DFAReporting/Types.hs @@ -184,11 +184,8 @@ , directorySiteSettings , dssInterstitialPlacementAccepted , dssInstreamVideoPlacementAccepted - , dssVerificationTagOptOut , dssActiveViewOptOut , dssDfpSettings - , dssVideoActiveViewOptOut - , dssNielsenOCROptOut -- * TargetableRemarketingListsListSortOrder , TargetableRemarketingListsListSortOrder (..) @@ -212,9 +209,6 @@ -- * PlacementVpaidAdapterChoice , PlacementVpaidAdapterChoice (..) - -- * DirectorySiteContactAssignmentVisibility - , DirectorySiteContactAssignmentVisibility (..) - -- * SizesListResponse , SizesListResponse , sizesListResponse @@ -292,6 +286,15 @@ -- * AdSlotCompatibility , AdSlotCompatibility (..) + -- * SiteVideoSettings + , SiteVideoSettings + , siteVideoSettings + , svsKind + , svsCompanionSettings + , svsTranscodeSettings + , svsOrientation + , svsSkippableSettings + -- * ListPopulationTerm , ListPopulationTerm , listPopulationTerm @@ -323,20 +326,6 @@ -- * VideoSettingsOrientation , VideoSettingsOrientation (..) - -- * DirectorySiteContact - , DirectorySiteContact - , directorySiteContact - , dscEmail - , dscPhone - , dscLastName - , dscKind - , dscAddress - , dscRole - , dscFirstName - , dscId - , dscTitle - , dscType - -- * RegionsListResponse , RegionsListResponse , regionsListResponse @@ -365,7 +354,6 @@ -- * DirectorySite , DirectorySite , directorySite - , dsCurrencyId , dsSettings , dsInterstitialTagFormats , dsKind @@ -375,10 +363,6 @@ , dsActive , dsName , dsId - , dsCountryId - , dsContactAssignments - , dsDescription - , dsParentId -- * CreativeAssetMetadataDetectedFeaturesItem , CreativeAssetMetadataDetectedFeaturesItem (..) @@ -517,6 +501,12 @@ , cocOptimizationActivitys , cocId + -- * SiteTranscodeSetting + , SiteTranscodeSetting + , siteTranscodeSetting + , stsKind + , stsEnabledVideoFormats + -- * CreativeClickThroughURL , CreativeClickThroughURL , creativeClickThroughURL @@ -866,6 +856,14 @@ , llrKind , llrLanguages + -- * CustomViewabilityMetricConfiguration + , CustomViewabilityMetricConfiguration + , customViewabilityMetricConfiguration + , cvmcViewabilityPercent + , cvmcTimePercent + , cvmcAudible + , cvmcTimeMillis + -- * UserRolesListSortOrder , UserRolesListSortOrder (..) @@ -1033,7 +1031,6 @@ , creLastModifiedInfo , creId , creAuthoringSource - , crePoliteLoadAssetId , creStudioAdvertiserId , creCreativeAssets , creSubAccountId @@ -1052,6 +1049,14 @@ , creRedirectURL , creCreativeFieldAssignments + -- * SiteCompanionSetting + , SiteCompanionSetting + , siteCompanionSetting + , scsKind + , scsImageOnly + , scsCompanionsDisabled + , scsEnabledSizes + -- * SiteContact , SiteContact , siteContact @@ -1107,6 +1112,14 @@ -- * PlacementPaymentSource , PlacementPaymentSource (..) + -- * SiteSkippableSetting + , SiteSkippableSetting + , siteSkippableSetting + , sssSkipOffSet + , sssProgressOffSet + , sssKind + , sssSkippable + -- * Rule , Rule , rule @@ -1131,7 +1144,6 @@ , camAdvertiserIdDimensionValue , camIdDimensionValue , camEventTagOverrides - , camLookbackConfiguration , camStartDate , camAccountId , camName @@ -1171,9 +1183,6 @@ -- * PopupWindowPropertiesPositionType , PopupWindowPropertiesPositionType (..) - -- * DirectorySiteContactRole - , DirectorySiteContactRole (..) - -- * ClickThroughURL , ClickThroughURL , clickThroughURL @@ -1221,11 +1230,9 @@ , ssDisableNewCookie , ssVideoActiveViewOptOutTemplate , ssAdBlockingOptOut - , ssLookbackConfiguration , ssTagSetting , ssActiveViewOptOut , ssVpaidAdapterChoiceTemplate - , ssCreativeSettings -- * PlacementStrategiesListSortField , PlacementStrategiesListSortField (..) @@ -1686,9 +1693,6 @@ -- * FloodlightActivityFloodlightActivityGroupType , FloodlightActivityFloodlightActivityGroupType (..) - -- * DirectorySiteContactsListSortOrder - , DirectorySiteContactsListSortOrder (..) - -- * PricingGroupType , PricingGroupType (..) @@ -1759,9 +1763,6 @@ -- * FloodlightActivityGroupType , FloodlightActivityGroupType (..) - -- * DirectorySiteContactType - , DirectorySiteContactType (..) - -- * EventTagOverride , EventTagOverride , eventTagOverride @@ -2059,13 +2060,6 @@ -- * SubAccountsListSortOrder , SubAccountsListSortOrder (..) - -- * DirectorySiteContactsListResponse - , DirectorySiteContactsListResponse - , directorySiteContactsListResponse - , dsclrNextPageToken - , dsclrKind - , dsclrDirectorySiteContacts - -- * Region , Region , region @@ -2144,6 +2138,7 @@ , fcNATuralSearchConversionAttributionOption , fcUserDefinedVariableConfigurations , fcSubAccountId + , fcCustomViewabilityMetric , fcFirstDayOfWeek , fcOmnitureSettings @@ -2214,6 +2209,13 @@ -- * AdvertisersListStatus , AdvertisersListStatus (..) + -- * CustomViewabilityMetric + , CustomViewabilityMetric + , customViewabilityMetric + , cvmName + , cvmId + , cvmConfiguration + -- * DimensionValueMatchType , DimensionValueMatchType (..) @@ -2266,6 +2268,7 @@ , creativeAsset , caaZIndex , caaPushdown + , caaFrameRate , caaOriginalBackup , caaWindowMode , caaFlashVersion @@ -2298,10 +2301,13 @@ , caaDisplayType , caaChildAssetType , caaCollapsedSize + , caaAudioSampleRate , caaId , caaBitRate + , caaPoliteLoad , caaCustomStartTimeValue , caaStartTimeType + , caaAudioBitRate , caaDuration , caaOrientation , caaArtworkType @@ -2407,9 +2413,6 @@ -- * TargetWindowTargetWindowOption , TargetWindowTargetWindowOption (..) - -- * DirectorySiteContactsListSortField - , DirectorySiteContactsListSortField (..) - -- * PlacementsListPricingTypes , PlacementsListPricingTypes (..) @@ -2425,6 +2428,7 @@ -- * Site , Site , site + , sitiVideoSettings , sitiKind , sitiKeyName , sitiSiteContacts @@ -2528,12 +2532,6 @@ , filId , filFileName - -- * CreativeSettings - , CreativeSettings - , creativeSettings - , csIFrameHeader - , csIFrameFooter - -- * DynamicTargetingKeyObjectType , DynamicTargetingKeyObjectType (..) @@ -2675,12 +2673,6 @@ , fagtrFloodlightActivityTag , fagtrKind - -- * DirectorySiteContactAssignment - , DirectorySiteContactAssignment - , directorySiteContactAssignment - , dscaVisibility - , dscaContactId - -- * AdSlot , AdSlot , adSlot @@ -2699,6 +2691,9 @@ , tptuURL , tptuThirdPartyURLType + -- * SiteVideoSettingsOrientation + , SiteVideoSettingsOrientation (..) + -- * PricingCapCostType , PricingCapCostType (..) @@ -2859,21 +2854,21 @@ import Network.Google.DFAReporting.Types.Sum import Network.Google.Prelude --- | Default request referring to version 'v3.2' of the DCM/DFA Reporting And Trafficking API. This contains the host and root path used as a starting point for constructing service requests. +-- | Default request referring to version 'v3.3' of the DCM/DFA Reporting And Trafficking API. This contains the host and root path used as a starting point for constructing service requests. dFAReportingService :: ServiceConfig dFAReportingService - = defaultService (ServiceId "dfareporting:v3.2") + = defaultService (ServiceId "dfareporting:v3.3") "www.googleapis.com" -- | View and manage DoubleClick for Advertisers reports dFAReportingScope :: Proxy '["https://www.googleapis.com/auth/dfareporting"] -dFAReportingScope = Proxy; +dFAReportingScope = Proxy -- | Manage DoubleClick Digital Marketing conversions ddmconversionsScope :: Proxy '["https://www.googleapis.com/auth/ddmconversions"] -ddmconversionsScope = Proxy; +ddmconversionsScope = Proxy -- | View and manage your DoubleClick Campaign Manager\'s (DCM) display ad -- campaigns dfatraffickingScope :: Proxy '["https://www.googleapis.com/auth/dfatrafficking"] -dfatraffickingScope = Proxy; +dfatraffickingScope = Proxy diff --git a/gen/Network/Google/DFAReporting/Types/Product.hs b/gen/Network/Google/DFAReporting/Types/Product.hs --- a/gen/Network/Google/DFAReporting/Types/Product.hs +++ b/gen/Network/Google/DFAReporting/Types/Product.hs @@ -23,23297 +23,24158 @@ -- | Video Offset -- -- /See:/ 'videoOffSet' smart constructor. -data VideoOffSet = VideoOffSet' - { _vosOffSetPercentage :: !(Maybe (Textual Int32)) - , _vosOffSetSeconds :: !(Maybe (Textual Int32)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'VideoOffSet' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'vosOffSetPercentage' --- --- * 'vosOffSetSeconds' -videoOffSet - :: VideoOffSet -videoOffSet = - VideoOffSet' - { _vosOffSetPercentage = Nothing - , _vosOffSetSeconds = Nothing - } - --- | Duration, as a percentage of video duration. Do not set when --- offsetSeconds is set. Acceptable values are 0 to 100, inclusive. -vosOffSetPercentage :: Lens' VideoOffSet (Maybe Int32) -vosOffSetPercentage - = lens _vosOffSetPercentage - (\ s a -> s{_vosOffSetPercentage = a}) - . mapping _Coerce - --- | Duration, in seconds. Do not set when offsetPercentage is set. --- Acceptable values are 0 to 86399, inclusive. -vosOffSetSeconds :: Lens' VideoOffSet (Maybe Int32) -vosOffSetSeconds - = lens _vosOffSetSeconds - (\ s a -> s{_vosOffSetSeconds = a}) - . mapping _Coerce - -instance FromJSON VideoOffSet where - parseJSON - = withObject "VideoOffSet" - (\ o -> - VideoOffSet' <$> - (o .:? "offsetPercentage") <*> - (o .:? "offsetSeconds")) - -instance ToJSON VideoOffSet where - toJSON VideoOffSet'{..} - = object - (catMaybes - [("offsetPercentage" .=) <$> _vosOffSetPercentage, - ("offsetSeconds" .=) <$> _vosOffSetSeconds]) - --- | Contains information about a landing page deep link. --- --- /See:/ 'deepLink' smart constructor. -data DeepLink = DeepLink' - { _dlRemarketingListIds :: !(Maybe [Textual Int64]) - , _dlKind :: !Text - , _dlFallbackURL :: !(Maybe Text) - , _dlAppURL :: !(Maybe Text) - , _dlMobileApp :: !(Maybe MobileApp) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'DeepLink' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'dlRemarketingListIds' --- --- * 'dlKind' --- --- * 'dlFallbackURL' --- --- * 'dlAppURL' --- --- * 'dlMobileApp' -deepLink - :: DeepLink -deepLink = - DeepLink' - { _dlRemarketingListIds = Nothing - , _dlKind = "dfareporting#deepLink" - , _dlFallbackURL = Nothing - , _dlAppURL = Nothing - , _dlMobileApp = Nothing - } - --- | Ads served to users on these remarketing lists will use this deep link. --- Applicable when mobileApp.directory is APPLE_APP_STORE. -dlRemarketingListIds :: Lens' DeepLink [Int64] -dlRemarketingListIds - = lens _dlRemarketingListIds - (\ s a -> s{_dlRemarketingListIds = a}) - . _Default - . _Coerce - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#deepLink\". -dlKind :: Lens' DeepLink Text -dlKind = lens _dlKind (\ s a -> s{_dlKind = a}) - --- | The fallback URL. This URL will be served to users who do not have the --- mobile app installed. -dlFallbackURL :: Lens' DeepLink (Maybe Text) -dlFallbackURL - = lens _dlFallbackURL - (\ s a -> s{_dlFallbackURL = a}) - --- | The URL of the mobile app being linked to. -dlAppURL :: Lens' DeepLink (Maybe Text) -dlAppURL = lens _dlAppURL (\ s a -> s{_dlAppURL = a}) - --- | The mobile app targeted by this deep link. -dlMobileApp :: Lens' DeepLink (Maybe MobileApp) -dlMobileApp - = lens _dlMobileApp (\ s a -> s{_dlMobileApp = a}) - -instance FromJSON DeepLink where - parseJSON - = withObject "DeepLink" - (\ o -> - DeepLink' <$> - (o .:? "remarketingListIds" .!= mempty) <*> - (o .:? "kind" .!= "dfareporting#deepLink") - <*> (o .:? "fallbackUrl") - <*> (o .:? "appUrl") - <*> (o .:? "mobileApp")) - -instance ToJSON DeepLink where - toJSON DeepLink'{..} - = object - (catMaybes - [("remarketingListIds" .=) <$> _dlRemarketingListIds, - Just ("kind" .= _dlKind), - ("fallbackUrl" .=) <$> _dlFallbackURL, - ("appUrl" .=) <$> _dlAppURL, - ("mobileApp" .=) <$> _dlMobileApp]) - --- | Represents the list of File resources. --- --- /See:/ 'fileList' smart constructor. -data FileList = FileList' - { _flEtag :: !(Maybe Text) - , _flNextPageToken :: !(Maybe Text) - , _flKind :: !Text - , _flItems :: !(Maybe [File]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'FileList' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'flEtag' --- --- * 'flNextPageToken' --- --- * 'flKind' --- --- * 'flItems' -fileList - :: FileList -fileList = - FileList' - { _flEtag = Nothing - , _flNextPageToken = Nothing - , _flKind = "dfareporting#fileList" - , _flItems = Nothing - } - --- | The eTag of this response for caching purposes. -flEtag :: Lens' FileList (Maybe Text) -flEtag = lens _flEtag (\ s a -> s{_flEtag = a}) - --- | Continuation token used to page through files. To retrieve the next page --- of results, set the next request\'s \"pageToken\" to the value of this --- field. The page token is only valid for a limited amount of time and --- should not be persisted. -flNextPageToken :: Lens' FileList (Maybe Text) -flNextPageToken - = lens _flNextPageToken - (\ s a -> s{_flNextPageToken = a}) - --- | The kind of list this is, in this case dfareporting#fileList. -flKind :: Lens' FileList Text -flKind = lens _flKind (\ s a -> s{_flKind = a}) - --- | The files returned in this response. -flItems :: Lens' FileList [File] -flItems - = lens _flItems (\ s a -> s{_flItems = a}) . _Default - . _Coerce - -instance FromJSON FileList where - parseJSON - = withObject "FileList" - (\ o -> - FileList' <$> - (o .:? "etag") <*> (o .:? "nextPageToken") <*> - (o .:? "kind" .!= "dfareporting#fileList") - <*> (o .:? "items" .!= mempty)) - -instance ToJSON FileList where - toJSON FileList'{..} - = object - (catMaybes - [("etag" .=) <$> _flEtag, - ("nextPageToken" .=) <$> _flNextPageToken, - Just ("kind" .= _flKind), ("items" .=) <$> _flItems]) - --- | Creative optimization activity. --- --- /See:/ 'optimizationActivity' smart constructor. -data OptimizationActivity = OptimizationActivity' - { _oaWeight :: !(Maybe (Textual Int32)) - , _oaFloodlightActivityId :: !(Maybe (Textual Int64)) - , _oaFloodlightActivityIdDimensionValue :: !(Maybe DimensionValue) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'OptimizationActivity' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'oaWeight' --- --- * 'oaFloodlightActivityId' --- --- * 'oaFloodlightActivityIdDimensionValue' -optimizationActivity - :: OptimizationActivity -optimizationActivity = - OptimizationActivity' - { _oaWeight = Nothing - , _oaFloodlightActivityId = Nothing - , _oaFloodlightActivityIdDimensionValue = Nothing - } - --- | Weight associated with this optimization. The weight assigned will be --- understood in proportion to the weights assigned to the other --- optimization activities. Value must be greater than or equal to 1. -oaWeight :: Lens' OptimizationActivity (Maybe Int32) -oaWeight - = lens _oaWeight (\ s a -> s{_oaWeight = a}) . - mapping _Coerce - --- | Floodlight activity ID of this optimization activity. This is a required --- field. -oaFloodlightActivityId :: Lens' OptimizationActivity (Maybe Int64) -oaFloodlightActivityId - = lens _oaFloodlightActivityId - (\ s a -> s{_oaFloodlightActivityId = a}) - . mapping _Coerce - --- | Dimension value for the ID of the floodlight activity. This is a --- read-only, auto-generated field. -oaFloodlightActivityIdDimensionValue :: Lens' OptimizationActivity (Maybe DimensionValue) -oaFloodlightActivityIdDimensionValue - = lens _oaFloodlightActivityIdDimensionValue - (\ s a -> - s{_oaFloodlightActivityIdDimensionValue = a}) - -instance FromJSON OptimizationActivity where - parseJSON - = withObject "OptimizationActivity" - (\ o -> - OptimizationActivity' <$> - (o .:? "weight") <*> (o .:? "floodlightActivityId") - <*> (o .:? "floodlightActivityIdDimensionValue")) - -instance ToJSON OptimizationActivity where - toJSON OptimizationActivity'{..} - = object - (catMaybes - [("weight" .=) <$> _oaWeight, - ("floodlightActivityId" .=) <$> - _oaFloodlightActivityId, - ("floodlightActivityIdDimensionValue" .=) <$> - _oaFloodlightActivityIdDimensionValue]) - --- | A group clause made up of list population terms representing constraints --- joined by ORs. --- --- /See:/ 'listPopulationClause' smart constructor. -newtype ListPopulationClause = ListPopulationClause' - { _lpcTerms :: Maybe [ListPopulationTerm] - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'ListPopulationClause' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'lpcTerms' -listPopulationClause - :: ListPopulationClause -listPopulationClause = - ListPopulationClause' - { _lpcTerms = Nothing - } - --- | Terms of this list population clause. Each clause is made up of list --- population terms representing constraints and are joined by ORs. -lpcTerms :: Lens' ListPopulationClause [ListPopulationTerm] -lpcTerms - = lens _lpcTerms (\ s a -> s{_lpcTerms = a}) . - _Default - . _Coerce - -instance FromJSON ListPopulationClause where - parseJSON - = withObject "ListPopulationClause" - (\ o -> - ListPopulationClause' <$> (o .:? "terms" .!= mempty)) - -instance ToJSON ListPopulationClause where - toJSON ListPopulationClause'{..} - = object (catMaybes [("terms" .=) <$> _lpcTerms]) - --- | Campaign ad blocking settings. --- --- /See:/ 'adBlockingConfiguration' smart constructor. -data AdBlockingConfiguration = AdBlockingConfiguration' - { _abcCreativeBundleId :: !(Maybe (Textual Int64)) - , _abcOverrideClickThroughURL :: !(Maybe Bool) - , _abcEnabled :: !(Maybe Bool) - , _abcClickThroughURL :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'AdBlockingConfiguration' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'abcCreativeBundleId' --- --- * 'abcOverrideClickThroughURL' --- --- * 'abcEnabled' --- --- * 'abcClickThroughURL' -adBlockingConfiguration - :: AdBlockingConfiguration -adBlockingConfiguration = - AdBlockingConfiguration' - { _abcCreativeBundleId = Nothing - , _abcOverrideClickThroughURL = Nothing - , _abcEnabled = Nothing - , _abcClickThroughURL = Nothing - } - --- | ID of a creative bundle to use for this campaign. If set, brand-neutral --- ads will select creatives from this bundle. Otherwise, a default --- transparent pixel will be used. -abcCreativeBundleId :: Lens' AdBlockingConfiguration (Maybe Int64) -abcCreativeBundleId - = lens _abcCreativeBundleId - (\ s a -> s{_abcCreativeBundleId = a}) - . mapping _Coerce - --- | Whether the brand-neutral ad\'s click-through URL comes from the --- campaign\'s creative bundle or the override URL. Must be set to true if --- ad blocking is enabled and no creative bundle is configured. -abcOverrideClickThroughURL :: Lens' AdBlockingConfiguration (Maybe Bool) -abcOverrideClickThroughURL - = lens _abcOverrideClickThroughURL - (\ s a -> s{_abcOverrideClickThroughURL = a}) - --- | Whether this campaign has enabled ad blocking. When true, ad blocking is --- enabled for placements in the campaign, but this may be overridden by --- site and placement settings. When false, ad blocking is disabled for all --- placements under the campaign, regardless of site and placement --- settings. -abcEnabled :: Lens' AdBlockingConfiguration (Maybe Bool) -abcEnabled - = lens _abcEnabled (\ s a -> s{_abcEnabled = a}) - --- | Click-through URL used by brand-neutral ads. This is a required field --- when overrideClickThroughUrl is set to true. -abcClickThroughURL :: Lens' AdBlockingConfiguration (Maybe Text) -abcClickThroughURL - = lens _abcClickThroughURL - (\ s a -> s{_abcClickThroughURL = a}) - -instance FromJSON AdBlockingConfiguration where - parseJSON - = withObject "AdBlockingConfiguration" - (\ o -> - AdBlockingConfiguration' <$> - (o .:? "creativeBundleId") <*> - (o .:? "overrideClickThroughUrl") - <*> (o .:? "enabled") - <*> (o .:? "clickThroughUrl")) - -instance ToJSON AdBlockingConfiguration where - toJSON AdBlockingConfiguration'{..} - = object - (catMaybes - [("creativeBundleId" .=) <$> _abcCreativeBundleId, - ("overrideClickThroughUrl" .=) <$> - _abcOverrideClickThroughURL, - ("enabled" .=) <$> _abcEnabled, - ("clickThroughUrl" .=) <$> _abcClickThroughURL]) - --- | Creative Custom Event. --- --- /See:/ 'creativeCustomEvent' smart constructor. -data CreativeCustomEvent = CreativeCustomEvent' - { _cceAdvertiserCustomEventId :: !(Maybe (Textual Int64)) - , _cceAdvertiserCustomEventType :: !(Maybe CreativeCustomEventAdvertiserCustomEventType) - , _cceAdvertiserCustomEventName :: !(Maybe Text) - , _cceExitClickThroughURL :: !(Maybe CreativeClickThroughURL) - , _cceTargetType :: !(Maybe CreativeCustomEventTargetType) - , _ccePopupWindowProperties :: !(Maybe PopupWindowProperties) - , _cceVideoReportingId :: !(Maybe Text) - , _cceId :: !(Maybe (Textual Int64)) - , _cceArtworkLabel :: !(Maybe Text) - , _cceArtworkType :: !(Maybe CreativeCustomEventArtworkType) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'CreativeCustomEvent' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'cceAdvertiserCustomEventId' --- --- * 'cceAdvertiserCustomEventType' --- --- * 'cceAdvertiserCustomEventName' --- --- * 'cceExitClickThroughURL' --- --- * 'cceTargetType' --- --- * 'ccePopupWindowProperties' --- --- * 'cceVideoReportingId' --- --- * 'cceId' --- --- * 'cceArtworkLabel' --- --- * 'cceArtworkType' -creativeCustomEvent - :: CreativeCustomEvent -creativeCustomEvent = - CreativeCustomEvent' - { _cceAdvertiserCustomEventId = Nothing - , _cceAdvertiserCustomEventType = Nothing - , _cceAdvertiserCustomEventName = Nothing - , _cceExitClickThroughURL = Nothing - , _cceTargetType = Nothing - , _ccePopupWindowProperties = Nothing - , _cceVideoReportingId = Nothing - , _cceId = Nothing - , _cceArtworkLabel = Nothing - , _cceArtworkType = Nothing - } - --- | Unique ID of this event used by Reporting and Data Transfer. This is a --- read-only field. -cceAdvertiserCustomEventId :: Lens' CreativeCustomEvent (Maybe Int64) -cceAdvertiserCustomEventId - = lens _cceAdvertiserCustomEventId - (\ s a -> s{_cceAdvertiserCustomEventId = a}) - . mapping _Coerce - --- | Type of the event. This is a read-only field. -cceAdvertiserCustomEventType :: Lens' CreativeCustomEvent (Maybe CreativeCustomEventAdvertiserCustomEventType) -cceAdvertiserCustomEventType - = lens _cceAdvertiserCustomEventType - (\ s a -> s{_cceAdvertiserCustomEventType = a}) - --- | User-entered name for the event. -cceAdvertiserCustomEventName :: Lens' CreativeCustomEvent (Maybe Text) -cceAdvertiserCustomEventName - = lens _cceAdvertiserCustomEventName - (\ s a -> s{_cceAdvertiserCustomEventName = a}) - --- | Exit click-through URL for the event. This field is used only for exit --- events. -cceExitClickThroughURL :: Lens' CreativeCustomEvent (Maybe CreativeClickThroughURL) -cceExitClickThroughURL - = lens _cceExitClickThroughURL - (\ s a -> s{_cceExitClickThroughURL = a}) - --- | Target type used by the event. -cceTargetType :: Lens' CreativeCustomEvent (Maybe CreativeCustomEventTargetType) -cceTargetType - = lens _cceTargetType - (\ s a -> s{_cceTargetType = a}) - --- | Properties for rich media popup windows. This field is used only for --- exit events. -ccePopupWindowProperties :: Lens' CreativeCustomEvent (Maybe PopupWindowProperties) -ccePopupWindowProperties - = lens _ccePopupWindowProperties - (\ s a -> s{_ccePopupWindowProperties = a}) - --- | Video reporting ID, used to differentiate multiple videos in a single --- creative. This is a read-only field. -cceVideoReportingId :: Lens' CreativeCustomEvent (Maybe Text) -cceVideoReportingId - = lens _cceVideoReportingId - (\ s a -> s{_cceVideoReportingId = a}) - --- | ID of this event. This is a required field and should not be modified --- after insertion. -cceId :: Lens' CreativeCustomEvent (Maybe Int64) -cceId - = lens _cceId (\ s a -> s{_cceId = a}) . - mapping _Coerce - --- | Artwork label column, used to link events in Campaign Manager back to --- events in Studio. This is a required field and should not be modified --- after insertion. -cceArtworkLabel :: Lens' CreativeCustomEvent (Maybe Text) -cceArtworkLabel - = lens _cceArtworkLabel - (\ s a -> s{_cceArtworkLabel = a}) - --- | Artwork type used by the creative.This is a read-only field. -cceArtworkType :: Lens' CreativeCustomEvent (Maybe CreativeCustomEventArtworkType) -cceArtworkType - = lens _cceArtworkType - (\ s a -> s{_cceArtworkType = a}) - -instance FromJSON CreativeCustomEvent where - parseJSON - = withObject "CreativeCustomEvent" - (\ o -> - CreativeCustomEvent' <$> - (o .:? "advertiserCustomEventId") <*> - (o .:? "advertiserCustomEventType") - <*> (o .:? "advertiserCustomEventName") - <*> (o .:? "exitClickThroughUrl") - <*> (o .:? "targetType") - <*> (o .:? "popupWindowProperties") - <*> (o .:? "videoReportingId") - <*> (o .:? "id") - <*> (o .:? "artworkLabel") - <*> (o .:? "artworkType")) - -instance ToJSON CreativeCustomEvent where - toJSON CreativeCustomEvent'{..} - = object - (catMaybes - [("advertiserCustomEventId" .=) <$> - _cceAdvertiserCustomEventId, - ("advertiserCustomEventType" .=) <$> - _cceAdvertiserCustomEventType, - ("advertiserCustomEventName" .=) <$> - _cceAdvertiserCustomEventName, - ("exitClickThroughUrl" .=) <$> - _cceExitClickThroughURL, - ("targetType" .=) <$> _cceTargetType, - ("popupWindowProperties" .=) <$> - _ccePopupWindowProperties, - ("videoReportingId" .=) <$> _cceVideoReportingId, - ("id" .=) <$> _cceId, - ("artworkLabel" .=) <$> _cceArtworkLabel, - ("artworkType" .=) <$> _cceArtworkType]) - --- | Creative Click Tag. --- --- /See:/ 'clickTag' smart constructor. -data ClickTag = ClickTag' - { _ctClickThroughURL :: !(Maybe CreativeClickThroughURL) - , _ctName :: !(Maybe Text) - , _ctEventName :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'ClickTag' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'ctClickThroughURL' --- --- * 'ctName' --- --- * 'ctEventName' -clickTag - :: ClickTag -clickTag = - ClickTag' - { _ctClickThroughURL = Nothing - , _ctName = Nothing - , _ctEventName = Nothing - } - --- | Parameter value for the specified click tag. This field contains a --- click-through url. -ctClickThroughURL :: Lens' ClickTag (Maybe CreativeClickThroughURL) -ctClickThroughURL - = lens _ctClickThroughURL - (\ s a -> s{_ctClickThroughURL = a}) - --- | Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY --- creative assets, this field must match the value of the creative --- asset\'s creativeAssetId.name field. -ctName :: Lens' ClickTag (Maybe Text) -ctName = lens _ctName (\ s a -> s{_ctName = a}) - --- | Advertiser event name associated with the click tag. This field is used --- by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to --- DISPLAY when the primary asset type is not HTML_IMAGE. -ctEventName :: Lens' ClickTag (Maybe Text) -ctEventName - = lens _ctEventName (\ s a -> s{_ctEventName = a}) - -instance FromJSON ClickTag where - parseJSON - = withObject "ClickTag" - (\ o -> - ClickTag' <$> - (o .:? "clickThroughUrl") <*> (o .:? "name") <*> - (o .:? "eventName")) - -instance ToJSON ClickTag where - toJSON ClickTag'{..} - = object - (catMaybes - [("clickThroughUrl" .=) <$> _ctClickThroughURL, - ("name" .=) <$> _ctName, - ("eventName" .=) <$> _ctEventName]) - --- | Campaign List Response --- --- /See:/ 'campaignsListResponse' smart constructor. -data CampaignsListResponse = CampaignsListResponse' - { _clrNextPageToken :: !(Maybe Text) - , _clrCampaigns :: !(Maybe [Campaign]) - , _clrKind :: !Text - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'CampaignsListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'clrNextPageToken' --- --- * 'clrCampaigns' --- --- * 'clrKind' -campaignsListResponse - :: CampaignsListResponse -campaignsListResponse = - CampaignsListResponse' - { _clrNextPageToken = Nothing - , _clrCampaigns = Nothing - , _clrKind = "dfareporting#campaignsListResponse" - } - --- | Pagination token to be used for the next list operation. -clrNextPageToken :: Lens' CampaignsListResponse (Maybe Text) -clrNextPageToken - = lens _clrNextPageToken - (\ s a -> s{_clrNextPageToken = a}) - --- | Campaign collection. -clrCampaigns :: Lens' CampaignsListResponse [Campaign] -clrCampaigns - = lens _clrCampaigns (\ s a -> s{_clrCampaigns = a}) - . _Default - . _Coerce - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#campaignsListResponse\". -clrKind :: Lens' CampaignsListResponse Text -clrKind = lens _clrKind (\ s a -> s{_clrKind = a}) - -instance FromJSON CampaignsListResponse where - parseJSON - = withObject "CampaignsListResponse" - (\ o -> - CampaignsListResponse' <$> - (o .:? "nextPageToken") <*> - (o .:? "campaigns" .!= mempty) - <*> - (o .:? "kind" .!= - "dfareporting#campaignsListResponse")) - -instance ToJSON CampaignsListResponse where - toJSON CampaignsListResponse'{..} - = object - (catMaybes - [("nextPageToken" .=) <$> _clrNextPageToken, - ("campaigns" .=) <$> _clrCampaigns, - Just ("kind" .= _clrKind)]) - --- | Geographical Targeting. --- --- /See:/ 'geoTargeting' smart constructor. -data GeoTargeting = GeoTargeting' - { _gtRegions :: !(Maybe [Region]) - , _gtCountries :: !(Maybe [Country]) - , _gtCities :: !(Maybe [City]) - , _gtMetros :: !(Maybe [Metro]) - , _gtExcludeCountries :: !(Maybe Bool) - , _gtPostalCodes :: !(Maybe [PostalCode]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'GeoTargeting' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'gtRegions' --- --- * 'gtCountries' --- --- * 'gtCities' --- --- * 'gtMetros' --- --- * 'gtExcludeCountries' --- --- * 'gtPostalCodes' -geoTargeting - :: GeoTargeting -geoTargeting = - GeoTargeting' - { _gtRegions = Nothing - , _gtCountries = Nothing - , _gtCities = Nothing - , _gtMetros = Nothing - , _gtExcludeCountries = Nothing - , _gtPostalCodes = Nothing - } - --- | Regions to be targeted. For each region only dartId is required. The --- other fields are populated automatically when the ad is inserted or --- updated. If targeting a region, do not target or exclude the country of --- the region. -gtRegions :: Lens' GeoTargeting [Region] -gtRegions - = lens _gtRegions (\ s a -> s{_gtRegions = a}) . - _Default - . _Coerce - --- | Countries to be targeted or excluded from targeting, depending on the --- setting of the excludeCountries field. For each country only dartId is --- required. The other fields are populated automatically when the ad is --- inserted or updated. If targeting or excluding a country, do not target --- regions, cities, metros, or postal codes in the same country. -gtCountries :: Lens' GeoTargeting [Country] -gtCountries - = lens _gtCountries (\ s a -> s{_gtCountries = a}) . - _Default - . _Coerce - --- | Cities to be targeted. For each city only dartId is required. The other --- fields are populated automatically when the ad is inserted or updated. --- If targeting a city, do not target or exclude the country of the city, --- and do not target the metro or region of the city. -gtCities :: Lens' GeoTargeting [City] -gtCities - = lens _gtCities (\ s a -> s{_gtCities = a}) . - _Default - . _Coerce - --- | Metros to be targeted. For each metro only dmaId is required. The other --- fields are populated automatically when the ad is inserted or updated. --- If targeting a metro, do not target or exclude the country of the metro. -gtMetros :: Lens' GeoTargeting [Metro] -gtMetros - = lens _gtMetros (\ s a -> s{_gtMetros = a}) . - _Default - . _Coerce - --- | Whether or not to exclude the countries in the countries field from --- targeting. If false, the countries field refers to countries which will --- be targeted by the ad. -gtExcludeCountries :: Lens' GeoTargeting (Maybe Bool) -gtExcludeCountries - = lens _gtExcludeCountries - (\ s a -> s{_gtExcludeCountries = a}) - --- | Postal codes to be targeted. For each postal code only id is required. --- The other fields are populated automatically when the ad is inserted or --- updated. If targeting a postal code, do not target or exclude the --- country of the postal code. -gtPostalCodes :: Lens' GeoTargeting [PostalCode] -gtPostalCodes - = lens _gtPostalCodes - (\ s a -> s{_gtPostalCodes = a}) - . _Default - . _Coerce - -instance FromJSON GeoTargeting where - parseJSON - = withObject "GeoTargeting" - (\ o -> - GeoTargeting' <$> - (o .:? "regions" .!= mempty) <*> - (o .:? "countries" .!= mempty) - <*> (o .:? "cities" .!= mempty) - <*> (o .:? "metros" .!= mempty) - <*> (o .:? "excludeCountries") - <*> (o .:? "postalCodes" .!= mempty)) - -instance ToJSON GeoTargeting where - toJSON GeoTargeting'{..} - = object - (catMaybes - [("regions" .=) <$> _gtRegions, - ("countries" .=) <$> _gtCountries, - ("cities" .=) <$> _gtCities, - ("metros" .=) <$> _gtMetros, - ("excludeCountries" .=) <$> _gtExcludeCountries, - ("postalCodes" .=) <$> _gtPostalCodes]) - --- | Video Settings --- --- /See:/ 'videoSettings' smart constructor. -data VideoSettings = VideoSettings' - { _vsKind :: !Text - , _vsCompanionSettings :: !(Maybe CompanionSetting) - , _vsTranscodeSettings :: !(Maybe TranscodeSetting) - , _vsOrientation :: !(Maybe VideoSettingsOrientation) - , _vsSkippableSettings :: !(Maybe SkippableSetting) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'VideoSettings' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'vsKind' --- --- * 'vsCompanionSettings' --- --- * 'vsTranscodeSettings' --- --- * 'vsOrientation' --- --- * 'vsSkippableSettings' -videoSettings - :: VideoSettings -videoSettings = - VideoSettings' - { _vsKind = "dfareporting#videoSettings" - , _vsCompanionSettings = Nothing - , _vsTranscodeSettings = Nothing - , _vsOrientation = Nothing - , _vsSkippableSettings = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#videoSettings\". -vsKind :: Lens' VideoSettings Text -vsKind = lens _vsKind (\ s a -> s{_vsKind = a}) - --- | Settings for the companion creatives of video creatives served to this --- placement. -vsCompanionSettings :: Lens' VideoSettings (Maybe CompanionSetting) -vsCompanionSettings - = lens _vsCompanionSettings - (\ s a -> s{_vsCompanionSettings = a}) - --- | Settings for the transcodes of video creatives served to this placement. --- If this object is provided, the creative-level transcode settings will --- be overridden. -vsTranscodeSettings :: Lens' VideoSettings (Maybe TranscodeSetting) -vsTranscodeSettings - = lens _vsTranscodeSettings - (\ s a -> s{_vsTranscodeSettings = a}) - --- | Orientation of a video placement. If this value is set, placement will --- return assets matching the specified orientation. -vsOrientation :: Lens' VideoSettings (Maybe VideoSettingsOrientation) -vsOrientation - = lens _vsOrientation - (\ s a -> s{_vsOrientation = a}) - --- | Settings for the skippability of video creatives served to this --- placement. If this object is provided, the creative-level skippable --- settings will be overridden. -vsSkippableSettings :: Lens' VideoSettings (Maybe SkippableSetting) -vsSkippableSettings - = lens _vsSkippableSettings - (\ s a -> s{_vsSkippableSettings = a}) - -instance FromJSON VideoSettings where - parseJSON - = withObject "VideoSettings" - (\ o -> - VideoSettings' <$> - (o .:? "kind" .!= "dfareporting#videoSettings") <*> - (o .:? "companionSettings") - <*> (o .:? "transcodeSettings") - <*> (o .:? "orientation") - <*> (o .:? "skippableSettings")) - -instance ToJSON VideoSettings where - toJSON VideoSettings'{..} - = object - (catMaybes - [Just ("kind" .= _vsKind), - ("companionSettings" .=) <$> _vsCompanionSettings, - ("transcodeSettings" .=) <$> _vsTranscodeSettings, - ("orientation" .=) <$> _vsOrientation, - ("skippableSettings" .=) <$> _vsSkippableSettings]) - --- | Represents fields that are compatible to be selected for a report of --- type \"REACH\". --- --- /See:/ 'reachReportCompatibleFields' smart constructor. -data ReachReportCompatibleFields = ReachReportCompatibleFields' - { _rrcfMetrics :: !(Maybe [Metric]) - , _rrcfReachByFrequencyMetrics :: !(Maybe [Metric]) - , _rrcfKind :: !Text - , _rrcfDimensionFilters :: !(Maybe [Dimension]) - , _rrcfPivotedActivityMetrics :: !(Maybe [Metric]) - , _rrcfDimensions :: !(Maybe [Dimension]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'ReachReportCompatibleFields' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'rrcfMetrics' --- --- * 'rrcfReachByFrequencyMetrics' --- --- * 'rrcfKind' --- --- * 'rrcfDimensionFilters' --- --- * 'rrcfPivotedActivityMetrics' --- --- * 'rrcfDimensions' -reachReportCompatibleFields - :: ReachReportCompatibleFields -reachReportCompatibleFields = - ReachReportCompatibleFields' - { _rrcfMetrics = Nothing - , _rrcfReachByFrequencyMetrics = Nothing - , _rrcfKind = "dfareporting#reachReportCompatibleFields" - , _rrcfDimensionFilters = Nothing - , _rrcfPivotedActivityMetrics = Nothing - , _rrcfDimensions = Nothing - } - --- | Metrics which are compatible to be selected in the \"metricNames\" --- section of the report. -rrcfMetrics :: Lens' ReachReportCompatibleFields [Metric] -rrcfMetrics - = lens _rrcfMetrics (\ s a -> s{_rrcfMetrics = a}) . - _Default - . _Coerce - --- | Metrics which are compatible to be selected in the --- \"reachByFrequencyMetricNames\" section of the report. -rrcfReachByFrequencyMetrics :: Lens' ReachReportCompatibleFields [Metric] -rrcfReachByFrequencyMetrics - = lens _rrcfReachByFrequencyMetrics - (\ s a -> s{_rrcfReachByFrequencyMetrics = a}) - . _Default - . _Coerce - --- | The kind of resource this is, in this case --- dfareporting#reachReportCompatibleFields. -rrcfKind :: Lens' ReachReportCompatibleFields Text -rrcfKind = lens _rrcfKind (\ s a -> s{_rrcfKind = a}) - --- | Dimensions which are compatible to be selected in the --- \"dimensionFilters\" section of the report. -rrcfDimensionFilters :: Lens' ReachReportCompatibleFields [Dimension] -rrcfDimensionFilters - = lens _rrcfDimensionFilters - (\ s a -> s{_rrcfDimensionFilters = a}) - . _Default - . _Coerce - --- | Metrics which are compatible to be selected as activity metrics to pivot --- on in the \"activities\" section of the report. -rrcfPivotedActivityMetrics :: Lens' ReachReportCompatibleFields [Metric] -rrcfPivotedActivityMetrics - = lens _rrcfPivotedActivityMetrics - (\ s a -> s{_rrcfPivotedActivityMetrics = a}) - . _Default - . _Coerce - --- | Dimensions which are compatible to be selected in the \"dimensions\" --- section of the report. -rrcfDimensions :: Lens' ReachReportCompatibleFields [Dimension] -rrcfDimensions - = lens _rrcfDimensions - (\ s a -> s{_rrcfDimensions = a}) - . _Default - . _Coerce - -instance FromJSON ReachReportCompatibleFields where - parseJSON - = withObject "ReachReportCompatibleFields" - (\ o -> - ReachReportCompatibleFields' <$> - (o .:? "metrics" .!= mempty) <*> - (o .:? "reachByFrequencyMetrics" .!= mempty) - <*> - (o .:? "kind" .!= - "dfareporting#reachReportCompatibleFields") - <*> (o .:? "dimensionFilters" .!= mempty) - <*> (o .:? "pivotedActivityMetrics" .!= mempty) - <*> (o .:? "dimensions" .!= mempty)) - -instance ToJSON ReachReportCompatibleFields where - toJSON ReachReportCompatibleFields'{..} - = object - (catMaybes - [("metrics" .=) <$> _rrcfMetrics, - ("reachByFrequencyMetrics" .=) <$> - _rrcfReachByFrequencyMetrics, - Just ("kind" .= _rrcfKind), - ("dimensionFilters" .=) <$> _rrcfDimensionFilters, - ("pivotedActivityMetrics" .=) <$> - _rrcfPivotedActivityMetrics, - ("dimensions" .=) <$> _rrcfDimensions]) - --- | Contains information about a browser that can be targeted by ads. --- --- /See:/ 'browser' smart constructor. -data Browser = Browser' - { _bMinorVersion :: !(Maybe Text) - , _bKind :: !Text - , _bBrowserVersionId :: !(Maybe (Textual Int64)) - , _bMajorVersion :: !(Maybe Text) - , _bName :: !(Maybe Text) - , _bDartId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'Browser' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'bMinorVersion' --- --- * 'bKind' --- --- * 'bBrowserVersionId' --- --- * 'bMajorVersion' --- --- * 'bName' --- --- * 'bDartId' -browser - :: Browser -browser = - Browser' - { _bMinorVersion = Nothing - , _bKind = "dfareporting#browser" - , _bBrowserVersionId = Nothing - , _bMajorVersion = Nothing - , _bName = Nothing - , _bDartId = Nothing - } - --- | Minor version number (number after first dot on left) of this browser. --- For example, for Chrome 5.0.375.86 beta, this field should be set to 0. --- An asterisk (*) may be used to target any version number, and a question --- mark (?) may be used to target cases where the version number cannot be --- identified. For example, Chrome *.* targets any version of Chrome: 1.2, --- 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. --- Firefox ?.? targets cases where the ad server knows the browser is --- Firefox but can\'t tell which version it is. -bMinorVersion :: Lens' Browser (Maybe Text) -bMinorVersion - = lens _bMinorVersion - (\ s a -> s{_bMinorVersion = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#browser\". -bKind :: Lens' Browser Text -bKind = lens _bKind (\ s a -> s{_bKind = a}) - --- | ID referring to this grouping of browser and version numbers. This is --- the ID used for targeting. -bBrowserVersionId :: Lens' Browser (Maybe Int64) -bBrowserVersionId - = lens _bBrowserVersionId - (\ s a -> s{_bBrowserVersionId = a}) - . mapping _Coerce - --- | Major version number (leftmost number) of this browser. For example, for --- Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) --- may be used to target any version number, and a question mark (?) may be --- used to target cases where the version number cannot be identified. For --- example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so --- on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets --- cases where the ad server knows the browser is Firefox but can\'t tell --- which version it is. -bMajorVersion :: Lens' Browser (Maybe Text) -bMajorVersion - = lens _bMajorVersion - (\ s a -> s{_bMajorVersion = a}) - --- | Name of this browser. -bName :: Lens' Browser (Maybe Text) -bName = lens _bName (\ s a -> s{_bName = a}) - --- | DART ID of this browser. This is the ID used when generating reports. -bDartId :: Lens' Browser (Maybe Int64) -bDartId - = lens _bDartId (\ s a -> s{_bDartId = a}) . - mapping _Coerce - -instance FromJSON Browser where - parseJSON - = withObject "Browser" - (\ o -> - Browser' <$> - (o .:? "minorVersion") <*> - (o .:? "kind" .!= "dfareporting#browser") - <*> (o .:? "browserVersionId") - <*> (o .:? "majorVersion") - <*> (o .:? "name") - <*> (o .:? "dartId")) - -instance ToJSON Browser where - toJSON Browser'{..} - = object - (catMaybes - [("minorVersion" .=) <$> _bMinorVersion, - Just ("kind" .= _bKind), - ("browserVersionId" .=) <$> _bBrowserVersionId, - ("majorVersion" .=) <$> _bMajorVersion, - ("name" .=) <$> _bName, ("dartId" .=) <$> _bDartId]) - --- | Creative Group Assignment. --- --- /See:/ 'creativeGroupAssignment' smart constructor. -data CreativeGroupAssignment = CreativeGroupAssignment' - { _cgaCreativeGroupNumber :: !(Maybe CreativeGroupAssignmentCreativeGroupNumber) - , _cgaCreativeGroupId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'CreativeGroupAssignment' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'cgaCreativeGroupNumber' --- --- * 'cgaCreativeGroupId' -creativeGroupAssignment - :: CreativeGroupAssignment -creativeGroupAssignment = - CreativeGroupAssignment' - { _cgaCreativeGroupNumber = Nothing - , _cgaCreativeGroupId = Nothing - } - --- | Creative group number of the creative group assignment. -cgaCreativeGroupNumber :: Lens' CreativeGroupAssignment (Maybe CreativeGroupAssignmentCreativeGroupNumber) -cgaCreativeGroupNumber - = lens _cgaCreativeGroupNumber - (\ s a -> s{_cgaCreativeGroupNumber = a}) - --- | ID of the creative group to be assigned. -cgaCreativeGroupId :: Lens' CreativeGroupAssignment (Maybe Int64) -cgaCreativeGroupId - = lens _cgaCreativeGroupId - (\ s a -> s{_cgaCreativeGroupId = a}) - . mapping _Coerce - -instance FromJSON CreativeGroupAssignment where - parseJSON - = withObject "CreativeGroupAssignment" - (\ o -> - CreativeGroupAssignment' <$> - (o .:? "creativeGroupNumber") <*> - (o .:? "creativeGroupId")) - -instance ToJSON CreativeGroupAssignment where - toJSON CreativeGroupAssignment'{..} - = object - (catMaybes - [("creativeGroupNumber" .=) <$> - _cgaCreativeGroupNumber, - ("creativeGroupId" .=) <$> _cgaCreativeGroupId]) - --- | Directory Site Settings --- --- /See:/ 'directorySiteSettings' smart constructor. -data DirectorySiteSettings = DirectorySiteSettings' - { _dssInterstitialPlacementAccepted :: !(Maybe Bool) - , _dssInstreamVideoPlacementAccepted :: !(Maybe Bool) - , _dssVerificationTagOptOut :: !(Maybe Bool) - , _dssActiveViewOptOut :: !(Maybe Bool) - , _dssDfpSettings :: !(Maybe DfpSettings) - , _dssVideoActiveViewOptOut :: !(Maybe Bool) - , _dssNielsenOCROptOut :: !(Maybe Bool) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'DirectorySiteSettings' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'dssInterstitialPlacementAccepted' --- --- * 'dssInstreamVideoPlacementAccepted' --- --- * 'dssVerificationTagOptOut' --- --- * 'dssActiveViewOptOut' --- --- * 'dssDfpSettings' --- --- * 'dssVideoActiveViewOptOut' --- --- * 'dssNielsenOCROptOut' -directorySiteSettings - :: DirectorySiteSettings -directorySiteSettings = - DirectorySiteSettings' - { _dssInterstitialPlacementAccepted = Nothing - , _dssInstreamVideoPlacementAccepted = Nothing - , _dssVerificationTagOptOut = Nothing - , _dssActiveViewOptOut = Nothing - , _dssDfpSettings = Nothing - , _dssVideoActiveViewOptOut = Nothing - , _dssNielsenOCROptOut = Nothing - } - --- | Whether this site accepts interstitial ads. -dssInterstitialPlacementAccepted :: Lens' DirectorySiteSettings (Maybe Bool) -dssInterstitialPlacementAccepted - = lens _dssInterstitialPlacementAccepted - (\ s a -> s{_dssInterstitialPlacementAccepted = a}) - --- | Whether this site accepts in-stream video ads. -dssInstreamVideoPlacementAccepted :: Lens' DirectorySiteSettings (Maybe Bool) -dssInstreamVideoPlacementAccepted - = lens _dssInstreamVideoPlacementAccepted - (\ s a -> s{_dssInstreamVideoPlacementAccepted = a}) - --- | Whether this directory site has disabled generation of Verification ins --- tags. -dssVerificationTagOptOut :: Lens' DirectorySiteSettings (Maybe Bool) -dssVerificationTagOptOut - = lens _dssVerificationTagOptOut - (\ s a -> s{_dssVerificationTagOptOut = a}) - --- | Whether this directory site has disabled active view creatives. -dssActiveViewOptOut :: Lens' DirectorySiteSettings (Maybe Bool) -dssActiveViewOptOut - = lens _dssActiveViewOptOut - (\ s a -> s{_dssActiveViewOptOut = a}) - --- | Directory site Ad Manager settings. -dssDfpSettings :: Lens' DirectorySiteSettings (Maybe DfpSettings) -dssDfpSettings - = lens _dssDfpSettings - (\ s a -> s{_dssDfpSettings = a}) - --- | Whether this directory site has disabled active view for in-stream video --- creatives. This is a read-only field. -dssVideoActiveViewOptOut :: Lens' DirectorySiteSettings (Maybe Bool) -dssVideoActiveViewOptOut - = lens _dssVideoActiveViewOptOut - (\ s a -> s{_dssVideoActiveViewOptOut = a}) - --- | Whether this directory site has disabled Nielsen OCR reach ratings. -dssNielsenOCROptOut :: Lens' DirectorySiteSettings (Maybe Bool) -dssNielsenOCROptOut - = lens _dssNielsenOCROptOut - (\ s a -> s{_dssNielsenOCROptOut = a}) - -instance FromJSON DirectorySiteSettings where - parseJSON - = withObject "DirectorySiteSettings" - (\ o -> - DirectorySiteSettings' <$> - (o .:? "interstitialPlacementAccepted") <*> - (o .:? "instreamVideoPlacementAccepted") - <*> (o .:? "verificationTagOptOut") - <*> (o .:? "activeViewOptOut") - <*> (o .:? "dfpSettings") - <*> (o .:? "videoActiveViewOptOut") - <*> (o .:? "nielsenOcrOptOut")) - -instance ToJSON DirectorySiteSettings where - toJSON DirectorySiteSettings'{..} - = object - (catMaybes - [("interstitialPlacementAccepted" .=) <$> - _dssInterstitialPlacementAccepted, - ("instreamVideoPlacementAccepted" .=) <$> - _dssInstreamVideoPlacementAccepted, - ("verificationTagOptOut" .=) <$> - _dssVerificationTagOptOut, - ("activeViewOptOut" .=) <$> _dssActiveViewOptOut, - ("dfpSettings" .=) <$> _dssDfpSettings, - ("videoActiveViewOptOut" .=) <$> - _dssVideoActiveViewOptOut, - ("nielsenOcrOptOut" .=) <$> _dssNielsenOCROptOut]) - --- | Remarketing List Population Rule. --- --- /See:/ 'listPopulationRule' smart constructor. -data ListPopulationRule = ListPopulationRule' - { _lprFloodlightActivityName :: !(Maybe Text) - , _lprFloodlightActivityId :: !(Maybe (Textual Int64)) - , _lprListPopulationClauses :: !(Maybe [ListPopulationClause]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'ListPopulationRule' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'lprFloodlightActivityName' --- --- * 'lprFloodlightActivityId' --- --- * 'lprListPopulationClauses' -listPopulationRule - :: ListPopulationRule -listPopulationRule = - ListPopulationRule' - { _lprFloodlightActivityName = Nothing - , _lprFloodlightActivityId = Nothing - , _lprListPopulationClauses = Nothing - } - --- | Name of floodlight activity associated with this rule. This is a --- read-only, auto-generated field. -lprFloodlightActivityName :: Lens' ListPopulationRule (Maybe Text) -lprFloodlightActivityName - = lens _lprFloodlightActivityName - (\ s a -> s{_lprFloodlightActivityName = a}) - --- | Floodlight activity ID associated with this rule. This field can be left --- blank. -lprFloodlightActivityId :: Lens' ListPopulationRule (Maybe Int64) -lprFloodlightActivityId - = lens _lprFloodlightActivityId - (\ s a -> s{_lprFloodlightActivityId = a}) - . mapping _Coerce - --- | Clauses that make up this list population rule. Clauses are joined by --- ANDs, and the clauses themselves are made up of list population terms --- which are joined by ORs. -lprListPopulationClauses :: Lens' ListPopulationRule [ListPopulationClause] -lprListPopulationClauses - = lens _lprListPopulationClauses - (\ s a -> s{_lprListPopulationClauses = a}) - . _Default - . _Coerce - -instance FromJSON ListPopulationRule where - parseJSON - = withObject "ListPopulationRule" - (\ o -> - ListPopulationRule' <$> - (o .:? "floodlightActivityName") <*> - (o .:? "floodlightActivityId") - <*> (o .:? "listPopulationClauses" .!= mempty)) - -instance ToJSON ListPopulationRule where - toJSON ListPopulationRule'{..} - = object - (catMaybes - [("floodlightActivityName" .=) <$> - _lprFloodlightActivityName, - ("floodlightActivityId" .=) <$> - _lprFloodlightActivityId, - ("listPopulationClauses" .=) <$> - _lprListPopulationClauses]) - --- | Size List Response --- --- /See:/ 'sizesListResponse' smart constructor. -data SizesListResponse = SizesListResponse' - { _slrKind :: !Text - , _slrSizes :: !(Maybe [Size]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'SizesListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'slrKind' --- --- * 'slrSizes' -sizesListResponse - :: SizesListResponse -sizesListResponse = - SizesListResponse' - { _slrKind = "dfareporting#sizesListResponse" - , _slrSizes = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#sizesListResponse\". -slrKind :: Lens' SizesListResponse Text -slrKind = lens _slrKind (\ s a -> s{_slrKind = a}) - --- | Size collection. -slrSizes :: Lens' SizesListResponse [Size] -slrSizes - = lens _slrSizes (\ s a -> s{_slrSizes = a}) . - _Default - . _Coerce - -instance FromJSON SizesListResponse where - parseJSON - = withObject "SizesListResponse" - (\ o -> - SizesListResponse' <$> - (o .:? "kind" .!= "dfareporting#sizesListResponse") - <*> (o .:? "sizes" .!= mempty)) - -instance ToJSON SizesListResponse where - toJSON SizesListResponse'{..} - = object - (catMaybes - [Just ("kind" .= _slrKind), - ("sizes" .=) <$> _slrSizes]) - --- | Creative Rotation. --- --- /See:/ 'creativeRotation' smart constructor. -data CreativeRotation = CreativeRotation' - { _crWeightCalculationStrategy :: !(Maybe CreativeRotationWeightCalculationStrategy) - , _crCreativeAssignments :: !(Maybe [CreativeAssignment]) - , _crCreativeOptimizationConfigurationId :: !(Maybe (Textual Int64)) - , _crType :: !(Maybe CreativeRotationType) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'CreativeRotation' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'crWeightCalculationStrategy' --- --- * 'crCreativeAssignments' --- --- * 'crCreativeOptimizationConfigurationId' --- --- * 'crType' -creativeRotation - :: CreativeRotation -creativeRotation = - CreativeRotation' - { _crWeightCalculationStrategy = Nothing - , _crCreativeAssignments = Nothing - , _crCreativeOptimizationConfigurationId = Nothing - , _crType = Nothing - } - --- | Strategy for calculating weights. Used with --- CREATIVE_ROTATION_TYPE_RANDOM. -crWeightCalculationStrategy :: Lens' CreativeRotation (Maybe CreativeRotationWeightCalculationStrategy) -crWeightCalculationStrategy - = lens _crWeightCalculationStrategy - (\ s a -> s{_crWeightCalculationStrategy = a}) - --- | Creative assignments in this creative rotation. -crCreativeAssignments :: Lens' CreativeRotation [CreativeAssignment] -crCreativeAssignments - = lens _crCreativeAssignments - (\ s a -> s{_crCreativeAssignments = a}) - . _Default - . _Coerce - --- | Creative optimization configuration that is used by this ad. It should --- refer to one of the existing optimization configurations in the ad\'s --- campaign. If it is unset or set to 0, then the campaign\'s default --- optimization configuration will be used for this ad. -crCreativeOptimizationConfigurationId :: Lens' CreativeRotation (Maybe Int64) -crCreativeOptimizationConfigurationId - = lens _crCreativeOptimizationConfigurationId - (\ s a -> - s{_crCreativeOptimizationConfigurationId = a}) - . mapping _Coerce - --- | Type of creative rotation. Can be used to specify whether to use --- sequential or random rotation. -crType :: Lens' CreativeRotation (Maybe CreativeRotationType) -crType = lens _crType (\ s a -> s{_crType = a}) - -instance FromJSON CreativeRotation where - parseJSON - = withObject "CreativeRotation" - (\ o -> - CreativeRotation' <$> - (o .:? "weightCalculationStrategy") <*> - (o .:? "creativeAssignments" .!= mempty) - <*> (o .:? "creativeOptimizationConfigurationId") - <*> (o .:? "type")) - -instance ToJSON CreativeRotation where - toJSON CreativeRotation'{..} - = object - (catMaybes - [("weightCalculationStrategy" .=) <$> - _crWeightCalculationStrategy, - ("creativeAssignments" .=) <$> - _crCreativeAssignments, - ("creativeOptimizationConfigurationId" .=) <$> - _crCreativeOptimizationConfigurationId, - ("type" .=) <$> _crType]) - --- | Technology Targeting. --- --- /See:/ 'technologyTargeting' smart constructor. -data TechnologyTargeting = TechnologyTargeting' - { _ttMobileCarriers :: !(Maybe [MobileCarrier]) - , _ttOperatingSystemVersions :: !(Maybe [OperatingSystemVersion]) - , _ttPlatformTypes :: !(Maybe [PlatformType]) - , _ttBrowsers :: !(Maybe [Browser]) - , _ttConnectionTypes :: !(Maybe [ConnectionType]) - , _ttOperatingSystems :: !(Maybe [OperatingSystem]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'TechnologyTargeting' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'ttMobileCarriers' --- --- * 'ttOperatingSystemVersions' --- --- * 'ttPlatformTypes' --- --- * 'ttBrowsers' --- --- * 'ttConnectionTypes' --- --- * 'ttOperatingSystems' -technologyTargeting - :: TechnologyTargeting -technologyTargeting = - TechnologyTargeting' - { _ttMobileCarriers = Nothing - , _ttOperatingSystemVersions = Nothing - , _ttPlatformTypes = Nothing - , _ttBrowsers = Nothing - , _ttConnectionTypes = Nothing - , _ttOperatingSystems = Nothing - } - --- | Mobile carriers that this ad targets. For each mobile carrier only id is --- required, and the other fields are populated automatically when the ad --- is inserted or updated. If targeting a mobile carrier, do not set --- targeting for any zip codes. -ttMobileCarriers :: Lens' TechnologyTargeting [MobileCarrier] -ttMobileCarriers - = lens _ttMobileCarriers - (\ s a -> s{_ttMobileCarriers = a}) - . _Default - . _Coerce - --- | Operating system versions that this ad targets. To target all versions, --- use operatingSystems. For each operating system version, only id is --- required. The other fields are populated automatically when the ad is --- inserted or updated. If targeting an operating system version, do not --- set targeting for the corresponding operating system in --- operatingSystems. -ttOperatingSystemVersions :: Lens' TechnologyTargeting [OperatingSystemVersion] -ttOperatingSystemVersions - = lens _ttOperatingSystemVersions - (\ s a -> s{_ttOperatingSystemVersions = a}) - . _Default - . _Coerce - --- | Platform types that this ad targets. For example, desktop, mobile, or --- tablet. For each platform type, only id is required, and the other --- fields are populated automatically when the ad is inserted or updated. -ttPlatformTypes :: Lens' TechnologyTargeting [PlatformType] -ttPlatformTypes - = lens _ttPlatformTypes - (\ s a -> s{_ttPlatformTypes = a}) - . _Default - . _Coerce - --- | Browsers that this ad targets. For each browser either set --- browserVersionId or dartId along with the version numbers. If both are --- specified, only browserVersionId will be used. The other fields are --- populated automatically when the ad is inserted or updated. -ttBrowsers :: Lens' TechnologyTargeting [Browser] -ttBrowsers - = lens _ttBrowsers (\ s a -> s{_ttBrowsers = a}) . - _Default - . _Coerce - --- | Connection types that this ad targets. For each connection type only id --- is required. The other fields are populated automatically when the ad is --- inserted or updated. -ttConnectionTypes :: Lens' TechnologyTargeting [ConnectionType] -ttConnectionTypes - = lens _ttConnectionTypes - (\ s a -> s{_ttConnectionTypes = a}) - . _Default - . _Coerce - --- | Operating systems that this ad targets. To target specific versions, use --- operatingSystemVersions. For each operating system only dartId is --- required. The other fields are populated automatically when the ad is --- inserted or updated. If targeting an operating system, do not set --- targeting for operating system versions for the same operating system. -ttOperatingSystems :: Lens' TechnologyTargeting [OperatingSystem] -ttOperatingSystems - = lens _ttOperatingSystems - (\ s a -> s{_ttOperatingSystems = a}) - . _Default - . _Coerce - -instance FromJSON TechnologyTargeting where - parseJSON - = withObject "TechnologyTargeting" - (\ o -> - TechnologyTargeting' <$> - (o .:? "mobileCarriers" .!= mempty) <*> - (o .:? "operatingSystemVersions" .!= mempty) - <*> (o .:? "platformTypes" .!= mempty) - <*> (o .:? "browsers" .!= mempty) - <*> (o .:? "connectionTypes" .!= mempty) - <*> (o .:? "operatingSystems" .!= mempty)) - -instance ToJSON TechnologyTargeting where - toJSON TechnologyTargeting'{..} - = object - (catMaybes - [("mobileCarriers" .=) <$> _ttMobileCarriers, - ("operatingSystemVersions" .=) <$> - _ttOperatingSystemVersions, - ("platformTypes" .=) <$> _ttPlatformTypes, - ("browsers" .=) <$> _ttBrowsers, - ("connectionTypes" .=) <$> _ttConnectionTypes, - ("operatingSystems" .=) <$> _ttOperatingSystems]) - --- | Represents a buy from the Planning inventory store. --- --- /See:/ 'inventoryItem' smart constructor. -data InventoryItem = InventoryItem' - { _iiPlacementStrategyId :: !(Maybe (Textual Int64)) - , _iiEstimatedClickThroughRate :: !(Maybe (Textual Int64)) - , _iiPricing :: !(Maybe Pricing) - , _iiKind :: !Text - , _iiAdvertiserId :: !(Maybe (Textual Int64)) - , _iiRfpId :: !(Maybe (Textual Int64)) - , _iiContentCategoryId :: !(Maybe (Textual Int64)) - , _iiInPlan :: !(Maybe Bool) - , _iiAccountId :: !(Maybe (Textual Int64)) - , _iiName :: !(Maybe Text) - , _iiAdSlots :: !(Maybe [AdSlot]) - , _iiNegotiationChannelId :: !(Maybe (Textual Int64)) - , _iiLastModifiedInfo :: !(Maybe LastModifiedInfo) - , _iiId :: !(Maybe (Textual Int64)) - , _iiEstimatedConversionRate :: !(Maybe (Textual Int64)) - , _iiProjectId :: !(Maybe (Textual Int64)) - , _iiSubAccountId :: !(Maybe (Textual Int64)) - , _iiType :: !(Maybe InventoryItemType) - , _iiOrderId :: !(Maybe (Textual Int64)) - , _iiSiteId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'InventoryItem' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'iiPlacementStrategyId' --- --- * 'iiEstimatedClickThroughRate' --- --- * 'iiPricing' --- --- * 'iiKind' --- --- * 'iiAdvertiserId' --- --- * 'iiRfpId' --- --- * 'iiContentCategoryId' --- --- * 'iiInPlan' --- --- * 'iiAccountId' --- --- * 'iiName' --- --- * 'iiAdSlots' --- --- * 'iiNegotiationChannelId' --- --- * 'iiLastModifiedInfo' --- --- * 'iiId' --- --- * 'iiEstimatedConversionRate' --- --- * 'iiProjectId' --- --- * 'iiSubAccountId' --- --- * 'iiType' --- --- * 'iiOrderId' --- --- * 'iiSiteId' -inventoryItem - :: InventoryItem -inventoryItem = - InventoryItem' - { _iiPlacementStrategyId = Nothing - , _iiEstimatedClickThroughRate = Nothing - , _iiPricing = Nothing - , _iiKind = "dfareporting#inventoryItem" - , _iiAdvertiserId = Nothing - , _iiRfpId = Nothing - , _iiContentCategoryId = Nothing - , _iiInPlan = Nothing - , _iiAccountId = Nothing - , _iiName = Nothing - , _iiAdSlots = Nothing - , _iiNegotiationChannelId = Nothing - , _iiLastModifiedInfo = Nothing - , _iiId = Nothing - , _iiEstimatedConversionRate = Nothing - , _iiProjectId = Nothing - , _iiSubAccountId = Nothing - , _iiType = Nothing - , _iiOrderId = Nothing - , _iiSiteId = Nothing - } - --- | Placement strategy ID of this inventory item. -iiPlacementStrategyId :: Lens' InventoryItem (Maybe Int64) -iiPlacementStrategyId - = lens _iiPlacementStrategyId - (\ s a -> s{_iiPlacementStrategyId = a}) - . mapping _Coerce - --- | Estimated click-through rate of this inventory item. -iiEstimatedClickThroughRate :: Lens' InventoryItem (Maybe Int64) -iiEstimatedClickThroughRate - = lens _iiEstimatedClickThroughRate - (\ s a -> s{_iiEstimatedClickThroughRate = a}) - . mapping _Coerce - --- | Pricing of this inventory item. -iiPricing :: Lens' InventoryItem (Maybe Pricing) -iiPricing - = lens _iiPricing (\ s a -> s{_iiPricing = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#inventoryItem\". -iiKind :: Lens' InventoryItem Text -iiKind = lens _iiKind (\ s a -> s{_iiKind = a}) - --- | Advertiser ID of this inventory item. -iiAdvertiserId :: Lens' InventoryItem (Maybe Int64) -iiAdvertiserId - = lens _iiAdvertiserId - (\ s a -> s{_iiAdvertiserId = a}) - . mapping _Coerce - --- | RFP ID of this inventory item. -iiRfpId :: Lens' InventoryItem (Maybe Int64) -iiRfpId - = lens _iiRfpId (\ s a -> s{_iiRfpId = a}) . - mapping _Coerce - --- | Content category ID of this inventory item. -iiContentCategoryId :: Lens' InventoryItem (Maybe Int64) -iiContentCategoryId - = lens _iiContentCategoryId - (\ s a -> s{_iiContentCategoryId = a}) - . mapping _Coerce - --- | Whether this inventory item is in plan. -iiInPlan :: Lens' InventoryItem (Maybe Bool) -iiInPlan = lens _iiInPlan (\ s a -> s{_iiInPlan = a}) - --- | Account ID of this inventory item. -iiAccountId :: Lens' InventoryItem (Maybe Int64) -iiAccountId - = lens _iiAccountId (\ s a -> s{_iiAccountId = a}) . - mapping _Coerce - --- | Name of this inventory item. For standalone inventory items, this is the --- same name as that of its only ad slot. For group inventory items, this --- can differ from the name of any of its ad slots. -iiName :: Lens' InventoryItem (Maybe Text) -iiName = lens _iiName (\ s a -> s{_iiName = a}) - --- | Ad slots of this inventory item. If this inventory item represents a --- standalone placement, there will be exactly one ad slot. If this --- inventory item represents a placement group, there will be more than one --- ad slot, each representing one child placement in that placement group. -iiAdSlots :: Lens' InventoryItem [AdSlot] -iiAdSlots - = lens _iiAdSlots (\ s a -> s{_iiAdSlots = a}) . - _Default - . _Coerce - --- | Negotiation channel ID of this inventory item. -iiNegotiationChannelId :: Lens' InventoryItem (Maybe Int64) -iiNegotiationChannelId - = lens _iiNegotiationChannelId - (\ s a -> s{_iiNegotiationChannelId = a}) - . mapping _Coerce - --- | Information about the most recent modification of this inventory item. -iiLastModifiedInfo :: Lens' InventoryItem (Maybe LastModifiedInfo) -iiLastModifiedInfo - = lens _iiLastModifiedInfo - (\ s a -> s{_iiLastModifiedInfo = a}) - --- | ID of this inventory item. -iiId :: Lens' InventoryItem (Maybe Int64) -iiId - = lens _iiId (\ s a -> s{_iiId = a}) . - mapping _Coerce - --- | Estimated conversion rate of this inventory item. -iiEstimatedConversionRate :: Lens' InventoryItem (Maybe Int64) -iiEstimatedConversionRate - = lens _iiEstimatedConversionRate - (\ s a -> s{_iiEstimatedConversionRate = a}) - . mapping _Coerce - --- | Project ID of this inventory item. -iiProjectId :: Lens' InventoryItem (Maybe Int64) -iiProjectId - = lens _iiProjectId (\ s a -> s{_iiProjectId = a}) . - mapping _Coerce - --- | Subaccount ID of this inventory item. -iiSubAccountId :: Lens' InventoryItem (Maybe Int64) -iiSubAccountId - = lens _iiSubAccountId - (\ s a -> s{_iiSubAccountId = a}) - . mapping _Coerce - --- | Type of inventory item. -iiType :: Lens' InventoryItem (Maybe InventoryItemType) -iiType = lens _iiType (\ s a -> s{_iiType = a}) - --- | Order ID of this inventory item. -iiOrderId :: Lens' InventoryItem (Maybe Int64) -iiOrderId - = lens _iiOrderId (\ s a -> s{_iiOrderId = a}) . - mapping _Coerce - --- | ID of the site this inventory item is associated with. -iiSiteId :: Lens' InventoryItem (Maybe Int64) -iiSiteId - = lens _iiSiteId (\ s a -> s{_iiSiteId = a}) . - mapping _Coerce - -instance FromJSON InventoryItem where - parseJSON - = withObject "InventoryItem" - (\ o -> - InventoryItem' <$> - (o .:? "placementStrategyId") <*> - (o .:? "estimatedClickThroughRate") - <*> (o .:? "pricing") - <*> (o .:? "kind" .!= "dfareporting#inventoryItem") - <*> (o .:? "advertiserId") - <*> (o .:? "rfpId") - <*> (o .:? "contentCategoryId") - <*> (o .:? "inPlan") - <*> (o .:? "accountId") - <*> (o .:? "name") - <*> (o .:? "adSlots" .!= mempty) - <*> (o .:? "negotiationChannelId") - <*> (o .:? "lastModifiedInfo") - <*> (o .:? "id") - <*> (o .:? "estimatedConversionRate") - <*> (o .:? "projectId") - <*> (o .:? "subaccountId") - <*> (o .:? "type") - <*> (o .:? "orderId") - <*> (o .:? "siteId")) - -instance ToJSON InventoryItem where - toJSON InventoryItem'{..} - = object - (catMaybes - [("placementStrategyId" .=) <$> - _iiPlacementStrategyId, - ("estimatedClickThroughRate" .=) <$> - _iiEstimatedClickThroughRate, - ("pricing" .=) <$> _iiPricing, - Just ("kind" .= _iiKind), - ("advertiserId" .=) <$> _iiAdvertiserId, - ("rfpId" .=) <$> _iiRfpId, - ("contentCategoryId" .=) <$> _iiContentCategoryId, - ("inPlan" .=) <$> _iiInPlan, - ("accountId" .=) <$> _iiAccountId, - ("name" .=) <$> _iiName, - ("adSlots" .=) <$> _iiAdSlots, - ("negotiationChannelId" .=) <$> - _iiNegotiationChannelId, - ("lastModifiedInfo" .=) <$> _iiLastModifiedInfo, - ("id" .=) <$> _iiId, - ("estimatedConversionRate" .=) <$> - _iiEstimatedConversionRate, - ("projectId" .=) <$> _iiProjectId, - ("subaccountId" .=) <$> _iiSubAccountId, - ("type" .=) <$> _iiType, - ("orderId" .=) <$> _iiOrderId, - ("siteId" .=) <$> _iiSiteId]) - --- | Project List Response --- --- /See:/ 'projectsListResponse' smart constructor. -data ProjectsListResponse = ProjectsListResponse' - { _plrNextPageToken :: !(Maybe Text) - , _plrKind :: !Text - , _plrProjects :: !(Maybe [Project]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'ProjectsListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'plrNextPageToken' --- --- * 'plrKind' --- --- * 'plrProjects' -projectsListResponse - :: ProjectsListResponse -projectsListResponse = - ProjectsListResponse' - { _plrNextPageToken = Nothing - , _plrKind = "dfareporting#projectsListResponse" - , _plrProjects = Nothing - } - --- | Pagination token to be used for the next list operation. -plrNextPageToken :: Lens' ProjectsListResponse (Maybe Text) -plrNextPageToken - = lens _plrNextPageToken - (\ s a -> s{_plrNextPageToken = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#projectsListResponse\". -plrKind :: Lens' ProjectsListResponse Text -plrKind = lens _plrKind (\ s a -> s{_plrKind = a}) - --- | Project collection. -plrProjects :: Lens' ProjectsListResponse [Project] -plrProjects - = lens _plrProjects (\ s a -> s{_plrProjects = a}) . - _Default - . _Coerce - -instance FromJSON ProjectsListResponse where - parseJSON - = withObject "ProjectsListResponse" - (\ o -> - ProjectsListResponse' <$> - (o .:? "nextPageToken") <*> - (o .:? "kind" .!= - "dfareporting#projectsListResponse") - <*> (o .:? "projects" .!= mempty)) - -instance ToJSON ProjectsListResponse where - toJSON ProjectsListResponse'{..} - = object - (catMaybes - [("nextPageToken" .=) <$> _plrNextPageToken, - Just ("kind" .= _plrKind), - ("projects" .=) <$> _plrProjects]) - --- | Ad List Response --- --- /See:/ 'adsListResponse' smart constructor. -data AdsListResponse = AdsListResponse' - { _alrNextPageToken :: !(Maybe Text) - , _alrKind :: !Text - , _alrAds :: !(Maybe [Ad]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'AdsListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'alrNextPageToken' --- --- * 'alrKind' --- --- * 'alrAds' -adsListResponse - :: AdsListResponse -adsListResponse = - AdsListResponse' - { _alrNextPageToken = Nothing - , _alrKind = "dfareporting#adsListResponse" - , _alrAds = Nothing - } - --- | Pagination token to be used for the next list operation. -alrNextPageToken :: Lens' AdsListResponse (Maybe Text) -alrNextPageToken - = lens _alrNextPageToken - (\ s a -> s{_alrNextPageToken = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#adsListResponse\". -alrKind :: Lens' AdsListResponse Text -alrKind = lens _alrKind (\ s a -> s{_alrKind = a}) - --- | Ad collection. -alrAds :: Lens' AdsListResponse [Ad] -alrAds - = lens _alrAds (\ s a -> s{_alrAds = a}) . _Default . - _Coerce - -instance FromJSON AdsListResponse where - parseJSON - = withObject "AdsListResponse" - (\ o -> - AdsListResponse' <$> - (o .:? "nextPageToken") <*> - (o .:? "kind" .!= "dfareporting#adsListResponse") - <*> (o .:? "ads" .!= mempty)) - -instance ToJSON AdsListResponse where - toJSON AdsListResponse'{..} - = object - (catMaybes - [("nextPageToken" .=) <$> _alrNextPageToken, - Just ("kind" .= _alrKind), ("ads" .=) <$> _alrAds]) - --- | Remarketing List Population Rule Term. --- --- /See:/ 'listPopulationTerm' smart constructor. -data ListPopulationTerm = ListPopulationTerm' - { _lptOperator :: !(Maybe ListPopulationTermOperator) - , _lptValue :: !(Maybe Text) - , _lptVariableFriendlyName :: !(Maybe Text) - , _lptNegation :: !(Maybe Bool) - , _lptVariableName :: !(Maybe Text) - , _lptRemarketingListId :: !(Maybe (Textual Int64)) - , _lptType :: !(Maybe ListPopulationTermType) - , _lptContains :: !(Maybe Bool) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'ListPopulationTerm' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'lptOperator' --- --- * 'lptValue' --- --- * 'lptVariableFriendlyName' --- --- * 'lptNegation' --- --- * 'lptVariableName' --- --- * 'lptRemarketingListId' --- --- * 'lptType' --- --- * 'lptContains' -listPopulationTerm - :: ListPopulationTerm -listPopulationTerm = - ListPopulationTerm' - { _lptOperator = Nothing - , _lptValue = Nothing - , _lptVariableFriendlyName = Nothing - , _lptNegation = Nothing - , _lptVariableName = Nothing - , _lptRemarketingListId = Nothing - , _lptType = Nothing - , _lptContains = Nothing - } - --- | Comparison operator of this term. This field is only relevant when type --- is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. -lptOperator :: Lens' ListPopulationTerm (Maybe ListPopulationTermOperator) -lptOperator - = lens _lptOperator (\ s a -> s{_lptOperator = a}) - --- | Literal to compare the variable to. This field is only relevant when --- type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. -lptValue :: Lens' ListPopulationTerm (Maybe Text) -lptValue = lens _lptValue (\ s a -> s{_lptValue = a}) - --- | Friendly name of this term\'s variable. This is a read-only, --- auto-generated field. This field is only relevant when type is left --- unset or set to CUSTOM_VARIABLE_TERM. -lptVariableFriendlyName :: Lens' ListPopulationTerm (Maybe Text) -lptVariableFriendlyName - = lens _lptVariableFriendlyName - (\ s a -> s{_lptVariableFriendlyName = a}) - --- | Whether to negate the comparison result of this term during rule --- evaluation. This field is only relevant when type is left unset or set --- to CUSTOM_VARIABLE_TERM or REFERRER_TERM. -lptNegation :: Lens' ListPopulationTerm (Maybe Bool) -lptNegation - = lens _lptNegation (\ s a -> s{_lptNegation = a}) - --- | Name of the variable (U1, U2, etc.) being compared in this term. This --- field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or --- REFERRER_TERM. -lptVariableName :: Lens' ListPopulationTerm (Maybe Text) -lptVariableName - = lens _lptVariableName - (\ s a -> s{_lptVariableName = a}) - --- | ID of the list in question. This field is only relevant when type is set --- to LIST_MEMBERSHIP_TERM. -lptRemarketingListId :: Lens' ListPopulationTerm (Maybe Int64) -lptRemarketingListId - = lens _lptRemarketingListId - (\ s a -> s{_lptRemarketingListId = a}) - . mapping _Coerce - --- | List population term type determines the applicable fields in this --- object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, --- variableFriendlyName, operator, value, and negation are applicable. If --- set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are --- applicable. If set to REFERRER_TERM then operator, value, and negation --- are applicable. -lptType :: Lens' ListPopulationTerm (Maybe ListPopulationTermType) -lptType = lens _lptType (\ s a -> s{_lptType = a}) - --- | Will be true if the term should check if the user is in the list and --- false if the term should check if the user is not in the list. This --- field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False --- by default. -lptContains :: Lens' ListPopulationTerm (Maybe Bool) -lptContains - = lens _lptContains (\ s a -> s{_lptContains = a}) - -instance FromJSON ListPopulationTerm where - parseJSON - = withObject "ListPopulationTerm" - (\ o -> - ListPopulationTerm' <$> - (o .:? "operator") <*> (o .:? "value") <*> - (o .:? "variableFriendlyName") - <*> (o .:? "negation") - <*> (o .:? "variableName") - <*> (o .:? "remarketingListId") - <*> (o .:? "type") - <*> (o .:? "contains")) - -instance ToJSON ListPopulationTerm where - toJSON ListPopulationTerm'{..} - = object - (catMaybes - [("operator" .=) <$> _lptOperator, - ("value" .=) <$> _lptValue, - ("variableFriendlyName" .=) <$> - _lptVariableFriendlyName, - ("negation" .=) <$> _lptNegation, - ("variableName" .=) <$> _lptVariableName, - ("remarketingListId" .=) <$> _lptRemarketingListId, - ("type" .=) <$> _lptType, - ("contains" .=) <$> _lptContains]) - --- | Dynamic and Image Tag Settings. --- --- /See:/ 'tagSettings' smart constructor. -data TagSettings = TagSettings' - { _tsDynamicTagEnabled :: !(Maybe Bool) - , _tsImageTagEnabled :: !(Maybe Bool) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'TagSettings' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'tsDynamicTagEnabled' --- --- * 'tsImageTagEnabled' -tagSettings - :: TagSettings -tagSettings = - TagSettings' - { _tsDynamicTagEnabled = Nothing - , _tsImageTagEnabled = Nothing - } - --- | Whether dynamic floodlight tags are enabled. -tsDynamicTagEnabled :: Lens' TagSettings (Maybe Bool) -tsDynamicTagEnabled - = lens _tsDynamicTagEnabled - (\ s a -> s{_tsDynamicTagEnabled = a}) - --- | Whether image tags are enabled. -tsImageTagEnabled :: Lens' TagSettings (Maybe Bool) -tsImageTagEnabled - = lens _tsImageTagEnabled - (\ s a -> s{_tsImageTagEnabled = a}) - -instance FromJSON TagSettings where - parseJSON - = withObject "TagSettings" - (\ o -> - TagSettings' <$> - (o .:? "dynamicTagEnabled") <*> - (o .:? "imageTagEnabled")) - -instance ToJSON TagSettings where - toJSON TagSettings'{..} - = object - (catMaybes - [("dynamicTagEnabled" .=) <$> _tsDynamicTagEnabled, - ("imageTagEnabled" .=) <$> _tsImageTagEnabled]) - --- | Subaccount List Response --- --- /See:/ 'subAccountsListResponse' smart constructor. -data SubAccountsListResponse = SubAccountsListResponse' - { _salrNextPageToken :: !(Maybe Text) - , _salrKind :: !Text - , _salrSubAccounts :: !(Maybe [SubAccount]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'SubAccountsListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'salrNextPageToken' --- --- * 'salrKind' --- --- * 'salrSubAccounts' -subAccountsListResponse - :: SubAccountsListResponse -subAccountsListResponse = - SubAccountsListResponse' - { _salrNextPageToken = Nothing - , _salrKind = "dfareporting#subaccountsListResponse" - , _salrSubAccounts = Nothing - } - --- | Pagination token to be used for the next list operation. -salrNextPageToken :: Lens' SubAccountsListResponse (Maybe Text) -salrNextPageToken - = lens _salrNextPageToken - (\ s a -> s{_salrNextPageToken = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#subaccountsListResponse\". -salrKind :: Lens' SubAccountsListResponse Text -salrKind = lens _salrKind (\ s a -> s{_salrKind = a}) - --- | Subaccount collection. -salrSubAccounts :: Lens' SubAccountsListResponse [SubAccount] -salrSubAccounts - = lens _salrSubAccounts - (\ s a -> s{_salrSubAccounts = a}) - . _Default - . _Coerce - -instance FromJSON SubAccountsListResponse where - parseJSON - = withObject "SubAccountsListResponse" - (\ o -> - SubAccountsListResponse' <$> - (o .:? "nextPageToken") <*> - (o .:? "kind" .!= - "dfareporting#subaccountsListResponse") - <*> (o .:? "subaccounts" .!= mempty)) - -instance ToJSON SubAccountsListResponse where - toJSON SubAccountsListResponse'{..} - = object - (catMaybes - [("nextPageToken" .=) <$> _salrNextPageToken, - Just ("kind" .= _salrKind), - ("subaccounts" .=) <$> _salrSubAccounts]) - --- | Contains properties of a Site Directory contact. --- --- /See:/ 'directorySiteContact' smart constructor. -data DirectorySiteContact = DirectorySiteContact' - { _dscEmail :: !(Maybe Text) - , _dscPhone :: !(Maybe Text) - , _dscLastName :: !(Maybe Text) - , _dscKind :: !Text - , _dscAddress :: !(Maybe Text) - , _dscRole :: !(Maybe DirectorySiteContactRole) - , _dscFirstName :: !(Maybe Text) - , _dscId :: !(Maybe (Textual Int64)) - , _dscTitle :: !(Maybe Text) - , _dscType :: !(Maybe DirectorySiteContactType) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'DirectorySiteContact' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'dscEmail' --- --- * 'dscPhone' --- --- * 'dscLastName' --- --- * 'dscKind' --- --- * 'dscAddress' --- --- * 'dscRole' --- --- * 'dscFirstName' --- --- * 'dscId' --- --- * 'dscTitle' --- --- * 'dscType' -directorySiteContact - :: DirectorySiteContact -directorySiteContact = - DirectorySiteContact' - { _dscEmail = Nothing - , _dscPhone = Nothing - , _dscLastName = Nothing - , _dscKind = "dfareporting#directorySiteContact" - , _dscAddress = Nothing - , _dscRole = Nothing - , _dscFirstName = Nothing - , _dscId = Nothing - , _dscTitle = Nothing - , _dscType = Nothing - } - --- | Email address of this directory site contact. -dscEmail :: Lens' DirectorySiteContact (Maybe Text) -dscEmail = lens _dscEmail (\ s a -> s{_dscEmail = a}) - --- | Phone number of this directory site contact. -dscPhone :: Lens' DirectorySiteContact (Maybe Text) -dscPhone = lens _dscPhone (\ s a -> s{_dscPhone = a}) - --- | Last name of this directory site contact. -dscLastName :: Lens' DirectorySiteContact (Maybe Text) -dscLastName - = lens _dscLastName (\ s a -> s{_dscLastName = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#directorySiteContact\". -dscKind :: Lens' DirectorySiteContact Text -dscKind = lens _dscKind (\ s a -> s{_dscKind = a}) - --- | Address of this directory site contact. -dscAddress :: Lens' DirectorySiteContact (Maybe Text) -dscAddress - = lens _dscAddress (\ s a -> s{_dscAddress = a}) - --- | Directory site contact role. -dscRole :: Lens' DirectorySiteContact (Maybe DirectorySiteContactRole) -dscRole = lens _dscRole (\ s a -> s{_dscRole = a}) - --- | First name of this directory site contact. -dscFirstName :: Lens' DirectorySiteContact (Maybe Text) -dscFirstName - = lens _dscFirstName (\ s a -> s{_dscFirstName = a}) - --- | ID of this directory site contact. This is a read-only, auto-generated --- field. -dscId :: Lens' DirectorySiteContact (Maybe Int64) -dscId - = lens _dscId (\ s a -> s{_dscId = a}) . - mapping _Coerce - --- | Title or designation of this directory site contact. -dscTitle :: Lens' DirectorySiteContact (Maybe Text) -dscTitle = lens _dscTitle (\ s a -> s{_dscTitle = a}) - --- | Directory site contact type. -dscType :: Lens' DirectorySiteContact (Maybe DirectorySiteContactType) -dscType = lens _dscType (\ s a -> s{_dscType = a}) - -instance FromJSON DirectorySiteContact where - parseJSON - = withObject "DirectorySiteContact" - (\ o -> - DirectorySiteContact' <$> - (o .:? "email") <*> (o .:? "phone") <*> - (o .:? "lastName") - <*> - (o .:? "kind" .!= - "dfareporting#directorySiteContact") - <*> (o .:? "address") - <*> (o .:? "role") - <*> (o .:? "firstName") - <*> (o .:? "id") - <*> (o .:? "title") - <*> (o .:? "type")) - -instance ToJSON DirectorySiteContact where - toJSON DirectorySiteContact'{..} - = object - (catMaybes - [("email" .=) <$> _dscEmail, - ("phone" .=) <$> _dscPhone, - ("lastName" .=) <$> _dscLastName, - Just ("kind" .= _dscKind), - ("address" .=) <$> _dscAddress, - ("role" .=) <$> _dscRole, - ("firstName" .=) <$> _dscFirstName, - ("id" .=) <$> _dscId, ("title" .=) <$> _dscTitle, - ("type" .=) <$> _dscType]) - --- | Region List Response --- --- /See:/ 'regionsListResponse' smart constructor. -data RegionsListResponse = RegionsListResponse' - { _rlrKind :: !Text - , _rlrRegions :: !(Maybe [Region]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'RegionsListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'rlrKind' --- --- * 'rlrRegions' -regionsListResponse - :: RegionsListResponse -regionsListResponse = - RegionsListResponse' - { _rlrKind = "dfareporting#regionsListResponse" - , _rlrRegions = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#regionsListResponse\". -rlrKind :: Lens' RegionsListResponse Text -rlrKind = lens _rlrKind (\ s a -> s{_rlrKind = a}) - --- | Region collection. -rlrRegions :: Lens' RegionsListResponse [Region] -rlrRegions - = lens _rlrRegions (\ s a -> s{_rlrRegions = a}) . - _Default - . _Coerce - -instance FromJSON RegionsListResponse where - parseJSON - = withObject "RegionsListResponse" - (\ o -> - RegionsListResponse' <$> - (o .:? "kind" .!= "dfareporting#regionsListResponse") - <*> (o .:? "regions" .!= mempty)) - -instance ToJSON RegionsListResponse where - toJSON RegionsListResponse'{..} - = object - (catMaybes - [Just ("kind" .= _rlrKind), - ("regions" .=) <$> _rlrRegions]) - --- | Dynamic Tag --- --- /See:/ 'floodlightActivityDynamicTag' smart constructor. -data FloodlightActivityDynamicTag = FloodlightActivityDynamicTag' - { _fadtTag :: !(Maybe Text) - , _fadtName :: !(Maybe Text) - , _fadtId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'FloodlightActivityDynamicTag' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'fadtTag' --- --- * 'fadtName' --- --- * 'fadtId' -floodlightActivityDynamicTag - :: FloodlightActivityDynamicTag -floodlightActivityDynamicTag = - FloodlightActivityDynamicTag' - { _fadtTag = Nothing - , _fadtName = Nothing - , _fadtId = Nothing - } - --- | Tag code. -fadtTag :: Lens' FloodlightActivityDynamicTag (Maybe Text) -fadtTag = lens _fadtTag (\ s a -> s{_fadtTag = a}) - --- | Name of this tag. -fadtName :: Lens' FloodlightActivityDynamicTag (Maybe Text) -fadtName = lens _fadtName (\ s a -> s{_fadtName = a}) - --- | ID of this dynamic tag. This is a read-only, auto-generated field. -fadtId :: Lens' FloodlightActivityDynamicTag (Maybe Int64) -fadtId - = lens _fadtId (\ s a -> s{_fadtId = a}) . - mapping _Coerce - -instance FromJSON FloodlightActivityDynamicTag where - parseJSON - = withObject "FloodlightActivityDynamicTag" - (\ o -> - FloodlightActivityDynamicTag' <$> - (o .:? "tag") <*> (o .:? "name") <*> (o .:? "id")) - -instance ToJSON FloodlightActivityDynamicTag where - toJSON FloodlightActivityDynamicTag'{..} - = object - (catMaybes - [("tag" .=) <$> _fadtTag, ("name" .=) <$> _fadtName, - ("id" .=) <$> _fadtId]) - --- | Contains information about supported video formats. --- --- /See:/ 'videoFormat' smart constructor. -data VideoFormat = VideoFormat' - { _vfKind :: !Text - , _vfFileType :: !(Maybe VideoFormatFileType) - , _vfResolution :: !(Maybe Size) - , _vfTargetBitRate :: !(Maybe (Textual Int32)) - , _vfId :: !(Maybe (Textual Int32)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'VideoFormat' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'vfKind' --- --- * 'vfFileType' --- --- * 'vfResolution' --- --- * 'vfTargetBitRate' --- --- * 'vfId' -videoFormat - :: VideoFormat -videoFormat = - VideoFormat' - { _vfKind = "dfareporting#videoFormat" - , _vfFileType = Nothing - , _vfResolution = Nothing - , _vfTargetBitRate = Nothing - , _vfId = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#videoFormat\". -vfKind :: Lens' VideoFormat Text -vfKind = lens _vfKind (\ s a -> s{_vfKind = a}) - --- | File type of the video format. -vfFileType :: Lens' VideoFormat (Maybe VideoFormatFileType) -vfFileType - = lens _vfFileType (\ s a -> s{_vfFileType = a}) - --- | The resolution of this video format. -vfResolution :: Lens' VideoFormat (Maybe Size) -vfResolution - = lens _vfResolution (\ s a -> s{_vfResolution = a}) - --- | The target bit rate of this video format. -vfTargetBitRate :: Lens' VideoFormat (Maybe Int32) -vfTargetBitRate - = lens _vfTargetBitRate - (\ s a -> s{_vfTargetBitRate = a}) - . mapping _Coerce - --- | ID of the video format. -vfId :: Lens' VideoFormat (Maybe Int32) -vfId - = lens _vfId (\ s a -> s{_vfId = a}) . - mapping _Coerce - -instance FromJSON VideoFormat where - parseJSON - = withObject "VideoFormat" - (\ o -> - VideoFormat' <$> - (o .:? "kind" .!= "dfareporting#videoFormat") <*> - (o .:? "fileType") - <*> (o .:? "resolution") - <*> (o .:? "targetBitRate") - <*> (o .:? "id")) - -instance ToJSON VideoFormat where - toJSON VideoFormat'{..} - = object - (catMaybes - [Just ("kind" .= _vfKind), - ("fileType" .=) <$> _vfFileType, - ("resolution" .=) <$> _vfResolution, - ("targetBitRate" .=) <$> _vfTargetBitRate, - ("id" .=) <$> _vfId]) - --- | DirectorySites contains properties of a website from the Site Directory. --- Sites need to be added to an account via the Sites resource before they --- can be assigned to a placement. --- --- /See:/ 'directorySite' smart constructor. -data DirectorySite = DirectorySite' - { _dsCurrencyId :: !(Maybe (Textual Int64)) - , _dsSettings :: !(Maybe DirectorySiteSettings) - , _dsInterstitialTagFormats :: !(Maybe [DirectorySiteInterstitialTagFormatsItem]) - , _dsKind :: !Text - , _dsURL :: !(Maybe Text) - , _dsIdDimensionValue :: !(Maybe DimensionValue) - , _dsInpageTagFormats :: !(Maybe [DirectorySiteInpageTagFormatsItem]) - , _dsActive :: !(Maybe Bool) - , _dsName :: !(Maybe Text) - , _dsId :: !(Maybe (Textual Int64)) - , _dsCountryId :: !(Maybe (Textual Int64)) - , _dsContactAssignments :: !(Maybe [DirectorySiteContactAssignment]) - , _dsDescription :: !(Maybe Text) - , _dsParentId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'DirectorySite' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'dsCurrencyId' --- --- * 'dsSettings' --- --- * 'dsInterstitialTagFormats' --- --- * 'dsKind' --- --- * 'dsURL' --- --- * 'dsIdDimensionValue' --- --- * 'dsInpageTagFormats' --- --- * 'dsActive' --- --- * 'dsName' --- --- * 'dsId' --- --- * 'dsCountryId' --- --- * 'dsContactAssignments' --- --- * 'dsDescription' --- --- * 'dsParentId' -directorySite - :: DirectorySite -directorySite = - DirectorySite' - { _dsCurrencyId = Nothing - , _dsSettings = Nothing - , _dsInterstitialTagFormats = Nothing - , _dsKind = "dfareporting#directorySite" - , _dsURL = Nothing - , _dsIdDimensionValue = Nothing - , _dsInpageTagFormats = Nothing - , _dsActive = Nothing - , _dsName = Nothing - , _dsId = Nothing - , _dsCountryId = Nothing - , _dsContactAssignments = Nothing - , _dsDescription = Nothing - , _dsParentId = Nothing - } - --- | Currency ID of this directory site. This is a read-only field. Possible --- values are: - \"1\" for USD - \"2\" for GBP - \"3\" for ESP - \"4\" for --- SEK - \"5\" for CAD - \"6\" for JPY - \"7\" for DEM - \"8\" for AUD - --- \"9\" for FRF - \"10\" for ITL - \"11\" for DKK - \"12\" for NOK - --- \"13\" for FIM - \"14\" for ZAR - \"15\" for IEP - \"16\" for NLG - --- \"17\" for EUR - \"18\" for KRW - \"19\" for TWD - \"20\" for SGD - --- \"21\" for CNY - \"22\" for HKD - \"23\" for NZD - \"24\" for MYR - --- \"25\" for BRL - \"26\" for PTE - \"27\" for MXP - \"28\" for CLP - --- \"29\" for TRY - \"30\" for ARS - \"31\" for PEN - \"32\" for ILS - --- \"33\" for CHF - \"34\" for VEF - \"35\" for COP - \"36\" for GTQ - --- \"37\" for PLN - \"39\" for INR - \"40\" for THB - \"41\" for IDR - --- \"42\" for CZK - \"43\" for RON - \"44\" for HUF - \"45\" for RUB - --- \"46\" for AED - \"47\" for BGN - \"48\" for HRK - \"49\" for MXN - --- \"50\" for NGN -dsCurrencyId :: Lens' DirectorySite (Maybe Int64) -dsCurrencyId - = lens _dsCurrencyId (\ s a -> s{_dsCurrencyId = a}) - . mapping _Coerce - --- | Directory site settings. -dsSettings :: Lens' DirectorySite (Maybe DirectorySiteSettings) -dsSettings - = lens _dsSettings (\ s a -> s{_dsSettings = a}) - --- | Tag types for interstitial placements. Acceptable values are: - --- \"IFRAME_JAVASCRIPT_INTERSTITIAL\" - \"INTERNAL_REDIRECT_INTERSTITIAL\" --- - \"JAVASCRIPT_INTERSTITIAL\" -dsInterstitialTagFormats :: Lens' DirectorySite [DirectorySiteInterstitialTagFormatsItem] -dsInterstitialTagFormats - = lens _dsInterstitialTagFormats - (\ s a -> s{_dsInterstitialTagFormats = a}) - . _Default - . _Coerce - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#directorySite\". -dsKind :: Lens' DirectorySite Text -dsKind = lens _dsKind (\ s a -> s{_dsKind = a}) - --- | URL of this directory site. -dsURL :: Lens' DirectorySite (Maybe Text) -dsURL = lens _dsURL (\ s a -> s{_dsURL = a}) - --- | Dimension value for the ID of this directory site. This is a read-only, --- auto-generated field. -dsIdDimensionValue :: Lens' DirectorySite (Maybe DimensionValue) -dsIdDimensionValue - = lens _dsIdDimensionValue - (\ s a -> s{_dsIdDimensionValue = a}) - --- | Tag types for regular placements. Acceptable values are: - \"STANDARD\" --- - \"IFRAME_JAVASCRIPT_INPAGE\" - \"INTERNAL_REDIRECT_INPAGE\" - --- \"JAVASCRIPT_INPAGE\" -dsInpageTagFormats :: Lens' DirectorySite [DirectorySiteInpageTagFormatsItem] -dsInpageTagFormats - = lens _dsInpageTagFormats - (\ s a -> s{_dsInpageTagFormats = a}) - . _Default - . _Coerce - --- | Whether this directory site is active. -dsActive :: Lens' DirectorySite (Maybe Bool) -dsActive = lens _dsActive (\ s a -> s{_dsActive = a}) - --- | Name of this directory site. -dsName :: Lens' DirectorySite (Maybe Text) -dsName = lens _dsName (\ s a -> s{_dsName = a}) - --- | ID of this directory site. This is a read-only, auto-generated field. -dsId :: Lens' DirectorySite (Maybe Int64) -dsId - = lens _dsId (\ s a -> s{_dsId = a}) . - mapping _Coerce - --- | Country ID of this directory site. This is a read-only field. -dsCountryId :: Lens' DirectorySite (Maybe Int64) -dsCountryId - = lens _dsCountryId (\ s a -> s{_dsCountryId = a}) . - mapping _Coerce - --- | Directory site contacts. -dsContactAssignments :: Lens' DirectorySite [DirectorySiteContactAssignment] -dsContactAssignments - = lens _dsContactAssignments - (\ s a -> s{_dsContactAssignments = a}) - . _Default - . _Coerce - --- | Description of this directory site. This is a read-only field. -dsDescription :: Lens' DirectorySite (Maybe Text) -dsDescription - = lens _dsDescription - (\ s a -> s{_dsDescription = a}) - --- | Parent directory site ID. -dsParentId :: Lens' DirectorySite (Maybe Int64) -dsParentId - = lens _dsParentId (\ s a -> s{_dsParentId = a}) . - mapping _Coerce - -instance FromJSON DirectorySite where - parseJSON - = withObject "DirectorySite" - (\ o -> - DirectorySite' <$> - (o .:? "currencyId") <*> (o .:? "settings") <*> - (o .:? "interstitialTagFormats" .!= mempty) - <*> (o .:? "kind" .!= "dfareporting#directorySite") - <*> (o .:? "url") - <*> (o .:? "idDimensionValue") - <*> (o .:? "inpageTagFormats" .!= mempty) - <*> (o .:? "active") - <*> (o .:? "name") - <*> (o .:? "id") - <*> (o .:? "countryId") - <*> (o .:? "contactAssignments" .!= mempty) - <*> (o .:? "description") - <*> (o .:? "parentId")) - -instance ToJSON DirectorySite where - toJSON DirectorySite'{..} - = object - (catMaybes - [("currencyId" .=) <$> _dsCurrencyId, - ("settings" .=) <$> _dsSettings, - ("interstitialTagFormats" .=) <$> - _dsInterstitialTagFormats, - Just ("kind" .= _dsKind), ("url" .=) <$> _dsURL, - ("idDimensionValue" .=) <$> _dsIdDimensionValue, - ("inpageTagFormats" .=) <$> _dsInpageTagFormats, - ("active" .=) <$> _dsActive, ("name" .=) <$> _dsName, - ("id" .=) <$> _dsId, - ("countryId" .=) <$> _dsCountryId, - ("contactAssignments" .=) <$> _dsContactAssignments, - ("description" .=) <$> _dsDescription, - ("parentId" .=) <$> _dsParentId]) - --- | The properties of the report. --- --- /See:/ 'reportFloodlightCriteriaReportProperties' smart constructor. -data ReportFloodlightCriteriaReportProperties = ReportFloodlightCriteriaReportProperties' - { _rfcrpIncludeUnattributedIPConversions :: !(Maybe Bool) - , _rfcrpIncludeUnattributedCookieConversions :: !(Maybe Bool) - , _rfcrpIncludeAttributedIPConversions :: !(Maybe Bool) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'ReportFloodlightCriteriaReportProperties' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'rfcrpIncludeUnattributedIPConversions' --- --- * 'rfcrpIncludeUnattributedCookieConversions' --- --- * 'rfcrpIncludeAttributedIPConversions' -reportFloodlightCriteriaReportProperties - :: ReportFloodlightCriteriaReportProperties -reportFloodlightCriteriaReportProperties = - ReportFloodlightCriteriaReportProperties' - { _rfcrpIncludeUnattributedIPConversions = Nothing - , _rfcrpIncludeUnattributedCookieConversions = Nothing - , _rfcrpIncludeAttributedIPConversions = Nothing - } - --- | Include conversions that have no associated cookies and no exposures. --- It’s therefore impossible to know how the user was exposed to your ads --- during the lookback window prior to a conversion. -rfcrpIncludeUnattributedIPConversions :: Lens' ReportFloodlightCriteriaReportProperties (Maybe Bool) -rfcrpIncludeUnattributedIPConversions - = lens _rfcrpIncludeUnattributedIPConversions - (\ s a -> - s{_rfcrpIncludeUnattributedIPConversions = a}) - --- | Include conversions of users with a DoubleClick cookie but without an --- exposure. That means the user did not click or see an ad from the --- advertiser within the Floodlight group, or that the interaction happened --- outside the lookback window. -rfcrpIncludeUnattributedCookieConversions :: Lens' ReportFloodlightCriteriaReportProperties (Maybe Bool) -rfcrpIncludeUnattributedCookieConversions - = lens _rfcrpIncludeUnattributedCookieConversions - (\ s a -> - s{_rfcrpIncludeUnattributedCookieConversions = a}) - --- | Include conversions that have no cookie, but do have an exposure path. -rfcrpIncludeAttributedIPConversions :: Lens' ReportFloodlightCriteriaReportProperties (Maybe Bool) -rfcrpIncludeAttributedIPConversions - = lens _rfcrpIncludeAttributedIPConversions - (\ s a -> - s{_rfcrpIncludeAttributedIPConversions = a}) - -instance FromJSON - ReportFloodlightCriteriaReportProperties where - parseJSON - = withObject - "ReportFloodlightCriteriaReportProperties" - (\ o -> - ReportFloodlightCriteriaReportProperties' <$> - (o .:? "includeUnattributedIPConversions") <*> - (o .:? "includeUnattributedCookieConversions") - <*> (o .:? "includeAttributedIPConversions")) - -instance ToJSON - ReportFloodlightCriteriaReportProperties where - toJSON ReportFloodlightCriteriaReportProperties'{..} - = object - (catMaybes - [("includeUnattributedIPConversions" .=) <$> - _rfcrpIncludeUnattributedIPConversions, - ("includeUnattributedCookieConversions" .=) <$> - _rfcrpIncludeUnattributedCookieConversions, - ("includeAttributedIPConversions" .=) <$> - _rfcrpIncludeAttributedIPConversions]) - --- | Contains properties of a Floodlight activity group. --- --- /See:/ 'floodlightActivityGroup' smart constructor. -data FloodlightActivityGroup = FloodlightActivityGroup' - { _fagTagString :: !(Maybe Text) - , _fagFloodlightConfigurationId :: !(Maybe (Textual Int64)) - , _fagKind :: !Text - , _fagAdvertiserId :: !(Maybe (Textual Int64)) - , _fagAdvertiserIdDimensionValue :: !(Maybe DimensionValue) - , _fagIdDimensionValue :: !(Maybe DimensionValue) - , _fagAccountId :: !(Maybe (Textual Int64)) - , _fagName :: !(Maybe Text) - , _fagId :: !(Maybe (Textual Int64)) - , _fagSubAccountId :: !(Maybe (Textual Int64)) - , _fagType :: !(Maybe FloodlightActivityGroupType) - , _fagFloodlightConfigurationIdDimensionValue :: !(Maybe DimensionValue) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'FloodlightActivityGroup' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'fagTagString' --- --- * 'fagFloodlightConfigurationId' --- --- * 'fagKind' --- --- * 'fagAdvertiserId' --- --- * 'fagAdvertiserIdDimensionValue' --- --- * 'fagIdDimensionValue' --- --- * 'fagAccountId' --- --- * 'fagName' --- --- * 'fagId' --- --- * 'fagSubAccountId' --- --- * 'fagType' --- --- * 'fagFloodlightConfigurationIdDimensionValue' -floodlightActivityGroup - :: FloodlightActivityGroup -floodlightActivityGroup = - FloodlightActivityGroup' - { _fagTagString = Nothing - , _fagFloodlightConfigurationId = Nothing - , _fagKind = "dfareporting#floodlightActivityGroup" - , _fagAdvertiserId = Nothing - , _fagAdvertiserIdDimensionValue = Nothing - , _fagIdDimensionValue = Nothing - , _fagAccountId = Nothing - , _fagName = Nothing - , _fagId = Nothing - , _fagSubAccountId = Nothing - , _fagType = Nothing - , _fagFloodlightConfigurationIdDimensionValue = Nothing - } - --- | Value of the type= parameter in the floodlight tag, which the ad servers --- use to identify the activity group that the activity belongs to. This is --- optional: if empty, a new tag string will be generated for you. This --- string must be 1 to 8 characters long, with valid characters being --- [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among --- activity groups of the same floodlight configuration. This field is --- read-only after insertion. -fagTagString :: Lens' FloodlightActivityGroup (Maybe Text) -fagTagString - = lens _fagTagString (\ s a -> s{_fagTagString = a}) - --- | Floodlight configuration ID of this floodlight activity group. This is a --- required field. -fagFloodlightConfigurationId :: Lens' FloodlightActivityGroup (Maybe Int64) -fagFloodlightConfigurationId - = lens _fagFloodlightConfigurationId - (\ s a -> s{_fagFloodlightConfigurationId = a}) - . mapping _Coerce - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#floodlightActivityGroup\". -fagKind :: Lens' FloodlightActivityGroup Text -fagKind = lens _fagKind (\ s a -> s{_fagKind = a}) - --- | Advertiser ID of this floodlight activity group. If this field is left --- blank, the value will be copied over either from the floodlight --- configuration\'s advertiser or from the existing activity group\'s --- advertiser. -fagAdvertiserId :: Lens' FloodlightActivityGroup (Maybe Int64) -fagAdvertiserId - = lens _fagAdvertiserId - (\ s a -> s{_fagAdvertiserId = a}) - . mapping _Coerce - --- | Dimension value for the ID of the advertiser. This is a read-only, --- auto-generated field. -fagAdvertiserIdDimensionValue :: Lens' FloodlightActivityGroup (Maybe DimensionValue) -fagAdvertiserIdDimensionValue - = lens _fagAdvertiserIdDimensionValue - (\ s a -> s{_fagAdvertiserIdDimensionValue = a}) - --- | Dimension value for the ID of this floodlight activity group. This is a --- read-only, auto-generated field. -fagIdDimensionValue :: Lens' FloodlightActivityGroup (Maybe DimensionValue) -fagIdDimensionValue - = lens _fagIdDimensionValue - (\ s a -> s{_fagIdDimensionValue = a}) - --- | Account ID of this floodlight activity group. This is a read-only field --- that can be left blank. -fagAccountId :: Lens' FloodlightActivityGroup (Maybe Int64) -fagAccountId - = lens _fagAccountId (\ s a -> s{_fagAccountId = a}) - . mapping _Coerce - --- | Name of this floodlight activity group. This is a required field. Must --- be less than 65 characters long and cannot contain quotes. -fagName :: Lens' FloodlightActivityGroup (Maybe Text) -fagName = lens _fagName (\ s a -> s{_fagName = a}) - --- | ID of this floodlight activity group. This is a read-only, --- auto-generated field. -fagId :: Lens' FloodlightActivityGroup (Maybe Int64) -fagId - = lens _fagId (\ s a -> s{_fagId = a}) . - mapping _Coerce - --- | Subaccount ID of this floodlight activity group. This is a read-only --- field that can be left blank. -fagSubAccountId :: Lens' FloodlightActivityGroup (Maybe Int64) -fagSubAccountId - = lens _fagSubAccountId - (\ s a -> s{_fagSubAccountId = a}) - . mapping _Coerce - --- | Type of the floodlight activity group. This is a required field that is --- read-only after insertion. -fagType :: Lens' FloodlightActivityGroup (Maybe FloodlightActivityGroupType) -fagType = lens _fagType (\ s a -> s{_fagType = a}) - --- | Dimension value for the ID of the floodlight configuration. This is a --- read-only, auto-generated field. -fagFloodlightConfigurationIdDimensionValue :: Lens' FloodlightActivityGroup (Maybe DimensionValue) -fagFloodlightConfigurationIdDimensionValue - = lens _fagFloodlightConfigurationIdDimensionValue - (\ s a -> - s{_fagFloodlightConfigurationIdDimensionValue = a}) - -instance FromJSON FloodlightActivityGroup where - parseJSON - = withObject "FloodlightActivityGroup" - (\ o -> - FloodlightActivityGroup' <$> - (o .:? "tagString") <*> - (o .:? "floodlightConfigurationId") - <*> - (o .:? "kind" .!= - "dfareporting#floodlightActivityGroup") - <*> (o .:? "advertiserId") - <*> (o .:? "advertiserIdDimensionValue") - <*> (o .:? "idDimensionValue") - <*> (o .:? "accountId") - <*> (o .:? "name") - <*> (o .:? "id") - <*> (o .:? "subaccountId") - <*> (o .:? "type") - <*> - (o .:? "floodlightConfigurationIdDimensionValue")) - -instance ToJSON FloodlightActivityGroup where - toJSON FloodlightActivityGroup'{..} - = object - (catMaybes - [("tagString" .=) <$> _fagTagString, - ("floodlightConfigurationId" .=) <$> - _fagFloodlightConfigurationId, - Just ("kind" .= _fagKind), - ("advertiserId" .=) <$> _fagAdvertiserId, - ("advertiserIdDimensionValue" .=) <$> - _fagAdvertiserIdDimensionValue, - ("idDimensionValue" .=) <$> _fagIdDimensionValue, - ("accountId" .=) <$> _fagAccountId, - ("name" .=) <$> _fagName, ("id" .=) <$> _fagId, - ("subaccountId" .=) <$> _fagSubAccountId, - ("type" .=) <$> _fagType, - ("floodlightConfigurationIdDimensionValue" .=) <$> - _fagFloodlightConfigurationIdDimensionValue]) - --- | Represents fields that are compatible to be selected for a report of --- type \"CROSS_DIMENSION_REACH\". --- --- /See:/ 'crossDimensionReachReportCompatibleFields' smart constructor. -data CrossDimensionReachReportCompatibleFields = CrossDimensionReachReportCompatibleFields' - { _cdrrcfMetrics :: !(Maybe [Metric]) - , _cdrrcfBreakdown :: !(Maybe [Dimension]) - , _cdrrcfKind :: !Text - , _cdrrcfDimensionFilters :: !(Maybe [Dimension]) - , _cdrrcfOverlapMetrics :: !(Maybe [Metric]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'CrossDimensionReachReportCompatibleFields' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'cdrrcfMetrics' --- --- * 'cdrrcfBreakdown' --- --- * 'cdrrcfKind' --- --- * 'cdrrcfDimensionFilters' --- --- * 'cdrrcfOverlapMetrics' -crossDimensionReachReportCompatibleFields - :: CrossDimensionReachReportCompatibleFields -crossDimensionReachReportCompatibleFields = - CrossDimensionReachReportCompatibleFields' - { _cdrrcfMetrics = Nothing - , _cdrrcfBreakdown = Nothing - , _cdrrcfKind = "dfareporting#crossDimensionReachReportCompatibleFields" - , _cdrrcfDimensionFilters = Nothing - , _cdrrcfOverlapMetrics = Nothing - } - --- | Metrics which are compatible to be selected in the \"metricNames\" --- section of the report. -cdrrcfMetrics :: Lens' CrossDimensionReachReportCompatibleFields [Metric] -cdrrcfMetrics - = lens _cdrrcfMetrics - (\ s a -> s{_cdrrcfMetrics = a}) - . _Default - . _Coerce - --- | Dimensions which are compatible to be selected in the \"breakdown\" --- section of the report. -cdrrcfBreakdown :: Lens' CrossDimensionReachReportCompatibleFields [Dimension] -cdrrcfBreakdown - = lens _cdrrcfBreakdown - (\ s a -> s{_cdrrcfBreakdown = a}) - . _Default - . _Coerce - --- | The kind of resource this is, in this case --- dfareporting#crossDimensionReachReportCompatibleFields. -cdrrcfKind :: Lens' CrossDimensionReachReportCompatibleFields Text -cdrrcfKind - = lens _cdrrcfKind (\ s a -> s{_cdrrcfKind = a}) - --- | Dimensions which are compatible to be selected in the --- \"dimensionFilters\" section of the report. -cdrrcfDimensionFilters :: Lens' CrossDimensionReachReportCompatibleFields [Dimension] -cdrrcfDimensionFilters - = lens _cdrrcfDimensionFilters - (\ s a -> s{_cdrrcfDimensionFilters = a}) - . _Default - . _Coerce - --- | Metrics which are compatible to be selected in the --- \"overlapMetricNames\" section of the report. -cdrrcfOverlapMetrics :: Lens' CrossDimensionReachReportCompatibleFields [Metric] -cdrrcfOverlapMetrics - = lens _cdrrcfOverlapMetrics - (\ s a -> s{_cdrrcfOverlapMetrics = a}) - . _Default - . _Coerce - -instance FromJSON - CrossDimensionReachReportCompatibleFields where - parseJSON - = withObject - "CrossDimensionReachReportCompatibleFields" - (\ o -> - CrossDimensionReachReportCompatibleFields' <$> - (o .:? "metrics" .!= mempty) <*> - (o .:? "breakdown" .!= mempty) - <*> - (o .:? "kind" .!= - "dfareporting#crossDimensionReachReportCompatibleFields") - <*> (o .:? "dimensionFilters" .!= mempty) - <*> (o .:? "overlapMetrics" .!= mempty)) - -instance ToJSON - CrossDimensionReachReportCompatibleFields where - toJSON CrossDimensionReachReportCompatibleFields'{..} - = object - (catMaybes - [("metrics" .=) <$> _cdrrcfMetrics, - ("breakdown" .=) <$> _cdrrcfBreakdown, - Just ("kind" .= _cdrrcfKind), - ("dimensionFilters" .=) <$> _cdrrcfDimensionFilters, - ("overlapMetrics" .=) <$> _cdrrcfOverlapMetrics]) - --- | FsCommand. --- --- /See:/ 'fsCommand' smart constructor. -data FsCommand = FsCommand' - { _fcPositionOption :: !(Maybe FsCommandPositionOption) - , _fcLeft :: !(Maybe (Textual Int32)) - , _fcWindowHeight :: !(Maybe (Textual Int32)) - , _fcWindowWidth :: !(Maybe (Textual Int32)) - , _fcTop :: !(Maybe (Textual Int32)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'FsCommand' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'fcPositionOption' --- --- * 'fcLeft' --- --- * 'fcWindowHeight' --- --- * 'fcWindowWidth' --- --- * 'fcTop' -fsCommand - :: FsCommand -fsCommand = - FsCommand' - { _fcPositionOption = Nothing - , _fcLeft = Nothing - , _fcWindowHeight = Nothing - , _fcWindowWidth = Nothing - , _fcTop = Nothing - } - --- | Position in the browser where the window will open. -fcPositionOption :: Lens' FsCommand (Maybe FsCommandPositionOption) -fcPositionOption - = lens _fcPositionOption - (\ s a -> s{_fcPositionOption = a}) - --- | Distance from the left of the browser.Applicable when positionOption is --- DISTANCE_FROM_TOP_LEFT_CORNER. -fcLeft :: Lens' FsCommand (Maybe Int32) -fcLeft - = lens _fcLeft (\ s a -> s{_fcLeft = a}) . - mapping _Coerce - --- | Height of the window. -fcWindowHeight :: Lens' FsCommand (Maybe Int32) -fcWindowHeight - = lens _fcWindowHeight - (\ s a -> s{_fcWindowHeight = a}) - . mapping _Coerce - --- | Width of the window. -fcWindowWidth :: Lens' FsCommand (Maybe Int32) -fcWindowWidth - = lens _fcWindowWidth - (\ s a -> s{_fcWindowWidth = a}) - . mapping _Coerce - --- | Distance from the top of the browser. Applicable when positionOption is --- DISTANCE_FROM_TOP_LEFT_CORNER. -fcTop :: Lens' FsCommand (Maybe Int32) -fcTop - = lens _fcTop (\ s a -> s{_fcTop = a}) . - mapping _Coerce - -instance FromJSON FsCommand where - parseJSON - = withObject "FsCommand" - (\ o -> - FsCommand' <$> - (o .:? "positionOption") <*> (o .:? "left") <*> - (o .:? "windowHeight") - <*> (o .:? "windowWidth") - <*> (o .:? "top")) - -instance ToJSON FsCommand where - toJSON FsCommand'{..} - = object - (catMaybes - [("positionOption" .=) <$> _fcPositionOption, - ("left" .=) <$> _fcLeft, - ("windowHeight" .=) <$> _fcWindowHeight, - ("windowWidth" .=) <$> _fcWindowWidth, - ("top" .=) <$> _fcTop]) - --- | Placement Assignment. --- --- /See:/ 'placementAssignment' smart constructor. -data PlacementAssignment = PlacementAssignment' - { _paPlacementId :: !(Maybe (Textual Int64)) - , _paPlacementIdDimensionValue :: !(Maybe DimensionValue) - , _paActive :: !(Maybe Bool) - , _paSSLRequired :: !(Maybe Bool) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'PlacementAssignment' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'paPlacementId' --- --- * 'paPlacementIdDimensionValue' --- --- * 'paActive' --- --- * 'paSSLRequired' -placementAssignment - :: PlacementAssignment -placementAssignment = - PlacementAssignment' - { _paPlacementId = Nothing - , _paPlacementIdDimensionValue = Nothing - , _paActive = Nothing - , _paSSLRequired = Nothing - } - --- | ID of the placement to be assigned. This is a required field. -paPlacementId :: Lens' PlacementAssignment (Maybe Int64) -paPlacementId - = lens _paPlacementId - (\ s a -> s{_paPlacementId = a}) - . mapping _Coerce - --- | Dimension value for the ID of the placement. This is a read-only, --- auto-generated field. -paPlacementIdDimensionValue :: Lens' PlacementAssignment (Maybe DimensionValue) -paPlacementIdDimensionValue - = lens _paPlacementIdDimensionValue - (\ s a -> s{_paPlacementIdDimensionValue = a}) - --- | Whether this placement assignment is active. When true, the placement --- will be included in the ad\'s rotation. -paActive :: Lens' PlacementAssignment (Maybe Bool) -paActive = lens _paActive (\ s a -> s{_paActive = a}) - --- | Whether the placement to be assigned requires SSL. This is a read-only --- field that is auto-generated when the ad is inserted or updated. -paSSLRequired :: Lens' PlacementAssignment (Maybe Bool) -paSSLRequired - = lens _paSSLRequired - (\ s a -> s{_paSSLRequired = a}) - -instance FromJSON PlacementAssignment where - parseJSON - = withObject "PlacementAssignment" - (\ o -> - PlacementAssignment' <$> - (o .:? "placementId") <*> - (o .:? "placementIdDimensionValue") - <*> (o .:? "active") - <*> (o .:? "sslRequired")) - -instance ToJSON PlacementAssignment where - toJSON PlacementAssignment'{..} - = object - (catMaybes - [("placementId" .=) <$> _paPlacementId, - ("placementIdDimensionValue" .=) <$> - _paPlacementIdDimensionValue, - ("active" .=) <$> _paActive, - ("sslRequired" .=) <$> _paSSLRequired]) - --- | Contains properties of a creative field value. --- --- /See:/ 'creativeFieldValue' smart constructor. -data CreativeFieldValue = CreativeFieldValue' - { _cfvKind :: !Text - , _cfvValue :: !(Maybe Text) - , _cfvId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'CreativeFieldValue' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'cfvKind' --- --- * 'cfvValue' --- --- * 'cfvId' -creativeFieldValue - :: CreativeFieldValue -creativeFieldValue = - CreativeFieldValue' - { _cfvKind = "dfareporting#creativeFieldValue" - , _cfvValue = Nothing - , _cfvId = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#creativeFieldValue\". -cfvKind :: Lens' CreativeFieldValue Text -cfvKind = lens _cfvKind (\ s a -> s{_cfvKind = a}) - --- | Value of this creative field value. It needs to be less than 256 --- characters in length and unique per creative field. -cfvValue :: Lens' CreativeFieldValue (Maybe Text) -cfvValue = lens _cfvValue (\ s a -> s{_cfvValue = a}) - --- | ID of this creative field value. This is a read-only, auto-generated --- field. -cfvId :: Lens' CreativeFieldValue (Maybe Int64) -cfvId - = lens _cfvId (\ s a -> s{_cfvId = a}) . - mapping _Coerce - -instance FromJSON CreativeFieldValue where - parseJSON - = withObject "CreativeFieldValue" - (\ o -> - CreativeFieldValue' <$> - (o .:? "kind" .!= "dfareporting#creativeFieldValue") - <*> (o .:? "value") - <*> (o .:? "id")) - -instance ToJSON CreativeFieldValue where - toJSON CreativeFieldValue'{..} - = object - (catMaybes - [Just ("kind" .= _cfvKind), - ("value" .=) <$> _cfvValue, ("id" .=) <$> _cfvId]) - --- | Represents a DimensionValuesRequest. --- --- /See:/ 'dimensionValueRequest' smart constructor. -data DimensionValueRequest = DimensionValueRequest' - { _dvrKind :: !Text - , _dvrEndDate :: !(Maybe Date') - , _dvrFilters :: !(Maybe [DimensionFilter]) - , _dvrStartDate :: !(Maybe Date') - , _dvrDimensionName :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'DimensionValueRequest' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'dvrKind' --- --- * 'dvrEndDate' --- --- * 'dvrFilters' --- --- * 'dvrStartDate' --- --- * 'dvrDimensionName' -dimensionValueRequest - :: DimensionValueRequest -dimensionValueRequest = - DimensionValueRequest' - { _dvrKind = "dfareporting#dimensionValueRequest" - , _dvrEndDate = Nothing - , _dvrFilters = Nothing - , _dvrStartDate = Nothing - , _dvrDimensionName = Nothing - } - --- | The kind of request this is, in this case --- dfareporting#dimensionValueRequest. -dvrKind :: Lens' DimensionValueRequest Text -dvrKind = lens _dvrKind (\ s a -> s{_dvrKind = a}) - --- | The end date of the date range for which to retrieve dimension values. A --- string of the format \"yyyy-MM-dd\". -dvrEndDate :: Lens' DimensionValueRequest (Maybe Day) -dvrEndDate - = lens _dvrEndDate (\ s a -> s{_dvrEndDate = a}) . - mapping _Date - --- | The list of filters by which to filter values. The filters are ANDed. -dvrFilters :: Lens' DimensionValueRequest [DimensionFilter] -dvrFilters - = lens _dvrFilters (\ s a -> s{_dvrFilters = a}) . - _Default - . _Coerce - --- | The start date of the date range for which to retrieve dimension values. --- A string of the format \"yyyy-MM-dd\". -dvrStartDate :: Lens' DimensionValueRequest (Maybe Day) -dvrStartDate - = lens _dvrStartDate (\ s a -> s{_dvrStartDate = a}) - . mapping _Date - --- | The name of the dimension for which values should be requested. -dvrDimensionName :: Lens' DimensionValueRequest (Maybe Text) -dvrDimensionName - = lens _dvrDimensionName - (\ s a -> s{_dvrDimensionName = a}) - -instance FromJSON DimensionValueRequest where - parseJSON - = withObject "DimensionValueRequest" - (\ o -> - DimensionValueRequest' <$> - (o .:? "kind" .!= - "dfareporting#dimensionValueRequest") - <*> (o .:? "endDate") - <*> (o .:? "filters" .!= mempty) - <*> (o .:? "startDate") - <*> (o .:? "dimensionName")) - -instance ToJSON DimensionValueRequest where - toJSON DimensionValueRequest'{..} - = object - (catMaybes - [Just ("kind" .= _dvrKind), - ("endDate" .=) <$> _dvrEndDate, - ("filters" .=) <$> _dvrFilters, - ("startDate" .=) <$> _dvrStartDate, - ("dimensionName" .=) <$> _dvrDimensionName]) - --- | Floodlight Configuration List Response --- --- /See:/ 'floodlightConfigurationsListResponse' smart constructor. -data FloodlightConfigurationsListResponse = FloodlightConfigurationsListResponse' - { _fclrKind :: !Text - , _fclrFloodlightConfigurations :: !(Maybe [FloodlightConfiguration]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'FloodlightConfigurationsListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'fclrKind' --- --- * 'fclrFloodlightConfigurations' -floodlightConfigurationsListResponse - :: FloodlightConfigurationsListResponse -floodlightConfigurationsListResponse = - FloodlightConfigurationsListResponse' - { _fclrKind = "dfareporting#floodlightConfigurationsListResponse" - , _fclrFloodlightConfigurations = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#floodlightConfigurationsListResponse\". -fclrKind :: Lens' FloodlightConfigurationsListResponse Text -fclrKind = lens _fclrKind (\ s a -> s{_fclrKind = a}) - --- | Floodlight configuration collection. -fclrFloodlightConfigurations :: Lens' FloodlightConfigurationsListResponse [FloodlightConfiguration] -fclrFloodlightConfigurations - = lens _fclrFloodlightConfigurations - (\ s a -> s{_fclrFloodlightConfigurations = a}) - . _Default - . _Coerce - -instance FromJSON - FloodlightConfigurationsListResponse where - parseJSON - = withObject "FloodlightConfigurationsListResponse" - (\ o -> - FloodlightConfigurationsListResponse' <$> - (o .:? "kind" .!= - "dfareporting#floodlightConfigurationsListResponse") - <*> (o .:? "floodlightConfigurations" .!= mempty)) - -instance ToJSON FloodlightConfigurationsListResponse - where - toJSON FloodlightConfigurationsListResponse'{..} - = object - (catMaybes - [Just ("kind" .= _fclrKind), - ("floodlightConfigurations" .=) <$> - _fclrFloodlightConfigurations]) - --- | Floodlight Activity List Response --- --- /See:/ 'floodlightActivitiesListResponse' smart constructor. -data FloodlightActivitiesListResponse = FloodlightActivitiesListResponse' - { _falrNextPageToken :: !(Maybe Text) - , _falrKind :: !Text - , _falrFloodlightActivities :: !(Maybe [FloodlightActivity]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'FloodlightActivitiesListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'falrNextPageToken' --- --- * 'falrKind' --- --- * 'falrFloodlightActivities' -floodlightActivitiesListResponse - :: FloodlightActivitiesListResponse -floodlightActivitiesListResponse = - FloodlightActivitiesListResponse' - { _falrNextPageToken = Nothing - , _falrKind = "dfareporting#floodlightActivitiesListResponse" - , _falrFloodlightActivities = Nothing - } - --- | Pagination token to be used for the next list operation. -falrNextPageToken :: Lens' FloodlightActivitiesListResponse (Maybe Text) -falrNextPageToken - = lens _falrNextPageToken - (\ s a -> s{_falrNextPageToken = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#floodlightActivitiesListResponse\". -falrKind :: Lens' FloodlightActivitiesListResponse Text -falrKind = lens _falrKind (\ s a -> s{_falrKind = a}) - --- | Floodlight activity collection. -falrFloodlightActivities :: Lens' FloodlightActivitiesListResponse [FloodlightActivity] -falrFloodlightActivities - = lens _falrFloodlightActivities - (\ s a -> s{_falrFloodlightActivities = a}) - . _Default - . _Coerce - -instance FromJSON FloodlightActivitiesListResponse - where - parseJSON - = withObject "FloodlightActivitiesListResponse" - (\ o -> - FloodlightActivitiesListResponse' <$> - (o .:? "nextPageToken") <*> - (o .:? "kind" .!= - "dfareporting#floodlightActivitiesListResponse") - <*> (o .:? "floodlightActivities" .!= mempty)) - -instance ToJSON FloodlightActivitiesListResponse - where - toJSON FloodlightActivitiesListResponse'{..} - = object - (catMaybes - [("nextPageToken" .=) <$> _falrNextPageToken, - Just ("kind" .= _falrKind), - ("floodlightActivities" .=) <$> - _falrFloodlightActivities]) - --- | Creative Field Assignment. --- --- /See:/ 'creativeFieldAssignment' smart constructor. -data CreativeFieldAssignment = CreativeFieldAssignment' - { _cfaCreativeFieldId :: !(Maybe (Textual Int64)) - , _cfaCreativeFieldValueId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'CreativeFieldAssignment' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'cfaCreativeFieldId' --- --- * 'cfaCreativeFieldValueId' -creativeFieldAssignment - :: CreativeFieldAssignment -creativeFieldAssignment = - CreativeFieldAssignment' - { _cfaCreativeFieldId = Nothing - , _cfaCreativeFieldValueId = Nothing - } - --- | ID of the creative field. -cfaCreativeFieldId :: Lens' CreativeFieldAssignment (Maybe Int64) -cfaCreativeFieldId - = lens _cfaCreativeFieldId - (\ s a -> s{_cfaCreativeFieldId = a}) - . mapping _Coerce - --- | ID of the creative field value. -cfaCreativeFieldValueId :: Lens' CreativeFieldAssignment (Maybe Int64) -cfaCreativeFieldValueId - = lens _cfaCreativeFieldValueId - (\ s a -> s{_cfaCreativeFieldValueId = a}) - . mapping _Coerce - -instance FromJSON CreativeFieldAssignment where - parseJSON - = withObject "CreativeFieldAssignment" - (\ o -> - CreativeFieldAssignment' <$> - (o .:? "creativeFieldId") <*> - (o .:? "creativeFieldValueId")) - -instance ToJSON CreativeFieldAssignment where - toJSON CreativeFieldAssignment'{..} - = object - (catMaybes - [("creativeFieldId" .=) <$> _cfaCreativeFieldId, - ("creativeFieldValueId" .=) <$> - _cfaCreativeFieldValueId]) - --- | Groups advertisers together so that reports can be generated for the --- entire group at once. --- --- /See:/ 'advertiserGroup' smart constructor. -data AdvertiserGroup = AdvertiserGroup' - { _agKind :: !Text - , _agAccountId :: !(Maybe (Textual Int64)) - , _agName :: !(Maybe Text) - , _agId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'AdvertiserGroup' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'agKind' --- --- * 'agAccountId' --- --- * 'agName' --- --- * 'agId' -advertiserGroup - :: AdvertiserGroup -advertiserGroup = - AdvertiserGroup' - { _agKind = "dfareporting#advertiserGroup" - , _agAccountId = Nothing - , _agName = Nothing - , _agId = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#advertiserGroup\". -agKind :: Lens' AdvertiserGroup Text -agKind = lens _agKind (\ s a -> s{_agKind = a}) - --- | Account ID of this advertiser group. This is a read-only field that can --- be left blank. -agAccountId :: Lens' AdvertiserGroup (Maybe Int64) -agAccountId - = lens _agAccountId (\ s a -> s{_agAccountId = a}) . - mapping _Coerce - --- | Name of this advertiser group. This is a required field and must be less --- than 256 characters long and unique among advertiser groups of the same --- account. -agName :: Lens' AdvertiserGroup (Maybe Text) -agName = lens _agName (\ s a -> s{_agName = a}) - --- | ID of this advertiser group. This is a read-only, auto-generated field. -agId :: Lens' AdvertiserGroup (Maybe Int64) -agId - = lens _agId (\ s a -> s{_agId = a}) . - mapping _Coerce - -instance FromJSON AdvertiserGroup where - parseJSON - = withObject "AdvertiserGroup" - (\ o -> - AdvertiserGroup' <$> - (o .:? "kind" .!= "dfareporting#advertiserGroup") <*> - (o .:? "accountId") - <*> (o .:? "name") - <*> (o .:? "id")) - -instance ToJSON AdvertiserGroup where - toJSON AdvertiserGroup'{..} - = object - (catMaybes - [Just ("kind" .= _agKind), - ("accountId" .=) <$> _agAccountId, - ("name" .=) <$> _agName, ("id" .=) <$> _agId]) - --- | Placement Tag Data --- --- /See:/ 'tagData' smart constructor. -data TagData = TagData' - { _tdClickTag :: !(Maybe Text) - , _tdFormat :: !(Maybe TagDataFormat) - , _tdCreativeId :: !(Maybe (Textual Int64)) - , _tdAdId :: !(Maybe (Textual Int64)) - , _tdImpressionTag :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'TagData' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'tdClickTag' --- --- * 'tdFormat' --- --- * 'tdCreativeId' --- --- * 'tdAdId' --- --- * 'tdImpressionTag' -tagData - :: TagData -tagData = - TagData' - { _tdClickTag = Nothing - , _tdFormat = Nothing - , _tdCreativeId = Nothing - , _tdAdId = Nothing - , _tdImpressionTag = Nothing - } - --- | Tag string to record a click. -tdClickTag :: Lens' TagData (Maybe Text) -tdClickTag - = lens _tdClickTag (\ s a -> s{_tdClickTag = a}) - --- | TagData tag format of this tag. -tdFormat :: Lens' TagData (Maybe TagDataFormat) -tdFormat = lens _tdFormat (\ s a -> s{_tdFormat = a}) - --- | Creative associated with this placement tag. Applicable only when format --- is PLACEMENT_TAG_TRACKING. -tdCreativeId :: Lens' TagData (Maybe Int64) -tdCreativeId - = lens _tdCreativeId (\ s a -> s{_tdCreativeId = a}) - . mapping _Coerce - --- | Ad associated with this placement tag. Applicable only when format is --- PLACEMENT_TAG_TRACKING. -tdAdId :: Lens' TagData (Maybe Int64) -tdAdId - = lens _tdAdId (\ s a -> s{_tdAdId = a}) . - mapping _Coerce - --- | Tag string for serving an ad. -tdImpressionTag :: Lens' TagData (Maybe Text) -tdImpressionTag - = lens _tdImpressionTag - (\ s a -> s{_tdImpressionTag = a}) - -instance FromJSON TagData where - parseJSON - = withObject "TagData" - (\ o -> - TagData' <$> - (o .:? "clickTag") <*> (o .:? "format") <*> - (o .:? "creativeId") - <*> (o .:? "adId") - <*> (o .:? "impressionTag")) - -instance ToJSON TagData where - toJSON TagData'{..} - = object - (catMaybes - [("clickTag" .=) <$> _tdClickTag, - ("format" .=) <$> _tdFormat, - ("creativeId" .=) <$> _tdCreativeId, - ("adId" .=) <$> _tdAdId, - ("impressionTag" .=) <$> _tdImpressionTag]) - --- | Day Part Targeting. --- --- /See:/ 'dayPartTargeting' smart constructor. -data DayPartTargeting = DayPartTargeting' - { _dptDaysOfWeek :: !(Maybe [DayPartTargetingDaysOfWeekItem]) - , _dptHoursOfDay :: !(Maybe [Textual Int32]) - , _dptUserLocalTime :: !(Maybe Bool) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'DayPartTargeting' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'dptDaysOfWeek' --- --- * 'dptHoursOfDay' --- --- * 'dptUserLocalTime' -dayPartTargeting - :: DayPartTargeting -dayPartTargeting = - DayPartTargeting' - { _dptDaysOfWeek = Nothing - , _dptHoursOfDay = Nothing - , _dptUserLocalTime = Nothing - } - --- | Days of the week when the ad will serve. Acceptable values are: - --- \"SUNDAY\" - \"MONDAY\" - \"TUESDAY\" - \"WEDNESDAY\" - \"THURSDAY\" - --- \"FRIDAY\" - \"SATURDAY\" -dptDaysOfWeek :: Lens' DayPartTargeting [DayPartTargetingDaysOfWeekItem] -dptDaysOfWeek - = lens _dptDaysOfWeek - (\ s a -> s{_dptDaysOfWeek = a}) - . _Default - . _Coerce - --- | Hours of the day when the ad will serve, where 0 is midnight to 1 AM and --- 23 is 11 PM to midnight. Can be specified with days of week, in which --- case the ad would serve during these hours on the specified days. For --- example if Monday, Wednesday, Friday are the days of week specified and --- 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve --- Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values --- are 0 to 23, inclusive. -dptHoursOfDay :: Lens' DayPartTargeting [Int32] -dptHoursOfDay - = lens _dptHoursOfDay - (\ s a -> s{_dptHoursOfDay = a}) - . _Default - . _Coerce - --- | Whether or not to use the user\'s local time. If false, the America\/New --- York time zone applies. -dptUserLocalTime :: Lens' DayPartTargeting (Maybe Bool) -dptUserLocalTime - = lens _dptUserLocalTime - (\ s a -> s{_dptUserLocalTime = a}) - -instance FromJSON DayPartTargeting where - parseJSON - = withObject "DayPartTargeting" - (\ o -> - DayPartTargeting' <$> - (o .:? "daysOfWeek" .!= mempty) <*> - (o .:? "hoursOfDay" .!= mempty) - <*> (o .:? "userLocalTime")) - -instance ToJSON DayPartTargeting where - toJSON DayPartTargeting'{..} - = object - (catMaybes - [("daysOfWeek" .=) <$> _dptDaysOfWeek, - ("hoursOfDay" .=) <$> _dptHoursOfDay, - ("userLocalTime" .=) <$> _dptUserLocalTime]) - --- | Creative optimization settings. --- --- /See:/ 'creativeOptimizationConfiguration' smart constructor. -data CreativeOptimizationConfiguration = CreativeOptimizationConfiguration' - { _cocOptimizationModel :: !(Maybe CreativeOptimizationConfigurationOptimizationModel) - , _cocName :: !(Maybe Text) - , _cocOptimizationActivitys :: !(Maybe [OptimizationActivity]) - , _cocId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'CreativeOptimizationConfiguration' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'cocOptimizationModel' --- --- * 'cocName' --- --- * 'cocOptimizationActivitys' --- --- * 'cocId' -creativeOptimizationConfiguration - :: CreativeOptimizationConfiguration -creativeOptimizationConfiguration = - CreativeOptimizationConfiguration' - { _cocOptimizationModel = Nothing - , _cocName = Nothing - , _cocOptimizationActivitys = Nothing - , _cocId = Nothing - } - --- | Optimization model for this configuration. -cocOptimizationModel :: Lens' CreativeOptimizationConfiguration (Maybe CreativeOptimizationConfigurationOptimizationModel) -cocOptimizationModel - = lens _cocOptimizationModel - (\ s a -> s{_cocOptimizationModel = a}) - --- | Name of this creative optimization config. This is a required field and --- must be less than 129 characters long. -cocName :: Lens' CreativeOptimizationConfiguration (Maybe Text) -cocName = lens _cocName (\ s a -> s{_cocName = a}) - --- | List of optimization activities associated with this configuration. -cocOptimizationActivitys :: Lens' CreativeOptimizationConfiguration [OptimizationActivity] -cocOptimizationActivitys - = lens _cocOptimizationActivitys - (\ s a -> s{_cocOptimizationActivitys = a}) - . _Default - . _Coerce - --- | ID of this creative optimization config. This field is auto-generated --- when the campaign is inserted or updated. It can be null for existing --- campaigns. -cocId :: Lens' CreativeOptimizationConfiguration (Maybe Int64) -cocId - = lens _cocId (\ s a -> s{_cocId = a}) . - mapping _Coerce - -instance FromJSON CreativeOptimizationConfiguration - where - parseJSON - = withObject "CreativeOptimizationConfiguration" - (\ o -> - CreativeOptimizationConfiguration' <$> - (o .:? "optimizationModel") <*> (o .:? "name") <*> - (o .:? "optimizationActivitys" .!= mempty) - <*> (o .:? "id")) - -instance ToJSON CreativeOptimizationConfiguration - where - toJSON CreativeOptimizationConfiguration'{..} - = object - (catMaybes - [("optimizationModel" .=) <$> _cocOptimizationModel, - ("name" .=) <$> _cocName, - ("optimizationActivitys" .=) <$> - _cocOptimizationActivitys, - ("id" .=) <$> _cocId]) - --- | Click-through URL --- --- /See:/ 'creativeClickThroughURL' smart constructor. -data CreativeClickThroughURL = CreativeClickThroughURL' - { _cctuComputedClickThroughURL :: !(Maybe Text) - , _cctuCustomClickThroughURL :: !(Maybe Text) - , _cctuLandingPageId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'CreativeClickThroughURL' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'cctuComputedClickThroughURL' --- --- * 'cctuCustomClickThroughURL' --- --- * 'cctuLandingPageId' -creativeClickThroughURL - :: CreativeClickThroughURL -creativeClickThroughURL = - CreativeClickThroughURL' - { _cctuComputedClickThroughURL = Nothing - , _cctuCustomClickThroughURL = Nothing - , _cctuLandingPageId = Nothing - } - --- | Read-only convenience field representing the actual URL that will be --- used for this click-through. The URL is computed as follows: - If --- landingPageId is specified then that landing page\'s URL is assigned to --- this field. - Otherwise, the customClickThroughUrl is assigned to this --- field. -cctuComputedClickThroughURL :: Lens' CreativeClickThroughURL (Maybe Text) -cctuComputedClickThroughURL - = lens _cctuComputedClickThroughURL - (\ s a -> s{_cctuComputedClickThroughURL = a}) - --- | Custom click-through URL. Applicable if the landingPageId field is left --- unset. -cctuCustomClickThroughURL :: Lens' CreativeClickThroughURL (Maybe Text) -cctuCustomClickThroughURL - = lens _cctuCustomClickThroughURL - (\ s a -> s{_cctuCustomClickThroughURL = a}) - --- | ID of the landing page for the click-through URL. -cctuLandingPageId :: Lens' CreativeClickThroughURL (Maybe Int64) -cctuLandingPageId - = lens _cctuLandingPageId - (\ s a -> s{_cctuLandingPageId = a}) - . mapping _Coerce - -instance FromJSON CreativeClickThroughURL where - parseJSON - = withObject "CreativeClickThroughURL" - (\ o -> - CreativeClickThroughURL' <$> - (o .:? "computedClickThroughUrl") <*> - (o .:? "customClickThroughUrl") - <*> (o .:? "landingPageId")) - -instance ToJSON CreativeClickThroughURL where - toJSON CreativeClickThroughURL'{..} - = object - (catMaybes - [("computedClickThroughUrl" .=) <$> - _cctuComputedClickThroughURL, - ("customClickThroughUrl" .=) <$> - _cctuCustomClickThroughURL, - ("landingPageId" .=) <$> _cctuLandingPageId]) - --- | The report criteria for a report of type \"STANDARD\". --- --- /See:/ 'reportCriteria' smart constructor. -data ReportCriteria = ReportCriteria' - { _rcMetricNames :: !(Maybe [Text]) - , _rcCustomRichMediaEvents :: !(Maybe CustomRichMediaEvents) - , _rcDimensionFilters :: !(Maybe [DimensionValue]) - , _rcActivities :: !(Maybe Activities) - , _rcDateRange :: !(Maybe DateRange) - , _rcDimensions :: !(Maybe [SortedDimension]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'ReportCriteria' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'rcMetricNames' --- --- * 'rcCustomRichMediaEvents' --- --- * 'rcDimensionFilters' --- --- * 'rcActivities' --- --- * 'rcDateRange' --- --- * 'rcDimensions' -reportCriteria - :: ReportCriteria -reportCriteria = - ReportCriteria' - { _rcMetricNames = Nothing - , _rcCustomRichMediaEvents = Nothing - , _rcDimensionFilters = Nothing - , _rcActivities = Nothing - , _rcDateRange = Nothing - , _rcDimensions = Nothing - } - --- | The list of names of metrics the report should include. -rcMetricNames :: Lens' ReportCriteria [Text] -rcMetricNames - = lens _rcMetricNames - (\ s a -> s{_rcMetricNames = a}) - . _Default - . _Coerce - --- | Custom Rich Media Events group. -rcCustomRichMediaEvents :: Lens' ReportCriteria (Maybe CustomRichMediaEvents) -rcCustomRichMediaEvents - = lens _rcCustomRichMediaEvents - (\ s a -> s{_rcCustomRichMediaEvents = a}) - --- | The list of filters on which dimensions are filtered. Filters for --- different dimensions are ANDed, filters for the same dimension are --- grouped together and ORed. -rcDimensionFilters :: Lens' ReportCriteria [DimensionValue] -rcDimensionFilters - = lens _rcDimensionFilters - (\ s a -> s{_rcDimensionFilters = a}) - . _Default - . _Coerce - --- | Activity group. -rcActivities :: Lens' ReportCriteria (Maybe Activities) -rcActivities - = lens _rcActivities (\ s a -> s{_rcActivities = a}) - --- | The date range for which this report should be run. -rcDateRange :: Lens' ReportCriteria (Maybe DateRange) -rcDateRange - = lens _rcDateRange (\ s a -> s{_rcDateRange = a}) - --- | The list of standard dimensions the report should include. -rcDimensions :: Lens' ReportCriteria [SortedDimension] -rcDimensions - = lens _rcDimensions (\ s a -> s{_rcDimensions = a}) - . _Default - . _Coerce - -instance FromJSON ReportCriteria where - parseJSON - = withObject "ReportCriteria" - (\ o -> - ReportCriteria' <$> - (o .:? "metricNames" .!= mempty) <*> - (o .:? "customRichMediaEvents") - <*> (o .:? "dimensionFilters" .!= mempty) - <*> (o .:? "activities") - <*> (o .:? "dateRange") - <*> (o .:? "dimensions" .!= mempty)) - -instance ToJSON ReportCriteria where - toJSON ReportCriteria'{..} - = object - (catMaybes - [("metricNames" .=) <$> _rcMetricNames, - ("customRichMediaEvents" .=) <$> - _rcCustomRichMediaEvents, - ("dimensionFilters" .=) <$> _rcDimensionFilters, - ("activities" .=) <$> _rcActivities, - ("dateRange" .=) <$> _rcDateRange, - ("dimensions" .=) <$> _rcDimensions]) - --- | Placement Strategy List Response --- --- /See:/ 'placementStrategiesListResponse' smart constructor. -data PlacementStrategiesListResponse = PlacementStrategiesListResponse' - { _pslrPlacementStrategies :: !(Maybe [PlacementStrategy]) - , _pslrNextPageToken :: !(Maybe Text) - , _pslrKind :: !Text - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'PlacementStrategiesListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'pslrPlacementStrategies' --- --- * 'pslrNextPageToken' --- --- * 'pslrKind' -placementStrategiesListResponse - :: PlacementStrategiesListResponse -placementStrategiesListResponse = - PlacementStrategiesListResponse' - { _pslrPlacementStrategies = Nothing - , _pslrNextPageToken = Nothing - , _pslrKind = "dfareporting#placementStrategiesListResponse" - } - --- | Placement strategy collection. -pslrPlacementStrategies :: Lens' PlacementStrategiesListResponse [PlacementStrategy] -pslrPlacementStrategies - = lens _pslrPlacementStrategies - (\ s a -> s{_pslrPlacementStrategies = a}) - . _Default - . _Coerce - --- | Pagination token to be used for the next list operation. -pslrNextPageToken :: Lens' PlacementStrategiesListResponse (Maybe Text) -pslrNextPageToken - = lens _pslrNextPageToken - (\ s a -> s{_pslrNextPageToken = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#placementStrategiesListResponse\". -pslrKind :: Lens' PlacementStrategiesListResponse Text -pslrKind = lens _pslrKind (\ s a -> s{_pslrKind = a}) - -instance FromJSON PlacementStrategiesListResponse - where - parseJSON - = withObject "PlacementStrategiesListResponse" - (\ o -> - PlacementStrategiesListResponse' <$> - (o .:? "placementStrategies" .!= mempty) <*> - (o .:? "nextPageToken") - <*> - (o .:? "kind" .!= - "dfareporting#placementStrategiesListResponse")) - -instance ToJSON PlacementStrategiesListResponse where - toJSON PlacementStrategiesListResponse'{..} - = object - (catMaybes - [("placementStrategies" .=) <$> - _pslrPlacementStrategies, - ("nextPageToken" .=) <$> _pslrNextPageToken, - Just ("kind" .= _pslrKind)]) - --- | Update Conversions Response. --- --- /See:/ 'conversionsBatchUpdateResponse' smart constructor. -data ConversionsBatchUpdateResponse = ConversionsBatchUpdateResponse' - { _cburStatus :: !(Maybe [ConversionStatus]) - , _cburKind :: !Text - , _cburHasFailures :: !(Maybe Bool) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'ConversionsBatchUpdateResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'cburStatus' --- --- * 'cburKind' --- --- * 'cburHasFailures' -conversionsBatchUpdateResponse - :: ConversionsBatchUpdateResponse -conversionsBatchUpdateResponse = - ConversionsBatchUpdateResponse' - { _cburStatus = Nothing - , _cburKind = "dfareporting#conversionsBatchUpdateResponse" - , _cburHasFailures = Nothing - } - --- | The update status of each conversion. Statuses are returned in the same --- order that conversions are updated. -cburStatus :: Lens' ConversionsBatchUpdateResponse [ConversionStatus] -cburStatus - = lens _cburStatus (\ s a -> s{_cburStatus = a}) . - _Default - . _Coerce - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#conversionsBatchUpdateResponse\". -cburKind :: Lens' ConversionsBatchUpdateResponse Text -cburKind = lens _cburKind (\ s a -> s{_cburKind = a}) - --- | Indicates that some or all conversions failed to update. -cburHasFailures :: Lens' ConversionsBatchUpdateResponse (Maybe Bool) -cburHasFailures - = lens _cburHasFailures - (\ s a -> s{_cburHasFailures = a}) - -instance FromJSON ConversionsBatchUpdateResponse - where - parseJSON - = withObject "ConversionsBatchUpdateResponse" - (\ o -> - ConversionsBatchUpdateResponse' <$> - (o .:? "status" .!= mempty) <*> - (o .:? "kind" .!= - "dfareporting#conversionsBatchUpdateResponse") - <*> (o .:? "hasFailures")) - -instance ToJSON ConversionsBatchUpdateResponse where - toJSON ConversionsBatchUpdateResponse'{..} - = object - (catMaybes - [("status" .=) <$> _cburStatus, - Just ("kind" .= _cburKind), - ("hasFailures" .=) <$> _cburHasFailures]) - --- | Contains properties of a Campaign Manager subaccount. --- --- /See:/ 'subAccount' smart constructor. -data SubAccount = SubAccount' - { _saKind :: !Text - , _saAvailablePermissionIds :: !(Maybe [Textual Int64]) - , _saAccountId :: !(Maybe (Textual Int64)) - , _saName :: !(Maybe Text) - , _saId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'SubAccount' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'saKind' --- --- * 'saAvailablePermissionIds' --- --- * 'saAccountId' --- --- * 'saName' --- --- * 'saId' -subAccount - :: SubAccount -subAccount = - SubAccount' - { _saKind = "dfareporting#subaccount" - , _saAvailablePermissionIds = Nothing - , _saAccountId = Nothing - , _saName = Nothing - , _saId = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#subaccount\". -saKind :: Lens' SubAccount Text -saKind = lens _saKind (\ s a -> s{_saKind = a}) - --- | IDs of the available user role permissions for this subaccount. -saAvailablePermissionIds :: Lens' SubAccount [Int64] -saAvailablePermissionIds - = lens _saAvailablePermissionIds - (\ s a -> s{_saAvailablePermissionIds = a}) - . _Default - . _Coerce - --- | ID of the account that contains this subaccount. This is a read-only --- field that can be left blank. -saAccountId :: Lens' SubAccount (Maybe Int64) -saAccountId - = lens _saAccountId (\ s a -> s{_saAccountId = a}) . - mapping _Coerce - --- | Name of this subaccount. This is a required field. Must be less than 128 --- characters long and be unique among subaccounts of the same account. -saName :: Lens' SubAccount (Maybe Text) -saName = lens _saName (\ s a -> s{_saName = a}) - --- | ID of this subaccount. This is a read-only, auto-generated field. -saId :: Lens' SubAccount (Maybe Int64) -saId - = lens _saId (\ s a -> s{_saId = a}) . - mapping _Coerce - -instance FromJSON SubAccount where - parseJSON - = withObject "SubAccount" - (\ o -> - SubAccount' <$> - (o .:? "kind" .!= "dfareporting#subaccount") <*> - (o .:? "availablePermissionIds" .!= mempty) - <*> (o .:? "accountId") - <*> (o .:? "name") - <*> (o .:? "id")) - -instance ToJSON SubAccount where - toJSON SubAccount'{..} - = object - (catMaybes - [Just ("kind" .= _saKind), - ("availablePermissionIds" .=) <$> - _saAvailablePermissionIds, - ("accountId" .=) <$> _saAccountId, - ("name" .=) <$> _saName, ("id" .=) <$> _saId]) - --- | Inventory item List Response --- --- /See:/ 'inventoryItemsListResponse' smart constructor. -data InventoryItemsListResponse = InventoryItemsListResponse' - { _iilrInventoryItems :: !(Maybe [InventoryItem]) - , _iilrNextPageToken :: !(Maybe Text) - , _iilrKind :: !Text - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'InventoryItemsListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'iilrInventoryItems' --- --- * 'iilrNextPageToken' --- --- * 'iilrKind' -inventoryItemsListResponse - :: InventoryItemsListResponse -inventoryItemsListResponse = - InventoryItemsListResponse' - { _iilrInventoryItems = Nothing - , _iilrNextPageToken = Nothing - , _iilrKind = "dfareporting#inventoryItemsListResponse" - } - --- | Inventory item collection -iilrInventoryItems :: Lens' InventoryItemsListResponse [InventoryItem] -iilrInventoryItems - = lens _iilrInventoryItems - (\ s a -> s{_iilrInventoryItems = a}) - . _Default - . _Coerce - --- | Pagination token to be used for the next list operation. -iilrNextPageToken :: Lens' InventoryItemsListResponse (Maybe Text) -iilrNextPageToken - = lens _iilrNextPageToken - (\ s a -> s{_iilrNextPageToken = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#inventoryItemsListResponse\". -iilrKind :: Lens' InventoryItemsListResponse Text -iilrKind = lens _iilrKind (\ s a -> s{_iilrKind = a}) - -instance FromJSON InventoryItemsListResponse where - parseJSON - = withObject "InventoryItemsListResponse" - (\ o -> - InventoryItemsListResponse' <$> - (o .:? "inventoryItems" .!= mempty) <*> - (o .:? "nextPageToken") - <*> - (o .:? "kind" .!= - "dfareporting#inventoryItemsListResponse")) - -instance ToJSON InventoryItemsListResponse where - toJSON InventoryItemsListResponse'{..} - = object - (catMaybes - [("inventoryItems" .=) <$> _iilrInventoryItems, - ("nextPageToken" .=) <$> _iilrNextPageToken, - Just ("kind" .= _iilrKind)]) - --- | A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following --- creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID. --- --- /See:/ 'universalAdId' smart constructor. -data UniversalAdId = UniversalAdId' - { _uaiValue :: !(Maybe Text) - , _uaiRegistry :: !(Maybe UniversalAdIdRegistry) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'UniversalAdId' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'uaiValue' --- --- * 'uaiRegistry' -universalAdId - :: UniversalAdId -universalAdId = - UniversalAdId' - { _uaiValue = Nothing - , _uaiRegistry = Nothing - } - --- | ID value for this creative. Only alphanumeric characters and the --- following symbols are valid: \"_\/\\-\". Maximum length is 64 --- characters. Read only when registry is DCM. -uaiValue :: Lens' UniversalAdId (Maybe Text) -uaiValue = lens _uaiValue (\ s a -> s{_uaiValue = a}) - --- | Registry used for the Ad ID value. -uaiRegistry :: Lens' UniversalAdId (Maybe UniversalAdIdRegistry) -uaiRegistry - = lens _uaiRegistry (\ s a -> s{_uaiRegistry = a}) - -instance FromJSON UniversalAdId where - parseJSON - = withObject "UniversalAdId" - (\ o -> - UniversalAdId' <$> - (o .:? "value") <*> (o .:? "registry")) - -instance ToJSON UniversalAdId where - toJSON UniversalAdId'{..} - = object - (catMaybes - [("value" .=) <$> _uaiValue, - ("registry" .=) <$> _uaiRegistry]) - --- | Contains properties of a Campaign Manager ad. --- --- /See:/ 'ad' smart constructor. -data Ad = Ad' - { _aTargetingTemplateId :: !(Maybe (Textual Int64)) - , _aCreativeGroupAssignments :: !(Maybe [CreativeGroupAssignment]) - , _aGeoTargeting :: !(Maybe GeoTargeting) - , _aCreativeRotation :: !(Maybe CreativeRotation) - , _aTechnologyTargeting :: !(Maybe TechnologyTargeting) - , _aAudienceSegmentId :: !(Maybe (Textual Int64)) - , _aDayPartTargeting :: !(Maybe DayPartTargeting) - , _aSize :: !(Maybe Size) - , _aStartTime :: !(Maybe DateTime') - , _aKind :: !Text - , _aClickThroughURLSuffixProperties :: !(Maybe ClickThroughURLSuffixProperties) - , _aCampaignIdDimensionValue :: !(Maybe DimensionValue) - , _aAdvertiserId :: !(Maybe (Textual Int64)) - , _aAdvertiserIdDimensionValue :: !(Maybe DimensionValue) - , _aSSLCompliant :: !(Maybe Bool) - , _aCampaignId :: !(Maybe (Textual Int64)) - , _aIdDimensionValue :: !(Maybe DimensionValue) - , _aClickThroughURL :: !(Maybe ClickThroughURL) - , _aDeliverySchedule :: !(Maybe DeliverySchedule) - , _aEventTagOverrides :: !(Maybe [EventTagOverride]) - , _aActive :: !(Maybe Bool) - , _aAccountId :: !(Maybe (Textual Int64)) - , _aName :: !(Maybe Text) - , _aKeyValueTargetingExpression :: !(Maybe KeyValueTargetingExpression) - , _aEndTime :: !(Maybe DateTime') - , _aCreateInfo :: !(Maybe LastModifiedInfo) - , _aLastModifiedInfo :: !(Maybe LastModifiedInfo) - , _aId :: !(Maybe (Textual Int64)) - , _aSSLRequired :: !(Maybe Bool) - , _aComments :: !(Maybe Text) - , _aSubAccountId :: !(Maybe (Textual Int64)) - , _aType :: !(Maybe AdType) - , _aRemarketingListExpression :: !(Maybe ListTargetingExpression) - , _aLanguageTargeting :: !(Maybe LanguageTargeting) - , _aDynamicClickTracker :: !(Maybe Bool) - , _aCompatibility :: !(Maybe AdCompatibility) - , _aArchived :: !(Maybe Bool) - , _aDefaultClickThroughEventTagProperties :: !(Maybe DefaultClickThroughEventTagProperties) - , _aPlacementAssignments :: !(Maybe [PlacementAssignment]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'Ad' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'aTargetingTemplateId' --- --- * 'aCreativeGroupAssignments' --- --- * 'aGeoTargeting' --- --- * 'aCreativeRotation' --- --- * 'aTechnologyTargeting' --- --- * 'aAudienceSegmentId' --- --- * 'aDayPartTargeting' --- --- * 'aSize' --- --- * 'aStartTime' --- --- * 'aKind' --- --- * 'aClickThroughURLSuffixProperties' --- --- * 'aCampaignIdDimensionValue' --- --- * 'aAdvertiserId' --- --- * 'aAdvertiserIdDimensionValue' --- --- * 'aSSLCompliant' --- --- * 'aCampaignId' --- --- * 'aIdDimensionValue' --- --- * 'aClickThroughURL' --- --- * 'aDeliverySchedule' --- --- * 'aEventTagOverrides' --- --- * 'aActive' --- --- * 'aAccountId' --- --- * 'aName' --- --- * 'aKeyValueTargetingExpression' --- --- * 'aEndTime' --- --- * 'aCreateInfo' --- --- * 'aLastModifiedInfo' --- --- * 'aId' --- --- * 'aSSLRequired' --- --- * 'aComments' --- --- * 'aSubAccountId' --- --- * 'aType' --- --- * 'aRemarketingListExpression' --- --- * 'aLanguageTargeting' --- --- * 'aDynamicClickTracker' --- --- * 'aCompatibility' --- --- * 'aArchived' --- --- * 'aDefaultClickThroughEventTagProperties' --- --- * 'aPlacementAssignments' -ad - :: Ad -ad = - Ad' - { _aTargetingTemplateId = Nothing - , _aCreativeGroupAssignments = Nothing - , _aGeoTargeting = Nothing - , _aCreativeRotation = Nothing - , _aTechnologyTargeting = Nothing - , _aAudienceSegmentId = Nothing - , _aDayPartTargeting = Nothing - , _aSize = Nothing - , _aStartTime = Nothing - , _aKind = "dfareporting#ad" - , _aClickThroughURLSuffixProperties = Nothing - , _aCampaignIdDimensionValue = Nothing - , _aAdvertiserId = Nothing - , _aAdvertiserIdDimensionValue = Nothing - , _aSSLCompliant = Nothing - , _aCampaignId = Nothing - , _aIdDimensionValue = Nothing - , _aClickThroughURL = Nothing - , _aDeliverySchedule = Nothing - , _aEventTagOverrides = Nothing - , _aActive = Nothing - , _aAccountId = Nothing - , _aName = Nothing - , _aKeyValueTargetingExpression = Nothing - , _aEndTime = Nothing - , _aCreateInfo = Nothing - , _aLastModifiedInfo = Nothing - , _aId = Nothing - , _aSSLRequired = Nothing - , _aComments = Nothing - , _aSubAccountId = Nothing - , _aType = Nothing - , _aRemarketingListExpression = Nothing - , _aLanguageTargeting = Nothing - , _aDynamicClickTracker = Nothing - , _aCompatibility = Nothing - , _aArchived = Nothing - , _aDefaultClickThroughEventTagProperties = Nothing - , _aPlacementAssignments = Nothing - } - --- | Targeting template ID, used to apply preconfigured targeting information --- to this ad. This cannot be set while any of dayPartTargeting, --- geoTargeting, keyValueTargetingExpression, languageTargeting, --- remarketingListExpression, or technologyTargeting are set. Applicable --- when type is AD_SERVING_STANDARD_AD. -aTargetingTemplateId :: Lens' Ad (Maybe Int64) -aTargetingTemplateId - = lens _aTargetingTemplateId - (\ s a -> s{_aTargetingTemplateId = a}) - . mapping _Coerce - --- | Creative group assignments for this ad. Applicable when type is --- AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number --- is allowed for a maximum of two assignments. -aCreativeGroupAssignments :: Lens' Ad [CreativeGroupAssignment] -aCreativeGroupAssignments - = lens _aCreativeGroupAssignments - (\ s a -> s{_aCreativeGroupAssignments = a}) - . _Default - . _Coerce - --- | Geographical targeting information for this ad. This field must be left --- blank if the ad is using a targeting template. Applicable when type is --- AD_SERVING_STANDARD_AD. -aGeoTargeting :: Lens' Ad (Maybe GeoTargeting) -aGeoTargeting - = lens _aGeoTargeting - (\ s a -> s{_aGeoTargeting = a}) - --- | Creative rotation for this ad. Applicable when type is --- AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. --- When type is AD_SERVING_DEFAULT_AD, this field should have exactly one --- creativeAssignment. -aCreativeRotation :: Lens' Ad (Maybe CreativeRotation) -aCreativeRotation - = lens _aCreativeRotation - (\ s a -> s{_aCreativeRotation = a}) - --- | Technology platform targeting information for this ad. This field must --- be left blank if the ad is using a targeting template. Applicable when --- type is AD_SERVING_STANDARD_AD. -aTechnologyTargeting :: Lens' Ad (Maybe TechnologyTargeting) -aTechnologyTargeting - = lens _aTechnologyTargeting - (\ s a -> s{_aTechnologyTargeting = a}) - --- | Audience segment ID that is being targeted for this ad. Applicable when --- type is AD_SERVING_STANDARD_AD. -aAudienceSegmentId :: Lens' Ad (Maybe Int64) -aAudienceSegmentId - = lens _aAudienceSegmentId - (\ s a -> s{_aAudienceSegmentId = a}) - . mapping _Coerce - --- | Time and day targeting information for this ad. This field must be left --- blank if the ad is using a targeting template. Applicable when type is --- AD_SERVING_STANDARD_AD. -aDayPartTargeting :: Lens' Ad (Maybe DayPartTargeting) -aDayPartTargeting - = lens _aDayPartTargeting - (\ s a -> s{_aDayPartTargeting = a}) - --- | Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. -aSize :: Lens' Ad (Maybe Size) -aSize = lens _aSize (\ s a -> s{_aSize = a}) - --- | Date and time that this ad should start serving. If creating an ad, this --- field must be a time in the future. This is a required field on --- insertion. -aStartTime :: Lens' Ad (Maybe UTCTime) -aStartTime - = lens _aStartTime (\ s a -> s{_aStartTime = a}) . - mapping _DateTime - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#ad\". -aKind :: Lens' Ad Text -aKind = lens _aKind (\ s a -> s{_aKind = a}) - --- | Click-through URL suffix properties for this ad. Applies to the URL in --- the ad or (if overriding ad properties) the URL in the creative. -aClickThroughURLSuffixProperties :: Lens' Ad (Maybe ClickThroughURLSuffixProperties) -aClickThroughURLSuffixProperties - = lens _aClickThroughURLSuffixProperties - (\ s a -> s{_aClickThroughURLSuffixProperties = a}) - --- | Dimension value for the ID of the campaign. This is a read-only, --- auto-generated field. -aCampaignIdDimensionValue :: Lens' Ad (Maybe DimensionValue) -aCampaignIdDimensionValue - = lens _aCampaignIdDimensionValue - (\ s a -> s{_aCampaignIdDimensionValue = a}) - --- | Advertiser ID of this ad. This is a required field on insertion. -aAdvertiserId :: Lens' Ad (Maybe Int64) -aAdvertiserId - = lens _aAdvertiserId - (\ s a -> s{_aAdvertiserId = a}) - . mapping _Coerce - --- | Dimension value for the ID of the advertiser. This is a read-only, --- auto-generated field. -aAdvertiserIdDimensionValue :: Lens' Ad (Maybe DimensionValue) -aAdvertiserIdDimensionValue - = lens _aAdvertiserIdDimensionValue - (\ s a -> s{_aAdvertiserIdDimensionValue = a}) - --- | Whether this ad is ssl compliant. This is a read-only field that is --- auto-generated when the ad is inserted or updated. -aSSLCompliant :: Lens' Ad (Maybe Bool) -aSSLCompliant - = lens _aSSLCompliant - (\ s a -> s{_aSSLCompliant = a}) - --- | Campaign ID of this ad. This is a required field on insertion. -aCampaignId :: Lens' Ad (Maybe Int64) -aCampaignId - = lens _aCampaignId (\ s a -> s{_aCampaignId = a}) . - mapping _Coerce - --- | Dimension value for the ID of this ad. This is a read-only, --- auto-generated field. -aIdDimensionValue :: Lens' Ad (Maybe DimensionValue) -aIdDimensionValue - = lens _aIdDimensionValue - (\ s a -> s{_aIdDimensionValue = a}) - --- | Click-through URL for this ad. This is a required field on insertion. --- Applicable when type is AD_SERVING_CLICK_TRACKER. -aClickThroughURL :: Lens' Ad (Maybe ClickThroughURL) -aClickThroughURL - = lens _aClickThroughURL - (\ s a -> s{_aClickThroughURL = a}) - --- | Delivery schedule information for this ad. Applicable when type is --- AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with --- subfields priority and impressionRatio are required on insertion when --- type is AD_SERVING_STANDARD_AD. -aDeliverySchedule :: Lens' Ad (Maybe DeliverySchedule) -aDeliverySchedule - = lens _aDeliverySchedule - (\ s a -> s{_aDeliverySchedule = a}) - --- | Event tag overrides for this ad. -aEventTagOverrides :: Lens' Ad [EventTagOverride] -aEventTagOverrides - = lens _aEventTagOverrides - (\ s a -> s{_aEventTagOverrides = a}) - . _Default - . _Coerce - --- | Whether this ad is active. When true, archived must be false. -aActive :: Lens' Ad (Maybe Bool) -aActive = lens _aActive (\ s a -> s{_aActive = a}) - --- | Account ID of this ad. This is a read-only field that can be left blank. -aAccountId :: Lens' Ad (Maybe Int64) -aAccountId - = lens _aAccountId (\ s a -> s{_aAccountId = a}) . - mapping _Coerce - --- | Name of this ad. This is a required field and must be less than 256 --- characters long. -aName :: Lens' Ad (Maybe Text) -aName = lens _aName (\ s a -> s{_aName = a}) - --- | Key-value targeting information for this ad. This field must be left --- blank if the ad is using a targeting template. Applicable when type is --- AD_SERVING_STANDARD_AD. -aKeyValueTargetingExpression :: Lens' Ad (Maybe KeyValueTargetingExpression) -aKeyValueTargetingExpression - = lens _aKeyValueTargetingExpression - (\ s a -> s{_aKeyValueTargetingExpression = a}) - --- | Date and time that this ad should stop serving. Must be later than the --- start time. This is a required field on insertion. -aEndTime :: Lens' Ad (Maybe UTCTime) -aEndTime - = lens _aEndTime (\ s a -> s{_aEndTime = a}) . - mapping _DateTime - --- | Information about the creation of this ad. This is a read-only field. -aCreateInfo :: Lens' Ad (Maybe LastModifiedInfo) -aCreateInfo - = lens _aCreateInfo (\ s a -> s{_aCreateInfo = a}) - --- | Information about the most recent modification of this ad. This is a --- read-only field. -aLastModifiedInfo :: Lens' Ad (Maybe LastModifiedInfo) -aLastModifiedInfo - = lens _aLastModifiedInfo - (\ s a -> s{_aLastModifiedInfo = a}) - --- | ID of this ad. This is a read-only, auto-generated field. -aId :: Lens' Ad (Maybe Int64) -aId - = lens _aId (\ s a -> s{_aId = a}) . mapping _Coerce - --- | Whether this ad requires ssl. This is a read-only field that is --- auto-generated when the ad is inserted or updated. -aSSLRequired :: Lens' Ad (Maybe Bool) -aSSLRequired - = lens _aSSLRequired (\ s a -> s{_aSSLRequired = a}) - --- | Comments for this ad. -aComments :: Lens' Ad (Maybe Text) -aComments - = lens _aComments (\ s a -> s{_aComments = a}) - --- | Subaccount ID of this ad. This is a read-only field that can be left --- blank. -aSubAccountId :: Lens' Ad (Maybe Int64) -aSubAccountId - = lens _aSubAccountId - (\ s a -> s{_aSubAccountId = a}) - . mapping _Coerce - --- | Type of ad. This is a required field on insertion. Note that default ads --- (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative --- resource). -aType :: Lens' Ad (Maybe AdType) -aType = lens _aType (\ s a -> s{_aType = a}) - --- | Remarketing list targeting expression for this ad. This field must be --- left blank if the ad is using a targeting template. Applicable when type --- is AD_SERVING_STANDARD_AD. -aRemarketingListExpression :: Lens' Ad (Maybe ListTargetingExpression) -aRemarketingListExpression - = lens _aRemarketingListExpression - (\ s a -> s{_aRemarketingListExpression = a}) - --- | Language targeting information for this ad. This field must be left --- blank if the ad is using a targeting template. Applicable when type is --- AD_SERVING_STANDARD_AD. -aLanguageTargeting :: Lens' Ad (Maybe LanguageTargeting) -aLanguageTargeting - = lens _aLanguageTargeting - (\ s a -> s{_aLanguageTargeting = a}) - --- | Whether this ad is a dynamic click tracker. Applicable when type is --- AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is --- read-only after insert. -aDynamicClickTracker :: Lens' Ad (Maybe Bool) -aDynamicClickTracker - = lens _aDynamicClickTracker - (\ s a -> s{_aDynamicClickTracker = a}) - --- | Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. --- DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or --- on mobile devices or in mobile apps for regular or interstitial ads, --- respectively. APP and APP_INTERSTITIAL are only used for existing --- default ads. New mobile placements must be assigned DISPLAY or --- DISPLAY_INTERSTITIAL and default ads created for those placements will --- be limited to those compatibility types. IN_STREAM_VIDEO refers to --- rendering in-stream video ads developed with the VAST standard. -aCompatibility :: Lens' Ad (Maybe AdCompatibility) -aCompatibility - = lens _aCompatibility - (\ s a -> s{_aCompatibility = a}) - --- | Whether this ad is archived. When true, active must be false. -aArchived :: Lens' Ad (Maybe Bool) -aArchived - = lens _aArchived (\ s a -> s{_aArchived = a}) - --- | Default click-through event tag properties for this ad. -aDefaultClickThroughEventTagProperties :: Lens' Ad (Maybe DefaultClickThroughEventTagProperties) -aDefaultClickThroughEventTagProperties - = lens _aDefaultClickThroughEventTagProperties - (\ s a -> - s{_aDefaultClickThroughEventTagProperties = a}) - --- | Placement assignments for this ad. -aPlacementAssignments :: Lens' Ad [PlacementAssignment] -aPlacementAssignments - = lens _aPlacementAssignments - (\ s a -> s{_aPlacementAssignments = a}) - . _Default - . _Coerce - -instance FromJSON Ad where - parseJSON - = withObject "Ad" - (\ o -> - Ad' <$> - (o .:? "targetingTemplateId") <*> - (o .:? "creativeGroupAssignments" .!= mempty) - <*> (o .:? "geoTargeting") - <*> (o .:? "creativeRotation") - <*> (o .:? "technologyTargeting") - <*> (o .:? "audienceSegmentId") - <*> (o .:? "dayPartTargeting") - <*> (o .:? "size") - <*> (o .:? "startTime") - <*> (o .:? "kind" .!= "dfareporting#ad") - <*> (o .:? "clickThroughUrlSuffixProperties") - <*> (o .:? "campaignIdDimensionValue") - <*> (o .:? "advertiserId") - <*> (o .:? "advertiserIdDimensionValue") - <*> (o .:? "sslCompliant") - <*> (o .:? "campaignId") - <*> (o .:? "idDimensionValue") - <*> (o .:? "clickThroughUrl") - <*> (o .:? "deliverySchedule") - <*> (o .:? "eventTagOverrides" .!= mempty) - <*> (o .:? "active") - <*> (o .:? "accountId") - <*> (o .:? "name") - <*> (o .:? "keyValueTargetingExpression") - <*> (o .:? "endTime") - <*> (o .:? "createInfo") - <*> (o .:? "lastModifiedInfo") - <*> (o .:? "id") - <*> (o .:? "sslRequired") - <*> (o .:? "comments") - <*> (o .:? "subaccountId") - <*> (o .:? "type") - <*> (o .:? "remarketingListExpression") - <*> (o .:? "languageTargeting") - <*> (o .:? "dynamicClickTracker") - <*> (o .:? "compatibility") - <*> (o .:? "archived") - <*> (o .:? "defaultClickThroughEventTagProperties") - <*> (o .:? "placementAssignments" .!= mempty)) - -instance ToJSON Ad where - toJSON Ad'{..} - = object - (catMaybes - [("targetingTemplateId" .=) <$> - _aTargetingTemplateId, - ("creativeGroupAssignments" .=) <$> - _aCreativeGroupAssignments, - ("geoTargeting" .=) <$> _aGeoTargeting, - ("creativeRotation" .=) <$> _aCreativeRotation, - ("technologyTargeting" .=) <$> _aTechnologyTargeting, - ("audienceSegmentId" .=) <$> _aAudienceSegmentId, - ("dayPartTargeting" .=) <$> _aDayPartTargeting, - ("size" .=) <$> _aSize, - ("startTime" .=) <$> _aStartTime, - Just ("kind" .= _aKind), - ("clickThroughUrlSuffixProperties" .=) <$> - _aClickThroughURLSuffixProperties, - ("campaignIdDimensionValue" .=) <$> - _aCampaignIdDimensionValue, - ("advertiserId" .=) <$> _aAdvertiserId, - ("advertiserIdDimensionValue" .=) <$> - _aAdvertiserIdDimensionValue, - ("sslCompliant" .=) <$> _aSSLCompliant, - ("campaignId" .=) <$> _aCampaignId, - ("idDimensionValue" .=) <$> _aIdDimensionValue, - ("clickThroughUrl" .=) <$> _aClickThroughURL, - ("deliverySchedule" .=) <$> _aDeliverySchedule, - ("eventTagOverrides" .=) <$> _aEventTagOverrides, - ("active" .=) <$> _aActive, - ("accountId" .=) <$> _aAccountId, - ("name" .=) <$> _aName, - ("keyValueTargetingExpression" .=) <$> - _aKeyValueTargetingExpression, - ("endTime" .=) <$> _aEndTime, - ("createInfo" .=) <$> _aCreateInfo, - ("lastModifiedInfo" .=) <$> _aLastModifiedInfo, - ("id" .=) <$> _aId, - ("sslRequired" .=) <$> _aSSLRequired, - ("comments" .=) <$> _aComments, - ("subaccountId" .=) <$> _aSubAccountId, - ("type" .=) <$> _aType, - ("remarketingListExpression" .=) <$> - _aRemarketingListExpression, - ("languageTargeting" .=) <$> _aLanguageTargeting, - ("dynamicClickTracker" .=) <$> _aDynamicClickTracker, - ("compatibility" .=) <$> _aCompatibility, - ("archived" .=) <$> _aArchived, - ("defaultClickThroughEventTagProperties" .=) <$> - _aDefaultClickThroughEventTagProperties, - ("placementAssignments" .=) <$> - _aPlacementAssignments]) - --- | Contains properties of a Planning project. --- --- /See:/ 'project' smart constructor. -data Project = Project' - { _pTargetClicks :: !(Maybe (Textual Int64)) - , _pClientBillingCode :: !(Maybe Text) - , _pTargetCpmNanos :: !(Maybe (Textual Int64)) - , _pTargetConversions :: !(Maybe (Textual Int64)) - , _pBudget :: !(Maybe (Textual Int64)) - , _pKind :: !Text - , _pAdvertiserId :: !(Maybe (Textual Int64)) - , _pEndDate :: !(Maybe Date') - , _pOverview :: !(Maybe Text) - , _pTargetImpressions :: !(Maybe (Textual Int64)) - , _pStartDate :: !(Maybe Date') - , _pTargetCpcNanos :: !(Maybe (Textual Int64)) - , _pAccountId :: !(Maybe (Textual Int64)) - , _pName :: !(Maybe Text) - , _pLastModifiedInfo :: !(Maybe LastModifiedInfo) - , _pId :: !(Maybe (Textual Int64)) - , _pAudienceAgeGroup :: !(Maybe ProjectAudienceAgeGroup) - , _pSubAccountId :: !(Maybe (Textual Int64)) - , _pTargetCpmActiveViewNanos :: !(Maybe (Textual Int64)) - , _pAudienceGender :: !(Maybe ProjectAudienceGender) - , _pClientName :: !(Maybe Text) - , _pTargetCpaNanos :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'Project' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'pTargetClicks' --- --- * 'pClientBillingCode' --- --- * 'pTargetCpmNanos' --- --- * 'pTargetConversions' --- --- * 'pBudget' --- --- * 'pKind' --- --- * 'pAdvertiserId' --- --- * 'pEndDate' --- --- * 'pOverview' --- --- * 'pTargetImpressions' --- --- * 'pStartDate' --- --- * 'pTargetCpcNanos' --- --- * 'pAccountId' --- --- * 'pName' --- --- * 'pLastModifiedInfo' --- --- * 'pId' --- --- * 'pAudienceAgeGroup' --- --- * 'pSubAccountId' --- --- * 'pTargetCpmActiveViewNanos' --- --- * 'pAudienceGender' --- --- * 'pClientName' --- --- * 'pTargetCpaNanos' -project - :: Project -project = - Project' - { _pTargetClicks = Nothing - , _pClientBillingCode = Nothing - , _pTargetCpmNanos = Nothing - , _pTargetConversions = Nothing - , _pBudget = Nothing - , _pKind = "dfareporting#project" - , _pAdvertiserId = Nothing - , _pEndDate = Nothing - , _pOverview = Nothing - , _pTargetImpressions = Nothing - , _pStartDate = Nothing - , _pTargetCpcNanos = Nothing - , _pAccountId = Nothing - , _pName = Nothing - , _pLastModifiedInfo = Nothing - , _pId = Nothing - , _pAudienceAgeGroup = Nothing - , _pSubAccountId = Nothing - , _pTargetCpmActiveViewNanos = Nothing - , _pAudienceGender = Nothing - , _pClientName = Nothing - , _pTargetCpaNanos = Nothing - } - --- | Number of clicks that the advertiser is targeting. -pTargetClicks :: Lens' Project (Maybe Int64) -pTargetClicks - = lens _pTargetClicks - (\ s a -> s{_pTargetClicks = a}) - . mapping _Coerce - --- | Client billing code of this project. -pClientBillingCode :: Lens' Project (Maybe Text) -pClientBillingCode - = lens _pClientBillingCode - (\ s a -> s{_pClientBillingCode = a}) - --- | CPM that the advertiser is targeting. -pTargetCpmNanos :: Lens' Project (Maybe Int64) -pTargetCpmNanos - = lens _pTargetCpmNanos - (\ s a -> s{_pTargetCpmNanos = a}) - . mapping _Coerce - --- | Number of conversions that the advertiser is targeting. -pTargetConversions :: Lens' Project (Maybe Int64) -pTargetConversions - = lens _pTargetConversions - (\ s a -> s{_pTargetConversions = a}) - . mapping _Coerce - --- | Budget of this project in the currency specified by the current account. --- The value stored in this field represents only the non-fractional --- amount. For example, for USD, the smallest value that can be represented --- by this field is 1 US dollar. -pBudget :: Lens' Project (Maybe Int64) -pBudget - = lens _pBudget (\ s a -> s{_pBudget = a}) . - mapping _Coerce - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#project\". -pKind :: Lens' Project Text -pKind = lens _pKind (\ s a -> s{_pKind = a}) - --- | Advertiser ID of this project. -pAdvertiserId :: Lens' Project (Maybe Int64) -pAdvertiserId - = lens _pAdvertiserId - (\ s a -> s{_pAdvertiserId = a}) - . mapping _Coerce - --- | End date of the project. -pEndDate :: Lens' Project (Maybe Day) -pEndDate - = lens _pEndDate (\ s a -> s{_pEndDate = a}) . - mapping _Date - --- | Overview of this project. -pOverview :: Lens' Project (Maybe Text) -pOverview - = lens _pOverview (\ s a -> s{_pOverview = a}) - --- | Number of impressions that the advertiser is targeting. -pTargetImpressions :: Lens' Project (Maybe Int64) -pTargetImpressions - = lens _pTargetImpressions - (\ s a -> s{_pTargetImpressions = a}) - . mapping _Coerce - --- | Start date of the project. -pStartDate :: Lens' Project (Maybe Day) -pStartDate - = lens _pStartDate (\ s a -> s{_pStartDate = a}) . - mapping _Date - --- | CPC that the advertiser is targeting. -pTargetCpcNanos :: Lens' Project (Maybe Int64) -pTargetCpcNanos - = lens _pTargetCpcNanos - (\ s a -> s{_pTargetCpcNanos = a}) - . mapping _Coerce - --- | Account ID of this project. -pAccountId :: Lens' Project (Maybe Int64) -pAccountId - = lens _pAccountId (\ s a -> s{_pAccountId = a}) . - mapping _Coerce - --- | Name of this project. -pName :: Lens' Project (Maybe Text) -pName = lens _pName (\ s a -> s{_pName = a}) - --- | Information about the most recent modification of this project. -pLastModifiedInfo :: Lens' Project (Maybe LastModifiedInfo) -pLastModifiedInfo - = lens _pLastModifiedInfo - (\ s a -> s{_pLastModifiedInfo = a}) - --- | ID of this project. This is a read-only, auto-generated field. -pId :: Lens' Project (Maybe Int64) -pId - = lens _pId (\ s a -> s{_pId = a}) . mapping _Coerce - --- | Audience age group of this project. -pAudienceAgeGroup :: Lens' Project (Maybe ProjectAudienceAgeGroup) -pAudienceAgeGroup - = lens _pAudienceAgeGroup - (\ s a -> s{_pAudienceAgeGroup = a}) - --- | Subaccount ID of this project. -pSubAccountId :: Lens' Project (Maybe Int64) -pSubAccountId - = lens _pSubAccountId - (\ s a -> s{_pSubAccountId = a}) - . mapping _Coerce - --- | vCPM from Active View that the advertiser is targeting. -pTargetCpmActiveViewNanos :: Lens' Project (Maybe Int64) -pTargetCpmActiveViewNanos - = lens _pTargetCpmActiveViewNanos - (\ s a -> s{_pTargetCpmActiveViewNanos = a}) - . mapping _Coerce - --- | Audience gender of this project. -pAudienceGender :: Lens' Project (Maybe ProjectAudienceGender) -pAudienceGender - = lens _pAudienceGender - (\ s a -> s{_pAudienceGender = a}) - --- | Name of the project client. -pClientName :: Lens' Project (Maybe Text) -pClientName - = lens _pClientName (\ s a -> s{_pClientName = a}) - --- | CPA that the advertiser is targeting. -pTargetCpaNanos :: Lens' Project (Maybe Int64) -pTargetCpaNanos - = lens _pTargetCpaNanos - (\ s a -> s{_pTargetCpaNanos = a}) - . mapping _Coerce - -instance FromJSON Project where - parseJSON - = withObject "Project" - (\ o -> - Project' <$> - (o .:? "targetClicks") <*> - (o .:? "clientBillingCode") - <*> (o .:? "targetCpmNanos") - <*> (o .:? "targetConversions") - <*> (o .:? "budget") - <*> (o .:? "kind" .!= "dfareporting#project") - <*> (o .:? "advertiserId") - <*> (o .:? "endDate") - <*> (o .:? "overview") - <*> (o .:? "targetImpressions") - <*> (o .:? "startDate") - <*> (o .:? "targetCpcNanos") - <*> (o .:? "accountId") - <*> (o .:? "name") - <*> (o .:? "lastModifiedInfo") - <*> (o .:? "id") - <*> (o .:? "audienceAgeGroup") - <*> (o .:? "subaccountId") - <*> (o .:? "targetCpmActiveViewNanos") - <*> (o .:? "audienceGender") - <*> (o .:? "clientName") - <*> (o .:? "targetCpaNanos")) - -instance ToJSON Project where - toJSON Project'{..} - = object - (catMaybes - [("targetClicks" .=) <$> _pTargetClicks, - ("clientBillingCode" .=) <$> _pClientBillingCode, - ("targetCpmNanos" .=) <$> _pTargetCpmNanos, - ("targetConversions" .=) <$> _pTargetConversions, - ("budget" .=) <$> _pBudget, Just ("kind" .= _pKind), - ("advertiserId" .=) <$> _pAdvertiserId, - ("endDate" .=) <$> _pEndDate, - ("overview" .=) <$> _pOverview, - ("targetImpressions" .=) <$> _pTargetImpressions, - ("startDate" .=) <$> _pStartDate, - ("targetCpcNanos" .=) <$> _pTargetCpcNanos, - ("accountId" .=) <$> _pAccountId, - ("name" .=) <$> _pName, - ("lastModifiedInfo" .=) <$> _pLastModifiedInfo, - ("id" .=) <$> _pId, - ("audienceAgeGroup" .=) <$> _pAudienceAgeGroup, - ("subaccountId" .=) <$> _pSubAccountId, - ("targetCpmActiveViewNanos" .=) <$> - _pTargetCpmActiveViewNanos, - ("audienceGender" .=) <$> _pAudienceGender, - ("clientName" .=) <$> _pClientName, - ("targetCpaNanos" .=) <$> _pTargetCpaNanos]) - --- | The report criteria for a report of type \"FLOODLIGHT\". --- --- /See:/ 'reportFloodlightCriteria' smart constructor. -data ReportFloodlightCriteria = ReportFloodlightCriteria' - { _rfcReportProperties :: !(Maybe ReportFloodlightCriteriaReportProperties) - , _rfcMetricNames :: !(Maybe [Text]) - , _rfcCustomRichMediaEvents :: !(Maybe [DimensionValue]) - , _rfcDimensionFilters :: !(Maybe [DimensionValue]) - , _rfcDateRange :: !(Maybe DateRange) - , _rfcFloodlightConfigId :: !(Maybe DimensionValue) - , _rfcDimensions :: !(Maybe [SortedDimension]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'ReportFloodlightCriteria' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'rfcReportProperties' --- --- * 'rfcMetricNames' --- --- * 'rfcCustomRichMediaEvents' --- --- * 'rfcDimensionFilters' --- --- * 'rfcDateRange' --- --- * 'rfcFloodlightConfigId' --- --- * 'rfcDimensions' -reportFloodlightCriteria - :: ReportFloodlightCriteria -reportFloodlightCriteria = - ReportFloodlightCriteria' - { _rfcReportProperties = Nothing - , _rfcMetricNames = Nothing - , _rfcCustomRichMediaEvents = Nothing - , _rfcDimensionFilters = Nothing - , _rfcDateRange = Nothing - , _rfcFloodlightConfigId = Nothing - , _rfcDimensions = Nothing - } - --- | The properties of the report. -rfcReportProperties :: Lens' ReportFloodlightCriteria (Maybe ReportFloodlightCriteriaReportProperties) -rfcReportProperties - = lens _rfcReportProperties - (\ s a -> s{_rfcReportProperties = a}) - --- | The list of names of metrics the report should include. -rfcMetricNames :: Lens' ReportFloodlightCriteria [Text] -rfcMetricNames - = lens _rfcMetricNames - (\ s a -> s{_rfcMetricNames = a}) - . _Default - . _Coerce - --- | The list of custom rich media events to include. -rfcCustomRichMediaEvents :: Lens' ReportFloodlightCriteria [DimensionValue] -rfcCustomRichMediaEvents - = lens _rfcCustomRichMediaEvents - (\ s a -> s{_rfcCustomRichMediaEvents = a}) - . _Default - . _Coerce - --- | The list of filters on which dimensions are filtered. Filters for --- different dimensions are ANDed, filters for the same dimension are --- grouped together and ORed. -rfcDimensionFilters :: Lens' ReportFloodlightCriteria [DimensionValue] -rfcDimensionFilters - = lens _rfcDimensionFilters - (\ s a -> s{_rfcDimensionFilters = a}) - . _Default - . _Coerce - --- | The date range this report should be run for. -rfcDateRange :: Lens' ReportFloodlightCriteria (Maybe DateRange) -rfcDateRange - = lens _rfcDateRange (\ s a -> s{_rfcDateRange = a}) - --- | The floodlight ID for which to show data in this report. All advertisers --- associated with that ID will automatically be added. The dimension of --- the value needs to be \'dfa:floodlightConfigId\'. -rfcFloodlightConfigId :: Lens' ReportFloodlightCriteria (Maybe DimensionValue) -rfcFloodlightConfigId - = lens _rfcFloodlightConfigId - (\ s a -> s{_rfcFloodlightConfigId = a}) - --- | The list of dimensions the report should include. -rfcDimensions :: Lens' ReportFloodlightCriteria [SortedDimension] -rfcDimensions - = lens _rfcDimensions - (\ s a -> s{_rfcDimensions = a}) - . _Default - . _Coerce - -instance FromJSON ReportFloodlightCriteria where - parseJSON - = withObject "ReportFloodlightCriteria" - (\ o -> - ReportFloodlightCriteria' <$> - (o .:? "reportProperties") <*> - (o .:? "metricNames" .!= mempty) - <*> (o .:? "customRichMediaEvents" .!= mempty) - <*> (o .:? "dimensionFilters" .!= mempty) - <*> (o .:? "dateRange") - <*> (o .:? "floodlightConfigId") - <*> (o .:? "dimensions" .!= mempty)) - -instance ToJSON ReportFloodlightCriteria where - toJSON ReportFloodlightCriteria'{..} - = object - (catMaybes - [("reportProperties" .=) <$> _rfcReportProperties, - ("metricNames" .=) <$> _rfcMetricNames, - ("customRichMediaEvents" .=) <$> - _rfcCustomRichMediaEvents, - ("dimensionFilters" .=) <$> _rfcDimensionFilters, - ("dateRange" .=) <$> _rfcDateRange, - ("floodlightConfigId" .=) <$> _rfcFloodlightConfigId, - ("dimensions" .=) <$> _rfcDimensions]) - --- | Represents the dimensions of ads, placements, creatives, or creative --- assets. --- --- /See:/ 'size' smart constructor. -data Size = Size' - { _sHeight :: !(Maybe (Textual Int32)) - , _sKind :: !Text - , _sWidth :: !(Maybe (Textual Int32)) - , _sIab :: !(Maybe Bool) - , _sId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'Size' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'sHeight' --- --- * 'sKind' --- --- * 'sWidth' --- --- * 'sIab' --- --- * 'sId' -size - :: Size -size = - Size' - { _sHeight = Nothing - , _sKind = "dfareporting#size" - , _sWidth = Nothing - , _sIab = Nothing - , _sId = Nothing - } - --- | Height of this size. Acceptable values are 0 to 32767, inclusive. -sHeight :: Lens' Size (Maybe Int32) -sHeight - = lens _sHeight (\ s a -> s{_sHeight = a}) . - mapping _Coerce - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#size\". -sKind :: Lens' Size Text -sKind = lens _sKind (\ s a -> s{_sKind = a}) - --- | Width of this size. Acceptable values are 0 to 32767, inclusive. -sWidth :: Lens' Size (Maybe Int32) -sWidth - = lens _sWidth (\ s a -> s{_sWidth = a}) . - mapping _Coerce - --- | IAB standard size. This is a read-only, auto-generated field. -sIab :: Lens' Size (Maybe Bool) -sIab = lens _sIab (\ s a -> s{_sIab = a}) - --- | ID of this size. This is a read-only, auto-generated field. -sId :: Lens' Size (Maybe Int64) -sId - = lens _sId (\ s a -> s{_sId = a}) . mapping _Coerce - -instance FromJSON Size where - parseJSON - = withObject "Size" - (\ o -> - Size' <$> - (o .:? "height") <*> - (o .:? "kind" .!= "dfareporting#size") - <*> (o .:? "width") - <*> (o .:? "iab") - <*> (o .:? "id")) - -instance ToJSON Size where - toJSON Size'{..} - = object - (catMaybes - [("height" .=) <$> _sHeight, Just ("kind" .= _sKind), - ("width" .=) <$> _sWidth, ("iab" .=) <$> _sIab, - ("id" .=) <$> _sId]) - --- | Object Filter. --- --- /See:/ 'objectFilter' smart constructor. -data ObjectFilter = ObjectFilter' - { _ofStatus :: !(Maybe ObjectFilterStatus) - , _ofKind :: !Text - , _ofObjectIds :: !(Maybe [Textual Int64]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'ObjectFilter' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'ofStatus' --- --- * 'ofKind' --- --- * 'ofObjectIds' -objectFilter - :: ObjectFilter -objectFilter = - ObjectFilter' - { _ofStatus = Nothing - , _ofKind = "dfareporting#objectFilter" - , _ofObjectIds = Nothing - } - --- | Status of the filter. NONE means the user has access to none of the --- objects. ALL means the user has access to all objects. ASSIGNED means --- the user has access to the objects with IDs in the objectIds list. -ofStatus :: Lens' ObjectFilter (Maybe ObjectFilterStatus) -ofStatus = lens _ofStatus (\ s a -> s{_ofStatus = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#objectFilter\". -ofKind :: Lens' ObjectFilter Text -ofKind = lens _ofKind (\ s a -> s{_ofKind = a}) - --- | Applicable when status is ASSIGNED. The user has access to objects with --- these object IDs. -ofObjectIds :: Lens' ObjectFilter [Int64] -ofObjectIds - = lens _ofObjectIds (\ s a -> s{_ofObjectIds = a}) . - _Default - . _Coerce - -instance FromJSON ObjectFilter where - parseJSON - = withObject "ObjectFilter" - (\ o -> - ObjectFilter' <$> - (o .:? "status") <*> - (o .:? "kind" .!= "dfareporting#objectFilter") - <*> (o .:? "objectIds" .!= mempty)) - -instance ToJSON ObjectFilter where - toJSON ObjectFilter'{..} - = object - (catMaybes - [("status" .=) <$> _ofStatus, - Just ("kind" .= _ofKind), - ("objectIds" .=) <$> _ofObjectIds]) - --- | Skippable Settings --- --- /See:/ 'skippableSetting' smart constructor. -data SkippableSetting = SkippableSetting' - { _ssSkipOffSet :: !(Maybe VideoOffSet) - , _ssProgressOffSet :: !(Maybe VideoOffSet) - , _ssKind :: !Text - , _ssSkippable :: !(Maybe Bool) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'SkippableSetting' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'ssSkipOffSet' --- --- * 'ssProgressOffSet' --- --- * 'ssKind' --- --- * 'ssSkippable' -skippableSetting - :: SkippableSetting -skippableSetting = - SkippableSetting' - { _ssSkipOffSet = Nothing - , _ssProgressOffSet = Nothing - , _ssKind = "dfareporting#skippableSetting" - , _ssSkippable = Nothing - } - --- | Amount of time to play videos served to this placement before the skip --- button should appear. Applicable when skippable is true. -ssSkipOffSet :: Lens' SkippableSetting (Maybe VideoOffSet) -ssSkipOffSet - = lens _ssSkipOffSet (\ s a -> s{_ssSkipOffSet = a}) - --- | Amount of time to play videos served to this placement before counting a --- view. Applicable when skippable is true. -ssProgressOffSet :: Lens' SkippableSetting (Maybe VideoOffSet) -ssProgressOffSet - = lens _ssProgressOffSet - (\ s a -> s{_ssProgressOffSet = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#skippableSetting\". -ssKind :: Lens' SkippableSetting Text -ssKind = lens _ssKind (\ s a -> s{_ssKind = a}) - --- | Whether the user can skip creatives served to this placement. -ssSkippable :: Lens' SkippableSetting (Maybe Bool) -ssSkippable - = lens _ssSkippable (\ s a -> s{_ssSkippable = a}) - -instance FromJSON SkippableSetting where - parseJSON - = withObject "SkippableSetting" - (\ o -> - SkippableSetting' <$> - (o .:? "skipOffset") <*> (o .:? "progressOffset") <*> - (o .:? "kind" .!= "dfareporting#skippableSetting") - <*> (o .:? "skippable")) - -instance ToJSON SkippableSetting where - toJSON SkippableSetting'{..} - = object - (catMaybes - [("skipOffset" .=) <$> _ssSkipOffSet, - ("progressOffset" .=) <$> _ssProgressOffSet, - Just ("kind" .= _ssKind), - ("skippable" .=) <$> _ssSkippable]) - --- | Reporting Configuration --- --- /See:/ 'reportsConfiguration' smart constructor. -data ReportsConfiguration = ReportsConfiguration' - { _rcExposureToConversionEnabled :: !(Maybe Bool) - , _rcReportGenerationTimeZoneId :: !(Maybe (Textual Int64)) - , _rcLookbackConfiguration :: !(Maybe LookbackConfiguration) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'ReportsConfiguration' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'rcExposureToConversionEnabled' --- --- * 'rcReportGenerationTimeZoneId' --- --- * 'rcLookbackConfiguration' -reportsConfiguration - :: ReportsConfiguration -reportsConfiguration = - ReportsConfiguration' - { _rcExposureToConversionEnabled = Nothing - , _rcReportGenerationTimeZoneId = Nothing - , _rcLookbackConfiguration = Nothing - } - --- | Whether the exposure to conversion report is enabled. This report shows --- detailed pathway information on up to 10 of the most recent ad exposures --- seen by a user before converting. -rcExposureToConversionEnabled :: Lens' ReportsConfiguration (Maybe Bool) -rcExposureToConversionEnabled - = lens _rcExposureToConversionEnabled - (\ s a -> s{_rcExposureToConversionEnabled = a}) - --- | Report generation time zone ID of this account. This is a required field --- that can only be changed by a superuser. Acceptable values are: - \"1\" --- for \"America\/New_York\" - \"2\" for \"Europe\/London\" - \"3\" for --- \"Europe\/Paris\" - \"4\" for \"Africa\/Johannesburg\" - \"5\" for --- \"Asia\/Jerusalem\" - \"6\" for \"Asia\/Shanghai\" - \"7\" for --- \"Asia\/Hong_Kong\" - \"8\" for \"Asia\/Tokyo\" - \"9\" for --- \"Australia\/Sydney\" - \"10\" for \"Asia\/Dubai\" - \"11\" for --- \"America\/Los_Angeles\" - \"12\" for \"Pacific\/Auckland\" - \"13\" for --- \"America\/Sao_Paulo\" -rcReportGenerationTimeZoneId :: Lens' ReportsConfiguration (Maybe Int64) -rcReportGenerationTimeZoneId - = lens _rcReportGenerationTimeZoneId - (\ s a -> s{_rcReportGenerationTimeZoneId = a}) - . mapping _Coerce - --- | Default lookback windows for new advertisers in this account. -rcLookbackConfiguration :: Lens' ReportsConfiguration (Maybe LookbackConfiguration) -rcLookbackConfiguration - = lens _rcLookbackConfiguration - (\ s a -> s{_rcLookbackConfiguration = a}) - -instance FromJSON ReportsConfiguration where - parseJSON - = withObject "ReportsConfiguration" - (\ o -> - ReportsConfiguration' <$> - (o .:? "exposureToConversionEnabled") <*> - (o .:? "reportGenerationTimeZoneId") - <*> (o .:? "lookbackConfiguration")) - -instance ToJSON ReportsConfiguration where - toJSON ReportsConfiguration'{..} - = object - (catMaybes - [("exposureToConversionEnabled" .=) <$> - _rcExposureToConversionEnabled, - ("reportGenerationTimeZoneId" .=) <$> - _rcReportGenerationTimeZoneId, - ("lookbackConfiguration" .=) <$> - _rcLookbackConfiguration]) - --- | Pricing Schedule --- --- /See:/ 'pricingSchedule' smart constructor. -data PricingSchedule = PricingSchedule' - { _psTestingStartDate :: !(Maybe Date') - , _psFloodlightActivityId :: !(Maybe (Textual Int64)) - , _psEndDate :: !(Maybe Date') - , _psDisregardOverdelivery :: !(Maybe Bool) - , _psStartDate :: !(Maybe Date') - , _psCapCostOption :: !(Maybe PricingScheduleCapCostOption) - , _psPricingType :: !(Maybe PricingSchedulePricingType) - , _psPricingPeriods :: !(Maybe [PricingSchedulePricingPeriod]) - , _psFlighted :: !(Maybe Bool) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'PricingSchedule' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'psTestingStartDate' --- --- * 'psFloodlightActivityId' --- --- * 'psEndDate' --- --- * 'psDisregardOverdelivery' --- --- * 'psStartDate' --- --- * 'psCapCostOption' --- --- * 'psPricingType' --- --- * 'psPricingPeriods' --- --- * 'psFlighted' -pricingSchedule - :: PricingSchedule -pricingSchedule = - PricingSchedule' - { _psTestingStartDate = Nothing - , _psFloodlightActivityId = Nothing - , _psEndDate = Nothing - , _psDisregardOverdelivery = Nothing - , _psStartDate = Nothing - , _psCapCostOption = Nothing - , _psPricingType = Nothing - , _psPricingPeriods = Nothing - , _psFlighted = Nothing - } - --- | Testing start date of this placement. The hours, minutes, and seconds of --- the start date should not be set, as doing so will result in an error. -psTestingStartDate :: Lens' PricingSchedule (Maybe Day) -psTestingStartDate - = lens _psTestingStartDate - (\ s a -> s{_psTestingStartDate = a}) - . mapping _Date - --- | Floodlight activity ID associated with this placement. This field should --- be set when placement pricing type is set to PRICING_TYPE_CPA. -psFloodlightActivityId :: Lens' PricingSchedule (Maybe Int64) -psFloodlightActivityId - = lens _psFloodlightActivityId - (\ s a -> s{_psFloodlightActivityId = a}) - . mapping _Coerce - --- | Placement end date. This date must be later than, or the same day as, --- the placement start date, but not later than the campaign end date. If, --- for example, you set 6\/25\/2015 as both the start and end dates, the --- effective placement date is just that day only, 6\/25\/2015. The hours, --- minutes, and seconds of the end date should not be set, as doing so will --- result in an error. This field is required on insertion. -psEndDate :: Lens' PricingSchedule (Maybe Day) -psEndDate - = lens _psEndDate (\ s a -> s{_psEndDate = a}) . - mapping _Date - --- | Whether cap costs are ignored by ad serving. -psDisregardOverdelivery :: Lens' PricingSchedule (Maybe Bool) -psDisregardOverdelivery - = lens _psDisregardOverdelivery - (\ s a -> s{_psDisregardOverdelivery = a}) - --- | Placement start date. This date must be later than, or the same day as, --- the campaign start date. The hours, minutes, and seconds of the start --- date should not be set, as doing so will result in an error. This field --- is required on insertion. -psStartDate :: Lens' PricingSchedule (Maybe Day) -psStartDate - = lens _psStartDate (\ s a -> s{_psStartDate = a}) . - mapping _Date - --- | Placement cap cost option. -psCapCostOption :: Lens' PricingSchedule (Maybe PricingScheduleCapCostOption) -psCapCostOption - = lens _psCapCostOption - (\ s a -> s{_psCapCostOption = a}) - --- | Placement pricing type. This field is required on insertion. -psPricingType :: Lens' PricingSchedule (Maybe PricingSchedulePricingType) -psPricingType - = lens _psPricingType - (\ s a -> s{_psPricingType = a}) - --- | Pricing periods for this placement. -psPricingPeriods :: Lens' PricingSchedule [PricingSchedulePricingPeriod] -psPricingPeriods - = lens _psPricingPeriods - (\ s a -> s{_psPricingPeriods = a}) - . _Default - . _Coerce - --- | Whether this placement is flighted. If true, pricing periods will be --- computed automatically. -psFlighted :: Lens' PricingSchedule (Maybe Bool) -psFlighted - = lens _psFlighted (\ s a -> s{_psFlighted = a}) - -instance FromJSON PricingSchedule where - parseJSON - = withObject "PricingSchedule" - (\ o -> - PricingSchedule' <$> - (o .:? "testingStartDate") <*> - (o .:? "floodlightActivityId") - <*> (o .:? "endDate") - <*> (o .:? "disregardOverdelivery") - <*> (o .:? "startDate") - <*> (o .:? "capCostOption") - <*> (o .:? "pricingType") - <*> (o .:? "pricingPeriods" .!= mempty) - <*> (o .:? "flighted")) - -instance ToJSON PricingSchedule where - toJSON PricingSchedule'{..} - = object - (catMaybes - [("testingStartDate" .=) <$> _psTestingStartDate, - ("floodlightActivityId" .=) <$> - _psFloodlightActivityId, - ("endDate" .=) <$> _psEndDate, - ("disregardOverdelivery" .=) <$> - _psDisregardOverdelivery, - ("startDate" .=) <$> _psStartDate, - ("capCostOption" .=) <$> _psCapCostOption, - ("pricingType" .=) <$> _psPricingType, - ("pricingPeriods" .=) <$> _psPricingPeriods, - ("flighted" .=) <$> _psFlighted]) - --- | Contains information about a postal code that can be targeted by ads. --- --- /See:/ 'postalCode' smart constructor. -data PostalCode = PostalCode' - { _pcKind :: !Text - , _pcCode :: !(Maybe Text) - , _pcCountryCode :: !(Maybe Text) - , _pcId :: !(Maybe Text) - , _pcCountryDartId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'PostalCode' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'pcKind' --- --- * 'pcCode' --- --- * 'pcCountryCode' --- --- * 'pcId' --- --- * 'pcCountryDartId' -postalCode - :: PostalCode -postalCode = - PostalCode' - { _pcKind = "dfareporting#postalCode" - , _pcCode = Nothing - , _pcCountryCode = Nothing - , _pcId = Nothing - , _pcCountryDartId = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#postalCode\". -pcKind :: Lens' PostalCode Text -pcKind = lens _pcKind (\ s a -> s{_pcKind = a}) - --- | Postal code. This is equivalent to the id field. -pcCode :: Lens' PostalCode (Maybe Text) -pcCode = lens _pcCode (\ s a -> s{_pcCode = a}) - --- | Country code of the country to which this postal code belongs. -pcCountryCode :: Lens' PostalCode (Maybe Text) -pcCountryCode - = lens _pcCountryCode - (\ s a -> s{_pcCountryCode = a}) - --- | ID of this postal code. -pcId :: Lens' PostalCode (Maybe Text) -pcId = lens _pcId (\ s a -> s{_pcId = a}) - --- | DART ID of the country to which this postal code belongs. -pcCountryDartId :: Lens' PostalCode (Maybe Int64) -pcCountryDartId - = lens _pcCountryDartId - (\ s a -> s{_pcCountryDartId = a}) - . mapping _Coerce - -instance FromJSON PostalCode where - parseJSON - = withObject "PostalCode" - (\ o -> - PostalCode' <$> - (o .:? "kind" .!= "dfareporting#postalCode") <*> - (o .:? "code") - <*> (o .:? "countryCode") - <*> (o .:? "id") - <*> (o .:? "countryDartId")) - -instance ToJSON PostalCode where - toJSON PostalCode'{..} - = object - (catMaybes - [Just ("kind" .= _pcKind), ("code" .=) <$> _pcCode, - ("countryCode" .=) <$> _pcCountryCode, - ("id" .=) <$> _pcId, - ("countryDartId" .=) <$> _pcCountryDartId]) - --- | Account Permission List Response --- --- /See:/ 'accountPermissionsListResponse' smart constructor. -data AccountPermissionsListResponse = AccountPermissionsListResponse' - { _aplrKind :: !Text - , _aplrAccountPermissions :: !(Maybe [AccountPermission]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'AccountPermissionsListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'aplrKind' --- --- * 'aplrAccountPermissions' -accountPermissionsListResponse - :: AccountPermissionsListResponse -accountPermissionsListResponse = - AccountPermissionsListResponse' - { _aplrKind = "dfareporting#accountPermissionsListResponse" - , _aplrAccountPermissions = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#accountPermissionsListResponse\". -aplrKind :: Lens' AccountPermissionsListResponse Text -aplrKind = lens _aplrKind (\ s a -> s{_aplrKind = a}) - --- | Account permission collection. -aplrAccountPermissions :: Lens' AccountPermissionsListResponse [AccountPermission] -aplrAccountPermissions - = lens _aplrAccountPermissions - (\ s a -> s{_aplrAccountPermissions = a}) - . _Default - . _Coerce - -instance FromJSON AccountPermissionsListResponse - where - parseJSON - = withObject "AccountPermissionsListResponse" - (\ o -> - AccountPermissionsListResponse' <$> - (o .:? "kind" .!= - "dfareporting#accountPermissionsListResponse") - <*> (o .:? "accountPermissions" .!= mempty)) - -instance ToJSON AccountPermissionsListResponse where - toJSON AccountPermissionsListResponse'{..} - = object - (catMaybes - [Just ("kind" .= _aplrKind), - ("accountPermissions" .=) <$> - _aplrAccountPermissions]) - --- | Contains information about a country that can be targeted by ads. --- --- /See:/ 'country' smart constructor. -data Country = Country' - { _cKind :: !Text - , _cName :: !(Maybe Text) - , _cCountryCode :: !(Maybe Text) - , _cDartId :: !(Maybe (Textual Int64)) - , _cSSLEnabled :: !(Maybe Bool) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'Country' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'cKind' --- --- * 'cName' --- --- * 'cCountryCode' --- --- * 'cDartId' --- --- * 'cSSLEnabled' -country - :: Country -country = - Country' - { _cKind = "dfareporting#country" - , _cName = Nothing - , _cCountryCode = Nothing - , _cDartId = Nothing - , _cSSLEnabled = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#country\". -cKind :: Lens' Country Text -cKind = lens _cKind (\ s a -> s{_cKind = a}) - --- | Name of this country. -cName :: Lens' Country (Maybe Text) -cName = lens _cName (\ s a -> s{_cName = a}) - --- | Country code. -cCountryCode :: Lens' Country (Maybe Text) -cCountryCode - = lens _cCountryCode (\ s a -> s{_cCountryCode = a}) - --- | DART ID of this country. This is the ID used for targeting and --- generating reports. -cDartId :: Lens' Country (Maybe Int64) -cDartId - = lens _cDartId (\ s a -> s{_cDartId = a}) . - mapping _Coerce - --- | Whether ad serving supports secure servers in this country. -cSSLEnabled :: Lens' Country (Maybe Bool) -cSSLEnabled - = lens _cSSLEnabled (\ s a -> s{_cSSLEnabled = a}) - -instance FromJSON Country where - parseJSON - = withObject "Country" - (\ o -> - Country' <$> - (o .:? "kind" .!= "dfareporting#country") <*> - (o .:? "name") - <*> (o .:? "countryCode") - <*> (o .:? "dartId") - <*> (o .:? "sslEnabled")) - -instance ToJSON Country where - toJSON Country'{..} - = object - (catMaybes - [Just ("kind" .= _cKind), ("name" .=) <$> _cName, - ("countryCode" .=) <$> _cCountryCode, - ("dartId" .=) <$> _cDartId, - ("sslEnabled" .=) <$> _cSSLEnabled]) - --- | Operating System Version List Response --- --- /See:/ 'operatingSystemVersionsListResponse' smart constructor. -data OperatingSystemVersionsListResponse = OperatingSystemVersionsListResponse' - { _osvlrKind :: !Text - , _osvlrOperatingSystemVersions :: !(Maybe [OperatingSystemVersion]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'OperatingSystemVersionsListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'osvlrKind' --- --- * 'osvlrOperatingSystemVersions' -operatingSystemVersionsListResponse - :: OperatingSystemVersionsListResponse -operatingSystemVersionsListResponse = - OperatingSystemVersionsListResponse' - { _osvlrKind = "dfareporting#operatingSystemVersionsListResponse" - , _osvlrOperatingSystemVersions = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#operatingSystemVersionsListResponse\". -osvlrKind :: Lens' OperatingSystemVersionsListResponse Text -osvlrKind - = lens _osvlrKind (\ s a -> s{_osvlrKind = a}) - --- | Operating system version collection. -osvlrOperatingSystemVersions :: Lens' OperatingSystemVersionsListResponse [OperatingSystemVersion] -osvlrOperatingSystemVersions - = lens _osvlrOperatingSystemVersions - (\ s a -> s{_osvlrOperatingSystemVersions = a}) - . _Default - . _Coerce - -instance FromJSON OperatingSystemVersionsListResponse - where - parseJSON - = withObject "OperatingSystemVersionsListResponse" - (\ o -> - OperatingSystemVersionsListResponse' <$> - (o .:? "kind" .!= - "dfareporting#operatingSystemVersionsListResponse") - <*> (o .:? "operatingSystemVersions" .!= mempty)) - -instance ToJSON OperatingSystemVersionsListResponse - where - toJSON OperatingSystemVersionsListResponse'{..} - = object - (catMaybes - [Just ("kind" .= _osvlrKind), - ("operatingSystemVersions" .=) <$> - _osvlrOperatingSystemVersions]) - --- | Click Through URL Suffix settings. --- --- /See:/ 'clickThroughURLSuffixProperties' smart constructor. -data ClickThroughURLSuffixProperties = ClickThroughURLSuffixProperties' - { _ctuspOverrideInheritedSuffix :: !(Maybe Bool) - , _ctuspClickThroughURLSuffix :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'ClickThroughURLSuffixProperties' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'ctuspOverrideInheritedSuffix' --- --- * 'ctuspClickThroughURLSuffix' -clickThroughURLSuffixProperties - :: ClickThroughURLSuffixProperties -clickThroughURLSuffixProperties = - ClickThroughURLSuffixProperties' - { _ctuspOverrideInheritedSuffix = Nothing - , _ctuspClickThroughURLSuffix = Nothing - } - --- | Whether this entity should override the inherited click-through URL --- suffix with its own defined value. -ctuspOverrideInheritedSuffix :: Lens' ClickThroughURLSuffixProperties (Maybe Bool) -ctuspOverrideInheritedSuffix - = lens _ctuspOverrideInheritedSuffix - (\ s a -> s{_ctuspOverrideInheritedSuffix = a}) - --- | Click-through URL suffix to apply to all ads in this entity\'s scope. --- Must be less than 128 characters long. -ctuspClickThroughURLSuffix :: Lens' ClickThroughURLSuffixProperties (Maybe Text) -ctuspClickThroughURLSuffix - = lens _ctuspClickThroughURLSuffix - (\ s a -> s{_ctuspClickThroughURLSuffix = a}) - -instance FromJSON ClickThroughURLSuffixProperties - where - parseJSON - = withObject "ClickThroughURLSuffixProperties" - (\ o -> - ClickThroughURLSuffixProperties' <$> - (o .:? "overrideInheritedSuffix") <*> - (o .:? "clickThroughUrlSuffix")) - -instance ToJSON ClickThroughURLSuffixProperties where - toJSON ClickThroughURLSuffixProperties'{..} - = object - (catMaybes - [("overrideInheritedSuffix" .=) <$> - _ctuspOverrideInheritedSuffix, - ("clickThroughUrlSuffix" .=) <$> - _ctuspClickThroughURLSuffix]) - --- | Pricing Information --- --- /See:/ 'pricing' smart constructor. -data Pricing = Pricing' - { _priEndDate :: !(Maybe Date') - , _priStartDate :: !(Maybe Date') - , _priGroupType :: !(Maybe PricingGroupType) - , _priPricingType :: !(Maybe PricingPricingType) - , _priFlights :: !(Maybe [Flight]) - , _priCapCostType :: !(Maybe PricingCapCostType) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'Pricing' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'priEndDate' --- --- * 'priStartDate' --- --- * 'priGroupType' --- --- * 'priPricingType' --- --- * 'priFlights' --- --- * 'priCapCostType' -pricing - :: Pricing -pricing = - Pricing' - { _priEndDate = Nothing - , _priStartDate = Nothing - , _priGroupType = Nothing - , _priPricingType = Nothing - , _priFlights = Nothing - , _priCapCostType = Nothing - } - --- | End date of this inventory item. -priEndDate :: Lens' Pricing (Maybe Day) -priEndDate - = lens _priEndDate (\ s a -> s{_priEndDate = a}) . - mapping _Date - --- | Start date of this inventory item. -priStartDate :: Lens' Pricing (Maybe Day) -priStartDate - = lens _priStartDate (\ s a -> s{_priStartDate = a}) - . mapping _Date - --- | Group type of this inventory item if it represents a placement group. Is --- null otherwise. There are two type of placement groups: --- PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory --- items that acts as a single pricing point for a group of tags. --- PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items --- that not only acts as a single pricing point, but also assumes that all --- the tags in it will be served at the same time. A roadblock requires one --- of its assigned inventory items to be marked as primary. -priGroupType :: Lens' Pricing (Maybe PricingGroupType) -priGroupType - = lens _priGroupType (\ s a -> s{_priGroupType = a}) - --- | Pricing type of this inventory item. -priPricingType :: Lens' Pricing (Maybe PricingPricingType) -priPricingType - = lens _priPricingType - (\ s a -> s{_priPricingType = a}) - --- | Flights of this inventory item. A flight (a.k.a. pricing period) --- represents the inventory item pricing information for a specific period --- of time. -priFlights :: Lens' Pricing [Flight] -priFlights - = lens _priFlights (\ s a -> s{_priFlights = a}) . - _Default - . _Coerce - --- | Cap cost type of this inventory item. -priCapCostType :: Lens' Pricing (Maybe PricingCapCostType) -priCapCostType - = lens _priCapCostType - (\ s a -> s{_priCapCostType = a}) - -instance FromJSON Pricing where - parseJSON - = withObject "Pricing" - (\ o -> - Pricing' <$> - (o .:? "endDate") <*> (o .:? "startDate") <*> - (o .:? "groupType") - <*> (o .:? "pricingType") - <*> (o .:? "flights" .!= mempty) - <*> (o .:? "capCostType")) - -instance ToJSON Pricing where - toJSON Pricing'{..} - = object - (catMaybes - [("endDate" .=) <$> _priEndDate, - ("startDate" .=) <$> _priStartDate, - ("groupType" .=) <$> _priGroupType, - ("pricingType" .=) <$> _priPricingType, - ("flights" .=) <$> _priFlights, - ("capCostType" .=) <$> _priCapCostType]) - --- | Audience Segment Group. --- --- /See:/ 'audienceSegmentGroup' smart constructor. -data AudienceSegmentGroup = AudienceSegmentGroup' - { _asgAudienceSegments :: !(Maybe [AudienceSegment]) - , _asgName :: !(Maybe Text) - , _asgId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'AudienceSegmentGroup' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'asgAudienceSegments' --- --- * 'asgName' --- --- * 'asgId' -audienceSegmentGroup - :: AudienceSegmentGroup -audienceSegmentGroup = - AudienceSegmentGroup' - { _asgAudienceSegments = Nothing - , _asgName = Nothing - , _asgId = Nothing - } - --- | Audience segments assigned to this group. The number of segments must be --- between 2 and 100. -asgAudienceSegments :: Lens' AudienceSegmentGroup [AudienceSegment] -asgAudienceSegments - = lens _asgAudienceSegments - (\ s a -> s{_asgAudienceSegments = a}) - . _Default - . _Coerce - --- | Name of this audience segment group. This is a required field and must --- be less than 65 characters long. -asgName :: Lens' AudienceSegmentGroup (Maybe Text) -asgName = lens _asgName (\ s a -> s{_asgName = a}) - --- | ID of this audience segment group. This is a read-only, auto-generated --- field. -asgId :: Lens' AudienceSegmentGroup (Maybe Int64) -asgId - = lens _asgId (\ s a -> s{_asgId = a}) . - mapping _Coerce - -instance FromJSON AudienceSegmentGroup where - parseJSON - = withObject "AudienceSegmentGroup" - (\ o -> - AudienceSegmentGroup' <$> - (o .:? "audienceSegments" .!= mempty) <*> - (o .:? "name") - <*> (o .:? "id")) - -instance ToJSON AudienceSegmentGroup where - toJSON AudienceSegmentGroup'{..} - = object - (catMaybes - [("audienceSegments" .=) <$> _asgAudienceSegments, - ("name" .=) <$> _asgName, ("id" .=) <$> _asgId]) - --- | Contains information about an operating system that can be targeted by --- ads. --- --- /See:/ 'operatingSystem' smart constructor. -data OperatingSystem = OperatingSystem' - { _osDesktop :: !(Maybe Bool) - , _osKind :: !Text - , _osName :: !(Maybe Text) - , _osMobile :: !(Maybe Bool) - , _osDartId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'OperatingSystem' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'osDesktop' --- --- * 'osKind' --- --- * 'osName' --- --- * 'osMobile' --- --- * 'osDartId' -operatingSystem - :: OperatingSystem -operatingSystem = - OperatingSystem' - { _osDesktop = Nothing - , _osKind = "dfareporting#operatingSystem" - , _osName = Nothing - , _osMobile = Nothing - , _osDartId = Nothing - } - --- | Whether this operating system is for desktop. -osDesktop :: Lens' OperatingSystem (Maybe Bool) -osDesktop - = lens _osDesktop (\ s a -> s{_osDesktop = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#operatingSystem\". -osKind :: Lens' OperatingSystem Text -osKind = lens _osKind (\ s a -> s{_osKind = a}) - --- | Name of this operating system. -osName :: Lens' OperatingSystem (Maybe Text) -osName = lens _osName (\ s a -> s{_osName = a}) - --- | Whether this operating system is for mobile. -osMobile :: Lens' OperatingSystem (Maybe Bool) -osMobile = lens _osMobile (\ s a -> s{_osMobile = a}) - --- | DART ID of this operating system. This is the ID used for targeting. -osDartId :: Lens' OperatingSystem (Maybe Int64) -osDartId - = lens _osDartId (\ s a -> s{_osDartId = a}) . - mapping _Coerce - -instance FromJSON OperatingSystem where - parseJSON - = withObject "OperatingSystem" - (\ o -> - OperatingSystem' <$> - (o .:? "desktop") <*> - (o .:? "kind" .!= "dfareporting#operatingSystem") - <*> (o .:? "name") - <*> (o .:? "mobile") - <*> (o .:? "dartId")) - -instance ToJSON OperatingSystem where - toJSON OperatingSystem'{..} - = object - (catMaybes - [("desktop" .=) <$> _osDesktop, - Just ("kind" .= _osKind), ("name" .=) <$> _osName, - ("mobile" .=) <$> _osMobile, - ("dartId" .=) <$> _osDartId]) - --- | Flight --- --- /See:/ 'flight' smart constructor. -data Flight = Flight' - { _fRateOrCost :: !(Maybe (Textual Int64)) - , _fEndDate :: !(Maybe Date') - , _fStartDate :: !(Maybe Date') - , _fUnits :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'Flight' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'fRateOrCost' --- --- * 'fEndDate' --- --- * 'fStartDate' --- --- * 'fUnits' -flight - :: Flight -flight = - Flight' - { _fRateOrCost = Nothing - , _fEndDate = Nothing - , _fStartDate = Nothing - , _fUnits = Nothing - } - --- | Rate or cost of this flight. -fRateOrCost :: Lens' Flight (Maybe Int64) -fRateOrCost - = lens _fRateOrCost (\ s a -> s{_fRateOrCost = a}) . - mapping _Coerce - --- | Inventory item flight end date. -fEndDate :: Lens' Flight (Maybe Day) -fEndDate - = lens _fEndDate (\ s a -> s{_fEndDate = a}) . - mapping _Date - --- | Inventory item flight start date. -fStartDate :: Lens' Flight (Maybe Day) -fStartDate - = lens _fStartDate (\ s a -> s{_fStartDate = a}) . - mapping _Date - --- | Units of this flight. -fUnits :: Lens' Flight (Maybe Int64) -fUnits - = lens _fUnits (\ s a -> s{_fUnits = a}) . - mapping _Coerce - -instance FromJSON Flight where - parseJSON - = withObject "Flight" - (\ o -> - Flight' <$> - (o .:? "rateOrCost") <*> (o .:? "endDate") <*> - (o .:? "startDate") - <*> (o .:? "units")) - -instance ToJSON Flight where - toJSON Flight'{..} - = object - (catMaybes - [("rateOrCost" .=) <$> _fRateOrCost, - ("endDate" .=) <$> _fEndDate, - ("startDate" .=) <$> _fStartDate, - ("units" .=) <$> _fUnits]) - --- | City List Response --- --- /See:/ 'citiesListResponse' smart constructor. -data CitiesListResponse = CitiesListResponse' - { _citKind :: !Text - , _citCities :: !(Maybe [City]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'CitiesListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'citKind' --- --- * 'citCities' -citiesListResponse - :: CitiesListResponse -citiesListResponse = - CitiesListResponse' - { _citKind = "dfareporting#citiesListResponse" - , _citCities = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#citiesListResponse\". -citKind :: Lens' CitiesListResponse Text -citKind = lens _citKind (\ s a -> s{_citKind = a}) - --- | City collection. -citCities :: Lens' CitiesListResponse [City] -citCities - = lens _citCities (\ s a -> s{_citCities = a}) . - _Default - . _Coerce - -instance FromJSON CitiesListResponse where - parseJSON - = withObject "CitiesListResponse" - (\ o -> - CitiesListResponse' <$> - (o .:? "kind" .!= "dfareporting#citiesListResponse") - <*> (o .:? "cities" .!= mempty)) - -instance ToJSON CitiesListResponse where - toJSON CitiesListResponse'{..} - = object - (catMaybes - [Just ("kind" .= _citKind), - ("cities" .=) <$> _citCities]) - --- | Represents a dimension. --- --- /See:/ 'dimension' smart constructor. -data Dimension = Dimension' - { _dKind :: !Text - , _dName :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'Dimension' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'dKind' --- --- * 'dName' -dimension - :: Dimension -dimension = - Dimension' - { _dKind = "dfareporting#dimension" - , _dName = Nothing - } - --- | The kind of resource this is, in this case dfareporting#dimension. -dKind :: Lens' Dimension Text -dKind = lens _dKind (\ s a -> s{_dKind = a}) - --- | The dimension name, e.g. dfa:advertiser -dName :: Lens' Dimension (Maybe Text) -dName = lens _dName (\ s a -> s{_dName = a}) - -instance FromJSON Dimension where - parseJSON - = withObject "Dimension" - (\ o -> - Dimension' <$> - (o .:? "kind" .!= "dfareporting#dimension") <*> - (o .:? "name")) - -instance ToJSON Dimension where - toJSON Dimension'{..} - = object - (catMaybes - [Just ("kind" .= _dKind), ("name" .=) <$> _dName]) - --- | The report criteria for a report of type \"REACH\". --- --- /See:/ 'reportReachCriteria' smart constructor. -data ReportReachCriteria = ReportReachCriteria' - { _rrcReachByFrequencyMetricNames :: !(Maybe [Text]) - , _rrcEnableAllDimensionCombinations :: !(Maybe Bool) - , _rrcMetricNames :: !(Maybe [Text]) - , _rrcCustomRichMediaEvents :: !(Maybe CustomRichMediaEvents) - , _rrcDimensionFilters :: !(Maybe [DimensionValue]) - , _rrcActivities :: !(Maybe Activities) - , _rrcDateRange :: !(Maybe DateRange) - , _rrcDimensions :: !(Maybe [SortedDimension]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'ReportReachCriteria' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'rrcReachByFrequencyMetricNames' --- --- * 'rrcEnableAllDimensionCombinations' --- --- * 'rrcMetricNames' --- --- * 'rrcCustomRichMediaEvents' --- --- * 'rrcDimensionFilters' --- --- * 'rrcActivities' --- --- * 'rrcDateRange' --- --- * 'rrcDimensions' -reportReachCriteria - :: ReportReachCriteria -reportReachCriteria = - ReportReachCriteria' - { _rrcReachByFrequencyMetricNames = Nothing - , _rrcEnableAllDimensionCombinations = Nothing - , _rrcMetricNames = Nothing - , _rrcCustomRichMediaEvents = Nothing - , _rrcDimensionFilters = Nothing - , _rrcActivities = Nothing - , _rrcDateRange = Nothing - , _rrcDimensions = Nothing - } - --- | The list of names of Reach By Frequency metrics the report should --- include. -rrcReachByFrequencyMetricNames :: Lens' ReportReachCriteria [Text] -rrcReachByFrequencyMetricNames - = lens _rrcReachByFrequencyMetricNames - (\ s a -> s{_rrcReachByFrequencyMetricNames = a}) - . _Default - . _Coerce - --- | Whether to enable all reach dimension combinations in the report. --- Defaults to false. If enabled, the date range of the report should be --- within the last 42 days. -rrcEnableAllDimensionCombinations :: Lens' ReportReachCriteria (Maybe Bool) -rrcEnableAllDimensionCombinations - = lens _rrcEnableAllDimensionCombinations - (\ s a -> s{_rrcEnableAllDimensionCombinations = a}) - --- | The list of names of metrics the report should include. -rrcMetricNames :: Lens' ReportReachCriteria [Text] -rrcMetricNames - = lens _rrcMetricNames - (\ s a -> s{_rrcMetricNames = a}) - . _Default - . _Coerce - --- | Custom Rich Media Events group. -rrcCustomRichMediaEvents :: Lens' ReportReachCriteria (Maybe CustomRichMediaEvents) -rrcCustomRichMediaEvents - = lens _rrcCustomRichMediaEvents - (\ s a -> s{_rrcCustomRichMediaEvents = a}) - --- | The list of filters on which dimensions are filtered. Filters for --- different dimensions are ANDed, filters for the same dimension are --- grouped together and ORed. -rrcDimensionFilters :: Lens' ReportReachCriteria [DimensionValue] -rrcDimensionFilters - = lens _rrcDimensionFilters - (\ s a -> s{_rrcDimensionFilters = a}) - . _Default - . _Coerce - --- | Activity group. -rrcActivities :: Lens' ReportReachCriteria (Maybe Activities) -rrcActivities - = lens _rrcActivities - (\ s a -> s{_rrcActivities = a}) - --- | The date range this report should be run for. -rrcDateRange :: Lens' ReportReachCriteria (Maybe DateRange) -rrcDateRange - = lens _rrcDateRange (\ s a -> s{_rrcDateRange = a}) - --- | The list of dimensions the report should include. -rrcDimensions :: Lens' ReportReachCriteria [SortedDimension] -rrcDimensions - = lens _rrcDimensions - (\ s a -> s{_rrcDimensions = a}) - . _Default - . _Coerce - -instance FromJSON ReportReachCriteria where - parseJSON - = withObject "ReportReachCriteria" - (\ o -> - ReportReachCriteria' <$> - (o .:? "reachByFrequencyMetricNames" .!= mempty) <*> - (o .:? "enableAllDimensionCombinations") - <*> (o .:? "metricNames" .!= mempty) - <*> (o .:? "customRichMediaEvents") - <*> (o .:? "dimensionFilters" .!= mempty) - <*> (o .:? "activities") - <*> (o .:? "dateRange") - <*> (o .:? "dimensions" .!= mempty)) - -instance ToJSON ReportReachCriteria where - toJSON ReportReachCriteria'{..} - = object - (catMaybes - [("reachByFrequencyMetricNames" .=) <$> - _rrcReachByFrequencyMetricNames, - ("enableAllDimensionCombinations" .=) <$> - _rrcEnableAllDimensionCombinations, - ("metricNames" .=) <$> _rrcMetricNames, - ("customRichMediaEvents" .=) <$> - _rrcCustomRichMediaEvents, - ("dimensionFilters" .=) <$> _rrcDimensionFilters, - ("activities" .=) <$> _rrcActivities, - ("dateRange" .=) <$> _rrcDateRange, - ("dimensions" .=) <$> _rrcDimensions]) - --- | Represents a Custom Rich Media Events group. --- --- /See:/ 'customRichMediaEvents' smart constructor. -data CustomRichMediaEvents = CustomRichMediaEvents' - { _crmeKind :: !Text - , _crmeFilteredEventIds :: !(Maybe [DimensionValue]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'CustomRichMediaEvents' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'crmeKind' --- --- * 'crmeFilteredEventIds' -customRichMediaEvents - :: CustomRichMediaEvents -customRichMediaEvents = - CustomRichMediaEvents' - { _crmeKind = "dfareporting#customRichMediaEvents" - , _crmeFilteredEventIds = Nothing - } - --- | The kind of resource this is, in this case --- dfareporting#customRichMediaEvents. -crmeKind :: Lens' CustomRichMediaEvents Text -crmeKind = lens _crmeKind (\ s a -> s{_crmeKind = a}) - --- | List of custom rich media event IDs. Dimension values must be all of --- type dfa:richMediaEventTypeIdAndName. -crmeFilteredEventIds :: Lens' CustomRichMediaEvents [DimensionValue] -crmeFilteredEventIds - = lens _crmeFilteredEventIds - (\ s a -> s{_crmeFilteredEventIds = a}) - . _Default - . _Coerce - -instance FromJSON CustomRichMediaEvents where - parseJSON - = withObject "CustomRichMediaEvents" - (\ o -> - CustomRichMediaEvents' <$> - (o .:? "kind" .!= - "dfareporting#customRichMediaEvents") - <*> (o .:? "filteredEventIds" .!= mempty)) - -instance ToJSON CustomRichMediaEvents where - toJSON CustomRichMediaEvents'{..} - = object - (catMaybes - [Just ("kind" .= _crmeKind), - ("filteredEventIds" .=) <$> _crmeFilteredEventIds]) - --- | Language List Response --- --- /See:/ 'languagesListResponse' smart constructor. -data LanguagesListResponse = LanguagesListResponse' - { _llrKind :: !Text - , _llrLanguages :: !(Maybe [Language]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'LanguagesListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'llrKind' --- --- * 'llrLanguages' -languagesListResponse - :: LanguagesListResponse -languagesListResponse = - LanguagesListResponse' - { _llrKind = "dfareporting#languagesListResponse" - , _llrLanguages = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#languagesListResponse\". -llrKind :: Lens' LanguagesListResponse Text -llrKind = lens _llrKind (\ s a -> s{_llrKind = a}) - --- | Language collection. -llrLanguages :: Lens' LanguagesListResponse [Language] -llrLanguages - = lens _llrLanguages (\ s a -> s{_llrLanguages = a}) - . _Default - . _Coerce - -instance FromJSON LanguagesListResponse where - parseJSON - = withObject "LanguagesListResponse" - (\ o -> - LanguagesListResponse' <$> - (o .:? "kind" .!= - "dfareporting#languagesListResponse") - <*> (o .:? "languages" .!= mempty)) - -instance ToJSON LanguagesListResponse where - toJSON LanguagesListResponse'{..} - = object - (catMaybes - [Just ("kind" .= _llrKind), - ("languages" .=) <$> _llrLanguages]) - --- | Targetable remarketing list response --- --- /See:/ 'targetableRemarketingListsListResponse' smart constructor. -data TargetableRemarketingListsListResponse = TargetableRemarketingListsListResponse' - { _trllrNextPageToken :: !(Maybe Text) - , _trllrKind :: !Text - , _trllrTargetableRemarketingLists :: !(Maybe [TargetableRemarketingList]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'TargetableRemarketingListsListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'trllrNextPageToken' --- --- * 'trllrKind' --- --- * 'trllrTargetableRemarketingLists' -targetableRemarketingListsListResponse - :: TargetableRemarketingListsListResponse -targetableRemarketingListsListResponse = - TargetableRemarketingListsListResponse' - { _trllrNextPageToken = Nothing - , _trllrKind = "dfareporting#targetableRemarketingListsListResponse" - , _trllrTargetableRemarketingLists = Nothing - } - --- | Pagination token to be used for the next list operation. -trllrNextPageToken :: Lens' TargetableRemarketingListsListResponse (Maybe Text) -trllrNextPageToken - = lens _trllrNextPageToken - (\ s a -> s{_trllrNextPageToken = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#targetableRemarketingListsListResponse\". -trllrKind :: Lens' TargetableRemarketingListsListResponse Text -trllrKind - = lens _trllrKind (\ s a -> s{_trllrKind = a}) - --- | Targetable remarketing list collection. -trllrTargetableRemarketingLists :: Lens' TargetableRemarketingListsListResponse [TargetableRemarketingList] -trllrTargetableRemarketingLists - = lens _trllrTargetableRemarketingLists - (\ s a -> s{_trllrTargetableRemarketingLists = a}) - . _Default - . _Coerce - -instance FromJSON - TargetableRemarketingListsListResponse where - parseJSON - = withObject "TargetableRemarketingListsListResponse" - (\ o -> - TargetableRemarketingListsListResponse' <$> - (o .:? "nextPageToken") <*> - (o .:? "kind" .!= - "dfareporting#targetableRemarketingListsListResponse") - <*> (o .:? "targetableRemarketingLists" .!= mempty)) - -instance ToJSON - TargetableRemarketingListsListResponse where - toJSON TargetableRemarketingListsListResponse'{..} - = object - (catMaybes - [("nextPageToken" .=) <$> _trllrNextPageToken, - Just ("kind" .= _trllrKind), - ("targetableRemarketingLists" .=) <$> - _trllrTargetableRemarketingLists]) - --- | Change Log List Response --- --- /See:/ 'changeLogsListResponse' smart constructor. -data ChangeLogsListResponse = ChangeLogsListResponse' - { _cllrNextPageToken :: !(Maybe Text) - , _cllrKind :: !Text - , _cllrChangeLogs :: !(Maybe [ChangeLog]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'ChangeLogsListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'cllrNextPageToken' --- --- * 'cllrKind' --- --- * 'cllrChangeLogs' -changeLogsListResponse - :: ChangeLogsListResponse -changeLogsListResponse = - ChangeLogsListResponse' - { _cllrNextPageToken = Nothing - , _cllrKind = "dfareporting#changeLogsListResponse" - , _cllrChangeLogs = Nothing - } - --- | Pagination token to be used for the next list operation. -cllrNextPageToken :: Lens' ChangeLogsListResponse (Maybe Text) -cllrNextPageToken - = lens _cllrNextPageToken - (\ s a -> s{_cllrNextPageToken = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#changeLogsListResponse\". -cllrKind :: Lens' ChangeLogsListResponse Text -cllrKind = lens _cllrKind (\ s a -> s{_cllrKind = a}) - --- | Change log collection. -cllrChangeLogs :: Lens' ChangeLogsListResponse [ChangeLog] -cllrChangeLogs - = lens _cllrChangeLogs - (\ s a -> s{_cllrChangeLogs = a}) - . _Default - . _Coerce - -instance FromJSON ChangeLogsListResponse where - parseJSON - = withObject "ChangeLogsListResponse" - (\ o -> - ChangeLogsListResponse' <$> - (o .:? "nextPageToken") <*> - (o .:? "kind" .!= - "dfareporting#changeLogsListResponse") - <*> (o .:? "changeLogs" .!= mempty)) - -instance ToJSON ChangeLogsListResponse where - toJSON ChangeLogsListResponse'{..} - = object - (catMaybes - [("nextPageToken" .=) <$> _cllrNextPageToken, - Just ("kind" .= _cllrKind), - ("changeLogs" .=) <$> _cllrChangeLogs]) - --- | AccountUserProfiles contains properties of a Campaign Manager user --- profile. This resource is specifically for managing user profiles, --- whereas UserProfiles is for accessing the API. --- --- /See:/ 'accountUserProFile' smart constructor. -data AccountUserProFile = AccountUserProFile' - { _aupfEmail :: !(Maybe Text) - , _aupfUserRoleFilter :: !(Maybe ObjectFilter) - , _aupfAdvertiserFilter :: !(Maybe ObjectFilter) - , _aupfUserRoleId :: !(Maybe (Textual Int64)) - , _aupfKind :: !Text - , _aupfLocale :: !(Maybe Text) - , _aupfSiteFilter :: !(Maybe ObjectFilter) - , _aupfTraffickerType :: !(Maybe AccountUserProFileTraffickerType) - , _aupfActive :: !(Maybe Bool) - , _aupfAccountId :: !(Maybe (Textual Int64)) - , _aupfName :: !(Maybe Text) - , _aupfId :: !(Maybe (Textual Int64)) - , _aupfUserAccessType :: !(Maybe AccountUserProFileUserAccessType) - , _aupfComments :: !(Maybe Text) - , _aupfSubAccountId :: !(Maybe (Textual Int64)) - , _aupfCampaignFilter :: !(Maybe ObjectFilter) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'AccountUserProFile' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'aupfEmail' --- --- * 'aupfUserRoleFilter' --- --- * 'aupfAdvertiserFilter' --- --- * 'aupfUserRoleId' --- --- * 'aupfKind' --- --- * 'aupfLocale' --- --- * 'aupfSiteFilter' --- --- * 'aupfTraffickerType' --- --- * 'aupfActive' --- --- * 'aupfAccountId' --- --- * 'aupfName' --- --- * 'aupfId' --- --- * 'aupfUserAccessType' --- --- * 'aupfComments' --- --- * 'aupfSubAccountId' --- --- * 'aupfCampaignFilter' -accountUserProFile - :: AccountUserProFile -accountUserProFile = - AccountUserProFile' - { _aupfEmail = Nothing - , _aupfUserRoleFilter = Nothing - , _aupfAdvertiserFilter = Nothing - , _aupfUserRoleId = Nothing - , _aupfKind = "dfareporting#accountUserProfile" - , _aupfLocale = Nothing - , _aupfSiteFilter = Nothing - , _aupfTraffickerType = Nothing - , _aupfActive = Nothing - , _aupfAccountId = Nothing - , _aupfName = Nothing - , _aupfId = Nothing - , _aupfUserAccessType = Nothing - , _aupfComments = Nothing - , _aupfSubAccountId = Nothing - , _aupfCampaignFilter = Nothing - } - --- | Email of the user profile. The email addresss must be linked to a Google --- Account. This field is required on insertion and is read-only after --- insertion. -aupfEmail :: Lens' AccountUserProFile (Maybe Text) -aupfEmail - = lens _aupfEmail (\ s a -> s{_aupfEmail = a}) - --- | Filter that describes which user roles are visible to the user profile. -aupfUserRoleFilter :: Lens' AccountUserProFile (Maybe ObjectFilter) -aupfUserRoleFilter - = lens _aupfUserRoleFilter - (\ s a -> s{_aupfUserRoleFilter = a}) - --- | Filter that describes which advertisers are visible to the user profile. -aupfAdvertiserFilter :: Lens' AccountUserProFile (Maybe ObjectFilter) -aupfAdvertiserFilter - = lens _aupfAdvertiserFilter - (\ s a -> s{_aupfAdvertiserFilter = a}) - --- | User role ID of the user profile. This is a required field. -aupfUserRoleId :: Lens' AccountUserProFile (Maybe Int64) -aupfUserRoleId - = lens _aupfUserRoleId - (\ s a -> s{_aupfUserRoleId = a}) - . mapping _Coerce - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#accountUserProfile\". -aupfKind :: Lens' AccountUserProFile Text -aupfKind = lens _aupfKind (\ s a -> s{_aupfKind = a}) - --- | Locale of the user profile. This is a required field. Acceptable values --- are: - \"cs\" (Czech) - \"de\" (German) - \"en\" (English) - \"en-GB\" --- (English United Kingdom) - \"es\" (Spanish) - \"fr\" (French) - \"it\" --- (Italian) - \"ja\" (Japanese) - \"ko\" (Korean) - \"pl\" (Polish) - --- \"pt-BR\" (Portuguese Brazil) - \"ru\" (Russian) - \"sv\" (Swedish) - --- \"tr\" (Turkish) - \"zh-CN\" (Chinese Simplified) - \"zh-TW\" (Chinese --- Traditional) -aupfLocale :: Lens' AccountUserProFile (Maybe Text) -aupfLocale - = lens _aupfLocale (\ s a -> s{_aupfLocale = a}) - --- | Filter that describes which sites are visible to the user profile. -aupfSiteFilter :: Lens' AccountUserProFile (Maybe ObjectFilter) -aupfSiteFilter - = lens _aupfSiteFilter - (\ s a -> s{_aupfSiteFilter = a}) - --- | Trafficker type of this user profile. This is a read-only field. -aupfTraffickerType :: Lens' AccountUserProFile (Maybe AccountUserProFileTraffickerType) -aupfTraffickerType - = lens _aupfTraffickerType - (\ s a -> s{_aupfTraffickerType = a}) - --- | Whether this user profile is active. This defaults to false, and must be --- set true on insert for the user profile to be usable. -aupfActive :: Lens' AccountUserProFile (Maybe Bool) -aupfActive - = lens _aupfActive (\ s a -> s{_aupfActive = a}) - --- | Account ID of the user profile. This is a read-only field that can be --- left blank. -aupfAccountId :: Lens' AccountUserProFile (Maybe Int64) -aupfAccountId - = lens _aupfAccountId - (\ s a -> s{_aupfAccountId = a}) - . mapping _Coerce - --- | Name of the user profile. This is a required field. Must be less than 64 --- characters long, must be globally unique, and cannot contain whitespace --- or any of the following characters: \"&;\"#%,\". -aupfName :: Lens' AccountUserProFile (Maybe Text) -aupfName = lens _aupfName (\ s a -> s{_aupfName = a}) - --- | ID of the user profile. This is a read-only, auto-generated field. -aupfId :: Lens' AccountUserProFile (Maybe Int64) -aupfId - = lens _aupfId (\ s a -> s{_aupfId = a}) . - mapping _Coerce - --- | User type of the user profile. This is a read-only field that can be --- left blank. -aupfUserAccessType :: Lens' AccountUserProFile (Maybe AccountUserProFileUserAccessType) -aupfUserAccessType - = lens _aupfUserAccessType - (\ s a -> s{_aupfUserAccessType = a}) - --- | Comments for this user profile. -aupfComments :: Lens' AccountUserProFile (Maybe Text) -aupfComments - = lens _aupfComments (\ s a -> s{_aupfComments = a}) - --- | Subaccount ID of the user profile. This is a read-only field that can be --- left blank. -aupfSubAccountId :: Lens' AccountUserProFile (Maybe Int64) -aupfSubAccountId - = lens _aupfSubAccountId - (\ s a -> s{_aupfSubAccountId = a}) - . mapping _Coerce - --- | Filter that describes which campaigns are visible to the user profile. -aupfCampaignFilter :: Lens' AccountUserProFile (Maybe ObjectFilter) -aupfCampaignFilter - = lens _aupfCampaignFilter - (\ s a -> s{_aupfCampaignFilter = a}) - -instance FromJSON AccountUserProFile where - parseJSON - = withObject "AccountUserProFile" - (\ o -> - AccountUserProFile' <$> - (o .:? "email") <*> (o .:? "userRoleFilter") <*> - (o .:? "advertiserFilter") - <*> (o .:? "userRoleId") - <*> - (o .:? "kind" .!= "dfareporting#accountUserProfile") - <*> (o .:? "locale") - <*> (o .:? "siteFilter") - <*> (o .:? "traffickerType") - <*> (o .:? "active") - <*> (o .:? "accountId") - <*> (o .:? "name") - <*> (o .:? "id") - <*> (o .:? "userAccessType") - <*> (o .:? "comments") - <*> (o .:? "subaccountId") - <*> (o .:? "campaignFilter")) - -instance ToJSON AccountUserProFile where - toJSON AccountUserProFile'{..} - = object - (catMaybes - [("email" .=) <$> _aupfEmail, - ("userRoleFilter" .=) <$> _aupfUserRoleFilter, - ("advertiserFilter" .=) <$> _aupfAdvertiserFilter, - ("userRoleId" .=) <$> _aupfUserRoleId, - Just ("kind" .= _aupfKind), - ("locale" .=) <$> _aupfLocale, - ("siteFilter" .=) <$> _aupfSiteFilter, - ("traffickerType" .=) <$> _aupfTraffickerType, - ("active" .=) <$> _aupfActive, - ("accountId" .=) <$> _aupfAccountId, - ("name" .=) <$> _aupfName, ("id" .=) <$> _aupfId, - ("userAccessType" .=) <$> _aupfUserAccessType, - ("comments" .=) <$> _aupfComments, - ("subaccountId" .=) <$> _aupfSubAccountId, - ("campaignFilter" .=) <$> _aupfCampaignFilter]) - --- | Represents a DimensionValue resource. --- --- /See:/ 'dimensionValue' smart constructor. -data DimensionValue = DimensionValue' - { _dvEtag :: !(Maybe Text) - , _dvKind :: !Text - , _dvValue :: !(Maybe Text) - , _dvMatchType :: !(Maybe DimensionValueMatchType) - , _dvDimensionName :: !(Maybe Text) - , _dvId :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'DimensionValue' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'dvEtag' --- --- * 'dvKind' --- --- * 'dvValue' --- --- * 'dvMatchType' --- --- * 'dvDimensionName' --- --- * 'dvId' -dimensionValue - :: DimensionValue -dimensionValue = - DimensionValue' - { _dvEtag = Nothing - , _dvKind = "dfareporting#dimensionValue" - , _dvValue = Nothing - , _dvMatchType = Nothing - , _dvDimensionName = Nothing - , _dvId = Nothing - } - --- | The eTag of this response for caching purposes. -dvEtag :: Lens' DimensionValue (Maybe Text) -dvEtag = lens _dvEtag (\ s a -> s{_dvEtag = a}) - --- | The kind of resource this is, in this case dfareporting#dimensionValue. -dvKind :: Lens' DimensionValue Text -dvKind = lens _dvKind (\ s a -> s{_dvKind = a}) - --- | The value of the dimension. -dvValue :: Lens' DimensionValue (Maybe Text) -dvValue = lens _dvValue (\ s a -> s{_dvValue = a}) - --- | Determines how the \'value\' field is matched when filtering. If not --- specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, \'*\' is --- allowed as a placeholder for variable length character sequences, and it --- can be escaped with a backslash. Note, only paid search dimensions --- (\'dfa:paidSearch*\') allow a matchType other than EXACT. -dvMatchType :: Lens' DimensionValue (Maybe DimensionValueMatchType) -dvMatchType - = lens _dvMatchType (\ s a -> s{_dvMatchType = a}) - --- | The name of the dimension. -dvDimensionName :: Lens' DimensionValue (Maybe Text) -dvDimensionName - = lens _dvDimensionName - (\ s a -> s{_dvDimensionName = a}) - --- | The ID associated with the value if available. -dvId :: Lens' DimensionValue (Maybe Text) -dvId = lens _dvId (\ s a -> s{_dvId = a}) - -instance FromJSON DimensionValue where - parseJSON - = withObject "DimensionValue" - (\ o -> - DimensionValue' <$> - (o .:? "etag") <*> - (o .:? "kind" .!= "dfareporting#dimensionValue") - <*> (o .:? "value") - <*> (o .:? "matchType") - <*> (o .:? "dimensionName") - <*> (o .:? "id")) - -instance ToJSON DimensionValue where - toJSON DimensionValue'{..} - = object - (catMaybes - [("etag" .=) <$> _dvEtag, Just ("kind" .= _dvKind), - ("value" .=) <$> _dvValue, - ("matchType" .=) <$> _dvMatchType, - ("dimensionName" .=) <$> _dvDimensionName, - ("id" .=) <$> _dvId]) - --- | Represents an activity group. --- --- /See:/ 'activities' smart constructor. -data Activities = Activities' - { _actKind :: !Text - , _actMetricNames :: !(Maybe [Text]) - , _actFilters :: !(Maybe [DimensionValue]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'Activities' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'actKind' --- --- * 'actMetricNames' --- --- * 'actFilters' -activities - :: Activities -activities = - Activities' - { _actKind = "dfareporting#activities" - , _actMetricNames = Nothing - , _actFilters = Nothing - } - --- | The kind of resource this is, in this case dfareporting#activities. -actKind :: Lens' Activities Text -actKind = lens _actKind (\ s a -> s{_actKind = a}) - --- | List of names of floodlight activity metrics. -actMetricNames :: Lens' Activities [Text] -actMetricNames - = lens _actMetricNames - (\ s a -> s{_actMetricNames = a}) - . _Default - . _Coerce - --- | List of activity filters. The dimension values need to be all either of --- type \"dfa:activity\" or \"dfa:activityGroup\". -actFilters :: Lens' Activities [DimensionValue] -actFilters - = lens _actFilters (\ s a -> s{_actFilters = a}) . - _Default - . _Coerce - -instance FromJSON Activities where - parseJSON - = withObject "Activities" - (\ o -> - Activities' <$> - (o .:? "kind" .!= "dfareporting#activities") <*> - (o .:? "metricNames" .!= mempty) - <*> (o .:? "filters" .!= mempty)) - -instance ToJSON Activities where - toJSON Activities'{..} - = object - (catMaybes - [Just ("kind" .= _actKind), - ("metricNames" .=) <$> _actMetricNames, - ("filters" .=) <$> _actFilters]) - --- | User Role Permission Group List Response --- --- /See:/ 'userRolePermissionGroupsListResponse' smart constructor. -data UserRolePermissionGroupsListResponse = UserRolePermissionGroupsListResponse' - { _urpglrUserRolePermissionGroups :: !(Maybe [UserRolePermissionGroup]) - , _urpglrKind :: !Text - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'UserRolePermissionGroupsListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'urpglrUserRolePermissionGroups' --- --- * 'urpglrKind' -userRolePermissionGroupsListResponse - :: UserRolePermissionGroupsListResponse -userRolePermissionGroupsListResponse = - UserRolePermissionGroupsListResponse' - { _urpglrUserRolePermissionGroups = Nothing - , _urpglrKind = "dfareporting#userRolePermissionGroupsListResponse" - } - --- | User role permission group collection. -urpglrUserRolePermissionGroups :: Lens' UserRolePermissionGroupsListResponse [UserRolePermissionGroup] -urpglrUserRolePermissionGroups - = lens _urpglrUserRolePermissionGroups - (\ s a -> s{_urpglrUserRolePermissionGroups = a}) - . _Default - . _Coerce - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#userRolePermissionGroupsListResponse\". -urpglrKind :: Lens' UserRolePermissionGroupsListResponse Text -urpglrKind - = lens _urpglrKind (\ s a -> s{_urpglrKind = a}) - -instance FromJSON - UserRolePermissionGroupsListResponse where - parseJSON - = withObject "UserRolePermissionGroupsListResponse" - (\ o -> - UserRolePermissionGroupsListResponse' <$> - (o .:? "userRolePermissionGroups" .!= mempty) <*> - (o .:? "kind" .!= - "dfareporting#userRolePermissionGroupsListResponse")) - -instance ToJSON UserRolePermissionGroupsListResponse - where - toJSON UserRolePermissionGroupsListResponse'{..} - = object - (catMaybes - [("userRolePermissionGroups" .=) <$> - _urpglrUserRolePermissionGroups, - Just ("kind" .= _urpglrKind)]) - --- | Placement Tag --- --- /See:/ 'placementTag' smart constructor. -data PlacementTag = PlacementTag' - { _ptPlacementId :: !(Maybe (Textual Int64)) - , _ptTagDatas :: !(Maybe [TagData]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'PlacementTag' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'ptPlacementId' --- --- * 'ptTagDatas' -placementTag - :: PlacementTag -placementTag = - PlacementTag' - { _ptPlacementId = Nothing - , _ptTagDatas = Nothing - } - --- | Placement ID -ptPlacementId :: Lens' PlacementTag (Maybe Int64) -ptPlacementId - = lens _ptPlacementId - (\ s a -> s{_ptPlacementId = a}) - . mapping _Coerce - --- | Tags generated for this placement. -ptTagDatas :: Lens' PlacementTag [TagData] -ptTagDatas - = lens _ptTagDatas (\ s a -> s{_ptTagDatas = a}) . - _Default - . _Coerce - -instance FromJSON PlacementTag where - parseJSON - = withObject "PlacementTag" - (\ o -> - PlacementTag' <$> - (o .:? "placementId") <*> - (o .:? "tagDatas" .!= mempty)) - -instance ToJSON PlacementTag where - toJSON PlacementTag'{..} - = object - (catMaybes - [("placementId" .=) <$> _ptPlacementId, - ("tagDatas" .=) <$> _ptTagDatas]) - --- | Remarketing list response --- --- /See:/ 'remarketingListsListResponse' smart constructor. -data RemarketingListsListResponse = RemarketingListsListResponse' - { _rllrNextPageToken :: !(Maybe Text) - , _rllrRemarketingLists :: !(Maybe [RemarketingList]) - , _rllrKind :: !Text - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'RemarketingListsListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'rllrNextPageToken' --- --- * 'rllrRemarketingLists' --- --- * 'rllrKind' -remarketingListsListResponse - :: RemarketingListsListResponse -remarketingListsListResponse = - RemarketingListsListResponse' - { _rllrNextPageToken = Nothing - , _rllrRemarketingLists = Nothing - , _rllrKind = "dfareporting#remarketingListsListResponse" - } - --- | Pagination token to be used for the next list operation. -rllrNextPageToken :: Lens' RemarketingListsListResponse (Maybe Text) -rllrNextPageToken - = lens _rllrNextPageToken - (\ s a -> s{_rllrNextPageToken = a}) - --- | Remarketing list collection. -rllrRemarketingLists :: Lens' RemarketingListsListResponse [RemarketingList] -rllrRemarketingLists - = lens _rllrRemarketingLists - (\ s a -> s{_rllrRemarketingLists = a}) - . _Default - . _Coerce - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#remarketingListsListResponse\". -rllrKind :: Lens' RemarketingListsListResponse Text -rllrKind = lens _rllrKind (\ s a -> s{_rllrKind = a}) - -instance FromJSON RemarketingListsListResponse where - parseJSON - = withObject "RemarketingListsListResponse" - (\ o -> - RemarketingListsListResponse' <$> - (o .:? "nextPageToken") <*> - (o .:? "remarketingLists" .!= mempty) - <*> - (o .:? "kind" .!= - "dfareporting#remarketingListsListResponse")) - -instance ToJSON RemarketingListsListResponse where - toJSON RemarketingListsListResponse'{..} - = object - (catMaybes - [("nextPageToken" .=) <$> _rllrNextPageToken, - ("remarketingLists" .=) <$> _rllrRemarketingLists, - Just ("kind" .= _rllrKind)]) - --- | Contains properties of a dynamic targeting key. Dynamic targeting keys --- are unique, user-friendly labels, created at the advertiser level in --- DCM, that can be assigned to ads, creatives, and placements and used for --- targeting with Studio dynamic creatives. Use these labels instead of --- numeric Campaign Manager IDs (such as placement IDs) to save time and --- avoid errors in your dynamic feeds. --- --- /See:/ 'dynamicTargetingKey' smart constructor. -data DynamicTargetingKey = DynamicTargetingKey' - { _dtkObjectType :: !(Maybe DynamicTargetingKeyObjectType) - , _dtkKind :: !Text - , _dtkObjectId :: !(Maybe (Textual Int64)) - , _dtkName :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'DynamicTargetingKey' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'dtkObjectType' --- --- * 'dtkKind' --- --- * 'dtkObjectId' --- --- * 'dtkName' -dynamicTargetingKey - :: DynamicTargetingKey -dynamicTargetingKey = - DynamicTargetingKey' - { _dtkObjectType = Nothing - , _dtkKind = "dfareporting#dynamicTargetingKey" - , _dtkObjectId = Nothing - , _dtkName = Nothing - } - --- | Type of the object of this dynamic targeting key. This is a required --- field. -dtkObjectType :: Lens' DynamicTargetingKey (Maybe DynamicTargetingKeyObjectType) -dtkObjectType - = lens _dtkObjectType - (\ s a -> s{_dtkObjectType = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#dynamicTargetingKey\". -dtkKind :: Lens' DynamicTargetingKey Text -dtkKind = lens _dtkKind (\ s a -> s{_dtkKind = a}) - --- | ID of the object of this dynamic targeting key. This is a required --- field. -dtkObjectId :: Lens' DynamicTargetingKey (Maybe Int64) -dtkObjectId - = lens _dtkObjectId (\ s a -> s{_dtkObjectId = a}) . - mapping _Coerce - --- | Name of this dynamic targeting key. This is a required field. Must be --- less than 256 characters long and cannot contain commas. All characters --- are converted to lowercase. -dtkName :: Lens' DynamicTargetingKey (Maybe Text) -dtkName = lens _dtkName (\ s a -> s{_dtkName = a}) - -instance FromJSON DynamicTargetingKey where - parseJSON - = withObject "DynamicTargetingKey" - (\ o -> - DynamicTargetingKey' <$> - (o .:? "objectType") <*> - (o .:? "kind" .!= "dfareporting#dynamicTargetingKey") - <*> (o .:? "objectId") - <*> (o .:? "name")) - -instance ToJSON DynamicTargetingKey where - toJSON DynamicTargetingKey'{..} - = object - (catMaybes - [("objectType" .=) <$> _dtkObjectType, - Just ("kind" .= _dtkKind), - ("objectId" .=) <$> _dtkObjectId, - ("name" .=) <$> _dtkName]) - --- | Contains properties of a Creative. --- --- /See:/ 'creative' smart constructor. -data Creative = Creative' - { _creConvertFlashToHTML5 :: !(Maybe Bool) - , _creBackupImageTargetWindow :: !(Maybe TargetWindow) - , _creRenderingIdDimensionValue :: !(Maybe DimensionValue) - , _creCustomKeyValues :: !(Maybe [Text]) - , _creSkipOffSet :: !(Maybe VideoOffSet) - , _creRenderingId :: !(Maybe (Textual Int64)) - , _creThirdPartyBackupImageImpressionsURL :: !(Maybe Text) - , _creFsCommand :: !(Maybe FsCommand) - , _creAllowScriptAccess :: !(Maybe Bool) - , _creHTMLCodeLocked :: !(Maybe Bool) - , _creRequiredFlashPluginVersion :: !(Maybe Text) - , _creUniversalAdId :: !(Maybe UniversalAdId) - , _creAuthoringTool :: !(Maybe CreativeAuthoringTool) - , _creSize :: !(Maybe Size) - , _creThirdPartyURLs :: !(Maybe [ThirdPartyTrackingURL]) - , _creProgressOffSet :: !(Maybe VideoOffSet) - , _creCounterCustomEvents :: !(Maybe [CreativeCustomEvent]) - , _creKind :: !Text - , _creSSLOverride :: !(Maybe Bool) - , _creHTMLCode :: !(Maybe Text) - , _creAdvertiserId :: !(Maybe (Textual Int64)) - , _creRequiredFlashVersion :: !(Maybe (Textual Int32)) - , _creBackgRoundColor :: !(Maybe Text) - , _creAdTagKeys :: !(Maybe [Text]) - , _creSkippable :: !(Maybe Bool) - , _creSSLCompliant :: !(Maybe Bool) - , _creIdDimensionValue :: !(Maybe DimensionValue) - , _creBackupImageReportingLabel :: !(Maybe Text) - , _creCommercialId :: !(Maybe Text) - , _creActive :: !(Maybe Bool) - , _creExitCustomEvents :: !(Maybe [CreativeCustomEvent]) - , _creAccountId :: !(Maybe (Textual Int64)) - , _creBackupImageClickThroughURL :: !(Maybe CreativeClickThroughURL) - , _creName :: !(Maybe Text) - , _creOverrideCss :: !(Maybe Text) - , _creAdditionalSizes :: !(Maybe [Size]) - , _creClickTags :: !(Maybe [ClickTag]) - , _creAdParameters :: !(Maybe Text) - , _creVersion :: !(Maybe (Textual Int32)) - , _creMediaDescription :: !(Maybe Text) - , _creMediaDuration :: !(Maybe (Textual Double)) - , _creLatestTraffickedCreativeId :: !(Maybe (Textual Int64)) - , _creThirdPartyRichMediaImpressionsURL :: !(Maybe Text) - , _creDynamicAssetSelection :: !(Maybe Bool) - , _creLastModifiedInfo :: !(Maybe LastModifiedInfo) - , _creId :: !(Maybe (Textual Int64)) - , _creAuthoringSource :: !(Maybe CreativeAuthoringSource) - , _crePoliteLoadAssetId :: !(Maybe (Textual Int64)) - , _creStudioAdvertiserId :: !(Maybe (Textual Int64)) - , _creCreativeAssets :: !(Maybe [CreativeAsset]) - , _creSubAccountId :: !(Maybe (Textual Int64)) - , _creType :: !(Maybe CreativeType) - , _creTimerCustomEvents :: !(Maybe [CreativeCustomEvent]) - , _creCreativeAssetSelection :: !(Maybe CreativeAssetSelection) - , _creStudioCreativeId :: !(Maybe (Textual Int64)) - , _creCompatibility :: !(Maybe [CreativeCompatibilityItem]) - , _creBackupImageFeatures :: !(Maybe [CreativeBackupImageFeaturesItem]) - , _creArtworkType :: !(Maybe CreativeArtworkType) - , _creArchived :: !(Maybe Bool) - , _creCompanionCreatives :: !(Maybe [Textual Int64]) - , _creTotalFileSize :: !(Maybe (Textual Int64)) - , _creStudioTraffickedCreativeId :: !(Maybe (Textual Int64)) - , _creAutoAdvanceImages :: !(Maybe Bool) - , _creRedirectURL :: !(Maybe Text) - , _creCreativeFieldAssignments :: !(Maybe [CreativeFieldAssignment]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'Creative' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'creConvertFlashToHTML5' --- --- * 'creBackupImageTargetWindow' --- --- * 'creRenderingIdDimensionValue' --- --- * 'creCustomKeyValues' --- --- * 'creSkipOffSet' --- --- * 'creRenderingId' --- --- * 'creThirdPartyBackupImageImpressionsURL' --- --- * 'creFsCommand' --- --- * 'creAllowScriptAccess' --- --- * 'creHTMLCodeLocked' --- --- * 'creRequiredFlashPluginVersion' --- --- * 'creUniversalAdId' --- --- * 'creAuthoringTool' --- --- * 'creSize' --- --- * 'creThirdPartyURLs' --- --- * 'creProgressOffSet' --- --- * 'creCounterCustomEvents' --- --- * 'creKind' --- --- * 'creSSLOverride' --- --- * 'creHTMLCode' --- --- * 'creAdvertiserId' --- --- * 'creRequiredFlashVersion' --- --- * 'creBackgRoundColor' --- --- * 'creAdTagKeys' --- --- * 'creSkippable' --- --- * 'creSSLCompliant' --- --- * 'creIdDimensionValue' --- --- * 'creBackupImageReportingLabel' --- --- * 'creCommercialId' --- --- * 'creActive' --- --- * 'creExitCustomEvents' --- --- * 'creAccountId' --- --- * 'creBackupImageClickThroughURL' --- --- * 'creName' --- --- * 'creOverrideCss' --- --- * 'creAdditionalSizes' --- --- * 'creClickTags' --- --- * 'creAdParameters' --- --- * 'creVersion' --- --- * 'creMediaDescription' --- --- * 'creMediaDuration' --- --- * 'creLatestTraffickedCreativeId' --- --- * 'creThirdPartyRichMediaImpressionsURL' --- --- * 'creDynamicAssetSelection' --- --- * 'creLastModifiedInfo' --- --- * 'creId' --- --- * 'creAuthoringSource' --- --- * 'crePoliteLoadAssetId' --- --- * 'creStudioAdvertiserId' --- --- * 'creCreativeAssets' --- --- * 'creSubAccountId' --- --- * 'creType' --- --- * 'creTimerCustomEvents' --- --- * 'creCreativeAssetSelection' --- --- * 'creStudioCreativeId' --- --- * 'creCompatibility' --- --- * 'creBackupImageFeatures' --- --- * 'creArtworkType' --- --- * 'creArchived' --- --- * 'creCompanionCreatives' --- --- * 'creTotalFileSize' --- --- * 'creStudioTraffickedCreativeId' --- --- * 'creAutoAdvanceImages' --- --- * 'creRedirectURL' --- --- * 'creCreativeFieldAssignments' -creative - :: Creative -creative = - Creative' - { _creConvertFlashToHTML5 = Nothing - , _creBackupImageTargetWindow = Nothing - , _creRenderingIdDimensionValue = Nothing - , _creCustomKeyValues = Nothing - , _creSkipOffSet = Nothing - , _creRenderingId = Nothing - , _creThirdPartyBackupImageImpressionsURL = Nothing - , _creFsCommand = Nothing - , _creAllowScriptAccess = Nothing - , _creHTMLCodeLocked = Nothing - , _creRequiredFlashPluginVersion = Nothing - , _creUniversalAdId = Nothing - , _creAuthoringTool = Nothing - , _creSize = Nothing - , _creThirdPartyURLs = Nothing - , _creProgressOffSet = Nothing - , _creCounterCustomEvents = Nothing - , _creKind = "dfareporting#creative" - , _creSSLOverride = Nothing - , _creHTMLCode = Nothing - , _creAdvertiserId = Nothing - , _creRequiredFlashVersion = Nothing - , _creBackgRoundColor = Nothing - , _creAdTagKeys = Nothing - , _creSkippable = Nothing - , _creSSLCompliant = Nothing - , _creIdDimensionValue = Nothing - , _creBackupImageReportingLabel = Nothing - , _creCommercialId = Nothing - , _creActive = Nothing - , _creExitCustomEvents = Nothing - , _creAccountId = Nothing - , _creBackupImageClickThroughURL = Nothing - , _creName = Nothing - , _creOverrideCss = Nothing - , _creAdditionalSizes = Nothing - , _creClickTags = Nothing - , _creAdParameters = Nothing - , _creVersion = Nothing - , _creMediaDescription = Nothing - , _creMediaDuration = Nothing - , _creLatestTraffickedCreativeId = Nothing - , _creThirdPartyRichMediaImpressionsURL = Nothing - , _creDynamicAssetSelection = Nothing - , _creLastModifiedInfo = Nothing - , _creId = Nothing - , _creAuthoringSource = Nothing - , _crePoliteLoadAssetId = Nothing - , _creStudioAdvertiserId = Nothing - , _creCreativeAssets = Nothing - , _creSubAccountId = Nothing - , _creType = Nothing - , _creTimerCustomEvents = Nothing - , _creCreativeAssetSelection = Nothing - , _creStudioCreativeId = Nothing - , _creCompatibility = Nothing - , _creBackupImageFeatures = Nothing - , _creArtworkType = Nothing - , _creArchived = Nothing - , _creCompanionCreatives = Nothing - , _creTotalFileSize = Nothing - , _creStudioTraffickedCreativeId = Nothing - , _creAutoAdvanceImages = Nothing - , _creRedirectURL = Nothing - , _creCreativeFieldAssignments = Nothing - } - --- | Whether Flash assets associated with the creative need to be --- automatically converted to HTML5. This flag is enabled by default and --- users can choose to disable it if they don\'t want the system to --- generate and use HTML5 asset for this creative. Applicable to the --- following creative type: FLASH_INPAGE. Applicable to DISPLAY when the --- primary asset type is not HTML_IMAGE. -creConvertFlashToHTML5 :: Lens' Creative (Maybe Bool) -creConvertFlashToHTML5 - = lens _creConvertFlashToHTML5 - (\ s a -> s{_creConvertFlashToHTML5 = a}) - --- | Target window for backup image. Applicable to the following creative --- types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the --- primary asset type is not HTML_IMAGE. -creBackupImageTargetWindow :: Lens' Creative (Maybe TargetWindow) -creBackupImageTargetWindow - = lens _creBackupImageTargetWindow - (\ s a -> s{_creBackupImageTargetWindow = a}) - --- | Dimension value for the rendering ID of this creative. This is a --- read-only field. Applicable to all creative types. -creRenderingIdDimensionValue :: Lens' Creative (Maybe DimensionValue) -creRenderingIdDimensionValue - = lens _creRenderingIdDimensionValue - (\ s a -> s{_creRenderingIdDimensionValue = a}) - --- | Custom key-values for a Rich Media creative. Key-values let you --- customize the creative settings of a Rich Media ad running on your site --- without having to contact the advertiser. You can use key-values to --- dynamically change the look or functionality of a creative. Applicable --- to the following creative types: all RICH_MEDIA, and all VPAID. -creCustomKeyValues :: Lens' Creative [Text] -creCustomKeyValues - = lens _creCustomKeyValues - (\ s a -> s{_creCustomKeyValues = a}) - . _Default - . _Coerce - --- | Amount of time to play the video before the skip button appears. --- Applicable to the following creative types: all INSTREAM_VIDEO. -creSkipOffSet :: Lens' Creative (Maybe VideoOffSet) -creSkipOffSet - = lens _creSkipOffSet - (\ s a -> s{_creSkipOffSet = a}) - --- | ID of current rendering version. This is a read-only field. Applicable --- to all creative types. -creRenderingId :: Lens' Creative (Maybe Int64) -creRenderingId - = lens _creRenderingId - (\ s a -> s{_creRenderingId = a}) - . mapping _Coerce - --- | Third-party URL used to record backup image impressions. Applicable to --- the following creative types: all RICH_MEDIA. -creThirdPartyBackupImageImpressionsURL :: Lens' Creative (Maybe Text) -creThirdPartyBackupImageImpressionsURL - = lens _creThirdPartyBackupImageImpressionsURL - (\ s a -> - s{_creThirdPartyBackupImageImpressionsURL = a}) - --- | OpenWindow FSCommand of this creative. This lets the SWF file --- communicate with either Flash Player or the program hosting Flash --- Player, such as a web browser. This is only triggered if --- allowScriptAccess field is true. Applicable to the following creative --- types: FLASH_INPAGE. -creFsCommand :: Lens' Creative (Maybe FsCommand) -creFsCommand - = lens _creFsCommand (\ s a -> s{_creFsCommand = a}) - --- | Whether script access is allowed for this creative. This is a read-only --- and deprecated field which will automatically be set to true on update. --- Applicable to the following creative types: FLASH_INPAGE. -creAllowScriptAccess :: Lens' Creative (Maybe Bool) -creAllowScriptAccess - = lens _creAllowScriptAccess - (\ s a -> s{_creAllowScriptAccess = a}) - --- | Whether HTML code is generated by Campaign Manager or manually entered. --- Set to true to ignore changes to htmlCode. Applicable to the following --- creative types: FLASH_INPAGE and HTML5_BANNER. -creHTMLCodeLocked :: Lens' Creative (Maybe Bool) -creHTMLCodeLocked - = lens _creHTMLCodeLocked - (\ s a -> s{_creHTMLCodeLocked = a}) - --- | The minimum required Flash plugin version for this creative. For --- example, 11.2.202.235. This is a read-only field. Applicable to the --- following creative types: all RICH_MEDIA, and all VPAID. -creRequiredFlashPluginVersion :: Lens' Creative (Maybe Text) -creRequiredFlashPluginVersion - = lens _creRequiredFlashPluginVersion - (\ s a -> s{_creRequiredFlashPluginVersion = a}) - --- | A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following --- creative types: INSTREAM_AUDIO and INSTREAM_VIDEO and VPAID. -creUniversalAdId :: Lens' Creative (Maybe UniversalAdId) -creUniversalAdId - = lens _creUniversalAdId - (\ s a -> s{_creUniversalAdId = a}) - --- | Authoring tool for HTML5 banner creatives. This is a read-only field. --- Applicable to the following creative types: HTML5_BANNER. -creAuthoringTool :: Lens' Creative (Maybe CreativeAuthoringTool) -creAuthoringTool - = lens _creAuthoringTool - (\ s a -> s{_creAuthoringTool = a}) - --- | Size associated with this creative. When inserting or updating a --- creative either the size ID field or size width and height fields can be --- used. This is a required field when applicable; however for IMAGE, --- FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset --- of type HTML_IMAGE, if left blank, this field will be automatically set --- using the actual size of the associated image assets. Applicable to the --- following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, --- HTML5_BANNER, IMAGE, and all RICH_MEDIA. -creSize :: Lens' Creative (Maybe Size) -creSize = lens _creSize (\ s a -> s{_creSize = a}) - --- | Third-party URLs for tracking in-stream creative events. Applicable to --- the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, --- and all VPAID. -creThirdPartyURLs :: Lens' Creative [ThirdPartyTrackingURL] -creThirdPartyURLs - = lens _creThirdPartyURLs - (\ s a -> s{_creThirdPartyURLs = a}) - . _Default - . _Coerce - --- | Amount of time to play the video before counting a view. Applicable to --- the following creative types: all INSTREAM_VIDEO. -creProgressOffSet :: Lens' Creative (Maybe VideoOffSet) -creProgressOffSet - = lens _creProgressOffSet - (\ s a -> s{_creProgressOffSet = a}) - --- | List of counter events configured for the creative. For --- DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated --- from clickTags. Applicable to the following creative types: --- DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. -creCounterCustomEvents :: Lens' Creative [CreativeCustomEvent] -creCounterCustomEvents - = lens _creCounterCustomEvents - (\ s a -> s{_creCounterCustomEvents = a}) - . _Default - . _Coerce - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#creative\". -creKind :: Lens' Creative Text -creKind = lens _creKind (\ s a -> s{_creKind = a}) - --- | Whether creative should be treated as SSL compliant even if the system --- scan shows it\'s not. Applicable to all creative types. -creSSLOverride :: Lens' Creative (Maybe Bool) -creSSLOverride - = lens _creSSLOverride - (\ s a -> s{_creSSLOverride = a}) - --- | HTML code for the creative. This is a required field when applicable. --- This field is ignored if htmlCodeLocked is true. Applicable to the --- following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, --- and all RICH_MEDIA. -creHTMLCode :: Lens' Creative (Maybe Text) -creHTMLCode - = lens _creHTMLCode (\ s a -> s{_creHTMLCode = a}) - --- | Advertiser ID of this creative. This is a required field. Applicable to --- all creative types. -creAdvertiserId :: Lens' Creative (Maybe Int64) -creAdvertiserId - = lens _creAdvertiserId - (\ s a -> s{_creAdvertiserId = a}) - . mapping _Coerce - --- | The internal Flash version for this creative as calculated by Studio. --- This is a read-only field. Applicable to the following creative types: --- FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when --- the primary asset type is not HTML_IMAGE. -creRequiredFlashVersion :: Lens' Creative (Maybe Int32) -creRequiredFlashVersion - = lens _creRequiredFlashVersion - (\ s a -> s{_creRequiredFlashVersion = a}) - . mapping _Coerce - --- | The 6-character HTML color code, beginning with #, for the background of --- the window area where the Flash file is displayed. Default is white. --- Applicable to the following creative types: FLASH_INPAGE. -creBackgRoundColor :: Lens' Creative (Maybe Text) -creBackgRoundColor - = lens _creBackgRoundColor - (\ s a -> s{_creBackgRoundColor = a}) - --- | Keywords for a Rich Media creative. Keywords let you customize the --- creative settings of a Rich Media ad running on your site without having --- to contact the advertiser. You can use keywords to dynamically change --- the look or functionality of a creative. Applicable to the following --- creative types: all RICH_MEDIA, and all VPAID. -creAdTagKeys :: Lens' Creative [Text] -creAdTagKeys - = lens _creAdTagKeys (\ s a -> s{_creAdTagKeys = a}) - . _Default - . _Coerce - --- | Whether the user can choose to skip the creative. Applicable to the --- following creative types: all INSTREAM_VIDEO and all VPAID. -creSkippable :: Lens' Creative (Maybe Bool) -creSkippable - = lens _creSkippable (\ s a -> s{_creSkippable = a}) - --- | Whether the creative is SSL-compliant. This is a read-only field. --- Applicable to all creative types. -creSSLCompliant :: Lens' Creative (Maybe Bool) -creSSLCompliant - = lens _creSSLCompliant - (\ s a -> s{_creSSLCompliant = a}) - --- | Dimension value for the ID of this creative. This is a read-only field. --- Applicable to all creative types. -creIdDimensionValue :: Lens' Creative (Maybe DimensionValue) -creIdDimensionValue - = lens _creIdDimensionValue - (\ s a -> s{_creIdDimensionValue = a}) - --- | Reporting label used for HTML5 banner backup image. Applicable to the --- following creative types: DISPLAY when the primary asset type is not --- HTML_IMAGE. -creBackupImageReportingLabel :: Lens' Creative (Maybe Text) -creBackupImageReportingLabel - = lens _creBackupImageReportingLabel - (\ s a -> s{_creBackupImageReportingLabel = a}) - --- | Industry standard ID assigned to creative for reach and frequency. --- Applicable to INSTREAM_VIDEO_REDIRECT creatives. -creCommercialId :: Lens' Creative (Maybe Text) -creCommercialId - = lens _creCommercialId - (\ s a -> s{_creCommercialId = a}) - --- | Whether the creative is active. Applicable to all creative types. -creActive :: Lens' Creative (Maybe Bool) -creActive - = lens _creActive (\ s a -> s{_creActive = a}) - --- | List of exit events configured for the creative. For DISPLAY and --- DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated --- from clickTags, For DISPLAY, an event is also created from the --- backupImageReportingLabel. Applicable to the following creative types: --- DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to --- DISPLAY when the primary asset type is not HTML_IMAGE. -creExitCustomEvents :: Lens' Creative [CreativeCustomEvent] -creExitCustomEvents - = lens _creExitCustomEvents - (\ s a -> s{_creExitCustomEvents = a}) - . _Default - . _Coerce - --- | Account ID of this creative. This field, if left unset, will be --- auto-generated for both insert and update operations. Applicable to all --- creative types. -creAccountId :: Lens' Creative (Maybe Int64) -creAccountId - = lens _creAccountId (\ s a -> s{_creAccountId = a}) - . mapping _Coerce - --- | Click-through URL for backup image. Applicable to ENHANCED_BANNER when --- the primary asset type is not HTML_IMAGE. -creBackupImageClickThroughURL :: Lens' Creative (Maybe CreativeClickThroughURL) -creBackupImageClickThroughURL - = lens _creBackupImageClickThroughURL - (\ s a -> s{_creBackupImageClickThroughURL = a}) - --- | Name of the creative. This is a required field and must be less than 256 --- characters long. Applicable to all creative types. -creName :: Lens' Creative (Maybe Text) -creName = lens _creName (\ s a -> s{_creName = a}) - --- | Override CSS value for rich media creatives. Applicable to the following --- creative types: all RICH_MEDIA. -creOverrideCss :: Lens' Creative (Maybe Text) -creOverrideCss - = lens _creOverrideCss - (\ s a -> s{_creOverrideCss = a}) - --- | Additional sizes associated with a responsive creative. When inserting --- or updating a creative either the size ID field or size width and height --- fields can be used. Applicable to DISPLAY creatives when the primary --- asset type is HTML_IMAGE. -creAdditionalSizes :: Lens' Creative [Size] -creAdditionalSizes - = lens _creAdditionalSizes - (\ s a -> s{_creAdditionalSizes = a}) - . _Default - . _Coerce - --- | Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER --- creatives, this is a subset of detected click tags for the assets --- associated with this creative. After creating a flash asset, detected --- click tags will be returned in the creativeAssetMetadata. When inserting --- the creative, populate the creative clickTags field using the --- creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY --- creatives, there should be exactly one entry in this list for each image --- creative asset. A click tag is matched with a corresponding creative --- asset by matching the clickTag.name field with the --- creativeAsset.assetIdentifier.name field. Applicable to the following --- creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. --- Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. -creClickTags :: Lens' Creative [ClickTag] -creClickTags - = lens _creClickTags (\ s a -> s{_creClickTags = a}) - . _Default - . _Coerce - --- | Ad parameters user for VPAID creative. This is a read-only field. --- Applicable to the following creative types: all VPAID. -creAdParameters :: Lens' Creative (Maybe Text) -creAdParameters - = lens _creAdParameters - (\ s a -> s{_creAdParameters = a}) - --- | The version number helps you keep track of multiple versions of your --- creative in your reports. The version number will always be --- auto-generated during insert operations to start at 1. For tracking --- creatives the version cannot be incremented and will always remain at 1. --- For all other creative types the version can be incremented only by 1 --- during update operations. In addition, the version will be automatically --- incremented by 1 when undergoing Rich Media creative merging. Applicable --- to all creative types. -creVersion :: Lens' Creative (Maybe Int32) -creVersion - = lens _creVersion (\ s a -> s{_creVersion = a}) . - mapping _Coerce - --- | Description of the audio or video ad. Applicable to the following --- creative types: all INSTREAM_VIDEO, INSTREAM_AUDIO, and all VPAID. -creMediaDescription :: Lens' Creative (Maybe Text) -creMediaDescription - = lens _creMediaDescription - (\ s a -> s{_creMediaDescription = a}) - --- | Creative audio or video duration in seconds. This is a read-only field. --- Applicable to the following creative types: INSTREAM_VIDEO, --- INSTREAM_AUDIO, all RICH_MEDIA, and all VPAID. -creMediaDuration :: Lens' Creative (Maybe Double) -creMediaDuration - = lens _creMediaDuration - (\ s a -> s{_creMediaDuration = a}) - . mapping _Coerce - --- | Latest Studio trafficked creative ID associated with rich media and --- VPAID creatives. This is a read-only field. Applicable to the following --- creative types: all RICH_MEDIA, and all VPAID. -creLatestTraffickedCreativeId :: Lens' Creative (Maybe Int64) -creLatestTraffickedCreativeId - = lens _creLatestTraffickedCreativeId - (\ s a -> s{_creLatestTraffickedCreativeId = a}) - . mapping _Coerce - --- | Third-party URL used to record rich media impressions. Applicable to the --- following creative types: all RICH_MEDIA. -creThirdPartyRichMediaImpressionsURL :: Lens' Creative (Maybe Text) -creThirdPartyRichMediaImpressionsURL - = lens _creThirdPartyRichMediaImpressionsURL - (\ s a -> - s{_creThirdPartyRichMediaImpressionsURL = a}) - --- | Set this to true to enable the use of rules to target individual assets --- in this creative. When set to true creativeAssetSelection must be set. --- This also controls asset-level companions. When this is true, companion --- creatives should be assigned to creative assets. Learn more. Applicable --- to INSTREAM_VIDEO creatives. -creDynamicAssetSelection :: Lens' Creative (Maybe Bool) -creDynamicAssetSelection - = lens _creDynamicAssetSelection - (\ s a -> s{_creDynamicAssetSelection = a}) - --- | Creative last modification information. This is a read-only field. --- Applicable to all creative types. -creLastModifiedInfo :: Lens' Creative (Maybe LastModifiedInfo) -creLastModifiedInfo - = lens _creLastModifiedInfo - (\ s a -> s{_creLastModifiedInfo = a}) - --- | ID of this creative. This is a read-only, auto-generated field. --- Applicable to all creative types. -creId :: Lens' Creative (Maybe Int64) -creId - = lens _creId (\ s a -> s{_creId = a}) . - mapping _Coerce - --- | Source application where creative was authored. Presently, only DBM --- authored creatives will have this field set. Applicable to all creative --- types. -creAuthoringSource :: Lens' Creative (Maybe CreativeAuthoringSource) -creAuthoringSource - = lens _creAuthoringSource - (\ s a -> s{_creAuthoringSource = a}) - --- | The asset ID of the polite load image asset. Applicable to the creative --- type: DISPLAY. -crePoliteLoadAssetId :: Lens' Creative (Maybe Int64) -crePoliteLoadAssetId - = lens _crePoliteLoadAssetId - (\ s a -> s{_crePoliteLoadAssetId = a}) - . mapping _Coerce - --- | Studio advertiser ID associated with rich media and VPAID creatives. --- This is a read-only field. Applicable to the following creative types: --- all RICH_MEDIA, and all VPAID. -creStudioAdvertiserId :: Lens' Creative (Maybe Int64) -creStudioAdvertiserId - = lens _creStudioAdvertiserId - (\ s a -> s{_creStudioAdvertiserId = a}) - . mapping _Coerce - --- | Assets associated with a creative. Applicable to all but the following --- creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and --- REDIRECT -creCreativeAssets :: Lens' Creative [CreativeAsset] -creCreativeAssets - = lens _creCreativeAssets - (\ s a -> s{_creCreativeAssets = a}) - . _Default - . _Coerce - --- | Subaccount ID of this creative. This field, if left unset, will be --- auto-generated for both insert and update operations. Applicable to all --- creative types. -creSubAccountId :: Lens' Creative (Maybe Int64) -creSubAccountId - = lens _creSubAccountId - (\ s a -> s{_creSubAccountId = a}) - . mapping _Coerce - --- | Type of this creative. This is a required field. Applicable to all --- creative types. Note: FLASH_INPAGE, HTML5_BANNER, and IMAGE are only --- used for existing creatives. New creatives should use DISPLAY as a --- replacement for these types. -creType :: Lens' Creative (Maybe CreativeType) -creType = lens _creType (\ s a -> s{_creType = a}) - --- | List of timer events configured for the creative. For --- DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated --- from clickTags. Applicable to the following creative types: --- DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to --- DISPLAY when the primary asset is not HTML_IMAGE. -creTimerCustomEvents :: Lens' Creative [CreativeCustomEvent] -creTimerCustomEvents - = lens _creTimerCustomEvents - (\ s a -> s{_creTimerCustomEvents = a}) - . _Default - . _Coerce - --- | Required if dynamicAssetSelection is true. -creCreativeAssetSelection :: Lens' Creative (Maybe CreativeAssetSelection) -creCreativeAssetSelection - = lens _creCreativeAssetSelection - (\ s a -> s{_creCreativeAssetSelection = a}) - --- | Studio creative ID associated with rich media and VPAID creatives. This --- is a read-only field. Applicable to the following creative types: all --- RICH_MEDIA, and all VPAID. -creStudioCreativeId :: Lens' Creative (Maybe Int64) -creStudioCreativeId - = lens _creStudioCreativeId - (\ s a -> s{_creStudioCreativeId = a}) - . mapping _Coerce - --- | Compatibilities associated with this creative. This is a read-only --- field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on --- desktop or on mobile devices or in mobile apps for regular or --- interstitial ads, respectively. APP and APP_INTERSTITIAL are for --- rendering in mobile apps. Only pre-existing creatives may have these --- compatibilities since new creatives will either be assigned DISPLAY or --- DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in --- in-stream video ads developed with the VAST standard. IN_STREAM_AUDIO --- refers to rendering in in-stream audio ads developed with the VAST --- standard. Applicable to all creative types. Acceptable values are: - --- \"APP\" - \"APP_INTERSTITIAL\" - \"IN_STREAM_VIDEO\" - --- \"IN_STREAM_AUDIO\" - \"DISPLAY\" - \"DISPLAY_INTERSTITIAL\" -creCompatibility :: Lens' Creative [CreativeCompatibilityItem] -creCompatibility - = lens _creCompatibility - (\ s a -> s{_creCompatibility = a}) - . _Default - . _Coerce - --- | List of feature dependencies that will cause a backup image to be served --- if the browser that serves the ad does not support them. Feature --- dependencies are features that a browser must be able to support in --- order to render your HTML5 creative asset correctly. This field is --- initially auto-generated to contain all features detected by Campaign --- Manager for all the assets of this creative and can then be modified by --- the client. To reset this field, copy over all the creativeAssets\' --- detected features. Applicable to the following creative types: --- HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not --- HTML_IMAGE. -creBackupImageFeatures :: Lens' Creative [CreativeBackupImageFeaturesItem] -creBackupImageFeatures - = lens _creBackupImageFeatures - (\ s a -> s{_creBackupImageFeatures = a}) - . _Default - . _Coerce - --- | Type of artwork used for the creative. This is a read-only field. --- Applicable to the following creative types: all RICH_MEDIA, and all --- VPAID. -creArtworkType :: Lens' Creative (Maybe CreativeArtworkType) -creArtworkType - = lens _creArtworkType - (\ s a -> s{_creArtworkType = a}) - --- | Whether the creative is archived. Applicable to all creative types. -creArchived :: Lens' Creative (Maybe Bool) -creArchived - = lens _creArchived (\ s a -> s{_creArchived = a}) - --- | List of companion creatives assigned to an in-Stream video creative. --- Acceptable values include IDs of existing flash and image creatives. --- Applicable to the following creative types: all VPAID, all --- INSTREAM_AUDIO and all INSTREAM_VIDEO with dynamicAssetSelection set to --- false. -creCompanionCreatives :: Lens' Creative [Int64] -creCompanionCreatives - = lens _creCompanionCreatives - (\ s a -> s{_creCompanionCreatives = a}) - . _Default - . _Coerce - --- | Combined size of all creative assets. This is a read-only field. --- Applicable to the following creative types: all RICH_MEDIA, and all --- VPAID. -creTotalFileSize :: Lens' Creative (Maybe Int64) -creTotalFileSize - = lens _creTotalFileSize - (\ s a -> s{_creTotalFileSize = a}) - . mapping _Coerce - --- | Studio trafficked creative ID associated with rich media and VPAID --- creatives. This is a read-only field. Applicable to the following --- creative types: all RICH_MEDIA, and all VPAID. -creStudioTraffickedCreativeId :: Lens' Creative (Maybe Int64) -creStudioTraffickedCreativeId - = lens _creStudioTraffickedCreativeId - (\ s a -> s{_creStudioTraffickedCreativeId = a}) - . mapping _Coerce - --- | Whether images are automatically advanced for image gallery creatives. --- Applicable to the following creative types: DISPLAY_IMAGE_GALLERY. -creAutoAdvanceImages :: Lens' Creative (Maybe Bool) -creAutoAdvanceImages - = lens _creAutoAdvanceImages - (\ s a -> s{_creAutoAdvanceImages = a}) - --- | URL of hosted image or hosted video or another ad tag. For --- INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect --- URL. The standard for a VAST (Video Ad Serving Template) ad response --- allows for a redirect link to another VAST 2.0 or 3.0 call. This is a --- required field when applicable. Applicable to the following creative --- types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, --- INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT -creRedirectURL :: Lens' Creative (Maybe Text) -creRedirectURL - = lens _creRedirectURL - (\ s a -> s{_creRedirectURL = a}) - --- | Creative field assignments for this creative. Applicable to all creative --- types. -creCreativeFieldAssignments :: Lens' Creative [CreativeFieldAssignment] -creCreativeFieldAssignments - = lens _creCreativeFieldAssignments - (\ s a -> s{_creCreativeFieldAssignments = a}) - . _Default - . _Coerce - -instance FromJSON Creative where - parseJSON - = withObject "Creative" - (\ o -> - Creative' <$> - (o .:? "convertFlashToHtml5") <*> - (o .:? "backupImageTargetWindow") - <*> (o .:? "renderingIdDimensionValue") - <*> (o .:? "customKeyValues" .!= mempty) - <*> (o .:? "skipOffset") - <*> (o .:? "renderingId") - <*> (o .:? "thirdPartyBackupImageImpressionsUrl") - <*> (o .:? "fsCommand") - <*> (o .:? "allowScriptAccess") - <*> (o .:? "htmlCodeLocked") - <*> (o .:? "requiredFlashPluginVersion") - <*> (o .:? "universalAdId") - <*> (o .:? "authoringTool") - <*> (o .:? "size") - <*> (o .:? "thirdPartyUrls" .!= mempty) - <*> (o .:? "progressOffset") - <*> (o .:? "counterCustomEvents" .!= mempty) - <*> (o .:? "kind" .!= "dfareporting#creative") - <*> (o .:? "sslOverride") - <*> (o .:? "htmlCode") - <*> (o .:? "advertiserId") - <*> (o .:? "requiredFlashVersion") - <*> (o .:? "backgroundColor") - <*> (o .:? "adTagKeys" .!= mempty) - <*> (o .:? "skippable") - <*> (o .:? "sslCompliant") - <*> (o .:? "idDimensionValue") - <*> (o .:? "backupImageReportingLabel") - <*> (o .:? "commercialId") - <*> (o .:? "active") - <*> (o .:? "exitCustomEvents" .!= mempty) - <*> (o .:? "accountId") - <*> (o .:? "backupImageClickThroughUrl") - <*> (o .:? "name") - <*> (o .:? "overrideCss") - <*> (o .:? "additionalSizes" .!= mempty) - <*> (o .:? "clickTags" .!= mempty) - <*> (o .:? "adParameters") - <*> (o .:? "version") - <*> (o .:? "mediaDescription") - <*> (o .:? "mediaDuration") - <*> (o .:? "latestTraffickedCreativeId") - <*> (o .:? "thirdPartyRichMediaImpressionsUrl") - <*> (o .:? "dynamicAssetSelection") - <*> (o .:? "lastModifiedInfo") - <*> (o .:? "id") - <*> (o .:? "authoringSource") - <*> (o .:? "politeLoadAssetId") - <*> (o .:? "studioAdvertiserId") - <*> (o .:? "creativeAssets" .!= mempty) - <*> (o .:? "subaccountId") - <*> (o .:? "type") - <*> (o .:? "timerCustomEvents" .!= mempty) - <*> (o .:? "creativeAssetSelection") - <*> (o .:? "studioCreativeId") - <*> (o .:? "compatibility" .!= mempty) - <*> (o .:? "backupImageFeatures" .!= mempty) - <*> (o .:? "artworkType") - <*> (o .:? "archived") - <*> (o .:? "companionCreatives" .!= mempty) - <*> (o .:? "totalFileSize") - <*> (o .:? "studioTraffickedCreativeId") - <*> (o .:? "autoAdvanceImages") - <*> (o .:? "redirectUrl") - <*> (o .:? "creativeFieldAssignments" .!= mempty)) - -instance ToJSON Creative where - toJSON Creative'{..} - = object - (catMaybes - [("convertFlashToHtml5" .=) <$> - _creConvertFlashToHTML5, - ("backupImageTargetWindow" .=) <$> - _creBackupImageTargetWindow, - ("renderingIdDimensionValue" .=) <$> - _creRenderingIdDimensionValue, - ("customKeyValues" .=) <$> _creCustomKeyValues, - ("skipOffset" .=) <$> _creSkipOffSet, - ("renderingId" .=) <$> _creRenderingId, - ("thirdPartyBackupImageImpressionsUrl" .=) <$> - _creThirdPartyBackupImageImpressionsURL, - ("fsCommand" .=) <$> _creFsCommand, - ("allowScriptAccess" .=) <$> _creAllowScriptAccess, - ("htmlCodeLocked" .=) <$> _creHTMLCodeLocked, - ("requiredFlashPluginVersion" .=) <$> - _creRequiredFlashPluginVersion, - ("universalAdId" .=) <$> _creUniversalAdId, - ("authoringTool" .=) <$> _creAuthoringTool, - ("size" .=) <$> _creSize, - ("thirdPartyUrls" .=) <$> _creThirdPartyURLs, - ("progressOffset" .=) <$> _creProgressOffSet, - ("counterCustomEvents" .=) <$> - _creCounterCustomEvents, - Just ("kind" .= _creKind), - ("sslOverride" .=) <$> _creSSLOverride, - ("htmlCode" .=) <$> _creHTMLCode, - ("advertiserId" .=) <$> _creAdvertiserId, - ("requiredFlashVersion" .=) <$> - _creRequiredFlashVersion, - ("backgroundColor" .=) <$> _creBackgRoundColor, - ("adTagKeys" .=) <$> _creAdTagKeys, - ("skippable" .=) <$> _creSkippable, - ("sslCompliant" .=) <$> _creSSLCompliant, - ("idDimensionValue" .=) <$> _creIdDimensionValue, - ("backupImageReportingLabel" .=) <$> - _creBackupImageReportingLabel, - ("commercialId" .=) <$> _creCommercialId, - ("active" .=) <$> _creActive, - ("exitCustomEvents" .=) <$> _creExitCustomEvents, - ("accountId" .=) <$> _creAccountId, - ("backupImageClickThroughUrl" .=) <$> - _creBackupImageClickThroughURL, - ("name" .=) <$> _creName, - ("overrideCss" .=) <$> _creOverrideCss, - ("additionalSizes" .=) <$> _creAdditionalSizes, - ("clickTags" .=) <$> _creClickTags, - ("adParameters" .=) <$> _creAdParameters, - ("version" .=) <$> _creVersion, - ("mediaDescription" .=) <$> _creMediaDescription, - ("mediaDuration" .=) <$> _creMediaDuration, - ("latestTraffickedCreativeId" .=) <$> - _creLatestTraffickedCreativeId, - ("thirdPartyRichMediaImpressionsUrl" .=) <$> - _creThirdPartyRichMediaImpressionsURL, - ("dynamicAssetSelection" .=) <$> - _creDynamicAssetSelection, - ("lastModifiedInfo" .=) <$> _creLastModifiedInfo, - ("id" .=) <$> _creId, - ("authoringSource" .=) <$> _creAuthoringSource, - ("politeLoadAssetId" .=) <$> _crePoliteLoadAssetId, - ("studioAdvertiserId" .=) <$> _creStudioAdvertiserId, - ("creativeAssets" .=) <$> _creCreativeAssets, - ("subaccountId" .=) <$> _creSubAccountId, - ("type" .=) <$> _creType, - ("timerCustomEvents" .=) <$> _creTimerCustomEvents, - ("creativeAssetSelection" .=) <$> - _creCreativeAssetSelection, - ("studioCreativeId" .=) <$> _creStudioCreativeId, - ("compatibility" .=) <$> _creCompatibility, - ("backupImageFeatures" .=) <$> - _creBackupImageFeatures, - ("artworkType" .=) <$> _creArtworkType, - ("archived" .=) <$> _creArchived, - ("companionCreatives" .=) <$> _creCompanionCreatives, - ("totalFileSize" .=) <$> _creTotalFileSize, - ("studioTraffickedCreativeId" .=) <$> - _creStudioTraffickedCreativeId, - ("autoAdvanceImages" .=) <$> _creAutoAdvanceImages, - ("redirectUrl" .=) <$> _creRedirectURL, - ("creativeFieldAssignments" .=) <$> - _creCreativeFieldAssignments]) - --- | Site Contact --- --- /See:/ 'siteContact' smart constructor. -data SiteContact = SiteContact' - { _scEmail :: !(Maybe Text) - , _scPhone :: !(Maybe Text) - , _scLastName :: !(Maybe Text) - , _scAddress :: !(Maybe Text) - , _scFirstName :: !(Maybe Text) - , _scId :: !(Maybe (Textual Int64)) - , _scTitle :: !(Maybe Text) - , _scContactType :: !(Maybe SiteContactContactType) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'SiteContact' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'scEmail' --- --- * 'scPhone' --- --- * 'scLastName' --- --- * 'scAddress' --- --- * 'scFirstName' --- --- * 'scId' --- --- * 'scTitle' --- --- * 'scContactType' -siteContact - :: SiteContact -siteContact = - SiteContact' - { _scEmail = Nothing - , _scPhone = Nothing - , _scLastName = Nothing - , _scAddress = Nothing - , _scFirstName = Nothing - , _scId = Nothing - , _scTitle = Nothing - , _scContactType = Nothing - } - --- | Email address of this site contact. This is a required field. -scEmail :: Lens' SiteContact (Maybe Text) -scEmail = lens _scEmail (\ s a -> s{_scEmail = a}) - --- | Primary phone number of this site contact. -scPhone :: Lens' SiteContact (Maybe Text) -scPhone = lens _scPhone (\ s a -> s{_scPhone = a}) - --- | Last name of this site contact. -scLastName :: Lens' SiteContact (Maybe Text) -scLastName - = lens _scLastName (\ s a -> s{_scLastName = a}) - --- | Address of this site contact. -scAddress :: Lens' SiteContact (Maybe Text) -scAddress - = lens _scAddress (\ s a -> s{_scAddress = a}) - --- | First name of this site contact. -scFirstName :: Lens' SiteContact (Maybe Text) -scFirstName - = lens _scFirstName (\ s a -> s{_scFirstName = a}) - --- | ID of this site contact. This is a read-only, auto-generated field. -scId :: Lens' SiteContact (Maybe Int64) -scId - = lens _scId (\ s a -> s{_scId = a}) . - mapping _Coerce - --- | Title or designation of this site contact. -scTitle :: Lens' SiteContact (Maybe Text) -scTitle = lens _scTitle (\ s a -> s{_scTitle = a}) - --- | Site contact type. -scContactType :: Lens' SiteContact (Maybe SiteContactContactType) -scContactType - = lens _scContactType - (\ s a -> s{_scContactType = a}) - -instance FromJSON SiteContact where - parseJSON - = withObject "SiteContact" - (\ o -> - SiteContact' <$> - (o .:? "email") <*> (o .:? "phone") <*> - (o .:? "lastName") - <*> (o .:? "address") - <*> (o .:? "firstName") - <*> (o .:? "id") - <*> (o .:? "title") - <*> (o .:? "contactType")) - -instance ToJSON SiteContact where - toJSON SiteContact'{..} - = object - (catMaybes - [("email" .=) <$> _scEmail, - ("phone" .=) <$> _scPhone, - ("lastName" .=) <$> _scLastName, - ("address" .=) <$> _scAddress, - ("firstName" .=) <$> _scFirstName, - ("id" .=) <$> _scId, ("title" .=) <$> _scTitle, - ("contactType" .=) <$> _scContactType]) - --- | Account List Response --- --- /See:/ 'accountsListResponse' smart constructor. -data AccountsListResponse = AccountsListResponse' - { _accNextPageToken :: !(Maybe Text) - , _accAccounts :: !(Maybe [Account]) - , _accKind :: !Text - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'AccountsListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'accNextPageToken' --- --- * 'accAccounts' --- --- * 'accKind' -accountsListResponse - :: AccountsListResponse -accountsListResponse = - AccountsListResponse' - { _accNextPageToken = Nothing - , _accAccounts = Nothing - , _accKind = "dfareporting#accountsListResponse" - } - --- | Pagination token to be used for the next list operation. -accNextPageToken :: Lens' AccountsListResponse (Maybe Text) -accNextPageToken - = lens _accNextPageToken - (\ s a -> s{_accNextPageToken = a}) - --- | Account collection. -accAccounts :: Lens' AccountsListResponse [Account] -accAccounts - = lens _accAccounts (\ s a -> s{_accAccounts = a}) . - _Default - . _Coerce - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#accountsListResponse\". -accKind :: Lens' AccountsListResponse Text -accKind = lens _accKind (\ s a -> s{_accKind = a}) - -instance FromJSON AccountsListResponse where - parseJSON - = withObject "AccountsListResponse" - (\ o -> - AccountsListResponse' <$> - (o .:? "nextPageToken") <*> - (o .:? "accounts" .!= mempty) - <*> - (o .:? "kind" .!= - "dfareporting#accountsListResponse")) - -instance ToJSON AccountsListResponse where - toJSON AccountsListResponse'{..} - = object - (catMaybes - [("nextPageToken" .=) <$> _accNextPageToken, - ("accounts" .=) <$> _accAccounts, - Just ("kind" .= _accKind)]) - --- | Represents a date range. --- --- /See:/ 'dateRange' smart constructor. -data DateRange = DateRange' - { _drKind :: !Text - , _drEndDate :: !(Maybe Date') - , _drStartDate :: !(Maybe Date') - , _drRelativeDateRange :: !(Maybe DateRangeRelativeDateRange) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'DateRange' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'drKind' --- --- * 'drEndDate' --- --- * 'drStartDate' --- --- * 'drRelativeDateRange' -dateRange - :: DateRange -dateRange = - DateRange' - { _drKind = "dfareporting#dateRange" - , _drEndDate = Nothing - , _drStartDate = Nothing - , _drRelativeDateRange = Nothing - } - --- | The kind of resource this is, in this case dfareporting#dateRange. -drKind :: Lens' DateRange Text -drKind = lens _drKind (\ s a -> s{_drKind = a}) - --- | The end date of the date range, inclusive. A string of the format: --- \"yyyy-MM-dd\". -drEndDate :: Lens' DateRange (Maybe Day) -drEndDate - = lens _drEndDate (\ s a -> s{_drEndDate = a}) . - mapping _Date - --- | The start date of the date range, inclusive. A string of the format: --- \"yyyy-MM-dd\". -drStartDate :: Lens' DateRange (Maybe Day) -drStartDate - = lens _drStartDate (\ s a -> s{_drStartDate = a}) . - mapping _Date - --- | The date range relative to the date of when the report is run. -drRelativeDateRange :: Lens' DateRange (Maybe DateRangeRelativeDateRange) -drRelativeDateRange - = lens _drRelativeDateRange - (\ s a -> s{_drRelativeDateRange = a}) - -instance FromJSON DateRange where - parseJSON - = withObject "DateRange" - (\ o -> - DateRange' <$> - (o .:? "kind" .!= "dfareporting#dateRange") <*> - (o .:? "endDate") - <*> (o .:? "startDate") - <*> (o .:? "relativeDateRange")) - -instance ToJSON DateRange where - toJSON DateRange'{..} - = object - (catMaybes - [Just ("kind" .= _drKind), - ("endDate" .=) <$> _drEndDate, - ("startDate" .=) <$> _drStartDate, - ("relativeDateRange" .=) <$> _drRelativeDateRange]) - --- | Represents a Report resource. --- --- /See:/ 'report' smart constructor. -data Report = Report' - { _rDelivery :: !(Maybe ReportDelivery) - , _rEtag :: !(Maybe Text) - , _rOwnerProFileId :: !(Maybe (Textual Int64)) - , _rSchedule :: !(Maybe ReportSchedule) - , _rPathToConversionCriteria :: !(Maybe ReportPathToConversionCriteria) - , _rKind :: !Text - , _rFormat :: !(Maybe ReportFormat) - , _rReachCriteria :: !(Maybe ReportReachCriteria) - , _rLastModifiedTime :: !(Maybe (Textual Word64)) - , _rAccountId :: !(Maybe (Textual Int64)) - , _rName :: !(Maybe Text) - , _rId :: !(Maybe (Textual Int64)) - , _rCrossDimensionReachCriteria :: !(Maybe ReportCrossDimensionReachCriteria) - , _rType :: !(Maybe ReportType) - , _rSubAccountId :: !(Maybe (Textual Int64)) - , _rFloodlightCriteria :: !(Maybe ReportFloodlightCriteria) - , _rCriteria :: !(Maybe ReportCriteria) - , _rFileName :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'Report' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'rDelivery' --- --- * 'rEtag' --- --- * 'rOwnerProFileId' --- --- * 'rSchedule' --- --- * 'rPathToConversionCriteria' --- --- * 'rKind' --- --- * 'rFormat' --- --- * 'rReachCriteria' --- --- * 'rLastModifiedTime' --- --- * 'rAccountId' --- --- * 'rName' --- --- * 'rId' --- --- * 'rCrossDimensionReachCriteria' --- --- * 'rType' --- --- * 'rSubAccountId' --- --- * 'rFloodlightCriteria' --- --- * 'rCriteria' --- --- * 'rFileName' -report - :: Report -report = - Report' - { _rDelivery = Nothing - , _rEtag = Nothing - , _rOwnerProFileId = Nothing - , _rSchedule = Nothing - , _rPathToConversionCriteria = Nothing - , _rKind = "dfareporting#report" - , _rFormat = Nothing - , _rReachCriteria = Nothing - , _rLastModifiedTime = Nothing - , _rAccountId = Nothing - , _rName = Nothing - , _rId = Nothing - , _rCrossDimensionReachCriteria = Nothing - , _rType = Nothing - , _rSubAccountId = Nothing - , _rFloodlightCriteria = Nothing - , _rCriteria = Nothing - , _rFileName = Nothing - } - --- | The report\'s email delivery settings. -rDelivery :: Lens' Report (Maybe ReportDelivery) -rDelivery - = lens _rDelivery (\ s a -> s{_rDelivery = a}) - --- | The eTag of this response for caching purposes. -rEtag :: Lens' Report (Maybe Text) -rEtag = lens _rEtag (\ s a -> s{_rEtag = a}) - --- | The user profile id of the owner of this report. -rOwnerProFileId :: Lens' Report (Maybe Int64) -rOwnerProFileId - = lens _rOwnerProFileId - (\ s a -> s{_rOwnerProFileId = a}) - . mapping _Coerce - --- | The report\'s schedule. Can only be set if the report\'s \'dateRange\' --- is a relative date range and the relative date range is not \"TODAY\". -rSchedule :: Lens' Report (Maybe ReportSchedule) -rSchedule - = lens _rSchedule (\ s a -> s{_rSchedule = a}) - --- | The report criteria for a report of type \"PATH_TO_CONVERSION\". -rPathToConversionCriteria :: Lens' Report (Maybe ReportPathToConversionCriteria) -rPathToConversionCriteria - = lens _rPathToConversionCriteria - (\ s a -> s{_rPathToConversionCriteria = a}) - --- | The kind of resource this is, in this case dfareporting#report. -rKind :: Lens' Report Text -rKind = lens _rKind (\ s a -> s{_rKind = a}) - --- | The output format of the report. If not specified, default format is --- \"CSV\". Note that the actual format in the completed report file might --- differ if for instance the report\'s size exceeds the format\'s --- capabilities. \"CSV\" will then be the fallback format. -rFormat :: Lens' Report (Maybe ReportFormat) -rFormat = lens _rFormat (\ s a -> s{_rFormat = a}) - --- | The report criteria for a report of type \"REACH\". -rReachCriteria :: Lens' Report (Maybe ReportReachCriteria) -rReachCriteria - = lens _rReachCriteria - (\ s a -> s{_rReachCriteria = a}) - --- | The timestamp (in milliseconds since epoch) of when this report was last --- modified. -rLastModifiedTime :: Lens' Report (Maybe Word64) -rLastModifiedTime - = lens _rLastModifiedTime - (\ s a -> s{_rLastModifiedTime = a}) - . mapping _Coerce - --- | The account ID to which this report belongs. -rAccountId :: Lens' Report (Maybe Int64) -rAccountId - = lens _rAccountId (\ s a -> s{_rAccountId = a}) . - mapping _Coerce - --- | The name of the report. -rName :: Lens' Report (Maybe Text) -rName = lens _rName (\ s a -> s{_rName = a}) - --- | The unique ID identifying this report resource. -rId :: Lens' Report (Maybe Int64) -rId - = lens _rId (\ s a -> s{_rId = a}) . mapping _Coerce - --- | The report criteria for a report of type \"CROSS_DIMENSION_REACH\". -rCrossDimensionReachCriteria :: Lens' Report (Maybe ReportCrossDimensionReachCriteria) -rCrossDimensionReachCriteria - = lens _rCrossDimensionReachCriteria - (\ s a -> s{_rCrossDimensionReachCriteria = a}) - --- | The type of the report. -rType :: Lens' Report (Maybe ReportType) -rType = lens _rType (\ s a -> s{_rType = a}) - --- | The subaccount ID to which this report belongs if applicable. -rSubAccountId :: Lens' Report (Maybe Int64) -rSubAccountId - = lens _rSubAccountId - (\ s a -> s{_rSubAccountId = a}) - . mapping _Coerce - --- | The report criteria for a report of type \"FLOODLIGHT\". -rFloodlightCriteria :: Lens' Report (Maybe ReportFloodlightCriteria) -rFloodlightCriteria - = lens _rFloodlightCriteria - (\ s a -> s{_rFloodlightCriteria = a}) - --- | The report criteria for a report of type \"STANDARD\". -rCriteria :: Lens' Report (Maybe ReportCriteria) -rCriteria - = lens _rCriteria (\ s a -> s{_rCriteria = a}) - --- | The filename used when generating report files for this report. -rFileName :: Lens' Report (Maybe Text) -rFileName - = lens _rFileName (\ s a -> s{_rFileName = a}) - -instance FromJSON Report where - parseJSON - = withObject "Report" - (\ o -> - Report' <$> - (o .:? "delivery") <*> (o .:? "etag") <*> - (o .:? "ownerProfileId") - <*> (o .:? "schedule") - <*> (o .:? "pathToConversionCriteria") - <*> (o .:? "kind" .!= "dfareporting#report") - <*> (o .:? "format") - <*> (o .:? "reachCriteria") - <*> (o .:? "lastModifiedTime") - <*> (o .:? "accountId") - <*> (o .:? "name") - <*> (o .:? "id") - <*> (o .:? "crossDimensionReachCriteria") - <*> (o .:? "type") - <*> (o .:? "subAccountId") - <*> (o .:? "floodlightCriteria") - <*> (o .:? "criteria") - <*> (o .:? "fileName")) - -instance ToJSON Report where - toJSON Report'{..} - = object - (catMaybes - [("delivery" .=) <$> _rDelivery, - ("etag" .=) <$> _rEtag, - ("ownerProfileId" .=) <$> _rOwnerProFileId, - ("schedule" .=) <$> _rSchedule, - ("pathToConversionCriteria" .=) <$> - _rPathToConversionCriteria, - Just ("kind" .= _rKind), ("format" .=) <$> _rFormat, - ("reachCriteria" .=) <$> _rReachCriteria, - ("lastModifiedTime" .=) <$> _rLastModifiedTime, - ("accountId" .=) <$> _rAccountId, - ("name" .=) <$> _rName, ("id" .=) <$> _rId, - ("crossDimensionReachCriteria" .=) <$> - _rCrossDimensionReachCriteria, - ("type" .=) <$> _rType, - ("subAccountId" .=) <$> _rSubAccountId, - ("floodlightCriteria" .=) <$> _rFloodlightCriteria, - ("criteria" .=) <$> _rCriteria, - ("fileName" .=) <$> _rFileName]) - --- | A rule associates an asset with a targeting template for asset-level --- targeting. Applicable to INSTREAM_VIDEO creatives. --- --- /See:/ 'rule' smart constructor. -data Rule = Rule' - { _rulTargetingTemplateId :: !(Maybe (Textual Int64)) - , _rulName :: !(Maybe Text) - , _rulAssetId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'Rule' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'rulTargetingTemplateId' --- --- * 'rulName' --- --- * 'rulAssetId' -rule - :: Rule -rule = - Rule' - { _rulTargetingTemplateId = Nothing - , _rulName = Nothing - , _rulAssetId = Nothing - } - --- | A targeting template ID. The targeting from the targeting template will --- be used to determine whether this asset should be served. This is a --- required field. -rulTargetingTemplateId :: Lens' Rule (Maybe Int64) -rulTargetingTemplateId - = lens _rulTargetingTemplateId - (\ s a -> s{_rulTargetingTemplateId = a}) - . mapping _Coerce - --- | A user-friendly name for this rule. This is a required field. -rulName :: Lens' Rule (Maybe Text) -rulName = lens _rulName (\ s a -> s{_rulName = a}) - --- | A creativeAssets[].id. This should refer to one of the parent assets in --- this creative. This is a required field. -rulAssetId :: Lens' Rule (Maybe Int64) -rulAssetId - = lens _rulAssetId (\ s a -> s{_rulAssetId = a}) . - mapping _Coerce - -instance FromJSON Rule where - parseJSON - = withObject "Rule" - (\ o -> - Rule' <$> - (o .:? "targetingTemplateId") <*> (o .:? "name") <*> - (o .:? "assetId")) - -instance ToJSON Rule where - toJSON Rule'{..} - = object - (catMaybes - [("targetingTemplateId" .=) <$> - _rulTargetingTemplateId, - ("name" .=) <$> _rulName, - ("assetId" .=) <$> _rulAssetId]) - --- | Contains properties of a Campaign Manager campaign. --- --- /See:/ 'campaign' smart constructor. -data Campaign = Campaign' - { _camAdBlockingConfiguration :: !(Maybe AdBlockingConfiguration) - , _camCreativeOptimizationConfiguration :: !(Maybe CreativeOptimizationConfiguration) - , _camCreativeGroupIds :: !(Maybe [Textual Int64]) - , _camNielsenOCREnabled :: !(Maybe Bool) - , _camKind :: !Text - , _camClickThroughURLSuffixProperties :: !(Maybe ClickThroughURLSuffixProperties) - , _camAdvertiserId :: !(Maybe (Textual Int64)) - , _camEndDate :: !(Maybe Date') - , _camAdvertiserIdDimensionValue :: !(Maybe DimensionValue) - , _camIdDimensionValue :: !(Maybe DimensionValue) - , _camEventTagOverrides :: !(Maybe [EventTagOverride]) - , _camLookbackConfiguration :: !(Maybe LookbackConfiguration) - , _camStartDate :: !(Maybe Date') - , _camAccountId :: !(Maybe (Textual Int64)) - , _camName :: !(Maybe Text) - , _camAdvertiserGroupId :: !(Maybe (Textual Int64)) - , _camBillingInvoiceCode :: !(Maybe Text) - , _camDefaultLandingPageId :: !(Maybe (Textual Int64)) - , _camCreateInfo :: !(Maybe LastModifiedInfo) - , _camLastModifiedInfo :: !(Maybe LastModifiedInfo) - , _camId :: !(Maybe (Textual Int64)) - , _camSubAccountId :: !(Maybe (Textual Int64)) - , _camAdditionalCreativeOptimizationConfigurations :: !(Maybe [CreativeOptimizationConfiguration]) - , _camExternalId :: !(Maybe Text) - , _camComment :: !(Maybe Text) - , _camAudienceSegmentGroups :: !(Maybe [AudienceSegmentGroup]) - , _camArchived :: !(Maybe Bool) - , _camTraffickerEmails :: !(Maybe [Text]) - , _camDefaultClickThroughEventTagProperties :: !(Maybe DefaultClickThroughEventTagProperties) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'Campaign' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'camAdBlockingConfiguration' --- --- * 'camCreativeOptimizationConfiguration' --- --- * 'camCreativeGroupIds' --- --- * 'camNielsenOCREnabled' --- --- * 'camKind' --- --- * 'camClickThroughURLSuffixProperties' --- --- * 'camAdvertiserId' --- --- * 'camEndDate' --- --- * 'camAdvertiserIdDimensionValue' --- --- * 'camIdDimensionValue' --- --- * 'camEventTagOverrides' --- --- * 'camLookbackConfiguration' --- --- * 'camStartDate' --- --- * 'camAccountId' --- --- * 'camName' --- --- * 'camAdvertiserGroupId' --- --- * 'camBillingInvoiceCode' --- --- * 'camDefaultLandingPageId' --- --- * 'camCreateInfo' --- --- * 'camLastModifiedInfo' --- --- * 'camId' --- --- * 'camSubAccountId' --- --- * 'camAdditionalCreativeOptimizationConfigurations' --- --- * 'camExternalId' --- --- * 'camComment' --- --- * 'camAudienceSegmentGroups' --- --- * 'camArchived' --- --- * 'camTraffickerEmails' --- --- * 'camDefaultClickThroughEventTagProperties' -campaign - :: Campaign -campaign = - Campaign' - { _camAdBlockingConfiguration = Nothing - , _camCreativeOptimizationConfiguration = Nothing - , _camCreativeGroupIds = Nothing - , _camNielsenOCREnabled = Nothing - , _camKind = "dfareporting#campaign" - , _camClickThroughURLSuffixProperties = Nothing - , _camAdvertiserId = Nothing - , _camEndDate = Nothing - , _camAdvertiserIdDimensionValue = Nothing - , _camIdDimensionValue = Nothing - , _camEventTagOverrides = Nothing - , _camLookbackConfiguration = Nothing - , _camStartDate = Nothing - , _camAccountId = Nothing - , _camName = Nothing - , _camAdvertiserGroupId = Nothing - , _camBillingInvoiceCode = Nothing - , _camDefaultLandingPageId = Nothing - , _camCreateInfo = Nothing - , _camLastModifiedInfo = Nothing - , _camId = Nothing - , _camSubAccountId = Nothing - , _camAdditionalCreativeOptimizationConfigurations = Nothing - , _camExternalId = Nothing - , _camComment = Nothing - , _camAudienceSegmentGroups = Nothing - , _camArchived = Nothing - , _camTraffickerEmails = Nothing - , _camDefaultClickThroughEventTagProperties = Nothing - } - --- | Ad blocking settings for this campaign. -camAdBlockingConfiguration :: Lens' Campaign (Maybe AdBlockingConfiguration) -camAdBlockingConfiguration - = lens _camAdBlockingConfiguration - (\ s a -> s{_camAdBlockingConfiguration = a}) - --- | Creative optimization configuration for the campaign. -camCreativeOptimizationConfiguration :: Lens' Campaign (Maybe CreativeOptimizationConfiguration) -camCreativeOptimizationConfiguration - = lens _camCreativeOptimizationConfiguration - (\ s a -> - s{_camCreativeOptimizationConfiguration = a}) - --- | List of creative group IDs that are assigned to the campaign. -camCreativeGroupIds :: Lens' Campaign [Int64] -camCreativeGroupIds - = lens _camCreativeGroupIds - (\ s a -> s{_camCreativeGroupIds = a}) - . _Default - . _Coerce - --- | Whether Nielsen reports are enabled for this campaign. -camNielsenOCREnabled :: Lens' Campaign (Maybe Bool) -camNielsenOCREnabled - = lens _camNielsenOCREnabled - (\ s a -> s{_camNielsenOCREnabled = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#campaign\". -camKind :: Lens' Campaign Text -camKind = lens _camKind (\ s a -> s{_camKind = a}) - --- | Click-through URL suffix override properties for this campaign. -camClickThroughURLSuffixProperties :: Lens' Campaign (Maybe ClickThroughURLSuffixProperties) -camClickThroughURLSuffixProperties - = lens _camClickThroughURLSuffixProperties - (\ s a -> s{_camClickThroughURLSuffixProperties = a}) - --- | Advertiser ID of this campaign. This is a required field. -camAdvertiserId :: Lens' Campaign (Maybe Int64) -camAdvertiserId - = lens _camAdvertiserId - (\ s a -> s{_camAdvertiserId = a}) - . mapping _Coerce - --- | Date on which the campaign will stop running. On insert, the end date --- must be today or a future date. The end date must be later than or be --- the same as the start date. If, for example, you set 6\/25\/2015 as both --- the start and end dates, the effective campaign run date is just that --- day only, 6\/25\/2015. The hours, minutes, and seconds of the end date --- should not be set, as doing so will result in an error. This is a --- required field. -camEndDate :: Lens' Campaign (Maybe Day) -camEndDate - = lens _camEndDate (\ s a -> s{_camEndDate = a}) . - mapping _Date - --- | Dimension value for the advertiser ID of this campaign. This is a --- read-only, auto-generated field. -camAdvertiserIdDimensionValue :: Lens' Campaign (Maybe DimensionValue) -camAdvertiserIdDimensionValue - = lens _camAdvertiserIdDimensionValue - (\ s a -> s{_camAdvertiserIdDimensionValue = a}) - --- | Dimension value for the ID of this campaign. This is a read-only, --- auto-generated field. -camIdDimensionValue :: Lens' Campaign (Maybe DimensionValue) -camIdDimensionValue - = lens _camIdDimensionValue - (\ s a -> s{_camIdDimensionValue = a}) - --- | Overrides that can be used to activate or deactivate advertiser event --- tags. -camEventTagOverrides :: Lens' Campaign [EventTagOverride] -camEventTagOverrides - = lens _camEventTagOverrides - (\ s a -> s{_camEventTagOverrides = a}) - . _Default - . _Coerce - --- | Lookback window settings for the campaign. -camLookbackConfiguration :: Lens' Campaign (Maybe LookbackConfiguration) -camLookbackConfiguration - = lens _camLookbackConfiguration - (\ s a -> s{_camLookbackConfiguration = a}) - --- | Date on which the campaign starts running. The start date can be any --- date. The hours, minutes, and seconds of the start date should not be --- set, as doing so will result in an error. This is a required field. -camStartDate :: Lens' Campaign (Maybe Day) -camStartDate - = lens _camStartDate (\ s a -> s{_camStartDate = a}) - . mapping _Date - --- | Account ID of this campaign. This is a read-only field that can be left --- blank. -camAccountId :: Lens' Campaign (Maybe Int64) -camAccountId - = lens _camAccountId (\ s a -> s{_camAccountId = a}) - . mapping _Coerce - --- | Name of this campaign. This is a required field and must be less than --- 256 characters long and unique among campaigns of the same advertiser. -camName :: Lens' Campaign (Maybe Text) -camName = lens _camName (\ s a -> s{_camName = a}) - --- | Advertiser group ID of the associated advertiser. -camAdvertiserGroupId :: Lens' Campaign (Maybe Int64) -camAdvertiserGroupId - = lens _camAdvertiserGroupId - (\ s a -> s{_camAdvertiserGroupId = a}) - . mapping _Coerce - --- | Billing invoice code included in the Campaign Manager client billing --- invoices associated with the campaign. -camBillingInvoiceCode :: Lens' Campaign (Maybe Text) -camBillingInvoiceCode - = lens _camBillingInvoiceCode - (\ s a -> s{_camBillingInvoiceCode = a}) - --- | The default landing page ID for this campaign. -camDefaultLandingPageId :: Lens' Campaign (Maybe Int64) -camDefaultLandingPageId - = lens _camDefaultLandingPageId - (\ s a -> s{_camDefaultLandingPageId = a}) - . mapping _Coerce - --- | Information about the creation of this campaign. This is a read-only --- field. -camCreateInfo :: Lens' Campaign (Maybe LastModifiedInfo) -camCreateInfo - = lens _camCreateInfo - (\ s a -> s{_camCreateInfo = a}) - --- | Information about the most recent modification of this campaign. This is --- a read-only field. -camLastModifiedInfo :: Lens' Campaign (Maybe LastModifiedInfo) -camLastModifiedInfo - = lens _camLastModifiedInfo - (\ s a -> s{_camLastModifiedInfo = a}) - --- | ID of this campaign. This is a read-only auto-generated field. -camId :: Lens' Campaign (Maybe Int64) -camId - = lens _camId (\ s a -> s{_camId = a}) . - mapping _Coerce - --- | Subaccount ID of this campaign. This is a read-only field that can be --- left blank. -camSubAccountId :: Lens' Campaign (Maybe Int64) -camSubAccountId - = lens _camSubAccountId - (\ s a -> s{_camSubAccountId = a}) - . mapping _Coerce - --- | Additional creative optimization configurations for the campaign. -camAdditionalCreativeOptimizationConfigurations :: Lens' Campaign [CreativeOptimizationConfiguration] -camAdditionalCreativeOptimizationConfigurations - = lens - _camAdditionalCreativeOptimizationConfigurations - (\ s a -> - s{_camAdditionalCreativeOptimizationConfigurations = - a}) - . _Default - . _Coerce - --- | External ID for this campaign. -camExternalId :: Lens' Campaign (Maybe Text) -camExternalId - = lens _camExternalId - (\ s a -> s{_camExternalId = a}) - --- | Arbitrary comments about this campaign. Must be less than 256 characters --- long. -camComment :: Lens' Campaign (Maybe Text) -camComment - = lens _camComment (\ s a -> s{_camComment = a}) - --- | Audience segment groups assigned to this campaign. Cannot have more than --- 300 segment groups. -camAudienceSegmentGroups :: Lens' Campaign [AudienceSegmentGroup] -camAudienceSegmentGroups - = lens _camAudienceSegmentGroups - (\ s a -> s{_camAudienceSegmentGroups = a}) - . _Default - . _Coerce - --- | Whether this campaign has been archived. -camArchived :: Lens' Campaign (Maybe Bool) -camArchived - = lens _camArchived (\ s a -> s{_camArchived = a}) - --- | Campaign trafficker contact emails. -camTraffickerEmails :: Lens' Campaign [Text] -camTraffickerEmails - = lens _camTraffickerEmails - (\ s a -> s{_camTraffickerEmails = a}) - . _Default - . _Coerce - --- | Click-through event tag ID override properties for this campaign. -camDefaultClickThroughEventTagProperties :: Lens' Campaign (Maybe DefaultClickThroughEventTagProperties) -camDefaultClickThroughEventTagProperties - = lens _camDefaultClickThroughEventTagProperties - (\ s a -> - s{_camDefaultClickThroughEventTagProperties = a}) - -instance FromJSON Campaign where - parseJSON - = withObject "Campaign" - (\ o -> - Campaign' <$> - (o .:? "adBlockingConfiguration") <*> - (o .:? "creativeOptimizationConfiguration") - <*> (o .:? "creativeGroupIds" .!= mempty) - <*> (o .:? "nielsenOcrEnabled") - <*> (o .:? "kind" .!= "dfareporting#campaign") - <*> (o .:? "clickThroughUrlSuffixProperties") - <*> (o .:? "advertiserId") - <*> (o .:? "endDate") - <*> (o .:? "advertiserIdDimensionValue") - <*> (o .:? "idDimensionValue") - <*> (o .:? "eventTagOverrides" .!= mempty) - <*> (o .:? "lookbackConfiguration") - <*> (o .:? "startDate") - <*> (o .:? "accountId") - <*> (o .:? "name") - <*> (o .:? "advertiserGroupId") - <*> (o .:? "billingInvoiceCode") - <*> (o .:? "defaultLandingPageId") - <*> (o .:? "createInfo") - <*> (o .:? "lastModifiedInfo") - <*> (o .:? "id") - <*> (o .:? "subaccountId") - <*> - (o .:? "additionalCreativeOptimizationConfigurations" - .!= mempty) - <*> (o .:? "externalId") - <*> (o .:? "comment") - <*> (o .:? "audienceSegmentGroups" .!= mempty) - <*> (o .:? "archived") - <*> (o .:? "traffickerEmails" .!= mempty) - <*> (o .:? "defaultClickThroughEventTagProperties")) - -instance ToJSON Campaign where - toJSON Campaign'{..} - = object - (catMaybes - [("adBlockingConfiguration" .=) <$> - _camAdBlockingConfiguration, - ("creativeOptimizationConfiguration" .=) <$> - _camCreativeOptimizationConfiguration, - ("creativeGroupIds" .=) <$> _camCreativeGroupIds, - ("nielsenOcrEnabled" .=) <$> _camNielsenOCREnabled, - Just ("kind" .= _camKind), - ("clickThroughUrlSuffixProperties" .=) <$> - _camClickThroughURLSuffixProperties, - ("advertiserId" .=) <$> _camAdvertiserId, - ("endDate" .=) <$> _camEndDate, - ("advertiserIdDimensionValue" .=) <$> - _camAdvertiserIdDimensionValue, - ("idDimensionValue" .=) <$> _camIdDimensionValue, - ("eventTagOverrides" .=) <$> _camEventTagOverrides, - ("lookbackConfiguration" .=) <$> - _camLookbackConfiguration, - ("startDate" .=) <$> _camStartDate, - ("accountId" .=) <$> _camAccountId, - ("name" .=) <$> _camName, - ("advertiserGroupId" .=) <$> _camAdvertiserGroupId, - ("billingInvoiceCode" .=) <$> _camBillingInvoiceCode, - ("defaultLandingPageId" .=) <$> - _camDefaultLandingPageId, - ("createInfo" .=) <$> _camCreateInfo, - ("lastModifiedInfo" .=) <$> _camLastModifiedInfo, - ("id" .=) <$> _camId, - ("subaccountId" .=) <$> _camSubAccountId, - ("additionalCreativeOptimizationConfigurations" .=) - <$> _camAdditionalCreativeOptimizationConfigurations, - ("externalId" .=) <$> _camExternalId, - ("comment" .=) <$> _camComment, - ("audienceSegmentGroups" .=) <$> - _camAudienceSegmentGroups, - ("archived" .=) <$> _camArchived, - ("traffickerEmails" .=) <$> _camTraffickerEmails, - ("defaultClickThroughEventTagProperties" .=) <$> - _camDefaultClickThroughEventTagProperties]) - --- | Third Party Authentication Token --- --- /See:/ 'thirdPartyAuthenticationToken' smart constructor. -data ThirdPartyAuthenticationToken = ThirdPartyAuthenticationToken' - { _tpatValue :: !(Maybe Text) - , _tpatName :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'ThirdPartyAuthenticationToken' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'tpatValue' --- --- * 'tpatName' -thirdPartyAuthenticationToken - :: ThirdPartyAuthenticationToken -thirdPartyAuthenticationToken = - ThirdPartyAuthenticationToken' - { _tpatValue = Nothing - , _tpatName = Nothing - } - --- | Value of the third-party authentication token. This is a read-only, --- auto-generated field. -tpatValue :: Lens' ThirdPartyAuthenticationToken (Maybe Text) -tpatValue - = lens _tpatValue (\ s a -> s{_tpatValue = a}) - --- | Name of the third-party authentication token. -tpatName :: Lens' ThirdPartyAuthenticationToken (Maybe Text) -tpatName = lens _tpatName (\ s a -> s{_tpatName = a}) - -instance FromJSON ThirdPartyAuthenticationToken where - parseJSON - = withObject "ThirdPartyAuthenticationToken" - (\ o -> - ThirdPartyAuthenticationToken' <$> - (o .:? "value") <*> (o .:? "name")) - -instance ToJSON ThirdPartyAuthenticationToken where - toJSON ThirdPartyAuthenticationToken'{..} - = object - (catMaybes - [("value" .=) <$> _tpatValue, - ("name" .=) <$> _tpatName]) - --- | Click-through URL --- --- /See:/ 'clickThroughURL' smart constructor. -data ClickThroughURL = ClickThroughURL' - { _ctuDefaultLandingPage :: !(Maybe Bool) - , _ctuComputedClickThroughURL :: !(Maybe Text) - , _ctuCustomClickThroughURL :: !(Maybe Text) - , _ctuLandingPageId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'ClickThroughURL' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'ctuDefaultLandingPage' --- --- * 'ctuComputedClickThroughURL' --- --- * 'ctuCustomClickThroughURL' --- --- * 'ctuLandingPageId' -clickThroughURL - :: ClickThroughURL -clickThroughURL = - ClickThroughURL' - { _ctuDefaultLandingPage = Nothing - , _ctuComputedClickThroughURL = Nothing - , _ctuCustomClickThroughURL = Nothing - , _ctuLandingPageId = Nothing - } - --- | Whether the campaign default landing page is used. -ctuDefaultLandingPage :: Lens' ClickThroughURL (Maybe Bool) -ctuDefaultLandingPage - = lens _ctuDefaultLandingPage - (\ s a -> s{_ctuDefaultLandingPage = a}) - --- | Read-only convenience field representing the actual URL that will be --- used for this click-through. The URL is computed as follows: - If --- defaultLandingPage is enabled then the campaign\'s default landing page --- URL is assigned to this field. - If defaultLandingPage is not enabled --- and a landingPageId is specified then that landing page\'s URL is --- assigned to this field. - If neither of the above cases apply, then the --- customClickThroughUrl is assigned to this field. -ctuComputedClickThroughURL :: Lens' ClickThroughURL (Maybe Text) -ctuComputedClickThroughURL - = lens _ctuComputedClickThroughURL - (\ s a -> s{_ctuComputedClickThroughURL = a}) - --- | Custom click-through URL. Applicable if the defaultLandingPage field is --- set to false and the landingPageId field is left unset. -ctuCustomClickThroughURL :: Lens' ClickThroughURL (Maybe Text) -ctuCustomClickThroughURL - = lens _ctuCustomClickThroughURL - (\ s a -> s{_ctuCustomClickThroughURL = a}) - --- | ID of the landing page for the click-through URL. Applicable if the --- defaultLandingPage field is set to false. -ctuLandingPageId :: Lens' ClickThroughURL (Maybe Int64) -ctuLandingPageId - = lens _ctuLandingPageId - (\ s a -> s{_ctuLandingPageId = a}) - . mapping _Coerce - -instance FromJSON ClickThroughURL where - parseJSON - = withObject "ClickThroughURL" - (\ o -> - ClickThroughURL' <$> - (o .:? "defaultLandingPage") <*> - (o .:? "computedClickThroughUrl") - <*> (o .:? "customClickThroughUrl") - <*> (o .:? "landingPageId")) - -instance ToJSON ClickThroughURL where - toJSON ClickThroughURL'{..} - = object - (catMaybes - [("defaultLandingPage" .=) <$> - _ctuDefaultLandingPage, - ("computedClickThroughUrl" .=) <$> - _ctuComputedClickThroughURL, - ("customClickThroughUrl" .=) <$> - _ctuCustomClickThroughURL, - ("landingPageId" .=) <$> _ctuLandingPageId]) - --- | Browser List Response --- --- /See:/ 'browsersListResponse' smart constructor. -data BrowsersListResponse = BrowsersListResponse' - { _blrKind :: !Text - , _blrBrowsers :: !(Maybe [Browser]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'BrowsersListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'blrKind' --- --- * 'blrBrowsers' -browsersListResponse - :: BrowsersListResponse -browsersListResponse = - BrowsersListResponse' - { _blrKind = "dfareporting#browsersListResponse" - , _blrBrowsers = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#browsersListResponse\". -blrKind :: Lens' BrowsersListResponse Text -blrKind = lens _blrKind (\ s a -> s{_blrKind = a}) - --- | Browser collection. -blrBrowsers :: Lens' BrowsersListResponse [Browser] -blrBrowsers - = lens _blrBrowsers (\ s a -> s{_blrBrowsers = a}) . - _Default - . _Coerce - -instance FromJSON BrowsersListResponse where - parseJSON - = withObject "BrowsersListResponse" - (\ o -> - BrowsersListResponse' <$> - (o .:? "kind" .!= - "dfareporting#browsersListResponse") - <*> (o .:? "browsers" .!= mempty)) - -instance ToJSON BrowsersListResponse where - toJSON BrowsersListResponse'{..} - = object - (catMaybes - [Just ("kind" .= _blrKind), - ("browsers" .=) <$> _blrBrowsers]) - --- | Site Settings --- --- /See:/ 'siteSettings' smart constructor. -data SiteSettings = SiteSettings' - { _ssDisableNewCookie :: !(Maybe Bool) - , _ssVideoActiveViewOptOutTemplate :: !(Maybe Bool) - , _ssAdBlockingOptOut :: !(Maybe Bool) - , _ssLookbackConfiguration :: !(Maybe LookbackConfiguration) - , _ssTagSetting :: !(Maybe TagSetting) - , _ssActiveViewOptOut :: !(Maybe Bool) - , _ssVpaidAdapterChoiceTemplate :: !(Maybe SiteSettingsVpaidAdapterChoiceTemplate) - , _ssCreativeSettings :: !(Maybe CreativeSettings) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'SiteSettings' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'ssDisableNewCookie' --- --- * 'ssVideoActiveViewOptOutTemplate' --- --- * 'ssAdBlockingOptOut' --- --- * 'ssLookbackConfiguration' --- --- * 'ssTagSetting' --- --- * 'ssActiveViewOptOut' --- --- * 'ssVpaidAdapterChoiceTemplate' --- --- * 'ssCreativeSettings' -siteSettings - :: SiteSettings -siteSettings = - SiteSettings' - { _ssDisableNewCookie = Nothing - , _ssVideoActiveViewOptOutTemplate = Nothing - , _ssAdBlockingOptOut = Nothing - , _ssLookbackConfiguration = Nothing - , _ssTagSetting = Nothing - , _ssActiveViewOptOut = Nothing - , _ssVpaidAdapterChoiceTemplate = Nothing - , _ssCreativeSettings = Nothing - } - --- | Whether new cookies are disabled for this site. -ssDisableNewCookie :: Lens' SiteSettings (Maybe Bool) -ssDisableNewCookie - = lens _ssDisableNewCookie - (\ s a -> s{_ssDisableNewCookie = a}) - --- | Whether Verification and ActiveView for in-stream video creatives are --- disabled by default for new placements created under this site. This --- value will be used to populate the placement.videoActiveViewOptOut --- field, when no value is specified for the new placement. -ssVideoActiveViewOptOutTemplate :: Lens' SiteSettings (Maybe Bool) -ssVideoActiveViewOptOutTemplate - = lens _ssVideoActiveViewOptOutTemplate - (\ s a -> s{_ssVideoActiveViewOptOutTemplate = a}) - --- | Whether this site opts out of ad blocking. When true, ad blocking is --- disabled for all placements under the site, regardless of the individual --- placement settings. When false, the campaign and placement settings take --- effect. -ssAdBlockingOptOut :: Lens' SiteSettings (Maybe Bool) -ssAdBlockingOptOut - = lens _ssAdBlockingOptOut - (\ s a -> s{_ssAdBlockingOptOut = a}) - --- | Lookback window settings for this site. -ssLookbackConfiguration :: Lens' SiteSettings (Maybe LookbackConfiguration) -ssLookbackConfiguration - = lens _ssLookbackConfiguration - (\ s a -> s{_ssLookbackConfiguration = a}) - --- | Configuration settings for dynamic and image floodlight tags. -ssTagSetting :: Lens' SiteSettings (Maybe TagSetting) -ssTagSetting - = lens _ssTagSetting (\ s a -> s{_ssTagSetting = a}) - --- | Whether active view creatives are disabled for this site. -ssActiveViewOptOut :: Lens' SiteSettings (Maybe Bool) -ssActiveViewOptOut - = lens _ssActiveViewOptOut - (\ s a -> s{_ssActiveViewOptOut = a}) - --- | Default VPAID adapter setting for new placements created under this --- site. This value will be used to populate the --- placements.vpaidAdapterChoice field, when no value is specified for the --- new placement. Controls which VPAID format the measurement adapter will --- use for in-stream video creatives assigned to the placement. The --- publisher\'s specifications will typically determine this setting. For --- VPAID creatives, the adapter format will match the VPAID format (HTML5 --- VPAID creatives use the HTML5 adapter). Note: Flash is no longer --- supported. This field now defaults to HTML5 when the following values --- are provided: FLASH, BOTH. -ssVpaidAdapterChoiceTemplate :: Lens' SiteSettings (Maybe SiteSettingsVpaidAdapterChoiceTemplate) -ssVpaidAdapterChoiceTemplate - = lens _ssVpaidAdapterChoiceTemplate - (\ s a -> s{_ssVpaidAdapterChoiceTemplate = a}) - --- | Site-wide creative settings. -ssCreativeSettings :: Lens' SiteSettings (Maybe CreativeSettings) -ssCreativeSettings - = lens _ssCreativeSettings - (\ s a -> s{_ssCreativeSettings = a}) - -instance FromJSON SiteSettings where - parseJSON - = withObject "SiteSettings" - (\ o -> - SiteSettings' <$> - (o .:? "disableNewCookie") <*> - (o .:? "videoActiveViewOptOutTemplate") - <*> (o .:? "adBlockingOptOut") - <*> (o .:? "lookbackConfiguration") - <*> (o .:? "tagSetting") - <*> (o .:? "activeViewOptOut") - <*> (o .:? "vpaidAdapterChoiceTemplate") - <*> (o .:? "creativeSettings")) - -instance ToJSON SiteSettings where - toJSON SiteSettings'{..} - = object - (catMaybes - [("disableNewCookie" .=) <$> _ssDisableNewCookie, - ("videoActiveViewOptOutTemplate" .=) <$> - _ssVideoActiveViewOptOutTemplate, - ("adBlockingOptOut" .=) <$> _ssAdBlockingOptOut, - ("lookbackConfiguration" .=) <$> - _ssLookbackConfiguration, - ("tagSetting" .=) <$> _ssTagSetting, - ("activeViewOptOut" .=) <$> _ssActiveViewOptOut, - ("vpaidAdapterChoiceTemplate" .=) <$> - _ssVpaidAdapterChoiceTemplate, - ("creativeSettings" .=) <$> _ssCreativeSettings]) - --- | Content Category List Response --- --- /See:/ 'contentCategoriesListResponse' smart constructor. -data ContentCategoriesListResponse = ContentCategoriesListResponse' - { _cclrNextPageToken :: !(Maybe Text) - , _cclrKind :: !Text - , _cclrContentCategories :: !(Maybe [ContentCategory]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'ContentCategoriesListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'cclrNextPageToken' --- --- * 'cclrKind' --- --- * 'cclrContentCategories' -contentCategoriesListResponse - :: ContentCategoriesListResponse -contentCategoriesListResponse = - ContentCategoriesListResponse' - { _cclrNextPageToken = Nothing - , _cclrKind = "dfareporting#contentCategoriesListResponse" - , _cclrContentCategories = Nothing - } - --- | Pagination token to be used for the next list operation. -cclrNextPageToken :: Lens' ContentCategoriesListResponse (Maybe Text) -cclrNextPageToken - = lens _cclrNextPageToken - (\ s a -> s{_cclrNextPageToken = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#contentCategoriesListResponse\". -cclrKind :: Lens' ContentCategoriesListResponse Text -cclrKind = lens _cclrKind (\ s a -> s{_cclrKind = a}) - --- | Content category collection. -cclrContentCategories :: Lens' ContentCategoriesListResponse [ContentCategory] -cclrContentCategories - = lens _cclrContentCategories - (\ s a -> s{_cclrContentCategories = a}) - . _Default - . _Coerce - -instance FromJSON ContentCategoriesListResponse where - parseJSON - = withObject "ContentCategoriesListResponse" - (\ o -> - ContentCategoriesListResponse' <$> - (o .:? "nextPageToken") <*> - (o .:? "kind" .!= - "dfareporting#contentCategoriesListResponse") - <*> (o .:? "contentCategories" .!= mempty)) - -instance ToJSON ContentCategoriesListResponse where - toJSON ContentCategoriesListResponse'{..} - = object - (catMaybes - [("nextPageToken" .=) <$> _cclrNextPageToken, - Just ("kind" .= _cclrKind), - ("contentCategories" .=) <$> _cclrContentCategories]) - --- | Creative List Response --- --- /See:/ 'creativesListResponse' smart constructor. -data CreativesListResponse = CreativesListResponse' - { _clrlNextPageToken :: !(Maybe Text) - , _clrlKind :: !Text - , _clrlCreatives :: !(Maybe [Creative]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'CreativesListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'clrlNextPageToken' --- --- * 'clrlKind' --- --- * 'clrlCreatives' -creativesListResponse - :: CreativesListResponse -creativesListResponse = - CreativesListResponse' - { _clrlNextPageToken = Nothing - , _clrlKind = "dfareporting#creativesListResponse" - , _clrlCreatives = Nothing - } - --- | Pagination token to be used for the next list operation. -clrlNextPageToken :: Lens' CreativesListResponse (Maybe Text) -clrlNextPageToken - = lens _clrlNextPageToken - (\ s a -> s{_clrlNextPageToken = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#creativesListResponse\". -clrlKind :: Lens' CreativesListResponse Text -clrlKind = lens _clrlKind (\ s a -> s{_clrlKind = a}) - --- | Creative collection. -clrlCreatives :: Lens' CreativesListResponse [Creative] -clrlCreatives - = lens _clrlCreatives - (\ s a -> s{_clrlCreatives = a}) - . _Default - . _Coerce - -instance FromJSON CreativesListResponse where - parseJSON - = withObject "CreativesListResponse" - (\ o -> - CreativesListResponse' <$> - (o .:? "nextPageToken") <*> - (o .:? "kind" .!= - "dfareporting#creativesListResponse") - <*> (o .:? "creatives" .!= mempty)) - -instance ToJSON CreativesListResponse where - toJSON CreativesListResponse'{..} - = object - (catMaybes - [("nextPageToken" .=) <$> _clrlNextPageToken, - Just ("kind" .= _clrlKind), - ("creatives" .=) <$> _clrlCreatives]) - --- | Contains properties of a Campaign Manager account. --- --- /See:/ 'account' smart constructor. -data Account = Account' - { _aaAccountPermissionIds :: !(Maybe [Textual Int64]) - , _aaMaximumImageSize :: !(Maybe (Textual Int64)) - , _aaCurrencyId :: !(Maybe (Textual Int64)) - , _aaReportsConfiguration :: !(Maybe ReportsConfiguration) - , _aaNielsenOCREnabled :: !(Maybe Bool) - , _aaKind :: !Text - , _aaLocale :: !(Maybe Text) - , _aaActive :: !(Maybe Bool) - , _aaAvailablePermissionIds :: !(Maybe [Textual Int64]) - , _aaTeaserSizeLimit :: !(Maybe (Textual Int64)) - , _aaActiveViewOptOut :: !(Maybe Bool) - , _aaShareReportsWithTwitter :: !(Maybe Bool) - , _aaName :: !(Maybe Text) - , _aaAccountProFile :: !(Maybe AccountAccountProFile) - , _aaId :: !(Maybe (Textual Int64)) - , _aaCountryId :: !(Maybe (Textual Int64)) - , _aaActiveAdsLimitTier :: !(Maybe AccountActiveAdsLimitTier) - , _aaDefaultCreativeSizeId :: !(Maybe (Textual Int64)) - , _aaDescription :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'Account' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'aaAccountPermissionIds' --- --- * 'aaMaximumImageSize' --- --- * 'aaCurrencyId' --- --- * 'aaReportsConfiguration' --- --- * 'aaNielsenOCREnabled' --- --- * 'aaKind' --- --- * 'aaLocale' --- --- * 'aaActive' --- --- * 'aaAvailablePermissionIds' --- --- * 'aaTeaserSizeLimit' --- --- * 'aaActiveViewOptOut' --- --- * 'aaShareReportsWithTwitter' --- --- * 'aaName' --- --- * 'aaAccountProFile' --- --- * 'aaId' --- --- * 'aaCountryId' --- --- * 'aaActiveAdsLimitTier' --- --- * 'aaDefaultCreativeSizeId' --- --- * 'aaDescription' -account - :: Account -account = - Account' - { _aaAccountPermissionIds = Nothing - , _aaMaximumImageSize = Nothing - , _aaCurrencyId = Nothing - , _aaReportsConfiguration = Nothing - , _aaNielsenOCREnabled = Nothing - , _aaKind = "dfareporting#account" - , _aaLocale = Nothing - , _aaActive = Nothing - , _aaAvailablePermissionIds = Nothing - , _aaTeaserSizeLimit = Nothing - , _aaActiveViewOptOut = Nothing - , _aaShareReportsWithTwitter = Nothing - , _aaName = Nothing - , _aaAccountProFile = Nothing - , _aaId = Nothing - , _aaCountryId = Nothing - , _aaActiveAdsLimitTier = Nothing - , _aaDefaultCreativeSizeId = Nothing - , _aaDescription = Nothing - } - --- | Account permissions assigned to this account. -aaAccountPermissionIds :: Lens' Account [Int64] -aaAccountPermissionIds - = lens _aaAccountPermissionIds - (\ s a -> s{_aaAccountPermissionIds = a}) - . _Default - . _Coerce - --- | Maximum image size allowed for this account, in kilobytes. Value must be --- greater than or equal to 1. -aaMaximumImageSize :: Lens' Account (Maybe Int64) -aaMaximumImageSize - = lens _aaMaximumImageSize - (\ s a -> s{_aaMaximumImageSize = a}) - . mapping _Coerce - --- | ID of currency associated with this account. This is a required field. --- Acceptable values are: - \"1\" for USD - \"2\" for GBP - \"3\" for ESP - --- \"4\" for SEK - \"5\" for CAD - \"6\" for JPY - \"7\" for DEM - \"8\" --- for AUD - \"9\" for FRF - \"10\" for ITL - \"11\" for DKK - \"12\" for --- NOK - \"13\" for FIM - \"14\" for ZAR - \"15\" for IEP - \"16\" for NLG --- - \"17\" for EUR - \"18\" for KRW - \"19\" for TWD - \"20\" for SGD - --- \"21\" for CNY - \"22\" for HKD - \"23\" for NZD - \"24\" for MYR - --- \"25\" for BRL - \"26\" for PTE - \"27\" for MXP - \"28\" for CLP - --- \"29\" for TRY - \"30\" for ARS - \"31\" for PEN - \"32\" for ILS - --- \"33\" for CHF - \"34\" for VEF - \"35\" for COP - \"36\" for GTQ - --- \"37\" for PLN - \"39\" for INR - \"40\" for THB - \"41\" for IDR - --- \"42\" for CZK - \"43\" for RON - \"44\" for HUF - \"45\" for RUB - --- \"46\" for AED - \"47\" for BGN - \"48\" for HRK - \"49\" for MXN - --- \"50\" for NGN -aaCurrencyId :: Lens' Account (Maybe Int64) -aaCurrencyId - = lens _aaCurrencyId (\ s a -> s{_aaCurrencyId = a}) - . mapping _Coerce - --- | Reporting configuration of this account. -aaReportsConfiguration :: Lens' Account (Maybe ReportsConfiguration) -aaReportsConfiguration - = lens _aaReportsConfiguration - (\ s a -> s{_aaReportsConfiguration = a}) - --- | Whether campaigns created in this account will be enabled for Nielsen --- OCR reach ratings by default. -aaNielsenOCREnabled :: Lens' Account (Maybe Bool) -aaNielsenOCREnabled - = lens _aaNielsenOCREnabled - (\ s a -> s{_aaNielsenOCREnabled = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#account\". -aaKind :: Lens' Account Text -aaKind = lens _aaKind (\ s a -> s{_aaKind = a}) - --- | Locale of this account. Acceptable values are: - \"cs\" (Czech) - \"de\" --- (German) - \"en\" (English) - \"en-GB\" (English United Kingdom) - --- \"es\" (Spanish) - \"fr\" (French) - \"it\" (Italian) - \"ja\" --- (Japanese) - \"ko\" (Korean) - \"pl\" (Polish) - \"pt-BR\" (Portuguese --- Brazil) - \"ru\" (Russian) - \"sv\" (Swedish) - \"tr\" (Turkish) - --- \"zh-CN\" (Chinese Simplified) - \"zh-TW\" (Chinese Traditional) -aaLocale :: Lens' Account (Maybe Text) -aaLocale = lens _aaLocale (\ s a -> s{_aaLocale = a}) - --- | Whether this account is active. -aaActive :: Lens' Account (Maybe Bool) -aaActive = lens _aaActive (\ s a -> s{_aaActive = a}) - --- | User role permissions available to the user roles of this account. -aaAvailablePermissionIds :: Lens' Account [Int64] -aaAvailablePermissionIds - = lens _aaAvailablePermissionIds - (\ s a -> s{_aaAvailablePermissionIds = a}) - . _Default - . _Coerce - --- | File size limit in kilobytes of Rich Media teaser creatives. Acceptable --- values are 1 to 10240, inclusive. -aaTeaserSizeLimit :: Lens' Account (Maybe Int64) -aaTeaserSizeLimit - = lens _aaTeaserSizeLimit - (\ s a -> s{_aaTeaserSizeLimit = a}) - . mapping _Coerce - --- | Whether to serve creatives with Active View tags. If disabled, --- viewability data will not be available for any impressions. -aaActiveViewOptOut :: Lens' Account (Maybe Bool) -aaActiveViewOptOut - = lens _aaActiveViewOptOut - (\ s a -> s{_aaActiveViewOptOut = a}) - --- | Share Path to Conversion reports with Twitter. -aaShareReportsWithTwitter :: Lens' Account (Maybe Bool) -aaShareReportsWithTwitter - = lens _aaShareReportsWithTwitter - (\ s a -> s{_aaShareReportsWithTwitter = a}) - --- | Name of this account. This is a required field, and must be less than --- 128 characters long and be globally unique. -aaName :: Lens' Account (Maybe Text) -aaName = lens _aaName (\ s a -> s{_aaName = a}) - --- | Profile for this account. This is a read-only field that can be left --- blank. -aaAccountProFile :: Lens' Account (Maybe AccountAccountProFile) -aaAccountProFile - = lens _aaAccountProFile - (\ s a -> s{_aaAccountProFile = a}) - --- | ID of this account. This is a read-only, auto-generated field. -aaId :: Lens' Account (Maybe Int64) -aaId - = lens _aaId (\ s a -> s{_aaId = a}) . - mapping _Coerce - --- | ID of the country associated with this account. -aaCountryId :: Lens' Account (Maybe Int64) -aaCountryId - = lens _aaCountryId (\ s a -> s{_aaCountryId = a}) . - mapping _Coerce - --- | Maximum number of active ads allowed for this account. -aaActiveAdsLimitTier :: Lens' Account (Maybe AccountActiveAdsLimitTier) -aaActiveAdsLimitTier - = lens _aaActiveAdsLimitTier - (\ s a -> s{_aaActiveAdsLimitTier = a}) - --- | Default placement dimensions for this account. -aaDefaultCreativeSizeId :: Lens' Account (Maybe Int64) -aaDefaultCreativeSizeId - = lens _aaDefaultCreativeSizeId - (\ s a -> s{_aaDefaultCreativeSizeId = a}) - . mapping _Coerce - --- | Description of this account. -aaDescription :: Lens' Account (Maybe Text) -aaDescription - = lens _aaDescription - (\ s a -> s{_aaDescription = a}) - -instance FromJSON Account where - parseJSON - = withObject "Account" - (\ o -> - Account' <$> - (o .:? "accountPermissionIds" .!= mempty) <*> - (o .:? "maximumImageSize") - <*> (o .:? "currencyId") - <*> (o .:? "reportsConfiguration") - <*> (o .:? "nielsenOcrEnabled") - <*> (o .:? "kind" .!= "dfareporting#account") - <*> (o .:? "locale") - <*> (o .:? "active") - <*> (o .:? "availablePermissionIds" .!= mempty) - <*> (o .:? "teaserSizeLimit") - <*> (o .:? "activeViewOptOut") - <*> (o .:? "shareReportsWithTwitter") - <*> (o .:? "name") - <*> (o .:? "accountProfile") - <*> (o .:? "id") - <*> (o .:? "countryId") - <*> (o .:? "activeAdsLimitTier") - <*> (o .:? "defaultCreativeSizeId") - <*> (o .:? "description")) - -instance ToJSON Account where - toJSON Account'{..} - = object - (catMaybes - [("accountPermissionIds" .=) <$> - _aaAccountPermissionIds, - ("maximumImageSize" .=) <$> _aaMaximumImageSize, - ("currencyId" .=) <$> _aaCurrencyId, - ("reportsConfiguration" .=) <$> - _aaReportsConfiguration, - ("nielsenOcrEnabled" .=) <$> _aaNielsenOCREnabled, - Just ("kind" .= _aaKind), - ("locale" .=) <$> _aaLocale, - ("active" .=) <$> _aaActive, - ("availablePermissionIds" .=) <$> - _aaAvailablePermissionIds, - ("teaserSizeLimit" .=) <$> _aaTeaserSizeLimit, - ("activeViewOptOut" .=) <$> _aaActiveViewOptOut, - ("shareReportsWithTwitter" .=) <$> - _aaShareReportsWithTwitter, - ("name" .=) <$> _aaName, - ("accountProfile" .=) <$> _aaAccountProFile, - ("id" .=) <$> _aaId, - ("countryId" .=) <$> _aaCountryId, - ("activeAdsLimitTier" .=) <$> _aaActiveAdsLimitTier, - ("defaultCreativeSizeId" .=) <$> - _aaDefaultCreativeSizeId, - ("description" .=) <$> _aaDescription]) - --- | Insert Conversions Request. --- --- /See:/ 'conversionsBatchInsertRequest' smart constructor. -data ConversionsBatchInsertRequest = ConversionsBatchInsertRequest' - { _cbirKind :: !Text - , _cbirConversions :: !(Maybe [Conversion]) - , _cbirEncryptionInfo :: !(Maybe EncryptionInfo) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'ConversionsBatchInsertRequest' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'cbirKind' --- --- * 'cbirConversions' --- --- * 'cbirEncryptionInfo' -conversionsBatchInsertRequest - :: ConversionsBatchInsertRequest -conversionsBatchInsertRequest = - ConversionsBatchInsertRequest' - { _cbirKind = "dfareporting#conversionsBatchInsertRequest" - , _cbirConversions = Nothing - , _cbirEncryptionInfo = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#conversionsBatchInsertRequest\". -cbirKind :: Lens' ConversionsBatchInsertRequest Text -cbirKind = lens _cbirKind (\ s a -> s{_cbirKind = a}) - --- | The set of conversions to insert. -cbirConversions :: Lens' ConversionsBatchInsertRequest [Conversion] -cbirConversions - = lens _cbirConversions - (\ s a -> s{_cbirConversions = a}) - . _Default - . _Coerce - --- | Describes how encryptedUserId or encryptedUserIdCandidates[] is --- encrypted. This is a required field if encryptedUserId or --- encryptedUserIdCandidates[] is used. -cbirEncryptionInfo :: Lens' ConversionsBatchInsertRequest (Maybe EncryptionInfo) -cbirEncryptionInfo - = lens _cbirEncryptionInfo - (\ s a -> s{_cbirEncryptionInfo = a}) - -instance FromJSON ConversionsBatchInsertRequest where - parseJSON - = withObject "ConversionsBatchInsertRequest" - (\ o -> - ConversionsBatchInsertRequest' <$> - (o .:? "kind" .!= - "dfareporting#conversionsBatchInsertRequest") - <*> (o .:? "conversions" .!= mempty) - <*> (o .:? "encryptionInfo")) - -instance ToJSON ConversionsBatchInsertRequest where - toJSON ConversionsBatchInsertRequest'{..} - = object - (catMaybes - [Just ("kind" .= _cbirKind), - ("conversions" .=) <$> _cbirConversions, - ("encryptionInfo" .=) <$> _cbirEncryptionInfo]) - --- | Account User Profile List Response --- --- /See:/ 'accountUserProFilesListResponse' smart constructor. -data AccountUserProFilesListResponse = AccountUserProFilesListResponse' - { _aupflrNextPageToken :: !(Maybe Text) - , _aupflrAccountUserProFiles :: !(Maybe [AccountUserProFile]) - , _aupflrKind :: !Text - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'AccountUserProFilesListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'aupflrNextPageToken' --- --- * 'aupflrAccountUserProFiles' --- --- * 'aupflrKind' -accountUserProFilesListResponse - :: AccountUserProFilesListResponse -accountUserProFilesListResponse = - AccountUserProFilesListResponse' - { _aupflrNextPageToken = Nothing - , _aupflrAccountUserProFiles = Nothing - , _aupflrKind = "dfareporting#accountUserProfilesListResponse" - } - --- | Pagination token to be used for the next list operation. -aupflrNextPageToken :: Lens' AccountUserProFilesListResponse (Maybe Text) -aupflrNextPageToken - = lens _aupflrNextPageToken - (\ s a -> s{_aupflrNextPageToken = a}) - --- | Account user profile collection. -aupflrAccountUserProFiles :: Lens' AccountUserProFilesListResponse [AccountUserProFile] -aupflrAccountUserProFiles - = lens _aupflrAccountUserProFiles - (\ s a -> s{_aupflrAccountUserProFiles = a}) - . _Default - . _Coerce - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#accountUserProfilesListResponse\". -aupflrKind :: Lens' AccountUserProFilesListResponse Text -aupflrKind - = lens _aupflrKind (\ s a -> s{_aupflrKind = a}) - -instance FromJSON AccountUserProFilesListResponse - where - parseJSON - = withObject "AccountUserProFilesListResponse" - (\ o -> - AccountUserProFilesListResponse' <$> - (o .:? "nextPageToken") <*> - (o .:? "accountUserProfiles" .!= mempty) - <*> - (o .:? "kind" .!= - "dfareporting#accountUserProfilesListResponse")) - -instance ToJSON AccountUserProFilesListResponse where - toJSON AccountUserProFilesListResponse'{..} - = object - (catMaybes - [("nextPageToken" .=) <$> _aupflrNextPageToken, - ("accountUserProfiles" .=) <$> - _aupflrAccountUserProFiles, - Just ("kind" .= _aupflrKind)]) - --- | Organizes placements according to the contents of their associated --- webpages. --- --- /See:/ 'contentCategory' smart constructor. -data ContentCategory = ContentCategory' - { _conKind :: !Text - , _conAccountId :: !(Maybe (Textual Int64)) - , _conName :: !(Maybe Text) - , _conId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'ContentCategory' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'conKind' --- --- * 'conAccountId' --- --- * 'conName' --- --- * 'conId' -contentCategory - :: ContentCategory -contentCategory = - ContentCategory' - { _conKind = "dfareporting#contentCategory" - , _conAccountId = Nothing - , _conName = Nothing - , _conId = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#contentCategory\". -conKind :: Lens' ContentCategory Text -conKind = lens _conKind (\ s a -> s{_conKind = a}) - --- | Account ID of this content category. This is a read-only field that can --- be left blank. -conAccountId :: Lens' ContentCategory (Maybe Int64) -conAccountId - = lens _conAccountId (\ s a -> s{_conAccountId = a}) - . mapping _Coerce - --- | Name of this content category. This is a required field and must be less --- than 256 characters long and unique among content categories of the same --- account. -conName :: Lens' ContentCategory (Maybe Text) -conName = lens _conName (\ s a -> s{_conName = a}) - --- | ID of this content category. This is a read-only, auto-generated field. -conId :: Lens' ContentCategory (Maybe Int64) -conId - = lens _conId (\ s a -> s{_conId = a}) . - mapping _Coerce - -instance FromJSON ContentCategory where - parseJSON - = withObject "ContentCategory" - (\ o -> - ContentCategory' <$> - (o .:? "kind" .!= "dfareporting#contentCategory") <*> - (o .:? "accountId") - <*> (o .:? "name") - <*> (o .:? "id")) - -instance ToJSON ContentCategory where - toJSON ContentCategory'{..} - = object - (catMaybes - [Just ("kind" .= _conKind), - ("accountId" .=) <$> _conAccountId, - ("name" .=) <$> _conName, ("id" .=) <$> _conId]) - --- | Represents fields that are compatible to be selected for a report of --- type \"STANDARD\". --- --- /See:/ 'reportCompatibleFields' smart constructor. -data ReportCompatibleFields = ReportCompatibleFields' - { _rcfMetrics :: !(Maybe [Metric]) - , _rcfKind :: !Text - , _rcfDimensionFilters :: !(Maybe [Dimension]) - , _rcfPivotedActivityMetrics :: !(Maybe [Metric]) - , _rcfDimensions :: !(Maybe [Dimension]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'ReportCompatibleFields' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'rcfMetrics' --- --- * 'rcfKind' --- --- * 'rcfDimensionFilters' --- --- * 'rcfPivotedActivityMetrics' --- --- * 'rcfDimensions' -reportCompatibleFields - :: ReportCompatibleFields -reportCompatibleFields = - ReportCompatibleFields' - { _rcfMetrics = Nothing - , _rcfKind = "dfareporting#reportCompatibleFields" - , _rcfDimensionFilters = Nothing - , _rcfPivotedActivityMetrics = Nothing - , _rcfDimensions = Nothing - } - --- | Metrics which are compatible to be selected in the \"metricNames\" --- section of the report. -rcfMetrics :: Lens' ReportCompatibleFields [Metric] -rcfMetrics - = lens _rcfMetrics (\ s a -> s{_rcfMetrics = a}) . - _Default - . _Coerce - --- | The kind of resource this is, in this case --- dfareporting#reportCompatibleFields. -rcfKind :: Lens' ReportCompatibleFields Text -rcfKind = lens _rcfKind (\ s a -> s{_rcfKind = a}) - --- | Dimensions which are compatible to be selected in the --- \"dimensionFilters\" section of the report. -rcfDimensionFilters :: Lens' ReportCompatibleFields [Dimension] -rcfDimensionFilters - = lens _rcfDimensionFilters - (\ s a -> s{_rcfDimensionFilters = a}) - . _Default - . _Coerce - --- | Metrics which are compatible to be selected as activity metrics to pivot --- on in the \"activities\" section of the report. -rcfPivotedActivityMetrics :: Lens' ReportCompatibleFields [Metric] -rcfPivotedActivityMetrics - = lens _rcfPivotedActivityMetrics - (\ s a -> s{_rcfPivotedActivityMetrics = a}) - . _Default - . _Coerce - --- | Dimensions which are compatible to be selected in the \"dimensions\" --- section of the report. -rcfDimensions :: Lens' ReportCompatibleFields [Dimension] -rcfDimensions - = lens _rcfDimensions - (\ s a -> s{_rcfDimensions = a}) - . _Default - . _Coerce - -instance FromJSON ReportCompatibleFields where - parseJSON - = withObject "ReportCompatibleFields" - (\ o -> - ReportCompatibleFields' <$> - (o .:? "metrics" .!= mempty) <*> - (o .:? "kind" .!= - "dfareporting#reportCompatibleFields") - <*> (o .:? "dimensionFilters" .!= mempty) - <*> (o .:? "pivotedActivityMetrics" .!= mempty) - <*> (o .:? "dimensions" .!= mempty)) - -instance ToJSON ReportCompatibleFields where - toJSON ReportCompatibleFields'{..} - = object - (catMaybes - [("metrics" .=) <$> _rcfMetrics, - Just ("kind" .= _rcfKind), - ("dimensionFilters" .=) <$> _rcfDimensionFilters, - ("pivotedActivityMetrics" .=) <$> - _rcfPivotedActivityMetrics, - ("dimensions" .=) <$> _rcfDimensions]) - --- | Delivery Schedule. --- --- /See:/ 'deliverySchedule' smart constructor. -data DeliverySchedule = DeliverySchedule' - { _dsHardCutoff :: !(Maybe Bool) - , _dsPriority :: !(Maybe DeliverySchedulePriority) - , _dsImpressionRatio :: !(Maybe (Textual Int64)) - , _dsFrequencyCap :: !(Maybe FrequencyCap) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'DeliverySchedule' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'dsHardCutoff' --- --- * 'dsPriority' --- --- * 'dsImpressionRatio' --- --- * 'dsFrequencyCap' -deliverySchedule - :: DeliverySchedule -deliverySchedule = - DeliverySchedule' - { _dsHardCutoff = Nothing - , _dsPriority = Nothing - , _dsImpressionRatio = Nothing - , _dsFrequencyCap = Nothing - } - --- | Whether or not hard cutoff is enabled. If true, the ad will not serve --- after the end date and time. Otherwise the ad will continue to be served --- until it has reached its delivery goals. -dsHardCutoff :: Lens' DeliverySchedule (Maybe Bool) -dsHardCutoff - = lens _dsHardCutoff (\ s a -> s{_dsHardCutoff = a}) - --- | Serving priority of an ad, with respect to other ads. The lower the --- priority number, the greater the priority with which it is served. -dsPriority :: Lens' DeliverySchedule (Maybe DeliverySchedulePriority) -dsPriority - = lens _dsPriority (\ s a -> s{_dsPriority = a}) - --- | Impression ratio for this ad. This ratio determines how often each ad is --- served relative to the others. For example, if ad A has an impression --- ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager --- will serve ad B three times as often as ad A. Acceptable values are 1 to --- 10, inclusive. -dsImpressionRatio :: Lens' DeliverySchedule (Maybe Int64) -dsImpressionRatio - = lens _dsImpressionRatio - (\ s a -> s{_dsImpressionRatio = a}) - . mapping _Coerce - --- | Limit on the number of times an individual user can be served the ad --- within a specified period of time. -dsFrequencyCap :: Lens' DeliverySchedule (Maybe FrequencyCap) -dsFrequencyCap - = lens _dsFrequencyCap - (\ s a -> s{_dsFrequencyCap = a}) - -instance FromJSON DeliverySchedule where - parseJSON - = withObject "DeliverySchedule" - (\ o -> - DeliverySchedule' <$> - (o .:? "hardCutoff") <*> (o .:? "priority") <*> - (o .:? "impressionRatio") - <*> (o .:? "frequencyCap")) - -instance ToJSON DeliverySchedule where - toJSON DeliverySchedule'{..} - = object - (catMaybes - [("hardCutoff" .=) <$> _dsHardCutoff, - ("priority" .=) <$> _dsPriority, - ("impressionRatio" .=) <$> _dsImpressionRatio, - ("frequencyCap" .=) <$> _dsFrequencyCap]) - --- | Contains properties of a remarketing list. Remarketing enables you to --- create lists of users who have performed specific actions on a site, --- then target ads to members of those lists. This resource can be used to --- manage remarketing lists that are owned by your advertisers. To see all --- remarketing lists that are visible to your advertisers, including those --- that are shared to your advertiser or account, use the --- TargetableRemarketingLists resource. --- --- /See:/ 'remarketingList' smart constructor. -data RemarketingList = RemarketingList' - { _rlListSize :: !(Maybe (Textual Int64)) - , _rlListPopulationRule :: !(Maybe ListPopulationRule) - , _rlLifeSpan :: !(Maybe (Textual Int64)) - , _rlKind :: !Text - , _rlAdvertiserId :: !(Maybe (Textual Int64)) - , _rlAdvertiserIdDimensionValue :: !(Maybe DimensionValue) - , _rlActive :: !(Maybe Bool) - , _rlAccountId :: !(Maybe (Textual Int64)) - , _rlName :: !(Maybe Text) - , _rlListSource :: !(Maybe RemarketingListListSource) - , _rlId :: !(Maybe (Textual Int64)) - , _rlSubAccountId :: !(Maybe (Textual Int64)) - , _rlDescription :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'RemarketingList' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'rlListSize' --- --- * 'rlListPopulationRule' --- --- * 'rlLifeSpan' --- --- * 'rlKind' --- --- * 'rlAdvertiserId' --- --- * 'rlAdvertiserIdDimensionValue' --- --- * 'rlActive' --- --- * 'rlAccountId' --- --- * 'rlName' --- --- * 'rlListSource' --- --- * 'rlId' --- --- * 'rlSubAccountId' --- --- * 'rlDescription' -remarketingList - :: RemarketingList -remarketingList = - RemarketingList' - { _rlListSize = Nothing - , _rlListPopulationRule = Nothing - , _rlLifeSpan = Nothing - , _rlKind = "dfareporting#remarketingList" - , _rlAdvertiserId = Nothing - , _rlAdvertiserIdDimensionValue = Nothing - , _rlActive = Nothing - , _rlAccountId = Nothing - , _rlName = Nothing - , _rlListSource = Nothing - , _rlId = Nothing - , _rlSubAccountId = Nothing - , _rlDescription = Nothing - } - --- | Number of users currently in the list. This is a read-only field. -rlListSize :: Lens' RemarketingList (Maybe Int64) -rlListSize - = lens _rlListSize (\ s a -> s{_rlListSize = a}) . - mapping _Coerce - --- | Rule used to populate the remarketing list with users. -rlListPopulationRule :: Lens' RemarketingList (Maybe ListPopulationRule) -rlListPopulationRule - = lens _rlListPopulationRule - (\ s a -> s{_rlListPopulationRule = a}) - --- | Number of days that a user should remain in the remarketing list without --- an impression. Acceptable values are 1 to 540, inclusive. -rlLifeSpan :: Lens' RemarketingList (Maybe Int64) -rlLifeSpan - = lens _rlLifeSpan (\ s a -> s{_rlLifeSpan = a}) . - mapping _Coerce - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#remarketingList\". -rlKind :: Lens' RemarketingList Text -rlKind = lens _rlKind (\ s a -> s{_rlKind = a}) - --- | Dimension value for the advertiser ID that owns this remarketing list. --- This is a required field. -rlAdvertiserId :: Lens' RemarketingList (Maybe Int64) -rlAdvertiserId - = lens _rlAdvertiserId - (\ s a -> s{_rlAdvertiserId = a}) - . mapping _Coerce - --- | Dimension value for the ID of the advertiser. This is a read-only, --- auto-generated field. -rlAdvertiserIdDimensionValue :: Lens' RemarketingList (Maybe DimensionValue) -rlAdvertiserIdDimensionValue - = lens _rlAdvertiserIdDimensionValue - (\ s a -> s{_rlAdvertiserIdDimensionValue = a}) - --- | Whether this remarketing list is active. -rlActive :: Lens' RemarketingList (Maybe Bool) -rlActive = lens _rlActive (\ s a -> s{_rlActive = a}) - --- | Account ID of this remarketing list. This is a read-only, auto-generated --- field that is only returned in GET requests. -rlAccountId :: Lens' RemarketingList (Maybe Int64) -rlAccountId - = lens _rlAccountId (\ s a -> s{_rlAccountId = a}) . - mapping _Coerce - --- | Name of the remarketing list. This is a required field. Must be no --- greater than 128 characters long. -rlName :: Lens' RemarketingList (Maybe Text) -rlName = lens _rlName (\ s a -> s{_rlName = a}) - --- | Product from which this remarketing list was originated. -rlListSource :: Lens' RemarketingList (Maybe RemarketingListListSource) -rlListSource - = lens _rlListSource (\ s a -> s{_rlListSource = a}) - --- | Remarketing list ID. This is a read-only, auto-generated field. -rlId :: Lens' RemarketingList (Maybe Int64) -rlId - = lens _rlId (\ s a -> s{_rlId = a}) . - mapping _Coerce - --- | Subaccount ID of this remarketing list. This is a read-only, --- auto-generated field that is only returned in GET requests. -rlSubAccountId :: Lens' RemarketingList (Maybe Int64) -rlSubAccountId - = lens _rlSubAccountId - (\ s a -> s{_rlSubAccountId = a}) - . mapping _Coerce - --- | Remarketing list description. -rlDescription :: Lens' RemarketingList (Maybe Text) -rlDescription - = lens _rlDescription - (\ s a -> s{_rlDescription = a}) - -instance FromJSON RemarketingList where - parseJSON - = withObject "RemarketingList" - (\ o -> - RemarketingList' <$> - (o .:? "listSize") <*> (o .:? "listPopulationRule") - <*> (o .:? "lifeSpan") - <*> (o .:? "kind" .!= "dfareporting#remarketingList") - <*> (o .:? "advertiserId") - <*> (o .:? "advertiserIdDimensionValue") - <*> (o .:? "active") - <*> (o .:? "accountId") - <*> (o .:? "name") - <*> (o .:? "listSource") - <*> (o .:? "id") - <*> (o .:? "subaccountId") - <*> (o .:? "description")) - -instance ToJSON RemarketingList where - toJSON RemarketingList'{..} - = object - (catMaybes - [("listSize" .=) <$> _rlListSize, - ("listPopulationRule" .=) <$> _rlListPopulationRule, - ("lifeSpan" .=) <$> _rlLifeSpan, - Just ("kind" .= _rlKind), - ("advertiserId" .=) <$> _rlAdvertiserId, - ("advertiserIdDimensionValue" .=) <$> - _rlAdvertiserIdDimensionValue, - ("active" .=) <$> _rlActive, - ("accountId" .=) <$> _rlAccountId, - ("name" .=) <$> _rlName, - ("listSource" .=) <$> _rlListSource, - ("id" .=) <$> _rlId, - ("subaccountId" .=) <$> _rlSubAccountId, - ("description" .=) <$> _rlDescription]) - --- | Dynamic Targeting Key List Response --- --- /See:/ 'dynamicTargetingKeysListResponse' smart constructor. -data DynamicTargetingKeysListResponse = DynamicTargetingKeysListResponse' - { _dtklrKind :: !Text - , _dtklrDynamicTargetingKeys :: !(Maybe [DynamicTargetingKey]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'DynamicTargetingKeysListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'dtklrKind' --- --- * 'dtklrDynamicTargetingKeys' -dynamicTargetingKeysListResponse - :: DynamicTargetingKeysListResponse -dynamicTargetingKeysListResponse = - DynamicTargetingKeysListResponse' - { _dtklrKind = "dfareporting#dynamicTargetingKeysListResponse" - , _dtklrDynamicTargetingKeys = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#dynamicTargetingKeysListResponse\". -dtklrKind :: Lens' DynamicTargetingKeysListResponse Text -dtklrKind - = lens _dtklrKind (\ s a -> s{_dtklrKind = a}) - --- | Dynamic targeting key collection. -dtklrDynamicTargetingKeys :: Lens' DynamicTargetingKeysListResponse [DynamicTargetingKey] -dtklrDynamicTargetingKeys - = lens _dtklrDynamicTargetingKeys - (\ s a -> s{_dtklrDynamicTargetingKeys = a}) - . _Default - . _Coerce - -instance FromJSON DynamicTargetingKeysListResponse - where - parseJSON - = withObject "DynamicTargetingKeysListResponse" - (\ o -> - DynamicTargetingKeysListResponse' <$> - (o .:? "kind" .!= - "dfareporting#dynamicTargetingKeysListResponse") - <*> (o .:? "dynamicTargetingKeys" .!= mempty)) - -instance ToJSON DynamicTargetingKeysListResponse - where - toJSON DynamicTargetingKeysListResponse'{..} - = object - (catMaybes - [Just ("kind" .= _dtklrKind), - ("dynamicTargetingKeys" .=) <$> - _dtklrDynamicTargetingKeys]) - --- | Represents the list of DimensionValue resources. --- --- /See:/ 'dimensionValueList' smart constructor. -data DimensionValueList = DimensionValueList' - { _dvlEtag :: !(Maybe Text) - , _dvlNextPageToken :: !(Maybe Text) - , _dvlKind :: !Text - , _dvlItems :: !(Maybe [DimensionValue]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'DimensionValueList' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'dvlEtag' --- --- * 'dvlNextPageToken' --- --- * 'dvlKind' --- --- * 'dvlItems' -dimensionValueList - :: DimensionValueList -dimensionValueList = - DimensionValueList' - { _dvlEtag = Nothing - , _dvlNextPageToken = Nothing - , _dvlKind = "dfareporting#dimensionValueList" - , _dvlItems = Nothing - } - --- | The eTag of this response for caching purposes. -dvlEtag :: Lens' DimensionValueList (Maybe Text) -dvlEtag = lens _dvlEtag (\ s a -> s{_dvlEtag = a}) - --- | Continuation token used to page through dimension values. To retrieve --- the next page of results, set the next request\'s \"pageToken\" to the --- value of this field. The page token is only valid for a limited amount --- of time and should not be persisted. -dvlNextPageToken :: Lens' DimensionValueList (Maybe Text) -dvlNextPageToken - = lens _dvlNextPageToken - (\ s a -> s{_dvlNextPageToken = a}) - --- | The kind of list this is, in this case dfareporting#dimensionValueList. -dvlKind :: Lens' DimensionValueList Text -dvlKind = lens _dvlKind (\ s a -> s{_dvlKind = a}) - --- | The dimension values returned in this response. -dvlItems :: Lens' DimensionValueList [DimensionValue] -dvlItems - = lens _dvlItems (\ s a -> s{_dvlItems = a}) . - _Default - . _Coerce - -instance FromJSON DimensionValueList where - parseJSON - = withObject "DimensionValueList" - (\ o -> - DimensionValueList' <$> - (o .:? "etag") <*> (o .:? "nextPageToken") <*> - (o .:? "kind" .!= "dfareporting#dimensionValueList") - <*> (o .:? "items" .!= mempty)) - -instance ToJSON DimensionValueList where - toJSON DimensionValueList'{..} - = object - (catMaybes - [("etag" .=) <$> _dvlEtag, - ("nextPageToken" .=) <$> _dvlNextPageToken, - Just ("kind" .= _dvlKind), - ("items" .=) <$> _dvlItems]) - --- | Represents fields that are compatible to be selected for a report of --- type \"FlOODLIGHT\". --- --- /See:/ 'floodlightReportCompatibleFields' smart constructor. -data FloodlightReportCompatibleFields = FloodlightReportCompatibleFields' - { _frcfMetrics :: !(Maybe [Metric]) - , _frcfKind :: !Text - , _frcfDimensionFilters :: !(Maybe [Dimension]) - , _frcfDimensions :: !(Maybe [Dimension]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'FloodlightReportCompatibleFields' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'frcfMetrics' --- --- * 'frcfKind' --- --- * 'frcfDimensionFilters' --- --- * 'frcfDimensions' -floodlightReportCompatibleFields - :: FloodlightReportCompatibleFields -floodlightReportCompatibleFields = - FloodlightReportCompatibleFields' - { _frcfMetrics = Nothing - , _frcfKind = "dfareporting#floodlightReportCompatibleFields" - , _frcfDimensionFilters = Nothing - , _frcfDimensions = Nothing - } - --- | Metrics which are compatible to be selected in the \"metricNames\" --- section of the report. -frcfMetrics :: Lens' FloodlightReportCompatibleFields [Metric] -frcfMetrics - = lens _frcfMetrics (\ s a -> s{_frcfMetrics = a}) . - _Default - . _Coerce - --- | The kind of resource this is, in this case --- dfareporting#floodlightReportCompatibleFields. -frcfKind :: Lens' FloodlightReportCompatibleFields Text -frcfKind = lens _frcfKind (\ s a -> s{_frcfKind = a}) - --- | Dimensions which are compatible to be selected in the --- \"dimensionFilters\" section of the report. -frcfDimensionFilters :: Lens' FloodlightReportCompatibleFields [Dimension] -frcfDimensionFilters - = lens _frcfDimensionFilters - (\ s a -> s{_frcfDimensionFilters = a}) - . _Default - . _Coerce - --- | Dimensions which are compatible to be selected in the \"dimensions\" --- section of the report. -frcfDimensions :: Lens' FloodlightReportCompatibleFields [Dimension] -frcfDimensions - = lens _frcfDimensions - (\ s a -> s{_frcfDimensions = a}) - . _Default - . _Coerce - -instance FromJSON FloodlightReportCompatibleFields - where - parseJSON - = withObject "FloodlightReportCompatibleFields" - (\ o -> - FloodlightReportCompatibleFields' <$> - (o .:? "metrics" .!= mempty) <*> - (o .:? "kind" .!= - "dfareporting#floodlightReportCompatibleFields") - <*> (o .:? "dimensionFilters" .!= mempty) - <*> (o .:? "dimensions" .!= mempty)) - -instance ToJSON FloodlightReportCompatibleFields - where - toJSON FloodlightReportCompatibleFields'{..} - = object - (catMaybes - [("metrics" .=) <$> _frcfMetrics, - Just ("kind" .= _frcfKind), - ("dimensionFilters" .=) <$> _frcfDimensionFilters, - ("dimensions" .=) <$> _frcfDimensions]) - --- | Represents a grouping of related user role permissions. --- --- /See:/ 'userRolePermissionGroup' smart constructor. -data UserRolePermissionGroup = UserRolePermissionGroup' - { _urpgKind :: !Text - , _urpgName :: !(Maybe Text) - , _urpgId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'UserRolePermissionGroup' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'urpgKind' --- --- * 'urpgName' --- --- * 'urpgId' -userRolePermissionGroup - :: UserRolePermissionGroup -userRolePermissionGroup = - UserRolePermissionGroup' - { _urpgKind = "dfareporting#userRolePermissionGroup" - , _urpgName = Nothing - , _urpgId = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#userRolePermissionGroup\". -urpgKind :: Lens' UserRolePermissionGroup Text -urpgKind = lens _urpgKind (\ s a -> s{_urpgKind = a}) - --- | Name of this user role permission group. -urpgName :: Lens' UserRolePermissionGroup (Maybe Text) -urpgName = lens _urpgName (\ s a -> s{_urpgName = a}) - --- | ID of this user role permission. -urpgId :: Lens' UserRolePermissionGroup (Maybe Int64) -urpgId - = lens _urpgId (\ s a -> s{_urpgId = a}) . - mapping _Coerce - -instance FromJSON UserRolePermissionGroup where - parseJSON - = withObject "UserRolePermissionGroup" - (\ o -> - UserRolePermissionGroup' <$> - (o .:? "kind" .!= - "dfareporting#userRolePermissionGroup") - <*> (o .:? "name") - <*> (o .:? "id")) - -instance ToJSON UserRolePermissionGroup where - toJSON UserRolePermissionGroup'{..} - = object - (catMaybes - [Just ("kind" .= _urpgKind), - ("name" .=) <$> _urpgName, ("id" .=) <$> _urpgId]) - --- | Tag Settings --- --- /See:/ 'tagSetting' smart constructor. -data TagSetting = TagSetting' - { _tsKeywordOption :: !(Maybe TagSettingKeywordOption) - , _tsIncludeClickThroughURLs :: !(Maybe Bool) - , _tsIncludeClickTracking :: !(Maybe Bool) - , _tsAdditionalKeyValues :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'TagSetting' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'tsKeywordOption' --- --- * 'tsIncludeClickThroughURLs' --- --- * 'tsIncludeClickTracking' --- --- * 'tsAdditionalKeyValues' -tagSetting - :: TagSetting -tagSetting = - TagSetting' - { _tsKeywordOption = Nothing - , _tsIncludeClickThroughURLs = Nothing - , _tsIncludeClickTracking = Nothing - , _tsAdditionalKeyValues = Nothing - } - --- | Option specifying how keywords are embedded in ad tags. This setting can --- be used to specify whether keyword placeholders are inserted in --- placement tags for this site. Publishers can then add keywords to those --- placeholders. -tsKeywordOption :: Lens' TagSetting (Maybe TagSettingKeywordOption) -tsKeywordOption - = lens _tsKeywordOption - (\ s a -> s{_tsKeywordOption = a}) - --- | Whether static landing page URLs should be included in the tags. This --- setting applies only to placements. -tsIncludeClickThroughURLs :: Lens' TagSetting (Maybe Bool) -tsIncludeClickThroughURLs - = lens _tsIncludeClickThroughURLs - (\ s a -> s{_tsIncludeClickThroughURLs = a}) - --- | Whether click-tracking string should be included in the tags. -tsIncludeClickTracking :: Lens' TagSetting (Maybe Bool) -tsIncludeClickTracking - = lens _tsIncludeClickTracking - (\ s a -> s{_tsIncludeClickTracking = a}) - --- | Additional key-values to be included in tags. Each key-value pair must --- be of the form key=value, and pairs must be separated by a semicolon --- (;). Keys and values must not contain commas. For example, --- id=2;color=red is a valid value for this field. -tsAdditionalKeyValues :: Lens' TagSetting (Maybe Text) -tsAdditionalKeyValues - = lens _tsAdditionalKeyValues - (\ s a -> s{_tsAdditionalKeyValues = a}) - -instance FromJSON TagSetting where - parseJSON - = withObject "TagSetting" - (\ o -> - TagSetting' <$> - (o .:? "keywordOption") <*> - (o .:? "includeClickThroughUrls") - <*> (o .:? "includeClickTracking") - <*> (o .:? "additionalKeyValues")) - -instance ToJSON TagSetting where - toJSON TagSetting'{..} - = object - (catMaybes - [("keywordOption" .=) <$> _tsKeywordOption, - ("includeClickThroughUrls" .=) <$> - _tsIncludeClickThroughURLs, - ("includeClickTracking" .=) <$> - _tsIncludeClickTracking, - ("additionalKeyValues" .=) <$> - _tsAdditionalKeyValues]) - --- | The properties of the report. --- --- /See:/ 'reportPathToConversionCriteriaReportProperties' smart constructor. -data ReportPathToConversionCriteriaReportProperties = ReportPathToConversionCriteriaReportProperties' - { _rptccrpMaximumInteractionGap :: !(Maybe (Textual Int32)) - , _rptccrpMaximumClickInteractions :: !(Maybe (Textual Int32)) - , _rptccrpPivotOnInteractionPath :: !(Maybe Bool) - , _rptccrpMaximumImpressionInteractions :: !(Maybe (Textual Int32)) - , _rptccrpIncludeUnattributedIPConversions :: !(Maybe Bool) - , _rptccrpImpressionsLookbackWindow :: !(Maybe (Textual Int32)) - , _rptccrpClicksLookbackWindow :: !(Maybe (Textual Int32)) - , _rptccrpIncludeUnattributedCookieConversions :: !(Maybe Bool) - , _rptccrpIncludeAttributedIPConversions :: !(Maybe Bool) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'ReportPathToConversionCriteriaReportProperties' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'rptccrpMaximumInteractionGap' --- --- * 'rptccrpMaximumClickInteractions' --- --- * 'rptccrpPivotOnInteractionPath' --- --- * 'rptccrpMaximumImpressionInteractions' --- --- * 'rptccrpIncludeUnattributedIPConversions' --- --- * 'rptccrpImpressionsLookbackWindow' --- --- * 'rptccrpClicksLookbackWindow' --- --- * 'rptccrpIncludeUnattributedCookieConversions' --- --- * 'rptccrpIncludeAttributedIPConversions' -reportPathToConversionCriteriaReportProperties - :: ReportPathToConversionCriteriaReportProperties -reportPathToConversionCriteriaReportProperties = - ReportPathToConversionCriteriaReportProperties' - { _rptccrpMaximumInteractionGap = Nothing - , _rptccrpMaximumClickInteractions = Nothing - , _rptccrpPivotOnInteractionPath = Nothing - , _rptccrpMaximumImpressionInteractions = Nothing - , _rptccrpIncludeUnattributedIPConversions = Nothing - , _rptccrpImpressionsLookbackWindow = Nothing - , _rptccrpClicksLookbackWindow = Nothing - , _rptccrpIncludeUnattributedCookieConversions = Nothing - , _rptccrpIncludeAttributedIPConversions = Nothing - } - --- | The maximum amount of time that can take place between interactions --- (clicks or impressions) by the same user. Valid values: 1-90. -rptccrpMaximumInteractionGap :: Lens' ReportPathToConversionCriteriaReportProperties (Maybe Int32) -rptccrpMaximumInteractionGap - = lens _rptccrpMaximumInteractionGap - (\ s a -> s{_rptccrpMaximumInteractionGap = a}) - . mapping _Coerce - --- | The maximum number of click interactions to include in the report. --- Advertisers currently paying for E2C reports get up to 200 (100 clicks, --- 100 impressions). If another advertiser in your network is paying for --- E2C, you can have up to 5 total exposures per report. -rptccrpMaximumClickInteractions :: Lens' ReportPathToConversionCriteriaReportProperties (Maybe Int32) -rptccrpMaximumClickInteractions - = lens _rptccrpMaximumClickInteractions - (\ s a -> s{_rptccrpMaximumClickInteractions = a}) - . mapping _Coerce - --- | Enable pivoting on interaction path. -rptccrpPivotOnInteractionPath :: Lens' ReportPathToConversionCriteriaReportProperties (Maybe Bool) -rptccrpPivotOnInteractionPath - = lens _rptccrpPivotOnInteractionPath - (\ s a -> s{_rptccrpPivotOnInteractionPath = a}) - --- | The maximum number of click interactions to include in the report. --- Advertisers currently paying for E2C reports get up to 200 (100 clicks, --- 100 impressions). If another advertiser in your network is paying for --- E2C, you can have up to 5 total exposures per report. -rptccrpMaximumImpressionInteractions :: Lens' ReportPathToConversionCriteriaReportProperties (Maybe Int32) -rptccrpMaximumImpressionInteractions - = lens _rptccrpMaximumImpressionInteractions - (\ s a -> - s{_rptccrpMaximumImpressionInteractions = a}) - . mapping _Coerce - --- | Include conversions that have no associated cookies and no exposures. --- It’s therefore impossible to know how the user was exposed to your ads --- during the lookback window prior to a conversion. -rptccrpIncludeUnattributedIPConversions :: Lens' ReportPathToConversionCriteriaReportProperties (Maybe Bool) -rptccrpIncludeUnattributedIPConversions - = lens _rptccrpIncludeUnattributedIPConversions - (\ s a -> - s{_rptccrpIncludeUnattributedIPConversions = a}) - --- | DFA checks to see if an impression interaction occurred within the --- specified period of time before a conversion. By default the value is --- pulled from Floodlight or you can manually enter a custom value. Valid --- values: 1-90. -rptccrpImpressionsLookbackWindow :: Lens' ReportPathToConversionCriteriaReportProperties (Maybe Int32) -rptccrpImpressionsLookbackWindow - = lens _rptccrpImpressionsLookbackWindow - (\ s a -> s{_rptccrpImpressionsLookbackWindow = a}) - . mapping _Coerce - --- | DFA checks to see if a click interaction occurred within the specified --- period of time before a conversion. By default the value is pulled from --- Floodlight or you can manually enter a custom value. Valid values: 1-90. -rptccrpClicksLookbackWindow :: Lens' ReportPathToConversionCriteriaReportProperties (Maybe Int32) -rptccrpClicksLookbackWindow - = lens _rptccrpClicksLookbackWindow - (\ s a -> s{_rptccrpClicksLookbackWindow = a}) - . mapping _Coerce - --- | Include conversions of users with a DoubleClick cookie but without an --- exposure. That means the user did not click or see an ad from the --- advertiser within the Floodlight group, or that the interaction happened --- outside the lookback window. -rptccrpIncludeUnattributedCookieConversions :: Lens' ReportPathToConversionCriteriaReportProperties (Maybe Bool) -rptccrpIncludeUnattributedCookieConversions - = lens _rptccrpIncludeUnattributedCookieConversions - (\ s a -> - s{_rptccrpIncludeUnattributedCookieConversions = a}) - --- | Deprecated: has no effect. -rptccrpIncludeAttributedIPConversions :: Lens' ReportPathToConversionCriteriaReportProperties (Maybe Bool) -rptccrpIncludeAttributedIPConversions - = lens _rptccrpIncludeAttributedIPConversions - (\ s a -> - s{_rptccrpIncludeAttributedIPConversions = a}) - -instance FromJSON - ReportPathToConversionCriteriaReportProperties where - parseJSON - = withObject - "ReportPathToConversionCriteriaReportProperties" - (\ o -> - ReportPathToConversionCriteriaReportProperties' <$> - (o .:? "maximumInteractionGap") <*> - (o .:? "maximumClickInteractions") - <*> (o .:? "pivotOnInteractionPath") - <*> (o .:? "maximumImpressionInteractions") - <*> (o .:? "includeUnattributedIPConversions") - <*> (o .:? "impressionsLookbackWindow") - <*> (o .:? "clicksLookbackWindow") - <*> (o .:? "includeUnattributedCookieConversions") - <*> (o .:? "includeAttributedIPConversions")) - -instance ToJSON - ReportPathToConversionCriteriaReportProperties where - toJSON - ReportPathToConversionCriteriaReportProperties'{..} - = object - (catMaybes - [("maximumInteractionGap" .=) <$> - _rptccrpMaximumInteractionGap, - ("maximumClickInteractions" .=) <$> - _rptccrpMaximumClickInteractions, - ("pivotOnInteractionPath" .=) <$> - _rptccrpPivotOnInteractionPath, - ("maximumImpressionInteractions" .=) <$> - _rptccrpMaximumImpressionInteractions, - ("includeUnattributedIPConversions" .=) <$> - _rptccrpIncludeUnattributedIPConversions, - ("impressionsLookbackWindow" .=) <$> - _rptccrpImpressionsLookbackWindow, - ("clicksLookbackWindow" .=) <$> - _rptccrpClicksLookbackWindow, - ("includeUnattributedCookieConversions" .=) <$> - _rptccrpIncludeUnattributedCookieConversions, - ("includeAttributedIPConversions" .=) <$> - _rptccrpIncludeAttributedIPConversions]) - --- | User Role Permission List Response --- --- /See:/ 'userRolePermissionsListResponse' smart constructor. -data UserRolePermissionsListResponse = UserRolePermissionsListResponse' - { _urplrKind :: !Text - , _urplrUserRolePermissions :: !(Maybe [UserRolePermission]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'UserRolePermissionsListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'urplrKind' --- --- * 'urplrUserRolePermissions' -userRolePermissionsListResponse - :: UserRolePermissionsListResponse -userRolePermissionsListResponse = - UserRolePermissionsListResponse' - { _urplrKind = "dfareporting#userRolePermissionsListResponse" - , _urplrUserRolePermissions = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#userRolePermissionsListResponse\". -urplrKind :: Lens' UserRolePermissionsListResponse Text -urplrKind - = lens _urplrKind (\ s a -> s{_urplrKind = a}) - --- | User role permission collection. -urplrUserRolePermissions :: Lens' UserRolePermissionsListResponse [UserRolePermission] -urplrUserRolePermissions - = lens _urplrUserRolePermissions - (\ s a -> s{_urplrUserRolePermissions = a}) - . _Default - . _Coerce - -instance FromJSON UserRolePermissionsListResponse - where - parseJSON - = withObject "UserRolePermissionsListResponse" - (\ o -> - UserRolePermissionsListResponse' <$> - (o .:? "kind" .!= - "dfareporting#userRolePermissionsListResponse") - <*> (o .:? "userRolePermissions" .!= mempty)) - -instance ToJSON UserRolePermissionsListResponse where - toJSON UserRolePermissionsListResponse'{..} - = object - (catMaybes - [Just ("kind" .= _urplrKind), - ("userRolePermissions" .=) <$> - _urplrUserRolePermissions]) - --- | Placement Group List Response --- --- /See:/ 'placementGroupsListResponse' smart constructor. -data PlacementGroupsListResponse = PlacementGroupsListResponse' - { _pglrNextPageToken :: !(Maybe Text) - , _pglrKind :: !Text - , _pglrPlacementGroups :: !(Maybe [PlacementGroup]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'PlacementGroupsListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'pglrNextPageToken' --- --- * 'pglrKind' --- --- * 'pglrPlacementGroups' -placementGroupsListResponse - :: PlacementGroupsListResponse -placementGroupsListResponse = - PlacementGroupsListResponse' - { _pglrNextPageToken = Nothing - , _pglrKind = "dfareporting#placementGroupsListResponse" - , _pglrPlacementGroups = Nothing - } - --- | Pagination token to be used for the next list operation. -pglrNextPageToken :: Lens' PlacementGroupsListResponse (Maybe Text) -pglrNextPageToken - = lens _pglrNextPageToken - (\ s a -> s{_pglrNextPageToken = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#placementGroupsListResponse\". -pglrKind :: Lens' PlacementGroupsListResponse Text -pglrKind = lens _pglrKind (\ s a -> s{_pglrKind = a}) - --- | Placement group collection. -pglrPlacementGroups :: Lens' PlacementGroupsListResponse [PlacementGroup] -pglrPlacementGroups - = lens _pglrPlacementGroups - (\ s a -> s{_pglrPlacementGroups = a}) - . _Default - . _Coerce - -instance FromJSON PlacementGroupsListResponse where - parseJSON - = withObject "PlacementGroupsListResponse" - (\ o -> - PlacementGroupsListResponse' <$> - (o .:? "nextPageToken") <*> - (o .:? "kind" .!= - "dfareporting#placementGroupsListResponse") - <*> (o .:? "placementGroups" .!= mempty)) - -instance ToJSON PlacementGroupsListResponse where - toJSON PlacementGroupsListResponse'{..} - = object - (catMaybes - [("nextPageToken" .=) <$> _pglrNextPageToken, - Just ("kind" .= _pglrKind), - ("placementGroups" .=) <$> _pglrPlacementGroups]) - --- | Contains information about a mobile carrier that can be targeted by ads. --- --- /See:/ 'mobileCarrier' smart constructor. -data MobileCarrier = MobileCarrier' - { _mcKind :: !Text - , _mcName :: !(Maybe Text) - , _mcCountryCode :: !(Maybe Text) - , _mcId :: !(Maybe (Textual Int64)) - , _mcCountryDartId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'MobileCarrier' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'mcKind' --- --- * 'mcName' --- --- * 'mcCountryCode' --- --- * 'mcId' --- --- * 'mcCountryDartId' -mobileCarrier - :: MobileCarrier -mobileCarrier = - MobileCarrier' - { _mcKind = "dfareporting#mobileCarrier" - , _mcName = Nothing - , _mcCountryCode = Nothing - , _mcId = Nothing - , _mcCountryDartId = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#mobileCarrier\". -mcKind :: Lens' MobileCarrier Text -mcKind = lens _mcKind (\ s a -> s{_mcKind = a}) - --- | Name of this mobile carrier. -mcName :: Lens' MobileCarrier (Maybe Text) -mcName = lens _mcName (\ s a -> s{_mcName = a}) - --- | Country code of the country to which this mobile carrier belongs. -mcCountryCode :: Lens' MobileCarrier (Maybe Text) -mcCountryCode - = lens _mcCountryCode - (\ s a -> s{_mcCountryCode = a}) - --- | ID of this mobile carrier. -mcId :: Lens' MobileCarrier (Maybe Int64) -mcId - = lens _mcId (\ s a -> s{_mcId = a}) . - mapping _Coerce - --- | DART ID of the country to which this mobile carrier belongs. -mcCountryDartId :: Lens' MobileCarrier (Maybe Int64) -mcCountryDartId - = lens _mcCountryDartId - (\ s a -> s{_mcCountryDartId = a}) - . mapping _Coerce - -instance FromJSON MobileCarrier where - parseJSON - = withObject "MobileCarrier" - (\ o -> - MobileCarrier' <$> - (o .:? "kind" .!= "dfareporting#mobileCarrier") <*> - (o .:? "name") - <*> (o .:? "countryCode") - <*> (o .:? "id") - <*> (o .:? "countryDartId")) - -instance ToJSON MobileCarrier where - toJSON MobileCarrier'{..} - = object - (catMaybes - [Just ("kind" .= _mcKind), ("name" .=) <$> _mcName, - ("countryCode" .=) <$> _mcCountryCode, - ("id" .=) <$> _mcId, - ("countryDartId" .=) <$> _mcCountryDartId]) - --- | Contains information about where a user\'s browser is taken after the --- user clicks an ad. --- --- /See:/ 'landingPage' smart constructor. -data LandingPage = LandingPage' - { _lpKind :: !Text - , _lpAdvertiserId :: !(Maybe (Textual Int64)) - , _lpURL :: !(Maybe Text) - , _lpName :: !(Maybe Text) - , _lpDeepLinks :: !(Maybe [DeepLink]) - , _lpId :: !(Maybe (Textual Int64)) - , _lpArchived :: !(Maybe Bool) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'LandingPage' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'lpKind' --- --- * 'lpAdvertiserId' --- --- * 'lpURL' --- --- * 'lpName' --- --- * 'lpDeepLinks' --- --- * 'lpId' --- --- * 'lpArchived' -landingPage - :: LandingPage -landingPage = - LandingPage' - { _lpKind = "dfareporting#landingPage" - , _lpAdvertiserId = Nothing - , _lpURL = Nothing - , _lpName = Nothing - , _lpDeepLinks = Nothing - , _lpId = Nothing - , _lpArchived = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#landingPage\". -lpKind :: Lens' LandingPage Text -lpKind = lens _lpKind (\ s a -> s{_lpKind = a}) - --- | Advertiser ID of this landing page. This is a required field. -lpAdvertiserId :: Lens' LandingPage (Maybe Int64) -lpAdvertiserId - = lens _lpAdvertiserId - (\ s a -> s{_lpAdvertiserId = a}) - . mapping _Coerce - --- | URL of this landing page. This is a required field. -lpURL :: Lens' LandingPage (Maybe Text) -lpURL = lens _lpURL (\ s a -> s{_lpURL = a}) - --- | Name of this landing page. This is a required field. It must be less --- than 256 characters long. -lpName :: Lens' LandingPage (Maybe Text) -lpName = lens _lpName (\ s a -> s{_lpName = a}) - --- | Links that will direct the user to a mobile app, if installed. -lpDeepLinks :: Lens' LandingPage [DeepLink] -lpDeepLinks - = lens _lpDeepLinks (\ s a -> s{_lpDeepLinks = a}) . - _Default - . _Coerce - --- | ID of this landing page. This is a read-only, auto-generated field. -lpId :: Lens' LandingPage (Maybe Int64) -lpId - = lens _lpId (\ s a -> s{_lpId = a}) . - mapping _Coerce - --- | Whether this landing page has been archived. -lpArchived :: Lens' LandingPage (Maybe Bool) -lpArchived - = lens _lpArchived (\ s a -> s{_lpArchived = a}) - -instance FromJSON LandingPage where - parseJSON - = withObject "LandingPage" - (\ o -> - LandingPage' <$> - (o .:? "kind" .!= "dfareporting#landingPage") <*> - (o .:? "advertiserId") - <*> (o .:? "url") - <*> (o .:? "name") - <*> (o .:? "deepLinks" .!= mempty) - <*> (o .:? "id") - <*> (o .:? "archived")) - -instance ToJSON LandingPage where - toJSON LandingPage'{..} - = object - (catMaybes - [Just ("kind" .= _lpKind), - ("advertiserId" .=) <$> _lpAdvertiserId, - ("url" .=) <$> _lpURL, ("name" .=) <$> _lpName, - ("deepLinks" .=) <$> _lpDeepLinks, - ("id" .=) <$> _lpId, - ("archived" .=) <$> _lpArchived]) - --- | Connection Type List Response --- --- /See:/ 'connectionTypesListResponse' smart constructor. -data ConnectionTypesListResponse = ConnectionTypesListResponse' - { _ctlrKind :: !Text - , _ctlrConnectionTypes :: !(Maybe [ConnectionType]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'ConnectionTypesListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'ctlrKind' --- --- * 'ctlrConnectionTypes' -connectionTypesListResponse - :: ConnectionTypesListResponse -connectionTypesListResponse = - ConnectionTypesListResponse' - { _ctlrKind = "dfareporting#connectionTypesListResponse" - , _ctlrConnectionTypes = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#connectionTypesListResponse\". -ctlrKind :: Lens' ConnectionTypesListResponse Text -ctlrKind = lens _ctlrKind (\ s a -> s{_ctlrKind = a}) - --- | Collection of connection types such as broadband and mobile. -ctlrConnectionTypes :: Lens' ConnectionTypesListResponse [ConnectionType] -ctlrConnectionTypes - = lens _ctlrConnectionTypes - (\ s a -> s{_ctlrConnectionTypes = a}) - . _Default - . _Coerce - -instance FromJSON ConnectionTypesListResponse where - parseJSON - = withObject "ConnectionTypesListResponse" - (\ o -> - ConnectionTypesListResponse' <$> - (o .:? "kind" .!= - "dfareporting#connectionTypesListResponse") - <*> (o .:? "connectionTypes" .!= mempty)) - -instance ToJSON ConnectionTypesListResponse where - toJSON ConnectionTypesListResponse'{..} - = object - (catMaybes - [Just ("kind" .= _ctlrKind), - ("connectionTypes" .=) <$> _ctlrConnectionTypes]) - --- | Order List Response --- --- /See:/ 'ordersListResponse' smart constructor. -data OrdersListResponse = OrdersListResponse' - { _olrNextPageToken :: !(Maybe Text) - , _olrKind :: !Text - , _olrOrders :: !(Maybe [Order]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'OrdersListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'olrNextPageToken' --- --- * 'olrKind' --- --- * 'olrOrders' -ordersListResponse - :: OrdersListResponse -ordersListResponse = - OrdersListResponse' - { _olrNextPageToken = Nothing - , _olrKind = "dfareporting#ordersListResponse" - , _olrOrders = Nothing - } - --- | Pagination token to be used for the next list operation. -olrNextPageToken :: Lens' OrdersListResponse (Maybe Text) -olrNextPageToken - = lens _olrNextPageToken - (\ s a -> s{_olrNextPageToken = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#ordersListResponse\". -olrKind :: Lens' OrdersListResponse Text -olrKind = lens _olrKind (\ s a -> s{_olrKind = a}) - --- | Order collection. -olrOrders :: Lens' OrdersListResponse [Order] -olrOrders - = lens _olrOrders (\ s a -> s{_olrOrders = a}) . - _Default - . _Coerce - -instance FromJSON OrdersListResponse where - parseJSON - = withObject "OrdersListResponse" - (\ o -> - OrdersListResponse' <$> - (o .:? "nextPageToken") <*> - (o .:? "kind" .!= "dfareporting#ordersListResponse") - <*> (o .:? "orders" .!= mempty)) - -instance ToJSON OrdersListResponse where - toJSON OrdersListResponse'{..} - = object - (catMaybes - [("nextPageToken" .=) <$> _olrNextPageToken, - Just ("kind" .= _olrKind), - ("orders" .=) <$> _olrOrders]) - --- | Represents the list of reports. --- --- /See:/ 'reportList' smart constructor. -data ReportList = ReportList' - { _repEtag :: !(Maybe Text) - , _repNextPageToken :: !(Maybe Text) - , _repKind :: !Text - , _repItems :: !(Maybe [Report]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'ReportList' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'repEtag' --- --- * 'repNextPageToken' --- --- * 'repKind' --- --- * 'repItems' -reportList - :: ReportList -reportList = - ReportList' - { _repEtag = Nothing - , _repNextPageToken = Nothing - , _repKind = "dfareporting#reportList" - , _repItems = Nothing - } - --- | The eTag of this response for caching purposes. -repEtag :: Lens' ReportList (Maybe Text) -repEtag = lens _repEtag (\ s a -> s{_repEtag = a}) - --- | Continuation token used to page through reports. To retrieve the next --- page of results, set the next request\'s \"pageToken\" to the value of --- this field. The page token is only valid for a limited amount of time --- and should not be persisted. -repNextPageToken :: Lens' ReportList (Maybe Text) -repNextPageToken - = lens _repNextPageToken - (\ s a -> s{_repNextPageToken = a}) - --- | The kind of list this is, in this case dfareporting#reportList. -repKind :: Lens' ReportList Text -repKind = lens _repKind (\ s a -> s{_repKind = a}) - --- | The reports returned in this response. -repItems :: Lens' ReportList [Report] -repItems - = lens _repItems (\ s a -> s{_repItems = a}) . - _Default - . _Coerce - -instance FromJSON ReportList where - parseJSON - = withObject "ReportList" - (\ o -> - ReportList' <$> - (o .:? "etag") <*> (o .:? "nextPageToken") <*> - (o .:? "kind" .!= "dfareporting#reportList") - <*> (o .:? "items" .!= mempty)) - -instance ToJSON ReportList where - toJSON ReportList'{..} - = object - (catMaybes - [("etag" .=) <$> _repEtag, - ("nextPageToken" .=) <$> _repNextPageToken, - Just ("kind" .= _repKind), - ("items" .=) <$> _repItems]) - --- | Contains properties of a creative group. --- --- /See:/ 'creativeGroup' smart constructor. -data CreativeGroup = CreativeGroup' - { _cgKind :: !Text - , _cgAdvertiserId :: !(Maybe (Textual Int64)) - , _cgAdvertiserIdDimensionValue :: !(Maybe DimensionValue) - , _cgGroupNumber :: !(Maybe (Textual Int32)) - , _cgAccountId :: !(Maybe (Textual Int64)) - , _cgName :: !(Maybe Text) - , _cgId :: !(Maybe (Textual Int64)) - , _cgSubAccountId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'CreativeGroup' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'cgKind' --- --- * 'cgAdvertiserId' --- --- * 'cgAdvertiserIdDimensionValue' --- --- * 'cgGroupNumber' --- --- * 'cgAccountId' --- --- * 'cgName' --- --- * 'cgId' --- --- * 'cgSubAccountId' -creativeGroup - :: CreativeGroup -creativeGroup = - CreativeGroup' - { _cgKind = "dfareporting#creativeGroup" - , _cgAdvertiserId = Nothing - , _cgAdvertiserIdDimensionValue = Nothing - , _cgGroupNumber = Nothing - , _cgAccountId = Nothing - , _cgName = Nothing - , _cgId = Nothing - , _cgSubAccountId = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#creativeGroup\". -cgKind :: Lens' CreativeGroup Text -cgKind = lens _cgKind (\ s a -> s{_cgKind = a}) - --- | Advertiser ID of this creative group. This is a required field on --- insertion. -cgAdvertiserId :: Lens' CreativeGroup (Maybe Int64) -cgAdvertiserId - = lens _cgAdvertiserId - (\ s a -> s{_cgAdvertiserId = a}) - . mapping _Coerce - --- | Dimension value for the ID of the advertiser. This is a read-only, --- auto-generated field. -cgAdvertiserIdDimensionValue :: Lens' CreativeGroup (Maybe DimensionValue) -cgAdvertiserIdDimensionValue - = lens _cgAdvertiserIdDimensionValue - (\ s a -> s{_cgAdvertiserIdDimensionValue = a}) - --- | Subgroup of the creative group. Assign your creative groups to a --- subgroup in order to filter or manage them more easily. This field is --- required on insertion and is read-only after insertion. Acceptable --- values are 1 to 2, inclusive. -cgGroupNumber :: Lens' CreativeGroup (Maybe Int32) -cgGroupNumber - = lens _cgGroupNumber - (\ s a -> s{_cgGroupNumber = a}) - . mapping _Coerce - --- | Account ID of this creative group. This is a read-only field that can be --- left blank. -cgAccountId :: Lens' CreativeGroup (Maybe Int64) -cgAccountId - = lens _cgAccountId (\ s a -> s{_cgAccountId = a}) . - mapping _Coerce - --- | Name of this creative group. This is a required field and must be less --- than 256 characters long and unique among creative groups of the same --- advertiser. -cgName :: Lens' CreativeGroup (Maybe Text) -cgName = lens _cgName (\ s a -> s{_cgName = a}) - --- | ID of this creative group. This is a read-only, auto-generated field. -cgId :: Lens' CreativeGroup (Maybe Int64) -cgId - = lens _cgId (\ s a -> s{_cgId = a}) . - mapping _Coerce - --- | Subaccount ID of this creative group. This is a read-only field that can --- be left blank. -cgSubAccountId :: Lens' CreativeGroup (Maybe Int64) -cgSubAccountId - = lens _cgSubAccountId - (\ s a -> s{_cgSubAccountId = a}) - . mapping _Coerce - -instance FromJSON CreativeGroup where - parseJSON - = withObject "CreativeGroup" - (\ o -> - CreativeGroup' <$> - (o .:? "kind" .!= "dfareporting#creativeGroup") <*> - (o .:? "advertiserId") - <*> (o .:? "advertiserIdDimensionValue") - <*> (o .:? "groupNumber") - <*> (o .:? "accountId") - <*> (o .:? "name") - <*> (o .:? "id") - <*> (o .:? "subaccountId")) - -instance ToJSON CreativeGroup where - toJSON CreativeGroup'{..} - = object - (catMaybes - [Just ("kind" .= _cgKind), - ("advertiserId" .=) <$> _cgAdvertiserId, - ("advertiserIdDimensionValue" .=) <$> - _cgAdvertiserIdDimensionValue, - ("groupNumber" .=) <$> _cgGroupNumber, - ("accountId" .=) <$> _cgAccountId, - ("name" .=) <$> _cgName, ("id" .=) <$> _cgId, - ("subaccountId" .=) <$> _cgSubAccountId]) - --- | Identifies a creative which has been associated with a given campaign. --- --- /See:/ 'campaignCreativeAssociation' smart constructor. -data CampaignCreativeAssociation = CampaignCreativeAssociation' - { _ccaKind :: !Text - , _ccaCreativeId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'CampaignCreativeAssociation' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'ccaKind' --- --- * 'ccaCreativeId' -campaignCreativeAssociation - :: CampaignCreativeAssociation -campaignCreativeAssociation = - CampaignCreativeAssociation' - { _ccaKind = "dfareporting#campaignCreativeAssociation" - , _ccaCreativeId = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#campaignCreativeAssociation\". -ccaKind :: Lens' CampaignCreativeAssociation Text -ccaKind = lens _ccaKind (\ s a -> s{_ccaKind = a}) - --- | ID of the creative associated with the campaign. This is a required --- field. -ccaCreativeId :: Lens' CampaignCreativeAssociation (Maybe Int64) -ccaCreativeId - = lens _ccaCreativeId - (\ s a -> s{_ccaCreativeId = a}) - . mapping _Coerce - -instance FromJSON CampaignCreativeAssociation where - parseJSON - = withObject "CampaignCreativeAssociation" - (\ o -> - CampaignCreativeAssociation' <$> - (o .:? "kind" .!= - "dfareporting#campaignCreativeAssociation") - <*> (o .:? "creativeId")) - -instance ToJSON CampaignCreativeAssociation where - toJSON CampaignCreativeAssociation'{..} - = object - (catMaybes - [Just ("kind" .= _ccaKind), - ("creativeId" .=) <$> _ccaCreativeId]) - --- | The original conversion that was inserted or updated and whether there --- were any errors. --- --- /See:/ 'conversionStatus' smart constructor. -data ConversionStatus = ConversionStatus' - { _csKind :: !Text - , _csConversion :: !(Maybe Conversion) - , _csErrors :: !(Maybe [ConversionError]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'ConversionStatus' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'csKind' --- --- * 'csConversion' --- --- * 'csErrors' -conversionStatus - :: ConversionStatus -conversionStatus = - ConversionStatus' - { _csKind = "dfareporting#conversionStatus" - , _csConversion = Nothing - , _csErrors = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#conversionStatus\". -csKind :: Lens' ConversionStatus Text -csKind = lens _csKind (\ s a -> s{_csKind = a}) - --- | The original conversion that was inserted or updated. -csConversion :: Lens' ConversionStatus (Maybe Conversion) -csConversion - = lens _csConversion (\ s a -> s{_csConversion = a}) - --- | A list of errors related to this conversion. -csErrors :: Lens' ConversionStatus [ConversionError] -csErrors - = lens _csErrors (\ s a -> s{_csErrors = a}) . - _Default - . _Coerce - -instance FromJSON ConversionStatus where - parseJSON - = withObject "ConversionStatus" - (\ o -> - ConversionStatus' <$> - (o .:? "kind" .!= "dfareporting#conversionStatus") - <*> (o .:? "conversion") - <*> (o .:? "errors" .!= mempty)) - -instance ToJSON ConversionStatus where - toJSON ConversionStatus'{..} - = object - (catMaybes - [Just ("kind" .= _csKind), - ("conversion" .=) <$> _csConversion, - ("errors" .=) <$> _csErrors]) - --- | Lookback configuration settings. --- --- /See:/ 'lookbackConfiguration' smart constructor. -data LookbackConfiguration = LookbackConfiguration' - { _lcClickDuration :: !(Maybe (Textual Int32)) - , _lcPostImpressionActivitiesDuration :: !(Maybe (Textual Int32)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'LookbackConfiguration' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'lcClickDuration' --- --- * 'lcPostImpressionActivitiesDuration' -lookbackConfiguration - :: LookbackConfiguration -lookbackConfiguration = - LookbackConfiguration' - { _lcClickDuration = Nothing - , _lcPostImpressionActivitiesDuration = Nothing - } - --- | Lookback window, in days, from the last time a given user clicked on one --- of your ads. If you enter 0, clicks will not be considered as triggering --- events for floodlight tracking. If you leave this field blank, the --- default value for your account will be used. Acceptable values are 0 to --- 90, inclusive. -lcClickDuration :: Lens' LookbackConfiguration (Maybe Int32) -lcClickDuration - = lens _lcClickDuration - (\ s a -> s{_lcClickDuration = a}) - . mapping _Coerce - --- | Lookback window, in days, from the last time a given user viewed one of --- your ads. If you enter 0, impressions will not be considered as --- triggering events for floodlight tracking. If you leave this field --- blank, the default value for your account will be used. Acceptable --- values are 0 to 90, inclusive. -lcPostImpressionActivitiesDuration :: Lens' LookbackConfiguration (Maybe Int32) -lcPostImpressionActivitiesDuration - = lens _lcPostImpressionActivitiesDuration - (\ s a -> s{_lcPostImpressionActivitiesDuration = a}) - . mapping _Coerce - -instance FromJSON LookbackConfiguration where - parseJSON - = withObject "LookbackConfiguration" - (\ o -> - LookbackConfiguration' <$> - (o .:? "clickDuration") <*> - (o .:? "postImpressionActivitiesDuration")) - -instance ToJSON LookbackConfiguration where - toJSON LookbackConfiguration'{..} - = object - (catMaybes - [("clickDuration" .=) <$> _lcClickDuration, - ("postImpressionActivitiesDuration" .=) <$> - _lcPostImpressionActivitiesDuration]) - --- | Publisher Dynamic Tag --- --- /See:/ 'floodlightActivityPublisherDynamicTag' smart constructor. -data FloodlightActivityPublisherDynamicTag = FloodlightActivityPublisherDynamicTag' - { _fapdtClickThrough :: !(Maybe Bool) - , _fapdtSiteIdDimensionValue :: !(Maybe DimensionValue) - , _fapdtDynamicTag :: !(Maybe FloodlightActivityDynamicTag) - , _fapdtDirectorySiteId :: !(Maybe (Textual Int64)) - , _fapdtSiteId :: !(Maybe (Textual Int64)) - , _fapdtViewThrough :: !(Maybe Bool) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'FloodlightActivityPublisherDynamicTag' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'fapdtClickThrough' --- --- * 'fapdtSiteIdDimensionValue' --- --- * 'fapdtDynamicTag' --- --- * 'fapdtDirectorySiteId' --- --- * 'fapdtSiteId' --- --- * 'fapdtViewThrough' -floodlightActivityPublisherDynamicTag - :: FloodlightActivityPublisherDynamicTag -floodlightActivityPublisherDynamicTag = - FloodlightActivityPublisherDynamicTag' - { _fapdtClickThrough = Nothing - , _fapdtSiteIdDimensionValue = Nothing - , _fapdtDynamicTag = Nothing - , _fapdtDirectorySiteId = Nothing - , _fapdtSiteId = Nothing - , _fapdtViewThrough = Nothing - } - --- | Whether this tag is applicable only for click-throughs. -fapdtClickThrough :: Lens' FloodlightActivityPublisherDynamicTag (Maybe Bool) -fapdtClickThrough - = lens _fapdtClickThrough - (\ s a -> s{_fapdtClickThrough = a}) - --- | Dimension value for the ID of the site. This is a read-only, --- auto-generated field. -fapdtSiteIdDimensionValue :: Lens' FloodlightActivityPublisherDynamicTag (Maybe DimensionValue) -fapdtSiteIdDimensionValue - = lens _fapdtSiteIdDimensionValue - (\ s a -> s{_fapdtSiteIdDimensionValue = a}) - --- | Dynamic floodlight tag. -fapdtDynamicTag :: Lens' FloodlightActivityPublisherDynamicTag (Maybe FloodlightActivityDynamicTag) -fapdtDynamicTag - = lens _fapdtDynamicTag - (\ s a -> s{_fapdtDynamicTag = a}) - --- | Directory site ID of this dynamic tag. This is a write-only field that --- can be used as an alternative to the siteId field. When this resource is --- retrieved, only the siteId field will be populated. -fapdtDirectorySiteId :: Lens' FloodlightActivityPublisherDynamicTag (Maybe Int64) -fapdtDirectorySiteId - = lens _fapdtDirectorySiteId - (\ s a -> s{_fapdtDirectorySiteId = a}) - . mapping _Coerce - --- | Site ID of this dynamic tag. -fapdtSiteId :: Lens' FloodlightActivityPublisherDynamicTag (Maybe Int64) -fapdtSiteId - = lens _fapdtSiteId (\ s a -> s{_fapdtSiteId = a}) . - mapping _Coerce - --- | Whether this tag is applicable only for view-throughs. -fapdtViewThrough :: Lens' FloodlightActivityPublisherDynamicTag (Maybe Bool) -fapdtViewThrough - = lens _fapdtViewThrough - (\ s a -> s{_fapdtViewThrough = a}) - -instance FromJSON - FloodlightActivityPublisherDynamicTag where - parseJSON - = withObject "FloodlightActivityPublisherDynamicTag" - (\ o -> - FloodlightActivityPublisherDynamicTag' <$> - (o .:? "clickThrough") <*> - (o .:? "siteIdDimensionValue") - <*> (o .:? "dynamicTag") - <*> (o .:? "directorySiteId") - <*> (o .:? "siteId") - <*> (o .:? "viewThrough")) - -instance ToJSON FloodlightActivityPublisherDynamicTag - where - toJSON FloodlightActivityPublisherDynamicTag'{..} - = object - (catMaybes - [("clickThrough" .=) <$> _fapdtClickThrough, - ("siteIdDimensionValue" .=) <$> - _fapdtSiteIdDimensionValue, - ("dynamicTag" .=) <$> _fapdtDynamicTag, - ("directorySiteId" .=) <$> _fapdtDirectorySiteId, - ("siteId" .=) <$> _fapdtSiteId, - ("viewThrough" .=) <$> _fapdtViewThrough]) - --- | Gets a summary of active ads in an account. --- --- /See:/ 'accountActiveAdSummary' smart constructor. -data AccountActiveAdSummary = AccountActiveAdSummary' - { _aaasAvailableAds :: !(Maybe (Textual Int64)) - , _aaasKind :: !Text - , _aaasAccountId :: !(Maybe (Textual Int64)) - , _aaasActiveAds :: !(Maybe (Textual Int64)) - , _aaasActiveAdsLimitTier :: !(Maybe AccountActiveAdSummaryActiveAdsLimitTier) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'AccountActiveAdSummary' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'aaasAvailableAds' --- --- * 'aaasKind' --- --- * 'aaasAccountId' --- --- * 'aaasActiveAds' --- --- * 'aaasActiveAdsLimitTier' -accountActiveAdSummary - :: AccountActiveAdSummary -accountActiveAdSummary = - AccountActiveAdSummary' - { _aaasAvailableAds = Nothing - , _aaasKind = "dfareporting#accountActiveAdSummary" - , _aaasAccountId = Nothing - , _aaasActiveAds = Nothing - , _aaasActiveAdsLimitTier = Nothing - } - --- | Ads that can be activated for the account. -aaasAvailableAds :: Lens' AccountActiveAdSummary (Maybe Int64) -aaasAvailableAds - = lens _aaasAvailableAds - (\ s a -> s{_aaasAvailableAds = a}) - . mapping _Coerce - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#accountActiveAdSummary\". -aaasKind :: Lens' AccountActiveAdSummary Text -aaasKind = lens _aaasKind (\ s a -> s{_aaasKind = a}) - --- | ID of the account. -aaasAccountId :: Lens' AccountActiveAdSummary (Maybe Int64) -aaasAccountId - = lens _aaasAccountId - (\ s a -> s{_aaasAccountId = a}) - . mapping _Coerce - --- | Ads that have been activated for the account -aaasActiveAds :: Lens' AccountActiveAdSummary (Maybe Int64) -aaasActiveAds - = lens _aaasActiveAds - (\ s a -> s{_aaasActiveAds = a}) - . mapping _Coerce - --- | Maximum number of active ads allowed for the account. -aaasActiveAdsLimitTier :: Lens' AccountActiveAdSummary (Maybe AccountActiveAdSummaryActiveAdsLimitTier) -aaasActiveAdsLimitTier - = lens _aaasActiveAdsLimitTier - (\ s a -> s{_aaasActiveAdsLimitTier = a}) - -instance FromJSON AccountActiveAdSummary where - parseJSON - = withObject "AccountActiveAdSummary" - (\ o -> - AccountActiveAdSummary' <$> - (o .:? "availableAds") <*> - (o .:? "kind" .!= - "dfareporting#accountActiveAdSummary") - <*> (o .:? "accountId") - <*> (o .:? "activeAds") - <*> (o .:? "activeAdsLimitTier")) - -instance ToJSON AccountActiveAdSummary where - toJSON AccountActiveAdSummary'{..} - = object - (catMaybes - [("availableAds" .=) <$> _aaasAvailableAds, - Just ("kind" .= _aaasKind), - ("accountId" .=) <$> _aaasAccountId, - ("activeAds" .=) <$> _aaasActiveAds, - ("activeAdsLimitTier" .=) <$> - _aaasActiveAdsLimitTier]) - --- | Offset Position. --- --- /See:/ 'offSetPosition' smart constructor. -data OffSetPosition = OffSetPosition' - { _ospLeft :: !(Maybe (Textual Int32)) - , _ospTop :: !(Maybe (Textual Int32)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'OffSetPosition' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'ospLeft' --- --- * 'ospTop' -offSetPosition - :: OffSetPosition -offSetPosition = - OffSetPosition' - { _ospLeft = Nothing - , _ospTop = Nothing - } - --- | Offset distance from left side of an asset or a window. -ospLeft :: Lens' OffSetPosition (Maybe Int32) -ospLeft - = lens _ospLeft (\ s a -> s{_ospLeft = a}) . - mapping _Coerce - --- | Offset distance from top side of an asset or a window. -ospTop :: Lens' OffSetPosition (Maybe Int32) -ospTop - = lens _ospTop (\ s a -> s{_ospTop = a}) . - mapping _Coerce - -instance FromJSON OffSetPosition where - parseJSON - = withObject "OffSetPosition" - (\ o -> - OffSetPosition' <$> (o .:? "left") <*> (o .:? "top")) - -instance ToJSON OffSetPosition where - toJSON OffSetPosition'{..} - = object - (catMaybes - [("left" .=) <$> _ospLeft, ("top" .=) <$> _ospTop]) - --- | Represents a metric. --- --- /See:/ 'metric' smart constructor. -data Metric = Metric' - { _mKind :: !Text - , _mName :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'Metric' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'mKind' --- --- * 'mName' -metric - :: Metric -metric = - Metric' - { _mKind = "dfareporting#metric" - , _mName = Nothing - } - --- | The kind of resource this is, in this case dfareporting#metric. -mKind :: Lens' Metric Text -mKind = lens _mKind (\ s a -> s{_mKind = a}) - --- | The metric name, e.g. dfa:impressions -mName :: Lens' Metric (Maybe Text) -mName = lens _mName (\ s a -> s{_mName = a}) - -instance FromJSON Metric where - parseJSON - = withObject "Metric" - (\ o -> - Metric' <$> - (o .:? "kind" .!= "dfareporting#metric") <*> - (o .:? "name")) - -instance ToJSON Metric where - toJSON Metric'{..} - = object - (catMaybes - [Just ("kind" .= _mKind), ("name" .=) <$> _mName]) - --- | Contains properties of a remarketing list\'s sharing information. --- Sharing allows other accounts or advertisers to target to your --- remarketing lists. This resource can be used to manage remarketing list --- sharing to other accounts and advertisers. --- --- /See:/ 'remarketingListShare' smart constructor. -data RemarketingListShare = RemarketingListShare' - { _rlsSharedAdvertiserIds :: !(Maybe [Textual Int64]) - , _rlsKind :: !Text - , _rlsRemarketingListId :: !(Maybe (Textual Int64)) - , _rlsSharedAccountIds :: !(Maybe [Textual Int64]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'RemarketingListShare' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'rlsSharedAdvertiserIds' --- --- * 'rlsKind' --- --- * 'rlsRemarketingListId' --- --- * 'rlsSharedAccountIds' -remarketingListShare - :: RemarketingListShare -remarketingListShare = - RemarketingListShare' - { _rlsSharedAdvertiserIds = Nothing - , _rlsKind = "dfareporting#remarketingListShare" - , _rlsRemarketingListId = Nothing - , _rlsSharedAccountIds = Nothing - } - --- | Advertisers that the remarketing list is shared with. -rlsSharedAdvertiserIds :: Lens' RemarketingListShare [Int64] -rlsSharedAdvertiserIds - = lens _rlsSharedAdvertiserIds - (\ s a -> s{_rlsSharedAdvertiserIds = a}) - . _Default - . _Coerce - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#remarketingListShare\". -rlsKind :: Lens' RemarketingListShare Text -rlsKind = lens _rlsKind (\ s a -> s{_rlsKind = a}) - --- | Remarketing list ID. This is a read-only, auto-generated field. -rlsRemarketingListId :: Lens' RemarketingListShare (Maybe Int64) -rlsRemarketingListId - = lens _rlsRemarketingListId - (\ s a -> s{_rlsRemarketingListId = a}) - . mapping _Coerce - --- | Accounts that the remarketing list is shared with. -rlsSharedAccountIds :: Lens' RemarketingListShare [Int64] -rlsSharedAccountIds - = lens _rlsSharedAccountIds - (\ s a -> s{_rlsSharedAccountIds = a}) - . _Default - . _Coerce - -instance FromJSON RemarketingListShare where - parseJSON - = withObject "RemarketingListShare" - (\ o -> - RemarketingListShare' <$> - (o .:? "sharedAdvertiserIds" .!= mempty) <*> - (o .:? "kind" .!= - "dfareporting#remarketingListShare") - <*> (o .:? "remarketingListId") - <*> (o .:? "sharedAccountIds" .!= mempty)) - -instance ToJSON RemarketingListShare where - toJSON RemarketingListShare'{..} - = object - (catMaybes - [("sharedAdvertiserIds" .=) <$> - _rlsSharedAdvertiserIds, - Just ("kind" .= _rlsKind), - ("remarketingListId" .=) <$> _rlsRemarketingListId, - ("sharedAccountIds" .=) <$> _rlsSharedAccountIds]) - --- | Event Tag List Response --- --- /See:/ 'eventTagsListResponse' smart constructor. -data EventTagsListResponse = EventTagsListResponse' - { _etlrKind :: !Text - , _etlrEventTags :: !(Maybe [EventTag]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'EventTagsListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'etlrKind' --- --- * 'etlrEventTags' -eventTagsListResponse - :: EventTagsListResponse -eventTagsListResponse = - EventTagsListResponse' - { _etlrKind = "dfareporting#eventTagsListResponse" - , _etlrEventTags = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#eventTagsListResponse\". -etlrKind :: Lens' EventTagsListResponse Text -etlrKind = lens _etlrKind (\ s a -> s{_etlrKind = a}) - --- | Event tag collection. -etlrEventTags :: Lens' EventTagsListResponse [EventTag] -etlrEventTags - = lens _etlrEventTags - (\ s a -> s{_etlrEventTags = a}) - . _Default - . _Coerce - -instance FromJSON EventTagsListResponse where - parseJSON - = withObject "EventTagsListResponse" - (\ o -> - EventTagsListResponse' <$> - (o .:? "kind" .!= - "dfareporting#eventTagsListResponse") - <*> (o .:? "eventTags" .!= mempty)) - -instance ToJSON EventTagsListResponse where - toJSON EventTagsListResponse'{..} - = object - (catMaybes - [Just ("kind" .= _etlrKind), - ("eventTags" .=) <$> _etlrEventTags]) - --- | User Role List Response --- --- /See:/ 'userRolesListResponse' smart constructor. -data UserRolesListResponse = UserRolesListResponse' - { _urlrNextPageToken :: !(Maybe Text) - , _urlrKind :: !Text - , _urlrUserRoles :: !(Maybe [UserRole]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'UserRolesListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'urlrNextPageToken' --- --- * 'urlrKind' --- --- * 'urlrUserRoles' -userRolesListResponse - :: UserRolesListResponse -userRolesListResponse = - UserRolesListResponse' - { _urlrNextPageToken = Nothing - , _urlrKind = "dfareporting#userRolesListResponse" - , _urlrUserRoles = Nothing - } - --- | Pagination token to be used for the next list operation. -urlrNextPageToken :: Lens' UserRolesListResponse (Maybe Text) -urlrNextPageToken - = lens _urlrNextPageToken - (\ s a -> s{_urlrNextPageToken = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#userRolesListResponse\". -urlrKind :: Lens' UserRolesListResponse Text -urlrKind = lens _urlrKind (\ s a -> s{_urlrKind = a}) - --- | User role collection. -urlrUserRoles :: Lens' UserRolesListResponse [UserRole] -urlrUserRoles - = lens _urlrUserRoles - (\ s a -> s{_urlrUserRoles = a}) - . _Default - . _Coerce - -instance FromJSON UserRolesListResponse where - parseJSON - = withObject "UserRolesListResponse" - (\ o -> - UserRolesListResponse' <$> - (o .:? "nextPageToken") <*> - (o .:? "kind" .!= - "dfareporting#userRolesListResponse") - <*> (o .:? "userRoles" .!= mempty)) - -instance ToJSON UserRolesListResponse where - toJSON UserRolesListResponse'{..} - = object - (catMaybes - [("nextPageToken" .=) <$> _urlrNextPageToken, - Just ("kind" .= _urlrKind), - ("userRoles" .=) <$> _urlrUserRoles]) - --- | Represents a response to the queryCompatibleFields method. --- --- /See:/ 'compatibleFields' smart constructor. -data CompatibleFields = CompatibleFields' - { _cfReachReportCompatibleFields :: !(Maybe ReachReportCompatibleFields) - , _cfCrossDimensionReachReportCompatibleFields :: !(Maybe CrossDimensionReachReportCompatibleFields) - , _cfKind :: !Text - , _cfFloodlightReportCompatibleFields :: !(Maybe FloodlightReportCompatibleFields) - , _cfReportCompatibleFields :: !(Maybe ReportCompatibleFields) - , _cfPathToConversionReportCompatibleFields :: !(Maybe PathToConversionReportCompatibleFields) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'CompatibleFields' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'cfReachReportCompatibleFields' --- --- * 'cfCrossDimensionReachReportCompatibleFields' --- --- * 'cfKind' --- --- * 'cfFloodlightReportCompatibleFields' --- --- * 'cfReportCompatibleFields' --- --- * 'cfPathToConversionReportCompatibleFields' -compatibleFields - :: CompatibleFields -compatibleFields = - CompatibleFields' - { _cfReachReportCompatibleFields = Nothing - , _cfCrossDimensionReachReportCompatibleFields = Nothing - , _cfKind = "dfareporting#compatibleFields" - , _cfFloodlightReportCompatibleFields = Nothing - , _cfReportCompatibleFields = Nothing - , _cfPathToConversionReportCompatibleFields = Nothing - } - --- | Contains items that are compatible to be selected for a report of type --- \"REACH\". -cfReachReportCompatibleFields :: Lens' CompatibleFields (Maybe ReachReportCompatibleFields) -cfReachReportCompatibleFields - = lens _cfReachReportCompatibleFields - (\ s a -> s{_cfReachReportCompatibleFields = a}) - --- | Contains items that are compatible to be selected for a report of type --- \"CROSS_DIMENSION_REACH\". -cfCrossDimensionReachReportCompatibleFields :: Lens' CompatibleFields (Maybe CrossDimensionReachReportCompatibleFields) -cfCrossDimensionReachReportCompatibleFields - = lens _cfCrossDimensionReachReportCompatibleFields - (\ s a -> - s{_cfCrossDimensionReachReportCompatibleFields = a}) - --- | The kind of resource this is, in this case --- dfareporting#compatibleFields. -cfKind :: Lens' CompatibleFields Text -cfKind = lens _cfKind (\ s a -> s{_cfKind = a}) - --- | Contains items that are compatible to be selected for a report of type --- \"FLOODLIGHT\". -cfFloodlightReportCompatibleFields :: Lens' CompatibleFields (Maybe FloodlightReportCompatibleFields) -cfFloodlightReportCompatibleFields - = lens _cfFloodlightReportCompatibleFields - (\ s a -> s{_cfFloodlightReportCompatibleFields = a}) - --- | Contains items that are compatible to be selected for a report of type --- \"STANDARD\". -cfReportCompatibleFields :: Lens' CompatibleFields (Maybe ReportCompatibleFields) -cfReportCompatibleFields - = lens _cfReportCompatibleFields - (\ s a -> s{_cfReportCompatibleFields = a}) - --- | Contains items that are compatible to be selected for a report of type --- \"PATH_TO_CONVERSION\". -cfPathToConversionReportCompatibleFields :: Lens' CompatibleFields (Maybe PathToConversionReportCompatibleFields) -cfPathToConversionReportCompatibleFields - = lens _cfPathToConversionReportCompatibleFields - (\ s a -> - s{_cfPathToConversionReportCompatibleFields = a}) - -instance FromJSON CompatibleFields where - parseJSON - = withObject "CompatibleFields" - (\ o -> - CompatibleFields' <$> - (o .:? "reachReportCompatibleFields") <*> - (o .:? "crossDimensionReachReportCompatibleFields") - <*> - (o .:? "kind" .!= "dfareporting#compatibleFields") - <*> (o .:? "floodlightReportCompatibleFields") - <*> (o .:? "reportCompatibleFields") - <*> (o .:? "pathToConversionReportCompatibleFields")) - -instance ToJSON CompatibleFields where - toJSON CompatibleFields'{..} - = object - (catMaybes - [("reachReportCompatibleFields" .=) <$> - _cfReachReportCompatibleFields, - ("crossDimensionReachReportCompatibleFields" .=) <$> - _cfCrossDimensionReachReportCompatibleFields, - Just ("kind" .= _cfKind), - ("floodlightReportCompatibleFields" .=) <$> - _cfFloodlightReportCompatibleFields, - ("reportCompatibleFields" .=) <$> - _cfReportCompatibleFields, - ("pathToConversionReportCompatibleFields" .=) <$> - _cfPathToConversionReportCompatibleFields]) - --- | Audience Segment. --- --- /See:/ 'audienceSegment' smart constructor. -data AudienceSegment = AudienceSegment' - { _asName :: !(Maybe Text) - , _asId :: !(Maybe (Textual Int64)) - , _asAllocation :: !(Maybe (Textual Int32)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'AudienceSegment' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'asName' --- --- * 'asId' --- --- * 'asAllocation' -audienceSegment - :: AudienceSegment -audienceSegment = - AudienceSegment' - { _asName = Nothing - , _asId = Nothing - , _asAllocation = Nothing - } - --- | Name of this audience segment. This is a required field and must be less --- than 65 characters long. -asName :: Lens' AudienceSegment (Maybe Text) -asName = lens _asName (\ s a -> s{_asName = a}) - --- | ID of this audience segment. This is a read-only, auto-generated field. -asId :: Lens' AudienceSegment (Maybe Int64) -asId - = lens _asId (\ s a -> s{_asId = a}) . - mapping _Coerce - --- | Weight allocated to this segment. The weight assigned will be understood --- in proportion to the weights assigned to other segments in the same --- segment group. Acceptable values are 1 to 1000, inclusive. -asAllocation :: Lens' AudienceSegment (Maybe Int32) -asAllocation - = lens _asAllocation (\ s a -> s{_asAllocation = a}) - . mapping _Coerce - -instance FromJSON AudienceSegment where - parseJSON - = withObject "AudienceSegment" - (\ o -> - AudienceSegment' <$> - (o .:? "name") <*> (o .:? "id") <*> - (o .:? "allocation")) - -instance ToJSON AudienceSegment where - toJSON AudienceSegment'{..} - = object - (catMaybes - [("name" .=) <$> _asName, ("id" .=) <$> _asId, - ("allocation" .=) <$> _asAllocation]) - --- | Update Conversions Request. --- --- /See:/ 'conversionsBatchUpdateRequest' smart constructor. -data ConversionsBatchUpdateRequest = ConversionsBatchUpdateRequest' - { _cburbKind :: !Text - , _cburbConversions :: !(Maybe [Conversion]) - , _cburbEncryptionInfo :: !(Maybe EncryptionInfo) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'ConversionsBatchUpdateRequest' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'cburbKind' --- --- * 'cburbConversions' --- --- * 'cburbEncryptionInfo' -conversionsBatchUpdateRequest - :: ConversionsBatchUpdateRequest -conversionsBatchUpdateRequest = - ConversionsBatchUpdateRequest' - { _cburbKind = "dfareporting#conversionsBatchUpdateRequest" - , _cburbConversions = Nothing - , _cburbEncryptionInfo = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#conversionsBatchUpdateRequest\". -cburbKind :: Lens' ConversionsBatchUpdateRequest Text -cburbKind - = lens _cburbKind (\ s a -> s{_cburbKind = a}) - --- | The set of conversions to update. -cburbConversions :: Lens' ConversionsBatchUpdateRequest [Conversion] -cburbConversions - = lens _cburbConversions - (\ s a -> s{_cburbConversions = a}) - . _Default - . _Coerce - --- | Describes how encryptedUserId is encrypted. This is a required field if --- encryptedUserId is used. -cburbEncryptionInfo :: Lens' ConversionsBatchUpdateRequest (Maybe EncryptionInfo) -cburbEncryptionInfo - = lens _cburbEncryptionInfo - (\ s a -> s{_cburbEncryptionInfo = a}) - -instance FromJSON ConversionsBatchUpdateRequest where - parseJSON - = withObject "ConversionsBatchUpdateRequest" - (\ o -> - ConversionsBatchUpdateRequest' <$> - (o .:? "kind" .!= - "dfareporting#conversionsBatchUpdateRequest") - <*> (o .:? "conversions" .!= mempty) - <*> (o .:? "encryptionInfo")) - -instance ToJSON ConversionsBatchUpdateRequest where - toJSON ConversionsBatchUpdateRequest'{..} - = object - (catMaybes - [Just ("kind" .= _cburbKind), - ("conversions" .=) <$> _cburbConversions, - ("encryptionInfo" .=) <$> _cburbEncryptionInfo]) - --- | Google Ad Manager Settings --- --- /See:/ 'dfpSettings' smart constructor. -data DfpSettings = DfpSettings' - { _dsPubPaidPlacementAccepted :: !(Maybe Bool) - , _dsDfpNetworkName :: !(Maybe Text) - , _dsPublisherPortalOnly :: !(Maybe Bool) - , _dsProgrammaticPlacementAccepted :: !(Maybe Bool) - , _dsDfpNetworkCode :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'DfpSettings' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'dsPubPaidPlacementAccepted' --- --- * 'dsDfpNetworkName' --- --- * 'dsPublisherPortalOnly' --- --- * 'dsProgrammaticPlacementAccepted' --- --- * 'dsDfpNetworkCode' -dfpSettings - :: DfpSettings -dfpSettings = - DfpSettings' - { _dsPubPaidPlacementAccepted = Nothing - , _dsDfpNetworkName = Nothing - , _dsPublisherPortalOnly = Nothing - , _dsProgrammaticPlacementAccepted = Nothing - , _dsDfpNetworkCode = Nothing - } - --- | Whether this directory site accepts publisher-paid tags. -dsPubPaidPlacementAccepted :: Lens' DfpSettings (Maybe Bool) -dsPubPaidPlacementAccepted - = lens _dsPubPaidPlacementAccepted - (\ s a -> s{_dsPubPaidPlacementAccepted = a}) - --- | Ad Manager network name for this directory site. -dsDfpNetworkName :: Lens' DfpSettings (Maybe Text) -dsDfpNetworkName - = lens _dsDfpNetworkName - (\ s a -> s{_dsDfpNetworkName = a}) - --- | Whether this directory site is available only via Publisher Portal. -dsPublisherPortalOnly :: Lens' DfpSettings (Maybe Bool) -dsPublisherPortalOnly - = lens _dsPublisherPortalOnly - (\ s a -> s{_dsPublisherPortalOnly = a}) - --- | Whether this directory site accepts programmatic placements. -dsProgrammaticPlacementAccepted :: Lens' DfpSettings (Maybe Bool) -dsProgrammaticPlacementAccepted - = lens _dsProgrammaticPlacementAccepted - (\ s a -> s{_dsProgrammaticPlacementAccepted = a}) - --- | Ad Manager network code for this directory site. -dsDfpNetworkCode :: Lens' DfpSettings (Maybe Text) -dsDfpNetworkCode - = lens _dsDfpNetworkCode - (\ s a -> s{_dsDfpNetworkCode = a}) - -instance FromJSON DfpSettings where - parseJSON - = withObject "DfpSettings" - (\ o -> - DfpSettings' <$> - (o .:? "pubPaidPlacementAccepted") <*> - (o .:? "dfpNetworkName") - <*> (o .:? "publisherPortalOnly") - <*> (o .:? "programmaticPlacementAccepted") - <*> (o .:? "dfpNetworkCode")) - -instance ToJSON DfpSettings where - toJSON DfpSettings'{..} - = object - (catMaybes - [("pubPaidPlacementAccepted" .=) <$> - _dsPubPaidPlacementAccepted, - ("dfpNetworkName" .=) <$> _dsDfpNetworkName, - ("publisherPortalOnly" .=) <$> - _dsPublisherPortalOnly, - ("programmaticPlacementAccepted" .=) <$> - _dsProgrammaticPlacementAccepted, - ("dfpNetworkCode" .=) <$> _dsDfpNetworkCode]) - --- | Represents fields that are compatible to be selected for a report of --- type \"PATH_TO_CONVERSION\". --- --- /See:/ 'pathToConversionReportCompatibleFields' smart constructor. -data PathToConversionReportCompatibleFields = PathToConversionReportCompatibleFields' - { _ptcrcfMetrics :: !(Maybe [Metric]) - , _ptcrcfKind :: !Text - , _ptcrcfConversionDimensions :: !(Maybe [Dimension]) - , _ptcrcfCustomFloodlightVariables :: !(Maybe [Dimension]) - , _ptcrcfPerInteractionDimensions :: !(Maybe [Dimension]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'PathToConversionReportCompatibleFields' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'ptcrcfMetrics' --- --- * 'ptcrcfKind' --- --- * 'ptcrcfConversionDimensions' --- --- * 'ptcrcfCustomFloodlightVariables' --- --- * 'ptcrcfPerInteractionDimensions' -pathToConversionReportCompatibleFields - :: PathToConversionReportCompatibleFields -pathToConversionReportCompatibleFields = - PathToConversionReportCompatibleFields' - { _ptcrcfMetrics = Nothing - , _ptcrcfKind = "dfareporting#pathToConversionReportCompatibleFields" - , _ptcrcfConversionDimensions = Nothing - , _ptcrcfCustomFloodlightVariables = Nothing - , _ptcrcfPerInteractionDimensions = Nothing - } - --- | Metrics which are compatible to be selected in the \"metricNames\" --- section of the report. -ptcrcfMetrics :: Lens' PathToConversionReportCompatibleFields [Metric] -ptcrcfMetrics - = lens _ptcrcfMetrics - (\ s a -> s{_ptcrcfMetrics = a}) - . _Default - . _Coerce - --- | The kind of resource this is, in this case --- dfareporting#pathToConversionReportCompatibleFields. -ptcrcfKind :: Lens' PathToConversionReportCompatibleFields Text -ptcrcfKind - = lens _ptcrcfKind (\ s a -> s{_ptcrcfKind = a}) - --- | Conversion dimensions which are compatible to be selected in the --- \"conversionDimensions\" section of the report. -ptcrcfConversionDimensions :: Lens' PathToConversionReportCompatibleFields [Dimension] -ptcrcfConversionDimensions - = lens _ptcrcfConversionDimensions - (\ s a -> s{_ptcrcfConversionDimensions = a}) - . _Default - . _Coerce - --- | Custom floodlight variables which are compatible to be selected in the --- \"customFloodlightVariables\" section of the report. -ptcrcfCustomFloodlightVariables :: Lens' PathToConversionReportCompatibleFields [Dimension] -ptcrcfCustomFloodlightVariables - = lens _ptcrcfCustomFloodlightVariables - (\ s a -> s{_ptcrcfCustomFloodlightVariables = a}) - . _Default - . _Coerce - --- | Per-interaction dimensions which are compatible to be selected in the --- \"perInteractionDimensions\" section of the report. -ptcrcfPerInteractionDimensions :: Lens' PathToConversionReportCompatibleFields [Dimension] -ptcrcfPerInteractionDimensions - = lens _ptcrcfPerInteractionDimensions - (\ s a -> s{_ptcrcfPerInteractionDimensions = a}) - . _Default - . _Coerce - -instance FromJSON - PathToConversionReportCompatibleFields where - parseJSON - = withObject "PathToConversionReportCompatibleFields" - (\ o -> - PathToConversionReportCompatibleFields' <$> - (o .:? "metrics" .!= mempty) <*> - (o .:? "kind" .!= - "dfareporting#pathToConversionReportCompatibleFields") - <*> (o .:? "conversionDimensions" .!= mempty) - <*> (o .:? "customFloodlightVariables" .!= mempty) - <*> (o .:? "perInteractionDimensions" .!= mempty)) - -instance ToJSON - PathToConversionReportCompatibleFields where - toJSON PathToConversionReportCompatibleFields'{..} - = object - (catMaybes - [("metrics" .=) <$> _ptcrcfMetrics, - Just ("kind" .= _ptcrcfKind), - ("conversionDimensions" .=) <$> - _ptcrcfConversionDimensions, - ("customFloodlightVariables" .=) <$> - _ptcrcfCustomFloodlightVariables, - ("perInteractionDimensions" .=) <$> - _ptcrcfPerInteractionDimensions]) - --- | Contains information about a city that can be targeted by ads. --- --- /See:/ 'city' smart constructor. -data City = City' - { _ccMetroCode :: !(Maybe Text) - , _ccRegionCode :: !(Maybe Text) - , _ccKind :: !Text - , _ccRegionDartId :: !(Maybe (Textual Int64)) - , _ccMetroDmaId :: !(Maybe (Textual Int64)) - , _ccName :: !(Maybe Text) - , _ccCountryCode :: !(Maybe Text) - , _ccCountryDartId :: !(Maybe (Textual Int64)) - , _ccDartId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'City' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'ccMetroCode' --- --- * 'ccRegionCode' --- --- * 'ccKind' --- --- * 'ccRegionDartId' --- --- * 'ccMetroDmaId' --- --- * 'ccName' --- --- * 'ccCountryCode' --- --- * 'ccCountryDartId' --- --- * 'ccDartId' -city - :: City -city = - City' - { _ccMetroCode = Nothing - , _ccRegionCode = Nothing - , _ccKind = "dfareporting#city" - , _ccRegionDartId = Nothing - , _ccMetroDmaId = Nothing - , _ccName = Nothing - , _ccCountryCode = Nothing - , _ccCountryDartId = Nothing - , _ccDartId = Nothing - } - --- | Metro region code of the metro region (DMA) to which this city belongs. -ccMetroCode :: Lens' City (Maybe Text) -ccMetroCode - = lens _ccMetroCode (\ s a -> s{_ccMetroCode = a}) - --- | Region code of the region to which this city belongs. -ccRegionCode :: Lens' City (Maybe Text) -ccRegionCode - = lens _ccRegionCode (\ s a -> s{_ccRegionCode = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#city\". -ccKind :: Lens' City Text -ccKind = lens _ccKind (\ s a -> s{_ccKind = a}) - --- | DART ID of the region to which this city belongs. -ccRegionDartId :: Lens' City (Maybe Int64) -ccRegionDartId - = lens _ccRegionDartId - (\ s a -> s{_ccRegionDartId = a}) - . mapping _Coerce - --- | ID of the metro region (DMA) to which this city belongs. -ccMetroDmaId :: Lens' City (Maybe Int64) -ccMetroDmaId - = lens _ccMetroDmaId (\ s a -> s{_ccMetroDmaId = a}) - . mapping _Coerce - --- | Name of this city. -ccName :: Lens' City (Maybe Text) -ccName = lens _ccName (\ s a -> s{_ccName = a}) - --- | Country code of the country to which this city belongs. -ccCountryCode :: Lens' City (Maybe Text) -ccCountryCode - = lens _ccCountryCode - (\ s a -> s{_ccCountryCode = a}) - --- | DART ID of the country to which this city belongs. -ccCountryDartId :: Lens' City (Maybe Int64) -ccCountryDartId - = lens _ccCountryDartId - (\ s a -> s{_ccCountryDartId = a}) - . mapping _Coerce - --- | DART ID of this city. This is the ID used for targeting and generating --- reports. -ccDartId :: Lens' City (Maybe Int64) -ccDartId - = lens _ccDartId (\ s a -> s{_ccDartId = a}) . - mapping _Coerce - -instance FromJSON City where - parseJSON - = withObject "City" - (\ o -> - City' <$> - (o .:? "metroCode") <*> (o .:? "regionCode") <*> - (o .:? "kind" .!= "dfareporting#city") - <*> (o .:? "regionDartId") - <*> (o .:? "metroDmaId") - <*> (o .:? "name") - <*> (o .:? "countryCode") - <*> (o .:? "countryDartId") - <*> (o .:? "dartId")) - -instance ToJSON City where - toJSON City'{..} - = object - (catMaybes - [("metroCode" .=) <$> _ccMetroCode, - ("regionCode" .=) <$> _ccRegionCode, - Just ("kind" .= _ccKind), - ("regionDartId" .=) <$> _ccRegionDartId, - ("metroDmaId" .=) <$> _ccMetroDmaId, - ("name" .=) <$> _ccName, - ("countryCode" .=) <$> _ccCountryCode, - ("countryDartId" .=) <$> _ccCountryDartId, - ("dartId" .=) <$> _ccDartId]) - --- | Contains information about a platform type that can be targeted by ads. --- --- /See:/ 'platformType' smart constructor. -data PlatformType = PlatformType' - { _ptKind :: !Text - , _ptName :: !(Maybe Text) - , _ptId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'PlatformType' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'ptKind' --- --- * 'ptName' --- --- * 'ptId' -platformType - :: PlatformType -platformType = - PlatformType' - { _ptKind = "dfareporting#platformType" - , _ptName = Nothing - , _ptId = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#platformType\". -ptKind :: Lens' PlatformType Text -ptKind = lens _ptKind (\ s a -> s{_ptKind = a}) - --- | Name of this platform type. -ptName :: Lens' PlatformType (Maybe Text) -ptName = lens _ptName (\ s a -> s{_ptName = a}) - --- | ID of this platform type. -ptId :: Lens' PlatformType (Maybe Int64) -ptId - = lens _ptId (\ s a -> s{_ptId = a}) . - mapping _Coerce - -instance FromJSON PlatformType where - parseJSON - = withObject "PlatformType" - (\ o -> - PlatformType' <$> - (o .:? "kind" .!= "dfareporting#platformType") <*> - (o .:? "name") - <*> (o .:? "id")) - -instance ToJSON PlatformType where - toJSON PlatformType'{..} - = object - (catMaybes - [Just ("kind" .= _ptKind), ("name" .=) <$> _ptName, - ("id" .=) <$> _ptId]) - --- | Key Value Targeting Expression. --- --- /See:/ 'keyValueTargetingExpression' smart constructor. -newtype KeyValueTargetingExpression = KeyValueTargetingExpression' - { _kvteExpression :: Maybe Text - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'KeyValueTargetingExpression' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'kvteExpression' -keyValueTargetingExpression - :: KeyValueTargetingExpression -keyValueTargetingExpression = - KeyValueTargetingExpression' - { _kvteExpression = Nothing - } - --- | Keyword expression being targeted by the ad. -kvteExpression :: Lens' KeyValueTargetingExpression (Maybe Text) -kvteExpression - = lens _kvteExpression - (\ s a -> s{_kvteExpression = a}) - -instance FromJSON KeyValueTargetingExpression where - parseJSON - = withObject "KeyValueTargetingExpression" - (\ o -> - KeyValueTargetingExpression' <$> - (o .:? "expression")) - -instance ToJSON KeyValueTargetingExpression where - toJSON KeyValueTargetingExpression'{..} - = object - (catMaybes [("expression" .=) <$> _kvteExpression]) - --- | Companion Click-through override. --- --- /See:/ 'companionClickThroughOverride' smart constructor. -data CompanionClickThroughOverride = CompanionClickThroughOverride' - { _cctoCreativeId :: !(Maybe (Textual Int64)) - , _cctoClickThroughURL :: !(Maybe ClickThroughURL) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'CompanionClickThroughOverride' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'cctoCreativeId' --- --- * 'cctoClickThroughURL' -companionClickThroughOverride - :: CompanionClickThroughOverride -companionClickThroughOverride = - CompanionClickThroughOverride' - { _cctoCreativeId = Nothing - , _cctoClickThroughURL = Nothing - } - --- | ID of the creative for this companion click-through override. -cctoCreativeId :: Lens' CompanionClickThroughOverride (Maybe Int64) -cctoCreativeId - = lens _cctoCreativeId - (\ s a -> s{_cctoCreativeId = a}) - . mapping _Coerce - --- | Click-through URL of this companion click-through override. -cctoClickThroughURL :: Lens' CompanionClickThroughOverride (Maybe ClickThroughURL) -cctoClickThroughURL - = lens _cctoClickThroughURL - (\ s a -> s{_cctoClickThroughURL = a}) - -instance FromJSON CompanionClickThroughOverride where - parseJSON - = withObject "CompanionClickThroughOverride" - (\ o -> - CompanionClickThroughOverride' <$> - (o .:? "creativeId") <*> (o .:? "clickThroughUrl")) - -instance ToJSON CompanionClickThroughOverride where - toJSON CompanionClickThroughOverride'{..} - = object - (catMaybes - [("creativeId" .=) <$> _cctoCreativeId, - ("clickThroughUrl" .=) <$> _cctoClickThroughURL]) - --- | Advertiser List Response --- --- /See:/ 'advertisersListResponse' smart constructor. -data AdvertisersListResponse = AdvertisersListResponse' - { _advNextPageToken :: !(Maybe Text) - , _advKind :: !Text - , _advAdvertisers :: !(Maybe [Advertiser]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'AdvertisersListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'advNextPageToken' --- --- * 'advKind' --- --- * 'advAdvertisers' -advertisersListResponse - :: AdvertisersListResponse -advertisersListResponse = - AdvertisersListResponse' - { _advNextPageToken = Nothing - , _advKind = "dfareporting#advertisersListResponse" - , _advAdvertisers = Nothing - } - --- | Pagination token to be used for the next list operation. -advNextPageToken :: Lens' AdvertisersListResponse (Maybe Text) -advNextPageToken - = lens _advNextPageToken - (\ s a -> s{_advNextPageToken = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#advertisersListResponse\". -advKind :: Lens' AdvertisersListResponse Text -advKind = lens _advKind (\ s a -> s{_advKind = a}) - --- | Advertiser collection. -advAdvertisers :: Lens' AdvertisersListResponse [Advertiser] -advAdvertisers - = lens _advAdvertisers - (\ s a -> s{_advAdvertisers = a}) - . _Default - . _Coerce - -instance FromJSON AdvertisersListResponse where - parseJSON - = withObject "AdvertisersListResponse" - (\ o -> - AdvertisersListResponse' <$> - (o .:? "nextPageToken") <*> - (o .:? "kind" .!= - "dfareporting#advertisersListResponse") - <*> (o .:? "advertisers" .!= mempty)) - -instance ToJSON AdvertisersListResponse where - toJSON AdvertisersListResponse'{..} - = object - (catMaybes - [("nextPageToken" .=) <$> _advNextPageToken, - Just ("kind" .= _advKind), - ("advertisers" .=) <$> _advAdvertisers]) - --- | Country List Response --- --- /See:/ 'countriesListResponse' smart constructor. -data CountriesListResponse = CountriesListResponse' - { _couKind :: !Text - , _couCountries :: !(Maybe [Country]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'CountriesListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'couKind' --- --- * 'couCountries' -countriesListResponse - :: CountriesListResponse -countriesListResponse = - CountriesListResponse' - { _couKind = "dfareporting#countriesListResponse" - , _couCountries = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#countriesListResponse\". -couKind :: Lens' CountriesListResponse Text -couKind = lens _couKind (\ s a -> s{_couKind = a}) - --- | Country collection. -couCountries :: Lens' CountriesListResponse [Country] -couCountries - = lens _couCountries (\ s a -> s{_couCountries = a}) - . _Default - . _Coerce - -instance FromJSON CountriesListResponse where - parseJSON - = withObject "CountriesListResponse" - (\ o -> - CountriesListResponse' <$> - (o .:? "kind" .!= - "dfareporting#countriesListResponse") - <*> (o .:? "countries" .!= mempty)) - -instance ToJSON CountriesListResponse where - toJSON CountriesListResponse'{..} - = object - (catMaybes - [Just ("kind" .= _couKind), - ("countries" .=) <$> _couCountries]) - --- | Account Permission Group List Response --- --- /See:/ 'accountPermissionGroupsListResponse' smart constructor. -data AccountPermissionGroupsListResponse = AccountPermissionGroupsListResponse' - { _apglrKind :: !Text - , _apglrAccountPermissionGroups :: !(Maybe [AccountPermissionGroup]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'AccountPermissionGroupsListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'apglrKind' --- --- * 'apglrAccountPermissionGroups' -accountPermissionGroupsListResponse - :: AccountPermissionGroupsListResponse -accountPermissionGroupsListResponse = - AccountPermissionGroupsListResponse' - { _apglrKind = "dfareporting#accountPermissionGroupsListResponse" - , _apglrAccountPermissionGroups = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#accountPermissionGroupsListResponse\". -apglrKind :: Lens' AccountPermissionGroupsListResponse Text -apglrKind - = lens _apglrKind (\ s a -> s{_apglrKind = a}) - --- | Account permission group collection. -apglrAccountPermissionGroups :: Lens' AccountPermissionGroupsListResponse [AccountPermissionGroup] -apglrAccountPermissionGroups - = lens _apglrAccountPermissionGroups - (\ s a -> s{_apglrAccountPermissionGroups = a}) - . _Default - . _Coerce - -instance FromJSON AccountPermissionGroupsListResponse - where - parseJSON - = withObject "AccountPermissionGroupsListResponse" - (\ o -> - AccountPermissionGroupsListResponse' <$> - (o .:? "kind" .!= - "dfareporting#accountPermissionGroupsListResponse") - <*> (o .:? "accountPermissionGroups" .!= mempty)) - -instance ToJSON AccountPermissionGroupsListResponse - where - toJSON AccountPermissionGroupsListResponse'{..} - = object - (catMaybes - [Just ("kind" .= _apglrKind), - ("accountPermissionGroups" .=) <$> - _apglrAccountPermissionGroups]) - --- | Popup Window Properties. --- --- /See:/ 'popupWindowProperties' smart constructor. -data PopupWindowProperties = PopupWindowProperties' - { _pwpOffSet :: !(Maybe OffSetPosition) - , _pwpDimension :: !(Maybe Size) - , _pwpShowStatusBar :: !(Maybe Bool) - , _pwpShowMenuBar :: !(Maybe Bool) - , _pwpPositionType :: !(Maybe PopupWindowPropertiesPositionType) - , _pwpShowAddressBar :: !(Maybe Bool) - , _pwpShowScrollBar :: !(Maybe Bool) - , _pwpShowToolBar :: !(Maybe Bool) - , _pwpTitle :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'PopupWindowProperties' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'pwpOffSet' --- --- * 'pwpDimension' --- --- * 'pwpShowStatusBar' --- --- * 'pwpShowMenuBar' --- --- * 'pwpPositionType' --- --- * 'pwpShowAddressBar' --- --- * 'pwpShowScrollBar' --- --- * 'pwpShowToolBar' --- --- * 'pwpTitle' -popupWindowProperties - :: PopupWindowProperties -popupWindowProperties = - PopupWindowProperties' - { _pwpOffSet = Nothing - , _pwpDimension = Nothing - , _pwpShowStatusBar = Nothing - , _pwpShowMenuBar = Nothing - , _pwpPositionType = Nothing - , _pwpShowAddressBar = Nothing - , _pwpShowScrollBar = Nothing - , _pwpShowToolBar = Nothing - , _pwpTitle = Nothing - } - --- | Upper-left corner coordinates of the popup window. Applicable if --- positionType is COORDINATES. -pwpOffSet :: Lens' PopupWindowProperties (Maybe OffSetPosition) -pwpOffSet - = lens _pwpOffSet (\ s a -> s{_pwpOffSet = a}) - --- | Popup dimension for a creative. This is a read-only field. Applicable to --- the following creative types: all RICH_MEDIA and all VPAID -pwpDimension :: Lens' PopupWindowProperties (Maybe Size) -pwpDimension - = lens _pwpDimension (\ s a -> s{_pwpDimension = a}) - --- | Whether to display the browser status bar. -pwpShowStatusBar :: Lens' PopupWindowProperties (Maybe Bool) -pwpShowStatusBar - = lens _pwpShowStatusBar - (\ s a -> s{_pwpShowStatusBar = a}) - --- | Whether to display the browser menu bar. -pwpShowMenuBar :: Lens' PopupWindowProperties (Maybe Bool) -pwpShowMenuBar - = lens _pwpShowMenuBar - (\ s a -> s{_pwpShowMenuBar = a}) - --- | Popup window position either centered or at specific coordinate. -pwpPositionType :: Lens' PopupWindowProperties (Maybe PopupWindowPropertiesPositionType) -pwpPositionType - = lens _pwpPositionType - (\ s a -> s{_pwpPositionType = a}) - --- | Whether to display the browser address bar. -pwpShowAddressBar :: Lens' PopupWindowProperties (Maybe Bool) -pwpShowAddressBar - = lens _pwpShowAddressBar - (\ s a -> s{_pwpShowAddressBar = a}) - --- | Whether to display the browser scroll bar. -pwpShowScrollBar :: Lens' PopupWindowProperties (Maybe Bool) -pwpShowScrollBar - = lens _pwpShowScrollBar - (\ s a -> s{_pwpShowScrollBar = a}) - --- | Whether to display the browser tool bar. -pwpShowToolBar :: Lens' PopupWindowProperties (Maybe Bool) -pwpShowToolBar - = lens _pwpShowToolBar - (\ s a -> s{_pwpShowToolBar = a}) - --- | Title of popup window. -pwpTitle :: Lens' PopupWindowProperties (Maybe Text) -pwpTitle = lens _pwpTitle (\ s a -> s{_pwpTitle = a}) - -instance FromJSON PopupWindowProperties where - parseJSON - = withObject "PopupWindowProperties" - (\ o -> - PopupWindowProperties' <$> - (o .:? "offset") <*> (o .:? "dimension") <*> - (o .:? "showStatusBar") - <*> (o .:? "showMenuBar") - <*> (o .:? "positionType") - <*> (o .:? "showAddressBar") - <*> (o .:? "showScrollBar") - <*> (o .:? "showToolBar") - <*> (o .:? "title")) - -instance ToJSON PopupWindowProperties where - toJSON PopupWindowProperties'{..} - = object - (catMaybes - [("offset" .=) <$> _pwpOffSet, - ("dimension" .=) <$> _pwpDimension, - ("showStatusBar" .=) <$> _pwpShowStatusBar, - ("showMenuBar" .=) <$> _pwpShowMenuBar, - ("positionType" .=) <$> _pwpPositionType, - ("showAddressBar" .=) <$> _pwpShowAddressBar, - ("showScrollBar" .=) <$> _pwpShowScrollBar, - ("showToolBar" .=) <$> _pwpShowToolBar, - ("title" .=) <$> _pwpTitle]) - --- | Event tag override information. --- --- /See:/ 'eventTagOverride' smart constructor. -data EventTagOverride = EventTagOverride' - { _etoEnabled :: !(Maybe Bool) - , _etoId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'EventTagOverride' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'etoEnabled' --- --- * 'etoId' -eventTagOverride - :: EventTagOverride -eventTagOverride = - EventTagOverride' - { _etoEnabled = Nothing - , _etoId = Nothing - } - --- | Whether this override is enabled. -etoEnabled :: Lens' EventTagOverride (Maybe Bool) -etoEnabled - = lens _etoEnabled (\ s a -> s{_etoEnabled = a}) - --- | ID of this event tag override. This is a read-only, auto-generated --- field. -etoId :: Lens' EventTagOverride (Maybe Int64) -etoId - = lens _etoId (\ s a -> s{_etoId = a}) . - mapping _Coerce - -instance FromJSON EventTagOverride where - parseJSON - = withObject "EventTagOverride" - (\ o -> - EventTagOverride' <$> - (o .:? "enabled") <*> (o .:? "id")) - -instance ToJSON EventTagOverride where - toJSON EventTagOverride'{..} - = object - (catMaybes - [("enabled" .=) <$> _etoEnabled, - ("id" .=) <$> _etoId]) - --- | Contains information about a particular version of an operating system --- that can be targeted by ads. --- --- /See:/ 'operatingSystemVersion' smart constructor. -data OperatingSystemVersion = OperatingSystemVersion' - { _osvMinorVersion :: !(Maybe Text) - , _osvKind :: !Text - , _osvOperatingSystem :: !(Maybe OperatingSystem) - , _osvMajorVersion :: !(Maybe Text) - , _osvName :: !(Maybe Text) - , _osvId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'OperatingSystemVersion' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'osvMinorVersion' --- --- * 'osvKind' --- --- * 'osvOperatingSystem' --- --- * 'osvMajorVersion' --- --- * 'osvName' --- --- * 'osvId' -operatingSystemVersion - :: OperatingSystemVersion -operatingSystemVersion = - OperatingSystemVersion' - { _osvMinorVersion = Nothing - , _osvKind = "dfareporting#operatingSystemVersion" - , _osvOperatingSystem = Nothing - , _osvMajorVersion = Nothing - , _osvName = Nothing - , _osvId = Nothing - } - --- | Minor version (number after the first dot) of this operating system --- version. -osvMinorVersion :: Lens' OperatingSystemVersion (Maybe Text) -osvMinorVersion - = lens _osvMinorVersion - (\ s a -> s{_osvMinorVersion = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#operatingSystemVersion\". -osvKind :: Lens' OperatingSystemVersion Text -osvKind = lens _osvKind (\ s a -> s{_osvKind = a}) - --- | Operating system of this operating system version. -osvOperatingSystem :: Lens' OperatingSystemVersion (Maybe OperatingSystem) -osvOperatingSystem - = lens _osvOperatingSystem - (\ s a -> s{_osvOperatingSystem = a}) - --- | Major version (leftmost number) of this operating system version. -osvMajorVersion :: Lens' OperatingSystemVersion (Maybe Text) -osvMajorVersion - = lens _osvMajorVersion - (\ s a -> s{_osvMajorVersion = a}) - --- | Name of this operating system version. -osvName :: Lens' OperatingSystemVersion (Maybe Text) -osvName = lens _osvName (\ s a -> s{_osvName = a}) - --- | ID of this operating system version. -osvId :: Lens' OperatingSystemVersion (Maybe Int64) -osvId - = lens _osvId (\ s a -> s{_osvId = a}) . - mapping _Coerce - -instance FromJSON OperatingSystemVersion where - parseJSON - = withObject "OperatingSystemVersion" - (\ o -> - OperatingSystemVersion' <$> - (o .:? "minorVersion") <*> - (o .:? "kind" .!= - "dfareporting#operatingSystemVersion") - <*> (o .:? "operatingSystem") - <*> (o .:? "majorVersion") - <*> (o .:? "name") - <*> (o .:? "id")) - -instance ToJSON OperatingSystemVersion where - toJSON OperatingSystemVersion'{..} - = object - (catMaybes - [("minorVersion" .=) <$> _osvMinorVersion, - Just ("kind" .= _osvKind), - ("operatingSystem" .=) <$> _osvOperatingSystem, - ("majorVersion" .=) <$> _osvMajorVersion, - ("name" .=) <$> _osvName, ("id" .=) <$> _osvId]) - --- | AccountPermissions contains information about a particular account --- permission. Some features of Campaign Manager require an account --- permission to be present in the account. --- --- /See:/ 'accountPermission' smart constructor. -data AccountPermission = AccountPermission' - { _acccKind :: !Text - , _acccAccountProFiles :: !(Maybe [AccountPermissionAccountProFilesItem]) - , _acccName :: !(Maybe Text) - , _acccId :: !(Maybe (Textual Int64)) - , _acccLevel :: !(Maybe AccountPermissionLevel) - , _acccPermissionGroupId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'AccountPermission' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'acccKind' --- --- * 'acccAccountProFiles' --- --- * 'acccName' --- --- * 'acccId' --- --- * 'acccLevel' --- --- * 'acccPermissionGroupId' -accountPermission - :: AccountPermission -accountPermission = - AccountPermission' - { _acccKind = "dfareporting#accountPermission" - , _acccAccountProFiles = Nothing - , _acccName = Nothing - , _acccId = Nothing - , _acccLevel = Nothing - , _acccPermissionGroupId = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#accountPermission\". -acccKind :: Lens' AccountPermission Text -acccKind = lens _acccKind (\ s a -> s{_acccKind = a}) - --- | Account profiles associated with this account permission. Possible --- values are: - \"ACCOUNT_PROFILE_BASIC\" - \"ACCOUNT_PROFILE_STANDARD\" -acccAccountProFiles :: Lens' AccountPermission [AccountPermissionAccountProFilesItem] -acccAccountProFiles - = lens _acccAccountProFiles - (\ s a -> s{_acccAccountProFiles = a}) - . _Default - . _Coerce - --- | Name of this account permission. -acccName :: Lens' AccountPermission (Maybe Text) -acccName = lens _acccName (\ s a -> s{_acccName = a}) - --- | ID of this account permission. -acccId :: Lens' AccountPermission (Maybe Int64) -acccId - = lens _acccId (\ s a -> s{_acccId = a}) . - mapping _Coerce - --- | Administrative level required to enable this account permission. -acccLevel :: Lens' AccountPermission (Maybe AccountPermissionLevel) -acccLevel - = lens _acccLevel (\ s a -> s{_acccLevel = a}) - --- | Permission group of this account permission. -acccPermissionGroupId :: Lens' AccountPermission (Maybe Int64) -acccPermissionGroupId - = lens _acccPermissionGroupId - (\ s a -> s{_acccPermissionGroupId = a}) - . mapping _Coerce - -instance FromJSON AccountPermission where - parseJSON - = withObject "AccountPermission" - (\ o -> - AccountPermission' <$> - (o .:? "kind" .!= "dfareporting#accountPermission") - <*> (o .:? "accountProfiles" .!= mempty) - <*> (o .:? "name") - <*> (o .:? "id") - <*> (o .:? "level") - <*> (o .:? "permissionGroupId")) - -instance ToJSON AccountPermission where - toJSON AccountPermission'{..} - = object - (catMaybes - [Just ("kind" .= _acccKind), - ("accountProfiles" .=) <$> _acccAccountProFiles, - ("name" .=) <$> _acccName, ("id" .=) <$> _acccId, - ("level" .=) <$> _acccLevel, - ("permissionGroupId" .=) <$> _acccPermissionGroupId]) - --- | Represents a UserProfile resource. --- --- /See:/ 'userProFile' smart constructor. -data UserProFile = UserProFile' - { _upfEtag :: !(Maybe Text) - , _upfKind :: !Text - , _upfAccountName :: !(Maybe Text) - , _upfProFileId :: !(Maybe (Textual Int64)) - , _upfUserName :: !(Maybe Text) - , _upfAccountId :: !(Maybe (Textual Int64)) - , _upfSubAccountName :: !(Maybe Text) - , _upfSubAccountId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'UserProFile' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'upfEtag' --- --- * 'upfKind' --- --- * 'upfAccountName' --- --- * 'upfProFileId' --- --- * 'upfUserName' --- --- * 'upfAccountId' --- --- * 'upfSubAccountName' --- --- * 'upfSubAccountId' -userProFile - :: UserProFile -userProFile = - UserProFile' - { _upfEtag = Nothing - , _upfKind = "dfareporting#userProfile" - , _upfAccountName = Nothing - , _upfProFileId = Nothing - , _upfUserName = Nothing - , _upfAccountId = Nothing - , _upfSubAccountName = Nothing - , _upfSubAccountId = Nothing - } - --- | The eTag of this response for caching purposes. -upfEtag :: Lens' UserProFile (Maybe Text) -upfEtag = lens _upfEtag (\ s a -> s{_upfEtag = a}) - --- | The kind of resource this is, in this case dfareporting#userProfile. -upfKind :: Lens' UserProFile Text -upfKind = lens _upfKind (\ s a -> s{_upfKind = a}) - --- | The account name this profile belongs to. -upfAccountName :: Lens' UserProFile (Maybe Text) -upfAccountName - = lens _upfAccountName - (\ s a -> s{_upfAccountName = a}) - --- | The unique ID of the user profile. -upfProFileId :: Lens' UserProFile (Maybe Int64) -upfProFileId - = lens _upfProFileId (\ s a -> s{_upfProFileId = a}) - . mapping _Coerce - --- | The user name. -upfUserName :: Lens' UserProFile (Maybe Text) -upfUserName - = lens _upfUserName (\ s a -> s{_upfUserName = a}) - --- | The account ID to which this profile belongs. -upfAccountId :: Lens' UserProFile (Maybe Int64) -upfAccountId - = lens _upfAccountId (\ s a -> s{_upfAccountId = a}) - . mapping _Coerce - --- | The sub account name this profile belongs to if applicable. -upfSubAccountName :: Lens' UserProFile (Maybe Text) -upfSubAccountName - = lens _upfSubAccountName - (\ s a -> s{_upfSubAccountName = a}) - --- | The sub account ID this profile belongs to if applicable. -upfSubAccountId :: Lens' UserProFile (Maybe Int64) -upfSubAccountId - = lens _upfSubAccountId - (\ s a -> s{_upfSubAccountId = a}) - . mapping _Coerce - -instance FromJSON UserProFile where - parseJSON - = withObject "UserProFile" - (\ o -> - UserProFile' <$> - (o .:? "etag") <*> - (o .:? "kind" .!= "dfareporting#userProfile") - <*> (o .:? "accountName") - <*> (o .:? "profileId") - <*> (o .:? "userName") - <*> (o .:? "accountId") - <*> (o .:? "subAccountName") - <*> (o .:? "subAccountId")) - -instance ToJSON UserProFile where - toJSON UserProFile'{..} - = object - (catMaybes - [("etag" .=) <$> _upfEtag, Just ("kind" .= _upfKind), - ("accountName" .=) <$> _upfAccountName, - ("profileId" .=) <$> _upfProFileId, - ("userName" .=) <$> _upfUserName, - ("accountId" .=) <$> _upfAccountId, - ("subAccountName" .=) <$> _upfSubAccountName, - ("subAccountId" .=) <$> _upfSubAccountId]) - --- | Operating System List Response --- --- /See:/ 'operatingSystemsListResponse' smart constructor. -data OperatingSystemsListResponse = OperatingSystemsListResponse' - { _oslrKind :: !Text - , _oslrOperatingSystems :: !(Maybe [OperatingSystem]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'OperatingSystemsListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'oslrKind' --- --- * 'oslrOperatingSystems' -operatingSystemsListResponse - :: OperatingSystemsListResponse -operatingSystemsListResponse = - OperatingSystemsListResponse' - { _oslrKind = "dfareporting#operatingSystemsListResponse" - , _oslrOperatingSystems = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#operatingSystemsListResponse\". -oslrKind :: Lens' OperatingSystemsListResponse Text -oslrKind = lens _oslrKind (\ s a -> s{_oslrKind = a}) - --- | Operating system collection. -oslrOperatingSystems :: Lens' OperatingSystemsListResponse [OperatingSystem] -oslrOperatingSystems - = lens _oslrOperatingSystems - (\ s a -> s{_oslrOperatingSystems = a}) - . _Default - . _Coerce - -instance FromJSON OperatingSystemsListResponse where - parseJSON - = withObject "OperatingSystemsListResponse" - (\ o -> - OperatingSystemsListResponse' <$> - (o .:? "kind" .!= - "dfareporting#operatingSystemsListResponse") - <*> (o .:? "operatingSystems" .!= mempty)) - -instance ToJSON OperatingSystemsListResponse where - toJSON OperatingSystemsListResponse'{..} - = object - (catMaybes - [Just ("kind" .= _oslrKind), - ("operatingSystems" .=) <$> _oslrOperatingSystems]) - --- | The report\'s email delivery settings. --- --- /See:/ 'reportDelivery' smart constructor. -data ReportDelivery = ReportDelivery' - { _rdEmailOwner :: !(Maybe Bool) - , _rdRecipients :: !(Maybe [Recipient]) - , _rdMessage :: !(Maybe Text) - , _rdEmailOwnerDeliveryType :: !(Maybe ReportDeliveryEmailOwnerDeliveryType) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'ReportDelivery' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'rdEmailOwner' --- --- * 'rdRecipients' --- --- * 'rdMessage' --- --- * 'rdEmailOwnerDeliveryType' -reportDelivery - :: ReportDelivery -reportDelivery = - ReportDelivery' - { _rdEmailOwner = Nothing - , _rdRecipients = Nothing - , _rdMessage = Nothing - , _rdEmailOwnerDeliveryType = Nothing - } - --- | Whether the report should be emailed to the report owner. -rdEmailOwner :: Lens' ReportDelivery (Maybe Bool) -rdEmailOwner - = lens _rdEmailOwner (\ s a -> s{_rdEmailOwner = a}) - --- | The list of recipients to which to email the report. -rdRecipients :: Lens' ReportDelivery [Recipient] -rdRecipients - = lens _rdRecipients (\ s a -> s{_rdRecipients = a}) - . _Default - . _Coerce - --- | The message to be sent with each email. -rdMessage :: Lens' ReportDelivery (Maybe Text) -rdMessage - = lens _rdMessage (\ s a -> s{_rdMessage = a}) - --- | The type of delivery for the owner to receive, if enabled. -rdEmailOwnerDeliveryType :: Lens' ReportDelivery (Maybe ReportDeliveryEmailOwnerDeliveryType) -rdEmailOwnerDeliveryType - = lens _rdEmailOwnerDeliveryType - (\ s a -> s{_rdEmailOwnerDeliveryType = a}) - -instance FromJSON ReportDelivery where - parseJSON - = withObject "ReportDelivery" - (\ o -> - ReportDelivery' <$> - (o .:? "emailOwner") <*> - (o .:? "recipients" .!= mempty) - <*> (o .:? "message") - <*> (o .:? "emailOwnerDeliveryType")) - -instance ToJSON ReportDelivery where - toJSON ReportDelivery'{..} - = object - (catMaybes - [("emailOwner" .=) <$> _rdEmailOwner, - ("recipients" .=) <$> _rdRecipients, - ("message" .=) <$> _rdMessage, - ("emailOwnerDeliveryType" .=) <$> - _rdEmailOwnerDeliveryType]) - --- | Contains properties of a targetable remarketing list. Remarketing --- enables you to create lists of users who have performed specific actions --- on a site, then target ads to members of those lists. This resource is a --- read-only view of a remarketing list to be used to faciliate targeting --- ads to specific lists. Remarketing lists that are owned by your --- advertisers and those that are shared to your advertisers or account are --- accessible via this resource. To manage remarketing lists that are owned --- by your advertisers, use the RemarketingLists resource. --- --- /See:/ 'targetableRemarketingList' smart constructor. -data TargetableRemarketingList = TargetableRemarketingList' - { _trlListSize :: !(Maybe (Textual Int64)) - , _trlLifeSpan :: !(Maybe (Textual Int64)) - , _trlKind :: !Text - , _trlAdvertiserId :: !(Maybe (Textual Int64)) - , _trlAdvertiserIdDimensionValue :: !(Maybe DimensionValue) - , _trlActive :: !(Maybe Bool) - , _trlAccountId :: !(Maybe (Textual Int64)) - , _trlName :: !(Maybe Text) - , _trlListSource :: !(Maybe TargetableRemarketingListListSource) - , _trlId :: !(Maybe (Textual Int64)) - , _trlSubAccountId :: !(Maybe (Textual Int64)) - , _trlDescription :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'TargetableRemarketingList' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'trlListSize' --- --- * 'trlLifeSpan' --- --- * 'trlKind' --- --- * 'trlAdvertiserId' --- --- * 'trlAdvertiserIdDimensionValue' --- --- * 'trlActive' --- --- * 'trlAccountId' --- --- * 'trlName' --- --- * 'trlListSource' --- --- * 'trlId' --- --- * 'trlSubAccountId' --- --- * 'trlDescription' -targetableRemarketingList - :: TargetableRemarketingList -targetableRemarketingList = - TargetableRemarketingList' - { _trlListSize = Nothing - , _trlLifeSpan = Nothing - , _trlKind = "dfareporting#targetableRemarketingList" - , _trlAdvertiserId = Nothing - , _trlAdvertiserIdDimensionValue = Nothing - , _trlActive = Nothing - , _trlAccountId = Nothing - , _trlName = Nothing - , _trlListSource = Nothing - , _trlId = Nothing - , _trlSubAccountId = Nothing - , _trlDescription = Nothing - } - --- | Number of users currently in the list. This is a read-only field. -trlListSize :: Lens' TargetableRemarketingList (Maybe Int64) -trlListSize - = lens _trlListSize (\ s a -> s{_trlListSize = a}) . - mapping _Coerce - --- | Number of days that a user should remain in the targetable remarketing --- list without an impression. -trlLifeSpan :: Lens' TargetableRemarketingList (Maybe Int64) -trlLifeSpan - = lens _trlLifeSpan (\ s a -> s{_trlLifeSpan = a}) . - mapping _Coerce - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#targetableRemarketingList\". -trlKind :: Lens' TargetableRemarketingList Text -trlKind = lens _trlKind (\ s a -> s{_trlKind = a}) - --- | Dimension value for the advertiser ID that owns this targetable --- remarketing list. -trlAdvertiserId :: Lens' TargetableRemarketingList (Maybe Int64) -trlAdvertiserId - = lens _trlAdvertiserId - (\ s a -> s{_trlAdvertiserId = a}) - . mapping _Coerce - --- | Dimension value for the ID of the advertiser. -trlAdvertiserIdDimensionValue :: Lens' TargetableRemarketingList (Maybe DimensionValue) -trlAdvertiserIdDimensionValue - = lens _trlAdvertiserIdDimensionValue - (\ s a -> s{_trlAdvertiserIdDimensionValue = a}) - --- | Whether this targetable remarketing list is active. -trlActive :: Lens' TargetableRemarketingList (Maybe Bool) -trlActive - = lens _trlActive (\ s a -> s{_trlActive = a}) - --- | Account ID of this remarketing list. This is a read-only, auto-generated --- field that is only returned in GET requests. -trlAccountId :: Lens' TargetableRemarketingList (Maybe Int64) -trlAccountId - = lens _trlAccountId (\ s a -> s{_trlAccountId = a}) - . mapping _Coerce - --- | Name of the targetable remarketing list. Is no greater than 128 --- characters long. -trlName :: Lens' TargetableRemarketingList (Maybe Text) -trlName = lens _trlName (\ s a -> s{_trlName = a}) - --- | Product from which this targetable remarketing list was originated. -trlListSource :: Lens' TargetableRemarketingList (Maybe TargetableRemarketingListListSource) -trlListSource - = lens _trlListSource - (\ s a -> s{_trlListSource = a}) - --- | Targetable remarketing list ID. -trlId :: Lens' TargetableRemarketingList (Maybe Int64) -trlId - = lens _trlId (\ s a -> s{_trlId = a}) . - mapping _Coerce - --- | Subaccount ID of this remarketing list. This is a read-only, --- auto-generated field that is only returned in GET requests. -trlSubAccountId :: Lens' TargetableRemarketingList (Maybe Int64) -trlSubAccountId - = lens _trlSubAccountId - (\ s a -> s{_trlSubAccountId = a}) - . mapping _Coerce - --- | Targetable remarketing list description. -trlDescription :: Lens' TargetableRemarketingList (Maybe Text) -trlDescription - = lens _trlDescription - (\ s a -> s{_trlDescription = a}) - -instance FromJSON TargetableRemarketingList where - parseJSON - = withObject "TargetableRemarketingList" - (\ o -> - TargetableRemarketingList' <$> - (o .:? "listSize") <*> (o .:? "lifeSpan") <*> - (o .:? "kind" .!= - "dfareporting#targetableRemarketingList") - <*> (o .:? "advertiserId") - <*> (o .:? "advertiserIdDimensionValue") - <*> (o .:? "active") - <*> (o .:? "accountId") - <*> (o .:? "name") - <*> (o .:? "listSource") - <*> (o .:? "id") - <*> (o .:? "subaccountId") - <*> (o .:? "description")) - -instance ToJSON TargetableRemarketingList where - toJSON TargetableRemarketingList'{..} - = object - (catMaybes - [("listSize" .=) <$> _trlListSize, - ("lifeSpan" .=) <$> _trlLifeSpan, - Just ("kind" .= _trlKind), - ("advertiserId" .=) <$> _trlAdvertiserId, - ("advertiserIdDimensionValue" .=) <$> - _trlAdvertiserIdDimensionValue, - ("active" .=) <$> _trlActive, - ("accountId" .=) <$> _trlAccountId, - ("name" .=) <$> _trlName, - ("listSource" .=) <$> _trlListSource, - ("id" .=) <$> _trlId, - ("subaccountId" .=) <$> _trlSubAccountId, - ("description" .=) <$> _trlDescription]) - --- | Postal Code List Response --- --- /See:/ 'postalCodesListResponse' smart constructor. -data PostalCodesListResponse = PostalCodesListResponse' - { _pclrKind :: !Text - , _pclrPostalCodes :: !(Maybe [PostalCode]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'PostalCodesListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'pclrKind' --- --- * 'pclrPostalCodes' -postalCodesListResponse - :: PostalCodesListResponse -postalCodesListResponse = - PostalCodesListResponse' - { _pclrKind = "dfareporting#postalCodesListResponse" - , _pclrPostalCodes = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#postalCodesListResponse\". -pclrKind :: Lens' PostalCodesListResponse Text -pclrKind = lens _pclrKind (\ s a -> s{_pclrKind = a}) - --- | Postal code collection. -pclrPostalCodes :: Lens' PostalCodesListResponse [PostalCode] -pclrPostalCodes - = lens _pclrPostalCodes - (\ s a -> s{_pclrPostalCodes = a}) - . _Default - . _Coerce - -instance FromJSON PostalCodesListResponse where - parseJSON - = withObject "PostalCodesListResponse" - (\ o -> - PostalCodesListResponse' <$> - (o .:? "kind" .!= - "dfareporting#postalCodesListResponse") - <*> (o .:? "postalCodes" .!= mempty)) - -instance ToJSON PostalCodesListResponse where - toJSON PostalCodesListResponse'{..} - = object - (catMaybes - [Just ("kind" .= _pclrKind), - ("postalCodes" .=) <$> _pclrPostalCodes]) - --- | Describes a change that a user has made to a resource. --- --- /See:/ 'changeLog' smart constructor. -data ChangeLog = ChangeLog' - { _chaUserProFileId :: !(Maybe (Textual Int64)) - , _chaObjectType :: !(Maybe Text) - , _chaUserProFileName :: !(Maybe Text) - , _chaKind :: !Text - , _chaObjectId :: !(Maybe (Textual Int64)) - , _chaAction :: !(Maybe Text) - , _chaTransactionId :: !(Maybe (Textual Int64)) - , _chaOldValue :: !(Maybe Text) - , _chaAccountId :: !(Maybe (Textual Int64)) - , _chaNewValue :: !(Maybe Text) - , _chaFieldName :: !(Maybe Text) - , _chaId :: !(Maybe (Textual Int64)) - , _chaSubAccountId :: !(Maybe (Textual Int64)) - , _chaChangeTime :: !(Maybe DateTime') - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'ChangeLog' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'chaUserProFileId' --- --- * 'chaObjectType' --- --- * 'chaUserProFileName' --- --- * 'chaKind' --- --- * 'chaObjectId' --- --- * 'chaAction' --- --- * 'chaTransactionId' --- --- * 'chaOldValue' --- --- * 'chaAccountId' --- --- * 'chaNewValue' --- --- * 'chaFieldName' --- --- * 'chaId' --- --- * 'chaSubAccountId' --- --- * 'chaChangeTime' -changeLog - :: ChangeLog -changeLog = - ChangeLog' - { _chaUserProFileId = Nothing - , _chaObjectType = Nothing - , _chaUserProFileName = Nothing - , _chaKind = "dfareporting#changeLog" - , _chaObjectId = Nothing - , _chaAction = Nothing - , _chaTransactionId = Nothing - , _chaOldValue = Nothing - , _chaAccountId = Nothing - , _chaNewValue = Nothing - , _chaFieldName = Nothing - , _chaId = Nothing - , _chaSubAccountId = Nothing - , _chaChangeTime = Nothing - } - --- | ID of the user who modified the object. -chaUserProFileId :: Lens' ChangeLog (Maybe Int64) -chaUserProFileId - = lens _chaUserProFileId - (\ s a -> s{_chaUserProFileId = a}) - . mapping _Coerce - --- | Object type of the change log. -chaObjectType :: Lens' ChangeLog (Maybe Text) -chaObjectType - = lens _chaObjectType - (\ s a -> s{_chaObjectType = a}) - --- | User profile name of the user who modified the object. -chaUserProFileName :: Lens' ChangeLog (Maybe Text) -chaUserProFileName - = lens _chaUserProFileName - (\ s a -> s{_chaUserProFileName = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#changeLog\". -chaKind :: Lens' ChangeLog Text -chaKind = lens _chaKind (\ s a -> s{_chaKind = a}) - --- | ID of the object of this change log. The object could be a campaign, --- placement, ad, or other type. -chaObjectId :: Lens' ChangeLog (Maybe Int64) -chaObjectId - = lens _chaObjectId (\ s a -> s{_chaObjectId = a}) . - mapping _Coerce - --- | Action which caused the change. -chaAction :: Lens' ChangeLog (Maybe Text) -chaAction - = lens _chaAction (\ s a -> s{_chaAction = a}) - --- | Transaction ID of this change log. When a single API call results in --- many changes, each change will have a separate ID in the change log but --- will share the same transactionId. -chaTransactionId :: Lens' ChangeLog (Maybe Int64) -chaTransactionId - = lens _chaTransactionId - (\ s a -> s{_chaTransactionId = a}) - . mapping _Coerce - --- | Old value of the object field. -chaOldValue :: Lens' ChangeLog (Maybe Text) -chaOldValue - = lens _chaOldValue (\ s a -> s{_chaOldValue = a}) - --- | Account ID of the modified object. -chaAccountId :: Lens' ChangeLog (Maybe Int64) -chaAccountId - = lens _chaAccountId (\ s a -> s{_chaAccountId = a}) - . mapping _Coerce - --- | New value of the object field. -chaNewValue :: Lens' ChangeLog (Maybe Text) -chaNewValue - = lens _chaNewValue (\ s a -> s{_chaNewValue = a}) - --- | Field name of the object which changed. -chaFieldName :: Lens' ChangeLog (Maybe Text) -chaFieldName - = lens _chaFieldName (\ s a -> s{_chaFieldName = a}) - --- | ID of this change log. -chaId :: Lens' ChangeLog (Maybe Int64) -chaId - = lens _chaId (\ s a -> s{_chaId = a}) . - mapping _Coerce - --- | Subaccount ID of the modified object. -chaSubAccountId :: Lens' ChangeLog (Maybe Int64) -chaSubAccountId - = lens _chaSubAccountId - (\ s a -> s{_chaSubAccountId = a}) - . mapping _Coerce - --- | Time when the object was modified. -chaChangeTime :: Lens' ChangeLog (Maybe UTCTime) -chaChangeTime - = lens _chaChangeTime - (\ s a -> s{_chaChangeTime = a}) - . mapping _DateTime - -instance FromJSON ChangeLog where - parseJSON - = withObject "ChangeLog" - (\ o -> - ChangeLog' <$> - (o .:? "userProfileId") <*> (o .:? "objectType") <*> - (o .:? "userProfileName") - <*> (o .:? "kind" .!= "dfareporting#changeLog") - <*> (o .:? "objectId") - <*> (o .:? "action") - <*> (o .:? "transactionId") - <*> (o .:? "oldValue") - <*> (o .:? "accountId") - <*> (o .:? "newValue") - <*> (o .:? "fieldName") - <*> (o .:? "id") - <*> (o .:? "subaccountId") - <*> (o .:? "changeTime")) - -instance ToJSON ChangeLog where - toJSON ChangeLog'{..} - = object - (catMaybes - [("userProfileId" .=) <$> _chaUserProFileId, - ("objectType" .=) <$> _chaObjectType, - ("userProfileName" .=) <$> _chaUserProFileName, - Just ("kind" .= _chaKind), - ("objectId" .=) <$> _chaObjectId, - ("action" .=) <$> _chaAction, - ("transactionId" .=) <$> _chaTransactionId, - ("oldValue" .=) <$> _chaOldValue, - ("accountId" .=) <$> _chaAccountId, - ("newValue" .=) <$> _chaNewValue, - ("fieldName" .=) <$> _chaFieldName, - ("id" .=) <$> _chaId, - ("subaccountId" .=) <$> _chaSubAccountId, - ("changeTime" .=) <$> _chaChangeTime]) - --- | Contains information about a language that can be targeted by ads. --- --- /See:/ 'language' smart constructor. -data Language = Language' - { _lLanguageCode :: !(Maybe Text) - , _lKind :: !Text - , _lName :: !(Maybe Text) - , _lId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'Language' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'lLanguageCode' --- --- * 'lKind' --- --- * 'lName' --- --- * 'lId' -language - :: Language -language = - Language' - { _lLanguageCode = Nothing - , _lKind = "dfareporting#language" - , _lName = Nothing - , _lId = Nothing - } - --- | Format of language code is an ISO 639 two-letter language code --- optionally followed by an underscore followed by an ISO 3166 code. --- Examples are \"en\" for English or \"zh_CN\" for Simplified Chinese. -lLanguageCode :: Lens' Language (Maybe Text) -lLanguageCode - = lens _lLanguageCode - (\ s a -> s{_lLanguageCode = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#language\". -lKind :: Lens' Language Text -lKind = lens _lKind (\ s a -> s{_lKind = a}) - --- | Name of this language. -lName :: Lens' Language (Maybe Text) -lName = lens _lName (\ s a -> s{_lName = a}) - --- | Language ID of this language. This is the ID used for targeting and --- generating reports. -lId :: Lens' Language (Maybe Int64) -lId - = lens _lId (\ s a -> s{_lId = a}) . mapping _Coerce - -instance FromJSON Language where - parseJSON - = withObject "Language" - (\ o -> - Language' <$> - (o .:? "languageCode") <*> - (o .:? "kind" .!= "dfareporting#language") - <*> (o .:? "name") - <*> (o .:? "id")) - -instance ToJSON Language where - toJSON Language'{..} - = object - (catMaybes - [("languageCode" .=) <$> _lLanguageCode, - Just ("kind" .= _lKind), ("name" .=) <$> _lName, - ("id" .=) <$> _lId]) - --- | Contains properties of a placement strategy. --- --- /See:/ 'placementStrategy' smart constructor. -data PlacementStrategy = PlacementStrategy' - { _psKind :: !Text - , _psAccountId :: !(Maybe (Textual Int64)) - , _psName :: !(Maybe Text) - , _psId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'PlacementStrategy' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'psKind' --- --- * 'psAccountId' --- --- * 'psName' --- --- * 'psId' -placementStrategy - :: PlacementStrategy -placementStrategy = - PlacementStrategy' - { _psKind = "dfareporting#placementStrategy" - , _psAccountId = Nothing - , _psName = Nothing - , _psId = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#placementStrategy\". -psKind :: Lens' PlacementStrategy Text -psKind = lens _psKind (\ s a -> s{_psKind = a}) - --- | Account ID of this placement strategy.This is a read-only field that can --- be left blank. -psAccountId :: Lens' PlacementStrategy (Maybe Int64) -psAccountId - = lens _psAccountId (\ s a -> s{_psAccountId = a}) . - mapping _Coerce - --- | Name of this placement strategy. This is a required field. It must be --- less than 256 characters long and unique among placement strategies of --- the same account. -psName :: Lens' PlacementStrategy (Maybe Text) -psName = lens _psName (\ s a -> s{_psName = a}) - --- | ID of this placement strategy. This is a read-only, auto-generated --- field. -psId :: Lens' PlacementStrategy (Maybe Int64) -psId - = lens _psId (\ s a -> s{_psId = a}) . - mapping _Coerce - -instance FromJSON PlacementStrategy where - parseJSON - = withObject "PlacementStrategy" - (\ o -> - PlacementStrategy' <$> - (o .:? "kind" .!= "dfareporting#placementStrategy") - <*> (o .:? "accountId") - <*> (o .:? "name") - <*> (o .:? "id")) - -instance ToJSON PlacementStrategy where - toJSON PlacementStrategy'{..} - = object - (catMaybes - [Just ("kind" .= _psKind), - ("accountId" .=) <$> _psAccountId, - ("name" .=) <$> _psName, ("id" .=) <$> _psId]) - --- | Contains properties of a Floodlight activity. --- --- /See:/ 'floodlightActivity' smart constructor. -data FloodlightActivity = FloodlightActivity' - { _faCountingMethod :: !(Maybe FloodlightActivityCountingMethod) - , _faTagString :: !(Maybe Text) - , _faSecure :: !(Maybe Bool) - , _faExpectedURL :: !(Maybe Text) - , _faFloodlightActivityGroupTagString :: !(Maybe Text) - , _faFloodlightConfigurationId :: !(Maybe (Textual Int64)) - , _faKind :: !Text - , _faAdvertiserId :: !(Maybe (Textual Int64)) - , _faAdvertiserIdDimensionValue :: !(Maybe DimensionValue) - , _faSSLCompliant :: !(Maybe Bool) - , _faIdDimensionValue :: !(Maybe DimensionValue) - , _faTagFormat :: !(Maybe FloodlightActivityTagFormat) - , _faCacheBustingType :: !(Maybe FloodlightActivityCacheBustingType) - , _faAccountId :: !(Maybe (Textual Int64)) - , _faName :: !(Maybe Text) - , _faPublisherTags :: !(Maybe [FloodlightActivityPublisherDynamicTag]) - , _faFloodlightActivityGroupId :: !(Maybe (Textual Int64)) - , _faHidden :: !(Maybe Bool) - , _faFloodlightActivityGroupType :: !(Maybe FloodlightActivityFloodlightActivityGroupType) - , _faDefaultTags :: !(Maybe [FloodlightActivityDynamicTag]) - , _faFloodlightTagType :: !(Maybe FloodlightActivityFloodlightTagType) - , _faFloodlightActivityGroupName :: !(Maybe Text) - , _faId :: !(Maybe (Textual Int64)) - , _faSSLRequired :: !(Maybe Bool) - , _faUserDefinedVariableTypes :: !(Maybe [FloodlightActivityUserDefinedVariableTypesItem]) - , _faSubAccountId :: !(Maybe (Textual Int64)) - , _faNotes :: !(Maybe Text) - , _faFloodlightConfigurationIdDimensionValue :: !(Maybe DimensionValue) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'FloodlightActivity' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'faCountingMethod' --- --- * 'faTagString' --- --- * 'faSecure' --- --- * 'faExpectedURL' --- --- * 'faFloodlightActivityGroupTagString' --- --- * 'faFloodlightConfigurationId' --- --- * 'faKind' --- --- * 'faAdvertiserId' --- --- * 'faAdvertiserIdDimensionValue' --- --- * 'faSSLCompliant' --- --- * 'faIdDimensionValue' --- --- * 'faTagFormat' --- --- * 'faCacheBustingType' --- --- * 'faAccountId' --- --- * 'faName' --- --- * 'faPublisherTags' --- --- * 'faFloodlightActivityGroupId' --- --- * 'faHidden' --- --- * 'faFloodlightActivityGroupType' --- --- * 'faDefaultTags' --- --- * 'faFloodlightTagType' --- --- * 'faFloodlightActivityGroupName' --- --- * 'faId' --- --- * 'faSSLRequired' --- --- * 'faUserDefinedVariableTypes' --- --- * 'faSubAccountId' --- --- * 'faNotes' --- --- * 'faFloodlightConfigurationIdDimensionValue' -floodlightActivity - :: FloodlightActivity -floodlightActivity = - FloodlightActivity' - { _faCountingMethod = Nothing - , _faTagString = Nothing - , _faSecure = Nothing - , _faExpectedURL = Nothing - , _faFloodlightActivityGroupTagString = Nothing - , _faFloodlightConfigurationId = Nothing - , _faKind = "dfareporting#floodlightActivity" - , _faAdvertiserId = Nothing - , _faAdvertiserIdDimensionValue = Nothing - , _faSSLCompliant = Nothing - , _faIdDimensionValue = Nothing - , _faTagFormat = Nothing - , _faCacheBustingType = Nothing - , _faAccountId = Nothing - , _faName = Nothing - , _faPublisherTags = Nothing - , _faFloodlightActivityGroupId = Nothing - , _faHidden = Nothing - , _faFloodlightActivityGroupType = Nothing - , _faDefaultTags = Nothing - , _faFloodlightTagType = Nothing - , _faFloodlightActivityGroupName = Nothing - , _faId = Nothing - , _faSSLRequired = Nothing - , _faUserDefinedVariableTypes = Nothing - , _faSubAccountId = Nothing - , _faNotes = Nothing - , _faFloodlightConfigurationIdDimensionValue = Nothing - } - --- | Counting method for conversions for this floodlight activity. This is a --- required field. -faCountingMethod :: Lens' FloodlightActivity (Maybe FloodlightActivityCountingMethod) -faCountingMethod - = lens _faCountingMethod - (\ s a -> s{_faCountingMethod = a}) - --- | Value of the cat= parameter in the floodlight tag, which the ad servers --- use to identify the activity. This is optional: if empty, a new tag --- string will be generated for you. This string must be 1 to 8 characters --- long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag --- string must also be unique among activities of the same activity group. --- This field is read-only after insertion. -faTagString :: Lens' FloodlightActivity (Maybe Text) -faTagString - = lens _faTagString (\ s a -> s{_faTagString = a}) - --- | Whether this tag should use SSL. -faSecure :: Lens' FloodlightActivity (Maybe Bool) -faSecure = lens _faSecure (\ s a -> s{_faSecure = a}) - --- | URL where this tag will be deployed. If specified, must be less than 256 --- characters long. -faExpectedURL :: Lens' FloodlightActivity (Maybe Text) -faExpectedURL - = lens _faExpectedURL - (\ s a -> s{_faExpectedURL = a}) - --- | Tag string of the associated floodlight activity group. This is a --- read-only field. -faFloodlightActivityGroupTagString :: Lens' FloodlightActivity (Maybe Text) -faFloodlightActivityGroupTagString - = lens _faFloodlightActivityGroupTagString - (\ s a -> s{_faFloodlightActivityGroupTagString = a}) - --- | Floodlight configuration ID of this floodlight activity. If this field --- is left blank, the value will be copied over either from the activity --- group\'s floodlight configuration or from the existing activity\'s --- floodlight configuration. -faFloodlightConfigurationId :: Lens' FloodlightActivity (Maybe Int64) -faFloodlightConfigurationId - = lens _faFloodlightConfigurationId - (\ s a -> s{_faFloodlightConfigurationId = a}) - . mapping _Coerce - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#floodlightActivity\". -faKind :: Lens' FloodlightActivity Text -faKind = lens _faKind (\ s a -> s{_faKind = a}) - --- | Advertiser ID of this floodlight activity. If this field is left blank, --- the value will be copied over either from the activity group\'s --- advertiser or the existing activity\'s advertiser. -faAdvertiserId :: Lens' FloodlightActivity (Maybe Int64) -faAdvertiserId - = lens _faAdvertiserId - (\ s a -> s{_faAdvertiserId = a}) - . mapping _Coerce - --- | Dimension value for the ID of the advertiser. This is a read-only, --- auto-generated field. -faAdvertiserIdDimensionValue :: Lens' FloodlightActivity (Maybe DimensionValue) -faAdvertiserIdDimensionValue - = lens _faAdvertiserIdDimensionValue - (\ s a -> s{_faAdvertiserIdDimensionValue = a}) - --- | Whether the floodlight activity is SSL-compliant. This is a read-only --- field, its value detected by the system from the floodlight tags. -faSSLCompliant :: Lens' FloodlightActivity (Maybe Bool) -faSSLCompliant - = lens _faSSLCompliant - (\ s a -> s{_faSSLCompliant = a}) - --- | Dimension value for the ID of this floodlight activity. This is a --- read-only, auto-generated field. -faIdDimensionValue :: Lens' FloodlightActivity (Maybe DimensionValue) -faIdDimensionValue - = lens _faIdDimensionValue - (\ s a -> s{_faIdDimensionValue = a}) - --- | Tag format type for the floodlight activity. If left blank, the tag --- format will default to HTML. -faTagFormat :: Lens' FloodlightActivity (Maybe FloodlightActivityTagFormat) -faTagFormat - = lens _faTagFormat (\ s a -> s{_faTagFormat = a}) - --- | Code type used for cache busting in the generated tag. Applicable only --- when floodlightActivityGroupType is COUNTER and countingMethod is --- STANDARD_COUNTING or UNIQUE_COUNTING. -faCacheBustingType :: Lens' FloodlightActivity (Maybe FloodlightActivityCacheBustingType) -faCacheBustingType - = lens _faCacheBustingType - (\ s a -> s{_faCacheBustingType = a}) - --- | Account ID of this floodlight activity. This is a read-only field that --- can be left blank. -faAccountId :: Lens' FloodlightActivity (Maybe Int64) -faAccountId - = lens _faAccountId (\ s a -> s{_faAccountId = a}) . - mapping _Coerce - --- | Name of this floodlight activity. This is a required field. Must be less --- than 129 characters long and cannot contain quotes. -faName :: Lens' FloodlightActivity (Maybe Text) -faName = lens _faName (\ s a -> s{_faName = a}) - --- | Publisher dynamic floodlight tags. -faPublisherTags :: Lens' FloodlightActivity [FloodlightActivityPublisherDynamicTag] -faPublisherTags - = lens _faPublisherTags - (\ s a -> s{_faPublisherTags = a}) - . _Default - . _Coerce - --- | Floodlight activity group ID of this floodlight activity. This is a --- required field. -faFloodlightActivityGroupId :: Lens' FloodlightActivity (Maybe Int64) -faFloodlightActivityGroupId - = lens _faFloodlightActivityGroupId - (\ s a -> s{_faFloodlightActivityGroupId = a}) - . mapping _Coerce - --- | Whether this activity is archived. -faHidden :: Lens' FloodlightActivity (Maybe Bool) -faHidden = lens _faHidden (\ s a -> s{_faHidden = a}) - --- | Type of the associated floodlight activity group. This is a read-only --- field. -faFloodlightActivityGroupType :: Lens' FloodlightActivity (Maybe FloodlightActivityFloodlightActivityGroupType) -faFloodlightActivityGroupType - = lens _faFloodlightActivityGroupType - (\ s a -> s{_faFloodlightActivityGroupType = a}) - --- | Dynamic floodlight tags. -faDefaultTags :: Lens' FloodlightActivity [FloodlightActivityDynamicTag] -faDefaultTags - = lens _faDefaultTags - (\ s a -> s{_faDefaultTags = a}) - . _Default - . _Coerce - --- | The type of Floodlight tag this activity will generate. This is a --- required field. -faFloodlightTagType :: Lens' FloodlightActivity (Maybe FloodlightActivityFloodlightTagType) -faFloodlightTagType - = lens _faFloodlightTagType - (\ s a -> s{_faFloodlightTagType = a}) - --- | Name of the associated floodlight activity group. This is a read-only --- field. -faFloodlightActivityGroupName :: Lens' FloodlightActivity (Maybe Text) -faFloodlightActivityGroupName - = lens _faFloodlightActivityGroupName - (\ s a -> s{_faFloodlightActivityGroupName = a}) - --- | ID of this floodlight activity. This is a read-only, auto-generated --- field. -faId :: Lens' FloodlightActivity (Maybe Int64) -faId - = lens _faId (\ s a -> s{_faId = a}) . - mapping _Coerce - --- | Whether this floodlight activity must be SSL-compliant. -faSSLRequired :: Lens' FloodlightActivity (Maybe Bool) -faSSLRequired - = lens _faSSLRequired - (\ s a -> s{_faSSLRequired = a}) - --- | List of the user-defined variables used by this conversion tag. These --- map to the \"u[1-100]=\" in the tags. Each of these can have a user --- defined type. Acceptable values are U1 to U100, inclusive. -faUserDefinedVariableTypes :: Lens' FloodlightActivity [FloodlightActivityUserDefinedVariableTypesItem] -faUserDefinedVariableTypes - = lens _faUserDefinedVariableTypes - (\ s a -> s{_faUserDefinedVariableTypes = a}) - . _Default - . _Coerce - --- | Subaccount ID of this floodlight activity. This is a read-only field --- that can be left blank. -faSubAccountId :: Lens' FloodlightActivity (Maybe Int64) -faSubAccountId - = lens _faSubAccountId - (\ s a -> s{_faSubAccountId = a}) - . mapping _Coerce - --- | General notes or implementation instructions for the tag. -faNotes :: Lens' FloodlightActivity (Maybe Text) -faNotes = lens _faNotes (\ s a -> s{_faNotes = a}) - --- | Dimension value for the ID of the floodlight configuration. This is a --- read-only, auto-generated field. -faFloodlightConfigurationIdDimensionValue :: Lens' FloodlightActivity (Maybe DimensionValue) -faFloodlightConfigurationIdDimensionValue - = lens _faFloodlightConfigurationIdDimensionValue - (\ s a -> - s{_faFloodlightConfigurationIdDimensionValue = a}) - -instance FromJSON FloodlightActivity where - parseJSON - = withObject "FloodlightActivity" - (\ o -> - FloodlightActivity' <$> - (o .:? "countingMethod") <*> (o .:? "tagString") <*> - (o .:? "secure") - <*> (o .:? "expectedUrl") - <*> (o .:? "floodlightActivityGroupTagString") - <*> (o .:? "floodlightConfigurationId") - <*> - (o .:? "kind" .!= "dfareporting#floodlightActivity") - <*> (o .:? "advertiserId") - <*> (o .:? "advertiserIdDimensionValue") - <*> (o .:? "sslCompliant") - <*> (o .:? "idDimensionValue") - <*> (o .:? "tagFormat") - <*> (o .:? "cacheBustingType") - <*> (o .:? "accountId") - <*> (o .:? "name") - <*> (o .:? "publisherTags" .!= mempty) - <*> (o .:? "floodlightActivityGroupId") - <*> (o .:? "hidden") - <*> (o .:? "floodlightActivityGroupType") - <*> (o .:? "defaultTags" .!= mempty) - <*> (o .:? "floodlightTagType") - <*> (o .:? "floodlightActivityGroupName") - <*> (o .:? "id") - <*> (o .:? "sslRequired") - <*> (o .:? "userDefinedVariableTypes" .!= mempty) - <*> (o .:? "subaccountId") - <*> (o .:? "notes") - <*> - (o .:? "floodlightConfigurationIdDimensionValue")) - -instance ToJSON FloodlightActivity where - toJSON FloodlightActivity'{..} - = object - (catMaybes - [("countingMethod" .=) <$> _faCountingMethod, - ("tagString" .=) <$> _faTagString, - ("secure" .=) <$> _faSecure, - ("expectedUrl" .=) <$> _faExpectedURL, - ("floodlightActivityGroupTagString" .=) <$> - _faFloodlightActivityGroupTagString, - ("floodlightConfigurationId" .=) <$> - _faFloodlightConfigurationId, - Just ("kind" .= _faKind), - ("advertiserId" .=) <$> _faAdvertiserId, - ("advertiserIdDimensionValue" .=) <$> - _faAdvertiserIdDimensionValue, - ("sslCompliant" .=) <$> _faSSLCompliant, - ("idDimensionValue" .=) <$> _faIdDimensionValue, - ("tagFormat" .=) <$> _faTagFormat, - ("cacheBustingType" .=) <$> _faCacheBustingType, - ("accountId" .=) <$> _faAccountId, - ("name" .=) <$> _faName, - ("publisherTags" .=) <$> _faPublisherTags, - ("floodlightActivityGroupId" .=) <$> - _faFloodlightActivityGroupId, - ("hidden" .=) <$> _faHidden, - ("floodlightActivityGroupType" .=) <$> - _faFloodlightActivityGroupType, - ("defaultTags" .=) <$> _faDefaultTags, - ("floodlightTagType" .=) <$> _faFloodlightTagType, - ("floodlightActivityGroupName" .=) <$> - _faFloodlightActivityGroupName, - ("id" .=) <$> _faId, - ("sslRequired" .=) <$> _faSSLRequired, - ("userDefinedVariableTypes" .=) <$> - _faUserDefinedVariableTypes, - ("subaccountId" .=) <$> _faSubAccountId, - ("notes" .=) <$> _faNotes, - ("floodlightConfigurationIdDimensionValue" .=) <$> - _faFloodlightConfigurationIdDimensionValue]) - --- | A custom floodlight variable. --- --- /See:/ 'customFloodlightVariable' smart constructor. -data CustomFloodlightVariable = CustomFloodlightVariable' - { _cusKind :: !Text - , _cusValue :: !(Maybe Text) - , _cusType :: !(Maybe CustomFloodlightVariableType) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'CustomFloodlightVariable' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'cusKind' --- --- * 'cusValue' --- --- * 'cusType' -customFloodlightVariable - :: CustomFloodlightVariable -customFloodlightVariable = - CustomFloodlightVariable' - { _cusKind = "dfareporting#customFloodlightVariable" - , _cusValue = Nothing - , _cusType = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#customFloodlightVariable\". -cusKind :: Lens' CustomFloodlightVariable Text -cusKind = lens _cusKind (\ s a -> s{_cusKind = a}) - --- | The value of the custom floodlight variable. The length of string must --- not exceed 50 characters. -cusValue :: Lens' CustomFloodlightVariable (Maybe Text) -cusValue = lens _cusValue (\ s a -> s{_cusValue = a}) - --- | The type of custom floodlight variable to supply a value for. These map --- to the \"u[1-20]=\" in the tags. -cusType :: Lens' CustomFloodlightVariable (Maybe CustomFloodlightVariableType) -cusType = lens _cusType (\ s a -> s{_cusType = a}) - -instance FromJSON CustomFloodlightVariable where - parseJSON - = withObject "CustomFloodlightVariable" - (\ o -> - CustomFloodlightVariable' <$> - (o .:? "kind" .!= - "dfareporting#customFloodlightVariable") - <*> (o .:? "value") - <*> (o .:? "type")) - -instance ToJSON CustomFloodlightVariable where - toJSON CustomFloodlightVariable'{..} - = object - (catMaybes - [Just ("kind" .= _cusKind), - ("value" .=) <$> _cusValue, - ("type" .=) <$> _cusType]) - --- | Platform Type List Response --- --- /See:/ 'platformTypesListResponse' smart constructor. -data PlatformTypesListResponse = PlatformTypesListResponse' - { _ptlrKind :: !Text - , _ptlrPlatformTypes :: !(Maybe [PlatformType]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'PlatformTypesListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'ptlrKind' --- --- * 'ptlrPlatformTypes' -platformTypesListResponse - :: PlatformTypesListResponse -platformTypesListResponse = - PlatformTypesListResponse' - { _ptlrKind = "dfareporting#platformTypesListResponse" - , _ptlrPlatformTypes = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#platformTypesListResponse\". -ptlrKind :: Lens' PlatformTypesListResponse Text -ptlrKind = lens _ptlrKind (\ s a -> s{_ptlrKind = a}) - --- | Platform type collection. -ptlrPlatformTypes :: Lens' PlatformTypesListResponse [PlatformType] -ptlrPlatformTypes - = lens _ptlrPlatformTypes - (\ s a -> s{_ptlrPlatformTypes = a}) - . _Default - . _Coerce - -instance FromJSON PlatformTypesListResponse where - parseJSON - = withObject "PlatformTypesListResponse" - (\ o -> - PlatformTypesListResponse' <$> - (o .:? "kind" .!= - "dfareporting#platformTypesListResponse") - <*> (o .:? "platformTypes" .!= mempty)) - -instance ToJSON PlatformTypesListResponse where - toJSON PlatformTypesListResponse'{..} - = object - (catMaybes - [Just ("kind" .= _ptlrKind), - ("platformTypes" .=) <$> _ptlrPlatformTypes]) - --- | Modification timestamp. --- --- /See:/ 'lastModifiedInfo' smart constructor. -newtype LastModifiedInfo = LastModifiedInfo' - { _lmiTime :: Maybe (Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'LastModifiedInfo' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'lmiTime' -lastModifiedInfo - :: LastModifiedInfo -lastModifiedInfo = - LastModifiedInfo' - { _lmiTime = Nothing - } - --- | Timestamp of the last change in milliseconds since epoch. -lmiTime :: Lens' LastModifiedInfo (Maybe Int64) -lmiTime - = lens _lmiTime (\ s a -> s{_lmiTime = a}) . - mapping _Coerce - -instance FromJSON LastModifiedInfo where - parseJSON - = withObject "LastModifiedInfo" - (\ o -> LastModifiedInfo' <$> (o .:? "time")) - -instance ToJSON LastModifiedInfo where - toJSON LastModifiedInfo'{..} - = object (catMaybes [("time" .=) <$> _lmiTime]) - --- | Target Window. --- --- /See:/ 'targetWindow' smart constructor. -data TargetWindow = TargetWindow' - { _twCustomHTML :: !(Maybe Text) - , _twTargetWindowOption :: !(Maybe TargetWindowTargetWindowOption) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'TargetWindow' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'twCustomHTML' --- --- * 'twTargetWindowOption' -targetWindow - :: TargetWindow -targetWindow = - TargetWindow' - { _twCustomHTML = Nothing - , _twTargetWindowOption = Nothing - } - --- | User-entered value. -twCustomHTML :: Lens' TargetWindow (Maybe Text) -twCustomHTML - = lens _twCustomHTML (\ s a -> s{_twCustomHTML = a}) - --- | Type of browser window for which the backup image of the flash creative --- can be displayed. -twTargetWindowOption :: Lens' TargetWindow (Maybe TargetWindowTargetWindowOption) -twTargetWindowOption - = lens _twTargetWindowOption - (\ s a -> s{_twTargetWindowOption = a}) - -instance FromJSON TargetWindow where - parseJSON - = withObject "TargetWindow" - (\ o -> - TargetWindow' <$> - (o .:? "customHtml") <*> - (o .:? "targetWindowOption")) - -instance ToJSON TargetWindow where - toJSON TargetWindow'{..} - = object - (catMaybes - [("customHtml" .=) <$> _twCustomHTML, - ("targetWindowOption" .=) <$> _twTargetWindowOption]) - --- | AccountPermissionGroups contains a mapping of permission group IDs to --- names. A permission group is a grouping of account permissions. --- --- /See:/ 'accountPermissionGroup' smart constructor. -data AccountPermissionGroup = AccountPermissionGroup' - { _apgpKind :: !Text - , _apgpName :: !(Maybe Text) - , _apgpId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'AccountPermissionGroup' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'apgpKind' --- --- * 'apgpName' --- --- * 'apgpId' -accountPermissionGroup - :: AccountPermissionGroup -accountPermissionGroup = - AccountPermissionGroup' - { _apgpKind = "dfareporting#accountPermissionGroup" - , _apgpName = Nothing - , _apgpId = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#accountPermissionGroup\". -apgpKind :: Lens' AccountPermissionGroup Text -apgpKind = lens _apgpKind (\ s a -> s{_apgpKind = a}) - --- | Name of this account permission group. -apgpName :: Lens' AccountPermissionGroup (Maybe Text) -apgpName = lens _apgpName (\ s a -> s{_apgpName = a}) - --- | ID of this account permission group. -apgpId :: Lens' AccountPermissionGroup (Maybe Int64) -apgpId - = lens _apgpId (\ s a -> s{_apgpId = a}) . - mapping _Coerce - -instance FromJSON AccountPermissionGroup where - parseJSON - = withObject "AccountPermissionGroup" - (\ o -> - AccountPermissionGroup' <$> - (o .:? "kind" .!= - "dfareporting#accountPermissionGroup") - <*> (o .:? "name") - <*> (o .:? "id")) - -instance ToJSON AccountPermissionGroup where - toJSON AccountPermissionGroup'{..} - = object - (catMaybes - [Just ("kind" .= _apgpKind), - ("name" .=) <$> _apgpName, ("id" .=) <$> _apgpId]) - --- | Contains properties of a Campaign Manager advertiser. --- --- /See:/ 'advertiser' smart constructor. -data Advertiser = Advertiser' - { _advdOriginalFloodlightConfigurationId :: !(Maybe (Textual Int64)) - , _advdStatus :: !(Maybe AdvertiserStatus) - , _advdFloodlightConfigurationId :: !(Maybe (Textual Int64)) - , _advdKind :: !Text - , _advdSuspended :: !(Maybe Bool) - , _advdIdDimensionValue :: !(Maybe DimensionValue) - , _advdAccountId :: !(Maybe (Textual Int64)) - , _advdDefaultEmail :: !(Maybe Text) - , _advdName :: !(Maybe Text) - , _advdAdvertiserGroupId :: !(Maybe (Textual Int64)) - , _advdDefaultClickThroughEventTagId :: !(Maybe (Textual Int64)) - , _advdId :: !(Maybe (Textual Int64)) - , _advdSubAccountId :: !(Maybe (Textual Int64)) - , _advdFloodlightConfigurationIdDimensionValue :: !(Maybe DimensionValue) - , _advdClickThroughURLSuffix :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'Advertiser' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'advdOriginalFloodlightConfigurationId' --- --- * 'advdStatus' --- --- * 'advdFloodlightConfigurationId' --- --- * 'advdKind' --- --- * 'advdSuspended' --- --- * 'advdIdDimensionValue' --- --- * 'advdAccountId' --- --- * 'advdDefaultEmail' --- --- * 'advdName' --- --- * 'advdAdvertiserGroupId' --- --- * 'advdDefaultClickThroughEventTagId' --- --- * 'advdId' --- --- * 'advdSubAccountId' --- --- * 'advdFloodlightConfigurationIdDimensionValue' --- --- * 'advdClickThroughURLSuffix' -advertiser - :: Advertiser -advertiser = - Advertiser' - { _advdOriginalFloodlightConfigurationId = Nothing - , _advdStatus = Nothing - , _advdFloodlightConfigurationId = Nothing - , _advdKind = "dfareporting#advertiser" - , _advdSuspended = Nothing - , _advdIdDimensionValue = Nothing - , _advdAccountId = Nothing - , _advdDefaultEmail = Nothing - , _advdName = Nothing - , _advdAdvertiserGroupId = Nothing - , _advdDefaultClickThroughEventTagId = Nothing - , _advdId = Nothing - , _advdSubAccountId = Nothing - , _advdFloodlightConfigurationIdDimensionValue = Nothing - , _advdClickThroughURLSuffix = Nothing - } - --- | Original floodlight configuration before any sharing occurred. Set the --- floodlightConfigurationId of this advertiser to --- originalFloodlightConfigurationId to unshare the advertiser\'s current --- floodlight configuration. You cannot unshare an advertiser\'s floodlight --- configuration if the shared configuration has activities associated with --- any campaign or placement. -advdOriginalFloodlightConfigurationId :: Lens' Advertiser (Maybe Int64) -advdOriginalFloodlightConfigurationId - = lens _advdOriginalFloodlightConfigurationId - (\ s a -> - s{_advdOriginalFloodlightConfigurationId = a}) - . mapping _Coerce - --- | Status of this advertiser. -advdStatus :: Lens' Advertiser (Maybe AdvertiserStatus) -advdStatus - = lens _advdStatus (\ s a -> s{_advdStatus = a}) - --- | Floodlight configuration ID of this advertiser. The floodlight --- configuration ID will be created automatically, so on insert this field --- should be left blank. This field can be set to another advertiser\'s --- floodlight configuration ID in order to share that advertiser\'s --- floodlight configuration with this advertiser, so long as: - This --- advertiser\'s original floodlight configuration is not already --- associated with floodlight activities or floodlight activity groups. - --- This advertiser\'s original floodlight configuration is not already --- shared with another advertiser. -advdFloodlightConfigurationId :: Lens' Advertiser (Maybe Int64) -advdFloodlightConfigurationId - = lens _advdFloodlightConfigurationId - (\ s a -> s{_advdFloodlightConfigurationId = a}) - . mapping _Coerce - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#advertiser\". -advdKind :: Lens' Advertiser Text -advdKind = lens _advdKind (\ s a -> s{_advdKind = a}) - --- | Suspension status of this advertiser. -advdSuspended :: Lens' Advertiser (Maybe Bool) -advdSuspended - = lens _advdSuspended - (\ s a -> s{_advdSuspended = a}) - --- | Dimension value for the ID of this advertiser. This is a read-only, --- auto-generated field. -advdIdDimensionValue :: Lens' Advertiser (Maybe DimensionValue) -advdIdDimensionValue - = lens _advdIdDimensionValue - (\ s a -> s{_advdIdDimensionValue = a}) - --- | Account ID of this advertiser.This is a read-only field that can be left --- blank. -advdAccountId :: Lens' Advertiser (Maybe Int64) -advdAccountId - = lens _advdAccountId - (\ s a -> s{_advdAccountId = a}) - . mapping _Coerce - --- | Default email address used in sender field for tag emails. -advdDefaultEmail :: Lens' Advertiser (Maybe Text) -advdDefaultEmail - = lens _advdDefaultEmail - (\ s a -> s{_advdDefaultEmail = a}) - --- | Name of this advertiser. This is a required field and must be less than --- 256 characters long and unique among advertisers of the same account. -advdName :: Lens' Advertiser (Maybe Text) -advdName = lens _advdName (\ s a -> s{_advdName = a}) - --- | ID of the advertiser group this advertiser belongs to. You can group --- advertisers for reporting purposes, allowing you to see aggregated --- information for all advertisers in each group. -advdAdvertiserGroupId :: Lens' Advertiser (Maybe Int64) -advdAdvertiserGroupId - = lens _advdAdvertiserGroupId - (\ s a -> s{_advdAdvertiserGroupId = a}) - . mapping _Coerce - --- | ID of the click-through event tag to apply by default to the landing --- pages of this advertiser\'s campaigns. -advdDefaultClickThroughEventTagId :: Lens' Advertiser (Maybe Int64) -advdDefaultClickThroughEventTagId - = lens _advdDefaultClickThroughEventTagId - (\ s a -> s{_advdDefaultClickThroughEventTagId = a}) - . mapping _Coerce - --- | ID of this advertiser. This is a read-only, auto-generated field. -advdId :: Lens' Advertiser (Maybe Int64) -advdId - = lens _advdId (\ s a -> s{_advdId = a}) . - mapping _Coerce - --- | Subaccount ID of this advertiser.This is a read-only field that can be --- left blank. -advdSubAccountId :: Lens' Advertiser (Maybe Int64) -advdSubAccountId - = lens _advdSubAccountId - (\ s a -> s{_advdSubAccountId = a}) - . mapping _Coerce - --- | Dimension value for the ID of the floodlight configuration. This is a --- read-only, auto-generated field. -advdFloodlightConfigurationIdDimensionValue :: Lens' Advertiser (Maybe DimensionValue) -advdFloodlightConfigurationIdDimensionValue - = lens _advdFloodlightConfigurationIdDimensionValue - (\ s a -> - s{_advdFloodlightConfigurationIdDimensionValue = a}) - --- | Suffix added to click-through URL of ad creative associations under this --- advertiser. Must be less than 129 characters long. -advdClickThroughURLSuffix :: Lens' Advertiser (Maybe Text) -advdClickThroughURLSuffix - = lens _advdClickThroughURLSuffix - (\ s a -> s{_advdClickThroughURLSuffix = a}) - -instance FromJSON Advertiser where - parseJSON - = withObject "Advertiser" - (\ o -> - Advertiser' <$> - (o .:? "originalFloodlightConfigurationId") <*> - (o .:? "status") - <*> (o .:? "floodlightConfigurationId") - <*> (o .:? "kind" .!= "dfareporting#advertiser") - <*> (o .:? "suspended") - <*> (o .:? "idDimensionValue") - <*> (o .:? "accountId") - <*> (o .:? "defaultEmail") - <*> (o .:? "name") - <*> (o .:? "advertiserGroupId") - <*> (o .:? "defaultClickThroughEventTagId") - <*> (o .:? "id") - <*> (o .:? "subaccountId") - <*> (o .:? "floodlightConfigurationIdDimensionValue") - <*> (o .:? "clickThroughUrlSuffix")) - -instance ToJSON Advertiser where - toJSON Advertiser'{..} - = object - (catMaybes - [("originalFloodlightConfigurationId" .=) <$> - _advdOriginalFloodlightConfigurationId, - ("status" .=) <$> _advdStatus, - ("floodlightConfigurationId" .=) <$> - _advdFloodlightConfigurationId, - Just ("kind" .= _advdKind), - ("suspended" .=) <$> _advdSuspended, - ("idDimensionValue" .=) <$> _advdIdDimensionValue, - ("accountId" .=) <$> _advdAccountId, - ("defaultEmail" .=) <$> _advdDefaultEmail, - ("name" .=) <$> _advdName, - ("advertiserGroupId" .=) <$> _advdAdvertiserGroupId, - ("defaultClickThroughEventTagId" .=) <$> - _advdDefaultClickThroughEventTagId, - ("id" .=) <$> _advdId, - ("subaccountId" .=) <$> _advdSubAccountId, - ("floodlightConfigurationIdDimensionValue" .=) <$> - _advdFloodlightConfigurationIdDimensionValue, - ("clickThroughUrlSuffix" .=) <$> - _advdClickThroughURLSuffix]) - --- | Contains properties of auser role, which is used to manage user access. --- --- /See:/ 'userRole' smart constructor. -data UserRole = UserRole' - { _urParentUserRoleId :: !(Maybe (Textual Int64)) - , _urKind :: !Text - , _urDefaultUserRole :: !(Maybe Bool) - , _urAccountId :: !(Maybe (Textual Int64)) - , _urName :: !(Maybe Text) - , _urId :: !(Maybe (Textual Int64)) - , _urPermissions :: !(Maybe [UserRolePermission]) - , _urSubAccountId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'UserRole' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'urParentUserRoleId' --- --- * 'urKind' --- --- * 'urDefaultUserRole' --- --- * 'urAccountId' --- --- * 'urName' --- --- * 'urId' --- --- * 'urPermissions' --- --- * 'urSubAccountId' -userRole - :: UserRole -userRole = - UserRole' - { _urParentUserRoleId = Nothing - , _urKind = "dfareporting#userRole" - , _urDefaultUserRole = Nothing - , _urAccountId = Nothing - , _urName = Nothing - , _urId = Nothing - , _urPermissions = Nothing - , _urSubAccountId = Nothing - } - --- | ID of the user role that this user role is based on or copied from. This --- is a required field. -urParentUserRoleId :: Lens' UserRole (Maybe Int64) -urParentUserRoleId - = lens _urParentUserRoleId - (\ s a -> s{_urParentUserRoleId = a}) - . mapping _Coerce - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#userRole\". -urKind :: Lens' UserRole Text -urKind = lens _urKind (\ s a -> s{_urKind = a}) - --- | Whether this is a default user role. Default user roles are created by --- the system for the account\/subaccount and cannot be modified or --- deleted. Each default user role comes with a basic set of preassigned --- permissions. -urDefaultUserRole :: Lens' UserRole (Maybe Bool) -urDefaultUserRole - = lens _urDefaultUserRole - (\ s a -> s{_urDefaultUserRole = a}) - --- | Account ID of this user role. This is a read-only field that can be left --- blank. -urAccountId :: Lens' UserRole (Maybe Int64) -urAccountId - = lens _urAccountId (\ s a -> s{_urAccountId = a}) . - mapping _Coerce - --- | Name of this user role. This is a required field. Must be less than 256 --- characters long. If this user role is under a subaccount, the name must --- be unique among sites of the same subaccount. Otherwise, this user role --- is a top-level user role, and the name must be unique among top-level --- user roles of the same account. -urName :: Lens' UserRole (Maybe Text) -urName = lens _urName (\ s a -> s{_urName = a}) - --- | ID of this user role. This is a read-only, auto-generated field. -urId :: Lens' UserRole (Maybe Int64) -urId - = lens _urId (\ s a -> s{_urId = a}) . - mapping _Coerce - --- | List of permissions associated with this user role. -urPermissions :: Lens' UserRole [UserRolePermission] -urPermissions - = lens _urPermissions - (\ s a -> s{_urPermissions = a}) - . _Default - . _Coerce - --- | Subaccount ID of this user role. This is a read-only field that can be --- left blank. -urSubAccountId :: Lens' UserRole (Maybe Int64) -urSubAccountId - = lens _urSubAccountId - (\ s a -> s{_urSubAccountId = a}) - . mapping _Coerce - -instance FromJSON UserRole where - parseJSON - = withObject "UserRole" - (\ o -> - UserRole' <$> - (o .:? "parentUserRoleId") <*> - (o .:? "kind" .!= "dfareporting#userRole") - <*> (o .:? "defaultUserRole") - <*> (o .:? "accountId") - <*> (o .:? "name") - <*> (o .:? "id") - <*> (o .:? "permissions" .!= mempty) - <*> (o .:? "subaccountId")) - -instance ToJSON UserRole where - toJSON UserRole'{..} - = object - (catMaybes - [("parentUserRoleId" .=) <$> _urParentUserRoleId, - Just ("kind" .= _urKind), - ("defaultUserRole" .=) <$> _urDefaultUserRole, - ("accountId" .=) <$> _urAccountId, - ("name" .=) <$> _urName, ("id" .=) <$> _urId, - ("permissions" .=) <$> _urPermissions, - ("subaccountId" .=) <$> _urSubAccountId]) - --- | Video Format List Response --- --- /See:/ 'videoFormatsListResponse' smart constructor. -data VideoFormatsListResponse = VideoFormatsListResponse' - { _vflrKind :: !Text - , _vflrVideoFormats :: !(Maybe [VideoFormat]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'VideoFormatsListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'vflrKind' --- --- * 'vflrVideoFormats' -videoFormatsListResponse - :: VideoFormatsListResponse -videoFormatsListResponse = - VideoFormatsListResponse' - { _vflrKind = "dfareporting#videoFormatsListResponse" - , _vflrVideoFormats = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#videoFormatsListResponse\". -vflrKind :: Lens' VideoFormatsListResponse Text -vflrKind = lens _vflrKind (\ s a -> s{_vflrKind = a}) - --- | Video format collection. -vflrVideoFormats :: Lens' VideoFormatsListResponse [VideoFormat] -vflrVideoFormats - = lens _vflrVideoFormats - (\ s a -> s{_vflrVideoFormats = a}) - . _Default - . _Coerce - -instance FromJSON VideoFormatsListResponse where - parseJSON - = withObject "VideoFormatsListResponse" - (\ o -> - VideoFormatsListResponse' <$> - (o .:? "kind" .!= - "dfareporting#videoFormatsListResponse") - <*> (o .:? "videoFormats" .!= mempty)) - -instance ToJSON VideoFormatsListResponse where - toJSON VideoFormatsListResponse'{..} - = object - (catMaybes - [Just ("kind" .= _vflrKind), - ("videoFormats" .=) <$> _vflrVideoFormats]) - --- | Directory Site List Response --- --- /See:/ 'directorySitesListResponse' smart constructor. -data DirectorySitesListResponse = DirectorySitesListResponse' - { _dslrNextPageToken :: !(Maybe Text) - , _dslrKind :: !Text - , _dslrDirectorySites :: !(Maybe [DirectorySite]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'DirectorySitesListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'dslrNextPageToken' --- --- * 'dslrKind' --- --- * 'dslrDirectorySites' -directorySitesListResponse - :: DirectorySitesListResponse -directorySitesListResponse = - DirectorySitesListResponse' - { _dslrNextPageToken = Nothing - , _dslrKind = "dfareporting#directorySitesListResponse" - , _dslrDirectorySites = Nothing - } - --- | Pagination token to be used for the next list operation. -dslrNextPageToken :: Lens' DirectorySitesListResponse (Maybe Text) -dslrNextPageToken - = lens _dslrNextPageToken - (\ s a -> s{_dslrNextPageToken = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#directorySitesListResponse\". -dslrKind :: Lens' DirectorySitesListResponse Text -dslrKind = lens _dslrKind (\ s a -> s{_dslrKind = a}) - --- | Directory site collection. -dslrDirectorySites :: Lens' DirectorySitesListResponse [DirectorySite] -dslrDirectorySites - = lens _dslrDirectorySites - (\ s a -> s{_dslrDirectorySites = a}) - . _Default - . _Coerce - -instance FromJSON DirectorySitesListResponse where - parseJSON - = withObject "DirectorySitesListResponse" - (\ o -> - DirectorySitesListResponse' <$> - (o .:? "nextPageToken") <*> - (o .:? "kind" .!= - "dfareporting#directorySitesListResponse") - <*> (o .:? "directorySites" .!= mempty)) - -instance ToJSON DirectorySitesListResponse where - toJSON DirectorySitesListResponse'{..} - = object - (catMaybes - [("nextPageToken" .=) <$> _dslrNextPageToken, - Just ("kind" .= _dslrKind), - ("directorySites" .=) <$> _dslrDirectorySites]) - --- | The error code and description for a conversion that failed to insert or --- update. --- --- /See:/ 'conversionError' smart constructor. -data ConversionError = ConversionError' - { _ceKind :: !Text - , _ceCode :: !(Maybe ConversionErrorCode) - , _ceMessage :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'ConversionError' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'ceKind' --- --- * 'ceCode' --- --- * 'ceMessage' -conversionError - :: ConversionError -conversionError = - ConversionError' - { _ceKind = "dfareporting#conversionError" - , _ceCode = Nothing - , _ceMessage = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#conversionError\". -ceKind :: Lens' ConversionError Text -ceKind = lens _ceKind (\ s a -> s{_ceKind = a}) - --- | The error code. -ceCode :: Lens' ConversionError (Maybe ConversionErrorCode) -ceCode = lens _ceCode (\ s a -> s{_ceCode = a}) - --- | A description of the error. -ceMessage :: Lens' ConversionError (Maybe Text) -ceMessage - = lens _ceMessage (\ s a -> s{_ceMessage = a}) - -instance FromJSON ConversionError where - parseJSON - = withObject "ConversionError" - (\ o -> - ConversionError' <$> - (o .:? "kind" .!= "dfareporting#conversionError") <*> - (o .:? "code") - <*> (o .:? "message")) - -instance ToJSON ConversionError where - toJSON ConversionError'{..} - = object - (catMaybes - [Just ("kind" .= _ceKind), ("code" .=) <$> _ceCode, - ("message" .=) <$> _ceMessage]) - --- | Pricing Period --- --- /See:/ 'pricingSchedulePricingPeriod' smart constructor. -data PricingSchedulePricingPeriod = PricingSchedulePricingPeriod' - { _psppEndDate :: !(Maybe Date') - , _psppRateOrCostNanos :: !(Maybe (Textual Int64)) - , _psppStartDate :: !(Maybe Date') - , _psppUnits :: !(Maybe (Textual Int64)) - , _psppPricingComment :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'PricingSchedulePricingPeriod' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'psppEndDate' --- --- * 'psppRateOrCostNanos' --- --- * 'psppStartDate' --- --- * 'psppUnits' --- --- * 'psppPricingComment' -pricingSchedulePricingPeriod - :: PricingSchedulePricingPeriod -pricingSchedulePricingPeriod = - PricingSchedulePricingPeriod' - { _psppEndDate = Nothing - , _psppRateOrCostNanos = Nothing - , _psppStartDate = Nothing - , _psppUnits = Nothing - , _psppPricingComment = Nothing - } - --- | Pricing period end date. This date must be later than, or the same day --- as, the pricing period start date, but not later than the placement end --- date. The period end date can be the same date as the period start date. --- If, for example, you set 6\/25\/2015 as both the start and end dates, --- the effective pricing period date is just that day only, 6\/25\/2015. --- The hours, minutes, and seconds of the end date should not be set, as --- doing so will result in an error. -psppEndDate :: Lens' PricingSchedulePricingPeriod (Maybe Day) -psppEndDate - = lens _psppEndDate (\ s a -> s{_psppEndDate = a}) . - mapping _Date - --- | Rate or cost of this pricing period in nanos (i.e., multipled by --- 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. -psppRateOrCostNanos :: Lens' PricingSchedulePricingPeriod (Maybe Int64) -psppRateOrCostNanos - = lens _psppRateOrCostNanos - (\ s a -> s{_psppRateOrCostNanos = a}) - . mapping _Coerce - --- | Pricing period start date. This date must be later than, or the same day --- as, the placement start date. The hours, minutes, and seconds of the --- start date should not be set, as doing so will result in an error. -psppStartDate :: Lens' PricingSchedulePricingPeriod (Maybe Day) -psppStartDate - = lens _psppStartDate - (\ s a -> s{_psppStartDate = a}) - . mapping _Date - --- | Units of this pricing period. Acceptable values are 0 to 10000000000, --- inclusive. -psppUnits :: Lens' PricingSchedulePricingPeriod (Maybe Int64) -psppUnits - = lens _psppUnits (\ s a -> s{_psppUnits = a}) . - mapping _Coerce - --- | Comments for this pricing period. -psppPricingComment :: Lens' PricingSchedulePricingPeriod (Maybe Text) -psppPricingComment - = lens _psppPricingComment - (\ s a -> s{_psppPricingComment = a}) - -instance FromJSON PricingSchedulePricingPeriod where - parseJSON - = withObject "PricingSchedulePricingPeriod" - (\ o -> - PricingSchedulePricingPeriod' <$> - (o .:? "endDate") <*> (o .:? "rateOrCostNanos") <*> - (o .:? "startDate") - <*> (o .:? "units") - <*> (o .:? "pricingComment")) - -instance ToJSON PricingSchedulePricingPeriod where - toJSON PricingSchedulePricingPeriod'{..} - = object - (catMaybes - [("endDate" .=) <$> _psppEndDate, - ("rateOrCostNanos" .=) <$> _psppRateOrCostNanos, - ("startDate" .=) <$> _psppStartDate, - ("units" .=) <$> _psppUnits, - ("pricingComment" .=) <$> _psppPricingComment]) - --- | Directory Site Contact List Response --- --- /See:/ 'directorySiteContactsListResponse' smart constructor. -data DirectorySiteContactsListResponse = DirectorySiteContactsListResponse' - { _dsclrNextPageToken :: !(Maybe Text) - , _dsclrKind :: !Text - , _dsclrDirectorySiteContacts :: !(Maybe [DirectorySiteContact]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'DirectorySiteContactsListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'dsclrNextPageToken' --- --- * 'dsclrKind' --- --- * 'dsclrDirectorySiteContacts' -directorySiteContactsListResponse - :: DirectorySiteContactsListResponse -directorySiteContactsListResponse = - DirectorySiteContactsListResponse' - { _dsclrNextPageToken = Nothing - , _dsclrKind = "dfareporting#directorySiteContactsListResponse" - , _dsclrDirectorySiteContacts = Nothing - } - --- | Pagination token to be used for the next list operation. -dsclrNextPageToken :: Lens' DirectorySiteContactsListResponse (Maybe Text) -dsclrNextPageToken - = lens _dsclrNextPageToken - (\ s a -> s{_dsclrNextPageToken = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#directorySiteContactsListResponse\". -dsclrKind :: Lens' DirectorySiteContactsListResponse Text -dsclrKind - = lens _dsclrKind (\ s a -> s{_dsclrKind = a}) - --- | Directory site contact collection -dsclrDirectorySiteContacts :: Lens' DirectorySiteContactsListResponse [DirectorySiteContact] -dsclrDirectorySiteContacts - = lens _dsclrDirectorySiteContacts - (\ s a -> s{_dsclrDirectorySiteContacts = a}) - . _Default - . _Coerce - -instance FromJSON DirectorySiteContactsListResponse - where - parseJSON - = withObject "DirectorySiteContactsListResponse" - (\ o -> - DirectorySiteContactsListResponse' <$> - (o .:? "nextPageToken") <*> - (o .:? "kind" .!= - "dfareporting#directorySiteContactsListResponse") - <*> (o .:? "directorySiteContacts" .!= mempty)) - -instance ToJSON DirectorySiteContactsListResponse - where - toJSON DirectorySiteContactsListResponse'{..} - = object - (catMaybes - [("nextPageToken" .=) <$> _dsclrNextPageToken, - Just ("kind" .= _dsclrKind), - ("directorySiteContacts" .=) <$> - _dsclrDirectorySiteContacts]) - --- | Contains information about a region that can be targeted by ads. --- --- /See:/ 'region' smart constructor. -data Region = Region' - { _regRegionCode :: !(Maybe Text) - , _regKind :: !Text - , _regName :: !(Maybe Text) - , _regCountryCode :: !(Maybe Text) - , _regCountryDartId :: !(Maybe (Textual Int64)) - , _regDartId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'Region' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'regRegionCode' --- --- * 'regKind' --- --- * 'regName' --- --- * 'regCountryCode' --- --- * 'regCountryDartId' --- --- * 'regDartId' -region - :: Region -region = - Region' - { _regRegionCode = Nothing - , _regKind = "dfareporting#region" - , _regName = Nothing - , _regCountryCode = Nothing - , _regCountryDartId = Nothing - , _regDartId = Nothing - } - --- | Region code. -regRegionCode :: Lens' Region (Maybe Text) -regRegionCode - = lens _regRegionCode - (\ s a -> s{_regRegionCode = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#region\". -regKind :: Lens' Region Text -regKind = lens _regKind (\ s a -> s{_regKind = a}) - --- | Name of this region. -regName :: Lens' Region (Maybe Text) -regName = lens _regName (\ s a -> s{_regName = a}) - --- | Country code of the country to which this region belongs. -regCountryCode :: Lens' Region (Maybe Text) -regCountryCode - = lens _regCountryCode - (\ s a -> s{_regCountryCode = a}) - --- | DART ID of the country to which this region belongs. -regCountryDartId :: Lens' Region (Maybe Int64) -regCountryDartId - = lens _regCountryDartId - (\ s a -> s{_regCountryDartId = a}) - . mapping _Coerce - --- | DART ID of this region. -regDartId :: Lens' Region (Maybe Int64) -regDartId - = lens _regDartId (\ s a -> s{_regDartId = a}) . - mapping _Coerce - -instance FromJSON Region where - parseJSON - = withObject "Region" - (\ o -> - Region' <$> - (o .:? "regionCode") <*> - (o .:? "kind" .!= "dfareporting#region") - <*> (o .:? "name") - <*> (o .:? "countryCode") - <*> (o .:? "countryDartId") - <*> (o .:? "dartId")) - -instance ToJSON Region where - toJSON Region'{..} - = object - (catMaybes - [("regionCode" .=) <$> _regRegionCode, - Just ("kind" .= _regKind), ("name" .=) <$> _regName, - ("countryCode" .=) <$> _regCountryCode, - ("countryDartId" .=) <$> _regCountryDartId, - ("dartId" .=) <$> _regDartId]) - --- | Advertiser Group List Response --- --- /See:/ 'advertiserGroupsListResponse' smart constructor. -data AdvertiserGroupsListResponse = AdvertiserGroupsListResponse' - { _aglrNextPageToken :: !(Maybe Text) - , _aglrKind :: !Text - , _aglrAdvertiserGroups :: !(Maybe [AdvertiserGroup]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'AdvertiserGroupsListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'aglrNextPageToken' --- --- * 'aglrKind' --- --- * 'aglrAdvertiserGroups' -advertiserGroupsListResponse - :: AdvertiserGroupsListResponse -advertiserGroupsListResponse = - AdvertiserGroupsListResponse' - { _aglrNextPageToken = Nothing - , _aglrKind = "dfareporting#advertiserGroupsListResponse" - , _aglrAdvertiserGroups = Nothing - } - --- | Pagination token to be used for the next list operation. -aglrNextPageToken :: Lens' AdvertiserGroupsListResponse (Maybe Text) -aglrNextPageToken - = lens _aglrNextPageToken - (\ s a -> s{_aglrNextPageToken = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#advertiserGroupsListResponse\". -aglrKind :: Lens' AdvertiserGroupsListResponse Text -aglrKind = lens _aglrKind (\ s a -> s{_aglrKind = a}) - --- | Advertiser group collection. -aglrAdvertiserGroups :: Lens' AdvertiserGroupsListResponse [AdvertiserGroup] -aglrAdvertiserGroups - = lens _aglrAdvertiserGroups - (\ s a -> s{_aglrAdvertiserGroups = a}) - . _Default - . _Coerce - -instance FromJSON AdvertiserGroupsListResponse where - parseJSON - = withObject "AdvertiserGroupsListResponse" - (\ o -> - AdvertiserGroupsListResponse' <$> - (o .:? "nextPageToken") <*> - (o .:? "kind" .!= - "dfareporting#advertiserGroupsListResponse") - <*> (o .:? "advertiserGroups" .!= mempty)) - -instance ToJSON AdvertiserGroupsListResponse where - toJSON AdvertiserGroupsListResponse'{..} - = object - (catMaybes - [("nextPageToken" .=) <$> _aglrNextPageToken, - Just ("kind" .= _aglrKind), - ("advertiserGroups" .=) <$> _aglrAdvertiserGroups]) - --- | Creative Assignment. --- --- /See:/ 'creativeAssignment' smart constructor. -data CreativeAssignment = CreativeAssignment' - { _caCreativeGroupAssignments :: !(Maybe [CreativeGroupAssignment]) - , _caStartTime :: !(Maybe DateTime') - , _caWeight :: !(Maybe (Textual Int32)) - , _caRichMediaExitOverrides :: !(Maybe [RichMediaExitOverride]) - , _caSSLCompliant :: !(Maybe Bool) - , _caCreativeId :: !(Maybe (Textual Int64)) - , _caClickThroughURL :: !(Maybe ClickThroughURL) - , _caApplyEventTags :: !(Maybe Bool) - , _caActive :: !(Maybe Bool) - , _caSequence :: !(Maybe (Textual Int32)) - , _caEndTime :: !(Maybe DateTime') - , _caCompanionCreativeOverrides :: !(Maybe [CompanionClickThroughOverride]) - , _caCreativeIdDimensionValue :: !(Maybe DimensionValue) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'CreativeAssignment' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'caCreativeGroupAssignments' --- --- * 'caStartTime' --- --- * 'caWeight' --- --- * 'caRichMediaExitOverrides' --- --- * 'caSSLCompliant' --- --- * 'caCreativeId' --- --- * 'caClickThroughURL' --- --- * 'caApplyEventTags' --- --- * 'caActive' --- --- * 'caSequence' --- --- * 'caEndTime' --- --- * 'caCompanionCreativeOverrides' --- --- * 'caCreativeIdDimensionValue' -creativeAssignment - :: CreativeAssignment -creativeAssignment = - CreativeAssignment' - { _caCreativeGroupAssignments = Nothing - , _caStartTime = Nothing - , _caWeight = Nothing - , _caRichMediaExitOverrides = Nothing - , _caSSLCompliant = Nothing - , _caCreativeId = Nothing - , _caClickThroughURL = Nothing - , _caApplyEventTags = Nothing - , _caActive = Nothing - , _caSequence = Nothing - , _caEndTime = Nothing - , _caCompanionCreativeOverrides = Nothing - , _caCreativeIdDimensionValue = Nothing - } - --- | Creative group assignments for this creative assignment. Only one --- assignment per creative group number is allowed for a maximum of two --- assignments. -caCreativeGroupAssignments :: Lens' CreativeAssignment [CreativeGroupAssignment] -caCreativeGroupAssignments - = lens _caCreativeGroupAssignments - (\ s a -> s{_caCreativeGroupAssignments = a}) - . _Default - . _Coerce - --- | Date and time that the assigned creative should start serving. -caStartTime :: Lens' CreativeAssignment (Maybe UTCTime) -caStartTime - = lens _caStartTime (\ s a -> s{_caStartTime = a}) . - mapping _DateTime - --- | Weight of the creative assignment, applicable when the rotation type is --- CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1. -caWeight :: Lens' CreativeAssignment (Maybe Int32) -caWeight - = lens _caWeight (\ s a -> s{_caWeight = a}) . - mapping _Coerce - --- | Rich media exit overrides for this creative assignment. Applicable when --- the creative type is any of the following: - DISPLAY - RICH_MEDIA_INPAGE --- - RICH_MEDIA_INPAGE_FLOATING - RICH_MEDIA_IM_EXPAND - --- RICH_MEDIA_EXPANDING - RICH_MEDIA_INTERSTITIAL_FLOAT - --- RICH_MEDIA_MOBILE_IN_APP - RICH_MEDIA_MULTI_FLOATING - --- RICH_MEDIA_PEEL_DOWN - VPAID_LINEAR - VPAID_NON_LINEAR -caRichMediaExitOverrides :: Lens' CreativeAssignment [RichMediaExitOverride] -caRichMediaExitOverrides - = lens _caRichMediaExitOverrides - (\ s a -> s{_caRichMediaExitOverrides = a}) - . _Default - . _Coerce - --- | Whether the creative to be assigned is SSL-compliant. This is a --- read-only field that is auto-generated when the ad is inserted or --- updated. -caSSLCompliant :: Lens' CreativeAssignment (Maybe Bool) -caSSLCompliant - = lens _caSSLCompliant - (\ s a -> s{_caSSLCompliant = a}) - --- | ID of the creative to be assigned. This is a required field. -caCreativeId :: Lens' CreativeAssignment (Maybe Int64) -caCreativeId - = lens _caCreativeId (\ s a -> s{_caCreativeId = a}) - . mapping _Coerce - --- | Click-through URL of the creative assignment. -caClickThroughURL :: Lens' CreativeAssignment (Maybe ClickThroughURL) -caClickThroughURL - = lens _caClickThroughURL - (\ s a -> s{_caClickThroughURL = a}) - --- | Whether applicable event tags should fire when this creative assignment --- is rendered. If this value is unset when the ad is inserted or updated, --- it will default to true for all creative types EXCEPT for --- INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO. -caApplyEventTags :: Lens' CreativeAssignment (Maybe Bool) -caApplyEventTags - = lens _caApplyEventTags - (\ s a -> s{_caApplyEventTags = a}) - --- | Whether this creative assignment is active. When true, the creative will --- be included in the ad\'s rotation. -caActive :: Lens' CreativeAssignment (Maybe Bool) -caActive = lens _caActive (\ s a -> s{_caActive = a}) - --- | Sequence number of the creative assignment, applicable when the rotation --- type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to --- 65535, inclusive. -caSequence :: Lens' CreativeAssignment (Maybe Int32) -caSequence - = lens _caSequence (\ s a -> s{_caSequence = a}) . - mapping _Coerce - --- | Date and time that the assigned creative should stop serving. Must be --- later than the start time. -caEndTime :: Lens' CreativeAssignment (Maybe UTCTime) -caEndTime - = lens _caEndTime (\ s a -> s{_caEndTime = a}) . - mapping _DateTime - --- | Companion creative overrides for this creative assignment. Applicable to --- video ads. -caCompanionCreativeOverrides :: Lens' CreativeAssignment [CompanionClickThroughOverride] -caCompanionCreativeOverrides - = lens _caCompanionCreativeOverrides - (\ s a -> s{_caCompanionCreativeOverrides = a}) - . _Default - . _Coerce - --- | Dimension value for the ID of the creative. This is a read-only, --- auto-generated field. -caCreativeIdDimensionValue :: Lens' CreativeAssignment (Maybe DimensionValue) -caCreativeIdDimensionValue - = lens _caCreativeIdDimensionValue - (\ s a -> s{_caCreativeIdDimensionValue = a}) - -instance FromJSON CreativeAssignment where - parseJSON - = withObject "CreativeAssignment" - (\ o -> - CreativeAssignment' <$> - (o .:? "creativeGroupAssignments" .!= mempty) <*> - (o .:? "startTime") - <*> (o .:? "weight") - <*> (o .:? "richMediaExitOverrides" .!= mempty) - <*> (o .:? "sslCompliant") - <*> (o .:? "creativeId") - <*> (o .:? "clickThroughUrl") - <*> (o .:? "applyEventTags") - <*> (o .:? "active") - <*> (o .:? "sequence") - <*> (o .:? "endTime") - <*> (o .:? "companionCreativeOverrides" .!= mempty) - <*> (o .:? "creativeIdDimensionValue")) - -instance ToJSON CreativeAssignment where - toJSON CreativeAssignment'{..} - = object - (catMaybes - [("creativeGroupAssignments" .=) <$> - _caCreativeGroupAssignments, - ("startTime" .=) <$> _caStartTime, - ("weight" .=) <$> _caWeight, - ("richMediaExitOverrides" .=) <$> - _caRichMediaExitOverrides, - ("sslCompliant" .=) <$> _caSSLCompliant, - ("creativeId" .=) <$> _caCreativeId, - ("clickThroughUrl" .=) <$> _caClickThroughURL, - ("applyEventTags" .=) <$> _caApplyEventTags, - ("active" .=) <$> _caActive, - ("sequence" .=) <$> _caSequence, - ("endTime" .=) <$> _caEndTime, - ("companionCreativeOverrides" .=) <$> - _caCompanionCreativeOverrides, - ("creativeIdDimensionValue" .=) <$> - _caCreativeIdDimensionValue]) - --- | Represents a dimension filter. --- --- /See:/ 'dimensionFilter' smart constructor. -data DimensionFilter = DimensionFilter' - { _dfKind :: !Text - , _dfValue :: !(Maybe Text) - , _dfDimensionName :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'DimensionFilter' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'dfKind' --- --- * 'dfValue' --- --- * 'dfDimensionName' -dimensionFilter - :: DimensionFilter -dimensionFilter = - DimensionFilter' - { _dfKind = "dfareporting#dimensionFilter" - , _dfValue = Nothing - , _dfDimensionName = Nothing - } - --- | The kind of resource this is, in this case dfareporting#dimensionFilter. -dfKind :: Lens' DimensionFilter Text -dfKind = lens _dfKind (\ s a -> s{_dfKind = a}) - --- | The value of the dimension to filter. -dfValue :: Lens' DimensionFilter (Maybe Text) -dfValue = lens _dfValue (\ s a -> s{_dfValue = a}) - --- | The name of the dimension to filter. -dfDimensionName :: Lens' DimensionFilter (Maybe Text) -dfDimensionName - = lens _dfDimensionName - (\ s a -> s{_dfDimensionName = a}) - -instance FromJSON DimensionFilter where - parseJSON - = withObject "DimensionFilter" - (\ o -> - DimensionFilter' <$> - (o .:? "kind" .!= "dfareporting#dimensionFilter") <*> - (o .:? "value") - <*> (o .:? "dimensionName")) - -instance ToJSON DimensionFilter where - toJSON DimensionFilter'{..} - = object - (catMaybes - [Just ("kind" .= _dfKind), ("value" .=) <$> _dfValue, - ("dimensionName" .=) <$> _dfDimensionName]) - --- | Represents the list of user profiles. --- --- /See:/ 'userProFileList' smart constructor. -data UserProFileList = UserProFileList' - { _upflEtag :: !(Maybe Text) - , _upflKind :: !Text - , _upflItems :: !(Maybe [UserProFile]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'UserProFileList' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'upflEtag' --- --- * 'upflKind' --- --- * 'upflItems' -userProFileList - :: UserProFileList -userProFileList = - UserProFileList' - { _upflEtag = Nothing - , _upflKind = "dfareporting#userProfileList" - , _upflItems = Nothing - } - --- | The eTag of this response for caching purposes. -upflEtag :: Lens' UserProFileList (Maybe Text) -upflEtag = lens _upflEtag (\ s a -> s{_upflEtag = a}) - --- | The kind of list this is, in this case dfareporting#userProfileList. -upflKind :: Lens' UserProFileList Text -upflKind = lens _upflKind (\ s a -> s{_upflKind = a}) - --- | The user profiles returned in this response. -upflItems :: Lens' UserProFileList [UserProFile] -upflItems - = lens _upflItems (\ s a -> s{_upflItems = a}) . - _Default - . _Coerce - -instance FromJSON UserProFileList where - parseJSON - = withObject "UserProFileList" - (\ o -> - UserProFileList' <$> - (o .:? "etag") <*> - (o .:? "kind" .!= "dfareporting#userProfileList") - <*> (o .:? "items" .!= mempty)) - -instance ToJSON UserProFileList where - toJSON UserProFileList'{..} - = object - (catMaybes - [("etag" .=) <$> _upflEtag, - Just ("kind" .= _upflKind), - ("items" .=) <$> _upflItems]) - --- | Contains properties of a Floodlight configuration. --- --- /See:/ 'floodlightConfiguration' smart constructor. -data FloodlightConfiguration = FloodlightConfiguration' - { _fcTagSettings :: !(Maybe TagSettings) - , _fcExposureToConversionEnabled :: !(Maybe Bool) - , _fcInAppAttributionTrackingEnabled :: !(Maybe Bool) - , _fcThirdPartyAuthenticationTokens :: !(Maybe [ThirdPartyAuthenticationToken]) - , _fcKind :: !Text - , _fcAdvertiserId :: !(Maybe (Textual Int64)) - , _fcAnalyticsDataSharingEnabled :: !(Maybe Bool) - , _fcAdvertiserIdDimensionValue :: !(Maybe DimensionValue) - , _fcIdDimensionValue :: !(Maybe DimensionValue) - , _fcLookbackConfiguration :: !(Maybe LookbackConfiguration) - , _fcAccountId :: !(Maybe (Textual Int64)) - , _fcId :: !(Maybe (Textual Int64)) - , _fcNATuralSearchConversionAttributionOption :: !(Maybe FloodlightConfigurationNATuralSearchConversionAttributionOption) - , _fcUserDefinedVariableConfigurations :: !(Maybe [UserDefinedVariableConfiguration]) - , _fcSubAccountId :: !(Maybe (Textual Int64)) - , _fcFirstDayOfWeek :: !(Maybe FloodlightConfigurationFirstDayOfWeek) - , _fcOmnitureSettings :: !(Maybe OmnitureSettings) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'FloodlightConfiguration' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'fcTagSettings' --- --- * 'fcExposureToConversionEnabled' --- --- * 'fcInAppAttributionTrackingEnabled' --- --- * 'fcThirdPartyAuthenticationTokens' --- --- * 'fcKind' --- --- * 'fcAdvertiserId' --- --- * 'fcAnalyticsDataSharingEnabled' --- --- * 'fcAdvertiserIdDimensionValue' --- --- * 'fcIdDimensionValue' --- --- * 'fcLookbackConfiguration' --- --- * 'fcAccountId' --- --- * 'fcId' --- --- * 'fcNATuralSearchConversionAttributionOption' --- --- * 'fcUserDefinedVariableConfigurations' --- --- * 'fcSubAccountId' --- --- * 'fcFirstDayOfWeek' --- --- * 'fcOmnitureSettings' -floodlightConfiguration - :: FloodlightConfiguration -floodlightConfiguration = - FloodlightConfiguration' - { _fcTagSettings = Nothing - , _fcExposureToConversionEnabled = Nothing - , _fcInAppAttributionTrackingEnabled = Nothing - , _fcThirdPartyAuthenticationTokens = Nothing - , _fcKind = "dfareporting#floodlightConfiguration" - , _fcAdvertiserId = Nothing - , _fcAnalyticsDataSharingEnabled = Nothing - , _fcAdvertiserIdDimensionValue = Nothing - , _fcIdDimensionValue = Nothing - , _fcLookbackConfiguration = Nothing - , _fcAccountId = Nothing - , _fcId = Nothing - , _fcNATuralSearchConversionAttributionOption = Nothing - , _fcUserDefinedVariableConfigurations = Nothing - , _fcSubAccountId = Nothing - , _fcFirstDayOfWeek = Nothing - , _fcOmnitureSettings = Nothing - } - --- | Configuration settings for dynamic and image floodlight tags. -fcTagSettings :: Lens' FloodlightConfiguration (Maybe TagSettings) -fcTagSettings - = lens _fcTagSettings - (\ s a -> s{_fcTagSettings = a}) - --- | Whether the exposure-to-conversion report is enabled. This report shows --- detailed pathway information on up to 10 of the most recent ad exposures --- seen by a user before converting. -fcExposureToConversionEnabled :: Lens' FloodlightConfiguration (Maybe Bool) -fcExposureToConversionEnabled - = lens _fcExposureToConversionEnabled - (\ s a -> s{_fcExposureToConversionEnabled = a}) - --- | Whether in-app attribution tracking is enabled. -fcInAppAttributionTrackingEnabled :: Lens' FloodlightConfiguration (Maybe Bool) -fcInAppAttributionTrackingEnabled - = lens _fcInAppAttributionTrackingEnabled - (\ s a -> s{_fcInAppAttributionTrackingEnabled = a}) - --- | List of third-party authentication tokens enabled for this --- configuration. -fcThirdPartyAuthenticationTokens :: Lens' FloodlightConfiguration [ThirdPartyAuthenticationToken] -fcThirdPartyAuthenticationTokens - = lens _fcThirdPartyAuthenticationTokens - (\ s a -> s{_fcThirdPartyAuthenticationTokens = a}) - . _Default - . _Coerce - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#floodlightConfiguration\". -fcKind :: Lens' FloodlightConfiguration Text -fcKind = lens _fcKind (\ s a -> s{_fcKind = a}) - --- | Advertiser ID of the parent advertiser of this floodlight configuration. -fcAdvertiserId :: Lens' FloodlightConfiguration (Maybe Int64) -fcAdvertiserId - = lens _fcAdvertiserId - (\ s a -> s{_fcAdvertiserId = a}) - . mapping _Coerce - --- | Whether advertiser data is shared with Google Analytics. -fcAnalyticsDataSharingEnabled :: Lens' FloodlightConfiguration (Maybe Bool) -fcAnalyticsDataSharingEnabled - = lens _fcAnalyticsDataSharingEnabled - (\ s a -> s{_fcAnalyticsDataSharingEnabled = a}) - --- | Dimension value for the ID of the advertiser. This is a read-only, --- auto-generated field. -fcAdvertiserIdDimensionValue :: Lens' FloodlightConfiguration (Maybe DimensionValue) -fcAdvertiserIdDimensionValue - = lens _fcAdvertiserIdDimensionValue - (\ s a -> s{_fcAdvertiserIdDimensionValue = a}) - --- | Dimension value for the ID of this floodlight configuration. This is a --- read-only, auto-generated field. -fcIdDimensionValue :: Lens' FloodlightConfiguration (Maybe DimensionValue) -fcIdDimensionValue - = lens _fcIdDimensionValue - (\ s a -> s{_fcIdDimensionValue = a}) - --- | Lookback window settings for this floodlight configuration. -fcLookbackConfiguration :: Lens' FloodlightConfiguration (Maybe LookbackConfiguration) -fcLookbackConfiguration - = lens _fcLookbackConfiguration - (\ s a -> s{_fcLookbackConfiguration = a}) - --- | Account ID of this floodlight configuration. This is a read-only field --- that can be left blank. -fcAccountId :: Lens' FloodlightConfiguration (Maybe Int64) -fcAccountId - = lens _fcAccountId (\ s a -> s{_fcAccountId = a}) . - mapping _Coerce - --- | ID of this floodlight configuration. This is a read-only, auto-generated --- field. -fcId :: Lens' FloodlightConfiguration (Maybe Int64) -fcId - = lens _fcId (\ s a -> s{_fcId = a}) . - mapping _Coerce - --- | Types of attribution options for natural search conversions. -fcNATuralSearchConversionAttributionOption :: Lens' FloodlightConfiguration (Maybe FloodlightConfigurationNATuralSearchConversionAttributionOption) -fcNATuralSearchConversionAttributionOption - = lens _fcNATuralSearchConversionAttributionOption - (\ s a -> - s{_fcNATuralSearchConversionAttributionOption = a}) - --- | List of user defined variables enabled for this configuration. -fcUserDefinedVariableConfigurations :: Lens' FloodlightConfiguration [UserDefinedVariableConfiguration] -fcUserDefinedVariableConfigurations - = lens _fcUserDefinedVariableConfigurations - (\ s a -> - s{_fcUserDefinedVariableConfigurations = a}) - . _Default - . _Coerce - --- | Subaccount ID of this floodlight configuration. This is a read-only --- field that can be left blank. -fcSubAccountId :: Lens' FloodlightConfiguration (Maybe Int64) -fcSubAccountId - = lens _fcSubAccountId - (\ s a -> s{_fcSubAccountId = a}) - . mapping _Coerce - --- | Day that will be counted as the first day of the week in reports. This --- is a required field. -fcFirstDayOfWeek :: Lens' FloodlightConfiguration (Maybe FloodlightConfigurationFirstDayOfWeek) -fcFirstDayOfWeek - = lens _fcFirstDayOfWeek - (\ s a -> s{_fcFirstDayOfWeek = a}) - --- | Settings for Campaign Manager Omniture integration. -fcOmnitureSettings :: Lens' FloodlightConfiguration (Maybe OmnitureSettings) -fcOmnitureSettings - = lens _fcOmnitureSettings - (\ s a -> s{_fcOmnitureSettings = a}) - -instance FromJSON FloodlightConfiguration where - parseJSON - = withObject "FloodlightConfiguration" - (\ o -> - FloodlightConfiguration' <$> - (o .:? "tagSettings") <*> - (o .:? "exposureToConversionEnabled") - <*> (o .:? "inAppAttributionTrackingEnabled") - <*> - (o .:? "thirdPartyAuthenticationTokens" .!= mempty) - <*> - (o .:? "kind" .!= - "dfareporting#floodlightConfiguration") - <*> (o .:? "advertiserId") - <*> (o .:? "analyticsDataSharingEnabled") - <*> (o .:? "advertiserIdDimensionValue") - <*> (o .:? "idDimensionValue") - <*> (o .:? "lookbackConfiguration") - <*> (o .:? "accountId") - <*> (o .:? "id") - <*> - (o .:? "naturalSearchConversionAttributionOption") - <*> - (o .:? "userDefinedVariableConfigurations" .!= - mempty) - <*> (o .:? "subaccountId") - <*> (o .:? "firstDayOfWeek") - <*> (o .:? "omnitureSettings")) - -instance ToJSON FloodlightConfiguration where - toJSON FloodlightConfiguration'{..} - = object - (catMaybes - [("tagSettings" .=) <$> _fcTagSettings, - ("exposureToConversionEnabled" .=) <$> - _fcExposureToConversionEnabled, - ("inAppAttributionTrackingEnabled" .=) <$> - _fcInAppAttributionTrackingEnabled, - ("thirdPartyAuthenticationTokens" .=) <$> - _fcThirdPartyAuthenticationTokens, - Just ("kind" .= _fcKind), - ("advertiserId" .=) <$> _fcAdvertiserId, - ("analyticsDataSharingEnabled" .=) <$> - _fcAnalyticsDataSharingEnabled, - ("advertiserIdDimensionValue" .=) <$> - _fcAdvertiserIdDimensionValue, - ("idDimensionValue" .=) <$> _fcIdDimensionValue, - ("lookbackConfiguration" .=) <$> - _fcLookbackConfiguration, - ("accountId" .=) <$> _fcAccountId, - ("id" .=) <$> _fcId, - ("naturalSearchConversionAttributionOption" .=) <$> - _fcNATuralSearchConversionAttributionOption, - ("userDefinedVariableConfigurations" .=) <$> - _fcUserDefinedVariableConfigurations, - ("subaccountId" .=) <$> _fcSubAccountId, - ("firstDayOfWeek" .=) <$> _fcFirstDayOfWeek, - ("omnitureSettings" .=) <$> _fcOmnitureSettings]) - --- | Companion Settings --- --- /See:/ 'companionSetting' smart constructor. -data CompanionSetting = CompanionSetting' - { _comKind :: !Text - , _comImageOnly :: !(Maybe Bool) - , _comCompanionsDisabled :: !(Maybe Bool) - , _comEnabledSizes :: !(Maybe [Size]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'CompanionSetting' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'comKind' --- --- * 'comImageOnly' --- --- * 'comCompanionsDisabled' --- --- * 'comEnabledSizes' -companionSetting - :: CompanionSetting -companionSetting = - CompanionSetting' - { _comKind = "dfareporting#companionSetting" - , _comImageOnly = Nothing - , _comCompanionsDisabled = Nothing - , _comEnabledSizes = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#companionSetting\". -comKind :: Lens' CompanionSetting Text -comKind = lens _comKind (\ s a -> s{_comKind = a}) - --- | Whether to serve only static images as companions. -comImageOnly :: Lens' CompanionSetting (Maybe Bool) -comImageOnly - = lens _comImageOnly (\ s a -> s{_comImageOnly = a}) - --- | Whether companions are disabled for this placement. -comCompanionsDisabled :: Lens' CompanionSetting (Maybe Bool) -comCompanionsDisabled - = lens _comCompanionsDisabled - (\ s a -> s{_comCompanionsDisabled = a}) - --- | Whitelist of companion sizes to be served to this placement. Set this --- list to null or empty to serve all companion sizes. -comEnabledSizes :: Lens' CompanionSetting [Size] -comEnabledSizes - = lens _comEnabledSizes - (\ s a -> s{_comEnabledSizes = a}) - . _Default - . _Coerce - -instance FromJSON CompanionSetting where - parseJSON - = withObject "CompanionSetting" - (\ o -> - CompanionSetting' <$> - (o .:? "kind" .!= "dfareporting#companionSetting") - <*> (o .:? "imageOnly") - <*> (o .:? "companionsDisabled") - <*> (o .:? "enabledSizes" .!= mempty)) - -instance ToJSON CompanionSetting where - toJSON CompanionSetting'{..} - = object - (catMaybes - [Just ("kind" .= _comKind), - ("imageOnly" .=) <$> _comImageOnly, - ("companionsDisabled" .=) <$> _comCompanionsDisabled, - ("enabledSizes" .=) <$> _comEnabledSizes]) - --- | Floodlight Activity Group List Response --- --- /See:/ 'floodlightActivityGroupsListResponse' smart constructor. -data FloodlightActivityGroupsListResponse = FloodlightActivityGroupsListResponse' - { _faglrNextPageToken :: !(Maybe Text) - , _faglrKind :: !Text - , _faglrFloodlightActivityGroups :: !(Maybe [FloodlightActivityGroup]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'FloodlightActivityGroupsListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'faglrNextPageToken' --- --- * 'faglrKind' --- --- * 'faglrFloodlightActivityGroups' -floodlightActivityGroupsListResponse - :: FloodlightActivityGroupsListResponse -floodlightActivityGroupsListResponse = - FloodlightActivityGroupsListResponse' - { _faglrNextPageToken = Nothing - , _faglrKind = "dfareporting#floodlightActivityGroupsListResponse" - , _faglrFloodlightActivityGroups = Nothing - } - --- | Pagination token to be used for the next list operation. -faglrNextPageToken :: Lens' FloodlightActivityGroupsListResponse (Maybe Text) -faglrNextPageToken - = lens _faglrNextPageToken - (\ s a -> s{_faglrNextPageToken = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#floodlightActivityGroupsListResponse\". -faglrKind :: Lens' FloodlightActivityGroupsListResponse Text -faglrKind - = lens _faglrKind (\ s a -> s{_faglrKind = a}) - --- | Floodlight activity group collection. -faglrFloodlightActivityGroups :: Lens' FloodlightActivityGroupsListResponse [FloodlightActivityGroup] -faglrFloodlightActivityGroups - = lens _faglrFloodlightActivityGroups - (\ s a -> s{_faglrFloodlightActivityGroups = a}) - . _Default - . _Coerce - -instance FromJSON - FloodlightActivityGroupsListResponse where - parseJSON - = withObject "FloodlightActivityGroupsListResponse" - (\ o -> - FloodlightActivityGroupsListResponse' <$> - (o .:? "nextPageToken") <*> - (o .:? "kind" .!= - "dfareporting#floodlightActivityGroupsListResponse") - <*> (o .:? "floodlightActivityGroups" .!= mempty)) - -instance ToJSON FloodlightActivityGroupsListResponse - where - toJSON FloodlightActivityGroupsListResponse'{..} - = object - (catMaybes - [("nextPageToken" .=) <$> _faglrNextPageToken, - Just ("kind" .= _faglrKind), - ("floodlightActivityGroups" .=) <$> - _faglrFloodlightActivityGroups]) - --- | A Conversion represents when a user successfully performs a desired --- action after seeing an ad. --- --- /See:/ 'conversion' smart constructor. -data Conversion = Conversion' - { _conoTreatmentForUnderage :: !(Maybe Bool) - , _conoEncryptedUserIdCandidates :: !(Maybe [Text]) - , _conoTimestampMicros :: !(Maybe (Textual Int64)) - , _conoLimitAdTracking :: !(Maybe Bool) - , _conoEncryptedUserId :: !(Maybe Text) - , _conoMobileDeviceId :: !(Maybe Text) - , _conoFloodlightConfigurationId :: !(Maybe (Textual Int64)) - , _conoKind :: !Text - , _conoFloodlightActivityId :: !(Maybe (Textual Int64)) - , _conoNonPersonalizedAd :: !(Maybe Bool) - , _conoQuantity :: !(Maybe (Textual Int64)) - , _conoValue :: !(Maybe (Textual Double)) - , _conoCustomVariables :: !(Maybe [CustomFloodlightVariable]) - , _conoChildDirectedTreatment :: !(Maybe Bool) - , _conoGclid :: !(Maybe Text) - , _conoOrdinal :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'Conversion' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'conoTreatmentForUnderage' --- --- * 'conoEncryptedUserIdCandidates' --- --- * 'conoTimestampMicros' --- --- * 'conoLimitAdTracking' --- --- * 'conoEncryptedUserId' --- --- * 'conoMobileDeviceId' --- --- * 'conoFloodlightConfigurationId' --- --- * 'conoKind' --- --- * 'conoFloodlightActivityId' --- --- * 'conoNonPersonalizedAd' --- --- * 'conoQuantity' --- --- * 'conoValue' --- --- * 'conoCustomVariables' --- --- * 'conoChildDirectedTreatment' --- --- * 'conoGclid' --- --- * 'conoOrdinal' -conversion - :: Conversion -conversion = - Conversion' - { _conoTreatmentForUnderage = Nothing - , _conoEncryptedUserIdCandidates = Nothing - , _conoTimestampMicros = Nothing - , _conoLimitAdTracking = Nothing - , _conoEncryptedUserId = Nothing - , _conoMobileDeviceId = Nothing - , _conoFloodlightConfigurationId = Nothing - , _conoKind = "dfareporting#conversion" - , _conoFloodlightActivityId = Nothing - , _conoNonPersonalizedAd = Nothing - , _conoQuantity = Nothing - , _conoValue = Nothing - , _conoCustomVariables = Nothing - , _conoChildDirectedTreatment = Nothing - , _conoGclid = Nothing - , _conoOrdinal = Nothing - } - --- | Whether this particular request may come from a user under the age of 16 --- (may differ by country), under compliance with the European Union\'s --- General Data Protection Regulation (GDPR). -conoTreatmentForUnderage :: Lens' Conversion (Maybe Bool) -conoTreatmentForUnderage - = lens _conoTreatmentForUnderage - (\ s a -> s{_conoTreatmentForUnderage = a}) - --- | A list of the alphanumeric encrypted user IDs. Any user ID with exposure --- prior to the conversion timestamp will be used in the inserted --- conversion. If no such user ID is found then the conversion will be --- rejected with NO_COOKIE_MATCH_FOUND error. When set, encryptionInfo --- should also be specified. This field may only be used when calling --- batchinsert; it is not supported by batchupdate. This field is mutually --- exclusive with encryptedUserId, mobileDeviceId and gclid. This or --- encryptedUserId or mobileDeviceId or gclid is a required field. -conoEncryptedUserIdCandidates :: Lens' Conversion [Text] -conoEncryptedUserIdCandidates - = lens _conoEncryptedUserIdCandidates - (\ s a -> s{_conoEncryptedUserIdCandidates = a}) - . _Default - . _Coerce - --- | The timestamp of conversion, in Unix epoch micros. This is a required --- field. -conoTimestampMicros :: Lens' Conversion (Maybe Int64) -conoTimestampMicros - = lens _conoTimestampMicros - (\ s a -> s{_conoTimestampMicros = a}) - . mapping _Coerce - --- | Whether Limit Ad Tracking is enabled. When set to true, the conversion --- will be used for reporting but not targeting. This will prevent --- remarketing. -conoLimitAdTracking :: Lens' Conversion (Maybe Bool) -conoLimitAdTracking - = lens _conoLimitAdTracking - (\ s a -> s{_conoLimitAdTracking = a}) - --- | The alphanumeric encrypted user ID. When set, encryptionInfo should also --- be specified. This field is mutually exclusive with --- encryptedUserIdCandidates[], mobileDeviceId and gclid. This or --- encryptedUserIdCandidates[] or mobileDeviceId or gclid is a required --- field. -conoEncryptedUserId :: Lens' Conversion (Maybe Text) -conoEncryptedUserId - = lens _conoEncryptedUserId - (\ s a -> s{_conoEncryptedUserId = a}) - --- | The mobile device ID. This field is mutually exclusive with --- encryptedUserId, encryptedUserIdCandidates[] and gclid. This or --- encryptedUserId or encryptedUserIdCandidates[] or gclid is a required --- field. -conoMobileDeviceId :: Lens' Conversion (Maybe Text) -conoMobileDeviceId - = lens _conoMobileDeviceId - (\ s a -> s{_conoMobileDeviceId = a}) - --- | Floodlight Configuration ID of this conversion. This is a required --- field. -conoFloodlightConfigurationId :: Lens' Conversion (Maybe Int64) -conoFloodlightConfigurationId - = lens _conoFloodlightConfigurationId - (\ s a -> s{_conoFloodlightConfigurationId = a}) - . mapping _Coerce - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#conversion\". -conoKind :: Lens' Conversion Text -conoKind = lens _conoKind (\ s a -> s{_conoKind = a}) - --- | Floodlight Activity ID of this conversion. This is a required field. -conoFloodlightActivityId :: Lens' Conversion (Maybe Int64) -conoFloodlightActivityId - = lens _conoFloodlightActivityId - (\ s a -> s{_conoFloodlightActivityId = a}) - . mapping _Coerce - --- | Whether the conversion was for a non personalized ad. -conoNonPersonalizedAd :: Lens' Conversion (Maybe Bool) -conoNonPersonalizedAd - = lens _conoNonPersonalizedAd - (\ s a -> s{_conoNonPersonalizedAd = a}) - --- | The quantity of the conversion. -conoQuantity :: Lens' Conversion (Maybe Int64) -conoQuantity - = lens _conoQuantity (\ s a -> s{_conoQuantity = a}) - . mapping _Coerce - --- | The value of the conversion. -conoValue :: Lens' Conversion (Maybe Double) -conoValue - = lens _conoValue (\ s a -> s{_conoValue = a}) . - mapping _Coerce - --- | Custom floodlight variables. -conoCustomVariables :: Lens' Conversion [CustomFloodlightVariable] -conoCustomVariables - = lens _conoCustomVariables - (\ s a -> s{_conoCustomVariables = a}) - . _Default - . _Coerce - --- | Whether this particular request may come from a user under the age of --- 13, under COPPA compliance. -conoChildDirectedTreatment :: Lens' Conversion (Maybe Bool) -conoChildDirectedTreatment - = lens _conoChildDirectedTreatment - (\ s a -> s{_conoChildDirectedTreatment = a}) - --- | The Google click ID. This field is mutually exclusive with --- encryptedUserId, encryptedUserIdCandidates[] and mobileDeviceId. This or --- encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId is a --- required field. -conoGclid :: Lens' Conversion (Maybe Text) -conoGclid - = lens _conoGclid (\ s a -> s{_conoGclid = a}) - --- | The ordinal of the conversion. Use this field to control how conversions --- of the same user and day are de-duplicated. This is a required field. -conoOrdinal :: Lens' Conversion (Maybe Text) -conoOrdinal - = lens _conoOrdinal (\ s a -> s{_conoOrdinal = a}) - -instance FromJSON Conversion where - parseJSON - = withObject "Conversion" - (\ o -> - Conversion' <$> - (o .:? "treatmentForUnderage") <*> - (o .:? "encryptedUserIdCandidates" .!= mempty) - <*> (o .:? "timestampMicros") - <*> (o .:? "limitAdTracking") - <*> (o .:? "encryptedUserId") - <*> (o .:? "mobileDeviceId") - <*> (o .:? "floodlightConfigurationId") - <*> (o .:? "kind" .!= "dfareporting#conversion") - <*> (o .:? "floodlightActivityId") - <*> (o .:? "nonPersonalizedAd") - <*> (o .:? "quantity") - <*> (o .:? "value") - <*> (o .:? "customVariables" .!= mempty) - <*> (o .:? "childDirectedTreatment") - <*> (o .:? "gclid") - <*> (o .:? "ordinal")) - -instance ToJSON Conversion where - toJSON Conversion'{..} - = object - (catMaybes - [("treatmentForUnderage" .=) <$> - _conoTreatmentForUnderage, - ("encryptedUserIdCandidates" .=) <$> - _conoEncryptedUserIdCandidates, - ("timestampMicros" .=) <$> _conoTimestampMicros, - ("limitAdTracking" .=) <$> _conoLimitAdTracking, - ("encryptedUserId" .=) <$> _conoEncryptedUserId, - ("mobileDeviceId" .=) <$> _conoMobileDeviceId, - ("floodlightConfigurationId" .=) <$> - _conoFloodlightConfigurationId, - Just ("kind" .= _conoKind), - ("floodlightActivityId" .=) <$> - _conoFloodlightActivityId, - ("nonPersonalizedAd" .=) <$> _conoNonPersonalizedAd, - ("quantity" .=) <$> _conoQuantity, - ("value" .=) <$> _conoValue, - ("customVariables" .=) <$> _conoCustomVariables, - ("childDirectedTreatment" .=) <$> - _conoChildDirectedTreatment, - ("gclid" .=) <$> _conoGclid, - ("ordinal" .=) <$> _conoOrdinal]) - --- | Creative Field Value List Response --- --- /See:/ 'creativeFieldValuesListResponse' smart constructor. -data CreativeFieldValuesListResponse = CreativeFieldValuesListResponse' - { _cfvlrNextPageToken :: !(Maybe Text) - , _cfvlrKind :: !Text - , _cfvlrCreativeFieldValues :: !(Maybe [CreativeFieldValue]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'CreativeFieldValuesListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'cfvlrNextPageToken' --- --- * 'cfvlrKind' --- --- * 'cfvlrCreativeFieldValues' -creativeFieldValuesListResponse - :: CreativeFieldValuesListResponse -creativeFieldValuesListResponse = - CreativeFieldValuesListResponse' - { _cfvlrNextPageToken = Nothing - , _cfvlrKind = "dfareporting#creativeFieldValuesListResponse" - , _cfvlrCreativeFieldValues = Nothing - } - --- | Pagination token to be used for the next list operation. -cfvlrNextPageToken :: Lens' CreativeFieldValuesListResponse (Maybe Text) -cfvlrNextPageToken - = lens _cfvlrNextPageToken - (\ s a -> s{_cfvlrNextPageToken = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#creativeFieldValuesListResponse\". -cfvlrKind :: Lens' CreativeFieldValuesListResponse Text -cfvlrKind - = lens _cfvlrKind (\ s a -> s{_cfvlrKind = a}) - --- | Creative field value collection. -cfvlrCreativeFieldValues :: Lens' CreativeFieldValuesListResponse [CreativeFieldValue] -cfvlrCreativeFieldValues - = lens _cfvlrCreativeFieldValues - (\ s a -> s{_cfvlrCreativeFieldValues = a}) - . _Default - . _Coerce - -instance FromJSON CreativeFieldValuesListResponse - where - parseJSON - = withObject "CreativeFieldValuesListResponse" - (\ o -> - CreativeFieldValuesListResponse' <$> - (o .:? "nextPageToken") <*> - (o .:? "kind" .!= - "dfareporting#creativeFieldValuesListResponse") - <*> (o .:? "creativeFieldValues" .!= mempty)) - -instance ToJSON CreativeFieldValuesListResponse where - toJSON CreativeFieldValuesListResponse'{..} - = object - (catMaybes - [("nextPageToken" .=) <$> _cfvlrNextPageToken, - Just ("kind" .= _cfvlrKind), - ("creativeFieldValues" .=) <$> - _cfvlrCreativeFieldValues]) - --- | Rich Media Exit Override. --- --- /See:/ 'richMediaExitOverride' smart constructor. -data RichMediaExitOverride = RichMediaExitOverride' - { _rmeoEnabled :: !(Maybe Bool) - , _rmeoClickThroughURL :: !(Maybe ClickThroughURL) - , _rmeoExitId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'RichMediaExitOverride' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'rmeoEnabled' --- --- * 'rmeoClickThroughURL' --- --- * 'rmeoExitId' -richMediaExitOverride - :: RichMediaExitOverride -richMediaExitOverride = - RichMediaExitOverride' - { _rmeoEnabled = Nothing - , _rmeoClickThroughURL = Nothing - , _rmeoExitId = Nothing - } - --- | Whether to use the clickThroughUrl. If false, the creative-level exit --- will be used. -rmeoEnabled :: Lens' RichMediaExitOverride (Maybe Bool) -rmeoEnabled - = lens _rmeoEnabled (\ s a -> s{_rmeoEnabled = a}) - --- | Click-through URL of this rich media exit override. Applicable if the --- enabled field is set to true. -rmeoClickThroughURL :: Lens' RichMediaExitOverride (Maybe ClickThroughURL) -rmeoClickThroughURL - = lens _rmeoClickThroughURL - (\ s a -> s{_rmeoClickThroughURL = a}) - --- | ID for the override to refer to a specific exit in the creative. -rmeoExitId :: Lens' RichMediaExitOverride (Maybe Int64) -rmeoExitId - = lens _rmeoExitId (\ s a -> s{_rmeoExitId = a}) . - mapping _Coerce - -instance FromJSON RichMediaExitOverride where - parseJSON - = withObject "RichMediaExitOverride" - (\ o -> - RichMediaExitOverride' <$> - (o .:? "enabled") <*> (o .:? "clickThroughUrl") <*> - (o .:? "exitId")) - -instance ToJSON RichMediaExitOverride where - toJSON RichMediaExitOverride'{..} - = object - (catMaybes - [("enabled" .=) <$> _rmeoEnabled, - ("clickThroughUrl" .=) <$> _rmeoClickThroughURL, - ("exitId" .=) <$> _rmeoExitId]) - --- | Landing Page List Response --- --- /See:/ 'advertiserLandingPagesListResponse' smart constructor. -data AdvertiserLandingPagesListResponse = AdvertiserLandingPagesListResponse' - { _alplrLandingPages :: !(Maybe [LandingPage]) - , _alplrNextPageToken :: !(Maybe Text) - , _alplrKind :: !Text - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'AdvertiserLandingPagesListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'alplrLandingPages' --- --- * 'alplrNextPageToken' --- --- * 'alplrKind' -advertiserLandingPagesListResponse - :: AdvertiserLandingPagesListResponse -advertiserLandingPagesListResponse = - AdvertiserLandingPagesListResponse' - { _alplrLandingPages = Nothing - , _alplrNextPageToken = Nothing - , _alplrKind = "dfareporting#advertiserLandingPagesListResponse" - } - --- | Landing page collection -alplrLandingPages :: Lens' AdvertiserLandingPagesListResponse [LandingPage] -alplrLandingPages - = lens _alplrLandingPages - (\ s a -> s{_alplrLandingPages = a}) - . _Default - . _Coerce - --- | Pagination token to be used for the next list operation. -alplrNextPageToken :: Lens' AdvertiserLandingPagesListResponse (Maybe Text) -alplrNextPageToken - = lens _alplrNextPageToken - (\ s a -> s{_alplrNextPageToken = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#advertiserLandingPagesListResponse\". -alplrKind :: Lens' AdvertiserLandingPagesListResponse Text -alplrKind - = lens _alplrKind (\ s a -> s{_alplrKind = a}) - -instance FromJSON AdvertiserLandingPagesListResponse - where - parseJSON - = withObject "AdvertiserLandingPagesListResponse" - (\ o -> - AdvertiserLandingPagesListResponse' <$> - (o .:? "landingPages" .!= mempty) <*> - (o .:? "nextPageToken") - <*> - (o .:? "kind" .!= - "dfareporting#advertiserLandingPagesListResponse")) - -instance ToJSON AdvertiserLandingPagesListResponse - where - toJSON AdvertiserLandingPagesListResponse'{..} - = object - (catMaybes - [("landingPages" .=) <$> _alplrLandingPages, - ("nextPageToken" .=) <$> _alplrNextPageToken, - Just ("kind" .= _alplrKind)]) - --- | Mobile app List Response --- --- /See:/ 'mobileAppsListResponse' smart constructor. -data MobileAppsListResponse = MobileAppsListResponse' - { _malrNextPageToken :: !(Maybe Text) - , _malrKind :: !Text - , _malrMobileApps :: !(Maybe [MobileApp]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'MobileAppsListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'malrNextPageToken' --- --- * 'malrKind' --- --- * 'malrMobileApps' -mobileAppsListResponse - :: MobileAppsListResponse -mobileAppsListResponse = - MobileAppsListResponse' - { _malrNextPageToken = Nothing - , _malrKind = "dfareporting#mobileAppsListResponse" - , _malrMobileApps = Nothing - } - --- | Pagination token to be used for the next list operation. -malrNextPageToken :: Lens' MobileAppsListResponse (Maybe Text) -malrNextPageToken - = lens _malrNextPageToken - (\ s a -> s{_malrNextPageToken = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#mobileAppsListResponse\". -malrKind :: Lens' MobileAppsListResponse Text -malrKind = lens _malrKind (\ s a -> s{_malrKind = a}) - --- | Mobile apps collection. -malrMobileApps :: Lens' MobileAppsListResponse [MobileApp] -malrMobileApps - = lens _malrMobileApps - (\ s a -> s{_malrMobileApps = a}) - . _Default - . _Coerce - -instance FromJSON MobileAppsListResponse where - parseJSON - = withObject "MobileAppsListResponse" - (\ o -> - MobileAppsListResponse' <$> - (o .:? "nextPageToken") <*> - (o .:? "kind" .!= - "dfareporting#mobileAppsListResponse") - <*> (o .:? "mobileApps" .!= mempty)) - -instance ToJSON MobileAppsListResponse where - toJSON MobileAppsListResponse'{..} - = object - (catMaybes - [("nextPageToken" .=) <$> _malrNextPageToken, - Just ("kind" .= _malrKind), - ("mobileApps" .=) <$> _malrMobileApps]) - --- | Represents a sorted dimension. --- --- /See:/ 'sortedDimension' smart constructor. -data SortedDimension = SortedDimension' - { _sdKind :: !Text - , _sdSortOrder :: !(Maybe SortedDimensionSortOrder) - , _sdName :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'SortedDimension' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'sdKind' --- --- * 'sdSortOrder' --- --- * 'sdName' -sortedDimension - :: SortedDimension -sortedDimension = - SortedDimension' - { _sdKind = "dfareporting#sortedDimension" - , _sdSortOrder = Nothing - , _sdName = Nothing - } - --- | The kind of resource this is, in this case dfareporting#sortedDimension. -sdKind :: Lens' SortedDimension Text -sdKind = lens _sdKind (\ s a -> s{_sdKind = a}) - --- | An optional sort order for the dimension column. -sdSortOrder :: Lens' SortedDimension (Maybe SortedDimensionSortOrder) -sdSortOrder - = lens _sdSortOrder (\ s a -> s{_sdSortOrder = a}) - --- | The name of the dimension. -sdName :: Lens' SortedDimension (Maybe Text) -sdName = lens _sdName (\ s a -> s{_sdName = a}) - -instance FromJSON SortedDimension where - parseJSON - = withObject "SortedDimension" - (\ o -> - SortedDimension' <$> - (o .:? "kind" .!= "dfareporting#sortedDimension") <*> - (o .:? "sortOrder") - <*> (o .:? "name")) - -instance ToJSON SortedDimension where - toJSON SortedDimension'{..} - = object - (catMaybes - [Just ("kind" .= _sdKind), - ("sortOrder" .=) <$> _sdSortOrder, - ("name" .=) <$> _sdName]) - --- | Creative Field List Response --- --- /See:/ 'creativeFieldsListResponse' smart constructor. -data CreativeFieldsListResponse = CreativeFieldsListResponse' - { _cflrNextPageToken :: !(Maybe Text) - , _cflrKind :: !Text - , _cflrCreativeFields :: !(Maybe [CreativeField]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'CreativeFieldsListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'cflrNextPageToken' --- --- * 'cflrKind' --- --- * 'cflrCreativeFields' -creativeFieldsListResponse - :: CreativeFieldsListResponse -creativeFieldsListResponse = - CreativeFieldsListResponse' - { _cflrNextPageToken = Nothing - , _cflrKind = "dfareporting#creativeFieldsListResponse" - , _cflrCreativeFields = Nothing - } - --- | Pagination token to be used for the next list operation. -cflrNextPageToken :: Lens' CreativeFieldsListResponse (Maybe Text) -cflrNextPageToken - = lens _cflrNextPageToken - (\ s a -> s{_cflrNextPageToken = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#creativeFieldsListResponse\". -cflrKind :: Lens' CreativeFieldsListResponse Text -cflrKind = lens _cflrKind (\ s a -> s{_cflrKind = a}) - --- | Creative field collection. -cflrCreativeFields :: Lens' CreativeFieldsListResponse [CreativeField] -cflrCreativeFields - = lens _cflrCreativeFields - (\ s a -> s{_cflrCreativeFields = a}) - . _Default - . _Coerce - -instance FromJSON CreativeFieldsListResponse where - parseJSON - = withObject "CreativeFieldsListResponse" - (\ o -> - CreativeFieldsListResponse' <$> - (o .:? "nextPageToken") <*> - (o .:? "kind" .!= - "dfareporting#creativeFieldsListResponse") - <*> (o .:? "creativeFields" .!= mempty)) - -instance ToJSON CreativeFieldsListResponse where - toJSON CreativeFieldsListResponse'{..} - = object - (catMaybes - [("nextPageToken" .=) <$> _cflrNextPageToken, - Just ("kind" .= _cflrKind), - ("creativeFields" .=) <$> _cflrCreativeFields]) - --- | Targeting Template List Response --- --- /See:/ 'targetingTemplatesListResponse' smart constructor. -data TargetingTemplatesListResponse = TargetingTemplatesListResponse' - { _ttlrNextPageToken :: !(Maybe Text) - , _ttlrKind :: !Text - , _ttlrTargetingTemplates :: !(Maybe [TargetingTemplate]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'TargetingTemplatesListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'ttlrNextPageToken' --- --- * 'ttlrKind' --- --- * 'ttlrTargetingTemplates' -targetingTemplatesListResponse - :: TargetingTemplatesListResponse -targetingTemplatesListResponse = - TargetingTemplatesListResponse' - { _ttlrNextPageToken = Nothing - , _ttlrKind = "dfareporting#targetingTemplatesListResponse" - , _ttlrTargetingTemplates = Nothing - } - --- | Pagination token to be used for the next list operation. -ttlrNextPageToken :: Lens' TargetingTemplatesListResponse (Maybe Text) -ttlrNextPageToken - = lens _ttlrNextPageToken - (\ s a -> s{_ttlrNextPageToken = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#targetingTemplatesListResponse\". -ttlrKind :: Lens' TargetingTemplatesListResponse Text -ttlrKind = lens _ttlrKind (\ s a -> s{_ttlrKind = a}) - --- | Targeting template collection. -ttlrTargetingTemplates :: Lens' TargetingTemplatesListResponse [TargetingTemplate] -ttlrTargetingTemplates - = lens _ttlrTargetingTemplates - (\ s a -> s{_ttlrTargetingTemplates = a}) - . _Default - . _Coerce - -instance FromJSON TargetingTemplatesListResponse - where - parseJSON - = withObject "TargetingTemplatesListResponse" - (\ o -> - TargetingTemplatesListResponse' <$> - (o .:? "nextPageToken") <*> - (o .:? "kind" .!= - "dfareporting#targetingTemplatesListResponse") - <*> (o .:? "targetingTemplates" .!= mempty)) - -instance ToJSON TargetingTemplatesListResponse where - toJSON TargetingTemplatesListResponse'{..} - = object - (catMaybes - [("nextPageToken" .=) <$> _ttlrNextPageToken, - Just ("kind" .= _ttlrKind), - ("targetingTemplates" .=) <$> - _ttlrTargetingTemplates]) - --- | Placement GenerateTags Response --- --- /See:/ 'placementsGenerateTagsResponse' smart constructor. -data PlacementsGenerateTagsResponse = PlacementsGenerateTagsResponse' - { _pgtrKind :: !Text - , _pgtrPlacementTags :: !(Maybe [PlacementTag]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'PlacementsGenerateTagsResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'pgtrKind' --- --- * 'pgtrPlacementTags' -placementsGenerateTagsResponse - :: PlacementsGenerateTagsResponse -placementsGenerateTagsResponse = - PlacementsGenerateTagsResponse' - { _pgtrKind = "dfareporting#placementsGenerateTagsResponse" - , _pgtrPlacementTags = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#placementsGenerateTagsResponse\". -pgtrKind :: Lens' PlacementsGenerateTagsResponse Text -pgtrKind = lens _pgtrKind (\ s a -> s{_pgtrKind = a}) - --- | Set of generated tags for the specified placements. -pgtrPlacementTags :: Lens' PlacementsGenerateTagsResponse [PlacementTag] -pgtrPlacementTags - = lens _pgtrPlacementTags - (\ s a -> s{_pgtrPlacementTags = a}) - . _Default - . _Coerce - -instance FromJSON PlacementsGenerateTagsResponse - where - parseJSON - = withObject "PlacementsGenerateTagsResponse" - (\ o -> - PlacementsGenerateTagsResponse' <$> - (o .:? "kind" .!= - "dfareporting#placementsGenerateTagsResponse") - <*> (o .:? "placementTags" .!= mempty)) - -instance ToJSON PlacementsGenerateTagsResponse where - toJSON PlacementsGenerateTagsResponse'{..} - = object - (catMaybes - [Just ("kind" .= _pgtrKind), - ("placementTags" .=) <$> _pgtrPlacementTags]) - --- | Creative Asset. --- --- /See:/ 'creativeAsset' smart constructor. -data CreativeAsset = CreativeAsset' - { _caaZIndex :: !(Maybe (Textual Int32)) - , _caaPushdown :: !(Maybe Bool) - , _caaOriginalBackup :: !(Maybe Bool) - , _caaWindowMode :: !(Maybe CreativeAssetWindowMode) - , _caaFlashVersion :: !(Maybe (Textual Int32)) - , _caaPushdownDuration :: !(Maybe (Textual Double)) - , _caaSize :: !(Maybe Size) - , _caaVerticallyLocked :: !(Maybe Bool) - , _caaOffSet :: !(Maybe OffSetPosition) - , _caaStreamingServingURL :: !(Maybe Text) - , _caaZipFilesize :: !(Maybe Text) - , _caaTransparency :: !(Maybe Bool) - , _caaHideSelectionBoxes :: !(Maybe Bool) - , _caaSSLCompliant :: !(Maybe Bool) - , _caaFileSize :: !(Maybe (Textual Int64)) - , _caaAssetIdentifier :: !(Maybe CreativeAssetId) - , _caaCompanionCreativeIds :: !(Maybe [Textual Int64]) - , _caaDurationType :: !(Maybe CreativeAssetDurationType) - , _caaProgressiveServingURL :: !(Maybe Text) - , _caaIdDimensionValue :: !(Maybe DimensionValue) - , _caaActive :: !(Maybe Bool) - , _caaRole :: !(Maybe CreativeAssetRole) - , _caaMimeType :: !(Maybe Text) - , _caaPositionTopUnit :: !(Maybe CreativeAssetPositionTopUnit) - , _caaPositionLeftUnit :: !(Maybe CreativeAssetPositionLeftUnit) - , _caaAlignment :: !(Maybe CreativeAssetAlignment) - , _caaExpandedDimension :: !(Maybe Size) - , _caaAdditionalSizes :: !(Maybe [Size]) - , _caaZipFilename :: !(Maybe Text) - , _caaMediaDuration :: !(Maybe (Textual Double)) - , _caaActionScript3 :: !(Maybe Bool) - , _caaDisplayType :: !(Maybe CreativeAssetDisplayType) - , _caaChildAssetType :: !(Maybe CreativeAssetChildAssetType) - , _caaCollapsedSize :: !(Maybe Size) - , _caaId :: !(Maybe (Textual Int64)) - , _caaBitRate :: !(Maybe (Textual Int32)) - , _caaCustomStartTimeValue :: !(Maybe (Textual Int32)) - , _caaStartTimeType :: !(Maybe CreativeAssetStartTimeType) - , _caaDuration :: !(Maybe (Textual Int32)) - , _caaOrientation :: !(Maybe CreativeAssetOrientation) - , _caaArtworkType :: !(Maybe CreativeAssetArtworkType) - , _caaHideFlashObjects :: !(Maybe Bool) - , _caaDetectedFeatures :: !(Maybe [CreativeAssetDetectedFeaturesItem]) - , _caaBackupImageExit :: !(Maybe CreativeCustomEvent) - , _caaPosition :: !(Maybe OffSetPosition) - , _caaHorizontallyLocked :: !(Maybe Bool) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'CreativeAsset' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'caaZIndex' --- --- * 'caaPushdown' --- --- * 'caaOriginalBackup' --- --- * 'caaWindowMode' --- --- * 'caaFlashVersion' --- --- * 'caaPushdownDuration' --- --- * 'caaSize' --- --- * 'caaVerticallyLocked' --- --- * 'caaOffSet' --- --- * 'caaStreamingServingURL' --- --- * 'caaZipFilesize' --- --- * 'caaTransparency' --- --- * 'caaHideSelectionBoxes' --- --- * 'caaSSLCompliant' --- --- * 'caaFileSize' --- --- * 'caaAssetIdentifier' --- --- * 'caaCompanionCreativeIds' --- --- * 'caaDurationType' --- --- * 'caaProgressiveServingURL' --- --- * 'caaIdDimensionValue' --- --- * 'caaActive' --- --- * 'caaRole' --- --- * 'caaMimeType' --- --- * 'caaPositionTopUnit' --- --- * 'caaPositionLeftUnit' --- --- * 'caaAlignment' --- --- * 'caaExpandedDimension' --- --- * 'caaAdditionalSizes' --- --- * 'caaZipFilename' --- --- * 'caaMediaDuration' --- --- * 'caaActionScript3' --- --- * 'caaDisplayType' --- --- * 'caaChildAssetType' --- --- * 'caaCollapsedSize' --- --- * 'caaId' --- --- * 'caaBitRate' --- --- * 'caaCustomStartTimeValue' --- --- * 'caaStartTimeType' --- --- * 'caaDuration' --- --- * 'caaOrientation' --- --- * 'caaArtworkType' --- --- * 'caaHideFlashObjects' --- --- * 'caaDetectedFeatures' --- --- * 'caaBackupImageExit' --- --- * 'caaPosition' --- --- * 'caaHorizontallyLocked' -creativeAsset - :: CreativeAsset -creativeAsset = - CreativeAsset' - { _caaZIndex = Nothing - , _caaPushdown = Nothing - , _caaOriginalBackup = Nothing - , _caaWindowMode = Nothing - , _caaFlashVersion = Nothing - , _caaPushdownDuration = Nothing - , _caaSize = Nothing - , _caaVerticallyLocked = Nothing - , _caaOffSet = Nothing - , _caaStreamingServingURL = Nothing - , _caaZipFilesize = Nothing - , _caaTransparency = Nothing - , _caaHideSelectionBoxes = Nothing - , _caaSSLCompliant = Nothing - , _caaFileSize = Nothing - , _caaAssetIdentifier = Nothing - , _caaCompanionCreativeIds = Nothing - , _caaDurationType = Nothing - , _caaProgressiveServingURL = Nothing - , _caaIdDimensionValue = Nothing - , _caaActive = Nothing - , _caaRole = Nothing - , _caaMimeType = Nothing - , _caaPositionTopUnit = Nothing - , _caaPositionLeftUnit = Nothing - , _caaAlignment = Nothing - , _caaExpandedDimension = Nothing - , _caaAdditionalSizes = Nothing - , _caaZipFilename = Nothing - , _caaMediaDuration = Nothing - , _caaActionScript3 = Nothing - , _caaDisplayType = Nothing - , _caaChildAssetType = Nothing - , _caaCollapsedSize = Nothing - , _caaId = Nothing - , _caaBitRate = Nothing - , _caaCustomStartTimeValue = Nothing - , _caaStartTimeType = Nothing - , _caaDuration = Nothing - , _caaOrientation = Nothing - , _caaArtworkType = Nothing - , _caaHideFlashObjects = Nothing - , _caaDetectedFeatures = Nothing - , _caaBackupImageExit = Nothing - , _caaPosition = Nothing - , _caaHorizontallyLocked = Nothing - } - --- | zIndex value of an asset. Applicable to the following creative types: --- all RICH_MEDIA.Additionally, only applicable to assets whose displayType --- is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or --- ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to --- 999999999, inclusive. -caaZIndex :: Lens' CreativeAsset (Maybe Int32) -caaZIndex - = lens _caaZIndex (\ s a -> s{_caaZIndex = a}) . - mapping _Coerce - --- | Whether the asset pushes down other content. Applicable to the following --- creative types: all RICH_MEDIA. Additionally, only applicable when the --- asset offsets are 0, the collapsedSize.width matches size.width, and the --- collapsedSize.height is less than size.height. -caaPushdown :: Lens' CreativeAsset (Maybe Bool) -caaPushdown - = lens _caaPushdown (\ s a -> s{_caaPushdown = a}) - --- | Whether the backup asset is original or changed by the user in Campaign --- Manager. Applicable to the following creative types: all RICH_MEDIA. -caaOriginalBackup :: Lens' CreativeAsset (Maybe Bool) -caaOriginalBackup - = lens _caaOriginalBackup - (\ s a -> s{_caaOriginalBackup = a}) - --- | Window mode options for flash assets. Applicable to the following --- creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, --- RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and --- RICH_MEDIA_INPAGE_FLOATING. -caaWindowMode :: Lens' CreativeAsset (Maybe CreativeAssetWindowMode) -caaWindowMode - = lens _caaWindowMode - (\ s a -> s{_caaWindowMode = a}) - --- | Flash version of the asset. This is a read-only field. Applicable to the --- following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. --- Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. -caaFlashVersion :: Lens' CreativeAsset (Maybe Int32) -caaFlashVersion - = lens _caaFlashVersion - (\ s a -> s{_caaFlashVersion = a}) - . mapping _Coerce - --- | Pushdown duration in seconds for an asset. Applicable to the following --- creative types: all RICH_MEDIA.Additionally, only applicable when the --- asset pushdown field is true, the offsets are 0, the collapsedSize.width --- matches size.width, and the collapsedSize.height is less than --- size.height. Acceptable values are 0 to 9.99, inclusive. -caaPushdownDuration :: Lens' CreativeAsset (Maybe Double) -caaPushdownDuration - = lens _caaPushdownDuration - (\ s a -> s{_caaPushdownDuration = a}) - . mapping _Coerce - --- | Size associated with this creative asset. This is a required field when --- applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, --- this field will be automatically set using the actual size of the --- associated image asset. Applicable to the following creative types: --- DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all --- RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not --- HTML_IMAGE. -caaSize :: Lens' CreativeAsset (Maybe Size) -caaSize = lens _caaSize (\ s a -> s{_caaSize = a}) - --- | Whether the asset is vertically locked. This is a read-only field. --- Applicable to the following creative types: all RICH_MEDIA. -caaVerticallyLocked :: Lens' CreativeAsset (Maybe Bool) -caaVerticallyLocked - = lens _caaVerticallyLocked - (\ s a -> s{_caaVerticallyLocked = a}) - --- | Offset position for an asset in collapsed mode. This is a read-only --- field. Applicable to the following creative types: all RICH_MEDIA and --- all VPAID. Additionally, only applicable to assets whose displayType is --- ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN. -caaOffSet :: Lens' CreativeAsset (Maybe OffSetPosition) -caaOffSet - = lens _caaOffSet (\ s a -> s{_caaOffSet = a}) - --- | Streaming URL for video asset. This is a read-only field. Applicable to --- the following creative types: INSTREAM_VIDEO and all VPAID. -caaStreamingServingURL :: Lens' CreativeAsset (Maybe Text) -caaStreamingServingURL - = lens _caaStreamingServingURL - (\ s a -> s{_caaStreamingServingURL = a}) - --- | Size of zip file. This is a read-only field. Applicable to the following --- creative types: HTML5_BANNER. -caaZipFilesize :: Lens' CreativeAsset (Maybe Text) -caaZipFilesize - = lens _caaZipFilesize - (\ s a -> s{_caaZipFilesize = a}) - --- | Whether the asset is transparent. Applicable to the following creative --- types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets. -caaTransparency :: Lens' CreativeAsset (Maybe Bool) -caaTransparency - = lens _caaTransparency - (\ s a -> s{_caaTransparency = a}) - --- | Whether to hide selection boxes flag for an asset. Applicable to the --- following creative types: all RICH_MEDIA. -caaHideSelectionBoxes :: Lens' CreativeAsset (Maybe Bool) -caaHideSelectionBoxes - = lens _caaHideSelectionBoxes - (\ s a -> s{_caaHideSelectionBoxes = a}) - --- | Whether the asset is SSL-compliant. This is a read-only field. --- Applicable to all but the following creative types: all REDIRECT and --- TRACKING_TEXT. -caaSSLCompliant :: Lens' CreativeAsset (Maybe Bool) -caaSSLCompliant - = lens _caaSSLCompliant - (\ s a -> s{_caaSSLCompliant = a}) - --- | File size associated with this creative asset. This is a read-only --- field. Applicable to all but the following creative types: all REDIRECT --- and TRACKING_TEXT. -caaFileSize :: Lens' CreativeAsset (Maybe Int64) -caaFileSize - = lens _caaFileSize (\ s a -> s{_caaFileSize = a}) . - mapping _Coerce - --- | Identifier of this asset. This is the same identifier returned during --- creative asset insert operation. This is a required field. Applicable to --- all but the following creative types: all REDIRECT and TRACKING_TEXT. -caaAssetIdentifier :: Lens' CreativeAsset (Maybe CreativeAssetId) -caaAssetIdentifier - = lens _caaAssetIdentifier - (\ s a -> s{_caaAssetIdentifier = a}) - --- | List of companion creatives assigned to an in-stream video creative --- asset. Acceptable values include IDs of existing flash and image --- creatives. Applicable to INSTREAM_VIDEO creative type with --- dynamicAssetSelection set to true. -caaCompanionCreativeIds :: Lens' CreativeAsset [Int64] -caaCompanionCreativeIds - = lens _caaCompanionCreativeIds - (\ s a -> s{_caaCompanionCreativeIds = a}) - . _Default - . _Coerce - --- | Duration type for which an asset will be displayed. Applicable to the --- following creative types: all RICH_MEDIA. -caaDurationType :: Lens' CreativeAsset (Maybe CreativeAssetDurationType) -caaDurationType - = lens _caaDurationType - (\ s a -> s{_caaDurationType = a}) - --- | Progressive URL for video asset. This is a read-only field. Applicable --- to the following creative types: INSTREAM_VIDEO and all VPAID. -caaProgressiveServingURL :: Lens' CreativeAsset (Maybe Text) -caaProgressiveServingURL - = lens _caaProgressiveServingURL - (\ s a -> s{_caaProgressiveServingURL = a}) - --- | Dimension value for the ID of the asset. This is a read-only, --- auto-generated field. -caaIdDimensionValue :: Lens' CreativeAsset (Maybe DimensionValue) -caaIdDimensionValue - = lens _caaIdDimensionValue - (\ s a -> s{_caaIdDimensionValue = a}) - --- | Whether the video or audio asset is active. This is a read-only field --- for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative --- types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. -caaActive :: Lens' CreativeAsset (Maybe Bool) -caaActive - = lens _caaActive (\ s a -> s{_caaActive = a}) - --- | Role of the asset in relation to creative. Applicable to all but the --- following creative types: all REDIRECT and TRACKING_TEXT. This is a --- required field. PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, --- IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple --- primary assets), and all VPAID creatives. BACKUP_IMAGE applies to --- FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. --- Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. --- ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. --- OTHER refers to assets from sources other than Campaign Manager, such as --- Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID --- creatives. PARENT_VIDEO refers to videos uploaded by the user in --- Campaign Manager and is applicable to INSTREAM_VIDEO and --- VPAID_LINEAR_VIDEO creatives. TRANSCODED_VIDEO refers to videos --- transcoded by Campaign Manager from PARENT_VIDEO assets and is --- applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. --- ALTERNATE_VIDEO refers to the Campaign Manager representation of child --- asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO --- creatives. These cannot be added or removed within Campaign Manager. For --- VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and --- ALTERNATE_VIDEO assets that are marked active serve as backup in case --- the VPAID creative cannot be served. Only PARENT_VIDEO assets can be --- added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative. --- PARENT_AUDIO refers to audios uploaded by the user in Campaign Manager --- and is applicable to INSTREAM_AUDIO creatives. TRANSCODED_AUDIO refers --- to audios transcoded by Campaign Manager from PARENT_AUDIO assets and is --- applicable to INSTREAM_AUDIO creatives. -caaRole :: Lens' CreativeAsset (Maybe CreativeAssetRole) -caaRole = lens _caaRole (\ s a -> s{_caaRole = a}) - --- | Detected MIME type for audio or video asset. This is a read-only field. --- Applicable to the following creative types: INSTREAM_AUDIO, --- INSTREAM_VIDEO and all VPAID. -caaMimeType :: Lens' CreativeAsset (Maybe Text) -caaMimeType - = lens _caaMimeType (\ s a -> s{_caaMimeType = a}) - --- | Offset top unit for an asset. This is a read-only field if the asset --- displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following --- creative types: all RICH_MEDIA. -caaPositionTopUnit :: Lens' CreativeAsset (Maybe CreativeAssetPositionTopUnit) -caaPositionTopUnit - = lens _caaPositionTopUnit - (\ s a -> s{_caaPositionTopUnit = a}) - --- | Offset left unit for an asset. This is a read-only field. Applicable to --- the following creative types: all RICH_MEDIA. -caaPositionLeftUnit :: Lens' CreativeAsset (Maybe CreativeAssetPositionLeftUnit) -caaPositionLeftUnit - = lens _caaPositionLeftUnit - (\ s a -> s{_caaPositionLeftUnit = a}) - --- | Possible alignments for an asset. This is a read-only field. Applicable --- to the following creative types: --- RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL. -caaAlignment :: Lens' CreativeAsset (Maybe CreativeAssetAlignment) -caaAlignment - = lens _caaAlignment (\ s a -> s{_caaAlignment = a}) - --- | Detected expanded dimension for video asset. This is a read-only field. --- Applicable to the following creative types: INSTREAM_VIDEO and all --- VPAID. -caaExpandedDimension :: Lens' CreativeAsset (Maybe Size) -caaExpandedDimension - = lens _caaExpandedDimension - (\ s a -> s{_caaExpandedDimension = a}) - --- | Additional sizes associated with this creative asset. HTML5 asset --- generated by compatible software such as GWD will be able to support --- more sizes this creative asset can render. -caaAdditionalSizes :: Lens' CreativeAsset [Size] -caaAdditionalSizes - = lens _caaAdditionalSizes - (\ s a -> s{_caaAdditionalSizes = a}) - . _Default - . _Coerce - --- | File name of zip file. This is a read-only field. Applicable to the --- following creative types: HTML5_BANNER. -caaZipFilename :: Lens' CreativeAsset (Maybe Text) -caaZipFilename - = lens _caaZipFilename - (\ s a -> s{_caaZipFilename = a}) - --- | Detected duration for audio or video asset. This is a read-only field. --- Applicable to the following creative types: INSTREAM_AUDIO, --- INSTREAM_VIDEO and all VPAID. -caaMediaDuration :: Lens' CreativeAsset (Maybe Double) -caaMediaDuration - = lens _caaMediaDuration - (\ s a -> s{_caaMediaDuration = a}) - . mapping _Coerce - --- | Whether ActionScript3 is enabled for the flash asset. This is a --- read-only field. Applicable to the following creative type: --- FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not --- HTML_IMAGE. -caaActionScript3 :: Lens' CreativeAsset (Maybe Bool) -caaActionScript3 - = lens _caaActionScript3 - (\ s a -> s{_caaActionScript3 = a}) - --- | Type of rich media asset. This is a read-only field. Applicable to the --- following creative types: all RICH_MEDIA. -caaDisplayType :: Lens' CreativeAsset (Maybe CreativeAssetDisplayType) -caaDisplayType - = lens _caaDisplayType - (\ s a -> s{_caaDisplayType = a}) - --- | Rich media child asset type. This is a read-only field. Applicable to --- the following creative types: all VPAID. -caaChildAssetType :: Lens' CreativeAsset (Maybe CreativeAssetChildAssetType) -caaChildAssetType - = lens _caaChildAssetType - (\ s a -> s{_caaChildAssetType = a}) - --- | Size of an asset when collapsed. This is a read-only field. Applicable --- to the following creative types: all RICH_MEDIA and all VPAID. --- Additionally, applicable to assets whose displayType is --- ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN. -caaCollapsedSize :: Lens' CreativeAsset (Maybe Size) -caaCollapsedSize - = lens _caaCollapsedSize - (\ s a -> s{_caaCollapsedSize = a}) - --- | Numeric ID of this creative asset. This is a required field and should --- not be modified. Applicable to all but the following creative types: all --- REDIRECT and TRACKING_TEXT. -caaId :: Lens' CreativeAsset (Maybe Int64) -caaId - = lens _caaId (\ s a -> s{_caaId = a}) . - mapping _Coerce - --- | Detected bit-rate for audio or video asset. This is a read-only field. --- Applicable to the following creative types: INSTREAM_AUDIO, --- INSTREAM_VIDEO and all VPAID. -caaBitRate :: Lens' CreativeAsset (Maybe Int32) -caaBitRate - = lens _caaBitRate (\ s a -> s{_caaBitRate = a}) . - mapping _Coerce - --- | Custom start time in seconds for making the asset visible. Applicable to --- the following creative types: all RICH_MEDIA. Value must be greater than --- or equal to 0. -caaCustomStartTimeValue :: Lens' CreativeAsset (Maybe Int32) -caaCustomStartTimeValue - = lens _caaCustomStartTimeValue - (\ s a -> s{_caaCustomStartTimeValue = a}) - . mapping _Coerce - --- | Initial wait time type before making the asset visible. Applicable to --- the following creative types: all RICH_MEDIA. -caaStartTimeType :: Lens' CreativeAsset (Maybe CreativeAssetStartTimeType) -caaStartTimeType - = lens _caaStartTimeType - (\ s a -> s{_caaStartTimeType = a}) - --- | Duration in seconds for which an asset will be displayed. Applicable to --- the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and --- VPAID_LINEAR_VIDEO. Value must be greater than or equal to 1. -caaDuration :: Lens' CreativeAsset (Maybe Int32) -caaDuration - = lens _caaDuration (\ s a -> s{_caaDuration = a}) . - mapping _Coerce - --- | Orientation of video asset. This is a read-only, auto-generated field. -caaOrientation :: Lens' CreativeAsset (Maybe CreativeAssetOrientation) -caaOrientation - = lens _caaOrientation - (\ s a -> s{_caaOrientation = a}) - --- | Artwork type of rich media creative. This is a read-only field. --- Applicable to the following creative types: all RICH_MEDIA. -caaArtworkType :: Lens' CreativeAsset (Maybe CreativeAssetArtworkType) -caaArtworkType - = lens _caaArtworkType - (\ s a -> s{_caaArtworkType = a}) - --- | Whether to hide Flash objects flag for an asset. Applicable to the --- following creative types: all RICH_MEDIA. -caaHideFlashObjects :: Lens' CreativeAsset (Maybe Bool) -caaHideFlashObjects - = lens _caaHideFlashObjects - (\ s a -> s{_caaHideFlashObjects = a}) - --- | List of feature dependencies for the creative asset that are detected by --- Campaign Manager. Feature dependencies are features that a browser must --- be able to support in order to render your HTML5 creative correctly. --- This is a read-only, auto-generated field. Applicable to the following --- creative types: HTML5_BANNER. Applicable to DISPLAY when the primary --- asset type is not HTML_IMAGE. -caaDetectedFeatures :: Lens' CreativeAsset [CreativeAssetDetectedFeaturesItem] -caaDetectedFeatures - = lens _caaDetectedFeatures - (\ s a -> s{_caaDetectedFeatures = a}) - . _Default - . _Coerce - --- | Exit event configured for the backup image. Applicable to the following --- creative types: all RICH_MEDIA. -caaBackupImageExit :: Lens' CreativeAsset (Maybe CreativeCustomEvent) -caaBackupImageExit - = lens _caaBackupImageExit - (\ s a -> s{_caaBackupImageExit = a}) - --- | Offset position for an asset. Applicable to the following creative --- types: all RICH_MEDIA. -caaPosition :: Lens' CreativeAsset (Maybe OffSetPosition) -caaPosition - = lens _caaPosition (\ s a -> s{_caaPosition = a}) - --- | Whether the asset is horizontally locked. This is a read-only field. --- Applicable to the following creative types: all RICH_MEDIA. -caaHorizontallyLocked :: Lens' CreativeAsset (Maybe Bool) -caaHorizontallyLocked - = lens _caaHorizontallyLocked - (\ s a -> s{_caaHorizontallyLocked = a}) - -instance FromJSON CreativeAsset where - parseJSON - = withObject "CreativeAsset" - (\ o -> - CreativeAsset' <$> - (o .:? "zIndex") <*> (o .:? "pushdown") <*> - (o .:? "originalBackup") - <*> (o .:? "windowMode") - <*> (o .:? "flashVersion") - <*> (o .:? "pushdownDuration") - <*> (o .:? "size") - <*> (o .:? "verticallyLocked") - <*> (o .:? "offset") - <*> (o .:? "streamingServingUrl") - <*> (o .:? "zipFilesize") - <*> (o .:? "transparency") - <*> (o .:? "hideSelectionBoxes") - <*> (o .:? "sslCompliant") - <*> (o .:? "fileSize") - <*> (o .:? "assetIdentifier") - <*> (o .:? "companionCreativeIds" .!= mempty) - <*> (o .:? "durationType") - <*> (o .:? "progressiveServingUrl") - <*> (o .:? "idDimensionValue") - <*> (o .:? "active") - <*> (o .:? "role") - <*> (o .:? "mimeType") - <*> (o .:? "positionTopUnit") - <*> (o .:? "positionLeftUnit") - <*> (o .:? "alignment") - <*> (o .:? "expandedDimension") - <*> (o .:? "additionalSizes" .!= mempty) - <*> (o .:? "zipFilename") - <*> (o .:? "mediaDuration") - <*> (o .:? "actionScript3") - <*> (o .:? "displayType") - <*> (o .:? "childAssetType") - <*> (o .:? "collapsedSize") - <*> (o .:? "id") - <*> (o .:? "bitRate") - <*> (o .:? "customStartTimeValue") - <*> (o .:? "startTimeType") - <*> (o .:? "duration") - <*> (o .:? "orientation") - <*> (o .:? "artworkType") - <*> (o .:? "hideFlashObjects") - <*> (o .:? "detectedFeatures" .!= mempty) - <*> (o .:? "backupImageExit") - <*> (o .:? "position") - <*> (o .:? "horizontallyLocked")) - -instance ToJSON CreativeAsset where - toJSON CreativeAsset'{..} - = object - (catMaybes - [("zIndex" .=) <$> _caaZIndex, - ("pushdown" .=) <$> _caaPushdown, - ("originalBackup" .=) <$> _caaOriginalBackup, - ("windowMode" .=) <$> _caaWindowMode, - ("flashVersion" .=) <$> _caaFlashVersion, - ("pushdownDuration" .=) <$> _caaPushdownDuration, - ("size" .=) <$> _caaSize, - ("verticallyLocked" .=) <$> _caaVerticallyLocked, - ("offset" .=) <$> _caaOffSet, - ("streamingServingUrl" .=) <$> - _caaStreamingServingURL, - ("zipFilesize" .=) <$> _caaZipFilesize, - ("transparency" .=) <$> _caaTransparency, - ("hideSelectionBoxes" .=) <$> _caaHideSelectionBoxes, - ("sslCompliant" .=) <$> _caaSSLCompliant, - ("fileSize" .=) <$> _caaFileSize, - ("assetIdentifier" .=) <$> _caaAssetIdentifier, - ("companionCreativeIds" .=) <$> - _caaCompanionCreativeIds, - ("durationType" .=) <$> _caaDurationType, - ("progressiveServingUrl" .=) <$> - _caaProgressiveServingURL, - ("idDimensionValue" .=) <$> _caaIdDimensionValue, - ("active" .=) <$> _caaActive, - ("role" .=) <$> _caaRole, - ("mimeType" .=) <$> _caaMimeType, - ("positionTopUnit" .=) <$> _caaPositionTopUnit, - ("positionLeftUnit" .=) <$> _caaPositionLeftUnit, - ("alignment" .=) <$> _caaAlignment, - ("expandedDimension" .=) <$> _caaExpandedDimension, - ("additionalSizes" .=) <$> _caaAdditionalSizes, - ("zipFilename" .=) <$> _caaZipFilename, - ("mediaDuration" .=) <$> _caaMediaDuration, - ("actionScript3" .=) <$> _caaActionScript3, - ("displayType" .=) <$> _caaDisplayType, - ("childAssetType" .=) <$> _caaChildAssetType, - ("collapsedSize" .=) <$> _caaCollapsedSize, - ("id" .=) <$> _caaId, ("bitRate" .=) <$> _caaBitRate, - ("customStartTimeValue" .=) <$> - _caaCustomStartTimeValue, - ("startTimeType" .=) <$> _caaStartTimeType, - ("duration" .=) <$> _caaDuration, - ("orientation" .=) <$> _caaOrientation, - ("artworkType" .=) <$> _caaArtworkType, - ("hideFlashObjects" .=) <$> _caaHideFlashObjects, - ("detectedFeatures" .=) <$> _caaDetectedFeatures, - ("backupImageExit" .=) <$> _caaBackupImageExit, - ("position" .=) <$> _caaPosition, - ("horizontallyLocked" .=) <$> - _caaHorizontallyLocked]) - --- | Language Targeting. --- --- /See:/ 'languageTargeting' smart constructor. -newtype LanguageTargeting = LanguageTargeting' - { _ltLanguages :: Maybe [Language] - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'LanguageTargeting' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'ltLanguages' -languageTargeting - :: LanguageTargeting -languageTargeting = - LanguageTargeting' - { _ltLanguages = Nothing - } - --- | Languages that this ad targets. For each language only languageId is --- required. The other fields are populated automatically when the ad is --- inserted or updated. -ltLanguages :: Lens' LanguageTargeting [Language] -ltLanguages - = lens _ltLanguages (\ s a -> s{_ltLanguages = a}) . - _Default - . _Coerce - -instance FromJSON LanguageTargeting where - parseJSON - = withObject "LanguageTargeting" - (\ o -> - LanguageTargeting' <$> - (o .:? "languages" .!= mempty)) - -instance ToJSON LanguageTargeting where - toJSON LanguageTargeting'{..} - = object - (catMaybes [("languages" .=) <$> _ltLanguages]) - --- | Encapsulates the list of rules for asset selection and a default asset --- in case none of the rules match. Applicable to INSTREAM_VIDEO creatives. --- --- /See:/ 'creativeAssetSelection' smart constructor. -data CreativeAssetSelection = CreativeAssetSelection' - { _casRules :: !(Maybe [Rule]) - , _casDefaultAssetId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'CreativeAssetSelection' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'casRules' --- --- * 'casDefaultAssetId' -creativeAssetSelection - :: CreativeAssetSelection -creativeAssetSelection = - CreativeAssetSelection' - { _casRules = Nothing - , _casDefaultAssetId = Nothing - } - --- | Rules determine which asset will be served to a viewer. Rules will be --- evaluated in the order in which they are stored in this list. This list --- must contain at least one rule. Applicable to INSTREAM_VIDEO creatives. -casRules :: Lens' CreativeAssetSelection [Rule] -casRules - = lens _casRules (\ s a -> s{_casRules = a}) . - _Default - . _Coerce - --- | A creativeAssets[].id. This should refer to one of the parent assets in --- this creative, and will be served if none of the rules match. This is a --- required field. -casDefaultAssetId :: Lens' CreativeAssetSelection (Maybe Int64) -casDefaultAssetId - = lens _casDefaultAssetId - (\ s a -> s{_casDefaultAssetId = a}) - . mapping _Coerce - -instance FromJSON CreativeAssetSelection where - parseJSON - = withObject "CreativeAssetSelection" - (\ o -> - CreativeAssetSelection' <$> - (o .:? "rules" .!= mempty) <*> - (o .:? "defaultAssetId")) - -instance ToJSON CreativeAssetSelection where - toJSON CreativeAssetSelection'{..} - = object - (catMaybes - [("rules" .=) <$> _casRules, - ("defaultAssetId" .=) <$> _casDefaultAssetId]) - --- | Placement List Response --- --- /See:/ 'placementsListResponse' smart constructor. -data PlacementsListResponse = PlacementsListResponse' - { _plaNextPageToken :: !(Maybe Text) - , _plaKind :: !Text - , _plaPlacements :: !(Maybe [Placement]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'PlacementsListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'plaNextPageToken' --- --- * 'plaKind' --- --- * 'plaPlacements' -placementsListResponse - :: PlacementsListResponse -placementsListResponse = - PlacementsListResponse' - { _plaNextPageToken = Nothing - , _plaKind = "dfareporting#placementsListResponse" - , _plaPlacements = Nothing - } - --- | Pagination token to be used for the next list operation. -plaNextPageToken :: Lens' PlacementsListResponse (Maybe Text) -plaNextPageToken - = lens _plaNextPageToken - (\ s a -> s{_plaNextPageToken = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#placementsListResponse\". -plaKind :: Lens' PlacementsListResponse Text -plaKind = lens _plaKind (\ s a -> s{_plaKind = a}) - --- | Placement collection. -plaPlacements :: Lens' PlacementsListResponse [Placement] -plaPlacements - = lens _plaPlacements - (\ s a -> s{_plaPlacements = a}) - . _Default - . _Coerce - -instance FromJSON PlacementsListResponse where - parseJSON - = withObject "PlacementsListResponse" - (\ o -> - PlacementsListResponse' <$> - (o .:? "nextPageToken") <*> - (o .:? "kind" .!= - "dfareporting#placementsListResponse") - <*> (o .:? "placements" .!= mempty)) - -instance ToJSON PlacementsListResponse where - toJSON PlacementsListResponse'{..} - = object - (catMaybes - [("nextPageToken" .=) <$> _plaNextPageToken, - Just ("kind" .= _plaKind), - ("placements" .=) <$> _plaPlacements]) - --- | The report\'s schedule. Can only be set if the report\'s \'dateRange\' --- is a relative date range and the relative date range is not \"TODAY\". --- --- /See:/ 'reportSchedule' smart constructor. -data ReportSchedule = ReportSchedule' - { _rsEvery :: !(Maybe (Textual Int32)) - , _rsActive :: !(Maybe Bool) - , _rsRepeats :: !(Maybe Text) - , _rsStartDate :: !(Maybe Date') - , _rsExpirationDate :: !(Maybe Date') - , _rsRunsOnDayOfMonth :: !(Maybe ReportScheduleRunsOnDayOfMonth) - , _rsRepeatsOnWeekDays :: !(Maybe [ReportScheduleRepeatsOnWeekDaysItem]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'ReportSchedule' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'rsEvery' --- --- * 'rsActive' --- --- * 'rsRepeats' --- --- * 'rsStartDate' --- --- * 'rsExpirationDate' --- --- * 'rsRunsOnDayOfMonth' --- --- * 'rsRepeatsOnWeekDays' -reportSchedule - :: ReportSchedule -reportSchedule = - ReportSchedule' - { _rsEvery = Nothing - , _rsActive = Nothing - , _rsRepeats = Nothing - , _rsStartDate = Nothing - , _rsExpirationDate = Nothing - , _rsRunsOnDayOfMonth = Nothing - , _rsRepeatsOnWeekDays = Nothing - } - --- | Defines every how many days, weeks or months the report should be run. --- Needs to be set when \"repeats\" is either \"DAILY\", \"WEEKLY\" or --- \"MONTHLY\". -rsEvery :: Lens' ReportSchedule (Maybe Int32) -rsEvery - = lens _rsEvery (\ s a -> s{_rsEvery = a}) . - mapping _Coerce - --- | Whether the schedule is active or not. Must be set to either true or --- false. -rsActive :: Lens' ReportSchedule (Maybe Bool) -rsActive = lens _rsActive (\ s a -> s{_rsActive = a}) - --- | The interval for which the report is repeated. Note: - \"DAILY\" also --- requires field \"every\" to be set. - \"WEEKLY\" also requires fields --- \"every\" and \"repeatsOnWeekDays\" to be set. - \"MONTHLY\" also --- requires fields \"every\" and \"runsOnDayOfMonth\" to be set. -rsRepeats :: Lens' ReportSchedule (Maybe Text) -rsRepeats - = lens _rsRepeats (\ s a -> s{_rsRepeats = a}) - --- | Start date of date range for which scheduled reports should be run. -rsStartDate :: Lens' ReportSchedule (Maybe Day) -rsStartDate - = lens _rsStartDate (\ s a -> s{_rsStartDate = a}) . - mapping _Date - --- | The expiration date when the scheduled report stops running. -rsExpirationDate :: Lens' ReportSchedule (Maybe Day) -rsExpirationDate - = lens _rsExpirationDate - (\ s a -> s{_rsExpirationDate = a}) - . mapping _Date - --- | Enum to define for \"MONTHLY\" scheduled reports whether reports should --- be repeated on the same day of the month as \"startDate\" or the same --- day of the week of the month. Example: If \'startDate\' is Monday, April --- 2nd 2012 (2012-04-02), \"DAY_OF_MONTH\" would run subsequent reports on --- the 2nd of every Month, and \"WEEK_OF_MONTH\" would run subsequent --- reports on the first Monday of the month. -rsRunsOnDayOfMonth :: Lens' ReportSchedule (Maybe ReportScheduleRunsOnDayOfMonth) -rsRunsOnDayOfMonth - = lens _rsRunsOnDayOfMonth - (\ s a -> s{_rsRunsOnDayOfMonth = a}) - --- | List of week days \"WEEKLY\" on which scheduled reports should run. -rsRepeatsOnWeekDays :: Lens' ReportSchedule [ReportScheduleRepeatsOnWeekDaysItem] -rsRepeatsOnWeekDays - = lens _rsRepeatsOnWeekDays - (\ s a -> s{_rsRepeatsOnWeekDays = a}) - . _Default - . _Coerce - -instance FromJSON ReportSchedule where - parseJSON - = withObject "ReportSchedule" - (\ o -> - ReportSchedule' <$> - (o .:? "every") <*> (o .:? "active") <*> - (o .:? "repeats") - <*> (o .:? "startDate") - <*> (o .:? "expirationDate") - <*> (o .:? "runsOnDayOfMonth") - <*> (o .:? "repeatsOnWeekDays" .!= mempty)) - -instance ToJSON ReportSchedule where - toJSON ReportSchedule'{..} - = object - (catMaybes - [("every" .=) <$> _rsEvery, - ("active" .=) <$> _rsActive, - ("repeats" .=) <$> _rsRepeats, - ("startDate" .=) <$> _rsStartDate, - ("expirationDate" .=) <$> _rsExpirationDate, - ("runsOnDayOfMonth" .=) <$> _rsRunsOnDayOfMonth, - ("repeatsOnWeekDays" .=) <$> _rsRepeatsOnWeekDays]) - --- | The report criteria for a report of type \"PATH_TO_CONVERSION\". --- --- /See:/ 'reportPathToConversionCriteria' smart constructor. -data ReportPathToConversionCriteria = ReportPathToConversionCriteria' - { _rptccReportProperties :: !(Maybe ReportPathToConversionCriteriaReportProperties) - , _rptccMetricNames :: !(Maybe [Text]) - , _rptccCustomRichMediaEvents :: !(Maybe [DimensionValue]) - , _rptccDateRange :: !(Maybe DateRange) - , _rptccConversionDimensions :: !(Maybe [SortedDimension]) - , _rptccCustomFloodlightVariables :: !(Maybe [SortedDimension]) - , _rptccFloodlightConfigId :: !(Maybe DimensionValue) - , _rptccActivityFilters :: !(Maybe [DimensionValue]) - , _rptccPerInteractionDimensions :: !(Maybe [SortedDimension]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'ReportPathToConversionCriteria' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'rptccReportProperties' --- --- * 'rptccMetricNames' --- --- * 'rptccCustomRichMediaEvents' --- --- * 'rptccDateRange' --- --- * 'rptccConversionDimensions' --- --- * 'rptccCustomFloodlightVariables' --- --- * 'rptccFloodlightConfigId' --- --- * 'rptccActivityFilters' --- --- * 'rptccPerInteractionDimensions' -reportPathToConversionCriteria - :: ReportPathToConversionCriteria -reportPathToConversionCriteria = - ReportPathToConversionCriteria' - { _rptccReportProperties = Nothing - , _rptccMetricNames = Nothing - , _rptccCustomRichMediaEvents = Nothing - , _rptccDateRange = Nothing - , _rptccConversionDimensions = Nothing - , _rptccCustomFloodlightVariables = Nothing - , _rptccFloodlightConfigId = Nothing - , _rptccActivityFilters = Nothing - , _rptccPerInteractionDimensions = Nothing - } - --- | The properties of the report. -rptccReportProperties :: Lens' ReportPathToConversionCriteria (Maybe ReportPathToConversionCriteriaReportProperties) -rptccReportProperties - = lens _rptccReportProperties - (\ s a -> s{_rptccReportProperties = a}) - --- | The list of names of metrics the report should include. -rptccMetricNames :: Lens' ReportPathToConversionCriteria [Text] -rptccMetricNames - = lens _rptccMetricNames - (\ s a -> s{_rptccMetricNames = a}) - . _Default - . _Coerce - --- | The list of custom rich media events to include. -rptccCustomRichMediaEvents :: Lens' ReportPathToConversionCriteria [DimensionValue] -rptccCustomRichMediaEvents - = lens _rptccCustomRichMediaEvents - (\ s a -> s{_rptccCustomRichMediaEvents = a}) - . _Default - . _Coerce - --- | The date range this report should be run for. -rptccDateRange :: Lens' ReportPathToConversionCriteria (Maybe DateRange) -rptccDateRange - = lens _rptccDateRange - (\ s a -> s{_rptccDateRange = a}) - --- | The list of conversion dimensions the report should include. -rptccConversionDimensions :: Lens' ReportPathToConversionCriteria [SortedDimension] -rptccConversionDimensions - = lens _rptccConversionDimensions - (\ s a -> s{_rptccConversionDimensions = a}) - . _Default - . _Coerce - --- | The list of custom floodlight variables the report should include. -rptccCustomFloodlightVariables :: Lens' ReportPathToConversionCriteria [SortedDimension] -rptccCustomFloodlightVariables - = lens _rptccCustomFloodlightVariables - (\ s a -> s{_rptccCustomFloodlightVariables = a}) - . _Default - . _Coerce - --- | The floodlight ID for which to show data in this report. All advertisers --- associated with that ID will automatically be added. The dimension of --- the value needs to be \'dfa:floodlightConfigId\'. -rptccFloodlightConfigId :: Lens' ReportPathToConversionCriteria (Maybe DimensionValue) -rptccFloodlightConfigId - = lens _rptccFloodlightConfigId - (\ s a -> s{_rptccFloodlightConfigId = a}) - --- | The list of \'dfa:activity\' values to filter on. -rptccActivityFilters :: Lens' ReportPathToConversionCriteria [DimensionValue] -rptccActivityFilters - = lens _rptccActivityFilters - (\ s a -> s{_rptccActivityFilters = a}) - . _Default - . _Coerce - --- | The list of per interaction dimensions the report should include. -rptccPerInteractionDimensions :: Lens' ReportPathToConversionCriteria [SortedDimension] -rptccPerInteractionDimensions - = lens _rptccPerInteractionDimensions - (\ s a -> s{_rptccPerInteractionDimensions = a}) - . _Default - . _Coerce - -instance FromJSON ReportPathToConversionCriteria - where - parseJSON - = withObject "ReportPathToConversionCriteria" - (\ o -> - ReportPathToConversionCriteria' <$> - (o .:? "reportProperties") <*> - (o .:? "metricNames" .!= mempty) - <*> (o .:? "customRichMediaEvents" .!= mempty) - <*> (o .:? "dateRange") - <*> (o .:? "conversionDimensions" .!= mempty) - <*> (o .:? "customFloodlightVariables" .!= mempty) - <*> (o .:? "floodlightConfigId") - <*> (o .:? "activityFilters" .!= mempty) - <*> (o .:? "perInteractionDimensions" .!= mempty)) - -instance ToJSON ReportPathToConversionCriteria where - toJSON ReportPathToConversionCriteria'{..} - = object - (catMaybes - [("reportProperties" .=) <$> _rptccReportProperties, - ("metricNames" .=) <$> _rptccMetricNames, - ("customRichMediaEvents" .=) <$> - _rptccCustomRichMediaEvents, - ("dateRange" .=) <$> _rptccDateRange, - ("conversionDimensions" .=) <$> - _rptccConversionDimensions, - ("customFloodlightVariables" .=) <$> - _rptccCustomFloodlightVariables, - ("floodlightConfigId" .=) <$> - _rptccFloodlightConfigId, - ("activityFilters" .=) <$> _rptccActivityFilters, - ("perInteractionDimensions" .=) <$> - _rptccPerInteractionDimensions]) - --- | Metro List Response --- --- /See:/ 'metrosListResponse' smart constructor. -data MetrosListResponse = MetrosListResponse' - { _mlrKind :: !Text - , _mlrMetros :: !(Maybe [Metro]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'MetrosListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'mlrKind' --- --- * 'mlrMetros' -metrosListResponse - :: MetrosListResponse -metrosListResponse = - MetrosListResponse' - { _mlrKind = "dfareporting#metrosListResponse" - , _mlrMetros = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#metrosListResponse\". -mlrKind :: Lens' MetrosListResponse Text -mlrKind = lens _mlrKind (\ s a -> s{_mlrKind = a}) - --- | Metro collection. -mlrMetros :: Lens' MetrosListResponse [Metro] -mlrMetros - = lens _mlrMetros (\ s a -> s{_mlrMetros = a}) . - _Default - . _Coerce - -instance FromJSON MetrosListResponse where - parseJSON - = withObject "MetrosListResponse" - (\ o -> - MetrosListResponse' <$> - (o .:? "kind" .!= "dfareporting#metrosListResponse") - <*> (o .:? "metros" .!= mempty)) - -instance ToJSON MetrosListResponse where - toJSON MetrosListResponse'{..} - = object - (catMaybes - [Just ("kind" .= _mlrKind), - ("metros" .=) <$> _mlrMetros]) - --- | Insert Conversions Response. --- --- /See:/ 'conversionsBatchInsertResponse' smart constructor. -data ConversionsBatchInsertResponse = ConversionsBatchInsertResponse' - { _cbirbStatus :: !(Maybe [ConversionStatus]) - , _cbirbKind :: !Text - , _cbirbHasFailures :: !(Maybe Bool) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'ConversionsBatchInsertResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'cbirbStatus' --- --- * 'cbirbKind' --- --- * 'cbirbHasFailures' -conversionsBatchInsertResponse - :: ConversionsBatchInsertResponse -conversionsBatchInsertResponse = - ConversionsBatchInsertResponse' - { _cbirbStatus = Nothing - , _cbirbKind = "dfareporting#conversionsBatchInsertResponse" - , _cbirbHasFailures = Nothing - } - --- | The insert status of each conversion. Statuses are returned in the same --- order that conversions are inserted. -cbirbStatus :: Lens' ConversionsBatchInsertResponse [ConversionStatus] -cbirbStatus - = lens _cbirbStatus (\ s a -> s{_cbirbStatus = a}) . - _Default - . _Coerce - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#conversionsBatchInsertResponse\". -cbirbKind :: Lens' ConversionsBatchInsertResponse Text -cbirbKind - = lens _cbirbKind (\ s a -> s{_cbirbKind = a}) - --- | Indicates that some or all conversions failed to insert. -cbirbHasFailures :: Lens' ConversionsBatchInsertResponse (Maybe Bool) -cbirbHasFailures - = lens _cbirbHasFailures - (\ s a -> s{_cbirbHasFailures = a}) - -instance FromJSON ConversionsBatchInsertResponse - where - parseJSON - = withObject "ConversionsBatchInsertResponse" - (\ o -> - ConversionsBatchInsertResponse' <$> - (o .:? "status" .!= mempty) <*> - (o .:? "kind" .!= - "dfareporting#conversionsBatchInsertResponse") - <*> (o .:? "hasFailures")) - -instance ToJSON ConversionsBatchInsertResponse where - toJSON ConversionsBatchInsertResponse'{..} - = object - (catMaybes - [("status" .=) <$> _cbirbStatus, - Just ("kind" .= _cbirbKind), - ("hasFailures" .=) <$> _cbirbHasFailures]) - --- | Order document List Response --- --- /See:/ 'orderDocumentsListResponse' smart constructor. -data OrderDocumentsListResponse = OrderDocumentsListResponse' - { _odlrNextPageToken :: !(Maybe Text) - , _odlrKind :: !Text - , _odlrOrderDocuments :: !(Maybe [OrderDocument]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'OrderDocumentsListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'odlrNextPageToken' --- --- * 'odlrKind' --- --- * 'odlrOrderDocuments' -orderDocumentsListResponse - :: OrderDocumentsListResponse -orderDocumentsListResponse = - OrderDocumentsListResponse' - { _odlrNextPageToken = Nothing - , _odlrKind = "dfareporting#orderDocumentsListResponse" - , _odlrOrderDocuments = Nothing - } - --- | Pagination token to be used for the next list operation. -odlrNextPageToken :: Lens' OrderDocumentsListResponse (Maybe Text) -odlrNextPageToken - = lens _odlrNextPageToken - (\ s a -> s{_odlrNextPageToken = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#orderDocumentsListResponse\". -odlrKind :: Lens' OrderDocumentsListResponse Text -odlrKind = lens _odlrKind (\ s a -> s{_odlrKind = a}) - --- | Order document collection -odlrOrderDocuments :: Lens' OrderDocumentsListResponse [OrderDocument] -odlrOrderDocuments - = lens _odlrOrderDocuments - (\ s a -> s{_odlrOrderDocuments = a}) - . _Default - . _Coerce - -instance FromJSON OrderDocumentsListResponse where - parseJSON - = withObject "OrderDocumentsListResponse" - (\ o -> - OrderDocumentsListResponse' <$> - (o .:? "nextPageToken") <*> - (o .:? "kind" .!= - "dfareporting#orderDocumentsListResponse") - <*> (o .:? "orderDocuments" .!= mempty)) - -instance ToJSON OrderDocumentsListResponse where - toJSON OrderDocumentsListResponse'{..} - = object - (catMaybes - [("nextPageToken" .=) <$> _odlrNextPageToken, - Just ("kind" .= _odlrKind), - ("orderDocuments" .=) <$> _odlrOrderDocuments]) - --- | Represents a recipient. --- --- /See:/ 'recipient' smart constructor. -data Recipient = Recipient' - { _recEmail :: !(Maybe Text) - , _recKind :: !Text - , _recDeliveryType :: !(Maybe RecipientDeliveryType) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'Recipient' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'recEmail' --- --- * 'recKind' --- --- * 'recDeliveryType' -recipient - :: Recipient -recipient = - Recipient' - { _recEmail = Nothing - , _recKind = "dfareporting#recipient" - , _recDeliveryType = Nothing - } - --- | The email address of the recipient. -recEmail :: Lens' Recipient (Maybe Text) -recEmail = lens _recEmail (\ s a -> s{_recEmail = a}) - --- | The kind of resource this is, in this case dfareporting#recipient. -recKind :: Lens' Recipient Text -recKind = lens _recKind (\ s a -> s{_recKind = a}) - --- | The delivery type for the recipient. -recDeliveryType :: Lens' Recipient (Maybe RecipientDeliveryType) -recDeliveryType - = lens _recDeliveryType - (\ s a -> s{_recDeliveryType = a}) - -instance FromJSON Recipient where - parseJSON - = withObject "Recipient" - (\ o -> - Recipient' <$> - (o .:? "email") <*> - (o .:? "kind" .!= "dfareporting#recipient") - <*> (o .:? "deliveryType")) - -instance ToJSON Recipient where - toJSON Recipient'{..} - = object - (catMaybes - [("email" .=) <$> _recEmail, - Just ("kind" .= _recKind), - ("deliveryType" .=) <$> _recDeliveryType]) - --- | Contains properties of a site. --- --- /See:/ 'site' smart constructor. -data Site = Site' - { _sitiKind :: !Text - , _sitiKeyName :: !(Maybe Text) - , _sitiSiteContacts :: !(Maybe [SiteContact]) - , _sitiSiteSettings :: !(Maybe SiteSettings) - , _sitiIdDimensionValue :: !(Maybe DimensionValue) - , _sitiDirectorySiteIdDimensionValue :: !(Maybe DimensionValue) - , _sitiAccountId :: !(Maybe (Textual Int64)) - , _sitiName :: !(Maybe Text) - , _sitiDirectorySiteId :: !(Maybe (Textual Int64)) - , _sitiId :: !(Maybe (Textual Int64)) - , _sitiSubAccountId :: !(Maybe (Textual Int64)) - , _sitiApproved :: !(Maybe Bool) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'Site' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'sitiKind' --- --- * 'sitiKeyName' --- --- * 'sitiSiteContacts' --- --- * 'sitiSiteSettings' --- --- * 'sitiIdDimensionValue' --- --- * 'sitiDirectorySiteIdDimensionValue' --- --- * 'sitiAccountId' --- --- * 'sitiName' --- --- * 'sitiDirectorySiteId' --- --- * 'sitiId' --- --- * 'sitiSubAccountId' --- --- * 'sitiApproved' -site - :: Site -site = - Site' - { _sitiKind = "dfareporting#site" - , _sitiKeyName = Nothing - , _sitiSiteContacts = Nothing - , _sitiSiteSettings = Nothing - , _sitiIdDimensionValue = Nothing - , _sitiDirectorySiteIdDimensionValue = Nothing - , _sitiAccountId = Nothing - , _sitiName = Nothing - , _sitiDirectorySiteId = Nothing - , _sitiId = Nothing - , _sitiSubAccountId = Nothing - , _sitiApproved = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#site\". -sitiKind :: Lens' Site Text -sitiKind = lens _sitiKind (\ s a -> s{_sitiKind = a}) - --- | Key name of this site. This is a read-only, auto-generated field. -sitiKeyName :: Lens' Site (Maybe Text) -sitiKeyName - = lens _sitiKeyName (\ s a -> s{_sitiKeyName = a}) - --- | Site contacts. -sitiSiteContacts :: Lens' Site [SiteContact] -sitiSiteContacts - = lens _sitiSiteContacts - (\ s a -> s{_sitiSiteContacts = a}) - . _Default - . _Coerce - --- | Site-wide settings. -sitiSiteSettings :: Lens' Site (Maybe SiteSettings) -sitiSiteSettings - = lens _sitiSiteSettings - (\ s a -> s{_sitiSiteSettings = a}) - --- | Dimension value for the ID of this site. This is a read-only, --- auto-generated field. -sitiIdDimensionValue :: Lens' Site (Maybe DimensionValue) -sitiIdDimensionValue - = lens _sitiIdDimensionValue - (\ s a -> s{_sitiIdDimensionValue = a}) - --- | Dimension value for the ID of the directory site. This is a read-only, --- auto-generated field. -sitiDirectorySiteIdDimensionValue :: Lens' Site (Maybe DimensionValue) -sitiDirectorySiteIdDimensionValue - = lens _sitiDirectorySiteIdDimensionValue - (\ s a -> s{_sitiDirectorySiteIdDimensionValue = a}) - --- | Account ID of this site. This is a read-only field that can be left --- blank. -sitiAccountId :: Lens' Site (Maybe Int64) -sitiAccountId - = lens _sitiAccountId - (\ s a -> s{_sitiAccountId = a}) - . mapping _Coerce - --- | Name of this site.This is a required field. Must be less than 128 --- characters long. If this site is under a subaccount, the name must be --- unique among sites of the same subaccount. Otherwise, this site is a --- top-level site, and the name must be unique among top-level sites of the --- same account. -sitiName :: Lens' Site (Maybe Text) -sitiName = lens _sitiName (\ s a -> s{_sitiName = a}) - --- | Directory site associated with this site. This is a required field that --- is read-only after insertion. -sitiDirectorySiteId :: Lens' Site (Maybe Int64) -sitiDirectorySiteId - = lens _sitiDirectorySiteId - (\ s a -> s{_sitiDirectorySiteId = a}) - . mapping _Coerce - --- | ID of this site. This is a read-only, auto-generated field. -sitiId :: Lens' Site (Maybe Int64) -sitiId - = lens _sitiId (\ s a -> s{_sitiId = a}) . - mapping _Coerce - --- | Subaccount ID of this site. This is a read-only field that can be left --- blank. -sitiSubAccountId :: Lens' Site (Maybe Int64) -sitiSubAccountId - = lens _sitiSubAccountId - (\ s a -> s{_sitiSubAccountId = a}) - . mapping _Coerce - --- | Whether this site is approved. -sitiApproved :: Lens' Site (Maybe Bool) -sitiApproved - = lens _sitiApproved (\ s a -> s{_sitiApproved = a}) - -instance FromJSON Site where - parseJSON - = withObject "Site" - (\ o -> - Site' <$> - (o .:? "kind" .!= "dfareporting#site") <*> - (o .:? "keyName") - <*> (o .:? "siteContacts" .!= mempty) - <*> (o .:? "siteSettings") - <*> (o .:? "idDimensionValue") - <*> (o .:? "directorySiteIdDimensionValue") - <*> (o .:? "accountId") - <*> (o .:? "name") - <*> (o .:? "directorySiteId") - <*> (o .:? "id") - <*> (o .:? "subaccountId") - <*> (o .:? "approved")) - -instance ToJSON Site where - toJSON Site'{..} - = object - (catMaybes - [Just ("kind" .= _sitiKind), - ("keyName" .=) <$> _sitiKeyName, - ("siteContacts" .=) <$> _sitiSiteContacts, - ("siteSettings" .=) <$> _sitiSiteSettings, - ("idDimensionValue" .=) <$> _sitiIdDimensionValue, - ("directorySiteIdDimensionValue" .=) <$> - _sitiDirectorySiteIdDimensionValue, - ("accountId" .=) <$> _sitiAccountId, - ("name" .=) <$> _sitiName, - ("directorySiteId" .=) <$> _sitiDirectorySiteId, - ("id" .=) <$> _sitiId, - ("subaccountId" .=) <$> _sitiSubAccountId, - ("approved" .=) <$> _sitiApproved]) - --- | User Defined Variable configuration. --- --- /See:/ 'userDefinedVariableConfiguration' smart constructor. -data UserDefinedVariableConfiguration = UserDefinedVariableConfiguration' - { _udvcReportName :: !(Maybe Text) - , _udvcDataType :: !(Maybe UserDefinedVariableConfigurationDataType) - , _udvcVariableType :: !(Maybe UserDefinedVariableConfigurationVariableType) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'UserDefinedVariableConfiguration' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'udvcReportName' --- --- * 'udvcDataType' --- --- * 'udvcVariableType' -userDefinedVariableConfiguration - :: UserDefinedVariableConfiguration -userDefinedVariableConfiguration = - UserDefinedVariableConfiguration' - { _udvcReportName = Nothing - , _udvcDataType = Nothing - , _udvcVariableType = Nothing - } - --- | User-friendly name for the variable which will appear in reports. This --- is a required field, must be less than 64 characters long, and cannot --- contain the following characters: \"\"\<>\". -udvcReportName :: Lens' UserDefinedVariableConfiguration (Maybe Text) -udvcReportName - = lens _udvcReportName - (\ s a -> s{_udvcReportName = a}) - --- | Data type for the variable. This is a required field. -udvcDataType :: Lens' UserDefinedVariableConfiguration (Maybe UserDefinedVariableConfigurationDataType) -udvcDataType - = lens _udvcDataType (\ s a -> s{_udvcDataType = a}) - --- | Variable name in the tag. This is a required field. -udvcVariableType :: Lens' UserDefinedVariableConfiguration (Maybe UserDefinedVariableConfigurationVariableType) -udvcVariableType - = lens _udvcVariableType - (\ s a -> s{_udvcVariableType = a}) - -instance FromJSON UserDefinedVariableConfiguration - where - parseJSON - = withObject "UserDefinedVariableConfiguration" - (\ o -> - UserDefinedVariableConfiguration' <$> - (o .:? "reportName") <*> (o .:? "dataType") <*> - (o .:? "variableType")) - -instance ToJSON UserDefinedVariableConfiguration - where - toJSON UserDefinedVariableConfiguration'{..} - = object - (catMaybes - [("reportName" .=) <$> _udvcReportName, - ("dataType" .=) <$> _udvcDataType, - ("variableType" .=) <$> _udvcVariableType]) - --- | The report criteria for a report of type \"CROSS_DIMENSION_REACH\". --- --- /See:/ 'reportCrossDimensionReachCriteria' smart constructor. -data ReportCrossDimensionReachCriteria = ReportCrossDimensionReachCriteria' - { _rcdrcPivoted :: !(Maybe Bool) - , _rcdrcBreakdown :: !(Maybe [SortedDimension]) - , _rcdrcDimension :: !(Maybe ReportCrossDimensionReachCriteriaDimension) - , _rcdrcMetricNames :: !(Maybe [Text]) - , _rcdrcDimensionFilters :: !(Maybe [DimensionValue]) - , _rcdrcDateRange :: !(Maybe DateRange) - , _rcdrcOverlapMetricNames :: !(Maybe [Text]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'ReportCrossDimensionReachCriteria' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'rcdrcPivoted' --- --- * 'rcdrcBreakdown' --- --- * 'rcdrcDimension' --- --- * 'rcdrcMetricNames' --- --- * 'rcdrcDimensionFilters' --- --- * 'rcdrcDateRange' --- --- * 'rcdrcOverlapMetricNames' -reportCrossDimensionReachCriteria - :: ReportCrossDimensionReachCriteria -reportCrossDimensionReachCriteria = - ReportCrossDimensionReachCriteria' - { _rcdrcPivoted = Nothing - , _rcdrcBreakdown = Nothing - , _rcdrcDimension = Nothing - , _rcdrcMetricNames = Nothing - , _rcdrcDimensionFilters = Nothing - , _rcdrcDateRange = Nothing - , _rcdrcOverlapMetricNames = Nothing - } - --- | Whether the report is pivoted or not. Defaults to true. -rcdrcPivoted :: Lens' ReportCrossDimensionReachCriteria (Maybe Bool) -rcdrcPivoted - = lens _rcdrcPivoted (\ s a -> s{_rcdrcPivoted = a}) - --- | The list of dimensions the report should include. -rcdrcBreakdown :: Lens' ReportCrossDimensionReachCriteria [SortedDimension] -rcdrcBreakdown - = lens _rcdrcBreakdown - (\ s a -> s{_rcdrcBreakdown = a}) - . _Default - . _Coerce - --- | The dimension option. -rcdrcDimension :: Lens' ReportCrossDimensionReachCriteria (Maybe ReportCrossDimensionReachCriteriaDimension) -rcdrcDimension - = lens _rcdrcDimension - (\ s a -> s{_rcdrcDimension = a}) - --- | The list of names of metrics the report should include. -rcdrcMetricNames :: Lens' ReportCrossDimensionReachCriteria [Text] -rcdrcMetricNames - = lens _rcdrcMetricNames - (\ s a -> s{_rcdrcMetricNames = a}) - . _Default - . _Coerce - --- | The list of filters on which dimensions are filtered. -rcdrcDimensionFilters :: Lens' ReportCrossDimensionReachCriteria [DimensionValue] -rcdrcDimensionFilters - = lens _rcdrcDimensionFilters - (\ s a -> s{_rcdrcDimensionFilters = a}) - . _Default - . _Coerce - --- | The date range this report should be run for. -rcdrcDateRange :: Lens' ReportCrossDimensionReachCriteria (Maybe DateRange) -rcdrcDateRange - = lens _rcdrcDateRange - (\ s a -> s{_rcdrcDateRange = a}) - --- | The list of names of overlap metrics the report should include. -rcdrcOverlapMetricNames :: Lens' ReportCrossDimensionReachCriteria [Text] -rcdrcOverlapMetricNames - = lens _rcdrcOverlapMetricNames - (\ s a -> s{_rcdrcOverlapMetricNames = a}) - . _Default - . _Coerce - -instance FromJSON ReportCrossDimensionReachCriteria - where - parseJSON - = withObject "ReportCrossDimensionReachCriteria" - (\ o -> - ReportCrossDimensionReachCriteria' <$> - (o .:? "pivoted") <*> (o .:? "breakdown" .!= mempty) - <*> (o .:? "dimension") - <*> (o .:? "metricNames" .!= mempty) - <*> (o .:? "dimensionFilters" .!= mempty) - <*> (o .:? "dateRange") - <*> (o .:? "overlapMetricNames" .!= mempty)) - -instance ToJSON ReportCrossDimensionReachCriteria - where - toJSON ReportCrossDimensionReachCriteria'{..} - = object - (catMaybes - [("pivoted" .=) <$> _rcdrcPivoted, - ("breakdown" .=) <$> _rcdrcBreakdown, - ("dimension" .=) <$> _rcdrcDimension, - ("metricNames" .=) <$> _rcdrcMetricNames, - ("dimensionFilters" .=) <$> _rcdrcDimensionFilters, - ("dateRange" .=) <$> _rcdrcDateRange, - ("overlapMetricNames" .=) <$> - _rcdrcOverlapMetricNames]) - --- | The URLs where the completed report file can be downloaded. --- --- /See:/ 'fileURLs' smart constructor. -data FileURLs = FileURLs' - { _fuBrowserURL :: !(Maybe Text) - , _fuAPIURL :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'FileURLs' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'fuBrowserURL' --- --- * 'fuAPIURL' -fileURLs - :: FileURLs -fileURLs = - FileURLs' - { _fuBrowserURL = Nothing - , _fuAPIURL = Nothing - } - --- | The URL for downloading the report data through a browser. -fuBrowserURL :: Lens' FileURLs (Maybe Text) -fuBrowserURL - = lens _fuBrowserURL (\ s a -> s{_fuBrowserURL = a}) - --- | The URL for downloading the report data through the API. -fuAPIURL :: Lens' FileURLs (Maybe Text) -fuAPIURL = lens _fuAPIURL (\ s a -> s{_fuAPIURL = a}) - -instance FromJSON FileURLs where - parseJSON - = withObject "FileURLs" - (\ o -> - FileURLs' <$> - (o .:? "browserUrl") <*> (o .:? "apiUrl")) - -instance ToJSON FileURLs where - toJSON FileURLs'{..} - = object - (catMaybes - [("browserUrl" .=) <$> _fuBrowserURL, - ("apiUrl" .=) <$> _fuAPIURL]) - --- | Campaign Creative Association List Response --- --- /See:/ 'campaignCreativeAssociationsListResponse' smart constructor. -data CampaignCreativeAssociationsListResponse = CampaignCreativeAssociationsListResponse' - { _ccalrCampaignCreativeAssociations :: !(Maybe [CampaignCreativeAssociation]) - , _ccalrNextPageToken :: !(Maybe Text) - , _ccalrKind :: !Text - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'CampaignCreativeAssociationsListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'ccalrCampaignCreativeAssociations' --- --- * 'ccalrNextPageToken' --- --- * 'ccalrKind' -campaignCreativeAssociationsListResponse - :: CampaignCreativeAssociationsListResponse -campaignCreativeAssociationsListResponse = - CampaignCreativeAssociationsListResponse' - { _ccalrCampaignCreativeAssociations = Nothing - , _ccalrNextPageToken = Nothing - , _ccalrKind = "dfareporting#campaignCreativeAssociationsListResponse" - } - --- | Campaign creative association collection -ccalrCampaignCreativeAssociations :: Lens' CampaignCreativeAssociationsListResponse [CampaignCreativeAssociation] -ccalrCampaignCreativeAssociations - = lens _ccalrCampaignCreativeAssociations - (\ s a -> s{_ccalrCampaignCreativeAssociations = a}) - . _Default - . _Coerce - --- | Pagination token to be used for the next list operation. -ccalrNextPageToken :: Lens' CampaignCreativeAssociationsListResponse (Maybe Text) -ccalrNextPageToken - = lens _ccalrNextPageToken - (\ s a -> s{_ccalrNextPageToken = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#campaignCreativeAssociationsListResponse\". -ccalrKind :: Lens' CampaignCreativeAssociationsListResponse Text -ccalrKind - = lens _ccalrKind (\ s a -> s{_ccalrKind = a}) - -instance FromJSON - CampaignCreativeAssociationsListResponse where - parseJSON - = withObject - "CampaignCreativeAssociationsListResponse" - (\ o -> - CampaignCreativeAssociationsListResponse' <$> - (o .:? "campaignCreativeAssociations" .!= mempty) <*> - (o .:? "nextPageToken") - <*> - (o .:? "kind" .!= - "dfareporting#campaignCreativeAssociationsListResponse")) - -instance ToJSON - CampaignCreativeAssociationsListResponse where - toJSON CampaignCreativeAssociationsListResponse'{..} - = object - (catMaybes - [("campaignCreativeAssociations" .=) <$> - _ccalrCampaignCreativeAssociations, - ("nextPageToken" .=) <$> _ccalrNextPageToken, - Just ("kind" .= _ccalrKind)]) - --- | Describes properties of a Planning order. --- --- /See:/ 'order' smart constructor. -data Order = Order' - { _oSellerOrderId :: !(Maybe Text) - , _oSellerOrganizationName :: !(Maybe Text) - , _oKind :: !Text - , _oAdvertiserId :: !(Maybe (Textual Int64)) - , _oPlanningTermId :: !(Maybe (Textual Int64)) - , _oAccountId :: !(Maybe (Textual Int64)) - , _oName :: !(Maybe Text) - , _oSiteNames :: !(Maybe [Text]) - , _oLastModifiedInfo :: !(Maybe LastModifiedInfo) - , _oBuyerOrganizationName :: !(Maybe Text) - , _oId :: !(Maybe (Textual Int64)) - , _oBuyerInvoiceId :: !(Maybe Text) - , _oComments :: !(Maybe Text) - , _oProjectId :: !(Maybe (Textual Int64)) - , _oSubAccountId :: !(Maybe (Textual Int64)) - , _oNotes :: !(Maybe Text) - , _oContacts :: !(Maybe [OrderContact]) - , _oSiteId :: !(Maybe [Textual Int64]) - , _oTermsAndConditions :: !(Maybe Text) - , _oApproverUserProFileIds :: !(Maybe [Textual Int64]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'Order' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'oSellerOrderId' --- --- * 'oSellerOrganizationName' --- --- * 'oKind' --- --- * 'oAdvertiserId' --- --- * 'oPlanningTermId' --- --- * 'oAccountId' --- --- * 'oName' --- --- * 'oSiteNames' --- --- * 'oLastModifiedInfo' --- --- * 'oBuyerOrganizationName' --- --- * 'oId' --- --- * 'oBuyerInvoiceId' --- --- * 'oComments' --- --- * 'oProjectId' --- --- * 'oSubAccountId' --- --- * 'oNotes' --- --- * 'oContacts' --- --- * 'oSiteId' --- --- * 'oTermsAndConditions' --- --- * 'oApproverUserProFileIds' -order - :: Order -order = - Order' - { _oSellerOrderId = Nothing - , _oSellerOrganizationName = Nothing - , _oKind = "dfareporting#order" - , _oAdvertiserId = Nothing - , _oPlanningTermId = Nothing - , _oAccountId = Nothing - , _oName = Nothing - , _oSiteNames = Nothing - , _oLastModifiedInfo = Nothing - , _oBuyerOrganizationName = Nothing - , _oId = Nothing - , _oBuyerInvoiceId = Nothing - , _oComments = Nothing - , _oProjectId = Nothing - , _oSubAccountId = Nothing - , _oNotes = Nothing - , _oContacts = Nothing - , _oSiteId = Nothing - , _oTermsAndConditions = Nothing - , _oApproverUserProFileIds = Nothing - } - --- | Seller order ID associated with this order. -oSellerOrderId :: Lens' Order (Maybe Text) -oSellerOrderId - = lens _oSellerOrderId - (\ s a -> s{_oSellerOrderId = a}) - --- | Name of the seller organization. -oSellerOrganizationName :: Lens' Order (Maybe Text) -oSellerOrganizationName - = lens _oSellerOrganizationName - (\ s a -> s{_oSellerOrganizationName = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#order\". -oKind :: Lens' Order Text -oKind = lens _oKind (\ s a -> s{_oKind = a}) - --- | Advertiser ID of this order. -oAdvertiserId :: Lens' Order (Maybe Int64) -oAdvertiserId - = lens _oAdvertiserId - (\ s a -> s{_oAdvertiserId = a}) - . mapping _Coerce - --- | ID of the terms and conditions template used in this order. -oPlanningTermId :: Lens' Order (Maybe Int64) -oPlanningTermId - = lens _oPlanningTermId - (\ s a -> s{_oPlanningTermId = a}) - . mapping _Coerce - --- | Account ID of this order. -oAccountId :: Lens' Order (Maybe Int64) -oAccountId - = lens _oAccountId (\ s a -> s{_oAccountId = a}) . - mapping _Coerce - --- | Name of this order. -oName :: Lens' Order (Maybe Text) -oName = lens _oName (\ s a -> s{_oName = a}) - --- | Free-form site names this order is associated with. -oSiteNames :: Lens' Order [Text] -oSiteNames - = lens _oSiteNames (\ s a -> s{_oSiteNames = a}) . - _Default - . _Coerce - --- | Information about the most recent modification of this order. -oLastModifiedInfo :: Lens' Order (Maybe LastModifiedInfo) -oLastModifiedInfo - = lens _oLastModifiedInfo - (\ s a -> s{_oLastModifiedInfo = a}) - --- | Name of the buyer organization. -oBuyerOrganizationName :: Lens' Order (Maybe Text) -oBuyerOrganizationName - = lens _oBuyerOrganizationName - (\ s a -> s{_oBuyerOrganizationName = a}) - --- | ID of this order. This is a read-only, auto-generated field. -oId :: Lens' Order (Maybe Int64) -oId - = lens _oId (\ s a -> s{_oId = a}) . mapping _Coerce - --- | Buyer invoice ID associated with this order. -oBuyerInvoiceId :: Lens' Order (Maybe Text) -oBuyerInvoiceId - = lens _oBuyerInvoiceId - (\ s a -> s{_oBuyerInvoiceId = a}) - --- | Comments in this order. -oComments :: Lens' Order (Maybe Text) -oComments - = lens _oComments (\ s a -> s{_oComments = a}) - --- | Project ID of this order. -oProjectId :: Lens' Order (Maybe Int64) -oProjectId - = lens _oProjectId (\ s a -> s{_oProjectId = a}) . - mapping _Coerce - --- | Subaccount ID of this order. -oSubAccountId :: Lens' Order (Maybe Int64) -oSubAccountId - = lens _oSubAccountId - (\ s a -> s{_oSubAccountId = a}) - . mapping _Coerce - --- | Notes of this order. -oNotes :: Lens' Order (Maybe Text) -oNotes = lens _oNotes (\ s a -> s{_oNotes = a}) - --- | Contacts for this order. -oContacts :: Lens' Order [OrderContact] -oContacts - = lens _oContacts (\ s a -> s{_oContacts = a}) . - _Default - . _Coerce - --- | Site IDs this order is associated with. -oSiteId :: Lens' Order [Int64] -oSiteId - = lens _oSiteId (\ s a -> s{_oSiteId = a}) . _Default - . _Coerce - --- | Terms and conditions of this order. -oTermsAndConditions :: Lens' Order (Maybe Text) -oTermsAndConditions - = lens _oTermsAndConditions - (\ s a -> s{_oTermsAndConditions = a}) - --- | IDs for users that have to approve documents created for this order. -oApproverUserProFileIds :: Lens' Order [Int64] -oApproverUserProFileIds - = lens _oApproverUserProFileIds - (\ s a -> s{_oApproverUserProFileIds = a}) - . _Default - . _Coerce - -instance FromJSON Order where - parseJSON - = withObject "Order" - (\ o -> - Order' <$> - (o .:? "sellerOrderId") <*> - (o .:? "sellerOrganizationName") - <*> (o .:? "kind" .!= "dfareporting#order") - <*> (o .:? "advertiserId") - <*> (o .:? "planningTermId") - <*> (o .:? "accountId") - <*> (o .:? "name") - <*> (o .:? "siteNames" .!= mempty) - <*> (o .:? "lastModifiedInfo") - <*> (o .:? "buyerOrganizationName") - <*> (o .:? "id") - <*> (o .:? "buyerInvoiceId") - <*> (o .:? "comments") - <*> (o .:? "projectId") - <*> (o .:? "subaccountId") - <*> (o .:? "notes") - <*> (o .:? "contacts" .!= mempty) - <*> (o .:? "siteId" .!= mempty) - <*> (o .:? "termsAndConditions") - <*> (o .:? "approverUserProfileIds" .!= mempty)) - -instance ToJSON Order where - toJSON Order'{..} - = object - (catMaybes - [("sellerOrderId" .=) <$> _oSellerOrderId, - ("sellerOrganizationName" .=) <$> - _oSellerOrganizationName, - Just ("kind" .= _oKind), - ("advertiserId" .=) <$> _oAdvertiserId, - ("planningTermId" .=) <$> _oPlanningTermId, - ("accountId" .=) <$> _oAccountId, - ("name" .=) <$> _oName, - ("siteNames" .=) <$> _oSiteNames, - ("lastModifiedInfo" .=) <$> _oLastModifiedInfo, - ("buyerOrganizationName" .=) <$> - _oBuyerOrganizationName, - ("id" .=) <$> _oId, - ("buyerInvoiceId" .=) <$> _oBuyerInvoiceId, - ("comments" .=) <$> _oComments, - ("projectId" .=) <$> _oProjectId, - ("subaccountId" .=) <$> _oSubAccountId, - ("notes" .=) <$> _oNotes, - ("contacts" .=) <$> _oContacts, - ("siteId" .=) <$> _oSiteId, - ("termsAndConditions" .=) <$> _oTermsAndConditions, - ("approverUserProfileIds" .=) <$> - _oApproverUserProFileIds]) - --- | Creative Asset ID. --- --- /See:/ 'creativeAssetId' smart constructor. -data CreativeAssetId = CreativeAssetId' - { _caiName :: !(Maybe Text) - , _caiType :: !(Maybe CreativeAssetIdType) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'CreativeAssetId' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'caiName' --- --- * 'caiType' -creativeAssetId - :: CreativeAssetId -creativeAssetId = - CreativeAssetId' - { _caiName = Nothing - , _caiType = Nothing - } - --- | Name of the creative asset. This is a required field while inserting an --- asset. After insertion, this assetIdentifier is used to identify the --- uploaded asset. Characters in the name must be alphanumeric or one of --- the following: \".-_ \". Spaces are allowed. -caiName :: Lens' CreativeAssetId (Maybe Text) -caiName = lens _caiName (\ s a -> s{_caiName = a}) - --- | Type of asset to upload. This is a required field. FLASH and IMAGE are --- no longer supported for new uploads. All image assets should use --- HTML_IMAGE. -caiType :: Lens' CreativeAssetId (Maybe CreativeAssetIdType) -caiType = lens _caiType (\ s a -> s{_caiType = a}) - -instance FromJSON CreativeAssetId where - parseJSON - = withObject "CreativeAssetId" - (\ o -> - CreativeAssetId' <$> - (o .:? "name") <*> (o .:? "type")) - -instance ToJSON CreativeAssetId where - toJSON CreativeAssetId'{..} - = object - (catMaybes - [("name" .=) <$> _caiName, ("type" .=) <$> _caiType]) - --- | Frequency Cap. --- --- /See:/ 'frequencyCap' smart constructor. -data FrequencyCap = FrequencyCap' - { _fcImpressions :: !(Maybe (Textual Int64)) - , _fcDuration :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'FrequencyCap' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'fcImpressions' --- --- * 'fcDuration' -frequencyCap - :: FrequencyCap -frequencyCap = - FrequencyCap' - { _fcImpressions = Nothing - , _fcDuration = Nothing - } - --- | Number of times an individual user can be served the ad within the --- specified duration. Acceptable values are 1 to 15, inclusive. -fcImpressions :: Lens' FrequencyCap (Maybe Int64) -fcImpressions - = lens _fcImpressions - (\ s a -> s{_fcImpressions = a}) - . mapping _Coerce - --- | Duration of time, in seconds, for this frequency cap. The maximum --- duration is 90 days. Acceptable values are 1 to 7776000, inclusive. -fcDuration :: Lens' FrequencyCap (Maybe Int64) -fcDuration - = lens _fcDuration (\ s a -> s{_fcDuration = a}) . - mapping _Coerce - -instance FromJSON FrequencyCap where - parseJSON - = withObject "FrequencyCap" - (\ o -> - FrequencyCap' <$> - (o .:? "impressions") <*> (o .:? "duration")) - -instance ToJSON FrequencyCap where - toJSON FrequencyCap'{..} - = object - (catMaybes - [("impressions" .=) <$> _fcImpressions, - ("duration" .=) <$> _fcDuration]) - --- | Represents a File resource. A file contains the metadata for a report --- run. It shows the status of the run and holds the URLs to the generated --- report data if the run is finished and the status is --- \"REPORT_AVAILABLE\". --- --- /See:/ 'file' smart constructor. -data File = File' - { _filStatus :: !(Maybe FileStatus) - , _filEtag :: !(Maybe Text) - , _filKind :: !Text - , _filURLs :: !(Maybe FileURLs) - , _filReportId :: !(Maybe (Textual Int64)) - , _filDateRange :: !(Maybe DateRange) - , _filFormat :: !(Maybe FileFormat) - , _filLastModifiedTime :: !(Maybe (Textual Int64)) - , _filId :: !(Maybe (Textual Int64)) - , _filFileName :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'File' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'filStatus' --- --- * 'filEtag' --- --- * 'filKind' --- --- * 'filURLs' --- --- * 'filReportId' --- --- * 'filDateRange' --- --- * 'filFormat' --- --- * 'filLastModifiedTime' --- --- * 'filId' --- --- * 'filFileName' -file - :: File -file = - File' - { _filStatus = Nothing - , _filEtag = Nothing - , _filKind = "dfareporting#file" - , _filURLs = Nothing - , _filReportId = Nothing - , _filDateRange = Nothing - , _filFormat = Nothing - , _filLastModifiedTime = Nothing - , _filId = Nothing - , _filFileName = Nothing - } - --- | The status of the report file. -filStatus :: Lens' File (Maybe FileStatus) -filStatus - = lens _filStatus (\ s a -> s{_filStatus = a}) - --- | The eTag of this response for caching purposes. -filEtag :: Lens' File (Maybe Text) -filEtag = lens _filEtag (\ s a -> s{_filEtag = a}) - --- | The kind of resource this is, in this case dfareporting#file. -filKind :: Lens' File Text -filKind = lens _filKind (\ s a -> s{_filKind = a}) - --- | The URLs where the completed report file can be downloaded. -filURLs :: Lens' File (Maybe FileURLs) -filURLs = lens _filURLs (\ s a -> s{_filURLs = a}) - --- | The ID of the report this file was generated from. -filReportId :: Lens' File (Maybe Int64) -filReportId - = lens _filReportId (\ s a -> s{_filReportId = a}) . - mapping _Coerce - --- | The date range for which the file has report data. The date range will --- always be the absolute date range for which the report is run. -filDateRange :: Lens' File (Maybe DateRange) -filDateRange - = lens _filDateRange (\ s a -> s{_filDateRange = a}) - --- | The output format of the report. Only available once the file is --- available. -filFormat :: Lens' File (Maybe FileFormat) -filFormat - = lens _filFormat (\ s a -> s{_filFormat = a}) - --- | The timestamp in milliseconds since epoch when this file was last --- modified. -filLastModifiedTime :: Lens' File (Maybe Int64) -filLastModifiedTime - = lens _filLastModifiedTime - (\ s a -> s{_filLastModifiedTime = a}) - . mapping _Coerce - --- | The unique ID of this report file. -filId :: Lens' File (Maybe Int64) -filId - = lens _filId (\ s a -> s{_filId = a}) . - mapping _Coerce - --- | The filename of the file. -filFileName :: Lens' File (Maybe Text) -filFileName - = lens _filFileName (\ s a -> s{_filFileName = a}) - -instance FromJSON File where - parseJSON - = withObject "File" - (\ o -> - File' <$> - (o .:? "status") <*> (o .:? "etag") <*> - (o .:? "kind" .!= "dfareporting#file") - <*> (o .:? "urls") - <*> (o .:? "reportId") - <*> (o .:? "dateRange") - <*> (o .:? "format") - <*> (o .:? "lastModifiedTime") - <*> (o .:? "id") - <*> (o .:? "fileName")) - -instance ToJSON File where - toJSON File'{..} - = object - (catMaybes - [("status" .=) <$> _filStatus, - ("etag" .=) <$> _filEtag, Just ("kind" .= _filKind), - ("urls" .=) <$> _filURLs, - ("reportId" .=) <$> _filReportId, - ("dateRange" .=) <$> _filDateRange, - ("format" .=) <$> _filFormat, - ("lastModifiedTime" .=) <$> _filLastModifiedTime, - ("id" .=) <$> _filId, - ("fileName" .=) <$> _filFileName]) - --- | Creative Settings --- --- /See:/ 'creativeSettings' smart constructor. -data CreativeSettings = CreativeSettings' - { _csIFrameHeader :: !(Maybe Text) - , _csIFrameFooter :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'CreativeSettings' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'csIFrameHeader' --- --- * 'csIFrameFooter' -creativeSettings - :: CreativeSettings -creativeSettings = - CreativeSettings' - { _csIFrameHeader = Nothing - , _csIFrameFooter = Nothing - } - --- | Header text for iFrames for this site. Must be less than or equal to --- 2000 characters long. -csIFrameHeader :: Lens' CreativeSettings (Maybe Text) -csIFrameHeader - = lens _csIFrameHeader - (\ s a -> s{_csIFrameHeader = a}) - --- | Header text for iFrames for this site. Must be less than or equal to --- 2000 characters long. -csIFrameFooter :: Lens' CreativeSettings (Maybe Text) -csIFrameFooter - = lens _csIFrameFooter - (\ s a -> s{_csIFrameFooter = a}) - -instance FromJSON CreativeSettings where - parseJSON - = withObject "CreativeSettings" - (\ o -> - CreativeSettings' <$> - (o .:? "iFrameHeader") <*> (o .:? "iFrameFooter")) - -instance ToJSON CreativeSettings where - toJSON CreativeSettings'{..} - = object - (catMaybes - [("iFrameHeader" .=) <$> _csIFrameHeader, - ("iFrameFooter" .=) <$> _csIFrameFooter]) - --- | Creative Group List Response --- --- /See:/ 'creativeGroupsListResponse' smart constructor. -data CreativeGroupsListResponse = CreativeGroupsListResponse' - { _cglrCreativeGroups :: !(Maybe [CreativeGroup]) - , _cglrNextPageToken :: !(Maybe Text) - , _cglrKind :: !Text - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'CreativeGroupsListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'cglrCreativeGroups' --- --- * 'cglrNextPageToken' --- --- * 'cglrKind' -creativeGroupsListResponse - :: CreativeGroupsListResponse -creativeGroupsListResponse = - CreativeGroupsListResponse' - { _cglrCreativeGroups = Nothing - , _cglrNextPageToken = Nothing - , _cglrKind = "dfareporting#creativeGroupsListResponse" - } - --- | Creative group collection. -cglrCreativeGroups :: Lens' CreativeGroupsListResponse [CreativeGroup] -cglrCreativeGroups - = lens _cglrCreativeGroups - (\ s a -> s{_cglrCreativeGroups = a}) - . _Default - . _Coerce - --- | Pagination token to be used for the next list operation. -cglrNextPageToken :: Lens' CreativeGroupsListResponse (Maybe Text) -cglrNextPageToken - = lens _cglrNextPageToken - (\ s a -> s{_cglrNextPageToken = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#creativeGroupsListResponse\". -cglrKind :: Lens' CreativeGroupsListResponse Text -cglrKind = lens _cglrKind (\ s a -> s{_cglrKind = a}) - -instance FromJSON CreativeGroupsListResponse where - parseJSON - = withObject "CreativeGroupsListResponse" - (\ o -> - CreativeGroupsListResponse' <$> - (o .:? "creativeGroups" .!= mempty) <*> - (o .:? "nextPageToken") - <*> - (o .:? "kind" .!= - "dfareporting#creativeGroupsListResponse")) - -instance ToJSON CreativeGroupsListResponse where - toJSON CreativeGroupsListResponse'{..} - = object - (catMaybes - [("creativeGroups" .=) <$> _cglrCreativeGroups, - ("nextPageToken" .=) <$> _cglrNextPageToken, - Just ("kind" .= _cglrKind)]) - --- | Mobile Carrier List Response --- --- /See:/ 'mobileCarriersListResponse' smart constructor. -data MobileCarriersListResponse = MobileCarriersListResponse' - { _mclrMobileCarriers :: !(Maybe [MobileCarrier]) - , _mclrKind :: !Text - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'MobileCarriersListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'mclrMobileCarriers' --- --- * 'mclrKind' -mobileCarriersListResponse - :: MobileCarriersListResponse -mobileCarriersListResponse = - MobileCarriersListResponse' - { _mclrMobileCarriers = Nothing - , _mclrKind = "dfareporting#mobileCarriersListResponse" - } - --- | Mobile carrier collection. -mclrMobileCarriers :: Lens' MobileCarriersListResponse [MobileCarrier] -mclrMobileCarriers - = lens _mclrMobileCarriers - (\ s a -> s{_mclrMobileCarriers = a}) - . _Default - . _Coerce - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#mobileCarriersListResponse\". -mclrKind :: Lens' MobileCarriersListResponse Text -mclrKind = lens _mclrKind (\ s a -> s{_mclrKind = a}) - -instance FromJSON MobileCarriersListResponse where - parseJSON - = withObject "MobileCarriersListResponse" - (\ o -> - MobileCarriersListResponse' <$> - (o .:? "mobileCarriers" .!= mempty) <*> - (o .:? "kind" .!= - "dfareporting#mobileCarriersListResponse")) - -instance ToJSON MobileCarriersListResponse where - toJSON MobileCarriersListResponse'{..} - = object - (catMaybes - [("mobileCarriers" .=) <$> _mclrMobileCarriers, - Just ("kind" .= _mclrKind)]) - --- | CreativeAssets contains properties of a creative asset file which will --- be uploaded or has already been uploaded. Refer to the creative sample --- code for how to upload assets and insert a creative. --- --- /See:/ 'creativeAssetMetadata' smart constructor. -data CreativeAssetMetadata = CreativeAssetMetadata' - { _camaKind :: !Text - , _camaAssetIdentifier :: !(Maybe CreativeAssetId) - , _camaIdDimensionValue :: !(Maybe DimensionValue) - , _camaClickTags :: !(Maybe [ClickTag]) - , _camaWarnedValidationRules :: !(Maybe [CreativeAssetMetadataWarnedValidationRulesItem]) - , _camaId :: !(Maybe (Textual Int64)) - , _camaDetectedFeatures :: !(Maybe [CreativeAssetMetadataDetectedFeaturesItem]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'CreativeAssetMetadata' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'camaKind' --- --- * 'camaAssetIdentifier' --- --- * 'camaIdDimensionValue' --- --- * 'camaClickTags' --- --- * 'camaWarnedValidationRules' --- --- * 'camaId' --- --- * 'camaDetectedFeatures' -creativeAssetMetadata - :: CreativeAssetMetadata -creativeAssetMetadata = - CreativeAssetMetadata' - { _camaKind = "dfareporting#creativeAssetMetadata" - , _camaAssetIdentifier = Nothing - , _camaIdDimensionValue = Nothing - , _camaClickTags = Nothing - , _camaWarnedValidationRules = Nothing - , _camaId = Nothing - , _camaDetectedFeatures = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#creativeAssetMetadata\". -camaKind :: Lens' CreativeAssetMetadata Text -camaKind = lens _camaKind (\ s a -> s{_camaKind = a}) - --- | ID of the creative asset. This is a required field. -camaAssetIdentifier :: Lens' CreativeAssetMetadata (Maybe CreativeAssetId) -camaAssetIdentifier - = lens _camaAssetIdentifier - (\ s a -> s{_camaAssetIdentifier = a}) - --- | Dimension value for the numeric ID of the asset. This is a read-only, --- auto-generated field. -camaIdDimensionValue :: Lens' CreativeAssetMetadata (Maybe DimensionValue) -camaIdDimensionValue - = lens _camaIdDimensionValue - (\ s a -> s{_camaIdDimensionValue = a}) - --- | List of detected click tags for assets. This is a read-only --- auto-generated field. -camaClickTags :: Lens' CreativeAssetMetadata [ClickTag] -camaClickTags - = lens _camaClickTags - (\ s a -> s{_camaClickTags = a}) - . _Default - . _Coerce - --- | Rules validated during code generation that generated a warning. This is --- a read-only, auto-generated field. Possible values are: - --- \"ADMOB_REFERENCED\" - \"ASSET_FORMAT_UNSUPPORTED_DCM\" - --- \"ASSET_INVALID\" - \"CLICK_TAG_HARD_CODED\" - \"CLICK_TAG_INVALID\" - --- \"CLICK_TAG_IN_GWD\" - \"CLICK_TAG_MISSING\" - --- \"CLICK_TAG_MORE_THAN_ONE\" - \"CLICK_TAG_NON_TOP_LEVEL\" - --- \"COMPONENT_UNSUPPORTED_DCM\" - \"ENABLER_UNSUPPORTED_METHOD_DCM\" - --- \"EXTERNAL_FILE_REFERENCED\" - \"FILE_DETAIL_EMPTY\" - --- \"FILE_TYPE_INVALID\" - \"GWD_PROPERTIES_INVALID\" - --- \"HTML5_FEATURE_UNSUPPORTED\" - \"LINKED_FILE_NOT_FOUND\" - --- \"MAX_FLASH_VERSION_11\" - \"MRAID_REFERENCED\" - \"NOT_SSL_COMPLIANT\" --- - \"ORPHANED_ASSET\" - \"PRIMARY_HTML_MISSING\" - \"SVG_INVALID\" - --- \"ZIP_INVALID\" -camaWarnedValidationRules :: Lens' CreativeAssetMetadata [CreativeAssetMetadataWarnedValidationRulesItem] -camaWarnedValidationRules - = lens _camaWarnedValidationRules - (\ s a -> s{_camaWarnedValidationRules = a}) - . _Default - . _Coerce - --- | Numeric ID of the asset. This is a read-only, auto-generated field. -camaId :: Lens' CreativeAssetMetadata (Maybe Int64) -camaId - = lens _camaId (\ s a -> s{_camaId = a}) . - mapping _Coerce - --- | List of feature dependencies for the creative asset that are detected by --- Campaign Manager. Feature dependencies are features that a browser must --- be able to support in order to render your HTML5 creative correctly. --- This is a read-only, auto-generated field. -camaDetectedFeatures :: Lens' CreativeAssetMetadata [CreativeAssetMetadataDetectedFeaturesItem] -camaDetectedFeatures - = lens _camaDetectedFeatures - (\ s a -> s{_camaDetectedFeatures = a}) - . _Default - . _Coerce - -instance FromJSON CreativeAssetMetadata where - parseJSON - = withObject "CreativeAssetMetadata" - (\ o -> - CreativeAssetMetadata' <$> - (o .:? "kind" .!= - "dfareporting#creativeAssetMetadata") - <*> (o .:? "assetIdentifier") - <*> (o .:? "idDimensionValue") - <*> (o .:? "clickTags" .!= mempty) - <*> (o .:? "warnedValidationRules" .!= mempty) - <*> (o .:? "id") - <*> (o .:? "detectedFeatures" .!= mempty)) - -instance ToJSON CreativeAssetMetadata where - toJSON CreativeAssetMetadata'{..} - = object - (catMaybes - [Just ("kind" .= _camaKind), - ("assetIdentifier" .=) <$> _camaAssetIdentifier, - ("idDimensionValue" .=) <$> _camaIdDimensionValue, - ("clickTags" .=) <$> _camaClickTags, - ("warnedValidationRules" .=) <$> - _camaWarnedValidationRules, - ("id" .=) <$> _camaId, - ("detectedFeatures" .=) <$> _camaDetectedFeatures]) - --- | Omniture Integration Settings. --- --- /See:/ 'omnitureSettings' smart constructor. -data OmnitureSettings = OmnitureSettings' - { _osOmnitureCostDataEnabled :: !(Maybe Bool) - , _osOmnitureIntegrationEnabled :: !(Maybe Bool) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'OmnitureSettings' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'osOmnitureCostDataEnabled' --- --- * 'osOmnitureIntegrationEnabled' -omnitureSettings - :: OmnitureSettings -omnitureSettings = - OmnitureSettings' - { _osOmnitureCostDataEnabled = Nothing - , _osOmnitureIntegrationEnabled = Nothing - } - --- | Whether placement cost data will be sent to Omniture. This property can --- be enabled only if omnitureIntegrationEnabled is true. -osOmnitureCostDataEnabled :: Lens' OmnitureSettings (Maybe Bool) -osOmnitureCostDataEnabled - = lens _osOmnitureCostDataEnabled - (\ s a -> s{_osOmnitureCostDataEnabled = a}) - --- | Whether Omniture integration is enabled. This property can be enabled --- only when the \"Advanced Ad Serving\" account setting is enabled. -osOmnitureIntegrationEnabled :: Lens' OmnitureSettings (Maybe Bool) -osOmnitureIntegrationEnabled - = lens _osOmnitureIntegrationEnabled - (\ s a -> s{_osOmnitureIntegrationEnabled = a}) - -instance FromJSON OmnitureSettings where - parseJSON - = withObject "OmnitureSettings" - (\ o -> - OmnitureSettings' <$> - (o .:? "omnitureCostDataEnabled") <*> - (o .:? "omnitureIntegrationEnabled")) - -instance ToJSON OmnitureSettings where - toJSON OmnitureSettings'{..} - = object - (catMaybes - [("omnitureCostDataEnabled" .=) <$> - _osOmnitureCostDataEnabled, - ("omnitureIntegrationEnabled" .=) <$> - _osOmnitureIntegrationEnabled]) - --- | Contains information about an internet connection type that can be --- targeted by ads. Clients can use the connection type to target mobile --- vs. broadband users. --- --- /See:/ 'connectionType' smart constructor. -data ConnectionType = ConnectionType' - { _cttKind :: !Text - , _cttName :: !(Maybe Text) - , _cttId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'ConnectionType' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'cttKind' --- --- * 'cttName' --- --- * 'cttId' -connectionType - :: ConnectionType -connectionType = - ConnectionType' - { _cttKind = "dfareporting#connectionType" - , _cttName = Nothing - , _cttId = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#connectionType\". -cttKind :: Lens' ConnectionType Text -cttKind = lens _cttKind (\ s a -> s{_cttKind = a}) - --- | Name of this connection type. -cttName :: Lens' ConnectionType (Maybe Text) -cttName = lens _cttName (\ s a -> s{_cttName = a}) - --- | ID of this connection type. -cttId :: Lens' ConnectionType (Maybe Int64) -cttId - = lens _cttId (\ s a -> s{_cttId = a}) . - mapping _Coerce - -instance FromJSON ConnectionType where - parseJSON - = withObject "ConnectionType" - (\ o -> - ConnectionType' <$> - (o .:? "kind" .!= "dfareporting#connectionType") <*> - (o .:? "name") - <*> (o .:? "id")) - -instance ToJSON ConnectionType where - toJSON ConnectionType'{..} - = object - (catMaybes - [Just ("kind" .= _cttKind), ("name" .=) <$> _cttName, - ("id" .=) <$> _cttId]) - --- | Contains properties of a package or roadblock. --- --- /See:/ 'placementGroup' smart constructor. -data PlacementGroup = PlacementGroup' - { _plalPlacementStrategyId :: !(Maybe (Textual Int64)) - , _plalSiteIdDimensionValue :: !(Maybe DimensionValue) - , _plalPricingSchedule :: !(Maybe PricingSchedule) - , _plalKind :: !Text - , _plalCampaignIdDimensionValue :: !(Maybe DimensionValue) - , _plalAdvertiserId :: !(Maybe (Textual Int64)) - , _plalAdvertiserIdDimensionValue :: !(Maybe DimensionValue) - , _plalCampaignId :: !(Maybe (Textual Int64)) - , _plalIdDimensionValue :: !(Maybe DimensionValue) - , _plalPlacementGroupType :: !(Maybe PlacementGroupPlacementGroupType) - , _plalContentCategoryId :: !(Maybe (Textual Int64)) - , _plalDirectorySiteIdDimensionValue :: !(Maybe DimensionValue) - , _plalAccountId :: !(Maybe (Textual Int64)) - , _plalName :: !(Maybe Text) - , _plalDirectorySiteId :: !(Maybe (Textual Int64)) - , _plalCreateInfo :: !(Maybe LastModifiedInfo) - , _plalChildPlacementIds :: !(Maybe [Textual Int64]) - , _plalLastModifiedInfo :: !(Maybe LastModifiedInfo) - , _plalId :: !(Maybe (Textual Int64)) - , _plalPrimaryPlacementId :: !(Maybe (Textual Int64)) - , _plalSubAccountId :: !(Maybe (Textual Int64)) - , _plalExternalId :: !(Maybe Text) - , _plalComment :: !(Maybe Text) - , _plalPrimaryPlacementIdDimensionValue :: !(Maybe DimensionValue) - , _plalSiteId :: !(Maybe (Textual Int64)) - , _plalArchived :: !(Maybe Bool) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'PlacementGroup' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'plalPlacementStrategyId' --- --- * 'plalSiteIdDimensionValue' --- --- * 'plalPricingSchedule' --- --- * 'plalKind' --- --- * 'plalCampaignIdDimensionValue' --- --- * 'plalAdvertiserId' --- --- * 'plalAdvertiserIdDimensionValue' --- --- * 'plalCampaignId' --- --- * 'plalIdDimensionValue' --- --- * 'plalPlacementGroupType' --- --- * 'plalContentCategoryId' --- --- * 'plalDirectorySiteIdDimensionValue' --- --- * 'plalAccountId' --- --- * 'plalName' --- --- * 'plalDirectorySiteId' --- --- * 'plalCreateInfo' --- --- * 'plalChildPlacementIds' --- --- * 'plalLastModifiedInfo' --- --- * 'plalId' --- --- * 'plalPrimaryPlacementId' --- --- * 'plalSubAccountId' --- --- * 'plalExternalId' --- --- * 'plalComment' --- --- * 'plalPrimaryPlacementIdDimensionValue' --- --- * 'plalSiteId' --- --- * 'plalArchived' -placementGroup - :: PlacementGroup -placementGroup = - PlacementGroup' - { _plalPlacementStrategyId = Nothing - , _plalSiteIdDimensionValue = Nothing - , _plalPricingSchedule = Nothing - , _plalKind = "dfareporting#placementGroup" - , _plalCampaignIdDimensionValue = Nothing - , _plalAdvertiserId = Nothing - , _plalAdvertiserIdDimensionValue = Nothing - , _plalCampaignId = Nothing - , _plalIdDimensionValue = Nothing - , _plalPlacementGroupType = Nothing - , _plalContentCategoryId = Nothing - , _plalDirectorySiteIdDimensionValue = Nothing - , _plalAccountId = Nothing - , _plalName = Nothing - , _plalDirectorySiteId = Nothing - , _plalCreateInfo = Nothing - , _plalChildPlacementIds = Nothing - , _plalLastModifiedInfo = Nothing - , _plalId = Nothing - , _plalPrimaryPlacementId = Nothing - , _plalSubAccountId = Nothing - , _plalExternalId = Nothing - , _plalComment = Nothing - , _plalPrimaryPlacementIdDimensionValue = Nothing - , _plalSiteId = Nothing - , _plalArchived = Nothing - } - --- | ID of the placement strategy assigned to this placement group. -plalPlacementStrategyId :: Lens' PlacementGroup (Maybe Int64) -plalPlacementStrategyId - = lens _plalPlacementStrategyId - (\ s a -> s{_plalPlacementStrategyId = a}) - . mapping _Coerce - --- | Dimension value for the ID of the site. This is a read-only, --- auto-generated field. -plalSiteIdDimensionValue :: Lens' PlacementGroup (Maybe DimensionValue) -plalSiteIdDimensionValue - = lens _plalSiteIdDimensionValue - (\ s a -> s{_plalSiteIdDimensionValue = a}) - --- | Pricing schedule of this placement group. This field is required on --- insertion. -plalPricingSchedule :: Lens' PlacementGroup (Maybe PricingSchedule) -plalPricingSchedule - = lens _plalPricingSchedule - (\ s a -> s{_plalPricingSchedule = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#placementGroup\". -plalKind :: Lens' PlacementGroup Text -plalKind = lens _plalKind (\ s a -> s{_plalKind = a}) - --- | Dimension value for the ID of the campaign. This is a read-only, --- auto-generated field. -plalCampaignIdDimensionValue :: Lens' PlacementGroup (Maybe DimensionValue) -plalCampaignIdDimensionValue - = lens _plalCampaignIdDimensionValue - (\ s a -> s{_plalCampaignIdDimensionValue = a}) - --- | Advertiser ID of this placement group. This is a required field on --- insertion. -plalAdvertiserId :: Lens' PlacementGroup (Maybe Int64) -plalAdvertiserId - = lens _plalAdvertiserId - (\ s a -> s{_plalAdvertiserId = a}) - . mapping _Coerce - --- | Dimension value for the ID of the advertiser. This is a read-only, --- auto-generated field. -plalAdvertiserIdDimensionValue :: Lens' PlacementGroup (Maybe DimensionValue) -plalAdvertiserIdDimensionValue - = lens _plalAdvertiserIdDimensionValue - (\ s a -> s{_plalAdvertiserIdDimensionValue = a}) - --- | Campaign ID of this placement group. This field is required on --- insertion. -plalCampaignId :: Lens' PlacementGroup (Maybe Int64) -plalCampaignId - = lens _plalCampaignId - (\ s a -> s{_plalCampaignId = a}) - . mapping _Coerce - --- | Dimension value for the ID of this placement group. This is a read-only, --- auto-generated field. -plalIdDimensionValue :: Lens' PlacementGroup (Maybe DimensionValue) -plalIdDimensionValue - = lens _plalIdDimensionValue - (\ s a -> s{_plalIdDimensionValue = a}) - --- | Type of this placement group. A package is a simple group of placements --- that acts as a single pricing point for a group of tags. A roadblock is --- a group of placements that not only acts as a single pricing point, but --- also assumes that all the tags in it will be served at the same time. A --- roadblock requires one of its assigned placements to be marked as --- primary for reporting. This field is required on insertion. -plalPlacementGroupType :: Lens' PlacementGroup (Maybe PlacementGroupPlacementGroupType) -plalPlacementGroupType - = lens _plalPlacementGroupType - (\ s a -> s{_plalPlacementGroupType = a}) - --- | ID of the content category assigned to this placement group. -plalContentCategoryId :: Lens' PlacementGroup (Maybe Int64) -plalContentCategoryId - = lens _plalContentCategoryId - (\ s a -> s{_plalContentCategoryId = a}) - . mapping _Coerce - --- | Dimension value for the ID of the directory site. This is a read-only, --- auto-generated field. -plalDirectorySiteIdDimensionValue :: Lens' PlacementGroup (Maybe DimensionValue) -plalDirectorySiteIdDimensionValue - = lens _plalDirectorySiteIdDimensionValue - (\ s a -> s{_plalDirectorySiteIdDimensionValue = a}) - --- | Account ID of this placement group. This is a read-only field that can --- be left blank. -plalAccountId :: Lens' PlacementGroup (Maybe Int64) -plalAccountId - = lens _plalAccountId - (\ s a -> s{_plalAccountId = a}) - . mapping _Coerce - --- | Name of this placement group. This is a required field and must be less --- than 256 characters long. -plalName :: Lens' PlacementGroup (Maybe Text) -plalName = lens _plalName (\ s a -> s{_plalName = a}) - --- | Directory site ID associated with this placement group. On insert, you --- must set either this field or the site_id field to specify the site --- associated with this placement group. This is a required field that is --- read-only after insertion. -plalDirectorySiteId :: Lens' PlacementGroup (Maybe Int64) -plalDirectorySiteId - = lens _plalDirectorySiteId - (\ s a -> s{_plalDirectorySiteId = a}) - . mapping _Coerce - --- | Information about the creation of this placement group. This is a --- read-only field. -plalCreateInfo :: Lens' PlacementGroup (Maybe LastModifiedInfo) -plalCreateInfo - = lens _plalCreateInfo - (\ s a -> s{_plalCreateInfo = a}) - --- | IDs of placements which are assigned to this placement group. This is a --- read-only, auto-generated field. -plalChildPlacementIds :: Lens' PlacementGroup [Int64] -plalChildPlacementIds - = lens _plalChildPlacementIds - (\ s a -> s{_plalChildPlacementIds = a}) - . _Default - . _Coerce - --- | Information about the most recent modification of this placement group. --- This is a read-only field. -plalLastModifiedInfo :: Lens' PlacementGroup (Maybe LastModifiedInfo) -plalLastModifiedInfo - = lens _plalLastModifiedInfo - (\ s a -> s{_plalLastModifiedInfo = a}) - --- | ID of this placement group. This is a read-only, auto-generated field. -plalId :: Lens' PlacementGroup (Maybe Int64) -plalId - = lens _plalId (\ s a -> s{_plalId = a}) . - mapping _Coerce - --- | ID of the primary placement, used to calculate the media cost of a --- roadblock (placement group). Modifying this field will automatically --- modify the primary field on all affected roadblock child placements. -plalPrimaryPlacementId :: Lens' PlacementGroup (Maybe Int64) -plalPrimaryPlacementId - = lens _plalPrimaryPlacementId - (\ s a -> s{_plalPrimaryPlacementId = a}) - . mapping _Coerce - --- | Subaccount ID of this placement group. This is a read-only field that --- can be left blank. -plalSubAccountId :: Lens' PlacementGroup (Maybe Int64) -plalSubAccountId - = lens _plalSubAccountId - (\ s a -> s{_plalSubAccountId = a}) - . mapping _Coerce - --- | External ID for this placement. -plalExternalId :: Lens' PlacementGroup (Maybe Text) -plalExternalId - = lens _plalExternalId - (\ s a -> s{_plalExternalId = a}) - --- | Comments for this placement group. -plalComment :: Lens' PlacementGroup (Maybe Text) -plalComment - = lens _plalComment (\ s a -> s{_plalComment = a}) - --- | Dimension value for the ID of the primary placement. This is a --- read-only, auto-generated field. -plalPrimaryPlacementIdDimensionValue :: Lens' PlacementGroup (Maybe DimensionValue) -plalPrimaryPlacementIdDimensionValue - = lens _plalPrimaryPlacementIdDimensionValue - (\ s a -> - s{_plalPrimaryPlacementIdDimensionValue = a}) - --- | Site ID associated with this placement group. On insert, you must set --- either this field or the directorySiteId field to specify the site --- associated with this placement group. This is a required field that is --- read-only after insertion. -plalSiteId :: Lens' PlacementGroup (Maybe Int64) -plalSiteId - = lens _plalSiteId (\ s a -> s{_plalSiteId = a}) . - mapping _Coerce - --- | Whether this placement group is archived. -plalArchived :: Lens' PlacementGroup (Maybe Bool) -plalArchived - = lens _plalArchived (\ s a -> s{_plalArchived = a}) - -instance FromJSON PlacementGroup where - parseJSON - = withObject "PlacementGroup" - (\ o -> - PlacementGroup' <$> - (o .:? "placementStrategyId") <*> - (o .:? "siteIdDimensionValue") - <*> (o .:? "pricingSchedule") - <*> (o .:? "kind" .!= "dfareporting#placementGroup") - <*> (o .:? "campaignIdDimensionValue") - <*> (o .:? "advertiserId") - <*> (o .:? "advertiserIdDimensionValue") - <*> (o .:? "campaignId") - <*> (o .:? "idDimensionValue") - <*> (o .:? "placementGroupType") - <*> (o .:? "contentCategoryId") - <*> (o .:? "directorySiteIdDimensionValue") - <*> (o .:? "accountId") - <*> (o .:? "name") - <*> (o .:? "directorySiteId") - <*> (o .:? "createInfo") - <*> (o .:? "childPlacementIds" .!= mempty) - <*> (o .:? "lastModifiedInfo") - <*> (o .:? "id") - <*> (o .:? "primaryPlacementId") - <*> (o .:? "subaccountId") - <*> (o .:? "externalId") - <*> (o .:? "comment") - <*> (o .:? "primaryPlacementIdDimensionValue") - <*> (o .:? "siteId") - <*> (o .:? "archived")) - -instance ToJSON PlacementGroup where - toJSON PlacementGroup'{..} - = object - (catMaybes - [("placementStrategyId" .=) <$> - _plalPlacementStrategyId, - ("siteIdDimensionValue" .=) <$> - _plalSiteIdDimensionValue, - ("pricingSchedule" .=) <$> _plalPricingSchedule, - Just ("kind" .= _plalKind), - ("campaignIdDimensionValue" .=) <$> - _plalCampaignIdDimensionValue, - ("advertiserId" .=) <$> _plalAdvertiserId, - ("advertiserIdDimensionValue" .=) <$> - _plalAdvertiserIdDimensionValue, - ("campaignId" .=) <$> _plalCampaignId, - ("idDimensionValue" .=) <$> _plalIdDimensionValue, - ("placementGroupType" .=) <$> - _plalPlacementGroupType, - ("contentCategoryId" .=) <$> _plalContentCategoryId, - ("directorySiteIdDimensionValue" .=) <$> - _plalDirectorySiteIdDimensionValue, - ("accountId" .=) <$> _plalAccountId, - ("name" .=) <$> _plalName, - ("directorySiteId" .=) <$> _plalDirectorySiteId, - ("createInfo" .=) <$> _plalCreateInfo, - ("childPlacementIds" .=) <$> _plalChildPlacementIds, - ("lastModifiedInfo" .=) <$> _plalLastModifiedInfo, - ("id" .=) <$> _plalId, - ("primaryPlacementId" .=) <$> - _plalPrimaryPlacementId, - ("subaccountId" .=) <$> _plalSubAccountId, - ("externalId" .=) <$> _plalExternalId, - ("comment" .=) <$> _plalComment, - ("primaryPlacementIdDimensionValue" .=) <$> - _plalPrimaryPlacementIdDimensionValue, - ("siteId" .=) <$> _plalSiteId, - ("archived" .=) <$> _plalArchived]) - --- | Contains properties of an event tag. --- --- /See:/ 'eventTag' smart constructor. -data EventTag = EventTag' - { _etStatus :: !(Maybe EventTagStatus) - , _etExcludeFromAdxRequests :: !(Maybe Bool) - , _etEnabledByDefault :: !(Maybe Bool) - , _etKind :: !Text - , _etCampaignIdDimensionValue :: !(Maybe DimensionValue) - , _etAdvertiserId :: !(Maybe (Textual Int64)) - , _etURL :: !(Maybe Text) - , _etAdvertiserIdDimensionValue :: !(Maybe DimensionValue) - , _etSSLCompliant :: !(Maybe Bool) - , _etCampaignId :: !(Maybe (Textual Int64)) - , _etAccountId :: !(Maybe (Textual Int64)) - , _etName :: !(Maybe Text) - , _etURLEscapeLevels :: !(Maybe (Textual Int32)) - , _etSiteIds :: !(Maybe [Textual Int64]) - , _etId :: !(Maybe (Textual Int64)) - , _etSubAccountId :: !(Maybe (Textual Int64)) - , _etType :: !(Maybe EventTagType) - , _etSiteFilterType :: !(Maybe EventTagSiteFilterType) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'EventTag' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'etStatus' --- --- * 'etExcludeFromAdxRequests' --- --- * 'etEnabledByDefault' --- --- * 'etKind' --- --- * 'etCampaignIdDimensionValue' --- --- * 'etAdvertiserId' --- --- * 'etURL' --- --- * 'etAdvertiserIdDimensionValue' --- --- * 'etSSLCompliant' --- --- * 'etCampaignId' --- --- * 'etAccountId' --- --- * 'etName' --- --- * 'etURLEscapeLevels' --- --- * 'etSiteIds' --- --- * 'etId' --- --- * 'etSubAccountId' --- --- * 'etType' --- --- * 'etSiteFilterType' -eventTag - :: EventTag -eventTag = - EventTag' - { _etStatus = Nothing - , _etExcludeFromAdxRequests = Nothing - , _etEnabledByDefault = Nothing - , _etKind = "dfareporting#eventTag" - , _etCampaignIdDimensionValue = Nothing - , _etAdvertiserId = Nothing - , _etURL = Nothing - , _etAdvertiserIdDimensionValue = Nothing - , _etSSLCompliant = Nothing - , _etCampaignId = Nothing - , _etAccountId = Nothing - , _etName = Nothing - , _etURLEscapeLevels = Nothing - , _etSiteIds = Nothing - , _etId = Nothing - , _etSubAccountId = Nothing - , _etType = Nothing - , _etSiteFilterType = Nothing - } - --- | Status of this event tag. Must be ENABLED for this event tag to fire. --- This is a required field. -etStatus :: Lens' EventTag (Maybe EventTagStatus) -etStatus = lens _etStatus (\ s a -> s{_etStatus = a}) - --- | Whether to remove this event tag from ads that are trafficked through --- Display & Video 360 to Ad Exchange. This may be useful if the event tag --- uses a pixel that is unapproved for Ad Exchange bids on one or more --- networks, such as the Google Display Network. -etExcludeFromAdxRequests :: Lens' EventTag (Maybe Bool) -etExcludeFromAdxRequests - = lens _etExcludeFromAdxRequests - (\ s a -> s{_etExcludeFromAdxRequests = a}) - --- | Whether this event tag should be automatically enabled for all of the --- advertiser\'s campaigns and ads. -etEnabledByDefault :: Lens' EventTag (Maybe Bool) -etEnabledByDefault - = lens _etEnabledByDefault - (\ s a -> s{_etEnabledByDefault = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#eventTag\". -etKind :: Lens' EventTag Text -etKind = lens _etKind (\ s a -> s{_etKind = a}) - --- | Dimension value for the ID of the campaign. This is a read-only, --- auto-generated field. -etCampaignIdDimensionValue :: Lens' EventTag (Maybe DimensionValue) -etCampaignIdDimensionValue - = lens _etCampaignIdDimensionValue - (\ s a -> s{_etCampaignIdDimensionValue = a}) - --- | Advertiser ID of this event tag. This field or the campaignId field is --- required on insertion. -etAdvertiserId :: Lens' EventTag (Maybe Int64) -etAdvertiserId - = lens _etAdvertiserId - (\ s a -> s{_etAdvertiserId = a}) - . mapping _Coerce - --- | Payload URL for this event tag. The URL on a click-through event tag --- should have a landing page URL appended to the end of it. This field is --- required on insertion. -etURL :: Lens' EventTag (Maybe Text) -etURL = lens _etURL (\ s a -> s{_etURL = a}) - --- | Dimension value for the ID of the advertiser. This is a read-only, --- auto-generated field. -etAdvertiserIdDimensionValue :: Lens' EventTag (Maybe DimensionValue) -etAdvertiserIdDimensionValue - = lens _etAdvertiserIdDimensionValue - (\ s a -> s{_etAdvertiserIdDimensionValue = a}) - --- | Whether this tag is SSL-compliant or not. This is a read-only field. -etSSLCompliant :: Lens' EventTag (Maybe Bool) -etSSLCompliant - = lens _etSSLCompliant - (\ s a -> s{_etSSLCompliant = a}) - --- | Campaign ID of this event tag. This field or the advertiserId field is --- required on insertion. -etCampaignId :: Lens' EventTag (Maybe Int64) -etCampaignId - = lens _etCampaignId (\ s a -> s{_etCampaignId = a}) - . mapping _Coerce - --- | Account ID of this event tag. This is a read-only field that can be left --- blank. -etAccountId :: Lens' EventTag (Maybe Int64) -etAccountId - = lens _etAccountId (\ s a -> s{_etAccountId = a}) . - mapping _Coerce - --- | Name of this event tag. This is a required field and must be less than --- 256 characters long. -etName :: Lens' EventTag (Maybe Text) -etName = lens _etName (\ s a -> s{_etName = a}) - --- | Number of times the landing page URL should be URL-escaped before being --- appended to the click-through event tag URL. Only applies to --- click-through event tags as specified by the event tag type. -etURLEscapeLevels :: Lens' EventTag (Maybe Int32) -etURLEscapeLevels - = lens _etURLEscapeLevels - (\ s a -> s{_etURLEscapeLevels = a}) - . mapping _Coerce - --- | Filter list of site IDs associated with this event tag. The --- siteFilterType determines whether this is a whitelist or blacklist --- filter. -etSiteIds :: Lens' EventTag [Int64] -etSiteIds - = lens _etSiteIds (\ s a -> s{_etSiteIds = a}) . - _Default - . _Coerce - --- | ID of this event tag. This is a read-only, auto-generated field. -etId :: Lens' EventTag (Maybe Int64) -etId - = lens _etId (\ s a -> s{_etId = a}) . - mapping _Coerce - --- | Subaccount ID of this event tag. This is a read-only field that can be --- left blank. -etSubAccountId :: Lens' EventTag (Maybe Int64) -etSubAccountId - = lens _etSubAccountId - (\ s a -> s{_etSubAccountId = a}) - . mapping _Coerce - --- | Event tag type. Can be used to specify whether to use a third-party --- pixel, a third-party JavaScript URL, or a third-party click-through URL --- for either impression or click tracking. This is a required field. -etType :: Lens' EventTag (Maybe EventTagType) -etType = lens _etType (\ s a -> s{_etType = a}) - --- | Site filter type for this event tag. If no type is specified then the --- event tag will be applied to all sites. -etSiteFilterType :: Lens' EventTag (Maybe EventTagSiteFilterType) -etSiteFilterType - = lens _etSiteFilterType - (\ s a -> s{_etSiteFilterType = a}) - -instance FromJSON EventTag where - parseJSON - = withObject "EventTag" - (\ o -> - EventTag' <$> - (o .:? "status") <*> (o .:? "excludeFromAdxRequests") - <*> (o .:? "enabledByDefault") - <*> (o .:? "kind" .!= "dfareporting#eventTag") - <*> (o .:? "campaignIdDimensionValue") - <*> (o .:? "advertiserId") - <*> (o .:? "url") - <*> (o .:? "advertiserIdDimensionValue") - <*> (o .:? "sslCompliant") - <*> (o .:? "campaignId") - <*> (o .:? "accountId") - <*> (o .:? "name") - <*> (o .:? "urlEscapeLevels") - <*> (o .:? "siteIds" .!= mempty) - <*> (o .:? "id") - <*> (o .:? "subaccountId") - <*> (o .:? "type") - <*> (o .:? "siteFilterType")) - -instance ToJSON EventTag where - toJSON EventTag'{..} - = object - (catMaybes - [("status" .=) <$> _etStatus, - ("excludeFromAdxRequests" .=) <$> - _etExcludeFromAdxRequests, - ("enabledByDefault" .=) <$> _etEnabledByDefault, - Just ("kind" .= _etKind), - ("campaignIdDimensionValue" .=) <$> - _etCampaignIdDimensionValue, - ("advertiserId" .=) <$> _etAdvertiserId, - ("url" .=) <$> _etURL, - ("advertiserIdDimensionValue" .=) <$> - _etAdvertiserIdDimensionValue, - ("sslCompliant" .=) <$> _etSSLCompliant, - ("campaignId" .=) <$> _etCampaignId, - ("accountId" .=) <$> _etAccountId, - ("name" .=) <$> _etName, - ("urlEscapeLevels" .=) <$> _etURLEscapeLevels, - ("siteIds" .=) <$> _etSiteIds, ("id" .=) <$> _etId, - ("subaccountId" .=) <$> _etSubAccountId, - ("type" .=) <$> _etType, - ("siteFilterType" .=) <$> _etSiteFilterType]) - --- | Contains properties of a user role permission. --- --- /See:/ 'userRolePermission' smart constructor. -data UserRolePermission = UserRolePermission' - { _useKind :: !Text - , _useAvailability :: !(Maybe UserRolePermissionAvailability) - , _useName :: !(Maybe Text) - , _useId :: !(Maybe (Textual Int64)) - , _usePermissionGroupId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'UserRolePermission' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'useKind' --- --- * 'useAvailability' --- --- * 'useName' --- --- * 'useId' --- --- * 'usePermissionGroupId' -userRolePermission - :: UserRolePermission -userRolePermission = - UserRolePermission' - { _useKind = "dfareporting#userRolePermission" - , _useAvailability = Nothing - , _useName = Nothing - , _useId = Nothing - , _usePermissionGroupId = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#userRolePermission\". -useKind :: Lens' UserRolePermission Text -useKind = lens _useKind (\ s a -> s{_useKind = a}) - --- | Levels of availability for a user role permission. -useAvailability :: Lens' UserRolePermission (Maybe UserRolePermissionAvailability) -useAvailability - = lens _useAvailability - (\ s a -> s{_useAvailability = a}) - --- | Name of this user role permission. -useName :: Lens' UserRolePermission (Maybe Text) -useName = lens _useName (\ s a -> s{_useName = a}) - --- | ID of this user role permission. -useId :: Lens' UserRolePermission (Maybe Int64) -useId - = lens _useId (\ s a -> s{_useId = a}) . - mapping _Coerce - --- | ID of the permission group that this user role permission belongs to. -usePermissionGroupId :: Lens' UserRolePermission (Maybe Int64) -usePermissionGroupId - = lens _usePermissionGroupId - (\ s a -> s{_usePermissionGroupId = a}) - . mapping _Coerce - -instance FromJSON UserRolePermission where - parseJSON - = withObject "UserRolePermission" - (\ o -> - UserRolePermission' <$> - (o .:? "kind" .!= "dfareporting#userRolePermission") - <*> (o .:? "availability") - <*> (o .:? "name") - <*> (o .:? "id") - <*> (o .:? "permissionGroupId")) - -instance ToJSON UserRolePermission where - toJSON UserRolePermission'{..} - = object - (catMaybes - [Just ("kind" .= _useKind), - ("availability" .=) <$> _useAvailability, - ("name" .=) <$> _useName, ("id" .=) <$> _useId, - ("permissionGroupId" .=) <$> _usePermissionGroupId]) - --- | Contact of an order. --- --- /See:/ 'orderContact' smart constructor. -data OrderContact = OrderContact' - { _ocSignatureUserProFileId :: !(Maybe (Textual Int64)) - , _ocContactName :: !(Maybe Text) - , _ocContactTitle :: !(Maybe Text) - , _ocContactType :: !(Maybe OrderContactContactType) - , _ocContactInfo :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'OrderContact' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'ocSignatureUserProFileId' --- --- * 'ocContactName' --- --- * 'ocContactTitle' --- --- * 'ocContactType' --- --- * 'ocContactInfo' -orderContact - :: OrderContact -orderContact = - OrderContact' - { _ocSignatureUserProFileId = Nothing - , _ocContactName = Nothing - , _ocContactTitle = Nothing - , _ocContactType = Nothing - , _ocContactInfo = Nothing - } - --- | ID of the user profile containing the signature that will be embedded --- into order documents. -ocSignatureUserProFileId :: Lens' OrderContact (Maybe Int64) -ocSignatureUserProFileId - = lens _ocSignatureUserProFileId - (\ s a -> s{_ocSignatureUserProFileId = a}) - . mapping _Coerce - --- | Name of this contact. -ocContactName :: Lens' OrderContact (Maybe Text) -ocContactName - = lens _ocContactName - (\ s a -> s{_ocContactName = a}) - --- | Title of this contact. -ocContactTitle :: Lens' OrderContact (Maybe Text) -ocContactTitle - = lens _ocContactTitle - (\ s a -> s{_ocContactTitle = a}) - --- | Type of this contact. -ocContactType :: Lens' OrderContact (Maybe OrderContactContactType) -ocContactType - = lens _ocContactType - (\ s a -> s{_ocContactType = a}) - --- | Free-form information about this contact. It could be any information --- related to this contact in addition to type, title, name, and signature --- user profile ID. -ocContactInfo :: Lens' OrderContact (Maybe Text) -ocContactInfo - = lens _ocContactInfo - (\ s a -> s{_ocContactInfo = a}) - -instance FromJSON OrderContact where - parseJSON - = withObject "OrderContact" - (\ o -> - OrderContact' <$> - (o .:? "signatureUserProfileId") <*> - (o .:? "contactName") - <*> (o .:? "contactTitle") - <*> (o .:? "contactType") - <*> (o .:? "contactInfo")) - -instance ToJSON OrderContact where - toJSON OrderContact'{..} - = object - (catMaybes - [("signatureUserProfileId" .=) <$> - _ocSignatureUserProFileId, - ("contactName" .=) <$> _ocContactName, - ("contactTitle" .=) <$> _ocContactTitle, - ("contactType" .=) <$> _ocContactType, - ("contactInfo" .=) <$> _ocContactInfo]) - --- | Transcode Settings --- --- /See:/ 'transcodeSetting' smart constructor. -data TranscodeSetting = TranscodeSetting' - { _tsKind :: !Text - , _tsEnabledVideoFormats :: !(Maybe [Textual Int32]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'TranscodeSetting' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'tsKind' --- --- * 'tsEnabledVideoFormats' -transcodeSetting - :: TranscodeSetting -transcodeSetting = - TranscodeSetting' - { _tsKind = "dfareporting#transcodeSetting" - , _tsEnabledVideoFormats = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#transcodeSetting\". -tsKind :: Lens' TranscodeSetting Text -tsKind = lens _tsKind (\ s a -> s{_tsKind = a}) - --- | Whitelist of video formats to be served to this placement. Set this list --- to null or empty to serve all video formats. -tsEnabledVideoFormats :: Lens' TranscodeSetting [Int32] -tsEnabledVideoFormats - = lens _tsEnabledVideoFormats - (\ s a -> s{_tsEnabledVideoFormats = a}) - . _Default - . _Coerce - -instance FromJSON TranscodeSetting where - parseJSON - = withObject "TranscodeSetting" - (\ o -> - TranscodeSetting' <$> - (o .:? "kind" .!= "dfareporting#transcodeSetting") - <*> (o .:? "enabledVideoFormats" .!= mempty)) - -instance ToJSON TranscodeSetting where - toJSON TranscodeSetting'{..} - = object - (catMaybes - [Just ("kind" .= _tsKind), - ("enabledVideoFormats" .=) <$> - _tsEnabledVideoFormats]) - --- | Floodlight Activity GenerateTag Response --- --- /See:/ 'floodlightActivitiesGenerateTagResponse' smart constructor. -data FloodlightActivitiesGenerateTagResponse = FloodlightActivitiesGenerateTagResponse' - { _fagtrGlobalSiteTagGlobalSnippet :: !(Maybe Text) - , _fagtrFloodlightActivityTag :: !(Maybe Text) - , _fagtrKind :: !Text - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'FloodlightActivitiesGenerateTagResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'fagtrGlobalSiteTagGlobalSnippet' --- --- * 'fagtrFloodlightActivityTag' --- --- * 'fagtrKind' -floodlightActivitiesGenerateTagResponse - :: FloodlightActivitiesGenerateTagResponse -floodlightActivitiesGenerateTagResponse = - FloodlightActivitiesGenerateTagResponse' - { _fagtrGlobalSiteTagGlobalSnippet = Nothing - , _fagtrFloodlightActivityTag = Nothing - , _fagtrKind = "dfareporting#floodlightActivitiesGenerateTagResponse" - } - --- | The global snippet section of a global site tag. The global site tag --- sets new cookies on your domain, which will store a unique identifier --- for a user or the ad click that brought the user to your site. Learn --- more. -fagtrGlobalSiteTagGlobalSnippet :: Lens' FloodlightActivitiesGenerateTagResponse (Maybe Text) -fagtrGlobalSiteTagGlobalSnippet - = lens _fagtrGlobalSiteTagGlobalSnippet - (\ s a -> s{_fagtrGlobalSiteTagGlobalSnippet = a}) - --- | Generated tag for this Floodlight activity. For global site tags, this --- is the event snippet. -fagtrFloodlightActivityTag :: Lens' FloodlightActivitiesGenerateTagResponse (Maybe Text) -fagtrFloodlightActivityTag - = lens _fagtrFloodlightActivityTag - (\ s a -> s{_fagtrFloodlightActivityTag = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#floodlightActivitiesGenerateTagResponse\". -fagtrKind :: Lens' FloodlightActivitiesGenerateTagResponse Text -fagtrKind - = lens _fagtrKind (\ s a -> s{_fagtrKind = a}) - -instance FromJSON - FloodlightActivitiesGenerateTagResponse where - parseJSON - = withObject - "FloodlightActivitiesGenerateTagResponse" - (\ o -> - FloodlightActivitiesGenerateTagResponse' <$> - (o .:? "globalSiteTagGlobalSnippet") <*> - (o .:? "floodlightActivityTag") - <*> - (o .:? "kind" .!= - "dfareporting#floodlightActivitiesGenerateTagResponse")) - -instance ToJSON - FloodlightActivitiesGenerateTagResponse where - toJSON FloodlightActivitiesGenerateTagResponse'{..} - = object - (catMaybes - [("globalSiteTagGlobalSnippet" .=) <$> - _fagtrGlobalSiteTagGlobalSnippet, - ("floodlightActivityTag" .=) <$> - _fagtrFloodlightActivityTag, - Just ("kind" .= _fagtrKind)]) - --- | Directory Site Contact Assignment --- --- /See:/ 'directorySiteContactAssignment' smart constructor. -data DirectorySiteContactAssignment = DirectorySiteContactAssignment' - { _dscaVisibility :: !(Maybe DirectorySiteContactAssignmentVisibility) - , _dscaContactId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'DirectorySiteContactAssignment' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'dscaVisibility' --- --- * 'dscaContactId' -directorySiteContactAssignment - :: DirectorySiteContactAssignment -directorySiteContactAssignment = - DirectorySiteContactAssignment' - { _dscaVisibility = Nothing - , _dscaContactId = Nothing - } - --- | Visibility of this directory site contact assignment. When set to PUBLIC --- this contact assignment is visible to all account and agency users; when --- set to PRIVATE it is visible only to the site. -dscaVisibility :: Lens' DirectorySiteContactAssignment (Maybe DirectorySiteContactAssignmentVisibility) -dscaVisibility - = lens _dscaVisibility - (\ s a -> s{_dscaVisibility = a}) - --- | ID of this directory site contact. This is a read-only, auto-generated --- field. -dscaContactId :: Lens' DirectorySiteContactAssignment (Maybe Int64) -dscaContactId - = lens _dscaContactId - (\ s a -> s{_dscaContactId = a}) - . mapping _Coerce - -instance FromJSON DirectorySiteContactAssignment - where - parseJSON - = withObject "DirectorySiteContactAssignment" - (\ o -> - DirectorySiteContactAssignment' <$> - (o .:? "visibility") <*> (o .:? "contactId")) - -instance ToJSON DirectorySiteContactAssignment where - toJSON DirectorySiteContactAssignment'{..} - = object - (catMaybes - [("visibility" .=) <$> _dscaVisibility, - ("contactId" .=) <$> _dscaContactId]) - --- | Ad Slot --- --- /See:/ 'adSlot' smart constructor. -data AdSlot = AdSlot' - { _assHeight :: !(Maybe (Textual Int64)) - , _assPaymentSourceType :: !(Maybe AdSlotPaymentSourceType) - , _assLinkedPlacementId :: !(Maybe (Textual Int64)) - , _assWidth :: !(Maybe (Textual Int64)) - , _assPrimary :: !(Maybe Bool) - , _assName :: !(Maybe Text) - , _assComment :: !(Maybe Text) - , _assCompatibility :: !(Maybe AdSlotCompatibility) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'AdSlot' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'assHeight' --- --- * 'assPaymentSourceType' --- --- * 'assLinkedPlacementId' --- --- * 'assWidth' --- --- * 'assPrimary' --- --- * 'assName' --- --- * 'assComment' --- --- * 'assCompatibility' -adSlot - :: AdSlot -adSlot = - AdSlot' - { _assHeight = Nothing - , _assPaymentSourceType = Nothing - , _assLinkedPlacementId = Nothing - , _assWidth = Nothing - , _assPrimary = Nothing - , _assName = Nothing - , _assComment = Nothing - , _assCompatibility = Nothing - } - --- | Height of this ad slot. -assHeight :: Lens' AdSlot (Maybe Int64) -assHeight - = lens _assHeight (\ s a -> s{_assHeight = a}) . - mapping _Coerce - --- | Payment source type of this ad slot. -assPaymentSourceType :: Lens' AdSlot (Maybe AdSlotPaymentSourceType) -assPaymentSourceType - = lens _assPaymentSourceType - (\ s a -> s{_assPaymentSourceType = a}) - --- | ID of the placement from an external platform that is linked to this ad --- slot. -assLinkedPlacementId :: Lens' AdSlot (Maybe Int64) -assLinkedPlacementId - = lens _assLinkedPlacementId - (\ s a -> s{_assLinkedPlacementId = a}) - . mapping _Coerce - --- | Width of this ad slot. -assWidth :: Lens' AdSlot (Maybe Int64) -assWidth - = lens _assWidth (\ s a -> s{_assWidth = a}) . - mapping _Coerce - --- | Primary ad slot of a roadblock inventory item. -assPrimary :: Lens' AdSlot (Maybe Bool) -assPrimary - = lens _assPrimary (\ s a -> s{_assPrimary = a}) - --- | Name of this ad slot. -assName :: Lens' AdSlot (Maybe Text) -assName = lens _assName (\ s a -> s{_assName = a}) - --- | Comment for this ad slot. -assComment :: Lens' AdSlot (Maybe Text) -assComment - = lens _assComment (\ s a -> s{_assComment = a}) - --- | Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to --- rendering either on desktop, mobile devices or in mobile apps for --- regular or interstitial ads respectively. APP and APP_INTERSTITIAL are --- for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in --- in-stream video ads developed with the VAST standard. -assCompatibility :: Lens' AdSlot (Maybe AdSlotCompatibility) -assCompatibility - = lens _assCompatibility - (\ s a -> s{_assCompatibility = a}) - -instance FromJSON AdSlot where - parseJSON - = withObject "AdSlot" - (\ o -> - AdSlot' <$> - (o .:? "height") <*> (o .:? "paymentSourceType") <*> - (o .:? "linkedPlacementId") - <*> (o .:? "width") - <*> (o .:? "primary") - <*> (o .:? "name") - <*> (o .:? "comment") - <*> (o .:? "compatibility")) - -instance ToJSON AdSlot where - toJSON AdSlot'{..} - = object - (catMaybes - [("height" .=) <$> _assHeight, - ("paymentSourceType" .=) <$> _assPaymentSourceType, - ("linkedPlacementId" .=) <$> _assLinkedPlacementId, - ("width" .=) <$> _assWidth, - ("primary" .=) <$> _assPrimary, - ("name" .=) <$> _assName, - ("comment" .=) <$> _assComment, - ("compatibility" .=) <$> _assCompatibility]) - --- | Third-party Tracking URL. --- --- /See:/ 'thirdPartyTrackingURL' smart constructor. -data ThirdPartyTrackingURL = ThirdPartyTrackingURL' - { _tptuURL :: !(Maybe Text) - , _tptuThirdPartyURLType :: !(Maybe ThirdPartyTrackingURLThirdPartyURLType) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'ThirdPartyTrackingURL' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'tptuURL' --- --- * 'tptuThirdPartyURLType' -thirdPartyTrackingURL - :: ThirdPartyTrackingURL -thirdPartyTrackingURL = - ThirdPartyTrackingURL' - { _tptuURL = Nothing - , _tptuThirdPartyURLType = Nothing - } - --- | URL for the specified third-party URL type. -tptuURL :: Lens' ThirdPartyTrackingURL (Maybe Text) -tptuURL = lens _tptuURL (\ s a -> s{_tptuURL = a}) - --- | Third-party URL type for in-stream video and in-stream audio creatives. -tptuThirdPartyURLType :: Lens' ThirdPartyTrackingURL (Maybe ThirdPartyTrackingURLThirdPartyURLType) -tptuThirdPartyURLType - = lens _tptuThirdPartyURLType - (\ s a -> s{_tptuThirdPartyURLType = a}) - -instance FromJSON ThirdPartyTrackingURL where - parseJSON - = withObject "ThirdPartyTrackingURL" - (\ o -> - ThirdPartyTrackingURL' <$> - (o .:? "url") <*> (o .:? "thirdPartyUrlType")) - -instance ToJSON ThirdPartyTrackingURL where - toJSON ThirdPartyTrackingURL'{..} - = object - (catMaybes - [("url" .=) <$> _tptuURL, - ("thirdPartyUrlType" .=) <$> _tptuThirdPartyURLType]) - --- | Contains properties of a Planning order document. --- --- /See:/ 'orderDocument' smart constructor. -data OrderDocument = OrderDocument' - { _odSigned :: !(Maybe Bool) - , _odKind :: !Text - , _odAdvertiserId :: !(Maybe (Textual Int64)) - , _odLastSentTime :: !(Maybe DateTime') - , _odAmendedOrderDocumentId :: !(Maybe (Textual Int64)) - , _odLastSentRecipients :: !(Maybe [Text]) - , _odEffectiveDate :: !(Maybe Date') - , _odApprovedByUserProFileIds :: !(Maybe [Textual Int64]) - , _odAccountId :: !(Maybe (Textual Int64)) - , _odId :: !(Maybe (Textual Int64)) - , _odProjectId :: !(Maybe (Textual Int64)) - , _odTitle :: !(Maybe Text) - , _odSubAccountId :: !(Maybe (Textual Int64)) - , _odType :: !(Maybe OrderDocumentType) - , _odOrderId :: !(Maybe (Textual Int64)) - , _odCancelled :: !(Maybe Bool) - , _odCreatedInfo :: !(Maybe LastModifiedInfo) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'OrderDocument' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'odSigned' --- --- * 'odKind' --- --- * 'odAdvertiserId' --- --- * 'odLastSentTime' --- --- * 'odAmendedOrderDocumentId' --- --- * 'odLastSentRecipients' --- --- * 'odEffectiveDate' --- --- * 'odApprovedByUserProFileIds' --- --- * 'odAccountId' --- --- * 'odId' --- --- * 'odProjectId' --- --- * 'odTitle' --- --- * 'odSubAccountId' --- --- * 'odType' --- --- * 'odOrderId' --- --- * 'odCancelled' --- --- * 'odCreatedInfo' -orderDocument - :: OrderDocument -orderDocument = - OrderDocument' - { _odSigned = Nothing - , _odKind = "dfareporting#orderDocument" - , _odAdvertiserId = Nothing - , _odLastSentTime = Nothing - , _odAmendedOrderDocumentId = Nothing - , _odLastSentRecipients = Nothing - , _odEffectiveDate = Nothing - , _odApprovedByUserProFileIds = Nothing - , _odAccountId = Nothing - , _odId = Nothing - , _odProjectId = Nothing - , _odTitle = Nothing - , _odSubAccountId = Nothing - , _odType = Nothing - , _odOrderId = Nothing - , _odCancelled = Nothing - , _odCreatedInfo = Nothing - } - --- | Whether this order document has been signed. -odSigned :: Lens' OrderDocument (Maybe Bool) -odSigned = lens _odSigned (\ s a -> s{_odSigned = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#orderDocument\". -odKind :: Lens' OrderDocument Text -odKind = lens _odKind (\ s a -> s{_odKind = a}) - --- | Advertiser ID of this order document. -odAdvertiserId :: Lens' OrderDocument (Maybe Int64) -odAdvertiserId - = lens _odAdvertiserId - (\ s a -> s{_odAdvertiserId = a}) - . mapping _Coerce - --- | Timestamp of the last email sent with this order document. -odLastSentTime :: Lens' OrderDocument (Maybe UTCTime) -odLastSentTime - = lens _odLastSentTime - (\ s a -> s{_odLastSentTime = a}) - . mapping _DateTime - --- | The amended order document ID of this order document. An order document --- can be created by optionally amending another order document so that the --- change history can be preserved. -odAmendedOrderDocumentId :: Lens' OrderDocument (Maybe Int64) -odAmendedOrderDocumentId - = lens _odAmendedOrderDocumentId - (\ s a -> s{_odAmendedOrderDocumentId = a}) - . mapping _Coerce - --- | List of email addresses that received the last sent document. -odLastSentRecipients :: Lens' OrderDocument [Text] -odLastSentRecipients - = lens _odLastSentRecipients - (\ s a -> s{_odLastSentRecipients = a}) - . _Default - . _Coerce - --- | Effective date of this order document. -odEffectiveDate :: Lens' OrderDocument (Maybe Day) -odEffectiveDate - = lens _odEffectiveDate - (\ s a -> s{_odEffectiveDate = a}) - . mapping _Date - --- | IDs of users who have approved this order document. -odApprovedByUserProFileIds :: Lens' OrderDocument [Int64] -odApprovedByUserProFileIds - = lens _odApprovedByUserProFileIds - (\ s a -> s{_odApprovedByUserProFileIds = a}) - . _Default - . _Coerce - --- | Account ID of this order document. -odAccountId :: Lens' OrderDocument (Maybe Int64) -odAccountId - = lens _odAccountId (\ s a -> s{_odAccountId = a}) . - mapping _Coerce - --- | ID of this order document. -odId :: Lens' OrderDocument (Maybe Int64) -odId - = lens _odId (\ s a -> s{_odId = a}) . - mapping _Coerce - --- | Project ID of this order document. -odProjectId :: Lens' OrderDocument (Maybe Int64) -odProjectId - = lens _odProjectId (\ s a -> s{_odProjectId = a}) . - mapping _Coerce - --- | Title of this order document. -odTitle :: Lens' OrderDocument (Maybe Text) -odTitle = lens _odTitle (\ s a -> s{_odTitle = a}) - --- | Subaccount ID of this order document. -odSubAccountId :: Lens' OrderDocument (Maybe Int64) -odSubAccountId - = lens _odSubAccountId - (\ s a -> s{_odSubAccountId = a}) - . mapping _Coerce - --- | Type of this order document -odType :: Lens' OrderDocument (Maybe OrderDocumentType) -odType = lens _odType (\ s a -> s{_odType = a}) - --- | ID of the order from which this order document is created. -odOrderId :: Lens' OrderDocument (Maybe Int64) -odOrderId - = lens _odOrderId (\ s a -> s{_odOrderId = a}) . - mapping _Coerce - --- | Whether this order document is cancelled. -odCancelled :: Lens' OrderDocument (Maybe Bool) -odCancelled - = lens _odCancelled (\ s a -> s{_odCancelled = a}) - --- | Information about the creation of this order document. -odCreatedInfo :: Lens' OrderDocument (Maybe LastModifiedInfo) -odCreatedInfo - = lens _odCreatedInfo - (\ s a -> s{_odCreatedInfo = a}) - -instance FromJSON OrderDocument where - parseJSON - = withObject "OrderDocument" - (\ o -> - OrderDocument' <$> - (o .:? "signed") <*> - (o .:? "kind" .!= "dfareporting#orderDocument") - <*> (o .:? "advertiserId") - <*> (o .:? "lastSentTime") - <*> (o .:? "amendedOrderDocumentId") - <*> (o .:? "lastSentRecipients" .!= mempty) - <*> (o .:? "effectiveDate") - <*> (o .:? "approvedByUserProfileIds" .!= mempty) - <*> (o .:? "accountId") - <*> (o .:? "id") - <*> (o .:? "projectId") - <*> (o .:? "title") - <*> (o .:? "subaccountId") - <*> (o .:? "type") - <*> (o .:? "orderId") - <*> (o .:? "cancelled") - <*> (o .:? "createdInfo")) - -instance ToJSON OrderDocument where - toJSON OrderDocument'{..} - = object - (catMaybes - [("signed" .=) <$> _odSigned, - Just ("kind" .= _odKind), - ("advertiserId" .=) <$> _odAdvertiserId, - ("lastSentTime" .=) <$> _odLastSentTime, - ("amendedOrderDocumentId" .=) <$> - _odAmendedOrderDocumentId, - ("lastSentRecipients" .=) <$> _odLastSentRecipients, - ("effectiveDate" .=) <$> _odEffectiveDate, - ("approvedByUserProfileIds" .=) <$> - _odApprovedByUserProFileIds, - ("accountId" .=) <$> _odAccountId, - ("id" .=) <$> _odId, - ("projectId" .=) <$> _odProjectId, - ("title" .=) <$> _odTitle, - ("subaccountId" .=) <$> _odSubAccountId, - ("type" .=) <$> _odType, - ("orderId" .=) <$> _odOrderId, - ("cancelled" .=) <$> _odCancelled, - ("createdInfo" .=) <$> _odCreatedInfo]) - --- | Contains information about a metro region that can be targeted by ads. --- --- /See:/ 'metro' smart constructor. -data Metro = Metro' - { _metMetroCode :: !(Maybe Text) - , _metKind :: !Text - , _metName :: !(Maybe Text) - , _metCountryCode :: !(Maybe Text) - , _metDmaId :: !(Maybe (Textual Int64)) - , _metCountryDartId :: !(Maybe (Textual Int64)) - , _metDartId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'Metro' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'metMetroCode' --- --- * 'metKind' --- --- * 'metName' --- --- * 'metCountryCode' --- --- * 'metDmaId' --- --- * 'metCountryDartId' --- --- * 'metDartId' -metro - :: Metro -metro = - Metro' - { _metMetroCode = Nothing - , _metKind = "dfareporting#metro" - , _metName = Nothing - , _metCountryCode = Nothing - , _metDmaId = Nothing - , _metCountryDartId = Nothing - , _metDartId = Nothing - } - --- | Metro code of this metro region. This is equivalent to dma_id. -metMetroCode :: Lens' Metro (Maybe Text) -metMetroCode - = lens _metMetroCode (\ s a -> s{_metMetroCode = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#metro\". -metKind :: Lens' Metro Text -metKind = lens _metKind (\ s a -> s{_metKind = a}) - --- | Name of this metro region. -metName :: Lens' Metro (Maybe Text) -metName = lens _metName (\ s a -> s{_metName = a}) - --- | Country code of the country to which this metro region belongs. -metCountryCode :: Lens' Metro (Maybe Text) -metCountryCode - = lens _metCountryCode - (\ s a -> s{_metCountryCode = a}) - --- | DMA ID of this metro region. This is the ID used for targeting and --- generating reports, and is equivalent to metro_code. -metDmaId :: Lens' Metro (Maybe Int64) -metDmaId - = lens _metDmaId (\ s a -> s{_metDmaId = a}) . - mapping _Coerce - --- | DART ID of the country to which this metro region belongs. -metCountryDartId :: Lens' Metro (Maybe Int64) -metCountryDartId - = lens _metCountryDartId - (\ s a -> s{_metCountryDartId = a}) - . mapping _Coerce - --- | DART ID of this metro region. -metDartId :: Lens' Metro (Maybe Int64) -metDartId - = lens _metDartId (\ s a -> s{_metDartId = a}) . - mapping _Coerce - -instance FromJSON Metro where - parseJSON - = withObject "Metro" - (\ o -> - Metro' <$> - (o .:? "metroCode") <*> - (o .:? "kind" .!= "dfareporting#metro") - <*> (o .:? "name") - <*> (o .:? "countryCode") - <*> (o .:? "dmaId") - <*> (o .:? "countryDartId") - <*> (o .:? "dartId")) - -instance ToJSON Metro where - toJSON Metro'{..} - = object - (catMaybes - [("metroCode" .=) <$> _metMetroCode, - Just ("kind" .= _metKind), ("name" .=) <$> _metName, - ("countryCode" .=) <$> _metCountryCode, - ("dmaId" .=) <$> _metDmaId, - ("countryDartId" .=) <$> _metCountryDartId, - ("dartId" .=) <$> _metDartId]) - --- | Contains information about a mobile app. Used as a landing page deep --- link. --- --- /See:/ 'mobileApp' smart constructor. -data MobileApp = MobileApp' - { _maKind :: !Text - , _maId :: !(Maybe Text) - , _maTitle :: !(Maybe Text) - , _maPublisherName :: !(Maybe Text) - , _maDirectory :: !(Maybe MobileAppDirectory) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'MobileApp' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'maKind' --- --- * 'maId' --- --- * 'maTitle' --- --- * 'maPublisherName' --- --- * 'maDirectory' -mobileApp - :: MobileApp -mobileApp = - MobileApp' - { _maKind = "dfareporting#mobileApp" - , _maId = Nothing - , _maTitle = Nothing - , _maPublisherName = Nothing - , _maDirectory = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#mobileApp\". -maKind :: Lens' MobileApp Text -maKind = lens _maKind (\ s a -> s{_maKind = a}) - --- | ID of this mobile app. -maId :: Lens' MobileApp (Maybe Text) -maId = lens _maId (\ s a -> s{_maId = a}) - --- | Title of this mobile app. -maTitle :: Lens' MobileApp (Maybe Text) -maTitle = lens _maTitle (\ s a -> s{_maTitle = a}) - --- | Publisher name. -maPublisherName :: Lens' MobileApp (Maybe Text) -maPublisherName - = lens _maPublisherName - (\ s a -> s{_maPublisherName = a}) - --- | Mobile app directory. -maDirectory :: Lens' MobileApp (Maybe MobileAppDirectory) -maDirectory - = lens _maDirectory (\ s a -> s{_maDirectory = a}) - -instance FromJSON MobileApp where - parseJSON - = withObject "MobileApp" - (\ o -> - MobileApp' <$> - (o .:? "kind" .!= "dfareporting#mobileApp") <*> - (o .:? "id") - <*> (o .:? "title") - <*> (o .:? "publisherName") - <*> (o .:? "directory")) - -instance ToJSON MobileApp where - toJSON MobileApp'{..} - = object - (catMaybes - [Just ("kind" .= _maKind), ("id" .=) <$> _maId, - ("title" .=) <$> _maTitle, - ("publisherName" .=) <$> _maPublisherName, - ("directory" .=) <$> _maDirectory]) - --- | Contains properties of a placement. --- --- /See:/ 'placement' smart constructor. -data Placement = Placement' - { _p1Status :: !(Maybe PlacementStatus) - , _p1VideoSettings :: !(Maybe VideoSettings) - , _p1PlacementStrategyId :: !(Maybe (Textual Int64)) - , _p1TagFormats :: !(Maybe [PlacementTagFormatsItem]) - , _p1SiteIdDimensionValue :: !(Maybe DimensionValue) - , _p1PricingSchedule :: !(Maybe PricingSchedule) - , _p1Size :: !(Maybe Size) - , _p1Kind :: !Text - , _p1KeyName :: !(Maybe Text) - , _p1CampaignIdDimensionValue :: !(Maybe DimensionValue) - , _p1AdvertiserId :: !(Maybe (Textual Int64)) - , _p1AdvertiserIdDimensionValue :: !(Maybe DimensionValue) - , _p1CampaignId :: !(Maybe (Textual Int64)) - , _p1IdDimensionValue :: !(Maybe DimensionValue) - , _p1VpaidAdapterChoice :: !(Maybe PlacementVpaidAdapterChoice) - , _p1AdBlockingOptOut :: !(Maybe Bool) - , _p1Primary :: !(Maybe Bool) - , _p1LookbackConfiguration :: !(Maybe LookbackConfiguration) - , _p1TagSetting :: !(Maybe TagSetting) - , _p1ContentCategoryId :: !(Maybe (Textual Int64)) - , _p1DirectorySiteIdDimensionValue :: !(Maybe DimensionValue) - , _p1AccountId :: !(Maybe (Textual Int64)) - , _p1PaymentSource :: !(Maybe PlacementPaymentSource) - , _p1Name :: !(Maybe Text) - , _p1AdditionalSizes :: !(Maybe [Size]) - , _p1DirectorySiteId :: !(Maybe (Textual Int64)) - , _p1CreateInfo :: !(Maybe LastModifiedInfo) - , _p1VideoActiveViewOptOut :: !(Maybe Bool) - , _p1LastModifiedInfo :: !(Maybe LastModifiedInfo) - , _p1Id :: !(Maybe (Textual Int64)) - , _p1SSLRequired :: !(Maybe Bool) - , _p1SubAccountId :: !(Maybe (Textual Int64)) - , _p1PlacementGroupIdDimensionValue :: !(Maybe DimensionValue) - , _p1ExternalId :: !(Maybe Text) - , _p1PlacementGroupId :: !(Maybe (Textual Int64)) - , _p1Comment :: !(Maybe Text) - , _p1SiteId :: !(Maybe (Textual Int64)) - , _p1Compatibility :: !(Maybe PlacementCompatibility) - , _p1Archived :: !(Maybe Bool) - , _p1PaymentApproved :: !(Maybe Bool) - , _p1PublisherUpdateInfo :: !(Maybe LastModifiedInfo) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'Placement' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'p1Status' --- --- * 'p1VideoSettings' --- --- * 'p1PlacementStrategyId' --- --- * 'p1TagFormats' --- --- * 'p1SiteIdDimensionValue' --- --- * 'p1PricingSchedule' --- --- * 'p1Size' --- --- * 'p1Kind' --- --- * 'p1KeyName' --- --- * 'p1CampaignIdDimensionValue' --- --- * 'p1AdvertiserId' --- --- * 'p1AdvertiserIdDimensionValue' --- --- * 'p1CampaignId' --- --- * 'p1IdDimensionValue' --- --- * 'p1VpaidAdapterChoice' --- --- * 'p1AdBlockingOptOut' --- --- * 'p1Primary' --- --- * 'p1LookbackConfiguration' --- --- * 'p1TagSetting' --- --- * 'p1ContentCategoryId' --- --- * 'p1DirectorySiteIdDimensionValue' --- --- * 'p1AccountId' --- --- * 'p1PaymentSource' --- --- * 'p1Name' --- --- * 'p1AdditionalSizes' --- --- * 'p1DirectorySiteId' --- --- * 'p1CreateInfo' --- --- * 'p1VideoActiveViewOptOut' --- --- * 'p1LastModifiedInfo' --- --- * 'p1Id' --- --- * 'p1SSLRequired' --- --- * 'p1SubAccountId' --- --- * 'p1PlacementGroupIdDimensionValue' --- --- * 'p1ExternalId' --- --- * 'p1PlacementGroupId' --- --- * 'p1Comment' --- --- * 'p1SiteId' --- --- * 'p1Compatibility' --- --- * 'p1Archived' --- --- * 'p1PaymentApproved' --- --- * 'p1PublisherUpdateInfo' -placement - :: Placement -placement = - Placement' - { _p1Status = Nothing - , _p1VideoSettings = Nothing - , _p1PlacementStrategyId = Nothing - , _p1TagFormats = Nothing - , _p1SiteIdDimensionValue = Nothing - , _p1PricingSchedule = Nothing - , _p1Size = Nothing - , _p1Kind = "dfareporting#placement" - , _p1KeyName = Nothing - , _p1CampaignIdDimensionValue = Nothing - , _p1AdvertiserId = Nothing - , _p1AdvertiserIdDimensionValue = Nothing - , _p1CampaignId = Nothing - , _p1IdDimensionValue = Nothing - , _p1VpaidAdapterChoice = Nothing - , _p1AdBlockingOptOut = Nothing - , _p1Primary = Nothing - , _p1LookbackConfiguration = Nothing - , _p1TagSetting = Nothing - , _p1ContentCategoryId = Nothing - , _p1DirectorySiteIdDimensionValue = Nothing - , _p1AccountId = Nothing - , _p1PaymentSource = Nothing - , _p1Name = Nothing - , _p1AdditionalSizes = Nothing - , _p1DirectorySiteId = Nothing - , _p1CreateInfo = Nothing - , _p1VideoActiveViewOptOut = Nothing - , _p1LastModifiedInfo = Nothing - , _p1Id = Nothing - , _p1SSLRequired = Nothing - , _p1SubAccountId = Nothing - , _p1PlacementGroupIdDimensionValue = Nothing - , _p1ExternalId = Nothing - , _p1PlacementGroupId = Nothing - , _p1Comment = Nothing - , _p1SiteId = Nothing - , _p1Compatibility = Nothing - , _p1Archived = Nothing - , _p1PaymentApproved = Nothing - , _p1PublisherUpdateInfo = Nothing - } - --- | Third-party placement status. -p1Status :: Lens' Placement (Maybe PlacementStatus) -p1Status = lens _p1Status (\ s a -> s{_p1Status = a}) - --- | A collection of settings which affect video creatives served through --- this placement. Applicable to placements with IN_STREAM_VIDEO --- compatibility. -p1VideoSettings :: Lens' Placement (Maybe VideoSettings) -p1VideoSettings - = lens _p1VideoSettings - (\ s a -> s{_p1VideoSettings = a}) - --- | ID of the placement strategy assigned to this placement. -p1PlacementStrategyId :: Lens' Placement (Maybe Int64) -p1PlacementStrategyId - = lens _p1PlacementStrategyId - (\ s a -> s{_p1PlacementStrategyId = a}) - . mapping _Coerce - --- | Tag formats to generate for this placement. This field is required on --- insertion. Acceptable values are: - \"PLACEMENT_TAG_STANDARD\" - --- \"PLACEMENT_TAG_IFRAME_JAVASCRIPT\" - \"PLACEMENT_TAG_IFRAME_ILAYER\" - --- \"PLACEMENT_TAG_INTERNAL_REDIRECT\" - \"PLACEMENT_TAG_JAVASCRIPT\" - --- \"PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT\" - --- \"PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT\" - --- \"PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT\" - --- \"PLACEMENT_TAG_CLICK_COMMANDS\" - --- \"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH\" - --- \"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3\" - --- \"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4\" - --- \"PLACEMENT_TAG_TRACKING\" - \"PLACEMENT_TAG_TRACKING_IFRAME\" - --- \"PLACEMENT_TAG_TRACKING_JAVASCRIPT\" -p1TagFormats :: Lens' Placement [PlacementTagFormatsItem] -p1TagFormats - = lens _p1TagFormats (\ s a -> s{_p1TagFormats = a}) - . _Default - . _Coerce - --- | Dimension value for the ID of the site. This is a read-only, --- auto-generated field. -p1SiteIdDimensionValue :: Lens' Placement (Maybe DimensionValue) -p1SiteIdDimensionValue - = lens _p1SiteIdDimensionValue - (\ s a -> s{_p1SiteIdDimensionValue = a}) - --- | Pricing schedule of this placement. This field is required on insertion, --- specifically subfields startDate, endDate and pricingType. -p1PricingSchedule :: Lens' Placement (Maybe PricingSchedule) -p1PricingSchedule - = lens _p1PricingSchedule - (\ s a -> s{_p1PricingSchedule = a}) - --- | Size associated with this placement. When inserting or updating a --- placement, only the size ID field is used. This field is required on --- insertion. -p1Size :: Lens' Placement (Maybe Size) -p1Size = lens _p1Size (\ s a -> s{_p1Size = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#placement\". -p1Kind :: Lens' Placement Text -p1Kind = lens _p1Kind (\ s a -> s{_p1Kind = a}) - --- | Key name of this placement. This is a read-only, auto-generated field. -p1KeyName :: Lens' Placement (Maybe Text) -p1KeyName - = lens _p1KeyName (\ s a -> s{_p1KeyName = a}) - --- | Dimension value for the ID of the campaign. This is a read-only, --- auto-generated field. -p1CampaignIdDimensionValue :: Lens' Placement (Maybe DimensionValue) -p1CampaignIdDimensionValue - = lens _p1CampaignIdDimensionValue - (\ s a -> s{_p1CampaignIdDimensionValue = a}) - --- | Advertiser ID of this placement. This field can be left blank. -p1AdvertiserId :: Lens' Placement (Maybe Int64) -p1AdvertiserId - = lens _p1AdvertiserId - (\ s a -> s{_p1AdvertiserId = a}) - . mapping _Coerce - --- | Dimension value for the ID of the advertiser. This is a read-only, --- auto-generated field. -p1AdvertiserIdDimensionValue :: Lens' Placement (Maybe DimensionValue) -p1AdvertiserIdDimensionValue - = lens _p1AdvertiserIdDimensionValue - (\ s a -> s{_p1AdvertiserIdDimensionValue = a}) - --- | Campaign ID of this placement. This field is a required field on --- insertion. -p1CampaignId :: Lens' Placement (Maybe Int64) -p1CampaignId - = lens _p1CampaignId (\ s a -> s{_p1CampaignId = a}) - . mapping _Coerce - --- | Dimension value for the ID of this placement. This is a read-only, --- auto-generated field. -p1IdDimensionValue :: Lens' Placement (Maybe DimensionValue) -p1IdDimensionValue - = lens _p1IdDimensionValue - (\ s a -> s{_p1IdDimensionValue = a}) - --- | VPAID adapter setting for this placement. Controls which VPAID format --- the measurement adapter will use for in-stream video creatives assigned --- to this placement. Note: Flash is no longer supported. This field now --- defaults to HTML5 when the following values are provided: FLASH, BOTH. -p1VpaidAdapterChoice :: Lens' Placement (Maybe PlacementVpaidAdapterChoice) -p1VpaidAdapterChoice - = lens _p1VpaidAdapterChoice - (\ s a -> s{_p1VpaidAdapterChoice = a}) - --- | Whether this placement opts out of ad blocking. When true, ad blocking --- is disabled for this placement. When false, the campaign and site --- settings take effect. -p1AdBlockingOptOut :: Lens' Placement (Maybe Bool) -p1AdBlockingOptOut - = lens _p1AdBlockingOptOut - (\ s a -> s{_p1AdBlockingOptOut = a}) - --- | Whether this placement is the primary placement of a roadblock --- (placement group). You cannot change this field from true to false. --- Setting this field to true will automatically set the primary field on --- the original primary placement of the roadblock to false, and it will --- automatically set the roadblock\'s primaryPlacementId field to the ID of --- this placement. -p1Primary :: Lens' Placement (Maybe Bool) -p1Primary - = lens _p1Primary (\ s a -> s{_p1Primary = a}) - --- | Lookback window settings for this placement. -p1LookbackConfiguration :: Lens' Placement (Maybe LookbackConfiguration) -p1LookbackConfiguration - = lens _p1LookbackConfiguration - (\ s a -> s{_p1LookbackConfiguration = a}) - --- | Tag settings for this placement. -p1TagSetting :: Lens' Placement (Maybe TagSetting) -p1TagSetting - = lens _p1TagSetting (\ s a -> s{_p1TagSetting = a}) - --- | ID of the content category assigned to this placement. -p1ContentCategoryId :: Lens' Placement (Maybe Int64) -p1ContentCategoryId - = lens _p1ContentCategoryId - (\ s a -> s{_p1ContentCategoryId = a}) - . mapping _Coerce - --- | Dimension value for the ID of the directory site. This is a read-only, --- auto-generated field. -p1DirectorySiteIdDimensionValue :: Lens' Placement (Maybe DimensionValue) -p1DirectorySiteIdDimensionValue - = lens _p1DirectorySiteIdDimensionValue - (\ s a -> s{_p1DirectorySiteIdDimensionValue = a}) - --- | Account ID of this placement. This field can be left blank. -p1AccountId :: Lens' Placement (Maybe Int64) -p1AccountId - = lens _p1AccountId (\ s a -> s{_p1AccountId = a}) . - mapping _Coerce - --- | Payment source for this placement. This is a required field that is --- read-only after insertion. -p1PaymentSource :: Lens' Placement (Maybe PlacementPaymentSource) -p1PaymentSource - = lens _p1PaymentSource - (\ s a -> s{_p1PaymentSource = a}) - --- | Name of this placement.This is a required field and must be less than --- 256 characters long. -p1Name :: Lens' Placement (Maybe Text) -p1Name = lens _p1Name (\ s a -> s{_p1Name = a}) - --- | Additional sizes associated with this placement. When inserting or --- updating a placement, only the size ID field is used. -p1AdditionalSizes :: Lens' Placement [Size] -p1AdditionalSizes - = lens _p1AdditionalSizes - (\ s a -> s{_p1AdditionalSizes = a}) - . _Default - . _Coerce - --- | Directory site ID of this placement. On insert, you must set either this --- field or the siteId field to specify the site associated with this --- placement. This is a required field that is read-only after insertion. -p1DirectorySiteId :: Lens' Placement (Maybe Int64) -p1DirectorySiteId - = lens _p1DirectorySiteId - (\ s a -> s{_p1DirectorySiteId = a}) - . mapping _Coerce - --- | Information about the creation of this placement. This is a read-only --- field. -p1CreateInfo :: Lens' Placement (Maybe LastModifiedInfo) -p1CreateInfo - = lens _p1CreateInfo (\ s a -> s{_p1CreateInfo = a}) - --- | Whether Verification and ActiveView are disabled for in-stream video --- creatives for this placement. The same setting videoActiveViewOptOut --- exists on the site level -- the opt out occurs if either of these --- settings are true. These settings are distinct from --- DirectorySites.settings.activeViewOptOut or --- Sites.siteSettings.activeViewOptOut which only apply to display ads. --- However, Accounts.activeViewOptOut opts out both video traffic, as well --- as display ads, from Verification and ActiveView. -p1VideoActiveViewOptOut :: Lens' Placement (Maybe Bool) -p1VideoActiveViewOptOut - = lens _p1VideoActiveViewOptOut - (\ s a -> s{_p1VideoActiveViewOptOut = a}) - --- | Information about the most recent modification of this placement. This --- is a read-only field. -p1LastModifiedInfo :: Lens' Placement (Maybe LastModifiedInfo) -p1LastModifiedInfo - = lens _p1LastModifiedInfo - (\ s a -> s{_p1LastModifiedInfo = a}) - --- | ID of this placement. This is a read-only, auto-generated field. -p1Id :: Lens' Placement (Maybe Int64) -p1Id - = lens _p1Id (\ s a -> s{_p1Id = a}) . - mapping _Coerce - --- | Whether creatives assigned to this placement must be SSL-compliant. -p1SSLRequired :: Lens' Placement (Maybe Bool) -p1SSLRequired - = lens _p1SSLRequired - (\ s a -> s{_p1SSLRequired = a}) - --- | Subaccount ID of this placement. This field can be left blank. -p1SubAccountId :: Lens' Placement (Maybe Int64) -p1SubAccountId - = lens _p1SubAccountId - (\ s a -> s{_p1SubAccountId = a}) - . mapping _Coerce - --- | Dimension value for the ID of the placement group. This is a read-only, --- auto-generated field. -p1PlacementGroupIdDimensionValue :: Lens' Placement (Maybe DimensionValue) -p1PlacementGroupIdDimensionValue - = lens _p1PlacementGroupIdDimensionValue - (\ s a -> s{_p1PlacementGroupIdDimensionValue = a}) - --- | External ID for this placement. -p1ExternalId :: Lens' Placement (Maybe Text) -p1ExternalId - = lens _p1ExternalId (\ s a -> s{_p1ExternalId = a}) - --- | ID of this placement\'s group, if applicable. -p1PlacementGroupId :: Lens' Placement (Maybe Int64) -p1PlacementGroupId - = lens _p1PlacementGroupId - (\ s a -> s{_p1PlacementGroupId = a}) - . mapping _Coerce - --- | Comments for this placement. -p1Comment :: Lens' Placement (Maybe Text) -p1Comment - = lens _p1Comment (\ s a -> s{_p1Comment = a}) - --- | Site ID associated with this placement. On insert, you must set either --- this field or the directorySiteId field to specify the site associated --- with this placement. This is a required field that is read-only after --- insertion. -p1SiteId :: Lens' Placement (Maybe Int64) -p1SiteId - = lens _p1SiteId (\ s a -> s{_p1SiteId = a}) . - mapping _Coerce - --- | Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to --- rendering on desktop, on mobile devices or in mobile apps for regular or --- interstitial ads respectively. APP and APP_INTERSTITIAL are no longer --- allowed for new placement insertions. Instead, use DISPLAY or --- DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream --- video ads developed with the VAST standard. This field is required on --- insertion. -p1Compatibility :: Lens' Placement (Maybe PlacementCompatibility) -p1Compatibility - = lens _p1Compatibility - (\ s a -> s{_p1Compatibility = a}) - --- | Whether this placement is archived. -p1Archived :: Lens' Placement (Maybe Bool) -p1Archived - = lens _p1Archived (\ s a -> s{_p1Archived = a}) - --- | Whether payment was approved for this placement. This is a read-only --- field relevant only to publisher-paid placements. -p1PaymentApproved :: Lens' Placement (Maybe Bool) -p1PaymentApproved - = lens _p1PaymentApproved - (\ s a -> s{_p1PaymentApproved = a}) - --- | Information about the last publisher update. This is a read-only field. -p1PublisherUpdateInfo :: Lens' Placement (Maybe LastModifiedInfo) -p1PublisherUpdateInfo - = lens _p1PublisherUpdateInfo - (\ s a -> s{_p1PublisherUpdateInfo = a}) - -instance FromJSON Placement where - parseJSON - = withObject "Placement" - (\ o -> - Placement' <$> - (o .:? "status") <*> (o .:? "videoSettings") <*> - (o .:? "placementStrategyId") - <*> (o .:? "tagFormats" .!= mempty) - <*> (o .:? "siteIdDimensionValue") - <*> (o .:? "pricingSchedule") - <*> (o .:? "size") - <*> (o .:? "kind" .!= "dfareporting#placement") - <*> (o .:? "keyName") - <*> (o .:? "campaignIdDimensionValue") - <*> (o .:? "advertiserId") - <*> (o .:? "advertiserIdDimensionValue") - <*> (o .:? "campaignId") - <*> (o .:? "idDimensionValue") - <*> (o .:? "vpaidAdapterChoice") - <*> (o .:? "adBlockingOptOut") - <*> (o .:? "primary") - <*> (o .:? "lookbackConfiguration") - <*> (o .:? "tagSetting") - <*> (o .:? "contentCategoryId") - <*> (o .:? "directorySiteIdDimensionValue") - <*> (o .:? "accountId") - <*> (o .:? "paymentSource") - <*> (o .:? "name") - <*> (o .:? "additionalSizes" .!= mempty) - <*> (o .:? "directorySiteId") - <*> (o .:? "createInfo") - <*> (o .:? "videoActiveViewOptOut") - <*> (o .:? "lastModifiedInfo") - <*> (o .:? "id") - <*> (o .:? "sslRequired") - <*> (o .:? "subaccountId") - <*> (o .:? "placementGroupIdDimensionValue") - <*> (o .:? "externalId") - <*> (o .:? "placementGroupId") - <*> (o .:? "comment") - <*> (o .:? "siteId") - <*> (o .:? "compatibility") - <*> (o .:? "archived") - <*> (o .:? "paymentApproved") - <*> (o .:? "publisherUpdateInfo")) - -instance ToJSON Placement where - toJSON Placement'{..} - = object - (catMaybes - [("status" .=) <$> _p1Status, - ("videoSettings" .=) <$> _p1VideoSettings, - ("placementStrategyId" .=) <$> - _p1PlacementStrategyId, - ("tagFormats" .=) <$> _p1TagFormats, - ("siteIdDimensionValue" .=) <$> - _p1SiteIdDimensionValue, - ("pricingSchedule" .=) <$> _p1PricingSchedule, - ("size" .=) <$> _p1Size, Just ("kind" .= _p1Kind), - ("keyName" .=) <$> _p1KeyName, - ("campaignIdDimensionValue" .=) <$> - _p1CampaignIdDimensionValue, - ("advertiserId" .=) <$> _p1AdvertiserId, - ("advertiserIdDimensionValue" .=) <$> - _p1AdvertiserIdDimensionValue, - ("campaignId" .=) <$> _p1CampaignId, - ("idDimensionValue" .=) <$> _p1IdDimensionValue, - ("vpaidAdapterChoice" .=) <$> _p1VpaidAdapterChoice, - ("adBlockingOptOut" .=) <$> _p1AdBlockingOptOut, - ("primary" .=) <$> _p1Primary, - ("lookbackConfiguration" .=) <$> - _p1LookbackConfiguration, - ("tagSetting" .=) <$> _p1TagSetting, - ("contentCategoryId" .=) <$> _p1ContentCategoryId, - ("directorySiteIdDimensionValue" .=) <$> - _p1DirectorySiteIdDimensionValue, - ("accountId" .=) <$> _p1AccountId, - ("paymentSource" .=) <$> _p1PaymentSource, - ("name" .=) <$> _p1Name, - ("additionalSizes" .=) <$> _p1AdditionalSizes, - ("directorySiteId" .=) <$> _p1DirectorySiteId, - ("createInfo" .=) <$> _p1CreateInfo, - ("videoActiveViewOptOut" .=) <$> - _p1VideoActiveViewOptOut, - ("lastModifiedInfo" .=) <$> _p1LastModifiedInfo, - ("id" .=) <$> _p1Id, - ("sslRequired" .=) <$> _p1SSLRequired, - ("subaccountId" .=) <$> _p1SubAccountId, - ("placementGroupIdDimensionValue" .=) <$> - _p1PlacementGroupIdDimensionValue, - ("externalId" .=) <$> _p1ExternalId, - ("placementGroupId" .=) <$> _p1PlacementGroupId, - ("comment" .=) <$> _p1Comment, - ("siteId" .=) <$> _p1SiteId, - ("compatibility" .=) <$> _p1Compatibility, - ("archived" .=) <$> _p1Archived, - ("paymentApproved" .=) <$> _p1PaymentApproved, - ("publisherUpdateInfo" .=) <$> - _p1PublisherUpdateInfo]) - --- | A description of how user IDs are encrypted. --- --- /See:/ 'encryptionInfo' smart constructor. -data EncryptionInfo = EncryptionInfo' - { _eiEncryptionSource :: !(Maybe EncryptionInfoEncryptionSource) - , _eiKind :: !Text - , _eiEncryptionEntityType :: !(Maybe EncryptionInfoEncryptionEntityType) - , _eiEncryptionEntityId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'EncryptionInfo' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'eiEncryptionSource' --- --- * 'eiKind' --- --- * 'eiEncryptionEntityType' --- --- * 'eiEncryptionEntityId' -encryptionInfo - :: EncryptionInfo -encryptionInfo = - EncryptionInfo' - { _eiEncryptionSource = Nothing - , _eiKind = "dfareporting#encryptionInfo" - , _eiEncryptionEntityType = Nothing - , _eiEncryptionEntityId = Nothing - } - --- | Describes whether the encrypted cookie was received from ad serving (the --- %m macro) or from Data Transfer. -eiEncryptionSource :: Lens' EncryptionInfo (Maybe EncryptionInfoEncryptionSource) -eiEncryptionSource - = lens _eiEncryptionSource - (\ s a -> s{_eiEncryptionSource = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#encryptionInfo\". -eiKind :: Lens' EncryptionInfo Text -eiKind = lens _eiKind (\ s a -> s{_eiKind = a}) - --- | The encryption entity type. This should match the encryption --- configuration for ad serving or Data Transfer. -eiEncryptionEntityType :: Lens' EncryptionInfo (Maybe EncryptionInfoEncryptionEntityType) -eiEncryptionEntityType - = lens _eiEncryptionEntityType - (\ s a -> s{_eiEncryptionEntityType = a}) - --- | The encryption entity ID. This should match the encryption configuration --- for ad serving or Data Transfer. -eiEncryptionEntityId :: Lens' EncryptionInfo (Maybe Int64) -eiEncryptionEntityId - = lens _eiEncryptionEntityId - (\ s a -> s{_eiEncryptionEntityId = a}) - . mapping _Coerce - -instance FromJSON EncryptionInfo where - parseJSON - = withObject "EncryptionInfo" - (\ o -> - EncryptionInfo' <$> - (o .:? "encryptionSource") <*> - (o .:? "kind" .!= "dfareporting#encryptionInfo") - <*> (o .:? "encryptionEntityType") - <*> (o .:? "encryptionEntityId")) - -instance ToJSON EncryptionInfo where - toJSON EncryptionInfo'{..} - = object - (catMaybes - [("encryptionSource" .=) <$> _eiEncryptionSource, - Just ("kind" .= _eiKind), - ("encryptionEntityType" .=) <$> - _eiEncryptionEntityType, - ("encryptionEntityId" .=) <$> _eiEncryptionEntityId]) - --- | Site List Response --- --- /See:/ 'sitesListResponse' smart constructor. -data SitesListResponse = SitesListResponse' - { _sitNextPageToken :: !(Maybe Text) - , _sitKind :: !Text - , _sitSites :: !(Maybe [Site]) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'SitesListResponse' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'sitNextPageToken' --- --- * 'sitKind' --- --- * 'sitSites' -sitesListResponse - :: SitesListResponse -sitesListResponse = - SitesListResponse' - { _sitNextPageToken = Nothing - , _sitKind = "dfareporting#sitesListResponse" - , _sitSites = Nothing - } - --- | Pagination token to be used for the next list operation. -sitNextPageToken :: Lens' SitesListResponse (Maybe Text) -sitNextPageToken - = lens _sitNextPageToken - (\ s a -> s{_sitNextPageToken = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#sitesListResponse\". -sitKind :: Lens' SitesListResponse Text -sitKind = lens _sitKind (\ s a -> s{_sitKind = a}) - --- | Site collection. -sitSites :: Lens' SitesListResponse [Site] -sitSites - = lens _sitSites (\ s a -> s{_sitSites = a}) . - _Default - . _Coerce - -instance FromJSON SitesListResponse where - parseJSON - = withObject "SitesListResponse" - (\ o -> - SitesListResponse' <$> - (o .:? "nextPageToken") <*> - (o .:? "kind" .!= "dfareporting#sitesListResponse") - <*> (o .:? "sites" .!= mempty)) - -instance ToJSON SitesListResponse where - toJSON SitesListResponse'{..} - = object - (catMaybes - [("nextPageToken" .=) <$> _sitNextPageToken, - Just ("kind" .= _sitKind), - ("sites" .=) <$> _sitSites]) - --- | Contains properties of a targeting template. A targeting template --- encapsulates targeting information which can be reused across multiple --- ads. --- --- /See:/ 'targetingTemplate' smart constructor. -data TargetingTemplate = TargetingTemplate' - { _ttGeoTargeting :: !(Maybe GeoTargeting) - , _ttTechnologyTargeting :: !(Maybe TechnologyTargeting) - , _ttDayPartTargeting :: !(Maybe DayPartTargeting) - , _ttKind :: !Text - , _ttAdvertiserId :: !(Maybe (Textual Int64)) - , _ttAdvertiserIdDimensionValue :: !(Maybe DimensionValue) - , _ttAccountId :: !(Maybe (Textual Int64)) - , _ttName :: !(Maybe Text) - , _ttKeyValueTargetingExpression :: !(Maybe KeyValueTargetingExpression) - , _ttId :: !(Maybe (Textual Int64)) - , _ttSubAccountId :: !(Maybe (Textual Int64)) - , _ttLanguageTargeting :: !(Maybe LanguageTargeting) - , _ttListTargetingExpression :: !(Maybe ListTargetingExpression) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'TargetingTemplate' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'ttGeoTargeting' --- --- * 'ttTechnologyTargeting' --- --- * 'ttDayPartTargeting' --- --- * 'ttKind' --- --- * 'ttAdvertiserId' --- --- * 'ttAdvertiserIdDimensionValue' --- --- * 'ttAccountId' --- --- * 'ttName' --- --- * 'ttKeyValueTargetingExpression' --- --- * 'ttId' --- --- * 'ttSubAccountId' --- --- * 'ttLanguageTargeting' --- --- * 'ttListTargetingExpression' -targetingTemplate - :: TargetingTemplate -targetingTemplate = - TargetingTemplate' - { _ttGeoTargeting = Nothing - , _ttTechnologyTargeting = Nothing - , _ttDayPartTargeting = Nothing - , _ttKind = "dfareporting#targetingTemplate" - , _ttAdvertiserId = Nothing - , _ttAdvertiserIdDimensionValue = Nothing - , _ttAccountId = Nothing - , _ttName = Nothing - , _ttKeyValueTargetingExpression = Nothing - , _ttId = Nothing - , _ttSubAccountId = Nothing - , _ttLanguageTargeting = Nothing - , _ttListTargetingExpression = Nothing - } - --- | Geographical targeting criteria. -ttGeoTargeting :: Lens' TargetingTemplate (Maybe GeoTargeting) -ttGeoTargeting - = lens _ttGeoTargeting - (\ s a -> s{_ttGeoTargeting = a}) - --- | Technology platform targeting criteria. -ttTechnologyTargeting :: Lens' TargetingTemplate (Maybe TechnologyTargeting) -ttTechnologyTargeting - = lens _ttTechnologyTargeting - (\ s a -> s{_ttTechnologyTargeting = a}) - --- | Time and day targeting criteria. -ttDayPartTargeting :: Lens' TargetingTemplate (Maybe DayPartTargeting) -ttDayPartTargeting - = lens _ttDayPartTargeting - (\ s a -> s{_ttDayPartTargeting = a}) - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#targetingTemplate\". -ttKind :: Lens' TargetingTemplate Text -ttKind = lens _ttKind (\ s a -> s{_ttKind = a}) - --- | Advertiser ID of this targeting template. This is a required field on --- insert and is read-only after insert. -ttAdvertiserId :: Lens' TargetingTemplate (Maybe Int64) -ttAdvertiserId - = lens _ttAdvertiserId - (\ s a -> s{_ttAdvertiserId = a}) - . mapping _Coerce - --- | Dimension value for the ID of the advertiser. This is a read-only, --- auto-generated field. -ttAdvertiserIdDimensionValue :: Lens' TargetingTemplate (Maybe DimensionValue) -ttAdvertiserIdDimensionValue - = lens _ttAdvertiserIdDimensionValue - (\ s a -> s{_ttAdvertiserIdDimensionValue = a}) - --- | Account ID of this targeting template. This field, if left unset, will --- be auto-generated on insert and is read-only after insert. -ttAccountId :: Lens' TargetingTemplate (Maybe Int64) -ttAccountId - = lens _ttAccountId (\ s a -> s{_ttAccountId = a}) . - mapping _Coerce - --- | Name of this targeting template. This field is required. It must be less --- than 256 characters long and unique within an advertiser. -ttName :: Lens' TargetingTemplate (Maybe Text) -ttName = lens _ttName (\ s a -> s{_ttName = a}) - --- | Key-value targeting criteria. -ttKeyValueTargetingExpression :: Lens' TargetingTemplate (Maybe KeyValueTargetingExpression) -ttKeyValueTargetingExpression - = lens _ttKeyValueTargetingExpression - (\ s a -> s{_ttKeyValueTargetingExpression = a}) - --- | ID of this targeting template. This is a read-only, auto-generated --- field. -ttId :: Lens' TargetingTemplate (Maybe Int64) -ttId - = lens _ttId (\ s a -> s{_ttId = a}) . - mapping _Coerce - --- | Subaccount ID of this targeting template. This field, if left unset, --- will be auto-generated on insert and is read-only after insert. -ttSubAccountId :: Lens' TargetingTemplate (Maybe Int64) -ttSubAccountId - = lens _ttSubAccountId - (\ s a -> s{_ttSubAccountId = a}) - . mapping _Coerce - --- | Language targeting criteria. -ttLanguageTargeting :: Lens' TargetingTemplate (Maybe LanguageTargeting) -ttLanguageTargeting - = lens _ttLanguageTargeting - (\ s a -> s{_ttLanguageTargeting = a}) - --- | Remarketing list targeting criteria. -ttListTargetingExpression :: Lens' TargetingTemplate (Maybe ListTargetingExpression) -ttListTargetingExpression - = lens _ttListTargetingExpression - (\ s a -> s{_ttListTargetingExpression = a}) - -instance FromJSON TargetingTemplate where - parseJSON - = withObject "TargetingTemplate" - (\ o -> - TargetingTemplate' <$> - (o .:? "geoTargeting") <*> - (o .:? "technologyTargeting") - <*> (o .:? "dayPartTargeting") - <*> - (o .:? "kind" .!= "dfareporting#targetingTemplate") - <*> (o .:? "advertiserId") - <*> (o .:? "advertiserIdDimensionValue") - <*> (o .:? "accountId") - <*> (o .:? "name") - <*> (o .:? "keyValueTargetingExpression") - <*> (o .:? "id") - <*> (o .:? "subaccountId") - <*> (o .:? "languageTargeting") - <*> (o .:? "listTargetingExpression")) - -instance ToJSON TargetingTemplate where - toJSON TargetingTemplate'{..} - = object - (catMaybes - [("geoTargeting" .=) <$> _ttGeoTargeting, - ("technologyTargeting" .=) <$> - _ttTechnologyTargeting, - ("dayPartTargeting" .=) <$> _ttDayPartTargeting, - Just ("kind" .= _ttKind), - ("advertiserId" .=) <$> _ttAdvertiserId, - ("advertiserIdDimensionValue" .=) <$> - _ttAdvertiserIdDimensionValue, - ("accountId" .=) <$> _ttAccountId, - ("name" .=) <$> _ttName, - ("keyValueTargetingExpression" .=) <$> - _ttKeyValueTargetingExpression, - ("id" .=) <$> _ttId, - ("subaccountId" .=) <$> _ttSubAccountId, - ("languageTargeting" .=) <$> _ttLanguageTargeting, - ("listTargetingExpression" .=) <$> - _ttListTargetingExpression]) - --- | Contains properties of a creative field. --- --- /See:/ 'creativeField' smart constructor. -data CreativeField = CreativeField' - { _cffKind :: !Text - , _cffAdvertiserId :: !(Maybe (Textual Int64)) - , _cffAdvertiserIdDimensionValue :: !(Maybe DimensionValue) - , _cffAccountId :: !(Maybe (Textual Int64)) - , _cffName :: !(Maybe Text) - , _cffId :: !(Maybe (Textual Int64)) - , _cffSubAccountId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'CreativeField' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'cffKind' --- --- * 'cffAdvertiserId' --- --- * 'cffAdvertiserIdDimensionValue' --- --- * 'cffAccountId' --- --- * 'cffName' --- --- * 'cffId' --- --- * 'cffSubAccountId' -creativeField - :: CreativeField -creativeField = - CreativeField' - { _cffKind = "dfareporting#creativeField" - , _cffAdvertiserId = Nothing - , _cffAdvertiserIdDimensionValue = Nothing - , _cffAccountId = Nothing - , _cffName = Nothing - , _cffId = Nothing - , _cffSubAccountId = Nothing - } - --- | Identifies what kind of resource this is. Value: the fixed string --- \"dfareporting#creativeField\". -cffKind :: Lens' CreativeField Text -cffKind = lens _cffKind (\ s a -> s{_cffKind = a}) - --- | Advertiser ID of this creative field. This is a required field on --- insertion. -cffAdvertiserId :: Lens' CreativeField (Maybe Int64) -cffAdvertiserId - = lens _cffAdvertiserId - (\ s a -> s{_cffAdvertiserId = a}) - . mapping _Coerce - --- | Dimension value for the ID of the advertiser. This is a read-only, --- auto-generated field. -cffAdvertiserIdDimensionValue :: Lens' CreativeField (Maybe DimensionValue) -cffAdvertiserIdDimensionValue - = lens _cffAdvertiserIdDimensionValue - (\ s a -> s{_cffAdvertiserIdDimensionValue = a}) - --- | Account ID of this creative field. This is a read-only field that can be --- left blank. -cffAccountId :: Lens' CreativeField (Maybe Int64) -cffAccountId - = lens _cffAccountId (\ s a -> s{_cffAccountId = a}) - . mapping _Coerce - --- | Name of this creative field. This is a required field and must be less --- than 256 characters long and unique among creative fields of the same --- advertiser. -cffName :: Lens' CreativeField (Maybe Text) -cffName = lens _cffName (\ s a -> s{_cffName = a}) - --- | ID of this creative field. This is a read-only, auto-generated field. -cffId :: Lens' CreativeField (Maybe Int64) -cffId - = lens _cffId (\ s a -> s{_cffId = a}) . - mapping _Coerce - --- | Subaccount ID of this creative field. This is a read-only field that can --- be left blank. -cffSubAccountId :: Lens' CreativeField (Maybe Int64) -cffSubAccountId - = lens _cffSubAccountId - (\ s a -> s{_cffSubAccountId = a}) - . mapping _Coerce - -instance FromJSON CreativeField where - parseJSON - = withObject "CreativeField" - (\ o -> - CreativeField' <$> - (o .:? "kind" .!= "dfareporting#creativeField") <*> - (o .:? "advertiserId") - <*> (o .:? "advertiserIdDimensionValue") - <*> (o .:? "accountId") - <*> (o .:? "name") - <*> (o .:? "id") - <*> (o .:? "subaccountId")) - -instance ToJSON CreativeField where - toJSON CreativeField'{..} - = object - (catMaybes - [Just ("kind" .= _cffKind), - ("advertiserId" .=) <$> _cffAdvertiserId, - ("advertiserIdDimensionValue" .=) <$> - _cffAdvertiserIdDimensionValue, - ("accountId" .=) <$> _cffAccountId, - ("name" .=) <$> _cffName, ("id" .=) <$> _cffId, - ("subaccountId" .=) <$> _cffSubAccountId]) - --- | Properties of inheriting and overriding the default click-through event --- tag. A campaign may override the event tag defined at the advertiser --- level, and an ad may also override the campaign\'s setting further. --- --- /See:/ 'defaultClickThroughEventTagProperties' smart constructor. -data DefaultClickThroughEventTagProperties = DefaultClickThroughEventTagProperties' - { _dctetpOverrideInheritedEventTag :: !(Maybe Bool) - , _dctetpDefaultClickThroughEventTagId :: !(Maybe (Textual Int64)) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'DefaultClickThroughEventTagProperties' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'dctetpOverrideInheritedEventTag' --- --- * 'dctetpDefaultClickThroughEventTagId' -defaultClickThroughEventTagProperties - :: DefaultClickThroughEventTagProperties -defaultClickThroughEventTagProperties = - DefaultClickThroughEventTagProperties' - { _dctetpOverrideInheritedEventTag = Nothing - , _dctetpDefaultClickThroughEventTagId = Nothing - } - --- | Whether this entity should override the inherited default click-through --- event tag with its own defined value. -dctetpOverrideInheritedEventTag :: Lens' DefaultClickThroughEventTagProperties (Maybe Bool) -dctetpOverrideInheritedEventTag - = lens _dctetpOverrideInheritedEventTag - (\ s a -> s{_dctetpOverrideInheritedEventTag = a}) - --- | ID of the click-through event tag to apply to all ads in this entity\'s --- scope. -dctetpDefaultClickThroughEventTagId :: Lens' DefaultClickThroughEventTagProperties (Maybe Int64) -dctetpDefaultClickThroughEventTagId - = lens _dctetpDefaultClickThroughEventTagId - (\ s a -> - s{_dctetpDefaultClickThroughEventTagId = a}) - . mapping _Coerce - -instance FromJSON - DefaultClickThroughEventTagProperties where - parseJSON - = withObject "DefaultClickThroughEventTagProperties" - (\ o -> - DefaultClickThroughEventTagProperties' <$> - (o .:? "overrideInheritedEventTag") <*> - (o .:? "defaultClickThroughEventTagId")) - -instance ToJSON DefaultClickThroughEventTagProperties - where - toJSON DefaultClickThroughEventTagProperties'{..} - = object - (catMaybes - [("overrideInheritedEventTag" .=) <$> - _dctetpOverrideInheritedEventTag, - ("defaultClickThroughEventTagId" .=) <$> - _dctetpDefaultClickThroughEventTagId]) - --- | Remarketing List Targeting Expression. --- --- /See:/ 'listTargetingExpression' smart constructor. -newtype ListTargetingExpression = ListTargetingExpression' - { _lteExpression :: Maybe Text - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'ListTargetingExpression' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'lteExpression' -listTargetingExpression - :: ListTargetingExpression -listTargetingExpression = - ListTargetingExpression' - { _lteExpression = Nothing - } +data VideoOffSet = + VideoOffSet' + { _vosOffSetPercentage :: !(Maybe (Textual Int32)) + , _vosOffSetSeconds :: !(Maybe (Textual Int32)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'VideoOffSet' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'vosOffSetPercentage' +-- +-- * 'vosOffSetSeconds' +videoOffSet + :: VideoOffSet +videoOffSet = + VideoOffSet' {_vosOffSetPercentage = Nothing, _vosOffSetSeconds = Nothing} + + +-- | Duration, as a percentage of video duration. Do not set when +-- offsetSeconds is set. Acceptable values are 0 to 100, inclusive. +vosOffSetPercentage :: Lens' VideoOffSet (Maybe Int32) +vosOffSetPercentage + = lens _vosOffSetPercentage + (\ s a -> s{_vosOffSetPercentage = a}) + . mapping _Coerce + +-- | Duration, in seconds. Do not set when offsetPercentage is set. +-- Acceptable values are 0 to 86399, inclusive. +vosOffSetSeconds :: Lens' VideoOffSet (Maybe Int32) +vosOffSetSeconds + = lens _vosOffSetSeconds + (\ s a -> s{_vosOffSetSeconds = a}) + . mapping _Coerce + +instance FromJSON VideoOffSet where + parseJSON + = withObject "VideoOffSet" + (\ o -> + VideoOffSet' <$> + (o .:? "offsetPercentage") <*> + (o .:? "offsetSeconds")) + +instance ToJSON VideoOffSet where + toJSON VideoOffSet'{..} + = object + (catMaybes + [("offsetPercentage" .=) <$> _vosOffSetPercentage, + ("offsetSeconds" .=) <$> _vosOffSetSeconds]) + +-- | Contains information about a landing page deep link. +-- +-- /See:/ 'deepLink' smart constructor. +data DeepLink = + DeepLink' + { _dlRemarketingListIds :: !(Maybe [Textual Int64]) + , _dlKind :: !Text + , _dlFallbackURL :: !(Maybe Text) + , _dlAppURL :: !(Maybe Text) + , _dlMobileApp :: !(Maybe MobileApp) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'DeepLink' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'dlRemarketingListIds' +-- +-- * 'dlKind' +-- +-- * 'dlFallbackURL' +-- +-- * 'dlAppURL' +-- +-- * 'dlMobileApp' +deepLink + :: DeepLink +deepLink = + DeepLink' + { _dlRemarketingListIds = Nothing + , _dlKind = "dfareporting#deepLink" + , _dlFallbackURL = Nothing + , _dlAppURL = Nothing + , _dlMobileApp = Nothing + } + + +-- | Ads served to users on these remarketing lists will use this deep link. +-- Applicable when mobileApp.directory is APPLE_APP_STORE. +dlRemarketingListIds :: Lens' DeepLink [Int64] +dlRemarketingListIds + = lens _dlRemarketingListIds + (\ s a -> s{_dlRemarketingListIds = a}) + . _Default + . _Coerce + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#deepLink\". +dlKind :: Lens' DeepLink Text +dlKind = lens _dlKind (\ s a -> s{_dlKind = a}) + +-- | The fallback URL. This URL will be served to users who do not have the +-- mobile app installed. +dlFallbackURL :: Lens' DeepLink (Maybe Text) +dlFallbackURL + = lens _dlFallbackURL + (\ s a -> s{_dlFallbackURL = a}) + +-- | The URL of the mobile app being linked to. +dlAppURL :: Lens' DeepLink (Maybe Text) +dlAppURL = lens _dlAppURL (\ s a -> s{_dlAppURL = a}) + +-- | The mobile app targeted by this deep link. +dlMobileApp :: Lens' DeepLink (Maybe MobileApp) +dlMobileApp + = lens _dlMobileApp (\ s a -> s{_dlMobileApp = a}) + +instance FromJSON DeepLink where + parseJSON + = withObject "DeepLink" + (\ o -> + DeepLink' <$> + (o .:? "remarketingListIds" .!= mempty) <*> + (o .:? "kind" .!= "dfareporting#deepLink") + <*> (o .:? "fallbackUrl") + <*> (o .:? "appUrl") + <*> (o .:? "mobileApp")) + +instance ToJSON DeepLink where + toJSON DeepLink'{..} + = object + (catMaybes + [("remarketingListIds" .=) <$> _dlRemarketingListIds, + Just ("kind" .= _dlKind), + ("fallbackUrl" .=) <$> _dlFallbackURL, + ("appUrl" .=) <$> _dlAppURL, + ("mobileApp" .=) <$> _dlMobileApp]) + +-- | Represents the list of File resources. +-- +-- /See:/ 'fileList' smart constructor. +data FileList = + FileList' + { _flEtag :: !(Maybe Text) + , _flNextPageToken :: !(Maybe Text) + , _flKind :: !Text + , _flItems :: !(Maybe [File]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'FileList' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'flEtag' +-- +-- * 'flNextPageToken' +-- +-- * 'flKind' +-- +-- * 'flItems' +fileList + :: FileList +fileList = + FileList' + { _flEtag = Nothing + , _flNextPageToken = Nothing + , _flKind = "dfareporting#fileList" + , _flItems = Nothing + } + + +-- | The eTag of this response for caching purposes. +flEtag :: Lens' FileList (Maybe Text) +flEtag = lens _flEtag (\ s a -> s{_flEtag = a}) + +-- | Continuation token used to page through files. To retrieve the next page +-- of results, set the next request\'s \"pageToken\" to the value of this +-- field. The page token is only valid for a limited amount of time and +-- should not be persisted. +flNextPageToken :: Lens' FileList (Maybe Text) +flNextPageToken + = lens _flNextPageToken + (\ s a -> s{_flNextPageToken = a}) + +-- | The kind of list this is, in this case dfareporting#fileList. +flKind :: Lens' FileList Text +flKind = lens _flKind (\ s a -> s{_flKind = a}) + +-- | The files returned in this response. +flItems :: Lens' FileList [File] +flItems + = lens _flItems (\ s a -> s{_flItems = a}) . _Default + . _Coerce + +instance FromJSON FileList where + parseJSON + = withObject "FileList" + (\ o -> + FileList' <$> + (o .:? "etag") <*> (o .:? "nextPageToken") <*> + (o .:? "kind" .!= "dfareporting#fileList") + <*> (o .:? "items" .!= mempty)) + +instance ToJSON FileList where + toJSON FileList'{..} + = object + (catMaybes + [("etag" .=) <$> _flEtag, + ("nextPageToken" .=) <$> _flNextPageToken, + Just ("kind" .= _flKind), ("items" .=) <$> _flItems]) + +-- | Creative optimization activity. +-- +-- /See:/ 'optimizationActivity' smart constructor. +data OptimizationActivity = + OptimizationActivity' + { _oaWeight :: !(Maybe (Textual Int32)) + , _oaFloodlightActivityId :: !(Maybe (Textual Int64)) + , _oaFloodlightActivityIdDimensionValue :: !(Maybe DimensionValue) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'OptimizationActivity' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'oaWeight' +-- +-- * 'oaFloodlightActivityId' +-- +-- * 'oaFloodlightActivityIdDimensionValue' +optimizationActivity + :: OptimizationActivity +optimizationActivity = + OptimizationActivity' + { _oaWeight = Nothing + , _oaFloodlightActivityId = Nothing + , _oaFloodlightActivityIdDimensionValue = Nothing + } + + +-- | Weight associated with this optimization. The weight assigned will be +-- understood in proportion to the weights assigned to the other +-- optimization activities. Value must be greater than or equal to 1. +oaWeight :: Lens' OptimizationActivity (Maybe Int32) +oaWeight + = lens _oaWeight (\ s a -> s{_oaWeight = a}) . + mapping _Coerce + +-- | Floodlight activity ID of this optimization activity. This is a required +-- field. +oaFloodlightActivityId :: Lens' OptimizationActivity (Maybe Int64) +oaFloodlightActivityId + = lens _oaFloodlightActivityId + (\ s a -> s{_oaFloodlightActivityId = a}) + . mapping _Coerce + +-- | Dimension value for the ID of the floodlight activity. This is a +-- read-only, auto-generated field. +oaFloodlightActivityIdDimensionValue :: Lens' OptimizationActivity (Maybe DimensionValue) +oaFloodlightActivityIdDimensionValue + = lens _oaFloodlightActivityIdDimensionValue + (\ s a -> + s{_oaFloodlightActivityIdDimensionValue = a}) + +instance FromJSON OptimizationActivity where + parseJSON + = withObject "OptimizationActivity" + (\ o -> + OptimizationActivity' <$> + (o .:? "weight") <*> (o .:? "floodlightActivityId") + <*> (o .:? "floodlightActivityIdDimensionValue")) + +instance ToJSON OptimizationActivity where + toJSON OptimizationActivity'{..} + = object + (catMaybes + [("weight" .=) <$> _oaWeight, + ("floodlightActivityId" .=) <$> + _oaFloodlightActivityId, + ("floodlightActivityIdDimensionValue" .=) <$> + _oaFloodlightActivityIdDimensionValue]) + +-- | A group clause made up of list population terms representing constraints +-- joined by ORs. +-- +-- /See:/ 'listPopulationClause' smart constructor. +newtype ListPopulationClause = + ListPopulationClause' + { _lpcTerms :: Maybe [ListPopulationTerm] + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ListPopulationClause' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'lpcTerms' +listPopulationClause + :: ListPopulationClause +listPopulationClause = ListPopulationClause' {_lpcTerms = Nothing} + + +-- | Terms of this list population clause. Each clause is made up of list +-- population terms representing constraints and are joined by ORs. +lpcTerms :: Lens' ListPopulationClause [ListPopulationTerm] +lpcTerms + = lens _lpcTerms (\ s a -> s{_lpcTerms = a}) . + _Default + . _Coerce + +instance FromJSON ListPopulationClause where + parseJSON + = withObject "ListPopulationClause" + (\ o -> + ListPopulationClause' <$> (o .:? "terms" .!= mempty)) + +instance ToJSON ListPopulationClause where + toJSON ListPopulationClause'{..} + = object (catMaybes [("terms" .=) <$> _lpcTerms]) + +-- | Campaign ad blocking settings. +-- +-- /See:/ 'adBlockingConfiguration' smart constructor. +data AdBlockingConfiguration = + AdBlockingConfiguration' + { _abcCreativeBundleId :: !(Maybe (Textual Int64)) + , _abcOverrideClickThroughURL :: !(Maybe Bool) + , _abcEnabled :: !(Maybe Bool) + , _abcClickThroughURL :: !(Maybe Text) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'AdBlockingConfiguration' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'abcCreativeBundleId' +-- +-- * 'abcOverrideClickThroughURL' +-- +-- * 'abcEnabled' +-- +-- * 'abcClickThroughURL' +adBlockingConfiguration + :: AdBlockingConfiguration +adBlockingConfiguration = + AdBlockingConfiguration' + { _abcCreativeBundleId = Nothing + , _abcOverrideClickThroughURL = Nothing + , _abcEnabled = Nothing + , _abcClickThroughURL = Nothing + } + + +-- | ID of a creative bundle to use for this campaign. If set, brand-neutral +-- ads will select creatives from this bundle. Otherwise, a default +-- transparent pixel will be used. +abcCreativeBundleId :: Lens' AdBlockingConfiguration (Maybe Int64) +abcCreativeBundleId + = lens _abcCreativeBundleId + (\ s a -> s{_abcCreativeBundleId = a}) + . mapping _Coerce + +-- | Whether the brand-neutral ad\'s click-through URL comes from the +-- campaign\'s creative bundle or the override URL. Must be set to true if +-- ad blocking is enabled and no creative bundle is configured. +abcOverrideClickThroughURL :: Lens' AdBlockingConfiguration (Maybe Bool) +abcOverrideClickThroughURL + = lens _abcOverrideClickThroughURL + (\ s a -> s{_abcOverrideClickThroughURL = a}) + +-- | Whether this campaign has enabled ad blocking. When true, ad blocking is +-- enabled for placements in the campaign, but this may be overridden by +-- site and placement settings. When false, ad blocking is disabled for all +-- placements under the campaign, regardless of site and placement +-- settings. +abcEnabled :: Lens' AdBlockingConfiguration (Maybe Bool) +abcEnabled + = lens _abcEnabled (\ s a -> s{_abcEnabled = a}) + +-- | Click-through URL used by brand-neutral ads. This is a required field +-- when overrideClickThroughUrl is set to true. +abcClickThroughURL :: Lens' AdBlockingConfiguration (Maybe Text) +abcClickThroughURL + = lens _abcClickThroughURL + (\ s a -> s{_abcClickThroughURL = a}) + +instance FromJSON AdBlockingConfiguration where + parseJSON + = withObject "AdBlockingConfiguration" + (\ o -> + AdBlockingConfiguration' <$> + (o .:? "creativeBundleId") <*> + (o .:? "overrideClickThroughUrl") + <*> (o .:? "enabled") + <*> (o .:? "clickThroughUrl")) + +instance ToJSON AdBlockingConfiguration where + toJSON AdBlockingConfiguration'{..} + = object + (catMaybes + [("creativeBundleId" .=) <$> _abcCreativeBundleId, + ("overrideClickThroughUrl" .=) <$> + _abcOverrideClickThroughURL, + ("enabled" .=) <$> _abcEnabled, + ("clickThroughUrl" .=) <$> _abcClickThroughURL]) + +-- | Creative Custom Event. +-- +-- /See:/ 'creativeCustomEvent' smart constructor. +data CreativeCustomEvent = + CreativeCustomEvent' + { _cceAdvertiserCustomEventId :: !(Maybe (Textual Int64)) + , _cceAdvertiserCustomEventType :: !(Maybe CreativeCustomEventAdvertiserCustomEventType) + , _cceAdvertiserCustomEventName :: !(Maybe Text) + , _cceExitClickThroughURL :: !(Maybe CreativeClickThroughURL) + , _cceTargetType :: !(Maybe CreativeCustomEventTargetType) + , _ccePopupWindowProperties :: !(Maybe PopupWindowProperties) + , _cceVideoReportingId :: !(Maybe Text) + , _cceId :: !(Maybe (Textual Int64)) + , _cceArtworkLabel :: !(Maybe Text) + , _cceArtworkType :: !(Maybe CreativeCustomEventArtworkType) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'CreativeCustomEvent' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'cceAdvertiserCustomEventId' +-- +-- * 'cceAdvertiserCustomEventType' +-- +-- * 'cceAdvertiserCustomEventName' +-- +-- * 'cceExitClickThroughURL' +-- +-- * 'cceTargetType' +-- +-- * 'ccePopupWindowProperties' +-- +-- * 'cceVideoReportingId' +-- +-- * 'cceId' +-- +-- * 'cceArtworkLabel' +-- +-- * 'cceArtworkType' +creativeCustomEvent + :: CreativeCustomEvent +creativeCustomEvent = + CreativeCustomEvent' + { _cceAdvertiserCustomEventId = Nothing + , _cceAdvertiserCustomEventType = Nothing + , _cceAdvertiserCustomEventName = Nothing + , _cceExitClickThroughURL = Nothing + , _cceTargetType = Nothing + , _ccePopupWindowProperties = Nothing + , _cceVideoReportingId = Nothing + , _cceId = Nothing + , _cceArtworkLabel = Nothing + , _cceArtworkType = Nothing + } + + +-- | Unique ID of this event used by Reporting and Data Transfer. This is a +-- read-only field. +cceAdvertiserCustomEventId :: Lens' CreativeCustomEvent (Maybe Int64) +cceAdvertiserCustomEventId + = lens _cceAdvertiserCustomEventId + (\ s a -> s{_cceAdvertiserCustomEventId = a}) + . mapping _Coerce + +-- | Type of the event. This is a read-only field. +cceAdvertiserCustomEventType :: Lens' CreativeCustomEvent (Maybe CreativeCustomEventAdvertiserCustomEventType) +cceAdvertiserCustomEventType + = lens _cceAdvertiserCustomEventType + (\ s a -> s{_cceAdvertiserCustomEventType = a}) + +-- | User-entered name for the event. +cceAdvertiserCustomEventName :: Lens' CreativeCustomEvent (Maybe Text) +cceAdvertiserCustomEventName + = lens _cceAdvertiserCustomEventName + (\ s a -> s{_cceAdvertiserCustomEventName = a}) + +-- | Exit click-through URL for the event. This field is used only for exit +-- events. +cceExitClickThroughURL :: Lens' CreativeCustomEvent (Maybe CreativeClickThroughURL) +cceExitClickThroughURL + = lens _cceExitClickThroughURL + (\ s a -> s{_cceExitClickThroughURL = a}) + +-- | Target type used by the event. +cceTargetType :: Lens' CreativeCustomEvent (Maybe CreativeCustomEventTargetType) +cceTargetType + = lens _cceTargetType + (\ s a -> s{_cceTargetType = a}) + +-- | Properties for rich media popup windows. This field is used only for +-- exit events. +ccePopupWindowProperties :: Lens' CreativeCustomEvent (Maybe PopupWindowProperties) +ccePopupWindowProperties + = lens _ccePopupWindowProperties + (\ s a -> s{_ccePopupWindowProperties = a}) + +-- | Video reporting ID, used to differentiate multiple videos in a single +-- creative. This is a read-only field. +cceVideoReportingId :: Lens' CreativeCustomEvent (Maybe Text) +cceVideoReportingId + = lens _cceVideoReportingId + (\ s a -> s{_cceVideoReportingId = a}) + +-- | ID of this event. This is a required field and should not be modified +-- after insertion. +cceId :: Lens' CreativeCustomEvent (Maybe Int64) +cceId + = lens _cceId (\ s a -> s{_cceId = a}) . + mapping _Coerce + +-- | Artwork label column, used to link events in Campaign Manager back to +-- events in Studio. This is a required field and should not be modified +-- after insertion. +cceArtworkLabel :: Lens' CreativeCustomEvent (Maybe Text) +cceArtworkLabel + = lens _cceArtworkLabel + (\ s a -> s{_cceArtworkLabel = a}) + +-- | Artwork type used by the creative.This is a read-only field. +cceArtworkType :: Lens' CreativeCustomEvent (Maybe CreativeCustomEventArtworkType) +cceArtworkType + = lens _cceArtworkType + (\ s a -> s{_cceArtworkType = a}) + +instance FromJSON CreativeCustomEvent where + parseJSON + = withObject "CreativeCustomEvent" + (\ o -> + CreativeCustomEvent' <$> + (o .:? "advertiserCustomEventId") <*> + (o .:? "advertiserCustomEventType") + <*> (o .:? "advertiserCustomEventName") + <*> (o .:? "exitClickThroughUrl") + <*> (o .:? "targetType") + <*> (o .:? "popupWindowProperties") + <*> (o .:? "videoReportingId") + <*> (o .:? "id") + <*> (o .:? "artworkLabel") + <*> (o .:? "artworkType")) + +instance ToJSON CreativeCustomEvent where + toJSON CreativeCustomEvent'{..} + = object + (catMaybes + [("advertiserCustomEventId" .=) <$> + _cceAdvertiserCustomEventId, + ("advertiserCustomEventType" .=) <$> + _cceAdvertiserCustomEventType, + ("advertiserCustomEventName" .=) <$> + _cceAdvertiserCustomEventName, + ("exitClickThroughUrl" .=) <$> + _cceExitClickThroughURL, + ("targetType" .=) <$> _cceTargetType, + ("popupWindowProperties" .=) <$> + _ccePopupWindowProperties, + ("videoReportingId" .=) <$> _cceVideoReportingId, + ("id" .=) <$> _cceId, + ("artworkLabel" .=) <$> _cceArtworkLabel, + ("artworkType" .=) <$> _cceArtworkType]) + +-- | Creative Click Tag. +-- +-- /See:/ 'clickTag' smart constructor. +data ClickTag = + ClickTag' + { _ctClickThroughURL :: !(Maybe CreativeClickThroughURL) + , _ctName :: !(Maybe Text) + , _ctEventName :: !(Maybe Text) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ClickTag' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'ctClickThroughURL' +-- +-- * 'ctName' +-- +-- * 'ctEventName' +clickTag + :: ClickTag +clickTag = + ClickTag' + {_ctClickThroughURL = Nothing, _ctName = Nothing, _ctEventName = Nothing} + + +-- | Parameter value for the specified click tag. This field contains a +-- click-through url. +ctClickThroughURL :: Lens' ClickTag (Maybe CreativeClickThroughURL) +ctClickThroughURL + = lens _ctClickThroughURL + (\ s a -> s{_ctClickThroughURL = a}) + +-- | Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY +-- creative assets, this field must match the value of the creative +-- asset\'s creativeAssetId.name field. +ctName :: Lens' ClickTag (Maybe Text) +ctName = lens _ctName (\ s a -> s{_ctName = a}) + +-- | Advertiser event name associated with the click tag. This field is used +-- by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to +-- DISPLAY when the primary asset type is not HTML_IMAGE. +ctEventName :: Lens' ClickTag (Maybe Text) +ctEventName + = lens _ctEventName (\ s a -> s{_ctEventName = a}) + +instance FromJSON ClickTag where + parseJSON + = withObject "ClickTag" + (\ o -> + ClickTag' <$> + (o .:? "clickThroughUrl") <*> (o .:? "name") <*> + (o .:? "eventName")) + +instance ToJSON ClickTag where + toJSON ClickTag'{..} + = object + (catMaybes + [("clickThroughUrl" .=) <$> _ctClickThroughURL, + ("name" .=) <$> _ctName, + ("eventName" .=) <$> _ctEventName]) + +-- | Campaign List Response +-- +-- /See:/ 'campaignsListResponse' smart constructor. +data CampaignsListResponse = + CampaignsListResponse' + { _clrNextPageToken :: !(Maybe Text) + , _clrCampaigns :: !(Maybe [Campaign]) + , _clrKind :: !Text + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'CampaignsListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'clrNextPageToken' +-- +-- * 'clrCampaigns' +-- +-- * 'clrKind' +campaignsListResponse + :: CampaignsListResponse +campaignsListResponse = + CampaignsListResponse' + { _clrNextPageToken = Nothing + , _clrCampaigns = Nothing + , _clrKind = "dfareporting#campaignsListResponse" + } + + +-- | Pagination token to be used for the next list operation. +clrNextPageToken :: Lens' CampaignsListResponse (Maybe Text) +clrNextPageToken + = lens _clrNextPageToken + (\ s a -> s{_clrNextPageToken = a}) + +-- | Campaign collection. +clrCampaigns :: Lens' CampaignsListResponse [Campaign] +clrCampaigns + = lens _clrCampaigns (\ s a -> s{_clrCampaigns = a}) + . _Default + . _Coerce + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#campaignsListResponse\". +clrKind :: Lens' CampaignsListResponse Text +clrKind = lens _clrKind (\ s a -> s{_clrKind = a}) + +instance FromJSON CampaignsListResponse where + parseJSON + = withObject "CampaignsListResponse" + (\ o -> + CampaignsListResponse' <$> + (o .:? "nextPageToken") <*> + (o .:? "campaigns" .!= mempty) + <*> + (o .:? "kind" .!= + "dfareporting#campaignsListResponse")) + +instance ToJSON CampaignsListResponse where + toJSON CampaignsListResponse'{..} + = object + (catMaybes + [("nextPageToken" .=) <$> _clrNextPageToken, + ("campaigns" .=) <$> _clrCampaigns, + Just ("kind" .= _clrKind)]) + +-- | Geographical Targeting. +-- +-- /See:/ 'geoTargeting' smart constructor. +data GeoTargeting = + GeoTargeting' + { _gtRegions :: !(Maybe [Region]) + , _gtCountries :: !(Maybe [Country]) + , _gtCities :: !(Maybe [City]) + , _gtMetros :: !(Maybe [Metro]) + , _gtExcludeCountries :: !(Maybe Bool) + , _gtPostalCodes :: !(Maybe [PostalCode]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'GeoTargeting' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'gtRegions' +-- +-- * 'gtCountries' +-- +-- * 'gtCities' +-- +-- * 'gtMetros' +-- +-- * 'gtExcludeCountries' +-- +-- * 'gtPostalCodes' +geoTargeting + :: GeoTargeting +geoTargeting = + GeoTargeting' + { _gtRegions = Nothing + , _gtCountries = Nothing + , _gtCities = Nothing + , _gtMetros = Nothing + , _gtExcludeCountries = Nothing + , _gtPostalCodes = Nothing + } + + +-- | Regions to be targeted. For each region only dartId is required. The +-- other fields are populated automatically when the ad is inserted or +-- updated. If targeting a region, do not target or exclude the country of +-- the region. +gtRegions :: Lens' GeoTargeting [Region] +gtRegions + = lens _gtRegions (\ s a -> s{_gtRegions = a}) . + _Default + . _Coerce + +-- | Countries to be targeted or excluded from targeting, depending on the +-- setting of the excludeCountries field. For each country only dartId is +-- required. The other fields are populated automatically when the ad is +-- inserted or updated. If targeting or excluding a country, do not target +-- regions, cities, metros, or postal codes in the same country. +gtCountries :: Lens' GeoTargeting [Country] +gtCountries + = lens _gtCountries (\ s a -> s{_gtCountries = a}) . + _Default + . _Coerce + +-- | Cities to be targeted. For each city only dartId is required. The other +-- fields are populated automatically when the ad is inserted or updated. +-- If targeting a city, do not target or exclude the country of the city, +-- and do not target the metro or region of the city. +gtCities :: Lens' GeoTargeting [City] +gtCities + = lens _gtCities (\ s a -> s{_gtCities = a}) . + _Default + . _Coerce + +-- | Metros to be targeted. For each metro only dmaId is required. The other +-- fields are populated automatically when the ad is inserted or updated. +-- If targeting a metro, do not target or exclude the country of the metro. +gtMetros :: Lens' GeoTargeting [Metro] +gtMetros + = lens _gtMetros (\ s a -> s{_gtMetros = a}) . + _Default + . _Coerce + +-- | Whether or not to exclude the countries in the countries field from +-- targeting. If false, the countries field refers to countries which will +-- be targeted by the ad. +gtExcludeCountries :: Lens' GeoTargeting (Maybe Bool) +gtExcludeCountries + = lens _gtExcludeCountries + (\ s a -> s{_gtExcludeCountries = a}) + +-- | Postal codes to be targeted. For each postal code only id is required. +-- The other fields are populated automatically when the ad is inserted or +-- updated. If targeting a postal code, do not target or exclude the +-- country of the postal code. +gtPostalCodes :: Lens' GeoTargeting [PostalCode] +gtPostalCodes + = lens _gtPostalCodes + (\ s a -> s{_gtPostalCodes = a}) + . _Default + . _Coerce + +instance FromJSON GeoTargeting where + parseJSON + = withObject "GeoTargeting" + (\ o -> + GeoTargeting' <$> + (o .:? "regions" .!= mempty) <*> + (o .:? "countries" .!= mempty) + <*> (o .:? "cities" .!= mempty) + <*> (o .:? "metros" .!= mempty) + <*> (o .:? "excludeCountries") + <*> (o .:? "postalCodes" .!= mempty)) + +instance ToJSON GeoTargeting where + toJSON GeoTargeting'{..} + = object + (catMaybes + [("regions" .=) <$> _gtRegions, + ("countries" .=) <$> _gtCountries, + ("cities" .=) <$> _gtCities, + ("metros" .=) <$> _gtMetros, + ("excludeCountries" .=) <$> _gtExcludeCountries, + ("postalCodes" .=) <$> _gtPostalCodes]) + +-- | Video Settings +-- +-- /See:/ 'videoSettings' smart constructor. +data VideoSettings = + VideoSettings' + { _vsKind :: !Text + , _vsCompanionSettings :: !(Maybe CompanionSetting) + , _vsTranscodeSettings :: !(Maybe TranscodeSetting) + , _vsOrientation :: !(Maybe VideoSettingsOrientation) + , _vsSkippableSettings :: !(Maybe SkippableSetting) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'VideoSettings' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'vsKind' +-- +-- * 'vsCompanionSettings' +-- +-- * 'vsTranscodeSettings' +-- +-- * 'vsOrientation' +-- +-- * 'vsSkippableSettings' +videoSettings + :: VideoSettings +videoSettings = + VideoSettings' + { _vsKind = "dfareporting#videoSettings" + , _vsCompanionSettings = Nothing + , _vsTranscodeSettings = Nothing + , _vsOrientation = Nothing + , _vsSkippableSettings = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#videoSettings\". +vsKind :: Lens' VideoSettings Text +vsKind = lens _vsKind (\ s a -> s{_vsKind = a}) + +-- | Settings for the companion creatives of video creatives served to this +-- placement. +vsCompanionSettings :: Lens' VideoSettings (Maybe CompanionSetting) +vsCompanionSettings + = lens _vsCompanionSettings + (\ s a -> s{_vsCompanionSettings = a}) + +-- | Settings for the transcodes of video creatives served to this placement. +-- If this object is provided, the creative-level transcode settings will +-- be overridden. +vsTranscodeSettings :: Lens' VideoSettings (Maybe TranscodeSetting) +vsTranscodeSettings + = lens _vsTranscodeSettings + (\ s a -> s{_vsTranscodeSettings = a}) + +-- | Orientation of a video placement. If this value is set, placement will +-- return assets matching the specified orientation. +vsOrientation :: Lens' VideoSettings (Maybe VideoSettingsOrientation) +vsOrientation + = lens _vsOrientation + (\ s a -> s{_vsOrientation = a}) + +-- | Settings for the skippability of video creatives served to this +-- placement. If this object is provided, the creative-level skippable +-- settings will be overridden. +vsSkippableSettings :: Lens' VideoSettings (Maybe SkippableSetting) +vsSkippableSettings + = lens _vsSkippableSettings + (\ s a -> s{_vsSkippableSettings = a}) + +instance FromJSON VideoSettings where + parseJSON + = withObject "VideoSettings" + (\ o -> + VideoSettings' <$> + (o .:? "kind" .!= "dfareporting#videoSettings") <*> + (o .:? "companionSettings") + <*> (o .:? "transcodeSettings") + <*> (o .:? "orientation") + <*> (o .:? "skippableSettings")) + +instance ToJSON VideoSettings where + toJSON VideoSettings'{..} + = object + (catMaybes + [Just ("kind" .= _vsKind), + ("companionSettings" .=) <$> _vsCompanionSettings, + ("transcodeSettings" .=) <$> _vsTranscodeSettings, + ("orientation" .=) <$> _vsOrientation, + ("skippableSettings" .=) <$> _vsSkippableSettings]) + +-- | Represents fields that are compatible to be selected for a report of +-- type \"REACH\". +-- +-- /See:/ 'reachReportCompatibleFields' smart constructor. +data ReachReportCompatibleFields = + ReachReportCompatibleFields' + { _rrcfMetrics :: !(Maybe [Metric]) + , _rrcfReachByFrequencyMetrics :: !(Maybe [Metric]) + , _rrcfKind :: !Text + , _rrcfDimensionFilters :: !(Maybe [Dimension]) + , _rrcfPivotedActivityMetrics :: !(Maybe [Metric]) + , _rrcfDimensions :: !(Maybe [Dimension]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ReachReportCompatibleFields' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'rrcfMetrics' +-- +-- * 'rrcfReachByFrequencyMetrics' +-- +-- * 'rrcfKind' +-- +-- * 'rrcfDimensionFilters' +-- +-- * 'rrcfPivotedActivityMetrics' +-- +-- * 'rrcfDimensions' +reachReportCompatibleFields + :: ReachReportCompatibleFields +reachReportCompatibleFields = + ReachReportCompatibleFields' + { _rrcfMetrics = Nothing + , _rrcfReachByFrequencyMetrics = Nothing + , _rrcfKind = "dfareporting#reachReportCompatibleFields" + , _rrcfDimensionFilters = Nothing + , _rrcfPivotedActivityMetrics = Nothing + , _rrcfDimensions = Nothing + } + + +-- | Metrics which are compatible to be selected in the \"metricNames\" +-- section of the report. +rrcfMetrics :: Lens' ReachReportCompatibleFields [Metric] +rrcfMetrics + = lens _rrcfMetrics (\ s a -> s{_rrcfMetrics = a}) . + _Default + . _Coerce + +-- | Metrics which are compatible to be selected in the +-- \"reachByFrequencyMetricNames\" section of the report. +rrcfReachByFrequencyMetrics :: Lens' ReachReportCompatibleFields [Metric] +rrcfReachByFrequencyMetrics + = lens _rrcfReachByFrequencyMetrics + (\ s a -> s{_rrcfReachByFrequencyMetrics = a}) + . _Default + . _Coerce + +-- | The kind of resource this is, in this case +-- dfareporting#reachReportCompatibleFields. +rrcfKind :: Lens' ReachReportCompatibleFields Text +rrcfKind = lens _rrcfKind (\ s a -> s{_rrcfKind = a}) + +-- | Dimensions which are compatible to be selected in the +-- \"dimensionFilters\" section of the report. +rrcfDimensionFilters :: Lens' ReachReportCompatibleFields [Dimension] +rrcfDimensionFilters + = lens _rrcfDimensionFilters + (\ s a -> s{_rrcfDimensionFilters = a}) + . _Default + . _Coerce + +-- | Metrics which are compatible to be selected as activity metrics to pivot +-- on in the \"activities\" section of the report. +rrcfPivotedActivityMetrics :: Lens' ReachReportCompatibleFields [Metric] +rrcfPivotedActivityMetrics + = lens _rrcfPivotedActivityMetrics + (\ s a -> s{_rrcfPivotedActivityMetrics = a}) + . _Default + . _Coerce + +-- | Dimensions which are compatible to be selected in the \"dimensions\" +-- section of the report. +rrcfDimensions :: Lens' ReachReportCompatibleFields [Dimension] +rrcfDimensions + = lens _rrcfDimensions + (\ s a -> s{_rrcfDimensions = a}) + . _Default + . _Coerce + +instance FromJSON ReachReportCompatibleFields where + parseJSON + = withObject "ReachReportCompatibleFields" + (\ o -> + ReachReportCompatibleFields' <$> + (o .:? "metrics" .!= mempty) <*> + (o .:? "reachByFrequencyMetrics" .!= mempty) + <*> + (o .:? "kind" .!= + "dfareporting#reachReportCompatibleFields") + <*> (o .:? "dimensionFilters" .!= mempty) + <*> (o .:? "pivotedActivityMetrics" .!= mempty) + <*> (o .:? "dimensions" .!= mempty)) + +instance ToJSON ReachReportCompatibleFields where + toJSON ReachReportCompatibleFields'{..} + = object + (catMaybes + [("metrics" .=) <$> _rrcfMetrics, + ("reachByFrequencyMetrics" .=) <$> + _rrcfReachByFrequencyMetrics, + Just ("kind" .= _rrcfKind), + ("dimensionFilters" .=) <$> _rrcfDimensionFilters, + ("pivotedActivityMetrics" .=) <$> + _rrcfPivotedActivityMetrics, + ("dimensions" .=) <$> _rrcfDimensions]) + +-- | Contains information about a browser that can be targeted by ads. +-- +-- /See:/ 'browser' smart constructor. +data Browser = + Browser' + { _bMinorVersion :: !(Maybe Text) + , _bKind :: !Text + , _bBrowserVersionId :: !(Maybe (Textual Int64)) + , _bMajorVersion :: !(Maybe Text) + , _bName :: !(Maybe Text) + , _bDartId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'Browser' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'bMinorVersion' +-- +-- * 'bKind' +-- +-- * 'bBrowserVersionId' +-- +-- * 'bMajorVersion' +-- +-- * 'bName' +-- +-- * 'bDartId' +browser + :: Browser +browser = + Browser' + { _bMinorVersion = Nothing + , _bKind = "dfareporting#browser" + , _bBrowserVersionId = Nothing + , _bMajorVersion = Nothing + , _bName = Nothing + , _bDartId = Nothing + } + + +-- | Minor version number (number after first dot on left) of this browser. +-- For example, for Chrome 5.0.375.86 beta, this field should be set to 0. +-- An asterisk (*) may be used to target any version number, and a question +-- mark (?) may be used to target cases where the version number cannot be +-- identified. For example, Chrome *.* targets any version of Chrome: 1.2, +-- 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. +-- Firefox ?.? targets cases where the ad server knows the browser is +-- Firefox but can\'t tell which version it is. +bMinorVersion :: Lens' Browser (Maybe Text) +bMinorVersion + = lens _bMinorVersion + (\ s a -> s{_bMinorVersion = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#browser\". +bKind :: Lens' Browser Text +bKind = lens _bKind (\ s a -> s{_bKind = a}) + +-- | ID referring to this grouping of browser and version numbers. This is +-- the ID used for targeting. +bBrowserVersionId :: Lens' Browser (Maybe Int64) +bBrowserVersionId + = lens _bBrowserVersionId + (\ s a -> s{_bBrowserVersionId = a}) + . mapping _Coerce + +-- | Major version number (leftmost number) of this browser. For example, for +-- Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) +-- may be used to target any version number, and a question mark (?) may be +-- used to target cases where the version number cannot be identified. For +-- example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so +-- on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets +-- cases where the ad server knows the browser is Firefox but can\'t tell +-- which version it is. +bMajorVersion :: Lens' Browser (Maybe Text) +bMajorVersion + = lens _bMajorVersion + (\ s a -> s{_bMajorVersion = a}) + +-- | Name of this browser. +bName :: Lens' Browser (Maybe Text) +bName = lens _bName (\ s a -> s{_bName = a}) + +-- | DART ID of this browser. This is the ID used when generating reports. +bDartId :: Lens' Browser (Maybe Int64) +bDartId + = lens _bDartId (\ s a -> s{_bDartId = a}) . + mapping _Coerce + +instance FromJSON Browser where + parseJSON + = withObject "Browser" + (\ o -> + Browser' <$> + (o .:? "minorVersion") <*> + (o .:? "kind" .!= "dfareporting#browser") + <*> (o .:? "browserVersionId") + <*> (o .:? "majorVersion") + <*> (o .:? "name") + <*> (o .:? "dartId")) + +instance ToJSON Browser where + toJSON Browser'{..} + = object + (catMaybes + [("minorVersion" .=) <$> _bMinorVersion, + Just ("kind" .= _bKind), + ("browserVersionId" .=) <$> _bBrowserVersionId, + ("majorVersion" .=) <$> _bMajorVersion, + ("name" .=) <$> _bName, ("dartId" .=) <$> _bDartId]) + +-- | Creative Group Assignment. +-- +-- /See:/ 'creativeGroupAssignment' smart constructor. +data CreativeGroupAssignment = + CreativeGroupAssignment' + { _cgaCreativeGroupNumber :: !(Maybe CreativeGroupAssignmentCreativeGroupNumber) + , _cgaCreativeGroupId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'CreativeGroupAssignment' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'cgaCreativeGroupNumber' +-- +-- * 'cgaCreativeGroupId' +creativeGroupAssignment + :: CreativeGroupAssignment +creativeGroupAssignment = + CreativeGroupAssignment' + {_cgaCreativeGroupNumber = Nothing, _cgaCreativeGroupId = Nothing} + + +-- | Creative group number of the creative group assignment. +cgaCreativeGroupNumber :: Lens' CreativeGroupAssignment (Maybe CreativeGroupAssignmentCreativeGroupNumber) +cgaCreativeGroupNumber + = lens _cgaCreativeGroupNumber + (\ s a -> s{_cgaCreativeGroupNumber = a}) + +-- | ID of the creative group to be assigned. +cgaCreativeGroupId :: Lens' CreativeGroupAssignment (Maybe Int64) +cgaCreativeGroupId + = lens _cgaCreativeGroupId + (\ s a -> s{_cgaCreativeGroupId = a}) + . mapping _Coerce + +instance FromJSON CreativeGroupAssignment where + parseJSON + = withObject "CreativeGroupAssignment" + (\ o -> + CreativeGroupAssignment' <$> + (o .:? "creativeGroupNumber") <*> + (o .:? "creativeGroupId")) + +instance ToJSON CreativeGroupAssignment where + toJSON CreativeGroupAssignment'{..} + = object + (catMaybes + [("creativeGroupNumber" .=) <$> + _cgaCreativeGroupNumber, + ("creativeGroupId" .=) <$> _cgaCreativeGroupId]) + +-- | Directory Site Settings +-- +-- /See:/ 'directorySiteSettings' smart constructor. +data DirectorySiteSettings = + DirectorySiteSettings' + { _dssInterstitialPlacementAccepted :: !(Maybe Bool) + , _dssInstreamVideoPlacementAccepted :: !(Maybe Bool) + , _dssActiveViewOptOut :: !(Maybe Bool) + , _dssDfpSettings :: !(Maybe DfpSettings) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'DirectorySiteSettings' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'dssInterstitialPlacementAccepted' +-- +-- * 'dssInstreamVideoPlacementAccepted' +-- +-- * 'dssActiveViewOptOut' +-- +-- * 'dssDfpSettings' +directorySiteSettings + :: DirectorySiteSettings +directorySiteSettings = + DirectorySiteSettings' + { _dssInterstitialPlacementAccepted = Nothing + , _dssInstreamVideoPlacementAccepted = Nothing + , _dssActiveViewOptOut = Nothing + , _dssDfpSettings = Nothing + } + + +-- | Whether this site accepts interstitial ads. +dssInterstitialPlacementAccepted :: Lens' DirectorySiteSettings (Maybe Bool) +dssInterstitialPlacementAccepted + = lens _dssInterstitialPlacementAccepted + (\ s a -> s{_dssInterstitialPlacementAccepted = a}) + +-- | Whether this site accepts in-stream video ads. +dssInstreamVideoPlacementAccepted :: Lens' DirectorySiteSettings (Maybe Bool) +dssInstreamVideoPlacementAccepted + = lens _dssInstreamVideoPlacementAccepted + (\ s a -> s{_dssInstreamVideoPlacementAccepted = a}) + +-- | Whether this directory site has disabled active view creatives. +dssActiveViewOptOut :: Lens' DirectorySiteSettings (Maybe Bool) +dssActiveViewOptOut + = lens _dssActiveViewOptOut + (\ s a -> s{_dssActiveViewOptOut = a}) + +-- | Directory site Ad Manager settings. +dssDfpSettings :: Lens' DirectorySiteSettings (Maybe DfpSettings) +dssDfpSettings + = lens _dssDfpSettings + (\ s a -> s{_dssDfpSettings = a}) + +instance FromJSON DirectorySiteSettings where + parseJSON + = withObject "DirectorySiteSettings" + (\ o -> + DirectorySiteSettings' <$> + (o .:? "interstitialPlacementAccepted") <*> + (o .:? "instreamVideoPlacementAccepted") + <*> (o .:? "activeViewOptOut") + <*> (o .:? "dfpSettings")) + +instance ToJSON DirectorySiteSettings where + toJSON DirectorySiteSettings'{..} + = object + (catMaybes + [("interstitialPlacementAccepted" .=) <$> + _dssInterstitialPlacementAccepted, + ("instreamVideoPlacementAccepted" .=) <$> + _dssInstreamVideoPlacementAccepted, + ("activeViewOptOut" .=) <$> _dssActiveViewOptOut, + ("dfpSettings" .=) <$> _dssDfpSettings]) + +-- | Remarketing List Population Rule. +-- +-- /See:/ 'listPopulationRule' smart constructor. +data ListPopulationRule = + ListPopulationRule' + { _lprFloodlightActivityName :: !(Maybe Text) + , _lprFloodlightActivityId :: !(Maybe (Textual Int64)) + , _lprListPopulationClauses :: !(Maybe [ListPopulationClause]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ListPopulationRule' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'lprFloodlightActivityName' +-- +-- * 'lprFloodlightActivityId' +-- +-- * 'lprListPopulationClauses' +listPopulationRule + :: ListPopulationRule +listPopulationRule = + ListPopulationRule' + { _lprFloodlightActivityName = Nothing + , _lprFloodlightActivityId = Nothing + , _lprListPopulationClauses = Nothing + } + + +-- | Name of floodlight activity associated with this rule. This is a +-- read-only, auto-generated field. +lprFloodlightActivityName :: Lens' ListPopulationRule (Maybe Text) +lprFloodlightActivityName + = lens _lprFloodlightActivityName + (\ s a -> s{_lprFloodlightActivityName = a}) + +-- | Floodlight activity ID associated with this rule. This field can be left +-- blank. +lprFloodlightActivityId :: Lens' ListPopulationRule (Maybe Int64) +lprFloodlightActivityId + = lens _lprFloodlightActivityId + (\ s a -> s{_lprFloodlightActivityId = a}) + . mapping _Coerce + +-- | Clauses that make up this list population rule. Clauses are joined by +-- ANDs, and the clauses themselves are made up of list population terms +-- which are joined by ORs. +lprListPopulationClauses :: Lens' ListPopulationRule [ListPopulationClause] +lprListPopulationClauses + = lens _lprListPopulationClauses + (\ s a -> s{_lprListPopulationClauses = a}) + . _Default + . _Coerce + +instance FromJSON ListPopulationRule where + parseJSON + = withObject "ListPopulationRule" + (\ o -> + ListPopulationRule' <$> + (o .:? "floodlightActivityName") <*> + (o .:? "floodlightActivityId") + <*> (o .:? "listPopulationClauses" .!= mempty)) + +instance ToJSON ListPopulationRule where + toJSON ListPopulationRule'{..} + = object + (catMaybes + [("floodlightActivityName" .=) <$> + _lprFloodlightActivityName, + ("floodlightActivityId" .=) <$> + _lprFloodlightActivityId, + ("listPopulationClauses" .=) <$> + _lprListPopulationClauses]) + +-- | Size List Response +-- +-- /See:/ 'sizesListResponse' smart constructor. +data SizesListResponse = + SizesListResponse' + { _slrKind :: !Text + , _slrSizes :: !(Maybe [Size]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'SizesListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'slrKind' +-- +-- * 'slrSizes' +sizesListResponse + :: SizesListResponse +sizesListResponse = + SizesListResponse' + {_slrKind = "dfareporting#sizesListResponse", _slrSizes = Nothing} + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#sizesListResponse\". +slrKind :: Lens' SizesListResponse Text +slrKind = lens _slrKind (\ s a -> s{_slrKind = a}) + +-- | Size collection. +slrSizes :: Lens' SizesListResponse [Size] +slrSizes + = lens _slrSizes (\ s a -> s{_slrSizes = a}) . + _Default + . _Coerce + +instance FromJSON SizesListResponse where + parseJSON + = withObject "SizesListResponse" + (\ o -> + SizesListResponse' <$> + (o .:? "kind" .!= "dfareporting#sizesListResponse") + <*> (o .:? "sizes" .!= mempty)) + +instance ToJSON SizesListResponse where + toJSON SizesListResponse'{..} + = object + (catMaybes + [Just ("kind" .= _slrKind), + ("sizes" .=) <$> _slrSizes]) + +-- | Creative Rotation. +-- +-- /See:/ 'creativeRotation' smart constructor. +data CreativeRotation = + CreativeRotation' + { _crWeightCalculationStrategy :: !(Maybe CreativeRotationWeightCalculationStrategy) + , _crCreativeAssignments :: !(Maybe [CreativeAssignment]) + , _crCreativeOptimizationConfigurationId :: !(Maybe (Textual Int64)) + , _crType :: !(Maybe CreativeRotationType) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'CreativeRotation' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'crWeightCalculationStrategy' +-- +-- * 'crCreativeAssignments' +-- +-- * 'crCreativeOptimizationConfigurationId' +-- +-- * 'crType' +creativeRotation + :: CreativeRotation +creativeRotation = + CreativeRotation' + { _crWeightCalculationStrategy = Nothing + , _crCreativeAssignments = Nothing + , _crCreativeOptimizationConfigurationId = Nothing + , _crType = Nothing + } + + +-- | Strategy for calculating weights. Used with +-- CREATIVE_ROTATION_TYPE_RANDOM. +crWeightCalculationStrategy :: Lens' CreativeRotation (Maybe CreativeRotationWeightCalculationStrategy) +crWeightCalculationStrategy + = lens _crWeightCalculationStrategy + (\ s a -> s{_crWeightCalculationStrategy = a}) + +-- | Creative assignments in this creative rotation. +crCreativeAssignments :: Lens' CreativeRotation [CreativeAssignment] +crCreativeAssignments + = lens _crCreativeAssignments + (\ s a -> s{_crCreativeAssignments = a}) + . _Default + . _Coerce + +-- | Creative optimization configuration that is used by this ad. It should +-- refer to one of the existing optimization configurations in the ad\'s +-- campaign. If it is unset or set to 0, then the campaign\'s default +-- optimization configuration will be used for this ad. +crCreativeOptimizationConfigurationId :: Lens' CreativeRotation (Maybe Int64) +crCreativeOptimizationConfigurationId + = lens _crCreativeOptimizationConfigurationId + (\ s a -> + s{_crCreativeOptimizationConfigurationId = a}) + . mapping _Coerce + +-- | Type of creative rotation. Can be used to specify whether to use +-- sequential or random rotation. +crType :: Lens' CreativeRotation (Maybe CreativeRotationType) +crType = lens _crType (\ s a -> s{_crType = a}) + +instance FromJSON CreativeRotation where + parseJSON + = withObject "CreativeRotation" + (\ o -> + CreativeRotation' <$> + (o .:? "weightCalculationStrategy") <*> + (o .:? "creativeAssignments" .!= mempty) + <*> (o .:? "creativeOptimizationConfigurationId") + <*> (o .:? "type")) + +instance ToJSON CreativeRotation where + toJSON CreativeRotation'{..} + = object + (catMaybes + [("weightCalculationStrategy" .=) <$> + _crWeightCalculationStrategy, + ("creativeAssignments" .=) <$> + _crCreativeAssignments, + ("creativeOptimizationConfigurationId" .=) <$> + _crCreativeOptimizationConfigurationId, + ("type" .=) <$> _crType]) + +-- | Technology Targeting. +-- +-- /See:/ 'technologyTargeting' smart constructor. +data TechnologyTargeting = + TechnologyTargeting' + { _ttMobileCarriers :: !(Maybe [MobileCarrier]) + , _ttOperatingSystemVersions :: !(Maybe [OperatingSystemVersion]) + , _ttPlatformTypes :: !(Maybe [PlatformType]) + , _ttBrowsers :: !(Maybe [Browser]) + , _ttConnectionTypes :: !(Maybe [ConnectionType]) + , _ttOperatingSystems :: !(Maybe [OperatingSystem]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'TechnologyTargeting' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'ttMobileCarriers' +-- +-- * 'ttOperatingSystemVersions' +-- +-- * 'ttPlatformTypes' +-- +-- * 'ttBrowsers' +-- +-- * 'ttConnectionTypes' +-- +-- * 'ttOperatingSystems' +technologyTargeting + :: TechnologyTargeting +technologyTargeting = + TechnologyTargeting' + { _ttMobileCarriers = Nothing + , _ttOperatingSystemVersions = Nothing + , _ttPlatformTypes = Nothing + , _ttBrowsers = Nothing + , _ttConnectionTypes = Nothing + , _ttOperatingSystems = Nothing + } + + +-- | Mobile carriers that this ad targets. For each mobile carrier only id is +-- required, and the other fields are populated automatically when the ad +-- is inserted or updated. If targeting a mobile carrier, do not set +-- targeting for any zip codes. +ttMobileCarriers :: Lens' TechnologyTargeting [MobileCarrier] +ttMobileCarriers + = lens _ttMobileCarriers + (\ s a -> s{_ttMobileCarriers = a}) + . _Default + . _Coerce + +-- | Operating system versions that this ad targets. To target all versions, +-- use operatingSystems. For each operating system version, only id is +-- required. The other fields are populated automatically when the ad is +-- inserted or updated. If targeting an operating system version, do not +-- set targeting for the corresponding operating system in +-- operatingSystems. +ttOperatingSystemVersions :: Lens' TechnologyTargeting [OperatingSystemVersion] +ttOperatingSystemVersions + = lens _ttOperatingSystemVersions + (\ s a -> s{_ttOperatingSystemVersions = a}) + . _Default + . _Coerce + +-- | Platform types that this ad targets. For example, desktop, mobile, or +-- tablet. For each platform type, only id is required, and the other +-- fields are populated automatically when the ad is inserted or updated. +ttPlatformTypes :: Lens' TechnologyTargeting [PlatformType] +ttPlatformTypes + = lens _ttPlatformTypes + (\ s a -> s{_ttPlatformTypes = a}) + . _Default + . _Coerce + +-- | Browsers that this ad targets. For each browser either set +-- browserVersionId or dartId along with the version numbers. If both are +-- specified, only browserVersionId will be used. The other fields are +-- populated automatically when the ad is inserted or updated. +ttBrowsers :: Lens' TechnologyTargeting [Browser] +ttBrowsers + = lens _ttBrowsers (\ s a -> s{_ttBrowsers = a}) . + _Default + . _Coerce + +-- | Connection types that this ad targets. For each connection type only id +-- is required. The other fields are populated automatically when the ad is +-- inserted or updated. +ttConnectionTypes :: Lens' TechnologyTargeting [ConnectionType] +ttConnectionTypes + = lens _ttConnectionTypes + (\ s a -> s{_ttConnectionTypes = a}) + . _Default + . _Coerce + +-- | Operating systems that this ad targets. To target specific versions, use +-- operatingSystemVersions. For each operating system only dartId is +-- required. The other fields are populated automatically when the ad is +-- inserted or updated. If targeting an operating system, do not set +-- targeting for operating system versions for the same operating system. +ttOperatingSystems :: Lens' TechnologyTargeting [OperatingSystem] +ttOperatingSystems + = lens _ttOperatingSystems + (\ s a -> s{_ttOperatingSystems = a}) + . _Default + . _Coerce + +instance FromJSON TechnologyTargeting where + parseJSON + = withObject "TechnologyTargeting" + (\ o -> + TechnologyTargeting' <$> + (o .:? "mobileCarriers" .!= mempty) <*> + (o .:? "operatingSystemVersions" .!= mempty) + <*> (o .:? "platformTypes" .!= mempty) + <*> (o .:? "browsers" .!= mempty) + <*> (o .:? "connectionTypes" .!= mempty) + <*> (o .:? "operatingSystems" .!= mempty)) + +instance ToJSON TechnologyTargeting where + toJSON TechnologyTargeting'{..} + = object + (catMaybes + [("mobileCarriers" .=) <$> _ttMobileCarriers, + ("operatingSystemVersions" .=) <$> + _ttOperatingSystemVersions, + ("platformTypes" .=) <$> _ttPlatformTypes, + ("browsers" .=) <$> _ttBrowsers, + ("connectionTypes" .=) <$> _ttConnectionTypes, + ("operatingSystems" .=) <$> _ttOperatingSystems]) + +-- | Represents a buy from the Planning inventory store. +-- +-- /See:/ 'inventoryItem' smart constructor. +data InventoryItem = + InventoryItem' + { _iiPlacementStrategyId :: !(Maybe (Textual Int64)) + , _iiEstimatedClickThroughRate :: !(Maybe (Textual Int64)) + , _iiPricing :: !(Maybe Pricing) + , _iiKind :: !Text + , _iiAdvertiserId :: !(Maybe (Textual Int64)) + , _iiRfpId :: !(Maybe (Textual Int64)) + , _iiContentCategoryId :: !(Maybe (Textual Int64)) + , _iiInPlan :: !(Maybe Bool) + , _iiAccountId :: !(Maybe (Textual Int64)) + , _iiName :: !(Maybe Text) + , _iiAdSlots :: !(Maybe [AdSlot]) + , _iiNegotiationChannelId :: !(Maybe (Textual Int64)) + , _iiLastModifiedInfo :: !(Maybe LastModifiedInfo) + , _iiId :: !(Maybe (Textual Int64)) + , _iiEstimatedConversionRate :: !(Maybe (Textual Int64)) + , _iiProjectId :: !(Maybe (Textual Int64)) + , _iiSubAccountId :: !(Maybe (Textual Int64)) + , _iiType :: !(Maybe InventoryItemType) + , _iiOrderId :: !(Maybe (Textual Int64)) + , _iiSiteId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'InventoryItem' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'iiPlacementStrategyId' +-- +-- * 'iiEstimatedClickThroughRate' +-- +-- * 'iiPricing' +-- +-- * 'iiKind' +-- +-- * 'iiAdvertiserId' +-- +-- * 'iiRfpId' +-- +-- * 'iiContentCategoryId' +-- +-- * 'iiInPlan' +-- +-- * 'iiAccountId' +-- +-- * 'iiName' +-- +-- * 'iiAdSlots' +-- +-- * 'iiNegotiationChannelId' +-- +-- * 'iiLastModifiedInfo' +-- +-- * 'iiId' +-- +-- * 'iiEstimatedConversionRate' +-- +-- * 'iiProjectId' +-- +-- * 'iiSubAccountId' +-- +-- * 'iiType' +-- +-- * 'iiOrderId' +-- +-- * 'iiSiteId' +inventoryItem + :: InventoryItem +inventoryItem = + InventoryItem' + { _iiPlacementStrategyId = Nothing + , _iiEstimatedClickThroughRate = Nothing + , _iiPricing = Nothing + , _iiKind = "dfareporting#inventoryItem" + , _iiAdvertiserId = Nothing + , _iiRfpId = Nothing + , _iiContentCategoryId = Nothing + , _iiInPlan = Nothing + , _iiAccountId = Nothing + , _iiName = Nothing + , _iiAdSlots = Nothing + , _iiNegotiationChannelId = Nothing + , _iiLastModifiedInfo = Nothing + , _iiId = Nothing + , _iiEstimatedConversionRate = Nothing + , _iiProjectId = Nothing + , _iiSubAccountId = Nothing + , _iiType = Nothing + , _iiOrderId = Nothing + , _iiSiteId = Nothing + } + + +-- | Placement strategy ID of this inventory item. +iiPlacementStrategyId :: Lens' InventoryItem (Maybe Int64) +iiPlacementStrategyId + = lens _iiPlacementStrategyId + (\ s a -> s{_iiPlacementStrategyId = a}) + . mapping _Coerce + +-- | Estimated click-through rate of this inventory item. +iiEstimatedClickThroughRate :: Lens' InventoryItem (Maybe Int64) +iiEstimatedClickThroughRate + = lens _iiEstimatedClickThroughRate + (\ s a -> s{_iiEstimatedClickThroughRate = a}) + . mapping _Coerce + +-- | Pricing of this inventory item. +iiPricing :: Lens' InventoryItem (Maybe Pricing) +iiPricing + = lens _iiPricing (\ s a -> s{_iiPricing = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#inventoryItem\". +iiKind :: Lens' InventoryItem Text +iiKind = lens _iiKind (\ s a -> s{_iiKind = a}) + +-- | Advertiser ID of this inventory item. +iiAdvertiserId :: Lens' InventoryItem (Maybe Int64) +iiAdvertiserId + = lens _iiAdvertiserId + (\ s a -> s{_iiAdvertiserId = a}) + . mapping _Coerce + +-- | RFP ID of this inventory item. +iiRfpId :: Lens' InventoryItem (Maybe Int64) +iiRfpId + = lens _iiRfpId (\ s a -> s{_iiRfpId = a}) . + mapping _Coerce + +-- | Content category ID of this inventory item. +iiContentCategoryId :: Lens' InventoryItem (Maybe Int64) +iiContentCategoryId + = lens _iiContentCategoryId + (\ s a -> s{_iiContentCategoryId = a}) + . mapping _Coerce + +-- | Whether this inventory item is in plan. +iiInPlan :: Lens' InventoryItem (Maybe Bool) +iiInPlan = lens _iiInPlan (\ s a -> s{_iiInPlan = a}) + +-- | Account ID of this inventory item. +iiAccountId :: Lens' InventoryItem (Maybe Int64) +iiAccountId + = lens _iiAccountId (\ s a -> s{_iiAccountId = a}) . + mapping _Coerce + +-- | Name of this inventory item. For standalone inventory items, this is the +-- same name as that of its only ad slot. For group inventory items, this +-- can differ from the name of any of its ad slots. +iiName :: Lens' InventoryItem (Maybe Text) +iiName = lens _iiName (\ s a -> s{_iiName = a}) + +-- | Ad slots of this inventory item. If this inventory item represents a +-- standalone placement, there will be exactly one ad slot. If this +-- inventory item represents a placement group, there will be more than one +-- ad slot, each representing one child placement in that placement group. +iiAdSlots :: Lens' InventoryItem [AdSlot] +iiAdSlots + = lens _iiAdSlots (\ s a -> s{_iiAdSlots = a}) . + _Default + . _Coerce + +-- | Negotiation channel ID of this inventory item. +iiNegotiationChannelId :: Lens' InventoryItem (Maybe Int64) +iiNegotiationChannelId + = lens _iiNegotiationChannelId + (\ s a -> s{_iiNegotiationChannelId = a}) + . mapping _Coerce + +-- | Information about the most recent modification of this inventory item. +iiLastModifiedInfo :: Lens' InventoryItem (Maybe LastModifiedInfo) +iiLastModifiedInfo + = lens _iiLastModifiedInfo + (\ s a -> s{_iiLastModifiedInfo = a}) + +-- | ID of this inventory item. +iiId :: Lens' InventoryItem (Maybe Int64) +iiId + = lens _iiId (\ s a -> s{_iiId = a}) . + mapping _Coerce + +-- | Estimated conversion rate of this inventory item. +iiEstimatedConversionRate :: Lens' InventoryItem (Maybe Int64) +iiEstimatedConversionRate + = lens _iiEstimatedConversionRate + (\ s a -> s{_iiEstimatedConversionRate = a}) + . mapping _Coerce + +-- | Project ID of this inventory item. +iiProjectId :: Lens' InventoryItem (Maybe Int64) +iiProjectId + = lens _iiProjectId (\ s a -> s{_iiProjectId = a}) . + mapping _Coerce + +-- | Subaccount ID of this inventory item. +iiSubAccountId :: Lens' InventoryItem (Maybe Int64) +iiSubAccountId + = lens _iiSubAccountId + (\ s a -> s{_iiSubAccountId = a}) + . mapping _Coerce + +-- | Type of inventory item. +iiType :: Lens' InventoryItem (Maybe InventoryItemType) +iiType = lens _iiType (\ s a -> s{_iiType = a}) + +-- | Order ID of this inventory item. +iiOrderId :: Lens' InventoryItem (Maybe Int64) +iiOrderId + = lens _iiOrderId (\ s a -> s{_iiOrderId = a}) . + mapping _Coerce + +-- | ID of the site this inventory item is associated with. +iiSiteId :: Lens' InventoryItem (Maybe Int64) +iiSiteId + = lens _iiSiteId (\ s a -> s{_iiSiteId = a}) . + mapping _Coerce + +instance FromJSON InventoryItem where + parseJSON + = withObject "InventoryItem" + (\ o -> + InventoryItem' <$> + (o .:? "placementStrategyId") <*> + (o .:? "estimatedClickThroughRate") + <*> (o .:? "pricing") + <*> (o .:? "kind" .!= "dfareporting#inventoryItem") + <*> (o .:? "advertiserId") + <*> (o .:? "rfpId") + <*> (o .:? "contentCategoryId") + <*> (o .:? "inPlan") + <*> (o .:? "accountId") + <*> (o .:? "name") + <*> (o .:? "adSlots" .!= mempty) + <*> (o .:? "negotiationChannelId") + <*> (o .:? "lastModifiedInfo") + <*> (o .:? "id") + <*> (o .:? "estimatedConversionRate") + <*> (o .:? "projectId") + <*> (o .:? "subaccountId") + <*> (o .:? "type") + <*> (o .:? "orderId") + <*> (o .:? "siteId")) + +instance ToJSON InventoryItem where + toJSON InventoryItem'{..} + = object + (catMaybes + [("placementStrategyId" .=) <$> + _iiPlacementStrategyId, + ("estimatedClickThroughRate" .=) <$> + _iiEstimatedClickThroughRate, + ("pricing" .=) <$> _iiPricing, + Just ("kind" .= _iiKind), + ("advertiserId" .=) <$> _iiAdvertiserId, + ("rfpId" .=) <$> _iiRfpId, + ("contentCategoryId" .=) <$> _iiContentCategoryId, + ("inPlan" .=) <$> _iiInPlan, + ("accountId" .=) <$> _iiAccountId, + ("name" .=) <$> _iiName, + ("adSlots" .=) <$> _iiAdSlots, + ("negotiationChannelId" .=) <$> + _iiNegotiationChannelId, + ("lastModifiedInfo" .=) <$> _iiLastModifiedInfo, + ("id" .=) <$> _iiId, + ("estimatedConversionRate" .=) <$> + _iiEstimatedConversionRate, + ("projectId" .=) <$> _iiProjectId, + ("subaccountId" .=) <$> _iiSubAccountId, + ("type" .=) <$> _iiType, + ("orderId" .=) <$> _iiOrderId, + ("siteId" .=) <$> _iiSiteId]) + +-- | Project List Response +-- +-- /See:/ 'projectsListResponse' smart constructor. +data ProjectsListResponse = + ProjectsListResponse' + { _plrNextPageToken :: !(Maybe Text) + , _plrKind :: !Text + , _plrProjects :: !(Maybe [Project]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ProjectsListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'plrNextPageToken' +-- +-- * 'plrKind' +-- +-- * 'plrProjects' +projectsListResponse + :: ProjectsListResponse +projectsListResponse = + ProjectsListResponse' + { _plrNextPageToken = Nothing + , _plrKind = "dfareporting#projectsListResponse" + , _plrProjects = Nothing + } + + +-- | Pagination token to be used for the next list operation. +plrNextPageToken :: Lens' ProjectsListResponse (Maybe Text) +plrNextPageToken + = lens _plrNextPageToken + (\ s a -> s{_plrNextPageToken = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#projectsListResponse\". +plrKind :: Lens' ProjectsListResponse Text +plrKind = lens _plrKind (\ s a -> s{_plrKind = a}) + +-- | Project collection. +plrProjects :: Lens' ProjectsListResponse [Project] +plrProjects + = lens _plrProjects (\ s a -> s{_plrProjects = a}) . + _Default + . _Coerce + +instance FromJSON ProjectsListResponse where + parseJSON + = withObject "ProjectsListResponse" + (\ o -> + ProjectsListResponse' <$> + (o .:? "nextPageToken") <*> + (o .:? "kind" .!= + "dfareporting#projectsListResponse") + <*> (o .:? "projects" .!= mempty)) + +instance ToJSON ProjectsListResponse where + toJSON ProjectsListResponse'{..} + = object + (catMaybes + [("nextPageToken" .=) <$> _plrNextPageToken, + Just ("kind" .= _plrKind), + ("projects" .=) <$> _plrProjects]) + +-- | Ad List Response +-- +-- /See:/ 'adsListResponse' smart constructor. +data AdsListResponse = + AdsListResponse' + { _alrNextPageToken :: !(Maybe Text) + , _alrKind :: !Text + , _alrAds :: !(Maybe [Ad]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'AdsListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'alrNextPageToken' +-- +-- * 'alrKind' +-- +-- * 'alrAds' +adsListResponse + :: AdsListResponse +adsListResponse = + AdsListResponse' + { _alrNextPageToken = Nothing + , _alrKind = "dfareporting#adsListResponse" + , _alrAds = Nothing + } + + +-- | Pagination token to be used for the next list operation. +alrNextPageToken :: Lens' AdsListResponse (Maybe Text) +alrNextPageToken + = lens _alrNextPageToken + (\ s a -> s{_alrNextPageToken = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#adsListResponse\". +alrKind :: Lens' AdsListResponse Text +alrKind = lens _alrKind (\ s a -> s{_alrKind = a}) + +-- | Ad collection. +alrAds :: Lens' AdsListResponse [Ad] +alrAds + = lens _alrAds (\ s a -> s{_alrAds = a}) . _Default . + _Coerce + +instance FromJSON AdsListResponse where + parseJSON + = withObject "AdsListResponse" + (\ o -> + AdsListResponse' <$> + (o .:? "nextPageToken") <*> + (o .:? "kind" .!= "dfareporting#adsListResponse") + <*> (o .:? "ads" .!= mempty)) + +instance ToJSON AdsListResponse where + toJSON AdsListResponse'{..} + = object + (catMaybes + [("nextPageToken" .=) <$> _alrNextPageToken, + Just ("kind" .= _alrKind), ("ads" .=) <$> _alrAds]) + +-- | Video Settings +-- +-- /See:/ 'siteVideoSettings' smart constructor. +data SiteVideoSettings = + SiteVideoSettings' + { _svsKind :: !Text + , _svsCompanionSettings :: !(Maybe SiteCompanionSetting) + , _svsTranscodeSettings :: !(Maybe SiteTranscodeSetting) + , _svsOrientation :: !(Maybe SiteVideoSettingsOrientation) + , _svsSkippableSettings :: !(Maybe SiteSkippableSetting) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'SiteVideoSettings' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'svsKind' +-- +-- * 'svsCompanionSettings' +-- +-- * 'svsTranscodeSettings' +-- +-- * 'svsOrientation' +-- +-- * 'svsSkippableSettings' +siteVideoSettings + :: SiteVideoSettings +siteVideoSettings = + SiteVideoSettings' + { _svsKind = "dfareporting#siteVideoSettings" + , _svsCompanionSettings = Nothing + , _svsTranscodeSettings = Nothing + , _svsOrientation = Nothing + , _svsSkippableSettings = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#siteVideoSettings\". +svsKind :: Lens' SiteVideoSettings Text +svsKind = lens _svsKind (\ s a -> s{_svsKind = a}) + +-- | Settings for the companion creatives of video creatives served to this +-- site. +svsCompanionSettings :: Lens' SiteVideoSettings (Maybe SiteCompanionSetting) +svsCompanionSettings + = lens _svsCompanionSettings + (\ s a -> s{_svsCompanionSettings = a}) + +-- | Settings for the transcodes of video creatives served to this site. This +-- will act as default for new placements created under this site. +svsTranscodeSettings :: Lens' SiteVideoSettings (Maybe SiteTranscodeSetting) +svsTranscodeSettings + = lens _svsTranscodeSettings + (\ s a -> s{_svsTranscodeSettings = a}) + +-- | Orientation of a site template used for video. This will act as default +-- for new placements created under this site. +svsOrientation :: Lens' SiteVideoSettings (Maybe SiteVideoSettingsOrientation) +svsOrientation + = lens _svsOrientation + (\ s a -> s{_svsOrientation = a}) + +-- | Settings for the skippability of video creatives served to this site. +-- This will act as default for new placements created under this site. +svsSkippableSettings :: Lens' SiteVideoSettings (Maybe SiteSkippableSetting) +svsSkippableSettings + = lens _svsSkippableSettings + (\ s a -> s{_svsSkippableSettings = a}) + +instance FromJSON SiteVideoSettings where + parseJSON + = withObject "SiteVideoSettings" + (\ o -> + SiteVideoSettings' <$> + (o .:? "kind" .!= "dfareporting#siteVideoSettings") + <*> (o .:? "companionSettings") + <*> (o .:? "transcodeSettings") + <*> (o .:? "orientation") + <*> (o .:? "skippableSettings")) + +instance ToJSON SiteVideoSettings where + toJSON SiteVideoSettings'{..} + = object + (catMaybes + [Just ("kind" .= _svsKind), + ("companionSettings" .=) <$> _svsCompanionSettings, + ("transcodeSettings" .=) <$> _svsTranscodeSettings, + ("orientation" .=) <$> _svsOrientation, + ("skippableSettings" .=) <$> _svsSkippableSettings]) + +-- | Remarketing List Population Rule Term. +-- +-- /See:/ 'listPopulationTerm' smart constructor. +data ListPopulationTerm = + ListPopulationTerm' + { _lptOperator :: !(Maybe ListPopulationTermOperator) + , _lptValue :: !(Maybe Text) + , _lptVariableFriendlyName :: !(Maybe Text) + , _lptNegation :: !(Maybe Bool) + , _lptVariableName :: !(Maybe Text) + , _lptRemarketingListId :: !(Maybe (Textual Int64)) + , _lptType :: !(Maybe ListPopulationTermType) + , _lptContains :: !(Maybe Bool) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ListPopulationTerm' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'lptOperator' +-- +-- * 'lptValue' +-- +-- * 'lptVariableFriendlyName' +-- +-- * 'lptNegation' +-- +-- * 'lptVariableName' +-- +-- * 'lptRemarketingListId' +-- +-- * 'lptType' +-- +-- * 'lptContains' +listPopulationTerm + :: ListPopulationTerm +listPopulationTerm = + ListPopulationTerm' + { _lptOperator = Nothing + , _lptValue = Nothing + , _lptVariableFriendlyName = Nothing + , _lptNegation = Nothing + , _lptVariableName = Nothing + , _lptRemarketingListId = Nothing + , _lptType = Nothing + , _lptContains = Nothing + } + + +-- | Comparison operator of this term. This field is only relevant when type +-- is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. +lptOperator :: Lens' ListPopulationTerm (Maybe ListPopulationTermOperator) +lptOperator + = lens _lptOperator (\ s a -> s{_lptOperator = a}) + +-- | Literal to compare the variable to. This field is only relevant when +-- type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. +lptValue :: Lens' ListPopulationTerm (Maybe Text) +lptValue = lens _lptValue (\ s a -> s{_lptValue = a}) + +-- | Friendly name of this term\'s variable. This is a read-only, +-- auto-generated field. This field is only relevant when type is left +-- unset or set to CUSTOM_VARIABLE_TERM. +lptVariableFriendlyName :: Lens' ListPopulationTerm (Maybe Text) +lptVariableFriendlyName + = lens _lptVariableFriendlyName + (\ s a -> s{_lptVariableFriendlyName = a}) + +-- | Whether to negate the comparison result of this term during rule +-- evaluation. This field is only relevant when type is left unset or set +-- to CUSTOM_VARIABLE_TERM or REFERRER_TERM. +lptNegation :: Lens' ListPopulationTerm (Maybe Bool) +lptNegation + = lens _lptNegation (\ s a -> s{_lptNegation = a}) + +-- | Name of the variable (U1, U2, etc.) being compared in this term. This +-- field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or +-- REFERRER_TERM. +lptVariableName :: Lens' ListPopulationTerm (Maybe Text) +lptVariableName + = lens _lptVariableName + (\ s a -> s{_lptVariableName = a}) + +-- | ID of the list in question. This field is only relevant when type is set +-- to LIST_MEMBERSHIP_TERM. +lptRemarketingListId :: Lens' ListPopulationTerm (Maybe Int64) +lptRemarketingListId + = lens _lptRemarketingListId + (\ s a -> s{_lptRemarketingListId = a}) + . mapping _Coerce + +-- | List population term type determines the applicable fields in this +-- object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, +-- variableFriendlyName, operator, value, and negation are applicable. If +-- set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are +-- applicable. If set to REFERRER_TERM then operator, value, and negation +-- are applicable. +lptType :: Lens' ListPopulationTerm (Maybe ListPopulationTermType) +lptType = lens _lptType (\ s a -> s{_lptType = a}) + +-- | Will be true if the term should check if the user is in the list and +-- false if the term should check if the user is not in the list. This +-- field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False +-- by default. +lptContains :: Lens' ListPopulationTerm (Maybe Bool) +lptContains + = lens _lptContains (\ s a -> s{_lptContains = a}) + +instance FromJSON ListPopulationTerm where + parseJSON + = withObject "ListPopulationTerm" + (\ o -> + ListPopulationTerm' <$> + (o .:? "operator") <*> (o .:? "value") <*> + (o .:? "variableFriendlyName") + <*> (o .:? "negation") + <*> (o .:? "variableName") + <*> (o .:? "remarketingListId") + <*> (o .:? "type") + <*> (o .:? "contains")) + +instance ToJSON ListPopulationTerm where + toJSON ListPopulationTerm'{..} + = object + (catMaybes + [("operator" .=) <$> _lptOperator, + ("value" .=) <$> _lptValue, + ("variableFriendlyName" .=) <$> + _lptVariableFriendlyName, + ("negation" .=) <$> _lptNegation, + ("variableName" .=) <$> _lptVariableName, + ("remarketingListId" .=) <$> _lptRemarketingListId, + ("type" .=) <$> _lptType, + ("contains" .=) <$> _lptContains]) + +-- | Dynamic and Image Tag Settings. +-- +-- /See:/ 'tagSettings' smart constructor. +data TagSettings = + TagSettings' + { _tsDynamicTagEnabled :: !(Maybe Bool) + , _tsImageTagEnabled :: !(Maybe Bool) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'TagSettings' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'tsDynamicTagEnabled' +-- +-- * 'tsImageTagEnabled' +tagSettings + :: TagSettings +tagSettings = + TagSettings' {_tsDynamicTagEnabled = Nothing, _tsImageTagEnabled = Nothing} + + +-- | Whether dynamic floodlight tags are enabled. +tsDynamicTagEnabled :: Lens' TagSettings (Maybe Bool) +tsDynamicTagEnabled + = lens _tsDynamicTagEnabled + (\ s a -> s{_tsDynamicTagEnabled = a}) + +-- | Whether image tags are enabled. +tsImageTagEnabled :: Lens' TagSettings (Maybe Bool) +tsImageTagEnabled + = lens _tsImageTagEnabled + (\ s a -> s{_tsImageTagEnabled = a}) + +instance FromJSON TagSettings where + parseJSON + = withObject "TagSettings" + (\ o -> + TagSettings' <$> + (o .:? "dynamicTagEnabled") <*> + (o .:? "imageTagEnabled")) + +instance ToJSON TagSettings where + toJSON TagSettings'{..} + = object + (catMaybes + [("dynamicTagEnabled" .=) <$> _tsDynamicTagEnabled, + ("imageTagEnabled" .=) <$> _tsImageTagEnabled]) + +-- | Subaccount List Response +-- +-- /See:/ 'subAccountsListResponse' smart constructor. +data SubAccountsListResponse = + SubAccountsListResponse' + { _salrNextPageToken :: !(Maybe Text) + , _salrKind :: !Text + , _salrSubAccounts :: !(Maybe [SubAccount]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'SubAccountsListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'salrNextPageToken' +-- +-- * 'salrKind' +-- +-- * 'salrSubAccounts' +subAccountsListResponse + :: SubAccountsListResponse +subAccountsListResponse = + SubAccountsListResponse' + { _salrNextPageToken = Nothing + , _salrKind = "dfareporting#subaccountsListResponse" + , _salrSubAccounts = Nothing + } + + +-- | Pagination token to be used for the next list operation. +salrNextPageToken :: Lens' SubAccountsListResponse (Maybe Text) +salrNextPageToken + = lens _salrNextPageToken + (\ s a -> s{_salrNextPageToken = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#subaccountsListResponse\". +salrKind :: Lens' SubAccountsListResponse Text +salrKind = lens _salrKind (\ s a -> s{_salrKind = a}) + +-- | Subaccount collection. +salrSubAccounts :: Lens' SubAccountsListResponse [SubAccount] +salrSubAccounts + = lens _salrSubAccounts + (\ s a -> s{_salrSubAccounts = a}) + . _Default + . _Coerce + +instance FromJSON SubAccountsListResponse where + parseJSON + = withObject "SubAccountsListResponse" + (\ o -> + SubAccountsListResponse' <$> + (o .:? "nextPageToken") <*> + (o .:? "kind" .!= + "dfareporting#subaccountsListResponse") + <*> (o .:? "subaccounts" .!= mempty)) + +instance ToJSON SubAccountsListResponse where + toJSON SubAccountsListResponse'{..} + = object + (catMaybes + [("nextPageToken" .=) <$> _salrNextPageToken, + Just ("kind" .= _salrKind), + ("subaccounts" .=) <$> _salrSubAccounts]) + +-- | Region List Response +-- +-- /See:/ 'regionsListResponse' smart constructor. +data RegionsListResponse = + RegionsListResponse' + { _rlrKind :: !Text + , _rlrRegions :: !(Maybe [Region]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'RegionsListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'rlrKind' +-- +-- * 'rlrRegions' +regionsListResponse + :: RegionsListResponse +regionsListResponse = + RegionsListResponse' + {_rlrKind = "dfareporting#regionsListResponse", _rlrRegions = Nothing} + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#regionsListResponse\". +rlrKind :: Lens' RegionsListResponse Text +rlrKind = lens _rlrKind (\ s a -> s{_rlrKind = a}) + +-- | Region collection. +rlrRegions :: Lens' RegionsListResponse [Region] +rlrRegions + = lens _rlrRegions (\ s a -> s{_rlrRegions = a}) . + _Default + . _Coerce + +instance FromJSON RegionsListResponse where + parseJSON + = withObject "RegionsListResponse" + (\ o -> + RegionsListResponse' <$> + (o .:? "kind" .!= "dfareporting#regionsListResponse") + <*> (o .:? "regions" .!= mempty)) + +instance ToJSON RegionsListResponse where + toJSON RegionsListResponse'{..} + = object + (catMaybes + [Just ("kind" .= _rlrKind), + ("regions" .=) <$> _rlrRegions]) + +-- | Dynamic Tag +-- +-- /See:/ 'floodlightActivityDynamicTag' smart constructor. +data FloodlightActivityDynamicTag = + FloodlightActivityDynamicTag' + { _fadtTag :: !(Maybe Text) + , _fadtName :: !(Maybe Text) + , _fadtId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'FloodlightActivityDynamicTag' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'fadtTag' +-- +-- * 'fadtName' +-- +-- * 'fadtId' +floodlightActivityDynamicTag + :: FloodlightActivityDynamicTag +floodlightActivityDynamicTag = + FloodlightActivityDynamicTag' + {_fadtTag = Nothing, _fadtName = Nothing, _fadtId = Nothing} + + +-- | Tag code. +fadtTag :: Lens' FloodlightActivityDynamicTag (Maybe Text) +fadtTag = lens _fadtTag (\ s a -> s{_fadtTag = a}) + +-- | Name of this tag. +fadtName :: Lens' FloodlightActivityDynamicTag (Maybe Text) +fadtName = lens _fadtName (\ s a -> s{_fadtName = a}) + +-- | ID of this dynamic tag. This is a read-only, auto-generated field. +fadtId :: Lens' FloodlightActivityDynamicTag (Maybe Int64) +fadtId + = lens _fadtId (\ s a -> s{_fadtId = a}) . + mapping _Coerce + +instance FromJSON FloodlightActivityDynamicTag where + parseJSON + = withObject "FloodlightActivityDynamicTag" + (\ o -> + FloodlightActivityDynamicTag' <$> + (o .:? "tag") <*> (o .:? "name") <*> (o .:? "id")) + +instance ToJSON FloodlightActivityDynamicTag where + toJSON FloodlightActivityDynamicTag'{..} + = object + (catMaybes + [("tag" .=) <$> _fadtTag, ("name" .=) <$> _fadtName, + ("id" .=) <$> _fadtId]) + +-- | Contains information about supported video formats. +-- +-- /See:/ 'videoFormat' smart constructor. +data VideoFormat = + VideoFormat' + { _vfKind :: !Text + , _vfFileType :: !(Maybe VideoFormatFileType) + , _vfResolution :: !(Maybe Size) + , _vfTargetBitRate :: !(Maybe (Textual Int32)) + , _vfId :: !(Maybe (Textual Int32)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'VideoFormat' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'vfKind' +-- +-- * 'vfFileType' +-- +-- * 'vfResolution' +-- +-- * 'vfTargetBitRate' +-- +-- * 'vfId' +videoFormat + :: VideoFormat +videoFormat = + VideoFormat' + { _vfKind = "dfareporting#videoFormat" + , _vfFileType = Nothing + , _vfResolution = Nothing + , _vfTargetBitRate = Nothing + , _vfId = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#videoFormat\". +vfKind :: Lens' VideoFormat Text +vfKind = lens _vfKind (\ s a -> s{_vfKind = a}) + +-- | File type of the video format. +vfFileType :: Lens' VideoFormat (Maybe VideoFormatFileType) +vfFileType + = lens _vfFileType (\ s a -> s{_vfFileType = a}) + +-- | The resolution of this video format. +vfResolution :: Lens' VideoFormat (Maybe Size) +vfResolution + = lens _vfResolution (\ s a -> s{_vfResolution = a}) + +-- | The target bit rate of this video format. +vfTargetBitRate :: Lens' VideoFormat (Maybe Int32) +vfTargetBitRate + = lens _vfTargetBitRate + (\ s a -> s{_vfTargetBitRate = a}) + . mapping _Coerce + +-- | ID of the video format. +vfId :: Lens' VideoFormat (Maybe Int32) +vfId + = lens _vfId (\ s a -> s{_vfId = a}) . + mapping _Coerce + +instance FromJSON VideoFormat where + parseJSON + = withObject "VideoFormat" + (\ o -> + VideoFormat' <$> + (o .:? "kind" .!= "dfareporting#videoFormat") <*> + (o .:? "fileType") + <*> (o .:? "resolution") + <*> (o .:? "targetBitRate") + <*> (o .:? "id")) + +instance ToJSON VideoFormat where + toJSON VideoFormat'{..} + = object + (catMaybes + [Just ("kind" .= _vfKind), + ("fileType" .=) <$> _vfFileType, + ("resolution" .=) <$> _vfResolution, + ("targetBitRate" .=) <$> _vfTargetBitRate, + ("id" .=) <$> _vfId]) + +-- | DirectorySites contains properties of a website from the Site Directory. +-- Sites need to be added to an account via the Sites resource before they +-- can be assigned to a placement. +-- +-- /See:/ 'directorySite' smart constructor. +data DirectorySite = + DirectorySite' + { _dsSettings :: !(Maybe DirectorySiteSettings) + , _dsInterstitialTagFormats :: !(Maybe [DirectorySiteInterstitialTagFormatsItem]) + , _dsKind :: !Text + , _dsURL :: !(Maybe Text) + , _dsIdDimensionValue :: !(Maybe DimensionValue) + , _dsInpageTagFormats :: !(Maybe [DirectorySiteInpageTagFormatsItem]) + , _dsActive :: !(Maybe Bool) + , _dsName :: !(Maybe Text) + , _dsId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'DirectorySite' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'dsSettings' +-- +-- * 'dsInterstitialTagFormats' +-- +-- * 'dsKind' +-- +-- * 'dsURL' +-- +-- * 'dsIdDimensionValue' +-- +-- * 'dsInpageTagFormats' +-- +-- * 'dsActive' +-- +-- * 'dsName' +-- +-- * 'dsId' +directorySite + :: DirectorySite +directorySite = + DirectorySite' + { _dsSettings = Nothing + , _dsInterstitialTagFormats = Nothing + , _dsKind = "dfareporting#directorySite" + , _dsURL = Nothing + , _dsIdDimensionValue = Nothing + , _dsInpageTagFormats = Nothing + , _dsActive = Nothing + , _dsName = Nothing + , _dsId = Nothing + } + + +-- | Directory site settings. +dsSettings :: Lens' DirectorySite (Maybe DirectorySiteSettings) +dsSettings + = lens _dsSettings (\ s a -> s{_dsSettings = a}) + +-- | Tag types for interstitial placements. Acceptable values are: - +-- \"IFRAME_JAVASCRIPT_INTERSTITIAL\" - \"INTERNAL_REDIRECT_INTERSTITIAL\" +-- - \"JAVASCRIPT_INTERSTITIAL\" +dsInterstitialTagFormats :: Lens' DirectorySite [DirectorySiteInterstitialTagFormatsItem] +dsInterstitialTagFormats + = lens _dsInterstitialTagFormats + (\ s a -> s{_dsInterstitialTagFormats = a}) + . _Default + . _Coerce + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#directorySite\". +dsKind :: Lens' DirectorySite Text +dsKind = lens _dsKind (\ s a -> s{_dsKind = a}) + +-- | URL of this directory site. +dsURL :: Lens' DirectorySite (Maybe Text) +dsURL = lens _dsURL (\ s a -> s{_dsURL = a}) + +-- | Dimension value for the ID of this directory site. This is a read-only, +-- auto-generated field. +dsIdDimensionValue :: Lens' DirectorySite (Maybe DimensionValue) +dsIdDimensionValue + = lens _dsIdDimensionValue + (\ s a -> s{_dsIdDimensionValue = a}) + +-- | Tag types for regular placements. Acceptable values are: - \"STANDARD\" +-- - \"IFRAME_JAVASCRIPT_INPAGE\" - \"INTERNAL_REDIRECT_INPAGE\" - +-- \"JAVASCRIPT_INPAGE\" +dsInpageTagFormats :: Lens' DirectorySite [DirectorySiteInpageTagFormatsItem] +dsInpageTagFormats + = lens _dsInpageTagFormats + (\ s a -> s{_dsInpageTagFormats = a}) + . _Default + . _Coerce + +-- | Whether this directory site is active. +dsActive :: Lens' DirectorySite (Maybe Bool) +dsActive = lens _dsActive (\ s a -> s{_dsActive = a}) + +-- | Name of this directory site. +dsName :: Lens' DirectorySite (Maybe Text) +dsName = lens _dsName (\ s a -> s{_dsName = a}) + +-- | ID of this directory site. This is a read-only, auto-generated field. +dsId :: Lens' DirectorySite (Maybe Int64) +dsId + = lens _dsId (\ s a -> s{_dsId = a}) . + mapping _Coerce + +instance FromJSON DirectorySite where + parseJSON + = withObject "DirectorySite" + (\ o -> + DirectorySite' <$> + (o .:? "settings") <*> + (o .:? "interstitialTagFormats" .!= mempty) + <*> (o .:? "kind" .!= "dfareporting#directorySite") + <*> (o .:? "url") + <*> (o .:? "idDimensionValue") + <*> (o .:? "inpageTagFormats" .!= mempty) + <*> (o .:? "active") + <*> (o .:? "name") + <*> (o .:? "id")) + +instance ToJSON DirectorySite where + toJSON DirectorySite'{..} + = object + (catMaybes + [("settings" .=) <$> _dsSettings, + ("interstitialTagFormats" .=) <$> + _dsInterstitialTagFormats, + Just ("kind" .= _dsKind), ("url" .=) <$> _dsURL, + ("idDimensionValue" .=) <$> _dsIdDimensionValue, + ("inpageTagFormats" .=) <$> _dsInpageTagFormats, + ("active" .=) <$> _dsActive, ("name" .=) <$> _dsName, + ("id" .=) <$> _dsId]) + +-- | The properties of the report. +-- +-- /See:/ 'reportFloodlightCriteriaReportProperties' smart constructor. +data ReportFloodlightCriteriaReportProperties = + ReportFloodlightCriteriaReportProperties' + { _rfcrpIncludeUnattributedIPConversions :: !(Maybe Bool) + , _rfcrpIncludeUnattributedCookieConversions :: !(Maybe Bool) + , _rfcrpIncludeAttributedIPConversions :: !(Maybe Bool) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ReportFloodlightCriteriaReportProperties' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'rfcrpIncludeUnattributedIPConversions' +-- +-- * 'rfcrpIncludeUnattributedCookieConversions' +-- +-- * 'rfcrpIncludeAttributedIPConversions' +reportFloodlightCriteriaReportProperties + :: ReportFloodlightCriteriaReportProperties +reportFloodlightCriteriaReportProperties = + ReportFloodlightCriteriaReportProperties' + { _rfcrpIncludeUnattributedIPConversions = Nothing + , _rfcrpIncludeUnattributedCookieConversions = Nothing + , _rfcrpIncludeAttributedIPConversions = Nothing + } + + +-- | Include conversions that have no associated cookies and no exposures. +-- It’s therefore impossible to know how the user was exposed to your ads +-- during the lookback window prior to a conversion. +rfcrpIncludeUnattributedIPConversions :: Lens' ReportFloodlightCriteriaReportProperties (Maybe Bool) +rfcrpIncludeUnattributedIPConversions + = lens _rfcrpIncludeUnattributedIPConversions + (\ s a -> + s{_rfcrpIncludeUnattributedIPConversions = a}) + +-- | Include conversions of users with a DoubleClick cookie but without an +-- exposure. That means the user did not click or see an ad from the +-- advertiser within the Floodlight group, or that the interaction happened +-- outside the lookback window. +rfcrpIncludeUnattributedCookieConversions :: Lens' ReportFloodlightCriteriaReportProperties (Maybe Bool) +rfcrpIncludeUnattributedCookieConversions + = lens _rfcrpIncludeUnattributedCookieConversions + (\ s a -> + s{_rfcrpIncludeUnattributedCookieConversions = a}) + +-- | Include conversions that have no cookie, but do have an exposure path. +rfcrpIncludeAttributedIPConversions :: Lens' ReportFloodlightCriteriaReportProperties (Maybe Bool) +rfcrpIncludeAttributedIPConversions + = lens _rfcrpIncludeAttributedIPConversions + (\ s a -> + s{_rfcrpIncludeAttributedIPConversions = a}) + +instance FromJSON + ReportFloodlightCriteriaReportProperties + where + parseJSON + = withObject + "ReportFloodlightCriteriaReportProperties" + (\ o -> + ReportFloodlightCriteriaReportProperties' <$> + (o .:? "includeUnattributedIPConversions") <*> + (o .:? "includeUnattributedCookieConversions") + <*> (o .:? "includeAttributedIPConversions")) + +instance ToJSON + ReportFloodlightCriteriaReportProperties + where + toJSON ReportFloodlightCriteriaReportProperties'{..} + = object + (catMaybes + [("includeUnattributedIPConversions" .=) <$> + _rfcrpIncludeUnattributedIPConversions, + ("includeUnattributedCookieConversions" .=) <$> + _rfcrpIncludeUnattributedCookieConversions, + ("includeAttributedIPConversions" .=) <$> + _rfcrpIncludeAttributedIPConversions]) + +-- | Contains properties of a Floodlight activity group. +-- +-- /See:/ 'floodlightActivityGroup' smart constructor. +data FloodlightActivityGroup = + FloodlightActivityGroup' + { _fagTagString :: !(Maybe Text) + , _fagFloodlightConfigurationId :: !(Maybe (Textual Int64)) + , _fagKind :: !Text + , _fagAdvertiserId :: !(Maybe (Textual Int64)) + , _fagAdvertiserIdDimensionValue :: !(Maybe DimensionValue) + , _fagIdDimensionValue :: !(Maybe DimensionValue) + , _fagAccountId :: !(Maybe (Textual Int64)) + , _fagName :: !(Maybe Text) + , _fagId :: !(Maybe (Textual Int64)) + , _fagSubAccountId :: !(Maybe (Textual Int64)) + , _fagType :: !(Maybe FloodlightActivityGroupType) + , _fagFloodlightConfigurationIdDimensionValue :: !(Maybe DimensionValue) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'FloodlightActivityGroup' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'fagTagString' +-- +-- * 'fagFloodlightConfigurationId' +-- +-- * 'fagKind' +-- +-- * 'fagAdvertiserId' +-- +-- * 'fagAdvertiserIdDimensionValue' +-- +-- * 'fagIdDimensionValue' +-- +-- * 'fagAccountId' +-- +-- * 'fagName' +-- +-- * 'fagId' +-- +-- * 'fagSubAccountId' +-- +-- * 'fagType' +-- +-- * 'fagFloodlightConfigurationIdDimensionValue' +floodlightActivityGroup + :: FloodlightActivityGroup +floodlightActivityGroup = + FloodlightActivityGroup' + { _fagTagString = Nothing + , _fagFloodlightConfigurationId = Nothing + , _fagKind = "dfareporting#floodlightActivityGroup" + , _fagAdvertiserId = Nothing + , _fagAdvertiserIdDimensionValue = Nothing + , _fagIdDimensionValue = Nothing + , _fagAccountId = Nothing + , _fagName = Nothing + , _fagId = Nothing + , _fagSubAccountId = Nothing + , _fagType = Nothing + , _fagFloodlightConfigurationIdDimensionValue = Nothing + } + + +-- | Value of the type= parameter in the floodlight tag, which the ad servers +-- use to identify the activity group that the activity belongs to. This is +-- optional: if empty, a new tag string will be generated for you. This +-- string must be 1 to 8 characters long, with valid characters being +-- [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among +-- activity groups of the same floodlight configuration. This field is +-- read-only after insertion. +fagTagString :: Lens' FloodlightActivityGroup (Maybe Text) +fagTagString + = lens _fagTagString (\ s a -> s{_fagTagString = a}) + +-- | Floodlight configuration ID of this floodlight activity group. This is a +-- required field. +fagFloodlightConfigurationId :: Lens' FloodlightActivityGroup (Maybe Int64) +fagFloodlightConfigurationId + = lens _fagFloodlightConfigurationId + (\ s a -> s{_fagFloodlightConfigurationId = a}) + . mapping _Coerce + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#floodlightActivityGroup\". +fagKind :: Lens' FloodlightActivityGroup Text +fagKind = lens _fagKind (\ s a -> s{_fagKind = a}) + +-- | Advertiser ID of this floodlight activity group. If this field is left +-- blank, the value will be copied over either from the floodlight +-- configuration\'s advertiser or from the existing activity group\'s +-- advertiser. +fagAdvertiserId :: Lens' FloodlightActivityGroup (Maybe Int64) +fagAdvertiserId + = lens _fagAdvertiserId + (\ s a -> s{_fagAdvertiserId = a}) + . mapping _Coerce + +-- | Dimension value for the ID of the advertiser. This is a read-only, +-- auto-generated field. +fagAdvertiserIdDimensionValue :: Lens' FloodlightActivityGroup (Maybe DimensionValue) +fagAdvertiserIdDimensionValue + = lens _fagAdvertiserIdDimensionValue + (\ s a -> s{_fagAdvertiserIdDimensionValue = a}) + +-- | Dimension value for the ID of this floodlight activity group. This is a +-- read-only, auto-generated field. +fagIdDimensionValue :: Lens' FloodlightActivityGroup (Maybe DimensionValue) +fagIdDimensionValue + = lens _fagIdDimensionValue + (\ s a -> s{_fagIdDimensionValue = a}) + +-- | Account ID of this floodlight activity group. This is a read-only field +-- that can be left blank. +fagAccountId :: Lens' FloodlightActivityGroup (Maybe Int64) +fagAccountId + = lens _fagAccountId (\ s a -> s{_fagAccountId = a}) + . mapping _Coerce + +-- | Name of this floodlight activity group. This is a required field. Must +-- be less than 65 characters long and cannot contain quotes. +fagName :: Lens' FloodlightActivityGroup (Maybe Text) +fagName = lens _fagName (\ s a -> s{_fagName = a}) + +-- | ID of this floodlight activity group. This is a read-only, +-- auto-generated field. +fagId :: Lens' FloodlightActivityGroup (Maybe Int64) +fagId + = lens _fagId (\ s a -> s{_fagId = a}) . + mapping _Coerce + +-- | Subaccount ID of this floodlight activity group. This is a read-only +-- field that can be left blank. +fagSubAccountId :: Lens' FloodlightActivityGroup (Maybe Int64) +fagSubAccountId + = lens _fagSubAccountId + (\ s a -> s{_fagSubAccountId = a}) + . mapping _Coerce + +-- | Type of the floodlight activity group. This is a required field that is +-- read-only after insertion. +fagType :: Lens' FloodlightActivityGroup (Maybe FloodlightActivityGroupType) +fagType = lens _fagType (\ s a -> s{_fagType = a}) + +-- | Dimension value for the ID of the floodlight configuration. This is a +-- read-only, auto-generated field. +fagFloodlightConfigurationIdDimensionValue :: Lens' FloodlightActivityGroup (Maybe DimensionValue) +fagFloodlightConfigurationIdDimensionValue + = lens _fagFloodlightConfigurationIdDimensionValue + (\ s a -> + s{_fagFloodlightConfigurationIdDimensionValue = a}) + +instance FromJSON FloodlightActivityGroup where + parseJSON + = withObject "FloodlightActivityGroup" + (\ o -> + FloodlightActivityGroup' <$> + (o .:? "tagString") <*> + (o .:? "floodlightConfigurationId") + <*> + (o .:? "kind" .!= + "dfareporting#floodlightActivityGroup") + <*> (o .:? "advertiserId") + <*> (o .:? "advertiserIdDimensionValue") + <*> (o .:? "idDimensionValue") + <*> (o .:? "accountId") + <*> (o .:? "name") + <*> (o .:? "id") + <*> (o .:? "subaccountId") + <*> (o .:? "type") + <*> + (o .:? "floodlightConfigurationIdDimensionValue")) + +instance ToJSON FloodlightActivityGroup where + toJSON FloodlightActivityGroup'{..} + = object + (catMaybes + [("tagString" .=) <$> _fagTagString, + ("floodlightConfigurationId" .=) <$> + _fagFloodlightConfigurationId, + Just ("kind" .= _fagKind), + ("advertiserId" .=) <$> _fagAdvertiserId, + ("advertiserIdDimensionValue" .=) <$> + _fagAdvertiserIdDimensionValue, + ("idDimensionValue" .=) <$> _fagIdDimensionValue, + ("accountId" .=) <$> _fagAccountId, + ("name" .=) <$> _fagName, ("id" .=) <$> _fagId, + ("subaccountId" .=) <$> _fagSubAccountId, + ("type" .=) <$> _fagType, + ("floodlightConfigurationIdDimensionValue" .=) <$> + _fagFloodlightConfigurationIdDimensionValue]) + +-- | Represents fields that are compatible to be selected for a report of +-- type \"CROSS_DIMENSION_REACH\". +-- +-- /See:/ 'crossDimensionReachReportCompatibleFields' smart constructor. +data CrossDimensionReachReportCompatibleFields = + CrossDimensionReachReportCompatibleFields' + { _cdrrcfMetrics :: !(Maybe [Metric]) + , _cdrrcfBreakdown :: !(Maybe [Dimension]) + , _cdrrcfKind :: !Text + , _cdrrcfDimensionFilters :: !(Maybe [Dimension]) + , _cdrrcfOverlapMetrics :: !(Maybe [Metric]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'CrossDimensionReachReportCompatibleFields' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'cdrrcfMetrics' +-- +-- * 'cdrrcfBreakdown' +-- +-- * 'cdrrcfKind' +-- +-- * 'cdrrcfDimensionFilters' +-- +-- * 'cdrrcfOverlapMetrics' +crossDimensionReachReportCompatibleFields + :: CrossDimensionReachReportCompatibleFields +crossDimensionReachReportCompatibleFields = + CrossDimensionReachReportCompatibleFields' + { _cdrrcfMetrics = Nothing + , _cdrrcfBreakdown = Nothing + , _cdrrcfKind = "dfareporting#crossDimensionReachReportCompatibleFields" + , _cdrrcfDimensionFilters = Nothing + , _cdrrcfOverlapMetrics = Nothing + } + + +-- | Metrics which are compatible to be selected in the \"metricNames\" +-- section of the report. +cdrrcfMetrics :: Lens' CrossDimensionReachReportCompatibleFields [Metric] +cdrrcfMetrics + = lens _cdrrcfMetrics + (\ s a -> s{_cdrrcfMetrics = a}) + . _Default + . _Coerce + +-- | Dimensions which are compatible to be selected in the \"breakdown\" +-- section of the report. +cdrrcfBreakdown :: Lens' CrossDimensionReachReportCompatibleFields [Dimension] +cdrrcfBreakdown + = lens _cdrrcfBreakdown + (\ s a -> s{_cdrrcfBreakdown = a}) + . _Default + . _Coerce + +-- | The kind of resource this is, in this case +-- dfareporting#crossDimensionReachReportCompatibleFields. +cdrrcfKind :: Lens' CrossDimensionReachReportCompatibleFields Text +cdrrcfKind + = lens _cdrrcfKind (\ s a -> s{_cdrrcfKind = a}) + +-- | Dimensions which are compatible to be selected in the +-- \"dimensionFilters\" section of the report. +cdrrcfDimensionFilters :: Lens' CrossDimensionReachReportCompatibleFields [Dimension] +cdrrcfDimensionFilters + = lens _cdrrcfDimensionFilters + (\ s a -> s{_cdrrcfDimensionFilters = a}) + . _Default + . _Coerce + +-- | Metrics which are compatible to be selected in the +-- \"overlapMetricNames\" section of the report. +cdrrcfOverlapMetrics :: Lens' CrossDimensionReachReportCompatibleFields [Metric] +cdrrcfOverlapMetrics + = lens _cdrrcfOverlapMetrics + (\ s a -> s{_cdrrcfOverlapMetrics = a}) + . _Default + . _Coerce + +instance FromJSON + CrossDimensionReachReportCompatibleFields + where + parseJSON + = withObject + "CrossDimensionReachReportCompatibleFields" + (\ o -> + CrossDimensionReachReportCompatibleFields' <$> + (o .:? "metrics" .!= mempty) <*> + (o .:? "breakdown" .!= mempty) + <*> + (o .:? "kind" .!= + "dfareporting#crossDimensionReachReportCompatibleFields") + <*> (o .:? "dimensionFilters" .!= mempty) + <*> (o .:? "overlapMetrics" .!= mempty)) + +instance ToJSON + CrossDimensionReachReportCompatibleFields + where + toJSON CrossDimensionReachReportCompatibleFields'{..} + = object + (catMaybes + [("metrics" .=) <$> _cdrrcfMetrics, + ("breakdown" .=) <$> _cdrrcfBreakdown, + Just ("kind" .= _cdrrcfKind), + ("dimensionFilters" .=) <$> _cdrrcfDimensionFilters, + ("overlapMetrics" .=) <$> _cdrrcfOverlapMetrics]) + +-- | FsCommand. +-- +-- /See:/ 'fsCommand' smart constructor. +data FsCommand = + FsCommand' + { _fcPositionOption :: !(Maybe FsCommandPositionOption) + , _fcLeft :: !(Maybe (Textual Int32)) + , _fcWindowHeight :: !(Maybe (Textual Int32)) + , _fcWindowWidth :: !(Maybe (Textual Int32)) + , _fcTop :: !(Maybe (Textual Int32)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'FsCommand' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'fcPositionOption' +-- +-- * 'fcLeft' +-- +-- * 'fcWindowHeight' +-- +-- * 'fcWindowWidth' +-- +-- * 'fcTop' +fsCommand + :: FsCommand +fsCommand = + FsCommand' + { _fcPositionOption = Nothing + , _fcLeft = Nothing + , _fcWindowHeight = Nothing + , _fcWindowWidth = Nothing + , _fcTop = Nothing + } + + +-- | Position in the browser where the window will open. +fcPositionOption :: Lens' FsCommand (Maybe FsCommandPositionOption) +fcPositionOption + = lens _fcPositionOption + (\ s a -> s{_fcPositionOption = a}) + +-- | Distance from the left of the browser.Applicable when positionOption is +-- DISTANCE_FROM_TOP_LEFT_CORNER. +fcLeft :: Lens' FsCommand (Maybe Int32) +fcLeft + = lens _fcLeft (\ s a -> s{_fcLeft = a}) . + mapping _Coerce + +-- | Height of the window. +fcWindowHeight :: Lens' FsCommand (Maybe Int32) +fcWindowHeight + = lens _fcWindowHeight + (\ s a -> s{_fcWindowHeight = a}) + . mapping _Coerce + +-- | Width of the window. +fcWindowWidth :: Lens' FsCommand (Maybe Int32) +fcWindowWidth + = lens _fcWindowWidth + (\ s a -> s{_fcWindowWidth = a}) + . mapping _Coerce + +-- | Distance from the top of the browser. Applicable when positionOption is +-- DISTANCE_FROM_TOP_LEFT_CORNER. +fcTop :: Lens' FsCommand (Maybe Int32) +fcTop + = lens _fcTop (\ s a -> s{_fcTop = a}) . + mapping _Coerce + +instance FromJSON FsCommand where + parseJSON + = withObject "FsCommand" + (\ o -> + FsCommand' <$> + (o .:? "positionOption") <*> (o .:? "left") <*> + (o .:? "windowHeight") + <*> (o .:? "windowWidth") + <*> (o .:? "top")) + +instance ToJSON FsCommand where + toJSON FsCommand'{..} + = object + (catMaybes + [("positionOption" .=) <$> _fcPositionOption, + ("left" .=) <$> _fcLeft, + ("windowHeight" .=) <$> _fcWindowHeight, + ("windowWidth" .=) <$> _fcWindowWidth, + ("top" .=) <$> _fcTop]) + +-- | Placement Assignment. +-- +-- /See:/ 'placementAssignment' smart constructor. +data PlacementAssignment = + PlacementAssignment' + { _paPlacementId :: !(Maybe (Textual Int64)) + , _paPlacementIdDimensionValue :: !(Maybe DimensionValue) + , _paActive :: !(Maybe Bool) + , _paSSLRequired :: !(Maybe Bool) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'PlacementAssignment' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'paPlacementId' +-- +-- * 'paPlacementIdDimensionValue' +-- +-- * 'paActive' +-- +-- * 'paSSLRequired' +placementAssignment + :: PlacementAssignment +placementAssignment = + PlacementAssignment' + { _paPlacementId = Nothing + , _paPlacementIdDimensionValue = Nothing + , _paActive = Nothing + , _paSSLRequired = Nothing + } + + +-- | ID of the placement to be assigned. This is a required field. +paPlacementId :: Lens' PlacementAssignment (Maybe Int64) +paPlacementId + = lens _paPlacementId + (\ s a -> s{_paPlacementId = a}) + . mapping _Coerce + +-- | Dimension value for the ID of the placement. This is a read-only, +-- auto-generated field. +paPlacementIdDimensionValue :: Lens' PlacementAssignment (Maybe DimensionValue) +paPlacementIdDimensionValue + = lens _paPlacementIdDimensionValue + (\ s a -> s{_paPlacementIdDimensionValue = a}) + +-- | Whether this placement assignment is active. When true, the placement +-- will be included in the ad\'s rotation. +paActive :: Lens' PlacementAssignment (Maybe Bool) +paActive = lens _paActive (\ s a -> s{_paActive = a}) + +-- | Whether the placement to be assigned requires SSL. This is a read-only +-- field that is auto-generated when the ad is inserted or updated. +paSSLRequired :: Lens' PlacementAssignment (Maybe Bool) +paSSLRequired + = lens _paSSLRequired + (\ s a -> s{_paSSLRequired = a}) + +instance FromJSON PlacementAssignment where + parseJSON + = withObject "PlacementAssignment" + (\ o -> + PlacementAssignment' <$> + (o .:? "placementId") <*> + (o .:? "placementIdDimensionValue") + <*> (o .:? "active") + <*> (o .:? "sslRequired")) + +instance ToJSON PlacementAssignment where + toJSON PlacementAssignment'{..} + = object + (catMaybes + [("placementId" .=) <$> _paPlacementId, + ("placementIdDimensionValue" .=) <$> + _paPlacementIdDimensionValue, + ("active" .=) <$> _paActive, + ("sslRequired" .=) <$> _paSSLRequired]) + +-- | Contains properties of a creative field value. +-- +-- /See:/ 'creativeFieldValue' smart constructor. +data CreativeFieldValue = + CreativeFieldValue' + { _cfvKind :: !Text + , _cfvValue :: !(Maybe Text) + , _cfvId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'CreativeFieldValue' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'cfvKind' +-- +-- * 'cfvValue' +-- +-- * 'cfvId' +creativeFieldValue + :: CreativeFieldValue +creativeFieldValue = + CreativeFieldValue' + { _cfvKind = "dfareporting#creativeFieldValue" + , _cfvValue = Nothing + , _cfvId = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#creativeFieldValue\". +cfvKind :: Lens' CreativeFieldValue Text +cfvKind = lens _cfvKind (\ s a -> s{_cfvKind = a}) + +-- | Value of this creative field value. It needs to be less than 256 +-- characters in length and unique per creative field. +cfvValue :: Lens' CreativeFieldValue (Maybe Text) +cfvValue = lens _cfvValue (\ s a -> s{_cfvValue = a}) + +-- | ID of this creative field value. This is a read-only, auto-generated +-- field. +cfvId :: Lens' CreativeFieldValue (Maybe Int64) +cfvId + = lens _cfvId (\ s a -> s{_cfvId = a}) . + mapping _Coerce + +instance FromJSON CreativeFieldValue where + parseJSON + = withObject "CreativeFieldValue" + (\ o -> + CreativeFieldValue' <$> + (o .:? "kind" .!= "dfareporting#creativeFieldValue") + <*> (o .:? "value") + <*> (o .:? "id")) + +instance ToJSON CreativeFieldValue where + toJSON CreativeFieldValue'{..} + = object + (catMaybes + [Just ("kind" .= _cfvKind), + ("value" .=) <$> _cfvValue, ("id" .=) <$> _cfvId]) + +-- | Represents a DimensionValuesRequest. +-- +-- /See:/ 'dimensionValueRequest' smart constructor. +data DimensionValueRequest = + DimensionValueRequest' + { _dvrKind :: !Text + , _dvrEndDate :: !(Maybe Date') + , _dvrFilters :: !(Maybe [DimensionFilter]) + , _dvrStartDate :: !(Maybe Date') + , _dvrDimensionName :: !(Maybe Text) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'DimensionValueRequest' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'dvrKind' +-- +-- * 'dvrEndDate' +-- +-- * 'dvrFilters' +-- +-- * 'dvrStartDate' +-- +-- * 'dvrDimensionName' +dimensionValueRequest + :: DimensionValueRequest +dimensionValueRequest = + DimensionValueRequest' + { _dvrKind = "dfareporting#dimensionValueRequest" + , _dvrEndDate = Nothing + , _dvrFilters = Nothing + , _dvrStartDate = Nothing + , _dvrDimensionName = Nothing + } + + +-- | The kind of request this is, in this case +-- dfareporting#dimensionValueRequest. +dvrKind :: Lens' DimensionValueRequest Text +dvrKind = lens _dvrKind (\ s a -> s{_dvrKind = a}) + +-- | The end date of the date range for which to retrieve dimension values. A +-- string of the format \"yyyy-MM-dd\". +dvrEndDate :: Lens' DimensionValueRequest (Maybe Day) +dvrEndDate + = lens _dvrEndDate (\ s a -> s{_dvrEndDate = a}) . + mapping _Date + +-- | The list of filters by which to filter values. The filters are ANDed. +dvrFilters :: Lens' DimensionValueRequest [DimensionFilter] +dvrFilters + = lens _dvrFilters (\ s a -> s{_dvrFilters = a}) . + _Default + . _Coerce + +-- | The start date of the date range for which to retrieve dimension values. +-- A string of the format \"yyyy-MM-dd\". +dvrStartDate :: Lens' DimensionValueRequest (Maybe Day) +dvrStartDate + = lens _dvrStartDate (\ s a -> s{_dvrStartDate = a}) + . mapping _Date + +-- | The name of the dimension for which values should be requested. +dvrDimensionName :: Lens' DimensionValueRequest (Maybe Text) +dvrDimensionName + = lens _dvrDimensionName + (\ s a -> s{_dvrDimensionName = a}) + +instance FromJSON DimensionValueRequest where + parseJSON + = withObject "DimensionValueRequest" + (\ o -> + DimensionValueRequest' <$> + (o .:? "kind" .!= + "dfareporting#dimensionValueRequest") + <*> (o .:? "endDate") + <*> (o .:? "filters" .!= mempty) + <*> (o .:? "startDate") + <*> (o .:? "dimensionName")) + +instance ToJSON DimensionValueRequest where + toJSON DimensionValueRequest'{..} + = object + (catMaybes + [Just ("kind" .= _dvrKind), + ("endDate" .=) <$> _dvrEndDate, + ("filters" .=) <$> _dvrFilters, + ("startDate" .=) <$> _dvrStartDate, + ("dimensionName" .=) <$> _dvrDimensionName]) + +-- | Floodlight Configuration List Response +-- +-- /See:/ 'floodlightConfigurationsListResponse' smart constructor. +data FloodlightConfigurationsListResponse = + FloodlightConfigurationsListResponse' + { _fclrKind :: !Text + , _fclrFloodlightConfigurations :: !(Maybe [FloodlightConfiguration]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'FloodlightConfigurationsListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'fclrKind' +-- +-- * 'fclrFloodlightConfigurations' +floodlightConfigurationsListResponse + :: FloodlightConfigurationsListResponse +floodlightConfigurationsListResponse = + FloodlightConfigurationsListResponse' + { _fclrKind = "dfareporting#floodlightConfigurationsListResponse" + , _fclrFloodlightConfigurations = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#floodlightConfigurationsListResponse\". +fclrKind :: Lens' FloodlightConfigurationsListResponse Text +fclrKind = lens _fclrKind (\ s a -> s{_fclrKind = a}) + +-- | Floodlight configuration collection. +fclrFloodlightConfigurations :: Lens' FloodlightConfigurationsListResponse [FloodlightConfiguration] +fclrFloodlightConfigurations + = lens _fclrFloodlightConfigurations + (\ s a -> s{_fclrFloodlightConfigurations = a}) + . _Default + . _Coerce + +instance FromJSON + FloodlightConfigurationsListResponse + where + parseJSON + = withObject "FloodlightConfigurationsListResponse" + (\ o -> + FloodlightConfigurationsListResponse' <$> + (o .:? "kind" .!= + "dfareporting#floodlightConfigurationsListResponse") + <*> (o .:? "floodlightConfigurations" .!= mempty)) + +instance ToJSON FloodlightConfigurationsListResponse + where + toJSON FloodlightConfigurationsListResponse'{..} + = object + (catMaybes + [Just ("kind" .= _fclrKind), + ("floodlightConfigurations" .=) <$> + _fclrFloodlightConfigurations]) + +-- | Floodlight Activity List Response +-- +-- /See:/ 'floodlightActivitiesListResponse' smart constructor. +data FloodlightActivitiesListResponse = + FloodlightActivitiesListResponse' + { _falrNextPageToken :: !(Maybe Text) + , _falrKind :: !Text + , _falrFloodlightActivities :: !(Maybe [FloodlightActivity]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'FloodlightActivitiesListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'falrNextPageToken' +-- +-- * 'falrKind' +-- +-- * 'falrFloodlightActivities' +floodlightActivitiesListResponse + :: FloodlightActivitiesListResponse +floodlightActivitiesListResponse = + FloodlightActivitiesListResponse' + { _falrNextPageToken = Nothing + , _falrKind = "dfareporting#floodlightActivitiesListResponse" + , _falrFloodlightActivities = Nothing + } + + +-- | Pagination token to be used for the next list operation. +falrNextPageToken :: Lens' FloodlightActivitiesListResponse (Maybe Text) +falrNextPageToken + = lens _falrNextPageToken + (\ s a -> s{_falrNextPageToken = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#floodlightActivitiesListResponse\". +falrKind :: Lens' FloodlightActivitiesListResponse Text +falrKind = lens _falrKind (\ s a -> s{_falrKind = a}) + +-- | Floodlight activity collection. +falrFloodlightActivities :: Lens' FloodlightActivitiesListResponse [FloodlightActivity] +falrFloodlightActivities + = lens _falrFloodlightActivities + (\ s a -> s{_falrFloodlightActivities = a}) + . _Default + . _Coerce + +instance FromJSON FloodlightActivitiesListResponse + where + parseJSON + = withObject "FloodlightActivitiesListResponse" + (\ o -> + FloodlightActivitiesListResponse' <$> + (o .:? "nextPageToken") <*> + (o .:? "kind" .!= + "dfareporting#floodlightActivitiesListResponse") + <*> (o .:? "floodlightActivities" .!= mempty)) + +instance ToJSON FloodlightActivitiesListResponse + where + toJSON FloodlightActivitiesListResponse'{..} + = object + (catMaybes + [("nextPageToken" .=) <$> _falrNextPageToken, + Just ("kind" .= _falrKind), + ("floodlightActivities" .=) <$> + _falrFloodlightActivities]) + +-- | Creative Field Assignment. +-- +-- /See:/ 'creativeFieldAssignment' smart constructor. +data CreativeFieldAssignment = + CreativeFieldAssignment' + { _cfaCreativeFieldId :: !(Maybe (Textual Int64)) + , _cfaCreativeFieldValueId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'CreativeFieldAssignment' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'cfaCreativeFieldId' +-- +-- * 'cfaCreativeFieldValueId' +creativeFieldAssignment + :: CreativeFieldAssignment +creativeFieldAssignment = + CreativeFieldAssignment' + {_cfaCreativeFieldId = Nothing, _cfaCreativeFieldValueId = Nothing} + + +-- | ID of the creative field. +cfaCreativeFieldId :: Lens' CreativeFieldAssignment (Maybe Int64) +cfaCreativeFieldId + = lens _cfaCreativeFieldId + (\ s a -> s{_cfaCreativeFieldId = a}) + . mapping _Coerce + +-- | ID of the creative field value. +cfaCreativeFieldValueId :: Lens' CreativeFieldAssignment (Maybe Int64) +cfaCreativeFieldValueId + = lens _cfaCreativeFieldValueId + (\ s a -> s{_cfaCreativeFieldValueId = a}) + . mapping _Coerce + +instance FromJSON CreativeFieldAssignment where + parseJSON + = withObject "CreativeFieldAssignment" + (\ o -> + CreativeFieldAssignment' <$> + (o .:? "creativeFieldId") <*> + (o .:? "creativeFieldValueId")) + +instance ToJSON CreativeFieldAssignment where + toJSON CreativeFieldAssignment'{..} + = object + (catMaybes + [("creativeFieldId" .=) <$> _cfaCreativeFieldId, + ("creativeFieldValueId" .=) <$> + _cfaCreativeFieldValueId]) + +-- | Groups advertisers together so that reports can be generated for the +-- entire group at once. +-- +-- /See:/ 'advertiserGroup' smart constructor. +data AdvertiserGroup = + AdvertiserGroup' + { _agKind :: !Text + , _agAccountId :: !(Maybe (Textual Int64)) + , _agName :: !(Maybe Text) + , _agId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'AdvertiserGroup' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'agKind' +-- +-- * 'agAccountId' +-- +-- * 'agName' +-- +-- * 'agId' +advertiserGroup + :: AdvertiserGroup +advertiserGroup = + AdvertiserGroup' + { _agKind = "dfareporting#advertiserGroup" + , _agAccountId = Nothing + , _agName = Nothing + , _agId = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#advertiserGroup\". +agKind :: Lens' AdvertiserGroup Text +agKind = lens _agKind (\ s a -> s{_agKind = a}) + +-- | Account ID of this advertiser group. This is a read-only field that can +-- be left blank. +agAccountId :: Lens' AdvertiserGroup (Maybe Int64) +agAccountId + = lens _agAccountId (\ s a -> s{_agAccountId = a}) . + mapping _Coerce + +-- | Name of this advertiser group. This is a required field and must be less +-- than 256 characters long and unique among advertiser groups of the same +-- account. +agName :: Lens' AdvertiserGroup (Maybe Text) +agName = lens _agName (\ s a -> s{_agName = a}) + +-- | ID of this advertiser group. This is a read-only, auto-generated field. +agId :: Lens' AdvertiserGroup (Maybe Int64) +agId + = lens _agId (\ s a -> s{_agId = a}) . + mapping _Coerce + +instance FromJSON AdvertiserGroup where + parseJSON + = withObject "AdvertiserGroup" + (\ o -> + AdvertiserGroup' <$> + (o .:? "kind" .!= "dfareporting#advertiserGroup") <*> + (o .:? "accountId") + <*> (o .:? "name") + <*> (o .:? "id")) + +instance ToJSON AdvertiserGroup where + toJSON AdvertiserGroup'{..} + = object + (catMaybes + [Just ("kind" .= _agKind), + ("accountId" .=) <$> _agAccountId, + ("name" .=) <$> _agName, ("id" .=) <$> _agId]) + +-- | Placement Tag Data +-- +-- /See:/ 'tagData' smart constructor. +data TagData = + TagData' + { _tdClickTag :: !(Maybe Text) + , _tdFormat :: !(Maybe TagDataFormat) + , _tdCreativeId :: !(Maybe (Textual Int64)) + , _tdAdId :: !(Maybe (Textual Int64)) + , _tdImpressionTag :: !(Maybe Text) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'TagData' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'tdClickTag' +-- +-- * 'tdFormat' +-- +-- * 'tdCreativeId' +-- +-- * 'tdAdId' +-- +-- * 'tdImpressionTag' +tagData + :: TagData +tagData = + TagData' + { _tdClickTag = Nothing + , _tdFormat = Nothing + , _tdCreativeId = Nothing + , _tdAdId = Nothing + , _tdImpressionTag = Nothing + } + + +-- | Tag string to record a click. +tdClickTag :: Lens' TagData (Maybe Text) +tdClickTag + = lens _tdClickTag (\ s a -> s{_tdClickTag = a}) + +-- | TagData tag format of this tag. +tdFormat :: Lens' TagData (Maybe TagDataFormat) +tdFormat = lens _tdFormat (\ s a -> s{_tdFormat = a}) + +-- | Creative associated with this placement tag. Applicable only when format +-- is PLACEMENT_TAG_TRACKING. +tdCreativeId :: Lens' TagData (Maybe Int64) +tdCreativeId + = lens _tdCreativeId (\ s a -> s{_tdCreativeId = a}) + . mapping _Coerce + +-- | Ad associated with this placement tag. Applicable only when format is +-- PLACEMENT_TAG_TRACKING. +tdAdId :: Lens' TagData (Maybe Int64) +tdAdId + = lens _tdAdId (\ s a -> s{_tdAdId = a}) . + mapping _Coerce + +-- | Tag string for serving an ad. +tdImpressionTag :: Lens' TagData (Maybe Text) +tdImpressionTag + = lens _tdImpressionTag + (\ s a -> s{_tdImpressionTag = a}) + +instance FromJSON TagData where + parseJSON + = withObject "TagData" + (\ o -> + TagData' <$> + (o .:? "clickTag") <*> (o .:? "format") <*> + (o .:? "creativeId") + <*> (o .:? "adId") + <*> (o .:? "impressionTag")) + +instance ToJSON TagData where + toJSON TagData'{..} + = object + (catMaybes + [("clickTag" .=) <$> _tdClickTag, + ("format" .=) <$> _tdFormat, + ("creativeId" .=) <$> _tdCreativeId, + ("adId" .=) <$> _tdAdId, + ("impressionTag" .=) <$> _tdImpressionTag]) + +-- | Day Part Targeting. +-- +-- /See:/ 'dayPartTargeting' smart constructor. +data DayPartTargeting = + DayPartTargeting' + { _dptDaysOfWeek :: !(Maybe [DayPartTargetingDaysOfWeekItem]) + , _dptHoursOfDay :: !(Maybe [Textual Int32]) + , _dptUserLocalTime :: !(Maybe Bool) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'DayPartTargeting' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'dptDaysOfWeek' +-- +-- * 'dptHoursOfDay' +-- +-- * 'dptUserLocalTime' +dayPartTargeting + :: DayPartTargeting +dayPartTargeting = + DayPartTargeting' + { _dptDaysOfWeek = Nothing + , _dptHoursOfDay = Nothing + , _dptUserLocalTime = Nothing + } + + +-- | Days of the week when the ad will serve. Acceptable values are: - +-- \"SUNDAY\" - \"MONDAY\" - \"TUESDAY\" - \"WEDNESDAY\" - \"THURSDAY\" - +-- \"FRIDAY\" - \"SATURDAY\" +dptDaysOfWeek :: Lens' DayPartTargeting [DayPartTargetingDaysOfWeekItem] +dptDaysOfWeek + = lens _dptDaysOfWeek + (\ s a -> s{_dptDaysOfWeek = a}) + . _Default + . _Coerce + +-- | Hours of the day when the ad will serve, where 0 is midnight to 1 AM and +-- 23 is 11 PM to midnight. Can be specified with days of week, in which +-- case the ad would serve during these hours on the specified days. For +-- example if Monday, Wednesday, Friday are the days of week specified and +-- 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve +-- Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values +-- are 0 to 23, inclusive. +dptHoursOfDay :: Lens' DayPartTargeting [Int32] +dptHoursOfDay + = lens _dptHoursOfDay + (\ s a -> s{_dptHoursOfDay = a}) + . _Default + . _Coerce + +-- | Whether or not to use the user\'s local time. If false, the America\/New +-- York time zone applies. +dptUserLocalTime :: Lens' DayPartTargeting (Maybe Bool) +dptUserLocalTime + = lens _dptUserLocalTime + (\ s a -> s{_dptUserLocalTime = a}) + +instance FromJSON DayPartTargeting where + parseJSON + = withObject "DayPartTargeting" + (\ o -> + DayPartTargeting' <$> + (o .:? "daysOfWeek" .!= mempty) <*> + (o .:? "hoursOfDay" .!= mempty) + <*> (o .:? "userLocalTime")) + +instance ToJSON DayPartTargeting where + toJSON DayPartTargeting'{..} + = object + (catMaybes + [("daysOfWeek" .=) <$> _dptDaysOfWeek, + ("hoursOfDay" .=) <$> _dptHoursOfDay, + ("userLocalTime" .=) <$> _dptUserLocalTime]) + +-- | Creative optimization settings. +-- +-- /See:/ 'creativeOptimizationConfiguration' smart constructor. +data CreativeOptimizationConfiguration = + CreativeOptimizationConfiguration' + { _cocOptimizationModel :: !(Maybe CreativeOptimizationConfigurationOptimizationModel) + , _cocName :: !(Maybe Text) + , _cocOptimizationActivitys :: !(Maybe [OptimizationActivity]) + , _cocId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'CreativeOptimizationConfiguration' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'cocOptimizationModel' +-- +-- * 'cocName' +-- +-- * 'cocOptimizationActivitys' +-- +-- * 'cocId' +creativeOptimizationConfiguration + :: CreativeOptimizationConfiguration +creativeOptimizationConfiguration = + CreativeOptimizationConfiguration' + { _cocOptimizationModel = Nothing + , _cocName = Nothing + , _cocOptimizationActivitys = Nothing + , _cocId = Nothing + } + + +-- | Optimization model for this configuration. +cocOptimizationModel :: Lens' CreativeOptimizationConfiguration (Maybe CreativeOptimizationConfigurationOptimizationModel) +cocOptimizationModel + = lens _cocOptimizationModel + (\ s a -> s{_cocOptimizationModel = a}) + +-- | Name of this creative optimization config. This is a required field and +-- must be less than 129 characters long. +cocName :: Lens' CreativeOptimizationConfiguration (Maybe Text) +cocName = lens _cocName (\ s a -> s{_cocName = a}) + +-- | List of optimization activities associated with this configuration. +cocOptimizationActivitys :: Lens' CreativeOptimizationConfiguration [OptimizationActivity] +cocOptimizationActivitys + = lens _cocOptimizationActivitys + (\ s a -> s{_cocOptimizationActivitys = a}) + . _Default + . _Coerce + +-- | ID of this creative optimization config. This field is auto-generated +-- when the campaign is inserted or updated. It can be null for existing +-- campaigns. +cocId :: Lens' CreativeOptimizationConfiguration (Maybe Int64) +cocId + = lens _cocId (\ s a -> s{_cocId = a}) . + mapping _Coerce + +instance FromJSON CreativeOptimizationConfiguration + where + parseJSON + = withObject "CreativeOptimizationConfiguration" + (\ o -> + CreativeOptimizationConfiguration' <$> + (o .:? "optimizationModel") <*> (o .:? "name") <*> + (o .:? "optimizationActivitys" .!= mempty) + <*> (o .:? "id")) + +instance ToJSON CreativeOptimizationConfiguration + where + toJSON CreativeOptimizationConfiguration'{..} + = object + (catMaybes + [("optimizationModel" .=) <$> _cocOptimizationModel, + ("name" .=) <$> _cocName, + ("optimizationActivitys" .=) <$> + _cocOptimizationActivitys, + ("id" .=) <$> _cocId]) + +-- | Transcode Settings +-- +-- /See:/ 'siteTranscodeSetting' smart constructor. +data SiteTranscodeSetting = + SiteTranscodeSetting' + { _stsKind :: !Text + , _stsEnabledVideoFormats :: !(Maybe [Textual Int32]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'SiteTranscodeSetting' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'stsKind' +-- +-- * 'stsEnabledVideoFormats' +siteTranscodeSetting + :: SiteTranscodeSetting +siteTranscodeSetting = + SiteTranscodeSetting' + { _stsKind = "dfareporting#siteTranscodeSetting" + , _stsEnabledVideoFormats = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#siteTranscodeSetting\". +stsKind :: Lens' SiteTranscodeSetting Text +stsKind = lens _stsKind (\ s a -> s{_stsKind = a}) + +-- | Whitelist of video formats to be served to this site template. Set this +-- list to null or empty to serve all video formats. +stsEnabledVideoFormats :: Lens' SiteTranscodeSetting [Int32] +stsEnabledVideoFormats + = lens _stsEnabledVideoFormats + (\ s a -> s{_stsEnabledVideoFormats = a}) + . _Default + . _Coerce + +instance FromJSON SiteTranscodeSetting where + parseJSON + = withObject "SiteTranscodeSetting" + (\ o -> + SiteTranscodeSetting' <$> + (o .:? "kind" .!= + "dfareporting#siteTranscodeSetting") + <*> (o .:? "enabledVideoFormats" .!= mempty)) + +instance ToJSON SiteTranscodeSetting where + toJSON SiteTranscodeSetting'{..} + = object + (catMaybes + [Just ("kind" .= _stsKind), + ("enabledVideoFormats" .=) <$> + _stsEnabledVideoFormats]) + +-- | Click-through URL +-- +-- /See:/ 'creativeClickThroughURL' smart constructor. +data CreativeClickThroughURL = + CreativeClickThroughURL' + { _cctuComputedClickThroughURL :: !(Maybe Text) + , _cctuCustomClickThroughURL :: !(Maybe Text) + , _cctuLandingPageId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'CreativeClickThroughURL' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'cctuComputedClickThroughURL' +-- +-- * 'cctuCustomClickThroughURL' +-- +-- * 'cctuLandingPageId' +creativeClickThroughURL + :: CreativeClickThroughURL +creativeClickThroughURL = + CreativeClickThroughURL' + { _cctuComputedClickThroughURL = Nothing + , _cctuCustomClickThroughURL = Nothing + , _cctuLandingPageId = Nothing + } + + +-- | Read-only convenience field representing the actual URL that will be +-- used for this click-through. The URL is computed as follows: - If +-- landingPageId is specified then that landing page\'s URL is assigned to +-- this field. - Otherwise, the customClickThroughUrl is assigned to this +-- field. +cctuComputedClickThroughURL :: Lens' CreativeClickThroughURL (Maybe Text) +cctuComputedClickThroughURL + = lens _cctuComputedClickThroughURL + (\ s a -> s{_cctuComputedClickThroughURL = a}) + +-- | Custom click-through URL. Applicable if the landingPageId field is left +-- unset. +cctuCustomClickThroughURL :: Lens' CreativeClickThroughURL (Maybe Text) +cctuCustomClickThroughURL + = lens _cctuCustomClickThroughURL + (\ s a -> s{_cctuCustomClickThroughURL = a}) + +-- | ID of the landing page for the click-through URL. +cctuLandingPageId :: Lens' CreativeClickThroughURL (Maybe Int64) +cctuLandingPageId + = lens _cctuLandingPageId + (\ s a -> s{_cctuLandingPageId = a}) + . mapping _Coerce + +instance FromJSON CreativeClickThroughURL where + parseJSON + = withObject "CreativeClickThroughURL" + (\ o -> + CreativeClickThroughURL' <$> + (o .:? "computedClickThroughUrl") <*> + (o .:? "customClickThroughUrl") + <*> (o .:? "landingPageId")) + +instance ToJSON CreativeClickThroughURL where + toJSON CreativeClickThroughURL'{..} + = object + (catMaybes + [("computedClickThroughUrl" .=) <$> + _cctuComputedClickThroughURL, + ("customClickThroughUrl" .=) <$> + _cctuCustomClickThroughURL, + ("landingPageId" .=) <$> _cctuLandingPageId]) + +-- | The report criteria for a report of type \"STANDARD\". +-- +-- /See:/ 'reportCriteria' smart constructor. +data ReportCriteria = + ReportCriteria' + { _rcMetricNames :: !(Maybe [Text]) + , _rcCustomRichMediaEvents :: !(Maybe CustomRichMediaEvents) + , _rcDimensionFilters :: !(Maybe [DimensionValue]) + , _rcActivities :: !(Maybe Activities) + , _rcDateRange :: !(Maybe DateRange) + , _rcDimensions :: !(Maybe [SortedDimension]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ReportCriteria' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'rcMetricNames' +-- +-- * 'rcCustomRichMediaEvents' +-- +-- * 'rcDimensionFilters' +-- +-- * 'rcActivities' +-- +-- * 'rcDateRange' +-- +-- * 'rcDimensions' +reportCriteria + :: ReportCriteria +reportCriteria = + ReportCriteria' + { _rcMetricNames = Nothing + , _rcCustomRichMediaEvents = Nothing + , _rcDimensionFilters = Nothing + , _rcActivities = Nothing + , _rcDateRange = Nothing + , _rcDimensions = Nothing + } + + +-- | The list of names of metrics the report should include. +rcMetricNames :: Lens' ReportCriteria [Text] +rcMetricNames + = lens _rcMetricNames + (\ s a -> s{_rcMetricNames = a}) + . _Default + . _Coerce + +-- | Custom Rich Media Events group. +rcCustomRichMediaEvents :: Lens' ReportCriteria (Maybe CustomRichMediaEvents) +rcCustomRichMediaEvents + = lens _rcCustomRichMediaEvents + (\ s a -> s{_rcCustomRichMediaEvents = a}) + +-- | The list of filters on which dimensions are filtered. Filters for +-- different dimensions are ANDed, filters for the same dimension are +-- grouped together and ORed. +rcDimensionFilters :: Lens' ReportCriteria [DimensionValue] +rcDimensionFilters + = lens _rcDimensionFilters + (\ s a -> s{_rcDimensionFilters = a}) + . _Default + . _Coerce + +-- | Activity group. +rcActivities :: Lens' ReportCriteria (Maybe Activities) +rcActivities + = lens _rcActivities (\ s a -> s{_rcActivities = a}) + +-- | The date range for which this report should be run. +rcDateRange :: Lens' ReportCriteria (Maybe DateRange) +rcDateRange + = lens _rcDateRange (\ s a -> s{_rcDateRange = a}) + +-- | The list of standard dimensions the report should include. +rcDimensions :: Lens' ReportCriteria [SortedDimension] +rcDimensions + = lens _rcDimensions (\ s a -> s{_rcDimensions = a}) + . _Default + . _Coerce + +instance FromJSON ReportCriteria where + parseJSON + = withObject "ReportCriteria" + (\ o -> + ReportCriteria' <$> + (o .:? "metricNames" .!= mempty) <*> + (o .:? "customRichMediaEvents") + <*> (o .:? "dimensionFilters" .!= mempty) + <*> (o .:? "activities") + <*> (o .:? "dateRange") + <*> (o .:? "dimensions" .!= mempty)) + +instance ToJSON ReportCriteria where + toJSON ReportCriteria'{..} + = object + (catMaybes + [("metricNames" .=) <$> _rcMetricNames, + ("customRichMediaEvents" .=) <$> + _rcCustomRichMediaEvents, + ("dimensionFilters" .=) <$> _rcDimensionFilters, + ("activities" .=) <$> _rcActivities, + ("dateRange" .=) <$> _rcDateRange, + ("dimensions" .=) <$> _rcDimensions]) + +-- | Placement Strategy List Response +-- +-- /See:/ 'placementStrategiesListResponse' smart constructor. +data PlacementStrategiesListResponse = + PlacementStrategiesListResponse' + { _pslrPlacementStrategies :: !(Maybe [PlacementStrategy]) + , _pslrNextPageToken :: !(Maybe Text) + , _pslrKind :: !Text + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'PlacementStrategiesListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'pslrPlacementStrategies' +-- +-- * 'pslrNextPageToken' +-- +-- * 'pslrKind' +placementStrategiesListResponse + :: PlacementStrategiesListResponse +placementStrategiesListResponse = + PlacementStrategiesListResponse' + { _pslrPlacementStrategies = Nothing + , _pslrNextPageToken = Nothing + , _pslrKind = "dfareporting#placementStrategiesListResponse" + } + + +-- | Placement strategy collection. +pslrPlacementStrategies :: Lens' PlacementStrategiesListResponse [PlacementStrategy] +pslrPlacementStrategies + = lens _pslrPlacementStrategies + (\ s a -> s{_pslrPlacementStrategies = a}) + . _Default + . _Coerce + +-- | Pagination token to be used for the next list operation. +pslrNextPageToken :: Lens' PlacementStrategiesListResponse (Maybe Text) +pslrNextPageToken + = lens _pslrNextPageToken + (\ s a -> s{_pslrNextPageToken = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#placementStrategiesListResponse\". +pslrKind :: Lens' PlacementStrategiesListResponse Text +pslrKind = lens _pslrKind (\ s a -> s{_pslrKind = a}) + +instance FromJSON PlacementStrategiesListResponse + where + parseJSON + = withObject "PlacementStrategiesListResponse" + (\ o -> + PlacementStrategiesListResponse' <$> + (o .:? "placementStrategies" .!= mempty) <*> + (o .:? "nextPageToken") + <*> + (o .:? "kind" .!= + "dfareporting#placementStrategiesListResponse")) + +instance ToJSON PlacementStrategiesListResponse where + toJSON PlacementStrategiesListResponse'{..} + = object + (catMaybes + [("placementStrategies" .=) <$> + _pslrPlacementStrategies, + ("nextPageToken" .=) <$> _pslrNextPageToken, + Just ("kind" .= _pslrKind)]) + +-- | Update Conversions Response. +-- +-- /See:/ 'conversionsBatchUpdateResponse' smart constructor. +data ConversionsBatchUpdateResponse = + ConversionsBatchUpdateResponse' + { _cburStatus :: !(Maybe [ConversionStatus]) + , _cburKind :: !Text + , _cburHasFailures :: !(Maybe Bool) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ConversionsBatchUpdateResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'cburStatus' +-- +-- * 'cburKind' +-- +-- * 'cburHasFailures' +conversionsBatchUpdateResponse + :: ConversionsBatchUpdateResponse +conversionsBatchUpdateResponse = + ConversionsBatchUpdateResponse' + { _cburStatus = Nothing + , _cburKind = "dfareporting#conversionsBatchUpdateResponse" + , _cburHasFailures = Nothing + } + + +-- | The update status of each conversion. Statuses are returned in the same +-- order that conversions are updated. +cburStatus :: Lens' ConversionsBatchUpdateResponse [ConversionStatus] +cburStatus + = lens _cburStatus (\ s a -> s{_cburStatus = a}) . + _Default + . _Coerce + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#conversionsBatchUpdateResponse\". +cburKind :: Lens' ConversionsBatchUpdateResponse Text +cburKind = lens _cburKind (\ s a -> s{_cburKind = a}) + +-- | Indicates that some or all conversions failed to update. +cburHasFailures :: Lens' ConversionsBatchUpdateResponse (Maybe Bool) +cburHasFailures + = lens _cburHasFailures + (\ s a -> s{_cburHasFailures = a}) + +instance FromJSON ConversionsBatchUpdateResponse + where + parseJSON + = withObject "ConversionsBatchUpdateResponse" + (\ o -> + ConversionsBatchUpdateResponse' <$> + (o .:? "status" .!= mempty) <*> + (o .:? "kind" .!= + "dfareporting#conversionsBatchUpdateResponse") + <*> (o .:? "hasFailures")) + +instance ToJSON ConversionsBatchUpdateResponse where + toJSON ConversionsBatchUpdateResponse'{..} + = object + (catMaybes + [("status" .=) <$> _cburStatus, + Just ("kind" .= _cburKind), + ("hasFailures" .=) <$> _cburHasFailures]) + +-- | Contains properties of a Campaign Manager subaccount. +-- +-- /See:/ 'subAccount' smart constructor. +data SubAccount = + SubAccount' + { _saKind :: !Text + , _saAvailablePermissionIds :: !(Maybe [Textual Int64]) + , _saAccountId :: !(Maybe (Textual Int64)) + , _saName :: !(Maybe Text) + , _saId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'SubAccount' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'saKind' +-- +-- * 'saAvailablePermissionIds' +-- +-- * 'saAccountId' +-- +-- * 'saName' +-- +-- * 'saId' +subAccount + :: SubAccount +subAccount = + SubAccount' + { _saKind = "dfareporting#subaccount" + , _saAvailablePermissionIds = Nothing + , _saAccountId = Nothing + , _saName = Nothing + , _saId = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#subaccount\". +saKind :: Lens' SubAccount Text +saKind = lens _saKind (\ s a -> s{_saKind = a}) + +-- | IDs of the available user role permissions for this subaccount. +saAvailablePermissionIds :: Lens' SubAccount [Int64] +saAvailablePermissionIds + = lens _saAvailablePermissionIds + (\ s a -> s{_saAvailablePermissionIds = a}) + . _Default + . _Coerce + +-- | ID of the account that contains this subaccount. This is a read-only +-- field that can be left blank. +saAccountId :: Lens' SubAccount (Maybe Int64) +saAccountId + = lens _saAccountId (\ s a -> s{_saAccountId = a}) . + mapping _Coerce + +-- | Name of this subaccount. This is a required field. Must be less than 128 +-- characters long and be unique among subaccounts of the same account. +saName :: Lens' SubAccount (Maybe Text) +saName = lens _saName (\ s a -> s{_saName = a}) + +-- | ID of this subaccount. This is a read-only, auto-generated field. +saId :: Lens' SubAccount (Maybe Int64) +saId + = lens _saId (\ s a -> s{_saId = a}) . + mapping _Coerce + +instance FromJSON SubAccount where + parseJSON + = withObject "SubAccount" + (\ o -> + SubAccount' <$> + (o .:? "kind" .!= "dfareporting#subaccount") <*> + (o .:? "availablePermissionIds" .!= mempty) + <*> (o .:? "accountId") + <*> (o .:? "name") + <*> (o .:? "id")) + +instance ToJSON SubAccount where + toJSON SubAccount'{..} + = object + (catMaybes + [Just ("kind" .= _saKind), + ("availablePermissionIds" .=) <$> + _saAvailablePermissionIds, + ("accountId" .=) <$> _saAccountId, + ("name" .=) <$> _saName, ("id" .=) <$> _saId]) + +-- | Inventory item List Response +-- +-- /See:/ 'inventoryItemsListResponse' smart constructor. +data InventoryItemsListResponse = + InventoryItemsListResponse' + { _iilrInventoryItems :: !(Maybe [InventoryItem]) + , _iilrNextPageToken :: !(Maybe Text) + , _iilrKind :: !Text + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'InventoryItemsListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'iilrInventoryItems' +-- +-- * 'iilrNextPageToken' +-- +-- * 'iilrKind' +inventoryItemsListResponse + :: InventoryItemsListResponse +inventoryItemsListResponse = + InventoryItemsListResponse' + { _iilrInventoryItems = Nothing + , _iilrNextPageToken = Nothing + , _iilrKind = "dfareporting#inventoryItemsListResponse" + } + + +-- | Inventory item collection +iilrInventoryItems :: Lens' InventoryItemsListResponse [InventoryItem] +iilrInventoryItems + = lens _iilrInventoryItems + (\ s a -> s{_iilrInventoryItems = a}) + . _Default + . _Coerce + +-- | Pagination token to be used for the next list operation. +iilrNextPageToken :: Lens' InventoryItemsListResponse (Maybe Text) +iilrNextPageToken + = lens _iilrNextPageToken + (\ s a -> s{_iilrNextPageToken = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#inventoryItemsListResponse\". +iilrKind :: Lens' InventoryItemsListResponse Text +iilrKind = lens _iilrKind (\ s a -> s{_iilrKind = a}) + +instance FromJSON InventoryItemsListResponse where + parseJSON + = withObject "InventoryItemsListResponse" + (\ o -> + InventoryItemsListResponse' <$> + (o .:? "inventoryItems" .!= mempty) <*> + (o .:? "nextPageToken") + <*> + (o .:? "kind" .!= + "dfareporting#inventoryItemsListResponse")) + +instance ToJSON InventoryItemsListResponse where + toJSON InventoryItemsListResponse'{..} + = object + (catMaybes + [("inventoryItems" .=) <$> _iilrInventoryItems, + ("nextPageToken" .=) <$> _iilrNextPageToken, + Just ("kind" .= _iilrKind)]) + +-- | A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following +-- creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID. +-- +-- /See:/ 'universalAdId' smart constructor. +data UniversalAdId = + UniversalAdId' + { _uaiValue :: !(Maybe Text) + , _uaiRegistry :: !(Maybe UniversalAdIdRegistry) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'UniversalAdId' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'uaiValue' +-- +-- * 'uaiRegistry' +universalAdId + :: UniversalAdId +universalAdId = UniversalAdId' {_uaiValue = Nothing, _uaiRegistry = Nothing} + + +-- | ID value for this creative. Only alphanumeric characters and the +-- following symbols are valid: \"_\/\\-\". Maximum length is 64 +-- characters. Read only when registry is DCM. +uaiValue :: Lens' UniversalAdId (Maybe Text) +uaiValue = lens _uaiValue (\ s a -> s{_uaiValue = a}) + +-- | Registry used for the Ad ID value. +uaiRegistry :: Lens' UniversalAdId (Maybe UniversalAdIdRegistry) +uaiRegistry + = lens _uaiRegistry (\ s a -> s{_uaiRegistry = a}) + +instance FromJSON UniversalAdId where + parseJSON + = withObject "UniversalAdId" + (\ o -> + UniversalAdId' <$> + (o .:? "value") <*> (o .:? "registry")) + +instance ToJSON UniversalAdId where + toJSON UniversalAdId'{..} + = object + (catMaybes + [("value" .=) <$> _uaiValue, + ("registry" .=) <$> _uaiRegistry]) + +-- | Contains properties of a Campaign Manager ad. +-- +-- /See:/ 'ad' smart constructor. +data Ad = + Ad' + { _aTargetingTemplateId :: !(Maybe (Textual Int64)) + , _aCreativeGroupAssignments :: !(Maybe [CreativeGroupAssignment]) + , _aGeoTargeting :: !(Maybe GeoTargeting) + , _aCreativeRotation :: !(Maybe CreativeRotation) + , _aTechnologyTargeting :: !(Maybe TechnologyTargeting) + , _aAudienceSegmentId :: !(Maybe (Textual Int64)) + , _aDayPartTargeting :: !(Maybe DayPartTargeting) + , _aSize :: !(Maybe Size) + , _aStartTime :: !(Maybe DateTime') + , _aKind :: !Text + , _aClickThroughURLSuffixProperties :: !(Maybe ClickThroughURLSuffixProperties) + , _aCampaignIdDimensionValue :: !(Maybe DimensionValue) + , _aAdvertiserId :: !(Maybe (Textual Int64)) + , _aAdvertiserIdDimensionValue :: !(Maybe DimensionValue) + , _aSSLCompliant :: !(Maybe Bool) + , _aCampaignId :: !(Maybe (Textual Int64)) + , _aIdDimensionValue :: !(Maybe DimensionValue) + , _aClickThroughURL :: !(Maybe ClickThroughURL) + , _aDeliverySchedule :: !(Maybe DeliverySchedule) + , _aEventTagOverrides :: !(Maybe [EventTagOverride]) + , _aActive :: !(Maybe Bool) + , _aAccountId :: !(Maybe (Textual Int64)) + , _aName :: !(Maybe Text) + , _aKeyValueTargetingExpression :: !(Maybe KeyValueTargetingExpression) + , _aEndTime :: !(Maybe DateTime') + , _aCreateInfo :: !(Maybe LastModifiedInfo) + , _aLastModifiedInfo :: !(Maybe LastModifiedInfo) + , _aId :: !(Maybe (Textual Int64)) + , _aSSLRequired :: !(Maybe Bool) + , _aComments :: !(Maybe Text) + , _aSubAccountId :: !(Maybe (Textual Int64)) + , _aType :: !(Maybe AdType) + , _aRemarketingListExpression :: !(Maybe ListTargetingExpression) + , _aLanguageTargeting :: !(Maybe LanguageTargeting) + , _aDynamicClickTracker :: !(Maybe Bool) + , _aCompatibility :: !(Maybe AdCompatibility) + , _aArchived :: !(Maybe Bool) + , _aDefaultClickThroughEventTagProperties :: !(Maybe DefaultClickThroughEventTagProperties) + , _aPlacementAssignments :: !(Maybe [PlacementAssignment]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'Ad' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'aTargetingTemplateId' +-- +-- * 'aCreativeGroupAssignments' +-- +-- * 'aGeoTargeting' +-- +-- * 'aCreativeRotation' +-- +-- * 'aTechnologyTargeting' +-- +-- * 'aAudienceSegmentId' +-- +-- * 'aDayPartTargeting' +-- +-- * 'aSize' +-- +-- * 'aStartTime' +-- +-- * 'aKind' +-- +-- * 'aClickThroughURLSuffixProperties' +-- +-- * 'aCampaignIdDimensionValue' +-- +-- * 'aAdvertiserId' +-- +-- * 'aAdvertiserIdDimensionValue' +-- +-- * 'aSSLCompliant' +-- +-- * 'aCampaignId' +-- +-- * 'aIdDimensionValue' +-- +-- * 'aClickThroughURL' +-- +-- * 'aDeliverySchedule' +-- +-- * 'aEventTagOverrides' +-- +-- * 'aActive' +-- +-- * 'aAccountId' +-- +-- * 'aName' +-- +-- * 'aKeyValueTargetingExpression' +-- +-- * 'aEndTime' +-- +-- * 'aCreateInfo' +-- +-- * 'aLastModifiedInfo' +-- +-- * 'aId' +-- +-- * 'aSSLRequired' +-- +-- * 'aComments' +-- +-- * 'aSubAccountId' +-- +-- * 'aType' +-- +-- * 'aRemarketingListExpression' +-- +-- * 'aLanguageTargeting' +-- +-- * 'aDynamicClickTracker' +-- +-- * 'aCompatibility' +-- +-- * 'aArchived' +-- +-- * 'aDefaultClickThroughEventTagProperties' +-- +-- * 'aPlacementAssignments' +ad + :: Ad +ad = + Ad' + { _aTargetingTemplateId = Nothing + , _aCreativeGroupAssignments = Nothing + , _aGeoTargeting = Nothing + , _aCreativeRotation = Nothing + , _aTechnologyTargeting = Nothing + , _aAudienceSegmentId = Nothing + , _aDayPartTargeting = Nothing + , _aSize = Nothing + , _aStartTime = Nothing + , _aKind = "dfareporting#ad" + , _aClickThroughURLSuffixProperties = Nothing + , _aCampaignIdDimensionValue = Nothing + , _aAdvertiserId = Nothing + , _aAdvertiserIdDimensionValue = Nothing + , _aSSLCompliant = Nothing + , _aCampaignId = Nothing + , _aIdDimensionValue = Nothing + , _aClickThroughURL = Nothing + , _aDeliverySchedule = Nothing + , _aEventTagOverrides = Nothing + , _aActive = Nothing + , _aAccountId = Nothing + , _aName = Nothing + , _aKeyValueTargetingExpression = Nothing + , _aEndTime = Nothing + , _aCreateInfo = Nothing + , _aLastModifiedInfo = Nothing + , _aId = Nothing + , _aSSLRequired = Nothing + , _aComments = Nothing + , _aSubAccountId = Nothing + , _aType = Nothing + , _aRemarketingListExpression = Nothing + , _aLanguageTargeting = Nothing + , _aDynamicClickTracker = Nothing + , _aCompatibility = Nothing + , _aArchived = Nothing + , _aDefaultClickThroughEventTagProperties = Nothing + , _aPlacementAssignments = Nothing + } + + +-- | Targeting template ID, used to apply preconfigured targeting information +-- to this ad. This cannot be set while any of dayPartTargeting, +-- geoTargeting, keyValueTargetingExpression, languageTargeting, +-- remarketingListExpression, or technologyTargeting are set. Applicable +-- when type is AD_SERVING_STANDARD_AD. +aTargetingTemplateId :: Lens' Ad (Maybe Int64) +aTargetingTemplateId + = lens _aTargetingTemplateId + (\ s a -> s{_aTargetingTemplateId = a}) + . mapping _Coerce + +-- | Creative group assignments for this ad. Applicable when type is +-- AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number +-- is allowed for a maximum of two assignments. +aCreativeGroupAssignments :: Lens' Ad [CreativeGroupAssignment] +aCreativeGroupAssignments + = lens _aCreativeGroupAssignments + (\ s a -> s{_aCreativeGroupAssignments = a}) + . _Default + . _Coerce + +-- | Geographical targeting information for this ad. This field must be left +-- blank if the ad is using a targeting template. Applicable when type is +-- AD_SERVING_STANDARD_AD. +aGeoTargeting :: Lens' Ad (Maybe GeoTargeting) +aGeoTargeting + = lens _aGeoTargeting + (\ s a -> s{_aGeoTargeting = a}) + +-- | Creative rotation for this ad. Applicable when type is +-- AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. +-- When type is AD_SERVING_DEFAULT_AD, this field should have exactly one +-- creativeAssignment. +aCreativeRotation :: Lens' Ad (Maybe CreativeRotation) +aCreativeRotation + = lens _aCreativeRotation + (\ s a -> s{_aCreativeRotation = a}) + +-- | Technology platform targeting information for this ad. This field must +-- be left blank if the ad is using a targeting template. Applicable when +-- type is AD_SERVING_STANDARD_AD. +aTechnologyTargeting :: Lens' Ad (Maybe TechnologyTargeting) +aTechnologyTargeting + = lens _aTechnologyTargeting + (\ s a -> s{_aTechnologyTargeting = a}) + +-- | Audience segment ID that is being targeted for this ad. Applicable when +-- type is AD_SERVING_STANDARD_AD. +aAudienceSegmentId :: Lens' Ad (Maybe Int64) +aAudienceSegmentId + = lens _aAudienceSegmentId + (\ s a -> s{_aAudienceSegmentId = a}) + . mapping _Coerce + +-- | Time and day targeting information for this ad. This field must be left +-- blank if the ad is using a targeting template. Applicable when type is +-- AD_SERVING_STANDARD_AD. +aDayPartTargeting :: Lens' Ad (Maybe DayPartTargeting) +aDayPartTargeting + = lens _aDayPartTargeting + (\ s a -> s{_aDayPartTargeting = a}) + +-- | Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. +aSize :: Lens' Ad (Maybe Size) +aSize = lens _aSize (\ s a -> s{_aSize = a}) + +-- | Date and time that this ad should start serving. If creating an ad, this +-- field must be a time in the future. This is a required field on +-- insertion. +aStartTime :: Lens' Ad (Maybe UTCTime) +aStartTime + = lens _aStartTime (\ s a -> s{_aStartTime = a}) . + mapping _DateTime + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#ad\". +aKind :: Lens' Ad Text +aKind = lens _aKind (\ s a -> s{_aKind = a}) + +-- | Click-through URL suffix properties for this ad. Applies to the URL in +-- the ad or (if overriding ad properties) the URL in the creative. +aClickThroughURLSuffixProperties :: Lens' Ad (Maybe ClickThroughURLSuffixProperties) +aClickThroughURLSuffixProperties + = lens _aClickThroughURLSuffixProperties + (\ s a -> s{_aClickThroughURLSuffixProperties = a}) + +-- | Dimension value for the ID of the campaign. This is a read-only, +-- auto-generated field. +aCampaignIdDimensionValue :: Lens' Ad (Maybe DimensionValue) +aCampaignIdDimensionValue + = lens _aCampaignIdDimensionValue + (\ s a -> s{_aCampaignIdDimensionValue = a}) + +-- | Advertiser ID of this ad. This is a required field on insertion. +aAdvertiserId :: Lens' Ad (Maybe Int64) +aAdvertiserId + = lens _aAdvertiserId + (\ s a -> s{_aAdvertiserId = a}) + . mapping _Coerce + +-- | Dimension value for the ID of the advertiser. This is a read-only, +-- auto-generated field. +aAdvertiserIdDimensionValue :: Lens' Ad (Maybe DimensionValue) +aAdvertiserIdDimensionValue + = lens _aAdvertiserIdDimensionValue + (\ s a -> s{_aAdvertiserIdDimensionValue = a}) + +-- | Whether this ad is ssl compliant. This is a read-only field that is +-- auto-generated when the ad is inserted or updated. +aSSLCompliant :: Lens' Ad (Maybe Bool) +aSSLCompliant + = lens _aSSLCompliant + (\ s a -> s{_aSSLCompliant = a}) + +-- | Campaign ID of this ad. This is a required field on insertion. +aCampaignId :: Lens' Ad (Maybe Int64) +aCampaignId + = lens _aCampaignId (\ s a -> s{_aCampaignId = a}) . + mapping _Coerce + +-- | Dimension value for the ID of this ad. This is a read-only, +-- auto-generated field. +aIdDimensionValue :: Lens' Ad (Maybe DimensionValue) +aIdDimensionValue + = lens _aIdDimensionValue + (\ s a -> s{_aIdDimensionValue = a}) + +-- | Click-through URL for this ad. This is a required field on insertion. +-- Applicable when type is AD_SERVING_CLICK_TRACKER. +aClickThroughURL :: Lens' Ad (Maybe ClickThroughURL) +aClickThroughURL + = lens _aClickThroughURL + (\ s a -> s{_aClickThroughURL = a}) + +-- | Delivery schedule information for this ad. Applicable when type is +-- AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with +-- subfields priority and impressionRatio are required on insertion when +-- type is AD_SERVING_STANDARD_AD. +aDeliverySchedule :: Lens' Ad (Maybe DeliverySchedule) +aDeliverySchedule + = lens _aDeliverySchedule + (\ s a -> s{_aDeliverySchedule = a}) + +-- | Event tag overrides for this ad. +aEventTagOverrides :: Lens' Ad [EventTagOverride] +aEventTagOverrides + = lens _aEventTagOverrides + (\ s a -> s{_aEventTagOverrides = a}) + . _Default + . _Coerce + +-- | Whether this ad is active. When true, archived must be false. +aActive :: Lens' Ad (Maybe Bool) +aActive = lens _aActive (\ s a -> s{_aActive = a}) + +-- | Account ID of this ad. This is a read-only field that can be left blank. +aAccountId :: Lens' Ad (Maybe Int64) +aAccountId + = lens _aAccountId (\ s a -> s{_aAccountId = a}) . + mapping _Coerce + +-- | Name of this ad. This is a required field and must be less than 256 +-- characters long. +aName :: Lens' Ad (Maybe Text) +aName = lens _aName (\ s a -> s{_aName = a}) + +-- | Key-value targeting information for this ad. This field must be left +-- blank if the ad is using a targeting template. Applicable when type is +-- AD_SERVING_STANDARD_AD. +aKeyValueTargetingExpression :: Lens' Ad (Maybe KeyValueTargetingExpression) +aKeyValueTargetingExpression + = lens _aKeyValueTargetingExpression + (\ s a -> s{_aKeyValueTargetingExpression = a}) + +-- | Date and time that this ad should stop serving. Must be later than the +-- start time. This is a required field on insertion. +aEndTime :: Lens' Ad (Maybe UTCTime) +aEndTime + = lens _aEndTime (\ s a -> s{_aEndTime = a}) . + mapping _DateTime + +-- | Information about the creation of this ad. This is a read-only field. +aCreateInfo :: Lens' Ad (Maybe LastModifiedInfo) +aCreateInfo + = lens _aCreateInfo (\ s a -> s{_aCreateInfo = a}) + +-- | Information about the most recent modification of this ad. This is a +-- read-only field. +aLastModifiedInfo :: Lens' Ad (Maybe LastModifiedInfo) +aLastModifiedInfo + = lens _aLastModifiedInfo + (\ s a -> s{_aLastModifiedInfo = a}) + +-- | ID of this ad. This is a read-only, auto-generated field. +aId :: Lens' Ad (Maybe Int64) +aId + = lens _aId (\ s a -> s{_aId = a}) . mapping _Coerce + +-- | Whether this ad requires ssl. This is a read-only field that is +-- auto-generated when the ad is inserted or updated. +aSSLRequired :: Lens' Ad (Maybe Bool) +aSSLRequired + = lens _aSSLRequired (\ s a -> s{_aSSLRequired = a}) + +-- | Comments for this ad. +aComments :: Lens' Ad (Maybe Text) +aComments + = lens _aComments (\ s a -> s{_aComments = a}) + +-- | Subaccount ID of this ad. This is a read-only field that can be left +-- blank. +aSubAccountId :: Lens' Ad (Maybe Int64) +aSubAccountId + = lens _aSubAccountId + (\ s a -> s{_aSubAccountId = a}) + . mapping _Coerce + +-- | Type of ad. This is a required field on insertion. Note that default ads +-- (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative +-- resource). +aType :: Lens' Ad (Maybe AdType) +aType = lens _aType (\ s a -> s{_aType = a}) + +-- | Remarketing list targeting expression for this ad. This field must be +-- left blank if the ad is using a targeting template. Applicable when type +-- is AD_SERVING_STANDARD_AD. +aRemarketingListExpression :: Lens' Ad (Maybe ListTargetingExpression) +aRemarketingListExpression + = lens _aRemarketingListExpression + (\ s a -> s{_aRemarketingListExpression = a}) + +-- | Language targeting information for this ad. This field must be left +-- blank if the ad is using a targeting template. Applicable when type is +-- AD_SERVING_STANDARD_AD. +aLanguageTargeting :: Lens' Ad (Maybe LanguageTargeting) +aLanguageTargeting + = lens _aLanguageTargeting + (\ s a -> s{_aLanguageTargeting = a}) + +-- | Whether this ad is a dynamic click tracker. Applicable when type is +-- AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is +-- read-only after insert. +aDynamicClickTracker :: Lens' Ad (Maybe Bool) +aDynamicClickTracker + = lens _aDynamicClickTracker + (\ s a -> s{_aDynamicClickTracker = a}) + +-- | Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. +-- DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or +-- on mobile devices or in mobile apps for regular or interstitial ads, +-- respectively. APP and APP_INTERSTITIAL are only used for existing +-- default ads. New mobile placements must be assigned DISPLAY or +-- DISPLAY_INTERSTITIAL and default ads created for those placements will +-- be limited to those compatibility types. IN_STREAM_VIDEO refers to +-- rendering in-stream video ads developed with the VAST standard. +aCompatibility :: Lens' Ad (Maybe AdCompatibility) +aCompatibility + = lens _aCompatibility + (\ s a -> s{_aCompatibility = a}) + +-- | Whether this ad is archived. When true, active must be false. +aArchived :: Lens' Ad (Maybe Bool) +aArchived + = lens _aArchived (\ s a -> s{_aArchived = a}) + +-- | Default click-through event tag properties for this ad. +aDefaultClickThroughEventTagProperties :: Lens' Ad (Maybe DefaultClickThroughEventTagProperties) +aDefaultClickThroughEventTagProperties + = lens _aDefaultClickThroughEventTagProperties + (\ s a -> + s{_aDefaultClickThroughEventTagProperties = a}) + +-- | Placement assignments for this ad. +aPlacementAssignments :: Lens' Ad [PlacementAssignment] +aPlacementAssignments + = lens _aPlacementAssignments + (\ s a -> s{_aPlacementAssignments = a}) + . _Default + . _Coerce + +instance FromJSON Ad where + parseJSON + = withObject "Ad" + (\ o -> + Ad' <$> + (o .:? "targetingTemplateId") <*> + (o .:? "creativeGroupAssignments" .!= mempty) + <*> (o .:? "geoTargeting") + <*> (o .:? "creativeRotation") + <*> (o .:? "technologyTargeting") + <*> (o .:? "audienceSegmentId") + <*> (o .:? "dayPartTargeting") + <*> (o .:? "size") + <*> (o .:? "startTime") + <*> (o .:? "kind" .!= "dfareporting#ad") + <*> (o .:? "clickThroughUrlSuffixProperties") + <*> (o .:? "campaignIdDimensionValue") + <*> (o .:? "advertiserId") + <*> (o .:? "advertiserIdDimensionValue") + <*> (o .:? "sslCompliant") + <*> (o .:? "campaignId") + <*> (o .:? "idDimensionValue") + <*> (o .:? "clickThroughUrl") + <*> (o .:? "deliverySchedule") + <*> (o .:? "eventTagOverrides" .!= mempty) + <*> (o .:? "active") + <*> (o .:? "accountId") + <*> (o .:? "name") + <*> (o .:? "keyValueTargetingExpression") + <*> (o .:? "endTime") + <*> (o .:? "createInfo") + <*> (o .:? "lastModifiedInfo") + <*> (o .:? "id") + <*> (o .:? "sslRequired") + <*> (o .:? "comments") + <*> (o .:? "subaccountId") + <*> (o .:? "type") + <*> (o .:? "remarketingListExpression") + <*> (o .:? "languageTargeting") + <*> (o .:? "dynamicClickTracker") + <*> (o .:? "compatibility") + <*> (o .:? "archived") + <*> (o .:? "defaultClickThroughEventTagProperties") + <*> (o .:? "placementAssignments" .!= mempty)) + +instance ToJSON Ad where + toJSON Ad'{..} + = object + (catMaybes + [("targetingTemplateId" .=) <$> + _aTargetingTemplateId, + ("creativeGroupAssignments" .=) <$> + _aCreativeGroupAssignments, + ("geoTargeting" .=) <$> _aGeoTargeting, + ("creativeRotation" .=) <$> _aCreativeRotation, + ("technologyTargeting" .=) <$> _aTechnologyTargeting, + ("audienceSegmentId" .=) <$> _aAudienceSegmentId, + ("dayPartTargeting" .=) <$> _aDayPartTargeting, + ("size" .=) <$> _aSize, + ("startTime" .=) <$> _aStartTime, + Just ("kind" .= _aKind), + ("clickThroughUrlSuffixProperties" .=) <$> + _aClickThroughURLSuffixProperties, + ("campaignIdDimensionValue" .=) <$> + _aCampaignIdDimensionValue, + ("advertiserId" .=) <$> _aAdvertiserId, + ("advertiserIdDimensionValue" .=) <$> + _aAdvertiserIdDimensionValue, + ("sslCompliant" .=) <$> _aSSLCompliant, + ("campaignId" .=) <$> _aCampaignId, + ("idDimensionValue" .=) <$> _aIdDimensionValue, + ("clickThroughUrl" .=) <$> _aClickThroughURL, + ("deliverySchedule" .=) <$> _aDeliverySchedule, + ("eventTagOverrides" .=) <$> _aEventTagOverrides, + ("active" .=) <$> _aActive, + ("accountId" .=) <$> _aAccountId, + ("name" .=) <$> _aName, + ("keyValueTargetingExpression" .=) <$> + _aKeyValueTargetingExpression, + ("endTime" .=) <$> _aEndTime, + ("createInfo" .=) <$> _aCreateInfo, + ("lastModifiedInfo" .=) <$> _aLastModifiedInfo, + ("id" .=) <$> _aId, + ("sslRequired" .=) <$> _aSSLRequired, + ("comments" .=) <$> _aComments, + ("subaccountId" .=) <$> _aSubAccountId, + ("type" .=) <$> _aType, + ("remarketingListExpression" .=) <$> + _aRemarketingListExpression, + ("languageTargeting" .=) <$> _aLanguageTargeting, + ("dynamicClickTracker" .=) <$> _aDynamicClickTracker, + ("compatibility" .=) <$> _aCompatibility, + ("archived" .=) <$> _aArchived, + ("defaultClickThroughEventTagProperties" .=) <$> + _aDefaultClickThroughEventTagProperties, + ("placementAssignments" .=) <$> + _aPlacementAssignments]) + +-- | Contains properties of a Planning project. +-- +-- /See:/ 'project' smart constructor. +data Project = + Project' + { _pTargetClicks :: !(Maybe (Textual Int64)) + , _pClientBillingCode :: !(Maybe Text) + , _pTargetCpmNanos :: !(Maybe (Textual Int64)) + , _pTargetConversions :: !(Maybe (Textual Int64)) + , _pBudget :: !(Maybe (Textual Int64)) + , _pKind :: !Text + , _pAdvertiserId :: !(Maybe (Textual Int64)) + , _pEndDate :: !(Maybe Date') + , _pOverview :: !(Maybe Text) + , _pTargetImpressions :: !(Maybe (Textual Int64)) + , _pStartDate :: !(Maybe Date') + , _pTargetCpcNanos :: !(Maybe (Textual Int64)) + , _pAccountId :: !(Maybe (Textual Int64)) + , _pName :: !(Maybe Text) + , _pLastModifiedInfo :: !(Maybe LastModifiedInfo) + , _pId :: !(Maybe (Textual Int64)) + , _pAudienceAgeGroup :: !(Maybe ProjectAudienceAgeGroup) + , _pSubAccountId :: !(Maybe (Textual Int64)) + , _pTargetCpmActiveViewNanos :: !(Maybe (Textual Int64)) + , _pAudienceGender :: !(Maybe ProjectAudienceGender) + , _pClientName :: !(Maybe Text) + , _pTargetCpaNanos :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'Project' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'pTargetClicks' +-- +-- * 'pClientBillingCode' +-- +-- * 'pTargetCpmNanos' +-- +-- * 'pTargetConversions' +-- +-- * 'pBudget' +-- +-- * 'pKind' +-- +-- * 'pAdvertiserId' +-- +-- * 'pEndDate' +-- +-- * 'pOverview' +-- +-- * 'pTargetImpressions' +-- +-- * 'pStartDate' +-- +-- * 'pTargetCpcNanos' +-- +-- * 'pAccountId' +-- +-- * 'pName' +-- +-- * 'pLastModifiedInfo' +-- +-- * 'pId' +-- +-- * 'pAudienceAgeGroup' +-- +-- * 'pSubAccountId' +-- +-- * 'pTargetCpmActiveViewNanos' +-- +-- * 'pAudienceGender' +-- +-- * 'pClientName' +-- +-- * 'pTargetCpaNanos' +project + :: Project +project = + Project' + { _pTargetClicks = Nothing + , _pClientBillingCode = Nothing + , _pTargetCpmNanos = Nothing + , _pTargetConversions = Nothing + , _pBudget = Nothing + , _pKind = "dfareporting#project" + , _pAdvertiserId = Nothing + , _pEndDate = Nothing + , _pOverview = Nothing + , _pTargetImpressions = Nothing + , _pStartDate = Nothing + , _pTargetCpcNanos = Nothing + , _pAccountId = Nothing + , _pName = Nothing + , _pLastModifiedInfo = Nothing + , _pId = Nothing + , _pAudienceAgeGroup = Nothing + , _pSubAccountId = Nothing + , _pTargetCpmActiveViewNanos = Nothing + , _pAudienceGender = Nothing + , _pClientName = Nothing + , _pTargetCpaNanos = Nothing + } + + +-- | Number of clicks that the advertiser is targeting. +pTargetClicks :: Lens' Project (Maybe Int64) +pTargetClicks + = lens _pTargetClicks + (\ s a -> s{_pTargetClicks = a}) + . mapping _Coerce + +-- | Client billing code of this project. +pClientBillingCode :: Lens' Project (Maybe Text) +pClientBillingCode + = lens _pClientBillingCode + (\ s a -> s{_pClientBillingCode = a}) + +-- | CPM that the advertiser is targeting. +pTargetCpmNanos :: Lens' Project (Maybe Int64) +pTargetCpmNanos + = lens _pTargetCpmNanos + (\ s a -> s{_pTargetCpmNanos = a}) + . mapping _Coerce + +-- | Number of conversions that the advertiser is targeting. +pTargetConversions :: Lens' Project (Maybe Int64) +pTargetConversions + = lens _pTargetConversions + (\ s a -> s{_pTargetConversions = a}) + . mapping _Coerce + +-- | Budget of this project in the currency specified by the current account. +-- The value stored in this field represents only the non-fractional +-- amount. For example, for USD, the smallest value that can be represented +-- by this field is 1 US dollar. +pBudget :: Lens' Project (Maybe Int64) +pBudget + = lens _pBudget (\ s a -> s{_pBudget = a}) . + mapping _Coerce + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#project\". +pKind :: Lens' Project Text +pKind = lens _pKind (\ s a -> s{_pKind = a}) + +-- | Advertiser ID of this project. +pAdvertiserId :: Lens' Project (Maybe Int64) +pAdvertiserId + = lens _pAdvertiserId + (\ s a -> s{_pAdvertiserId = a}) + . mapping _Coerce + +-- | End date of the project. +pEndDate :: Lens' Project (Maybe Day) +pEndDate + = lens _pEndDate (\ s a -> s{_pEndDate = a}) . + mapping _Date + +-- | Overview of this project. +pOverview :: Lens' Project (Maybe Text) +pOverview + = lens _pOverview (\ s a -> s{_pOverview = a}) + +-- | Number of impressions that the advertiser is targeting. +pTargetImpressions :: Lens' Project (Maybe Int64) +pTargetImpressions + = lens _pTargetImpressions + (\ s a -> s{_pTargetImpressions = a}) + . mapping _Coerce + +-- | Start date of the project. +pStartDate :: Lens' Project (Maybe Day) +pStartDate + = lens _pStartDate (\ s a -> s{_pStartDate = a}) . + mapping _Date + +-- | CPC that the advertiser is targeting. +pTargetCpcNanos :: Lens' Project (Maybe Int64) +pTargetCpcNanos + = lens _pTargetCpcNanos + (\ s a -> s{_pTargetCpcNanos = a}) + . mapping _Coerce + +-- | Account ID of this project. +pAccountId :: Lens' Project (Maybe Int64) +pAccountId + = lens _pAccountId (\ s a -> s{_pAccountId = a}) . + mapping _Coerce + +-- | Name of this project. +pName :: Lens' Project (Maybe Text) +pName = lens _pName (\ s a -> s{_pName = a}) + +-- | Information about the most recent modification of this project. +pLastModifiedInfo :: Lens' Project (Maybe LastModifiedInfo) +pLastModifiedInfo + = lens _pLastModifiedInfo + (\ s a -> s{_pLastModifiedInfo = a}) + +-- | ID of this project. This is a read-only, auto-generated field. +pId :: Lens' Project (Maybe Int64) +pId + = lens _pId (\ s a -> s{_pId = a}) . mapping _Coerce + +-- | Audience age group of this project. +pAudienceAgeGroup :: Lens' Project (Maybe ProjectAudienceAgeGroup) +pAudienceAgeGroup + = lens _pAudienceAgeGroup + (\ s a -> s{_pAudienceAgeGroup = a}) + +-- | Subaccount ID of this project. +pSubAccountId :: Lens' Project (Maybe Int64) +pSubAccountId + = lens _pSubAccountId + (\ s a -> s{_pSubAccountId = a}) + . mapping _Coerce + +-- | vCPM from Active View that the advertiser is targeting. +pTargetCpmActiveViewNanos :: Lens' Project (Maybe Int64) +pTargetCpmActiveViewNanos + = lens _pTargetCpmActiveViewNanos + (\ s a -> s{_pTargetCpmActiveViewNanos = a}) + . mapping _Coerce + +-- | Audience gender of this project. +pAudienceGender :: Lens' Project (Maybe ProjectAudienceGender) +pAudienceGender + = lens _pAudienceGender + (\ s a -> s{_pAudienceGender = a}) + +-- | Name of the project client. +pClientName :: Lens' Project (Maybe Text) +pClientName + = lens _pClientName (\ s a -> s{_pClientName = a}) + +-- | CPA that the advertiser is targeting. +pTargetCpaNanos :: Lens' Project (Maybe Int64) +pTargetCpaNanos + = lens _pTargetCpaNanos + (\ s a -> s{_pTargetCpaNanos = a}) + . mapping _Coerce + +instance FromJSON Project where + parseJSON + = withObject "Project" + (\ o -> + Project' <$> + (o .:? "targetClicks") <*> + (o .:? "clientBillingCode") + <*> (o .:? "targetCpmNanos") + <*> (o .:? "targetConversions") + <*> (o .:? "budget") + <*> (o .:? "kind" .!= "dfareporting#project") + <*> (o .:? "advertiserId") + <*> (o .:? "endDate") + <*> (o .:? "overview") + <*> (o .:? "targetImpressions") + <*> (o .:? "startDate") + <*> (o .:? "targetCpcNanos") + <*> (o .:? "accountId") + <*> (o .:? "name") + <*> (o .:? "lastModifiedInfo") + <*> (o .:? "id") + <*> (o .:? "audienceAgeGroup") + <*> (o .:? "subaccountId") + <*> (o .:? "targetCpmActiveViewNanos") + <*> (o .:? "audienceGender") + <*> (o .:? "clientName") + <*> (o .:? "targetCpaNanos")) + +instance ToJSON Project where + toJSON Project'{..} + = object + (catMaybes + [("targetClicks" .=) <$> _pTargetClicks, + ("clientBillingCode" .=) <$> _pClientBillingCode, + ("targetCpmNanos" .=) <$> _pTargetCpmNanos, + ("targetConversions" .=) <$> _pTargetConversions, + ("budget" .=) <$> _pBudget, Just ("kind" .= _pKind), + ("advertiserId" .=) <$> _pAdvertiserId, + ("endDate" .=) <$> _pEndDate, + ("overview" .=) <$> _pOverview, + ("targetImpressions" .=) <$> _pTargetImpressions, + ("startDate" .=) <$> _pStartDate, + ("targetCpcNanos" .=) <$> _pTargetCpcNanos, + ("accountId" .=) <$> _pAccountId, + ("name" .=) <$> _pName, + ("lastModifiedInfo" .=) <$> _pLastModifiedInfo, + ("id" .=) <$> _pId, + ("audienceAgeGroup" .=) <$> _pAudienceAgeGroup, + ("subaccountId" .=) <$> _pSubAccountId, + ("targetCpmActiveViewNanos" .=) <$> + _pTargetCpmActiveViewNanos, + ("audienceGender" .=) <$> _pAudienceGender, + ("clientName" .=) <$> _pClientName, + ("targetCpaNanos" .=) <$> _pTargetCpaNanos]) + +-- | The report criteria for a report of type \"FLOODLIGHT\". +-- +-- /See:/ 'reportFloodlightCriteria' smart constructor. +data ReportFloodlightCriteria = + ReportFloodlightCriteria' + { _rfcReportProperties :: !(Maybe ReportFloodlightCriteriaReportProperties) + , _rfcMetricNames :: !(Maybe [Text]) + , _rfcCustomRichMediaEvents :: !(Maybe [DimensionValue]) + , _rfcDimensionFilters :: !(Maybe [DimensionValue]) + , _rfcDateRange :: !(Maybe DateRange) + , _rfcFloodlightConfigId :: !(Maybe DimensionValue) + , _rfcDimensions :: !(Maybe [SortedDimension]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ReportFloodlightCriteria' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'rfcReportProperties' +-- +-- * 'rfcMetricNames' +-- +-- * 'rfcCustomRichMediaEvents' +-- +-- * 'rfcDimensionFilters' +-- +-- * 'rfcDateRange' +-- +-- * 'rfcFloodlightConfigId' +-- +-- * 'rfcDimensions' +reportFloodlightCriteria + :: ReportFloodlightCriteria +reportFloodlightCriteria = + ReportFloodlightCriteria' + { _rfcReportProperties = Nothing + , _rfcMetricNames = Nothing + , _rfcCustomRichMediaEvents = Nothing + , _rfcDimensionFilters = Nothing + , _rfcDateRange = Nothing + , _rfcFloodlightConfigId = Nothing + , _rfcDimensions = Nothing + } + + +-- | The properties of the report. +rfcReportProperties :: Lens' ReportFloodlightCriteria (Maybe ReportFloodlightCriteriaReportProperties) +rfcReportProperties + = lens _rfcReportProperties + (\ s a -> s{_rfcReportProperties = a}) + +-- | The list of names of metrics the report should include. +rfcMetricNames :: Lens' ReportFloodlightCriteria [Text] +rfcMetricNames + = lens _rfcMetricNames + (\ s a -> s{_rfcMetricNames = a}) + . _Default + . _Coerce + +-- | The list of custom rich media events to include. +rfcCustomRichMediaEvents :: Lens' ReportFloodlightCriteria [DimensionValue] +rfcCustomRichMediaEvents + = lens _rfcCustomRichMediaEvents + (\ s a -> s{_rfcCustomRichMediaEvents = a}) + . _Default + . _Coerce + +-- | The list of filters on which dimensions are filtered. Filters for +-- different dimensions are ANDed, filters for the same dimension are +-- grouped together and ORed. +rfcDimensionFilters :: Lens' ReportFloodlightCriteria [DimensionValue] +rfcDimensionFilters + = lens _rfcDimensionFilters + (\ s a -> s{_rfcDimensionFilters = a}) + . _Default + . _Coerce + +-- | The date range this report should be run for. +rfcDateRange :: Lens' ReportFloodlightCriteria (Maybe DateRange) +rfcDateRange + = lens _rfcDateRange (\ s a -> s{_rfcDateRange = a}) + +-- | The floodlight ID for which to show data in this report. All advertisers +-- associated with that ID will automatically be added. The dimension of +-- the value needs to be \'dfa:floodlightConfigId\'. +rfcFloodlightConfigId :: Lens' ReportFloodlightCriteria (Maybe DimensionValue) +rfcFloodlightConfigId + = lens _rfcFloodlightConfigId + (\ s a -> s{_rfcFloodlightConfigId = a}) + +-- | The list of dimensions the report should include. +rfcDimensions :: Lens' ReportFloodlightCriteria [SortedDimension] +rfcDimensions + = lens _rfcDimensions + (\ s a -> s{_rfcDimensions = a}) + . _Default + . _Coerce + +instance FromJSON ReportFloodlightCriteria where + parseJSON + = withObject "ReportFloodlightCriteria" + (\ o -> + ReportFloodlightCriteria' <$> + (o .:? "reportProperties") <*> + (o .:? "metricNames" .!= mempty) + <*> (o .:? "customRichMediaEvents" .!= mempty) + <*> (o .:? "dimensionFilters" .!= mempty) + <*> (o .:? "dateRange") + <*> (o .:? "floodlightConfigId") + <*> (o .:? "dimensions" .!= mempty)) + +instance ToJSON ReportFloodlightCriteria where + toJSON ReportFloodlightCriteria'{..} + = object + (catMaybes + [("reportProperties" .=) <$> _rfcReportProperties, + ("metricNames" .=) <$> _rfcMetricNames, + ("customRichMediaEvents" .=) <$> + _rfcCustomRichMediaEvents, + ("dimensionFilters" .=) <$> _rfcDimensionFilters, + ("dateRange" .=) <$> _rfcDateRange, + ("floodlightConfigId" .=) <$> _rfcFloodlightConfigId, + ("dimensions" .=) <$> _rfcDimensions]) + +-- | Represents the dimensions of ads, placements, creatives, or creative +-- assets. +-- +-- /See:/ 'size' smart constructor. +data Size = + Size' + { _sHeight :: !(Maybe (Textual Int32)) + , _sKind :: !Text + , _sWidth :: !(Maybe (Textual Int32)) + , _sIab :: !(Maybe Bool) + , _sId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'Size' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'sHeight' +-- +-- * 'sKind' +-- +-- * 'sWidth' +-- +-- * 'sIab' +-- +-- * 'sId' +size + :: Size +size = + Size' + { _sHeight = Nothing + , _sKind = "dfareporting#size" + , _sWidth = Nothing + , _sIab = Nothing + , _sId = Nothing + } + + +-- | Height of this size. Acceptable values are 0 to 32767, inclusive. +sHeight :: Lens' Size (Maybe Int32) +sHeight + = lens _sHeight (\ s a -> s{_sHeight = a}) . + mapping _Coerce + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#size\". +sKind :: Lens' Size Text +sKind = lens _sKind (\ s a -> s{_sKind = a}) + +-- | Width of this size. Acceptable values are 0 to 32767, inclusive. +sWidth :: Lens' Size (Maybe Int32) +sWidth + = lens _sWidth (\ s a -> s{_sWidth = a}) . + mapping _Coerce + +-- | IAB standard size. This is a read-only, auto-generated field. +sIab :: Lens' Size (Maybe Bool) +sIab = lens _sIab (\ s a -> s{_sIab = a}) + +-- | ID of this size. This is a read-only, auto-generated field. +sId :: Lens' Size (Maybe Int64) +sId + = lens _sId (\ s a -> s{_sId = a}) . mapping _Coerce + +instance FromJSON Size where + parseJSON + = withObject "Size" + (\ o -> + Size' <$> + (o .:? "height") <*> + (o .:? "kind" .!= "dfareporting#size") + <*> (o .:? "width") + <*> (o .:? "iab") + <*> (o .:? "id")) + +instance ToJSON Size where + toJSON Size'{..} + = object + (catMaybes + [("height" .=) <$> _sHeight, Just ("kind" .= _sKind), + ("width" .=) <$> _sWidth, ("iab" .=) <$> _sIab, + ("id" .=) <$> _sId]) + +-- | Object Filter. +-- +-- /See:/ 'objectFilter' smart constructor. +data ObjectFilter = + ObjectFilter' + { _ofStatus :: !(Maybe ObjectFilterStatus) + , _ofKind :: !Text + , _ofObjectIds :: !(Maybe [Textual Int64]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ObjectFilter' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'ofStatus' +-- +-- * 'ofKind' +-- +-- * 'ofObjectIds' +objectFilter + :: ObjectFilter +objectFilter = + ObjectFilter' + { _ofStatus = Nothing + , _ofKind = "dfareporting#objectFilter" + , _ofObjectIds = Nothing + } + + +-- | Status of the filter. NONE means the user has access to none of the +-- objects. ALL means the user has access to all objects. ASSIGNED means +-- the user has access to the objects with IDs in the objectIds list. +ofStatus :: Lens' ObjectFilter (Maybe ObjectFilterStatus) +ofStatus = lens _ofStatus (\ s a -> s{_ofStatus = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#objectFilter\". +ofKind :: Lens' ObjectFilter Text +ofKind = lens _ofKind (\ s a -> s{_ofKind = a}) + +-- | Applicable when status is ASSIGNED. The user has access to objects with +-- these object IDs. +ofObjectIds :: Lens' ObjectFilter [Int64] +ofObjectIds + = lens _ofObjectIds (\ s a -> s{_ofObjectIds = a}) . + _Default + . _Coerce + +instance FromJSON ObjectFilter where + parseJSON + = withObject "ObjectFilter" + (\ o -> + ObjectFilter' <$> + (o .:? "status") <*> + (o .:? "kind" .!= "dfareporting#objectFilter") + <*> (o .:? "objectIds" .!= mempty)) + +instance ToJSON ObjectFilter where + toJSON ObjectFilter'{..} + = object + (catMaybes + [("status" .=) <$> _ofStatus, + Just ("kind" .= _ofKind), + ("objectIds" .=) <$> _ofObjectIds]) + +-- | Skippable Settings +-- +-- /See:/ 'skippableSetting' smart constructor. +data SkippableSetting = + SkippableSetting' + { _ssSkipOffSet :: !(Maybe VideoOffSet) + , _ssProgressOffSet :: !(Maybe VideoOffSet) + , _ssKind :: !Text + , _ssSkippable :: !(Maybe Bool) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'SkippableSetting' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'ssSkipOffSet' +-- +-- * 'ssProgressOffSet' +-- +-- * 'ssKind' +-- +-- * 'ssSkippable' +skippableSetting + :: SkippableSetting +skippableSetting = + SkippableSetting' + { _ssSkipOffSet = Nothing + , _ssProgressOffSet = Nothing + , _ssKind = "dfareporting#skippableSetting" + , _ssSkippable = Nothing + } + + +-- | Amount of time to play videos served to this placement before the skip +-- button should appear. Applicable when skippable is true. +ssSkipOffSet :: Lens' SkippableSetting (Maybe VideoOffSet) +ssSkipOffSet + = lens _ssSkipOffSet (\ s a -> s{_ssSkipOffSet = a}) + +-- | Amount of time to play videos served to this placement before counting a +-- view. Applicable when skippable is true. +ssProgressOffSet :: Lens' SkippableSetting (Maybe VideoOffSet) +ssProgressOffSet + = lens _ssProgressOffSet + (\ s a -> s{_ssProgressOffSet = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#skippableSetting\". +ssKind :: Lens' SkippableSetting Text +ssKind = lens _ssKind (\ s a -> s{_ssKind = a}) + +-- | Whether the user can skip creatives served to this placement. +ssSkippable :: Lens' SkippableSetting (Maybe Bool) +ssSkippable + = lens _ssSkippable (\ s a -> s{_ssSkippable = a}) + +instance FromJSON SkippableSetting where + parseJSON + = withObject "SkippableSetting" + (\ o -> + SkippableSetting' <$> + (o .:? "skipOffset") <*> (o .:? "progressOffset") <*> + (o .:? "kind" .!= "dfareporting#skippableSetting") + <*> (o .:? "skippable")) + +instance ToJSON SkippableSetting where + toJSON SkippableSetting'{..} + = object + (catMaybes + [("skipOffset" .=) <$> _ssSkipOffSet, + ("progressOffset" .=) <$> _ssProgressOffSet, + Just ("kind" .= _ssKind), + ("skippable" .=) <$> _ssSkippable]) + +-- | Reporting Configuration +-- +-- /See:/ 'reportsConfiguration' smart constructor. +data ReportsConfiguration = + ReportsConfiguration' + { _rcExposureToConversionEnabled :: !(Maybe Bool) + , _rcReportGenerationTimeZoneId :: !(Maybe (Textual Int64)) + , _rcLookbackConfiguration :: !(Maybe LookbackConfiguration) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ReportsConfiguration' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'rcExposureToConversionEnabled' +-- +-- * 'rcReportGenerationTimeZoneId' +-- +-- * 'rcLookbackConfiguration' +reportsConfiguration + :: ReportsConfiguration +reportsConfiguration = + ReportsConfiguration' + { _rcExposureToConversionEnabled = Nothing + , _rcReportGenerationTimeZoneId = Nothing + , _rcLookbackConfiguration = Nothing + } + + +-- | Whether the exposure to conversion report is enabled. This report shows +-- detailed pathway information on up to 10 of the most recent ad exposures +-- seen by a user before converting. +rcExposureToConversionEnabled :: Lens' ReportsConfiguration (Maybe Bool) +rcExposureToConversionEnabled + = lens _rcExposureToConversionEnabled + (\ s a -> s{_rcExposureToConversionEnabled = a}) + +-- | Report generation time zone ID of this account. This is a required field +-- that can only be changed by a superuser. Acceptable values are: - \"1\" +-- for \"America\/New_York\" - \"2\" for \"Europe\/London\" - \"3\" for +-- \"Europe\/Paris\" - \"4\" for \"Africa\/Johannesburg\" - \"5\" for +-- \"Asia\/Jerusalem\" - \"6\" for \"Asia\/Shanghai\" - \"7\" for +-- \"Asia\/Hong_Kong\" - \"8\" for \"Asia\/Tokyo\" - \"9\" for +-- \"Australia\/Sydney\" - \"10\" for \"Asia\/Dubai\" - \"11\" for +-- \"America\/Los_Angeles\" - \"12\" for \"Pacific\/Auckland\" - \"13\" for +-- \"America\/Sao_Paulo\" +rcReportGenerationTimeZoneId :: Lens' ReportsConfiguration (Maybe Int64) +rcReportGenerationTimeZoneId + = lens _rcReportGenerationTimeZoneId + (\ s a -> s{_rcReportGenerationTimeZoneId = a}) + . mapping _Coerce + +-- | Default lookback windows for new advertisers in this account. +rcLookbackConfiguration :: Lens' ReportsConfiguration (Maybe LookbackConfiguration) +rcLookbackConfiguration + = lens _rcLookbackConfiguration + (\ s a -> s{_rcLookbackConfiguration = a}) + +instance FromJSON ReportsConfiguration where + parseJSON + = withObject "ReportsConfiguration" + (\ o -> + ReportsConfiguration' <$> + (o .:? "exposureToConversionEnabled") <*> + (o .:? "reportGenerationTimeZoneId") + <*> (o .:? "lookbackConfiguration")) + +instance ToJSON ReportsConfiguration where + toJSON ReportsConfiguration'{..} + = object + (catMaybes + [("exposureToConversionEnabled" .=) <$> + _rcExposureToConversionEnabled, + ("reportGenerationTimeZoneId" .=) <$> + _rcReportGenerationTimeZoneId, + ("lookbackConfiguration" .=) <$> + _rcLookbackConfiguration]) + +-- | Pricing Schedule +-- +-- /See:/ 'pricingSchedule' smart constructor. +data PricingSchedule = + PricingSchedule' + { _psTestingStartDate :: !(Maybe Date') + , _psFloodlightActivityId :: !(Maybe (Textual Int64)) + , _psEndDate :: !(Maybe Date') + , _psDisregardOverdelivery :: !(Maybe Bool) + , _psStartDate :: !(Maybe Date') + , _psCapCostOption :: !(Maybe PricingScheduleCapCostOption) + , _psPricingType :: !(Maybe PricingSchedulePricingType) + , _psPricingPeriods :: !(Maybe [PricingSchedulePricingPeriod]) + , _psFlighted :: !(Maybe Bool) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'PricingSchedule' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'psTestingStartDate' +-- +-- * 'psFloodlightActivityId' +-- +-- * 'psEndDate' +-- +-- * 'psDisregardOverdelivery' +-- +-- * 'psStartDate' +-- +-- * 'psCapCostOption' +-- +-- * 'psPricingType' +-- +-- * 'psPricingPeriods' +-- +-- * 'psFlighted' +pricingSchedule + :: PricingSchedule +pricingSchedule = + PricingSchedule' + { _psTestingStartDate = Nothing + , _psFloodlightActivityId = Nothing + , _psEndDate = Nothing + , _psDisregardOverdelivery = Nothing + , _psStartDate = Nothing + , _psCapCostOption = Nothing + , _psPricingType = Nothing + , _psPricingPeriods = Nothing + , _psFlighted = Nothing + } + + +-- | Testing start date of this placement. The hours, minutes, and seconds of +-- the start date should not be set, as doing so will result in an error. +psTestingStartDate :: Lens' PricingSchedule (Maybe Day) +psTestingStartDate + = lens _psTestingStartDate + (\ s a -> s{_psTestingStartDate = a}) + . mapping _Date + +-- | Floodlight activity ID associated with this placement. This field should +-- be set when placement pricing type is set to PRICING_TYPE_CPA. +psFloodlightActivityId :: Lens' PricingSchedule (Maybe Int64) +psFloodlightActivityId + = lens _psFloodlightActivityId + (\ s a -> s{_psFloodlightActivityId = a}) + . mapping _Coerce + +-- | Placement end date. This date must be later than, or the same day as, +-- the placement start date, but not later than the campaign end date. If, +-- for example, you set 6\/25\/2015 as both the start and end dates, the +-- effective placement date is just that day only, 6\/25\/2015. The hours, +-- minutes, and seconds of the end date should not be set, as doing so will +-- result in an error. This field is required on insertion. +psEndDate :: Lens' PricingSchedule (Maybe Day) +psEndDate + = lens _psEndDate (\ s a -> s{_psEndDate = a}) . + mapping _Date + +-- | Whether cap costs are ignored by ad serving. +psDisregardOverdelivery :: Lens' PricingSchedule (Maybe Bool) +psDisregardOverdelivery + = lens _psDisregardOverdelivery + (\ s a -> s{_psDisregardOverdelivery = a}) + +-- | Placement start date. This date must be later than, or the same day as, +-- the campaign start date. The hours, minutes, and seconds of the start +-- date should not be set, as doing so will result in an error. This field +-- is required on insertion. +psStartDate :: Lens' PricingSchedule (Maybe Day) +psStartDate + = lens _psStartDate (\ s a -> s{_psStartDate = a}) . + mapping _Date + +-- | Placement cap cost option. +psCapCostOption :: Lens' PricingSchedule (Maybe PricingScheduleCapCostOption) +psCapCostOption + = lens _psCapCostOption + (\ s a -> s{_psCapCostOption = a}) + +-- | Placement pricing type. This field is required on insertion. +psPricingType :: Lens' PricingSchedule (Maybe PricingSchedulePricingType) +psPricingType + = lens _psPricingType + (\ s a -> s{_psPricingType = a}) + +-- | Pricing periods for this placement. +psPricingPeriods :: Lens' PricingSchedule [PricingSchedulePricingPeriod] +psPricingPeriods + = lens _psPricingPeriods + (\ s a -> s{_psPricingPeriods = a}) + . _Default + . _Coerce + +-- | Whether this placement is flighted. If true, pricing periods will be +-- computed automatically. +psFlighted :: Lens' PricingSchedule (Maybe Bool) +psFlighted + = lens _psFlighted (\ s a -> s{_psFlighted = a}) + +instance FromJSON PricingSchedule where + parseJSON + = withObject "PricingSchedule" + (\ o -> + PricingSchedule' <$> + (o .:? "testingStartDate") <*> + (o .:? "floodlightActivityId") + <*> (o .:? "endDate") + <*> (o .:? "disregardOverdelivery") + <*> (o .:? "startDate") + <*> (o .:? "capCostOption") + <*> (o .:? "pricingType") + <*> (o .:? "pricingPeriods" .!= mempty) + <*> (o .:? "flighted")) + +instance ToJSON PricingSchedule where + toJSON PricingSchedule'{..} + = object + (catMaybes + [("testingStartDate" .=) <$> _psTestingStartDate, + ("floodlightActivityId" .=) <$> + _psFloodlightActivityId, + ("endDate" .=) <$> _psEndDate, + ("disregardOverdelivery" .=) <$> + _psDisregardOverdelivery, + ("startDate" .=) <$> _psStartDate, + ("capCostOption" .=) <$> _psCapCostOption, + ("pricingType" .=) <$> _psPricingType, + ("pricingPeriods" .=) <$> _psPricingPeriods, + ("flighted" .=) <$> _psFlighted]) + +-- | Contains information about a postal code that can be targeted by ads. +-- +-- /See:/ 'postalCode' smart constructor. +data PostalCode = + PostalCode' + { _pcKind :: !Text + , _pcCode :: !(Maybe Text) + , _pcCountryCode :: !(Maybe Text) + , _pcId :: !(Maybe Text) + , _pcCountryDartId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'PostalCode' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'pcKind' +-- +-- * 'pcCode' +-- +-- * 'pcCountryCode' +-- +-- * 'pcId' +-- +-- * 'pcCountryDartId' +postalCode + :: PostalCode +postalCode = + PostalCode' + { _pcKind = "dfareporting#postalCode" + , _pcCode = Nothing + , _pcCountryCode = Nothing + , _pcId = Nothing + , _pcCountryDartId = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#postalCode\". +pcKind :: Lens' PostalCode Text +pcKind = lens _pcKind (\ s a -> s{_pcKind = a}) + +-- | Postal code. This is equivalent to the id field. +pcCode :: Lens' PostalCode (Maybe Text) +pcCode = lens _pcCode (\ s a -> s{_pcCode = a}) + +-- | Country code of the country to which this postal code belongs. +pcCountryCode :: Lens' PostalCode (Maybe Text) +pcCountryCode + = lens _pcCountryCode + (\ s a -> s{_pcCountryCode = a}) + +-- | ID of this postal code. +pcId :: Lens' PostalCode (Maybe Text) +pcId = lens _pcId (\ s a -> s{_pcId = a}) + +-- | DART ID of the country to which this postal code belongs. +pcCountryDartId :: Lens' PostalCode (Maybe Int64) +pcCountryDartId + = lens _pcCountryDartId + (\ s a -> s{_pcCountryDartId = a}) + . mapping _Coerce + +instance FromJSON PostalCode where + parseJSON + = withObject "PostalCode" + (\ o -> + PostalCode' <$> + (o .:? "kind" .!= "dfareporting#postalCode") <*> + (o .:? "code") + <*> (o .:? "countryCode") + <*> (o .:? "id") + <*> (o .:? "countryDartId")) + +instance ToJSON PostalCode where + toJSON PostalCode'{..} + = object + (catMaybes + [Just ("kind" .= _pcKind), ("code" .=) <$> _pcCode, + ("countryCode" .=) <$> _pcCountryCode, + ("id" .=) <$> _pcId, + ("countryDartId" .=) <$> _pcCountryDartId]) + +-- | Account Permission List Response +-- +-- /See:/ 'accountPermissionsListResponse' smart constructor. +data AccountPermissionsListResponse = + AccountPermissionsListResponse' + { _aplrKind :: !Text + , _aplrAccountPermissions :: !(Maybe [AccountPermission]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'AccountPermissionsListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'aplrKind' +-- +-- * 'aplrAccountPermissions' +accountPermissionsListResponse + :: AccountPermissionsListResponse +accountPermissionsListResponse = + AccountPermissionsListResponse' + { _aplrKind = "dfareporting#accountPermissionsListResponse" + , _aplrAccountPermissions = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#accountPermissionsListResponse\". +aplrKind :: Lens' AccountPermissionsListResponse Text +aplrKind = lens _aplrKind (\ s a -> s{_aplrKind = a}) + +-- | Account permission collection. +aplrAccountPermissions :: Lens' AccountPermissionsListResponse [AccountPermission] +aplrAccountPermissions + = lens _aplrAccountPermissions + (\ s a -> s{_aplrAccountPermissions = a}) + . _Default + . _Coerce + +instance FromJSON AccountPermissionsListResponse + where + parseJSON + = withObject "AccountPermissionsListResponse" + (\ o -> + AccountPermissionsListResponse' <$> + (o .:? "kind" .!= + "dfareporting#accountPermissionsListResponse") + <*> (o .:? "accountPermissions" .!= mempty)) + +instance ToJSON AccountPermissionsListResponse where + toJSON AccountPermissionsListResponse'{..} + = object + (catMaybes + [Just ("kind" .= _aplrKind), + ("accountPermissions" .=) <$> + _aplrAccountPermissions]) + +-- | Contains information about a country that can be targeted by ads. +-- +-- /See:/ 'country' smart constructor. +data Country = + Country' + { _cKind :: !Text + , _cName :: !(Maybe Text) + , _cCountryCode :: !(Maybe Text) + , _cDartId :: !(Maybe (Textual Int64)) + , _cSSLEnabled :: !(Maybe Bool) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'Country' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'cKind' +-- +-- * 'cName' +-- +-- * 'cCountryCode' +-- +-- * 'cDartId' +-- +-- * 'cSSLEnabled' +country + :: Country +country = + Country' + { _cKind = "dfareporting#country" + , _cName = Nothing + , _cCountryCode = Nothing + , _cDartId = Nothing + , _cSSLEnabled = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#country\". +cKind :: Lens' Country Text +cKind = lens _cKind (\ s a -> s{_cKind = a}) + +-- | Name of this country. +cName :: Lens' Country (Maybe Text) +cName = lens _cName (\ s a -> s{_cName = a}) + +-- | Country code. +cCountryCode :: Lens' Country (Maybe Text) +cCountryCode + = lens _cCountryCode (\ s a -> s{_cCountryCode = a}) + +-- | DART ID of this country. This is the ID used for targeting and +-- generating reports. +cDartId :: Lens' Country (Maybe Int64) +cDartId + = lens _cDartId (\ s a -> s{_cDartId = a}) . + mapping _Coerce + +-- | Whether ad serving supports secure servers in this country. +cSSLEnabled :: Lens' Country (Maybe Bool) +cSSLEnabled + = lens _cSSLEnabled (\ s a -> s{_cSSLEnabled = a}) + +instance FromJSON Country where + parseJSON + = withObject "Country" + (\ o -> + Country' <$> + (o .:? "kind" .!= "dfareporting#country") <*> + (o .:? "name") + <*> (o .:? "countryCode") + <*> (o .:? "dartId") + <*> (o .:? "sslEnabled")) + +instance ToJSON Country where + toJSON Country'{..} + = object + (catMaybes + [Just ("kind" .= _cKind), ("name" .=) <$> _cName, + ("countryCode" .=) <$> _cCountryCode, + ("dartId" .=) <$> _cDartId, + ("sslEnabled" .=) <$> _cSSLEnabled]) + +-- | Operating System Version List Response +-- +-- /See:/ 'operatingSystemVersionsListResponse' smart constructor. +data OperatingSystemVersionsListResponse = + OperatingSystemVersionsListResponse' + { _osvlrKind :: !Text + , _osvlrOperatingSystemVersions :: !(Maybe [OperatingSystemVersion]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'OperatingSystemVersionsListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'osvlrKind' +-- +-- * 'osvlrOperatingSystemVersions' +operatingSystemVersionsListResponse + :: OperatingSystemVersionsListResponse +operatingSystemVersionsListResponse = + OperatingSystemVersionsListResponse' + { _osvlrKind = "dfareporting#operatingSystemVersionsListResponse" + , _osvlrOperatingSystemVersions = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#operatingSystemVersionsListResponse\". +osvlrKind :: Lens' OperatingSystemVersionsListResponse Text +osvlrKind + = lens _osvlrKind (\ s a -> s{_osvlrKind = a}) + +-- | Operating system version collection. +osvlrOperatingSystemVersions :: Lens' OperatingSystemVersionsListResponse [OperatingSystemVersion] +osvlrOperatingSystemVersions + = lens _osvlrOperatingSystemVersions + (\ s a -> s{_osvlrOperatingSystemVersions = a}) + . _Default + . _Coerce + +instance FromJSON OperatingSystemVersionsListResponse + where + parseJSON + = withObject "OperatingSystemVersionsListResponse" + (\ o -> + OperatingSystemVersionsListResponse' <$> + (o .:? "kind" .!= + "dfareporting#operatingSystemVersionsListResponse") + <*> (o .:? "operatingSystemVersions" .!= mempty)) + +instance ToJSON OperatingSystemVersionsListResponse + where + toJSON OperatingSystemVersionsListResponse'{..} + = object + (catMaybes + [Just ("kind" .= _osvlrKind), + ("operatingSystemVersions" .=) <$> + _osvlrOperatingSystemVersions]) + +-- | Click Through URL Suffix settings. +-- +-- /See:/ 'clickThroughURLSuffixProperties' smart constructor. +data ClickThroughURLSuffixProperties = + ClickThroughURLSuffixProperties' + { _ctuspOverrideInheritedSuffix :: !(Maybe Bool) + , _ctuspClickThroughURLSuffix :: !(Maybe Text) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ClickThroughURLSuffixProperties' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'ctuspOverrideInheritedSuffix' +-- +-- * 'ctuspClickThroughURLSuffix' +clickThroughURLSuffixProperties + :: ClickThroughURLSuffixProperties +clickThroughURLSuffixProperties = + ClickThroughURLSuffixProperties' + { _ctuspOverrideInheritedSuffix = Nothing + , _ctuspClickThroughURLSuffix = Nothing + } + + +-- | Whether this entity should override the inherited click-through URL +-- suffix with its own defined value. +ctuspOverrideInheritedSuffix :: Lens' ClickThroughURLSuffixProperties (Maybe Bool) +ctuspOverrideInheritedSuffix + = lens _ctuspOverrideInheritedSuffix + (\ s a -> s{_ctuspOverrideInheritedSuffix = a}) + +-- | Click-through URL suffix to apply to all ads in this entity\'s scope. +-- Must be less than 128 characters long. +ctuspClickThroughURLSuffix :: Lens' ClickThroughURLSuffixProperties (Maybe Text) +ctuspClickThroughURLSuffix + = lens _ctuspClickThroughURLSuffix + (\ s a -> s{_ctuspClickThroughURLSuffix = a}) + +instance FromJSON ClickThroughURLSuffixProperties + where + parseJSON + = withObject "ClickThroughURLSuffixProperties" + (\ o -> + ClickThroughURLSuffixProperties' <$> + (o .:? "overrideInheritedSuffix") <*> + (o .:? "clickThroughUrlSuffix")) + +instance ToJSON ClickThroughURLSuffixProperties where + toJSON ClickThroughURLSuffixProperties'{..} + = object + (catMaybes + [("overrideInheritedSuffix" .=) <$> + _ctuspOverrideInheritedSuffix, + ("clickThroughUrlSuffix" .=) <$> + _ctuspClickThroughURLSuffix]) + +-- | Pricing Information +-- +-- /See:/ 'pricing' smart constructor. +data Pricing = + Pricing' + { _priEndDate :: !(Maybe Date') + , _priStartDate :: !(Maybe Date') + , _priGroupType :: !(Maybe PricingGroupType) + , _priPricingType :: !(Maybe PricingPricingType) + , _priFlights :: !(Maybe [Flight]) + , _priCapCostType :: !(Maybe PricingCapCostType) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'Pricing' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'priEndDate' +-- +-- * 'priStartDate' +-- +-- * 'priGroupType' +-- +-- * 'priPricingType' +-- +-- * 'priFlights' +-- +-- * 'priCapCostType' +pricing + :: Pricing +pricing = + Pricing' + { _priEndDate = Nothing + , _priStartDate = Nothing + , _priGroupType = Nothing + , _priPricingType = Nothing + , _priFlights = Nothing + , _priCapCostType = Nothing + } + + +-- | End date of this inventory item. +priEndDate :: Lens' Pricing (Maybe Day) +priEndDate + = lens _priEndDate (\ s a -> s{_priEndDate = a}) . + mapping _Date + +-- | Start date of this inventory item. +priStartDate :: Lens' Pricing (Maybe Day) +priStartDate + = lens _priStartDate (\ s a -> s{_priStartDate = a}) + . mapping _Date + +-- | Group type of this inventory item if it represents a placement group. Is +-- null otherwise. There are two type of placement groups: +-- PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory +-- items that acts as a single pricing point for a group of tags. +-- PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items +-- that not only acts as a single pricing point, but also assumes that all +-- the tags in it will be served at the same time. A roadblock requires one +-- of its assigned inventory items to be marked as primary. +priGroupType :: Lens' Pricing (Maybe PricingGroupType) +priGroupType + = lens _priGroupType (\ s a -> s{_priGroupType = a}) + +-- | Pricing type of this inventory item. +priPricingType :: Lens' Pricing (Maybe PricingPricingType) +priPricingType + = lens _priPricingType + (\ s a -> s{_priPricingType = a}) + +-- | Flights of this inventory item. A flight (a.k.a. pricing period) +-- represents the inventory item pricing information for a specific period +-- of time. +priFlights :: Lens' Pricing [Flight] +priFlights + = lens _priFlights (\ s a -> s{_priFlights = a}) . + _Default + . _Coerce + +-- | Cap cost type of this inventory item. +priCapCostType :: Lens' Pricing (Maybe PricingCapCostType) +priCapCostType + = lens _priCapCostType + (\ s a -> s{_priCapCostType = a}) + +instance FromJSON Pricing where + parseJSON + = withObject "Pricing" + (\ o -> + Pricing' <$> + (o .:? "endDate") <*> (o .:? "startDate") <*> + (o .:? "groupType") + <*> (o .:? "pricingType") + <*> (o .:? "flights" .!= mempty) + <*> (o .:? "capCostType")) + +instance ToJSON Pricing where + toJSON Pricing'{..} + = object + (catMaybes + [("endDate" .=) <$> _priEndDate, + ("startDate" .=) <$> _priStartDate, + ("groupType" .=) <$> _priGroupType, + ("pricingType" .=) <$> _priPricingType, + ("flights" .=) <$> _priFlights, + ("capCostType" .=) <$> _priCapCostType]) + +-- | Audience Segment Group. +-- +-- /See:/ 'audienceSegmentGroup' smart constructor. +data AudienceSegmentGroup = + AudienceSegmentGroup' + { _asgAudienceSegments :: !(Maybe [AudienceSegment]) + , _asgName :: !(Maybe Text) + , _asgId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'AudienceSegmentGroup' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'asgAudienceSegments' +-- +-- * 'asgName' +-- +-- * 'asgId' +audienceSegmentGroup + :: AudienceSegmentGroup +audienceSegmentGroup = + AudienceSegmentGroup' + {_asgAudienceSegments = Nothing, _asgName = Nothing, _asgId = Nothing} + + +-- | Audience segments assigned to this group. The number of segments must be +-- between 2 and 100. +asgAudienceSegments :: Lens' AudienceSegmentGroup [AudienceSegment] +asgAudienceSegments + = lens _asgAudienceSegments + (\ s a -> s{_asgAudienceSegments = a}) + . _Default + . _Coerce + +-- | Name of this audience segment group. This is a required field and must +-- be less than 65 characters long. +asgName :: Lens' AudienceSegmentGroup (Maybe Text) +asgName = lens _asgName (\ s a -> s{_asgName = a}) + +-- | ID of this audience segment group. This is a read-only, auto-generated +-- field. +asgId :: Lens' AudienceSegmentGroup (Maybe Int64) +asgId + = lens _asgId (\ s a -> s{_asgId = a}) . + mapping _Coerce + +instance FromJSON AudienceSegmentGroup where + parseJSON + = withObject "AudienceSegmentGroup" + (\ o -> + AudienceSegmentGroup' <$> + (o .:? "audienceSegments" .!= mempty) <*> + (o .:? "name") + <*> (o .:? "id")) + +instance ToJSON AudienceSegmentGroup where + toJSON AudienceSegmentGroup'{..} + = object + (catMaybes + [("audienceSegments" .=) <$> _asgAudienceSegments, + ("name" .=) <$> _asgName, ("id" .=) <$> _asgId]) + +-- | Contains information about an operating system that can be targeted by +-- ads. +-- +-- /See:/ 'operatingSystem' smart constructor. +data OperatingSystem = + OperatingSystem' + { _osDesktop :: !(Maybe Bool) + , _osKind :: !Text + , _osName :: !(Maybe Text) + , _osMobile :: !(Maybe Bool) + , _osDartId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'OperatingSystem' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'osDesktop' +-- +-- * 'osKind' +-- +-- * 'osName' +-- +-- * 'osMobile' +-- +-- * 'osDartId' +operatingSystem + :: OperatingSystem +operatingSystem = + OperatingSystem' + { _osDesktop = Nothing + , _osKind = "dfareporting#operatingSystem" + , _osName = Nothing + , _osMobile = Nothing + , _osDartId = Nothing + } + + +-- | Whether this operating system is for desktop. +osDesktop :: Lens' OperatingSystem (Maybe Bool) +osDesktop + = lens _osDesktop (\ s a -> s{_osDesktop = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#operatingSystem\". +osKind :: Lens' OperatingSystem Text +osKind = lens _osKind (\ s a -> s{_osKind = a}) + +-- | Name of this operating system. +osName :: Lens' OperatingSystem (Maybe Text) +osName = lens _osName (\ s a -> s{_osName = a}) + +-- | Whether this operating system is for mobile. +osMobile :: Lens' OperatingSystem (Maybe Bool) +osMobile = lens _osMobile (\ s a -> s{_osMobile = a}) + +-- | DART ID of this operating system. This is the ID used for targeting. +osDartId :: Lens' OperatingSystem (Maybe Int64) +osDartId + = lens _osDartId (\ s a -> s{_osDartId = a}) . + mapping _Coerce + +instance FromJSON OperatingSystem where + parseJSON + = withObject "OperatingSystem" + (\ o -> + OperatingSystem' <$> + (o .:? "desktop") <*> + (o .:? "kind" .!= "dfareporting#operatingSystem") + <*> (o .:? "name") + <*> (o .:? "mobile") + <*> (o .:? "dartId")) + +instance ToJSON OperatingSystem where + toJSON OperatingSystem'{..} + = object + (catMaybes + [("desktop" .=) <$> _osDesktop, + Just ("kind" .= _osKind), ("name" .=) <$> _osName, + ("mobile" .=) <$> _osMobile, + ("dartId" .=) <$> _osDartId]) + +-- | Flight +-- +-- /See:/ 'flight' smart constructor. +data Flight = + Flight' + { _fRateOrCost :: !(Maybe (Textual Int64)) + , _fEndDate :: !(Maybe Date') + , _fStartDate :: !(Maybe Date') + , _fUnits :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'Flight' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'fRateOrCost' +-- +-- * 'fEndDate' +-- +-- * 'fStartDate' +-- +-- * 'fUnits' +flight + :: Flight +flight = + Flight' + { _fRateOrCost = Nothing + , _fEndDate = Nothing + , _fStartDate = Nothing + , _fUnits = Nothing + } + + +-- | Rate or cost of this flight. +fRateOrCost :: Lens' Flight (Maybe Int64) +fRateOrCost + = lens _fRateOrCost (\ s a -> s{_fRateOrCost = a}) . + mapping _Coerce + +-- | Inventory item flight end date. +fEndDate :: Lens' Flight (Maybe Day) +fEndDate + = lens _fEndDate (\ s a -> s{_fEndDate = a}) . + mapping _Date + +-- | Inventory item flight start date. +fStartDate :: Lens' Flight (Maybe Day) +fStartDate + = lens _fStartDate (\ s a -> s{_fStartDate = a}) . + mapping _Date + +-- | Units of this flight. +fUnits :: Lens' Flight (Maybe Int64) +fUnits + = lens _fUnits (\ s a -> s{_fUnits = a}) . + mapping _Coerce + +instance FromJSON Flight where + parseJSON + = withObject "Flight" + (\ o -> + Flight' <$> + (o .:? "rateOrCost") <*> (o .:? "endDate") <*> + (o .:? "startDate") + <*> (o .:? "units")) + +instance ToJSON Flight where + toJSON Flight'{..} + = object + (catMaybes + [("rateOrCost" .=) <$> _fRateOrCost, + ("endDate" .=) <$> _fEndDate, + ("startDate" .=) <$> _fStartDate, + ("units" .=) <$> _fUnits]) + +-- | City List Response +-- +-- /See:/ 'citiesListResponse' smart constructor. +data CitiesListResponse = + CitiesListResponse' + { _citKind :: !Text + , _citCities :: !(Maybe [City]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'CitiesListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'citKind' +-- +-- * 'citCities' +citiesListResponse + :: CitiesListResponse +citiesListResponse = + CitiesListResponse' + {_citKind = "dfareporting#citiesListResponse", _citCities = Nothing} + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#citiesListResponse\". +citKind :: Lens' CitiesListResponse Text +citKind = lens _citKind (\ s a -> s{_citKind = a}) + +-- | City collection. +citCities :: Lens' CitiesListResponse [City] +citCities + = lens _citCities (\ s a -> s{_citCities = a}) . + _Default + . _Coerce + +instance FromJSON CitiesListResponse where + parseJSON + = withObject "CitiesListResponse" + (\ o -> + CitiesListResponse' <$> + (o .:? "kind" .!= "dfareporting#citiesListResponse") + <*> (o .:? "cities" .!= mempty)) + +instance ToJSON CitiesListResponse where + toJSON CitiesListResponse'{..} + = object + (catMaybes + [Just ("kind" .= _citKind), + ("cities" .=) <$> _citCities]) + +-- | Represents a dimension. +-- +-- /See:/ 'dimension' smart constructor. +data Dimension = + Dimension' + { _dKind :: !Text + , _dName :: !(Maybe Text) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'Dimension' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'dKind' +-- +-- * 'dName' +dimension + :: Dimension +dimension = Dimension' {_dKind = "dfareporting#dimension", _dName = Nothing} + + +-- | The kind of resource this is, in this case dfareporting#dimension. +dKind :: Lens' Dimension Text +dKind = lens _dKind (\ s a -> s{_dKind = a}) + +-- | The dimension name, e.g. dfa:advertiser +dName :: Lens' Dimension (Maybe Text) +dName = lens _dName (\ s a -> s{_dName = a}) + +instance FromJSON Dimension where + parseJSON + = withObject "Dimension" + (\ o -> + Dimension' <$> + (o .:? "kind" .!= "dfareporting#dimension") <*> + (o .:? "name")) + +instance ToJSON Dimension where + toJSON Dimension'{..} + = object + (catMaybes + [Just ("kind" .= _dKind), ("name" .=) <$> _dName]) + +-- | The report criteria for a report of type \"REACH\". +-- +-- /See:/ 'reportReachCriteria' smart constructor. +data ReportReachCriteria = + ReportReachCriteria' + { _rrcReachByFrequencyMetricNames :: !(Maybe [Text]) + , _rrcEnableAllDimensionCombinations :: !(Maybe Bool) + , _rrcMetricNames :: !(Maybe [Text]) + , _rrcCustomRichMediaEvents :: !(Maybe CustomRichMediaEvents) + , _rrcDimensionFilters :: !(Maybe [DimensionValue]) + , _rrcActivities :: !(Maybe Activities) + , _rrcDateRange :: !(Maybe DateRange) + , _rrcDimensions :: !(Maybe [SortedDimension]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ReportReachCriteria' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'rrcReachByFrequencyMetricNames' +-- +-- * 'rrcEnableAllDimensionCombinations' +-- +-- * 'rrcMetricNames' +-- +-- * 'rrcCustomRichMediaEvents' +-- +-- * 'rrcDimensionFilters' +-- +-- * 'rrcActivities' +-- +-- * 'rrcDateRange' +-- +-- * 'rrcDimensions' +reportReachCriteria + :: ReportReachCriteria +reportReachCriteria = + ReportReachCriteria' + { _rrcReachByFrequencyMetricNames = Nothing + , _rrcEnableAllDimensionCombinations = Nothing + , _rrcMetricNames = Nothing + , _rrcCustomRichMediaEvents = Nothing + , _rrcDimensionFilters = Nothing + , _rrcActivities = Nothing + , _rrcDateRange = Nothing + , _rrcDimensions = Nothing + } + + +-- | The list of names of Reach By Frequency metrics the report should +-- include. +rrcReachByFrequencyMetricNames :: Lens' ReportReachCriteria [Text] +rrcReachByFrequencyMetricNames + = lens _rrcReachByFrequencyMetricNames + (\ s a -> s{_rrcReachByFrequencyMetricNames = a}) + . _Default + . _Coerce + +-- | Whether to enable all reach dimension combinations in the report. +-- Defaults to false. If enabled, the date range of the report should be +-- within the last 42 days. +rrcEnableAllDimensionCombinations :: Lens' ReportReachCriteria (Maybe Bool) +rrcEnableAllDimensionCombinations + = lens _rrcEnableAllDimensionCombinations + (\ s a -> s{_rrcEnableAllDimensionCombinations = a}) + +-- | The list of names of metrics the report should include. +rrcMetricNames :: Lens' ReportReachCriteria [Text] +rrcMetricNames + = lens _rrcMetricNames + (\ s a -> s{_rrcMetricNames = a}) + . _Default + . _Coerce + +-- | Custom Rich Media Events group. +rrcCustomRichMediaEvents :: Lens' ReportReachCriteria (Maybe CustomRichMediaEvents) +rrcCustomRichMediaEvents + = lens _rrcCustomRichMediaEvents + (\ s a -> s{_rrcCustomRichMediaEvents = a}) + +-- | The list of filters on which dimensions are filtered. Filters for +-- different dimensions are ANDed, filters for the same dimension are +-- grouped together and ORed. +rrcDimensionFilters :: Lens' ReportReachCriteria [DimensionValue] +rrcDimensionFilters + = lens _rrcDimensionFilters + (\ s a -> s{_rrcDimensionFilters = a}) + . _Default + . _Coerce + +-- | Activity group. +rrcActivities :: Lens' ReportReachCriteria (Maybe Activities) +rrcActivities + = lens _rrcActivities + (\ s a -> s{_rrcActivities = a}) + +-- | The date range this report should be run for. +rrcDateRange :: Lens' ReportReachCriteria (Maybe DateRange) +rrcDateRange + = lens _rrcDateRange (\ s a -> s{_rrcDateRange = a}) + +-- | The list of dimensions the report should include. +rrcDimensions :: Lens' ReportReachCriteria [SortedDimension] +rrcDimensions + = lens _rrcDimensions + (\ s a -> s{_rrcDimensions = a}) + . _Default + . _Coerce + +instance FromJSON ReportReachCriteria where + parseJSON + = withObject "ReportReachCriteria" + (\ o -> + ReportReachCriteria' <$> + (o .:? "reachByFrequencyMetricNames" .!= mempty) <*> + (o .:? "enableAllDimensionCombinations") + <*> (o .:? "metricNames" .!= mempty) + <*> (o .:? "customRichMediaEvents") + <*> (o .:? "dimensionFilters" .!= mempty) + <*> (o .:? "activities") + <*> (o .:? "dateRange") + <*> (o .:? "dimensions" .!= mempty)) + +instance ToJSON ReportReachCriteria where + toJSON ReportReachCriteria'{..} + = object + (catMaybes + [("reachByFrequencyMetricNames" .=) <$> + _rrcReachByFrequencyMetricNames, + ("enableAllDimensionCombinations" .=) <$> + _rrcEnableAllDimensionCombinations, + ("metricNames" .=) <$> _rrcMetricNames, + ("customRichMediaEvents" .=) <$> + _rrcCustomRichMediaEvents, + ("dimensionFilters" .=) <$> _rrcDimensionFilters, + ("activities" .=) <$> _rrcActivities, + ("dateRange" .=) <$> _rrcDateRange, + ("dimensions" .=) <$> _rrcDimensions]) + +-- | Represents a Custom Rich Media Events group. +-- +-- /See:/ 'customRichMediaEvents' smart constructor. +data CustomRichMediaEvents = + CustomRichMediaEvents' + { _crmeKind :: !Text + , _crmeFilteredEventIds :: !(Maybe [DimensionValue]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'CustomRichMediaEvents' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'crmeKind' +-- +-- * 'crmeFilteredEventIds' +customRichMediaEvents + :: CustomRichMediaEvents +customRichMediaEvents = + CustomRichMediaEvents' + { _crmeKind = "dfareporting#customRichMediaEvents" + , _crmeFilteredEventIds = Nothing + } + + +-- | The kind of resource this is, in this case +-- dfareporting#customRichMediaEvents. +crmeKind :: Lens' CustomRichMediaEvents Text +crmeKind = lens _crmeKind (\ s a -> s{_crmeKind = a}) + +-- | List of custom rich media event IDs. Dimension values must be all of +-- type dfa:richMediaEventTypeIdAndName. +crmeFilteredEventIds :: Lens' CustomRichMediaEvents [DimensionValue] +crmeFilteredEventIds + = lens _crmeFilteredEventIds + (\ s a -> s{_crmeFilteredEventIds = a}) + . _Default + . _Coerce + +instance FromJSON CustomRichMediaEvents where + parseJSON + = withObject "CustomRichMediaEvents" + (\ o -> + CustomRichMediaEvents' <$> + (o .:? "kind" .!= + "dfareporting#customRichMediaEvents") + <*> (o .:? "filteredEventIds" .!= mempty)) + +instance ToJSON CustomRichMediaEvents where + toJSON CustomRichMediaEvents'{..} + = object + (catMaybes + [Just ("kind" .= _crmeKind), + ("filteredEventIds" .=) <$> _crmeFilteredEventIds]) + +-- | Language List Response +-- +-- /See:/ 'languagesListResponse' smart constructor. +data LanguagesListResponse = + LanguagesListResponse' + { _llrKind :: !Text + , _llrLanguages :: !(Maybe [Language]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'LanguagesListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'llrKind' +-- +-- * 'llrLanguages' +languagesListResponse + :: LanguagesListResponse +languagesListResponse = + LanguagesListResponse' + {_llrKind = "dfareporting#languagesListResponse", _llrLanguages = Nothing} + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#languagesListResponse\". +llrKind :: Lens' LanguagesListResponse Text +llrKind = lens _llrKind (\ s a -> s{_llrKind = a}) + +-- | Language collection. +llrLanguages :: Lens' LanguagesListResponse [Language] +llrLanguages + = lens _llrLanguages (\ s a -> s{_llrLanguages = a}) + . _Default + . _Coerce + +instance FromJSON LanguagesListResponse where + parseJSON + = withObject "LanguagesListResponse" + (\ o -> + LanguagesListResponse' <$> + (o .:? "kind" .!= + "dfareporting#languagesListResponse") + <*> (o .:? "languages" .!= mempty)) + +instance ToJSON LanguagesListResponse where + toJSON LanguagesListResponse'{..} + = object + (catMaybes + [Just ("kind" .= _llrKind), + ("languages" .=) <$> _llrLanguages]) + +-- | The attributes, like playtime and percent onscreen, that define the +-- Custom Viewability Metric. +-- +-- /See:/ 'customViewabilityMetricConfiguration' smart constructor. +data CustomViewabilityMetricConfiguration = + CustomViewabilityMetricConfiguration' + { _cvmcViewabilityPercent :: !(Maybe (Textual Int32)) + , _cvmcTimePercent :: !(Maybe (Textual Int32)) + , _cvmcAudible :: !(Maybe Bool) + , _cvmcTimeMillis :: !(Maybe (Textual Int32)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'CustomViewabilityMetricConfiguration' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'cvmcViewabilityPercent' +-- +-- * 'cvmcTimePercent' +-- +-- * 'cvmcAudible' +-- +-- * 'cvmcTimeMillis' +customViewabilityMetricConfiguration + :: CustomViewabilityMetricConfiguration +customViewabilityMetricConfiguration = + CustomViewabilityMetricConfiguration' + { _cvmcViewabilityPercent = Nothing + , _cvmcTimePercent = Nothing + , _cvmcAudible = Nothing + , _cvmcTimeMillis = Nothing + } + + +-- | The percentage of video that must be on screen for the Custom +-- Viewability Metric to count an impression. +cvmcViewabilityPercent :: Lens' CustomViewabilityMetricConfiguration (Maybe Int32) +cvmcViewabilityPercent + = lens _cvmcViewabilityPercent + (\ s a -> s{_cvmcViewabilityPercent = a}) + . mapping _Coerce + +-- | The percentage of video that must play for the Custom Viewability Metric +-- to count an impression. If both this and timeMillis are specified, the +-- earlier of the two will be used. +cvmcTimePercent :: Lens' CustomViewabilityMetricConfiguration (Maybe Int32) +cvmcTimePercent + = lens _cvmcTimePercent + (\ s a -> s{_cvmcTimePercent = a}) + . mapping _Coerce + +-- | Whether the video must be audible to count an impression. +cvmcAudible :: Lens' CustomViewabilityMetricConfiguration (Maybe Bool) +cvmcAudible + = lens _cvmcAudible (\ s a -> s{_cvmcAudible = a}) + +-- | The time in milliseconds the video must play for the Custom Viewability +-- Metric to count an impression. If both this and timePercent are +-- specified, the earlier of the two will be used. +cvmcTimeMillis :: Lens' CustomViewabilityMetricConfiguration (Maybe Int32) +cvmcTimeMillis + = lens _cvmcTimeMillis + (\ s a -> s{_cvmcTimeMillis = a}) + . mapping _Coerce + +instance FromJSON + CustomViewabilityMetricConfiguration + where + parseJSON + = withObject "CustomViewabilityMetricConfiguration" + (\ o -> + CustomViewabilityMetricConfiguration' <$> + (o .:? "viewabilityPercent") <*> + (o .:? "timePercent") + <*> (o .:? "audible") + <*> (o .:? "timeMillis")) + +instance ToJSON CustomViewabilityMetricConfiguration + where + toJSON CustomViewabilityMetricConfiguration'{..} + = object + (catMaybes + [("viewabilityPercent" .=) <$> + _cvmcViewabilityPercent, + ("timePercent" .=) <$> _cvmcTimePercent, + ("audible" .=) <$> _cvmcAudible, + ("timeMillis" .=) <$> _cvmcTimeMillis]) + +-- | Targetable remarketing list response +-- +-- /See:/ 'targetableRemarketingListsListResponse' smart constructor. +data TargetableRemarketingListsListResponse = + TargetableRemarketingListsListResponse' + { _trllrNextPageToken :: !(Maybe Text) + , _trllrKind :: !Text + , _trllrTargetableRemarketingLists :: !(Maybe [TargetableRemarketingList]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'TargetableRemarketingListsListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'trllrNextPageToken' +-- +-- * 'trllrKind' +-- +-- * 'trllrTargetableRemarketingLists' +targetableRemarketingListsListResponse + :: TargetableRemarketingListsListResponse +targetableRemarketingListsListResponse = + TargetableRemarketingListsListResponse' + { _trllrNextPageToken = Nothing + , _trllrKind = "dfareporting#targetableRemarketingListsListResponse" + , _trllrTargetableRemarketingLists = Nothing + } + + +-- | Pagination token to be used for the next list operation. +trllrNextPageToken :: Lens' TargetableRemarketingListsListResponse (Maybe Text) +trllrNextPageToken + = lens _trllrNextPageToken + (\ s a -> s{_trllrNextPageToken = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#targetableRemarketingListsListResponse\". +trllrKind :: Lens' TargetableRemarketingListsListResponse Text +trllrKind + = lens _trllrKind (\ s a -> s{_trllrKind = a}) + +-- | Targetable remarketing list collection. +trllrTargetableRemarketingLists :: Lens' TargetableRemarketingListsListResponse [TargetableRemarketingList] +trllrTargetableRemarketingLists + = lens _trllrTargetableRemarketingLists + (\ s a -> s{_trllrTargetableRemarketingLists = a}) + . _Default + . _Coerce + +instance FromJSON + TargetableRemarketingListsListResponse + where + parseJSON + = withObject "TargetableRemarketingListsListResponse" + (\ o -> + TargetableRemarketingListsListResponse' <$> + (o .:? "nextPageToken") <*> + (o .:? "kind" .!= + "dfareporting#targetableRemarketingListsListResponse") + <*> (o .:? "targetableRemarketingLists" .!= mempty)) + +instance ToJSON + TargetableRemarketingListsListResponse + where + toJSON TargetableRemarketingListsListResponse'{..} + = object + (catMaybes + [("nextPageToken" .=) <$> _trllrNextPageToken, + Just ("kind" .= _trllrKind), + ("targetableRemarketingLists" .=) <$> + _trllrTargetableRemarketingLists]) + +-- | Change Log List Response +-- +-- /See:/ 'changeLogsListResponse' smart constructor. +data ChangeLogsListResponse = + ChangeLogsListResponse' + { _cllrNextPageToken :: !(Maybe Text) + , _cllrKind :: !Text + , _cllrChangeLogs :: !(Maybe [ChangeLog]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ChangeLogsListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'cllrNextPageToken' +-- +-- * 'cllrKind' +-- +-- * 'cllrChangeLogs' +changeLogsListResponse + :: ChangeLogsListResponse +changeLogsListResponse = + ChangeLogsListResponse' + { _cllrNextPageToken = Nothing + , _cllrKind = "dfareporting#changeLogsListResponse" + , _cllrChangeLogs = Nothing + } + + +-- | Pagination token to be used for the next list operation. +cllrNextPageToken :: Lens' ChangeLogsListResponse (Maybe Text) +cllrNextPageToken + = lens _cllrNextPageToken + (\ s a -> s{_cllrNextPageToken = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#changeLogsListResponse\". +cllrKind :: Lens' ChangeLogsListResponse Text +cllrKind = lens _cllrKind (\ s a -> s{_cllrKind = a}) + +-- | Change log collection. +cllrChangeLogs :: Lens' ChangeLogsListResponse [ChangeLog] +cllrChangeLogs + = lens _cllrChangeLogs + (\ s a -> s{_cllrChangeLogs = a}) + . _Default + . _Coerce + +instance FromJSON ChangeLogsListResponse where + parseJSON + = withObject "ChangeLogsListResponse" + (\ o -> + ChangeLogsListResponse' <$> + (o .:? "nextPageToken") <*> + (o .:? "kind" .!= + "dfareporting#changeLogsListResponse") + <*> (o .:? "changeLogs" .!= mempty)) + +instance ToJSON ChangeLogsListResponse where + toJSON ChangeLogsListResponse'{..} + = object + (catMaybes + [("nextPageToken" .=) <$> _cllrNextPageToken, + Just ("kind" .= _cllrKind), + ("changeLogs" .=) <$> _cllrChangeLogs]) + +-- | AccountUserProfiles contains properties of a Campaign Manager user +-- profile. This resource is specifically for managing user profiles, +-- whereas UserProfiles is for accessing the API. +-- +-- /See:/ 'accountUserProFile' smart constructor. +data AccountUserProFile = + AccountUserProFile' + { _aupfEmail :: !(Maybe Text) + , _aupfUserRoleFilter :: !(Maybe ObjectFilter) + , _aupfAdvertiserFilter :: !(Maybe ObjectFilter) + , _aupfUserRoleId :: !(Maybe (Textual Int64)) + , _aupfKind :: !Text + , _aupfLocale :: !(Maybe Text) + , _aupfSiteFilter :: !(Maybe ObjectFilter) + , _aupfTraffickerType :: !(Maybe AccountUserProFileTraffickerType) + , _aupfActive :: !(Maybe Bool) + , _aupfAccountId :: !(Maybe (Textual Int64)) + , _aupfName :: !(Maybe Text) + , _aupfId :: !(Maybe (Textual Int64)) + , _aupfUserAccessType :: !(Maybe AccountUserProFileUserAccessType) + , _aupfComments :: !(Maybe Text) + , _aupfSubAccountId :: !(Maybe (Textual Int64)) + , _aupfCampaignFilter :: !(Maybe ObjectFilter) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'AccountUserProFile' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'aupfEmail' +-- +-- * 'aupfUserRoleFilter' +-- +-- * 'aupfAdvertiserFilter' +-- +-- * 'aupfUserRoleId' +-- +-- * 'aupfKind' +-- +-- * 'aupfLocale' +-- +-- * 'aupfSiteFilter' +-- +-- * 'aupfTraffickerType' +-- +-- * 'aupfActive' +-- +-- * 'aupfAccountId' +-- +-- * 'aupfName' +-- +-- * 'aupfId' +-- +-- * 'aupfUserAccessType' +-- +-- * 'aupfComments' +-- +-- * 'aupfSubAccountId' +-- +-- * 'aupfCampaignFilter' +accountUserProFile + :: AccountUserProFile +accountUserProFile = + AccountUserProFile' + { _aupfEmail = Nothing + , _aupfUserRoleFilter = Nothing + , _aupfAdvertiserFilter = Nothing + , _aupfUserRoleId = Nothing + , _aupfKind = "dfareporting#accountUserProfile" + , _aupfLocale = Nothing + , _aupfSiteFilter = Nothing + , _aupfTraffickerType = Nothing + , _aupfActive = Nothing + , _aupfAccountId = Nothing + , _aupfName = Nothing + , _aupfId = Nothing + , _aupfUserAccessType = Nothing + , _aupfComments = Nothing + , _aupfSubAccountId = Nothing + , _aupfCampaignFilter = Nothing + } + + +-- | Email of the user profile. The email addresss must be linked to a Google +-- Account. This field is required on insertion and is read-only after +-- insertion. +aupfEmail :: Lens' AccountUserProFile (Maybe Text) +aupfEmail + = lens _aupfEmail (\ s a -> s{_aupfEmail = a}) + +-- | Filter that describes which user roles are visible to the user profile. +aupfUserRoleFilter :: Lens' AccountUserProFile (Maybe ObjectFilter) +aupfUserRoleFilter + = lens _aupfUserRoleFilter + (\ s a -> s{_aupfUserRoleFilter = a}) + +-- | Filter that describes which advertisers are visible to the user profile. +aupfAdvertiserFilter :: Lens' AccountUserProFile (Maybe ObjectFilter) +aupfAdvertiserFilter + = lens _aupfAdvertiserFilter + (\ s a -> s{_aupfAdvertiserFilter = a}) + +-- | User role ID of the user profile. This is a required field. +aupfUserRoleId :: Lens' AccountUserProFile (Maybe Int64) +aupfUserRoleId + = lens _aupfUserRoleId + (\ s a -> s{_aupfUserRoleId = a}) + . mapping _Coerce + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#accountUserProfile\". +aupfKind :: Lens' AccountUserProFile Text +aupfKind = lens _aupfKind (\ s a -> s{_aupfKind = a}) + +-- | Locale of the user profile. This is a required field. Acceptable values +-- are: - \"cs\" (Czech) - \"de\" (German) - \"en\" (English) - \"en-GB\" +-- (English United Kingdom) - \"es\" (Spanish) - \"fr\" (French) - \"it\" +-- (Italian) - \"ja\" (Japanese) - \"ko\" (Korean) - \"pl\" (Polish) - +-- \"pt-BR\" (Portuguese Brazil) - \"ru\" (Russian) - \"sv\" (Swedish) - +-- \"tr\" (Turkish) - \"zh-CN\" (Chinese Simplified) - \"zh-TW\" (Chinese +-- Traditional) +aupfLocale :: Lens' AccountUserProFile (Maybe Text) +aupfLocale + = lens _aupfLocale (\ s a -> s{_aupfLocale = a}) + +-- | Filter that describes which sites are visible to the user profile. +aupfSiteFilter :: Lens' AccountUserProFile (Maybe ObjectFilter) +aupfSiteFilter + = lens _aupfSiteFilter + (\ s a -> s{_aupfSiteFilter = a}) + +-- | Trafficker type of this user profile. This is a read-only field. +aupfTraffickerType :: Lens' AccountUserProFile (Maybe AccountUserProFileTraffickerType) +aupfTraffickerType + = lens _aupfTraffickerType + (\ s a -> s{_aupfTraffickerType = a}) + +-- | Whether this user profile is active. This defaults to false, and must be +-- set true on insert for the user profile to be usable. +aupfActive :: Lens' AccountUserProFile (Maybe Bool) +aupfActive + = lens _aupfActive (\ s a -> s{_aupfActive = a}) + +-- | Account ID of the user profile. This is a read-only field that can be +-- left blank. +aupfAccountId :: Lens' AccountUserProFile (Maybe Int64) +aupfAccountId + = lens _aupfAccountId + (\ s a -> s{_aupfAccountId = a}) + . mapping _Coerce + +-- | Name of the user profile. This is a required field. Must be less than 64 +-- characters long, must be globally unique, and cannot contain whitespace +-- or any of the following characters: \"&;\"#%,\". +aupfName :: Lens' AccountUserProFile (Maybe Text) +aupfName = lens _aupfName (\ s a -> s{_aupfName = a}) + +-- | ID of the user profile. This is a read-only, auto-generated field. +aupfId :: Lens' AccountUserProFile (Maybe Int64) +aupfId + = lens _aupfId (\ s a -> s{_aupfId = a}) . + mapping _Coerce + +-- | User type of the user profile. This is a read-only field that can be +-- left blank. +aupfUserAccessType :: Lens' AccountUserProFile (Maybe AccountUserProFileUserAccessType) +aupfUserAccessType + = lens _aupfUserAccessType + (\ s a -> s{_aupfUserAccessType = a}) + +-- | Comments for this user profile. +aupfComments :: Lens' AccountUserProFile (Maybe Text) +aupfComments + = lens _aupfComments (\ s a -> s{_aupfComments = a}) + +-- | Subaccount ID of the user profile. This is a read-only field that can be +-- left blank. +aupfSubAccountId :: Lens' AccountUserProFile (Maybe Int64) +aupfSubAccountId + = lens _aupfSubAccountId + (\ s a -> s{_aupfSubAccountId = a}) + . mapping _Coerce + +-- | Filter that describes which campaigns are visible to the user profile. +aupfCampaignFilter :: Lens' AccountUserProFile (Maybe ObjectFilter) +aupfCampaignFilter + = lens _aupfCampaignFilter + (\ s a -> s{_aupfCampaignFilter = a}) + +instance FromJSON AccountUserProFile where + parseJSON + = withObject "AccountUserProFile" + (\ o -> + AccountUserProFile' <$> + (o .:? "email") <*> (o .:? "userRoleFilter") <*> + (o .:? "advertiserFilter") + <*> (o .:? "userRoleId") + <*> + (o .:? "kind" .!= "dfareporting#accountUserProfile") + <*> (o .:? "locale") + <*> (o .:? "siteFilter") + <*> (o .:? "traffickerType") + <*> (o .:? "active") + <*> (o .:? "accountId") + <*> (o .:? "name") + <*> (o .:? "id") + <*> (o .:? "userAccessType") + <*> (o .:? "comments") + <*> (o .:? "subaccountId") + <*> (o .:? "campaignFilter")) + +instance ToJSON AccountUserProFile where + toJSON AccountUserProFile'{..} + = object + (catMaybes + [("email" .=) <$> _aupfEmail, + ("userRoleFilter" .=) <$> _aupfUserRoleFilter, + ("advertiserFilter" .=) <$> _aupfAdvertiserFilter, + ("userRoleId" .=) <$> _aupfUserRoleId, + Just ("kind" .= _aupfKind), + ("locale" .=) <$> _aupfLocale, + ("siteFilter" .=) <$> _aupfSiteFilter, + ("traffickerType" .=) <$> _aupfTraffickerType, + ("active" .=) <$> _aupfActive, + ("accountId" .=) <$> _aupfAccountId, + ("name" .=) <$> _aupfName, ("id" .=) <$> _aupfId, + ("userAccessType" .=) <$> _aupfUserAccessType, + ("comments" .=) <$> _aupfComments, + ("subaccountId" .=) <$> _aupfSubAccountId, + ("campaignFilter" .=) <$> _aupfCampaignFilter]) + +-- | Represents a DimensionValue resource. +-- +-- /See:/ 'dimensionValue' smart constructor. +data DimensionValue = + DimensionValue' + { _dvEtag :: !(Maybe Text) + , _dvKind :: !Text + , _dvValue :: !(Maybe Text) + , _dvMatchType :: !(Maybe DimensionValueMatchType) + , _dvDimensionName :: !(Maybe Text) + , _dvId :: !(Maybe Text) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'DimensionValue' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'dvEtag' +-- +-- * 'dvKind' +-- +-- * 'dvValue' +-- +-- * 'dvMatchType' +-- +-- * 'dvDimensionName' +-- +-- * 'dvId' +dimensionValue + :: DimensionValue +dimensionValue = + DimensionValue' + { _dvEtag = Nothing + , _dvKind = "dfareporting#dimensionValue" + , _dvValue = Nothing + , _dvMatchType = Nothing + , _dvDimensionName = Nothing + , _dvId = Nothing + } + + +-- | The eTag of this response for caching purposes. +dvEtag :: Lens' DimensionValue (Maybe Text) +dvEtag = lens _dvEtag (\ s a -> s{_dvEtag = a}) + +-- | The kind of resource this is, in this case dfareporting#dimensionValue. +dvKind :: Lens' DimensionValue Text +dvKind = lens _dvKind (\ s a -> s{_dvKind = a}) + +-- | The value of the dimension. +dvValue :: Lens' DimensionValue (Maybe Text) +dvValue = lens _dvValue (\ s a -> s{_dvValue = a}) + +-- | Determines how the \'value\' field is matched when filtering. If not +-- specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, \'*\' is +-- allowed as a placeholder for variable length character sequences, and it +-- can be escaped with a backslash. Note, only paid search dimensions +-- (\'dfa:paidSearch*\') allow a matchType other than EXACT. +dvMatchType :: Lens' DimensionValue (Maybe DimensionValueMatchType) +dvMatchType + = lens _dvMatchType (\ s a -> s{_dvMatchType = a}) + +-- | The name of the dimension. +dvDimensionName :: Lens' DimensionValue (Maybe Text) +dvDimensionName + = lens _dvDimensionName + (\ s a -> s{_dvDimensionName = a}) + +-- | The ID associated with the value if available. +dvId :: Lens' DimensionValue (Maybe Text) +dvId = lens _dvId (\ s a -> s{_dvId = a}) + +instance FromJSON DimensionValue where + parseJSON + = withObject "DimensionValue" + (\ o -> + DimensionValue' <$> + (o .:? "etag") <*> + (o .:? "kind" .!= "dfareporting#dimensionValue") + <*> (o .:? "value") + <*> (o .:? "matchType") + <*> (o .:? "dimensionName") + <*> (o .:? "id")) + +instance ToJSON DimensionValue where + toJSON DimensionValue'{..} + = object + (catMaybes + [("etag" .=) <$> _dvEtag, Just ("kind" .= _dvKind), + ("value" .=) <$> _dvValue, + ("matchType" .=) <$> _dvMatchType, + ("dimensionName" .=) <$> _dvDimensionName, + ("id" .=) <$> _dvId]) + +-- | Represents an activity group. +-- +-- /See:/ 'activities' smart constructor. +data Activities = + Activities' + { _actKind :: !Text + , _actMetricNames :: !(Maybe [Text]) + , _actFilters :: !(Maybe [DimensionValue]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'Activities' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'actKind' +-- +-- * 'actMetricNames' +-- +-- * 'actFilters' +activities + :: Activities +activities = + Activities' + { _actKind = "dfareporting#activities" + , _actMetricNames = Nothing + , _actFilters = Nothing + } + + +-- | The kind of resource this is, in this case dfareporting#activities. +actKind :: Lens' Activities Text +actKind = lens _actKind (\ s a -> s{_actKind = a}) + +-- | List of names of floodlight activity metrics. +actMetricNames :: Lens' Activities [Text] +actMetricNames + = lens _actMetricNames + (\ s a -> s{_actMetricNames = a}) + . _Default + . _Coerce + +-- | List of activity filters. The dimension values need to be all either of +-- type \"dfa:activity\" or \"dfa:activityGroup\". +actFilters :: Lens' Activities [DimensionValue] +actFilters + = lens _actFilters (\ s a -> s{_actFilters = a}) . + _Default + . _Coerce + +instance FromJSON Activities where + parseJSON + = withObject "Activities" + (\ o -> + Activities' <$> + (o .:? "kind" .!= "dfareporting#activities") <*> + (o .:? "metricNames" .!= mempty) + <*> (o .:? "filters" .!= mempty)) + +instance ToJSON Activities where + toJSON Activities'{..} + = object + (catMaybes + [Just ("kind" .= _actKind), + ("metricNames" .=) <$> _actMetricNames, + ("filters" .=) <$> _actFilters]) + +-- | User Role Permission Group List Response +-- +-- /See:/ 'userRolePermissionGroupsListResponse' smart constructor. +data UserRolePermissionGroupsListResponse = + UserRolePermissionGroupsListResponse' + { _urpglrUserRolePermissionGroups :: !(Maybe [UserRolePermissionGroup]) + , _urpglrKind :: !Text + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'UserRolePermissionGroupsListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'urpglrUserRolePermissionGroups' +-- +-- * 'urpglrKind' +userRolePermissionGroupsListResponse + :: UserRolePermissionGroupsListResponse +userRolePermissionGroupsListResponse = + UserRolePermissionGroupsListResponse' + { _urpglrUserRolePermissionGroups = Nothing + , _urpglrKind = "dfareporting#userRolePermissionGroupsListResponse" + } + + +-- | User role permission group collection. +urpglrUserRolePermissionGroups :: Lens' UserRolePermissionGroupsListResponse [UserRolePermissionGroup] +urpglrUserRolePermissionGroups + = lens _urpglrUserRolePermissionGroups + (\ s a -> s{_urpglrUserRolePermissionGroups = a}) + . _Default + . _Coerce + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#userRolePermissionGroupsListResponse\". +urpglrKind :: Lens' UserRolePermissionGroupsListResponse Text +urpglrKind + = lens _urpglrKind (\ s a -> s{_urpglrKind = a}) + +instance FromJSON + UserRolePermissionGroupsListResponse + where + parseJSON + = withObject "UserRolePermissionGroupsListResponse" + (\ o -> + UserRolePermissionGroupsListResponse' <$> + (o .:? "userRolePermissionGroups" .!= mempty) <*> + (o .:? "kind" .!= + "dfareporting#userRolePermissionGroupsListResponse")) + +instance ToJSON UserRolePermissionGroupsListResponse + where + toJSON UserRolePermissionGroupsListResponse'{..} + = object + (catMaybes + [("userRolePermissionGroups" .=) <$> + _urpglrUserRolePermissionGroups, + Just ("kind" .= _urpglrKind)]) + +-- | Placement Tag +-- +-- /See:/ 'placementTag' smart constructor. +data PlacementTag = + PlacementTag' + { _ptPlacementId :: !(Maybe (Textual Int64)) + , _ptTagDatas :: !(Maybe [TagData]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'PlacementTag' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'ptPlacementId' +-- +-- * 'ptTagDatas' +placementTag + :: PlacementTag +placementTag = PlacementTag' {_ptPlacementId = Nothing, _ptTagDatas = Nothing} + + +-- | Placement ID +ptPlacementId :: Lens' PlacementTag (Maybe Int64) +ptPlacementId + = lens _ptPlacementId + (\ s a -> s{_ptPlacementId = a}) + . mapping _Coerce + +-- | Tags generated for this placement. +ptTagDatas :: Lens' PlacementTag [TagData] +ptTagDatas + = lens _ptTagDatas (\ s a -> s{_ptTagDatas = a}) . + _Default + . _Coerce + +instance FromJSON PlacementTag where + parseJSON + = withObject "PlacementTag" + (\ o -> + PlacementTag' <$> + (o .:? "placementId") <*> + (o .:? "tagDatas" .!= mempty)) + +instance ToJSON PlacementTag where + toJSON PlacementTag'{..} + = object + (catMaybes + [("placementId" .=) <$> _ptPlacementId, + ("tagDatas" .=) <$> _ptTagDatas]) + +-- | Remarketing list response +-- +-- /See:/ 'remarketingListsListResponse' smart constructor. +data RemarketingListsListResponse = + RemarketingListsListResponse' + { _rllrNextPageToken :: !(Maybe Text) + , _rllrRemarketingLists :: !(Maybe [RemarketingList]) + , _rllrKind :: !Text + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'RemarketingListsListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'rllrNextPageToken' +-- +-- * 'rllrRemarketingLists' +-- +-- * 'rllrKind' +remarketingListsListResponse + :: RemarketingListsListResponse +remarketingListsListResponse = + RemarketingListsListResponse' + { _rllrNextPageToken = Nothing + , _rllrRemarketingLists = Nothing + , _rllrKind = "dfareporting#remarketingListsListResponse" + } + + +-- | Pagination token to be used for the next list operation. +rllrNextPageToken :: Lens' RemarketingListsListResponse (Maybe Text) +rllrNextPageToken + = lens _rllrNextPageToken + (\ s a -> s{_rllrNextPageToken = a}) + +-- | Remarketing list collection. +rllrRemarketingLists :: Lens' RemarketingListsListResponse [RemarketingList] +rllrRemarketingLists + = lens _rllrRemarketingLists + (\ s a -> s{_rllrRemarketingLists = a}) + . _Default + . _Coerce + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#remarketingListsListResponse\". +rllrKind :: Lens' RemarketingListsListResponse Text +rllrKind = lens _rllrKind (\ s a -> s{_rllrKind = a}) + +instance FromJSON RemarketingListsListResponse where + parseJSON + = withObject "RemarketingListsListResponse" + (\ o -> + RemarketingListsListResponse' <$> + (o .:? "nextPageToken") <*> + (o .:? "remarketingLists" .!= mempty) + <*> + (o .:? "kind" .!= + "dfareporting#remarketingListsListResponse")) + +instance ToJSON RemarketingListsListResponse where + toJSON RemarketingListsListResponse'{..} + = object + (catMaybes + [("nextPageToken" .=) <$> _rllrNextPageToken, + ("remarketingLists" .=) <$> _rllrRemarketingLists, + Just ("kind" .= _rllrKind)]) + +-- | Contains properties of a dynamic targeting key. Dynamic targeting keys +-- are unique, user-friendly labels, created at the advertiser level in +-- DCM, that can be assigned to ads, creatives, and placements and used for +-- targeting with Studio dynamic creatives. Use these labels instead of +-- numeric Campaign Manager IDs (such as placement IDs) to save time and +-- avoid errors in your dynamic feeds. +-- +-- /See:/ 'dynamicTargetingKey' smart constructor. +data DynamicTargetingKey = + DynamicTargetingKey' + { _dtkObjectType :: !(Maybe DynamicTargetingKeyObjectType) + , _dtkKind :: !Text + , _dtkObjectId :: !(Maybe (Textual Int64)) + , _dtkName :: !(Maybe Text) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'DynamicTargetingKey' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'dtkObjectType' +-- +-- * 'dtkKind' +-- +-- * 'dtkObjectId' +-- +-- * 'dtkName' +dynamicTargetingKey + :: DynamicTargetingKey +dynamicTargetingKey = + DynamicTargetingKey' + { _dtkObjectType = Nothing + , _dtkKind = "dfareporting#dynamicTargetingKey" + , _dtkObjectId = Nothing + , _dtkName = Nothing + } + + +-- | Type of the object of this dynamic targeting key. This is a required +-- field. +dtkObjectType :: Lens' DynamicTargetingKey (Maybe DynamicTargetingKeyObjectType) +dtkObjectType + = lens _dtkObjectType + (\ s a -> s{_dtkObjectType = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#dynamicTargetingKey\". +dtkKind :: Lens' DynamicTargetingKey Text +dtkKind = lens _dtkKind (\ s a -> s{_dtkKind = a}) + +-- | ID of the object of this dynamic targeting key. This is a required +-- field. +dtkObjectId :: Lens' DynamicTargetingKey (Maybe Int64) +dtkObjectId + = lens _dtkObjectId (\ s a -> s{_dtkObjectId = a}) . + mapping _Coerce + +-- | Name of this dynamic targeting key. This is a required field. Must be +-- less than 256 characters long and cannot contain commas. All characters +-- are converted to lowercase. +dtkName :: Lens' DynamicTargetingKey (Maybe Text) +dtkName = lens _dtkName (\ s a -> s{_dtkName = a}) + +instance FromJSON DynamicTargetingKey where + parseJSON + = withObject "DynamicTargetingKey" + (\ o -> + DynamicTargetingKey' <$> + (o .:? "objectType") <*> + (o .:? "kind" .!= "dfareporting#dynamicTargetingKey") + <*> (o .:? "objectId") + <*> (o .:? "name")) + +instance ToJSON DynamicTargetingKey where + toJSON DynamicTargetingKey'{..} + = object + (catMaybes + [("objectType" .=) <$> _dtkObjectType, + Just ("kind" .= _dtkKind), + ("objectId" .=) <$> _dtkObjectId, + ("name" .=) <$> _dtkName]) + +-- | Contains properties of a Creative. +-- +-- /See:/ 'creative' smart constructor. +data Creative = + Creative' + { _creConvertFlashToHTML5 :: !(Maybe Bool) + , _creBackupImageTargetWindow :: !(Maybe TargetWindow) + , _creRenderingIdDimensionValue :: !(Maybe DimensionValue) + , _creCustomKeyValues :: !(Maybe [Text]) + , _creSkipOffSet :: !(Maybe VideoOffSet) + , _creRenderingId :: !(Maybe (Textual Int64)) + , _creThirdPartyBackupImageImpressionsURL :: !(Maybe Text) + , _creFsCommand :: !(Maybe FsCommand) + , _creAllowScriptAccess :: !(Maybe Bool) + , _creHTMLCodeLocked :: !(Maybe Bool) + , _creRequiredFlashPluginVersion :: !(Maybe Text) + , _creUniversalAdId :: !(Maybe UniversalAdId) + , _creAuthoringTool :: !(Maybe CreativeAuthoringTool) + , _creSize :: !(Maybe Size) + , _creThirdPartyURLs :: !(Maybe [ThirdPartyTrackingURL]) + , _creProgressOffSet :: !(Maybe VideoOffSet) + , _creCounterCustomEvents :: !(Maybe [CreativeCustomEvent]) + , _creKind :: !Text + , _creSSLOverride :: !(Maybe Bool) + , _creHTMLCode :: !(Maybe Text) + , _creAdvertiserId :: !(Maybe (Textual Int64)) + , _creRequiredFlashVersion :: !(Maybe (Textual Int32)) + , _creBackgRoundColor :: !(Maybe Text) + , _creAdTagKeys :: !(Maybe [Text]) + , _creSkippable :: !(Maybe Bool) + , _creSSLCompliant :: !(Maybe Bool) + , _creIdDimensionValue :: !(Maybe DimensionValue) + , _creBackupImageReportingLabel :: !(Maybe Text) + , _creCommercialId :: !(Maybe Text) + , _creActive :: !(Maybe Bool) + , _creExitCustomEvents :: !(Maybe [CreativeCustomEvent]) + , _creAccountId :: !(Maybe (Textual Int64)) + , _creBackupImageClickThroughURL :: !(Maybe CreativeClickThroughURL) + , _creName :: !(Maybe Text) + , _creOverrideCss :: !(Maybe Text) + , _creAdditionalSizes :: !(Maybe [Size]) + , _creClickTags :: !(Maybe [ClickTag]) + , _creAdParameters :: !(Maybe Text) + , _creVersion :: !(Maybe (Textual Int32)) + , _creMediaDescription :: !(Maybe Text) + , _creMediaDuration :: !(Maybe (Textual Double)) + , _creLatestTraffickedCreativeId :: !(Maybe (Textual Int64)) + , _creThirdPartyRichMediaImpressionsURL :: !(Maybe Text) + , _creDynamicAssetSelection :: !(Maybe Bool) + , _creLastModifiedInfo :: !(Maybe LastModifiedInfo) + , _creId :: !(Maybe (Textual Int64)) + , _creAuthoringSource :: !(Maybe CreativeAuthoringSource) + , _creStudioAdvertiserId :: !(Maybe (Textual Int64)) + , _creCreativeAssets :: !(Maybe [CreativeAsset]) + , _creSubAccountId :: !(Maybe (Textual Int64)) + , _creType :: !(Maybe CreativeType) + , _creTimerCustomEvents :: !(Maybe [CreativeCustomEvent]) + , _creCreativeAssetSelection :: !(Maybe CreativeAssetSelection) + , _creStudioCreativeId :: !(Maybe (Textual Int64)) + , _creCompatibility :: !(Maybe [CreativeCompatibilityItem]) + , _creBackupImageFeatures :: !(Maybe [CreativeBackupImageFeaturesItem]) + , _creArtworkType :: !(Maybe CreativeArtworkType) + , _creArchived :: !(Maybe Bool) + , _creCompanionCreatives :: !(Maybe [Textual Int64]) + , _creTotalFileSize :: !(Maybe (Textual Int64)) + , _creStudioTraffickedCreativeId :: !(Maybe (Textual Int64)) + , _creAutoAdvanceImages :: !(Maybe Bool) + , _creRedirectURL :: !(Maybe Text) + , _creCreativeFieldAssignments :: !(Maybe [CreativeFieldAssignment]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'Creative' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'creConvertFlashToHTML5' +-- +-- * 'creBackupImageTargetWindow' +-- +-- * 'creRenderingIdDimensionValue' +-- +-- * 'creCustomKeyValues' +-- +-- * 'creSkipOffSet' +-- +-- * 'creRenderingId' +-- +-- * 'creThirdPartyBackupImageImpressionsURL' +-- +-- * 'creFsCommand' +-- +-- * 'creAllowScriptAccess' +-- +-- * 'creHTMLCodeLocked' +-- +-- * 'creRequiredFlashPluginVersion' +-- +-- * 'creUniversalAdId' +-- +-- * 'creAuthoringTool' +-- +-- * 'creSize' +-- +-- * 'creThirdPartyURLs' +-- +-- * 'creProgressOffSet' +-- +-- * 'creCounterCustomEvents' +-- +-- * 'creKind' +-- +-- * 'creSSLOverride' +-- +-- * 'creHTMLCode' +-- +-- * 'creAdvertiserId' +-- +-- * 'creRequiredFlashVersion' +-- +-- * 'creBackgRoundColor' +-- +-- * 'creAdTagKeys' +-- +-- * 'creSkippable' +-- +-- * 'creSSLCompliant' +-- +-- * 'creIdDimensionValue' +-- +-- * 'creBackupImageReportingLabel' +-- +-- * 'creCommercialId' +-- +-- * 'creActive' +-- +-- * 'creExitCustomEvents' +-- +-- * 'creAccountId' +-- +-- * 'creBackupImageClickThroughURL' +-- +-- * 'creName' +-- +-- * 'creOverrideCss' +-- +-- * 'creAdditionalSizes' +-- +-- * 'creClickTags' +-- +-- * 'creAdParameters' +-- +-- * 'creVersion' +-- +-- * 'creMediaDescription' +-- +-- * 'creMediaDuration' +-- +-- * 'creLatestTraffickedCreativeId' +-- +-- * 'creThirdPartyRichMediaImpressionsURL' +-- +-- * 'creDynamicAssetSelection' +-- +-- * 'creLastModifiedInfo' +-- +-- * 'creId' +-- +-- * 'creAuthoringSource' +-- +-- * 'creStudioAdvertiserId' +-- +-- * 'creCreativeAssets' +-- +-- * 'creSubAccountId' +-- +-- * 'creType' +-- +-- * 'creTimerCustomEvents' +-- +-- * 'creCreativeAssetSelection' +-- +-- * 'creStudioCreativeId' +-- +-- * 'creCompatibility' +-- +-- * 'creBackupImageFeatures' +-- +-- * 'creArtworkType' +-- +-- * 'creArchived' +-- +-- * 'creCompanionCreatives' +-- +-- * 'creTotalFileSize' +-- +-- * 'creStudioTraffickedCreativeId' +-- +-- * 'creAutoAdvanceImages' +-- +-- * 'creRedirectURL' +-- +-- * 'creCreativeFieldAssignments' +creative + :: Creative +creative = + Creative' + { _creConvertFlashToHTML5 = Nothing + , _creBackupImageTargetWindow = Nothing + , _creRenderingIdDimensionValue = Nothing + , _creCustomKeyValues = Nothing + , _creSkipOffSet = Nothing + , _creRenderingId = Nothing + , _creThirdPartyBackupImageImpressionsURL = Nothing + , _creFsCommand = Nothing + , _creAllowScriptAccess = Nothing + , _creHTMLCodeLocked = Nothing + , _creRequiredFlashPluginVersion = Nothing + , _creUniversalAdId = Nothing + , _creAuthoringTool = Nothing + , _creSize = Nothing + , _creThirdPartyURLs = Nothing + , _creProgressOffSet = Nothing + , _creCounterCustomEvents = Nothing + , _creKind = "dfareporting#creative" + , _creSSLOverride = Nothing + , _creHTMLCode = Nothing + , _creAdvertiserId = Nothing + , _creRequiredFlashVersion = Nothing + , _creBackgRoundColor = Nothing + , _creAdTagKeys = Nothing + , _creSkippable = Nothing + , _creSSLCompliant = Nothing + , _creIdDimensionValue = Nothing + , _creBackupImageReportingLabel = Nothing + , _creCommercialId = Nothing + , _creActive = Nothing + , _creExitCustomEvents = Nothing + , _creAccountId = Nothing + , _creBackupImageClickThroughURL = Nothing + , _creName = Nothing + , _creOverrideCss = Nothing + , _creAdditionalSizes = Nothing + , _creClickTags = Nothing + , _creAdParameters = Nothing + , _creVersion = Nothing + , _creMediaDescription = Nothing + , _creMediaDuration = Nothing + , _creLatestTraffickedCreativeId = Nothing + , _creThirdPartyRichMediaImpressionsURL = Nothing + , _creDynamicAssetSelection = Nothing + , _creLastModifiedInfo = Nothing + , _creId = Nothing + , _creAuthoringSource = Nothing + , _creStudioAdvertiserId = Nothing + , _creCreativeAssets = Nothing + , _creSubAccountId = Nothing + , _creType = Nothing + , _creTimerCustomEvents = Nothing + , _creCreativeAssetSelection = Nothing + , _creStudioCreativeId = Nothing + , _creCompatibility = Nothing + , _creBackupImageFeatures = Nothing + , _creArtworkType = Nothing + , _creArchived = Nothing + , _creCompanionCreatives = Nothing + , _creTotalFileSize = Nothing + , _creStudioTraffickedCreativeId = Nothing + , _creAutoAdvanceImages = Nothing + , _creRedirectURL = Nothing + , _creCreativeFieldAssignments = Nothing + } + + +-- | Whether Flash assets associated with the creative need to be +-- automatically converted to HTML5. This flag is enabled by default and +-- users can choose to disable it if they don\'t want the system to +-- generate and use HTML5 asset for this creative. Applicable to the +-- following creative type: FLASH_INPAGE. Applicable to DISPLAY when the +-- primary asset type is not HTML_IMAGE. +creConvertFlashToHTML5 :: Lens' Creative (Maybe Bool) +creConvertFlashToHTML5 + = lens _creConvertFlashToHTML5 + (\ s a -> s{_creConvertFlashToHTML5 = a}) + +-- | Target window for backup image. Applicable to the following creative +-- types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the +-- primary asset type is not HTML_IMAGE. +creBackupImageTargetWindow :: Lens' Creative (Maybe TargetWindow) +creBackupImageTargetWindow + = lens _creBackupImageTargetWindow + (\ s a -> s{_creBackupImageTargetWindow = a}) + +-- | Dimension value for the rendering ID of this creative. This is a +-- read-only field. Applicable to all creative types. +creRenderingIdDimensionValue :: Lens' Creative (Maybe DimensionValue) +creRenderingIdDimensionValue + = lens _creRenderingIdDimensionValue + (\ s a -> s{_creRenderingIdDimensionValue = a}) + +-- | Custom key-values for a Rich Media creative. Key-values let you +-- customize the creative settings of a Rich Media ad running on your site +-- without having to contact the advertiser. You can use key-values to +-- dynamically change the look or functionality of a creative. Applicable +-- to the following creative types: all RICH_MEDIA, and all VPAID. +creCustomKeyValues :: Lens' Creative [Text] +creCustomKeyValues + = lens _creCustomKeyValues + (\ s a -> s{_creCustomKeyValues = a}) + . _Default + . _Coerce + +-- | Amount of time to play the video before the skip button appears. +-- Applicable to the following creative types: all INSTREAM_VIDEO. +creSkipOffSet :: Lens' Creative (Maybe VideoOffSet) +creSkipOffSet + = lens _creSkipOffSet + (\ s a -> s{_creSkipOffSet = a}) + +-- | ID of current rendering version. This is a read-only field. Applicable +-- to all creative types. +creRenderingId :: Lens' Creative (Maybe Int64) +creRenderingId + = lens _creRenderingId + (\ s a -> s{_creRenderingId = a}) + . mapping _Coerce + +-- | Third-party URL used to record backup image impressions. Applicable to +-- the following creative types: all RICH_MEDIA. +creThirdPartyBackupImageImpressionsURL :: Lens' Creative (Maybe Text) +creThirdPartyBackupImageImpressionsURL + = lens _creThirdPartyBackupImageImpressionsURL + (\ s a -> + s{_creThirdPartyBackupImageImpressionsURL = a}) + +-- | OpenWindow FSCommand of this creative. This lets the SWF file +-- communicate with either Flash Player or the program hosting Flash +-- Player, such as a web browser. This is only triggered if +-- allowScriptAccess field is true. Applicable to the following creative +-- types: FLASH_INPAGE. +creFsCommand :: Lens' Creative (Maybe FsCommand) +creFsCommand + = lens _creFsCommand (\ s a -> s{_creFsCommand = a}) + +-- | Whether script access is allowed for this creative. This is a read-only +-- and deprecated field which will automatically be set to true on update. +-- Applicable to the following creative types: FLASH_INPAGE. +creAllowScriptAccess :: Lens' Creative (Maybe Bool) +creAllowScriptAccess + = lens _creAllowScriptAccess + (\ s a -> s{_creAllowScriptAccess = a}) + +-- | Whether HTML code is generated by Campaign Manager or manually entered. +-- Set to true to ignore changes to htmlCode. Applicable to the following +-- creative types: FLASH_INPAGE and HTML5_BANNER. +creHTMLCodeLocked :: Lens' Creative (Maybe Bool) +creHTMLCodeLocked + = lens _creHTMLCodeLocked + (\ s a -> s{_creHTMLCodeLocked = a}) + +-- | The minimum required Flash plugin version for this creative. For +-- example, 11.2.202.235. This is a read-only field. Applicable to the +-- following creative types: all RICH_MEDIA, and all VPAID. +creRequiredFlashPluginVersion :: Lens' Creative (Maybe Text) +creRequiredFlashPluginVersion + = lens _creRequiredFlashPluginVersion + (\ s a -> s{_creRequiredFlashPluginVersion = a}) + +-- | A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following +-- creative types: INSTREAM_AUDIO and INSTREAM_VIDEO and VPAID. +creUniversalAdId :: Lens' Creative (Maybe UniversalAdId) +creUniversalAdId + = lens _creUniversalAdId + (\ s a -> s{_creUniversalAdId = a}) + +-- | Authoring tool for HTML5 banner creatives. This is a read-only field. +-- Applicable to the following creative types: HTML5_BANNER. +creAuthoringTool :: Lens' Creative (Maybe CreativeAuthoringTool) +creAuthoringTool + = lens _creAuthoringTool + (\ s a -> s{_creAuthoringTool = a}) + +-- | Size associated with this creative. When inserting or updating a +-- creative either the size ID field or size width and height fields can be +-- used. This is a required field when applicable; however for IMAGE, +-- FLASH_INPAGE creatives, and for DISPLAY creatives with a primary asset +-- of type HTML_IMAGE, if left blank, this field will be automatically set +-- using the actual size of the associated image assets. Applicable to the +-- following creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, +-- HTML5_BANNER, IMAGE, and all RICH_MEDIA. +creSize :: Lens' Creative (Maybe Size) +creSize = lens _creSize (\ s a -> s{_creSize = a}) + +-- | Third-party URLs for tracking in-stream creative events. Applicable to +-- the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, +-- and all VPAID. +creThirdPartyURLs :: Lens' Creative [ThirdPartyTrackingURL] +creThirdPartyURLs + = lens _creThirdPartyURLs + (\ s a -> s{_creThirdPartyURLs = a}) + . _Default + . _Coerce + +-- | Amount of time to play the video before counting a view. Applicable to +-- the following creative types: all INSTREAM_VIDEO. +creProgressOffSet :: Lens' Creative (Maybe VideoOffSet) +creProgressOffSet + = lens _creProgressOffSet + (\ s a -> s{_creProgressOffSet = a}) + +-- | List of counter events configured for the creative. For +-- DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated +-- from clickTags. Applicable to the following creative types: +-- DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. +creCounterCustomEvents :: Lens' Creative [CreativeCustomEvent] +creCounterCustomEvents + = lens _creCounterCustomEvents + (\ s a -> s{_creCounterCustomEvents = a}) + . _Default + . _Coerce + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#creative\". +creKind :: Lens' Creative Text +creKind = lens _creKind (\ s a -> s{_creKind = a}) + +-- | Whether creative should be treated as SSL compliant even if the system +-- scan shows it\'s not. Applicable to all creative types. +creSSLOverride :: Lens' Creative (Maybe Bool) +creSSLOverride + = lens _creSSLOverride + (\ s a -> s{_creSSLOverride = a}) + +-- | HTML code for the creative. This is a required field when applicable. +-- This field is ignored if htmlCodeLocked is true. Applicable to the +-- following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, +-- and all RICH_MEDIA. +creHTMLCode :: Lens' Creative (Maybe Text) +creHTMLCode + = lens _creHTMLCode (\ s a -> s{_creHTMLCode = a}) + +-- | Advertiser ID of this creative. This is a required field. Applicable to +-- all creative types. +creAdvertiserId :: Lens' Creative (Maybe Int64) +creAdvertiserId + = lens _creAdvertiserId + (\ s a -> s{_creAdvertiserId = a}) + . mapping _Coerce + +-- | The internal Flash version for this creative as calculated by Studio. +-- This is a read-only field. Applicable to the following creative types: +-- FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when +-- the primary asset type is not HTML_IMAGE. +creRequiredFlashVersion :: Lens' Creative (Maybe Int32) +creRequiredFlashVersion + = lens _creRequiredFlashVersion + (\ s a -> s{_creRequiredFlashVersion = a}) + . mapping _Coerce + +-- | The 6-character HTML color code, beginning with #, for the background of +-- the window area where the Flash file is displayed. Default is white. +-- Applicable to the following creative types: FLASH_INPAGE. +creBackgRoundColor :: Lens' Creative (Maybe Text) +creBackgRoundColor + = lens _creBackgRoundColor + (\ s a -> s{_creBackgRoundColor = a}) + +-- | Keywords for a Rich Media creative. Keywords let you customize the +-- creative settings of a Rich Media ad running on your site without having +-- to contact the advertiser. You can use keywords to dynamically change +-- the look or functionality of a creative. Applicable to the following +-- creative types: all RICH_MEDIA, and all VPAID. +creAdTagKeys :: Lens' Creative [Text] +creAdTagKeys + = lens _creAdTagKeys (\ s a -> s{_creAdTagKeys = a}) + . _Default + . _Coerce + +-- | Whether the user can choose to skip the creative. Applicable to the +-- following creative types: all INSTREAM_VIDEO and all VPAID. +creSkippable :: Lens' Creative (Maybe Bool) +creSkippable + = lens _creSkippable (\ s a -> s{_creSkippable = a}) + +-- | Whether the creative is SSL-compliant. This is a read-only field. +-- Applicable to all creative types. +creSSLCompliant :: Lens' Creative (Maybe Bool) +creSSLCompliant + = lens _creSSLCompliant + (\ s a -> s{_creSSLCompliant = a}) + +-- | Dimension value for the ID of this creative. This is a read-only field. +-- Applicable to all creative types. +creIdDimensionValue :: Lens' Creative (Maybe DimensionValue) +creIdDimensionValue + = lens _creIdDimensionValue + (\ s a -> s{_creIdDimensionValue = a}) + +-- | Reporting label used for HTML5 banner backup image. Applicable to the +-- following creative types: DISPLAY when the primary asset type is not +-- HTML_IMAGE. +creBackupImageReportingLabel :: Lens' Creative (Maybe Text) +creBackupImageReportingLabel + = lens _creBackupImageReportingLabel + (\ s a -> s{_creBackupImageReportingLabel = a}) + +-- | Industry standard ID assigned to creative for reach and frequency. +-- Applicable to INSTREAM_VIDEO_REDIRECT creatives. +creCommercialId :: Lens' Creative (Maybe Text) +creCommercialId + = lens _creCommercialId + (\ s a -> s{_creCommercialId = a}) + +-- | Whether the creative is active. Applicable to all creative types. +creActive :: Lens' Creative (Maybe Bool) +creActive + = lens _creActive (\ s a -> s{_creActive = a}) + +-- | List of exit events configured for the creative. For DISPLAY and +-- DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated +-- from clickTags, For DISPLAY, an event is also created from the +-- backupImageReportingLabel. Applicable to the following creative types: +-- DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to +-- DISPLAY when the primary asset type is not HTML_IMAGE. +creExitCustomEvents :: Lens' Creative [CreativeCustomEvent] +creExitCustomEvents + = lens _creExitCustomEvents + (\ s a -> s{_creExitCustomEvents = a}) + . _Default + . _Coerce + +-- | Account ID of this creative. This field, if left unset, will be +-- auto-generated for both insert and update operations. Applicable to all +-- creative types. +creAccountId :: Lens' Creative (Maybe Int64) +creAccountId + = lens _creAccountId (\ s a -> s{_creAccountId = a}) + . mapping _Coerce + +-- | Click-through URL for backup image. Applicable to ENHANCED_BANNER when +-- the primary asset type is not HTML_IMAGE. +creBackupImageClickThroughURL :: Lens' Creative (Maybe CreativeClickThroughURL) +creBackupImageClickThroughURL + = lens _creBackupImageClickThroughURL + (\ s a -> s{_creBackupImageClickThroughURL = a}) + +-- | Name of the creative. This is a required field and must be less than 256 +-- characters long. Applicable to all creative types. +creName :: Lens' Creative (Maybe Text) +creName = lens _creName (\ s a -> s{_creName = a}) + +-- | Override CSS value for rich media creatives. Applicable to the following +-- creative types: all RICH_MEDIA. +creOverrideCss :: Lens' Creative (Maybe Text) +creOverrideCss + = lens _creOverrideCss + (\ s a -> s{_creOverrideCss = a}) + +-- | Additional sizes associated with a responsive creative. When inserting +-- or updating a creative either the size ID field or size width and height +-- fields can be used. Applicable to DISPLAY creatives when the primary +-- asset type is HTML_IMAGE. +creAdditionalSizes :: Lens' Creative [Size] +creAdditionalSizes + = lens _creAdditionalSizes + (\ s a -> s{_creAdditionalSizes = a}) + . _Default + . _Coerce + +-- | Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER +-- creatives, this is a subset of detected click tags for the assets +-- associated with this creative. After creating a flash asset, detected +-- click tags will be returned in the creativeAssetMetadata. When inserting +-- the creative, populate the creative clickTags field using the +-- creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY +-- creatives, there should be exactly one entry in this list for each image +-- creative asset. A click tag is matched with a corresponding creative +-- asset by matching the clickTag.name field with the +-- creativeAsset.assetIdentifier.name field. Applicable to the following +-- creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. +-- Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. +creClickTags :: Lens' Creative [ClickTag] +creClickTags + = lens _creClickTags (\ s a -> s{_creClickTags = a}) + . _Default + . _Coerce + +-- | Ad parameters user for VPAID creative. This is a read-only field. +-- Applicable to the following creative types: all VPAID. +creAdParameters :: Lens' Creative (Maybe Text) +creAdParameters + = lens _creAdParameters + (\ s a -> s{_creAdParameters = a}) + +-- | The version number helps you keep track of multiple versions of your +-- creative in your reports. The version number will always be +-- auto-generated during insert operations to start at 1. For tracking +-- creatives the version cannot be incremented and will always remain at 1. +-- For all other creative types the version can be incremented only by 1 +-- during update operations. In addition, the version will be automatically +-- incremented by 1 when undergoing Rich Media creative merging. Applicable +-- to all creative types. +creVersion :: Lens' Creative (Maybe Int32) +creVersion + = lens _creVersion (\ s a -> s{_creVersion = a}) . + mapping _Coerce + +-- | Description of the audio or video ad. Applicable to the following +-- creative types: all INSTREAM_VIDEO, INSTREAM_AUDIO, and all VPAID. +creMediaDescription :: Lens' Creative (Maybe Text) +creMediaDescription + = lens _creMediaDescription + (\ s a -> s{_creMediaDescription = a}) + +-- | Creative audio or video duration in seconds. This is a read-only field. +-- Applicable to the following creative types: INSTREAM_VIDEO, +-- INSTREAM_AUDIO, all RICH_MEDIA, and all VPAID. +creMediaDuration :: Lens' Creative (Maybe Double) +creMediaDuration + = lens _creMediaDuration + (\ s a -> s{_creMediaDuration = a}) + . mapping _Coerce + +-- | Latest Studio trafficked creative ID associated with rich media and +-- VPAID creatives. This is a read-only field. Applicable to the following +-- creative types: all RICH_MEDIA, and all VPAID. +creLatestTraffickedCreativeId :: Lens' Creative (Maybe Int64) +creLatestTraffickedCreativeId + = lens _creLatestTraffickedCreativeId + (\ s a -> s{_creLatestTraffickedCreativeId = a}) + . mapping _Coerce + +-- | Third-party URL used to record rich media impressions. Applicable to the +-- following creative types: all RICH_MEDIA. +creThirdPartyRichMediaImpressionsURL :: Lens' Creative (Maybe Text) +creThirdPartyRichMediaImpressionsURL + = lens _creThirdPartyRichMediaImpressionsURL + (\ s a -> + s{_creThirdPartyRichMediaImpressionsURL = a}) + +-- | Set this to true to enable the use of rules to target individual assets +-- in this creative. When set to true creativeAssetSelection must be set. +-- This also controls asset-level companions. When this is true, companion +-- creatives should be assigned to creative assets. Learn more. Applicable +-- to INSTREAM_VIDEO creatives. +creDynamicAssetSelection :: Lens' Creative (Maybe Bool) +creDynamicAssetSelection + = lens _creDynamicAssetSelection + (\ s a -> s{_creDynamicAssetSelection = a}) + +-- | Creative last modification information. This is a read-only field. +-- Applicable to all creative types. +creLastModifiedInfo :: Lens' Creative (Maybe LastModifiedInfo) +creLastModifiedInfo + = lens _creLastModifiedInfo + (\ s a -> s{_creLastModifiedInfo = a}) + +-- | ID of this creative. This is a read-only, auto-generated field. +-- Applicable to all creative types. +creId :: Lens' Creative (Maybe Int64) +creId + = lens _creId (\ s a -> s{_creId = a}) . + mapping _Coerce + +-- | Source application where creative was authored. Presently, only DBM +-- authored creatives will have this field set. Applicable to all creative +-- types. +creAuthoringSource :: Lens' Creative (Maybe CreativeAuthoringSource) +creAuthoringSource + = lens _creAuthoringSource + (\ s a -> s{_creAuthoringSource = a}) + +-- | Studio advertiser ID associated with rich media and VPAID creatives. +-- This is a read-only field. Applicable to the following creative types: +-- all RICH_MEDIA, and all VPAID. +creStudioAdvertiserId :: Lens' Creative (Maybe Int64) +creStudioAdvertiserId + = lens _creStudioAdvertiserId + (\ s a -> s{_creStudioAdvertiserId = a}) + . mapping _Coerce + +-- | Assets associated with a creative. Applicable to all but the following +-- creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and +-- REDIRECT +creCreativeAssets :: Lens' Creative [CreativeAsset] +creCreativeAssets + = lens _creCreativeAssets + (\ s a -> s{_creCreativeAssets = a}) + . _Default + . _Coerce + +-- | Subaccount ID of this creative. This field, if left unset, will be +-- auto-generated for both insert and update operations. Applicable to all +-- creative types. +creSubAccountId :: Lens' Creative (Maybe Int64) +creSubAccountId + = lens _creSubAccountId + (\ s a -> s{_creSubAccountId = a}) + . mapping _Coerce + +-- | Type of this creative. This is a required field. Applicable to all +-- creative types. Note: FLASH_INPAGE, HTML5_BANNER, and IMAGE are only +-- used for existing creatives. New creatives should use DISPLAY as a +-- replacement for these types. +creType :: Lens' Creative (Maybe CreativeType) +creType = lens _creType (\ s a -> s{_creType = a}) + +-- | List of timer events configured for the creative. For +-- DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated +-- from clickTags. Applicable to the following creative types: +-- DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to +-- DISPLAY when the primary asset is not HTML_IMAGE. +creTimerCustomEvents :: Lens' Creative [CreativeCustomEvent] +creTimerCustomEvents + = lens _creTimerCustomEvents + (\ s a -> s{_creTimerCustomEvents = a}) + . _Default + . _Coerce + +-- | Required if dynamicAssetSelection is true. +creCreativeAssetSelection :: Lens' Creative (Maybe CreativeAssetSelection) +creCreativeAssetSelection + = lens _creCreativeAssetSelection + (\ s a -> s{_creCreativeAssetSelection = a}) + +-- | Studio creative ID associated with rich media and VPAID creatives. This +-- is a read-only field. Applicable to the following creative types: all +-- RICH_MEDIA, and all VPAID. +creStudioCreativeId :: Lens' Creative (Maybe Int64) +creStudioCreativeId + = lens _creStudioCreativeId + (\ s a -> s{_creStudioCreativeId = a}) + . mapping _Coerce + +-- | Compatibilities associated with this creative. This is a read-only +-- field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on +-- desktop or on mobile devices or in mobile apps for regular or +-- interstitial ads, respectively. APP and APP_INTERSTITIAL are for +-- rendering in mobile apps. Only pre-existing creatives may have these +-- compatibilities since new creatives will either be assigned DISPLAY or +-- DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in +-- in-stream video ads developed with the VAST standard. IN_STREAM_AUDIO +-- refers to rendering in in-stream audio ads developed with the VAST +-- standard. Applicable to all creative types. Acceptable values are: - +-- \"APP\" - \"APP_INTERSTITIAL\" - \"IN_STREAM_VIDEO\" - +-- \"IN_STREAM_AUDIO\" - \"DISPLAY\" - \"DISPLAY_INTERSTITIAL\" +creCompatibility :: Lens' Creative [CreativeCompatibilityItem] +creCompatibility + = lens _creCompatibility + (\ s a -> s{_creCompatibility = a}) + . _Default + . _Coerce + +-- | List of feature dependencies that will cause a backup image to be served +-- if the browser that serves the ad does not support them. Feature +-- dependencies are features that a browser must be able to support in +-- order to render your HTML5 creative asset correctly. This field is +-- initially auto-generated to contain all features detected by Campaign +-- Manager for all the assets of this creative and can then be modified by +-- the client. To reset this field, copy over all the creativeAssets\' +-- detected features. Applicable to the following creative types: +-- HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not +-- HTML_IMAGE. +creBackupImageFeatures :: Lens' Creative [CreativeBackupImageFeaturesItem] +creBackupImageFeatures + = lens _creBackupImageFeatures + (\ s a -> s{_creBackupImageFeatures = a}) + . _Default + . _Coerce + +-- | Type of artwork used for the creative. This is a read-only field. +-- Applicable to the following creative types: all RICH_MEDIA, and all +-- VPAID. +creArtworkType :: Lens' Creative (Maybe CreativeArtworkType) +creArtworkType + = lens _creArtworkType + (\ s a -> s{_creArtworkType = a}) + +-- | Whether the creative is archived. Applicable to all creative types. +creArchived :: Lens' Creative (Maybe Bool) +creArchived + = lens _creArchived (\ s a -> s{_creArchived = a}) + +-- | List of companion creatives assigned to an in-Stream video creative. +-- Acceptable values include IDs of existing flash and image creatives. +-- Applicable to the following creative types: all VPAID, all +-- INSTREAM_AUDIO and all INSTREAM_VIDEO with dynamicAssetSelection set to +-- false. +creCompanionCreatives :: Lens' Creative [Int64] +creCompanionCreatives + = lens _creCompanionCreatives + (\ s a -> s{_creCompanionCreatives = a}) + . _Default + . _Coerce + +-- | Combined size of all creative assets. This is a read-only field. +-- Applicable to the following creative types: all RICH_MEDIA, and all +-- VPAID. +creTotalFileSize :: Lens' Creative (Maybe Int64) +creTotalFileSize + = lens _creTotalFileSize + (\ s a -> s{_creTotalFileSize = a}) + . mapping _Coerce + +-- | Studio trafficked creative ID associated with rich media and VPAID +-- creatives. This is a read-only field. Applicable to the following +-- creative types: all RICH_MEDIA, and all VPAID. +creStudioTraffickedCreativeId :: Lens' Creative (Maybe Int64) +creStudioTraffickedCreativeId + = lens _creStudioTraffickedCreativeId + (\ s a -> s{_creStudioTraffickedCreativeId = a}) + . mapping _Coerce + +-- | Whether images are automatically advanced for image gallery creatives. +-- Applicable to the following creative types: DISPLAY_IMAGE_GALLERY. +creAutoAdvanceImages :: Lens' Creative (Maybe Bool) +creAutoAdvanceImages + = lens _creAutoAdvanceImages + (\ s a -> s{_creAutoAdvanceImages = a}) + +-- | URL of hosted image or hosted video or another ad tag. For +-- INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect +-- URL. The standard for a VAST (Video Ad Serving Template) ad response +-- allows for a redirect link to another VAST 2.0 or 3.0 call. This is a +-- required field when applicable. Applicable to the following creative +-- types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, +-- INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT +creRedirectURL :: Lens' Creative (Maybe Text) +creRedirectURL + = lens _creRedirectURL + (\ s a -> s{_creRedirectURL = a}) + +-- | Creative field assignments for this creative. Applicable to all creative +-- types. +creCreativeFieldAssignments :: Lens' Creative [CreativeFieldAssignment] +creCreativeFieldAssignments + = lens _creCreativeFieldAssignments + (\ s a -> s{_creCreativeFieldAssignments = a}) + . _Default + . _Coerce + +instance FromJSON Creative where + parseJSON + = withObject "Creative" + (\ o -> + Creative' <$> + (o .:? "convertFlashToHtml5") <*> + (o .:? "backupImageTargetWindow") + <*> (o .:? "renderingIdDimensionValue") + <*> (o .:? "customKeyValues" .!= mempty) + <*> (o .:? "skipOffset") + <*> (o .:? "renderingId") + <*> (o .:? "thirdPartyBackupImageImpressionsUrl") + <*> (o .:? "fsCommand") + <*> (o .:? "allowScriptAccess") + <*> (o .:? "htmlCodeLocked") + <*> (o .:? "requiredFlashPluginVersion") + <*> (o .:? "universalAdId") + <*> (o .:? "authoringTool") + <*> (o .:? "size") + <*> (o .:? "thirdPartyUrls" .!= mempty) + <*> (o .:? "progressOffset") + <*> (o .:? "counterCustomEvents" .!= mempty) + <*> (o .:? "kind" .!= "dfareporting#creative") + <*> (o .:? "sslOverride") + <*> (o .:? "htmlCode") + <*> (o .:? "advertiserId") + <*> (o .:? "requiredFlashVersion") + <*> (o .:? "backgroundColor") + <*> (o .:? "adTagKeys" .!= mempty) + <*> (o .:? "skippable") + <*> (o .:? "sslCompliant") + <*> (o .:? "idDimensionValue") + <*> (o .:? "backupImageReportingLabel") + <*> (o .:? "commercialId") + <*> (o .:? "active") + <*> (o .:? "exitCustomEvents" .!= mempty) + <*> (o .:? "accountId") + <*> (o .:? "backupImageClickThroughUrl") + <*> (o .:? "name") + <*> (o .:? "overrideCss") + <*> (o .:? "additionalSizes" .!= mempty) + <*> (o .:? "clickTags" .!= mempty) + <*> (o .:? "adParameters") + <*> (o .:? "version") + <*> (o .:? "mediaDescription") + <*> (o .:? "mediaDuration") + <*> (o .:? "latestTraffickedCreativeId") + <*> (o .:? "thirdPartyRichMediaImpressionsUrl") + <*> (o .:? "dynamicAssetSelection") + <*> (o .:? "lastModifiedInfo") + <*> (o .:? "id") + <*> (o .:? "authoringSource") + <*> (o .:? "studioAdvertiserId") + <*> (o .:? "creativeAssets" .!= mempty) + <*> (o .:? "subaccountId") + <*> (o .:? "type") + <*> (o .:? "timerCustomEvents" .!= mempty) + <*> (o .:? "creativeAssetSelection") + <*> (o .:? "studioCreativeId") + <*> (o .:? "compatibility" .!= mempty) + <*> (o .:? "backupImageFeatures" .!= mempty) + <*> (o .:? "artworkType") + <*> (o .:? "archived") + <*> (o .:? "companionCreatives" .!= mempty) + <*> (o .:? "totalFileSize") + <*> (o .:? "studioTraffickedCreativeId") + <*> (o .:? "autoAdvanceImages") + <*> (o .:? "redirectUrl") + <*> (o .:? "creativeFieldAssignments" .!= mempty)) + +instance ToJSON Creative where + toJSON Creative'{..} + = object + (catMaybes + [("convertFlashToHtml5" .=) <$> + _creConvertFlashToHTML5, + ("backupImageTargetWindow" .=) <$> + _creBackupImageTargetWindow, + ("renderingIdDimensionValue" .=) <$> + _creRenderingIdDimensionValue, + ("customKeyValues" .=) <$> _creCustomKeyValues, + ("skipOffset" .=) <$> _creSkipOffSet, + ("renderingId" .=) <$> _creRenderingId, + ("thirdPartyBackupImageImpressionsUrl" .=) <$> + _creThirdPartyBackupImageImpressionsURL, + ("fsCommand" .=) <$> _creFsCommand, + ("allowScriptAccess" .=) <$> _creAllowScriptAccess, + ("htmlCodeLocked" .=) <$> _creHTMLCodeLocked, + ("requiredFlashPluginVersion" .=) <$> + _creRequiredFlashPluginVersion, + ("universalAdId" .=) <$> _creUniversalAdId, + ("authoringTool" .=) <$> _creAuthoringTool, + ("size" .=) <$> _creSize, + ("thirdPartyUrls" .=) <$> _creThirdPartyURLs, + ("progressOffset" .=) <$> _creProgressOffSet, + ("counterCustomEvents" .=) <$> + _creCounterCustomEvents, + Just ("kind" .= _creKind), + ("sslOverride" .=) <$> _creSSLOverride, + ("htmlCode" .=) <$> _creHTMLCode, + ("advertiserId" .=) <$> _creAdvertiserId, + ("requiredFlashVersion" .=) <$> + _creRequiredFlashVersion, + ("backgroundColor" .=) <$> _creBackgRoundColor, + ("adTagKeys" .=) <$> _creAdTagKeys, + ("skippable" .=) <$> _creSkippable, + ("sslCompliant" .=) <$> _creSSLCompliant, + ("idDimensionValue" .=) <$> _creIdDimensionValue, + ("backupImageReportingLabel" .=) <$> + _creBackupImageReportingLabel, + ("commercialId" .=) <$> _creCommercialId, + ("active" .=) <$> _creActive, + ("exitCustomEvents" .=) <$> _creExitCustomEvents, + ("accountId" .=) <$> _creAccountId, + ("backupImageClickThroughUrl" .=) <$> + _creBackupImageClickThroughURL, + ("name" .=) <$> _creName, + ("overrideCss" .=) <$> _creOverrideCss, + ("additionalSizes" .=) <$> _creAdditionalSizes, + ("clickTags" .=) <$> _creClickTags, + ("adParameters" .=) <$> _creAdParameters, + ("version" .=) <$> _creVersion, + ("mediaDescription" .=) <$> _creMediaDescription, + ("mediaDuration" .=) <$> _creMediaDuration, + ("latestTraffickedCreativeId" .=) <$> + _creLatestTraffickedCreativeId, + ("thirdPartyRichMediaImpressionsUrl" .=) <$> + _creThirdPartyRichMediaImpressionsURL, + ("dynamicAssetSelection" .=) <$> + _creDynamicAssetSelection, + ("lastModifiedInfo" .=) <$> _creLastModifiedInfo, + ("id" .=) <$> _creId, + ("authoringSource" .=) <$> _creAuthoringSource, + ("studioAdvertiserId" .=) <$> _creStudioAdvertiserId, + ("creativeAssets" .=) <$> _creCreativeAssets, + ("subaccountId" .=) <$> _creSubAccountId, + ("type" .=) <$> _creType, + ("timerCustomEvents" .=) <$> _creTimerCustomEvents, + ("creativeAssetSelection" .=) <$> + _creCreativeAssetSelection, + ("studioCreativeId" .=) <$> _creStudioCreativeId, + ("compatibility" .=) <$> _creCompatibility, + ("backupImageFeatures" .=) <$> + _creBackupImageFeatures, + ("artworkType" .=) <$> _creArtworkType, + ("archived" .=) <$> _creArchived, + ("companionCreatives" .=) <$> _creCompanionCreatives, + ("totalFileSize" .=) <$> _creTotalFileSize, + ("studioTraffickedCreativeId" .=) <$> + _creStudioTraffickedCreativeId, + ("autoAdvanceImages" .=) <$> _creAutoAdvanceImages, + ("redirectUrl" .=) <$> _creRedirectURL, + ("creativeFieldAssignments" .=) <$> + _creCreativeFieldAssignments]) + +-- | Companion Settings +-- +-- /See:/ 'siteCompanionSetting' smart constructor. +data SiteCompanionSetting = + SiteCompanionSetting' + { _scsKind :: !Text + , _scsImageOnly :: !(Maybe Bool) + , _scsCompanionsDisabled :: !(Maybe Bool) + , _scsEnabledSizes :: !(Maybe [Size]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'SiteCompanionSetting' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'scsKind' +-- +-- * 'scsImageOnly' +-- +-- * 'scsCompanionsDisabled' +-- +-- * 'scsEnabledSizes' +siteCompanionSetting + :: SiteCompanionSetting +siteCompanionSetting = + SiteCompanionSetting' + { _scsKind = "dfareporting#siteCompanionSetting" + , _scsImageOnly = Nothing + , _scsCompanionsDisabled = Nothing + , _scsEnabledSizes = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#siteCompanionSetting\". +scsKind :: Lens' SiteCompanionSetting Text +scsKind = lens _scsKind (\ s a -> s{_scsKind = a}) + +-- | Whether to serve only static images as companions. +scsImageOnly :: Lens' SiteCompanionSetting (Maybe Bool) +scsImageOnly + = lens _scsImageOnly (\ s a -> s{_scsImageOnly = a}) + +-- | Whether companions are disabled for this site template. +scsCompanionsDisabled :: Lens' SiteCompanionSetting (Maybe Bool) +scsCompanionsDisabled + = lens _scsCompanionsDisabled + (\ s a -> s{_scsCompanionsDisabled = a}) + +-- | Whitelist of companion sizes to be served via this site template. Set +-- this list to null or empty to serve all companion sizes. +scsEnabledSizes :: Lens' SiteCompanionSetting [Size] +scsEnabledSizes + = lens _scsEnabledSizes + (\ s a -> s{_scsEnabledSizes = a}) + . _Default + . _Coerce + +instance FromJSON SiteCompanionSetting where + parseJSON + = withObject "SiteCompanionSetting" + (\ o -> + SiteCompanionSetting' <$> + (o .:? "kind" .!= + "dfareporting#siteCompanionSetting") + <*> (o .:? "imageOnly") + <*> (o .:? "companionsDisabled") + <*> (o .:? "enabledSizes" .!= mempty)) + +instance ToJSON SiteCompanionSetting where + toJSON SiteCompanionSetting'{..} + = object + (catMaybes + [Just ("kind" .= _scsKind), + ("imageOnly" .=) <$> _scsImageOnly, + ("companionsDisabled" .=) <$> _scsCompanionsDisabled, + ("enabledSizes" .=) <$> _scsEnabledSizes]) + +-- | Site Contact +-- +-- /See:/ 'siteContact' smart constructor. +data SiteContact = + SiteContact' + { _scEmail :: !(Maybe Text) + , _scPhone :: !(Maybe Text) + , _scLastName :: !(Maybe Text) + , _scAddress :: !(Maybe Text) + , _scFirstName :: !(Maybe Text) + , _scId :: !(Maybe (Textual Int64)) + , _scTitle :: !(Maybe Text) + , _scContactType :: !(Maybe SiteContactContactType) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'SiteContact' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'scEmail' +-- +-- * 'scPhone' +-- +-- * 'scLastName' +-- +-- * 'scAddress' +-- +-- * 'scFirstName' +-- +-- * 'scId' +-- +-- * 'scTitle' +-- +-- * 'scContactType' +siteContact + :: SiteContact +siteContact = + SiteContact' + { _scEmail = Nothing + , _scPhone = Nothing + , _scLastName = Nothing + , _scAddress = Nothing + , _scFirstName = Nothing + , _scId = Nothing + , _scTitle = Nothing + , _scContactType = Nothing + } + + +-- | Email address of this site contact. This is a required field. +scEmail :: Lens' SiteContact (Maybe Text) +scEmail = lens _scEmail (\ s a -> s{_scEmail = a}) + +-- | Primary phone number of this site contact. +scPhone :: Lens' SiteContact (Maybe Text) +scPhone = lens _scPhone (\ s a -> s{_scPhone = a}) + +-- | Last name of this site contact. +scLastName :: Lens' SiteContact (Maybe Text) +scLastName + = lens _scLastName (\ s a -> s{_scLastName = a}) + +-- | Address of this site contact. +scAddress :: Lens' SiteContact (Maybe Text) +scAddress + = lens _scAddress (\ s a -> s{_scAddress = a}) + +-- | First name of this site contact. +scFirstName :: Lens' SiteContact (Maybe Text) +scFirstName + = lens _scFirstName (\ s a -> s{_scFirstName = a}) + +-- | ID of this site contact. This is a read-only, auto-generated field. +scId :: Lens' SiteContact (Maybe Int64) +scId + = lens _scId (\ s a -> s{_scId = a}) . + mapping _Coerce + +-- | Title or designation of this site contact. +scTitle :: Lens' SiteContact (Maybe Text) +scTitle = lens _scTitle (\ s a -> s{_scTitle = a}) + +-- | Site contact type. +scContactType :: Lens' SiteContact (Maybe SiteContactContactType) +scContactType + = lens _scContactType + (\ s a -> s{_scContactType = a}) + +instance FromJSON SiteContact where + parseJSON + = withObject "SiteContact" + (\ o -> + SiteContact' <$> + (o .:? "email") <*> (o .:? "phone") <*> + (o .:? "lastName") + <*> (o .:? "address") + <*> (o .:? "firstName") + <*> (o .:? "id") + <*> (o .:? "title") + <*> (o .:? "contactType")) + +instance ToJSON SiteContact where + toJSON SiteContact'{..} + = object + (catMaybes + [("email" .=) <$> _scEmail, + ("phone" .=) <$> _scPhone, + ("lastName" .=) <$> _scLastName, + ("address" .=) <$> _scAddress, + ("firstName" .=) <$> _scFirstName, + ("id" .=) <$> _scId, ("title" .=) <$> _scTitle, + ("contactType" .=) <$> _scContactType]) + +-- | Account List Response +-- +-- /See:/ 'accountsListResponse' smart constructor. +data AccountsListResponse = + AccountsListResponse' + { _accNextPageToken :: !(Maybe Text) + , _accAccounts :: !(Maybe [Account]) + , _accKind :: !Text + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'AccountsListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'accNextPageToken' +-- +-- * 'accAccounts' +-- +-- * 'accKind' +accountsListResponse + :: AccountsListResponse +accountsListResponse = + AccountsListResponse' + { _accNextPageToken = Nothing + , _accAccounts = Nothing + , _accKind = "dfareporting#accountsListResponse" + } + + +-- | Pagination token to be used for the next list operation. +accNextPageToken :: Lens' AccountsListResponse (Maybe Text) +accNextPageToken + = lens _accNextPageToken + (\ s a -> s{_accNextPageToken = a}) + +-- | Account collection. +accAccounts :: Lens' AccountsListResponse [Account] +accAccounts + = lens _accAccounts (\ s a -> s{_accAccounts = a}) . + _Default + . _Coerce + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#accountsListResponse\". +accKind :: Lens' AccountsListResponse Text +accKind = lens _accKind (\ s a -> s{_accKind = a}) + +instance FromJSON AccountsListResponse where + parseJSON + = withObject "AccountsListResponse" + (\ o -> + AccountsListResponse' <$> + (o .:? "nextPageToken") <*> + (o .:? "accounts" .!= mempty) + <*> + (o .:? "kind" .!= + "dfareporting#accountsListResponse")) + +instance ToJSON AccountsListResponse where + toJSON AccountsListResponse'{..} + = object + (catMaybes + [("nextPageToken" .=) <$> _accNextPageToken, + ("accounts" .=) <$> _accAccounts, + Just ("kind" .= _accKind)]) + +-- | Represents a date range. +-- +-- /See:/ 'dateRange' smart constructor. +data DateRange = + DateRange' + { _drKind :: !Text + , _drEndDate :: !(Maybe Date') + , _drStartDate :: !(Maybe Date') + , _drRelativeDateRange :: !(Maybe DateRangeRelativeDateRange) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'DateRange' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'drKind' +-- +-- * 'drEndDate' +-- +-- * 'drStartDate' +-- +-- * 'drRelativeDateRange' +dateRange + :: DateRange +dateRange = + DateRange' + { _drKind = "dfareporting#dateRange" + , _drEndDate = Nothing + , _drStartDate = Nothing + , _drRelativeDateRange = Nothing + } + + +-- | The kind of resource this is, in this case dfareporting#dateRange. +drKind :: Lens' DateRange Text +drKind = lens _drKind (\ s a -> s{_drKind = a}) + +-- | The end date of the date range, inclusive. A string of the format: +-- \"yyyy-MM-dd\". +drEndDate :: Lens' DateRange (Maybe Day) +drEndDate + = lens _drEndDate (\ s a -> s{_drEndDate = a}) . + mapping _Date + +-- | The start date of the date range, inclusive. A string of the format: +-- \"yyyy-MM-dd\". +drStartDate :: Lens' DateRange (Maybe Day) +drStartDate + = lens _drStartDate (\ s a -> s{_drStartDate = a}) . + mapping _Date + +-- | The date range relative to the date of when the report is run. +drRelativeDateRange :: Lens' DateRange (Maybe DateRangeRelativeDateRange) +drRelativeDateRange + = lens _drRelativeDateRange + (\ s a -> s{_drRelativeDateRange = a}) + +instance FromJSON DateRange where + parseJSON + = withObject "DateRange" + (\ o -> + DateRange' <$> + (o .:? "kind" .!= "dfareporting#dateRange") <*> + (o .:? "endDate") + <*> (o .:? "startDate") + <*> (o .:? "relativeDateRange")) + +instance ToJSON DateRange where + toJSON DateRange'{..} + = object + (catMaybes + [Just ("kind" .= _drKind), + ("endDate" .=) <$> _drEndDate, + ("startDate" .=) <$> _drStartDate, + ("relativeDateRange" .=) <$> _drRelativeDateRange]) + +-- | Represents a Report resource. +-- +-- /See:/ 'report' smart constructor. +data Report = + Report' + { _rDelivery :: !(Maybe ReportDelivery) + , _rEtag :: !(Maybe Text) + , _rOwnerProFileId :: !(Maybe (Textual Int64)) + , _rSchedule :: !(Maybe ReportSchedule) + , _rPathToConversionCriteria :: !(Maybe ReportPathToConversionCriteria) + , _rKind :: !Text + , _rFormat :: !(Maybe ReportFormat) + , _rReachCriteria :: !(Maybe ReportReachCriteria) + , _rLastModifiedTime :: !(Maybe (Textual Word64)) + , _rAccountId :: !(Maybe (Textual Int64)) + , _rName :: !(Maybe Text) + , _rId :: !(Maybe (Textual Int64)) + , _rCrossDimensionReachCriteria :: !(Maybe ReportCrossDimensionReachCriteria) + , _rType :: !(Maybe ReportType) + , _rSubAccountId :: !(Maybe (Textual Int64)) + , _rFloodlightCriteria :: !(Maybe ReportFloodlightCriteria) + , _rCriteria :: !(Maybe ReportCriteria) + , _rFileName :: !(Maybe Text) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'Report' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'rDelivery' +-- +-- * 'rEtag' +-- +-- * 'rOwnerProFileId' +-- +-- * 'rSchedule' +-- +-- * 'rPathToConversionCriteria' +-- +-- * 'rKind' +-- +-- * 'rFormat' +-- +-- * 'rReachCriteria' +-- +-- * 'rLastModifiedTime' +-- +-- * 'rAccountId' +-- +-- * 'rName' +-- +-- * 'rId' +-- +-- * 'rCrossDimensionReachCriteria' +-- +-- * 'rType' +-- +-- * 'rSubAccountId' +-- +-- * 'rFloodlightCriteria' +-- +-- * 'rCriteria' +-- +-- * 'rFileName' +report + :: Report +report = + Report' + { _rDelivery = Nothing + , _rEtag = Nothing + , _rOwnerProFileId = Nothing + , _rSchedule = Nothing + , _rPathToConversionCriteria = Nothing + , _rKind = "dfareporting#report" + , _rFormat = Nothing + , _rReachCriteria = Nothing + , _rLastModifiedTime = Nothing + , _rAccountId = Nothing + , _rName = Nothing + , _rId = Nothing + , _rCrossDimensionReachCriteria = Nothing + , _rType = Nothing + , _rSubAccountId = Nothing + , _rFloodlightCriteria = Nothing + , _rCriteria = Nothing + , _rFileName = Nothing + } + + +-- | The report\'s email delivery settings. +rDelivery :: Lens' Report (Maybe ReportDelivery) +rDelivery + = lens _rDelivery (\ s a -> s{_rDelivery = a}) + +-- | The eTag of this response for caching purposes. +rEtag :: Lens' Report (Maybe Text) +rEtag = lens _rEtag (\ s a -> s{_rEtag = a}) + +-- | The user profile id of the owner of this report. +rOwnerProFileId :: Lens' Report (Maybe Int64) +rOwnerProFileId + = lens _rOwnerProFileId + (\ s a -> s{_rOwnerProFileId = a}) + . mapping _Coerce + +-- | The report\'s schedule. Can only be set if the report\'s \'dateRange\' +-- is a relative date range and the relative date range is not \"TODAY\". +rSchedule :: Lens' Report (Maybe ReportSchedule) +rSchedule + = lens _rSchedule (\ s a -> s{_rSchedule = a}) + +-- | The report criteria for a report of type \"PATH_TO_CONVERSION\". +rPathToConversionCriteria :: Lens' Report (Maybe ReportPathToConversionCriteria) +rPathToConversionCriteria + = lens _rPathToConversionCriteria + (\ s a -> s{_rPathToConversionCriteria = a}) + +-- | The kind of resource this is, in this case dfareporting#report. +rKind :: Lens' Report Text +rKind = lens _rKind (\ s a -> s{_rKind = a}) + +-- | The output format of the report. If not specified, default format is +-- \"CSV\". Note that the actual format in the completed report file might +-- differ if for instance the report\'s size exceeds the format\'s +-- capabilities. \"CSV\" will then be the fallback format. +rFormat :: Lens' Report (Maybe ReportFormat) +rFormat = lens _rFormat (\ s a -> s{_rFormat = a}) + +-- | The report criteria for a report of type \"REACH\". +rReachCriteria :: Lens' Report (Maybe ReportReachCriteria) +rReachCriteria + = lens _rReachCriteria + (\ s a -> s{_rReachCriteria = a}) + +-- | The timestamp (in milliseconds since epoch) of when this report was last +-- modified. +rLastModifiedTime :: Lens' Report (Maybe Word64) +rLastModifiedTime + = lens _rLastModifiedTime + (\ s a -> s{_rLastModifiedTime = a}) + . mapping _Coerce + +-- | The account ID to which this report belongs. +rAccountId :: Lens' Report (Maybe Int64) +rAccountId + = lens _rAccountId (\ s a -> s{_rAccountId = a}) . + mapping _Coerce + +-- | The name of the report. +rName :: Lens' Report (Maybe Text) +rName = lens _rName (\ s a -> s{_rName = a}) + +-- | The unique ID identifying this report resource. +rId :: Lens' Report (Maybe Int64) +rId + = lens _rId (\ s a -> s{_rId = a}) . mapping _Coerce + +-- | The report criteria for a report of type \"CROSS_DIMENSION_REACH\". +rCrossDimensionReachCriteria :: Lens' Report (Maybe ReportCrossDimensionReachCriteria) +rCrossDimensionReachCriteria + = lens _rCrossDimensionReachCriteria + (\ s a -> s{_rCrossDimensionReachCriteria = a}) + +-- | The type of the report. +rType :: Lens' Report (Maybe ReportType) +rType = lens _rType (\ s a -> s{_rType = a}) + +-- | The subaccount ID to which this report belongs if applicable. +rSubAccountId :: Lens' Report (Maybe Int64) +rSubAccountId + = lens _rSubAccountId + (\ s a -> s{_rSubAccountId = a}) + . mapping _Coerce + +-- | The report criteria for a report of type \"FLOODLIGHT\". +rFloodlightCriteria :: Lens' Report (Maybe ReportFloodlightCriteria) +rFloodlightCriteria + = lens _rFloodlightCriteria + (\ s a -> s{_rFloodlightCriteria = a}) + +-- | The report criteria for a report of type \"STANDARD\". +rCriteria :: Lens' Report (Maybe ReportCriteria) +rCriteria + = lens _rCriteria (\ s a -> s{_rCriteria = a}) + +-- | The filename used when generating report files for this report. +rFileName :: Lens' Report (Maybe Text) +rFileName + = lens _rFileName (\ s a -> s{_rFileName = a}) + +instance FromJSON Report where + parseJSON + = withObject "Report" + (\ o -> + Report' <$> + (o .:? "delivery") <*> (o .:? "etag") <*> + (o .:? "ownerProfileId") + <*> (o .:? "schedule") + <*> (o .:? "pathToConversionCriteria") + <*> (o .:? "kind" .!= "dfareporting#report") + <*> (o .:? "format") + <*> (o .:? "reachCriteria") + <*> (o .:? "lastModifiedTime") + <*> (o .:? "accountId") + <*> (o .:? "name") + <*> (o .:? "id") + <*> (o .:? "crossDimensionReachCriteria") + <*> (o .:? "type") + <*> (o .:? "subAccountId") + <*> (o .:? "floodlightCriteria") + <*> (o .:? "criteria") + <*> (o .:? "fileName")) + +instance ToJSON Report where + toJSON Report'{..} + = object + (catMaybes + [("delivery" .=) <$> _rDelivery, + ("etag" .=) <$> _rEtag, + ("ownerProfileId" .=) <$> _rOwnerProFileId, + ("schedule" .=) <$> _rSchedule, + ("pathToConversionCriteria" .=) <$> + _rPathToConversionCriteria, + Just ("kind" .= _rKind), ("format" .=) <$> _rFormat, + ("reachCriteria" .=) <$> _rReachCriteria, + ("lastModifiedTime" .=) <$> _rLastModifiedTime, + ("accountId" .=) <$> _rAccountId, + ("name" .=) <$> _rName, ("id" .=) <$> _rId, + ("crossDimensionReachCriteria" .=) <$> + _rCrossDimensionReachCriteria, + ("type" .=) <$> _rType, + ("subAccountId" .=) <$> _rSubAccountId, + ("floodlightCriteria" .=) <$> _rFloodlightCriteria, + ("criteria" .=) <$> _rCriteria, + ("fileName" .=) <$> _rFileName]) + +-- | Skippable Settings +-- +-- /See:/ 'siteSkippableSetting' smart constructor. +data SiteSkippableSetting = + SiteSkippableSetting' + { _sssSkipOffSet :: !(Maybe VideoOffSet) + , _sssProgressOffSet :: !(Maybe VideoOffSet) + , _sssKind :: !Text + , _sssSkippable :: !(Maybe Bool) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'SiteSkippableSetting' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'sssSkipOffSet' +-- +-- * 'sssProgressOffSet' +-- +-- * 'sssKind' +-- +-- * 'sssSkippable' +siteSkippableSetting + :: SiteSkippableSetting +siteSkippableSetting = + SiteSkippableSetting' + { _sssSkipOffSet = Nothing + , _sssProgressOffSet = Nothing + , _sssKind = "dfareporting#siteSkippableSetting" + , _sssSkippable = Nothing + } + + +-- | Amount of time to play videos served to this site before the skip button +-- should appear. Applicable when skippable is true. +sssSkipOffSet :: Lens' SiteSkippableSetting (Maybe VideoOffSet) +sssSkipOffSet + = lens _sssSkipOffSet + (\ s a -> s{_sssSkipOffSet = a}) + +-- | Amount of time to play videos served to this site template before +-- counting a view. Applicable when skippable is true. +sssProgressOffSet :: Lens' SiteSkippableSetting (Maybe VideoOffSet) +sssProgressOffSet + = lens _sssProgressOffSet + (\ s a -> s{_sssProgressOffSet = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#siteSkippableSetting\". +sssKind :: Lens' SiteSkippableSetting Text +sssKind = lens _sssKind (\ s a -> s{_sssKind = a}) + +-- | Whether the user can skip creatives served to this site. This will act +-- as default for new placements created under this site. +sssSkippable :: Lens' SiteSkippableSetting (Maybe Bool) +sssSkippable + = lens _sssSkippable (\ s a -> s{_sssSkippable = a}) + +instance FromJSON SiteSkippableSetting where + parseJSON + = withObject "SiteSkippableSetting" + (\ o -> + SiteSkippableSetting' <$> + (o .:? "skipOffset") <*> (o .:? "progressOffset") <*> + (o .:? "kind" .!= + "dfareporting#siteSkippableSetting") + <*> (o .:? "skippable")) + +instance ToJSON SiteSkippableSetting where + toJSON SiteSkippableSetting'{..} + = object + (catMaybes + [("skipOffset" .=) <$> _sssSkipOffSet, + ("progressOffset" .=) <$> _sssProgressOffSet, + Just ("kind" .= _sssKind), + ("skippable" .=) <$> _sssSkippable]) + +-- | A rule associates an asset with a targeting template for asset-level +-- targeting. Applicable to INSTREAM_VIDEO creatives. +-- +-- /See:/ 'rule' smart constructor. +data Rule = + Rule' + { _rulTargetingTemplateId :: !(Maybe (Textual Int64)) + , _rulName :: !(Maybe Text) + , _rulAssetId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'Rule' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'rulTargetingTemplateId' +-- +-- * 'rulName' +-- +-- * 'rulAssetId' +rule + :: Rule +rule = + Rule' + { _rulTargetingTemplateId = Nothing + , _rulName = Nothing + , _rulAssetId = Nothing + } + + +-- | A targeting template ID. The targeting from the targeting template will +-- be used to determine whether this asset should be served. This is a +-- required field. +rulTargetingTemplateId :: Lens' Rule (Maybe Int64) +rulTargetingTemplateId + = lens _rulTargetingTemplateId + (\ s a -> s{_rulTargetingTemplateId = a}) + . mapping _Coerce + +-- | A user-friendly name for this rule. This is a required field. +rulName :: Lens' Rule (Maybe Text) +rulName = lens _rulName (\ s a -> s{_rulName = a}) + +-- | A creativeAssets[].id. This should refer to one of the parent assets in +-- this creative. This is a required field. +rulAssetId :: Lens' Rule (Maybe Int64) +rulAssetId + = lens _rulAssetId (\ s a -> s{_rulAssetId = a}) . + mapping _Coerce + +instance FromJSON Rule where + parseJSON + = withObject "Rule" + (\ o -> + Rule' <$> + (o .:? "targetingTemplateId") <*> (o .:? "name") <*> + (o .:? "assetId")) + +instance ToJSON Rule where + toJSON Rule'{..} + = object + (catMaybes + [("targetingTemplateId" .=) <$> + _rulTargetingTemplateId, + ("name" .=) <$> _rulName, + ("assetId" .=) <$> _rulAssetId]) + +-- | Contains properties of a Campaign Manager campaign. +-- +-- /See:/ 'campaign' smart constructor. +data Campaign = + Campaign' + { _camAdBlockingConfiguration :: !(Maybe AdBlockingConfiguration) + , _camCreativeOptimizationConfiguration :: !(Maybe CreativeOptimizationConfiguration) + , _camCreativeGroupIds :: !(Maybe [Textual Int64]) + , _camNielsenOCREnabled :: !(Maybe Bool) + , _camKind :: !Text + , _camClickThroughURLSuffixProperties :: !(Maybe ClickThroughURLSuffixProperties) + , _camAdvertiserId :: !(Maybe (Textual Int64)) + , _camEndDate :: !(Maybe Date') + , _camAdvertiserIdDimensionValue :: !(Maybe DimensionValue) + , _camIdDimensionValue :: !(Maybe DimensionValue) + , _camEventTagOverrides :: !(Maybe [EventTagOverride]) + , _camStartDate :: !(Maybe Date') + , _camAccountId :: !(Maybe (Textual Int64)) + , _camName :: !(Maybe Text) + , _camAdvertiserGroupId :: !(Maybe (Textual Int64)) + , _camBillingInvoiceCode :: !(Maybe Text) + , _camDefaultLandingPageId :: !(Maybe (Textual Int64)) + , _camCreateInfo :: !(Maybe LastModifiedInfo) + , _camLastModifiedInfo :: !(Maybe LastModifiedInfo) + , _camId :: !(Maybe (Textual Int64)) + , _camSubAccountId :: !(Maybe (Textual Int64)) + , _camAdditionalCreativeOptimizationConfigurations :: !(Maybe [CreativeOptimizationConfiguration]) + , _camExternalId :: !(Maybe Text) + , _camComment :: !(Maybe Text) + , _camAudienceSegmentGroups :: !(Maybe [AudienceSegmentGroup]) + , _camArchived :: !(Maybe Bool) + , _camTraffickerEmails :: !(Maybe [Text]) + , _camDefaultClickThroughEventTagProperties :: !(Maybe DefaultClickThroughEventTagProperties) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'Campaign' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'camAdBlockingConfiguration' +-- +-- * 'camCreativeOptimizationConfiguration' +-- +-- * 'camCreativeGroupIds' +-- +-- * 'camNielsenOCREnabled' +-- +-- * 'camKind' +-- +-- * 'camClickThroughURLSuffixProperties' +-- +-- * 'camAdvertiserId' +-- +-- * 'camEndDate' +-- +-- * 'camAdvertiserIdDimensionValue' +-- +-- * 'camIdDimensionValue' +-- +-- * 'camEventTagOverrides' +-- +-- * 'camStartDate' +-- +-- * 'camAccountId' +-- +-- * 'camName' +-- +-- * 'camAdvertiserGroupId' +-- +-- * 'camBillingInvoiceCode' +-- +-- * 'camDefaultLandingPageId' +-- +-- * 'camCreateInfo' +-- +-- * 'camLastModifiedInfo' +-- +-- * 'camId' +-- +-- * 'camSubAccountId' +-- +-- * 'camAdditionalCreativeOptimizationConfigurations' +-- +-- * 'camExternalId' +-- +-- * 'camComment' +-- +-- * 'camAudienceSegmentGroups' +-- +-- * 'camArchived' +-- +-- * 'camTraffickerEmails' +-- +-- * 'camDefaultClickThroughEventTagProperties' +campaign + :: Campaign +campaign = + Campaign' + { _camAdBlockingConfiguration = Nothing + , _camCreativeOptimizationConfiguration = Nothing + , _camCreativeGroupIds = Nothing + , _camNielsenOCREnabled = Nothing + , _camKind = "dfareporting#campaign" + , _camClickThroughURLSuffixProperties = Nothing + , _camAdvertiserId = Nothing + , _camEndDate = Nothing + , _camAdvertiserIdDimensionValue = Nothing + , _camIdDimensionValue = Nothing + , _camEventTagOverrides = Nothing + , _camStartDate = Nothing + , _camAccountId = Nothing + , _camName = Nothing + , _camAdvertiserGroupId = Nothing + , _camBillingInvoiceCode = Nothing + , _camDefaultLandingPageId = Nothing + , _camCreateInfo = Nothing + , _camLastModifiedInfo = Nothing + , _camId = Nothing + , _camSubAccountId = Nothing + , _camAdditionalCreativeOptimizationConfigurations = Nothing + , _camExternalId = Nothing + , _camComment = Nothing + , _camAudienceSegmentGroups = Nothing + , _camArchived = Nothing + , _camTraffickerEmails = Nothing + , _camDefaultClickThroughEventTagProperties = Nothing + } + + +-- | Ad blocking settings for this campaign. +camAdBlockingConfiguration :: Lens' Campaign (Maybe AdBlockingConfiguration) +camAdBlockingConfiguration + = lens _camAdBlockingConfiguration + (\ s a -> s{_camAdBlockingConfiguration = a}) + +-- | Creative optimization configuration for the campaign. +camCreativeOptimizationConfiguration :: Lens' Campaign (Maybe CreativeOptimizationConfiguration) +camCreativeOptimizationConfiguration + = lens _camCreativeOptimizationConfiguration + (\ s a -> + s{_camCreativeOptimizationConfiguration = a}) + +-- | List of creative group IDs that are assigned to the campaign. +camCreativeGroupIds :: Lens' Campaign [Int64] +camCreativeGroupIds + = lens _camCreativeGroupIds + (\ s a -> s{_camCreativeGroupIds = a}) + . _Default + . _Coerce + +-- | Whether Nielsen reports are enabled for this campaign. +camNielsenOCREnabled :: Lens' Campaign (Maybe Bool) +camNielsenOCREnabled + = lens _camNielsenOCREnabled + (\ s a -> s{_camNielsenOCREnabled = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#campaign\". +camKind :: Lens' Campaign Text +camKind = lens _camKind (\ s a -> s{_camKind = a}) + +-- | Click-through URL suffix override properties for this campaign. +camClickThroughURLSuffixProperties :: Lens' Campaign (Maybe ClickThroughURLSuffixProperties) +camClickThroughURLSuffixProperties + = lens _camClickThroughURLSuffixProperties + (\ s a -> s{_camClickThroughURLSuffixProperties = a}) + +-- | Advertiser ID of this campaign. This is a required field. +camAdvertiserId :: Lens' Campaign (Maybe Int64) +camAdvertiserId + = lens _camAdvertiserId + (\ s a -> s{_camAdvertiserId = a}) + . mapping _Coerce + +-- | Date on which the campaign will stop running. On insert, the end date +-- must be today or a future date. The end date must be later than or be +-- the same as the start date. If, for example, you set 6\/25\/2015 as both +-- the start and end dates, the effective campaign run date is just that +-- day only, 6\/25\/2015. The hours, minutes, and seconds of the end date +-- should not be set, as doing so will result in an error. This is a +-- required field. +camEndDate :: Lens' Campaign (Maybe Day) +camEndDate + = lens _camEndDate (\ s a -> s{_camEndDate = a}) . + mapping _Date + +-- | Dimension value for the advertiser ID of this campaign. This is a +-- read-only, auto-generated field. +camAdvertiserIdDimensionValue :: Lens' Campaign (Maybe DimensionValue) +camAdvertiserIdDimensionValue + = lens _camAdvertiserIdDimensionValue + (\ s a -> s{_camAdvertiserIdDimensionValue = a}) + +-- | Dimension value for the ID of this campaign. This is a read-only, +-- auto-generated field. +camIdDimensionValue :: Lens' Campaign (Maybe DimensionValue) +camIdDimensionValue + = lens _camIdDimensionValue + (\ s a -> s{_camIdDimensionValue = a}) + +-- | Overrides that can be used to activate or deactivate advertiser event +-- tags. +camEventTagOverrides :: Lens' Campaign [EventTagOverride] +camEventTagOverrides + = lens _camEventTagOverrides + (\ s a -> s{_camEventTagOverrides = a}) + . _Default + . _Coerce + +-- | Date on which the campaign starts running. The start date can be any +-- date. The hours, minutes, and seconds of the start date should not be +-- set, as doing so will result in an error. This is a required field. +camStartDate :: Lens' Campaign (Maybe Day) +camStartDate + = lens _camStartDate (\ s a -> s{_camStartDate = a}) + . mapping _Date + +-- | Account ID of this campaign. This is a read-only field that can be left +-- blank. +camAccountId :: Lens' Campaign (Maybe Int64) +camAccountId + = lens _camAccountId (\ s a -> s{_camAccountId = a}) + . mapping _Coerce + +-- | Name of this campaign. This is a required field and must be less than +-- 256 characters long and unique among campaigns of the same advertiser. +camName :: Lens' Campaign (Maybe Text) +camName = lens _camName (\ s a -> s{_camName = a}) + +-- | Advertiser group ID of the associated advertiser. +camAdvertiserGroupId :: Lens' Campaign (Maybe Int64) +camAdvertiserGroupId + = lens _camAdvertiserGroupId + (\ s a -> s{_camAdvertiserGroupId = a}) + . mapping _Coerce + +-- | Billing invoice code included in the Campaign Manager client billing +-- invoices associated with the campaign. +camBillingInvoiceCode :: Lens' Campaign (Maybe Text) +camBillingInvoiceCode + = lens _camBillingInvoiceCode + (\ s a -> s{_camBillingInvoiceCode = a}) + +-- | The default landing page ID for this campaign. +camDefaultLandingPageId :: Lens' Campaign (Maybe Int64) +camDefaultLandingPageId + = lens _camDefaultLandingPageId + (\ s a -> s{_camDefaultLandingPageId = a}) + . mapping _Coerce + +-- | Information about the creation of this campaign. This is a read-only +-- field. +camCreateInfo :: Lens' Campaign (Maybe LastModifiedInfo) +camCreateInfo + = lens _camCreateInfo + (\ s a -> s{_camCreateInfo = a}) + +-- | Information about the most recent modification of this campaign. This is +-- a read-only field. +camLastModifiedInfo :: Lens' Campaign (Maybe LastModifiedInfo) +camLastModifiedInfo + = lens _camLastModifiedInfo + (\ s a -> s{_camLastModifiedInfo = a}) + +-- | ID of this campaign. This is a read-only auto-generated field. +camId :: Lens' Campaign (Maybe Int64) +camId + = lens _camId (\ s a -> s{_camId = a}) . + mapping _Coerce + +-- | Subaccount ID of this campaign. This is a read-only field that can be +-- left blank. +camSubAccountId :: Lens' Campaign (Maybe Int64) +camSubAccountId + = lens _camSubAccountId + (\ s a -> s{_camSubAccountId = a}) + . mapping _Coerce + +-- | Additional creative optimization configurations for the campaign. +camAdditionalCreativeOptimizationConfigurations :: Lens' Campaign [CreativeOptimizationConfiguration] +camAdditionalCreativeOptimizationConfigurations + = lens + _camAdditionalCreativeOptimizationConfigurations + (\ s a -> + s{_camAdditionalCreativeOptimizationConfigurations = + a}) + . _Default + . _Coerce + +-- | External ID for this campaign. +camExternalId :: Lens' Campaign (Maybe Text) +camExternalId + = lens _camExternalId + (\ s a -> s{_camExternalId = a}) + +-- | Arbitrary comments about this campaign. Must be less than 256 characters +-- long. +camComment :: Lens' Campaign (Maybe Text) +camComment + = lens _camComment (\ s a -> s{_camComment = a}) + +-- | Audience segment groups assigned to this campaign. Cannot have more than +-- 300 segment groups. +camAudienceSegmentGroups :: Lens' Campaign [AudienceSegmentGroup] +camAudienceSegmentGroups + = lens _camAudienceSegmentGroups + (\ s a -> s{_camAudienceSegmentGroups = a}) + . _Default + . _Coerce + +-- | Whether this campaign has been archived. +camArchived :: Lens' Campaign (Maybe Bool) +camArchived + = lens _camArchived (\ s a -> s{_camArchived = a}) + +-- | Campaign trafficker contact emails. +camTraffickerEmails :: Lens' Campaign [Text] +camTraffickerEmails + = lens _camTraffickerEmails + (\ s a -> s{_camTraffickerEmails = a}) + . _Default + . _Coerce + +-- | Click-through event tag ID override properties for this campaign. +camDefaultClickThroughEventTagProperties :: Lens' Campaign (Maybe DefaultClickThroughEventTagProperties) +camDefaultClickThroughEventTagProperties + = lens _camDefaultClickThroughEventTagProperties + (\ s a -> + s{_camDefaultClickThroughEventTagProperties = a}) + +instance FromJSON Campaign where + parseJSON + = withObject "Campaign" + (\ o -> + Campaign' <$> + (o .:? "adBlockingConfiguration") <*> + (o .:? "creativeOptimizationConfiguration") + <*> (o .:? "creativeGroupIds" .!= mempty) + <*> (o .:? "nielsenOcrEnabled") + <*> (o .:? "kind" .!= "dfareporting#campaign") + <*> (o .:? "clickThroughUrlSuffixProperties") + <*> (o .:? "advertiserId") + <*> (o .:? "endDate") + <*> (o .:? "advertiserIdDimensionValue") + <*> (o .:? "idDimensionValue") + <*> (o .:? "eventTagOverrides" .!= mempty) + <*> (o .:? "startDate") + <*> (o .:? "accountId") + <*> (o .:? "name") + <*> (o .:? "advertiserGroupId") + <*> (o .:? "billingInvoiceCode") + <*> (o .:? "defaultLandingPageId") + <*> (o .:? "createInfo") + <*> (o .:? "lastModifiedInfo") + <*> (o .:? "id") + <*> (o .:? "subaccountId") + <*> + (o .:? "additionalCreativeOptimizationConfigurations" + .!= mempty) + <*> (o .:? "externalId") + <*> (o .:? "comment") + <*> (o .:? "audienceSegmentGroups" .!= mempty) + <*> (o .:? "archived") + <*> (o .:? "traffickerEmails" .!= mempty) + <*> (o .:? "defaultClickThroughEventTagProperties")) + +instance ToJSON Campaign where + toJSON Campaign'{..} + = object + (catMaybes + [("adBlockingConfiguration" .=) <$> + _camAdBlockingConfiguration, + ("creativeOptimizationConfiguration" .=) <$> + _camCreativeOptimizationConfiguration, + ("creativeGroupIds" .=) <$> _camCreativeGroupIds, + ("nielsenOcrEnabled" .=) <$> _camNielsenOCREnabled, + Just ("kind" .= _camKind), + ("clickThroughUrlSuffixProperties" .=) <$> + _camClickThroughURLSuffixProperties, + ("advertiserId" .=) <$> _camAdvertiserId, + ("endDate" .=) <$> _camEndDate, + ("advertiserIdDimensionValue" .=) <$> + _camAdvertiserIdDimensionValue, + ("idDimensionValue" .=) <$> _camIdDimensionValue, + ("eventTagOverrides" .=) <$> _camEventTagOverrides, + ("startDate" .=) <$> _camStartDate, + ("accountId" .=) <$> _camAccountId, + ("name" .=) <$> _camName, + ("advertiserGroupId" .=) <$> _camAdvertiserGroupId, + ("billingInvoiceCode" .=) <$> _camBillingInvoiceCode, + ("defaultLandingPageId" .=) <$> + _camDefaultLandingPageId, + ("createInfo" .=) <$> _camCreateInfo, + ("lastModifiedInfo" .=) <$> _camLastModifiedInfo, + ("id" .=) <$> _camId, + ("subaccountId" .=) <$> _camSubAccountId, + ("additionalCreativeOptimizationConfigurations" .=) + <$> _camAdditionalCreativeOptimizationConfigurations, + ("externalId" .=) <$> _camExternalId, + ("comment" .=) <$> _camComment, + ("audienceSegmentGroups" .=) <$> + _camAudienceSegmentGroups, + ("archived" .=) <$> _camArchived, + ("traffickerEmails" .=) <$> _camTraffickerEmails, + ("defaultClickThroughEventTagProperties" .=) <$> + _camDefaultClickThroughEventTagProperties]) + +-- | Third Party Authentication Token +-- +-- /See:/ 'thirdPartyAuthenticationToken' smart constructor. +data ThirdPartyAuthenticationToken = + ThirdPartyAuthenticationToken' + { _tpatValue :: !(Maybe Text) + , _tpatName :: !(Maybe Text) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ThirdPartyAuthenticationToken' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'tpatValue' +-- +-- * 'tpatName' +thirdPartyAuthenticationToken + :: ThirdPartyAuthenticationToken +thirdPartyAuthenticationToken = + ThirdPartyAuthenticationToken' {_tpatValue = Nothing, _tpatName = Nothing} + + +-- | Value of the third-party authentication token. This is a read-only, +-- auto-generated field. +tpatValue :: Lens' ThirdPartyAuthenticationToken (Maybe Text) +tpatValue + = lens _tpatValue (\ s a -> s{_tpatValue = a}) + +-- | Name of the third-party authentication token. +tpatName :: Lens' ThirdPartyAuthenticationToken (Maybe Text) +tpatName = lens _tpatName (\ s a -> s{_tpatName = a}) + +instance FromJSON ThirdPartyAuthenticationToken where + parseJSON + = withObject "ThirdPartyAuthenticationToken" + (\ o -> + ThirdPartyAuthenticationToken' <$> + (o .:? "value") <*> (o .:? "name")) + +instance ToJSON ThirdPartyAuthenticationToken where + toJSON ThirdPartyAuthenticationToken'{..} + = object + (catMaybes + [("value" .=) <$> _tpatValue, + ("name" .=) <$> _tpatName]) + +-- | Click-through URL +-- +-- /See:/ 'clickThroughURL' smart constructor. +data ClickThroughURL = + ClickThroughURL' + { _ctuDefaultLandingPage :: !(Maybe Bool) + , _ctuComputedClickThroughURL :: !(Maybe Text) + , _ctuCustomClickThroughURL :: !(Maybe Text) + , _ctuLandingPageId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ClickThroughURL' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'ctuDefaultLandingPage' +-- +-- * 'ctuComputedClickThroughURL' +-- +-- * 'ctuCustomClickThroughURL' +-- +-- * 'ctuLandingPageId' +clickThroughURL + :: ClickThroughURL +clickThroughURL = + ClickThroughURL' + { _ctuDefaultLandingPage = Nothing + , _ctuComputedClickThroughURL = Nothing + , _ctuCustomClickThroughURL = Nothing + , _ctuLandingPageId = Nothing + } + + +-- | Whether the campaign default landing page is used. +ctuDefaultLandingPage :: Lens' ClickThroughURL (Maybe Bool) +ctuDefaultLandingPage + = lens _ctuDefaultLandingPage + (\ s a -> s{_ctuDefaultLandingPage = a}) + +-- | Read-only convenience field representing the actual URL that will be +-- used for this click-through. The URL is computed as follows: - If +-- defaultLandingPage is enabled then the campaign\'s default landing page +-- URL is assigned to this field. - If defaultLandingPage is not enabled +-- and a landingPageId is specified then that landing page\'s URL is +-- assigned to this field. - If neither of the above cases apply, then the +-- customClickThroughUrl is assigned to this field. +ctuComputedClickThroughURL :: Lens' ClickThroughURL (Maybe Text) +ctuComputedClickThroughURL + = lens _ctuComputedClickThroughURL + (\ s a -> s{_ctuComputedClickThroughURL = a}) + +-- | Custom click-through URL. Applicable if the defaultLandingPage field is +-- set to false and the landingPageId field is left unset. +ctuCustomClickThroughURL :: Lens' ClickThroughURL (Maybe Text) +ctuCustomClickThroughURL + = lens _ctuCustomClickThroughURL + (\ s a -> s{_ctuCustomClickThroughURL = a}) + +-- | ID of the landing page for the click-through URL. Applicable if the +-- defaultLandingPage field is set to false. +ctuLandingPageId :: Lens' ClickThroughURL (Maybe Int64) +ctuLandingPageId + = lens _ctuLandingPageId + (\ s a -> s{_ctuLandingPageId = a}) + . mapping _Coerce + +instance FromJSON ClickThroughURL where + parseJSON + = withObject "ClickThroughURL" + (\ o -> + ClickThroughURL' <$> + (o .:? "defaultLandingPage") <*> + (o .:? "computedClickThroughUrl") + <*> (o .:? "customClickThroughUrl") + <*> (o .:? "landingPageId")) + +instance ToJSON ClickThroughURL where + toJSON ClickThroughURL'{..} + = object + (catMaybes + [("defaultLandingPage" .=) <$> + _ctuDefaultLandingPage, + ("computedClickThroughUrl" .=) <$> + _ctuComputedClickThroughURL, + ("customClickThroughUrl" .=) <$> + _ctuCustomClickThroughURL, + ("landingPageId" .=) <$> _ctuLandingPageId]) + +-- | Browser List Response +-- +-- /See:/ 'browsersListResponse' smart constructor. +data BrowsersListResponse = + BrowsersListResponse' + { _blrKind :: !Text + , _blrBrowsers :: !(Maybe [Browser]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'BrowsersListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'blrKind' +-- +-- * 'blrBrowsers' +browsersListResponse + :: BrowsersListResponse +browsersListResponse = + BrowsersListResponse' + {_blrKind = "dfareporting#browsersListResponse", _blrBrowsers = Nothing} + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#browsersListResponse\". +blrKind :: Lens' BrowsersListResponse Text +blrKind = lens _blrKind (\ s a -> s{_blrKind = a}) + +-- | Browser collection. +blrBrowsers :: Lens' BrowsersListResponse [Browser] +blrBrowsers + = lens _blrBrowsers (\ s a -> s{_blrBrowsers = a}) . + _Default + . _Coerce + +instance FromJSON BrowsersListResponse where + parseJSON + = withObject "BrowsersListResponse" + (\ o -> + BrowsersListResponse' <$> + (o .:? "kind" .!= + "dfareporting#browsersListResponse") + <*> (o .:? "browsers" .!= mempty)) + +instance ToJSON BrowsersListResponse where + toJSON BrowsersListResponse'{..} + = object + (catMaybes + [Just ("kind" .= _blrKind), + ("browsers" .=) <$> _blrBrowsers]) + +-- | Site Settings +-- +-- /See:/ 'siteSettings' smart constructor. +data SiteSettings = + SiteSettings' + { _ssDisableNewCookie :: !(Maybe Bool) + , _ssVideoActiveViewOptOutTemplate :: !(Maybe Bool) + , _ssAdBlockingOptOut :: !(Maybe Bool) + , _ssTagSetting :: !(Maybe TagSetting) + , _ssActiveViewOptOut :: !(Maybe Bool) + , _ssVpaidAdapterChoiceTemplate :: !(Maybe SiteSettingsVpaidAdapterChoiceTemplate) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'SiteSettings' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'ssDisableNewCookie' +-- +-- * 'ssVideoActiveViewOptOutTemplate' +-- +-- * 'ssAdBlockingOptOut' +-- +-- * 'ssTagSetting' +-- +-- * 'ssActiveViewOptOut' +-- +-- * 'ssVpaidAdapterChoiceTemplate' +siteSettings + :: SiteSettings +siteSettings = + SiteSettings' + { _ssDisableNewCookie = Nothing + , _ssVideoActiveViewOptOutTemplate = Nothing + , _ssAdBlockingOptOut = Nothing + , _ssTagSetting = Nothing + , _ssActiveViewOptOut = Nothing + , _ssVpaidAdapterChoiceTemplate = Nothing + } + + +-- | Whether new cookies are disabled for this site. +ssDisableNewCookie :: Lens' SiteSettings (Maybe Bool) +ssDisableNewCookie + = lens _ssDisableNewCookie + (\ s a -> s{_ssDisableNewCookie = a}) + +-- | Whether Verification and ActiveView for in-stream video creatives are +-- disabled by default for new placements created under this site. This +-- value will be used to populate the placement.videoActiveViewOptOut +-- field, when no value is specified for the new placement. +ssVideoActiveViewOptOutTemplate :: Lens' SiteSettings (Maybe Bool) +ssVideoActiveViewOptOutTemplate + = lens _ssVideoActiveViewOptOutTemplate + (\ s a -> s{_ssVideoActiveViewOptOutTemplate = a}) + +-- | Whether this site opts out of ad blocking. When true, ad blocking is +-- disabled for all placements under the site, regardless of the individual +-- placement settings. When false, the campaign and placement settings take +-- effect. +ssAdBlockingOptOut :: Lens' SiteSettings (Maybe Bool) +ssAdBlockingOptOut + = lens _ssAdBlockingOptOut + (\ s a -> s{_ssAdBlockingOptOut = a}) + +-- | Configuration settings for dynamic and image floodlight tags. +ssTagSetting :: Lens' SiteSettings (Maybe TagSetting) +ssTagSetting + = lens _ssTagSetting (\ s a -> s{_ssTagSetting = a}) + +-- | Whether active view creatives are disabled for this site. +ssActiveViewOptOut :: Lens' SiteSettings (Maybe Bool) +ssActiveViewOptOut + = lens _ssActiveViewOptOut + (\ s a -> s{_ssActiveViewOptOut = a}) + +-- | Default VPAID adapter setting for new placements created under this +-- site. This value will be used to populate the +-- placements.vpaidAdapterChoice field, when no value is specified for the +-- new placement. Controls which VPAID format the measurement adapter will +-- use for in-stream video creatives assigned to the placement. The +-- publisher\'s specifications will typically determine this setting. For +-- VPAID creatives, the adapter format will match the VPAID format (HTML5 +-- VPAID creatives use the HTML5 adapter). Note: Flash is no longer +-- supported. This field now defaults to HTML5 when the following values +-- are provided: FLASH, BOTH. +ssVpaidAdapterChoiceTemplate :: Lens' SiteSettings (Maybe SiteSettingsVpaidAdapterChoiceTemplate) +ssVpaidAdapterChoiceTemplate + = lens _ssVpaidAdapterChoiceTemplate + (\ s a -> s{_ssVpaidAdapterChoiceTemplate = a}) + +instance FromJSON SiteSettings where + parseJSON + = withObject "SiteSettings" + (\ o -> + SiteSettings' <$> + (o .:? "disableNewCookie") <*> + (o .:? "videoActiveViewOptOutTemplate") + <*> (o .:? "adBlockingOptOut") + <*> (o .:? "tagSetting") + <*> (o .:? "activeViewOptOut") + <*> (o .:? "vpaidAdapterChoiceTemplate")) + +instance ToJSON SiteSettings where + toJSON SiteSettings'{..} + = object + (catMaybes + [("disableNewCookie" .=) <$> _ssDisableNewCookie, + ("videoActiveViewOptOutTemplate" .=) <$> + _ssVideoActiveViewOptOutTemplate, + ("adBlockingOptOut" .=) <$> _ssAdBlockingOptOut, + ("tagSetting" .=) <$> _ssTagSetting, + ("activeViewOptOut" .=) <$> _ssActiveViewOptOut, + ("vpaidAdapterChoiceTemplate" .=) <$> + _ssVpaidAdapterChoiceTemplate]) + +-- | Content Category List Response +-- +-- /See:/ 'contentCategoriesListResponse' smart constructor. +data ContentCategoriesListResponse = + ContentCategoriesListResponse' + { _cclrNextPageToken :: !(Maybe Text) + , _cclrKind :: !Text + , _cclrContentCategories :: !(Maybe [ContentCategory]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ContentCategoriesListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'cclrNextPageToken' +-- +-- * 'cclrKind' +-- +-- * 'cclrContentCategories' +contentCategoriesListResponse + :: ContentCategoriesListResponse +contentCategoriesListResponse = + ContentCategoriesListResponse' + { _cclrNextPageToken = Nothing + , _cclrKind = "dfareporting#contentCategoriesListResponse" + , _cclrContentCategories = Nothing + } + + +-- | Pagination token to be used for the next list operation. +cclrNextPageToken :: Lens' ContentCategoriesListResponse (Maybe Text) +cclrNextPageToken + = lens _cclrNextPageToken + (\ s a -> s{_cclrNextPageToken = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#contentCategoriesListResponse\". +cclrKind :: Lens' ContentCategoriesListResponse Text +cclrKind = lens _cclrKind (\ s a -> s{_cclrKind = a}) + +-- | Content category collection. +cclrContentCategories :: Lens' ContentCategoriesListResponse [ContentCategory] +cclrContentCategories + = lens _cclrContentCategories + (\ s a -> s{_cclrContentCategories = a}) + . _Default + . _Coerce + +instance FromJSON ContentCategoriesListResponse where + parseJSON + = withObject "ContentCategoriesListResponse" + (\ o -> + ContentCategoriesListResponse' <$> + (o .:? "nextPageToken") <*> + (o .:? "kind" .!= + "dfareporting#contentCategoriesListResponse") + <*> (o .:? "contentCategories" .!= mempty)) + +instance ToJSON ContentCategoriesListResponse where + toJSON ContentCategoriesListResponse'{..} + = object + (catMaybes + [("nextPageToken" .=) <$> _cclrNextPageToken, + Just ("kind" .= _cclrKind), + ("contentCategories" .=) <$> _cclrContentCategories]) + +-- | Creative List Response +-- +-- /See:/ 'creativesListResponse' smart constructor. +data CreativesListResponse = + CreativesListResponse' + { _clrlNextPageToken :: !(Maybe Text) + , _clrlKind :: !Text + , _clrlCreatives :: !(Maybe [Creative]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'CreativesListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'clrlNextPageToken' +-- +-- * 'clrlKind' +-- +-- * 'clrlCreatives' +creativesListResponse + :: CreativesListResponse +creativesListResponse = + CreativesListResponse' + { _clrlNextPageToken = Nothing + , _clrlKind = "dfareporting#creativesListResponse" + , _clrlCreatives = Nothing + } + + +-- | Pagination token to be used for the next list operation. +clrlNextPageToken :: Lens' CreativesListResponse (Maybe Text) +clrlNextPageToken + = lens _clrlNextPageToken + (\ s a -> s{_clrlNextPageToken = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#creativesListResponse\". +clrlKind :: Lens' CreativesListResponse Text +clrlKind = lens _clrlKind (\ s a -> s{_clrlKind = a}) + +-- | Creative collection. +clrlCreatives :: Lens' CreativesListResponse [Creative] +clrlCreatives + = lens _clrlCreatives + (\ s a -> s{_clrlCreatives = a}) + . _Default + . _Coerce + +instance FromJSON CreativesListResponse where + parseJSON + = withObject "CreativesListResponse" + (\ o -> + CreativesListResponse' <$> + (o .:? "nextPageToken") <*> + (o .:? "kind" .!= + "dfareporting#creativesListResponse") + <*> (o .:? "creatives" .!= mempty)) + +instance ToJSON CreativesListResponse where + toJSON CreativesListResponse'{..} + = object + (catMaybes + [("nextPageToken" .=) <$> _clrlNextPageToken, + Just ("kind" .= _clrlKind), + ("creatives" .=) <$> _clrlCreatives]) + +-- | Contains properties of a Campaign Manager account. +-- +-- /See:/ 'account' smart constructor. +data Account = + Account' + { _aaAccountPermissionIds :: !(Maybe [Textual Int64]) + , _aaMaximumImageSize :: !(Maybe (Textual Int64)) + , _aaCurrencyId :: !(Maybe (Textual Int64)) + , _aaReportsConfiguration :: !(Maybe ReportsConfiguration) + , _aaNielsenOCREnabled :: !(Maybe Bool) + , _aaKind :: !Text + , _aaLocale :: !(Maybe Text) + , _aaActive :: !(Maybe Bool) + , _aaAvailablePermissionIds :: !(Maybe [Textual Int64]) + , _aaTeaserSizeLimit :: !(Maybe (Textual Int64)) + , _aaActiveViewOptOut :: !(Maybe Bool) + , _aaShareReportsWithTwitter :: !(Maybe Bool) + , _aaName :: !(Maybe Text) + , _aaAccountProFile :: !(Maybe AccountAccountProFile) + , _aaId :: !(Maybe (Textual Int64)) + , _aaCountryId :: !(Maybe (Textual Int64)) + , _aaActiveAdsLimitTier :: !(Maybe AccountActiveAdsLimitTier) + , _aaDefaultCreativeSizeId :: !(Maybe (Textual Int64)) + , _aaDescription :: !(Maybe Text) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'Account' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'aaAccountPermissionIds' +-- +-- * 'aaMaximumImageSize' +-- +-- * 'aaCurrencyId' +-- +-- * 'aaReportsConfiguration' +-- +-- * 'aaNielsenOCREnabled' +-- +-- * 'aaKind' +-- +-- * 'aaLocale' +-- +-- * 'aaActive' +-- +-- * 'aaAvailablePermissionIds' +-- +-- * 'aaTeaserSizeLimit' +-- +-- * 'aaActiveViewOptOut' +-- +-- * 'aaShareReportsWithTwitter' +-- +-- * 'aaName' +-- +-- * 'aaAccountProFile' +-- +-- * 'aaId' +-- +-- * 'aaCountryId' +-- +-- * 'aaActiveAdsLimitTier' +-- +-- * 'aaDefaultCreativeSizeId' +-- +-- * 'aaDescription' +account + :: Account +account = + Account' + { _aaAccountPermissionIds = Nothing + , _aaMaximumImageSize = Nothing + , _aaCurrencyId = Nothing + , _aaReportsConfiguration = Nothing + , _aaNielsenOCREnabled = Nothing + , _aaKind = "dfareporting#account" + , _aaLocale = Nothing + , _aaActive = Nothing + , _aaAvailablePermissionIds = Nothing + , _aaTeaserSizeLimit = Nothing + , _aaActiveViewOptOut = Nothing + , _aaShareReportsWithTwitter = Nothing + , _aaName = Nothing + , _aaAccountProFile = Nothing + , _aaId = Nothing + , _aaCountryId = Nothing + , _aaActiveAdsLimitTier = Nothing + , _aaDefaultCreativeSizeId = Nothing + , _aaDescription = Nothing + } + + +-- | Account permissions assigned to this account. +aaAccountPermissionIds :: Lens' Account [Int64] +aaAccountPermissionIds + = lens _aaAccountPermissionIds + (\ s a -> s{_aaAccountPermissionIds = a}) + . _Default + . _Coerce + +-- | Maximum image size allowed for this account, in kilobytes. Value must be +-- greater than or equal to 1. +aaMaximumImageSize :: Lens' Account (Maybe Int64) +aaMaximumImageSize + = lens _aaMaximumImageSize + (\ s a -> s{_aaMaximumImageSize = a}) + . mapping _Coerce + +-- | ID of currency associated with this account. This is a required field. +-- Acceptable values are: - \"1\" for USD - \"2\" for GBP - \"3\" for ESP - +-- \"4\" for SEK - \"5\" for CAD - \"6\" for JPY - \"7\" for DEM - \"8\" +-- for AUD - \"9\" for FRF - \"10\" for ITL - \"11\" for DKK - \"12\" for +-- NOK - \"13\" for FIM - \"14\" for ZAR - \"15\" for IEP - \"16\" for NLG +-- - \"17\" for EUR - \"18\" for KRW - \"19\" for TWD - \"20\" for SGD - +-- \"21\" for CNY - \"22\" for HKD - \"23\" for NZD - \"24\" for MYR - +-- \"25\" for BRL - \"26\" for PTE - \"27\" for MXP - \"28\" for CLP - +-- \"29\" for TRY - \"30\" for ARS - \"31\" for PEN - \"32\" for ILS - +-- \"33\" for CHF - \"34\" for VEF - \"35\" for COP - \"36\" for GTQ - +-- \"37\" for PLN - \"39\" for INR - \"40\" for THB - \"41\" for IDR - +-- \"42\" for CZK - \"43\" for RON - \"44\" for HUF - \"45\" for RUB - +-- \"46\" for AED - \"47\" for BGN - \"48\" for HRK - \"49\" for MXN - +-- \"50\" for NGN +aaCurrencyId :: Lens' Account (Maybe Int64) +aaCurrencyId + = lens _aaCurrencyId (\ s a -> s{_aaCurrencyId = a}) + . mapping _Coerce + +-- | Reporting configuration of this account. +aaReportsConfiguration :: Lens' Account (Maybe ReportsConfiguration) +aaReportsConfiguration + = lens _aaReportsConfiguration + (\ s a -> s{_aaReportsConfiguration = a}) + +-- | Whether campaigns created in this account will be enabled for Nielsen +-- OCR reach ratings by default. +aaNielsenOCREnabled :: Lens' Account (Maybe Bool) +aaNielsenOCREnabled + = lens _aaNielsenOCREnabled + (\ s a -> s{_aaNielsenOCREnabled = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#account\". +aaKind :: Lens' Account Text +aaKind = lens _aaKind (\ s a -> s{_aaKind = a}) + +-- | Locale of this account. Acceptable values are: - \"cs\" (Czech) - \"de\" +-- (German) - \"en\" (English) - \"en-GB\" (English United Kingdom) - +-- \"es\" (Spanish) - \"fr\" (French) - \"it\" (Italian) - \"ja\" +-- (Japanese) - \"ko\" (Korean) - \"pl\" (Polish) - \"pt-BR\" (Portuguese +-- Brazil) - \"ru\" (Russian) - \"sv\" (Swedish) - \"tr\" (Turkish) - +-- \"zh-CN\" (Chinese Simplified) - \"zh-TW\" (Chinese Traditional) +aaLocale :: Lens' Account (Maybe Text) +aaLocale = lens _aaLocale (\ s a -> s{_aaLocale = a}) + +-- | Whether this account is active. +aaActive :: Lens' Account (Maybe Bool) +aaActive = lens _aaActive (\ s a -> s{_aaActive = a}) + +-- | User role permissions available to the user roles of this account. +aaAvailablePermissionIds :: Lens' Account [Int64] +aaAvailablePermissionIds + = lens _aaAvailablePermissionIds + (\ s a -> s{_aaAvailablePermissionIds = a}) + . _Default + . _Coerce + +-- | File size limit in kilobytes of Rich Media teaser creatives. Acceptable +-- values are 1 to 10240, inclusive. +aaTeaserSizeLimit :: Lens' Account (Maybe Int64) +aaTeaserSizeLimit + = lens _aaTeaserSizeLimit + (\ s a -> s{_aaTeaserSizeLimit = a}) + . mapping _Coerce + +-- | Whether to serve creatives with Active View tags. If disabled, +-- viewability data will not be available for any impressions. +aaActiveViewOptOut :: Lens' Account (Maybe Bool) +aaActiveViewOptOut + = lens _aaActiveViewOptOut + (\ s a -> s{_aaActiveViewOptOut = a}) + +-- | Share Path to Conversion reports with Twitter. +aaShareReportsWithTwitter :: Lens' Account (Maybe Bool) +aaShareReportsWithTwitter + = lens _aaShareReportsWithTwitter + (\ s a -> s{_aaShareReportsWithTwitter = a}) + +-- | Name of this account. This is a required field, and must be less than +-- 128 characters long and be globally unique. +aaName :: Lens' Account (Maybe Text) +aaName = lens _aaName (\ s a -> s{_aaName = a}) + +-- | Profile for this account. This is a read-only field that can be left +-- blank. +aaAccountProFile :: Lens' Account (Maybe AccountAccountProFile) +aaAccountProFile + = lens _aaAccountProFile + (\ s a -> s{_aaAccountProFile = a}) + +-- | ID of this account. This is a read-only, auto-generated field. +aaId :: Lens' Account (Maybe Int64) +aaId + = lens _aaId (\ s a -> s{_aaId = a}) . + mapping _Coerce + +-- | ID of the country associated with this account. +aaCountryId :: Lens' Account (Maybe Int64) +aaCountryId + = lens _aaCountryId (\ s a -> s{_aaCountryId = a}) . + mapping _Coerce + +-- | Maximum number of active ads allowed for this account. +aaActiveAdsLimitTier :: Lens' Account (Maybe AccountActiveAdsLimitTier) +aaActiveAdsLimitTier + = lens _aaActiveAdsLimitTier + (\ s a -> s{_aaActiveAdsLimitTier = a}) + +-- | Default placement dimensions for this account. +aaDefaultCreativeSizeId :: Lens' Account (Maybe Int64) +aaDefaultCreativeSizeId + = lens _aaDefaultCreativeSizeId + (\ s a -> s{_aaDefaultCreativeSizeId = a}) + . mapping _Coerce + +-- | Description of this account. +aaDescription :: Lens' Account (Maybe Text) +aaDescription + = lens _aaDescription + (\ s a -> s{_aaDescription = a}) + +instance FromJSON Account where + parseJSON + = withObject "Account" + (\ o -> + Account' <$> + (o .:? "accountPermissionIds" .!= mempty) <*> + (o .:? "maximumImageSize") + <*> (o .:? "currencyId") + <*> (o .:? "reportsConfiguration") + <*> (o .:? "nielsenOcrEnabled") + <*> (o .:? "kind" .!= "dfareporting#account") + <*> (o .:? "locale") + <*> (o .:? "active") + <*> (o .:? "availablePermissionIds" .!= mempty) + <*> (o .:? "teaserSizeLimit") + <*> (o .:? "activeViewOptOut") + <*> (o .:? "shareReportsWithTwitter") + <*> (o .:? "name") + <*> (o .:? "accountProfile") + <*> (o .:? "id") + <*> (o .:? "countryId") + <*> (o .:? "activeAdsLimitTier") + <*> (o .:? "defaultCreativeSizeId") + <*> (o .:? "description")) + +instance ToJSON Account where + toJSON Account'{..} + = object + (catMaybes + [("accountPermissionIds" .=) <$> + _aaAccountPermissionIds, + ("maximumImageSize" .=) <$> _aaMaximumImageSize, + ("currencyId" .=) <$> _aaCurrencyId, + ("reportsConfiguration" .=) <$> + _aaReportsConfiguration, + ("nielsenOcrEnabled" .=) <$> _aaNielsenOCREnabled, + Just ("kind" .= _aaKind), + ("locale" .=) <$> _aaLocale, + ("active" .=) <$> _aaActive, + ("availablePermissionIds" .=) <$> + _aaAvailablePermissionIds, + ("teaserSizeLimit" .=) <$> _aaTeaserSizeLimit, + ("activeViewOptOut" .=) <$> _aaActiveViewOptOut, + ("shareReportsWithTwitter" .=) <$> + _aaShareReportsWithTwitter, + ("name" .=) <$> _aaName, + ("accountProfile" .=) <$> _aaAccountProFile, + ("id" .=) <$> _aaId, + ("countryId" .=) <$> _aaCountryId, + ("activeAdsLimitTier" .=) <$> _aaActiveAdsLimitTier, + ("defaultCreativeSizeId" .=) <$> + _aaDefaultCreativeSizeId, + ("description" .=) <$> _aaDescription]) + +-- | Insert Conversions Request. +-- +-- /See:/ 'conversionsBatchInsertRequest' smart constructor. +data ConversionsBatchInsertRequest = + ConversionsBatchInsertRequest' + { _cbirKind :: !Text + , _cbirConversions :: !(Maybe [Conversion]) + , _cbirEncryptionInfo :: !(Maybe EncryptionInfo) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ConversionsBatchInsertRequest' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'cbirKind' +-- +-- * 'cbirConversions' +-- +-- * 'cbirEncryptionInfo' +conversionsBatchInsertRequest + :: ConversionsBatchInsertRequest +conversionsBatchInsertRequest = + ConversionsBatchInsertRequest' + { _cbirKind = "dfareporting#conversionsBatchInsertRequest" + , _cbirConversions = Nothing + , _cbirEncryptionInfo = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#conversionsBatchInsertRequest\". +cbirKind :: Lens' ConversionsBatchInsertRequest Text +cbirKind = lens _cbirKind (\ s a -> s{_cbirKind = a}) + +-- | The set of conversions to insert. +cbirConversions :: Lens' ConversionsBatchInsertRequest [Conversion] +cbirConversions + = lens _cbirConversions + (\ s a -> s{_cbirConversions = a}) + . _Default + . _Coerce + +-- | Describes how encryptedUserId or encryptedUserIdCandidates[] is +-- encrypted. This is a required field if encryptedUserId or +-- encryptedUserIdCandidates[] is used. +cbirEncryptionInfo :: Lens' ConversionsBatchInsertRequest (Maybe EncryptionInfo) +cbirEncryptionInfo + = lens _cbirEncryptionInfo + (\ s a -> s{_cbirEncryptionInfo = a}) + +instance FromJSON ConversionsBatchInsertRequest where + parseJSON + = withObject "ConversionsBatchInsertRequest" + (\ o -> + ConversionsBatchInsertRequest' <$> + (o .:? "kind" .!= + "dfareporting#conversionsBatchInsertRequest") + <*> (o .:? "conversions" .!= mempty) + <*> (o .:? "encryptionInfo")) + +instance ToJSON ConversionsBatchInsertRequest where + toJSON ConversionsBatchInsertRequest'{..} + = object + (catMaybes + [Just ("kind" .= _cbirKind), + ("conversions" .=) <$> _cbirConversions, + ("encryptionInfo" .=) <$> _cbirEncryptionInfo]) + +-- | Account User Profile List Response +-- +-- /See:/ 'accountUserProFilesListResponse' smart constructor. +data AccountUserProFilesListResponse = + AccountUserProFilesListResponse' + { _aupflrNextPageToken :: !(Maybe Text) + , _aupflrAccountUserProFiles :: !(Maybe [AccountUserProFile]) + , _aupflrKind :: !Text + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'AccountUserProFilesListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'aupflrNextPageToken' +-- +-- * 'aupflrAccountUserProFiles' +-- +-- * 'aupflrKind' +accountUserProFilesListResponse + :: AccountUserProFilesListResponse +accountUserProFilesListResponse = + AccountUserProFilesListResponse' + { _aupflrNextPageToken = Nothing + , _aupflrAccountUserProFiles = Nothing + , _aupflrKind = "dfareporting#accountUserProfilesListResponse" + } + + +-- | Pagination token to be used for the next list operation. +aupflrNextPageToken :: Lens' AccountUserProFilesListResponse (Maybe Text) +aupflrNextPageToken + = lens _aupflrNextPageToken + (\ s a -> s{_aupflrNextPageToken = a}) + +-- | Account user profile collection. +aupflrAccountUserProFiles :: Lens' AccountUserProFilesListResponse [AccountUserProFile] +aupflrAccountUserProFiles + = lens _aupflrAccountUserProFiles + (\ s a -> s{_aupflrAccountUserProFiles = a}) + . _Default + . _Coerce + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#accountUserProfilesListResponse\". +aupflrKind :: Lens' AccountUserProFilesListResponse Text +aupflrKind + = lens _aupflrKind (\ s a -> s{_aupflrKind = a}) + +instance FromJSON AccountUserProFilesListResponse + where + parseJSON + = withObject "AccountUserProFilesListResponse" + (\ o -> + AccountUserProFilesListResponse' <$> + (o .:? "nextPageToken") <*> + (o .:? "accountUserProfiles" .!= mempty) + <*> + (o .:? "kind" .!= + "dfareporting#accountUserProfilesListResponse")) + +instance ToJSON AccountUserProFilesListResponse where + toJSON AccountUserProFilesListResponse'{..} + = object + (catMaybes + [("nextPageToken" .=) <$> _aupflrNextPageToken, + ("accountUserProfiles" .=) <$> + _aupflrAccountUserProFiles, + Just ("kind" .= _aupflrKind)]) + +-- | Organizes placements according to the contents of their associated +-- webpages. +-- +-- /See:/ 'contentCategory' smart constructor. +data ContentCategory = + ContentCategory' + { _conKind :: !Text + , _conAccountId :: !(Maybe (Textual Int64)) + , _conName :: !(Maybe Text) + , _conId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ContentCategory' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'conKind' +-- +-- * 'conAccountId' +-- +-- * 'conName' +-- +-- * 'conId' +contentCategory + :: ContentCategory +contentCategory = + ContentCategory' + { _conKind = "dfareporting#contentCategory" + , _conAccountId = Nothing + , _conName = Nothing + , _conId = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#contentCategory\". +conKind :: Lens' ContentCategory Text +conKind = lens _conKind (\ s a -> s{_conKind = a}) + +-- | Account ID of this content category. This is a read-only field that can +-- be left blank. +conAccountId :: Lens' ContentCategory (Maybe Int64) +conAccountId + = lens _conAccountId (\ s a -> s{_conAccountId = a}) + . mapping _Coerce + +-- | Name of this content category. This is a required field and must be less +-- than 256 characters long and unique among content categories of the same +-- account. +conName :: Lens' ContentCategory (Maybe Text) +conName = lens _conName (\ s a -> s{_conName = a}) + +-- | ID of this content category. This is a read-only, auto-generated field. +conId :: Lens' ContentCategory (Maybe Int64) +conId + = lens _conId (\ s a -> s{_conId = a}) . + mapping _Coerce + +instance FromJSON ContentCategory where + parseJSON + = withObject "ContentCategory" + (\ o -> + ContentCategory' <$> + (o .:? "kind" .!= "dfareporting#contentCategory") <*> + (o .:? "accountId") + <*> (o .:? "name") + <*> (o .:? "id")) + +instance ToJSON ContentCategory where + toJSON ContentCategory'{..} + = object + (catMaybes + [Just ("kind" .= _conKind), + ("accountId" .=) <$> _conAccountId, + ("name" .=) <$> _conName, ("id" .=) <$> _conId]) + +-- | Represents fields that are compatible to be selected for a report of +-- type \"STANDARD\". +-- +-- /See:/ 'reportCompatibleFields' smart constructor. +data ReportCompatibleFields = + ReportCompatibleFields' + { _rcfMetrics :: !(Maybe [Metric]) + , _rcfKind :: !Text + , _rcfDimensionFilters :: !(Maybe [Dimension]) + , _rcfPivotedActivityMetrics :: !(Maybe [Metric]) + , _rcfDimensions :: !(Maybe [Dimension]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ReportCompatibleFields' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'rcfMetrics' +-- +-- * 'rcfKind' +-- +-- * 'rcfDimensionFilters' +-- +-- * 'rcfPivotedActivityMetrics' +-- +-- * 'rcfDimensions' +reportCompatibleFields + :: ReportCompatibleFields +reportCompatibleFields = + ReportCompatibleFields' + { _rcfMetrics = Nothing + , _rcfKind = "dfareporting#reportCompatibleFields" + , _rcfDimensionFilters = Nothing + , _rcfPivotedActivityMetrics = Nothing + , _rcfDimensions = Nothing + } + + +-- | Metrics which are compatible to be selected in the \"metricNames\" +-- section of the report. +rcfMetrics :: Lens' ReportCompatibleFields [Metric] +rcfMetrics + = lens _rcfMetrics (\ s a -> s{_rcfMetrics = a}) . + _Default + . _Coerce + +-- | The kind of resource this is, in this case +-- dfareporting#reportCompatibleFields. +rcfKind :: Lens' ReportCompatibleFields Text +rcfKind = lens _rcfKind (\ s a -> s{_rcfKind = a}) + +-- | Dimensions which are compatible to be selected in the +-- \"dimensionFilters\" section of the report. +rcfDimensionFilters :: Lens' ReportCompatibleFields [Dimension] +rcfDimensionFilters + = lens _rcfDimensionFilters + (\ s a -> s{_rcfDimensionFilters = a}) + . _Default + . _Coerce + +-- | Metrics which are compatible to be selected as activity metrics to pivot +-- on in the \"activities\" section of the report. +rcfPivotedActivityMetrics :: Lens' ReportCompatibleFields [Metric] +rcfPivotedActivityMetrics + = lens _rcfPivotedActivityMetrics + (\ s a -> s{_rcfPivotedActivityMetrics = a}) + . _Default + . _Coerce + +-- | Dimensions which are compatible to be selected in the \"dimensions\" +-- section of the report. +rcfDimensions :: Lens' ReportCompatibleFields [Dimension] +rcfDimensions + = lens _rcfDimensions + (\ s a -> s{_rcfDimensions = a}) + . _Default + . _Coerce + +instance FromJSON ReportCompatibleFields where + parseJSON + = withObject "ReportCompatibleFields" + (\ o -> + ReportCompatibleFields' <$> + (o .:? "metrics" .!= mempty) <*> + (o .:? "kind" .!= + "dfareporting#reportCompatibleFields") + <*> (o .:? "dimensionFilters" .!= mempty) + <*> (o .:? "pivotedActivityMetrics" .!= mempty) + <*> (o .:? "dimensions" .!= mempty)) + +instance ToJSON ReportCompatibleFields where + toJSON ReportCompatibleFields'{..} + = object + (catMaybes + [("metrics" .=) <$> _rcfMetrics, + Just ("kind" .= _rcfKind), + ("dimensionFilters" .=) <$> _rcfDimensionFilters, + ("pivotedActivityMetrics" .=) <$> + _rcfPivotedActivityMetrics, + ("dimensions" .=) <$> _rcfDimensions]) + +-- | Delivery Schedule. +-- +-- /See:/ 'deliverySchedule' smart constructor. +data DeliverySchedule = + DeliverySchedule' + { _dsHardCutoff :: !(Maybe Bool) + , _dsPriority :: !(Maybe DeliverySchedulePriority) + , _dsImpressionRatio :: !(Maybe (Textual Int64)) + , _dsFrequencyCap :: !(Maybe FrequencyCap) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'DeliverySchedule' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'dsHardCutoff' +-- +-- * 'dsPriority' +-- +-- * 'dsImpressionRatio' +-- +-- * 'dsFrequencyCap' +deliverySchedule + :: DeliverySchedule +deliverySchedule = + DeliverySchedule' + { _dsHardCutoff = Nothing + , _dsPriority = Nothing + , _dsImpressionRatio = Nothing + , _dsFrequencyCap = Nothing + } + + +-- | Whether or not hard cutoff is enabled. If true, the ad will not serve +-- after the end date and time. Otherwise the ad will continue to be served +-- until it has reached its delivery goals. +dsHardCutoff :: Lens' DeliverySchedule (Maybe Bool) +dsHardCutoff + = lens _dsHardCutoff (\ s a -> s{_dsHardCutoff = a}) + +-- | Serving priority of an ad, with respect to other ads. The lower the +-- priority number, the greater the priority with which it is served. +dsPriority :: Lens' DeliverySchedule (Maybe DeliverySchedulePriority) +dsPriority + = lens _dsPriority (\ s a -> s{_dsPriority = a}) + +-- | Impression ratio for this ad. This ratio determines how often each ad is +-- served relative to the others. For example, if ad A has an impression +-- ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager +-- will serve ad B three times as often as ad A. Acceptable values are 1 to +-- 10, inclusive. +dsImpressionRatio :: Lens' DeliverySchedule (Maybe Int64) +dsImpressionRatio + = lens _dsImpressionRatio + (\ s a -> s{_dsImpressionRatio = a}) + . mapping _Coerce + +-- | Limit on the number of times an individual user can be served the ad +-- within a specified period of time. +dsFrequencyCap :: Lens' DeliverySchedule (Maybe FrequencyCap) +dsFrequencyCap + = lens _dsFrequencyCap + (\ s a -> s{_dsFrequencyCap = a}) + +instance FromJSON DeliverySchedule where + parseJSON + = withObject "DeliverySchedule" + (\ o -> + DeliverySchedule' <$> + (o .:? "hardCutoff") <*> (o .:? "priority") <*> + (o .:? "impressionRatio") + <*> (o .:? "frequencyCap")) + +instance ToJSON DeliverySchedule where + toJSON DeliverySchedule'{..} + = object + (catMaybes + [("hardCutoff" .=) <$> _dsHardCutoff, + ("priority" .=) <$> _dsPriority, + ("impressionRatio" .=) <$> _dsImpressionRatio, + ("frequencyCap" .=) <$> _dsFrequencyCap]) + +-- | Contains properties of a remarketing list. Remarketing enables you to +-- create lists of users who have performed specific actions on a site, +-- then target ads to members of those lists. This resource can be used to +-- manage remarketing lists that are owned by your advertisers. To see all +-- remarketing lists that are visible to your advertisers, including those +-- that are shared to your advertiser or account, use the +-- TargetableRemarketingLists resource. +-- +-- /See:/ 'remarketingList' smart constructor. +data RemarketingList = + RemarketingList' + { _rlListSize :: !(Maybe (Textual Int64)) + , _rlListPopulationRule :: !(Maybe ListPopulationRule) + , _rlLifeSpan :: !(Maybe (Textual Int64)) + , _rlKind :: !Text + , _rlAdvertiserId :: !(Maybe (Textual Int64)) + , _rlAdvertiserIdDimensionValue :: !(Maybe DimensionValue) + , _rlActive :: !(Maybe Bool) + , _rlAccountId :: !(Maybe (Textual Int64)) + , _rlName :: !(Maybe Text) + , _rlListSource :: !(Maybe RemarketingListListSource) + , _rlId :: !(Maybe (Textual Int64)) + , _rlSubAccountId :: !(Maybe (Textual Int64)) + , _rlDescription :: !(Maybe Text) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'RemarketingList' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'rlListSize' +-- +-- * 'rlListPopulationRule' +-- +-- * 'rlLifeSpan' +-- +-- * 'rlKind' +-- +-- * 'rlAdvertiserId' +-- +-- * 'rlAdvertiserIdDimensionValue' +-- +-- * 'rlActive' +-- +-- * 'rlAccountId' +-- +-- * 'rlName' +-- +-- * 'rlListSource' +-- +-- * 'rlId' +-- +-- * 'rlSubAccountId' +-- +-- * 'rlDescription' +remarketingList + :: RemarketingList +remarketingList = + RemarketingList' + { _rlListSize = Nothing + , _rlListPopulationRule = Nothing + , _rlLifeSpan = Nothing + , _rlKind = "dfareporting#remarketingList" + , _rlAdvertiserId = Nothing + , _rlAdvertiserIdDimensionValue = Nothing + , _rlActive = Nothing + , _rlAccountId = Nothing + , _rlName = Nothing + , _rlListSource = Nothing + , _rlId = Nothing + , _rlSubAccountId = Nothing + , _rlDescription = Nothing + } + + +-- | Number of users currently in the list. This is a read-only field. +rlListSize :: Lens' RemarketingList (Maybe Int64) +rlListSize + = lens _rlListSize (\ s a -> s{_rlListSize = a}) . + mapping _Coerce + +-- | Rule used to populate the remarketing list with users. +rlListPopulationRule :: Lens' RemarketingList (Maybe ListPopulationRule) +rlListPopulationRule + = lens _rlListPopulationRule + (\ s a -> s{_rlListPopulationRule = a}) + +-- | Number of days that a user should remain in the remarketing list without +-- an impression. Acceptable values are 1 to 540, inclusive. +rlLifeSpan :: Lens' RemarketingList (Maybe Int64) +rlLifeSpan + = lens _rlLifeSpan (\ s a -> s{_rlLifeSpan = a}) . + mapping _Coerce + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#remarketingList\". +rlKind :: Lens' RemarketingList Text +rlKind = lens _rlKind (\ s a -> s{_rlKind = a}) + +-- | Dimension value for the advertiser ID that owns this remarketing list. +-- This is a required field. +rlAdvertiserId :: Lens' RemarketingList (Maybe Int64) +rlAdvertiserId + = lens _rlAdvertiserId + (\ s a -> s{_rlAdvertiserId = a}) + . mapping _Coerce + +-- | Dimension value for the ID of the advertiser. This is a read-only, +-- auto-generated field. +rlAdvertiserIdDimensionValue :: Lens' RemarketingList (Maybe DimensionValue) +rlAdvertiserIdDimensionValue + = lens _rlAdvertiserIdDimensionValue + (\ s a -> s{_rlAdvertiserIdDimensionValue = a}) + +-- | Whether this remarketing list is active. +rlActive :: Lens' RemarketingList (Maybe Bool) +rlActive = lens _rlActive (\ s a -> s{_rlActive = a}) + +-- | Account ID of this remarketing list. This is a read-only, auto-generated +-- field that is only returned in GET requests. +rlAccountId :: Lens' RemarketingList (Maybe Int64) +rlAccountId + = lens _rlAccountId (\ s a -> s{_rlAccountId = a}) . + mapping _Coerce + +-- | Name of the remarketing list. This is a required field. Must be no +-- greater than 128 characters long. +rlName :: Lens' RemarketingList (Maybe Text) +rlName = lens _rlName (\ s a -> s{_rlName = a}) + +-- | Product from which this remarketing list was originated. +rlListSource :: Lens' RemarketingList (Maybe RemarketingListListSource) +rlListSource + = lens _rlListSource (\ s a -> s{_rlListSource = a}) + +-- | Remarketing list ID. This is a read-only, auto-generated field. +rlId :: Lens' RemarketingList (Maybe Int64) +rlId + = lens _rlId (\ s a -> s{_rlId = a}) . + mapping _Coerce + +-- | Subaccount ID of this remarketing list. This is a read-only, +-- auto-generated field that is only returned in GET requests. +rlSubAccountId :: Lens' RemarketingList (Maybe Int64) +rlSubAccountId + = lens _rlSubAccountId + (\ s a -> s{_rlSubAccountId = a}) + . mapping _Coerce + +-- | Remarketing list description. +rlDescription :: Lens' RemarketingList (Maybe Text) +rlDescription + = lens _rlDescription + (\ s a -> s{_rlDescription = a}) + +instance FromJSON RemarketingList where + parseJSON + = withObject "RemarketingList" + (\ o -> + RemarketingList' <$> + (o .:? "listSize") <*> (o .:? "listPopulationRule") + <*> (o .:? "lifeSpan") + <*> (o .:? "kind" .!= "dfareporting#remarketingList") + <*> (o .:? "advertiserId") + <*> (o .:? "advertiserIdDimensionValue") + <*> (o .:? "active") + <*> (o .:? "accountId") + <*> (o .:? "name") + <*> (o .:? "listSource") + <*> (o .:? "id") + <*> (o .:? "subaccountId") + <*> (o .:? "description")) + +instance ToJSON RemarketingList where + toJSON RemarketingList'{..} + = object + (catMaybes + [("listSize" .=) <$> _rlListSize, + ("listPopulationRule" .=) <$> _rlListPopulationRule, + ("lifeSpan" .=) <$> _rlLifeSpan, + Just ("kind" .= _rlKind), + ("advertiserId" .=) <$> _rlAdvertiserId, + ("advertiserIdDimensionValue" .=) <$> + _rlAdvertiserIdDimensionValue, + ("active" .=) <$> _rlActive, + ("accountId" .=) <$> _rlAccountId, + ("name" .=) <$> _rlName, + ("listSource" .=) <$> _rlListSource, + ("id" .=) <$> _rlId, + ("subaccountId" .=) <$> _rlSubAccountId, + ("description" .=) <$> _rlDescription]) + +-- | Dynamic Targeting Key List Response +-- +-- /See:/ 'dynamicTargetingKeysListResponse' smart constructor. +data DynamicTargetingKeysListResponse = + DynamicTargetingKeysListResponse' + { _dtklrKind :: !Text + , _dtklrDynamicTargetingKeys :: !(Maybe [DynamicTargetingKey]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'DynamicTargetingKeysListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'dtklrKind' +-- +-- * 'dtklrDynamicTargetingKeys' +dynamicTargetingKeysListResponse + :: DynamicTargetingKeysListResponse +dynamicTargetingKeysListResponse = + DynamicTargetingKeysListResponse' + { _dtklrKind = "dfareporting#dynamicTargetingKeysListResponse" + , _dtklrDynamicTargetingKeys = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#dynamicTargetingKeysListResponse\". +dtklrKind :: Lens' DynamicTargetingKeysListResponse Text +dtklrKind + = lens _dtklrKind (\ s a -> s{_dtklrKind = a}) + +-- | Dynamic targeting key collection. +dtklrDynamicTargetingKeys :: Lens' DynamicTargetingKeysListResponse [DynamicTargetingKey] +dtklrDynamicTargetingKeys + = lens _dtklrDynamicTargetingKeys + (\ s a -> s{_dtklrDynamicTargetingKeys = a}) + . _Default + . _Coerce + +instance FromJSON DynamicTargetingKeysListResponse + where + parseJSON + = withObject "DynamicTargetingKeysListResponse" + (\ o -> + DynamicTargetingKeysListResponse' <$> + (o .:? "kind" .!= + "dfareporting#dynamicTargetingKeysListResponse") + <*> (o .:? "dynamicTargetingKeys" .!= mempty)) + +instance ToJSON DynamicTargetingKeysListResponse + where + toJSON DynamicTargetingKeysListResponse'{..} + = object + (catMaybes + [Just ("kind" .= _dtklrKind), + ("dynamicTargetingKeys" .=) <$> + _dtklrDynamicTargetingKeys]) + +-- | Represents the list of DimensionValue resources. +-- +-- /See:/ 'dimensionValueList' smart constructor. +data DimensionValueList = + DimensionValueList' + { _dvlEtag :: !(Maybe Text) + , _dvlNextPageToken :: !(Maybe Text) + , _dvlKind :: !Text + , _dvlItems :: !(Maybe [DimensionValue]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'DimensionValueList' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'dvlEtag' +-- +-- * 'dvlNextPageToken' +-- +-- * 'dvlKind' +-- +-- * 'dvlItems' +dimensionValueList + :: DimensionValueList +dimensionValueList = + DimensionValueList' + { _dvlEtag = Nothing + , _dvlNextPageToken = Nothing + , _dvlKind = "dfareporting#dimensionValueList" + , _dvlItems = Nothing + } + + +-- | The eTag of this response for caching purposes. +dvlEtag :: Lens' DimensionValueList (Maybe Text) +dvlEtag = lens _dvlEtag (\ s a -> s{_dvlEtag = a}) + +-- | Continuation token used to page through dimension values. To retrieve +-- the next page of results, set the next request\'s \"pageToken\" to the +-- value of this field. The page token is only valid for a limited amount +-- of time and should not be persisted. +dvlNextPageToken :: Lens' DimensionValueList (Maybe Text) +dvlNextPageToken + = lens _dvlNextPageToken + (\ s a -> s{_dvlNextPageToken = a}) + +-- | The kind of list this is, in this case dfareporting#dimensionValueList. +dvlKind :: Lens' DimensionValueList Text +dvlKind = lens _dvlKind (\ s a -> s{_dvlKind = a}) + +-- | The dimension values returned in this response. +dvlItems :: Lens' DimensionValueList [DimensionValue] +dvlItems + = lens _dvlItems (\ s a -> s{_dvlItems = a}) . + _Default + . _Coerce + +instance FromJSON DimensionValueList where + parseJSON + = withObject "DimensionValueList" + (\ o -> + DimensionValueList' <$> + (o .:? "etag") <*> (o .:? "nextPageToken") <*> + (o .:? "kind" .!= "dfareporting#dimensionValueList") + <*> (o .:? "items" .!= mempty)) + +instance ToJSON DimensionValueList where + toJSON DimensionValueList'{..} + = object + (catMaybes + [("etag" .=) <$> _dvlEtag, + ("nextPageToken" .=) <$> _dvlNextPageToken, + Just ("kind" .= _dvlKind), + ("items" .=) <$> _dvlItems]) + +-- | Represents fields that are compatible to be selected for a report of +-- type \"FlOODLIGHT\". +-- +-- /See:/ 'floodlightReportCompatibleFields' smart constructor. +data FloodlightReportCompatibleFields = + FloodlightReportCompatibleFields' + { _frcfMetrics :: !(Maybe [Metric]) + , _frcfKind :: !Text + , _frcfDimensionFilters :: !(Maybe [Dimension]) + , _frcfDimensions :: !(Maybe [Dimension]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'FloodlightReportCompatibleFields' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'frcfMetrics' +-- +-- * 'frcfKind' +-- +-- * 'frcfDimensionFilters' +-- +-- * 'frcfDimensions' +floodlightReportCompatibleFields + :: FloodlightReportCompatibleFields +floodlightReportCompatibleFields = + FloodlightReportCompatibleFields' + { _frcfMetrics = Nothing + , _frcfKind = "dfareporting#floodlightReportCompatibleFields" + , _frcfDimensionFilters = Nothing + , _frcfDimensions = Nothing + } + + +-- | Metrics which are compatible to be selected in the \"metricNames\" +-- section of the report. +frcfMetrics :: Lens' FloodlightReportCompatibleFields [Metric] +frcfMetrics + = lens _frcfMetrics (\ s a -> s{_frcfMetrics = a}) . + _Default + . _Coerce + +-- | The kind of resource this is, in this case +-- dfareporting#floodlightReportCompatibleFields. +frcfKind :: Lens' FloodlightReportCompatibleFields Text +frcfKind = lens _frcfKind (\ s a -> s{_frcfKind = a}) + +-- | Dimensions which are compatible to be selected in the +-- \"dimensionFilters\" section of the report. +frcfDimensionFilters :: Lens' FloodlightReportCompatibleFields [Dimension] +frcfDimensionFilters + = lens _frcfDimensionFilters + (\ s a -> s{_frcfDimensionFilters = a}) + . _Default + . _Coerce + +-- | Dimensions which are compatible to be selected in the \"dimensions\" +-- section of the report. +frcfDimensions :: Lens' FloodlightReportCompatibleFields [Dimension] +frcfDimensions + = lens _frcfDimensions + (\ s a -> s{_frcfDimensions = a}) + . _Default + . _Coerce + +instance FromJSON FloodlightReportCompatibleFields + where + parseJSON + = withObject "FloodlightReportCompatibleFields" + (\ o -> + FloodlightReportCompatibleFields' <$> + (o .:? "metrics" .!= mempty) <*> + (o .:? "kind" .!= + "dfareporting#floodlightReportCompatibleFields") + <*> (o .:? "dimensionFilters" .!= mempty) + <*> (o .:? "dimensions" .!= mempty)) + +instance ToJSON FloodlightReportCompatibleFields + where + toJSON FloodlightReportCompatibleFields'{..} + = object + (catMaybes + [("metrics" .=) <$> _frcfMetrics, + Just ("kind" .= _frcfKind), + ("dimensionFilters" .=) <$> _frcfDimensionFilters, + ("dimensions" .=) <$> _frcfDimensions]) + +-- | Represents a grouping of related user role permissions. +-- +-- /See:/ 'userRolePermissionGroup' smart constructor. +data UserRolePermissionGroup = + UserRolePermissionGroup' + { _urpgKind :: !Text + , _urpgName :: !(Maybe Text) + , _urpgId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'UserRolePermissionGroup' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'urpgKind' +-- +-- * 'urpgName' +-- +-- * 'urpgId' +userRolePermissionGroup + :: UserRolePermissionGroup +userRolePermissionGroup = + UserRolePermissionGroup' + { _urpgKind = "dfareporting#userRolePermissionGroup" + , _urpgName = Nothing + , _urpgId = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#userRolePermissionGroup\". +urpgKind :: Lens' UserRolePermissionGroup Text +urpgKind = lens _urpgKind (\ s a -> s{_urpgKind = a}) + +-- | Name of this user role permission group. +urpgName :: Lens' UserRolePermissionGroup (Maybe Text) +urpgName = lens _urpgName (\ s a -> s{_urpgName = a}) + +-- | ID of this user role permission. +urpgId :: Lens' UserRolePermissionGroup (Maybe Int64) +urpgId + = lens _urpgId (\ s a -> s{_urpgId = a}) . + mapping _Coerce + +instance FromJSON UserRolePermissionGroup where + parseJSON + = withObject "UserRolePermissionGroup" + (\ o -> + UserRolePermissionGroup' <$> + (o .:? "kind" .!= + "dfareporting#userRolePermissionGroup") + <*> (o .:? "name") + <*> (o .:? "id")) + +instance ToJSON UserRolePermissionGroup where + toJSON UserRolePermissionGroup'{..} + = object + (catMaybes + [Just ("kind" .= _urpgKind), + ("name" .=) <$> _urpgName, ("id" .=) <$> _urpgId]) + +-- | Tag Settings +-- +-- /See:/ 'tagSetting' smart constructor. +data TagSetting = + TagSetting' + { _tsKeywordOption :: !(Maybe TagSettingKeywordOption) + , _tsIncludeClickThroughURLs :: !(Maybe Bool) + , _tsIncludeClickTracking :: !(Maybe Bool) + , _tsAdditionalKeyValues :: !(Maybe Text) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'TagSetting' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'tsKeywordOption' +-- +-- * 'tsIncludeClickThroughURLs' +-- +-- * 'tsIncludeClickTracking' +-- +-- * 'tsAdditionalKeyValues' +tagSetting + :: TagSetting +tagSetting = + TagSetting' + { _tsKeywordOption = Nothing + , _tsIncludeClickThroughURLs = Nothing + , _tsIncludeClickTracking = Nothing + , _tsAdditionalKeyValues = Nothing + } + + +-- | Option specifying how keywords are embedded in ad tags. This setting can +-- be used to specify whether keyword placeholders are inserted in +-- placement tags for this site. Publishers can then add keywords to those +-- placeholders. +tsKeywordOption :: Lens' TagSetting (Maybe TagSettingKeywordOption) +tsKeywordOption + = lens _tsKeywordOption + (\ s a -> s{_tsKeywordOption = a}) + +-- | Whether static landing page URLs should be included in the tags. This +-- setting applies only to placements. +tsIncludeClickThroughURLs :: Lens' TagSetting (Maybe Bool) +tsIncludeClickThroughURLs + = lens _tsIncludeClickThroughURLs + (\ s a -> s{_tsIncludeClickThroughURLs = a}) + +-- | Whether click-tracking string should be included in the tags. +tsIncludeClickTracking :: Lens' TagSetting (Maybe Bool) +tsIncludeClickTracking + = lens _tsIncludeClickTracking + (\ s a -> s{_tsIncludeClickTracking = a}) + +-- | Additional key-values to be included in tags. Each key-value pair must +-- be of the form key=value, and pairs must be separated by a semicolon +-- (;). Keys and values must not contain commas. For example, +-- id=2;color=red is a valid value for this field. +tsAdditionalKeyValues :: Lens' TagSetting (Maybe Text) +tsAdditionalKeyValues + = lens _tsAdditionalKeyValues + (\ s a -> s{_tsAdditionalKeyValues = a}) + +instance FromJSON TagSetting where + parseJSON + = withObject "TagSetting" + (\ o -> + TagSetting' <$> + (o .:? "keywordOption") <*> + (o .:? "includeClickThroughUrls") + <*> (o .:? "includeClickTracking") + <*> (o .:? "additionalKeyValues")) + +instance ToJSON TagSetting where + toJSON TagSetting'{..} + = object + (catMaybes + [("keywordOption" .=) <$> _tsKeywordOption, + ("includeClickThroughUrls" .=) <$> + _tsIncludeClickThroughURLs, + ("includeClickTracking" .=) <$> + _tsIncludeClickTracking, + ("additionalKeyValues" .=) <$> + _tsAdditionalKeyValues]) + +-- | The properties of the report. +-- +-- /See:/ 'reportPathToConversionCriteriaReportProperties' smart constructor. +data ReportPathToConversionCriteriaReportProperties = + ReportPathToConversionCriteriaReportProperties' + { _rptccrpMaximumInteractionGap :: !(Maybe (Textual Int32)) + , _rptccrpMaximumClickInteractions :: !(Maybe (Textual Int32)) + , _rptccrpPivotOnInteractionPath :: !(Maybe Bool) + , _rptccrpMaximumImpressionInteractions :: !(Maybe (Textual Int32)) + , _rptccrpIncludeUnattributedIPConversions :: !(Maybe Bool) + , _rptccrpImpressionsLookbackWindow :: !(Maybe (Textual Int32)) + , _rptccrpClicksLookbackWindow :: !(Maybe (Textual Int32)) + , _rptccrpIncludeUnattributedCookieConversions :: !(Maybe Bool) + , _rptccrpIncludeAttributedIPConversions :: !(Maybe Bool) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ReportPathToConversionCriteriaReportProperties' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'rptccrpMaximumInteractionGap' +-- +-- * 'rptccrpMaximumClickInteractions' +-- +-- * 'rptccrpPivotOnInteractionPath' +-- +-- * 'rptccrpMaximumImpressionInteractions' +-- +-- * 'rptccrpIncludeUnattributedIPConversions' +-- +-- * 'rptccrpImpressionsLookbackWindow' +-- +-- * 'rptccrpClicksLookbackWindow' +-- +-- * 'rptccrpIncludeUnattributedCookieConversions' +-- +-- * 'rptccrpIncludeAttributedIPConversions' +reportPathToConversionCriteriaReportProperties + :: ReportPathToConversionCriteriaReportProperties +reportPathToConversionCriteriaReportProperties = + ReportPathToConversionCriteriaReportProperties' + { _rptccrpMaximumInteractionGap = Nothing + , _rptccrpMaximumClickInteractions = Nothing + , _rptccrpPivotOnInteractionPath = Nothing + , _rptccrpMaximumImpressionInteractions = Nothing + , _rptccrpIncludeUnattributedIPConversions = Nothing + , _rptccrpImpressionsLookbackWindow = Nothing + , _rptccrpClicksLookbackWindow = Nothing + , _rptccrpIncludeUnattributedCookieConversions = Nothing + , _rptccrpIncludeAttributedIPConversions = Nothing + } + + +-- | The maximum amount of time that can take place between interactions +-- (clicks or impressions) by the same user. Valid values: 1-90. +rptccrpMaximumInteractionGap :: Lens' ReportPathToConversionCriteriaReportProperties (Maybe Int32) +rptccrpMaximumInteractionGap + = lens _rptccrpMaximumInteractionGap + (\ s a -> s{_rptccrpMaximumInteractionGap = a}) + . mapping _Coerce + +-- | The maximum number of click interactions to include in the report. +-- Advertisers currently paying for E2C reports get up to 200 (100 clicks, +-- 100 impressions). If another advertiser in your network is paying for +-- E2C, you can have up to 5 total exposures per report. +rptccrpMaximumClickInteractions :: Lens' ReportPathToConversionCriteriaReportProperties (Maybe Int32) +rptccrpMaximumClickInteractions + = lens _rptccrpMaximumClickInteractions + (\ s a -> s{_rptccrpMaximumClickInteractions = a}) + . mapping _Coerce + +-- | Enable pivoting on interaction path. +rptccrpPivotOnInteractionPath :: Lens' ReportPathToConversionCriteriaReportProperties (Maybe Bool) +rptccrpPivotOnInteractionPath + = lens _rptccrpPivotOnInteractionPath + (\ s a -> s{_rptccrpPivotOnInteractionPath = a}) + +-- | The maximum number of click interactions to include in the report. +-- Advertisers currently paying for E2C reports get up to 200 (100 clicks, +-- 100 impressions). If another advertiser in your network is paying for +-- E2C, you can have up to 5 total exposures per report. +rptccrpMaximumImpressionInteractions :: Lens' ReportPathToConversionCriteriaReportProperties (Maybe Int32) +rptccrpMaximumImpressionInteractions + = lens _rptccrpMaximumImpressionInteractions + (\ s a -> + s{_rptccrpMaximumImpressionInteractions = a}) + . mapping _Coerce + +-- | Include conversions that have no associated cookies and no exposures. +-- It’s therefore impossible to know how the user was exposed to your ads +-- during the lookback window prior to a conversion. +rptccrpIncludeUnattributedIPConversions :: Lens' ReportPathToConversionCriteriaReportProperties (Maybe Bool) +rptccrpIncludeUnattributedIPConversions + = lens _rptccrpIncludeUnattributedIPConversions + (\ s a -> + s{_rptccrpIncludeUnattributedIPConversions = a}) + +-- | DFA checks to see if an impression interaction occurred within the +-- specified period of time before a conversion. By default the value is +-- pulled from Floodlight or you can manually enter a custom value. Valid +-- values: 1-90. +rptccrpImpressionsLookbackWindow :: Lens' ReportPathToConversionCriteriaReportProperties (Maybe Int32) +rptccrpImpressionsLookbackWindow + = lens _rptccrpImpressionsLookbackWindow + (\ s a -> s{_rptccrpImpressionsLookbackWindow = a}) + . mapping _Coerce + +-- | DFA checks to see if a click interaction occurred within the specified +-- period of time before a conversion. By default the value is pulled from +-- Floodlight or you can manually enter a custom value. Valid values: 1-90. +rptccrpClicksLookbackWindow :: Lens' ReportPathToConversionCriteriaReportProperties (Maybe Int32) +rptccrpClicksLookbackWindow + = lens _rptccrpClicksLookbackWindow + (\ s a -> s{_rptccrpClicksLookbackWindow = a}) + . mapping _Coerce + +-- | Include conversions of users with a DoubleClick cookie but without an +-- exposure. That means the user did not click or see an ad from the +-- advertiser within the Floodlight group, or that the interaction happened +-- outside the lookback window. +rptccrpIncludeUnattributedCookieConversions :: Lens' ReportPathToConversionCriteriaReportProperties (Maybe Bool) +rptccrpIncludeUnattributedCookieConversions + = lens _rptccrpIncludeUnattributedCookieConversions + (\ s a -> + s{_rptccrpIncludeUnattributedCookieConversions = a}) + +-- | Deprecated: has no effect. +rptccrpIncludeAttributedIPConversions :: Lens' ReportPathToConversionCriteriaReportProperties (Maybe Bool) +rptccrpIncludeAttributedIPConversions + = lens _rptccrpIncludeAttributedIPConversions + (\ s a -> + s{_rptccrpIncludeAttributedIPConversions = a}) + +instance FromJSON + ReportPathToConversionCriteriaReportProperties + where + parseJSON + = withObject + "ReportPathToConversionCriteriaReportProperties" + (\ o -> + ReportPathToConversionCriteriaReportProperties' <$> + (o .:? "maximumInteractionGap") <*> + (o .:? "maximumClickInteractions") + <*> (o .:? "pivotOnInteractionPath") + <*> (o .:? "maximumImpressionInteractions") + <*> (o .:? "includeUnattributedIPConversions") + <*> (o .:? "impressionsLookbackWindow") + <*> (o .:? "clicksLookbackWindow") + <*> (o .:? "includeUnattributedCookieConversions") + <*> (o .:? "includeAttributedIPConversions")) + +instance ToJSON + ReportPathToConversionCriteriaReportProperties + where + toJSON + ReportPathToConversionCriteriaReportProperties'{..} + = object + (catMaybes + [("maximumInteractionGap" .=) <$> + _rptccrpMaximumInteractionGap, + ("maximumClickInteractions" .=) <$> + _rptccrpMaximumClickInteractions, + ("pivotOnInteractionPath" .=) <$> + _rptccrpPivotOnInteractionPath, + ("maximumImpressionInteractions" .=) <$> + _rptccrpMaximumImpressionInteractions, + ("includeUnattributedIPConversions" .=) <$> + _rptccrpIncludeUnattributedIPConversions, + ("impressionsLookbackWindow" .=) <$> + _rptccrpImpressionsLookbackWindow, + ("clicksLookbackWindow" .=) <$> + _rptccrpClicksLookbackWindow, + ("includeUnattributedCookieConversions" .=) <$> + _rptccrpIncludeUnattributedCookieConversions, + ("includeAttributedIPConversions" .=) <$> + _rptccrpIncludeAttributedIPConversions]) + +-- | User Role Permission List Response +-- +-- /See:/ 'userRolePermissionsListResponse' smart constructor. +data UserRolePermissionsListResponse = + UserRolePermissionsListResponse' + { _urplrKind :: !Text + , _urplrUserRolePermissions :: !(Maybe [UserRolePermission]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'UserRolePermissionsListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'urplrKind' +-- +-- * 'urplrUserRolePermissions' +userRolePermissionsListResponse + :: UserRolePermissionsListResponse +userRolePermissionsListResponse = + UserRolePermissionsListResponse' + { _urplrKind = "dfareporting#userRolePermissionsListResponse" + , _urplrUserRolePermissions = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#userRolePermissionsListResponse\". +urplrKind :: Lens' UserRolePermissionsListResponse Text +urplrKind + = lens _urplrKind (\ s a -> s{_urplrKind = a}) + +-- | User role permission collection. +urplrUserRolePermissions :: Lens' UserRolePermissionsListResponse [UserRolePermission] +urplrUserRolePermissions + = lens _urplrUserRolePermissions + (\ s a -> s{_urplrUserRolePermissions = a}) + . _Default + . _Coerce + +instance FromJSON UserRolePermissionsListResponse + where + parseJSON + = withObject "UserRolePermissionsListResponse" + (\ o -> + UserRolePermissionsListResponse' <$> + (o .:? "kind" .!= + "dfareporting#userRolePermissionsListResponse") + <*> (o .:? "userRolePermissions" .!= mempty)) + +instance ToJSON UserRolePermissionsListResponse where + toJSON UserRolePermissionsListResponse'{..} + = object + (catMaybes + [Just ("kind" .= _urplrKind), + ("userRolePermissions" .=) <$> + _urplrUserRolePermissions]) + +-- | Placement Group List Response +-- +-- /See:/ 'placementGroupsListResponse' smart constructor. +data PlacementGroupsListResponse = + PlacementGroupsListResponse' + { _pglrNextPageToken :: !(Maybe Text) + , _pglrKind :: !Text + , _pglrPlacementGroups :: !(Maybe [PlacementGroup]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'PlacementGroupsListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'pglrNextPageToken' +-- +-- * 'pglrKind' +-- +-- * 'pglrPlacementGroups' +placementGroupsListResponse + :: PlacementGroupsListResponse +placementGroupsListResponse = + PlacementGroupsListResponse' + { _pglrNextPageToken = Nothing + , _pglrKind = "dfareporting#placementGroupsListResponse" + , _pglrPlacementGroups = Nothing + } + + +-- | Pagination token to be used for the next list operation. +pglrNextPageToken :: Lens' PlacementGroupsListResponse (Maybe Text) +pglrNextPageToken + = lens _pglrNextPageToken + (\ s a -> s{_pglrNextPageToken = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#placementGroupsListResponse\". +pglrKind :: Lens' PlacementGroupsListResponse Text +pglrKind = lens _pglrKind (\ s a -> s{_pglrKind = a}) + +-- | Placement group collection. +pglrPlacementGroups :: Lens' PlacementGroupsListResponse [PlacementGroup] +pglrPlacementGroups + = lens _pglrPlacementGroups + (\ s a -> s{_pglrPlacementGroups = a}) + . _Default + . _Coerce + +instance FromJSON PlacementGroupsListResponse where + parseJSON + = withObject "PlacementGroupsListResponse" + (\ o -> + PlacementGroupsListResponse' <$> + (o .:? "nextPageToken") <*> + (o .:? "kind" .!= + "dfareporting#placementGroupsListResponse") + <*> (o .:? "placementGroups" .!= mempty)) + +instance ToJSON PlacementGroupsListResponse where + toJSON PlacementGroupsListResponse'{..} + = object + (catMaybes + [("nextPageToken" .=) <$> _pglrNextPageToken, + Just ("kind" .= _pglrKind), + ("placementGroups" .=) <$> _pglrPlacementGroups]) + +-- | Contains information about a mobile carrier that can be targeted by ads. +-- +-- /See:/ 'mobileCarrier' smart constructor. +data MobileCarrier = + MobileCarrier' + { _mcKind :: !Text + , _mcName :: !(Maybe Text) + , _mcCountryCode :: !(Maybe Text) + , _mcId :: !(Maybe (Textual Int64)) + , _mcCountryDartId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'MobileCarrier' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'mcKind' +-- +-- * 'mcName' +-- +-- * 'mcCountryCode' +-- +-- * 'mcId' +-- +-- * 'mcCountryDartId' +mobileCarrier + :: MobileCarrier +mobileCarrier = + MobileCarrier' + { _mcKind = "dfareporting#mobileCarrier" + , _mcName = Nothing + , _mcCountryCode = Nothing + , _mcId = Nothing + , _mcCountryDartId = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#mobileCarrier\". +mcKind :: Lens' MobileCarrier Text +mcKind = lens _mcKind (\ s a -> s{_mcKind = a}) + +-- | Name of this mobile carrier. +mcName :: Lens' MobileCarrier (Maybe Text) +mcName = lens _mcName (\ s a -> s{_mcName = a}) + +-- | Country code of the country to which this mobile carrier belongs. +mcCountryCode :: Lens' MobileCarrier (Maybe Text) +mcCountryCode + = lens _mcCountryCode + (\ s a -> s{_mcCountryCode = a}) + +-- | ID of this mobile carrier. +mcId :: Lens' MobileCarrier (Maybe Int64) +mcId + = lens _mcId (\ s a -> s{_mcId = a}) . + mapping _Coerce + +-- | DART ID of the country to which this mobile carrier belongs. +mcCountryDartId :: Lens' MobileCarrier (Maybe Int64) +mcCountryDartId + = lens _mcCountryDartId + (\ s a -> s{_mcCountryDartId = a}) + . mapping _Coerce + +instance FromJSON MobileCarrier where + parseJSON + = withObject "MobileCarrier" + (\ o -> + MobileCarrier' <$> + (o .:? "kind" .!= "dfareporting#mobileCarrier") <*> + (o .:? "name") + <*> (o .:? "countryCode") + <*> (o .:? "id") + <*> (o .:? "countryDartId")) + +instance ToJSON MobileCarrier where + toJSON MobileCarrier'{..} + = object + (catMaybes + [Just ("kind" .= _mcKind), ("name" .=) <$> _mcName, + ("countryCode" .=) <$> _mcCountryCode, + ("id" .=) <$> _mcId, + ("countryDartId" .=) <$> _mcCountryDartId]) + +-- | Contains information about where a user\'s browser is taken after the +-- user clicks an ad. +-- +-- /See:/ 'landingPage' smart constructor. +data LandingPage = + LandingPage' + { _lpKind :: !Text + , _lpAdvertiserId :: !(Maybe (Textual Int64)) + , _lpURL :: !(Maybe Text) + , _lpName :: !(Maybe Text) + , _lpDeepLinks :: !(Maybe [DeepLink]) + , _lpId :: !(Maybe (Textual Int64)) + , _lpArchived :: !(Maybe Bool) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'LandingPage' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'lpKind' +-- +-- * 'lpAdvertiserId' +-- +-- * 'lpURL' +-- +-- * 'lpName' +-- +-- * 'lpDeepLinks' +-- +-- * 'lpId' +-- +-- * 'lpArchived' +landingPage + :: LandingPage +landingPage = + LandingPage' + { _lpKind = "dfareporting#landingPage" + , _lpAdvertiserId = Nothing + , _lpURL = Nothing + , _lpName = Nothing + , _lpDeepLinks = Nothing + , _lpId = Nothing + , _lpArchived = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#landingPage\". +lpKind :: Lens' LandingPage Text +lpKind = lens _lpKind (\ s a -> s{_lpKind = a}) + +-- | Advertiser ID of this landing page. This is a required field. +lpAdvertiserId :: Lens' LandingPage (Maybe Int64) +lpAdvertiserId + = lens _lpAdvertiserId + (\ s a -> s{_lpAdvertiserId = a}) + . mapping _Coerce + +-- | URL of this landing page. This is a required field. +lpURL :: Lens' LandingPage (Maybe Text) +lpURL = lens _lpURL (\ s a -> s{_lpURL = a}) + +-- | Name of this landing page. This is a required field. It must be less +-- than 256 characters long. +lpName :: Lens' LandingPage (Maybe Text) +lpName = lens _lpName (\ s a -> s{_lpName = a}) + +-- | Links that will direct the user to a mobile app, if installed. +lpDeepLinks :: Lens' LandingPage [DeepLink] +lpDeepLinks + = lens _lpDeepLinks (\ s a -> s{_lpDeepLinks = a}) . + _Default + . _Coerce + +-- | ID of this landing page. This is a read-only, auto-generated field. +lpId :: Lens' LandingPage (Maybe Int64) +lpId + = lens _lpId (\ s a -> s{_lpId = a}) . + mapping _Coerce + +-- | Whether this landing page has been archived. +lpArchived :: Lens' LandingPage (Maybe Bool) +lpArchived + = lens _lpArchived (\ s a -> s{_lpArchived = a}) + +instance FromJSON LandingPage where + parseJSON + = withObject "LandingPage" + (\ o -> + LandingPage' <$> + (o .:? "kind" .!= "dfareporting#landingPage") <*> + (o .:? "advertiserId") + <*> (o .:? "url") + <*> (o .:? "name") + <*> (o .:? "deepLinks" .!= mempty) + <*> (o .:? "id") + <*> (o .:? "archived")) + +instance ToJSON LandingPage where + toJSON LandingPage'{..} + = object + (catMaybes + [Just ("kind" .= _lpKind), + ("advertiserId" .=) <$> _lpAdvertiserId, + ("url" .=) <$> _lpURL, ("name" .=) <$> _lpName, + ("deepLinks" .=) <$> _lpDeepLinks, + ("id" .=) <$> _lpId, + ("archived" .=) <$> _lpArchived]) + +-- | Connection Type List Response +-- +-- /See:/ 'connectionTypesListResponse' smart constructor. +data ConnectionTypesListResponse = + ConnectionTypesListResponse' + { _ctlrKind :: !Text + , _ctlrConnectionTypes :: !(Maybe [ConnectionType]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ConnectionTypesListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'ctlrKind' +-- +-- * 'ctlrConnectionTypes' +connectionTypesListResponse + :: ConnectionTypesListResponse +connectionTypesListResponse = + ConnectionTypesListResponse' + { _ctlrKind = "dfareporting#connectionTypesListResponse" + , _ctlrConnectionTypes = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#connectionTypesListResponse\". +ctlrKind :: Lens' ConnectionTypesListResponse Text +ctlrKind = lens _ctlrKind (\ s a -> s{_ctlrKind = a}) + +-- | Collection of connection types such as broadband and mobile. +ctlrConnectionTypes :: Lens' ConnectionTypesListResponse [ConnectionType] +ctlrConnectionTypes + = lens _ctlrConnectionTypes + (\ s a -> s{_ctlrConnectionTypes = a}) + . _Default + . _Coerce + +instance FromJSON ConnectionTypesListResponse where + parseJSON + = withObject "ConnectionTypesListResponse" + (\ o -> + ConnectionTypesListResponse' <$> + (o .:? "kind" .!= + "dfareporting#connectionTypesListResponse") + <*> (o .:? "connectionTypes" .!= mempty)) + +instance ToJSON ConnectionTypesListResponse where + toJSON ConnectionTypesListResponse'{..} + = object + (catMaybes + [Just ("kind" .= _ctlrKind), + ("connectionTypes" .=) <$> _ctlrConnectionTypes]) + +-- | Order List Response +-- +-- /See:/ 'ordersListResponse' smart constructor. +data OrdersListResponse = + OrdersListResponse' + { _olrNextPageToken :: !(Maybe Text) + , _olrKind :: !Text + , _olrOrders :: !(Maybe [Order]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'OrdersListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'olrNextPageToken' +-- +-- * 'olrKind' +-- +-- * 'olrOrders' +ordersListResponse + :: OrdersListResponse +ordersListResponse = + OrdersListResponse' + { _olrNextPageToken = Nothing + , _olrKind = "dfareporting#ordersListResponse" + , _olrOrders = Nothing + } + + +-- | Pagination token to be used for the next list operation. +olrNextPageToken :: Lens' OrdersListResponse (Maybe Text) +olrNextPageToken + = lens _olrNextPageToken + (\ s a -> s{_olrNextPageToken = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#ordersListResponse\". +olrKind :: Lens' OrdersListResponse Text +olrKind = lens _olrKind (\ s a -> s{_olrKind = a}) + +-- | Order collection. +olrOrders :: Lens' OrdersListResponse [Order] +olrOrders + = lens _olrOrders (\ s a -> s{_olrOrders = a}) . + _Default + . _Coerce + +instance FromJSON OrdersListResponse where + parseJSON + = withObject "OrdersListResponse" + (\ o -> + OrdersListResponse' <$> + (o .:? "nextPageToken") <*> + (o .:? "kind" .!= "dfareporting#ordersListResponse") + <*> (o .:? "orders" .!= mempty)) + +instance ToJSON OrdersListResponse where + toJSON OrdersListResponse'{..} + = object + (catMaybes + [("nextPageToken" .=) <$> _olrNextPageToken, + Just ("kind" .= _olrKind), + ("orders" .=) <$> _olrOrders]) + +-- | Represents the list of reports. +-- +-- /See:/ 'reportList' smart constructor. +data ReportList = + ReportList' + { _repEtag :: !(Maybe Text) + , _repNextPageToken :: !(Maybe Text) + , _repKind :: !Text + , _repItems :: !(Maybe [Report]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ReportList' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'repEtag' +-- +-- * 'repNextPageToken' +-- +-- * 'repKind' +-- +-- * 'repItems' +reportList + :: ReportList +reportList = + ReportList' + { _repEtag = Nothing + , _repNextPageToken = Nothing + , _repKind = "dfareporting#reportList" + , _repItems = Nothing + } + + +-- | The eTag of this response for caching purposes. +repEtag :: Lens' ReportList (Maybe Text) +repEtag = lens _repEtag (\ s a -> s{_repEtag = a}) + +-- | Continuation token used to page through reports. To retrieve the next +-- page of results, set the next request\'s \"pageToken\" to the value of +-- this field. The page token is only valid for a limited amount of time +-- and should not be persisted. +repNextPageToken :: Lens' ReportList (Maybe Text) +repNextPageToken + = lens _repNextPageToken + (\ s a -> s{_repNextPageToken = a}) + +-- | The kind of list this is, in this case dfareporting#reportList. +repKind :: Lens' ReportList Text +repKind = lens _repKind (\ s a -> s{_repKind = a}) + +-- | The reports returned in this response. +repItems :: Lens' ReportList [Report] +repItems + = lens _repItems (\ s a -> s{_repItems = a}) . + _Default + . _Coerce + +instance FromJSON ReportList where + parseJSON + = withObject "ReportList" + (\ o -> + ReportList' <$> + (o .:? "etag") <*> (o .:? "nextPageToken") <*> + (o .:? "kind" .!= "dfareporting#reportList") + <*> (o .:? "items" .!= mempty)) + +instance ToJSON ReportList where + toJSON ReportList'{..} + = object + (catMaybes + [("etag" .=) <$> _repEtag, + ("nextPageToken" .=) <$> _repNextPageToken, + Just ("kind" .= _repKind), + ("items" .=) <$> _repItems]) + +-- | Contains properties of a creative group. +-- +-- /See:/ 'creativeGroup' smart constructor. +data CreativeGroup = + CreativeGroup' + { _cgKind :: !Text + , _cgAdvertiserId :: !(Maybe (Textual Int64)) + , _cgAdvertiserIdDimensionValue :: !(Maybe DimensionValue) + , _cgGroupNumber :: !(Maybe (Textual Int32)) + , _cgAccountId :: !(Maybe (Textual Int64)) + , _cgName :: !(Maybe Text) + , _cgId :: !(Maybe (Textual Int64)) + , _cgSubAccountId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'CreativeGroup' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'cgKind' +-- +-- * 'cgAdvertiserId' +-- +-- * 'cgAdvertiserIdDimensionValue' +-- +-- * 'cgGroupNumber' +-- +-- * 'cgAccountId' +-- +-- * 'cgName' +-- +-- * 'cgId' +-- +-- * 'cgSubAccountId' +creativeGroup + :: CreativeGroup +creativeGroup = + CreativeGroup' + { _cgKind = "dfareporting#creativeGroup" + , _cgAdvertiserId = Nothing + , _cgAdvertiserIdDimensionValue = Nothing + , _cgGroupNumber = Nothing + , _cgAccountId = Nothing + , _cgName = Nothing + , _cgId = Nothing + , _cgSubAccountId = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#creativeGroup\". +cgKind :: Lens' CreativeGroup Text +cgKind = lens _cgKind (\ s a -> s{_cgKind = a}) + +-- | Advertiser ID of this creative group. This is a required field on +-- insertion. +cgAdvertiserId :: Lens' CreativeGroup (Maybe Int64) +cgAdvertiserId + = lens _cgAdvertiserId + (\ s a -> s{_cgAdvertiserId = a}) + . mapping _Coerce + +-- | Dimension value for the ID of the advertiser. This is a read-only, +-- auto-generated field. +cgAdvertiserIdDimensionValue :: Lens' CreativeGroup (Maybe DimensionValue) +cgAdvertiserIdDimensionValue + = lens _cgAdvertiserIdDimensionValue + (\ s a -> s{_cgAdvertiserIdDimensionValue = a}) + +-- | Subgroup of the creative group. Assign your creative groups to a +-- subgroup in order to filter or manage them more easily. This field is +-- required on insertion and is read-only after insertion. Acceptable +-- values are 1 to 2, inclusive. +cgGroupNumber :: Lens' CreativeGroup (Maybe Int32) +cgGroupNumber + = lens _cgGroupNumber + (\ s a -> s{_cgGroupNumber = a}) + . mapping _Coerce + +-- | Account ID of this creative group. This is a read-only field that can be +-- left blank. +cgAccountId :: Lens' CreativeGroup (Maybe Int64) +cgAccountId + = lens _cgAccountId (\ s a -> s{_cgAccountId = a}) . + mapping _Coerce + +-- | Name of this creative group. This is a required field and must be less +-- than 256 characters long and unique among creative groups of the same +-- advertiser. +cgName :: Lens' CreativeGroup (Maybe Text) +cgName = lens _cgName (\ s a -> s{_cgName = a}) + +-- | ID of this creative group. This is a read-only, auto-generated field. +cgId :: Lens' CreativeGroup (Maybe Int64) +cgId + = lens _cgId (\ s a -> s{_cgId = a}) . + mapping _Coerce + +-- | Subaccount ID of this creative group. This is a read-only field that can +-- be left blank. +cgSubAccountId :: Lens' CreativeGroup (Maybe Int64) +cgSubAccountId + = lens _cgSubAccountId + (\ s a -> s{_cgSubAccountId = a}) + . mapping _Coerce + +instance FromJSON CreativeGroup where + parseJSON + = withObject "CreativeGroup" + (\ o -> + CreativeGroup' <$> + (o .:? "kind" .!= "dfareporting#creativeGroup") <*> + (o .:? "advertiserId") + <*> (o .:? "advertiserIdDimensionValue") + <*> (o .:? "groupNumber") + <*> (o .:? "accountId") + <*> (o .:? "name") + <*> (o .:? "id") + <*> (o .:? "subaccountId")) + +instance ToJSON CreativeGroup where + toJSON CreativeGroup'{..} + = object + (catMaybes + [Just ("kind" .= _cgKind), + ("advertiserId" .=) <$> _cgAdvertiserId, + ("advertiserIdDimensionValue" .=) <$> + _cgAdvertiserIdDimensionValue, + ("groupNumber" .=) <$> _cgGroupNumber, + ("accountId" .=) <$> _cgAccountId, + ("name" .=) <$> _cgName, ("id" .=) <$> _cgId, + ("subaccountId" .=) <$> _cgSubAccountId]) + +-- | Identifies a creative which has been associated with a given campaign. +-- +-- /See:/ 'campaignCreativeAssociation' smart constructor. +data CampaignCreativeAssociation = + CampaignCreativeAssociation' + { _ccaKind :: !Text + , _ccaCreativeId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'CampaignCreativeAssociation' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'ccaKind' +-- +-- * 'ccaCreativeId' +campaignCreativeAssociation + :: CampaignCreativeAssociation +campaignCreativeAssociation = + CampaignCreativeAssociation' + { _ccaKind = "dfareporting#campaignCreativeAssociation" + , _ccaCreativeId = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#campaignCreativeAssociation\". +ccaKind :: Lens' CampaignCreativeAssociation Text +ccaKind = lens _ccaKind (\ s a -> s{_ccaKind = a}) + +-- | ID of the creative associated with the campaign. This is a required +-- field. +ccaCreativeId :: Lens' CampaignCreativeAssociation (Maybe Int64) +ccaCreativeId + = lens _ccaCreativeId + (\ s a -> s{_ccaCreativeId = a}) + . mapping _Coerce + +instance FromJSON CampaignCreativeAssociation where + parseJSON + = withObject "CampaignCreativeAssociation" + (\ o -> + CampaignCreativeAssociation' <$> + (o .:? "kind" .!= + "dfareporting#campaignCreativeAssociation") + <*> (o .:? "creativeId")) + +instance ToJSON CampaignCreativeAssociation where + toJSON CampaignCreativeAssociation'{..} + = object + (catMaybes + [Just ("kind" .= _ccaKind), + ("creativeId" .=) <$> _ccaCreativeId]) + +-- | The original conversion that was inserted or updated and whether there +-- were any errors. +-- +-- /See:/ 'conversionStatus' smart constructor. +data ConversionStatus = + ConversionStatus' + { _csKind :: !Text + , _csConversion :: !(Maybe Conversion) + , _csErrors :: !(Maybe [ConversionError]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ConversionStatus' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'csKind' +-- +-- * 'csConversion' +-- +-- * 'csErrors' +conversionStatus + :: ConversionStatus +conversionStatus = + ConversionStatus' + { _csKind = "dfareporting#conversionStatus" + , _csConversion = Nothing + , _csErrors = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#conversionStatus\". +csKind :: Lens' ConversionStatus Text +csKind = lens _csKind (\ s a -> s{_csKind = a}) + +-- | The original conversion that was inserted or updated. +csConversion :: Lens' ConversionStatus (Maybe Conversion) +csConversion + = lens _csConversion (\ s a -> s{_csConversion = a}) + +-- | A list of errors related to this conversion. +csErrors :: Lens' ConversionStatus [ConversionError] +csErrors + = lens _csErrors (\ s a -> s{_csErrors = a}) . + _Default + . _Coerce + +instance FromJSON ConversionStatus where + parseJSON + = withObject "ConversionStatus" + (\ o -> + ConversionStatus' <$> + (o .:? "kind" .!= "dfareporting#conversionStatus") + <*> (o .:? "conversion") + <*> (o .:? "errors" .!= mempty)) + +instance ToJSON ConversionStatus where + toJSON ConversionStatus'{..} + = object + (catMaybes + [Just ("kind" .= _csKind), + ("conversion" .=) <$> _csConversion, + ("errors" .=) <$> _csErrors]) + +-- | Lookback configuration settings. +-- +-- /See:/ 'lookbackConfiguration' smart constructor. +data LookbackConfiguration = + LookbackConfiguration' + { _lcClickDuration :: !(Maybe (Textual Int32)) + , _lcPostImpressionActivitiesDuration :: !(Maybe (Textual Int32)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'LookbackConfiguration' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'lcClickDuration' +-- +-- * 'lcPostImpressionActivitiesDuration' +lookbackConfiguration + :: LookbackConfiguration +lookbackConfiguration = + LookbackConfiguration' + {_lcClickDuration = Nothing, _lcPostImpressionActivitiesDuration = Nothing} + + +-- | Lookback window, in days, from the last time a given user clicked on one +-- of your ads. If you enter 0, clicks will not be considered as triggering +-- events for floodlight tracking. If you leave this field blank, the +-- default value for your account will be used. Acceptable values are 0 to +-- 90, inclusive. +lcClickDuration :: Lens' LookbackConfiguration (Maybe Int32) +lcClickDuration + = lens _lcClickDuration + (\ s a -> s{_lcClickDuration = a}) + . mapping _Coerce + +-- | Lookback window, in days, from the last time a given user viewed one of +-- your ads. If you enter 0, impressions will not be considered as +-- triggering events for floodlight tracking. If you leave this field +-- blank, the default value for your account will be used. Acceptable +-- values are 0 to 90, inclusive. +lcPostImpressionActivitiesDuration :: Lens' LookbackConfiguration (Maybe Int32) +lcPostImpressionActivitiesDuration + = lens _lcPostImpressionActivitiesDuration + (\ s a -> s{_lcPostImpressionActivitiesDuration = a}) + . mapping _Coerce + +instance FromJSON LookbackConfiguration where + parseJSON + = withObject "LookbackConfiguration" + (\ o -> + LookbackConfiguration' <$> + (o .:? "clickDuration") <*> + (o .:? "postImpressionActivitiesDuration")) + +instance ToJSON LookbackConfiguration where + toJSON LookbackConfiguration'{..} + = object + (catMaybes + [("clickDuration" .=) <$> _lcClickDuration, + ("postImpressionActivitiesDuration" .=) <$> + _lcPostImpressionActivitiesDuration]) + +-- | Publisher Dynamic Tag +-- +-- /See:/ 'floodlightActivityPublisherDynamicTag' smart constructor. +data FloodlightActivityPublisherDynamicTag = + FloodlightActivityPublisherDynamicTag' + { _fapdtClickThrough :: !(Maybe Bool) + , _fapdtSiteIdDimensionValue :: !(Maybe DimensionValue) + , _fapdtDynamicTag :: !(Maybe FloodlightActivityDynamicTag) + , _fapdtDirectorySiteId :: !(Maybe (Textual Int64)) + , _fapdtSiteId :: !(Maybe (Textual Int64)) + , _fapdtViewThrough :: !(Maybe Bool) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'FloodlightActivityPublisherDynamicTag' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'fapdtClickThrough' +-- +-- * 'fapdtSiteIdDimensionValue' +-- +-- * 'fapdtDynamicTag' +-- +-- * 'fapdtDirectorySiteId' +-- +-- * 'fapdtSiteId' +-- +-- * 'fapdtViewThrough' +floodlightActivityPublisherDynamicTag + :: FloodlightActivityPublisherDynamicTag +floodlightActivityPublisherDynamicTag = + FloodlightActivityPublisherDynamicTag' + { _fapdtClickThrough = Nothing + , _fapdtSiteIdDimensionValue = Nothing + , _fapdtDynamicTag = Nothing + , _fapdtDirectorySiteId = Nothing + , _fapdtSiteId = Nothing + , _fapdtViewThrough = Nothing + } + + +-- | Whether this tag is applicable only for click-throughs. +fapdtClickThrough :: Lens' FloodlightActivityPublisherDynamicTag (Maybe Bool) +fapdtClickThrough + = lens _fapdtClickThrough + (\ s a -> s{_fapdtClickThrough = a}) + +-- | Dimension value for the ID of the site. This is a read-only, +-- auto-generated field. +fapdtSiteIdDimensionValue :: Lens' FloodlightActivityPublisherDynamicTag (Maybe DimensionValue) +fapdtSiteIdDimensionValue + = lens _fapdtSiteIdDimensionValue + (\ s a -> s{_fapdtSiteIdDimensionValue = a}) + +-- | Dynamic floodlight tag. +fapdtDynamicTag :: Lens' FloodlightActivityPublisherDynamicTag (Maybe FloodlightActivityDynamicTag) +fapdtDynamicTag + = lens _fapdtDynamicTag + (\ s a -> s{_fapdtDynamicTag = a}) + +-- | Directory site ID of this dynamic tag. This is a write-only field that +-- can be used as an alternative to the siteId field. When this resource is +-- retrieved, only the siteId field will be populated. +fapdtDirectorySiteId :: Lens' FloodlightActivityPublisherDynamicTag (Maybe Int64) +fapdtDirectorySiteId + = lens _fapdtDirectorySiteId + (\ s a -> s{_fapdtDirectorySiteId = a}) + . mapping _Coerce + +-- | Site ID of this dynamic tag. +fapdtSiteId :: Lens' FloodlightActivityPublisherDynamicTag (Maybe Int64) +fapdtSiteId + = lens _fapdtSiteId (\ s a -> s{_fapdtSiteId = a}) . + mapping _Coerce + +-- | Whether this tag is applicable only for view-throughs. +fapdtViewThrough :: Lens' FloodlightActivityPublisherDynamicTag (Maybe Bool) +fapdtViewThrough + = lens _fapdtViewThrough + (\ s a -> s{_fapdtViewThrough = a}) + +instance FromJSON + FloodlightActivityPublisherDynamicTag + where + parseJSON + = withObject "FloodlightActivityPublisherDynamicTag" + (\ o -> + FloodlightActivityPublisherDynamicTag' <$> + (o .:? "clickThrough") <*> + (o .:? "siteIdDimensionValue") + <*> (o .:? "dynamicTag") + <*> (o .:? "directorySiteId") + <*> (o .:? "siteId") + <*> (o .:? "viewThrough")) + +instance ToJSON FloodlightActivityPublisherDynamicTag + where + toJSON FloodlightActivityPublisherDynamicTag'{..} + = object + (catMaybes + [("clickThrough" .=) <$> _fapdtClickThrough, + ("siteIdDimensionValue" .=) <$> + _fapdtSiteIdDimensionValue, + ("dynamicTag" .=) <$> _fapdtDynamicTag, + ("directorySiteId" .=) <$> _fapdtDirectorySiteId, + ("siteId" .=) <$> _fapdtSiteId, + ("viewThrough" .=) <$> _fapdtViewThrough]) + +-- | Gets a summary of active ads in an account. +-- +-- /See:/ 'accountActiveAdSummary' smart constructor. +data AccountActiveAdSummary = + AccountActiveAdSummary' + { _aaasAvailableAds :: !(Maybe (Textual Int64)) + , _aaasKind :: !Text + , _aaasAccountId :: !(Maybe (Textual Int64)) + , _aaasActiveAds :: !(Maybe (Textual Int64)) + , _aaasActiveAdsLimitTier :: !(Maybe AccountActiveAdSummaryActiveAdsLimitTier) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'AccountActiveAdSummary' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'aaasAvailableAds' +-- +-- * 'aaasKind' +-- +-- * 'aaasAccountId' +-- +-- * 'aaasActiveAds' +-- +-- * 'aaasActiveAdsLimitTier' +accountActiveAdSummary + :: AccountActiveAdSummary +accountActiveAdSummary = + AccountActiveAdSummary' + { _aaasAvailableAds = Nothing + , _aaasKind = "dfareporting#accountActiveAdSummary" + , _aaasAccountId = Nothing + , _aaasActiveAds = Nothing + , _aaasActiveAdsLimitTier = Nothing + } + + +-- | Ads that can be activated for the account. +aaasAvailableAds :: Lens' AccountActiveAdSummary (Maybe Int64) +aaasAvailableAds + = lens _aaasAvailableAds + (\ s a -> s{_aaasAvailableAds = a}) + . mapping _Coerce + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#accountActiveAdSummary\". +aaasKind :: Lens' AccountActiveAdSummary Text +aaasKind = lens _aaasKind (\ s a -> s{_aaasKind = a}) + +-- | ID of the account. +aaasAccountId :: Lens' AccountActiveAdSummary (Maybe Int64) +aaasAccountId + = lens _aaasAccountId + (\ s a -> s{_aaasAccountId = a}) + . mapping _Coerce + +-- | Ads that have been activated for the account +aaasActiveAds :: Lens' AccountActiveAdSummary (Maybe Int64) +aaasActiveAds + = lens _aaasActiveAds + (\ s a -> s{_aaasActiveAds = a}) + . mapping _Coerce + +-- | Maximum number of active ads allowed for the account. +aaasActiveAdsLimitTier :: Lens' AccountActiveAdSummary (Maybe AccountActiveAdSummaryActiveAdsLimitTier) +aaasActiveAdsLimitTier + = lens _aaasActiveAdsLimitTier + (\ s a -> s{_aaasActiveAdsLimitTier = a}) + +instance FromJSON AccountActiveAdSummary where + parseJSON + = withObject "AccountActiveAdSummary" + (\ o -> + AccountActiveAdSummary' <$> + (o .:? "availableAds") <*> + (o .:? "kind" .!= + "dfareporting#accountActiveAdSummary") + <*> (o .:? "accountId") + <*> (o .:? "activeAds") + <*> (o .:? "activeAdsLimitTier")) + +instance ToJSON AccountActiveAdSummary where + toJSON AccountActiveAdSummary'{..} + = object + (catMaybes + [("availableAds" .=) <$> _aaasAvailableAds, + Just ("kind" .= _aaasKind), + ("accountId" .=) <$> _aaasAccountId, + ("activeAds" .=) <$> _aaasActiveAds, + ("activeAdsLimitTier" .=) <$> + _aaasActiveAdsLimitTier]) + +-- | Offset Position. +-- +-- /See:/ 'offSetPosition' smart constructor. +data OffSetPosition = + OffSetPosition' + { _ospLeft :: !(Maybe (Textual Int32)) + , _ospTop :: !(Maybe (Textual Int32)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'OffSetPosition' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'ospLeft' +-- +-- * 'ospTop' +offSetPosition + :: OffSetPosition +offSetPosition = OffSetPosition' {_ospLeft = Nothing, _ospTop = Nothing} + + +-- | Offset distance from left side of an asset or a window. +ospLeft :: Lens' OffSetPosition (Maybe Int32) +ospLeft + = lens _ospLeft (\ s a -> s{_ospLeft = a}) . + mapping _Coerce + +-- | Offset distance from top side of an asset or a window. +ospTop :: Lens' OffSetPosition (Maybe Int32) +ospTop + = lens _ospTop (\ s a -> s{_ospTop = a}) . + mapping _Coerce + +instance FromJSON OffSetPosition where + parseJSON + = withObject "OffSetPosition" + (\ o -> + OffSetPosition' <$> (o .:? "left") <*> (o .:? "top")) + +instance ToJSON OffSetPosition where + toJSON OffSetPosition'{..} + = object + (catMaybes + [("left" .=) <$> _ospLeft, ("top" .=) <$> _ospTop]) + +-- | Represents a metric. +-- +-- /See:/ 'metric' smart constructor. +data Metric = + Metric' + { _mKind :: !Text + , _mName :: !(Maybe Text) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'Metric' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'mKind' +-- +-- * 'mName' +metric + :: Metric +metric = Metric' {_mKind = "dfareporting#metric", _mName = Nothing} + + +-- | The kind of resource this is, in this case dfareporting#metric. +mKind :: Lens' Metric Text +mKind = lens _mKind (\ s a -> s{_mKind = a}) + +-- | The metric name, e.g. dfa:impressions +mName :: Lens' Metric (Maybe Text) +mName = lens _mName (\ s a -> s{_mName = a}) + +instance FromJSON Metric where + parseJSON + = withObject "Metric" + (\ o -> + Metric' <$> + (o .:? "kind" .!= "dfareporting#metric") <*> + (o .:? "name")) + +instance ToJSON Metric where + toJSON Metric'{..} + = object + (catMaybes + [Just ("kind" .= _mKind), ("name" .=) <$> _mName]) + +-- | Contains properties of a remarketing list\'s sharing information. +-- Sharing allows other accounts or advertisers to target to your +-- remarketing lists. This resource can be used to manage remarketing list +-- sharing to other accounts and advertisers. +-- +-- /See:/ 'remarketingListShare' smart constructor. +data RemarketingListShare = + RemarketingListShare' + { _rlsSharedAdvertiserIds :: !(Maybe [Textual Int64]) + , _rlsKind :: !Text + , _rlsRemarketingListId :: !(Maybe (Textual Int64)) + , _rlsSharedAccountIds :: !(Maybe [Textual Int64]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'RemarketingListShare' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'rlsSharedAdvertiserIds' +-- +-- * 'rlsKind' +-- +-- * 'rlsRemarketingListId' +-- +-- * 'rlsSharedAccountIds' +remarketingListShare + :: RemarketingListShare +remarketingListShare = + RemarketingListShare' + { _rlsSharedAdvertiserIds = Nothing + , _rlsKind = "dfareporting#remarketingListShare" + , _rlsRemarketingListId = Nothing + , _rlsSharedAccountIds = Nothing + } + + +-- | Advertisers that the remarketing list is shared with. +rlsSharedAdvertiserIds :: Lens' RemarketingListShare [Int64] +rlsSharedAdvertiserIds + = lens _rlsSharedAdvertiserIds + (\ s a -> s{_rlsSharedAdvertiserIds = a}) + . _Default + . _Coerce + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#remarketingListShare\". +rlsKind :: Lens' RemarketingListShare Text +rlsKind = lens _rlsKind (\ s a -> s{_rlsKind = a}) + +-- | Remarketing list ID. This is a read-only, auto-generated field. +rlsRemarketingListId :: Lens' RemarketingListShare (Maybe Int64) +rlsRemarketingListId + = lens _rlsRemarketingListId + (\ s a -> s{_rlsRemarketingListId = a}) + . mapping _Coerce + +-- | Accounts that the remarketing list is shared with. +rlsSharedAccountIds :: Lens' RemarketingListShare [Int64] +rlsSharedAccountIds + = lens _rlsSharedAccountIds + (\ s a -> s{_rlsSharedAccountIds = a}) + . _Default + . _Coerce + +instance FromJSON RemarketingListShare where + parseJSON + = withObject "RemarketingListShare" + (\ o -> + RemarketingListShare' <$> + (o .:? "sharedAdvertiserIds" .!= mempty) <*> + (o .:? "kind" .!= + "dfareporting#remarketingListShare") + <*> (o .:? "remarketingListId") + <*> (o .:? "sharedAccountIds" .!= mempty)) + +instance ToJSON RemarketingListShare where + toJSON RemarketingListShare'{..} + = object + (catMaybes + [("sharedAdvertiserIds" .=) <$> + _rlsSharedAdvertiserIds, + Just ("kind" .= _rlsKind), + ("remarketingListId" .=) <$> _rlsRemarketingListId, + ("sharedAccountIds" .=) <$> _rlsSharedAccountIds]) + +-- | Event Tag List Response +-- +-- /See:/ 'eventTagsListResponse' smart constructor. +data EventTagsListResponse = + EventTagsListResponse' + { _etlrKind :: !Text + , _etlrEventTags :: !(Maybe [EventTag]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'EventTagsListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'etlrKind' +-- +-- * 'etlrEventTags' +eventTagsListResponse + :: EventTagsListResponse +eventTagsListResponse = + EventTagsListResponse' + {_etlrKind = "dfareporting#eventTagsListResponse", _etlrEventTags = Nothing} + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#eventTagsListResponse\". +etlrKind :: Lens' EventTagsListResponse Text +etlrKind = lens _etlrKind (\ s a -> s{_etlrKind = a}) + +-- | Event tag collection. +etlrEventTags :: Lens' EventTagsListResponse [EventTag] +etlrEventTags + = lens _etlrEventTags + (\ s a -> s{_etlrEventTags = a}) + . _Default + . _Coerce + +instance FromJSON EventTagsListResponse where + parseJSON + = withObject "EventTagsListResponse" + (\ o -> + EventTagsListResponse' <$> + (o .:? "kind" .!= + "dfareporting#eventTagsListResponse") + <*> (o .:? "eventTags" .!= mempty)) + +instance ToJSON EventTagsListResponse where + toJSON EventTagsListResponse'{..} + = object + (catMaybes + [Just ("kind" .= _etlrKind), + ("eventTags" .=) <$> _etlrEventTags]) + +-- | User Role List Response +-- +-- /See:/ 'userRolesListResponse' smart constructor. +data UserRolesListResponse = + UserRolesListResponse' + { _urlrNextPageToken :: !(Maybe Text) + , _urlrKind :: !Text + , _urlrUserRoles :: !(Maybe [UserRole]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'UserRolesListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'urlrNextPageToken' +-- +-- * 'urlrKind' +-- +-- * 'urlrUserRoles' +userRolesListResponse + :: UserRolesListResponse +userRolesListResponse = + UserRolesListResponse' + { _urlrNextPageToken = Nothing + , _urlrKind = "dfareporting#userRolesListResponse" + , _urlrUserRoles = Nothing + } + + +-- | Pagination token to be used for the next list operation. +urlrNextPageToken :: Lens' UserRolesListResponse (Maybe Text) +urlrNextPageToken + = lens _urlrNextPageToken + (\ s a -> s{_urlrNextPageToken = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#userRolesListResponse\". +urlrKind :: Lens' UserRolesListResponse Text +urlrKind = lens _urlrKind (\ s a -> s{_urlrKind = a}) + +-- | User role collection. +urlrUserRoles :: Lens' UserRolesListResponse [UserRole] +urlrUserRoles + = lens _urlrUserRoles + (\ s a -> s{_urlrUserRoles = a}) + . _Default + . _Coerce + +instance FromJSON UserRolesListResponse where + parseJSON + = withObject "UserRolesListResponse" + (\ o -> + UserRolesListResponse' <$> + (o .:? "nextPageToken") <*> + (o .:? "kind" .!= + "dfareporting#userRolesListResponse") + <*> (o .:? "userRoles" .!= mempty)) + +instance ToJSON UserRolesListResponse where + toJSON UserRolesListResponse'{..} + = object + (catMaybes + [("nextPageToken" .=) <$> _urlrNextPageToken, + Just ("kind" .= _urlrKind), + ("userRoles" .=) <$> _urlrUserRoles]) + +-- | Represents a response to the queryCompatibleFields method. +-- +-- /See:/ 'compatibleFields' smart constructor. +data CompatibleFields = + CompatibleFields' + { _cfReachReportCompatibleFields :: !(Maybe ReachReportCompatibleFields) + , _cfCrossDimensionReachReportCompatibleFields :: !(Maybe CrossDimensionReachReportCompatibleFields) + , _cfKind :: !Text + , _cfFloodlightReportCompatibleFields :: !(Maybe FloodlightReportCompatibleFields) + , _cfReportCompatibleFields :: !(Maybe ReportCompatibleFields) + , _cfPathToConversionReportCompatibleFields :: !(Maybe PathToConversionReportCompatibleFields) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'CompatibleFields' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'cfReachReportCompatibleFields' +-- +-- * 'cfCrossDimensionReachReportCompatibleFields' +-- +-- * 'cfKind' +-- +-- * 'cfFloodlightReportCompatibleFields' +-- +-- * 'cfReportCompatibleFields' +-- +-- * 'cfPathToConversionReportCompatibleFields' +compatibleFields + :: CompatibleFields +compatibleFields = + CompatibleFields' + { _cfReachReportCompatibleFields = Nothing + , _cfCrossDimensionReachReportCompatibleFields = Nothing + , _cfKind = "dfareporting#compatibleFields" + , _cfFloodlightReportCompatibleFields = Nothing + , _cfReportCompatibleFields = Nothing + , _cfPathToConversionReportCompatibleFields = Nothing + } + + +-- | Contains items that are compatible to be selected for a report of type +-- \"REACH\". +cfReachReportCompatibleFields :: Lens' CompatibleFields (Maybe ReachReportCompatibleFields) +cfReachReportCompatibleFields + = lens _cfReachReportCompatibleFields + (\ s a -> s{_cfReachReportCompatibleFields = a}) + +-- | Contains items that are compatible to be selected for a report of type +-- \"CROSS_DIMENSION_REACH\". +cfCrossDimensionReachReportCompatibleFields :: Lens' CompatibleFields (Maybe CrossDimensionReachReportCompatibleFields) +cfCrossDimensionReachReportCompatibleFields + = lens _cfCrossDimensionReachReportCompatibleFields + (\ s a -> + s{_cfCrossDimensionReachReportCompatibleFields = a}) + +-- | The kind of resource this is, in this case +-- dfareporting#compatibleFields. +cfKind :: Lens' CompatibleFields Text +cfKind = lens _cfKind (\ s a -> s{_cfKind = a}) + +-- | Contains items that are compatible to be selected for a report of type +-- \"FLOODLIGHT\". +cfFloodlightReportCompatibleFields :: Lens' CompatibleFields (Maybe FloodlightReportCompatibleFields) +cfFloodlightReportCompatibleFields + = lens _cfFloodlightReportCompatibleFields + (\ s a -> s{_cfFloodlightReportCompatibleFields = a}) + +-- | Contains items that are compatible to be selected for a report of type +-- \"STANDARD\". +cfReportCompatibleFields :: Lens' CompatibleFields (Maybe ReportCompatibleFields) +cfReportCompatibleFields + = lens _cfReportCompatibleFields + (\ s a -> s{_cfReportCompatibleFields = a}) + +-- | Contains items that are compatible to be selected for a report of type +-- \"PATH_TO_CONVERSION\". +cfPathToConversionReportCompatibleFields :: Lens' CompatibleFields (Maybe PathToConversionReportCompatibleFields) +cfPathToConversionReportCompatibleFields + = lens _cfPathToConversionReportCompatibleFields + (\ s a -> + s{_cfPathToConversionReportCompatibleFields = a}) + +instance FromJSON CompatibleFields where + parseJSON + = withObject "CompatibleFields" + (\ o -> + CompatibleFields' <$> + (o .:? "reachReportCompatibleFields") <*> + (o .:? "crossDimensionReachReportCompatibleFields") + <*> + (o .:? "kind" .!= "dfareporting#compatibleFields") + <*> (o .:? "floodlightReportCompatibleFields") + <*> (o .:? "reportCompatibleFields") + <*> (o .:? "pathToConversionReportCompatibleFields")) + +instance ToJSON CompatibleFields where + toJSON CompatibleFields'{..} + = object + (catMaybes + [("reachReportCompatibleFields" .=) <$> + _cfReachReportCompatibleFields, + ("crossDimensionReachReportCompatibleFields" .=) <$> + _cfCrossDimensionReachReportCompatibleFields, + Just ("kind" .= _cfKind), + ("floodlightReportCompatibleFields" .=) <$> + _cfFloodlightReportCompatibleFields, + ("reportCompatibleFields" .=) <$> + _cfReportCompatibleFields, + ("pathToConversionReportCompatibleFields" .=) <$> + _cfPathToConversionReportCompatibleFields]) + +-- | Audience Segment. +-- +-- /See:/ 'audienceSegment' smart constructor. +data AudienceSegment = + AudienceSegment' + { _asName :: !(Maybe Text) + , _asId :: !(Maybe (Textual Int64)) + , _asAllocation :: !(Maybe (Textual Int32)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'AudienceSegment' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'asName' +-- +-- * 'asId' +-- +-- * 'asAllocation' +audienceSegment + :: AudienceSegment +audienceSegment = + AudienceSegment' {_asName = Nothing, _asId = Nothing, _asAllocation = Nothing} + + +-- | Name of this audience segment. This is a required field and must be less +-- than 65 characters long. +asName :: Lens' AudienceSegment (Maybe Text) +asName = lens _asName (\ s a -> s{_asName = a}) + +-- | ID of this audience segment. This is a read-only, auto-generated field. +asId :: Lens' AudienceSegment (Maybe Int64) +asId + = lens _asId (\ s a -> s{_asId = a}) . + mapping _Coerce + +-- | Weight allocated to this segment. The weight assigned will be understood +-- in proportion to the weights assigned to other segments in the same +-- segment group. Acceptable values are 1 to 1000, inclusive. +asAllocation :: Lens' AudienceSegment (Maybe Int32) +asAllocation + = lens _asAllocation (\ s a -> s{_asAllocation = a}) + . mapping _Coerce + +instance FromJSON AudienceSegment where + parseJSON + = withObject "AudienceSegment" + (\ o -> + AudienceSegment' <$> + (o .:? "name") <*> (o .:? "id") <*> + (o .:? "allocation")) + +instance ToJSON AudienceSegment where + toJSON AudienceSegment'{..} + = object + (catMaybes + [("name" .=) <$> _asName, ("id" .=) <$> _asId, + ("allocation" .=) <$> _asAllocation]) + +-- | Update Conversions Request. +-- +-- /See:/ 'conversionsBatchUpdateRequest' smart constructor. +data ConversionsBatchUpdateRequest = + ConversionsBatchUpdateRequest' + { _cburbKind :: !Text + , _cburbConversions :: !(Maybe [Conversion]) + , _cburbEncryptionInfo :: !(Maybe EncryptionInfo) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ConversionsBatchUpdateRequest' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'cburbKind' +-- +-- * 'cburbConversions' +-- +-- * 'cburbEncryptionInfo' +conversionsBatchUpdateRequest + :: ConversionsBatchUpdateRequest +conversionsBatchUpdateRequest = + ConversionsBatchUpdateRequest' + { _cburbKind = "dfareporting#conversionsBatchUpdateRequest" + , _cburbConversions = Nothing + , _cburbEncryptionInfo = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#conversionsBatchUpdateRequest\". +cburbKind :: Lens' ConversionsBatchUpdateRequest Text +cburbKind + = lens _cburbKind (\ s a -> s{_cburbKind = a}) + +-- | The set of conversions to update. +cburbConversions :: Lens' ConversionsBatchUpdateRequest [Conversion] +cburbConversions + = lens _cburbConversions + (\ s a -> s{_cburbConversions = a}) + . _Default + . _Coerce + +-- | Describes how encryptedUserId is encrypted. This is a required field if +-- encryptedUserId is used. +cburbEncryptionInfo :: Lens' ConversionsBatchUpdateRequest (Maybe EncryptionInfo) +cburbEncryptionInfo + = lens _cburbEncryptionInfo + (\ s a -> s{_cburbEncryptionInfo = a}) + +instance FromJSON ConversionsBatchUpdateRequest where + parseJSON + = withObject "ConversionsBatchUpdateRequest" + (\ o -> + ConversionsBatchUpdateRequest' <$> + (o .:? "kind" .!= + "dfareporting#conversionsBatchUpdateRequest") + <*> (o .:? "conversions" .!= mempty) + <*> (o .:? "encryptionInfo")) + +instance ToJSON ConversionsBatchUpdateRequest where + toJSON ConversionsBatchUpdateRequest'{..} + = object + (catMaybes + [Just ("kind" .= _cburbKind), + ("conversions" .=) <$> _cburbConversions, + ("encryptionInfo" .=) <$> _cburbEncryptionInfo]) + +-- | Google Ad Manager Settings +-- +-- /See:/ 'dfpSettings' smart constructor. +data DfpSettings = + DfpSettings' + { _dsPubPaidPlacementAccepted :: !(Maybe Bool) + , _dsDfpNetworkName :: !(Maybe Text) + , _dsPublisherPortalOnly :: !(Maybe Bool) + , _dsProgrammaticPlacementAccepted :: !(Maybe Bool) + , _dsDfpNetworkCode :: !(Maybe Text) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'DfpSettings' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'dsPubPaidPlacementAccepted' +-- +-- * 'dsDfpNetworkName' +-- +-- * 'dsPublisherPortalOnly' +-- +-- * 'dsProgrammaticPlacementAccepted' +-- +-- * 'dsDfpNetworkCode' +dfpSettings + :: DfpSettings +dfpSettings = + DfpSettings' + { _dsPubPaidPlacementAccepted = Nothing + , _dsDfpNetworkName = Nothing + , _dsPublisherPortalOnly = Nothing + , _dsProgrammaticPlacementAccepted = Nothing + , _dsDfpNetworkCode = Nothing + } + + +-- | Whether this directory site accepts publisher-paid tags. +dsPubPaidPlacementAccepted :: Lens' DfpSettings (Maybe Bool) +dsPubPaidPlacementAccepted + = lens _dsPubPaidPlacementAccepted + (\ s a -> s{_dsPubPaidPlacementAccepted = a}) + +-- | Ad Manager network name for this directory site. +dsDfpNetworkName :: Lens' DfpSettings (Maybe Text) +dsDfpNetworkName + = lens _dsDfpNetworkName + (\ s a -> s{_dsDfpNetworkName = a}) + +-- | Whether this directory site is available only via Publisher Portal. +dsPublisherPortalOnly :: Lens' DfpSettings (Maybe Bool) +dsPublisherPortalOnly + = lens _dsPublisherPortalOnly + (\ s a -> s{_dsPublisherPortalOnly = a}) + +-- | Whether this directory site accepts programmatic placements. +dsProgrammaticPlacementAccepted :: Lens' DfpSettings (Maybe Bool) +dsProgrammaticPlacementAccepted + = lens _dsProgrammaticPlacementAccepted + (\ s a -> s{_dsProgrammaticPlacementAccepted = a}) + +-- | Ad Manager network code for this directory site. +dsDfpNetworkCode :: Lens' DfpSettings (Maybe Text) +dsDfpNetworkCode + = lens _dsDfpNetworkCode + (\ s a -> s{_dsDfpNetworkCode = a}) + +instance FromJSON DfpSettings where + parseJSON + = withObject "DfpSettings" + (\ o -> + DfpSettings' <$> + (o .:? "pubPaidPlacementAccepted") <*> + (o .:? "dfpNetworkName") + <*> (o .:? "publisherPortalOnly") + <*> (o .:? "programmaticPlacementAccepted") + <*> (o .:? "dfpNetworkCode")) + +instance ToJSON DfpSettings where + toJSON DfpSettings'{..} + = object + (catMaybes + [("pubPaidPlacementAccepted" .=) <$> + _dsPubPaidPlacementAccepted, + ("dfpNetworkName" .=) <$> _dsDfpNetworkName, + ("publisherPortalOnly" .=) <$> + _dsPublisherPortalOnly, + ("programmaticPlacementAccepted" .=) <$> + _dsProgrammaticPlacementAccepted, + ("dfpNetworkCode" .=) <$> _dsDfpNetworkCode]) + +-- | Represents fields that are compatible to be selected for a report of +-- type \"PATH_TO_CONVERSION\". +-- +-- /See:/ 'pathToConversionReportCompatibleFields' smart constructor. +data PathToConversionReportCompatibleFields = + PathToConversionReportCompatibleFields' + { _ptcrcfMetrics :: !(Maybe [Metric]) + , _ptcrcfKind :: !Text + , _ptcrcfConversionDimensions :: !(Maybe [Dimension]) + , _ptcrcfCustomFloodlightVariables :: !(Maybe [Dimension]) + , _ptcrcfPerInteractionDimensions :: !(Maybe [Dimension]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'PathToConversionReportCompatibleFields' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'ptcrcfMetrics' +-- +-- * 'ptcrcfKind' +-- +-- * 'ptcrcfConversionDimensions' +-- +-- * 'ptcrcfCustomFloodlightVariables' +-- +-- * 'ptcrcfPerInteractionDimensions' +pathToConversionReportCompatibleFields + :: PathToConversionReportCompatibleFields +pathToConversionReportCompatibleFields = + PathToConversionReportCompatibleFields' + { _ptcrcfMetrics = Nothing + , _ptcrcfKind = "dfareporting#pathToConversionReportCompatibleFields" + , _ptcrcfConversionDimensions = Nothing + , _ptcrcfCustomFloodlightVariables = Nothing + , _ptcrcfPerInteractionDimensions = Nothing + } + + +-- | Metrics which are compatible to be selected in the \"metricNames\" +-- section of the report. +ptcrcfMetrics :: Lens' PathToConversionReportCompatibleFields [Metric] +ptcrcfMetrics + = lens _ptcrcfMetrics + (\ s a -> s{_ptcrcfMetrics = a}) + . _Default + . _Coerce + +-- | The kind of resource this is, in this case +-- dfareporting#pathToConversionReportCompatibleFields. +ptcrcfKind :: Lens' PathToConversionReportCompatibleFields Text +ptcrcfKind + = lens _ptcrcfKind (\ s a -> s{_ptcrcfKind = a}) + +-- | Conversion dimensions which are compatible to be selected in the +-- \"conversionDimensions\" section of the report. +ptcrcfConversionDimensions :: Lens' PathToConversionReportCompatibleFields [Dimension] +ptcrcfConversionDimensions + = lens _ptcrcfConversionDimensions + (\ s a -> s{_ptcrcfConversionDimensions = a}) + . _Default + . _Coerce + +-- | Custom floodlight variables which are compatible to be selected in the +-- \"customFloodlightVariables\" section of the report. +ptcrcfCustomFloodlightVariables :: Lens' PathToConversionReportCompatibleFields [Dimension] +ptcrcfCustomFloodlightVariables + = lens _ptcrcfCustomFloodlightVariables + (\ s a -> s{_ptcrcfCustomFloodlightVariables = a}) + . _Default + . _Coerce + +-- | Per-interaction dimensions which are compatible to be selected in the +-- \"perInteractionDimensions\" section of the report. +ptcrcfPerInteractionDimensions :: Lens' PathToConversionReportCompatibleFields [Dimension] +ptcrcfPerInteractionDimensions + = lens _ptcrcfPerInteractionDimensions + (\ s a -> s{_ptcrcfPerInteractionDimensions = a}) + . _Default + . _Coerce + +instance FromJSON + PathToConversionReportCompatibleFields + where + parseJSON + = withObject "PathToConversionReportCompatibleFields" + (\ o -> + PathToConversionReportCompatibleFields' <$> + (o .:? "metrics" .!= mempty) <*> + (o .:? "kind" .!= + "dfareporting#pathToConversionReportCompatibleFields") + <*> (o .:? "conversionDimensions" .!= mempty) + <*> (o .:? "customFloodlightVariables" .!= mempty) + <*> (o .:? "perInteractionDimensions" .!= mempty)) + +instance ToJSON + PathToConversionReportCompatibleFields + where + toJSON PathToConversionReportCompatibleFields'{..} + = object + (catMaybes + [("metrics" .=) <$> _ptcrcfMetrics, + Just ("kind" .= _ptcrcfKind), + ("conversionDimensions" .=) <$> + _ptcrcfConversionDimensions, + ("customFloodlightVariables" .=) <$> + _ptcrcfCustomFloodlightVariables, + ("perInteractionDimensions" .=) <$> + _ptcrcfPerInteractionDimensions]) + +-- | Contains information about a city that can be targeted by ads. +-- +-- /See:/ 'city' smart constructor. +data City = + City' + { _ccMetroCode :: !(Maybe Text) + , _ccRegionCode :: !(Maybe Text) + , _ccKind :: !Text + , _ccRegionDartId :: !(Maybe (Textual Int64)) + , _ccMetroDmaId :: !(Maybe (Textual Int64)) + , _ccName :: !(Maybe Text) + , _ccCountryCode :: !(Maybe Text) + , _ccCountryDartId :: !(Maybe (Textual Int64)) + , _ccDartId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'City' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'ccMetroCode' +-- +-- * 'ccRegionCode' +-- +-- * 'ccKind' +-- +-- * 'ccRegionDartId' +-- +-- * 'ccMetroDmaId' +-- +-- * 'ccName' +-- +-- * 'ccCountryCode' +-- +-- * 'ccCountryDartId' +-- +-- * 'ccDartId' +city + :: City +city = + City' + { _ccMetroCode = Nothing + , _ccRegionCode = Nothing + , _ccKind = "dfareporting#city" + , _ccRegionDartId = Nothing + , _ccMetroDmaId = Nothing + , _ccName = Nothing + , _ccCountryCode = Nothing + , _ccCountryDartId = Nothing + , _ccDartId = Nothing + } + + +-- | Metro region code of the metro region (DMA) to which this city belongs. +ccMetroCode :: Lens' City (Maybe Text) +ccMetroCode + = lens _ccMetroCode (\ s a -> s{_ccMetroCode = a}) + +-- | Region code of the region to which this city belongs. +ccRegionCode :: Lens' City (Maybe Text) +ccRegionCode + = lens _ccRegionCode (\ s a -> s{_ccRegionCode = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#city\". +ccKind :: Lens' City Text +ccKind = lens _ccKind (\ s a -> s{_ccKind = a}) + +-- | DART ID of the region to which this city belongs. +ccRegionDartId :: Lens' City (Maybe Int64) +ccRegionDartId + = lens _ccRegionDartId + (\ s a -> s{_ccRegionDartId = a}) + . mapping _Coerce + +-- | ID of the metro region (DMA) to which this city belongs. +ccMetroDmaId :: Lens' City (Maybe Int64) +ccMetroDmaId + = lens _ccMetroDmaId (\ s a -> s{_ccMetroDmaId = a}) + . mapping _Coerce + +-- | Name of this city. +ccName :: Lens' City (Maybe Text) +ccName = lens _ccName (\ s a -> s{_ccName = a}) + +-- | Country code of the country to which this city belongs. +ccCountryCode :: Lens' City (Maybe Text) +ccCountryCode + = lens _ccCountryCode + (\ s a -> s{_ccCountryCode = a}) + +-- | DART ID of the country to which this city belongs. +ccCountryDartId :: Lens' City (Maybe Int64) +ccCountryDartId + = lens _ccCountryDartId + (\ s a -> s{_ccCountryDartId = a}) + . mapping _Coerce + +-- | DART ID of this city. This is the ID used for targeting and generating +-- reports. +ccDartId :: Lens' City (Maybe Int64) +ccDartId + = lens _ccDartId (\ s a -> s{_ccDartId = a}) . + mapping _Coerce + +instance FromJSON City where + parseJSON + = withObject "City" + (\ o -> + City' <$> + (o .:? "metroCode") <*> (o .:? "regionCode") <*> + (o .:? "kind" .!= "dfareporting#city") + <*> (o .:? "regionDartId") + <*> (o .:? "metroDmaId") + <*> (o .:? "name") + <*> (o .:? "countryCode") + <*> (o .:? "countryDartId") + <*> (o .:? "dartId")) + +instance ToJSON City where + toJSON City'{..} + = object + (catMaybes + [("metroCode" .=) <$> _ccMetroCode, + ("regionCode" .=) <$> _ccRegionCode, + Just ("kind" .= _ccKind), + ("regionDartId" .=) <$> _ccRegionDartId, + ("metroDmaId" .=) <$> _ccMetroDmaId, + ("name" .=) <$> _ccName, + ("countryCode" .=) <$> _ccCountryCode, + ("countryDartId" .=) <$> _ccCountryDartId, + ("dartId" .=) <$> _ccDartId]) + +-- | Contains information about a platform type that can be targeted by ads. +-- +-- /See:/ 'platformType' smart constructor. +data PlatformType = + PlatformType' + { _ptKind :: !Text + , _ptName :: !(Maybe Text) + , _ptId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'PlatformType' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'ptKind' +-- +-- * 'ptName' +-- +-- * 'ptId' +platformType + :: PlatformType +platformType = + PlatformType' + {_ptKind = "dfareporting#platformType", _ptName = Nothing, _ptId = Nothing} + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#platformType\". +ptKind :: Lens' PlatformType Text +ptKind = lens _ptKind (\ s a -> s{_ptKind = a}) + +-- | Name of this platform type. +ptName :: Lens' PlatformType (Maybe Text) +ptName = lens _ptName (\ s a -> s{_ptName = a}) + +-- | ID of this platform type. +ptId :: Lens' PlatformType (Maybe Int64) +ptId + = lens _ptId (\ s a -> s{_ptId = a}) . + mapping _Coerce + +instance FromJSON PlatformType where + parseJSON + = withObject "PlatformType" + (\ o -> + PlatformType' <$> + (o .:? "kind" .!= "dfareporting#platformType") <*> + (o .:? "name") + <*> (o .:? "id")) + +instance ToJSON PlatformType where + toJSON PlatformType'{..} + = object + (catMaybes + [Just ("kind" .= _ptKind), ("name" .=) <$> _ptName, + ("id" .=) <$> _ptId]) + +-- | Key Value Targeting Expression. +-- +-- /See:/ 'keyValueTargetingExpression' smart constructor. +newtype KeyValueTargetingExpression = + KeyValueTargetingExpression' + { _kvteExpression :: Maybe Text + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'KeyValueTargetingExpression' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'kvteExpression' +keyValueTargetingExpression + :: KeyValueTargetingExpression +keyValueTargetingExpression = + KeyValueTargetingExpression' {_kvteExpression = Nothing} + + +-- | Keyword expression being targeted by the ad. +kvteExpression :: Lens' KeyValueTargetingExpression (Maybe Text) +kvteExpression + = lens _kvteExpression + (\ s a -> s{_kvteExpression = a}) + +instance FromJSON KeyValueTargetingExpression where + parseJSON + = withObject "KeyValueTargetingExpression" + (\ o -> + KeyValueTargetingExpression' <$> + (o .:? "expression")) + +instance ToJSON KeyValueTargetingExpression where + toJSON KeyValueTargetingExpression'{..} + = object + (catMaybes [("expression" .=) <$> _kvteExpression]) + +-- | Companion Click-through override. +-- +-- /See:/ 'companionClickThroughOverride' smart constructor. +data CompanionClickThroughOverride = + CompanionClickThroughOverride' + { _cctoCreativeId :: !(Maybe (Textual Int64)) + , _cctoClickThroughURL :: !(Maybe ClickThroughURL) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'CompanionClickThroughOverride' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'cctoCreativeId' +-- +-- * 'cctoClickThroughURL' +companionClickThroughOverride + :: CompanionClickThroughOverride +companionClickThroughOverride = + CompanionClickThroughOverride' + {_cctoCreativeId = Nothing, _cctoClickThroughURL = Nothing} + + +-- | ID of the creative for this companion click-through override. +cctoCreativeId :: Lens' CompanionClickThroughOverride (Maybe Int64) +cctoCreativeId + = lens _cctoCreativeId + (\ s a -> s{_cctoCreativeId = a}) + . mapping _Coerce + +-- | Click-through URL of this companion click-through override. +cctoClickThroughURL :: Lens' CompanionClickThroughOverride (Maybe ClickThroughURL) +cctoClickThroughURL + = lens _cctoClickThroughURL + (\ s a -> s{_cctoClickThroughURL = a}) + +instance FromJSON CompanionClickThroughOverride where + parseJSON + = withObject "CompanionClickThroughOverride" + (\ o -> + CompanionClickThroughOverride' <$> + (o .:? "creativeId") <*> (o .:? "clickThroughUrl")) + +instance ToJSON CompanionClickThroughOverride where + toJSON CompanionClickThroughOverride'{..} + = object + (catMaybes + [("creativeId" .=) <$> _cctoCreativeId, + ("clickThroughUrl" .=) <$> _cctoClickThroughURL]) + +-- | Advertiser List Response +-- +-- /See:/ 'advertisersListResponse' smart constructor. +data AdvertisersListResponse = + AdvertisersListResponse' + { _advNextPageToken :: !(Maybe Text) + , _advKind :: !Text + , _advAdvertisers :: !(Maybe [Advertiser]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'AdvertisersListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'advNextPageToken' +-- +-- * 'advKind' +-- +-- * 'advAdvertisers' +advertisersListResponse + :: AdvertisersListResponse +advertisersListResponse = + AdvertisersListResponse' + { _advNextPageToken = Nothing + , _advKind = "dfareporting#advertisersListResponse" + , _advAdvertisers = Nothing + } + + +-- | Pagination token to be used for the next list operation. +advNextPageToken :: Lens' AdvertisersListResponse (Maybe Text) +advNextPageToken + = lens _advNextPageToken + (\ s a -> s{_advNextPageToken = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#advertisersListResponse\". +advKind :: Lens' AdvertisersListResponse Text +advKind = lens _advKind (\ s a -> s{_advKind = a}) + +-- | Advertiser collection. +advAdvertisers :: Lens' AdvertisersListResponse [Advertiser] +advAdvertisers + = lens _advAdvertisers + (\ s a -> s{_advAdvertisers = a}) + . _Default + . _Coerce + +instance FromJSON AdvertisersListResponse where + parseJSON + = withObject "AdvertisersListResponse" + (\ o -> + AdvertisersListResponse' <$> + (o .:? "nextPageToken") <*> + (o .:? "kind" .!= + "dfareporting#advertisersListResponse") + <*> (o .:? "advertisers" .!= mempty)) + +instance ToJSON AdvertisersListResponse where + toJSON AdvertisersListResponse'{..} + = object + (catMaybes + [("nextPageToken" .=) <$> _advNextPageToken, + Just ("kind" .= _advKind), + ("advertisers" .=) <$> _advAdvertisers]) + +-- | Country List Response +-- +-- /See:/ 'countriesListResponse' smart constructor. +data CountriesListResponse = + CountriesListResponse' + { _couKind :: !Text + , _couCountries :: !(Maybe [Country]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'CountriesListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'couKind' +-- +-- * 'couCountries' +countriesListResponse + :: CountriesListResponse +countriesListResponse = + CountriesListResponse' + {_couKind = "dfareporting#countriesListResponse", _couCountries = Nothing} + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#countriesListResponse\". +couKind :: Lens' CountriesListResponse Text +couKind = lens _couKind (\ s a -> s{_couKind = a}) + +-- | Country collection. +couCountries :: Lens' CountriesListResponse [Country] +couCountries + = lens _couCountries (\ s a -> s{_couCountries = a}) + . _Default + . _Coerce + +instance FromJSON CountriesListResponse where + parseJSON + = withObject "CountriesListResponse" + (\ o -> + CountriesListResponse' <$> + (o .:? "kind" .!= + "dfareporting#countriesListResponse") + <*> (o .:? "countries" .!= mempty)) + +instance ToJSON CountriesListResponse where + toJSON CountriesListResponse'{..} + = object + (catMaybes + [Just ("kind" .= _couKind), + ("countries" .=) <$> _couCountries]) + +-- | Account Permission Group List Response +-- +-- /See:/ 'accountPermissionGroupsListResponse' smart constructor. +data AccountPermissionGroupsListResponse = + AccountPermissionGroupsListResponse' + { _apglrKind :: !Text + , _apglrAccountPermissionGroups :: !(Maybe [AccountPermissionGroup]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'AccountPermissionGroupsListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'apglrKind' +-- +-- * 'apglrAccountPermissionGroups' +accountPermissionGroupsListResponse + :: AccountPermissionGroupsListResponse +accountPermissionGroupsListResponse = + AccountPermissionGroupsListResponse' + { _apglrKind = "dfareporting#accountPermissionGroupsListResponse" + , _apglrAccountPermissionGroups = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#accountPermissionGroupsListResponse\". +apglrKind :: Lens' AccountPermissionGroupsListResponse Text +apglrKind + = lens _apglrKind (\ s a -> s{_apglrKind = a}) + +-- | Account permission group collection. +apglrAccountPermissionGroups :: Lens' AccountPermissionGroupsListResponse [AccountPermissionGroup] +apglrAccountPermissionGroups + = lens _apglrAccountPermissionGroups + (\ s a -> s{_apglrAccountPermissionGroups = a}) + . _Default + . _Coerce + +instance FromJSON AccountPermissionGroupsListResponse + where + parseJSON + = withObject "AccountPermissionGroupsListResponse" + (\ o -> + AccountPermissionGroupsListResponse' <$> + (o .:? "kind" .!= + "dfareporting#accountPermissionGroupsListResponse") + <*> (o .:? "accountPermissionGroups" .!= mempty)) + +instance ToJSON AccountPermissionGroupsListResponse + where + toJSON AccountPermissionGroupsListResponse'{..} + = object + (catMaybes + [Just ("kind" .= _apglrKind), + ("accountPermissionGroups" .=) <$> + _apglrAccountPermissionGroups]) + +-- | Popup Window Properties. +-- +-- /See:/ 'popupWindowProperties' smart constructor. +data PopupWindowProperties = + PopupWindowProperties' + { _pwpOffSet :: !(Maybe OffSetPosition) + , _pwpDimension :: !(Maybe Size) + , _pwpShowStatusBar :: !(Maybe Bool) + , _pwpShowMenuBar :: !(Maybe Bool) + , _pwpPositionType :: !(Maybe PopupWindowPropertiesPositionType) + , _pwpShowAddressBar :: !(Maybe Bool) + , _pwpShowScrollBar :: !(Maybe Bool) + , _pwpShowToolBar :: !(Maybe Bool) + , _pwpTitle :: !(Maybe Text) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'PopupWindowProperties' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'pwpOffSet' +-- +-- * 'pwpDimension' +-- +-- * 'pwpShowStatusBar' +-- +-- * 'pwpShowMenuBar' +-- +-- * 'pwpPositionType' +-- +-- * 'pwpShowAddressBar' +-- +-- * 'pwpShowScrollBar' +-- +-- * 'pwpShowToolBar' +-- +-- * 'pwpTitle' +popupWindowProperties + :: PopupWindowProperties +popupWindowProperties = + PopupWindowProperties' + { _pwpOffSet = Nothing + , _pwpDimension = Nothing + , _pwpShowStatusBar = Nothing + , _pwpShowMenuBar = Nothing + , _pwpPositionType = Nothing + , _pwpShowAddressBar = Nothing + , _pwpShowScrollBar = Nothing + , _pwpShowToolBar = Nothing + , _pwpTitle = Nothing + } + + +-- | Upper-left corner coordinates of the popup window. Applicable if +-- positionType is COORDINATES. +pwpOffSet :: Lens' PopupWindowProperties (Maybe OffSetPosition) +pwpOffSet + = lens _pwpOffSet (\ s a -> s{_pwpOffSet = a}) + +-- | Popup dimension for a creative. This is a read-only field. Applicable to +-- the following creative types: all RICH_MEDIA and all VPAID +pwpDimension :: Lens' PopupWindowProperties (Maybe Size) +pwpDimension + = lens _pwpDimension (\ s a -> s{_pwpDimension = a}) + +-- | Whether to display the browser status bar. +pwpShowStatusBar :: Lens' PopupWindowProperties (Maybe Bool) +pwpShowStatusBar + = lens _pwpShowStatusBar + (\ s a -> s{_pwpShowStatusBar = a}) + +-- | Whether to display the browser menu bar. +pwpShowMenuBar :: Lens' PopupWindowProperties (Maybe Bool) +pwpShowMenuBar + = lens _pwpShowMenuBar + (\ s a -> s{_pwpShowMenuBar = a}) + +-- | Popup window position either centered or at specific coordinate. +pwpPositionType :: Lens' PopupWindowProperties (Maybe PopupWindowPropertiesPositionType) +pwpPositionType + = lens _pwpPositionType + (\ s a -> s{_pwpPositionType = a}) + +-- | Whether to display the browser address bar. +pwpShowAddressBar :: Lens' PopupWindowProperties (Maybe Bool) +pwpShowAddressBar + = lens _pwpShowAddressBar + (\ s a -> s{_pwpShowAddressBar = a}) + +-- | Whether to display the browser scroll bar. +pwpShowScrollBar :: Lens' PopupWindowProperties (Maybe Bool) +pwpShowScrollBar + = lens _pwpShowScrollBar + (\ s a -> s{_pwpShowScrollBar = a}) + +-- | Whether to display the browser tool bar. +pwpShowToolBar :: Lens' PopupWindowProperties (Maybe Bool) +pwpShowToolBar + = lens _pwpShowToolBar + (\ s a -> s{_pwpShowToolBar = a}) + +-- | Title of popup window. +pwpTitle :: Lens' PopupWindowProperties (Maybe Text) +pwpTitle = lens _pwpTitle (\ s a -> s{_pwpTitle = a}) + +instance FromJSON PopupWindowProperties where + parseJSON + = withObject "PopupWindowProperties" + (\ o -> + PopupWindowProperties' <$> + (o .:? "offset") <*> (o .:? "dimension") <*> + (o .:? "showStatusBar") + <*> (o .:? "showMenuBar") + <*> (o .:? "positionType") + <*> (o .:? "showAddressBar") + <*> (o .:? "showScrollBar") + <*> (o .:? "showToolBar") + <*> (o .:? "title")) + +instance ToJSON PopupWindowProperties where + toJSON PopupWindowProperties'{..} + = object + (catMaybes + [("offset" .=) <$> _pwpOffSet, + ("dimension" .=) <$> _pwpDimension, + ("showStatusBar" .=) <$> _pwpShowStatusBar, + ("showMenuBar" .=) <$> _pwpShowMenuBar, + ("positionType" .=) <$> _pwpPositionType, + ("showAddressBar" .=) <$> _pwpShowAddressBar, + ("showScrollBar" .=) <$> _pwpShowScrollBar, + ("showToolBar" .=) <$> _pwpShowToolBar, + ("title" .=) <$> _pwpTitle]) + +-- | Event tag override information. +-- +-- /See:/ 'eventTagOverride' smart constructor. +data EventTagOverride = + EventTagOverride' + { _etoEnabled :: !(Maybe Bool) + , _etoId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'EventTagOverride' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'etoEnabled' +-- +-- * 'etoId' +eventTagOverride + :: EventTagOverride +eventTagOverride = EventTagOverride' {_etoEnabled = Nothing, _etoId = Nothing} + + +-- | Whether this override is enabled. +etoEnabled :: Lens' EventTagOverride (Maybe Bool) +etoEnabled + = lens _etoEnabled (\ s a -> s{_etoEnabled = a}) + +-- | ID of this event tag override. This is a read-only, auto-generated +-- field. +etoId :: Lens' EventTagOverride (Maybe Int64) +etoId + = lens _etoId (\ s a -> s{_etoId = a}) . + mapping _Coerce + +instance FromJSON EventTagOverride where + parseJSON + = withObject "EventTagOverride" + (\ o -> + EventTagOverride' <$> + (o .:? "enabled") <*> (o .:? "id")) + +instance ToJSON EventTagOverride where + toJSON EventTagOverride'{..} + = object + (catMaybes + [("enabled" .=) <$> _etoEnabled, + ("id" .=) <$> _etoId]) + +-- | Contains information about a particular version of an operating system +-- that can be targeted by ads. +-- +-- /See:/ 'operatingSystemVersion' smart constructor. +data OperatingSystemVersion = + OperatingSystemVersion' + { _osvMinorVersion :: !(Maybe Text) + , _osvKind :: !Text + , _osvOperatingSystem :: !(Maybe OperatingSystem) + , _osvMajorVersion :: !(Maybe Text) + , _osvName :: !(Maybe Text) + , _osvId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'OperatingSystemVersion' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'osvMinorVersion' +-- +-- * 'osvKind' +-- +-- * 'osvOperatingSystem' +-- +-- * 'osvMajorVersion' +-- +-- * 'osvName' +-- +-- * 'osvId' +operatingSystemVersion + :: OperatingSystemVersion +operatingSystemVersion = + OperatingSystemVersion' + { _osvMinorVersion = Nothing + , _osvKind = "dfareporting#operatingSystemVersion" + , _osvOperatingSystem = Nothing + , _osvMajorVersion = Nothing + , _osvName = Nothing + , _osvId = Nothing + } + + +-- | Minor version (number after the first dot) of this operating system +-- version. +osvMinorVersion :: Lens' OperatingSystemVersion (Maybe Text) +osvMinorVersion + = lens _osvMinorVersion + (\ s a -> s{_osvMinorVersion = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#operatingSystemVersion\". +osvKind :: Lens' OperatingSystemVersion Text +osvKind = lens _osvKind (\ s a -> s{_osvKind = a}) + +-- | Operating system of this operating system version. +osvOperatingSystem :: Lens' OperatingSystemVersion (Maybe OperatingSystem) +osvOperatingSystem + = lens _osvOperatingSystem + (\ s a -> s{_osvOperatingSystem = a}) + +-- | Major version (leftmost number) of this operating system version. +osvMajorVersion :: Lens' OperatingSystemVersion (Maybe Text) +osvMajorVersion + = lens _osvMajorVersion + (\ s a -> s{_osvMajorVersion = a}) + +-- | Name of this operating system version. +osvName :: Lens' OperatingSystemVersion (Maybe Text) +osvName = lens _osvName (\ s a -> s{_osvName = a}) + +-- | ID of this operating system version. +osvId :: Lens' OperatingSystemVersion (Maybe Int64) +osvId + = lens _osvId (\ s a -> s{_osvId = a}) . + mapping _Coerce + +instance FromJSON OperatingSystemVersion where + parseJSON + = withObject "OperatingSystemVersion" + (\ o -> + OperatingSystemVersion' <$> + (o .:? "minorVersion") <*> + (o .:? "kind" .!= + "dfareporting#operatingSystemVersion") + <*> (o .:? "operatingSystem") + <*> (o .:? "majorVersion") + <*> (o .:? "name") + <*> (o .:? "id")) + +instance ToJSON OperatingSystemVersion where + toJSON OperatingSystemVersion'{..} + = object + (catMaybes + [("minorVersion" .=) <$> _osvMinorVersion, + Just ("kind" .= _osvKind), + ("operatingSystem" .=) <$> _osvOperatingSystem, + ("majorVersion" .=) <$> _osvMajorVersion, + ("name" .=) <$> _osvName, ("id" .=) <$> _osvId]) + +-- | AccountPermissions contains information about a particular account +-- permission. Some features of Campaign Manager require an account +-- permission to be present in the account. +-- +-- /See:/ 'accountPermission' smart constructor. +data AccountPermission = + AccountPermission' + { _acccKind :: !Text + , _acccAccountProFiles :: !(Maybe [AccountPermissionAccountProFilesItem]) + , _acccName :: !(Maybe Text) + , _acccId :: !(Maybe (Textual Int64)) + , _acccLevel :: !(Maybe AccountPermissionLevel) + , _acccPermissionGroupId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'AccountPermission' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'acccKind' +-- +-- * 'acccAccountProFiles' +-- +-- * 'acccName' +-- +-- * 'acccId' +-- +-- * 'acccLevel' +-- +-- * 'acccPermissionGroupId' +accountPermission + :: AccountPermission +accountPermission = + AccountPermission' + { _acccKind = "dfareporting#accountPermission" + , _acccAccountProFiles = Nothing + , _acccName = Nothing + , _acccId = Nothing + , _acccLevel = Nothing + , _acccPermissionGroupId = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#accountPermission\". +acccKind :: Lens' AccountPermission Text +acccKind = lens _acccKind (\ s a -> s{_acccKind = a}) + +-- | Account profiles associated with this account permission. Possible +-- values are: - \"ACCOUNT_PROFILE_BASIC\" - \"ACCOUNT_PROFILE_STANDARD\" +acccAccountProFiles :: Lens' AccountPermission [AccountPermissionAccountProFilesItem] +acccAccountProFiles + = lens _acccAccountProFiles + (\ s a -> s{_acccAccountProFiles = a}) + . _Default + . _Coerce + +-- | Name of this account permission. +acccName :: Lens' AccountPermission (Maybe Text) +acccName = lens _acccName (\ s a -> s{_acccName = a}) + +-- | ID of this account permission. +acccId :: Lens' AccountPermission (Maybe Int64) +acccId + = lens _acccId (\ s a -> s{_acccId = a}) . + mapping _Coerce + +-- | Administrative level required to enable this account permission. +acccLevel :: Lens' AccountPermission (Maybe AccountPermissionLevel) +acccLevel + = lens _acccLevel (\ s a -> s{_acccLevel = a}) + +-- | Permission group of this account permission. +acccPermissionGroupId :: Lens' AccountPermission (Maybe Int64) +acccPermissionGroupId + = lens _acccPermissionGroupId + (\ s a -> s{_acccPermissionGroupId = a}) + . mapping _Coerce + +instance FromJSON AccountPermission where + parseJSON + = withObject "AccountPermission" + (\ o -> + AccountPermission' <$> + (o .:? "kind" .!= "dfareporting#accountPermission") + <*> (o .:? "accountProfiles" .!= mempty) + <*> (o .:? "name") + <*> (o .:? "id") + <*> (o .:? "level") + <*> (o .:? "permissionGroupId")) + +instance ToJSON AccountPermission where + toJSON AccountPermission'{..} + = object + (catMaybes + [Just ("kind" .= _acccKind), + ("accountProfiles" .=) <$> _acccAccountProFiles, + ("name" .=) <$> _acccName, ("id" .=) <$> _acccId, + ("level" .=) <$> _acccLevel, + ("permissionGroupId" .=) <$> _acccPermissionGroupId]) + +-- | Represents a UserProfile resource. +-- +-- /See:/ 'userProFile' smart constructor. +data UserProFile = + UserProFile' + { _upfEtag :: !(Maybe Text) + , _upfKind :: !Text + , _upfAccountName :: !(Maybe Text) + , _upfProFileId :: !(Maybe (Textual Int64)) + , _upfUserName :: !(Maybe Text) + , _upfAccountId :: !(Maybe (Textual Int64)) + , _upfSubAccountName :: !(Maybe Text) + , _upfSubAccountId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'UserProFile' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'upfEtag' +-- +-- * 'upfKind' +-- +-- * 'upfAccountName' +-- +-- * 'upfProFileId' +-- +-- * 'upfUserName' +-- +-- * 'upfAccountId' +-- +-- * 'upfSubAccountName' +-- +-- * 'upfSubAccountId' +userProFile + :: UserProFile +userProFile = + UserProFile' + { _upfEtag = Nothing + , _upfKind = "dfareporting#userProfile" + , _upfAccountName = Nothing + , _upfProFileId = Nothing + , _upfUserName = Nothing + , _upfAccountId = Nothing + , _upfSubAccountName = Nothing + , _upfSubAccountId = Nothing + } + + +-- | The eTag of this response for caching purposes. +upfEtag :: Lens' UserProFile (Maybe Text) +upfEtag = lens _upfEtag (\ s a -> s{_upfEtag = a}) + +-- | The kind of resource this is, in this case dfareporting#userProfile. +upfKind :: Lens' UserProFile Text +upfKind = lens _upfKind (\ s a -> s{_upfKind = a}) + +-- | The account name this profile belongs to. +upfAccountName :: Lens' UserProFile (Maybe Text) +upfAccountName + = lens _upfAccountName + (\ s a -> s{_upfAccountName = a}) + +-- | The unique ID of the user profile. +upfProFileId :: Lens' UserProFile (Maybe Int64) +upfProFileId + = lens _upfProFileId (\ s a -> s{_upfProFileId = a}) + . mapping _Coerce + +-- | The user name. +upfUserName :: Lens' UserProFile (Maybe Text) +upfUserName + = lens _upfUserName (\ s a -> s{_upfUserName = a}) + +-- | The account ID to which this profile belongs. +upfAccountId :: Lens' UserProFile (Maybe Int64) +upfAccountId + = lens _upfAccountId (\ s a -> s{_upfAccountId = a}) + . mapping _Coerce + +-- | The sub account name this profile belongs to if applicable. +upfSubAccountName :: Lens' UserProFile (Maybe Text) +upfSubAccountName + = lens _upfSubAccountName + (\ s a -> s{_upfSubAccountName = a}) + +-- | The sub account ID this profile belongs to if applicable. +upfSubAccountId :: Lens' UserProFile (Maybe Int64) +upfSubAccountId + = lens _upfSubAccountId + (\ s a -> s{_upfSubAccountId = a}) + . mapping _Coerce + +instance FromJSON UserProFile where + parseJSON + = withObject "UserProFile" + (\ o -> + UserProFile' <$> + (o .:? "etag") <*> + (o .:? "kind" .!= "dfareporting#userProfile") + <*> (o .:? "accountName") + <*> (o .:? "profileId") + <*> (o .:? "userName") + <*> (o .:? "accountId") + <*> (o .:? "subAccountName") + <*> (o .:? "subAccountId")) + +instance ToJSON UserProFile where + toJSON UserProFile'{..} + = object + (catMaybes + [("etag" .=) <$> _upfEtag, Just ("kind" .= _upfKind), + ("accountName" .=) <$> _upfAccountName, + ("profileId" .=) <$> _upfProFileId, + ("userName" .=) <$> _upfUserName, + ("accountId" .=) <$> _upfAccountId, + ("subAccountName" .=) <$> _upfSubAccountName, + ("subAccountId" .=) <$> _upfSubAccountId]) + +-- | Operating System List Response +-- +-- /See:/ 'operatingSystemsListResponse' smart constructor. +data OperatingSystemsListResponse = + OperatingSystemsListResponse' + { _oslrKind :: !Text + , _oslrOperatingSystems :: !(Maybe [OperatingSystem]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'OperatingSystemsListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'oslrKind' +-- +-- * 'oslrOperatingSystems' +operatingSystemsListResponse + :: OperatingSystemsListResponse +operatingSystemsListResponse = + OperatingSystemsListResponse' + { _oslrKind = "dfareporting#operatingSystemsListResponse" + , _oslrOperatingSystems = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#operatingSystemsListResponse\". +oslrKind :: Lens' OperatingSystemsListResponse Text +oslrKind = lens _oslrKind (\ s a -> s{_oslrKind = a}) + +-- | Operating system collection. +oslrOperatingSystems :: Lens' OperatingSystemsListResponse [OperatingSystem] +oslrOperatingSystems + = lens _oslrOperatingSystems + (\ s a -> s{_oslrOperatingSystems = a}) + . _Default + . _Coerce + +instance FromJSON OperatingSystemsListResponse where + parseJSON + = withObject "OperatingSystemsListResponse" + (\ o -> + OperatingSystemsListResponse' <$> + (o .:? "kind" .!= + "dfareporting#operatingSystemsListResponse") + <*> (o .:? "operatingSystems" .!= mempty)) + +instance ToJSON OperatingSystemsListResponse where + toJSON OperatingSystemsListResponse'{..} + = object + (catMaybes + [Just ("kind" .= _oslrKind), + ("operatingSystems" .=) <$> _oslrOperatingSystems]) + +-- | The report\'s email delivery settings. +-- +-- /See:/ 'reportDelivery' smart constructor. +data ReportDelivery = + ReportDelivery' + { _rdEmailOwner :: !(Maybe Bool) + , _rdRecipients :: !(Maybe [Recipient]) + , _rdMessage :: !(Maybe Text) + , _rdEmailOwnerDeliveryType :: !(Maybe ReportDeliveryEmailOwnerDeliveryType) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ReportDelivery' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'rdEmailOwner' +-- +-- * 'rdRecipients' +-- +-- * 'rdMessage' +-- +-- * 'rdEmailOwnerDeliveryType' +reportDelivery + :: ReportDelivery +reportDelivery = + ReportDelivery' + { _rdEmailOwner = Nothing + , _rdRecipients = Nothing + , _rdMessage = Nothing + , _rdEmailOwnerDeliveryType = Nothing + } + + +-- | Whether the report should be emailed to the report owner. +rdEmailOwner :: Lens' ReportDelivery (Maybe Bool) +rdEmailOwner + = lens _rdEmailOwner (\ s a -> s{_rdEmailOwner = a}) + +-- | The list of recipients to which to email the report. +rdRecipients :: Lens' ReportDelivery [Recipient] +rdRecipients + = lens _rdRecipients (\ s a -> s{_rdRecipients = a}) + . _Default + . _Coerce + +-- | The message to be sent with each email. +rdMessage :: Lens' ReportDelivery (Maybe Text) +rdMessage + = lens _rdMessage (\ s a -> s{_rdMessage = a}) + +-- | The type of delivery for the owner to receive, if enabled. +rdEmailOwnerDeliveryType :: Lens' ReportDelivery (Maybe ReportDeliveryEmailOwnerDeliveryType) +rdEmailOwnerDeliveryType + = lens _rdEmailOwnerDeliveryType + (\ s a -> s{_rdEmailOwnerDeliveryType = a}) + +instance FromJSON ReportDelivery where + parseJSON + = withObject "ReportDelivery" + (\ o -> + ReportDelivery' <$> + (o .:? "emailOwner") <*> + (o .:? "recipients" .!= mempty) + <*> (o .:? "message") + <*> (o .:? "emailOwnerDeliveryType")) + +instance ToJSON ReportDelivery where + toJSON ReportDelivery'{..} + = object + (catMaybes + [("emailOwner" .=) <$> _rdEmailOwner, + ("recipients" .=) <$> _rdRecipients, + ("message" .=) <$> _rdMessage, + ("emailOwnerDeliveryType" .=) <$> + _rdEmailOwnerDeliveryType]) + +-- | Contains properties of a targetable remarketing list. Remarketing +-- enables you to create lists of users who have performed specific actions +-- on a site, then target ads to members of those lists. This resource is a +-- read-only view of a remarketing list to be used to faciliate targeting +-- ads to specific lists. Remarketing lists that are owned by your +-- advertisers and those that are shared to your advertisers or account are +-- accessible via this resource. To manage remarketing lists that are owned +-- by your advertisers, use the RemarketingLists resource. +-- +-- /See:/ 'targetableRemarketingList' smart constructor. +data TargetableRemarketingList = + TargetableRemarketingList' + { _trlListSize :: !(Maybe (Textual Int64)) + , _trlLifeSpan :: !(Maybe (Textual Int64)) + , _trlKind :: !Text + , _trlAdvertiserId :: !(Maybe (Textual Int64)) + , _trlAdvertiserIdDimensionValue :: !(Maybe DimensionValue) + , _trlActive :: !(Maybe Bool) + , _trlAccountId :: !(Maybe (Textual Int64)) + , _trlName :: !(Maybe Text) + , _trlListSource :: !(Maybe TargetableRemarketingListListSource) + , _trlId :: !(Maybe (Textual Int64)) + , _trlSubAccountId :: !(Maybe (Textual Int64)) + , _trlDescription :: !(Maybe Text) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'TargetableRemarketingList' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'trlListSize' +-- +-- * 'trlLifeSpan' +-- +-- * 'trlKind' +-- +-- * 'trlAdvertiserId' +-- +-- * 'trlAdvertiserIdDimensionValue' +-- +-- * 'trlActive' +-- +-- * 'trlAccountId' +-- +-- * 'trlName' +-- +-- * 'trlListSource' +-- +-- * 'trlId' +-- +-- * 'trlSubAccountId' +-- +-- * 'trlDescription' +targetableRemarketingList + :: TargetableRemarketingList +targetableRemarketingList = + TargetableRemarketingList' + { _trlListSize = Nothing + , _trlLifeSpan = Nothing + , _trlKind = "dfareporting#targetableRemarketingList" + , _trlAdvertiserId = Nothing + , _trlAdvertiserIdDimensionValue = Nothing + , _trlActive = Nothing + , _trlAccountId = Nothing + , _trlName = Nothing + , _trlListSource = Nothing + , _trlId = Nothing + , _trlSubAccountId = Nothing + , _trlDescription = Nothing + } + + +-- | Number of users currently in the list. This is a read-only field. +trlListSize :: Lens' TargetableRemarketingList (Maybe Int64) +trlListSize + = lens _trlListSize (\ s a -> s{_trlListSize = a}) . + mapping _Coerce + +-- | Number of days that a user should remain in the targetable remarketing +-- list without an impression. +trlLifeSpan :: Lens' TargetableRemarketingList (Maybe Int64) +trlLifeSpan + = lens _trlLifeSpan (\ s a -> s{_trlLifeSpan = a}) . + mapping _Coerce + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#targetableRemarketingList\". +trlKind :: Lens' TargetableRemarketingList Text +trlKind = lens _trlKind (\ s a -> s{_trlKind = a}) + +-- | Dimension value for the advertiser ID that owns this targetable +-- remarketing list. +trlAdvertiserId :: Lens' TargetableRemarketingList (Maybe Int64) +trlAdvertiserId + = lens _trlAdvertiserId + (\ s a -> s{_trlAdvertiserId = a}) + . mapping _Coerce + +-- | Dimension value for the ID of the advertiser. +trlAdvertiserIdDimensionValue :: Lens' TargetableRemarketingList (Maybe DimensionValue) +trlAdvertiserIdDimensionValue + = lens _trlAdvertiserIdDimensionValue + (\ s a -> s{_trlAdvertiserIdDimensionValue = a}) + +-- | Whether this targetable remarketing list is active. +trlActive :: Lens' TargetableRemarketingList (Maybe Bool) +trlActive + = lens _trlActive (\ s a -> s{_trlActive = a}) + +-- | Account ID of this remarketing list. This is a read-only, auto-generated +-- field that is only returned in GET requests. +trlAccountId :: Lens' TargetableRemarketingList (Maybe Int64) +trlAccountId + = lens _trlAccountId (\ s a -> s{_trlAccountId = a}) + . mapping _Coerce + +-- | Name of the targetable remarketing list. Is no greater than 128 +-- characters long. +trlName :: Lens' TargetableRemarketingList (Maybe Text) +trlName = lens _trlName (\ s a -> s{_trlName = a}) + +-- | Product from which this targetable remarketing list was originated. +trlListSource :: Lens' TargetableRemarketingList (Maybe TargetableRemarketingListListSource) +trlListSource + = lens _trlListSource + (\ s a -> s{_trlListSource = a}) + +-- | Targetable remarketing list ID. +trlId :: Lens' TargetableRemarketingList (Maybe Int64) +trlId + = lens _trlId (\ s a -> s{_trlId = a}) . + mapping _Coerce + +-- | Subaccount ID of this remarketing list. This is a read-only, +-- auto-generated field that is only returned in GET requests. +trlSubAccountId :: Lens' TargetableRemarketingList (Maybe Int64) +trlSubAccountId + = lens _trlSubAccountId + (\ s a -> s{_trlSubAccountId = a}) + . mapping _Coerce + +-- | Targetable remarketing list description. +trlDescription :: Lens' TargetableRemarketingList (Maybe Text) +trlDescription + = lens _trlDescription + (\ s a -> s{_trlDescription = a}) + +instance FromJSON TargetableRemarketingList where + parseJSON + = withObject "TargetableRemarketingList" + (\ o -> + TargetableRemarketingList' <$> + (o .:? "listSize") <*> (o .:? "lifeSpan") <*> + (o .:? "kind" .!= + "dfareporting#targetableRemarketingList") + <*> (o .:? "advertiserId") + <*> (o .:? "advertiserIdDimensionValue") + <*> (o .:? "active") + <*> (o .:? "accountId") + <*> (o .:? "name") + <*> (o .:? "listSource") + <*> (o .:? "id") + <*> (o .:? "subaccountId") + <*> (o .:? "description")) + +instance ToJSON TargetableRemarketingList where + toJSON TargetableRemarketingList'{..} + = object + (catMaybes + [("listSize" .=) <$> _trlListSize, + ("lifeSpan" .=) <$> _trlLifeSpan, + Just ("kind" .= _trlKind), + ("advertiserId" .=) <$> _trlAdvertiserId, + ("advertiserIdDimensionValue" .=) <$> + _trlAdvertiserIdDimensionValue, + ("active" .=) <$> _trlActive, + ("accountId" .=) <$> _trlAccountId, + ("name" .=) <$> _trlName, + ("listSource" .=) <$> _trlListSource, + ("id" .=) <$> _trlId, + ("subaccountId" .=) <$> _trlSubAccountId, + ("description" .=) <$> _trlDescription]) + +-- | Postal Code List Response +-- +-- /See:/ 'postalCodesListResponse' smart constructor. +data PostalCodesListResponse = + PostalCodesListResponse' + { _pclrKind :: !Text + , _pclrPostalCodes :: !(Maybe [PostalCode]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'PostalCodesListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'pclrKind' +-- +-- * 'pclrPostalCodes' +postalCodesListResponse + :: PostalCodesListResponse +postalCodesListResponse = + PostalCodesListResponse' + { _pclrKind = "dfareporting#postalCodesListResponse" + , _pclrPostalCodes = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#postalCodesListResponse\". +pclrKind :: Lens' PostalCodesListResponse Text +pclrKind = lens _pclrKind (\ s a -> s{_pclrKind = a}) + +-- | Postal code collection. +pclrPostalCodes :: Lens' PostalCodesListResponse [PostalCode] +pclrPostalCodes + = lens _pclrPostalCodes + (\ s a -> s{_pclrPostalCodes = a}) + . _Default + . _Coerce + +instance FromJSON PostalCodesListResponse where + parseJSON + = withObject "PostalCodesListResponse" + (\ o -> + PostalCodesListResponse' <$> + (o .:? "kind" .!= + "dfareporting#postalCodesListResponse") + <*> (o .:? "postalCodes" .!= mempty)) + +instance ToJSON PostalCodesListResponse where + toJSON PostalCodesListResponse'{..} + = object + (catMaybes + [Just ("kind" .= _pclrKind), + ("postalCodes" .=) <$> _pclrPostalCodes]) + +-- | Describes a change that a user has made to a resource. +-- +-- /See:/ 'changeLog' smart constructor. +data ChangeLog = + ChangeLog' + { _chaUserProFileId :: !(Maybe (Textual Int64)) + , _chaObjectType :: !(Maybe Text) + , _chaUserProFileName :: !(Maybe Text) + , _chaKind :: !Text + , _chaObjectId :: !(Maybe (Textual Int64)) + , _chaAction :: !(Maybe Text) + , _chaTransactionId :: !(Maybe (Textual Int64)) + , _chaOldValue :: !(Maybe Text) + , _chaAccountId :: !(Maybe (Textual Int64)) + , _chaNewValue :: !(Maybe Text) + , _chaFieldName :: !(Maybe Text) + , _chaId :: !(Maybe (Textual Int64)) + , _chaSubAccountId :: !(Maybe (Textual Int64)) + , _chaChangeTime :: !(Maybe DateTime') + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ChangeLog' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'chaUserProFileId' +-- +-- * 'chaObjectType' +-- +-- * 'chaUserProFileName' +-- +-- * 'chaKind' +-- +-- * 'chaObjectId' +-- +-- * 'chaAction' +-- +-- * 'chaTransactionId' +-- +-- * 'chaOldValue' +-- +-- * 'chaAccountId' +-- +-- * 'chaNewValue' +-- +-- * 'chaFieldName' +-- +-- * 'chaId' +-- +-- * 'chaSubAccountId' +-- +-- * 'chaChangeTime' +changeLog + :: ChangeLog +changeLog = + ChangeLog' + { _chaUserProFileId = Nothing + , _chaObjectType = Nothing + , _chaUserProFileName = Nothing + , _chaKind = "dfareporting#changeLog" + , _chaObjectId = Nothing + , _chaAction = Nothing + , _chaTransactionId = Nothing + , _chaOldValue = Nothing + , _chaAccountId = Nothing + , _chaNewValue = Nothing + , _chaFieldName = Nothing + , _chaId = Nothing + , _chaSubAccountId = Nothing + , _chaChangeTime = Nothing + } + + +-- | ID of the user who modified the object. +chaUserProFileId :: Lens' ChangeLog (Maybe Int64) +chaUserProFileId + = lens _chaUserProFileId + (\ s a -> s{_chaUserProFileId = a}) + . mapping _Coerce + +-- | Object type of the change log. +chaObjectType :: Lens' ChangeLog (Maybe Text) +chaObjectType + = lens _chaObjectType + (\ s a -> s{_chaObjectType = a}) + +-- | User profile name of the user who modified the object. +chaUserProFileName :: Lens' ChangeLog (Maybe Text) +chaUserProFileName + = lens _chaUserProFileName + (\ s a -> s{_chaUserProFileName = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#changeLog\". +chaKind :: Lens' ChangeLog Text +chaKind = lens _chaKind (\ s a -> s{_chaKind = a}) + +-- | ID of the object of this change log. The object could be a campaign, +-- placement, ad, or other type. +chaObjectId :: Lens' ChangeLog (Maybe Int64) +chaObjectId + = lens _chaObjectId (\ s a -> s{_chaObjectId = a}) . + mapping _Coerce + +-- | Action which caused the change. +chaAction :: Lens' ChangeLog (Maybe Text) +chaAction + = lens _chaAction (\ s a -> s{_chaAction = a}) + +-- | Transaction ID of this change log. When a single API call results in +-- many changes, each change will have a separate ID in the change log but +-- will share the same transactionId. +chaTransactionId :: Lens' ChangeLog (Maybe Int64) +chaTransactionId + = lens _chaTransactionId + (\ s a -> s{_chaTransactionId = a}) + . mapping _Coerce + +-- | Old value of the object field. +chaOldValue :: Lens' ChangeLog (Maybe Text) +chaOldValue + = lens _chaOldValue (\ s a -> s{_chaOldValue = a}) + +-- | Account ID of the modified object. +chaAccountId :: Lens' ChangeLog (Maybe Int64) +chaAccountId + = lens _chaAccountId (\ s a -> s{_chaAccountId = a}) + . mapping _Coerce + +-- | New value of the object field. +chaNewValue :: Lens' ChangeLog (Maybe Text) +chaNewValue + = lens _chaNewValue (\ s a -> s{_chaNewValue = a}) + +-- | Field name of the object which changed. +chaFieldName :: Lens' ChangeLog (Maybe Text) +chaFieldName + = lens _chaFieldName (\ s a -> s{_chaFieldName = a}) + +-- | ID of this change log. +chaId :: Lens' ChangeLog (Maybe Int64) +chaId + = lens _chaId (\ s a -> s{_chaId = a}) . + mapping _Coerce + +-- | Subaccount ID of the modified object. +chaSubAccountId :: Lens' ChangeLog (Maybe Int64) +chaSubAccountId + = lens _chaSubAccountId + (\ s a -> s{_chaSubAccountId = a}) + . mapping _Coerce + +-- | Time when the object was modified. +chaChangeTime :: Lens' ChangeLog (Maybe UTCTime) +chaChangeTime + = lens _chaChangeTime + (\ s a -> s{_chaChangeTime = a}) + . mapping _DateTime + +instance FromJSON ChangeLog where + parseJSON + = withObject "ChangeLog" + (\ o -> + ChangeLog' <$> + (o .:? "userProfileId") <*> (o .:? "objectType") <*> + (o .:? "userProfileName") + <*> (o .:? "kind" .!= "dfareporting#changeLog") + <*> (o .:? "objectId") + <*> (o .:? "action") + <*> (o .:? "transactionId") + <*> (o .:? "oldValue") + <*> (o .:? "accountId") + <*> (o .:? "newValue") + <*> (o .:? "fieldName") + <*> (o .:? "id") + <*> (o .:? "subaccountId") + <*> (o .:? "changeTime")) + +instance ToJSON ChangeLog where + toJSON ChangeLog'{..} + = object + (catMaybes + [("userProfileId" .=) <$> _chaUserProFileId, + ("objectType" .=) <$> _chaObjectType, + ("userProfileName" .=) <$> _chaUserProFileName, + Just ("kind" .= _chaKind), + ("objectId" .=) <$> _chaObjectId, + ("action" .=) <$> _chaAction, + ("transactionId" .=) <$> _chaTransactionId, + ("oldValue" .=) <$> _chaOldValue, + ("accountId" .=) <$> _chaAccountId, + ("newValue" .=) <$> _chaNewValue, + ("fieldName" .=) <$> _chaFieldName, + ("id" .=) <$> _chaId, + ("subaccountId" .=) <$> _chaSubAccountId, + ("changeTime" .=) <$> _chaChangeTime]) + +-- | Contains information about a language that can be targeted by ads. +-- +-- /See:/ 'language' smart constructor. +data Language = + Language' + { _lLanguageCode :: !(Maybe Text) + , _lKind :: !Text + , _lName :: !(Maybe Text) + , _lId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'Language' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'lLanguageCode' +-- +-- * 'lKind' +-- +-- * 'lName' +-- +-- * 'lId' +language + :: Language +language = + Language' + { _lLanguageCode = Nothing + , _lKind = "dfareporting#language" + , _lName = Nothing + , _lId = Nothing + } + + +-- | Format of language code is an ISO 639 two-letter language code +-- optionally followed by an underscore followed by an ISO 3166 code. +-- Examples are \"en\" for English or \"zh_CN\" for Simplified Chinese. +lLanguageCode :: Lens' Language (Maybe Text) +lLanguageCode + = lens _lLanguageCode + (\ s a -> s{_lLanguageCode = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#language\". +lKind :: Lens' Language Text +lKind = lens _lKind (\ s a -> s{_lKind = a}) + +-- | Name of this language. +lName :: Lens' Language (Maybe Text) +lName = lens _lName (\ s a -> s{_lName = a}) + +-- | Language ID of this language. This is the ID used for targeting and +-- generating reports. +lId :: Lens' Language (Maybe Int64) +lId + = lens _lId (\ s a -> s{_lId = a}) . mapping _Coerce + +instance FromJSON Language where + parseJSON + = withObject "Language" + (\ o -> + Language' <$> + (o .:? "languageCode") <*> + (o .:? "kind" .!= "dfareporting#language") + <*> (o .:? "name") + <*> (o .:? "id")) + +instance ToJSON Language where + toJSON Language'{..} + = object + (catMaybes + [("languageCode" .=) <$> _lLanguageCode, + Just ("kind" .= _lKind), ("name" .=) <$> _lName, + ("id" .=) <$> _lId]) + +-- | Contains properties of a placement strategy. +-- +-- /See:/ 'placementStrategy' smart constructor. +data PlacementStrategy = + PlacementStrategy' + { _psKind :: !Text + , _psAccountId :: !(Maybe (Textual Int64)) + , _psName :: !(Maybe Text) + , _psId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'PlacementStrategy' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'psKind' +-- +-- * 'psAccountId' +-- +-- * 'psName' +-- +-- * 'psId' +placementStrategy + :: PlacementStrategy +placementStrategy = + PlacementStrategy' + { _psKind = "dfareporting#placementStrategy" + , _psAccountId = Nothing + , _psName = Nothing + , _psId = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#placementStrategy\". +psKind :: Lens' PlacementStrategy Text +psKind = lens _psKind (\ s a -> s{_psKind = a}) + +-- | Account ID of this placement strategy.This is a read-only field that can +-- be left blank. +psAccountId :: Lens' PlacementStrategy (Maybe Int64) +psAccountId + = lens _psAccountId (\ s a -> s{_psAccountId = a}) . + mapping _Coerce + +-- | Name of this placement strategy. This is a required field. It must be +-- less than 256 characters long and unique among placement strategies of +-- the same account. +psName :: Lens' PlacementStrategy (Maybe Text) +psName = lens _psName (\ s a -> s{_psName = a}) + +-- | ID of this placement strategy. This is a read-only, auto-generated +-- field. +psId :: Lens' PlacementStrategy (Maybe Int64) +psId + = lens _psId (\ s a -> s{_psId = a}) . + mapping _Coerce + +instance FromJSON PlacementStrategy where + parseJSON + = withObject "PlacementStrategy" + (\ o -> + PlacementStrategy' <$> + (o .:? "kind" .!= "dfareporting#placementStrategy") + <*> (o .:? "accountId") + <*> (o .:? "name") + <*> (o .:? "id")) + +instance ToJSON PlacementStrategy where + toJSON PlacementStrategy'{..} + = object + (catMaybes + [Just ("kind" .= _psKind), + ("accountId" .=) <$> _psAccountId, + ("name" .=) <$> _psName, ("id" .=) <$> _psId]) + +-- | Contains properties of a Floodlight activity. +-- +-- /See:/ 'floodlightActivity' smart constructor. +data FloodlightActivity = + FloodlightActivity' + { _faCountingMethod :: !(Maybe FloodlightActivityCountingMethod) + , _faTagString :: !(Maybe Text) + , _faSecure :: !(Maybe Bool) + , _faExpectedURL :: !(Maybe Text) + , _faFloodlightActivityGroupTagString :: !(Maybe Text) + , _faFloodlightConfigurationId :: !(Maybe (Textual Int64)) + , _faKind :: !Text + , _faAdvertiserId :: !(Maybe (Textual Int64)) + , _faAdvertiserIdDimensionValue :: !(Maybe DimensionValue) + , _faSSLCompliant :: !(Maybe Bool) + , _faIdDimensionValue :: !(Maybe DimensionValue) + , _faTagFormat :: !(Maybe FloodlightActivityTagFormat) + , _faCacheBustingType :: !(Maybe FloodlightActivityCacheBustingType) + , _faAccountId :: !(Maybe (Textual Int64)) + , _faName :: !(Maybe Text) + , _faPublisherTags :: !(Maybe [FloodlightActivityPublisherDynamicTag]) + , _faFloodlightActivityGroupId :: !(Maybe (Textual Int64)) + , _faHidden :: !(Maybe Bool) + , _faFloodlightActivityGroupType :: !(Maybe FloodlightActivityFloodlightActivityGroupType) + , _faDefaultTags :: !(Maybe [FloodlightActivityDynamicTag]) + , _faFloodlightTagType :: !(Maybe FloodlightActivityFloodlightTagType) + , _faFloodlightActivityGroupName :: !(Maybe Text) + , _faId :: !(Maybe (Textual Int64)) + , _faSSLRequired :: !(Maybe Bool) + , _faUserDefinedVariableTypes :: !(Maybe [FloodlightActivityUserDefinedVariableTypesItem]) + , _faSubAccountId :: !(Maybe (Textual Int64)) + , _faNotes :: !(Maybe Text) + , _faFloodlightConfigurationIdDimensionValue :: !(Maybe DimensionValue) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'FloodlightActivity' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'faCountingMethod' +-- +-- * 'faTagString' +-- +-- * 'faSecure' +-- +-- * 'faExpectedURL' +-- +-- * 'faFloodlightActivityGroupTagString' +-- +-- * 'faFloodlightConfigurationId' +-- +-- * 'faKind' +-- +-- * 'faAdvertiserId' +-- +-- * 'faAdvertiserIdDimensionValue' +-- +-- * 'faSSLCompliant' +-- +-- * 'faIdDimensionValue' +-- +-- * 'faTagFormat' +-- +-- * 'faCacheBustingType' +-- +-- * 'faAccountId' +-- +-- * 'faName' +-- +-- * 'faPublisherTags' +-- +-- * 'faFloodlightActivityGroupId' +-- +-- * 'faHidden' +-- +-- * 'faFloodlightActivityGroupType' +-- +-- * 'faDefaultTags' +-- +-- * 'faFloodlightTagType' +-- +-- * 'faFloodlightActivityGroupName' +-- +-- * 'faId' +-- +-- * 'faSSLRequired' +-- +-- * 'faUserDefinedVariableTypes' +-- +-- * 'faSubAccountId' +-- +-- * 'faNotes' +-- +-- * 'faFloodlightConfigurationIdDimensionValue' +floodlightActivity + :: FloodlightActivity +floodlightActivity = + FloodlightActivity' + { _faCountingMethod = Nothing + , _faTagString = Nothing + , _faSecure = Nothing + , _faExpectedURL = Nothing + , _faFloodlightActivityGroupTagString = Nothing + , _faFloodlightConfigurationId = Nothing + , _faKind = "dfareporting#floodlightActivity" + , _faAdvertiserId = Nothing + , _faAdvertiserIdDimensionValue = Nothing + , _faSSLCompliant = Nothing + , _faIdDimensionValue = Nothing + , _faTagFormat = Nothing + , _faCacheBustingType = Nothing + , _faAccountId = Nothing + , _faName = Nothing + , _faPublisherTags = Nothing + , _faFloodlightActivityGroupId = Nothing + , _faHidden = Nothing + , _faFloodlightActivityGroupType = Nothing + , _faDefaultTags = Nothing + , _faFloodlightTagType = Nothing + , _faFloodlightActivityGroupName = Nothing + , _faId = Nothing + , _faSSLRequired = Nothing + , _faUserDefinedVariableTypes = Nothing + , _faSubAccountId = Nothing + , _faNotes = Nothing + , _faFloodlightConfigurationIdDimensionValue = Nothing + } + + +-- | Counting method for conversions for this floodlight activity. This is a +-- required field. +faCountingMethod :: Lens' FloodlightActivity (Maybe FloodlightActivityCountingMethod) +faCountingMethod + = lens _faCountingMethod + (\ s a -> s{_faCountingMethod = a}) + +-- | Value of the cat= parameter in the floodlight tag, which the ad servers +-- use to identify the activity. This is optional: if empty, a new tag +-- string will be generated for you. This string must be 1 to 8 characters +-- long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag +-- string must also be unique among activities of the same activity group. +-- This field is read-only after insertion. +faTagString :: Lens' FloodlightActivity (Maybe Text) +faTagString + = lens _faTagString (\ s a -> s{_faTagString = a}) + +-- | Whether this tag should use SSL. +faSecure :: Lens' FloodlightActivity (Maybe Bool) +faSecure = lens _faSecure (\ s a -> s{_faSecure = a}) + +-- | URL where this tag will be deployed. If specified, must be less than 256 +-- characters long. +faExpectedURL :: Lens' FloodlightActivity (Maybe Text) +faExpectedURL + = lens _faExpectedURL + (\ s a -> s{_faExpectedURL = a}) + +-- | Tag string of the associated floodlight activity group. This is a +-- read-only field. +faFloodlightActivityGroupTagString :: Lens' FloodlightActivity (Maybe Text) +faFloodlightActivityGroupTagString + = lens _faFloodlightActivityGroupTagString + (\ s a -> s{_faFloodlightActivityGroupTagString = a}) + +-- | Floodlight configuration ID of this floodlight activity. If this field +-- is left blank, the value will be copied over either from the activity +-- group\'s floodlight configuration or from the existing activity\'s +-- floodlight configuration. +faFloodlightConfigurationId :: Lens' FloodlightActivity (Maybe Int64) +faFloodlightConfigurationId + = lens _faFloodlightConfigurationId + (\ s a -> s{_faFloodlightConfigurationId = a}) + . mapping _Coerce + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#floodlightActivity\". +faKind :: Lens' FloodlightActivity Text +faKind = lens _faKind (\ s a -> s{_faKind = a}) + +-- | Advertiser ID of this floodlight activity. If this field is left blank, +-- the value will be copied over either from the activity group\'s +-- advertiser or the existing activity\'s advertiser. +faAdvertiserId :: Lens' FloodlightActivity (Maybe Int64) +faAdvertiserId + = lens _faAdvertiserId + (\ s a -> s{_faAdvertiserId = a}) + . mapping _Coerce + +-- | Dimension value for the ID of the advertiser. This is a read-only, +-- auto-generated field. +faAdvertiserIdDimensionValue :: Lens' FloodlightActivity (Maybe DimensionValue) +faAdvertiserIdDimensionValue + = lens _faAdvertiserIdDimensionValue + (\ s a -> s{_faAdvertiserIdDimensionValue = a}) + +-- | Whether the floodlight activity is SSL-compliant. This is a read-only +-- field, its value detected by the system from the floodlight tags. +faSSLCompliant :: Lens' FloodlightActivity (Maybe Bool) +faSSLCompliant + = lens _faSSLCompliant + (\ s a -> s{_faSSLCompliant = a}) + +-- | Dimension value for the ID of this floodlight activity. This is a +-- read-only, auto-generated field. +faIdDimensionValue :: Lens' FloodlightActivity (Maybe DimensionValue) +faIdDimensionValue + = lens _faIdDimensionValue + (\ s a -> s{_faIdDimensionValue = a}) + +-- | Tag format type for the floodlight activity. If left blank, the tag +-- format will default to HTML. +faTagFormat :: Lens' FloodlightActivity (Maybe FloodlightActivityTagFormat) +faTagFormat + = lens _faTagFormat (\ s a -> s{_faTagFormat = a}) + +-- | Code type used for cache busting in the generated tag. Applicable only +-- when floodlightActivityGroupType is COUNTER and countingMethod is +-- STANDARD_COUNTING or UNIQUE_COUNTING. +faCacheBustingType :: Lens' FloodlightActivity (Maybe FloodlightActivityCacheBustingType) +faCacheBustingType + = lens _faCacheBustingType + (\ s a -> s{_faCacheBustingType = a}) + +-- | Account ID of this floodlight activity. This is a read-only field that +-- can be left blank. +faAccountId :: Lens' FloodlightActivity (Maybe Int64) +faAccountId + = lens _faAccountId (\ s a -> s{_faAccountId = a}) . + mapping _Coerce + +-- | Name of this floodlight activity. This is a required field. Must be less +-- than 129 characters long and cannot contain quotes. +faName :: Lens' FloodlightActivity (Maybe Text) +faName = lens _faName (\ s a -> s{_faName = a}) + +-- | Publisher dynamic floodlight tags. +faPublisherTags :: Lens' FloodlightActivity [FloodlightActivityPublisherDynamicTag] +faPublisherTags + = lens _faPublisherTags + (\ s a -> s{_faPublisherTags = a}) + . _Default + . _Coerce + +-- | Floodlight activity group ID of this floodlight activity. This is a +-- required field. +faFloodlightActivityGroupId :: Lens' FloodlightActivity (Maybe Int64) +faFloodlightActivityGroupId + = lens _faFloodlightActivityGroupId + (\ s a -> s{_faFloodlightActivityGroupId = a}) + . mapping _Coerce + +-- | Whether this activity is archived. +faHidden :: Lens' FloodlightActivity (Maybe Bool) +faHidden = lens _faHidden (\ s a -> s{_faHidden = a}) + +-- | Type of the associated floodlight activity group. This is a read-only +-- field. +faFloodlightActivityGroupType :: Lens' FloodlightActivity (Maybe FloodlightActivityFloodlightActivityGroupType) +faFloodlightActivityGroupType + = lens _faFloodlightActivityGroupType + (\ s a -> s{_faFloodlightActivityGroupType = a}) + +-- | Dynamic floodlight tags. +faDefaultTags :: Lens' FloodlightActivity [FloodlightActivityDynamicTag] +faDefaultTags + = lens _faDefaultTags + (\ s a -> s{_faDefaultTags = a}) + . _Default + . _Coerce + +-- | The type of Floodlight tag this activity will generate. This is a +-- required field. +faFloodlightTagType :: Lens' FloodlightActivity (Maybe FloodlightActivityFloodlightTagType) +faFloodlightTagType + = lens _faFloodlightTagType + (\ s a -> s{_faFloodlightTagType = a}) + +-- | Name of the associated floodlight activity group. This is a read-only +-- field. +faFloodlightActivityGroupName :: Lens' FloodlightActivity (Maybe Text) +faFloodlightActivityGroupName + = lens _faFloodlightActivityGroupName + (\ s a -> s{_faFloodlightActivityGroupName = a}) + +-- | ID of this floodlight activity. This is a read-only, auto-generated +-- field. +faId :: Lens' FloodlightActivity (Maybe Int64) +faId + = lens _faId (\ s a -> s{_faId = a}) . + mapping _Coerce + +-- | Whether this floodlight activity must be SSL-compliant. +faSSLRequired :: Lens' FloodlightActivity (Maybe Bool) +faSSLRequired + = lens _faSSLRequired + (\ s a -> s{_faSSLRequired = a}) + +-- | List of the user-defined variables used by this conversion tag. These +-- map to the \"u[1-100]=\" in the tags. Each of these can have a user +-- defined type. Acceptable values are U1 to U100, inclusive. +faUserDefinedVariableTypes :: Lens' FloodlightActivity [FloodlightActivityUserDefinedVariableTypesItem] +faUserDefinedVariableTypes + = lens _faUserDefinedVariableTypes + (\ s a -> s{_faUserDefinedVariableTypes = a}) + . _Default + . _Coerce + +-- | Subaccount ID of this floodlight activity. This is a read-only field +-- that can be left blank. +faSubAccountId :: Lens' FloodlightActivity (Maybe Int64) +faSubAccountId + = lens _faSubAccountId + (\ s a -> s{_faSubAccountId = a}) + . mapping _Coerce + +-- | General notes or implementation instructions for the tag. +faNotes :: Lens' FloodlightActivity (Maybe Text) +faNotes = lens _faNotes (\ s a -> s{_faNotes = a}) + +-- | Dimension value for the ID of the floodlight configuration. This is a +-- read-only, auto-generated field. +faFloodlightConfigurationIdDimensionValue :: Lens' FloodlightActivity (Maybe DimensionValue) +faFloodlightConfigurationIdDimensionValue + = lens _faFloodlightConfigurationIdDimensionValue + (\ s a -> + s{_faFloodlightConfigurationIdDimensionValue = a}) + +instance FromJSON FloodlightActivity where + parseJSON + = withObject "FloodlightActivity" + (\ o -> + FloodlightActivity' <$> + (o .:? "countingMethod") <*> (o .:? "tagString") <*> + (o .:? "secure") + <*> (o .:? "expectedUrl") + <*> (o .:? "floodlightActivityGroupTagString") + <*> (o .:? "floodlightConfigurationId") + <*> + (o .:? "kind" .!= "dfareporting#floodlightActivity") + <*> (o .:? "advertiserId") + <*> (o .:? "advertiserIdDimensionValue") + <*> (o .:? "sslCompliant") + <*> (o .:? "idDimensionValue") + <*> (o .:? "tagFormat") + <*> (o .:? "cacheBustingType") + <*> (o .:? "accountId") + <*> (o .:? "name") + <*> (o .:? "publisherTags" .!= mempty) + <*> (o .:? "floodlightActivityGroupId") + <*> (o .:? "hidden") + <*> (o .:? "floodlightActivityGroupType") + <*> (o .:? "defaultTags" .!= mempty) + <*> (o .:? "floodlightTagType") + <*> (o .:? "floodlightActivityGroupName") + <*> (o .:? "id") + <*> (o .:? "sslRequired") + <*> (o .:? "userDefinedVariableTypes" .!= mempty) + <*> (o .:? "subaccountId") + <*> (o .:? "notes") + <*> + (o .:? "floodlightConfigurationIdDimensionValue")) + +instance ToJSON FloodlightActivity where + toJSON FloodlightActivity'{..} + = object + (catMaybes + [("countingMethod" .=) <$> _faCountingMethod, + ("tagString" .=) <$> _faTagString, + ("secure" .=) <$> _faSecure, + ("expectedUrl" .=) <$> _faExpectedURL, + ("floodlightActivityGroupTagString" .=) <$> + _faFloodlightActivityGroupTagString, + ("floodlightConfigurationId" .=) <$> + _faFloodlightConfigurationId, + Just ("kind" .= _faKind), + ("advertiserId" .=) <$> _faAdvertiserId, + ("advertiserIdDimensionValue" .=) <$> + _faAdvertiserIdDimensionValue, + ("sslCompliant" .=) <$> _faSSLCompliant, + ("idDimensionValue" .=) <$> _faIdDimensionValue, + ("tagFormat" .=) <$> _faTagFormat, + ("cacheBustingType" .=) <$> _faCacheBustingType, + ("accountId" .=) <$> _faAccountId, + ("name" .=) <$> _faName, + ("publisherTags" .=) <$> _faPublisherTags, + ("floodlightActivityGroupId" .=) <$> + _faFloodlightActivityGroupId, + ("hidden" .=) <$> _faHidden, + ("floodlightActivityGroupType" .=) <$> + _faFloodlightActivityGroupType, + ("defaultTags" .=) <$> _faDefaultTags, + ("floodlightTagType" .=) <$> _faFloodlightTagType, + ("floodlightActivityGroupName" .=) <$> + _faFloodlightActivityGroupName, + ("id" .=) <$> _faId, + ("sslRequired" .=) <$> _faSSLRequired, + ("userDefinedVariableTypes" .=) <$> + _faUserDefinedVariableTypes, + ("subaccountId" .=) <$> _faSubAccountId, + ("notes" .=) <$> _faNotes, + ("floodlightConfigurationIdDimensionValue" .=) <$> + _faFloodlightConfigurationIdDimensionValue]) + +-- | A custom floodlight variable. +-- +-- /See:/ 'customFloodlightVariable' smart constructor. +data CustomFloodlightVariable = + CustomFloodlightVariable' + { _cusKind :: !Text + , _cusValue :: !(Maybe Text) + , _cusType :: !(Maybe CustomFloodlightVariableType) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'CustomFloodlightVariable' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'cusKind' +-- +-- * 'cusValue' +-- +-- * 'cusType' +customFloodlightVariable + :: CustomFloodlightVariable +customFloodlightVariable = + CustomFloodlightVariable' + { _cusKind = "dfareporting#customFloodlightVariable" + , _cusValue = Nothing + , _cusType = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#customFloodlightVariable\". +cusKind :: Lens' CustomFloodlightVariable Text +cusKind = lens _cusKind (\ s a -> s{_cusKind = a}) + +-- | The value of the custom floodlight variable. The length of string must +-- not exceed 50 characters. +cusValue :: Lens' CustomFloodlightVariable (Maybe Text) +cusValue = lens _cusValue (\ s a -> s{_cusValue = a}) + +-- | The type of custom floodlight variable to supply a value for. These map +-- to the \"u[1-20]=\" in the tags. +cusType :: Lens' CustomFloodlightVariable (Maybe CustomFloodlightVariableType) +cusType = lens _cusType (\ s a -> s{_cusType = a}) + +instance FromJSON CustomFloodlightVariable where + parseJSON + = withObject "CustomFloodlightVariable" + (\ o -> + CustomFloodlightVariable' <$> + (o .:? "kind" .!= + "dfareporting#customFloodlightVariable") + <*> (o .:? "value") + <*> (o .:? "type")) + +instance ToJSON CustomFloodlightVariable where + toJSON CustomFloodlightVariable'{..} + = object + (catMaybes + [Just ("kind" .= _cusKind), + ("value" .=) <$> _cusValue, + ("type" .=) <$> _cusType]) + +-- | Platform Type List Response +-- +-- /See:/ 'platformTypesListResponse' smart constructor. +data PlatformTypesListResponse = + PlatformTypesListResponse' + { _ptlrKind :: !Text + , _ptlrPlatformTypes :: !(Maybe [PlatformType]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'PlatformTypesListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'ptlrKind' +-- +-- * 'ptlrPlatformTypes' +platformTypesListResponse + :: PlatformTypesListResponse +platformTypesListResponse = + PlatformTypesListResponse' + { _ptlrKind = "dfareporting#platformTypesListResponse" + , _ptlrPlatformTypes = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#platformTypesListResponse\". +ptlrKind :: Lens' PlatformTypesListResponse Text +ptlrKind = lens _ptlrKind (\ s a -> s{_ptlrKind = a}) + +-- | Platform type collection. +ptlrPlatformTypes :: Lens' PlatformTypesListResponse [PlatformType] +ptlrPlatformTypes + = lens _ptlrPlatformTypes + (\ s a -> s{_ptlrPlatformTypes = a}) + . _Default + . _Coerce + +instance FromJSON PlatformTypesListResponse where + parseJSON + = withObject "PlatformTypesListResponse" + (\ o -> + PlatformTypesListResponse' <$> + (o .:? "kind" .!= + "dfareporting#platformTypesListResponse") + <*> (o .:? "platformTypes" .!= mempty)) + +instance ToJSON PlatformTypesListResponse where + toJSON PlatformTypesListResponse'{..} + = object + (catMaybes + [Just ("kind" .= _ptlrKind), + ("platformTypes" .=) <$> _ptlrPlatformTypes]) + +-- | Modification timestamp. +-- +-- /See:/ 'lastModifiedInfo' smart constructor. +newtype LastModifiedInfo = + LastModifiedInfo' + { _lmiTime :: Maybe (Textual Int64) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'LastModifiedInfo' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'lmiTime' +lastModifiedInfo + :: LastModifiedInfo +lastModifiedInfo = LastModifiedInfo' {_lmiTime = Nothing} + + +-- | Timestamp of the last change in milliseconds since epoch. +lmiTime :: Lens' LastModifiedInfo (Maybe Int64) +lmiTime + = lens _lmiTime (\ s a -> s{_lmiTime = a}) . + mapping _Coerce + +instance FromJSON LastModifiedInfo where + parseJSON + = withObject "LastModifiedInfo" + (\ o -> LastModifiedInfo' <$> (o .:? "time")) + +instance ToJSON LastModifiedInfo where + toJSON LastModifiedInfo'{..} + = object (catMaybes [("time" .=) <$> _lmiTime]) + +-- | Target Window. +-- +-- /See:/ 'targetWindow' smart constructor. +data TargetWindow = + TargetWindow' + { _twCustomHTML :: !(Maybe Text) + , _twTargetWindowOption :: !(Maybe TargetWindowTargetWindowOption) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'TargetWindow' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'twCustomHTML' +-- +-- * 'twTargetWindowOption' +targetWindow + :: TargetWindow +targetWindow = + TargetWindow' {_twCustomHTML = Nothing, _twTargetWindowOption = Nothing} + + +-- | User-entered value. +twCustomHTML :: Lens' TargetWindow (Maybe Text) +twCustomHTML + = lens _twCustomHTML (\ s a -> s{_twCustomHTML = a}) + +-- | Type of browser window for which the backup image of the flash creative +-- can be displayed. +twTargetWindowOption :: Lens' TargetWindow (Maybe TargetWindowTargetWindowOption) +twTargetWindowOption + = lens _twTargetWindowOption + (\ s a -> s{_twTargetWindowOption = a}) + +instance FromJSON TargetWindow where + parseJSON + = withObject "TargetWindow" + (\ o -> + TargetWindow' <$> + (o .:? "customHtml") <*> + (o .:? "targetWindowOption")) + +instance ToJSON TargetWindow where + toJSON TargetWindow'{..} + = object + (catMaybes + [("customHtml" .=) <$> _twCustomHTML, + ("targetWindowOption" .=) <$> _twTargetWindowOption]) + +-- | AccountPermissionGroups contains a mapping of permission group IDs to +-- names. A permission group is a grouping of account permissions. +-- +-- /See:/ 'accountPermissionGroup' smart constructor. +data AccountPermissionGroup = + AccountPermissionGroup' + { _apgpKind :: !Text + , _apgpName :: !(Maybe Text) + , _apgpId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'AccountPermissionGroup' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'apgpKind' +-- +-- * 'apgpName' +-- +-- * 'apgpId' +accountPermissionGroup + :: AccountPermissionGroup +accountPermissionGroup = + AccountPermissionGroup' + { _apgpKind = "dfareporting#accountPermissionGroup" + , _apgpName = Nothing + , _apgpId = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#accountPermissionGroup\". +apgpKind :: Lens' AccountPermissionGroup Text +apgpKind = lens _apgpKind (\ s a -> s{_apgpKind = a}) + +-- | Name of this account permission group. +apgpName :: Lens' AccountPermissionGroup (Maybe Text) +apgpName = lens _apgpName (\ s a -> s{_apgpName = a}) + +-- | ID of this account permission group. +apgpId :: Lens' AccountPermissionGroup (Maybe Int64) +apgpId + = lens _apgpId (\ s a -> s{_apgpId = a}) . + mapping _Coerce + +instance FromJSON AccountPermissionGroup where + parseJSON + = withObject "AccountPermissionGroup" + (\ o -> + AccountPermissionGroup' <$> + (o .:? "kind" .!= + "dfareporting#accountPermissionGroup") + <*> (o .:? "name") + <*> (o .:? "id")) + +instance ToJSON AccountPermissionGroup where + toJSON AccountPermissionGroup'{..} + = object + (catMaybes + [Just ("kind" .= _apgpKind), + ("name" .=) <$> _apgpName, ("id" .=) <$> _apgpId]) + +-- | Contains properties of a Campaign Manager advertiser. +-- +-- /See:/ 'advertiser' smart constructor. +data Advertiser = + Advertiser' + { _advdOriginalFloodlightConfigurationId :: !(Maybe (Textual Int64)) + , _advdStatus :: !(Maybe AdvertiserStatus) + , _advdFloodlightConfigurationId :: !(Maybe (Textual Int64)) + , _advdKind :: !Text + , _advdSuspended :: !(Maybe Bool) + , _advdIdDimensionValue :: !(Maybe DimensionValue) + , _advdAccountId :: !(Maybe (Textual Int64)) + , _advdDefaultEmail :: !(Maybe Text) + , _advdName :: !(Maybe Text) + , _advdAdvertiserGroupId :: !(Maybe (Textual Int64)) + , _advdDefaultClickThroughEventTagId :: !(Maybe (Textual Int64)) + , _advdId :: !(Maybe (Textual Int64)) + , _advdSubAccountId :: !(Maybe (Textual Int64)) + , _advdFloodlightConfigurationIdDimensionValue :: !(Maybe DimensionValue) + , _advdClickThroughURLSuffix :: !(Maybe Text) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'Advertiser' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'advdOriginalFloodlightConfigurationId' +-- +-- * 'advdStatus' +-- +-- * 'advdFloodlightConfigurationId' +-- +-- * 'advdKind' +-- +-- * 'advdSuspended' +-- +-- * 'advdIdDimensionValue' +-- +-- * 'advdAccountId' +-- +-- * 'advdDefaultEmail' +-- +-- * 'advdName' +-- +-- * 'advdAdvertiserGroupId' +-- +-- * 'advdDefaultClickThroughEventTagId' +-- +-- * 'advdId' +-- +-- * 'advdSubAccountId' +-- +-- * 'advdFloodlightConfigurationIdDimensionValue' +-- +-- * 'advdClickThroughURLSuffix' +advertiser + :: Advertiser +advertiser = + Advertiser' + { _advdOriginalFloodlightConfigurationId = Nothing + , _advdStatus = Nothing + , _advdFloodlightConfigurationId = Nothing + , _advdKind = "dfareporting#advertiser" + , _advdSuspended = Nothing + , _advdIdDimensionValue = Nothing + , _advdAccountId = Nothing + , _advdDefaultEmail = Nothing + , _advdName = Nothing + , _advdAdvertiserGroupId = Nothing + , _advdDefaultClickThroughEventTagId = Nothing + , _advdId = Nothing + , _advdSubAccountId = Nothing + , _advdFloodlightConfigurationIdDimensionValue = Nothing + , _advdClickThroughURLSuffix = Nothing + } + + +-- | Original floodlight configuration before any sharing occurred. Set the +-- floodlightConfigurationId of this advertiser to +-- originalFloodlightConfigurationId to unshare the advertiser\'s current +-- floodlight configuration. You cannot unshare an advertiser\'s floodlight +-- configuration if the shared configuration has activities associated with +-- any campaign or placement. +advdOriginalFloodlightConfigurationId :: Lens' Advertiser (Maybe Int64) +advdOriginalFloodlightConfigurationId + = lens _advdOriginalFloodlightConfigurationId + (\ s a -> + s{_advdOriginalFloodlightConfigurationId = a}) + . mapping _Coerce + +-- | Status of this advertiser. +advdStatus :: Lens' Advertiser (Maybe AdvertiserStatus) +advdStatus + = lens _advdStatus (\ s a -> s{_advdStatus = a}) + +-- | Floodlight configuration ID of this advertiser. The floodlight +-- configuration ID will be created automatically, so on insert this field +-- should be left blank. This field can be set to another advertiser\'s +-- floodlight configuration ID in order to share that advertiser\'s +-- floodlight configuration with this advertiser, so long as: - This +-- advertiser\'s original floodlight configuration is not already +-- associated with floodlight activities or floodlight activity groups. - +-- This advertiser\'s original floodlight configuration is not already +-- shared with another advertiser. +advdFloodlightConfigurationId :: Lens' Advertiser (Maybe Int64) +advdFloodlightConfigurationId + = lens _advdFloodlightConfigurationId + (\ s a -> s{_advdFloodlightConfigurationId = a}) + . mapping _Coerce + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#advertiser\". +advdKind :: Lens' Advertiser Text +advdKind = lens _advdKind (\ s a -> s{_advdKind = a}) + +-- | Suspension status of this advertiser. +advdSuspended :: Lens' Advertiser (Maybe Bool) +advdSuspended + = lens _advdSuspended + (\ s a -> s{_advdSuspended = a}) + +-- | Dimension value for the ID of this advertiser. This is a read-only, +-- auto-generated field. +advdIdDimensionValue :: Lens' Advertiser (Maybe DimensionValue) +advdIdDimensionValue + = lens _advdIdDimensionValue + (\ s a -> s{_advdIdDimensionValue = a}) + +-- | Account ID of this advertiser.This is a read-only field that can be left +-- blank. +advdAccountId :: Lens' Advertiser (Maybe Int64) +advdAccountId + = lens _advdAccountId + (\ s a -> s{_advdAccountId = a}) + . mapping _Coerce + +-- | Default email address used in sender field for tag emails. +advdDefaultEmail :: Lens' Advertiser (Maybe Text) +advdDefaultEmail + = lens _advdDefaultEmail + (\ s a -> s{_advdDefaultEmail = a}) + +-- | Name of this advertiser. This is a required field and must be less than +-- 256 characters long and unique among advertisers of the same account. +advdName :: Lens' Advertiser (Maybe Text) +advdName = lens _advdName (\ s a -> s{_advdName = a}) + +-- | ID of the advertiser group this advertiser belongs to. You can group +-- advertisers for reporting purposes, allowing you to see aggregated +-- information for all advertisers in each group. +advdAdvertiserGroupId :: Lens' Advertiser (Maybe Int64) +advdAdvertiserGroupId + = lens _advdAdvertiserGroupId + (\ s a -> s{_advdAdvertiserGroupId = a}) + . mapping _Coerce + +-- | ID of the click-through event tag to apply by default to the landing +-- pages of this advertiser\'s campaigns. +advdDefaultClickThroughEventTagId :: Lens' Advertiser (Maybe Int64) +advdDefaultClickThroughEventTagId + = lens _advdDefaultClickThroughEventTagId + (\ s a -> s{_advdDefaultClickThroughEventTagId = a}) + . mapping _Coerce + +-- | ID of this advertiser. This is a read-only, auto-generated field. +advdId :: Lens' Advertiser (Maybe Int64) +advdId + = lens _advdId (\ s a -> s{_advdId = a}) . + mapping _Coerce + +-- | Subaccount ID of this advertiser.This is a read-only field that can be +-- left blank. +advdSubAccountId :: Lens' Advertiser (Maybe Int64) +advdSubAccountId + = lens _advdSubAccountId + (\ s a -> s{_advdSubAccountId = a}) + . mapping _Coerce + +-- | Dimension value for the ID of the floodlight configuration. This is a +-- read-only, auto-generated field. +advdFloodlightConfigurationIdDimensionValue :: Lens' Advertiser (Maybe DimensionValue) +advdFloodlightConfigurationIdDimensionValue + = lens _advdFloodlightConfigurationIdDimensionValue + (\ s a -> + s{_advdFloodlightConfigurationIdDimensionValue = a}) + +-- | Suffix added to click-through URL of ad creative associations under this +-- advertiser. Must be less than 129 characters long. +advdClickThroughURLSuffix :: Lens' Advertiser (Maybe Text) +advdClickThroughURLSuffix + = lens _advdClickThroughURLSuffix + (\ s a -> s{_advdClickThroughURLSuffix = a}) + +instance FromJSON Advertiser where + parseJSON + = withObject "Advertiser" + (\ o -> + Advertiser' <$> + (o .:? "originalFloodlightConfigurationId") <*> + (o .:? "status") + <*> (o .:? "floodlightConfigurationId") + <*> (o .:? "kind" .!= "dfareporting#advertiser") + <*> (o .:? "suspended") + <*> (o .:? "idDimensionValue") + <*> (o .:? "accountId") + <*> (o .:? "defaultEmail") + <*> (o .:? "name") + <*> (o .:? "advertiserGroupId") + <*> (o .:? "defaultClickThroughEventTagId") + <*> (o .:? "id") + <*> (o .:? "subaccountId") + <*> (o .:? "floodlightConfigurationIdDimensionValue") + <*> (o .:? "clickThroughUrlSuffix")) + +instance ToJSON Advertiser where + toJSON Advertiser'{..} + = object + (catMaybes + [("originalFloodlightConfigurationId" .=) <$> + _advdOriginalFloodlightConfigurationId, + ("status" .=) <$> _advdStatus, + ("floodlightConfigurationId" .=) <$> + _advdFloodlightConfigurationId, + Just ("kind" .= _advdKind), + ("suspended" .=) <$> _advdSuspended, + ("idDimensionValue" .=) <$> _advdIdDimensionValue, + ("accountId" .=) <$> _advdAccountId, + ("defaultEmail" .=) <$> _advdDefaultEmail, + ("name" .=) <$> _advdName, + ("advertiserGroupId" .=) <$> _advdAdvertiserGroupId, + ("defaultClickThroughEventTagId" .=) <$> + _advdDefaultClickThroughEventTagId, + ("id" .=) <$> _advdId, + ("subaccountId" .=) <$> _advdSubAccountId, + ("floodlightConfigurationIdDimensionValue" .=) <$> + _advdFloodlightConfigurationIdDimensionValue, + ("clickThroughUrlSuffix" .=) <$> + _advdClickThroughURLSuffix]) + +-- | Contains properties of auser role, which is used to manage user access. +-- +-- /See:/ 'userRole' smart constructor. +data UserRole = + UserRole' + { _urParentUserRoleId :: !(Maybe (Textual Int64)) + , _urKind :: !Text + , _urDefaultUserRole :: !(Maybe Bool) + , _urAccountId :: !(Maybe (Textual Int64)) + , _urName :: !(Maybe Text) + , _urId :: !(Maybe (Textual Int64)) + , _urPermissions :: !(Maybe [UserRolePermission]) + , _urSubAccountId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'UserRole' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'urParentUserRoleId' +-- +-- * 'urKind' +-- +-- * 'urDefaultUserRole' +-- +-- * 'urAccountId' +-- +-- * 'urName' +-- +-- * 'urId' +-- +-- * 'urPermissions' +-- +-- * 'urSubAccountId' +userRole + :: UserRole +userRole = + UserRole' + { _urParentUserRoleId = Nothing + , _urKind = "dfareporting#userRole" + , _urDefaultUserRole = Nothing + , _urAccountId = Nothing + , _urName = Nothing + , _urId = Nothing + , _urPermissions = Nothing + , _urSubAccountId = Nothing + } + + +-- | ID of the user role that this user role is based on or copied from. This +-- is a required field. +urParentUserRoleId :: Lens' UserRole (Maybe Int64) +urParentUserRoleId + = lens _urParentUserRoleId + (\ s a -> s{_urParentUserRoleId = a}) + . mapping _Coerce + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#userRole\". +urKind :: Lens' UserRole Text +urKind = lens _urKind (\ s a -> s{_urKind = a}) + +-- | Whether this is a default user role. Default user roles are created by +-- the system for the account\/subaccount and cannot be modified or +-- deleted. Each default user role comes with a basic set of preassigned +-- permissions. +urDefaultUserRole :: Lens' UserRole (Maybe Bool) +urDefaultUserRole + = lens _urDefaultUserRole + (\ s a -> s{_urDefaultUserRole = a}) + +-- | Account ID of this user role. This is a read-only field that can be left +-- blank. +urAccountId :: Lens' UserRole (Maybe Int64) +urAccountId + = lens _urAccountId (\ s a -> s{_urAccountId = a}) . + mapping _Coerce + +-- | Name of this user role. This is a required field. Must be less than 256 +-- characters long. If this user role is under a subaccount, the name must +-- be unique among sites of the same subaccount. Otherwise, this user role +-- is a top-level user role, and the name must be unique among top-level +-- user roles of the same account. +urName :: Lens' UserRole (Maybe Text) +urName = lens _urName (\ s a -> s{_urName = a}) + +-- | ID of this user role. This is a read-only, auto-generated field. +urId :: Lens' UserRole (Maybe Int64) +urId + = lens _urId (\ s a -> s{_urId = a}) . + mapping _Coerce + +-- | List of permissions associated with this user role. +urPermissions :: Lens' UserRole [UserRolePermission] +urPermissions + = lens _urPermissions + (\ s a -> s{_urPermissions = a}) + . _Default + . _Coerce + +-- | Subaccount ID of this user role. This is a read-only field that can be +-- left blank. +urSubAccountId :: Lens' UserRole (Maybe Int64) +urSubAccountId + = lens _urSubAccountId + (\ s a -> s{_urSubAccountId = a}) + . mapping _Coerce + +instance FromJSON UserRole where + parseJSON + = withObject "UserRole" + (\ o -> + UserRole' <$> + (o .:? "parentUserRoleId") <*> + (o .:? "kind" .!= "dfareporting#userRole") + <*> (o .:? "defaultUserRole") + <*> (o .:? "accountId") + <*> (o .:? "name") + <*> (o .:? "id") + <*> (o .:? "permissions" .!= mempty) + <*> (o .:? "subaccountId")) + +instance ToJSON UserRole where + toJSON UserRole'{..} + = object + (catMaybes + [("parentUserRoleId" .=) <$> _urParentUserRoleId, + Just ("kind" .= _urKind), + ("defaultUserRole" .=) <$> _urDefaultUserRole, + ("accountId" .=) <$> _urAccountId, + ("name" .=) <$> _urName, ("id" .=) <$> _urId, + ("permissions" .=) <$> _urPermissions, + ("subaccountId" .=) <$> _urSubAccountId]) + +-- | Video Format List Response +-- +-- /See:/ 'videoFormatsListResponse' smart constructor. +data VideoFormatsListResponse = + VideoFormatsListResponse' + { _vflrKind :: !Text + , _vflrVideoFormats :: !(Maybe [VideoFormat]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'VideoFormatsListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'vflrKind' +-- +-- * 'vflrVideoFormats' +videoFormatsListResponse + :: VideoFormatsListResponse +videoFormatsListResponse = + VideoFormatsListResponse' + { _vflrKind = "dfareporting#videoFormatsListResponse" + , _vflrVideoFormats = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#videoFormatsListResponse\". +vflrKind :: Lens' VideoFormatsListResponse Text +vflrKind = lens _vflrKind (\ s a -> s{_vflrKind = a}) + +-- | Video format collection. +vflrVideoFormats :: Lens' VideoFormatsListResponse [VideoFormat] +vflrVideoFormats + = lens _vflrVideoFormats + (\ s a -> s{_vflrVideoFormats = a}) + . _Default + . _Coerce + +instance FromJSON VideoFormatsListResponse where + parseJSON + = withObject "VideoFormatsListResponse" + (\ o -> + VideoFormatsListResponse' <$> + (o .:? "kind" .!= + "dfareporting#videoFormatsListResponse") + <*> (o .:? "videoFormats" .!= mempty)) + +instance ToJSON VideoFormatsListResponse where + toJSON VideoFormatsListResponse'{..} + = object + (catMaybes + [Just ("kind" .= _vflrKind), + ("videoFormats" .=) <$> _vflrVideoFormats]) + +-- | Directory Site List Response +-- +-- /See:/ 'directorySitesListResponse' smart constructor. +data DirectorySitesListResponse = + DirectorySitesListResponse' + { _dslrNextPageToken :: !(Maybe Text) + , _dslrKind :: !Text + , _dslrDirectorySites :: !(Maybe [DirectorySite]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'DirectorySitesListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'dslrNextPageToken' +-- +-- * 'dslrKind' +-- +-- * 'dslrDirectorySites' +directorySitesListResponse + :: DirectorySitesListResponse +directorySitesListResponse = + DirectorySitesListResponse' + { _dslrNextPageToken = Nothing + , _dslrKind = "dfareporting#directorySitesListResponse" + , _dslrDirectorySites = Nothing + } + + +-- | Pagination token to be used for the next list operation. +dslrNextPageToken :: Lens' DirectorySitesListResponse (Maybe Text) +dslrNextPageToken + = lens _dslrNextPageToken + (\ s a -> s{_dslrNextPageToken = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#directorySitesListResponse\". +dslrKind :: Lens' DirectorySitesListResponse Text +dslrKind = lens _dslrKind (\ s a -> s{_dslrKind = a}) + +-- | Directory site collection. +dslrDirectorySites :: Lens' DirectorySitesListResponse [DirectorySite] +dslrDirectorySites + = lens _dslrDirectorySites + (\ s a -> s{_dslrDirectorySites = a}) + . _Default + . _Coerce + +instance FromJSON DirectorySitesListResponse where + parseJSON + = withObject "DirectorySitesListResponse" + (\ o -> + DirectorySitesListResponse' <$> + (o .:? "nextPageToken") <*> + (o .:? "kind" .!= + "dfareporting#directorySitesListResponse") + <*> (o .:? "directorySites" .!= mempty)) + +instance ToJSON DirectorySitesListResponse where + toJSON DirectorySitesListResponse'{..} + = object + (catMaybes + [("nextPageToken" .=) <$> _dslrNextPageToken, + Just ("kind" .= _dslrKind), + ("directorySites" .=) <$> _dslrDirectorySites]) + +-- | The error code and description for a conversion that failed to insert or +-- update. +-- +-- /See:/ 'conversionError' smart constructor. +data ConversionError = + ConversionError' + { _ceKind :: !Text + , _ceCode :: !(Maybe ConversionErrorCode) + , _ceMessage :: !(Maybe Text) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ConversionError' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'ceKind' +-- +-- * 'ceCode' +-- +-- * 'ceMessage' +conversionError + :: ConversionError +conversionError = + ConversionError' + { _ceKind = "dfareporting#conversionError" + , _ceCode = Nothing + , _ceMessage = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#conversionError\". +ceKind :: Lens' ConversionError Text +ceKind = lens _ceKind (\ s a -> s{_ceKind = a}) + +-- | The error code. +ceCode :: Lens' ConversionError (Maybe ConversionErrorCode) +ceCode = lens _ceCode (\ s a -> s{_ceCode = a}) + +-- | A description of the error. +ceMessage :: Lens' ConversionError (Maybe Text) +ceMessage + = lens _ceMessage (\ s a -> s{_ceMessage = a}) + +instance FromJSON ConversionError where + parseJSON + = withObject "ConversionError" + (\ o -> + ConversionError' <$> + (o .:? "kind" .!= "dfareporting#conversionError") <*> + (o .:? "code") + <*> (o .:? "message")) + +instance ToJSON ConversionError where + toJSON ConversionError'{..} + = object + (catMaybes + [Just ("kind" .= _ceKind), ("code" .=) <$> _ceCode, + ("message" .=) <$> _ceMessage]) + +-- | Pricing Period +-- +-- /See:/ 'pricingSchedulePricingPeriod' smart constructor. +data PricingSchedulePricingPeriod = + PricingSchedulePricingPeriod' + { _psppEndDate :: !(Maybe Date') + , _psppRateOrCostNanos :: !(Maybe (Textual Int64)) + , _psppStartDate :: !(Maybe Date') + , _psppUnits :: !(Maybe (Textual Int64)) + , _psppPricingComment :: !(Maybe Text) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'PricingSchedulePricingPeriod' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'psppEndDate' +-- +-- * 'psppRateOrCostNanos' +-- +-- * 'psppStartDate' +-- +-- * 'psppUnits' +-- +-- * 'psppPricingComment' +pricingSchedulePricingPeriod + :: PricingSchedulePricingPeriod +pricingSchedulePricingPeriod = + PricingSchedulePricingPeriod' + { _psppEndDate = Nothing + , _psppRateOrCostNanos = Nothing + , _psppStartDate = Nothing + , _psppUnits = Nothing + , _psppPricingComment = Nothing + } + + +-- | Pricing period end date. This date must be later than, or the same day +-- as, the pricing period start date, but not later than the placement end +-- date. The period end date can be the same date as the period start date. +-- If, for example, you set 6\/25\/2015 as both the start and end dates, +-- the effective pricing period date is just that day only, 6\/25\/2015. +-- The hours, minutes, and seconds of the end date should not be set, as +-- doing so will result in an error. +psppEndDate :: Lens' PricingSchedulePricingPeriod (Maybe Day) +psppEndDate + = lens _psppEndDate (\ s a -> s{_psppEndDate = a}) . + mapping _Date + +-- | Rate or cost of this pricing period in nanos (i.e., multipled by +-- 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. +psppRateOrCostNanos :: Lens' PricingSchedulePricingPeriod (Maybe Int64) +psppRateOrCostNanos + = lens _psppRateOrCostNanos + (\ s a -> s{_psppRateOrCostNanos = a}) + . mapping _Coerce + +-- | Pricing period start date. This date must be later than, or the same day +-- as, the placement start date. The hours, minutes, and seconds of the +-- start date should not be set, as doing so will result in an error. +psppStartDate :: Lens' PricingSchedulePricingPeriod (Maybe Day) +psppStartDate + = lens _psppStartDate + (\ s a -> s{_psppStartDate = a}) + . mapping _Date + +-- | Units of this pricing period. Acceptable values are 0 to 10000000000, +-- inclusive. +psppUnits :: Lens' PricingSchedulePricingPeriod (Maybe Int64) +psppUnits + = lens _psppUnits (\ s a -> s{_psppUnits = a}) . + mapping _Coerce + +-- | Comments for this pricing period. +psppPricingComment :: Lens' PricingSchedulePricingPeriod (Maybe Text) +psppPricingComment + = lens _psppPricingComment + (\ s a -> s{_psppPricingComment = a}) + +instance FromJSON PricingSchedulePricingPeriod where + parseJSON + = withObject "PricingSchedulePricingPeriod" + (\ o -> + PricingSchedulePricingPeriod' <$> + (o .:? "endDate") <*> (o .:? "rateOrCostNanos") <*> + (o .:? "startDate") + <*> (o .:? "units") + <*> (o .:? "pricingComment")) + +instance ToJSON PricingSchedulePricingPeriod where + toJSON PricingSchedulePricingPeriod'{..} + = object + (catMaybes + [("endDate" .=) <$> _psppEndDate, + ("rateOrCostNanos" .=) <$> _psppRateOrCostNanos, + ("startDate" .=) <$> _psppStartDate, + ("units" .=) <$> _psppUnits, + ("pricingComment" .=) <$> _psppPricingComment]) + +-- | Contains information about a region that can be targeted by ads. +-- +-- /See:/ 'region' smart constructor. +data Region = + Region' + { _regRegionCode :: !(Maybe Text) + , _regKind :: !Text + , _regName :: !(Maybe Text) + , _regCountryCode :: !(Maybe Text) + , _regCountryDartId :: !(Maybe (Textual Int64)) + , _regDartId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'Region' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'regRegionCode' +-- +-- * 'regKind' +-- +-- * 'regName' +-- +-- * 'regCountryCode' +-- +-- * 'regCountryDartId' +-- +-- * 'regDartId' +region + :: Region +region = + Region' + { _regRegionCode = Nothing + , _regKind = "dfareporting#region" + , _regName = Nothing + , _regCountryCode = Nothing + , _regCountryDartId = Nothing + , _regDartId = Nothing + } + + +-- | Region code. +regRegionCode :: Lens' Region (Maybe Text) +regRegionCode + = lens _regRegionCode + (\ s a -> s{_regRegionCode = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#region\". +regKind :: Lens' Region Text +regKind = lens _regKind (\ s a -> s{_regKind = a}) + +-- | Name of this region. +regName :: Lens' Region (Maybe Text) +regName = lens _regName (\ s a -> s{_regName = a}) + +-- | Country code of the country to which this region belongs. +regCountryCode :: Lens' Region (Maybe Text) +regCountryCode + = lens _regCountryCode + (\ s a -> s{_regCountryCode = a}) + +-- | DART ID of the country to which this region belongs. +regCountryDartId :: Lens' Region (Maybe Int64) +regCountryDartId + = lens _regCountryDartId + (\ s a -> s{_regCountryDartId = a}) + . mapping _Coerce + +-- | DART ID of this region. +regDartId :: Lens' Region (Maybe Int64) +regDartId + = lens _regDartId (\ s a -> s{_regDartId = a}) . + mapping _Coerce + +instance FromJSON Region where + parseJSON + = withObject "Region" + (\ o -> + Region' <$> + (o .:? "regionCode") <*> + (o .:? "kind" .!= "dfareporting#region") + <*> (o .:? "name") + <*> (o .:? "countryCode") + <*> (o .:? "countryDartId") + <*> (o .:? "dartId")) + +instance ToJSON Region where + toJSON Region'{..} + = object + (catMaybes + [("regionCode" .=) <$> _regRegionCode, + Just ("kind" .= _regKind), ("name" .=) <$> _regName, + ("countryCode" .=) <$> _regCountryCode, + ("countryDartId" .=) <$> _regCountryDartId, + ("dartId" .=) <$> _regDartId]) + +-- | Advertiser Group List Response +-- +-- /See:/ 'advertiserGroupsListResponse' smart constructor. +data AdvertiserGroupsListResponse = + AdvertiserGroupsListResponse' + { _aglrNextPageToken :: !(Maybe Text) + , _aglrKind :: !Text + , _aglrAdvertiserGroups :: !(Maybe [AdvertiserGroup]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'AdvertiserGroupsListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'aglrNextPageToken' +-- +-- * 'aglrKind' +-- +-- * 'aglrAdvertiserGroups' +advertiserGroupsListResponse + :: AdvertiserGroupsListResponse +advertiserGroupsListResponse = + AdvertiserGroupsListResponse' + { _aglrNextPageToken = Nothing + , _aglrKind = "dfareporting#advertiserGroupsListResponse" + , _aglrAdvertiserGroups = Nothing + } + + +-- | Pagination token to be used for the next list operation. +aglrNextPageToken :: Lens' AdvertiserGroupsListResponse (Maybe Text) +aglrNextPageToken + = lens _aglrNextPageToken + (\ s a -> s{_aglrNextPageToken = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#advertiserGroupsListResponse\". +aglrKind :: Lens' AdvertiserGroupsListResponse Text +aglrKind = lens _aglrKind (\ s a -> s{_aglrKind = a}) + +-- | Advertiser group collection. +aglrAdvertiserGroups :: Lens' AdvertiserGroupsListResponse [AdvertiserGroup] +aglrAdvertiserGroups + = lens _aglrAdvertiserGroups + (\ s a -> s{_aglrAdvertiserGroups = a}) + . _Default + . _Coerce + +instance FromJSON AdvertiserGroupsListResponse where + parseJSON + = withObject "AdvertiserGroupsListResponse" + (\ o -> + AdvertiserGroupsListResponse' <$> + (o .:? "nextPageToken") <*> + (o .:? "kind" .!= + "dfareporting#advertiserGroupsListResponse") + <*> (o .:? "advertiserGroups" .!= mempty)) + +instance ToJSON AdvertiserGroupsListResponse where + toJSON AdvertiserGroupsListResponse'{..} + = object + (catMaybes + [("nextPageToken" .=) <$> _aglrNextPageToken, + Just ("kind" .= _aglrKind), + ("advertiserGroups" .=) <$> _aglrAdvertiserGroups]) + +-- | Creative Assignment. +-- +-- /See:/ 'creativeAssignment' smart constructor. +data CreativeAssignment = + CreativeAssignment' + { _caCreativeGroupAssignments :: !(Maybe [CreativeGroupAssignment]) + , _caStartTime :: !(Maybe DateTime') + , _caWeight :: !(Maybe (Textual Int32)) + , _caRichMediaExitOverrides :: !(Maybe [RichMediaExitOverride]) + , _caSSLCompliant :: !(Maybe Bool) + , _caCreativeId :: !(Maybe (Textual Int64)) + , _caClickThroughURL :: !(Maybe ClickThroughURL) + , _caApplyEventTags :: !(Maybe Bool) + , _caActive :: !(Maybe Bool) + , _caSequence :: !(Maybe (Textual Int32)) + , _caEndTime :: !(Maybe DateTime') + , _caCompanionCreativeOverrides :: !(Maybe [CompanionClickThroughOverride]) + , _caCreativeIdDimensionValue :: !(Maybe DimensionValue) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'CreativeAssignment' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'caCreativeGroupAssignments' +-- +-- * 'caStartTime' +-- +-- * 'caWeight' +-- +-- * 'caRichMediaExitOverrides' +-- +-- * 'caSSLCompliant' +-- +-- * 'caCreativeId' +-- +-- * 'caClickThroughURL' +-- +-- * 'caApplyEventTags' +-- +-- * 'caActive' +-- +-- * 'caSequence' +-- +-- * 'caEndTime' +-- +-- * 'caCompanionCreativeOverrides' +-- +-- * 'caCreativeIdDimensionValue' +creativeAssignment + :: CreativeAssignment +creativeAssignment = + CreativeAssignment' + { _caCreativeGroupAssignments = Nothing + , _caStartTime = Nothing + , _caWeight = Nothing + , _caRichMediaExitOverrides = Nothing + , _caSSLCompliant = Nothing + , _caCreativeId = Nothing + , _caClickThroughURL = Nothing + , _caApplyEventTags = Nothing + , _caActive = Nothing + , _caSequence = Nothing + , _caEndTime = Nothing + , _caCompanionCreativeOverrides = Nothing + , _caCreativeIdDimensionValue = Nothing + } + + +-- | Creative group assignments for this creative assignment. Only one +-- assignment per creative group number is allowed for a maximum of two +-- assignments. +caCreativeGroupAssignments :: Lens' CreativeAssignment [CreativeGroupAssignment] +caCreativeGroupAssignments + = lens _caCreativeGroupAssignments + (\ s a -> s{_caCreativeGroupAssignments = a}) + . _Default + . _Coerce + +-- | Date and time that the assigned creative should start serving. +caStartTime :: Lens' CreativeAssignment (Maybe UTCTime) +caStartTime + = lens _caStartTime (\ s a -> s{_caStartTime = a}) . + mapping _DateTime + +-- | Weight of the creative assignment, applicable when the rotation type is +-- CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1. +caWeight :: Lens' CreativeAssignment (Maybe Int32) +caWeight + = lens _caWeight (\ s a -> s{_caWeight = a}) . + mapping _Coerce + +-- | Rich media exit overrides for this creative assignment. Applicable when +-- the creative type is any of the following: - DISPLAY - RICH_MEDIA_INPAGE +-- - RICH_MEDIA_INPAGE_FLOATING - RICH_MEDIA_IM_EXPAND - +-- RICH_MEDIA_EXPANDING - RICH_MEDIA_INTERSTITIAL_FLOAT - +-- RICH_MEDIA_MOBILE_IN_APP - RICH_MEDIA_MULTI_FLOATING - +-- RICH_MEDIA_PEEL_DOWN - VPAID_LINEAR - VPAID_NON_LINEAR +caRichMediaExitOverrides :: Lens' CreativeAssignment [RichMediaExitOverride] +caRichMediaExitOverrides + = lens _caRichMediaExitOverrides + (\ s a -> s{_caRichMediaExitOverrides = a}) + . _Default + . _Coerce + +-- | Whether the creative to be assigned is SSL-compliant. This is a +-- read-only field that is auto-generated when the ad is inserted or +-- updated. +caSSLCompliant :: Lens' CreativeAssignment (Maybe Bool) +caSSLCompliant + = lens _caSSLCompliant + (\ s a -> s{_caSSLCompliant = a}) + +-- | ID of the creative to be assigned. This is a required field. +caCreativeId :: Lens' CreativeAssignment (Maybe Int64) +caCreativeId + = lens _caCreativeId (\ s a -> s{_caCreativeId = a}) + . mapping _Coerce + +-- | Click-through URL of the creative assignment. +caClickThroughURL :: Lens' CreativeAssignment (Maybe ClickThroughURL) +caClickThroughURL + = lens _caClickThroughURL + (\ s a -> s{_caClickThroughURL = a}) + +-- | Whether applicable event tags should fire when this creative assignment +-- is rendered. If this value is unset when the ad is inserted or updated, +-- it will default to true for all creative types EXCEPT for +-- INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO. +caApplyEventTags :: Lens' CreativeAssignment (Maybe Bool) +caApplyEventTags + = lens _caApplyEventTags + (\ s a -> s{_caApplyEventTags = a}) + +-- | Whether this creative assignment is active. When true, the creative will +-- be included in the ad\'s rotation. +caActive :: Lens' CreativeAssignment (Maybe Bool) +caActive = lens _caActive (\ s a -> s{_caActive = a}) + +-- | Sequence number of the creative assignment, applicable when the rotation +-- type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to +-- 65535, inclusive. +caSequence :: Lens' CreativeAssignment (Maybe Int32) +caSequence + = lens _caSequence (\ s a -> s{_caSequence = a}) . + mapping _Coerce + +-- | Date and time that the assigned creative should stop serving. Must be +-- later than the start time. +caEndTime :: Lens' CreativeAssignment (Maybe UTCTime) +caEndTime + = lens _caEndTime (\ s a -> s{_caEndTime = a}) . + mapping _DateTime + +-- | Companion creative overrides for this creative assignment. Applicable to +-- video ads. +caCompanionCreativeOverrides :: Lens' CreativeAssignment [CompanionClickThroughOverride] +caCompanionCreativeOverrides + = lens _caCompanionCreativeOverrides + (\ s a -> s{_caCompanionCreativeOverrides = a}) + . _Default + . _Coerce + +-- | Dimension value for the ID of the creative. This is a read-only, +-- auto-generated field. +caCreativeIdDimensionValue :: Lens' CreativeAssignment (Maybe DimensionValue) +caCreativeIdDimensionValue + = lens _caCreativeIdDimensionValue + (\ s a -> s{_caCreativeIdDimensionValue = a}) + +instance FromJSON CreativeAssignment where + parseJSON + = withObject "CreativeAssignment" + (\ o -> + CreativeAssignment' <$> + (o .:? "creativeGroupAssignments" .!= mempty) <*> + (o .:? "startTime") + <*> (o .:? "weight") + <*> (o .:? "richMediaExitOverrides" .!= mempty) + <*> (o .:? "sslCompliant") + <*> (o .:? "creativeId") + <*> (o .:? "clickThroughUrl") + <*> (o .:? "applyEventTags") + <*> (o .:? "active") + <*> (o .:? "sequence") + <*> (o .:? "endTime") + <*> (o .:? "companionCreativeOverrides" .!= mempty) + <*> (o .:? "creativeIdDimensionValue")) + +instance ToJSON CreativeAssignment where + toJSON CreativeAssignment'{..} + = object + (catMaybes + [("creativeGroupAssignments" .=) <$> + _caCreativeGroupAssignments, + ("startTime" .=) <$> _caStartTime, + ("weight" .=) <$> _caWeight, + ("richMediaExitOverrides" .=) <$> + _caRichMediaExitOverrides, + ("sslCompliant" .=) <$> _caSSLCompliant, + ("creativeId" .=) <$> _caCreativeId, + ("clickThroughUrl" .=) <$> _caClickThroughURL, + ("applyEventTags" .=) <$> _caApplyEventTags, + ("active" .=) <$> _caActive, + ("sequence" .=) <$> _caSequence, + ("endTime" .=) <$> _caEndTime, + ("companionCreativeOverrides" .=) <$> + _caCompanionCreativeOverrides, + ("creativeIdDimensionValue" .=) <$> + _caCreativeIdDimensionValue]) + +-- | Represents a dimension filter. +-- +-- /See:/ 'dimensionFilter' smart constructor. +data DimensionFilter = + DimensionFilter' + { _dfKind :: !Text + , _dfValue :: !(Maybe Text) + , _dfDimensionName :: !(Maybe Text) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'DimensionFilter' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'dfKind' +-- +-- * 'dfValue' +-- +-- * 'dfDimensionName' +dimensionFilter + :: DimensionFilter +dimensionFilter = + DimensionFilter' + { _dfKind = "dfareporting#dimensionFilter" + , _dfValue = Nothing + , _dfDimensionName = Nothing + } + + +-- | The kind of resource this is, in this case dfareporting#dimensionFilter. +dfKind :: Lens' DimensionFilter Text +dfKind = lens _dfKind (\ s a -> s{_dfKind = a}) + +-- | The value of the dimension to filter. +dfValue :: Lens' DimensionFilter (Maybe Text) +dfValue = lens _dfValue (\ s a -> s{_dfValue = a}) + +-- | The name of the dimension to filter. +dfDimensionName :: Lens' DimensionFilter (Maybe Text) +dfDimensionName + = lens _dfDimensionName + (\ s a -> s{_dfDimensionName = a}) + +instance FromJSON DimensionFilter where + parseJSON + = withObject "DimensionFilter" + (\ o -> + DimensionFilter' <$> + (o .:? "kind" .!= "dfareporting#dimensionFilter") <*> + (o .:? "value") + <*> (o .:? "dimensionName")) + +instance ToJSON DimensionFilter where + toJSON DimensionFilter'{..} + = object + (catMaybes + [Just ("kind" .= _dfKind), ("value" .=) <$> _dfValue, + ("dimensionName" .=) <$> _dfDimensionName]) + +-- | Represents the list of user profiles. +-- +-- /See:/ 'userProFileList' smart constructor. +data UserProFileList = + UserProFileList' + { _upflEtag :: !(Maybe Text) + , _upflKind :: !Text + , _upflItems :: !(Maybe [UserProFile]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'UserProFileList' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'upflEtag' +-- +-- * 'upflKind' +-- +-- * 'upflItems' +userProFileList + :: UserProFileList +userProFileList = + UserProFileList' + { _upflEtag = Nothing + , _upflKind = "dfareporting#userProfileList" + , _upflItems = Nothing + } + + +-- | The eTag of this response for caching purposes. +upflEtag :: Lens' UserProFileList (Maybe Text) +upflEtag = lens _upflEtag (\ s a -> s{_upflEtag = a}) + +-- | The kind of list this is, in this case dfareporting#userProfileList. +upflKind :: Lens' UserProFileList Text +upflKind = lens _upflKind (\ s a -> s{_upflKind = a}) + +-- | The user profiles returned in this response. +upflItems :: Lens' UserProFileList [UserProFile] +upflItems + = lens _upflItems (\ s a -> s{_upflItems = a}) . + _Default + . _Coerce + +instance FromJSON UserProFileList where + parseJSON + = withObject "UserProFileList" + (\ o -> + UserProFileList' <$> + (o .:? "etag") <*> + (o .:? "kind" .!= "dfareporting#userProfileList") + <*> (o .:? "items" .!= mempty)) + +instance ToJSON UserProFileList where + toJSON UserProFileList'{..} + = object + (catMaybes + [("etag" .=) <$> _upflEtag, + Just ("kind" .= _upflKind), + ("items" .=) <$> _upflItems]) + +-- | Contains properties of a Floodlight configuration. +-- +-- /See:/ 'floodlightConfiguration' smart constructor. +data FloodlightConfiguration = + FloodlightConfiguration' + { _fcTagSettings :: !(Maybe TagSettings) + , _fcExposureToConversionEnabled :: !(Maybe Bool) + , _fcInAppAttributionTrackingEnabled :: !(Maybe Bool) + , _fcThirdPartyAuthenticationTokens :: !(Maybe [ThirdPartyAuthenticationToken]) + , _fcKind :: !Text + , _fcAdvertiserId :: !(Maybe (Textual Int64)) + , _fcAnalyticsDataSharingEnabled :: !(Maybe Bool) + , _fcAdvertiserIdDimensionValue :: !(Maybe DimensionValue) + , _fcIdDimensionValue :: !(Maybe DimensionValue) + , _fcLookbackConfiguration :: !(Maybe LookbackConfiguration) + , _fcAccountId :: !(Maybe (Textual Int64)) + , _fcId :: !(Maybe (Textual Int64)) + , _fcNATuralSearchConversionAttributionOption :: !(Maybe FloodlightConfigurationNATuralSearchConversionAttributionOption) + , _fcUserDefinedVariableConfigurations :: !(Maybe [UserDefinedVariableConfiguration]) + , _fcSubAccountId :: !(Maybe (Textual Int64)) + , _fcCustomViewabilityMetric :: !(Maybe CustomViewabilityMetric) + , _fcFirstDayOfWeek :: !(Maybe FloodlightConfigurationFirstDayOfWeek) + , _fcOmnitureSettings :: !(Maybe OmnitureSettings) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'FloodlightConfiguration' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'fcTagSettings' +-- +-- * 'fcExposureToConversionEnabled' +-- +-- * 'fcInAppAttributionTrackingEnabled' +-- +-- * 'fcThirdPartyAuthenticationTokens' +-- +-- * 'fcKind' +-- +-- * 'fcAdvertiserId' +-- +-- * 'fcAnalyticsDataSharingEnabled' +-- +-- * 'fcAdvertiserIdDimensionValue' +-- +-- * 'fcIdDimensionValue' +-- +-- * 'fcLookbackConfiguration' +-- +-- * 'fcAccountId' +-- +-- * 'fcId' +-- +-- * 'fcNATuralSearchConversionAttributionOption' +-- +-- * 'fcUserDefinedVariableConfigurations' +-- +-- * 'fcSubAccountId' +-- +-- * 'fcCustomViewabilityMetric' +-- +-- * 'fcFirstDayOfWeek' +-- +-- * 'fcOmnitureSettings' +floodlightConfiguration + :: FloodlightConfiguration +floodlightConfiguration = + FloodlightConfiguration' + { _fcTagSettings = Nothing + , _fcExposureToConversionEnabled = Nothing + , _fcInAppAttributionTrackingEnabled = Nothing + , _fcThirdPartyAuthenticationTokens = Nothing + , _fcKind = "dfareporting#floodlightConfiguration" + , _fcAdvertiserId = Nothing + , _fcAnalyticsDataSharingEnabled = Nothing + , _fcAdvertiserIdDimensionValue = Nothing + , _fcIdDimensionValue = Nothing + , _fcLookbackConfiguration = Nothing + , _fcAccountId = Nothing + , _fcId = Nothing + , _fcNATuralSearchConversionAttributionOption = Nothing + , _fcUserDefinedVariableConfigurations = Nothing + , _fcSubAccountId = Nothing + , _fcCustomViewabilityMetric = Nothing + , _fcFirstDayOfWeek = Nothing + , _fcOmnitureSettings = Nothing + } + + +-- | Configuration settings for dynamic and image floodlight tags. +fcTagSettings :: Lens' FloodlightConfiguration (Maybe TagSettings) +fcTagSettings + = lens _fcTagSettings + (\ s a -> s{_fcTagSettings = a}) + +-- | Whether the exposure-to-conversion report is enabled. This report shows +-- detailed pathway information on up to 10 of the most recent ad exposures +-- seen by a user before converting. +fcExposureToConversionEnabled :: Lens' FloodlightConfiguration (Maybe Bool) +fcExposureToConversionEnabled + = lens _fcExposureToConversionEnabled + (\ s a -> s{_fcExposureToConversionEnabled = a}) + +-- | Whether in-app attribution tracking is enabled. +fcInAppAttributionTrackingEnabled :: Lens' FloodlightConfiguration (Maybe Bool) +fcInAppAttributionTrackingEnabled + = lens _fcInAppAttributionTrackingEnabled + (\ s a -> s{_fcInAppAttributionTrackingEnabled = a}) + +-- | List of third-party authentication tokens enabled for this +-- configuration. +fcThirdPartyAuthenticationTokens :: Lens' FloodlightConfiguration [ThirdPartyAuthenticationToken] +fcThirdPartyAuthenticationTokens + = lens _fcThirdPartyAuthenticationTokens + (\ s a -> s{_fcThirdPartyAuthenticationTokens = a}) + . _Default + . _Coerce + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#floodlightConfiguration\". +fcKind :: Lens' FloodlightConfiguration Text +fcKind = lens _fcKind (\ s a -> s{_fcKind = a}) + +-- | Advertiser ID of the parent advertiser of this floodlight configuration. +fcAdvertiserId :: Lens' FloodlightConfiguration (Maybe Int64) +fcAdvertiserId + = lens _fcAdvertiserId + (\ s a -> s{_fcAdvertiserId = a}) + . mapping _Coerce + +-- | Whether advertiser data is shared with Google Analytics. +fcAnalyticsDataSharingEnabled :: Lens' FloodlightConfiguration (Maybe Bool) +fcAnalyticsDataSharingEnabled + = lens _fcAnalyticsDataSharingEnabled + (\ s a -> s{_fcAnalyticsDataSharingEnabled = a}) + +-- | Dimension value for the ID of the advertiser. This is a read-only, +-- auto-generated field. +fcAdvertiserIdDimensionValue :: Lens' FloodlightConfiguration (Maybe DimensionValue) +fcAdvertiserIdDimensionValue + = lens _fcAdvertiserIdDimensionValue + (\ s a -> s{_fcAdvertiserIdDimensionValue = a}) + +-- | Dimension value for the ID of this floodlight configuration. This is a +-- read-only, auto-generated field. +fcIdDimensionValue :: Lens' FloodlightConfiguration (Maybe DimensionValue) +fcIdDimensionValue + = lens _fcIdDimensionValue + (\ s a -> s{_fcIdDimensionValue = a}) + +-- | Lookback window settings for this floodlight configuration. +fcLookbackConfiguration :: Lens' FloodlightConfiguration (Maybe LookbackConfiguration) +fcLookbackConfiguration + = lens _fcLookbackConfiguration + (\ s a -> s{_fcLookbackConfiguration = a}) + +-- | Account ID of this floodlight configuration. This is a read-only field +-- that can be left blank. +fcAccountId :: Lens' FloodlightConfiguration (Maybe Int64) +fcAccountId + = lens _fcAccountId (\ s a -> s{_fcAccountId = a}) . + mapping _Coerce + +-- | ID of this floodlight configuration. This is a read-only, auto-generated +-- field. +fcId :: Lens' FloodlightConfiguration (Maybe Int64) +fcId + = lens _fcId (\ s a -> s{_fcId = a}) . + mapping _Coerce + +-- | Types of attribution options for natural search conversions. +fcNATuralSearchConversionAttributionOption :: Lens' FloodlightConfiguration (Maybe FloodlightConfigurationNATuralSearchConversionAttributionOption) +fcNATuralSearchConversionAttributionOption + = lens _fcNATuralSearchConversionAttributionOption + (\ s a -> + s{_fcNATuralSearchConversionAttributionOption = a}) + +-- | List of user defined variables enabled for this configuration. +fcUserDefinedVariableConfigurations :: Lens' FloodlightConfiguration [UserDefinedVariableConfiguration] +fcUserDefinedVariableConfigurations + = lens _fcUserDefinedVariableConfigurations + (\ s a -> + s{_fcUserDefinedVariableConfigurations = a}) + . _Default + . _Coerce + +-- | Subaccount ID of this floodlight configuration. This is a read-only +-- field that can be left blank. +fcSubAccountId :: Lens' FloodlightConfiguration (Maybe Int64) +fcSubAccountId + = lens _fcSubAccountId + (\ s a -> s{_fcSubAccountId = a}) + . mapping _Coerce + +-- | Custom Viewability metric for the floodlight configuration. +fcCustomViewabilityMetric :: Lens' FloodlightConfiguration (Maybe CustomViewabilityMetric) +fcCustomViewabilityMetric + = lens _fcCustomViewabilityMetric + (\ s a -> s{_fcCustomViewabilityMetric = a}) + +-- | Day that will be counted as the first day of the week in reports. This +-- is a required field. +fcFirstDayOfWeek :: Lens' FloodlightConfiguration (Maybe FloodlightConfigurationFirstDayOfWeek) +fcFirstDayOfWeek + = lens _fcFirstDayOfWeek + (\ s a -> s{_fcFirstDayOfWeek = a}) + +-- | Settings for Campaign Manager Omniture integration. +fcOmnitureSettings :: Lens' FloodlightConfiguration (Maybe OmnitureSettings) +fcOmnitureSettings + = lens _fcOmnitureSettings + (\ s a -> s{_fcOmnitureSettings = a}) + +instance FromJSON FloodlightConfiguration where + parseJSON + = withObject "FloodlightConfiguration" + (\ o -> + FloodlightConfiguration' <$> + (o .:? "tagSettings") <*> + (o .:? "exposureToConversionEnabled") + <*> (o .:? "inAppAttributionTrackingEnabled") + <*> + (o .:? "thirdPartyAuthenticationTokens" .!= mempty) + <*> + (o .:? "kind" .!= + "dfareporting#floodlightConfiguration") + <*> (o .:? "advertiserId") + <*> (o .:? "analyticsDataSharingEnabled") + <*> (o .:? "advertiserIdDimensionValue") + <*> (o .:? "idDimensionValue") + <*> (o .:? "lookbackConfiguration") + <*> (o .:? "accountId") + <*> (o .:? "id") + <*> + (o .:? "naturalSearchConversionAttributionOption") + <*> + (o .:? "userDefinedVariableConfigurations" .!= + mempty) + <*> (o .:? "subaccountId") + <*> (o .:? "customViewabilityMetric") + <*> (o .:? "firstDayOfWeek") + <*> (o .:? "omnitureSettings")) + +instance ToJSON FloodlightConfiguration where + toJSON FloodlightConfiguration'{..} + = object + (catMaybes + [("tagSettings" .=) <$> _fcTagSettings, + ("exposureToConversionEnabled" .=) <$> + _fcExposureToConversionEnabled, + ("inAppAttributionTrackingEnabled" .=) <$> + _fcInAppAttributionTrackingEnabled, + ("thirdPartyAuthenticationTokens" .=) <$> + _fcThirdPartyAuthenticationTokens, + Just ("kind" .= _fcKind), + ("advertiserId" .=) <$> _fcAdvertiserId, + ("analyticsDataSharingEnabled" .=) <$> + _fcAnalyticsDataSharingEnabled, + ("advertiserIdDimensionValue" .=) <$> + _fcAdvertiserIdDimensionValue, + ("idDimensionValue" .=) <$> _fcIdDimensionValue, + ("lookbackConfiguration" .=) <$> + _fcLookbackConfiguration, + ("accountId" .=) <$> _fcAccountId, + ("id" .=) <$> _fcId, + ("naturalSearchConversionAttributionOption" .=) <$> + _fcNATuralSearchConversionAttributionOption, + ("userDefinedVariableConfigurations" .=) <$> + _fcUserDefinedVariableConfigurations, + ("subaccountId" .=) <$> _fcSubAccountId, + ("customViewabilityMetric" .=) <$> + _fcCustomViewabilityMetric, + ("firstDayOfWeek" .=) <$> _fcFirstDayOfWeek, + ("omnitureSettings" .=) <$> _fcOmnitureSettings]) + +-- | Companion Settings +-- +-- /See:/ 'companionSetting' smart constructor. +data CompanionSetting = + CompanionSetting' + { _comKind :: !Text + , _comImageOnly :: !(Maybe Bool) + , _comCompanionsDisabled :: !(Maybe Bool) + , _comEnabledSizes :: !(Maybe [Size]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'CompanionSetting' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'comKind' +-- +-- * 'comImageOnly' +-- +-- * 'comCompanionsDisabled' +-- +-- * 'comEnabledSizes' +companionSetting + :: CompanionSetting +companionSetting = + CompanionSetting' + { _comKind = "dfareporting#companionSetting" + , _comImageOnly = Nothing + , _comCompanionsDisabled = Nothing + , _comEnabledSizes = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#companionSetting\". +comKind :: Lens' CompanionSetting Text +comKind = lens _comKind (\ s a -> s{_comKind = a}) + +-- | Whether to serve only static images as companions. +comImageOnly :: Lens' CompanionSetting (Maybe Bool) +comImageOnly + = lens _comImageOnly (\ s a -> s{_comImageOnly = a}) + +-- | Whether companions are disabled for this placement. +comCompanionsDisabled :: Lens' CompanionSetting (Maybe Bool) +comCompanionsDisabled + = lens _comCompanionsDisabled + (\ s a -> s{_comCompanionsDisabled = a}) + +-- | Whitelist of companion sizes to be served to this placement. Set this +-- list to null or empty to serve all companion sizes. +comEnabledSizes :: Lens' CompanionSetting [Size] +comEnabledSizes + = lens _comEnabledSizes + (\ s a -> s{_comEnabledSizes = a}) + . _Default + . _Coerce + +instance FromJSON CompanionSetting where + parseJSON + = withObject "CompanionSetting" + (\ o -> + CompanionSetting' <$> + (o .:? "kind" .!= "dfareporting#companionSetting") + <*> (o .:? "imageOnly") + <*> (o .:? "companionsDisabled") + <*> (o .:? "enabledSizes" .!= mempty)) + +instance ToJSON CompanionSetting where + toJSON CompanionSetting'{..} + = object + (catMaybes + [Just ("kind" .= _comKind), + ("imageOnly" .=) <$> _comImageOnly, + ("companionsDisabled" .=) <$> _comCompanionsDisabled, + ("enabledSizes" .=) <$> _comEnabledSizes]) + +-- | Floodlight Activity Group List Response +-- +-- /See:/ 'floodlightActivityGroupsListResponse' smart constructor. +data FloodlightActivityGroupsListResponse = + FloodlightActivityGroupsListResponse' + { _faglrNextPageToken :: !(Maybe Text) + , _faglrKind :: !Text + , _faglrFloodlightActivityGroups :: !(Maybe [FloodlightActivityGroup]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'FloodlightActivityGroupsListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'faglrNextPageToken' +-- +-- * 'faglrKind' +-- +-- * 'faglrFloodlightActivityGroups' +floodlightActivityGroupsListResponse + :: FloodlightActivityGroupsListResponse +floodlightActivityGroupsListResponse = + FloodlightActivityGroupsListResponse' + { _faglrNextPageToken = Nothing + , _faglrKind = "dfareporting#floodlightActivityGroupsListResponse" + , _faglrFloodlightActivityGroups = Nothing + } + + +-- | Pagination token to be used for the next list operation. +faglrNextPageToken :: Lens' FloodlightActivityGroupsListResponse (Maybe Text) +faglrNextPageToken + = lens _faglrNextPageToken + (\ s a -> s{_faglrNextPageToken = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#floodlightActivityGroupsListResponse\". +faglrKind :: Lens' FloodlightActivityGroupsListResponse Text +faglrKind + = lens _faglrKind (\ s a -> s{_faglrKind = a}) + +-- | Floodlight activity group collection. +faglrFloodlightActivityGroups :: Lens' FloodlightActivityGroupsListResponse [FloodlightActivityGroup] +faglrFloodlightActivityGroups + = lens _faglrFloodlightActivityGroups + (\ s a -> s{_faglrFloodlightActivityGroups = a}) + . _Default + . _Coerce + +instance FromJSON + FloodlightActivityGroupsListResponse + where + parseJSON + = withObject "FloodlightActivityGroupsListResponse" + (\ o -> + FloodlightActivityGroupsListResponse' <$> + (o .:? "nextPageToken") <*> + (o .:? "kind" .!= + "dfareporting#floodlightActivityGroupsListResponse") + <*> (o .:? "floodlightActivityGroups" .!= mempty)) + +instance ToJSON FloodlightActivityGroupsListResponse + where + toJSON FloodlightActivityGroupsListResponse'{..} + = object + (catMaybes + [("nextPageToken" .=) <$> _faglrNextPageToken, + Just ("kind" .= _faglrKind), + ("floodlightActivityGroups" .=) <$> + _faglrFloodlightActivityGroups]) + +-- | A Conversion represents when a user successfully performs a desired +-- action after seeing an ad. +-- +-- /See:/ 'conversion' smart constructor. +data Conversion = + Conversion' + { _conoTreatmentForUnderage :: !(Maybe Bool) + , _conoEncryptedUserIdCandidates :: !(Maybe [Text]) + , _conoTimestampMicros :: !(Maybe (Textual Int64)) + , _conoLimitAdTracking :: !(Maybe Bool) + , _conoEncryptedUserId :: !(Maybe Text) + , _conoMobileDeviceId :: !(Maybe Text) + , _conoFloodlightConfigurationId :: !(Maybe (Textual Int64)) + , _conoKind :: !Text + , _conoFloodlightActivityId :: !(Maybe (Textual Int64)) + , _conoNonPersonalizedAd :: !(Maybe Bool) + , _conoQuantity :: !(Maybe (Textual Int64)) + , _conoValue :: !(Maybe (Textual Double)) + , _conoCustomVariables :: !(Maybe [CustomFloodlightVariable]) + , _conoChildDirectedTreatment :: !(Maybe Bool) + , _conoGclid :: !(Maybe Text) + , _conoOrdinal :: !(Maybe Text) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'Conversion' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'conoTreatmentForUnderage' +-- +-- * 'conoEncryptedUserIdCandidates' +-- +-- * 'conoTimestampMicros' +-- +-- * 'conoLimitAdTracking' +-- +-- * 'conoEncryptedUserId' +-- +-- * 'conoMobileDeviceId' +-- +-- * 'conoFloodlightConfigurationId' +-- +-- * 'conoKind' +-- +-- * 'conoFloodlightActivityId' +-- +-- * 'conoNonPersonalizedAd' +-- +-- * 'conoQuantity' +-- +-- * 'conoValue' +-- +-- * 'conoCustomVariables' +-- +-- * 'conoChildDirectedTreatment' +-- +-- * 'conoGclid' +-- +-- * 'conoOrdinal' +conversion + :: Conversion +conversion = + Conversion' + { _conoTreatmentForUnderage = Nothing + , _conoEncryptedUserIdCandidates = Nothing + , _conoTimestampMicros = Nothing + , _conoLimitAdTracking = Nothing + , _conoEncryptedUserId = Nothing + , _conoMobileDeviceId = Nothing + , _conoFloodlightConfigurationId = Nothing + , _conoKind = "dfareporting#conversion" + , _conoFloodlightActivityId = Nothing + , _conoNonPersonalizedAd = Nothing + , _conoQuantity = Nothing + , _conoValue = Nothing + , _conoCustomVariables = Nothing + , _conoChildDirectedTreatment = Nothing + , _conoGclid = Nothing + , _conoOrdinal = Nothing + } + + +-- | Whether this particular request may come from a user under the age of 16 +-- (may differ by country), under compliance with the European Union\'s +-- General Data Protection Regulation (GDPR). +conoTreatmentForUnderage :: Lens' Conversion (Maybe Bool) +conoTreatmentForUnderage + = lens _conoTreatmentForUnderage + (\ s a -> s{_conoTreatmentForUnderage = a}) + +-- | A list of the alphanumeric encrypted user IDs. Any user ID with exposure +-- prior to the conversion timestamp will be used in the inserted +-- conversion. If no such user ID is found then the conversion will be +-- rejected with NO_COOKIE_MATCH_FOUND error. When set, encryptionInfo +-- should also be specified. This field may only be used when calling +-- batchinsert; it is not supported by batchupdate. This field is mutually +-- exclusive with encryptedUserId, mobileDeviceId and gclid. This or +-- encryptedUserId or mobileDeviceId or gclid is a required field. +conoEncryptedUserIdCandidates :: Lens' Conversion [Text] +conoEncryptedUserIdCandidates + = lens _conoEncryptedUserIdCandidates + (\ s a -> s{_conoEncryptedUserIdCandidates = a}) + . _Default + . _Coerce + +-- | The timestamp of conversion, in Unix epoch micros. This is a required +-- field. +conoTimestampMicros :: Lens' Conversion (Maybe Int64) +conoTimestampMicros + = lens _conoTimestampMicros + (\ s a -> s{_conoTimestampMicros = a}) + . mapping _Coerce + +-- | Whether Limit Ad Tracking is enabled. When set to true, the conversion +-- will be used for reporting but not targeting. This will prevent +-- remarketing. +conoLimitAdTracking :: Lens' Conversion (Maybe Bool) +conoLimitAdTracking + = lens _conoLimitAdTracking + (\ s a -> s{_conoLimitAdTracking = a}) + +-- | The alphanumeric encrypted user ID. When set, encryptionInfo should also +-- be specified. This field is mutually exclusive with +-- encryptedUserIdCandidates[], mobileDeviceId and gclid. This or +-- encryptedUserIdCandidates[] or mobileDeviceId or gclid is a required +-- field. +conoEncryptedUserId :: Lens' Conversion (Maybe Text) +conoEncryptedUserId + = lens _conoEncryptedUserId + (\ s a -> s{_conoEncryptedUserId = a}) + +-- | The mobile device ID. This field is mutually exclusive with +-- encryptedUserId, encryptedUserIdCandidates[] and gclid. This or +-- encryptedUserId or encryptedUserIdCandidates[] or gclid is a required +-- field. +conoMobileDeviceId :: Lens' Conversion (Maybe Text) +conoMobileDeviceId + = lens _conoMobileDeviceId + (\ s a -> s{_conoMobileDeviceId = a}) + +-- | Floodlight Configuration ID of this conversion. This is a required +-- field. +conoFloodlightConfigurationId :: Lens' Conversion (Maybe Int64) +conoFloodlightConfigurationId + = lens _conoFloodlightConfigurationId + (\ s a -> s{_conoFloodlightConfigurationId = a}) + . mapping _Coerce + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#conversion\". +conoKind :: Lens' Conversion Text +conoKind = lens _conoKind (\ s a -> s{_conoKind = a}) + +-- | Floodlight Activity ID of this conversion. This is a required field. +conoFloodlightActivityId :: Lens' Conversion (Maybe Int64) +conoFloodlightActivityId + = lens _conoFloodlightActivityId + (\ s a -> s{_conoFloodlightActivityId = a}) + . mapping _Coerce + +-- | Whether the conversion was for a non personalized ad. +conoNonPersonalizedAd :: Lens' Conversion (Maybe Bool) +conoNonPersonalizedAd + = lens _conoNonPersonalizedAd + (\ s a -> s{_conoNonPersonalizedAd = a}) + +-- | The quantity of the conversion. +conoQuantity :: Lens' Conversion (Maybe Int64) +conoQuantity + = lens _conoQuantity (\ s a -> s{_conoQuantity = a}) + . mapping _Coerce + +-- | The value of the conversion. +conoValue :: Lens' Conversion (Maybe Double) +conoValue + = lens _conoValue (\ s a -> s{_conoValue = a}) . + mapping _Coerce + +-- | Custom floodlight variables. +conoCustomVariables :: Lens' Conversion [CustomFloodlightVariable] +conoCustomVariables + = lens _conoCustomVariables + (\ s a -> s{_conoCustomVariables = a}) + . _Default + . _Coerce + +-- | Whether this particular request may come from a user under the age of +-- 13, under COPPA compliance. +conoChildDirectedTreatment :: Lens' Conversion (Maybe Bool) +conoChildDirectedTreatment + = lens _conoChildDirectedTreatment + (\ s a -> s{_conoChildDirectedTreatment = a}) + +-- | The Google click ID. This field is mutually exclusive with +-- encryptedUserId, encryptedUserIdCandidates[] and mobileDeviceId. This or +-- encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId is a +-- required field. +conoGclid :: Lens' Conversion (Maybe Text) +conoGclid + = lens _conoGclid (\ s a -> s{_conoGclid = a}) + +-- | The ordinal of the conversion. Use this field to control how conversions +-- of the same user and day are de-duplicated. This is a required field. +conoOrdinal :: Lens' Conversion (Maybe Text) +conoOrdinal + = lens _conoOrdinal (\ s a -> s{_conoOrdinal = a}) + +instance FromJSON Conversion where + parseJSON + = withObject "Conversion" + (\ o -> + Conversion' <$> + (o .:? "treatmentForUnderage") <*> + (o .:? "encryptedUserIdCandidates" .!= mempty) + <*> (o .:? "timestampMicros") + <*> (o .:? "limitAdTracking") + <*> (o .:? "encryptedUserId") + <*> (o .:? "mobileDeviceId") + <*> (o .:? "floodlightConfigurationId") + <*> (o .:? "kind" .!= "dfareporting#conversion") + <*> (o .:? "floodlightActivityId") + <*> (o .:? "nonPersonalizedAd") + <*> (o .:? "quantity") + <*> (o .:? "value") + <*> (o .:? "customVariables" .!= mempty) + <*> (o .:? "childDirectedTreatment") + <*> (o .:? "gclid") + <*> (o .:? "ordinal")) + +instance ToJSON Conversion where + toJSON Conversion'{..} + = object + (catMaybes + [("treatmentForUnderage" .=) <$> + _conoTreatmentForUnderage, + ("encryptedUserIdCandidates" .=) <$> + _conoEncryptedUserIdCandidates, + ("timestampMicros" .=) <$> _conoTimestampMicros, + ("limitAdTracking" .=) <$> _conoLimitAdTracking, + ("encryptedUserId" .=) <$> _conoEncryptedUserId, + ("mobileDeviceId" .=) <$> _conoMobileDeviceId, + ("floodlightConfigurationId" .=) <$> + _conoFloodlightConfigurationId, + Just ("kind" .= _conoKind), + ("floodlightActivityId" .=) <$> + _conoFloodlightActivityId, + ("nonPersonalizedAd" .=) <$> _conoNonPersonalizedAd, + ("quantity" .=) <$> _conoQuantity, + ("value" .=) <$> _conoValue, + ("customVariables" .=) <$> _conoCustomVariables, + ("childDirectedTreatment" .=) <$> + _conoChildDirectedTreatment, + ("gclid" .=) <$> _conoGclid, + ("ordinal" .=) <$> _conoOrdinal]) + +-- | Creative Field Value List Response +-- +-- /See:/ 'creativeFieldValuesListResponse' smart constructor. +data CreativeFieldValuesListResponse = + CreativeFieldValuesListResponse' + { _cfvlrNextPageToken :: !(Maybe Text) + , _cfvlrKind :: !Text + , _cfvlrCreativeFieldValues :: !(Maybe [CreativeFieldValue]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'CreativeFieldValuesListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'cfvlrNextPageToken' +-- +-- * 'cfvlrKind' +-- +-- * 'cfvlrCreativeFieldValues' +creativeFieldValuesListResponse + :: CreativeFieldValuesListResponse +creativeFieldValuesListResponse = + CreativeFieldValuesListResponse' + { _cfvlrNextPageToken = Nothing + , _cfvlrKind = "dfareporting#creativeFieldValuesListResponse" + , _cfvlrCreativeFieldValues = Nothing + } + + +-- | Pagination token to be used for the next list operation. +cfvlrNextPageToken :: Lens' CreativeFieldValuesListResponse (Maybe Text) +cfvlrNextPageToken + = lens _cfvlrNextPageToken + (\ s a -> s{_cfvlrNextPageToken = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#creativeFieldValuesListResponse\". +cfvlrKind :: Lens' CreativeFieldValuesListResponse Text +cfvlrKind + = lens _cfvlrKind (\ s a -> s{_cfvlrKind = a}) + +-- | Creative field value collection. +cfvlrCreativeFieldValues :: Lens' CreativeFieldValuesListResponse [CreativeFieldValue] +cfvlrCreativeFieldValues + = lens _cfvlrCreativeFieldValues + (\ s a -> s{_cfvlrCreativeFieldValues = a}) + . _Default + . _Coerce + +instance FromJSON CreativeFieldValuesListResponse + where + parseJSON + = withObject "CreativeFieldValuesListResponse" + (\ o -> + CreativeFieldValuesListResponse' <$> + (o .:? "nextPageToken") <*> + (o .:? "kind" .!= + "dfareporting#creativeFieldValuesListResponse") + <*> (o .:? "creativeFieldValues" .!= mempty)) + +instance ToJSON CreativeFieldValuesListResponse where + toJSON CreativeFieldValuesListResponse'{..} + = object + (catMaybes + [("nextPageToken" .=) <$> _cfvlrNextPageToken, + Just ("kind" .= _cfvlrKind), + ("creativeFieldValues" .=) <$> + _cfvlrCreativeFieldValues]) + +-- | Rich Media Exit Override. +-- +-- /See:/ 'richMediaExitOverride' smart constructor. +data RichMediaExitOverride = + RichMediaExitOverride' + { _rmeoEnabled :: !(Maybe Bool) + , _rmeoClickThroughURL :: !(Maybe ClickThroughURL) + , _rmeoExitId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'RichMediaExitOverride' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'rmeoEnabled' +-- +-- * 'rmeoClickThroughURL' +-- +-- * 'rmeoExitId' +richMediaExitOverride + :: RichMediaExitOverride +richMediaExitOverride = + RichMediaExitOverride' + { _rmeoEnabled = Nothing + , _rmeoClickThroughURL = Nothing + , _rmeoExitId = Nothing + } + + +-- | Whether to use the clickThroughUrl. If false, the creative-level exit +-- will be used. +rmeoEnabled :: Lens' RichMediaExitOverride (Maybe Bool) +rmeoEnabled + = lens _rmeoEnabled (\ s a -> s{_rmeoEnabled = a}) + +-- | Click-through URL of this rich media exit override. Applicable if the +-- enabled field is set to true. +rmeoClickThroughURL :: Lens' RichMediaExitOverride (Maybe ClickThroughURL) +rmeoClickThroughURL + = lens _rmeoClickThroughURL + (\ s a -> s{_rmeoClickThroughURL = a}) + +-- | ID for the override to refer to a specific exit in the creative. +rmeoExitId :: Lens' RichMediaExitOverride (Maybe Int64) +rmeoExitId + = lens _rmeoExitId (\ s a -> s{_rmeoExitId = a}) . + mapping _Coerce + +instance FromJSON RichMediaExitOverride where + parseJSON + = withObject "RichMediaExitOverride" + (\ o -> + RichMediaExitOverride' <$> + (o .:? "enabled") <*> (o .:? "clickThroughUrl") <*> + (o .:? "exitId")) + +instance ToJSON RichMediaExitOverride where + toJSON RichMediaExitOverride'{..} + = object + (catMaybes + [("enabled" .=) <$> _rmeoEnabled, + ("clickThroughUrl" .=) <$> _rmeoClickThroughURL, + ("exitId" .=) <$> _rmeoExitId]) + +-- | Custom Viewability Metric +-- +-- /See:/ 'customViewabilityMetric' smart constructor. +data CustomViewabilityMetric = + CustomViewabilityMetric' + { _cvmName :: !(Maybe Text) + , _cvmId :: !(Maybe (Textual Int64)) + , _cvmConfiguration :: !(Maybe CustomViewabilityMetricConfiguration) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'CustomViewabilityMetric' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'cvmName' +-- +-- * 'cvmId' +-- +-- * 'cvmConfiguration' +customViewabilityMetric + :: CustomViewabilityMetric +customViewabilityMetric = + CustomViewabilityMetric' + {_cvmName = Nothing, _cvmId = Nothing, _cvmConfiguration = Nothing} + + +-- | Name of the custom viewability metric. +cvmName :: Lens' CustomViewabilityMetric (Maybe Text) +cvmName = lens _cvmName (\ s a -> s{_cvmName = a}) + +-- | ID of the custom viewability metric. +cvmId :: Lens' CustomViewabilityMetric (Maybe Int64) +cvmId + = lens _cvmId (\ s a -> s{_cvmId = a}) . + mapping _Coerce + +-- | Configuration of the custom viewability metric. +cvmConfiguration :: Lens' CustomViewabilityMetric (Maybe CustomViewabilityMetricConfiguration) +cvmConfiguration + = lens _cvmConfiguration + (\ s a -> s{_cvmConfiguration = a}) + +instance FromJSON CustomViewabilityMetric where + parseJSON + = withObject "CustomViewabilityMetric" + (\ o -> + CustomViewabilityMetric' <$> + (o .:? "name") <*> (o .:? "id") <*> + (o .:? "configuration")) + +instance ToJSON CustomViewabilityMetric where + toJSON CustomViewabilityMetric'{..} + = object + (catMaybes + [("name" .=) <$> _cvmName, ("id" .=) <$> _cvmId, + ("configuration" .=) <$> _cvmConfiguration]) + +-- | Landing Page List Response +-- +-- /See:/ 'advertiserLandingPagesListResponse' smart constructor. +data AdvertiserLandingPagesListResponse = + AdvertiserLandingPagesListResponse' + { _alplrLandingPages :: !(Maybe [LandingPage]) + , _alplrNextPageToken :: !(Maybe Text) + , _alplrKind :: !Text + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'AdvertiserLandingPagesListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'alplrLandingPages' +-- +-- * 'alplrNextPageToken' +-- +-- * 'alplrKind' +advertiserLandingPagesListResponse + :: AdvertiserLandingPagesListResponse +advertiserLandingPagesListResponse = + AdvertiserLandingPagesListResponse' + { _alplrLandingPages = Nothing + , _alplrNextPageToken = Nothing + , _alplrKind = "dfareporting#advertiserLandingPagesListResponse" + } + + +-- | Landing page collection +alplrLandingPages :: Lens' AdvertiserLandingPagesListResponse [LandingPage] +alplrLandingPages + = lens _alplrLandingPages + (\ s a -> s{_alplrLandingPages = a}) + . _Default + . _Coerce + +-- | Pagination token to be used for the next list operation. +alplrNextPageToken :: Lens' AdvertiserLandingPagesListResponse (Maybe Text) +alplrNextPageToken + = lens _alplrNextPageToken + (\ s a -> s{_alplrNextPageToken = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#advertiserLandingPagesListResponse\". +alplrKind :: Lens' AdvertiserLandingPagesListResponse Text +alplrKind + = lens _alplrKind (\ s a -> s{_alplrKind = a}) + +instance FromJSON AdvertiserLandingPagesListResponse + where + parseJSON + = withObject "AdvertiserLandingPagesListResponse" + (\ o -> + AdvertiserLandingPagesListResponse' <$> + (o .:? "landingPages" .!= mempty) <*> + (o .:? "nextPageToken") + <*> + (o .:? "kind" .!= + "dfareporting#advertiserLandingPagesListResponse")) + +instance ToJSON AdvertiserLandingPagesListResponse + where + toJSON AdvertiserLandingPagesListResponse'{..} + = object + (catMaybes + [("landingPages" .=) <$> _alplrLandingPages, + ("nextPageToken" .=) <$> _alplrNextPageToken, + Just ("kind" .= _alplrKind)]) + +-- | Mobile app List Response +-- +-- /See:/ 'mobileAppsListResponse' smart constructor. +data MobileAppsListResponse = + MobileAppsListResponse' + { _malrNextPageToken :: !(Maybe Text) + , _malrKind :: !Text + , _malrMobileApps :: !(Maybe [MobileApp]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'MobileAppsListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'malrNextPageToken' +-- +-- * 'malrKind' +-- +-- * 'malrMobileApps' +mobileAppsListResponse + :: MobileAppsListResponse +mobileAppsListResponse = + MobileAppsListResponse' + { _malrNextPageToken = Nothing + , _malrKind = "dfareporting#mobileAppsListResponse" + , _malrMobileApps = Nothing + } + + +-- | Pagination token to be used for the next list operation. +malrNextPageToken :: Lens' MobileAppsListResponse (Maybe Text) +malrNextPageToken + = lens _malrNextPageToken + (\ s a -> s{_malrNextPageToken = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#mobileAppsListResponse\". +malrKind :: Lens' MobileAppsListResponse Text +malrKind = lens _malrKind (\ s a -> s{_malrKind = a}) + +-- | Mobile apps collection. +malrMobileApps :: Lens' MobileAppsListResponse [MobileApp] +malrMobileApps + = lens _malrMobileApps + (\ s a -> s{_malrMobileApps = a}) + . _Default + . _Coerce + +instance FromJSON MobileAppsListResponse where + parseJSON + = withObject "MobileAppsListResponse" + (\ o -> + MobileAppsListResponse' <$> + (o .:? "nextPageToken") <*> + (o .:? "kind" .!= + "dfareporting#mobileAppsListResponse") + <*> (o .:? "mobileApps" .!= mempty)) + +instance ToJSON MobileAppsListResponse where + toJSON MobileAppsListResponse'{..} + = object + (catMaybes + [("nextPageToken" .=) <$> _malrNextPageToken, + Just ("kind" .= _malrKind), + ("mobileApps" .=) <$> _malrMobileApps]) + +-- | Represents a sorted dimension. +-- +-- /See:/ 'sortedDimension' smart constructor. +data SortedDimension = + SortedDimension' + { _sdKind :: !Text + , _sdSortOrder :: !(Maybe SortedDimensionSortOrder) + , _sdName :: !(Maybe Text) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'SortedDimension' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'sdKind' +-- +-- * 'sdSortOrder' +-- +-- * 'sdName' +sortedDimension + :: SortedDimension +sortedDimension = + SortedDimension' + { _sdKind = "dfareporting#sortedDimension" + , _sdSortOrder = Nothing + , _sdName = Nothing + } + + +-- | The kind of resource this is, in this case dfareporting#sortedDimension. +sdKind :: Lens' SortedDimension Text +sdKind = lens _sdKind (\ s a -> s{_sdKind = a}) + +-- | An optional sort order for the dimension column. +sdSortOrder :: Lens' SortedDimension (Maybe SortedDimensionSortOrder) +sdSortOrder + = lens _sdSortOrder (\ s a -> s{_sdSortOrder = a}) + +-- | The name of the dimension. +sdName :: Lens' SortedDimension (Maybe Text) +sdName = lens _sdName (\ s a -> s{_sdName = a}) + +instance FromJSON SortedDimension where + parseJSON + = withObject "SortedDimension" + (\ o -> + SortedDimension' <$> + (o .:? "kind" .!= "dfareporting#sortedDimension") <*> + (o .:? "sortOrder") + <*> (o .:? "name")) + +instance ToJSON SortedDimension where + toJSON SortedDimension'{..} + = object + (catMaybes + [Just ("kind" .= _sdKind), + ("sortOrder" .=) <$> _sdSortOrder, + ("name" .=) <$> _sdName]) + +-- | Creative Field List Response +-- +-- /See:/ 'creativeFieldsListResponse' smart constructor. +data CreativeFieldsListResponse = + CreativeFieldsListResponse' + { _cflrNextPageToken :: !(Maybe Text) + , _cflrKind :: !Text + , _cflrCreativeFields :: !(Maybe [CreativeField]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'CreativeFieldsListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'cflrNextPageToken' +-- +-- * 'cflrKind' +-- +-- * 'cflrCreativeFields' +creativeFieldsListResponse + :: CreativeFieldsListResponse +creativeFieldsListResponse = + CreativeFieldsListResponse' + { _cflrNextPageToken = Nothing + , _cflrKind = "dfareporting#creativeFieldsListResponse" + , _cflrCreativeFields = Nothing + } + + +-- | Pagination token to be used for the next list operation. +cflrNextPageToken :: Lens' CreativeFieldsListResponse (Maybe Text) +cflrNextPageToken + = lens _cflrNextPageToken + (\ s a -> s{_cflrNextPageToken = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#creativeFieldsListResponse\". +cflrKind :: Lens' CreativeFieldsListResponse Text +cflrKind = lens _cflrKind (\ s a -> s{_cflrKind = a}) + +-- | Creative field collection. +cflrCreativeFields :: Lens' CreativeFieldsListResponse [CreativeField] +cflrCreativeFields + = lens _cflrCreativeFields + (\ s a -> s{_cflrCreativeFields = a}) + . _Default + . _Coerce + +instance FromJSON CreativeFieldsListResponse where + parseJSON + = withObject "CreativeFieldsListResponse" + (\ o -> + CreativeFieldsListResponse' <$> + (o .:? "nextPageToken") <*> + (o .:? "kind" .!= + "dfareporting#creativeFieldsListResponse") + <*> (o .:? "creativeFields" .!= mempty)) + +instance ToJSON CreativeFieldsListResponse where + toJSON CreativeFieldsListResponse'{..} + = object + (catMaybes + [("nextPageToken" .=) <$> _cflrNextPageToken, + Just ("kind" .= _cflrKind), + ("creativeFields" .=) <$> _cflrCreativeFields]) + +-- | Targeting Template List Response +-- +-- /See:/ 'targetingTemplatesListResponse' smart constructor. +data TargetingTemplatesListResponse = + TargetingTemplatesListResponse' + { _ttlrNextPageToken :: !(Maybe Text) + , _ttlrKind :: !Text + , _ttlrTargetingTemplates :: !(Maybe [TargetingTemplate]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'TargetingTemplatesListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'ttlrNextPageToken' +-- +-- * 'ttlrKind' +-- +-- * 'ttlrTargetingTemplates' +targetingTemplatesListResponse + :: TargetingTemplatesListResponse +targetingTemplatesListResponse = + TargetingTemplatesListResponse' + { _ttlrNextPageToken = Nothing + , _ttlrKind = "dfareporting#targetingTemplatesListResponse" + , _ttlrTargetingTemplates = Nothing + } + + +-- | Pagination token to be used for the next list operation. +ttlrNextPageToken :: Lens' TargetingTemplatesListResponse (Maybe Text) +ttlrNextPageToken + = lens _ttlrNextPageToken + (\ s a -> s{_ttlrNextPageToken = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#targetingTemplatesListResponse\". +ttlrKind :: Lens' TargetingTemplatesListResponse Text +ttlrKind = lens _ttlrKind (\ s a -> s{_ttlrKind = a}) + +-- | Targeting template collection. +ttlrTargetingTemplates :: Lens' TargetingTemplatesListResponse [TargetingTemplate] +ttlrTargetingTemplates + = lens _ttlrTargetingTemplates + (\ s a -> s{_ttlrTargetingTemplates = a}) + . _Default + . _Coerce + +instance FromJSON TargetingTemplatesListResponse + where + parseJSON + = withObject "TargetingTemplatesListResponse" + (\ o -> + TargetingTemplatesListResponse' <$> + (o .:? "nextPageToken") <*> + (o .:? "kind" .!= + "dfareporting#targetingTemplatesListResponse") + <*> (o .:? "targetingTemplates" .!= mempty)) + +instance ToJSON TargetingTemplatesListResponse where + toJSON TargetingTemplatesListResponse'{..} + = object + (catMaybes + [("nextPageToken" .=) <$> _ttlrNextPageToken, + Just ("kind" .= _ttlrKind), + ("targetingTemplates" .=) <$> + _ttlrTargetingTemplates]) + +-- | Placement GenerateTags Response +-- +-- /See:/ 'placementsGenerateTagsResponse' smart constructor. +data PlacementsGenerateTagsResponse = + PlacementsGenerateTagsResponse' + { _pgtrKind :: !Text + , _pgtrPlacementTags :: !(Maybe [PlacementTag]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'PlacementsGenerateTagsResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'pgtrKind' +-- +-- * 'pgtrPlacementTags' +placementsGenerateTagsResponse + :: PlacementsGenerateTagsResponse +placementsGenerateTagsResponse = + PlacementsGenerateTagsResponse' + { _pgtrKind = "dfareporting#placementsGenerateTagsResponse" + , _pgtrPlacementTags = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#placementsGenerateTagsResponse\". +pgtrKind :: Lens' PlacementsGenerateTagsResponse Text +pgtrKind = lens _pgtrKind (\ s a -> s{_pgtrKind = a}) + +-- | Set of generated tags for the specified placements. +pgtrPlacementTags :: Lens' PlacementsGenerateTagsResponse [PlacementTag] +pgtrPlacementTags + = lens _pgtrPlacementTags + (\ s a -> s{_pgtrPlacementTags = a}) + . _Default + . _Coerce + +instance FromJSON PlacementsGenerateTagsResponse + where + parseJSON + = withObject "PlacementsGenerateTagsResponse" + (\ o -> + PlacementsGenerateTagsResponse' <$> + (o .:? "kind" .!= + "dfareporting#placementsGenerateTagsResponse") + <*> (o .:? "placementTags" .!= mempty)) + +instance ToJSON PlacementsGenerateTagsResponse where + toJSON PlacementsGenerateTagsResponse'{..} + = object + (catMaybes + [Just ("kind" .= _pgtrKind), + ("placementTags" .=) <$> _pgtrPlacementTags]) + +-- | Creative Asset. +-- +-- /See:/ 'creativeAsset' smart constructor. +data CreativeAsset = + CreativeAsset' + { _caaZIndex :: !(Maybe (Textual Int32)) + , _caaPushdown :: !(Maybe Bool) + , _caaFrameRate :: !(Maybe (Textual Double)) + , _caaOriginalBackup :: !(Maybe Bool) + , _caaWindowMode :: !(Maybe CreativeAssetWindowMode) + , _caaFlashVersion :: !(Maybe (Textual Int32)) + , _caaPushdownDuration :: !(Maybe (Textual Double)) + , _caaSize :: !(Maybe Size) + , _caaVerticallyLocked :: !(Maybe Bool) + , _caaOffSet :: !(Maybe OffSetPosition) + , _caaStreamingServingURL :: !(Maybe Text) + , _caaZipFilesize :: !(Maybe Text) + , _caaTransparency :: !(Maybe Bool) + , _caaHideSelectionBoxes :: !(Maybe Bool) + , _caaSSLCompliant :: !(Maybe Bool) + , _caaFileSize :: !(Maybe (Textual Int64)) + , _caaAssetIdentifier :: !(Maybe CreativeAssetId) + , _caaCompanionCreativeIds :: !(Maybe [Textual Int64]) + , _caaDurationType :: !(Maybe CreativeAssetDurationType) + , _caaProgressiveServingURL :: !(Maybe Text) + , _caaIdDimensionValue :: !(Maybe DimensionValue) + , _caaActive :: !(Maybe Bool) + , _caaRole :: !(Maybe CreativeAssetRole) + , _caaMimeType :: !(Maybe Text) + , _caaPositionTopUnit :: !(Maybe CreativeAssetPositionTopUnit) + , _caaPositionLeftUnit :: !(Maybe CreativeAssetPositionLeftUnit) + , _caaAlignment :: !(Maybe CreativeAssetAlignment) + , _caaExpandedDimension :: !(Maybe Size) + , _caaAdditionalSizes :: !(Maybe [Size]) + , _caaZipFilename :: !(Maybe Text) + , _caaMediaDuration :: !(Maybe (Textual Double)) + , _caaActionScript3 :: !(Maybe Bool) + , _caaDisplayType :: !(Maybe CreativeAssetDisplayType) + , _caaChildAssetType :: !(Maybe CreativeAssetChildAssetType) + , _caaCollapsedSize :: !(Maybe Size) + , _caaAudioSampleRate :: !(Maybe (Textual Int32)) + , _caaId :: !(Maybe (Textual Int64)) + , _caaBitRate :: !(Maybe (Textual Int32)) + , _caaPoliteLoad :: !(Maybe Bool) + , _caaCustomStartTimeValue :: !(Maybe (Textual Int32)) + , _caaStartTimeType :: !(Maybe CreativeAssetStartTimeType) + , _caaAudioBitRate :: !(Maybe (Textual Int32)) + , _caaDuration :: !(Maybe (Textual Int32)) + , _caaOrientation :: !(Maybe CreativeAssetOrientation) + , _caaArtworkType :: !(Maybe CreativeAssetArtworkType) + , _caaHideFlashObjects :: !(Maybe Bool) + , _caaDetectedFeatures :: !(Maybe [CreativeAssetDetectedFeaturesItem]) + , _caaBackupImageExit :: !(Maybe CreativeCustomEvent) + , _caaPosition :: !(Maybe OffSetPosition) + , _caaHorizontallyLocked :: !(Maybe Bool) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'CreativeAsset' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'caaZIndex' +-- +-- * 'caaPushdown' +-- +-- * 'caaFrameRate' +-- +-- * 'caaOriginalBackup' +-- +-- * 'caaWindowMode' +-- +-- * 'caaFlashVersion' +-- +-- * 'caaPushdownDuration' +-- +-- * 'caaSize' +-- +-- * 'caaVerticallyLocked' +-- +-- * 'caaOffSet' +-- +-- * 'caaStreamingServingURL' +-- +-- * 'caaZipFilesize' +-- +-- * 'caaTransparency' +-- +-- * 'caaHideSelectionBoxes' +-- +-- * 'caaSSLCompliant' +-- +-- * 'caaFileSize' +-- +-- * 'caaAssetIdentifier' +-- +-- * 'caaCompanionCreativeIds' +-- +-- * 'caaDurationType' +-- +-- * 'caaProgressiveServingURL' +-- +-- * 'caaIdDimensionValue' +-- +-- * 'caaActive' +-- +-- * 'caaRole' +-- +-- * 'caaMimeType' +-- +-- * 'caaPositionTopUnit' +-- +-- * 'caaPositionLeftUnit' +-- +-- * 'caaAlignment' +-- +-- * 'caaExpandedDimension' +-- +-- * 'caaAdditionalSizes' +-- +-- * 'caaZipFilename' +-- +-- * 'caaMediaDuration' +-- +-- * 'caaActionScript3' +-- +-- * 'caaDisplayType' +-- +-- * 'caaChildAssetType' +-- +-- * 'caaCollapsedSize' +-- +-- * 'caaAudioSampleRate' +-- +-- * 'caaId' +-- +-- * 'caaBitRate' +-- +-- * 'caaPoliteLoad' +-- +-- * 'caaCustomStartTimeValue' +-- +-- * 'caaStartTimeType' +-- +-- * 'caaAudioBitRate' +-- +-- * 'caaDuration' +-- +-- * 'caaOrientation' +-- +-- * 'caaArtworkType' +-- +-- * 'caaHideFlashObjects' +-- +-- * 'caaDetectedFeatures' +-- +-- * 'caaBackupImageExit' +-- +-- * 'caaPosition' +-- +-- * 'caaHorizontallyLocked' +creativeAsset + :: CreativeAsset +creativeAsset = + CreativeAsset' + { _caaZIndex = Nothing + , _caaPushdown = Nothing + , _caaFrameRate = Nothing + , _caaOriginalBackup = Nothing + , _caaWindowMode = Nothing + , _caaFlashVersion = Nothing + , _caaPushdownDuration = Nothing + , _caaSize = Nothing + , _caaVerticallyLocked = Nothing + , _caaOffSet = Nothing + , _caaStreamingServingURL = Nothing + , _caaZipFilesize = Nothing + , _caaTransparency = Nothing + , _caaHideSelectionBoxes = Nothing + , _caaSSLCompliant = Nothing + , _caaFileSize = Nothing + , _caaAssetIdentifier = Nothing + , _caaCompanionCreativeIds = Nothing + , _caaDurationType = Nothing + , _caaProgressiveServingURL = Nothing + , _caaIdDimensionValue = Nothing + , _caaActive = Nothing + , _caaRole = Nothing + , _caaMimeType = Nothing + , _caaPositionTopUnit = Nothing + , _caaPositionLeftUnit = Nothing + , _caaAlignment = Nothing + , _caaExpandedDimension = Nothing + , _caaAdditionalSizes = Nothing + , _caaZipFilename = Nothing + , _caaMediaDuration = Nothing + , _caaActionScript3 = Nothing + , _caaDisplayType = Nothing + , _caaChildAssetType = Nothing + , _caaCollapsedSize = Nothing + , _caaAudioSampleRate = Nothing + , _caaId = Nothing + , _caaBitRate = Nothing + , _caaPoliteLoad = Nothing + , _caaCustomStartTimeValue = Nothing + , _caaStartTimeType = Nothing + , _caaAudioBitRate = Nothing + , _caaDuration = Nothing + , _caaOrientation = Nothing + , _caaArtworkType = Nothing + , _caaHideFlashObjects = Nothing + , _caaDetectedFeatures = Nothing + , _caaBackupImageExit = Nothing + , _caaPosition = Nothing + , _caaHorizontallyLocked = Nothing + } + + +-- | zIndex value of an asset. Applicable to the following creative types: +-- all RICH_MEDIA.Additionally, only applicable to assets whose displayType +-- is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or +-- ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to +-- 999999999, inclusive. +caaZIndex :: Lens' CreativeAsset (Maybe Int32) +caaZIndex + = lens _caaZIndex (\ s a -> s{_caaZIndex = a}) . + mapping _Coerce + +-- | Whether the asset pushes down other content. Applicable to the following +-- creative types: all RICH_MEDIA. Additionally, only applicable when the +-- asset offsets are 0, the collapsedSize.width matches size.width, and the +-- collapsedSize.height is less than size.height. +caaPushdown :: Lens' CreativeAsset (Maybe Bool) +caaPushdown + = lens _caaPushdown (\ s a -> s{_caaPushdown = a}) + +-- | Video frame rate for video asset in frames per second. This is a +-- read-only field. Applicable to the following creative types: +-- INSTREAM_VIDEO and all VPAID. +caaFrameRate :: Lens' CreativeAsset (Maybe Double) +caaFrameRate + = lens _caaFrameRate (\ s a -> s{_caaFrameRate = a}) + . mapping _Coerce + +-- | Whether the backup asset is original or changed by the user in Campaign +-- Manager. Applicable to the following creative types: all RICH_MEDIA. +caaOriginalBackup :: Lens' CreativeAsset (Maybe Bool) +caaOriginalBackup + = lens _caaOriginalBackup + (\ s a -> s{_caaOriginalBackup = a}) + +-- | Window mode options for flash assets. Applicable to the following +-- creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, +-- RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and +-- RICH_MEDIA_INPAGE_FLOATING. +caaWindowMode :: Lens' CreativeAsset (Maybe CreativeAssetWindowMode) +caaWindowMode + = lens _caaWindowMode + (\ s a -> s{_caaWindowMode = a}) + +-- | Flash version of the asset. This is a read-only field. Applicable to the +-- following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. +-- Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. +caaFlashVersion :: Lens' CreativeAsset (Maybe Int32) +caaFlashVersion + = lens _caaFlashVersion + (\ s a -> s{_caaFlashVersion = a}) + . mapping _Coerce + +-- | Pushdown duration in seconds for an asset. Applicable to the following +-- creative types: all RICH_MEDIA.Additionally, only applicable when the +-- asset pushdown field is true, the offsets are 0, the collapsedSize.width +-- matches size.width, and the collapsedSize.height is less than +-- size.height. Acceptable values are 0 to 9.99, inclusive. +caaPushdownDuration :: Lens' CreativeAsset (Maybe Double) +caaPushdownDuration + = lens _caaPushdownDuration + (\ s a -> s{_caaPushdownDuration = a}) + . mapping _Coerce + +-- | Size associated with this creative asset. This is a required field when +-- applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, +-- this field will be automatically set using the actual size of the +-- associated image asset. Applicable to the following creative types: +-- DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all +-- RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not +-- HTML_IMAGE. +caaSize :: Lens' CreativeAsset (Maybe Size) +caaSize = lens _caaSize (\ s a -> s{_caaSize = a}) + +-- | Whether the asset is vertically locked. This is a read-only field. +-- Applicable to the following creative types: all RICH_MEDIA. +caaVerticallyLocked :: Lens' CreativeAsset (Maybe Bool) +caaVerticallyLocked + = lens _caaVerticallyLocked + (\ s a -> s{_caaVerticallyLocked = a}) + +-- | Offset position for an asset in collapsed mode. This is a read-only +-- field. Applicable to the following creative types: all RICH_MEDIA and +-- all VPAID. Additionally, only applicable to assets whose displayType is +-- ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN. +caaOffSet :: Lens' CreativeAsset (Maybe OffSetPosition) +caaOffSet + = lens _caaOffSet (\ s a -> s{_caaOffSet = a}) + +-- | Streaming URL for video asset. This is a read-only field. Applicable to +-- the following creative types: INSTREAM_VIDEO and all VPAID. +caaStreamingServingURL :: Lens' CreativeAsset (Maybe Text) +caaStreamingServingURL + = lens _caaStreamingServingURL + (\ s a -> s{_caaStreamingServingURL = a}) + +-- | Size of zip file. This is a read-only field. Applicable to the following +-- creative types: HTML5_BANNER. +caaZipFilesize :: Lens' CreativeAsset (Maybe Text) +caaZipFilesize + = lens _caaZipFilesize + (\ s a -> s{_caaZipFilesize = a}) + +-- | Whether the asset is transparent. Applicable to the following creative +-- types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets. +caaTransparency :: Lens' CreativeAsset (Maybe Bool) +caaTransparency + = lens _caaTransparency + (\ s a -> s{_caaTransparency = a}) + +-- | Whether to hide selection boxes flag for an asset. Applicable to the +-- following creative types: all RICH_MEDIA. +caaHideSelectionBoxes :: Lens' CreativeAsset (Maybe Bool) +caaHideSelectionBoxes + = lens _caaHideSelectionBoxes + (\ s a -> s{_caaHideSelectionBoxes = a}) + +-- | Whether the asset is SSL-compliant. This is a read-only field. +-- Applicable to all but the following creative types: all REDIRECT and +-- TRACKING_TEXT. +caaSSLCompliant :: Lens' CreativeAsset (Maybe Bool) +caaSSLCompliant + = lens _caaSSLCompliant + (\ s a -> s{_caaSSLCompliant = a}) + +-- | File size associated with this creative asset. This is a read-only +-- field. Applicable to all but the following creative types: all REDIRECT +-- and TRACKING_TEXT. +caaFileSize :: Lens' CreativeAsset (Maybe Int64) +caaFileSize + = lens _caaFileSize (\ s a -> s{_caaFileSize = a}) . + mapping _Coerce + +-- | Identifier of this asset. This is the same identifier returned during +-- creative asset insert operation. This is a required field. Applicable to +-- all but the following creative types: all REDIRECT and TRACKING_TEXT. +caaAssetIdentifier :: Lens' CreativeAsset (Maybe CreativeAssetId) +caaAssetIdentifier + = lens _caaAssetIdentifier + (\ s a -> s{_caaAssetIdentifier = a}) + +-- | List of companion creatives assigned to an in-stream video creative +-- asset. Acceptable values include IDs of existing flash and image +-- creatives. Applicable to INSTREAM_VIDEO creative type with +-- dynamicAssetSelection set to true. +caaCompanionCreativeIds :: Lens' CreativeAsset [Int64] +caaCompanionCreativeIds + = lens _caaCompanionCreativeIds + (\ s a -> s{_caaCompanionCreativeIds = a}) + . _Default + . _Coerce + +-- | Duration type for which an asset will be displayed. Applicable to the +-- following creative types: all RICH_MEDIA. +caaDurationType :: Lens' CreativeAsset (Maybe CreativeAssetDurationType) +caaDurationType + = lens _caaDurationType + (\ s a -> s{_caaDurationType = a}) + +-- | Progressive URL for video asset. This is a read-only field. Applicable +-- to the following creative types: INSTREAM_VIDEO and all VPAID. +caaProgressiveServingURL :: Lens' CreativeAsset (Maybe Text) +caaProgressiveServingURL + = lens _caaProgressiveServingURL + (\ s a -> s{_caaProgressiveServingURL = a}) + +-- | Dimension value for the ID of the asset. This is a read-only, +-- auto-generated field. +caaIdDimensionValue :: Lens' CreativeAsset (Maybe DimensionValue) +caaIdDimensionValue + = lens _caaIdDimensionValue + (\ s a -> s{_caaIdDimensionValue = a}) + +-- | Whether the video or audio asset is active. This is a read-only field +-- for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative +-- types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. +caaActive :: Lens' CreativeAsset (Maybe Bool) +caaActive + = lens _caaActive (\ s a -> s{_caaActive = a}) + +-- | Role of the asset in relation to creative. Applicable to all but the +-- following creative types: all REDIRECT and TRACKING_TEXT. This is a +-- required field. PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, +-- IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple +-- primary assets), and all VPAID creatives. BACKUP_IMAGE applies to +-- FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. +-- Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. +-- ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. +-- OTHER refers to assets from sources other than Campaign Manager, such as +-- Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID +-- creatives. PARENT_VIDEO refers to videos uploaded by the user in +-- Campaign Manager and is applicable to INSTREAM_VIDEO and +-- VPAID_LINEAR_VIDEO creatives. TRANSCODED_VIDEO refers to videos +-- transcoded by Campaign Manager from PARENT_VIDEO assets and is +-- applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. +-- ALTERNATE_VIDEO refers to the Campaign Manager representation of child +-- asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO +-- creatives. These cannot be added or removed within Campaign Manager. For +-- VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and +-- ALTERNATE_VIDEO assets that are marked active serve as backup in case +-- the VPAID creative cannot be served. Only PARENT_VIDEO assets can be +-- added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative. +-- PARENT_AUDIO refers to audios uploaded by the user in Campaign Manager +-- and is applicable to INSTREAM_AUDIO creatives. TRANSCODED_AUDIO refers +-- to audios transcoded by Campaign Manager from PARENT_AUDIO assets and is +-- applicable to INSTREAM_AUDIO creatives. +caaRole :: Lens' CreativeAsset (Maybe CreativeAssetRole) +caaRole = lens _caaRole (\ s a -> s{_caaRole = a}) + +-- | Detected MIME type for audio or video asset. This is a read-only field. +-- Applicable to the following creative types: INSTREAM_AUDIO, +-- INSTREAM_VIDEO and all VPAID. +caaMimeType :: Lens' CreativeAsset (Maybe Text) +caaMimeType + = lens _caaMimeType (\ s a -> s{_caaMimeType = a}) + +-- | Offset top unit for an asset. This is a read-only field if the asset +-- displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following +-- creative types: all RICH_MEDIA. +caaPositionTopUnit :: Lens' CreativeAsset (Maybe CreativeAssetPositionTopUnit) +caaPositionTopUnit + = lens _caaPositionTopUnit + (\ s a -> s{_caaPositionTopUnit = a}) + +-- | Offset left unit for an asset. This is a read-only field. Applicable to +-- the following creative types: all RICH_MEDIA. +caaPositionLeftUnit :: Lens' CreativeAsset (Maybe CreativeAssetPositionLeftUnit) +caaPositionLeftUnit + = lens _caaPositionLeftUnit + (\ s a -> s{_caaPositionLeftUnit = a}) + +-- | Possible alignments for an asset. This is a read-only field. Applicable +-- to the following creative types: +-- RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL. +caaAlignment :: Lens' CreativeAsset (Maybe CreativeAssetAlignment) +caaAlignment + = lens _caaAlignment (\ s a -> s{_caaAlignment = a}) + +-- | Detected expanded dimension for video asset. This is a read-only field. +-- Applicable to the following creative types: INSTREAM_VIDEO and all +-- VPAID. +caaExpandedDimension :: Lens' CreativeAsset (Maybe Size) +caaExpandedDimension + = lens _caaExpandedDimension + (\ s a -> s{_caaExpandedDimension = a}) + +-- | Additional sizes associated with this creative asset. HTML5 asset +-- generated by compatible software such as GWD will be able to support +-- more sizes this creative asset can render. +caaAdditionalSizes :: Lens' CreativeAsset [Size] +caaAdditionalSizes + = lens _caaAdditionalSizes + (\ s a -> s{_caaAdditionalSizes = a}) + . _Default + . _Coerce + +-- | File name of zip file. This is a read-only field. Applicable to the +-- following creative types: HTML5_BANNER. +caaZipFilename :: Lens' CreativeAsset (Maybe Text) +caaZipFilename + = lens _caaZipFilename + (\ s a -> s{_caaZipFilename = a}) + +-- | Detected duration for audio or video asset. This is a read-only field. +-- Applicable to the following creative types: INSTREAM_AUDIO, +-- INSTREAM_VIDEO and all VPAID. +caaMediaDuration :: Lens' CreativeAsset (Maybe Double) +caaMediaDuration + = lens _caaMediaDuration + (\ s a -> s{_caaMediaDuration = a}) + . mapping _Coerce + +-- | Whether ActionScript3 is enabled for the flash asset. This is a +-- read-only field. Applicable to the following creative type: +-- FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not +-- HTML_IMAGE. +caaActionScript3 :: Lens' CreativeAsset (Maybe Bool) +caaActionScript3 + = lens _caaActionScript3 + (\ s a -> s{_caaActionScript3 = a}) + +-- | Type of rich media asset. This is a read-only field. Applicable to the +-- following creative types: all RICH_MEDIA. +caaDisplayType :: Lens' CreativeAsset (Maybe CreativeAssetDisplayType) +caaDisplayType + = lens _caaDisplayType + (\ s a -> s{_caaDisplayType = a}) + +-- | Rich media child asset type. This is a read-only field. Applicable to +-- the following creative types: all VPAID. +caaChildAssetType :: Lens' CreativeAsset (Maybe CreativeAssetChildAssetType) +caaChildAssetType + = lens _caaChildAssetType + (\ s a -> s{_caaChildAssetType = a}) + +-- | Size of an asset when collapsed. This is a read-only field. Applicable +-- to the following creative types: all RICH_MEDIA and all VPAID. +-- Additionally, applicable to assets whose displayType is +-- ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN. +caaCollapsedSize :: Lens' CreativeAsset (Maybe Size) +caaCollapsedSize + = lens _caaCollapsedSize + (\ s a -> s{_caaCollapsedSize = a}) + +-- | Audio sample bit rate in hertz. This is a read-only field. Applicable to +-- the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all +-- VPAID. +caaAudioSampleRate :: Lens' CreativeAsset (Maybe Int32) +caaAudioSampleRate + = lens _caaAudioSampleRate + (\ s a -> s{_caaAudioSampleRate = a}) + . mapping _Coerce + +-- | Numeric ID of this creative asset. This is a required field and should +-- not be modified. Applicable to all but the following creative types: all +-- REDIRECT and TRACKING_TEXT. +caaId :: Lens' CreativeAsset (Maybe Int64) +caaId + = lens _caaId (\ s a -> s{_caaId = a}) . + mapping _Coerce + +-- | Detected bit-rate for audio or video asset. This is a read-only field. +-- Applicable to the following creative types: INSTREAM_AUDIO, +-- INSTREAM_VIDEO and all VPAID. +caaBitRate :: Lens' CreativeAsset (Maybe Int32) +caaBitRate + = lens _caaBitRate (\ s a -> s{_caaBitRate = a}) . + mapping _Coerce + +-- | Whether this asset is used as a polite load asset. +caaPoliteLoad :: Lens' CreativeAsset (Maybe Bool) +caaPoliteLoad + = lens _caaPoliteLoad + (\ s a -> s{_caaPoliteLoad = a}) + +-- | Custom start time in seconds for making the asset visible. Applicable to +-- the following creative types: all RICH_MEDIA. Value must be greater than +-- or equal to 0. +caaCustomStartTimeValue :: Lens' CreativeAsset (Maybe Int32) +caaCustomStartTimeValue + = lens _caaCustomStartTimeValue + (\ s a -> s{_caaCustomStartTimeValue = a}) + . mapping _Coerce + +-- | Initial wait time type before making the asset visible. Applicable to +-- the following creative types: all RICH_MEDIA. +caaStartTimeType :: Lens' CreativeAsset (Maybe CreativeAssetStartTimeType) +caaStartTimeType + = lens _caaStartTimeType + (\ s a -> s{_caaStartTimeType = a}) + +-- | Audio stream bit rate in kbps. This is a read-only field. Applicable to +-- the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all +-- VPAID. +caaAudioBitRate :: Lens' CreativeAsset (Maybe Int32) +caaAudioBitRate + = lens _caaAudioBitRate + (\ s a -> s{_caaAudioBitRate = a}) + . mapping _Coerce + +-- | Duration in seconds for which an asset will be displayed. Applicable to +-- the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and +-- VPAID_LINEAR_VIDEO. Value must be greater than or equal to 1. +caaDuration :: Lens' CreativeAsset (Maybe Int32) +caaDuration + = lens _caaDuration (\ s a -> s{_caaDuration = a}) . + mapping _Coerce + +-- | Orientation of video asset. This is a read-only, auto-generated field. +caaOrientation :: Lens' CreativeAsset (Maybe CreativeAssetOrientation) +caaOrientation + = lens _caaOrientation + (\ s a -> s{_caaOrientation = a}) + +-- | Artwork type of rich media creative. This is a read-only field. +-- Applicable to the following creative types: all RICH_MEDIA. +caaArtworkType :: Lens' CreativeAsset (Maybe CreativeAssetArtworkType) +caaArtworkType + = lens _caaArtworkType + (\ s a -> s{_caaArtworkType = a}) + +-- | Whether to hide Flash objects flag for an asset. Applicable to the +-- following creative types: all RICH_MEDIA. +caaHideFlashObjects :: Lens' CreativeAsset (Maybe Bool) +caaHideFlashObjects + = lens _caaHideFlashObjects + (\ s a -> s{_caaHideFlashObjects = a}) + +-- | List of feature dependencies for the creative asset that are detected by +-- Campaign Manager. Feature dependencies are features that a browser must +-- be able to support in order to render your HTML5 creative correctly. +-- This is a read-only, auto-generated field. Applicable to the following +-- creative types: HTML5_BANNER. Applicable to DISPLAY when the primary +-- asset type is not HTML_IMAGE. +caaDetectedFeatures :: Lens' CreativeAsset [CreativeAssetDetectedFeaturesItem] +caaDetectedFeatures + = lens _caaDetectedFeatures + (\ s a -> s{_caaDetectedFeatures = a}) + . _Default + . _Coerce + +-- | Exit event configured for the backup image. Applicable to the following +-- creative types: all RICH_MEDIA. +caaBackupImageExit :: Lens' CreativeAsset (Maybe CreativeCustomEvent) +caaBackupImageExit + = lens _caaBackupImageExit + (\ s a -> s{_caaBackupImageExit = a}) + +-- | Offset position for an asset. Applicable to the following creative +-- types: all RICH_MEDIA. +caaPosition :: Lens' CreativeAsset (Maybe OffSetPosition) +caaPosition + = lens _caaPosition (\ s a -> s{_caaPosition = a}) + +-- | Whether the asset is horizontally locked. This is a read-only field. +-- Applicable to the following creative types: all RICH_MEDIA. +caaHorizontallyLocked :: Lens' CreativeAsset (Maybe Bool) +caaHorizontallyLocked + = lens _caaHorizontallyLocked + (\ s a -> s{_caaHorizontallyLocked = a}) + +instance FromJSON CreativeAsset where + parseJSON + = withObject "CreativeAsset" + (\ o -> + CreativeAsset' <$> + (o .:? "zIndex") <*> (o .:? "pushdown") <*> + (o .:? "frameRate") + <*> (o .:? "originalBackup") + <*> (o .:? "windowMode") + <*> (o .:? "flashVersion") + <*> (o .:? "pushdownDuration") + <*> (o .:? "size") + <*> (o .:? "verticallyLocked") + <*> (o .:? "offset") + <*> (o .:? "streamingServingUrl") + <*> (o .:? "zipFilesize") + <*> (o .:? "transparency") + <*> (o .:? "hideSelectionBoxes") + <*> (o .:? "sslCompliant") + <*> (o .:? "fileSize") + <*> (o .:? "assetIdentifier") + <*> (o .:? "companionCreativeIds" .!= mempty) + <*> (o .:? "durationType") + <*> (o .:? "progressiveServingUrl") + <*> (o .:? "idDimensionValue") + <*> (o .:? "active") + <*> (o .:? "role") + <*> (o .:? "mimeType") + <*> (o .:? "positionTopUnit") + <*> (o .:? "positionLeftUnit") + <*> (o .:? "alignment") + <*> (o .:? "expandedDimension") + <*> (o .:? "additionalSizes" .!= mempty) + <*> (o .:? "zipFilename") + <*> (o .:? "mediaDuration") + <*> (o .:? "actionScript3") + <*> (o .:? "displayType") + <*> (o .:? "childAssetType") + <*> (o .:? "collapsedSize") + <*> (o .:? "audioSampleRate") + <*> (o .:? "id") + <*> (o .:? "bitRate") + <*> (o .:? "politeLoad") + <*> (o .:? "customStartTimeValue") + <*> (o .:? "startTimeType") + <*> (o .:? "audioBitRate") + <*> (o .:? "duration") + <*> (o .:? "orientation") + <*> (o .:? "artworkType") + <*> (o .:? "hideFlashObjects") + <*> (o .:? "detectedFeatures" .!= mempty) + <*> (o .:? "backupImageExit") + <*> (o .:? "position") + <*> (o .:? "horizontallyLocked")) + +instance ToJSON CreativeAsset where + toJSON CreativeAsset'{..} + = object + (catMaybes + [("zIndex" .=) <$> _caaZIndex, + ("pushdown" .=) <$> _caaPushdown, + ("frameRate" .=) <$> _caaFrameRate, + ("originalBackup" .=) <$> _caaOriginalBackup, + ("windowMode" .=) <$> _caaWindowMode, + ("flashVersion" .=) <$> _caaFlashVersion, + ("pushdownDuration" .=) <$> _caaPushdownDuration, + ("size" .=) <$> _caaSize, + ("verticallyLocked" .=) <$> _caaVerticallyLocked, + ("offset" .=) <$> _caaOffSet, + ("streamingServingUrl" .=) <$> + _caaStreamingServingURL, + ("zipFilesize" .=) <$> _caaZipFilesize, + ("transparency" .=) <$> _caaTransparency, + ("hideSelectionBoxes" .=) <$> _caaHideSelectionBoxes, + ("sslCompliant" .=) <$> _caaSSLCompliant, + ("fileSize" .=) <$> _caaFileSize, + ("assetIdentifier" .=) <$> _caaAssetIdentifier, + ("companionCreativeIds" .=) <$> + _caaCompanionCreativeIds, + ("durationType" .=) <$> _caaDurationType, + ("progressiveServingUrl" .=) <$> + _caaProgressiveServingURL, + ("idDimensionValue" .=) <$> _caaIdDimensionValue, + ("active" .=) <$> _caaActive, + ("role" .=) <$> _caaRole, + ("mimeType" .=) <$> _caaMimeType, + ("positionTopUnit" .=) <$> _caaPositionTopUnit, + ("positionLeftUnit" .=) <$> _caaPositionLeftUnit, + ("alignment" .=) <$> _caaAlignment, + ("expandedDimension" .=) <$> _caaExpandedDimension, + ("additionalSizes" .=) <$> _caaAdditionalSizes, + ("zipFilename" .=) <$> _caaZipFilename, + ("mediaDuration" .=) <$> _caaMediaDuration, + ("actionScript3" .=) <$> _caaActionScript3, + ("displayType" .=) <$> _caaDisplayType, + ("childAssetType" .=) <$> _caaChildAssetType, + ("collapsedSize" .=) <$> _caaCollapsedSize, + ("audioSampleRate" .=) <$> _caaAudioSampleRate, + ("id" .=) <$> _caaId, ("bitRate" .=) <$> _caaBitRate, + ("politeLoad" .=) <$> _caaPoliteLoad, + ("customStartTimeValue" .=) <$> + _caaCustomStartTimeValue, + ("startTimeType" .=) <$> _caaStartTimeType, + ("audioBitRate" .=) <$> _caaAudioBitRate, + ("duration" .=) <$> _caaDuration, + ("orientation" .=) <$> _caaOrientation, + ("artworkType" .=) <$> _caaArtworkType, + ("hideFlashObjects" .=) <$> _caaHideFlashObjects, + ("detectedFeatures" .=) <$> _caaDetectedFeatures, + ("backupImageExit" .=) <$> _caaBackupImageExit, + ("position" .=) <$> _caaPosition, + ("horizontallyLocked" .=) <$> + _caaHorizontallyLocked]) + +-- | Language Targeting. +-- +-- /See:/ 'languageTargeting' smart constructor. +newtype LanguageTargeting = + LanguageTargeting' + { _ltLanguages :: Maybe [Language] + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'LanguageTargeting' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'ltLanguages' +languageTargeting + :: LanguageTargeting +languageTargeting = LanguageTargeting' {_ltLanguages = Nothing} + + +-- | Languages that this ad targets. For each language only languageId is +-- required. The other fields are populated automatically when the ad is +-- inserted or updated. +ltLanguages :: Lens' LanguageTargeting [Language] +ltLanguages + = lens _ltLanguages (\ s a -> s{_ltLanguages = a}) . + _Default + . _Coerce + +instance FromJSON LanguageTargeting where + parseJSON + = withObject "LanguageTargeting" + (\ o -> + LanguageTargeting' <$> + (o .:? "languages" .!= mempty)) + +instance ToJSON LanguageTargeting where + toJSON LanguageTargeting'{..} + = object + (catMaybes [("languages" .=) <$> _ltLanguages]) + +-- | Encapsulates the list of rules for asset selection and a default asset +-- in case none of the rules match. Applicable to INSTREAM_VIDEO creatives. +-- +-- /See:/ 'creativeAssetSelection' smart constructor. +data CreativeAssetSelection = + CreativeAssetSelection' + { _casRules :: !(Maybe [Rule]) + , _casDefaultAssetId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'CreativeAssetSelection' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'casRules' +-- +-- * 'casDefaultAssetId' +creativeAssetSelection + :: CreativeAssetSelection +creativeAssetSelection = + CreativeAssetSelection' {_casRules = Nothing, _casDefaultAssetId = Nothing} + + +-- | Rules determine which asset will be served to a viewer. Rules will be +-- evaluated in the order in which they are stored in this list. This list +-- must contain at least one rule. Applicable to INSTREAM_VIDEO creatives. +casRules :: Lens' CreativeAssetSelection [Rule] +casRules + = lens _casRules (\ s a -> s{_casRules = a}) . + _Default + . _Coerce + +-- | A creativeAssets[].id. This should refer to one of the parent assets in +-- this creative, and will be served if none of the rules match. This is a +-- required field. +casDefaultAssetId :: Lens' CreativeAssetSelection (Maybe Int64) +casDefaultAssetId + = lens _casDefaultAssetId + (\ s a -> s{_casDefaultAssetId = a}) + . mapping _Coerce + +instance FromJSON CreativeAssetSelection where + parseJSON + = withObject "CreativeAssetSelection" + (\ o -> + CreativeAssetSelection' <$> + (o .:? "rules" .!= mempty) <*> + (o .:? "defaultAssetId")) + +instance ToJSON CreativeAssetSelection where + toJSON CreativeAssetSelection'{..} + = object + (catMaybes + [("rules" .=) <$> _casRules, + ("defaultAssetId" .=) <$> _casDefaultAssetId]) + +-- | Placement List Response +-- +-- /See:/ 'placementsListResponse' smart constructor. +data PlacementsListResponse = + PlacementsListResponse' + { _plaNextPageToken :: !(Maybe Text) + , _plaKind :: !Text + , _plaPlacements :: !(Maybe [Placement]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'PlacementsListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'plaNextPageToken' +-- +-- * 'plaKind' +-- +-- * 'plaPlacements' +placementsListResponse + :: PlacementsListResponse +placementsListResponse = + PlacementsListResponse' + { _plaNextPageToken = Nothing + , _plaKind = "dfareporting#placementsListResponse" + , _plaPlacements = Nothing + } + + +-- | Pagination token to be used for the next list operation. +plaNextPageToken :: Lens' PlacementsListResponse (Maybe Text) +plaNextPageToken + = lens _plaNextPageToken + (\ s a -> s{_plaNextPageToken = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#placementsListResponse\". +plaKind :: Lens' PlacementsListResponse Text +plaKind = lens _plaKind (\ s a -> s{_plaKind = a}) + +-- | Placement collection. +plaPlacements :: Lens' PlacementsListResponse [Placement] +plaPlacements + = lens _plaPlacements + (\ s a -> s{_plaPlacements = a}) + . _Default + . _Coerce + +instance FromJSON PlacementsListResponse where + parseJSON + = withObject "PlacementsListResponse" + (\ o -> + PlacementsListResponse' <$> + (o .:? "nextPageToken") <*> + (o .:? "kind" .!= + "dfareporting#placementsListResponse") + <*> (o .:? "placements" .!= mempty)) + +instance ToJSON PlacementsListResponse where + toJSON PlacementsListResponse'{..} + = object + (catMaybes + [("nextPageToken" .=) <$> _plaNextPageToken, + Just ("kind" .= _plaKind), + ("placements" .=) <$> _plaPlacements]) + +-- | The report\'s schedule. Can only be set if the report\'s \'dateRange\' +-- is a relative date range and the relative date range is not \"TODAY\". +-- +-- /See:/ 'reportSchedule' smart constructor. +data ReportSchedule = + ReportSchedule' + { _rsEvery :: !(Maybe (Textual Int32)) + , _rsActive :: !(Maybe Bool) + , _rsRepeats :: !(Maybe Text) + , _rsStartDate :: !(Maybe Date') + , _rsExpirationDate :: !(Maybe Date') + , _rsRunsOnDayOfMonth :: !(Maybe ReportScheduleRunsOnDayOfMonth) + , _rsRepeatsOnWeekDays :: !(Maybe [ReportScheduleRepeatsOnWeekDaysItem]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ReportSchedule' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'rsEvery' +-- +-- * 'rsActive' +-- +-- * 'rsRepeats' +-- +-- * 'rsStartDate' +-- +-- * 'rsExpirationDate' +-- +-- * 'rsRunsOnDayOfMonth' +-- +-- * 'rsRepeatsOnWeekDays' +reportSchedule + :: ReportSchedule +reportSchedule = + ReportSchedule' + { _rsEvery = Nothing + , _rsActive = Nothing + , _rsRepeats = Nothing + , _rsStartDate = Nothing + , _rsExpirationDate = Nothing + , _rsRunsOnDayOfMonth = Nothing + , _rsRepeatsOnWeekDays = Nothing + } + + +-- | Defines every how many days, weeks or months the report should be run. +-- Needs to be set when \"repeats\" is either \"DAILY\", \"WEEKLY\" or +-- \"MONTHLY\". +rsEvery :: Lens' ReportSchedule (Maybe Int32) +rsEvery + = lens _rsEvery (\ s a -> s{_rsEvery = a}) . + mapping _Coerce + +-- | Whether the schedule is active or not. Must be set to either true or +-- false. +rsActive :: Lens' ReportSchedule (Maybe Bool) +rsActive = lens _rsActive (\ s a -> s{_rsActive = a}) + +-- | The interval for which the report is repeated. Note: - \"DAILY\" also +-- requires field \"every\" to be set. - \"WEEKLY\" also requires fields +-- \"every\" and \"repeatsOnWeekDays\" to be set. - \"MONTHLY\" also +-- requires fields \"every\" and \"runsOnDayOfMonth\" to be set. +rsRepeats :: Lens' ReportSchedule (Maybe Text) +rsRepeats + = lens _rsRepeats (\ s a -> s{_rsRepeats = a}) + +-- | Start date of date range for which scheduled reports should be run. +rsStartDate :: Lens' ReportSchedule (Maybe Day) +rsStartDate + = lens _rsStartDate (\ s a -> s{_rsStartDate = a}) . + mapping _Date + +-- | The expiration date when the scheduled report stops running. +rsExpirationDate :: Lens' ReportSchedule (Maybe Day) +rsExpirationDate + = lens _rsExpirationDate + (\ s a -> s{_rsExpirationDate = a}) + . mapping _Date + +-- | Enum to define for \"MONTHLY\" scheduled reports whether reports should +-- be repeated on the same day of the month as \"startDate\" or the same +-- day of the week of the month. Example: If \'startDate\' is Monday, April +-- 2nd 2012 (2012-04-02), \"DAY_OF_MONTH\" would run subsequent reports on +-- the 2nd of every Month, and \"WEEK_OF_MONTH\" would run subsequent +-- reports on the first Monday of the month. +rsRunsOnDayOfMonth :: Lens' ReportSchedule (Maybe ReportScheduleRunsOnDayOfMonth) +rsRunsOnDayOfMonth + = lens _rsRunsOnDayOfMonth + (\ s a -> s{_rsRunsOnDayOfMonth = a}) + +-- | List of week days \"WEEKLY\" on which scheduled reports should run. +rsRepeatsOnWeekDays :: Lens' ReportSchedule [ReportScheduleRepeatsOnWeekDaysItem] +rsRepeatsOnWeekDays + = lens _rsRepeatsOnWeekDays + (\ s a -> s{_rsRepeatsOnWeekDays = a}) + . _Default + . _Coerce + +instance FromJSON ReportSchedule where + parseJSON + = withObject "ReportSchedule" + (\ o -> + ReportSchedule' <$> + (o .:? "every") <*> (o .:? "active") <*> + (o .:? "repeats") + <*> (o .:? "startDate") + <*> (o .:? "expirationDate") + <*> (o .:? "runsOnDayOfMonth") + <*> (o .:? "repeatsOnWeekDays" .!= mempty)) + +instance ToJSON ReportSchedule where + toJSON ReportSchedule'{..} + = object + (catMaybes + [("every" .=) <$> _rsEvery, + ("active" .=) <$> _rsActive, + ("repeats" .=) <$> _rsRepeats, + ("startDate" .=) <$> _rsStartDate, + ("expirationDate" .=) <$> _rsExpirationDate, + ("runsOnDayOfMonth" .=) <$> _rsRunsOnDayOfMonth, + ("repeatsOnWeekDays" .=) <$> _rsRepeatsOnWeekDays]) + +-- | The report criteria for a report of type \"PATH_TO_CONVERSION\". +-- +-- /See:/ 'reportPathToConversionCriteria' smart constructor. +data ReportPathToConversionCriteria = + ReportPathToConversionCriteria' + { _rptccReportProperties :: !(Maybe ReportPathToConversionCriteriaReportProperties) + , _rptccMetricNames :: !(Maybe [Text]) + , _rptccCustomRichMediaEvents :: !(Maybe [DimensionValue]) + , _rptccDateRange :: !(Maybe DateRange) + , _rptccConversionDimensions :: !(Maybe [SortedDimension]) + , _rptccCustomFloodlightVariables :: !(Maybe [SortedDimension]) + , _rptccFloodlightConfigId :: !(Maybe DimensionValue) + , _rptccActivityFilters :: !(Maybe [DimensionValue]) + , _rptccPerInteractionDimensions :: !(Maybe [SortedDimension]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ReportPathToConversionCriteria' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'rptccReportProperties' +-- +-- * 'rptccMetricNames' +-- +-- * 'rptccCustomRichMediaEvents' +-- +-- * 'rptccDateRange' +-- +-- * 'rptccConversionDimensions' +-- +-- * 'rptccCustomFloodlightVariables' +-- +-- * 'rptccFloodlightConfigId' +-- +-- * 'rptccActivityFilters' +-- +-- * 'rptccPerInteractionDimensions' +reportPathToConversionCriteria + :: ReportPathToConversionCriteria +reportPathToConversionCriteria = + ReportPathToConversionCriteria' + { _rptccReportProperties = Nothing + , _rptccMetricNames = Nothing + , _rptccCustomRichMediaEvents = Nothing + , _rptccDateRange = Nothing + , _rptccConversionDimensions = Nothing + , _rptccCustomFloodlightVariables = Nothing + , _rptccFloodlightConfigId = Nothing + , _rptccActivityFilters = Nothing + , _rptccPerInteractionDimensions = Nothing + } + + +-- | The properties of the report. +rptccReportProperties :: Lens' ReportPathToConversionCriteria (Maybe ReportPathToConversionCriteriaReportProperties) +rptccReportProperties + = lens _rptccReportProperties + (\ s a -> s{_rptccReportProperties = a}) + +-- | The list of names of metrics the report should include. +rptccMetricNames :: Lens' ReportPathToConversionCriteria [Text] +rptccMetricNames + = lens _rptccMetricNames + (\ s a -> s{_rptccMetricNames = a}) + . _Default + . _Coerce + +-- | The list of custom rich media events to include. +rptccCustomRichMediaEvents :: Lens' ReportPathToConversionCriteria [DimensionValue] +rptccCustomRichMediaEvents + = lens _rptccCustomRichMediaEvents + (\ s a -> s{_rptccCustomRichMediaEvents = a}) + . _Default + . _Coerce + +-- | The date range this report should be run for. +rptccDateRange :: Lens' ReportPathToConversionCriteria (Maybe DateRange) +rptccDateRange + = lens _rptccDateRange + (\ s a -> s{_rptccDateRange = a}) + +-- | The list of conversion dimensions the report should include. +rptccConversionDimensions :: Lens' ReportPathToConversionCriteria [SortedDimension] +rptccConversionDimensions + = lens _rptccConversionDimensions + (\ s a -> s{_rptccConversionDimensions = a}) + . _Default + . _Coerce + +-- | The list of custom floodlight variables the report should include. +rptccCustomFloodlightVariables :: Lens' ReportPathToConversionCriteria [SortedDimension] +rptccCustomFloodlightVariables + = lens _rptccCustomFloodlightVariables + (\ s a -> s{_rptccCustomFloodlightVariables = a}) + . _Default + . _Coerce + +-- | The floodlight ID for which to show data in this report. All advertisers +-- associated with that ID will automatically be added. The dimension of +-- the value needs to be \'dfa:floodlightConfigId\'. +rptccFloodlightConfigId :: Lens' ReportPathToConversionCriteria (Maybe DimensionValue) +rptccFloodlightConfigId + = lens _rptccFloodlightConfigId + (\ s a -> s{_rptccFloodlightConfigId = a}) + +-- | The list of \'dfa:activity\' values to filter on. +rptccActivityFilters :: Lens' ReportPathToConversionCriteria [DimensionValue] +rptccActivityFilters + = lens _rptccActivityFilters + (\ s a -> s{_rptccActivityFilters = a}) + . _Default + . _Coerce + +-- | The list of per interaction dimensions the report should include. +rptccPerInteractionDimensions :: Lens' ReportPathToConversionCriteria [SortedDimension] +rptccPerInteractionDimensions + = lens _rptccPerInteractionDimensions + (\ s a -> s{_rptccPerInteractionDimensions = a}) + . _Default + . _Coerce + +instance FromJSON ReportPathToConversionCriteria + where + parseJSON + = withObject "ReportPathToConversionCriteria" + (\ o -> + ReportPathToConversionCriteria' <$> + (o .:? "reportProperties") <*> + (o .:? "metricNames" .!= mempty) + <*> (o .:? "customRichMediaEvents" .!= mempty) + <*> (o .:? "dateRange") + <*> (o .:? "conversionDimensions" .!= mempty) + <*> (o .:? "customFloodlightVariables" .!= mempty) + <*> (o .:? "floodlightConfigId") + <*> (o .:? "activityFilters" .!= mempty) + <*> (o .:? "perInteractionDimensions" .!= mempty)) + +instance ToJSON ReportPathToConversionCriteria where + toJSON ReportPathToConversionCriteria'{..} + = object + (catMaybes + [("reportProperties" .=) <$> _rptccReportProperties, + ("metricNames" .=) <$> _rptccMetricNames, + ("customRichMediaEvents" .=) <$> + _rptccCustomRichMediaEvents, + ("dateRange" .=) <$> _rptccDateRange, + ("conversionDimensions" .=) <$> + _rptccConversionDimensions, + ("customFloodlightVariables" .=) <$> + _rptccCustomFloodlightVariables, + ("floodlightConfigId" .=) <$> + _rptccFloodlightConfigId, + ("activityFilters" .=) <$> _rptccActivityFilters, + ("perInteractionDimensions" .=) <$> + _rptccPerInteractionDimensions]) + +-- | Metro List Response +-- +-- /See:/ 'metrosListResponse' smart constructor. +data MetrosListResponse = + MetrosListResponse' + { _mlrKind :: !Text + , _mlrMetros :: !(Maybe [Metro]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'MetrosListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'mlrKind' +-- +-- * 'mlrMetros' +metrosListResponse + :: MetrosListResponse +metrosListResponse = + MetrosListResponse' + {_mlrKind = "dfareporting#metrosListResponse", _mlrMetros = Nothing} + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#metrosListResponse\". +mlrKind :: Lens' MetrosListResponse Text +mlrKind = lens _mlrKind (\ s a -> s{_mlrKind = a}) + +-- | Metro collection. +mlrMetros :: Lens' MetrosListResponse [Metro] +mlrMetros + = lens _mlrMetros (\ s a -> s{_mlrMetros = a}) . + _Default + . _Coerce + +instance FromJSON MetrosListResponse where + parseJSON + = withObject "MetrosListResponse" + (\ o -> + MetrosListResponse' <$> + (o .:? "kind" .!= "dfareporting#metrosListResponse") + <*> (o .:? "metros" .!= mempty)) + +instance ToJSON MetrosListResponse where + toJSON MetrosListResponse'{..} + = object + (catMaybes + [Just ("kind" .= _mlrKind), + ("metros" .=) <$> _mlrMetros]) + +-- | Insert Conversions Response. +-- +-- /See:/ 'conversionsBatchInsertResponse' smart constructor. +data ConversionsBatchInsertResponse = + ConversionsBatchInsertResponse' + { _cbirbStatus :: !(Maybe [ConversionStatus]) + , _cbirbKind :: !Text + , _cbirbHasFailures :: !(Maybe Bool) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ConversionsBatchInsertResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'cbirbStatus' +-- +-- * 'cbirbKind' +-- +-- * 'cbirbHasFailures' +conversionsBatchInsertResponse + :: ConversionsBatchInsertResponse +conversionsBatchInsertResponse = + ConversionsBatchInsertResponse' + { _cbirbStatus = Nothing + , _cbirbKind = "dfareporting#conversionsBatchInsertResponse" + , _cbirbHasFailures = Nothing + } + + +-- | The insert status of each conversion. Statuses are returned in the same +-- order that conversions are inserted. +cbirbStatus :: Lens' ConversionsBatchInsertResponse [ConversionStatus] +cbirbStatus + = lens _cbirbStatus (\ s a -> s{_cbirbStatus = a}) . + _Default + . _Coerce + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#conversionsBatchInsertResponse\". +cbirbKind :: Lens' ConversionsBatchInsertResponse Text +cbirbKind + = lens _cbirbKind (\ s a -> s{_cbirbKind = a}) + +-- | Indicates that some or all conversions failed to insert. +cbirbHasFailures :: Lens' ConversionsBatchInsertResponse (Maybe Bool) +cbirbHasFailures + = lens _cbirbHasFailures + (\ s a -> s{_cbirbHasFailures = a}) + +instance FromJSON ConversionsBatchInsertResponse + where + parseJSON + = withObject "ConversionsBatchInsertResponse" + (\ o -> + ConversionsBatchInsertResponse' <$> + (o .:? "status" .!= mempty) <*> + (o .:? "kind" .!= + "dfareporting#conversionsBatchInsertResponse") + <*> (o .:? "hasFailures")) + +instance ToJSON ConversionsBatchInsertResponse where + toJSON ConversionsBatchInsertResponse'{..} + = object + (catMaybes + [("status" .=) <$> _cbirbStatus, + Just ("kind" .= _cbirbKind), + ("hasFailures" .=) <$> _cbirbHasFailures]) + +-- | Order document List Response +-- +-- /See:/ 'orderDocumentsListResponse' smart constructor. +data OrderDocumentsListResponse = + OrderDocumentsListResponse' + { _odlrNextPageToken :: !(Maybe Text) + , _odlrKind :: !Text + , _odlrOrderDocuments :: !(Maybe [OrderDocument]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'OrderDocumentsListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'odlrNextPageToken' +-- +-- * 'odlrKind' +-- +-- * 'odlrOrderDocuments' +orderDocumentsListResponse + :: OrderDocumentsListResponse +orderDocumentsListResponse = + OrderDocumentsListResponse' + { _odlrNextPageToken = Nothing + , _odlrKind = "dfareporting#orderDocumentsListResponse" + , _odlrOrderDocuments = Nothing + } + + +-- | Pagination token to be used for the next list operation. +odlrNextPageToken :: Lens' OrderDocumentsListResponse (Maybe Text) +odlrNextPageToken + = lens _odlrNextPageToken + (\ s a -> s{_odlrNextPageToken = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#orderDocumentsListResponse\". +odlrKind :: Lens' OrderDocumentsListResponse Text +odlrKind = lens _odlrKind (\ s a -> s{_odlrKind = a}) + +-- | Order document collection +odlrOrderDocuments :: Lens' OrderDocumentsListResponse [OrderDocument] +odlrOrderDocuments + = lens _odlrOrderDocuments + (\ s a -> s{_odlrOrderDocuments = a}) + . _Default + . _Coerce + +instance FromJSON OrderDocumentsListResponse where + parseJSON + = withObject "OrderDocumentsListResponse" + (\ o -> + OrderDocumentsListResponse' <$> + (o .:? "nextPageToken") <*> + (o .:? "kind" .!= + "dfareporting#orderDocumentsListResponse") + <*> (o .:? "orderDocuments" .!= mempty)) + +instance ToJSON OrderDocumentsListResponse where + toJSON OrderDocumentsListResponse'{..} + = object + (catMaybes + [("nextPageToken" .=) <$> _odlrNextPageToken, + Just ("kind" .= _odlrKind), + ("orderDocuments" .=) <$> _odlrOrderDocuments]) + +-- | Represents a recipient. +-- +-- /See:/ 'recipient' smart constructor. +data Recipient = + Recipient' + { _recEmail :: !(Maybe Text) + , _recKind :: !Text + , _recDeliveryType :: !(Maybe RecipientDeliveryType) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'Recipient' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'recEmail' +-- +-- * 'recKind' +-- +-- * 'recDeliveryType' +recipient + :: Recipient +recipient = + Recipient' + { _recEmail = Nothing + , _recKind = "dfareporting#recipient" + , _recDeliveryType = Nothing + } + + +-- | The email address of the recipient. +recEmail :: Lens' Recipient (Maybe Text) +recEmail = lens _recEmail (\ s a -> s{_recEmail = a}) + +-- | The kind of resource this is, in this case dfareporting#recipient. +recKind :: Lens' Recipient Text +recKind = lens _recKind (\ s a -> s{_recKind = a}) + +-- | The delivery type for the recipient. +recDeliveryType :: Lens' Recipient (Maybe RecipientDeliveryType) +recDeliveryType + = lens _recDeliveryType + (\ s a -> s{_recDeliveryType = a}) + +instance FromJSON Recipient where + parseJSON + = withObject "Recipient" + (\ o -> + Recipient' <$> + (o .:? "email") <*> + (o .:? "kind" .!= "dfareporting#recipient") + <*> (o .:? "deliveryType")) + +instance ToJSON Recipient where + toJSON Recipient'{..} + = object + (catMaybes + [("email" .=) <$> _recEmail, + Just ("kind" .= _recKind), + ("deliveryType" .=) <$> _recDeliveryType]) + +-- | Contains properties of a site. +-- +-- /See:/ 'site' smart constructor. +data Site = + Site' + { _sitiVideoSettings :: !(Maybe SiteVideoSettings) + , _sitiKind :: !Text + , _sitiKeyName :: !(Maybe Text) + , _sitiSiteContacts :: !(Maybe [SiteContact]) + , _sitiSiteSettings :: !(Maybe SiteSettings) + , _sitiIdDimensionValue :: !(Maybe DimensionValue) + , _sitiDirectorySiteIdDimensionValue :: !(Maybe DimensionValue) + , _sitiAccountId :: !(Maybe (Textual Int64)) + , _sitiName :: !(Maybe Text) + , _sitiDirectorySiteId :: !(Maybe (Textual Int64)) + , _sitiId :: !(Maybe (Textual Int64)) + , _sitiSubAccountId :: !(Maybe (Textual Int64)) + , _sitiApproved :: !(Maybe Bool) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'Site' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'sitiVideoSettings' +-- +-- * 'sitiKind' +-- +-- * 'sitiKeyName' +-- +-- * 'sitiSiteContacts' +-- +-- * 'sitiSiteSettings' +-- +-- * 'sitiIdDimensionValue' +-- +-- * 'sitiDirectorySiteIdDimensionValue' +-- +-- * 'sitiAccountId' +-- +-- * 'sitiName' +-- +-- * 'sitiDirectorySiteId' +-- +-- * 'sitiId' +-- +-- * 'sitiSubAccountId' +-- +-- * 'sitiApproved' +site + :: Site +site = + Site' + { _sitiVideoSettings = Nothing + , _sitiKind = "dfareporting#site" + , _sitiKeyName = Nothing + , _sitiSiteContacts = Nothing + , _sitiSiteSettings = Nothing + , _sitiIdDimensionValue = Nothing + , _sitiDirectorySiteIdDimensionValue = Nothing + , _sitiAccountId = Nothing + , _sitiName = Nothing + , _sitiDirectorySiteId = Nothing + , _sitiId = Nothing + , _sitiSubAccountId = Nothing + , _sitiApproved = Nothing + } + + +-- | Default video settings for new placements created under this site. This +-- value will be used to populate the placements.videoSettings field, when +-- no value is specified for the new placement. +sitiVideoSettings :: Lens' Site (Maybe SiteVideoSettings) +sitiVideoSettings + = lens _sitiVideoSettings + (\ s a -> s{_sitiVideoSettings = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#site\". +sitiKind :: Lens' Site Text +sitiKind = lens _sitiKind (\ s a -> s{_sitiKind = a}) + +-- | Key name of this site. This is a read-only, auto-generated field. +sitiKeyName :: Lens' Site (Maybe Text) +sitiKeyName + = lens _sitiKeyName (\ s a -> s{_sitiKeyName = a}) + +-- | Site contacts. +sitiSiteContacts :: Lens' Site [SiteContact] +sitiSiteContacts + = lens _sitiSiteContacts + (\ s a -> s{_sitiSiteContacts = a}) + . _Default + . _Coerce + +-- | Site-wide settings. +sitiSiteSettings :: Lens' Site (Maybe SiteSettings) +sitiSiteSettings + = lens _sitiSiteSettings + (\ s a -> s{_sitiSiteSettings = a}) + +-- | Dimension value for the ID of this site. This is a read-only, +-- auto-generated field. +sitiIdDimensionValue :: Lens' Site (Maybe DimensionValue) +sitiIdDimensionValue + = lens _sitiIdDimensionValue + (\ s a -> s{_sitiIdDimensionValue = a}) + +-- | Dimension value for the ID of the directory site. This is a read-only, +-- auto-generated field. +sitiDirectorySiteIdDimensionValue :: Lens' Site (Maybe DimensionValue) +sitiDirectorySiteIdDimensionValue + = lens _sitiDirectorySiteIdDimensionValue + (\ s a -> s{_sitiDirectorySiteIdDimensionValue = a}) + +-- | Account ID of this site. This is a read-only field that can be left +-- blank. +sitiAccountId :: Lens' Site (Maybe Int64) +sitiAccountId + = lens _sitiAccountId + (\ s a -> s{_sitiAccountId = a}) + . mapping _Coerce + +-- | Name of this site.This is a required field. Must be less than 128 +-- characters long. If this site is under a subaccount, the name must be +-- unique among sites of the same subaccount. Otherwise, this site is a +-- top-level site, and the name must be unique among top-level sites of the +-- same account. +sitiName :: Lens' Site (Maybe Text) +sitiName = lens _sitiName (\ s a -> s{_sitiName = a}) + +-- | Directory site associated with this site. This is a required field that +-- is read-only after insertion. +sitiDirectorySiteId :: Lens' Site (Maybe Int64) +sitiDirectorySiteId + = lens _sitiDirectorySiteId + (\ s a -> s{_sitiDirectorySiteId = a}) + . mapping _Coerce + +-- | ID of this site. This is a read-only, auto-generated field. +sitiId :: Lens' Site (Maybe Int64) +sitiId + = lens _sitiId (\ s a -> s{_sitiId = a}) . + mapping _Coerce + +-- | Subaccount ID of this site. This is a read-only field that can be left +-- blank. +sitiSubAccountId :: Lens' Site (Maybe Int64) +sitiSubAccountId + = lens _sitiSubAccountId + (\ s a -> s{_sitiSubAccountId = a}) + . mapping _Coerce + +-- | Whether this site is approved. +sitiApproved :: Lens' Site (Maybe Bool) +sitiApproved + = lens _sitiApproved (\ s a -> s{_sitiApproved = a}) + +instance FromJSON Site where + parseJSON + = withObject "Site" + (\ o -> + Site' <$> + (o .:? "videoSettings") <*> + (o .:? "kind" .!= "dfareporting#site") + <*> (o .:? "keyName") + <*> (o .:? "siteContacts" .!= mempty) + <*> (o .:? "siteSettings") + <*> (o .:? "idDimensionValue") + <*> (o .:? "directorySiteIdDimensionValue") + <*> (o .:? "accountId") + <*> (o .:? "name") + <*> (o .:? "directorySiteId") + <*> (o .:? "id") + <*> (o .:? "subaccountId") + <*> (o .:? "approved")) + +instance ToJSON Site where + toJSON Site'{..} + = object + (catMaybes + [("videoSettings" .=) <$> _sitiVideoSettings, + Just ("kind" .= _sitiKind), + ("keyName" .=) <$> _sitiKeyName, + ("siteContacts" .=) <$> _sitiSiteContacts, + ("siteSettings" .=) <$> _sitiSiteSettings, + ("idDimensionValue" .=) <$> _sitiIdDimensionValue, + ("directorySiteIdDimensionValue" .=) <$> + _sitiDirectorySiteIdDimensionValue, + ("accountId" .=) <$> _sitiAccountId, + ("name" .=) <$> _sitiName, + ("directorySiteId" .=) <$> _sitiDirectorySiteId, + ("id" .=) <$> _sitiId, + ("subaccountId" .=) <$> _sitiSubAccountId, + ("approved" .=) <$> _sitiApproved]) + +-- | User Defined Variable configuration. +-- +-- /See:/ 'userDefinedVariableConfiguration' smart constructor. +data UserDefinedVariableConfiguration = + UserDefinedVariableConfiguration' + { _udvcReportName :: !(Maybe Text) + , _udvcDataType :: !(Maybe UserDefinedVariableConfigurationDataType) + , _udvcVariableType :: !(Maybe UserDefinedVariableConfigurationVariableType) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'UserDefinedVariableConfiguration' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'udvcReportName' +-- +-- * 'udvcDataType' +-- +-- * 'udvcVariableType' +userDefinedVariableConfiguration + :: UserDefinedVariableConfiguration +userDefinedVariableConfiguration = + UserDefinedVariableConfiguration' + { _udvcReportName = Nothing + , _udvcDataType = Nothing + , _udvcVariableType = Nothing + } + + +-- | User-friendly name for the variable which will appear in reports. This +-- is a required field, must be less than 64 characters long, and cannot +-- contain the following characters: \"\"\<>\". +udvcReportName :: Lens' UserDefinedVariableConfiguration (Maybe Text) +udvcReportName + = lens _udvcReportName + (\ s a -> s{_udvcReportName = a}) + +-- | Data type for the variable. This is a required field. +udvcDataType :: Lens' UserDefinedVariableConfiguration (Maybe UserDefinedVariableConfigurationDataType) +udvcDataType + = lens _udvcDataType (\ s a -> s{_udvcDataType = a}) + +-- | Variable name in the tag. This is a required field. +udvcVariableType :: Lens' UserDefinedVariableConfiguration (Maybe UserDefinedVariableConfigurationVariableType) +udvcVariableType + = lens _udvcVariableType + (\ s a -> s{_udvcVariableType = a}) + +instance FromJSON UserDefinedVariableConfiguration + where + parseJSON + = withObject "UserDefinedVariableConfiguration" + (\ o -> + UserDefinedVariableConfiguration' <$> + (o .:? "reportName") <*> (o .:? "dataType") <*> + (o .:? "variableType")) + +instance ToJSON UserDefinedVariableConfiguration + where + toJSON UserDefinedVariableConfiguration'{..} + = object + (catMaybes + [("reportName" .=) <$> _udvcReportName, + ("dataType" .=) <$> _udvcDataType, + ("variableType" .=) <$> _udvcVariableType]) + +-- | The report criteria for a report of type \"CROSS_DIMENSION_REACH\". +-- +-- /See:/ 'reportCrossDimensionReachCriteria' smart constructor. +data ReportCrossDimensionReachCriteria = + ReportCrossDimensionReachCriteria' + { _rcdrcPivoted :: !(Maybe Bool) + , _rcdrcBreakdown :: !(Maybe [SortedDimension]) + , _rcdrcDimension :: !(Maybe ReportCrossDimensionReachCriteriaDimension) + , _rcdrcMetricNames :: !(Maybe [Text]) + , _rcdrcDimensionFilters :: !(Maybe [DimensionValue]) + , _rcdrcDateRange :: !(Maybe DateRange) + , _rcdrcOverlapMetricNames :: !(Maybe [Text]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ReportCrossDimensionReachCriteria' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'rcdrcPivoted' +-- +-- * 'rcdrcBreakdown' +-- +-- * 'rcdrcDimension' +-- +-- * 'rcdrcMetricNames' +-- +-- * 'rcdrcDimensionFilters' +-- +-- * 'rcdrcDateRange' +-- +-- * 'rcdrcOverlapMetricNames' +reportCrossDimensionReachCriteria + :: ReportCrossDimensionReachCriteria +reportCrossDimensionReachCriteria = + ReportCrossDimensionReachCriteria' + { _rcdrcPivoted = Nothing + , _rcdrcBreakdown = Nothing + , _rcdrcDimension = Nothing + , _rcdrcMetricNames = Nothing + , _rcdrcDimensionFilters = Nothing + , _rcdrcDateRange = Nothing + , _rcdrcOverlapMetricNames = Nothing + } + + +-- | Whether the report is pivoted or not. Defaults to true. +rcdrcPivoted :: Lens' ReportCrossDimensionReachCriteria (Maybe Bool) +rcdrcPivoted + = lens _rcdrcPivoted (\ s a -> s{_rcdrcPivoted = a}) + +-- | The list of dimensions the report should include. +rcdrcBreakdown :: Lens' ReportCrossDimensionReachCriteria [SortedDimension] +rcdrcBreakdown + = lens _rcdrcBreakdown + (\ s a -> s{_rcdrcBreakdown = a}) + . _Default + . _Coerce + +-- | The dimension option. +rcdrcDimension :: Lens' ReportCrossDimensionReachCriteria (Maybe ReportCrossDimensionReachCriteriaDimension) +rcdrcDimension + = lens _rcdrcDimension + (\ s a -> s{_rcdrcDimension = a}) + +-- | The list of names of metrics the report should include. +rcdrcMetricNames :: Lens' ReportCrossDimensionReachCriteria [Text] +rcdrcMetricNames + = lens _rcdrcMetricNames + (\ s a -> s{_rcdrcMetricNames = a}) + . _Default + . _Coerce + +-- | The list of filters on which dimensions are filtered. +rcdrcDimensionFilters :: Lens' ReportCrossDimensionReachCriteria [DimensionValue] +rcdrcDimensionFilters + = lens _rcdrcDimensionFilters + (\ s a -> s{_rcdrcDimensionFilters = a}) + . _Default + . _Coerce + +-- | The date range this report should be run for. +rcdrcDateRange :: Lens' ReportCrossDimensionReachCriteria (Maybe DateRange) +rcdrcDateRange + = lens _rcdrcDateRange + (\ s a -> s{_rcdrcDateRange = a}) + +-- | The list of names of overlap metrics the report should include. +rcdrcOverlapMetricNames :: Lens' ReportCrossDimensionReachCriteria [Text] +rcdrcOverlapMetricNames + = lens _rcdrcOverlapMetricNames + (\ s a -> s{_rcdrcOverlapMetricNames = a}) + . _Default + . _Coerce + +instance FromJSON ReportCrossDimensionReachCriteria + where + parseJSON + = withObject "ReportCrossDimensionReachCriteria" + (\ o -> + ReportCrossDimensionReachCriteria' <$> + (o .:? "pivoted") <*> (o .:? "breakdown" .!= mempty) + <*> (o .:? "dimension") + <*> (o .:? "metricNames" .!= mempty) + <*> (o .:? "dimensionFilters" .!= mempty) + <*> (o .:? "dateRange") + <*> (o .:? "overlapMetricNames" .!= mempty)) + +instance ToJSON ReportCrossDimensionReachCriteria + where + toJSON ReportCrossDimensionReachCriteria'{..} + = object + (catMaybes + [("pivoted" .=) <$> _rcdrcPivoted, + ("breakdown" .=) <$> _rcdrcBreakdown, + ("dimension" .=) <$> _rcdrcDimension, + ("metricNames" .=) <$> _rcdrcMetricNames, + ("dimensionFilters" .=) <$> _rcdrcDimensionFilters, + ("dateRange" .=) <$> _rcdrcDateRange, + ("overlapMetricNames" .=) <$> + _rcdrcOverlapMetricNames]) + +-- | The URLs where the completed report file can be downloaded. +-- +-- /See:/ 'fileURLs' smart constructor. +data FileURLs = + FileURLs' + { _fuBrowserURL :: !(Maybe Text) + , _fuAPIURL :: !(Maybe Text) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'FileURLs' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'fuBrowserURL' +-- +-- * 'fuAPIURL' +fileURLs + :: FileURLs +fileURLs = FileURLs' {_fuBrowserURL = Nothing, _fuAPIURL = Nothing} + + +-- | The URL for downloading the report data through a browser. +fuBrowserURL :: Lens' FileURLs (Maybe Text) +fuBrowserURL + = lens _fuBrowserURL (\ s a -> s{_fuBrowserURL = a}) + +-- | The URL for downloading the report data through the API. +fuAPIURL :: Lens' FileURLs (Maybe Text) +fuAPIURL = lens _fuAPIURL (\ s a -> s{_fuAPIURL = a}) + +instance FromJSON FileURLs where + parseJSON + = withObject "FileURLs" + (\ o -> + FileURLs' <$> + (o .:? "browserUrl") <*> (o .:? "apiUrl")) + +instance ToJSON FileURLs where + toJSON FileURLs'{..} + = object + (catMaybes + [("browserUrl" .=) <$> _fuBrowserURL, + ("apiUrl" .=) <$> _fuAPIURL]) + +-- | Campaign Creative Association List Response +-- +-- /See:/ 'campaignCreativeAssociationsListResponse' smart constructor. +data CampaignCreativeAssociationsListResponse = + CampaignCreativeAssociationsListResponse' + { _ccalrCampaignCreativeAssociations :: !(Maybe [CampaignCreativeAssociation]) + , _ccalrNextPageToken :: !(Maybe Text) + , _ccalrKind :: !Text + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'CampaignCreativeAssociationsListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'ccalrCampaignCreativeAssociations' +-- +-- * 'ccalrNextPageToken' +-- +-- * 'ccalrKind' +campaignCreativeAssociationsListResponse + :: CampaignCreativeAssociationsListResponse +campaignCreativeAssociationsListResponse = + CampaignCreativeAssociationsListResponse' + { _ccalrCampaignCreativeAssociations = Nothing + , _ccalrNextPageToken = Nothing + , _ccalrKind = "dfareporting#campaignCreativeAssociationsListResponse" + } + + +-- | Campaign creative association collection +ccalrCampaignCreativeAssociations :: Lens' CampaignCreativeAssociationsListResponse [CampaignCreativeAssociation] +ccalrCampaignCreativeAssociations + = lens _ccalrCampaignCreativeAssociations + (\ s a -> s{_ccalrCampaignCreativeAssociations = a}) + . _Default + . _Coerce + +-- | Pagination token to be used for the next list operation. +ccalrNextPageToken :: Lens' CampaignCreativeAssociationsListResponse (Maybe Text) +ccalrNextPageToken + = lens _ccalrNextPageToken + (\ s a -> s{_ccalrNextPageToken = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#campaignCreativeAssociationsListResponse\". +ccalrKind :: Lens' CampaignCreativeAssociationsListResponse Text +ccalrKind + = lens _ccalrKind (\ s a -> s{_ccalrKind = a}) + +instance FromJSON + CampaignCreativeAssociationsListResponse + where + parseJSON + = withObject + "CampaignCreativeAssociationsListResponse" + (\ o -> + CampaignCreativeAssociationsListResponse' <$> + (o .:? "campaignCreativeAssociations" .!= mempty) <*> + (o .:? "nextPageToken") + <*> + (o .:? "kind" .!= + "dfareporting#campaignCreativeAssociationsListResponse")) + +instance ToJSON + CampaignCreativeAssociationsListResponse + where + toJSON CampaignCreativeAssociationsListResponse'{..} + = object + (catMaybes + [("campaignCreativeAssociations" .=) <$> + _ccalrCampaignCreativeAssociations, + ("nextPageToken" .=) <$> _ccalrNextPageToken, + Just ("kind" .= _ccalrKind)]) + +-- | Describes properties of a Planning order. +-- +-- /See:/ 'order' smart constructor. +data Order = + Order' + { _oSellerOrderId :: !(Maybe Text) + , _oSellerOrganizationName :: !(Maybe Text) + , _oKind :: !Text + , _oAdvertiserId :: !(Maybe (Textual Int64)) + , _oPlanningTermId :: !(Maybe (Textual Int64)) + , _oAccountId :: !(Maybe (Textual Int64)) + , _oName :: !(Maybe Text) + , _oSiteNames :: !(Maybe [Text]) + , _oLastModifiedInfo :: !(Maybe LastModifiedInfo) + , _oBuyerOrganizationName :: !(Maybe Text) + , _oId :: !(Maybe (Textual Int64)) + , _oBuyerInvoiceId :: !(Maybe Text) + , _oComments :: !(Maybe Text) + , _oProjectId :: !(Maybe (Textual Int64)) + , _oSubAccountId :: !(Maybe (Textual Int64)) + , _oNotes :: !(Maybe Text) + , _oContacts :: !(Maybe [OrderContact]) + , _oSiteId :: !(Maybe [Textual Int64]) + , _oTermsAndConditions :: !(Maybe Text) + , _oApproverUserProFileIds :: !(Maybe [Textual Int64]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'Order' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'oSellerOrderId' +-- +-- * 'oSellerOrganizationName' +-- +-- * 'oKind' +-- +-- * 'oAdvertiserId' +-- +-- * 'oPlanningTermId' +-- +-- * 'oAccountId' +-- +-- * 'oName' +-- +-- * 'oSiteNames' +-- +-- * 'oLastModifiedInfo' +-- +-- * 'oBuyerOrganizationName' +-- +-- * 'oId' +-- +-- * 'oBuyerInvoiceId' +-- +-- * 'oComments' +-- +-- * 'oProjectId' +-- +-- * 'oSubAccountId' +-- +-- * 'oNotes' +-- +-- * 'oContacts' +-- +-- * 'oSiteId' +-- +-- * 'oTermsAndConditions' +-- +-- * 'oApproverUserProFileIds' +order + :: Order +order = + Order' + { _oSellerOrderId = Nothing + , _oSellerOrganizationName = Nothing + , _oKind = "dfareporting#order" + , _oAdvertiserId = Nothing + , _oPlanningTermId = Nothing + , _oAccountId = Nothing + , _oName = Nothing + , _oSiteNames = Nothing + , _oLastModifiedInfo = Nothing + , _oBuyerOrganizationName = Nothing + , _oId = Nothing + , _oBuyerInvoiceId = Nothing + , _oComments = Nothing + , _oProjectId = Nothing + , _oSubAccountId = Nothing + , _oNotes = Nothing + , _oContacts = Nothing + , _oSiteId = Nothing + , _oTermsAndConditions = Nothing + , _oApproverUserProFileIds = Nothing + } + + +-- | Seller order ID associated with this order. +oSellerOrderId :: Lens' Order (Maybe Text) +oSellerOrderId + = lens _oSellerOrderId + (\ s a -> s{_oSellerOrderId = a}) + +-- | Name of the seller organization. +oSellerOrganizationName :: Lens' Order (Maybe Text) +oSellerOrganizationName + = lens _oSellerOrganizationName + (\ s a -> s{_oSellerOrganizationName = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#order\". +oKind :: Lens' Order Text +oKind = lens _oKind (\ s a -> s{_oKind = a}) + +-- | Advertiser ID of this order. +oAdvertiserId :: Lens' Order (Maybe Int64) +oAdvertiserId + = lens _oAdvertiserId + (\ s a -> s{_oAdvertiserId = a}) + . mapping _Coerce + +-- | ID of the terms and conditions template used in this order. +oPlanningTermId :: Lens' Order (Maybe Int64) +oPlanningTermId + = lens _oPlanningTermId + (\ s a -> s{_oPlanningTermId = a}) + . mapping _Coerce + +-- | Account ID of this order. +oAccountId :: Lens' Order (Maybe Int64) +oAccountId + = lens _oAccountId (\ s a -> s{_oAccountId = a}) . + mapping _Coerce + +-- | Name of this order. +oName :: Lens' Order (Maybe Text) +oName = lens _oName (\ s a -> s{_oName = a}) + +-- | Free-form site names this order is associated with. +oSiteNames :: Lens' Order [Text] +oSiteNames + = lens _oSiteNames (\ s a -> s{_oSiteNames = a}) . + _Default + . _Coerce + +-- | Information about the most recent modification of this order. +oLastModifiedInfo :: Lens' Order (Maybe LastModifiedInfo) +oLastModifiedInfo + = lens _oLastModifiedInfo + (\ s a -> s{_oLastModifiedInfo = a}) + +-- | Name of the buyer organization. +oBuyerOrganizationName :: Lens' Order (Maybe Text) +oBuyerOrganizationName + = lens _oBuyerOrganizationName + (\ s a -> s{_oBuyerOrganizationName = a}) + +-- | ID of this order. This is a read-only, auto-generated field. +oId :: Lens' Order (Maybe Int64) +oId + = lens _oId (\ s a -> s{_oId = a}) . mapping _Coerce + +-- | Buyer invoice ID associated with this order. +oBuyerInvoiceId :: Lens' Order (Maybe Text) +oBuyerInvoiceId + = lens _oBuyerInvoiceId + (\ s a -> s{_oBuyerInvoiceId = a}) + +-- | Comments in this order. +oComments :: Lens' Order (Maybe Text) +oComments + = lens _oComments (\ s a -> s{_oComments = a}) + +-- | Project ID of this order. +oProjectId :: Lens' Order (Maybe Int64) +oProjectId + = lens _oProjectId (\ s a -> s{_oProjectId = a}) . + mapping _Coerce + +-- | Subaccount ID of this order. +oSubAccountId :: Lens' Order (Maybe Int64) +oSubAccountId + = lens _oSubAccountId + (\ s a -> s{_oSubAccountId = a}) + . mapping _Coerce + +-- | Notes of this order. +oNotes :: Lens' Order (Maybe Text) +oNotes = lens _oNotes (\ s a -> s{_oNotes = a}) + +-- | Contacts for this order. +oContacts :: Lens' Order [OrderContact] +oContacts + = lens _oContacts (\ s a -> s{_oContacts = a}) . + _Default + . _Coerce + +-- | Site IDs this order is associated with. +oSiteId :: Lens' Order [Int64] +oSiteId + = lens _oSiteId (\ s a -> s{_oSiteId = a}) . _Default + . _Coerce + +-- | Terms and conditions of this order. +oTermsAndConditions :: Lens' Order (Maybe Text) +oTermsAndConditions + = lens _oTermsAndConditions + (\ s a -> s{_oTermsAndConditions = a}) + +-- | IDs for users that have to approve documents created for this order. +oApproverUserProFileIds :: Lens' Order [Int64] +oApproverUserProFileIds + = lens _oApproverUserProFileIds + (\ s a -> s{_oApproverUserProFileIds = a}) + . _Default + . _Coerce + +instance FromJSON Order where + parseJSON + = withObject "Order" + (\ o -> + Order' <$> + (o .:? "sellerOrderId") <*> + (o .:? "sellerOrganizationName") + <*> (o .:? "kind" .!= "dfareporting#order") + <*> (o .:? "advertiserId") + <*> (o .:? "planningTermId") + <*> (o .:? "accountId") + <*> (o .:? "name") + <*> (o .:? "siteNames" .!= mempty) + <*> (o .:? "lastModifiedInfo") + <*> (o .:? "buyerOrganizationName") + <*> (o .:? "id") + <*> (o .:? "buyerInvoiceId") + <*> (o .:? "comments") + <*> (o .:? "projectId") + <*> (o .:? "subaccountId") + <*> (o .:? "notes") + <*> (o .:? "contacts" .!= mempty) + <*> (o .:? "siteId" .!= mempty) + <*> (o .:? "termsAndConditions") + <*> (o .:? "approverUserProfileIds" .!= mempty)) + +instance ToJSON Order where + toJSON Order'{..} + = object + (catMaybes + [("sellerOrderId" .=) <$> _oSellerOrderId, + ("sellerOrganizationName" .=) <$> + _oSellerOrganizationName, + Just ("kind" .= _oKind), + ("advertiserId" .=) <$> _oAdvertiserId, + ("planningTermId" .=) <$> _oPlanningTermId, + ("accountId" .=) <$> _oAccountId, + ("name" .=) <$> _oName, + ("siteNames" .=) <$> _oSiteNames, + ("lastModifiedInfo" .=) <$> _oLastModifiedInfo, + ("buyerOrganizationName" .=) <$> + _oBuyerOrganizationName, + ("id" .=) <$> _oId, + ("buyerInvoiceId" .=) <$> _oBuyerInvoiceId, + ("comments" .=) <$> _oComments, + ("projectId" .=) <$> _oProjectId, + ("subaccountId" .=) <$> _oSubAccountId, + ("notes" .=) <$> _oNotes, + ("contacts" .=) <$> _oContacts, + ("siteId" .=) <$> _oSiteId, + ("termsAndConditions" .=) <$> _oTermsAndConditions, + ("approverUserProfileIds" .=) <$> + _oApproverUserProFileIds]) + +-- | Creative Asset ID. +-- +-- /See:/ 'creativeAssetId' smart constructor. +data CreativeAssetId = + CreativeAssetId' + { _caiName :: !(Maybe Text) + , _caiType :: !(Maybe CreativeAssetIdType) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'CreativeAssetId' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'caiName' +-- +-- * 'caiType' +creativeAssetId + :: CreativeAssetId +creativeAssetId = CreativeAssetId' {_caiName = Nothing, _caiType = Nothing} + + +-- | Name of the creative asset. This is a required field while inserting an +-- asset. After insertion, this assetIdentifier is used to identify the +-- uploaded asset. Characters in the name must be alphanumeric or one of +-- the following: \".-_ \". Spaces are allowed. +caiName :: Lens' CreativeAssetId (Maybe Text) +caiName = lens _caiName (\ s a -> s{_caiName = a}) + +-- | Type of asset to upload. This is a required field. FLASH and IMAGE are +-- no longer supported for new uploads. All image assets should use +-- HTML_IMAGE. +caiType :: Lens' CreativeAssetId (Maybe CreativeAssetIdType) +caiType = lens _caiType (\ s a -> s{_caiType = a}) + +instance FromJSON CreativeAssetId where + parseJSON + = withObject "CreativeAssetId" + (\ o -> + CreativeAssetId' <$> + (o .:? "name") <*> (o .:? "type")) + +instance ToJSON CreativeAssetId where + toJSON CreativeAssetId'{..} + = object + (catMaybes + [("name" .=) <$> _caiName, ("type" .=) <$> _caiType]) + +-- | Frequency Cap. +-- +-- /See:/ 'frequencyCap' smart constructor. +data FrequencyCap = + FrequencyCap' + { _fcImpressions :: !(Maybe (Textual Int64)) + , _fcDuration :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'FrequencyCap' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'fcImpressions' +-- +-- * 'fcDuration' +frequencyCap + :: FrequencyCap +frequencyCap = FrequencyCap' {_fcImpressions = Nothing, _fcDuration = Nothing} + + +-- | Number of times an individual user can be served the ad within the +-- specified duration. Acceptable values are 1 to 15, inclusive. +fcImpressions :: Lens' FrequencyCap (Maybe Int64) +fcImpressions + = lens _fcImpressions + (\ s a -> s{_fcImpressions = a}) + . mapping _Coerce + +-- | Duration of time, in seconds, for this frequency cap. The maximum +-- duration is 90 days. Acceptable values are 1 to 7776000, inclusive. +fcDuration :: Lens' FrequencyCap (Maybe Int64) +fcDuration + = lens _fcDuration (\ s a -> s{_fcDuration = a}) . + mapping _Coerce + +instance FromJSON FrequencyCap where + parseJSON + = withObject "FrequencyCap" + (\ o -> + FrequencyCap' <$> + (o .:? "impressions") <*> (o .:? "duration")) + +instance ToJSON FrequencyCap where + toJSON FrequencyCap'{..} + = object + (catMaybes + [("impressions" .=) <$> _fcImpressions, + ("duration" .=) <$> _fcDuration]) + +-- | Represents a File resource. A file contains the metadata for a report +-- run. It shows the status of the run and holds the URLs to the generated +-- report data if the run is finished and the status is +-- \"REPORT_AVAILABLE\". +-- +-- /See:/ 'file' smart constructor. +data File = + File' + { _filStatus :: !(Maybe FileStatus) + , _filEtag :: !(Maybe Text) + , _filKind :: !Text + , _filURLs :: !(Maybe FileURLs) + , _filReportId :: !(Maybe (Textual Int64)) + , _filDateRange :: !(Maybe DateRange) + , _filFormat :: !(Maybe FileFormat) + , _filLastModifiedTime :: !(Maybe (Textual Int64)) + , _filId :: !(Maybe (Textual Int64)) + , _filFileName :: !(Maybe Text) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'File' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'filStatus' +-- +-- * 'filEtag' +-- +-- * 'filKind' +-- +-- * 'filURLs' +-- +-- * 'filReportId' +-- +-- * 'filDateRange' +-- +-- * 'filFormat' +-- +-- * 'filLastModifiedTime' +-- +-- * 'filId' +-- +-- * 'filFileName' +file + :: File +file = + File' + { _filStatus = Nothing + , _filEtag = Nothing + , _filKind = "dfareporting#file" + , _filURLs = Nothing + , _filReportId = Nothing + , _filDateRange = Nothing + , _filFormat = Nothing + , _filLastModifiedTime = Nothing + , _filId = Nothing + , _filFileName = Nothing + } + + +-- | The status of the report file. +filStatus :: Lens' File (Maybe FileStatus) +filStatus + = lens _filStatus (\ s a -> s{_filStatus = a}) + +-- | The eTag of this response for caching purposes. +filEtag :: Lens' File (Maybe Text) +filEtag = lens _filEtag (\ s a -> s{_filEtag = a}) + +-- | The kind of resource this is, in this case dfareporting#file. +filKind :: Lens' File Text +filKind = lens _filKind (\ s a -> s{_filKind = a}) + +-- | The URLs where the completed report file can be downloaded. +filURLs :: Lens' File (Maybe FileURLs) +filURLs = lens _filURLs (\ s a -> s{_filURLs = a}) + +-- | The ID of the report this file was generated from. +filReportId :: Lens' File (Maybe Int64) +filReportId + = lens _filReportId (\ s a -> s{_filReportId = a}) . + mapping _Coerce + +-- | The date range for which the file has report data. The date range will +-- always be the absolute date range for which the report is run. +filDateRange :: Lens' File (Maybe DateRange) +filDateRange + = lens _filDateRange (\ s a -> s{_filDateRange = a}) + +-- | The output format of the report. Only available once the file is +-- available. +filFormat :: Lens' File (Maybe FileFormat) +filFormat + = lens _filFormat (\ s a -> s{_filFormat = a}) + +-- | The timestamp in milliseconds since epoch when this file was last +-- modified. +filLastModifiedTime :: Lens' File (Maybe Int64) +filLastModifiedTime + = lens _filLastModifiedTime + (\ s a -> s{_filLastModifiedTime = a}) + . mapping _Coerce + +-- | The unique ID of this report file. +filId :: Lens' File (Maybe Int64) +filId + = lens _filId (\ s a -> s{_filId = a}) . + mapping _Coerce + +-- | The filename of the file. +filFileName :: Lens' File (Maybe Text) +filFileName + = lens _filFileName (\ s a -> s{_filFileName = a}) + +instance FromJSON File where + parseJSON + = withObject "File" + (\ o -> + File' <$> + (o .:? "status") <*> (o .:? "etag") <*> + (o .:? "kind" .!= "dfareporting#file") + <*> (o .:? "urls") + <*> (o .:? "reportId") + <*> (o .:? "dateRange") + <*> (o .:? "format") + <*> (o .:? "lastModifiedTime") + <*> (o .:? "id") + <*> (o .:? "fileName")) + +instance ToJSON File where + toJSON File'{..} + = object + (catMaybes + [("status" .=) <$> _filStatus, + ("etag" .=) <$> _filEtag, Just ("kind" .= _filKind), + ("urls" .=) <$> _filURLs, + ("reportId" .=) <$> _filReportId, + ("dateRange" .=) <$> _filDateRange, + ("format" .=) <$> _filFormat, + ("lastModifiedTime" .=) <$> _filLastModifiedTime, + ("id" .=) <$> _filId, + ("fileName" .=) <$> _filFileName]) + +-- | Creative Group List Response +-- +-- /See:/ 'creativeGroupsListResponse' smart constructor. +data CreativeGroupsListResponse = + CreativeGroupsListResponse' + { _cglrCreativeGroups :: !(Maybe [CreativeGroup]) + , _cglrNextPageToken :: !(Maybe Text) + , _cglrKind :: !Text + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'CreativeGroupsListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'cglrCreativeGroups' +-- +-- * 'cglrNextPageToken' +-- +-- * 'cglrKind' +creativeGroupsListResponse + :: CreativeGroupsListResponse +creativeGroupsListResponse = + CreativeGroupsListResponse' + { _cglrCreativeGroups = Nothing + , _cglrNextPageToken = Nothing + , _cglrKind = "dfareporting#creativeGroupsListResponse" + } + + +-- | Creative group collection. +cglrCreativeGroups :: Lens' CreativeGroupsListResponse [CreativeGroup] +cglrCreativeGroups + = lens _cglrCreativeGroups + (\ s a -> s{_cglrCreativeGroups = a}) + . _Default + . _Coerce + +-- | Pagination token to be used for the next list operation. +cglrNextPageToken :: Lens' CreativeGroupsListResponse (Maybe Text) +cglrNextPageToken + = lens _cglrNextPageToken + (\ s a -> s{_cglrNextPageToken = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#creativeGroupsListResponse\". +cglrKind :: Lens' CreativeGroupsListResponse Text +cglrKind = lens _cglrKind (\ s a -> s{_cglrKind = a}) + +instance FromJSON CreativeGroupsListResponse where + parseJSON + = withObject "CreativeGroupsListResponse" + (\ o -> + CreativeGroupsListResponse' <$> + (o .:? "creativeGroups" .!= mempty) <*> + (o .:? "nextPageToken") + <*> + (o .:? "kind" .!= + "dfareporting#creativeGroupsListResponse")) + +instance ToJSON CreativeGroupsListResponse where + toJSON CreativeGroupsListResponse'{..} + = object + (catMaybes + [("creativeGroups" .=) <$> _cglrCreativeGroups, + ("nextPageToken" .=) <$> _cglrNextPageToken, + Just ("kind" .= _cglrKind)]) + +-- | Mobile Carrier List Response +-- +-- /See:/ 'mobileCarriersListResponse' smart constructor. +data MobileCarriersListResponse = + MobileCarriersListResponse' + { _mclrMobileCarriers :: !(Maybe [MobileCarrier]) + , _mclrKind :: !Text + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'MobileCarriersListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'mclrMobileCarriers' +-- +-- * 'mclrKind' +mobileCarriersListResponse + :: MobileCarriersListResponse +mobileCarriersListResponse = + MobileCarriersListResponse' + { _mclrMobileCarriers = Nothing + , _mclrKind = "dfareporting#mobileCarriersListResponse" + } + + +-- | Mobile carrier collection. +mclrMobileCarriers :: Lens' MobileCarriersListResponse [MobileCarrier] +mclrMobileCarriers + = lens _mclrMobileCarriers + (\ s a -> s{_mclrMobileCarriers = a}) + . _Default + . _Coerce + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#mobileCarriersListResponse\". +mclrKind :: Lens' MobileCarriersListResponse Text +mclrKind = lens _mclrKind (\ s a -> s{_mclrKind = a}) + +instance FromJSON MobileCarriersListResponse where + parseJSON + = withObject "MobileCarriersListResponse" + (\ o -> + MobileCarriersListResponse' <$> + (o .:? "mobileCarriers" .!= mempty) <*> + (o .:? "kind" .!= + "dfareporting#mobileCarriersListResponse")) + +instance ToJSON MobileCarriersListResponse where + toJSON MobileCarriersListResponse'{..} + = object + (catMaybes + [("mobileCarriers" .=) <$> _mclrMobileCarriers, + Just ("kind" .= _mclrKind)]) + +-- | CreativeAssets contains properties of a creative asset file which will +-- be uploaded or has already been uploaded. Refer to the creative sample +-- code for how to upload assets and insert a creative. +-- +-- /See:/ 'creativeAssetMetadata' smart constructor. +data CreativeAssetMetadata = + CreativeAssetMetadata' + { _camaKind :: !Text + , _camaAssetIdentifier :: !(Maybe CreativeAssetId) + , _camaIdDimensionValue :: !(Maybe DimensionValue) + , _camaClickTags :: !(Maybe [ClickTag]) + , _camaWarnedValidationRules :: !(Maybe [CreativeAssetMetadataWarnedValidationRulesItem]) + , _camaId :: !(Maybe (Textual Int64)) + , _camaDetectedFeatures :: !(Maybe [CreativeAssetMetadataDetectedFeaturesItem]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'CreativeAssetMetadata' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'camaKind' +-- +-- * 'camaAssetIdentifier' +-- +-- * 'camaIdDimensionValue' +-- +-- * 'camaClickTags' +-- +-- * 'camaWarnedValidationRules' +-- +-- * 'camaId' +-- +-- * 'camaDetectedFeatures' +creativeAssetMetadata + :: CreativeAssetMetadata +creativeAssetMetadata = + CreativeAssetMetadata' + { _camaKind = "dfareporting#creativeAssetMetadata" + , _camaAssetIdentifier = Nothing + , _camaIdDimensionValue = Nothing + , _camaClickTags = Nothing + , _camaWarnedValidationRules = Nothing + , _camaId = Nothing + , _camaDetectedFeatures = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#creativeAssetMetadata\". +camaKind :: Lens' CreativeAssetMetadata Text +camaKind = lens _camaKind (\ s a -> s{_camaKind = a}) + +-- | ID of the creative asset. This is a required field. +camaAssetIdentifier :: Lens' CreativeAssetMetadata (Maybe CreativeAssetId) +camaAssetIdentifier + = lens _camaAssetIdentifier + (\ s a -> s{_camaAssetIdentifier = a}) + +-- | Dimension value for the numeric ID of the asset. This is a read-only, +-- auto-generated field. +camaIdDimensionValue :: Lens' CreativeAssetMetadata (Maybe DimensionValue) +camaIdDimensionValue + = lens _camaIdDimensionValue + (\ s a -> s{_camaIdDimensionValue = a}) + +-- | List of detected click tags for assets. This is a read-only +-- auto-generated field. +camaClickTags :: Lens' CreativeAssetMetadata [ClickTag] +camaClickTags + = lens _camaClickTags + (\ s a -> s{_camaClickTags = a}) + . _Default + . _Coerce + +-- | Rules validated during code generation that generated a warning. This is +-- a read-only, auto-generated field. Possible values are: - +-- \"ADMOB_REFERENCED\" - \"ASSET_FORMAT_UNSUPPORTED_DCM\" - +-- \"ASSET_INVALID\" - \"CLICK_TAG_HARD_CODED\" - \"CLICK_TAG_INVALID\" - +-- \"CLICK_TAG_IN_GWD\" - \"CLICK_TAG_MISSING\" - +-- \"CLICK_TAG_MORE_THAN_ONE\" - \"CLICK_TAG_NON_TOP_LEVEL\" - +-- \"COMPONENT_UNSUPPORTED_DCM\" - \"ENABLER_UNSUPPORTED_METHOD_DCM\" - +-- \"EXTERNAL_FILE_REFERENCED\" - \"FILE_DETAIL_EMPTY\" - +-- \"FILE_TYPE_INVALID\" - \"GWD_PROPERTIES_INVALID\" - +-- \"HTML5_FEATURE_UNSUPPORTED\" - \"LINKED_FILE_NOT_FOUND\" - +-- \"MAX_FLASH_VERSION_11\" - \"MRAID_REFERENCED\" - \"NOT_SSL_COMPLIANT\" +-- - \"ORPHANED_ASSET\" - \"PRIMARY_HTML_MISSING\" - \"SVG_INVALID\" - +-- \"ZIP_INVALID\" +camaWarnedValidationRules :: Lens' CreativeAssetMetadata [CreativeAssetMetadataWarnedValidationRulesItem] +camaWarnedValidationRules + = lens _camaWarnedValidationRules + (\ s a -> s{_camaWarnedValidationRules = a}) + . _Default + . _Coerce + +-- | Numeric ID of the asset. This is a read-only, auto-generated field. +camaId :: Lens' CreativeAssetMetadata (Maybe Int64) +camaId + = lens _camaId (\ s a -> s{_camaId = a}) . + mapping _Coerce + +-- | List of feature dependencies for the creative asset that are detected by +-- Campaign Manager. Feature dependencies are features that a browser must +-- be able to support in order to render your HTML5 creative correctly. +-- This is a read-only, auto-generated field. +camaDetectedFeatures :: Lens' CreativeAssetMetadata [CreativeAssetMetadataDetectedFeaturesItem] +camaDetectedFeatures + = lens _camaDetectedFeatures + (\ s a -> s{_camaDetectedFeatures = a}) + . _Default + . _Coerce + +instance FromJSON CreativeAssetMetadata where + parseJSON + = withObject "CreativeAssetMetadata" + (\ o -> + CreativeAssetMetadata' <$> + (o .:? "kind" .!= + "dfareporting#creativeAssetMetadata") + <*> (o .:? "assetIdentifier") + <*> (o .:? "idDimensionValue") + <*> (o .:? "clickTags" .!= mempty) + <*> (o .:? "warnedValidationRules" .!= mempty) + <*> (o .:? "id") + <*> (o .:? "detectedFeatures" .!= mempty)) + +instance ToJSON CreativeAssetMetadata where + toJSON CreativeAssetMetadata'{..} + = object + (catMaybes + [Just ("kind" .= _camaKind), + ("assetIdentifier" .=) <$> _camaAssetIdentifier, + ("idDimensionValue" .=) <$> _camaIdDimensionValue, + ("clickTags" .=) <$> _camaClickTags, + ("warnedValidationRules" .=) <$> + _camaWarnedValidationRules, + ("id" .=) <$> _camaId, + ("detectedFeatures" .=) <$> _camaDetectedFeatures]) + +-- | Omniture Integration Settings. +-- +-- /See:/ 'omnitureSettings' smart constructor. +data OmnitureSettings = + OmnitureSettings' + { _osOmnitureCostDataEnabled :: !(Maybe Bool) + , _osOmnitureIntegrationEnabled :: !(Maybe Bool) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'OmnitureSettings' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'osOmnitureCostDataEnabled' +-- +-- * 'osOmnitureIntegrationEnabled' +omnitureSettings + :: OmnitureSettings +omnitureSettings = + OmnitureSettings' + { _osOmnitureCostDataEnabled = Nothing + , _osOmnitureIntegrationEnabled = Nothing + } + + +-- | Whether placement cost data will be sent to Omniture. This property can +-- be enabled only if omnitureIntegrationEnabled is true. +osOmnitureCostDataEnabled :: Lens' OmnitureSettings (Maybe Bool) +osOmnitureCostDataEnabled + = lens _osOmnitureCostDataEnabled + (\ s a -> s{_osOmnitureCostDataEnabled = a}) + +-- | Whether Omniture integration is enabled. This property can be enabled +-- only when the \"Advanced Ad Serving\" account setting is enabled. +osOmnitureIntegrationEnabled :: Lens' OmnitureSettings (Maybe Bool) +osOmnitureIntegrationEnabled + = lens _osOmnitureIntegrationEnabled + (\ s a -> s{_osOmnitureIntegrationEnabled = a}) + +instance FromJSON OmnitureSettings where + parseJSON + = withObject "OmnitureSettings" + (\ o -> + OmnitureSettings' <$> + (o .:? "omnitureCostDataEnabled") <*> + (o .:? "omnitureIntegrationEnabled")) + +instance ToJSON OmnitureSettings where + toJSON OmnitureSettings'{..} + = object + (catMaybes + [("omnitureCostDataEnabled" .=) <$> + _osOmnitureCostDataEnabled, + ("omnitureIntegrationEnabled" .=) <$> + _osOmnitureIntegrationEnabled]) + +-- | Contains information about an internet connection type that can be +-- targeted by ads. Clients can use the connection type to target mobile +-- vs. broadband users. +-- +-- /See:/ 'connectionType' smart constructor. +data ConnectionType = + ConnectionType' + { _cttKind :: !Text + , _cttName :: !(Maybe Text) + , _cttId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ConnectionType' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'cttKind' +-- +-- * 'cttName' +-- +-- * 'cttId' +connectionType + :: ConnectionType +connectionType = + ConnectionType' + { _cttKind = "dfareporting#connectionType" + , _cttName = Nothing + , _cttId = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#connectionType\". +cttKind :: Lens' ConnectionType Text +cttKind = lens _cttKind (\ s a -> s{_cttKind = a}) + +-- | Name of this connection type. +cttName :: Lens' ConnectionType (Maybe Text) +cttName = lens _cttName (\ s a -> s{_cttName = a}) + +-- | ID of this connection type. +cttId :: Lens' ConnectionType (Maybe Int64) +cttId + = lens _cttId (\ s a -> s{_cttId = a}) . + mapping _Coerce + +instance FromJSON ConnectionType where + parseJSON + = withObject "ConnectionType" + (\ o -> + ConnectionType' <$> + (o .:? "kind" .!= "dfareporting#connectionType") <*> + (o .:? "name") + <*> (o .:? "id")) + +instance ToJSON ConnectionType where + toJSON ConnectionType'{..} + = object + (catMaybes + [Just ("kind" .= _cttKind), ("name" .=) <$> _cttName, + ("id" .=) <$> _cttId]) + +-- | Contains properties of a package or roadblock. +-- +-- /See:/ 'placementGroup' smart constructor. +data PlacementGroup = + PlacementGroup' + { _plalPlacementStrategyId :: !(Maybe (Textual Int64)) + , _plalSiteIdDimensionValue :: !(Maybe DimensionValue) + , _plalPricingSchedule :: !(Maybe PricingSchedule) + , _plalKind :: !Text + , _plalCampaignIdDimensionValue :: !(Maybe DimensionValue) + , _plalAdvertiserId :: !(Maybe (Textual Int64)) + , _plalAdvertiserIdDimensionValue :: !(Maybe DimensionValue) + , _plalCampaignId :: !(Maybe (Textual Int64)) + , _plalIdDimensionValue :: !(Maybe DimensionValue) + , _plalPlacementGroupType :: !(Maybe PlacementGroupPlacementGroupType) + , _plalContentCategoryId :: !(Maybe (Textual Int64)) + , _plalDirectorySiteIdDimensionValue :: !(Maybe DimensionValue) + , _plalAccountId :: !(Maybe (Textual Int64)) + , _plalName :: !(Maybe Text) + , _plalDirectorySiteId :: !(Maybe (Textual Int64)) + , _plalCreateInfo :: !(Maybe LastModifiedInfo) + , _plalChildPlacementIds :: !(Maybe [Textual Int64]) + , _plalLastModifiedInfo :: !(Maybe LastModifiedInfo) + , _plalId :: !(Maybe (Textual Int64)) + , _plalPrimaryPlacementId :: !(Maybe (Textual Int64)) + , _plalSubAccountId :: !(Maybe (Textual Int64)) + , _plalExternalId :: !(Maybe Text) + , _plalComment :: !(Maybe Text) + , _plalPrimaryPlacementIdDimensionValue :: !(Maybe DimensionValue) + , _plalSiteId :: !(Maybe (Textual Int64)) + , _plalArchived :: !(Maybe Bool) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'PlacementGroup' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'plalPlacementStrategyId' +-- +-- * 'plalSiteIdDimensionValue' +-- +-- * 'plalPricingSchedule' +-- +-- * 'plalKind' +-- +-- * 'plalCampaignIdDimensionValue' +-- +-- * 'plalAdvertiserId' +-- +-- * 'plalAdvertiserIdDimensionValue' +-- +-- * 'plalCampaignId' +-- +-- * 'plalIdDimensionValue' +-- +-- * 'plalPlacementGroupType' +-- +-- * 'plalContentCategoryId' +-- +-- * 'plalDirectorySiteIdDimensionValue' +-- +-- * 'plalAccountId' +-- +-- * 'plalName' +-- +-- * 'plalDirectorySiteId' +-- +-- * 'plalCreateInfo' +-- +-- * 'plalChildPlacementIds' +-- +-- * 'plalLastModifiedInfo' +-- +-- * 'plalId' +-- +-- * 'plalPrimaryPlacementId' +-- +-- * 'plalSubAccountId' +-- +-- * 'plalExternalId' +-- +-- * 'plalComment' +-- +-- * 'plalPrimaryPlacementIdDimensionValue' +-- +-- * 'plalSiteId' +-- +-- * 'plalArchived' +placementGroup + :: PlacementGroup +placementGroup = + PlacementGroup' + { _plalPlacementStrategyId = Nothing + , _plalSiteIdDimensionValue = Nothing + , _plalPricingSchedule = Nothing + , _plalKind = "dfareporting#placementGroup" + , _plalCampaignIdDimensionValue = Nothing + , _plalAdvertiserId = Nothing + , _plalAdvertiserIdDimensionValue = Nothing + , _plalCampaignId = Nothing + , _plalIdDimensionValue = Nothing + , _plalPlacementGroupType = Nothing + , _plalContentCategoryId = Nothing + , _plalDirectorySiteIdDimensionValue = Nothing + , _plalAccountId = Nothing + , _plalName = Nothing + , _plalDirectorySiteId = Nothing + , _plalCreateInfo = Nothing + , _plalChildPlacementIds = Nothing + , _plalLastModifiedInfo = Nothing + , _plalId = Nothing + , _plalPrimaryPlacementId = Nothing + , _plalSubAccountId = Nothing + , _plalExternalId = Nothing + , _plalComment = Nothing + , _plalPrimaryPlacementIdDimensionValue = Nothing + , _plalSiteId = Nothing + , _plalArchived = Nothing + } + + +-- | ID of the placement strategy assigned to this placement group. +plalPlacementStrategyId :: Lens' PlacementGroup (Maybe Int64) +plalPlacementStrategyId + = lens _plalPlacementStrategyId + (\ s a -> s{_plalPlacementStrategyId = a}) + . mapping _Coerce + +-- | Dimension value for the ID of the site. This is a read-only, +-- auto-generated field. +plalSiteIdDimensionValue :: Lens' PlacementGroup (Maybe DimensionValue) +plalSiteIdDimensionValue + = lens _plalSiteIdDimensionValue + (\ s a -> s{_plalSiteIdDimensionValue = a}) + +-- | Pricing schedule of this placement group. This field is required on +-- insertion. +plalPricingSchedule :: Lens' PlacementGroup (Maybe PricingSchedule) +plalPricingSchedule + = lens _plalPricingSchedule + (\ s a -> s{_plalPricingSchedule = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#placementGroup\". +plalKind :: Lens' PlacementGroup Text +plalKind = lens _plalKind (\ s a -> s{_plalKind = a}) + +-- | Dimension value for the ID of the campaign. This is a read-only, +-- auto-generated field. +plalCampaignIdDimensionValue :: Lens' PlacementGroup (Maybe DimensionValue) +plalCampaignIdDimensionValue + = lens _plalCampaignIdDimensionValue + (\ s a -> s{_plalCampaignIdDimensionValue = a}) + +-- | Advertiser ID of this placement group. This is a required field on +-- insertion. +plalAdvertiserId :: Lens' PlacementGroup (Maybe Int64) +plalAdvertiserId + = lens _plalAdvertiserId + (\ s a -> s{_plalAdvertiserId = a}) + . mapping _Coerce + +-- | Dimension value for the ID of the advertiser. This is a read-only, +-- auto-generated field. +plalAdvertiserIdDimensionValue :: Lens' PlacementGroup (Maybe DimensionValue) +plalAdvertiserIdDimensionValue + = lens _plalAdvertiserIdDimensionValue + (\ s a -> s{_plalAdvertiserIdDimensionValue = a}) + +-- | Campaign ID of this placement group. This field is required on +-- insertion. +plalCampaignId :: Lens' PlacementGroup (Maybe Int64) +plalCampaignId + = lens _plalCampaignId + (\ s a -> s{_plalCampaignId = a}) + . mapping _Coerce + +-- | Dimension value for the ID of this placement group. This is a read-only, +-- auto-generated field. +plalIdDimensionValue :: Lens' PlacementGroup (Maybe DimensionValue) +plalIdDimensionValue + = lens _plalIdDimensionValue + (\ s a -> s{_plalIdDimensionValue = a}) + +-- | Type of this placement group. A package is a simple group of placements +-- that acts as a single pricing point for a group of tags. A roadblock is +-- a group of placements that not only acts as a single pricing point, but +-- also assumes that all the tags in it will be served at the same time. A +-- roadblock requires one of its assigned placements to be marked as +-- primary for reporting. This field is required on insertion. +plalPlacementGroupType :: Lens' PlacementGroup (Maybe PlacementGroupPlacementGroupType) +plalPlacementGroupType + = lens _plalPlacementGroupType + (\ s a -> s{_plalPlacementGroupType = a}) + +-- | ID of the content category assigned to this placement group. +plalContentCategoryId :: Lens' PlacementGroup (Maybe Int64) +plalContentCategoryId + = lens _plalContentCategoryId + (\ s a -> s{_plalContentCategoryId = a}) + . mapping _Coerce + +-- | Dimension value for the ID of the directory site. This is a read-only, +-- auto-generated field. +plalDirectorySiteIdDimensionValue :: Lens' PlacementGroup (Maybe DimensionValue) +plalDirectorySiteIdDimensionValue + = lens _plalDirectorySiteIdDimensionValue + (\ s a -> s{_plalDirectorySiteIdDimensionValue = a}) + +-- | Account ID of this placement group. This is a read-only field that can +-- be left blank. +plalAccountId :: Lens' PlacementGroup (Maybe Int64) +plalAccountId + = lens _plalAccountId + (\ s a -> s{_plalAccountId = a}) + . mapping _Coerce + +-- | Name of this placement group. This is a required field and must be less +-- than 256 characters long. +plalName :: Lens' PlacementGroup (Maybe Text) +plalName = lens _plalName (\ s a -> s{_plalName = a}) + +-- | Directory site ID associated with this placement group. On insert, you +-- must set either this field or the site_id field to specify the site +-- associated with this placement group. This is a required field that is +-- read-only after insertion. +plalDirectorySiteId :: Lens' PlacementGroup (Maybe Int64) +plalDirectorySiteId + = lens _plalDirectorySiteId + (\ s a -> s{_plalDirectorySiteId = a}) + . mapping _Coerce + +-- | Information about the creation of this placement group. This is a +-- read-only field. +plalCreateInfo :: Lens' PlacementGroup (Maybe LastModifiedInfo) +plalCreateInfo + = lens _plalCreateInfo + (\ s a -> s{_plalCreateInfo = a}) + +-- | IDs of placements which are assigned to this placement group. This is a +-- read-only, auto-generated field. +plalChildPlacementIds :: Lens' PlacementGroup [Int64] +plalChildPlacementIds + = lens _plalChildPlacementIds + (\ s a -> s{_plalChildPlacementIds = a}) + . _Default + . _Coerce + +-- | Information about the most recent modification of this placement group. +-- This is a read-only field. +plalLastModifiedInfo :: Lens' PlacementGroup (Maybe LastModifiedInfo) +plalLastModifiedInfo + = lens _plalLastModifiedInfo + (\ s a -> s{_plalLastModifiedInfo = a}) + +-- | ID of this placement group. This is a read-only, auto-generated field. +plalId :: Lens' PlacementGroup (Maybe Int64) +plalId + = lens _plalId (\ s a -> s{_plalId = a}) . + mapping _Coerce + +-- | ID of the primary placement, used to calculate the media cost of a +-- roadblock (placement group). Modifying this field will automatically +-- modify the primary field on all affected roadblock child placements. +plalPrimaryPlacementId :: Lens' PlacementGroup (Maybe Int64) +plalPrimaryPlacementId + = lens _plalPrimaryPlacementId + (\ s a -> s{_plalPrimaryPlacementId = a}) + . mapping _Coerce + +-- | Subaccount ID of this placement group. This is a read-only field that +-- can be left blank. +plalSubAccountId :: Lens' PlacementGroup (Maybe Int64) +plalSubAccountId + = lens _plalSubAccountId + (\ s a -> s{_plalSubAccountId = a}) + . mapping _Coerce + +-- | External ID for this placement. +plalExternalId :: Lens' PlacementGroup (Maybe Text) +plalExternalId + = lens _plalExternalId + (\ s a -> s{_plalExternalId = a}) + +-- | Comments for this placement group. +plalComment :: Lens' PlacementGroup (Maybe Text) +plalComment + = lens _plalComment (\ s a -> s{_plalComment = a}) + +-- | Dimension value for the ID of the primary placement. This is a +-- read-only, auto-generated field. +plalPrimaryPlacementIdDimensionValue :: Lens' PlacementGroup (Maybe DimensionValue) +plalPrimaryPlacementIdDimensionValue + = lens _plalPrimaryPlacementIdDimensionValue + (\ s a -> + s{_plalPrimaryPlacementIdDimensionValue = a}) + +-- | Site ID associated with this placement group. On insert, you must set +-- either this field or the directorySiteId field to specify the site +-- associated with this placement group. This is a required field that is +-- read-only after insertion. +plalSiteId :: Lens' PlacementGroup (Maybe Int64) +plalSiteId + = lens _plalSiteId (\ s a -> s{_plalSiteId = a}) . + mapping _Coerce + +-- | Whether this placement group is archived. +plalArchived :: Lens' PlacementGroup (Maybe Bool) +plalArchived + = lens _plalArchived (\ s a -> s{_plalArchived = a}) + +instance FromJSON PlacementGroup where + parseJSON + = withObject "PlacementGroup" + (\ o -> + PlacementGroup' <$> + (o .:? "placementStrategyId") <*> + (o .:? "siteIdDimensionValue") + <*> (o .:? "pricingSchedule") + <*> (o .:? "kind" .!= "dfareporting#placementGroup") + <*> (o .:? "campaignIdDimensionValue") + <*> (o .:? "advertiserId") + <*> (o .:? "advertiserIdDimensionValue") + <*> (o .:? "campaignId") + <*> (o .:? "idDimensionValue") + <*> (o .:? "placementGroupType") + <*> (o .:? "contentCategoryId") + <*> (o .:? "directorySiteIdDimensionValue") + <*> (o .:? "accountId") + <*> (o .:? "name") + <*> (o .:? "directorySiteId") + <*> (o .:? "createInfo") + <*> (o .:? "childPlacementIds" .!= mempty) + <*> (o .:? "lastModifiedInfo") + <*> (o .:? "id") + <*> (o .:? "primaryPlacementId") + <*> (o .:? "subaccountId") + <*> (o .:? "externalId") + <*> (o .:? "comment") + <*> (o .:? "primaryPlacementIdDimensionValue") + <*> (o .:? "siteId") + <*> (o .:? "archived")) + +instance ToJSON PlacementGroup where + toJSON PlacementGroup'{..} + = object + (catMaybes + [("placementStrategyId" .=) <$> + _plalPlacementStrategyId, + ("siteIdDimensionValue" .=) <$> + _plalSiteIdDimensionValue, + ("pricingSchedule" .=) <$> _plalPricingSchedule, + Just ("kind" .= _plalKind), + ("campaignIdDimensionValue" .=) <$> + _plalCampaignIdDimensionValue, + ("advertiserId" .=) <$> _plalAdvertiserId, + ("advertiserIdDimensionValue" .=) <$> + _plalAdvertiserIdDimensionValue, + ("campaignId" .=) <$> _plalCampaignId, + ("idDimensionValue" .=) <$> _plalIdDimensionValue, + ("placementGroupType" .=) <$> + _plalPlacementGroupType, + ("contentCategoryId" .=) <$> _plalContentCategoryId, + ("directorySiteIdDimensionValue" .=) <$> + _plalDirectorySiteIdDimensionValue, + ("accountId" .=) <$> _plalAccountId, + ("name" .=) <$> _plalName, + ("directorySiteId" .=) <$> _plalDirectorySiteId, + ("createInfo" .=) <$> _plalCreateInfo, + ("childPlacementIds" .=) <$> _plalChildPlacementIds, + ("lastModifiedInfo" .=) <$> _plalLastModifiedInfo, + ("id" .=) <$> _plalId, + ("primaryPlacementId" .=) <$> + _plalPrimaryPlacementId, + ("subaccountId" .=) <$> _plalSubAccountId, + ("externalId" .=) <$> _plalExternalId, + ("comment" .=) <$> _plalComment, + ("primaryPlacementIdDimensionValue" .=) <$> + _plalPrimaryPlacementIdDimensionValue, + ("siteId" .=) <$> _plalSiteId, + ("archived" .=) <$> _plalArchived]) + +-- | Contains properties of an event tag. +-- +-- /See:/ 'eventTag' smart constructor. +data EventTag = + EventTag' + { _etStatus :: !(Maybe EventTagStatus) + , _etExcludeFromAdxRequests :: !(Maybe Bool) + , _etEnabledByDefault :: !(Maybe Bool) + , _etKind :: !Text + , _etCampaignIdDimensionValue :: !(Maybe DimensionValue) + , _etAdvertiserId :: !(Maybe (Textual Int64)) + , _etURL :: !(Maybe Text) + , _etAdvertiserIdDimensionValue :: !(Maybe DimensionValue) + , _etSSLCompliant :: !(Maybe Bool) + , _etCampaignId :: !(Maybe (Textual Int64)) + , _etAccountId :: !(Maybe (Textual Int64)) + , _etName :: !(Maybe Text) + , _etURLEscapeLevels :: !(Maybe (Textual Int32)) + , _etSiteIds :: !(Maybe [Textual Int64]) + , _etId :: !(Maybe (Textual Int64)) + , _etSubAccountId :: !(Maybe (Textual Int64)) + , _etType :: !(Maybe EventTagType) + , _etSiteFilterType :: !(Maybe EventTagSiteFilterType) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'EventTag' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'etStatus' +-- +-- * 'etExcludeFromAdxRequests' +-- +-- * 'etEnabledByDefault' +-- +-- * 'etKind' +-- +-- * 'etCampaignIdDimensionValue' +-- +-- * 'etAdvertiserId' +-- +-- * 'etURL' +-- +-- * 'etAdvertiserIdDimensionValue' +-- +-- * 'etSSLCompliant' +-- +-- * 'etCampaignId' +-- +-- * 'etAccountId' +-- +-- * 'etName' +-- +-- * 'etURLEscapeLevels' +-- +-- * 'etSiteIds' +-- +-- * 'etId' +-- +-- * 'etSubAccountId' +-- +-- * 'etType' +-- +-- * 'etSiteFilterType' +eventTag + :: EventTag +eventTag = + EventTag' + { _etStatus = Nothing + , _etExcludeFromAdxRequests = Nothing + , _etEnabledByDefault = Nothing + , _etKind = "dfareporting#eventTag" + , _etCampaignIdDimensionValue = Nothing + , _etAdvertiserId = Nothing + , _etURL = Nothing + , _etAdvertiserIdDimensionValue = Nothing + , _etSSLCompliant = Nothing + , _etCampaignId = Nothing + , _etAccountId = Nothing + , _etName = Nothing + , _etURLEscapeLevels = Nothing + , _etSiteIds = Nothing + , _etId = Nothing + , _etSubAccountId = Nothing + , _etType = Nothing + , _etSiteFilterType = Nothing + } + + +-- | Status of this event tag. Must be ENABLED for this event tag to fire. +-- This is a required field. +etStatus :: Lens' EventTag (Maybe EventTagStatus) +etStatus = lens _etStatus (\ s a -> s{_etStatus = a}) + +-- | Whether to remove this event tag from ads that are trafficked through +-- Display & Video 360 to Ad Exchange. This may be useful if the event tag +-- uses a pixel that is unapproved for Ad Exchange bids on one or more +-- networks, such as the Google Display Network. +etExcludeFromAdxRequests :: Lens' EventTag (Maybe Bool) +etExcludeFromAdxRequests + = lens _etExcludeFromAdxRequests + (\ s a -> s{_etExcludeFromAdxRequests = a}) + +-- | Whether this event tag should be automatically enabled for all of the +-- advertiser\'s campaigns and ads. +etEnabledByDefault :: Lens' EventTag (Maybe Bool) +etEnabledByDefault + = lens _etEnabledByDefault + (\ s a -> s{_etEnabledByDefault = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#eventTag\". +etKind :: Lens' EventTag Text +etKind = lens _etKind (\ s a -> s{_etKind = a}) + +-- | Dimension value for the ID of the campaign. This is a read-only, +-- auto-generated field. +etCampaignIdDimensionValue :: Lens' EventTag (Maybe DimensionValue) +etCampaignIdDimensionValue + = lens _etCampaignIdDimensionValue + (\ s a -> s{_etCampaignIdDimensionValue = a}) + +-- | Advertiser ID of this event tag. This field or the campaignId field is +-- required on insertion. +etAdvertiserId :: Lens' EventTag (Maybe Int64) +etAdvertiserId + = lens _etAdvertiserId + (\ s a -> s{_etAdvertiserId = a}) + . mapping _Coerce + +-- | Payload URL for this event tag. The URL on a click-through event tag +-- should have a landing page URL appended to the end of it. This field is +-- required on insertion. +etURL :: Lens' EventTag (Maybe Text) +etURL = lens _etURL (\ s a -> s{_etURL = a}) + +-- | Dimension value for the ID of the advertiser. This is a read-only, +-- auto-generated field. +etAdvertiserIdDimensionValue :: Lens' EventTag (Maybe DimensionValue) +etAdvertiserIdDimensionValue + = lens _etAdvertiserIdDimensionValue + (\ s a -> s{_etAdvertiserIdDimensionValue = a}) + +-- | Whether this tag is SSL-compliant or not. This is a read-only field. +etSSLCompliant :: Lens' EventTag (Maybe Bool) +etSSLCompliant + = lens _etSSLCompliant + (\ s a -> s{_etSSLCompliant = a}) + +-- | Campaign ID of this event tag. This field or the advertiserId field is +-- required on insertion. +etCampaignId :: Lens' EventTag (Maybe Int64) +etCampaignId + = lens _etCampaignId (\ s a -> s{_etCampaignId = a}) + . mapping _Coerce + +-- | Account ID of this event tag. This is a read-only field that can be left +-- blank. +etAccountId :: Lens' EventTag (Maybe Int64) +etAccountId + = lens _etAccountId (\ s a -> s{_etAccountId = a}) . + mapping _Coerce + +-- | Name of this event tag. This is a required field and must be less than +-- 256 characters long. +etName :: Lens' EventTag (Maybe Text) +etName = lens _etName (\ s a -> s{_etName = a}) + +-- | Number of times the landing page URL should be URL-escaped before being +-- appended to the click-through event tag URL. Only applies to +-- click-through event tags as specified by the event tag type. +etURLEscapeLevels :: Lens' EventTag (Maybe Int32) +etURLEscapeLevels + = lens _etURLEscapeLevels + (\ s a -> s{_etURLEscapeLevels = a}) + . mapping _Coerce + +-- | Filter list of site IDs associated with this event tag. The +-- siteFilterType determines whether this is a whitelist or blacklist +-- filter. +etSiteIds :: Lens' EventTag [Int64] +etSiteIds + = lens _etSiteIds (\ s a -> s{_etSiteIds = a}) . + _Default + . _Coerce + +-- | ID of this event tag. This is a read-only, auto-generated field. +etId :: Lens' EventTag (Maybe Int64) +etId + = lens _etId (\ s a -> s{_etId = a}) . + mapping _Coerce + +-- | Subaccount ID of this event tag. This is a read-only field that can be +-- left blank. +etSubAccountId :: Lens' EventTag (Maybe Int64) +etSubAccountId + = lens _etSubAccountId + (\ s a -> s{_etSubAccountId = a}) + . mapping _Coerce + +-- | Event tag type. Can be used to specify whether to use a third-party +-- pixel, a third-party JavaScript URL, or a third-party click-through URL +-- for either impression or click tracking. This is a required field. +etType :: Lens' EventTag (Maybe EventTagType) +etType = lens _etType (\ s a -> s{_etType = a}) + +-- | Site filter type for this event tag. If no type is specified then the +-- event tag will be applied to all sites. +etSiteFilterType :: Lens' EventTag (Maybe EventTagSiteFilterType) +etSiteFilterType + = lens _etSiteFilterType + (\ s a -> s{_etSiteFilterType = a}) + +instance FromJSON EventTag where + parseJSON + = withObject "EventTag" + (\ o -> + EventTag' <$> + (o .:? "status") <*> (o .:? "excludeFromAdxRequests") + <*> (o .:? "enabledByDefault") + <*> (o .:? "kind" .!= "dfareporting#eventTag") + <*> (o .:? "campaignIdDimensionValue") + <*> (o .:? "advertiserId") + <*> (o .:? "url") + <*> (o .:? "advertiserIdDimensionValue") + <*> (o .:? "sslCompliant") + <*> (o .:? "campaignId") + <*> (o .:? "accountId") + <*> (o .:? "name") + <*> (o .:? "urlEscapeLevels") + <*> (o .:? "siteIds" .!= mempty) + <*> (o .:? "id") + <*> (o .:? "subaccountId") + <*> (o .:? "type") + <*> (o .:? "siteFilterType")) + +instance ToJSON EventTag where + toJSON EventTag'{..} + = object + (catMaybes + [("status" .=) <$> _etStatus, + ("excludeFromAdxRequests" .=) <$> + _etExcludeFromAdxRequests, + ("enabledByDefault" .=) <$> _etEnabledByDefault, + Just ("kind" .= _etKind), + ("campaignIdDimensionValue" .=) <$> + _etCampaignIdDimensionValue, + ("advertiserId" .=) <$> _etAdvertiserId, + ("url" .=) <$> _etURL, + ("advertiserIdDimensionValue" .=) <$> + _etAdvertiserIdDimensionValue, + ("sslCompliant" .=) <$> _etSSLCompliant, + ("campaignId" .=) <$> _etCampaignId, + ("accountId" .=) <$> _etAccountId, + ("name" .=) <$> _etName, + ("urlEscapeLevels" .=) <$> _etURLEscapeLevels, + ("siteIds" .=) <$> _etSiteIds, ("id" .=) <$> _etId, + ("subaccountId" .=) <$> _etSubAccountId, + ("type" .=) <$> _etType, + ("siteFilterType" .=) <$> _etSiteFilterType]) + +-- | Contains properties of a user role permission. +-- +-- /See:/ 'userRolePermission' smart constructor. +data UserRolePermission = + UserRolePermission' + { _useKind :: !Text + , _useAvailability :: !(Maybe UserRolePermissionAvailability) + , _useName :: !(Maybe Text) + , _useId :: !(Maybe (Textual Int64)) + , _usePermissionGroupId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'UserRolePermission' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'useKind' +-- +-- * 'useAvailability' +-- +-- * 'useName' +-- +-- * 'useId' +-- +-- * 'usePermissionGroupId' +userRolePermission + :: UserRolePermission +userRolePermission = + UserRolePermission' + { _useKind = "dfareporting#userRolePermission" + , _useAvailability = Nothing + , _useName = Nothing + , _useId = Nothing + , _usePermissionGroupId = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#userRolePermission\". +useKind :: Lens' UserRolePermission Text +useKind = lens _useKind (\ s a -> s{_useKind = a}) + +-- | Levels of availability for a user role permission. +useAvailability :: Lens' UserRolePermission (Maybe UserRolePermissionAvailability) +useAvailability + = lens _useAvailability + (\ s a -> s{_useAvailability = a}) + +-- | Name of this user role permission. +useName :: Lens' UserRolePermission (Maybe Text) +useName = lens _useName (\ s a -> s{_useName = a}) + +-- | ID of this user role permission. +useId :: Lens' UserRolePermission (Maybe Int64) +useId + = lens _useId (\ s a -> s{_useId = a}) . + mapping _Coerce + +-- | ID of the permission group that this user role permission belongs to. +usePermissionGroupId :: Lens' UserRolePermission (Maybe Int64) +usePermissionGroupId + = lens _usePermissionGroupId + (\ s a -> s{_usePermissionGroupId = a}) + . mapping _Coerce + +instance FromJSON UserRolePermission where + parseJSON + = withObject "UserRolePermission" + (\ o -> + UserRolePermission' <$> + (o .:? "kind" .!= "dfareporting#userRolePermission") + <*> (o .:? "availability") + <*> (o .:? "name") + <*> (o .:? "id") + <*> (o .:? "permissionGroupId")) + +instance ToJSON UserRolePermission where + toJSON UserRolePermission'{..} + = object + (catMaybes + [Just ("kind" .= _useKind), + ("availability" .=) <$> _useAvailability, + ("name" .=) <$> _useName, ("id" .=) <$> _useId, + ("permissionGroupId" .=) <$> _usePermissionGroupId]) + +-- | Contact of an order. +-- +-- /See:/ 'orderContact' smart constructor. +data OrderContact = + OrderContact' + { _ocSignatureUserProFileId :: !(Maybe (Textual Int64)) + , _ocContactName :: !(Maybe Text) + , _ocContactTitle :: !(Maybe Text) + , _ocContactType :: !(Maybe OrderContactContactType) + , _ocContactInfo :: !(Maybe Text) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'OrderContact' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'ocSignatureUserProFileId' +-- +-- * 'ocContactName' +-- +-- * 'ocContactTitle' +-- +-- * 'ocContactType' +-- +-- * 'ocContactInfo' +orderContact + :: OrderContact +orderContact = + OrderContact' + { _ocSignatureUserProFileId = Nothing + , _ocContactName = Nothing + , _ocContactTitle = Nothing + , _ocContactType = Nothing + , _ocContactInfo = Nothing + } + + +-- | ID of the user profile containing the signature that will be embedded +-- into order documents. +ocSignatureUserProFileId :: Lens' OrderContact (Maybe Int64) +ocSignatureUserProFileId + = lens _ocSignatureUserProFileId + (\ s a -> s{_ocSignatureUserProFileId = a}) + . mapping _Coerce + +-- | Name of this contact. +ocContactName :: Lens' OrderContact (Maybe Text) +ocContactName + = lens _ocContactName + (\ s a -> s{_ocContactName = a}) + +-- | Title of this contact. +ocContactTitle :: Lens' OrderContact (Maybe Text) +ocContactTitle + = lens _ocContactTitle + (\ s a -> s{_ocContactTitle = a}) + +-- | Type of this contact. +ocContactType :: Lens' OrderContact (Maybe OrderContactContactType) +ocContactType + = lens _ocContactType + (\ s a -> s{_ocContactType = a}) + +-- | Free-form information about this contact. It could be any information +-- related to this contact in addition to type, title, name, and signature +-- user profile ID. +ocContactInfo :: Lens' OrderContact (Maybe Text) +ocContactInfo + = lens _ocContactInfo + (\ s a -> s{_ocContactInfo = a}) + +instance FromJSON OrderContact where + parseJSON + = withObject "OrderContact" + (\ o -> + OrderContact' <$> + (o .:? "signatureUserProfileId") <*> + (o .:? "contactName") + <*> (o .:? "contactTitle") + <*> (o .:? "contactType") + <*> (o .:? "contactInfo")) + +instance ToJSON OrderContact where + toJSON OrderContact'{..} + = object + (catMaybes + [("signatureUserProfileId" .=) <$> + _ocSignatureUserProFileId, + ("contactName" .=) <$> _ocContactName, + ("contactTitle" .=) <$> _ocContactTitle, + ("contactType" .=) <$> _ocContactType, + ("contactInfo" .=) <$> _ocContactInfo]) + +-- | Transcode Settings +-- +-- /See:/ 'transcodeSetting' smart constructor. +data TranscodeSetting = + TranscodeSetting' + { _tsKind :: !Text + , _tsEnabledVideoFormats :: !(Maybe [Textual Int32]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'TranscodeSetting' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'tsKind' +-- +-- * 'tsEnabledVideoFormats' +transcodeSetting + :: TranscodeSetting +transcodeSetting = + TranscodeSetting' + { _tsKind = "dfareporting#transcodeSetting" + , _tsEnabledVideoFormats = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#transcodeSetting\". +tsKind :: Lens' TranscodeSetting Text +tsKind = lens _tsKind (\ s a -> s{_tsKind = a}) + +-- | Whitelist of video formats to be served to this placement. Set this list +-- to null or empty to serve all video formats. +tsEnabledVideoFormats :: Lens' TranscodeSetting [Int32] +tsEnabledVideoFormats + = lens _tsEnabledVideoFormats + (\ s a -> s{_tsEnabledVideoFormats = a}) + . _Default + . _Coerce + +instance FromJSON TranscodeSetting where + parseJSON + = withObject "TranscodeSetting" + (\ o -> + TranscodeSetting' <$> + (o .:? "kind" .!= "dfareporting#transcodeSetting") + <*> (o .:? "enabledVideoFormats" .!= mempty)) + +instance ToJSON TranscodeSetting where + toJSON TranscodeSetting'{..} + = object + (catMaybes + [Just ("kind" .= _tsKind), + ("enabledVideoFormats" .=) <$> + _tsEnabledVideoFormats]) + +-- | Floodlight Activity GenerateTag Response +-- +-- /See:/ 'floodlightActivitiesGenerateTagResponse' smart constructor. +data FloodlightActivitiesGenerateTagResponse = + FloodlightActivitiesGenerateTagResponse' + { _fagtrGlobalSiteTagGlobalSnippet :: !(Maybe Text) + , _fagtrFloodlightActivityTag :: !(Maybe Text) + , _fagtrKind :: !Text + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'FloodlightActivitiesGenerateTagResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'fagtrGlobalSiteTagGlobalSnippet' +-- +-- * 'fagtrFloodlightActivityTag' +-- +-- * 'fagtrKind' +floodlightActivitiesGenerateTagResponse + :: FloodlightActivitiesGenerateTagResponse +floodlightActivitiesGenerateTagResponse = + FloodlightActivitiesGenerateTagResponse' + { _fagtrGlobalSiteTagGlobalSnippet = Nothing + , _fagtrFloodlightActivityTag = Nothing + , _fagtrKind = "dfareporting#floodlightActivitiesGenerateTagResponse" + } + + +-- | The global snippet section of a global site tag. The global site tag +-- sets new cookies on your domain, which will store a unique identifier +-- for a user or the ad click that brought the user to your site. Learn +-- more. +fagtrGlobalSiteTagGlobalSnippet :: Lens' FloodlightActivitiesGenerateTagResponse (Maybe Text) +fagtrGlobalSiteTagGlobalSnippet + = lens _fagtrGlobalSiteTagGlobalSnippet + (\ s a -> s{_fagtrGlobalSiteTagGlobalSnippet = a}) + +-- | Generated tag for this Floodlight activity. For global site tags, this +-- is the event snippet. +fagtrFloodlightActivityTag :: Lens' FloodlightActivitiesGenerateTagResponse (Maybe Text) +fagtrFloodlightActivityTag + = lens _fagtrFloodlightActivityTag + (\ s a -> s{_fagtrFloodlightActivityTag = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#floodlightActivitiesGenerateTagResponse\". +fagtrKind :: Lens' FloodlightActivitiesGenerateTagResponse Text +fagtrKind + = lens _fagtrKind (\ s a -> s{_fagtrKind = a}) + +instance FromJSON + FloodlightActivitiesGenerateTagResponse + where + parseJSON + = withObject + "FloodlightActivitiesGenerateTagResponse" + (\ o -> + FloodlightActivitiesGenerateTagResponse' <$> + (o .:? "globalSiteTagGlobalSnippet") <*> + (o .:? "floodlightActivityTag") + <*> + (o .:? "kind" .!= + "dfareporting#floodlightActivitiesGenerateTagResponse")) + +instance ToJSON + FloodlightActivitiesGenerateTagResponse + where + toJSON FloodlightActivitiesGenerateTagResponse'{..} + = object + (catMaybes + [("globalSiteTagGlobalSnippet" .=) <$> + _fagtrGlobalSiteTagGlobalSnippet, + ("floodlightActivityTag" .=) <$> + _fagtrFloodlightActivityTag, + Just ("kind" .= _fagtrKind)]) + +-- | Ad Slot +-- +-- /See:/ 'adSlot' smart constructor. +data AdSlot = + AdSlot' + { _assHeight :: !(Maybe (Textual Int64)) + , _assPaymentSourceType :: !(Maybe AdSlotPaymentSourceType) + , _assLinkedPlacementId :: !(Maybe (Textual Int64)) + , _assWidth :: !(Maybe (Textual Int64)) + , _assPrimary :: !(Maybe Bool) + , _assName :: !(Maybe Text) + , _assComment :: !(Maybe Text) + , _assCompatibility :: !(Maybe AdSlotCompatibility) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'AdSlot' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'assHeight' +-- +-- * 'assPaymentSourceType' +-- +-- * 'assLinkedPlacementId' +-- +-- * 'assWidth' +-- +-- * 'assPrimary' +-- +-- * 'assName' +-- +-- * 'assComment' +-- +-- * 'assCompatibility' +adSlot + :: AdSlot +adSlot = + AdSlot' + { _assHeight = Nothing + , _assPaymentSourceType = Nothing + , _assLinkedPlacementId = Nothing + , _assWidth = Nothing + , _assPrimary = Nothing + , _assName = Nothing + , _assComment = Nothing + , _assCompatibility = Nothing + } + + +-- | Height of this ad slot. +assHeight :: Lens' AdSlot (Maybe Int64) +assHeight + = lens _assHeight (\ s a -> s{_assHeight = a}) . + mapping _Coerce + +-- | Payment source type of this ad slot. +assPaymentSourceType :: Lens' AdSlot (Maybe AdSlotPaymentSourceType) +assPaymentSourceType + = lens _assPaymentSourceType + (\ s a -> s{_assPaymentSourceType = a}) + +-- | ID of the placement from an external platform that is linked to this ad +-- slot. +assLinkedPlacementId :: Lens' AdSlot (Maybe Int64) +assLinkedPlacementId + = lens _assLinkedPlacementId + (\ s a -> s{_assLinkedPlacementId = a}) + . mapping _Coerce + +-- | Width of this ad slot. +assWidth :: Lens' AdSlot (Maybe Int64) +assWidth + = lens _assWidth (\ s a -> s{_assWidth = a}) . + mapping _Coerce + +-- | Primary ad slot of a roadblock inventory item. +assPrimary :: Lens' AdSlot (Maybe Bool) +assPrimary + = lens _assPrimary (\ s a -> s{_assPrimary = a}) + +-- | Name of this ad slot. +assName :: Lens' AdSlot (Maybe Text) +assName = lens _assName (\ s a -> s{_assName = a}) + +-- | Comment for this ad slot. +assComment :: Lens' AdSlot (Maybe Text) +assComment + = lens _assComment (\ s a -> s{_assComment = a}) + +-- | Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to +-- rendering either on desktop, mobile devices or in mobile apps for +-- regular or interstitial ads respectively. APP and APP_INTERSTITIAL are +-- for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in +-- in-stream video ads developed with the VAST standard. +assCompatibility :: Lens' AdSlot (Maybe AdSlotCompatibility) +assCompatibility + = lens _assCompatibility + (\ s a -> s{_assCompatibility = a}) + +instance FromJSON AdSlot where + parseJSON + = withObject "AdSlot" + (\ o -> + AdSlot' <$> + (o .:? "height") <*> (o .:? "paymentSourceType") <*> + (o .:? "linkedPlacementId") + <*> (o .:? "width") + <*> (o .:? "primary") + <*> (o .:? "name") + <*> (o .:? "comment") + <*> (o .:? "compatibility")) + +instance ToJSON AdSlot where + toJSON AdSlot'{..} + = object + (catMaybes + [("height" .=) <$> _assHeight, + ("paymentSourceType" .=) <$> _assPaymentSourceType, + ("linkedPlacementId" .=) <$> _assLinkedPlacementId, + ("width" .=) <$> _assWidth, + ("primary" .=) <$> _assPrimary, + ("name" .=) <$> _assName, + ("comment" .=) <$> _assComment, + ("compatibility" .=) <$> _assCompatibility]) + +-- | Third-party Tracking URL. +-- +-- /See:/ 'thirdPartyTrackingURL' smart constructor. +data ThirdPartyTrackingURL = + ThirdPartyTrackingURL' + { _tptuURL :: !(Maybe Text) + , _tptuThirdPartyURLType :: !(Maybe ThirdPartyTrackingURLThirdPartyURLType) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ThirdPartyTrackingURL' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'tptuURL' +-- +-- * 'tptuThirdPartyURLType' +thirdPartyTrackingURL + :: ThirdPartyTrackingURL +thirdPartyTrackingURL = + ThirdPartyTrackingURL' {_tptuURL = Nothing, _tptuThirdPartyURLType = Nothing} + + +-- | URL for the specified third-party URL type. +tptuURL :: Lens' ThirdPartyTrackingURL (Maybe Text) +tptuURL = lens _tptuURL (\ s a -> s{_tptuURL = a}) + +-- | Third-party URL type for in-stream video and in-stream audio creatives. +tptuThirdPartyURLType :: Lens' ThirdPartyTrackingURL (Maybe ThirdPartyTrackingURLThirdPartyURLType) +tptuThirdPartyURLType + = lens _tptuThirdPartyURLType + (\ s a -> s{_tptuThirdPartyURLType = a}) + +instance FromJSON ThirdPartyTrackingURL where + parseJSON + = withObject "ThirdPartyTrackingURL" + (\ o -> + ThirdPartyTrackingURL' <$> + (o .:? "url") <*> (o .:? "thirdPartyUrlType")) + +instance ToJSON ThirdPartyTrackingURL where + toJSON ThirdPartyTrackingURL'{..} + = object + (catMaybes + [("url" .=) <$> _tptuURL, + ("thirdPartyUrlType" .=) <$> _tptuThirdPartyURLType]) + +-- | Contains properties of a Planning order document. +-- +-- /See:/ 'orderDocument' smart constructor. +data OrderDocument = + OrderDocument' + { _odSigned :: !(Maybe Bool) + , _odKind :: !Text + , _odAdvertiserId :: !(Maybe (Textual Int64)) + , _odLastSentTime :: !(Maybe DateTime') + , _odAmendedOrderDocumentId :: !(Maybe (Textual Int64)) + , _odLastSentRecipients :: !(Maybe [Text]) + , _odEffectiveDate :: !(Maybe Date') + , _odApprovedByUserProFileIds :: !(Maybe [Textual Int64]) + , _odAccountId :: !(Maybe (Textual Int64)) + , _odId :: !(Maybe (Textual Int64)) + , _odProjectId :: !(Maybe (Textual Int64)) + , _odTitle :: !(Maybe Text) + , _odSubAccountId :: !(Maybe (Textual Int64)) + , _odType :: !(Maybe OrderDocumentType) + , _odOrderId :: !(Maybe (Textual Int64)) + , _odCancelled :: !(Maybe Bool) + , _odCreatedInfo :: !(Maybe LastModifiedInfo) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'OrderDocument' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'odSigned' +-- +-- * 'odKind' +-- +-- * 'odAdvertiserId' +-- +-- * 'odLastSentTime' +-- +-- * 'odAmendedOrderDocumentId' +-- +-- * 'odLastSentRecipients' +-- +-- * 'odEffectiveDate' +-- +-- * 'odApprovedByUserProFileIds' +-- +-- * 'odAccountId' +-- +-- * 'odId' +-- +-- * 'odProjectId' +-- +-- * 'odTitle' +-- +-- * 'odSubAccountId' +-- +-- * 'odType' +-- +-- * 'odOrderId' +-- +-- * 'odCancelled' +-- +-- * 'odCreatedInfo' +orderDocument + :: OrderDocument +orderDocument = + OrderDocument' + { _odSigned = Nothing + , _odKind = "dfareporting#orderDocument" + , _odAdvertiserId = Nothing + , _odLastSentTime = Nothing + , _odAmendedOrderDocumentId = Nothing + , _odLastSentRecipients = Nothing + , _odEffectiveDate = Nothing + , _odApprovedByUserProFileIds = Nothing + , _odAccountId = Nothing + , _odId = Nothing + , _odProjectId = Nothing + , _odTitle = Nothing + , _odSubAccountId = Nothing + , _odType = Nothing + , _odOrderId = Nothing + , _odCancelled = Nothing + , _odCreatedInfo = Nothing + } + + +-- | Whether this order document has been signed. +odSigned :: Lens' OrderDocument (Maybe Bool) +odSigned = lens _odSigned (\ s a -> s{_odSigned = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#orderDocument\". +odKind :: Lens' OrderDocument Text +odKind = lens _odKind (\ s a -> s{_odKind = a}) + +-- | Advertiser ID of this order document. +odAdvertiserId :: Lens' OrderDocument (Maybe Int64) +odAdvertiserId + = lens _odAdvertiserId + (\ s a -> s{_odAdvertiserId = a}) + . mapping _Coerce + +-- | Timestamp of the last email sent with this order document. +odLastSentTime :: Lens' OrderDocument (Maybe UTCTime) +odLastSentTime + = lens _odLastSentTime + (\ s a -> s{_odLastSentTime = a}) + . mapping _DateTime + +-- | The amended order document ID of this order document. An order document +-- can be created by optionally amending another order document so that the +-- change history can be preserved. +odAmendedOrderDocumentId :: Lens' OrderDocument (Maybe Int64) +odAmendedOrderDocumentId + = lens _odAmendedOrderDocumentId + (\ s a -> s{_odAmendedOrderDocumentId = a}) + . mapping _Coerce + +-- | List of email addresses that received the last sent document. +odLastSentRecipients :: Lens' OrderDocument [Text] +odLastSentRecipients + = lens _odLastSentRecipients + (\ s a -> s{_odLastSentRecipients = a}) + . _Default + . _Coerce + +-- | Effective date of this order document. +odEffectiveDate :: Lens' OrderDocument (Maybe Day) +odEffectiveDate + = lens _odEffectiveDate + (\ s a -> s{_odEffectiveDate = a}) + . mapping _Date + +-- | IDs of users who have approved this order document. +odApprovedByUserProFileIds :: Lens' OrderDocument [Int64] +odApprovedByUserProFileIds + = lens _odApprovedByUserProFileIds + (\ s a -> s{_odApprovedByUserProFileIds = a}) + . _Default + . _Coerce + +-- | Account ID of this order document. +odAccountId :: Lens' OrderDocument (Maybe Int64) +odAccountId + = lens _odAccountId (\ s a -> s{_odAccountId = a}) . + mapping _Coerce + +-- | ID of this order document. +odId :: Lens' OrderDocument (Maybe Int64) +odId + = lens _odId (\ s a -> s{_odId = a}) . + mapping _Coerce + +-- | Project ID of this order document. +odProjectId :: Lens' OrderDocument (Maybe Int64) +odProjectId + = lens _odProjectId (\ s a -> s{_odProjectId = a}) . + mapping _Coerce + +-- | Title of this order document. +odTitle :: Lens' OrderDocument (Maybe Text) +odTitle = lens _odTitle (\ s a -> s{_odTitle = a}) + +-- | Subaccount ID of this order document. +odSubAccountId :: Lens' OrderDocument (Maybe Int64) +odSubAccountId + = lens _odSubAccountId + (\ s a -> s{_odSubAccountId = a}) + . mapping _Coerce + +-- | Type of this order document +odType :: Lens' OrderDocument (Maybe OrderDocumentType) +odType = lens _odType (\ s a -> s{_odType = a}) + +-- | ID of the order from which this order document is created. +odOrderId :: Lens' OrderDocument (Maybe Int64) +odOrderId + = lens _odOrderId (\ s a -> s{_odOrderId = a}) . + mapping _Coerce + +-- | Whether this order document is cancelled. +odCancelled :: Lens' OrderDocument (Maybe Bool) +odCancelled + = lens _odCancelled (\ s a -> s{_odCancelled = a}) + +-- | Information about the creation of this order document. +odCreatedInfo :: Lens' OrderDocument (Maybe LastModifiedInfo) +odCreatedInfo + = lens _odCreatedInfo + (\ s a -> s{_odCreatedInfo = a}) + +instance FromJSON OrderDocument where + parseJSON + = withObject "OrderDocument" + (\ o -> + OrderDocument' <$> + (o .:? "signed") <*> + (o .:? "kind" .!= "dfareporting#orderDocument") + <*> (o .:? "advertiserId") + <*> (o .:? "lastSentTime") + <*> (o .:? "amendedOrderDocumentId") + <*> (o .:? "lastSentRecipients" .!= mempty) + <*> (o .:? "effectiveDate") + <*> (o .:? "approvedByUserProfileIds" .!= mempty) + <*> (o .:? "accountId") + <*> (o .:? "id") + <*> (o .:? "projectId") + <*> (o .:? "title") + <*> (o .:? "subaccountId") + <*> (o .:? "type") + <*> (o .:? "orderId") + <*> (o .:? "cancelled") + <*> (o .:? "createdInfo")) + +instance ToJSON OrderDocument where + toJSON OrderDocument'{..} + = object + (catMaybes + [("signed" .=) <$> _odSigned, + Just ("kind" .= _odKind), + ("advertiserId" .=) <$> _odAdvertiserId, + ("lastSentTime" .=) <$> _odLastSentTime, + ("amendedOrderDocumentId" .=) <$> + _odAmendedOrderDocumentId, + ("lastSentRecipients" .=) <$> _odLastSentRecipients, + ("effectiveDate" .=) <$> _odEffectiveDate, + ("approvedByUserProfileIds" .=) <$> + _odApprovedByUserProFileIds, + ("accountId" .=) <$> _odAccountId, + ("id" .=) <$> _odId, + ("projectId" .=) <$> _odProjectId, + ("title" .=) <$> _odTitle, + ("subaccountId" .=) <$> _odSubAccountId, + ("type" .=) <$> _odType, + ("orderId" .=) <$> _odOrderId, + ("cancelled" .=) <$> _odCancelled, + ("createdInfo" .=) <$> _odCreatedInfo]) + +-- | Contains information about a metro region that can be targeted by ads. +-- +-- /See:/ 'metro' smart constructor. +data Metro = + Metro' + { _metMetroCode :: !(Maybe Text) + , _metKind :: !Text + , _metName :: !(Maybe Text) + , _metCountryCode :: !(Maybe Text) + , _metDmaId :: !(Maybe (Textual Int64)) + , _metCountryDartId :: !(Maybe (Textual Int64)) + , _metDartId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'Metro' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'metMetroCode' +-- +-- * 'metKind' +-- +-- * 'metName' +-- +-- * 'metCountryCode' +-- +-- * 'metDmaId' +-- +-- * 'metCountryDartId' +-- +-- * 'metDartId' +metro + :: Metro +metro = + Metro' + { _metMetroCode = Nothing + , _metKind = "dfareporting#metro" + , _metName = Nothing + , _metCountryCode = Nothing + , _metDmaId = Nothing + , _metCountryDartId = Nothing + , _metDartId = Nothing + } + + +-- | Metro code of this metro region. This is equivalent to dma_id. +metMetroCode :: Lens' Metro (Maybe Text) +metMetroCode + = lens _metMetroCode (\ s a -> s{_metMetroCode = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#metro\". +metKind :: Lens' Metro Text +metKind = lens _metKind (\ s a -> s{_metKind = a}) + +-- | Name of this metro region. +metName :: Lens' Metro (Maybe Text) +metName = lens _metName (\ s a -> s{_metName = a}) + +-- | Country code of the country to which this metro region belongs. +metCountryCode :: Lens' Metro (Maybe Text) +metCountryCode + = lens _metCountryCode + (\ s a -> s{_metCountryCode = a}) + +-- | DMA ID of this metro region. This is the ID used for targeting and +-- generating reports, and is equivalent to metro_code. +metDmaId :: Lens' Metro (Maybe Int64) +metDmaId + = lens _metDmaId (\ s a -> s{_metDmaId = a}) . + mapping _Coerce + +-- | DART ID of the country to which this metro region belongs. +metCountryDartId :: Lens' Metro (Maybe Int64) +metCountryDartId + = lens _metCountryDartId + (\ s a -> s{_metCountryDartId = a}) + . mapping _Coerce + +-- | DART ID of this metro region. +metDartId :: Lens' Metro (Maybe Int64) +metDartId + = lens _metDartId (\ s a -> s{_metDartId = a}) . + mapping _Coerce + +instance FromJSON Metro where + parseJSON + = withObject "Metro" + (\ o -> + Metro' <$> + (o .:? "metroCode") <*> + (o .:? "kind" .!= "dfareporting#metro") + <*> (o .:? "name") + <*> (o .:? "countryCode") + <*> (o .:? "dmaId") + <*> (o .:? "countryDartId") + <*> (o .:? "dartId")) + +instance ToJSON Metro where + toJSON Metro'{..} + = object + (catMaybes + [("metroCode" .=) <$> _metMetroCode, + Just ("kind" .= _metKind), ("name" .=) <$> _metName, + ("countryCode" .=) <$> _metCountryCode, + ("dmaId" .=) <$> _metDmaId, + ("countryDartId" .=) <$> _metCountryDartId, + ("dartId" .=) <$> _metDartId]) + +-- | Contains information about a mobile app. Used as a landing page deep +-- link. +-- +-- /See:/ 'mobileApp' smart constructor. +data MobileApp = + MobileApp' + { _maKind :: !Text + , _maId :: !(Maybe Text) + , _maTitle :: !(Maybe Text) + , _maPublisherName :: !(Maybe Text) + , _maDirectory :: !(Maybe MobileAppDirectory) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'MobileApp' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'maKind' +-- +-- * 'maId' +-- +-- * 'maTitle' +-- +-- * 'maPublisherName' +-- +-- * 'maDirectory' +mobileApp + :: MobileApp +mobileApp = + MobileApp' + { _maKind = "dfareporting#mobileApp" + , _maId = Nothing + , _maTitle = Nothing + , _maPublisherName = Nothing + , _maDirectory = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#mobileApp\". +maKind :: Lens' MobileApp Text +maKind = lens _maKind (\ s a -> s{_maKind = a}) + +-- | ID of this mobile app. +maId :: Lens' MobileApp (Maybe Text) +maId = lens _maId (\ s a -> s{_maId = a}) + +-- | Title of this mobile app. +maTitle :: Lens' MobileApp (Maybe Text) +maTitle = lens _maTitle (\ s a -> s{_maTitle = a}) + +-- | Publisher name. +maPublisherName :: Lens' MobileApp (Maybe Text) +maPublisherName + = lens _maPublisherName + (\ s a -> s{_maPublisherName = a}) + +-- | Mobile app directory. +maDirectory :: Lens' MobileApp (Maybe MobileAppDirectory) +maDirectory + = lens _maDirectory (\ s a -> s{_maDirectory = a}) + +instance FromJSON MobileApp where + parseJSON + = withObject "MobileApp" + (\ o -> + MobileApp' <$> + (o .:? "kind" .!= "dfareporting#mobileApp") <*> + (o .:? "id") + <*> (o .:? "title") + <*> (o .:? "publisherName") + <*> (o .:? "directory")) + +instance ToJSON MobileApp where + toJSON MobileApp'{..} + = object + (catMaybes + [Just ("kind" .= _maKind), ("id" .=) <$> _maId, + ("title" .=) <$> _maTitle, + ("publisherName" .=) <$> _maPublisherName, + ("directory" .=) <$> _maDirectory]) + +-- | Contains properties of a placement. +-- +-- /See:/ 'placement' smart constructor. +data Placement = + Placement' + { _p1Status :: !(Maybe PlacementStatus) + , _p1VideoSettings :: !(Maybe VideoSettings) + , _p1PlacementStrategyId :: !(Maybe (Textual Int64)) + , _p1TagFormats :: !(Maybe [PlacementTagFormatsItem]) + , _p1SiteIdDimensionValue :: !(Maybe DimensionValue) + , _p1PricingSchedule :: !(Maybe PricingSchedule) + , _p1Size :: !(Maybe Size) + , _p1Kind :: !Text + , _p1KeyName :: !(Maybe Text) + , _p1CampaignIdDimensionValue :: !(Maybe DimensionValue) + , _p1AdvertiserId :: !(Maybe (Textual Int64)) + , _p1AdvertiserIdDimensionValue :: !(Maybe DimensionValue) + , _p1CampaignId :: !(Maybe (Textual Int64)) + , _p1IdDimensionValue :: !(Maybe DimensionValue) + , _p1VpaidAdapterChoice :: !(Maybe PlacementVpaidAdapterChoice) + , _p1AdBlockingOptOut :: !(Maybe Bool) + , _p1Primary :: !(Maybe Bool) + , _p1LookbackConfiguration :: !(Maybe LookbackConfiguration) + , _p1TagSetting :: !(Maybe TagSetting) + , _p1ContentCategoryId :: !(Maybe (Textual Int64)) + , _p1DirectorySiteIdDimensionValue :: !(Maybe DimensionValue) + , _p1AccountId :: !(Maybe (Textual Int64)) + , _p1PaymentSource :: !(Maybe PlacementPaymentSource) + , _p1Name :: !(Maybe Text) + , _p1AdditionalSizes :: !(Maybe [Size]) + , _p1DirectorySiteId :: !(Maybe (Textual Int64)) + , _p1CreateInfo :: !(Maybe LastModifiedInfo) + , _p1VideoActiveViewOptOut :: !(Maybe Bool) + , _p1LastModifiedInfo :: !(Maybe LastModifiedInfo) + , _p1Id :: !(Maybe (Textual Int64)) + , _p1SSLRequired :: !(Maybe Bool) + , _p1SubAccountId :: !(Maybe (Textual Int64)) + , _p1PlacementGroupIdDimensionValue :: !(Maybe DimensionValue) + , _p1ExternalId :: !(Maybe Text) + , _p1PlacementGroupId :: !(Maybe (Textual Int64)) + , _p1Comment :: !(Maybe Text) + , _p1SiteId :: !(Maybe (Textual Int64)) + , _p1Compatibility :: !(Maybe PlacementCompatibility) + , _p1Archived :: !(Maybe Bool) + , _p1PaymentApproved :: !(Maybe Bool) + , _p1PublisherUpdateInfo :: !(Maybe LastModifiedInfo) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'Placement' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'p1Status' +-- +-- * 'p1VideoSettings' +-- +-- * 'p1PlacementStrategyId' +-- +-- * 'p1TagFormats' +-- +-- * 'p1SiteIdDimensionValue' +-- +-- * 'p1PricingSchedule' +-- +-- * 'p1Size' +-- +-- * 'p1Kind' +-- +-- * 'p1KeyName' +-- +-- * 'p1CampaignIdDimensionValue' +-- +-- * 'p1AdvertiserId' +-- +-- * 'p1AdvertiserIdDimensionValue' +-- +-- * 'p1CampaignId' +-- +-- * 'p1IdDimensionValue' +-- +-- * 'p1VpaidAdapterChoice' +-- +-- * 'p1AdBlockingOptOut' +-- +-- * 'p1Primary' +-- +-- * 'p1LookbackConfiguration' +-- +-- * 'p1TagSetting' +-- +-- * 'p1ContentCategoryId' +-- +-- * 'p1DirectorySiteIdDimensionValue' +-- +-- * 'p1AccountId' +-- +-- * 'p1PaymentSource' +-- +-- * 'p1Name' +-- +-- * 'p1AdditionalSizes' +-- +-- * 'p1DirectorySiteId' +-- +-- * 'p1CreateInfo' +-- +-- * 'p1VideoActiveViewOptOut' +-- +-- * 'p1LastModifiedInfo' +-- +-- * 'p1Id' +-- +-- * 'p1SSLRequired' +-- +-- * 'p1SubAccountId' +-- +-- * 'p1PlacementGroupIdDimensionValue' +-- +-- * 'p1ExternalId' +-- +-- * 'p1PlacementGroupId' +-- +-- * 'p1Comment' +-- +-- * 'p1SiteId' +-- +-- * 'p1Compatibility' +-- +-- * 'p1Archived' +-- +-- * 'p1PaymentApproved' +-- +-- * 'p1PublisherUpdateInfo' +placement + :: Placement +placement = + Placement' + { _p1Status = Nothing + , _p1VideoSettings = Nothing + , _p1PlacementStrategyId = Nothing + , _p1TagFormats = Nothing + , _p1SiteIdDimensionValue = Nothing + , _p1PricingSchedule = Nothing + , _p1Size = Nothing + , _p1Kind = "dfareporting#placement" + , _p1KeyName = Nothing + , _p1CampaignIdDimensionValue = Nothing + , _p1AdvertiserId = Nothing + , _p1AdvertiserIdDimensionValue = Nothing + , _p1CampaignId = Nothing + , _p1IdDimensionValue = Nothing + , _p1VpaidAdapterChoice = Nothing + , _p1AdBlockingOptOut = Nothing + , _p1Primary = Nothing + , _p1LookbackConfiguration = Nothing + , _p1TagSetting = Nothing + , _p1ContentCategoryId = Nothing + , _p1DirectorySiteIdDimensionValue = Nothing + , _p1AccountId = Nothing + , _p1PaymentSource = Nothing + , _p1Name = Nothing + , _p1AdditionalSizes = Nothing + , _p1DirectorySiteId = Nothing + , _p1CreateInfo = Nothing + , _p1VideoActiveViewOptOut = Nothing + , _p1LastModifiedInfo = Nothing + , _p1Id = Nothing + , _p1SSLRequired = Nothing + , _p1SubAccountId = Nothing + , _p1PlacementGroupIdDimensionValue = Nothing + , _p1ExternalId = Nothing + , _p1PlacementGroupId = Nothing + , _p1Comment = Nothing + , _p1SiteId = Nothing + , _p1Compatibility = Nothing + , _p1Archived = Nothing + , _p1PaymentApproved = Nothing + , _p1PublisherUpdateInfo = Nothing + } + + +-- | Third-party placement status. +p1Status :: Lens' Placement (Maybe PlacementStatus) +p1Status = lens _p1Status (\ s a -> s{_p1Status = a}) + +-- | A collection of settings which affect video creatives served through +-- this placement. Applicable to placements with IN_STREAM_VIDEO +-- compatibility. +p1VideoSettings :: Lens' Placement (Maybe VideoSettings) +p1VideoSettings + = lens _p1VideoSettings + (\ s a -> s{_p1VideoSettings = a}) + +-- | ID of the placement strategy assigned to this placement. +p1PlacementStrategyId :: Lens' Placement (Maybe Int64) +p1PlacementStrategyId + = lens _p1PlacementStrategyId + (\ s a -> s{_p1PlacementStrategyId = a}) + . mapping _Coerce + +-- | Tag formats to generate for this placement. This field is required on +-- insertion. Acceptable values are: - \"PLACEMENT_TAG_STANDARD\" - +-- \"PLACEMENT_TAG_IFRAME_JAVASCRIPT\" - \"PLACEMENT_TAG_IFRAME_ILAYER\" - +-- \"PLACEMENT_TAG_INTERNAL_REDIRECT\" - \"PLACEMENT_TAG_JAVASCRIPT\" - +-- \"PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT\" - +-- \"PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT\" - +-- \"PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT\" - +-- \"PLACEMENT_TAG_CLICK_COMMANDS\" - +-- \"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH\" - +-- \"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3\" - +-- \"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4\" - +-- \"PLACEMENT_TAG_TRACKING\" - \"PLACEMENT_TAG_TRACKING_IFRAME\" - +-- \"PLACEMENT_TAG_TRACKING_JAVASCRIPT\" +p1TagFormats :: Lens' Placement [PlacementTagFormatsItem] +p1TagFormats + = lens _p1TagFormats (\ s a -> s{_p1TagFormats = a}) + . _Default + . _Coerce + +-- | Dimension value for the ID of the site. This is a read-only, +-- auto-generated field. +p1SiteIdDimensionValue :: Lens' Placement (Maybe DimensionValue) +p1SiteIdDimensionValue + = lens _p1SiteIdDimensionValue + (\ s a -> s{_p1SiteIdDimensionValue = a}) + +-- | Pricing schedule of this placement. This field is required on insertion, +-- specifically subfields startDate, endDate and pricingType. +p1PricingSchedule :: Lens' Placement (Maybe PricingSchedule) +p1PricingSchedule + = lens _p1PricingSchedule + (\ s a -> s{_p1PricingSchedule = a}) + +-- | Size associated with this placement. When inserting or updating a +-- placement, only the size ID field is used. This field is required on +-- insertion. +p1Size :: Lens' Placement (Maybe Size) +p1Size = lens _p1Size (\ s a -> s{_p1Size = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#placement\". +p1Kind :: Lens' Placement Text +p1Kind = lens _p1Kind (\ s a -> s{_p1Kind = a}) + +-- | Key name of this placement. This is a read-only, auto-generated field. +p1KeyName :: Lens' Placement (Maybe Text) +p1KeyName + = lens _p1KeyName (\ s a -> s{_p1KeyName = a}) + +-- | Dimension value for the ID of the campaign. This is a read-only, +-- auto-generated field. +p1CampaignIdDimensionValue :: Lens' Placement (Maybe DimensionValue) +p1CampaignIdDimensionValue + = lens _p1CampaignIdDimensionValue + (\ s a -> s{_p1CampaignIdDimensionValue = a}) + +-- | Advertiser ID of this placement. This field can be left blank. +p1AdvertiserId :: Lens' Placement (Maybe Int64) +p1AdvertiserId + = lens _p1AdvertiserId + (\ s a -> s{_p1AdvertiserId = a}) + . mapping _Coerce + +-- | Dimension value for the ID of the advertiser. This is a read-only, +-- auto-generated field. +p1AdvertiserIdDimensionValue :: Lens' Placement (Maybe DimensionValue) +p1AdvertiserIdDimensionValue + = lens _p1AdvertiserIdDimensionValue + (\ s a -> s{_p1AdvertiserIdDimensionValue = a}) + +-- | Campaign ID of this placement. This field is a required field on +-- insertion. +p1CampaignId :: Lens' Placement (Maybe Int64) +p1CampaignId + = lens _p1CampaignId (\ s a -> s{_p1CampaignId = a}) + . mapping _Coerce + +-- | Dimension value for the ID of this placement. This is a read-only, +-- auto-generated field. +p1IdDimensionValue :: Lens' Placement (Maybe DimensionValue) +p1IdDimensionValue + = lens _p1IdDimensionValue + (\ s a -> s{_p1IdDimensionValue = a}) + +-- | VPAID adapter setting for this placement. Controls which VPAID format +-- the measurement adapter will use for in-stream video creatives assigned +-- to this placement. Note: Flash is no longer supported. This field now +-- defaults to HTML5 when the following values are provided: FLASH, BOTH. +p1VpaidAdapterChoice :: Lens' Placement (Maybe PlacementVpaidAdapterChoice) +p1VpaidAdapterChoice + = lens _p1VpaidAdapterChoice + (\ s a -> s{_p1VpaidAdapterChoice = a}) + +-- | Whether this placement opts out of ad blocking. When true, ad blocking +-- is disabled for this placement. When false, the campaign and site +-- settings take effect. +p1AdBlockingOptOut :: Lens' Placement (Maybe Bool) +p1AdBlockingOptOut + = lens _p1AdBlockingOptOut + (\ s a -> s{_p1AdBlockingOptOut = a}) + +-- | Whether this placement is the primary placement of a roadblock +-- (placement group). You cannot change this field from true to false. +-- Setting this field to true will automatically set the primary field on +-- the original primary placement of the roadblock to false, and it will +-- automatically set the roadblock\'s primaryPlacementId field to the ID of +-- this placement. +p1Primary :: Lens' Placement (Maybe Bool) +p1Primary + = lens _p1Primary (\ s a -> s{_p1Primary = a}) + +-- | Lookback window settings for this placement. +p1LookbackConfiguration :: Lens' Placement (Maybe LookbackConfiguration) +p1LookbackConfiguration + = lens _p1LookbackConfiguration + (\ s a -> s{_p1LookbackConfiguration = a}) + +-- | Tag settings for this placement. +p1TagSetting :: Lens' Placement (Maybe TagSetting) +p1TagSetting + = lens _p1TagSetting (\ s a -> s{_p1TagSetting = a}) + +-- | ID of the content category assigned to this placement. +p1ContentCategoryId :: Lens' Placement (Maybe Int64) +p1ContentCategoryId + = lens _p1ContentCategoryId + (\ s a -> s{_p1ContentCategoryId = a}) + . mapping _Coerce + +-- | Dimension value for the ID of the directory site. This is a read-only, +-- auto-generated field. +p1DirectorySiteIdDimensionValue :: Lens' Placement (Maybe DimensionValue) +p1DirectorySiteIdDimensionValue + = lens _p1DirectorySiteIdDimensionValue + (\ s a -> s{_p1DirectorySiteIdDimensionValue = a}) + +-- | Account ID of this placement. This field can be left blank. +p1AccountId :: Lens' Placement (Maybe Int64) +p1AccountId + = lens _p1AccountId (\ s a -> s{_p1AccountId = a}) . + mapping _Coerce + +-- | Payment source for this placement. This is a required field that is +-- read-only after insertion. +p1PaymentSource :: Lens' Placement (Maybe PlacementPaymentSource) +p1PaymentSource + = lens _p1PaymentSource + (\ s a -> s{_p1PaymentSource = a}) + +-- | Name of this placement.This is a required field and must be less than +-- 256 characters long. +p1Name :: Lens' Placement (Maybe Text) +p1Name = lens _p1Name (\ s a -> s{_p1Name = a}) + +-- | Additional sizes associated with this placement. When inserting or +-- updating a placement, only the size ID field is used. +p1AdditionalSizes :: Lens' Placement [Size] +p1AdditionalSizes + = lens _p1AdditionalSizes + (\ s a -> s{_p1AdditionalSizes = a}) + . _Default + . _Coerce + +-- | Directory site ID of this placement. On insert, you must set either this +-- field or the siteId field to specify the site associated with this +-- placement. This is a required field that is read-only after insertion. +p1DirectorySiteId :: Lens' Placement (Maybe Int64) +p1DirectorySiteId + = lens _p1DirectorySiteId + (\ s a -> s{_p1DirectorySiteId = a}) + . mapping _Coerce + +-- | Information about the creation of this placement. This is a read-only +-- field. +p1CreateInfo :: Lens' Placement (Maybe LastModifiedInfo) +p1CreateInfo + = lens _p1CreateInfo (\ s a -> s{_p1CreateInfo = a}) + +-- | Whether Verification and ActiveView are disabled for in-stream video +-- creatives for this placement. The same setting videoActiveViewOptOut +-- exists on the site level -- the opt out occurs if either of these +-- settings are true. These settings are distinct from +-- DirectorySites.settings.activeViewOptOut or +-- Sites.siteSettings.activeViewOptOut which only apply to display ads. +-- However, Accounts.activeViewOptOut opts out both video traffic, as well +-- as display ads, from Verification and ActiveView. +p1VideoActiveViewOptOut :: Lens' Placement (Maybe Bool) +p1VideoActiveViewOptOut + = lens _p1VideoActiveViewOptOut + (\ s a -> s{_p1VideoActiveViewOptOut = a}) + +-- | Information about the most recent modification of this placement. This +-- is a read-only field. +p1LastModifiedInfo :: Lens' Placement (Maybe LastModifiedInfo) +p1LastModifiedInfo + = lens _p1LastModifiedInfo + (\ s a -> s{_p1LastModifiedInfo = a}) + +-- | ID of this placement. This is a read-only, auto-generated field. +p1Id :: Lens' Placement (Maybe Int64) +p1Id + = lens _p1Id (\ s a -> s{_p1Id = a}) . + mapping _Coerce + +-- | Whether creatives assigned to this placement must be SSL-compliant. +p1SSLRequired :: Lens' Placement (Maybe Bool) +p1SSLRequired + = lens _p1SSLRequired + (\ s a -> s{_p1SSLRequired = a}) + +-- | Subaccount ID of this placement. This field can be left blank. +p1SubAccountId :: Lens' Placement (Maybe Int64) +p1SubAccountId + = lens _p1SubAccountId + (\ s a -> s{_p1SubAccountId = a}) + . mapping _Coerce + +-- | Dimension value for the ID of the placement group. This is a read-only, +-- auto-generated field. +p1PlacementGroupIdDimensionValue :: Lens' Placement (Maybe DimensionValue) +p1PlacementGroupIdDimensionValue + = lens _p1PlacementGroupIdDimensionValue + (\ s a -> s{_p1PlacementGroupIdDimensionValue = a}) + +-- | External ID for this placement. +p1ExternalId :: Lens' Placement (Maybe Text) +p1ExternalId + = lens _p1ExternalId (\ s a -> s{_p1ExternalId = a}) + +-- | ID of this placement\'s group, if applicable. +p1PlacementGroupId :: Lens' Placement (Maybe Int64) +p1PlacementGroupId + = lens _p1PlacementGroupId + (\ s a -> s{_p1PlacementGroupId = a}) + . mapping _Coerce + +-- | Comments for this placement. +p1Comment :: Lens' Placement (Maybe Text) +p1Comment + = lens _p1Comment (\ s a -> s{_p1Comment = a}) + +-- | Site ID associated with this placement. On insert, you must set either +-- this field or the directorySiteId field to specify the site associated +-- with this placement. This is a required field that is read-only after +-- insertion. +p1SiteId :: Lens' Placement (Maybe Int64) +p1SiteId + = lens _p1SiteId (\ s a -> s{_p1SiteId = a}) . + mapping _Coerce + +-- | Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to +-- rendering on desktop, on mobile devices or in mobile apps for regular or +-- interstitial ads respectively. APP and APP_INTERSTITIAL are no longer +-- allowed for new placement insertions. Instead, use DISPLAY or +-- DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream +-- video ads developed with the VAST standard. This field is required on +-- insertion. +p1Compatibility :: Lens' Placement (Maybe PlacementCompatibility) +p1Compatibility + = lens _p1Compatibility + (\ s a -> s{_p1Compatibility = a}) + +-- | Whether this placement is archived. +p1Archived :: Lens' Placement (Maybe Bool) +p1Archived + = lens _p1Archived (\ s a -> s{_p1Archived = a}) + +-- | Whether payment was approved for this placement. This is a read-only +-- field relevant only to publisher-paid placements. +p1PaymentApproved :: Lens' Placement (Maybe Bool) +p1PaymentApproved + = lens _p1PaymentApproved + (\ s a -> s{_p1PaymentApproved = a}) + +-- | Information about the last publisher update. This is a read-only field. +p1PublisherUpdateInfo :: Lens' Placement (Maybe LastModifiedInfo) +p1PublisherUpdateInfo + = lens _p1PublisherUpdateInfo + (\ s a -> s{_p1PublisherUpdateInfo = a}) + +instance FromJSON Placement where + parseJSON + = withObject "Placement" + (\ o -> + Placement' <$> + (o .:? "status") <*> (o .:? "videoSettings") <*> + (o .:? "placementStrategyId") + <*> (o .:? "tagFormats" .!= mempty) + <*> (o .:? "siteIdDimensionValue") + <*> (o .:? "pricingSchedule") + <*> (o .:? "size") + <*> (o .:? "kind" .!= "dfareporting#placement") + <*> (o .:? "keyName") + <*> (o .:? "campaignIdDimensionValue") + <*> (o .:? "advertiserId") + <*> (o .:? "advertiserIdDimensionValue") + <*> (o .:? "campaignId") + <*> (o .:? "idDimensionValue") + <*> (o .:? "vpaidAdapterChoice") + <*> (o .:? "adBlockingOptOut") + <*> (o .:? "primary") + <*> (o .:? "lookbackConfiguration") + <*> (o .:? "tagSetting") + <*> (o .:? "contentCategoryId") + <*> (o .:? "directorySiteIdDimensionValue") + <*> (o .:? "accountId") + <*> (o .:? "paymentSource") + <*> (o .:? "name") + <*> (o .:? "additionalSizes" .!= mempty) + <*> (o .:? "directorySiteId") + <*> (o .:? "createInfo") + <*> (o .:? "videoActiveViewOptOut") + <*> (o .:? "lastModifiedInfo") + <*> (o .:? "id") + <*> (o .:? "sslRequired") + <*> (o .:? "subaccountId") + <*> (o .:? "placementGroupIdDimensionValue") + <*> (o .:? "externalId") + <*> (o .:? "placementGroupId") + <*> (o .:? "comment") + <*> (o .:? "siteId") + <*> (o .:? "compatibility") + <*> (o .:? "archived") + <*> (o .:? "paymentApproved") + <*> (o .:? "publisherUpdateInfo")) + +instance ToJSON Placement where + toJSON Placement'{..} + = object + (catMaybes + [("status" .=) <$> _p1Status, + ("videoSettings" .=) <$> _p1VideoSettings, + ("placementStrategyId" .=) <$> + _p1PlacementStrategyId, + ("tagFormats" .=) <$> _p1TagFormats, + ("siteIdDimensionValue" .=) <$> + _p1SiteIdDimensionValue, + ("pricingSchedule" .=) <$> _p1PricingSchedule, + ("size" .=) <$> _p1Size, Just ("kind" .= _p1Kind), + ("keyName" .=) <$> _p1KeyName, + ("campaignIdDimensionValue" .=) <$> + _p1CampaignIdDimensionValue, + ("advertiserId" .=) <$> _p1AdvertiserId, + ("advertiserIdDimensionValue" .=) <$> + _p1AdvertiserIdDimensionValue, + ("campaignId" .=) <$> _p1CampaignId, + ("idDimensionValue" .=) <$> _p1IdDimensionValue, + ("vpaidAdapterChoice" .=) <$> _p1VpaidAdapterChoice, + ("adBlockingOptOut" .=) <$> _p1AdBlockingOptOut, + ("primary" .=) <$> _p1Primary, + ("lookbackConfiguration" .=) <$> + _p1LookbackConfiguration, + ("tagSetting" .=) <$> _p1TagSetting, + ("contentCategoryId" .=) <$> _p1ContentCategoryId, + ("directorySiteIdDimensionValue" .=) <$> + _p1DirectorySiteIdDimensionValue, + ("accountId" .=) <$> _p1AccountId, + ("paymentSource" .=) <$> _p1PaymentSource, + ("name" .=) <$> _p1Name, + ("additionalSizes" .=) <$> _p1AdditionalSizes, + ("directorySiteId" .=) <$> _p1DirectorySiteId, + ("createInfo" .=) <$> _p1CreateInfo, + ("videoActiveViewOptOut" .=) <$> + _p1VideoActiveViewOptOut, + ("lastModifiedInfo" .=) <$> _p1LastModifiedInfo, + ("id" .=) <$> _p1Id, + ("sslRequired" .=) <$> _p1SSLRequired, + ("subaccountId" .=) <$> _p1SubAccountId, + ("placementGroupIdDimensionValue" .=) <$> + _p1PlacementGroupIdDimensionValue, + ("externalId" .=) <$> _p1ExternalId, + ("placementGroupId" .=) <$> _p1PlacementGroupId, + ("comment" .=) <$> _p1Comment, + ("siteId" .=) <$> _p1SiteId, + ("compatibility" .=) <$> _p1Compatibility, + ("archived" .=) <$> _p1Archived, + ("paymentApproved" .=) <$> _p1PaymentApproved, + ("publisherUpdateInfo" .=) <$> + _p1PublisherUpdateInfo]) + +-- | A description of how user IDs are encrypted. +-- +-- /See:/ 'encryptionInfo' smart constructor. +data EncryptionInfo = + EncryptionInfo' + { _eiEncryptionSource :: !(Maybe EncryptionInfoEncryptionSource) + , _eiKind :: !Text + , _eiEncryptionEntityType :: !(Maybe EncryptionInfoEncryptionEntityType) + , _eiEncryptionEntityId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'EncryptionInfo' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'eiEncryptionSource' +-- +-- * 'eiKind' +-- +-- * 'eiEncryptionEntityType' +-- +-- * 'eiEncryptionEntityId' +encryptionInfo + :: EncryptionInfo +encryptionInfo = + EncryptionInfo' + { _eiEncryptionSource = Nothing + , _eiKind = "dfareporting#encryptionInfo" + , _eiEncryptionEntityType = Nothing + , _eiEncryptionEntityId = Nothing + } + + +-- | Describes whether the encrypted cookie was received from ad serving (the +-- %m macro) or from Data Transfer. +eiEncryptionSource :: Lens' EncryptionInfo (Maybe EncryptionInfoEncryptionSource) +eiEncryptionSource + = lens _eiEncryptionSource + (\ s a -> s{_eiEncryptionSource = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#encryptionInfo\". +eiKind :: Lens' EncryptionInfo Text +eiKind = lens _eiKind (\ s a -> s{_eiKind = a}) + +-- | The encryption entity type. This should match the encryption +-- configuration for ad serving or Data Transfer. +eiEncryptionEntityType :: Lens' EncryptionInfo (Maybe EncryptionInfoEncryptionEntityType) +eiEncryptionEntityType + = lens _eiEncryptionEntityType + (\ s a -> s{_eiEncryptionEntityType = a}) + +-- | The encryption entity ID. This should match the encryption configuration +-- for ad serving or Data Transfer. +eiEncryptionEntityId :: Lens' EncryptionInfo (Maybe Int64) +eiEncryptionEntityId + = lens _eiEncryptionEntityId + (\ s a -> s{_eiEncryptionEntityId = a}) + . mapping _Coerce + +instance FromJSON EncryptionInfo where + parseJSON + = withObject "EncryptionInfo" + (\ o -> + EncryptionInfo' <$> + (o .:? "encryptionSource") <*> + (o .:? "kind" .!= "dfareporting#encryptionInfo") + <*> (o .:? "encryptionEntityType") + <*> (o .:? "encryptionEntityId")) + +instance ToJSON EncryptionInfo where + toJSON EncryptionInfo'{..} + = object + (catMaybes + [("encryptionSource" .=) <$> _eiEncryptionSource, + Just ("kind" .= _eiKind), + ("encryptionEntityType" .=) <$> + _eiEncryptionEntityType, + ("encryptionEntityId" .=) <$> _eiEncryptionEntityId]) + +-- | Site List Response +-- +-- /See:/ 'sitesListResponse' smart constructor. +data SitesListResponse = + SitesListResponse' + { _sitNextPageToken :: !(Maybe Text) + , _sitKind :: !Text + , _sitSites :: !(Maybe [Site]) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'SitesListResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'sitNextPageToken' +-- +-- * 'sitKind' +-- +-- * 'sitSites' +sitesListResponse + :: SitesListResponse +sitesListResponse = + SitesListResponse' + { _sitNextPageToken = Nothing + , _sitKind = "dfareporting#sitesListResponse" + , _sitSites = Nothing + } + + +-- | Pagination token to be used for the next list operation. +sitNextPageToken :: Lens' SitesListResponse (Maybe Text) +sitNextPageToken + = lens _sitNextPageToken + (\ s a -> s{_sitNextPageToken = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#sitesListResponse\". +sitKind :: Lens' SitesListResponse Text +sitKind = lens _sitKind (\ s a -> s{_sitKind = a}) + +-- | Site collection. +sitSites :: Lens' SitesListResponse [Site] +sitSites + = lens _sitSites (\ s a -> s{_sitSites = a}) . + _Default + . _Coerce + +instance FromJSON SitesListResponse where + parseJSON + = withObject "SitesListResponse" + (\ o -> + SitesListResponse' <$> + (o .:? "nextPageToken") <*> + (o .:? "kind" .!= "dfareporting#sitesListResponse") + <*> (o .:? "sites" .!= mempty)) + +instance ToJSON SitesListResponse where + toJSON SitesListResponse'{..} + = object + (catMaybes + [("nextPageToken" .=) <$> _sitNextPageToken, + Just ("kind" .= _sitKind), + ("sites" .=) <$> _sitSites]) + +-- | Contains properties of a targeting template. A targeting template +-- encapsulates targeting information which can be reused across multiple +-- ads. +-- +-- /See:/ 'targetingTemplate' smart constructor. +data TargetingTemplate = + TargetingTemplate' + { _ttGeoTargeting :: !(Maybe GeoTargeting) + , _ttTechnologyTargeting :: !(Maybe TechnologyTargeting) + , _ttDayPartTargeting :: !(Maybe DayPartTargeting) + , _ttKind :: !Text + , _ttAdvertiserId :: !(Maybe (Textual Int64)) + , _ttAdvertiserIdDimensionValue :: !(Maybe DimensionValue) + , _ttAccountId :: !(Maybe (Textual Int64)) + , _ttName :: !(Maybe Text) + , _ttKeyValueTargetingExpression :: !(Maybe KeyValueTargetingExpression) + , _ttId :: !(Maybe (Textual Int64)) + , _ttSubAccountId :: !(Maybe (Textual Int64)) + , _ttLanguageTargeting :: !(Maybe LanguageTargeting) + , _ttListTargetingExpression :: !(Maybe ListTargetingExpression) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'TargetingTemplate' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'ttGeoTargeting' +-- +-- * 'ttTechnologyTargeting' +-- +-- * 'ttDayPartTargeting' +-- +-- * 'ttKind' +-- +-- * 'ttAdvertiserId' +-- +-- * 'ttAdvertiserIdDimensionValue' +-- +-- * 'ttAccountId' +-- +-- * 'ttName' +-- +-- * 'ttKeyValueTargetingExpression' +-- +-- * 'ttId' +-- +-- * 'ttSubAccountId' +-- +-- * 'ttLanguageTargeting' +-- +-- * 'ttListTargetingExpression' +targetingTemplate + :: TargetingTemplate +targetingTemplate = + TargetingTemplate' + { _ttGeoTargeting = Nothing + , _ttTechnologyTargeting = Nothing + , _ttDayPartTargeting = Nothing + , _ttKind = "dfareporting#targetingTemplate" + , _ttAdvertiserId = Nothing + , _ttAdvertiserIdDimensionValue = Nothing + , _ttAccountId = Nothing + , _ttName = Nothing + , _ttKeyValueTargetingExpression = Nothing + , _ttId = Nothing + , _ttSubAccountId = Nothing + , _ttLanguageTargeting = Nothing + , _ttListTargetingExpression = Nothing + } + + +-- | Geographical targeting criteria. +ttGeoTargeting :: Lens' TargetingTemplate (Maybe GeoTargeting) +ttGeoTargeting + = lens _ttGeoTargeting + (\ s a -> s{_ttGeoTargeting = a}) + +-- | Technology platform targeting criteria. +ttTechnologyTargeting :: Lens' TargetingTemplate (Maybe TechnologyTargeting) +ttTechnologyTargeting + = lens _ttTechnologyTargeting + (\ s a -> s{_ttTechnologyTargeting = a}) + +-- | Time and day targeting criteria. +ttDayPartTargeting :: Lens' TargetingTemplate (Maybe DayPartTargeting) +ttDayPartTargeting + = lens _ttDayPartTargeting + (\ s a -> s{_ttDayPartTargeting = a}) + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#targetingTemplate\". +ttKind :: Lens' TargetingTemplate Text +ttKind = lens _ttKind (\ s a -> s{_ttKind = a}) + +-- | Advertiser ID of this targeting template. This is a required field on +-- insert and is read-only after insert. +ttAdvertiserId :: Lens' TargetingTemplate (Maybe Int64) +ttAdvertiserId + = lens _ttAdvertiserId + (\ s a -> s{_ttAdvertiserId = a}) + . mapping _Coerce + +-- | Dimension value for the ID of the advertiser. This is a read-only, +-- auto-generated field. +ttAdvertiserIdDimensionValue :: Lens' TargetingTemplate (Maybe DimensionValue) +ttAdvertiserIdDimensionValue + = lens _ttAdvertiserIdDimensionValue + (\ s a -> s{_ttAdvertiserIdDimensionValue = a}) + +-- | Account ID of this targeting template. This field, if left unset, will +-- be auto-generated on insert and is read-only after insert. +ttAccountId :: Lens' TargetingTemplate (Maybe Int64) +ttAccountId + = lens _ttAccountId (\ s a -> s{_ttAccountId = a}) . + mapping _Coerce + +-- | Name of this targeting template. This field is required. It must be less +-- than 256 characters long and unique within an advertiser. +ttName :: Lens' TargetingTemplate (Maybe Text) +ttName = lens _ttName (\ s a -> s{_ttName = a}) + +-- | Key-value targeting criteria. +ttKeyValueTargetingExpression :: Lens' TargetingTemplate (Maybe KeyValueTargetingExpression) +ttKeyValueTargetingExpression + = lens _ttKeyValueTargetingExpression + (\ s a -> s{_ttKeyValueTargetingExpression = a}) + +-- | ID of this targeting template. This is a read-only, auto-generated +-- field. +ttId :: Lens' TargetingTemplate (Maybe Int64) +ttId + = lens _ttId (\ s a -> s{_ttId = a}) . + mapping _Coerce + +-- | Subaccount ID of this targeting template. This field, if left unset, +-- will be auto-generated on insert and is read-only after insert. +ttSubAccountId :: Lens' TargetingTemplate (Maybe Int64) +ttSubAccountId + = lens _ttSubAccountId + (\ s a -> s{_ttSubAccountId = a}) + . mapping _Coerce + +-- | Language targeting criteria. +ttLanguageTargeting :: Lens' TargetingTemplate (Maybe LanguageTargeting) +ttLanguageTargeting + = lens _ttLanguageTargeting + (\ s a -> s{_ttLanguageTargeting = a}) + +-- | Remarketing list targeting criteria. +ttListTargetingExpression :: Lens' TargetingTemplate (Maybe ListTargetingExpression) +ttListTargetingExpression + = lens _ttListTargetingExpression + (\ s a -> s{_ttListTargetingExpression = a}) + +instance FromJSON TargetingTemplate where + parseJSON + = withObject "TargetingTemplate" + (\ o -> + TargetingTemplate' <$> + (o .:? "geoTargeting") <*> + (o .:? "technologyTargeting") + <*> (o .:? "dayPartTargeting") + <*> + (o .:? "kind" .!= "dfareporting#targetingTemplate") + <*> (o .:? "advertiserId") + <*> (o .:? "advertiserIdDimensionValue") + <*> (o .:? "accountId") + <*> (o .:? "name") + <*> (o .:? "keyValueTargetingExpression") + <*> (o .:? "id") + <*> (o .:? "subaccountId") + <*> (o .:? "languageTargeting") + <*> (o .:? "listTargetingExpression")) + +instance ToJSON TargetingTemplate where + toJSON TargetingTemplate'{..} + = object + (catMaybes + [("geoTargeting" .=) <$> _ttGeoTargeting, + ("technologyTargeting" .=) <$> + _ttTechnologyTargeting, + ("dayPartTargeting" .=) <$> _ttDayPartTargeting, + Just ("kind" .= _ttKind), + ("advertiserId" .=) <$> _ttAdvertiserId, + ("advertiserIdDimensionValue" .=) <$> + _ttAdvertiserIdDimensionValue, + ("accountId" .=) <$> _ttAccountId, + ("name" .=) <$> _ttName, + ("keyValueTargetingExpression" .=) <$> + _ttKeyValueTargetingExpression, + ("id" .=) <$> _ttId, + ("subaccountId" .=) <$> _ttSubAccountId, + ("languageTargeting" .=) <$> _ttLanguageTargeting, + ("listTargetingExpression" .=) <$> + _ttListTargetingExpression]) + +-- | Contains properties of a creative field. +-- +-- /See:/ 'creativeField' smart constructor. +data CreativeField = + CreativeField' + { _cffKind :: !Text + , _cffAdvertiserId :: !(Maybe (Textual Int64)) + , _cffAdvertiserIdDimensionValue :: !(Maybe DimensionValue) + , _cffAccountId :: !(Maybe (Textual Int64)) + , _cffName :: !(Maybe Text) + , _cffId :: !(Maybe (Textual Int64)) + , _cffSubAccountId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'CreativeField' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'cffKind' +-- +-- * 'cffAdvertiserId' +-- +-- * 'cffAdvertiserIdDimensionValue' +-- +-- * 'cffAccountId' +-- +-- * 'cffName' +-- +-- * 'cffId' +-- +-- * 'cffSubAccountId' +creativeField + :: CreativeField +creativeField = + CreativeField' + { _cffKind = "dfareporting#creativeField" + , _cffAdvertiserId = Nothing + , _cffAdvertiserIdDimensionValue = Nothing + , _cffAccountId = Nothing + , _cffName = Nothing + , _cffId = Nothing + , _cffSubAccountId = Nothing + } + + +-- | Identifies what kind of resource this is. Value: the fixed string +-- \"dfareporting#creativeField\". +cffKind :: Lens' CreativeField Text +cffKind = lens _cffKind (\ s a -> s{_cffKind = a}) + +-- | Advertiser ID of this creative field. This is a required field on +-- insertion. +cffAdvertiserId :: Lens' CreativeField (Maybe Int64) +cffAdvertiserId + = lens _cffAdvertiserId + (\ s a -> s{_cffAdvertiserId = a}) + . mapping _Coerce + +-- | Dimension value for the ID of the advertiser. This is a read-only, +-- auto-generated field. +cffAdvertiserIdDimensionValue :: Lens' CreativeField (Maybe DimensionValue) +cffAdvertiserIdDimensionValue + = lens _cffAdvertiserIdDimensionValue + (\ s a -> s{_cffAdvertiserIdDimensionValue = a}) + +-- | Account ID of this creative field. This is a read-only field that can be +-- left blank. +cffAccountId :: Lens' CreativeField (Maybe Int64) +cffAccountId + = lens _cffAccountId (\ s a -> s{_cffAccountId = a}) + . mapping _Coerce + +-- | Name of this creative field. This is a required field and must be less +-- than 256 characters long and unique among creative fields of the same +-- advertiser. +cffName :: Lens' CreativeField (Maybe Text) +cffName = lens _cffName (\ s a -> s{_cffName = a}) + +-- | ID of this creative field. This is a read-only, auto-generated field. +cffId :: Lens' CreativeField (Maybe Int64) +cffId + = lens _cffId (\ s a -> s{_cffId = a}) . + mapping _Coerce + +-- | Subaccount ID of this creative field. This is a read-only field that can +-- be left blank. +cffSubAccountId :: Lens' CreativeField (Maybe Int64) +cffSubAccountId + = lens _cffSubAccountId + (\ s a -> s{_cffSubAccountId = a}) + . mapping _Coerce + +instance FromJSON CreativeField where + parseJSON + = withObject "CreativeField" + (\ o -> + CreativeField' <$> + (o .:? "kind" .!= "dfareporting#creativeField") <*> + (o .:? "advertiserId") + <*> (o .:? "advertiserIdDimensionValue") + <*> (o .:? "accountId") + <*> (o .:? "name") + <*> (o .:? "id") + <*> (o .:? "subaccountId")) + +instance ToJSON CreativeField where + toJSON CreativeField'{..} + = object + (catMaybes + [Just ("kind" .= _cffKind), + ("advertiserId" .=) <$> _cffAdvertiserId, + ("advertiserIdDimensionValue" .=) <$> + _cffAdvertiserIdDimensionValue, + ("accountId" .=) <$> _cffAccountId, + ("name" .=) <$> _cffName, ("id" .=) <$> _cffId, + ("subaccountId" .=) <$> _cffSubAccountId]) + +-- | Properties of inheriting and overriding the default click-through event +-- tag. A campaign may override the event tag defined at the advertiser +-- level, and an ad may also override the campaign\'s setting further. +-- +-- /See:/ 'defaultClickThroughEventTagProperties' smart constructor. +data DefaultClickThroughEventTagProperties = + DefaultClickThroughEventTagProperties' + { _dctetpOverrideInheritedEventTag :: !(Maybe Bool) + , _dctetpDefaultClickThroughEventTagId :: !(Maybe (Textual Int64)) + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'DefaultClickThroughEventTagProperties' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'dctetpOverrideInheritedEventTag' +-- +-- * 'dctetpDefaultClickThroughEventTagId' +defaultClickThroughEventTagProperties + :: DefaultClickThroughEventTagProperties +defaultClickThroughEventTagProperties = + DefaultClickThroughEventTagProperties' + { _dctetpOverrideInheritedEventTag = Nothing + , _dctetpDefaultClickThroughEventTagId = Nothing + } + + +-- | Whether this entity should override the inherited default click-through +-- event tag with its own defined value. +dctetpOverrideInheritedEventTag :: Lens' DefaultClickThroughEventTagProperties (Maybe Bool) +dctetpOverrideInheritedEventTag + = lens _dctetpOverrideInheritedEventTag + (\ s a -> s{_dctetpOverrideInheritedEventTag = a}) + +-- | ID of the click-through event tag to apply to all ads in this entity\'s +-- scope. +dctetpDefaultClickThroughEventTagId :: Lens' DefaultClickThroughEventTagProperties (Maybe Int64) +dctetpDefaultClickThroughEventTagId + = lens _dctetpDefaultClickThroughEventTagId + (\ s a -> + s{_dctetpDefaultClickThroughEventTagId = a}) + . mapping _Coerce + +instance FromJSON + DefaultClickThroughEventTagProperties + where + parseJSON + = withObject "DefaultClickThroughEventTagProperties" + (\ o -> + DefaultClickThroughEventTagProperties' <$> + (o .:? "overrideInheritedEventTag") <*> + (o .:? "defaultClickThroughEventTagId")) + +instance ToJSON DefaultClickThroughEventTagProperties + where + toJSON DefaultClickThroughEventTagProperties'{..} + = object + (catMaybes + [("overrideInheritedEventTag" .=) <$> + _dctetpOverrideInheritedEventTag, + ("defaultClickThroughEventTagId" .=) <$> + _dctetpDefaultClickThroughEventTagId]) + +-- | Remarketing List Targeting Expression. +-- +-- /See:/ 'listTargetingExpression' smart constructor. +newtype ListTargetingExpression = + ListTargetingExpression' + { _lteExpression :: Maybe Text + } + deriving (Eq, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'ListTargetingExpression' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'lteExpression' +listTargetingExpression + :: ListTargetingExpression +listTargetingExpression = ListTargetingExpression' {_lteExpression = Nothing} + -- | Expression describing which lists are being targeted by the ad. lteExpression :: Lens' ListTargetingExpression (Maybe Text) diff --git a/gen/Network/Google/DFAReporting/Types/Sum.hs b/gen/Network/Google/DFAReporting/Types/Sum.hs --- a/gen/Network/Google/DFAReporting/Types/Sum.hs +++ b/gen/Network/Google/DFAReporting/Types/Sum.hs @@ -730,35 +730,6 @@ instance ToJSON PlacementVpaidAdapterChoice where toJSON = toJSONText --- | Visibility of this directory site contact assignment. When set to PUBLIC --- this contact assignment is visible to all account and agency users; when --- set to PRIVATE it is visible only to the site. -data DirectorySiteContactAssignmentVisibility - = Private - -- ^ @PRIVATE@ - | Public - -- ^ @PUBLIC@ - deriving (Eq, Ord, Enum, Read, Show, Data, Typeable, Generic) - -instance Hashable DirectorySiteContactAssignmentVisibility - -instance FromHttpApiData DirectorySiteContactAssignmentVisibility where - parseQueryParam = \case - "PRIVATE" -> Right Private - "PUBLIC" -> Right Public - x -> Left ("Unable to parse DirectorySiteContactAssignmentVisibility from: " <> x) - -instance ToHttpApiData DirectorySiteContactAssignmentVisibility where - toQueryParam = \case - Private -> "PRIVATE" - Public -> "PUBLIC" - -instance FromJSON DirectorySiteContactAssignmentVisibility where - parseJSON = parseJSONText "DirectorySiteContactAssignmentVisibility" - -instance ToJSON DirectorySiteContactAssignmentVisibility where - toJSON = toJSONText - -- | Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to -- rendering on desktop, on mobile devices or in mobile apps for regular or -- interstitial ads respectively. APP and APP_INTERSTITIAL are no longer @@ -3975,37 +3946,6 @@ instance ToJSON PopupWindowPropertiesPositionType where toJSON = toJSONText --- | Directory site contact role. -data DirectorySiteContactRole - = Admin - -- ^ @ADMIN@ - | Edit - -- ^ @EDIT@ - | View - -- ^ @VIEW@ - deriving (Eq, Ord, Enum, Read, Show, Data, Typeable, Generic) - -instance Hashable DirectorySiteContactRole - -instance FromHttpApiData DirectorySiteContactRole where - parseQueryParam = \case - "ADMIN" -> Right Admin - "EDIT" -> Right Edit - "VIEW" -> Right View - x -> Left ("Unable to parse DirectorySiteContactRole from: " <> x) - -instance ToHttpApiData DirectorySiteContactRole where - toQueryParam = \case - Admin -> "ADMIN" - Edit -> "EDIT" - View -> "VIEW" - -instance FromJSON DirectorySiteContactRole where - parseJSON = parseJSONText "DirectorySiteContactRole" - -instance ToJSON DirectorySiteContactRole where - toJSON = toJSONText - -- | Option specifying how keywords are embedded in ad tags. This setting can -- be used to specify whether keyword placeholders are inserted in -- placement tags for this site. Publishers can then add keywords to those @@ -5726,33 +5666,6 @@ instance ToJSON FloodlightActivityFloodlightActivityGroupType where toJSON = toJSONText --- | Order of sorted results. -data DirectorySiteContactsListSortOrder - = DSCLSOAscending - -- ^ @ASCENDING@ - | DSCLSODescending - -- ^ @DESCENDING@ - deriving (Eq, Ord, Enum, Read, Show, Data, Typeable, Generic) - -instance Hashable DirectorySiteContactsListSortOrder - -instance FromHttpApiData DirectorySiteContactsListSortOrder where - parseQueryParam = \case - "ASCENDING" -> Right DSCLSOAscending - "DESCENDING" -> Right DSCLSODescending - x -> Left ("Unable to parse DirectorySiteContactsListSortOrder from: " <> x) - -instance ToHttpApiData DirectorySiteContactsListSortOrder where - toQueryParam = \case - DSCLSOAscending -> "ASCENDING" - DSCLSODescending -> "DESCENDING" - -instance FromJSON DirectorySiteContactsListSortOrder where - parseJSON = parseJSONText "DirectorySiteContactsListSortOrder" - -instance ToJSON DirectorySiteContactsListSortOrder where - toJSON = toJSONText - -- | Group type of this inventory item if it represents a placement group. Is -- null otherwise. There are two type of placement groups: -- PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory @@ -6265,41 +6178,6 @@ instance ToJSON FloodlightActivityGroupType where toJSON = toJSONText --- | Directory site contact type. -data DirectorySiteContactType - = DSCTBilling - -- ^ @BILLING@ - | DSCTOther - -- ^ @OTHER@ - | DSCTSales - -- ^ @SALES@ - | DSCTTechnical - -- ^ @TECHNICAL@ - deriving (Eq, Ord, Enum, Read, Show, Data, Typeable, Generic) - -instance Hashable DirectorySiteContactType - -instance FromHttpApiData DirectorySiteContactType where - parseQueryParam = \case - "BILLING" -> Right DSCTBilling - "OTHER" -> Right DSCTOther - "SALES" -> Right DSCTSales - "TECHNICAL" -> Right DSCTTechnical - x -> Left ("Unable to parse DirectorySiteContactType from: " <> x) - -instance ToHttpApiData DirectorySiteContactType where - toQueryParam = \case - DSCTBilling -> "BILLING" - DSCTOther -> "OTHER" - DSCTSales -> "SALES" - DSCTTechnical -> "TECHNICAL" - -instance FromJSON DirectorySiteContactType where - parseJSON = parseJSONText "DirectorySiteContactType" - -instance ToJSON DirectorySiteContactType where - toJSON = toJSONText - -- | Tag formats to generate for these placements. Note: -- PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements. data PlacementsGeneratetagsTagFormats @@ -8298,33 +8176,6 @@ instance ToJSON TargetWindowTargetWindowOption where toJSON = toJSONText --- | Field by which to sort the list. -data DirectorySiteContactsListSortField - = DSCLSFID - -- ^ @ID@ - | DSCLSFName - -- ^ @NAME@ - deriving (Eq, Ord, Enum, Read, Show, Data, Typeable, Generic) - -instance Hashable DirectorySiteContactsListSortField - -instance FromHttpApiData DirectorySiteContactsListSortField where - parseQueryParam = \case - "ID" -> Right DSCLSFID - "NAME" -> Right DSCLSFName - x -> Left ("Unable to parse DirectorySiteContactsListSortField from: " <> x) - -instance ToHttpApiData DirectorySiteContactsListSortField where - toQueryParam = \case - DSCLSFID -> "ID" - DSCLSFName -> "NAME" - -instance FromJSON DirectorySiteContactsListSortField where - parseJSON = parseJSONText "DirectorySiteContactsListSortField" - -instance ToJSON DirectorySiteContactsListSortField where - toJSON = toJSONText - -- | Select only placements with these pricing types. data PlacementsListPricingTypes = PLPTPricingTypeCpa @@ -9056,6 +8907,38 @@ parseJSON = parseJSONText "ChangeLogsListObjectType" instance ToJSON ChangeLogsListObjectType where + toJSON = toJSONText + +-- | Orientation of a site template used for video. This will act as default +-- for new placements created under this site. +data SiteVideoSettingsOrientation + = SVSOAny + -- ^ @ANY@ + | SVSOLandscape + -- ^ @LANDSCAPE@ + | SVSOPortrait + -- ^ @PORTRAIT@ + deriving (Eq, Ord, Enum, Read, Show, Data, Typeable, Generic) + +instance Hashable SiteVideoSettingsOrientation + +instance FromHttpApiData SiteVideoSettingsOrientation where + parseQueryParam = \case + "ANY" -> Right SVSOAny + "LANDSCAPE" -> Right SVSOLandscape + "PORTRAIT" -> Right SVSOPortrait + x -> Left ("Unable to parse SiteVideoSettingsOrientation from: " <> x) + +instance ToHttpApiData SiteVideoSettingsOrientation where + toQueryParam = \case + SVSOAny -> "ANY" + SVSOLandscape -> "LANDSCAPE" + SVSOPortrait -> "PORTRAIT" + +instance FromJSON SiteVideoSettingsOrientation where + parseJSON = parseJSONText "SiteVideoSettingsOrientation" + +instance ToJSON SiteVideoSettingsOrientation where toJSON = toJSONText -- | Cap cost type of this inventory item. diff --git a/gen/Network/Google/Resource/DFAReporting/AccountActiveAdSummaries/Get.hs b/gen/Network/Google/Resource/DFAReporting/AccountActiveAdSummaries/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/AccountActiveAdSummaries/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/AccountActiveAdSummaries/Get.hs @@ -44,7 +44,7 @@ -- 'AccountActiveAdSummariesGet' request conforms to. type AccountActiveAdSummariesGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "accountActiveAdSummaries" :> @@ -55,11 +55,14 @@ -- | Gets the account\'s active ad summary by account ID. -- -- /See:/ 'accountActiveAdSummariesGet' smart constructor. -data AccountActiveAdSummariesGet = AccountActiveAdSummariesGet' +data AccountActiveAdSummariesGet = + AccountActiveAdSummariesGet' { _aaasgProFileId :: !(Textual Int64) , _aaasgSummaryAccountId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'AccountActiveAdSummariesGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,11 @@ -> Int64 -- ^ 'aaasgSummaryAccountId' -> AccountActiveAdSummariesGet accountActiveAdSummariesGet pAaasgProFileId_ pAaasgSummaryAccountId_ = - AccountActiveAdSummariesGet' + AccountActiveAdSummariesGet' { _aaasgProFileId = _Coerce # pAaasgProFileId_ , _aaasgSummaryAccountId = _Coerce # pAaasgSummaryAccountId_ } + -- | User profile ID associated with this request. aaasgProFileId :: Lens' AccountActiveAdSummariesGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/AccountPermissionGroups/Get.hs b/gen/Network/Google/Resource/DFAReporting/AccountPermissionGroups/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/AccountPermissionGroups/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/AccountPermissionGroups/Get.hs @@ -44,7 +44,7 @@ -- 'AccountPermissionGroupsGet' request conforms to. type AccountPermissionGroupsGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "accountPermissionGroups" :> @@ -55,11 +55,14 @@ -- | Gets one account permission group by ID. -- -- /See:/ 'accountPermissionGroupsGet' smart constructor. -data AccountPermissionGroupsGet = AccountPermissionGroupsGet' +data AccountPermissionGroupsGet = + AccountPermissionGroupsGet' { _apggProFileId :: !(Textual Int64) , _apggId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'AccountPermissionGroupsGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> Int64 -- ^ 'apggId' -> AccountPermissionGroupsGet accountPermissionGroupsGet pApggProFileId_ pApggId_ = - AccountPermissionGroupsGet' - { _apggProFileId = _Coerce # pApggProFileId_ - , _apggId = _Coerce # pApggId_ - } + AccountPermissionGroupsGet' + {_apggProFileId = _Coerce # pApggProFileId_, _apggId = _Coerce # pApggId_} + -- | User profile ID associated with this request. apggProFileId :: Lens' AccountPermissionGroupsGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/AccountPermissionGroups/List.hs b/gen/Network/Google/Resource/DFAReporting/AccountPermissionGroups/List.hs --- a/gen/Network/Google/Resource/DFAReporting/AccountPermissionGroups/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/AccountPermissionGroups/List.hs @@ -43,7 +43,7 @@ -- 'AccountPermissionGroupsList' request conforms to. type AccountPermissionGroupsListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "accountPermissionGroups" :> @@ -53,10 +53,13 @@ -- | Retrieves the list of account permission groups. -- -- /See:/ 'accountPermissionGroupsList' smart constructor. -newtype AccountPermissionGroupsList = AccountPermissionGroupsList' +newtype AccountPermissionGroupsList = + AccountPermissionGroupsList' { _apglProFileId :: Textual Int64 - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'AccountPermissionGroupsList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -66,9 +69,8 @@ :: Int64 -- ^ 'apglProFileId' -> AccountPermissionGroupsList accountPermissionGroupsList pApglProFileId_ = - AccountPermissionGroupsList' - { _apglProFileId = _Coerce # pApglProFileId_ - } + AccountPermissionGroupsList' {_apglProFileId = _Coerce # pApglProFileId_} + -- | User profile ID associated with this request. apglProFileId :: Lens' AccountPermissionGroupsList Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/AccountPermissions/Get.hs b/gen/Network/Google/Resource/DFAReporting/AccountPermissions/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/AccountPermissions/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/AccountPermissions/Get.hs @@ -44,7 +44,7 @@ -- 'AccountPermissionsGet' request conforms to. type AccountPermissionsGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "accountPermissions" :> @@ -55,11 +55,14 @@ -- | Gets one account permission by ID. -- -- /See:/ 'accountPermissionsGet' smart constructor. -data AccountPermissionsGet = AccountPermissionsGet' +data AccountPermissionsGet = + AccountPermissionsGet' { _apgProFileId :: !(Textual Int64) , _apgId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'AccountPermissionsGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> Int64 -- ^ 'apgId' -> AccountPermissionsGet accountPermissionsGet pApgProFileId_ pApgId_ = - AccountPermissionsGet' - { _apgProFileId = _Coerce # pApgProFileId_ - , _apgId = _Coerce # pApgId_ - } + AccountPermissionsGet' + {_apgProFileId = _Coerce # pApgProFileId_, _apgId = _Coerce # pApgId_} + -- | User profile ID associated with this request. apgProFileId :: Lens' AccountPermissionsGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/AccountPermissions/List.hs b/gen/Network/Google/Resource/DFAReporting/AccountPermissions/List.hs --- a/gen/Network/Google/Resource/DFAReporting/AccountPermissions/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/AccountPermissions/List.hs @@ -43,7 +43,7 @@ -- 'AccountPermissionsList' request conforms to. type AccountPermissionsListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "accountPermissions" :> @@ -53,10 +53,13 @@ -- | Retrieves the list of account permissions. -- -- /See:/ 'accountPermissionsList' smart constructor. -newtype AccountPermissionsList = AccountPermissionsList' +newtype AccountPermissionsList = + AccountPermissionsList' { _aplProFileId :: Textual Int64 - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'AccountPermissionsList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -66,9 +69,8 @@ :: Int64 -- ^ 'aplProFileId' -> AccountPermissionsList accountPermissionsList pAplProFileId_ = - AccountPermissionsList' - { _aplProFileId = _Coerce # pAplProFileId_ - } + AccountPermissionsList' {_aplProFileId = _Coerce # pAplProFileId_} + -- | User profile ID associated with this request. aplProFileId :: Lens' AccountPermissionsList Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/AccountUserProFiles/Get.hs b/gen/Network/Google/Resource/DFAReporting/AccountUserProFiles/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/AccountUserProFiles/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/AccountUserProFiles/Get.hs @@ -44,7 +44,7 @@ -- 'AccountUserProFilesGet' request conforms to. type AccountUserProFilesGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "accountUserProfiles" :> @@ -55,11 +55,14 @@ -- | Gets one account user profile by ID. -- -- /See:/ 'accountUserProFilesGet' smart constructor. -data AccountUserProFilesGet = AccountUserProFilesGet' +data AccountUserProFilesGet = + AccountUserProFilesGet' { _aupfgProFileId :: !(Textual Int64) , _aupfgId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'AccountUserProFilesGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,11 @@ -> Int64 -- ^ 'aupfgId' -> AccountUserProFilesGet accountUserProFilesGet pAupfgProFileId_ pAupfgId_ = - AccountUserProFilesGet' + AccountUserProFilesGet' { _aupfgProFileId = _Coerce # pAupfgProFileId_ , _aupfgId = _Coerce # pAupfgId_ } + -- | User profile ID associated with this request. aupfgProFileId :: Lens' AccountUserProFilesGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/AccountUserProFiles/Insert.hs b/gen/Network/Google/Resource/DFAReporting/AccountUserProFiles/Insert.hs --- a/gen/Network/Google/Resource/DFAReporting/AccountUserProFiles/Insert.hs +++ b/gen/Network/Google/Resource/DFAReporting/AccountUserProFiles/Insert.hs @@ -44,7 +44,7 @@ -- 'AccountUserProFilesInsert' request conforms to. type AccountUserProFilesInsertResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "accountUserProfiles" :> @@ -55,11 +55,14 @@ -- | Inserts a new account user profile. -- -- /See:/ 'accountUserProFilesInsert' smart constructor. -data AccountUserProFilesInsert = AccountUserProFilesInsert' +data AccountUserProFilesInsert = + AccountUserProFilesInsert' { _aupfiProFileId :: !(Textual Int64) , _aupfiPayload :: !AccountUserProFile - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'AccountUserProFilesInsert' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,11 @@ -> AccountUserProFile -- ^ 'aupfiPayload' -> AccountUserProFilesInsert accountUserProFilesInsert pAupfiProFileId_ pAupfiPayload_ = - AccountUserProFilesInsert' + AccountUserProFilesInsert' { _aupfiProFileId = _Coerce # pAupfiProFileId_ , _aupfiPayload = pAupfiPayload_ } + -- | User profile ID associated with this request. aupfiProFileId :: Lens' AccountUserProFilesInsert Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/AccountUserProFiles/List.hs b/gen/Network/Google/Resource/DFAReporting/AccountUserProFiles/List.hs --- a/gen/Network/Google/Resource/DFAReporting/AccountUserProFiles/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/AccountUserProFiles/List.hs @@ -53,7 +53,7 @@ -- 'AccountUserProFilesList' request conforms to. type AccountUserProFilesListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "accountUserProfiles" :> @@ -77,7 +77,8 @@ -- method supports paging. -- -- /See:/ 'accountUserProFilesList' smart constructor. -data AccountUserProFilesList = AccountUserProFilesList' +data AccountUserProFilesList = + AccountUserProFilesList' { _aupflUserRoleId :: !(Maybe (Textual Int64)) , _aupflSearchString :: !(Maybe Text) , _aupflIds :: !(Maybe [Textual Int64]) @@ -88,8 +89,10 @@ , _aupflSortField :: !AccountUserProFilesListSortField , _aupflSubAccountId :: !(Maybe (Textual Int64)) , _aupflMaxResults :: !(Textual Int32) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'AccountUserProFilesList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -117,7 +120,7 @@ :: Int64 -- ^ 'aupflProFileId' -> AccountUserProFilesList accountUserProFilesList pAupflProFileId_ = - AccountUserProFilesList' + AccountUserProFilesList' { _aupflUserRoleId = Nothing , _aupflSearchString = Nothing , _aupflIds = Nothing @@ -129,6 +132,7 @@ , _aupflSubAccountId = Nothing , _aupflMaxResults = 1000 } + -- | Select only user profiles with the specified user role ID. aupflUserRoleId :: Lens' AccountUserProFilesList (Maybe Int64) diff --git a/gen/Network/Google/Resource/DFAReporting/AccountUserProFiles/Patch.hs b/gen/Network/Google/Resource/DFAReporting/AccountUserProFiles/Patch.hs --- a/gen/Network/Google/Resource/DFAReporting/AccountUserProFiles/Patch.hs +++ b/gen/Network/Google/Resource/DFAReporting/AccountUserProFiles/Patch.hs @@ -46,7 +46,7 @@ -- 'AccountUserProFilesPatch' request conforms to. type AccountUserProFilesPatchResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "accountUserProfiles" :> @@ -59,12 +59,15 @@ -- semantics. -- -- /See:/ 'accountUserProFilesPatch' smart constructor. -data AccountUserProFilesPatch = AccountUserProFilesPatch' +data AccountUserProFilesPatch = + AccountUserProFilesPatch' { _aupfpProFileId :: !(Textual Int64) , _aupfpPayload :: !AccountUserProFile , _aupfpId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'AccountUserProFilesPatch' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -80,11 +83,12 @@ -> Int64 -- ^ 'aupfpId' -> AccountUserProFilesPatch accountUserProFilesPatch pAupfpProFileId_ pAupfpPayload_ pAupfpId_ = - AccountUserProFilesPatch' + AccountUserProFilesPatch' { _aupfpProFileId = _Coerce # pAupfpProFileId_ , _aupfpPayload = pAupfpPayload_ , _aupfpId = _Coerce # pAupfpId_ } + -- | User profile ID associated with this request. aupfpProFileId :: Lens' AccountUserProFilesPatch Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/AccountUserProFiles/Update.hs b/gen/Network/Google/Resource/DFAReporting/AccountUserProFiles/Update.hs --- a/gen/Network/Google/Resource/DFAReporting/AccountUserProFiles/Update.hs +++ b/gen/Network/Google/Resource/DFAReporting/AccountUserProFiles/Update.hs @@ -44,7 +44,7 @@ -- 'AccountUserProFilesUpdate' request conforms to. type AccountUserProFilesUpdateResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "accountUserProfiles" :> @@ -55,11 +55,14 @@ -- | Updates an existing account user profile. -- -- /See:/ 'accountUserProFilesUpdate' smart constructor. -data AccountUserProFilesUpdate = AccountUserProFilesUpdate' +data AccountUserProFilesUpdate = + AccountUserProFilesUpdate' { _aupfuProFileId :: !(Textual Int64) , _aupfuPayload :: !AccountUserProFile - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'AccountUserProFilesUpdate' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,11 @@ -> AccountUserProFile -- ^ 'aupfuPayload' -> AccountUserProFilesUpdate accountUserProFilesUpdate pAupfuProFileId_ pAupfuPayload_ = - AccountUserProFilesUpdate' + AccountUserProFilesUpdate' { _aupfuProFileId = _Coerce # pAupfuProFileId_ , _aupfuPayload = pAupfuPayload_ } + -- | User profile ID associated with this request. aupfuProFileId :: Lens' AccountUserProFilesUpdate Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Accounts/Get.hs b/gen/Network/Google/Resource/DFAReporting/Accounts/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/Accounts/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/Accounts/Get.hs @@ -44,7 +44,7 @@ -- 'AccountsGet' request conforms to. type AccountsGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "accounts" :> @@ -54,11 +54,14 @@ -- | Gets one account by ID. -- -- /See:/ 'accountsGet' smart constructor. -data AccountsGet = AccountsGet' +data AccountsGet = + AccountsGet' { _aggProFileId :: !(Textual Int64) , _aggId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'AccountsGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Int64 -- ^ 'aggId' -> AccountsGet accountsGet pAggProFileId_ pAggId_ = - AccountsGet' - { _aggProFileId = _Coerce # pAggProFileId_ - , _aggId = _Coerce # pAggId_ - } + AccountsGet' + {_aggProFileId = _Coerce # pAggProFileId_, _aggId = _Coerce # pAggId_} + -- | User profile ID associated with this request. aggProFileId :: Lens' AccountsGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Accounts/List.hs b/gen/Network/Google/Resource/DFAReporting/Accounts/List.hs --- a/gen/Network/Google/Resource/DFAReporting/Accounts/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/Accounts/List.hs @@ -51,7 +51,7 @@ -- 'AccountsList' request conforms to. type AccountsListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "accounts" :> @@ -69,7 +69,8 @@ -- paging. -- -- /See:/ 'accountsList' smart constructor. -data AccountsList = AccountsList' +data AccountsList = + AccountsList' { _accSearchString :: !(Maybe Text) , _accIds :: !(Maybe [Textual Int64]) , _accProFileId :: !(Textual Int64) @@ -78,8 +79,10 @@ , _accPageToken :: !(Maybe Text) , _accSortField :: !AccountsListSortField , _accMaxResults :: !(Textual Int32) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'AccountsList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -103,7 +106,7 @@ :: Int64 -- ^ 'accProFileId' -> AccountsList accountsList pAccProFileId_ = - AccountsList' + AccountsList' { _accSearchString = Nothing , _accIds = Nothing , _accProFileId = _Coerce # pAccProFileId_ @@ -113,6 +116,7 @@ , _accSortField = AID , _accMaxResults = 1000 } + -- | Allows searching for objects by name or ID. Wildcards (*) are allowed. -- For example, \"account*2015\" will return objects with names like diff --git a/gen/Network/Google/Resource/DFAReporting/Accounts/Patch.hs b/gen/Network/Google/Resource/DFAReporting/Accounts/Patch.hs --- a/gen/Network/Google/Resource/DFAReporting/Accounts/Patch.hs +++ b/gen/Network/Google/Resource/DFAReporting/Accounts/Patch.hs @@ -45,7 +45,7 @@ -- 'AccountsPatch' request conforms to. type AccountsPatchResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "accounts" :> @@ -56,12 +56,15 @@ -- | Updates an existing account. This method supports patch semantics. -- -- /See:/ 'accountsPatch' smart constructor. -data AccountsPatch = AccountsPatch' +data AccountsPatch = + AccountsPatch' { _appProFileId :: !(Textual Int64) , _appPayload :: !Account , _appId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'AccountsPatch' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -77,11 +80,12 @@ -> Int64 -- ^ 'appId' -> AccountsPatch accountsPatch pAppProFileId_ pAppPayload_ pAppId_ = - AccountsPatch' + AccountsPatch' { _appProFileId = _Coerce # pAppProFileId_ , _appPayload = pAppPayload_ , _appId = _Coerce # pAppId_ } + -- | User profile ID associated with this request. appProFileId :: Lens' AccountsPatch Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Accounts/Update.hs b/gen/Network/Google/Resource/DFAReporting/Accounts/Update.hs --- a/gen/Network/Google/Resource/DFAReporting/Accounts/Update.hs +++ b/gen/Network/Google/Resource/DFAReporting/Accounts/Update.hs @@ -44,7 +44,7 @@ -- 'AccountsUpdate' request conforms to. type AccountsUpdateResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "accounts" :> @@ -54,11 +54,14 @@ -- | Updates an existing account. -- -- /See:/ 'accountsUpdate' smart constructor. -data AccountsUpdate = AccountsUpdate' +data AccountsUpdate = + AccountsUpdate' { _auuProFileId :: !(Textual Int64) , _auuPayload :: !Account - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'AccountsUpdate' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Account -- ^ 'auuPayload' -> AccountsUpdate accountsUpdate pAuuProFileId_ pAuuPayload_ = - AccountsUpdate' - { _auuProFileId = _Coerce # pAuuProFileId_ - , _auuPayload = pAuuPayload_ - } + AccountsUpdate' + {_auuProFileId = _Coerce # pAuuProFileId_, _auuPayload = pAuuPayload_} + -- | User profile ID associated with this request. auuProFileId :: Lens' AccountsUpdate Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Ads/Get.hs b/gen/Network/Google/Resource/DFAReporting/Ads/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/Ads/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/Ads/Get.hs @@ -44,7 +44,7 @@ -- 'AdsGet' request conforms to. type AdsGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "ads" :> @@ -54,11 +54,14 @@ -- | Gets one ad by ID. -- -- /See:/ 'adsGet' smart constructor. -data AdsGet = AdsGet' +data AdsGet = + AdsGet' { _adsProFileId :: !(Textual Int64) , _adsId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'AdsGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,8 @@ -> Int64 -- ^ 'adsId' -> AdsGet adsGet pAdsProFileId_ pAdsId_ = - AdsGet' - { _adsProFileId = _Coerce # pAdsProFileId_ - , _adsId = _Coerce # pAdsId_ - } + AdsGet' {_adsProFileId = _Coerce # pAdsProFileId_, _adsId = _Coerce # pAdsId_} + -- | User profile ID associated with this request. adsProFileId :: Lens' AdsGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Ads/Insert.hs b/gen/Network/Google/Resource/DFAReporting/Ads/Insert.hs --- a/gen/Network/Google/Resource/DFAReporting/Ads/Insert.hs +++ b/gen/Network/Google/Resource/DFAReporting/Ads/Insert.hs @@ -44,7 +44,7 @@ -- 'AdsInsert' request conforms to. type AdsInsertResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "ads" :> @@ -54,11 +54,14 @@ -- | Inserts a new ad. -- -- /See:/ 'adsInsert' smart constructor. -data AdsInsert = AdsInsert' +data AdsInsert = + AdsInsert' { _aiProFileId :: !(Textual Int64) , _aiPayload :: !Ad - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'AdsInsert' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,8 @@ -> Ad -- ^ 'aiPayload' -> AdsInsert adsInsert pAiProFileId_ pAiPayload_ = - AdsInsert' - { _aiProFileId = _Coerce # pAiProFileId_ - , _aiPayload = pAiPayload_ - } + AdsInsert' {_aiProFileId = _Coerce # pAiProFileId_, _aiPayload = pAiPayload_} + -- | User profile ID associated with this request. aiProFileId :: Lens' AdsInsert Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Ads/List.hs b/gen/Network/Google/Resource/DFAReporting/Ads/List.hs --- a/gen/Network/Google/Resource/DFAReporting/Ads/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/Ads/List.hs @@ -66,7 +66,7 @@ -- 'AdsList' request conforms to. type AdsListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "ads" :> @@ -124,7 +124,8 @@ -- | Retrieves a list of ads, possibly filtered. This method supports paging. -- -- /See:/ 'adsList' smart constructor. -data AdsList = AdsList' +data AdsList = + AdsList' { _alRemarketingListIds :: !(Maybe [Textual Int64]) , _alLandingPageIds :: !(Maybe [Textual Int64]) , _alCreativeIds :: !(Maybe [Textual Int64]) @@ -149,8 +150,10 @@ , _alArchived :: !(Maybe Bool) , _alMaxResults :: !(Textual Int32) , _alAudienceSegmentIds :: !(Maybe [Textual Int64]) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'AdsList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -206,7 +209,7 @@ :: Int64 -- ^ 'alProFileId' -> AdsList adsList pAlProFileId_ = - AdsList' + AdsList' { _alRemarketingListIds = Nothing , _alLandingPageIds = Nothing , _alCreativeIds = Nothing @@ -232,6 +235,7 @@ , _alMaxResults = 1000 , _alAudienceSegmentIds = Nothing } + -- | Select only ads whose list targeting expression use these remarketing -- list IDs. diff --git a/gen/Network/Google/Resource/DFAReporting/Ads/Patch.hs b/gen/Network/Google/Resource/DFAReporting/Ads/Patch.hs --- a/gen/Network/Google/Resource/DFAReporting/Ads/Patch.hs +++ b/gen/Network/Google/Resource/DFAReporting/Ads/Patch.hs @@ -45,7 +45,7 @@ -- 'AdsPatch' request conforms to. type AdsPatchResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "ads" :> @@ -56,12 +56,15 @@ -- | Updates an existing ad. This method supports patch semantics. -- -- /See:/ 'adsPatch' smart constructor. -data AdsPatch = AdsPatch' +data AdsPatch = + AdsPatch' { _adsdProFileId :: !(Textual Int64) , _adsdPayload :: !Ad , _adsdId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'AdsPatch' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -77,11 +80,12 @@ -> Int64 -- ^ 'adsdId' -> AdsPatch adsPatch pAdsdProFileId_ pAdsdPayload_ pAdsdId_ = - AdsPatch' + AdsPatch' { _adsdProFileId = _Coerce # pAdsdProFileId_ , _adsdPayload = pAdsdPayload_ , _adsdId = _Coerce # pAdsdId_ } + -- | User profile ID associated with this request. adsdProFileId :: Lens' AdsPatch Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Ads/Update.hs b/gen/Network/Google/Resource/DFAReporting/Ads/Update.hs --- a/gen/Network/Google/Resource/DFAReporting/Ads/Update.hs +++ b/gen/Network/Google/Resource/DFAReporting/Ads/Update.hs @@ -44,7 +44,7 @@ -- 'AdsUpdate' request conforms to. type AdsUpdateResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "ads" :> @@ -54,11 +54,14 @@ -- | Updates an existing ad. -- -- /See:/ 'adsUpdate' smart constructor. -data AdsUpdate = AdsUpdate' +data AdsUpdate = + AdsUpdate' { _aProFileId :: !(Textual Int64) , _aPayload :: !Ad - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'AdsUpdate' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,8 @@ -> Ad -- ^ 'aPayload' -> AdsUpdate adsUpdate pAProFileId_ pAPayload_ = - AdsUpdate' - { _aProFileId = _Coerce # pAProFileId_ - , _aPayload = pAPayload_ - } + AdsUpdate' {_aProFileId = _Coerce # pAProFileId_, _aPayload = pAPayload_} + -- | User profile ID associated with this request. aProFileId :: Lens' AdsUpdate Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/AdvertiserGroups/Delete.hs b/gen/Network/Google/Resource/DFAReporting/AdvertiserGroups/Delete.hs --- a/gen/Network/Google/Resource/DFAReporting/AdvertiserGroups/Delete.hs +++ b/gen/Network/Google/Resource/DFAReporting/AdvertiserGroups/Delete.hs @@ -44,7 +44,7 @@ -- 'AdvertiserGroupsDelete' request conforms to. type AdvertiserGroupsDeleteResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "advertiserGroups" :> @@ -54,11 +54,14 @@ -- | Deletes an existing advertiser group. -- -- /See:/ 'advertiserGroupsDelete' smart constructor. -data AdvertiserGroupsDelete = AdvertiserGroupsDelete' +data AdvertiserGroupsDelete = + AdvertiserGroupsDelete' { _agdProFileId :: !(Textual Int64) , _agdId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'AdvertiserGroupsDelete' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Int64 -- ^ 'agdId' -> AdvertiserGroupsDelete advertiserGroupsDelete pAgdProFileId_ pAgdId_ = - AdvertiserGroupsDelete' - { _agdProFileId = _Coerce # pAgdProFileId_ - , _agdId = _Coerce # pAgdId_ - } + AdvertiserGroupsDelete' + {_agdProFileId = _Coerce # pAgdProFileId_, _agdId = _Coerce # pAgdId_} + -- | User profile ID associated with this request. agdProFileId :: Lens' AdvertiserGroupsDelete Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/AdvertiserGroups/Get.hs b/gen/Network/Google/Resource/DFAReporting/AdvertiserGroups/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/AdvertiserGroups/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/AdvertiserGroups/Get.hs @@ -44,7 +44,7 @@ -- 'AdvertiserGroupsGet' request conforms to. type AdvertiserGroupsGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "advertiserGroups" :> @@ -55,11 +55,14 @@ -- | Gets one advertiser group by ID. -- -- /See:/ 'advertiserGroupsGet' smart constructor. -data AdvertiserGroupsGet = AdvertiserGroupsGet' +data AdvertiserGroupsGet = + AdvertiserGroupsGet' { _agggProFileId :: !(Textual Int64) , _agggId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'AdvertiserGroupsGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> Int64 -- ^ 'agggId' -> AdvertiserGroupsGet advertiserGroupsGet pAgggProFileId_ pAgggId_ = - AdvertiserGroupsGet' - { _agggProFileId = _Coerce # pAgggProFileId_ - , _agggId = _Coerce # pAgggId_ - } + AdvertiserGroupsGet' + {_agggProFileId = _Coerce # pAgggProFileId_, _agggId = _Coerce # pAgggId_} + -- | User profile ID associated with this request. agggProFileId :: Lens' AdvertiserGroupsGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/AdvertiserGroups/Insert.hs b/gen/Network/Google/Resource/DFAReporting/AdvertiserGroups/Insert.hs --- a/gen/Network/Google/Resource/DFAReporting/AdvertiserGroups/Insert.hs +++ b/gen/Network/Google/Resource/DFAReporting/AdvertiserGroups/Insert.hs @@ -44,7 +44,7 @@ -- 'AdvertiserGroupsInsert' request conforms to. type AdvertiserGroupsInsertResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "advertiserGroups" :> @@ -55,11 +55,14 @@ -- | Inserts a new advertiser group. -- -- /See:/ 'advertiserGroupsInsert' smart constructor. -data AdvertiserGroupsInsert = AdvertiserGroupsInsert' +data AdvertiserGroupsInsert = + AdvertiserGroupsInsert' { _agiProFileId :: !(Textual Int64) , _agiPayload :: !AdvertiserGroup - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'AdvertiserGroupsInsert' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> AdvertiserGroup -- ^ 'agiPayload' -> AdvertiserGroupsInsert advertiserGroupsInsert pAgiProFileId_ pAgiPayload_ = - AdvertiserGroupsInsert' - { _agiProFileId = _Coerce # pAgiProFileId_ - , _agiPayload = pAgiPayload_ - } + AdvertiserGroupsInsert' + {_agiProFileId = _Coerce # pAgiProFileId_, _agiPayload = pAgiPayload_} + -- | User profile ID associated with this request. agiProFileId :: Lens' AdvertiserGroupsInsert Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/AdvertiserGroups/List.hs b/gen/Network/Google/Resource/DFAReporting/AdvertiserGroups/List.hs --- a/gen/Network/Google/Resource/DFAReporting/AdvertiserGroups/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/AdvertiserGroups/List.hs @@ -50,7 +50,7 @@ -- 'AdvertiserGroupsList' request conforms to. type AdvertiserGroupsListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "advertiserGroups" :> @@ -69,7 +69,8 @@ -- supports paging. -- -- /See:/ 'advertiserGroupsList' smart constructor. -data AdvertiserGroupsList = AdvertiserGroupsList' +data AdvertiserGroupsList = + AdvertiserGroupsList' { _aglSearchString :: !(Maybe Text) , _aglIds :: !(Maybe [Textual Int64]) , _aglProFileId :: !(Textual Int64) @@ -77,8 +78,10 @@ , _aglPageToken :: !(Maybe Text) , _aglSortField :: !AdvertiserGroupsListSortField , _aglMaxResults :: !(Textual Int32) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'AdvertiserGroupsList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -100,7 +103,7 @@ :: Int64 -- ^ 'aglProFileId' -> AdvertiserGroupsList advertiserGroupsList pAglProFileId_ = - AdvertiserGroupsList' + AdvertiserGroupsList' { _aglSearchString = Nothing , _aglIds = Nothing , _aglProFileId = _Coerce # pAglProFileId_ @@ -109,6 +112,7 @@ , _aglSortField = AGLSFID , _aglMaxResults = 1000 } + -- | Allows searching for objects by name or ID. Wildcards (*) are allowed. -- For example, \"advertiser*2015\" will return objects with names like diff --git a/gen/Network/Google/Resource/DFAReporting/AdvertiserGroups/Patch.hs b/gen/Network/Google/Resource/DFAReporting/AdvertiserGroups/Patch.hs --- a/gen/Network/Google/Resource/DFAReporting/AdvertiserGroups/Patch.hs +++ b/gen/Network/Google/Resource/DFAReporting/AdvertiserGroups/Patch.hs @@ -46,7 +46,7 @@ -- 'AdvertiserGroupsPatch' request conforms to. type AdvertiserGroupsPatchResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "advertiserGroups" :> @@ -59,12 +59,15 @@ -- semantics. -- -- /See:/ 'advertiserGroupsPatch' smart constructor. -data AdvertiserGroupsPatch = AdvertiserGroupsPatch' +data AdvertiserGroupsPatch = + AdvertiserGroupsPatch' { _agpProFileId :: !(Textual Int64) , _agpPayload :: !AdvertiserGroup , _agpId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'AdvertiserGroupsPatch' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -80,11 +83,12 @@ -> Int64 -- ^ 'agpId' -> AdvertiserGroupsPatch advertiserGroupsPatch pAgpProFileId_ pAgpPayload_ pAgpId_ = - AdvertiserGroupsPatch' + AdvertiserGroupsPatch' { _agpProFileId = _Coerce # pAgpProFileId_ , _agpPayload = pAgpPayload_ , _agpId = _Coerce # pAgpId_ } + -- | User profile ID associated with this request. agpProFileId :: Lens' AdvertiserGroupsPatch Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/AdvertiserGroups/Update.hs b/gen/Network/Google/Resource/DFAReporting/AdvertiserGroups/Update.hs --- a/gen/Network/Google/Resource/DFAReporting/AdvertiserGroups/Update.hs +++ b/gen/Network/Google/Resource/DFAReporting/AdvertiserGroups/Update.hs @@ -44,7 +44,7 @@ -- 'AdvertiserGroupsUpdate' request conforms to. type AdvertiserGroupsUpdateResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "advertiserGroups" :> @@ -55,11 +55,14 @@ -- | Updates an existing advertiser group. -- -- /See:/ 'advertiserGroupsUpdate' smart constructor. -data AdvertiserGroupsUpdate = AdvertiserGroupsUpdate' +data AdvertiserGroupsUpdate = + AdvertiserGroupsUpdate' { _aguProFileId :: !(Textual Int64) , _aguPayload :: !AdvertiserGroup - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'AdvertiserGroupsUpdate' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> AdvertiserGroup -- ^ 'aguPayload' -> AdvertiserGroupsUpdate advertiserGroupsUpdate pAguProFileId_ pAguPayload_ = - AdvertiserGroupsUpdate' - { _aguProFileId = _Coerce # pAguProFileId_ - , _aguPayload = pAguPayload_ - } + AdvertiserGroupsUpdate' + {_aguProFileId = _Coerce # pAguProFileId_, _aguPayload = pAguPayload_} + -- | User profile ID associated with this request. aguProFileId :: Lens' AdvertiserGroupsUpdate Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/AdvertiserLandingPages/Get.hs b/gen/Network/Google/Resource/DFAReporting/AdvertiserLandingPages/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/AdvertiserLandingPages/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/AdvertiserLandingPages/Get.hs @@ -44,7 +44,7 @@ -- 'AdvertiserLandingPagesGet' request conforms to. type AdvertiserLandingPagesGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "advertiserLandingPages" :> @@ -54,11 +54,14 @@ -- | Gets one landing page by ID. -- -- /See:/ 'advertiserLandingPagesGet' smart constructor. -data AdvertiserLandingPagesGet = AdvertiserLandingPagesGet' +data AdvertiserLandingPagesGet = + AdvertiserLandingPagesGet' { _alpgProFileId :: !(Textual Int64) , _alpgId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'AdvertiserLandingPagesGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Int64 -- ^ 'alpgId' -> AdvertiserLandingPagesGet advertiserLandingPagesGet pAlpgProFileId_ pAlpgId_ = - AdvertiserLandingPagesGet' - { _alpgProFileId = _Coerce # pAlpgProFileId_ - , _alpgId = _Coerce # pAlpgId_ - } + AdvertiserLandingPagesGet' + {_alpgProFileId = _Coerce # pAlpgProFileId_, _alpgId = _Coerce # pAlpgId_} + -- | User profile ID associated with this request. alpgProFileId :: Lens' AdvertiserLandingPagesGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/AdvertiserLandingPages/Insert.hs b/gen/Network/Google/Resource/DFAReporting/AdvertiserLandingPages/Insert.hs --- a/gen/Network/Google/Resource/DFAReporting/AdvertiserLandingPages/Insert.hs +++ b/gen/Network/Google/Resource/DFAReporting/AdvertiserLandingPages/Insert.hs @@ -44,7 +44,7 @@ -- 'AdvertiserLandingPagesInsert' request conforms to. type AdvertiserLandingPagesInsertResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "advertiserLandingPages" :> @@ -55,11 +55,14 @@ -- | Inserts a new landing page. -- -- /See:/ 'advertiserLandingPagesInsert' smart constructor. -data AdvertiserLandingPagesInsert = AdvertiserLandingPagesInsert' +data AdvertiserLandingPagesInsert = + AdvertiserLandingPagesInsert' { _alpiProFileId :: !(Textual Int64) , _alpiPayload :: !LandingPage - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'AdvertiserLandingPagesInsert' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> LandingPage -- ^ 'alpiPayload' -> AdvertiserLandingPagesInsert advertiserLandingPagesInsert pAlpiProFileId_ pAlpiPayload_ = - AdvertiserLandingPagesInsert' - { _alpiProFileId = _Coerce # pAlpiProFileId_ - , _alpiPayload = pAlpiPayload_ - } + AdvertiserLandingPagesInsert' + {_alpiProFileId = _Coerce # pAlpiProFileId_, _alpiPayload = pAlpiPayload_} + -- | User profile ID associated with this request. alpiProFileId :: Lens' AdvertiserLandingPagesInsert Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/AdvertiserLandingPages/List.hs b/gen/Network/Google/Resource/DFAReporting/AdvertiserLandingPages/List.hs --- a/gen/Network/Google/Resource/DFAReporting/AdvertiserLandingPages/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/AdvertiserLandingPages/List.hs @@ -53,7 +53,7 @@ -- 'AdvertiserLandingPagesList' request conforms to. type AdvertiserLandingPagesListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "advertiserLandingPages" :> @@ -78,7 +78,8 @@ -- | Retrieves a list of landing pages. -- -- /See:/ 'advertiserLandingPagesList' smart constructor. -data AdvertiserLandingPagesList = AdvertiserLandingPagesList' +data AdvertiserLandingPagesList = + AdvertiserLandingPagesList' { _alplCampaignIds :: !(Maybe [Textual Int64]) , _alplSearchString :: !(Maybe Text) , _alplIds :: !(Maybe [Textual Int64]) @@ -90,8 +91,10 @@ , _alplAdvertiserIds :: !(Maybe [Textual Int64]) , _alplArchived :: !(Maybe Bool) , _alplMaxResults :: !(Textual Int32) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'AdvertiserLandingPagesList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -121,7 +124,7 @@ :: Int64 -- ^ 'alplProFileId' -> AdvertiserLandingPagesList advertiserLandingPagesList pAlplProFileId_ = - AdvertiserLandingPagesList' + AdvertiserLandingPagesList' { _alplCampaignIds = Nothing , _alplSearchString = Nothing , _alplIds = Nothing @@ -134,6 +137,7 @@ , _alplArchived = Nothing , _alplMaxResults = 1000 } + -- | Select only landing pages that are associated with these campaigns. alplCampaignIds :: Lens' AdvertiserLandingPagesList [Int64] diff --git a/gen/Network/Google/Resource/DFAReporting/AdvertiserLandingPages/Patch.hs b/gen/Network/Google/Resource/DFAReporting/AdvertiserLandingPages/Patch.hs --- a/gen/Network/Google/Resource/DFAReporting/AdvertiserLandingPages/Patch.hs +++ b/gen/Network/Google/Resource/DFAReporting/AdvertiserLandingPages/Patch.hs @@ -45,7 +45,7 @@ -- 'AdvertiserLandingPagesPatch' request conforms to. type AdvertiserLandingPagesPatchResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "advertiserLandingPages" :> @@ -57,12 +57,15 @@ -- | Updates an existing landing page. This method supports patch semantics. -- -- /See:/ 'advertiserLandingPagesPatch' smart constructor. -data AdvertiserLandingPagesPatch = AdvertiserLandingPagesPatch' +data AdvertiserLandingPagesPatch = + AdvertiserLandingPagesPatch' { _alppProFileId :: !(Textual Int64) , _alppPayload :: !LandingPage , _alppId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'AdvertiserLandingPagesPatch' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -78,11 +81,12 @@ -> Int64 -- ^ 'alppId' -> AdvertiserLandingPagesPatch advertiserLandingPagesPatch pAlppProFileId_ pAlppPayload_ pAlppId_ = - AdvertiserLandingPagesPatch' + AdvertiserLandingPagesPatch' { _alppProFileId = _Coerce # pAlppProFileId_ , _alppPayload = pAlppPayload_ , _alppId = _Coerce # pAlppId_ } + -- | User profile ID associated with this request. alppProFileId :: Lens' AdvertiserLandingPagesPatch Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/AdvertiserLandingPages/Update.hs b/gen/Network/Google/Resource/DFAReporting/AdvertiserLandingPages/Update.hs --- a/gen/Network/Google/Resource/DFAReporting/AdvertiserLandingPages/Update.hs +++ b/gen/Network/Google/Resource/DFAReporting/AdvertiserLandingPages/Update.hs @@ -44,7 +44,7 @@ -- 'AdvertiserLandingPagesUpdate' request conforms to. type AdvertiserLandingPagesUpdateResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "advertiserLandingPages" :> @@ -55,11 +55,14 @@ -- | Updates an existing landing page. -- -- /See:/ 'advertiserLandingPagesUpdate' smart constructor. -data AdvertiserLandingPagesUpdate = AdvertiserLandingPagesUpdate' +data AdvertiserLandingPagesUpdate = + AdvertiserLandingPagesUpdate' { _alpuProFileId :: !(Textual Int64) , _alpuPayload :: !LandingPage - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'AdvertiserLandingPagesUpdate' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> LandingPage -- ^ 'alpuPayload' -> AdvertiserLandingPagesUpdate advertiserLandingPagesUpdate pAlpuProFileId_ pAlpuPayload_ = - AdvertiserLandingPagesUpdate' - { _alpuProFileId = _Coerce # pAlpuProFileId_ - , _alpuPayload = pAlpuPayload_ - } + AdvertiserLandingPagesUpdate' + {_alpuProFileId = _Coerce # pAlpuProFileId_, _alpuPayload = pAlpuPayload_} + -- | User profile ID associated with this request. alpuProFileId :: Lens' AdvertiserLandingPagesUpdate Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Advertisers/Get.hs b/gen/Network/Google/Resource/DFAReporting/Advertisers/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/Advertisers/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/Advertisers/Get.hs @@ -44,7 +44,7 @@ -- 'AdvertisersGet' request conforms to. type AdvertisersGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "advertisers" :> @@ -54,11 +54,14 @@ -- | Gets one advertiser by ID. -- -- /See:/ 'advertisersGet' smart constructor. -data AdvertisersGet = AdvertisersGet' +data AdvertisersGet = + AdvertisersGet' { _advProFileId :: !(Textual Int64) , _advId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'AdvertisersGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Int64 -- ^ 'advId' -> AdvertisersGet advertisersGet pAdvProFileId_ pAdvId_ = - AdvertisersGet' - { _advProFileId = _Coerce # pAdvProFileId_ - , _advId = _Coerce # pAdvId_ - } + AdvertisersGet' + {_advProFileId = _Coerce # pAdvProFileId_, _advId = _Coerce # pAdvId_} + -- | User profile ID associated with this request. advProFileId :: Lens' AdvertisersGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Advertisers/Insert.hs b/gen/Network/Google/Resource/DFAReporting/Advertisers/Insert.hs --- a/gen/Network/Google/Resource/DFAReporting/Advertisers/Insert.hs +++ b/gen/Network/Google/Resource/DFAReporting/Advertisers/Insert.hs @@ -44,7 +44,7 @@ -- 'AdvertisersInsert' request conforms to. type AdvertisersInsertResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "advertisers" :> @@ -54,11 +54,14 @@ -- | Inserts a new advertiser. -- -- /See:/ 'advertisersInsert' smart constructor. -data AdvertisersInsert = AdvertisersInsert' +data AdvertisersInsert = + AdvertisersInsert' { _aiiProFileId :: !(Textual Int64) , _aiiPayload :: !Advertiser - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'AdvertisersInsert' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Advertiser -- ^ 'aiiPayload' -> AdvertisersInsert advertisersInsert pAiiProFileId_ pAiiPayload_ = - AdvertisersInsert' - { _aiiProFileId = _Coerce # pAiiProFileId_ - , _aiiPayload = pAiiPayload_ - } + AdvertisersInsert' + {_aiiProFileId = _Coerce # pAiiProFileId_, _aiiPayload = pAiiPayload_} + -- | User profile ID associated with this request. aiiProFileId :: Lens' AdvertisersInsert Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Advertisers/List.hs b/gen/Network/Google/Resource/DFAReporting/Advertisers/List.hs --- a/gen/Network/Google/Resource/DFAReporting/Advertisers/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/Advertisers/List.hs @@ -56,7 +56,7 @@ -- 'AdvertisersList' request conforms to. type AdvertisersListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "advertisers" :> @@ -83,7 +83,8 @@ -- paging. -- -- /See:/ 'advertisersList' smart constructor. -data AdvertisersList = AdvertisersList' +data AdvertisersList = + AdvertisersList' { _allStatus :: !(Maybe AdvertisersListStatus) , _allOnlyParent :: !(Maybe Bool) , _allSearchString :: !(Maybe Text) @@ -97,8 +98,10 @@ , _allSubAccountId :: !(Maybe (Textual Int64)) , _allFloodlightConfigurationIds :: !(Maybe [Textual Int64]) , _allMaxResults :: !(Textual Int32) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'AdvertisersList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -132,7 +135,7 @@ :: Int64 -- ^ 'allProFileId' -> AdvertisersList advertisersList pAllProFileId_ = - AdvertisersList' + AdvertisersList' { _allStatus = Nothing , _allOnlyParent = Nothing , _allSearchString = Nothing @@ -147,6 +150,7 @@ , _allFloodlightConfigurationIds = Nothing , _allMaxResults = 1000 } + -- | Select only advertisers with the specified status. allStatus :: Lens' AdvertisersList (Maybe AdvertisersListStatus) diff --git a/gen/Network/Google/Resource/DFAReporting/Advertisers/Patch.hs b/gen/Network/Google/Resource/DFAReporting/Advertisers/Patch.hs --- a/gen/Network/Google/Resource/DFAReporting/Advertisers/Patch.hs +++ b/gen/Network/Google/Resource/DFAReporting/Advertisers/Patch.hs @@ -45,7 +45,7 @@ -- 'AdvertisersPatch' request conforms to. type AdvertisersPatchResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "advertisers" :> @@ -57,12 +57,15 @@ -- | Updates an existing advertiser. This method supports patch semantics. -- -- /See:/ 'advertisersPatch' smart constructor. -data AdvertisersPatch = AdvertisersPatch' +data AdvertisersPatch = + AdvertisersPatch' { _apProFileId :: !(Textual Int64) , _apPayload :: !Advertiser , _apId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'AdvertisersPatch' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -78,11 +81,12 @@ -> Int64 -- ^ 'apId' -> AdvertisersPatch advertisersPatch pApProFileId_ pApPayload_ pApId_ = - AdvertisersPatch' + AdvertisersPatch' { _apProFileId = _Coerce # pApProFileId_ , _apPayload = pApPayload_ , _apId = _Coerce # pApId_ } + -- | User profile ID associated with this request. apProFileId :: Lens' AdvertisersPatch Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Advertisers/Update.hs b/gen/Network/Google/Resource/DFAReporting/Advertisers/Update.hs --- a/gen/Network/Google/Resource/DFAReporting/Advertisers/Update.hs +++ b/gen/Network/Google/Resource/DFAReporting/Advertisers/Update.hs @@ -44,7 +44,7 @@ -- 'AdvertisersUpdate' request conforms to. type AdvertisersUpdateResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "advertisers" :> @@ -54,11 +54,14 @@ -- | Updates an existing advertiser. -- -- /See:/ 'advertisersUpdate' smart constructor. -data AdvertisersUpdate = AdvertisersUpdate' +data AdvertisersUpdate = + AdvertisersUpdate' { _auProFileId :: !(Textual Int64) , _auPayload :: !Advertiser - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'AdvertisersUpdate' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Advertiser -- ^ 'auPayload' -> AdvertisersUpdate advertisersUpdate pAuProFileId_ pAuPayload_ = - AdvertisersUpdate' - { _auProFileId = _Coerce # pAuProFileId_ - , _auPayload = pAuPayload_ - } + AdvertisersUpdate' + {_auProFileId = _Coerce # pAuProFileId_, _auPayload = pAuPayload_} + -- | User profile ID associated with this request. auProFileId :: Lens' AdvertisersUpdate Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Browsers/List.hs b/gen/Network/Google/Resource/DFAReporting/Browsers/List.hs --- a/gen/Network/Google/Resource/DFAReporting/Browsers/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/Browsers/List.hs @@ -43,7 +43,7 @@ -- 'BrowsersList' request conforms to. type BrowsersListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "browsers" :> @@ -53,10 +53,13 @@ -- | Retrieves a list of browsers. -- -- /See:/ 'browsersList' smart constructor. -newtype BrowsersList = BrowsersList' +newtype BrowsersList = + BrowsersList' { _blProFileId :: Textual Int64 - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'BrowsersList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -66,9 +69,8 @@ :: Int64 -- ^ 'blProFileId' -> BrowsersList browsersList pBlProFileId_ = - BrowsersList' - { _blProFileId = _Coerce # pBlProFileId_ - } + BrowsersList' {_blProFileId = _Coerce # pBlProFileId_} + -- | User profile ID associated with this request. blProFileId :: Lens' BrowsersList Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/CampaignCreativeAssociations/Insert.hs b/gen/Network/Google/Resource/DFAReporting/CampaignCreativeAssociations/Insert.hs --- a/gen/Network/Google/Resource/DFAReporting/CampaignCreativeAssociations/Insert.hs +++ b/gen/Network/Google/Resource/DFAReporting/CampaignCreativeAssociations/Insert.hs @@ -47,7 +47,7 @@ -- 'CampaignCreativeAssociationsInsert' request conforms to. type CampaignCreativeAssociationsInsertResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "campaigns" :> @@ -62,12 +62,15 @@ -- a default ad does not exist already. -- -- /See:/ 'campaignCreativeAssociationsInsert' smart constructor. -data CampaignCreativeAssociationsInsert = CampaignCreativeAssociationsInsert' +data CampaignCreativeAssociationsInsert = + CampaignCreativeAssociationsInsert' { _ccaiCampaignId :: !(Textual Int64) , _ccaiProFileId :: !(Textual Int64) , _ccaiPayload :: !CampaignCreativeAssociation - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'CampaignCreativeAssociationsInsert' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -83,12 +86,13 @@ -> CampaignCreativeAssociation -- ^ 'ccaiPayload' -> CampaignCreativeAssociationsInsert campaignCreativeAssociationsInsert pCcaiCampaignId_ pCcaiProFileId_ pCcaiPayload_ = - CampaignCreativeAssociationsInsert' + CampaignCreativeAssociationsInsert' { _ccaiCampaignId = _Coerce # pCcaiCampaignId_ , _ccaiProFileId = _Coerce # pCcaiProFileId_ , _ccaiPayload = pCcaiPayload_ } + -- | Campaign ID in this association. ccaiCampaignId :: Lens' CampaignCreativeAssociationsInsert Int64 ccaiCampaignId @@ -109,7 +113,8 @@ = lens _ccaiPayload (\ s a -> s{_ccaiPayload = a}) instance GoogleRequest - CampaignCreativeAssociationsInsert where + CampaignCreativeAssociationsInsert + where type Rs CampaignCreativeAssociationsInsert = CampaignCreativeAssociation type Scopes CampaignCreativeAssociationsInsert = diff --git a/gen/Network/Google/Resource/DFAReporting/CampaignCreativeAssociations/List.hs b/gen/Network/Google/Resource/DFAReporting/CampaignCreativeAssociations/List.hs --- a/gen/Network/Google/Resource/DFAReporting/CampaignCreativeAssociations/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/CampaignCreativeAssociations/List.hs @@ -48,7 +48,7 @@ -- 'CampaignCreativeAssociationsList' request conforms to. type CampaignCreativeAssociationsListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "campaigns" :> @@ -66,14 +66,17 @@ -- campaign. This method supports paging. -- -- /See:/ 'campaignCreativeAssociationsList' smart constructor. -data CampaignCreativeAssociationsList = CampaignCreativeAssociationsList' +data CampaignCreativeAssociationsList = + CampaignCreativeAssociationsList' { _ccalCampaignId :: !(Textual Int64) , _ccalProFileId :: !(Textual Int64) , _ccalSortOrder :: !CampaignCreativeAssociationsListSortOrder , _ccalPageToken :: !(Maybe Text) , _ccalMaxResults :: !(Textual Int32) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'CampaignCreativeAssociationsList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -92,7 +95,7 @@ -> Int64 -- ^ 'ccalProFileId' -> CampaignCreativeAssociationsList campaignCreativeAssociationsList pCcalCampaignId_ pCcalProFileId_ = - CampaignCreativeAssociationsList' + CampaignCreativeAssociationsList' { _ccalCampaignId = _Coerce # pCcalCampaignId_ , _ccalProFileId = _Coerce # pCcalProFileId_ , _ccalSortOrder = CCALSOAscending @@ -100,6 +103,7 @@ , _ccalMaxResults = 1000 } + -- | Campaign ID in this association. ccalCampaignId :: Lens' CampaignCreativeAssociationsList Int64 ccalCampaignId @@ -134,7 +138,8 @@ . _Coerce instance GoogleRequest - CampaignCreativeAssociationsList where + CampaignCreativeAssociationsList + where type Rs CampaignCreativeAssociationsList = CampaignCreativeAssociationsListResponse type Scopes CampaignCreativeAssociationsList = diff --git a/gen/Network/Google/Resource/DFAReporting/Campaigns/Get.hs b/gen/Network/Google/Resource/DFAReporting/Campaigns/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/Campaigns/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/Campaigns/Get.hs @@ -44,7 +44,7 @@ -- 'CampaignsGet' request conforms to. type CampaignsGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "campaigns" :> @@ -54,11 +54,14 @@ -- | Gets one campaign by ID. -- -- /See:/ 'campaignsGet' smart constructor. -data CampaignsGet = CampaignsGet' +data CampaignsGet = + CampaignsGet' { _cggProFileId :: !(Textual Int64) , _cggId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'CampaignsGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Int64 -- ^ 'cggId' -> CampaignsGet campaignsGet pCggProFileId_ pCggId_ = - CampaignsGet' - { _cggProFileId = _Coerce # pCggProFileId_ - , _cggId = _Coerce # pCggId_ - } + CampaignsGet' + {_cggProFileId = _Coerce # pCggProFileId_, _cggId = _Coerce # pCggId_} + -- | User profile ID associated with this request. cggProFileId :: Lens' CampaignsGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Campaigns/Insert.hs b/gen/Network/Google/Resource/DFAReporting/Campaigns/Insert.hs --- a/gen/Network/Google/Resource/DFAReporting/Campaigns/Insert.hs +++ b/gen/Network/Google/Resource/DFAReporting/Campaigns/Insert.hs @@ -44,7 +44,7 @@ -- 'CampaignsInsert' request conforms to. type CampaignsInsertResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "campaigns" :> @@ -54,11 +54,14 @@ -- | Inserts a new campaign. -- -- /See:/ 'campaignsInsert' smart constructor. -data CampaignsInsert = CampaignsInsert' +data CampaignsInsert = + CampaignsInsert' { _camProFileId :: !(Textual Int64) , _camPayload :: !Campaign - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'CampaignsInsert' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Campaign -- ^ 'camPayload' -> CampaignsInsert campaignsInsert pCamProFileId_ pCamPayload_ = - CampaignsInsert' - { _camProFileId = _Coerce # pCamProFileId_ - , _camPayload = pCamPayload_ - } + CampaignsInsert' + {_camProFileId = _Coerce # pCamProFileId_, _camPayload = pCamPayload_} + -- | User profile ID associated with this request. camProFileId :: Lens' CampaignsInsert Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Campaigns/List.hs b/gen/Network/Google/Resource/DFAReporting/Campaigns/List.hs --- a/gen/Network/Google/Resource/DFAReporting/Campaigns/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/Campaigns/List.hs @@ -57,7 +57,7 @@ -- 'CampaignsList' request conforms to. type CampaignsListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "campaigns" :> @@ -83,7 +83,8 @@ -- paging. -- -- /See:/ 'campaignsList' smart constructor. -data CampaignsList = CampaignsList' +data CampaignsList = + CampaignsList' { _clExcludedIds :: !(Maybe [Textual Int64]) , _clSearchString :: !(Maybe Text) , _clIds :: !(Maybe [Textual Int64]) @@ -98,8 +99,10 @@ , _clAdvertiserIds :: !(Maybe [Textual Int64]) , _clArchived :: !(Maybe Bool) , _clMaxResults :: !(Textual Int32) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'CampaignsList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -135,7 +138,7 @@ :: Int64 -- ^ 'clProFileId' -> CampaignsList campaignsList pClProFileId_ = - CampaignsList' + CampaignsList' { _clExcludedIds = Nothing , _clSearchString = Nothing , _clIds = Nothing @@ -151,6 +154,7 @@ , _clArchived = Nothing , _clMaxResults = 1000 } + -- | Exclude campaigns with these IDs. clExcludedIds :: Lens' CampaignsList [Int64] diff --git a/gen/Network/Google/Resource/DFAReporting/Campaigns/Patch.hs b/gen/Network/Google/Resource/DFAReporting/Campaigns/Patch.hs --- a/gen/Network/Google/Resource/DFAReporting/Campaigns/Patch.hs +++ b/gen/Network/Google/Resource/DFAReporting/Campaigns/Patch.hs @@ -45,7 +45,7 @@ -- 'CampaignsPatch' request conforms to. type CampaignsPatchResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "campaigns" :> @@ -56,12 +56,15 @@ -- | Updates an existing campaign. This method supports patch semantics. -- -- /See:/ 'campaignsPatch' smart constructor. -data CampaignsPatch = CampaignsPatch' +data CampaignsPatch = + CampaignsPatch' { _cpProFileId :: !(Textual Int64) , _cpPayload :: !Campaign , _cpId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'CampaignsPatch' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -77,11 +80,12 @@ -> Int64 -- ^ 'cpId' -> CampaignsPatch campaignsPatch pCpProFileId_ pCpPayload_ pCpId_ = - CampaignsPatch' + CampaignsPatch' { _cpProFileId = _Coerce # pCpProFileId_ , _cpPayload = pCpPayload_ , _cpId = _Coerce # pCpId_ } + -- | User profile ID associated with this request. cpProFileId :: Lens' CampaignsPatch Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Campaigns/Update.hs b/gen/Network/Google/Resource/DFAReporting/Campaigns/Update.hs --- a/gen/Network/Google/Resource/DFAReporting/Campaigns/Update.hs +++ b/gen/Network/Google/Resource/DFAReporting/Campaigns/Update.hs @@ -44,7 +44,7 @@ -- 'CampaignsUpdate' request conforms to. type CampaignsUpdateResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "campaigns" :> @@ -54,11 +54,14 @@ -- | Updates an existing campaign. -- -- /See:/ 'campaignsUpdate' smart constructor. -data CampaignsUpdate = CampaignsUpdate' +data CampaignsUpdate = + CampaignsUpdate' { _cuProFileId :: !(Textual Int64) , _cuPayload :: !Campaign - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'CampaignsUpdate' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Campaign -- ^ 'cuPayload' -> CampaignsUpdate campaignsUpdate pCuProFileId_ pCuPayload_ = - CampaignsUpdate' - { _cuProFileId = _Coerce # pCuProFileId_ - , _cuPayload = pCuPayload_ - } + CampaignsUpdate' + {_cuProFileId = _Coerce # pCuProFileId_, _cuPayload = pCuPayload_} + -- | User profile ID associated with this request. cuProFileId :: Lens' CampaignsUpdate Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/ChangeLogs/Get.hs b/gen/Network/Google/Resource/DFAReporting/ChangeLogs/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/ChangeLogs/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/ChangeLogs/Get.hs @@ -44,7 +44,7 @@ -- 'ChangeLogsGet' request conforms to. type ChangeLogsGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "changeLogs" :> @@ -54,11 +54,14 @@ -- | Gets one change log by ID. -- -- /See:/ 'changeLogsGet' smart constructor. -data ChangeLogsGet = ChangeLogsGet' +data ChangeLogsGet = + ChangeLogsGet' { _clgProFileId :: !(Textual Int64) , _clgId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'ChangeLogsGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Int64 -- ^ 'clgId' -> ChangeLogsGet changeLogsGet pClgProFileId_ pClgId_ = - ChangeLogsGet' - { _clgProFileId = _Coerce # pClgProFileId_ - , _clgId = _Coerce # pClgId_ - } + ChangeLogsGet' + {_clgProFileId = _Coerce # pClgProFileId_, _clgId = _Coerce # pClgId_} + -- | User profile ID associated with this request. clgProFileId :: Lens' ChangeLogsGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/ChangeLogs/List.hs b/gen/Network/Google/Resource/DFAReporting/ChangeLogs/List.hs --- a/gen/Network/Google/Resource/DFAReporting/ChangeLogs/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/ChangeLogs/List.hs @@ -53,7 +53,7 @@ -- 'ChangeLogsList' request conforms to. type ChangeLogsListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "changeLogs" :> @@ -73,7 +73,8 @@ -- | Retrieves a list of change logs. This method supports paging. -- -- /See:/ 'changeLogsList' smart constructor. -data ChangeLogsList = ChangeLogsList' +data ChangeLogsList = + ChangeLogsList' { _cllUserProFileIds :: !(Maybe [Textual Int64]) , _cllObjectType :: !(Maybe ChangeLogsListObjectType) , _cllSearchString :: !(Maybe Text) @@ -85,8 +86,10 @@ , _cllPageToken :: !(Maybe Text) , _cllObjectIds :: !(Maybe [Textual Int64]) , _cllMaxResults :: !(Textual Int32) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'ChangeLogsList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -116,7 +119,7 @@ :: Int64 -- ^ 'cllProFileId' -> ChangeLogsList changeLogsList pCllProFileId_ = - ChangeLogsList' + ChangeLogsList' { _cllUserProFileIds = Nothing , _cllObjectType = Nothing , _cllSearchString = Nothing @@ -129,6 +132,7 @@ , _cllObjectIds = Nothing , _cllMaxResults = 1000 } + -- | Select only change logs with these user profile IDs. cllUserProFileIds :: Lens' ChangeLogsList [Int64] diff --git a/gen/Network/Google/Resource/DFAReporting/Cities/List.hs b/gen/Network/Google/Resource/DFAReporting/Cities/List.hs --- a/gen/Network/Google/Resource/DFAReporting/Cities/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/Cities/List.hs @@ -47,7 +47,7 @@ -- 'CitiesList' request conforms to. type CitiesListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "cities" :> @@ -61,14 +61,17 @@ -- | Retrieves a list of cities, possibly filtered. -- -- /See:/ 'citiesList' smart constructor. -data CitiesList = CitiesList' +data CitiesList = + CitiesList' { _citRegionDartIds :: !(Maybe [Textual Int64]) , _citProFileId :: !(Textual Int64) , _citNamePrefix :: !(Maybe Text) , _citCountryDartIds :: !(Maybe [Textual Int64]) , _citDartIds :: !(Maybe [Textual Int64]) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'CitiesList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -86,13 +89,14 @@ :: Int64 -- ^ 'citProFileId' -> CitiesList citiesList pCitProFileId_ = - CitiesList' + CitiesList' { _citRegionDartIds = Nothing , _citProFileId = _Coerce # pCitProFileId_ , _citNamePrefix = Nothing , _citCountryDartIds = Nothing , _citDartIds = Nothing } + -- | Select only cities from these regions. citRegionDartIds :: Lens' CitiesList [Int64] diff --git a/gen/Network/Google/Resource/DFAReporting/ConnectionTypes/Get.hs b/gen/Network/Google/Resource/DFAReporting/ConnectionTypes/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/ConnectionTypes/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/ConnectionTypes/Get.hs @@ -44,7 +44,7 @@ -- 'ConnectionTypesGet' request conforms to. type ConnectionTypesGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "connectionTypes" :> @@ -55,11 +55,14 @@ -- | Gets one connection type by ID. -- -- /See:/ 'connectionTypesGet' smart constructor. -data ConnectionTypesGet = ConnectionTypesGet' +data ConnectionTypesGet = + ConnectionTypesGet' { _ctgProFileId :: !(Textual Int64) , _ctgId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'ConnectionTypesGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> Int64 -- ^ 'ctgId' -> ConnectionTypesGet connectionTypesGet pCtgProFileId_ pCtgId_ = - ConnectionTypesGet' - { _ctgProFileId = _Coerce # pCtgProFileId_ - , _ctgId = _Coerce # pCtgId_ - } + ConnectionTypesGet' + {_ctgProFileId = _Coerce # pCtgProFileId_, _ctgId = _Coerce # pCtgId_} + -- | User profile ID associated with this request. ctgProFileId :: Lens' ConnectionTypesGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/ConnectionTypes/List.hs b/gen/Network/Google/Resource/DFAReporting/ConnectionTypes/List.hs --- a/gen/Network/Google/Resource/DFAReporting/ConnectionTypes/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/ConnectionTypes/List.hs @@ -43,7 +43,7 @@ -- 'ConnectionTypesList' request conforms to. type ConnectionTypesListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "connectionTypes" :> @@ -53,10 +53,13 @@ -- | Retrieves a list of connection types. -- -- /See:/ 'connectionTypesList' smart constructor. -newtype ConnectionTypesList = ConnectionTypesList' +newtype ConnectionTypesList = + ConnectionTypesList' { _ctlProFileId :: Textual Int64 - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'ConnectionTypesList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -66,9 +69,8 @@ :: Int64 -- ^ 'ctlProFileId' -> ConnectionTypesList connectionTypesList pCtlProFileId_ = - ConnectionTypesList' - { _ctlProFileId = _Coerce # pCtlProFileId_ - } + ConnectionTypesList' {_ctlProFileId = _Coerce # pCtlProFileId_} + -- | User profile ID associated with this request. ctlProFileId :: Lens' ConnectionTypesList Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/ContentCategories/Delete.hs b/gen/Network/Google/Resource/DFAReporting/ContentCategories/Delete.hs --- a/gen/Network/Google/Resource/DFAReporting/ContentCategories/Delete.hs +++ b/gen/Network/Google/Resource/DFAReporting/ContentCategories/Delete.hs @@ -44,7 +44,7 @@ -- 'ContentCategoriesDelete' request conforms to. type ContentCategoriesDeleteResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "contentCategories" :> @@ -54,11 +54,14 @@ -- | Deletes an existing content category. -- -- /See:/ 'contentCategoriesDelete' smart constructor. -data ContentCategoriesDelete = ContentCategoriesDelete' +data ContentCategoriesDelete = + ContentCategoriesDelete' { _ccdProFileId :: !(Textual Int64) , _ccdId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'ContentCategoriesDelete' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Int64 -- ^ 'ccdId' -> ContentCategoriesDelete contentCategoriesDelete pCcdProFileId_ pCcdId_ = - ContentCategoriesDelete' - { _ccdProFileId = _Coerce # pCcdProFileId_ - , _ccdId = _Coerce # pCcdId_ - } + ContentCategoriesDelete' + {_ccdProFileId = _Coerce # pCcdProFileId_, _ccdId = _Coerce # pCcdId_} + -- | User profile ID associated with this request. ccdProFileId :: Lens' ContentCategoriesDelete Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/ContentCategories/Get.hs b/gen/Network/Google/Resource/DFAReporting/ContentCategories/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/ContentCategories/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/ContentCategories/Get.hs @@ -44,7 +44,7 @@ -- 'ContentCategoriesGet' request conforms to. type ContentCategoriesGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "contentCategories" :> @@ -55,11 +55,14 @@ -- | Gets one content category by ID. -- -- /See:/ 'contentCategoriesGet' smart constructor. -data ContentCategoriesGet = ContentCategoriesGet' +data ContentCategoriesGet = + ContentCategoriesGet' { _ccgProFileId :: !(Textual Int64) , _ccgId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'ContentCategoriesGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> Int64 -- ^ 'ccgId' -> ContentCategoriesGet contentCategoriesGet pCcgProFileId_ pCcgId_ = - ContentCategoriesGet' - { _ccgProFileId = _Coerce # pCcgProFileId_ - , _ccgId = _Coerce # pCcgId_ - } + ContentCategoriesGet' + {_ccgProFileId = _Coerce # pCcgProFileId_, _ccgId = _Coerce # pCcgId_} + -- | User profile ID associated with this request. ccgProFileId :: Lens' ContentCategoriesGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/ContentCategories/Insert.hs b/gen/Network/Google/Resource/DFAReporting/ContentCategories/Insert.hs --- a/gen/Network/Google/Resource/DFAReporting/ContentCategories/Insert.hs +++ b/gen/Network/Google/Resource/DFAReporting/ContentCategories/Insert.hs @@ -44,7 +44,7 @@ -- 'ContentCategoriesInsert' request conforms to. type ContentCategoriesInsertResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "contentCategories" :> @@ -55,11 +55,14 @@ -- | Inserts a new content category. -- -- /See:/ 'contentCategoriesInsert' smart constructor. -data ContentCategoriesInsert = ContentCategoriesInsert' +data ContentCategoriesInsert = + ContentCategoriesInsert' { _cciProFileId :: !(Textual Int64) , _cciPayload :: !ContentCategory - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'ContentCategoriesInsert' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> ContentCategory -- ^ 'cciPayload' -> ContentCategoriesInsert contentCategoriesInsert pCciProFileId_ pCciPayload_ = - ContentCategoriesInsert' - { _cciProFileId = _Coerce # pCciProFileId_ - , _cciPayload = pCciPayload_ - } + ContentCategoriesInsert' + {_cciProFileId = _Coerce # pCciProFileId_, _cciPayload = pCciPayload_} + -- | User profile ID associated with this request. cciProFileId :: Lens' ContentCategoriesInsert Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/ContentCategories/List.hs b/gen/Network/Google/Resource/DFAReporting/ContentCategories/List.hs --- a/gen/Network/Google/Resource/DFAReporting/ContentCategories/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/ContentCategories/List.hs @@ -50,7 +50,7 @@ -- 'ContentCategoriesList' request conforms to. type ContentCategoriesListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "contentCategories" :> @@ -69,7 +69,8 @@ -- supports paging. -- -- /See:/ 'contentCategoriesList' smart constructor. -data ContentCategoriesList = ContentCategoriesList' +data ContentCategoriesList = + ContentCategoriesList' { _cclSearchString :: !(Maybe Text) , _cclIds :: !(Maybe [Textual Int64]) , _cclProFileId :: !(Textual Int64) @@ -77,8 +78,10 @@ , _cclPageToken :: !(Maybe Text) , _cclSortField :: !ContentCategoriesListSortField , _cclMaxResults :: !(Textual Int32) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'ContentCategoriesList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -100,7 +103,7 @@ :: Int64 -- ^ 'cclProFileId' -> ContentCategoriesList contentCategoriesList pCclProFileId_ = - ContentCategoriesList' + ContentCategoriesList' { _cclSearchString = Nothing , _cclIds = Nothing , _cclProFileId = _Coerce # pCclProFileId_ @@ -109,6 +112,7 @@ , _cclSortField = CCLSFID , _cclMaxResults = 1000 } + -- | Allows searching for objects by name or ID. Wildcards (*) are allowed. -- For example, \"contentcategory*2015\" will return objects with names diff --git a/gen/Network/Google/Resource/DFAReporting/ContentCategories/Patch.hs b/gen/Network/Google/Resource/DFAReporting/ContentCategories/Patch.hs --- a/gen/Network/Google/Resource/DFAReporting/ContentCategories/Patch.hs +++ b/gen/Network/Google/Resource/DFAReporting/ContentCategories/Patch.hs @@ -46,7 +46,7 @@ -- 'ContentCategoriesPatch' request conforms to. type ContentCategoriesPatchResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "contentCategories" :> @@ -59,12 +59,15 @@ -- semantics. -- -- /See:/ 'contentCategoriesPatch' smart constructor. -data ContentCategoriesPatch = ContentCategoriesPatch' +data ContentCategoriesPatch = + ContentCategoriesPatch' { _ccpProFileId :: !(Textual Int64) , _ccpPayload :: !ContentCategory , _ccpId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'ContentCategoriesPatch' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -80,11 +83,12 @@ -> Int64 -- ^ 'ccpId' -> ContentCategoriesPatch contentCategoriesPatch pCcpProFileId_ pCcpPayload_ pCcpId_ = - ContentCategoriesPatch' + ContentCategoriesPatch' { _ccpProFileId = _Coerce # pCcpProFileId_ , _ccpPayload = pCcpPayload_ , _ccpId = _Coerce # pCcpId_ } + -- | User profile ID associated with this request. ccpProFileId :: Lens' ContentCategoriesPatch Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/ContentCategories/Update.hs b/gen/Network/Google/Resource/DFAReporting/ContentCategories/Update.hs --- a/gen/Network/Google/Resource/DFAReporting/ContentCategories/Update.hs +++ b/gen/Network/Google/Resource/DFAReporting/ContentCategories/Update.hs @@ -44,7 +44,7 @@ -- 'ContentCategoriesUpdate' request conforms to. type ContentCategoriesUpdateResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "contentCategories" :> @@ -55,11 +55,14 @@ -- | Updates an existing content category. -- -- /See:/ 'contentCategoriesUpdate' smart constructor. -data ContentCategoriesUpdate = ContentCategoriesUpdate' +data ContentCategoriesUpdate = + ContentCategoriesUpdate' { _ccuProFileId :: !(Textual Int64) , _ccuPayload :: !ContentCategory - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'ContentCategoriesUpdate' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> ContentCategory -- ^ 'ccuPayload' -> ContentCategoriesUpdate contentCategoriesUpdate pCcuProFileId_ pCcuPayload_ = - ContentCategoriesUpdate' - { _ccuProFileId = _Coerce # pCcuProFileId_ - , _ccuPayload = pCcuPayload_ - } + ContentCategoriesUpdate' + {_ccuProFileId = _Coerce # pCcuProFileId_, _ccuPayload = pCcuPayload_} + -- | User profile ID associated with this request. ccuProFileId :: Lens' ContentCategoriesUpdate Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Conversions/Batchinsert.hs b/gen/Network/Google/Resource/DFAReporting/Conversions/Batchinsert.hs --- a/gen/Network/Google/Resource/DFAReporting/Conversions/Batchinsert.hs +++ b/gen/Network/Google/Resource/DFAReporting/Conversions/Batchinsert.hs @@ -44,7 +44,7 @@ -- 'ConversionsBatchinsert' request conforms to. type ConversionsBatchinsertResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "conversions" :> @@ -56,11 +56,14 @@ -- | Inserts conversions. -- -- /See:/ 'conversionsBatchinsert' smart constructor. -data ConversionsBatchinsert = ConversionsBatchinsert' +data ConversionsBatchinsert = + ConversionsBatchinsert' { _cbProFileId :: !(Textual Int64) , _cbPayload :: !ConversionsBatchInsertRequest - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'ConversionsBatchinsert' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -73,10 +76,9 @@ -> ConversionsBatchInsertRequest -- ^ 'cbPayload' -> ConversionsBatchinsert conversionsBatchinsert pCbProFileId_ pCbPayload_ = - ConversionsBatchinsert' - { _cbProFileId = _Coerce # pCbProFileId_ - , _cbPayload = pCbPayload_ - } + ConversionsBatchinsert' + {_cbProFileId = _Coerce # pCbProFileId_, _cbPayload = pCbPayload_} + -- | User profile ID associated with this request. cbProFileId :: Lens' ConversionsBatchinsert Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Conversions/Batchupdate.hs b/gen/Network/Google/Resource/DFAReporting/Conversions/Batchupdate.hs --- a/gen/Network/Google/Resource/DFAReporting/Conversions/Batchupdate.hs +++ b/gen/Network/Google/Resource/DFAReporting/Conversions/Batchupdate.hs @@ -44,7 +44,7 @@ -- 'ConversionsBatchupdate' request conforms to. type ConversionsBatchupdateResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "conversions" :> @@ -56,11 +56,14 @@ -- | Updates existing conversions. -- -- /See:/ 'conversionsBatchupdate' smart constructor. -data ConversionsBatchupdate = ConversionsBatchupdate' +data ConversionsBatchupdate = + ConversionsBatchupdate' { _conProFileId :: !(Textual Int64) , _conPayload :: !ConversionsBatchUpdateRequest - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'ConversionsBatchupdate' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -73,10 +76,9 @@ -> ConversionsBatchUpdateRequest -- ^ 'conPayload' -> ConversionsBatchupdate conversionsBatchupdate pConProFileId_ pConPayload_ = - ConversionsBatchupdate' - { _conProFileId = _Coerce # pConProFileId_ - , _conPayload = pConPayload_ - } + ConversionsBatchupdate' + {_conProFileId = _Coerce # pConProFileId_, _conPayload = pConPayload_} + -- | User profile ID associated with this request. conProFileId :: Lens' ConversionsBatchupdate Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Countries/Get.hs b/gen/Network/Google/Resource/DFAReporting/Countries/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/Countries/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/Countries/Get.hs @@ -44,7 +44,7 @@ -- 'CountriesGet' request conforms to. type CountriesGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "countries" :> @@ -54,11 +54,14 @@ -- | Gets one country by ID. -- -- /See:/ 'countriesGet' smart constructor. -data CountriesGet = CountriesGet' +data CountriesGet = + CountriesGet' { _cgProFileId :: !(Textual Int64) , _cgDartId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'CountriesGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Int64 -- ^ 'cgDartId' -> CountriesGet countriesGet pCgProFileId_ pCgDartId_ = - CountriesGet' - { _cgProFileId = _Coerce # pCgProFileId_ - , _cgDartId = _Coerce # pCgDartId_ - } + CountriesGet' + {_cgProFileId = _Coerce # pCgProFileId_, _cgDartId = _Coerce # pCgDartId_} + -- | User profile ID associated with this request. cgProFileId :: Lens' CountriesGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Countries/List.hs b/gen/Network/Google/Resource/DFAReporting/Countries/List.hs --- a/gen/Network/Google/Resource/DFAReporting/Countries/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/Countries/List.hs @@ -43,7 +43,7 @@ -- 'CountriesList' request conforms to. type CountriesListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "countries" :> @@ -53,10 +53,13 @@ -- | Retrieves a list of countries. -- -- /See:/ 'countriesList' smart constructor. -newtype CountriesList = CountriesList' +newtype CountriesList = + CountriesList' { _couProFileId :: Textual Int64 - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'CountriesList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -66,9 +69,8 @@ :: Int64 -- ^ 'couProFileId' -> CountriesList countriesList pCouProFileId_ = - CountriesList' - { _couProFileId = _Coerce # pCouProFileId_ - } + CountriesList' {_couProFileId = _Coerce # pCouProFileId_} + -- | User profile ID associated with this request. couProFileId :: Lens' CountriesList Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/CreativeAssets/Insert.hs b/gen/Network/Google/Resource/DFAReporting/CreativeAssets/Insert.hs --- a/gen/Network/Google/Resource/DFAReporting/CreativeAssets/Insert.hs +++ b/gen/Network/Google/Resource/DFAReporting/CreativeAssets/Insert.hs @@ -45,7 +45,7 @@ -- 'CreativeAssetsInsert' request conforms to. type CreativeAssetsInsertResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "creativeAssets" :> @@ -57,7 +57,7 @@ :<|> "upload" :> "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "creativeAssets" :> @@ -71,12 +71,15 @@ -- | Inserts a new creative asset. -- -- /See:/ 'creativeAssetsInsert' smart constructor. -data CreativeAssetsInsert = CreativeAssetsInsert' +data CreativeAssetsInsert = + CreativeAssetsInsert' { _caiAdvertiserId :: !(Textual Int64) , _caiProFileId :: !(Textual Int64) , _caiPayload :: !CreativeAssetMetadata - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'CreativeAssetsInsert' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -92,12 +95,13 @@ -> CreativeAssetMetadata -- ^ 'caiPayload' -> CreativeAssetsInsert creativeAssetsInsert pCaiAdvertiserId_ pCaiProFileId_ pCaiPayload_ = - CreativeAssetsInsert' + CreativeAssetsInsert' { _caiAdvertiserId = _Coerce # pCaiAdvertiserId_ , _caiProFileId = _Coerce # pCaiProFileId_ , _caiPayload = pCaiPayload_ } + -- | Advertiser ID of this creative. This is a required field. caiAdvertiserId :: Lens' CreativeAssetsInsert Int64 caiAdvertiserId @@ -130,7 +134,8 @@ mempty instance GoogleRequest - (MediaUpload CreativeAssetsInsert) where + (MediaUpload CreativeAssetsInsert) + where type Rs (MediaUpload CreativeAssetsInsert) = CreativeAssetMetadata type Scopes (MediaUpload CreativeAssetsInsert) = diff --git a/gen/Network/Google/Resource/DFAReporting/CreativeFieldValues/Delete.hs b/gen/Network/Google/Resource/DFAReporting/CreativeFieldValues/Delete.hs --- a/gen/Network/Google/Resource/DFAReporting/CreativeFieldValues/Delete.hs +++ b/gen/Network/Google/Resource/DFAReporting/CreativeFieldValues/Delete.hs @@ -45,7 +45,7 @@ -- 'CreativeFieldValuesDelete' request conforms to. type CreativeFieldValuesDeleteResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "creativeFields" :> @@ -57,12 +57,15 @@ -- | Deletes an existing creative field value. -- -- /See:/ 'creativeFieldValuesDelete' smart constructor. -data CreativeFieldValuesDelete = CreativeFieldValuesDelete' +data CreativeFieldValuesDelete = + CreativeFieldValuesDelete' { _cfvdCreativeFieldId :: !(Textual Int64) , _cfvdProFileId :: !(Textual Int64) , _cfvdId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'CreativeFieldValuesDelete' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -78,11 +81,12 @@ -> Int64 -- ^ 'cfvdId' -> CreativeFieldValuesDelete creativeFieldValuesDelete pCfvdCreativeFieldId_ pCfvdProFileId_ pCfvdId_ = - CreativeFieldValuesDelete' + CreativeFieldValuesDelete' { _cfvdCreativeFieldId = _Coerce # pCfvdCreativeFieldId_ , _cfvdProFileId = _Coerce # pCfvdProFileId_ , _cfvdId = _Coerce # pCfvdId_ } + -- | Creative field ID for this creative field value. cfvdCreativeFieldId :: Lens' CreativeFieldValuesDelete Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/CreativeFieldValues/Get.hs b/gen/Network/Google/Resource/DFAReporting/CreativeFieldValues/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/CreativeFieldValues/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/CreativeFieldValues/Get.hs @@ -45,7 +45,7 @@ -- 'CreativeFieldValuesGet' request conforms to. type CreativeFieldValuesGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "creativeFields" :> @@ -58,12 +58,15 @@ -- | Gets one creative field value by ID. -- -- /See:/ 'creativeFieldValuesGet' smart constructor. -data CreativeFieldValuesGet = CreativeFieldValuesGet' +data CreativeFieldValuesGet = + CreativeFieldValuesGet' { _cfvgCreativeFieldId :: !(Textual Int64) , _cfvgProFileId :: !(Textual Int64) , _cfvgId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'CreativeFieldValuesGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -79,11 +82,12 @@ -> Int64 -- ^ 'cfvgId' -> CreativeFieldValuesGet creativeFieldValuesGet pCfvgCreativeFieldId_ pCfvgProFileId_ pCfvgId_ = - CreativeFieldValuesGet' + CreativeFieldValuesGet' { _cfvgCreativeFieldId = _Coerce # pCfvgCreativeFieldId_ , _cfvgProFileId = _Coerce # pCfvgProFileId_ , _cfvgId = _Coerce # pCfvgId_ } + -- | Creative field ID for this creative field value. cfvgCreativeFieldId :: Lens' CreativeFieldValuesGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/CreativeFieldValues/Insert.hs b/gen/Network/Google/Resource/DFAReporting/CreativeFieldValues/Insert.hs --- a/gen/Network/Google/Resource/DFAReporting/CreativeFieldValues/Insert.hs +++ b/gen/Network/Google/Resource/DFAReporting/CreativeFieldValues/Insert.hs @@ -45,7 +45,7 @@ -- 'CreativeFieldValuesInsert' request conforms to. type CreativeFieldValuesInsertResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "creativeFields" :> @@ -58,12 +58,15 @@ -- | Inserts a new creative field value. -- -- /See:/ 'creativeFieldValuesInsert' smart constructor. -data CreativeFieldValuesInsert = CreativeFieldValuesInsert' +data CreativeFieldValuesInsert = + CreativeFieldValuesInsert' { _cfviCreativeFieldId :: !(Textual Int64) , _cfviProFileId :: !(Textual Int64) , _cfviPayload :: !CreativeFieldValue - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'CreativeFieldValuesInsert' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -79,11 +82,12 @@ -> CreativeFieldValue -- ^ 'cfviPayload' -> CreativeFieldValuesInsert creativeFieldValuesInsert pCfviCreativeFieldId_ pCfviProFileId_ pCfviPayload_ = - CreativeFieldValuesInsert' + CreativeFieldValuesInsert' { _cfviCreativeFieldId = _Coerce # pCfviCreativeFieldId_ , _cfviProFileId = _Coerce # pCfviProFileId_ , _cfviPayload = pCfviPayload_ } + -- | Creative field ID for this creative field value. cfviCreativeFieldId :: Lens' CreativeFieldValuesInsert Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/CreativeFieldValues/List.hs b/gen/Network/Google/Resource/DFAReporting/CreativeFieldValues/List.hs --- a/gen/Network/Google/Resource/DFAReporting/CreativeFieldValues/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/CreativeFieldValues/List.hs @@ -51,7 +51,7 @@ -- 'CreativeFieldValuesList' request conforms to. type CreativeFieldValuesListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "creativeFields" :> @@ -74,7 +74,8 @@ -- method supports paging. -- -- /See:/ 'creativeFieldValuesList' smart constructor. -data CreativeFieldValuesList = CreativeFieldValuesList' +data CreativeFieldValuesList = + CreativeFieldValuesList' { _cfvlCreativeFieldId :: !(Textual Int64) , _cfvlSearchString :: !(Maybe Text) , _cfvlIds :: !(Maybe [Textual Int64]) @@ -83,8 +84,10 @@ , _cfvlPageToken :: !(Maybe Text) , _cfvlSortField :: !CreativeFieldValuesListSortField , _cfvlMaxResults :: !(Textual Int32) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'CreativeFieldValuesList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -109,7 +112,7 @@ -> Int64 -- ^ 'cfvlProFileId' -> CreativeFieldValuesList creativeFieldValuesList pCfvlCreativeFieldId_ pCfvlProFileId_ = - CreativeFieldValuesList' + CreativeFieldValuesList' { _cfvlCreativeFieldId = _Coerce # pCfvlCreativeFieldId_ , _cfvlSearchString = Nothing , _cfvlIds = Nothing @@ -119,6 +122,7 @@ , _cfvlSortField = CFVLSFID , _cfvlMaxResults = 1000 } + -- | Creative field ID for this creative field value. cfvlCreativeFieldId :: Lens' CreativeFieldValuesList Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/CreativeFieldValues/Patch.hs b/gen/Network/Google/Resource/DFAReporting/CreativeFieldValues/Patch.hs --- a/gen/Network/Google/Resource/DFAReporting/CreativeFieldValues/Patch.hs +++ b/gen/Network/Google/Resource/DFAReporting/CreativeFieldValues/Patch.hs @@ -47,7 +47,7 @@ -- 'CreativeFieldValuesPatch' request conforms to. type CreativeFieldValuesPatchResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "creativeFields" :> @@ -62,13 +62,16 @@ -- semantics. -- -- /See:/ 'creativeFieldValuesPatch' smart constructor. -data CreativeFieldValuesPatch = CreativeFieldValuesPatch' +data CreativeFieldValuesPatch = + CreativeFieldValuesPatch' { _cfvpCreativeFieldId :: !(Textual Int64) , _cfvpProFileId :: !(Textual Int64) , _cfvpPayload :: !CreativeFieldValue , _cfvpId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'CreativeFieldValuesPatch' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -87,12 +90,13 @@ -> Int64 -- ^ 'cfvpId' -> CreativeFieldValuesPatch creativeFieldValuesPatch pCfvpCreativeFieldId_ pCfvpProFileId_ pCfvpPayload_ pCfvpId_ = - CreativeFieldValuesPatch' + CreativeFieldValuesPatch' { _cfvpCreativeFieldId = _Coerce # pCfvpCreativeFieldId_ , _cfvpProFileId = _Coerce # pCfvpProFileId_ , _cfvpPayload = pCfvpPayload_ , _cfvpId = _Coerce # pCfvpId_ } + -- | Creative field ID for this creative field value. cfvpCreativeFieldId :: Lens' CreativeFieldValuesPatch Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/CreativeFieldValues/Update.hs b/gen/Network/Google/Resource/DFAReporting/CreativeFieldValues/Update.hs --- a/gen/Network/Google/Resource/DFAReporting/CreativeFieldValues/Update.hs +++ b/gen/Network/Google/Resource/DFAReporting/CreativeFieldValues/Update.hs @@ -45,7 +45,7 @@ -- 'CreativeFieldValuesUpdate' request conforms to. type CreativeFieldValuesUpdateResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "creativeFields" :> @@ -58,12 +58,15 @@ -- | Updates an existing creative field value. -- -- /See:/ 'creativeFieldValuesUpdate' smart constructor. -data CreativeFieldValuesUpdate = CreativeFieldValuesUpdate' +data CreativeFieldValuesUpdate = + CreativeFieldValuesUpdate' { _cfvuCreativeFieldId :: !(Textual Int64) , _cfvuProFileId :: !(Textual Int64) , _cfvuPayload :: !CreativeFieldValue - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'CreativeFieldValuesUpdate' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -79,11 +82,12 @@ -> CreativeFieldValue -- ^ 'cfvuPayload' -> CreativeFieldValuesUpdate creativeFieldValuesUpdate pCfvuCreativeFieldId_ pCfvuProFileId_ pCfvuPayload_ = - CreativeFieldValuesUpdate' + CreativeFieldValuesUpdate' { _cfvuCreativeFieldId = _Coerce # pCfvuCreativeFieldId_ , _cfvuProFileId = _Coerce # pCfvuProFileId_ , _cfvuPayload = pCfvuPayload_ } + -- | Creative field ID for this creative field value. cfvuCreativeFieldId :: Lens' CreativeFieldValuesUpdate Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/CreativeFields/Delete.hs b/gen/Network/Google/Resource/DFAReporting/CreativeFields/Delete.hs --- a/gen/Network/Google/Resource/DFAReporting/CreativeFields/Delete.hs +++ b/gen/Network/Google/Resource/DFAReporting/CreativeFields/Delete.hs @@ -44,7 +44,7 @@ -- 'CreativeFieldsDelete' request conforms to. type CreativeFieldsDeleteResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "creativeFields" :> @@ -54,11 +54,14 @@ -- | Deletes an existing creative field. -- -- /See:/ 'creativeFieldsDelete' smart constructor. -data CreativeFieldsDelete = CreativeFieldsDelete' +data CreativeFieldsDelete = + CreativeFieldsDelete' { _cfdProFileId :: !(Textual Int64) , _cfdId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'CreativeFieldsDelete' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Int64 -- ^ 'cfdId' -> CreativeFieldsDelete creativeFieldsDelete pCfdProFileId_ pCfdId_ = - CreativeFieldsDelete' - { _cfdProFileId = _Coerce # pCfdProFileId_ - , _cfdId = _Coerce # pCfdId_ - } + CreativeFieldsDelete' + {_cfdProFileId = _Coerce # pCfdProFileId_, _cfdId = _Coerce # pCfdId_} + -- | User profile ID associated with this request. cfdProFileId :: Lens' CreativeFieldsDelete Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/CreativeFields/Get.hs b/gen/Network/Google/Resource/DFAReporting/CreativeFields/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/CreativeFields/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/CreativeFields/Get.hs @@ -44,7 +44,7 @@ -- 'CreativeFieldsGet' request conforms to. type CreativeFieldsGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "creativeFields" :> @@ -54,11 +54,14 @@ -- | Gets one creative field by ID. -- -- /See:/ 'creativeFieldsGet' smart constructor. -data CreativeFieldsGet = CreativeFieldsGet' +data CreativeFieldsGet = + CreativeFieldsGet' { _cfgProFileId :: !(Textual Int64) , _cfgId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'CreativeFieldsGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Int64 -- ^ 'cfgId' -> CreativeFieldsGet creativeFieldsGet pCfgProFileId_ pCfgId_ = - CreativeFieldsGet' - { _cfgProFileId = _Coerce # pCfgProFileId_ - , _cfgId = _Coerce # pCfgId_ - } + CreativeFieldsGet' + {_cfgProFileId = _Coerce # pCfgProFileId_, _cfgId = _Coerce # pCfgId_} + -- | User profile ID associated with this request. cfgProFileId :: Lens' CreativeFieldsGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/CreativeFields/Insert.hs b/gen/Network/Google/Resource/DFAReporting/CreativeFields/Insert.hs --- a/gen/Network/Google/Resource/DFAReporting/CreativeFields/Insert.hs +++ b/gen/Network/Google/Resource/DFAReporting/CreativeFields/Insert.hs @@ -44,7 +44,7 @@ -- 'CreativeFieldsInsert' request conforms to. type CreativeFieldsInsertResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "creativeFields" :> @@ -55,11 +55,14 @@ -- | Inserts a new creative field. -- -- /See:/ 'creativeFieldsInsert' smart constructor. -data CreativeFieldsInsert = CreativeFieldsInsert' +data CreativeFieldsInsert = + CreativeFieldsInsert' { _cfiProFileId :: !(Textual Int64) , _cfiPayload :: !CreativeField - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'CreativeFieldsInsert' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> CreativeField -- ^ 'cfiPayload' -> CreativeFieldsInsert creativeFieldsInsert pCfiProFileId_ pCfiPayload_ = - CreativeFieldsInsert' - { _cfiProFileId = _Coerce # pCfiProFileId_ - , _cfiPayload = pCfiPayload_ - } + CreativeFieldsInsert' + {_cfiProFileId = _Coerce # pCfiProFileId_, _cfiPayload = pCfiPayload_} + -- | User profile ID associated with this request. cfiProFileId :: Lens' CreativeFieldsInsert Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/CreativeFields/List.hs b/gen/Network/Google/Resource/DFAReporting/CreativeFields/List.hs --- a/gen/Network/Google/Resource/DFAReporting/CreativeFields/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/CreativeFields/List.hs @@ -51,7 +51,7 @@ -- 'CreativeFieldsList' request conforms to. type CreativeFieldsListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "creativeFields" :> @@ -69,7 +69,8 @@ -- supports paging. -- -- /See:/ 'creativeFieldsList' smart constructor. -data CreativeFieldsList = CreativeFieldsList' +data CreativeFieldsList = + CreativeFieldsList' { _cflSearchString :: !(Maybe Text) , _cflIds :: !(Maybe [Textual Int64]) , _cflProFileId :: !(Textual Int64) @@ -78,8 +79,10 @@ , _cflSortField :: !CreativeFieldsListSortField , _cflAdvertiserIds :: !(Maybe [Textual Int64]) , _cflMaxResults :: !(Textual Int32) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'CreativeFieldsList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -103,7 +106,7 @@ :: Int64 -- ^ 'cflProFileId' -> CreativeFieldsList creativeFieldsList pCflProFileId_ = - CreativeFieldsList' + CreativeFieldsList' { _cflSearchString = Nothing , _cflIds = Nothing , _cflProFileId = _Coerce # pCflProFileId_ @@ -113,6 +116,7 @@ , _cflAdvertiserIds = Nothing , _cflMaxResults = 1000 } + -- | Allows searching for creative fields by name or ID. Wildcards (*) are -- allowed. For example, \"creativefield*2015\" will return creative fields diff --git a/gen/Network/Google/Resource/DFAReporting/CreativeFields/Patch.hs b/gen/Network/Google/Resource/DFAReporting/CreativeFields/Patch.hs --- a/gen/Network/Google/Resource/DFAReporting/CreativeFields/Patch.hs +++ b/gen/Network/Google/Resource/DFAReporting/CreativeFields/Patch.hs @@ -46,7 +46,7 @@ -- 'CreativeFieldsPatch' request conforms to. type CreativeFieldsPatchResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "creativeFields" :> @@ -59,12 +59,15 @@ -- semantics. -- -- /See:/ 'creativeFieldsPatch' smart constructor. -data CreativeFieldsPatch = CreativeFieldsPatch' +data CreativeFieldsPatch = + CreativeFieldsPatch' { _cfpProFileId :: !(Textual Int64) , _cfpPayload :: !CreativeField , _cfpId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'CreativeFieldsPatch' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -80,11 +83,12 @@ -> Int64 -- ^ 'cfpId' -> CreativeFieldsPatch creativeFieldsPatch pCfpProFileId_ pCfpPayload_ pCfpId_ = - CreativeFieldsPatch' + CreativeFieldsPatch' { _cfpProFileId = _Coerce # pCfpProFileId_ , _cfpPayload = pCfpPayload_ , _cfpId = _Coerce # pCfpId_ } + -- | User profile ID associated with this request. cfpProFileId :: Lens' CreativeFieldsPatch Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/CreativeFields/Update.hs b/gen/Network/Google/Resource/DFAReporting/CreativeFields/Update.hs --- a/gen/Network/Google/Resource/DFAReporting/CreativeFields/Update.hs +++ b/gen/Network/Google/Resource/DFAReporting/CreativeFields/Update.hs @@ -44,7 +44,7 @@ -- 'CreativeFieldsUpdate' request conforms to. type CreativeFieldsUpdateResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "creativeFields" :> @@ -55,11 +55,14 @@ -- | Updates an existing creative field. -- -- /See:/ 'creativeFieldsUpdate' smart constructor. -data CreativeFieldsUpdate = CreativeFieldsUpdate' +data CreativeFieldsUpdate = + CreativeFieldsUpdate' { _cfuProFileId :: !(Textual Int64) , _cfuPayload :: !CreativeField - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'CreativeFieldsUpdate' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> CreativeField -- ^ 'cfuPayload' -> CreativeFieldsUpdate creativeFieldsUpdate pCfuProFileId_ pCfuPayload_ = - CreativeFieldsUpdate' - { _cfuProFileId = _Coerce # pCfuProFileId_ - , _cfuPayload = pCfuPayload_ - } + CreativeFieldsUpdate' + {_cfuProFileId = _Coerce # pCfuProFileId_, _cfuPayload = pCfuPayload_} + -- | User profile ID associated with this request. cfuProFileId :: Lens' CreativeFieldsUpdate Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/CreativeGroups/Get.hs b/gen/Network/Google/Resource/DFAReporting/CreativeGroups/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/CreativeGroups/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/CreativeGroups/Get.hs @@ -44,7 +44,7 @@ -- 'CreativeGroupsGet' request conforms to. type CreativeGroupsGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "creativeGroups" :> @@ -54,11 +54,14 @@ -- | Gets one creative group by ID. -- -- /See:/ 'creativeGroupsGet' smart constructor. -data CreativeGroupsGet = CreativeGroupsGet' +data CreativeGroupsGet = + CreativeGroupsGet' { _cgggProFileId :: !(Textual Int64) , _cgggId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'CreativeGroupsGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Int64 -- ^ 'cgggId' -> CreativeGroupsGet creativeGroupsGet pCgggProFileId_ pCgggId_ = - CreativeGroupsGet' - { _cgggProFileId = _Coerce # pCgggProFileId_ - , _cgggId = _Coerce # pCgggId_ - } + CreativeGroupsGet' + {_cgggProFileId = _Coerce # pCgggProFileId_, _cgggId = _Coerce # pCgggId_} + -- | User profile ID associated with this request. cgggProFileId :: Lens' CreativeGroupsGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/CreativeGroups/Insert.hs b/gen/Network/Google/Resource/DFAReporting/CreativeGroups/Insert.hs --- a/gen/Network/Google/Resource/DFAReporting/CreativeGroups/Insert.hs +++ b/gen/Network/Google/Resource/DFAReporting/CreativeGroups/Insert.hs @@ -44,7 +44,7 @@ -- 'CreativeGroupsInsert' request conforms to. type CreativeGroupsInsertResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "creativeGroups" :> @@ -55,11 +55,14 @@ -- | Inserts a new creative group. -- -- /See:/ 'creativeGroupsInsert' smart constructor. -data CreativeGroupsInsert = CreativeGroupsInsert' +data CreativeGroupsInsert = + CreativeGroupsInsert' { _cgiProFileId :: !(Textual Int64) , _cgiPayload :: !CreativeGroup - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'CreativeGroupsInsert' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> CreativeGroup -- ^ 'cgiPayload' -> CreativeGroupsInsert creativeGroupsInsert pCgiProFileId_ pCgiPayload_ = - CreativeGroupsInsert' - { _cgiProFileId = _Coerce # pCgiProFileId_ - , _cgiPayload = pCgiPayload_ - } + CreativeGroupsInsert' + {_cgiProFileId = _Coerce # pCgiProFileId_, _cgiPayload = pCgiPayload_} + -- | User profile ID associated with this request. cgiProFileId :: Lens' CreativeGroupsInsert Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/CreativeGroups/List.hs b/gen/Network/Google/Resource/DFAReporting/CreativeGroups/List.hs --- a/gen/Network/Google/Resource/DFAReporting/CreativeGroups/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/CreativeGroups/List.hs @@ -52,7 +52,7 @@ -- 'CreativeGroupsList' request conforms to. type CreativeGroupsListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "creativeGroups" :> @@ -71,7 +71,8 @@ -- supports paging. -- -- /See:/ 'creativeGroupsList' smart constructor. -data CreativeGroupsList = CreativeGroupsList' +data CreativeGroupsList = + CreativeGroupsList' { _cglSearchString :: !(Maybe Text) , _cglIds :: !(Maybe [Textual Int64]) , _cglProFileId :: !(Textual Int64) @@ -81,8 +82,10 @@ , _cglSortField :: !CreativeGroupsListSortField , _cglAdvertiserIds :: !(Maybe [Textual Int64]) , _cglMaxResults :: !(Textual Int32) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'CreativeGroupsList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -108,7 +111,7 @@ :: Int64 -- ^ 'cglProFileId' -> CreativeGroupsList creativeGroupsList pCglProFileId_ = - CreativeGroupsList' + CreativeGroupsList' { _cglSearchString = Nothing , _cglIds = Nothing , _cglProFileId = _Coerce # pCglProFileId_ @@ -119,6 +122,7 @@ , _cglAdvertiserIds = Nothing , _cglMaxResults = 1000 } + -- | Allows searching for creative groups by name or ID. Wildcards (*) are -- allowed. For example, \"creativegroup*2015\" will return creative groups diff --git a/gen/Network/Google/Resource/DFAReporting/CreativeGroups/Patch.hs b/gen/Network/Google/Resource/DFAReporting/CreativeGroups/Patch.hs --- a/gen/Network/Google/Resource/DFAReporting/CreativeGroups/Patch.hs +++ b/gen/Network/Google/Resource/DFAReporting/CreativeGroups/Patch.hs @@ -46,7 +46,7 @@ -- 'CreativeGroupsPatch' request conforms to. type CreativeGroupsPatchResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "creativeGroups" :> @@ -59,12 +59,15 @@ -- semantics. -- -- /See:/ 'creativeGroupsPatch' smart constructor. -data CreativeGroupsPatch = CreativeGroupsPatch' +data CreativeGroupsPatch = + CreativeGroupsPatch' { _cgpProFileId :: !(Textual Int64) , _cgpPayload :: !CreativeGroup , _cgpId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'CreativeGroupsPatch' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -80,11 +83,12 @@ -> Int64 -- ^ 'cgpId' -> CreativeGroupsPatch creativeGroupsPatch pCgpProFileId_ pCgpPayload_ pCgpId_ = - CreativeGroupsPatch' + CreativeGroupsPatch' { _cgpProFileId = _Coerce # pCgpProFileId_ , _cgpPayload = pCgpPayload_ , _cgpId = _Coerce # pCgpId_ } + -- | User profile ID associated with this request. cgpProFileId :: Lens' CreativeGroupsPatch Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/CreativeGroups/Update.hs b/gen/Network/Google/Resource/DFAReporting/CreativeGroups/Update.hs --- a/gen/Network/Google/Resource/DFAReporting/CreativeGroups/Update.hs +++ b/gen/Network/Google/Resource/DFAReporting/CreativeGroups/Update.hs @@ -44,7 +44,7 @@ -- 'CreativeGroupsUpdate' request conforms to. type CreativeGroupsUpdateResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "creativeGroups" :> @@ -55,11 +55,14 @@ -- | Updates an existing creative group. -- -- /See:/ 'creativeGroupsUpdate' smart constructor. -data CreativeGroupsUpdate = CreativeGroupsUpdate' +data CreativeGroupsUpdate = + CreativeGroupsUpdate' { _cguProFileId :: !(Textual Int64) , _cguPayload :: !CreativeGroup - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'CreativeGroupsUpdate' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> CreativeGroup -- ^ 'cguPayload' -> CreativeGroupsUpdate creativeGroupsUpdate pCguProFileId_ pCguPayload_ = - CreativeGroupsUpdate' - { _cguProFileId = _Coerce # pCguProFileId_ - , _cguPayload = pCguPayload_ - } + CreativeGroupsUpdate' + {_cguProFileId = _Coerce # pCguProFileId_, _cguPayload = pCguPayload_} + -- | User profile ID associated with this request. cguProFileId :: Lens' CreativeGroupsUpdate Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Creatives/Get.hs b/gen/Network/Google/Resource/DFAReporting/Creatives/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/Creatives/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/Creatives/Get.hs @@ -44,7 +44,7 @@ -- 'CreativesGet' request conforms to. type CreativesGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "creatives" :> @@ -54,11 +54,14 @@ -- | Gets one creative by ID. -- -- /See:/ 'creativesGet' smart constructor. -data CreativesGet = CreativesGet' +data CreativesGet = + CreativesGet' { _ccProFileId :: !(Textual Int64) , _ccId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'CreativesGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Int64 -- ^ 'ccId' -> CreativesGet creativesGet pCcProFileId_ pCcId_ = - CreativesGet' - { _ccProFileId = _Coerce # pCcProFileId_ - , _ccId = _Coerce # pCcId_ - } + CreativesGet' + {_ccProFileId = _Coerce # pCcProFileId_, _ccId = _Coerce # pCcId_} + -- | User profile ID associated with this request. ccProFileId :: Lens' CreativesGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Creatives/Insert.hs b/gen/Network/Google/Resource/DFAReporting/Creatives/Insert.hs --- a/gen/Network/Google/Resource/DFAReporting/Creatives/Insert.hs +++ b/gen/Network/Google/Resource/DFAReporting/Creatives/Insert.hs @@ -44,7 +44,7 @@ -- 'CreativesInsert' request conforms to. type CreativesInsertResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "creatives" :> @@ -54,11 +54,14 @@ -- | Inserts a new creative. -- -- /See:/ 'creativesInsert' smart constructor. -data CreativesInsert = CreativesInsert' +data CreativesInsert = + CreativesInsert' { _ciProFileId :: !(Textual Int64) , _ciPayload :: !Creative - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'CreativesInsert' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Creative -- ^ 'ciPayload' -> CreativesInsert creativesInsert pCiProFileId_ pCiPayload_ = - CreativesInsert' - { _ciProFileId = _Coerce # pCiProFileId_ - , _ciPayload = pCiPayload_ - } + CreativesInsert' + {_ciProFileId = _Coerce # pCiProFileId_, _ciPayload = pCiPayload_} + -- | User profile ID associated with this request. ciProFileId :: Lens' CreativesInsert Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Creatives/List.hs b/gen/Network/Google/Resource/DFAReporting/Creatives/List.hs --- a/gen/Network/Google/Resource/DFAReporting/Creatives/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/Creatives/List.hs @@ -60,7 +60,7 @@ -- 'CreativesList' request conforms to. type CreativesListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "creatives" :> @@ -96,7 +96,8 @@ -- paging. -- -- /See:/ 'creativesList' smart constructor. -data CreativesList = CreativesList' +data CreativesList = + CreativesList' { _cRenderingIds :: !(Maybe [Textual Int64]) , _cAdvertiserId :: !(Maybe (Textual Int64)) , _cSearchString :: !(Maybe Text) @@ -114,8 +115,10 @@ , _cStudioCreativeId :: !(Maybe (Textual Int64)) , _cArchived :: !(Maybe Bool) , _cMaxResults :: !(Textual Int32) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'CreativesList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -157,7 +160,7 @@ :: Int64 -- ^ 'cProFileId' -> CreativesList creativesList pCProFileId_ = - CreativesList' + CreativesList' { _cRenderingIds = Nothing , _cAdvertiserId = Nothing , _cSearchString = Nothing @@ -176,6 +179,7 @@ , _cArchived = Nothing , _cMaxResults = 1000 } + -- | Select only creatives with these rendering IDs. cRenderingIds :: Lens' CreativesList [Int64] diff --git a/gen/Network/Google/Resource/DFAReporting/Creatives/Patch.hs b/gen/Network/Google/Resource/DFAReporting/Creatives/Patch.hs --- a/gen/Network/Google/Resource/DFAReporting/Creatives/Patch.hs +++ b/gen/Network/Google/Resource/DFAReporting/Creatives/Patch.hs @@ -45,7 +45,7 @@ -- 'CreativesPatch' request conforms to. type CreativesPatchResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "creatives" :> @@ -56,12 +56,15 @@ -- | Updates an existing creative. This method supports patch semantics. -- -- /See:/ 'creativesPatch' smart constructor. -data CreativesPatch = CreativesPatch' +data CreativesPatch = + CreativesPatch' { _cppProFileId :: !(Textual Int64) , _cppPayload :: !Creative , _cppId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'CreativesPatch' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -77,11 +80,12 @@ -> Int64 -- ^ 'cppId' -> CreativesPatch creativesPatch pCppProFileId_ pCppPayload_ pCppId_ = - CreativesPatch' + CreativesPatch' { _cppProFileId = _Coerce # pCppProFileId_ , _cppPayload = pCppPayload_ , _cppId = _Coerce # pCppId_ } + -- | User profile ID associated with this request. cppProFileId :: Lens' CreativesPatch Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Creatives/Update.hs b/gen/Network/Google/Resource/DFAReporting/Creatives/Update.hs --- a/gen/Network/Google/Resource/DFAReporting/Creatives/Update.hs +++ b/gen/Network/Google/Resource/DFAReporting/Creatives/Update.hs @@ -44,7 +44,7 @@ -- 'CreativesUpdate' request conforms to. type CreativesUpdateResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "creatives" :> @@ -54,11 +54,14 @@ -- | Updates an existing creative. -- -- /See:/ 'creativesUpdate' smart constructor. -data CreativesUpdate = CreativesUpdate' +data CreativesUpdate = + CreativesUpdate' { _creProFileId :: !(Textual Int64) , _crePayload :: !Creative - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'CreativesUpdate' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Creative -- ^ 'crePayload' -> CreativesUpdate creativesUpdate pCreProFileId_ pCrePayload_ = - CreativesUpdate' - { _creProFileId = _Coerce # pCreProFileId_ - , _crePayload = pCrePayload_ - } + CreativesUpdate' + {_creProFileId = _Coerce # pCreProFileId_, _crePayload = pCrePayload_} + -- | User profile ID associated with this request. creProFileId :: Lens' CreativesUpdate Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/DimensionValues/Query.hs b/gen/Network/Google/Resource/DFAReporting/DimensionValues/Query.hs --- a/gen/Network/Google/Resource/DFAReporting/DimensionValues/Query.hs +++ b/gen/Network/Google/Resource/DFAReporting/DimensionValues/Query.hs @@ -46,7 +46,7 @@ -- 'DimensionValuesQuery' request conforms to. type DimensionValuesQueryResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "dimensionvalues" :> @@ -60,13 +60,16 @@ -- | Retrieves list of report dimension values for a list of filters. -- -- /See:/ 'dimensionValuesQuery' smart constructor. -data DimensionValuesQuery = DimensionValuesQuery' +data DimensionValuesQuery = + DimensionValuesQuery' { _dvqProFileId :: !(Textual Int64) , _dvqPayload :: !DimensionValueRequest , _dvqPageToken :: !(Maybe Text) , _dvqMaxResults :: !(Textual Int32) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'DimensionValuesQuery' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -83,12 +86,13 @@ -> DimensionValueRequest -- ^ 'dvqPayload' -> DimensionValuesQuery dimensionValuesQuery pDvqProFileId_ pDvqPayload_ = - DimensionValuesQuery' + DimensionValuesQuery' { _dvqProFileId = _Coerce # pDvqProFileId_ , _dvqPayload = pDvqPayload_ , _dvqPageToken = Nothing , _dvqMaxResults = 100 } + -- | The DFA user profile ID. dvqProFileId :: Lens' DimensionValuesQuery Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/DirectorySiteContacts/Get.hs b/gen/Network/Google/Resource/DFAReporting/DirectorySiteContacts/Get.hs deleted file mode 100644 --- a/gen/Network/Google/Resource/DFAReporting/DirectorySiteContacts/Get.hs +++ /dev/null @@ -1,103 +0,0 @@ -{-# LANGUAGE DataKinds #-} -{-# LANGUAGE DeriveDataTypeable #-} -{-# LANGUAGE DeriveGeneric #-} -{-# LANGUAGE FlexibleInstances #-} -{-# LANGUAGE NoImplicitPrelude #-} -{-# LANGUAGE OverloadedStrings #-} -{-# LANGUAGE RecordWildCards #-} -{-# LANGUAGE TypeFamilies #-} -{-# LANGUAGE TypeOperators #-} - -{-# OPTIONS_GHC -fno-warn-duplicate-exports #-} -{-# OPTIONS_GHC -fno-warn-unused-binds #-} -{-# OPTIONS_GHC -fno-warn-unused-imports #-} - --- | --- Module : Network.Google.Resource.DFAReporting.DirectorySiteContacts.Get --- Copyright : (c) 2015-2016 Brendan Hay --- License : Mozilla Public License, v. 2.0. --- Maintainer : Brendan Hay --- Stability : auto-generated --- Portability : non-portable (GHC extensions) --- --- Gets one directory site contact by ID. --- --- /See:/ for @dfareporting.directorySiteContacts.get@. -module Network.Google.Resource.DFAReporting.DirectorySiteContacts.Get - ( - -- * REST Resource - DirectorySiteContactsGetResource - - -- * Creating a Request - , directorySiteContactsGet - , DirectorySiteContactsGet - - -- * Request Lenses - , dscgProFileId - , dscgId - ) where - -import Network.Google.DFAReporting.Types -import Network.Google.Prelude - --- | A resource alias for @dfareporting.directorySiteContacts.get@ method which the --- 'DirectorySiteContactsGet' request conforms to. -type DirectorySiteContactsGetResource = - "dfareporting" :> - "v3.2" :> - "userprofiles" :> - Capture "profileId" (Textual Int64) :> - "directorySiteContacts" :> - Capture "id" (Textual Int64) :> - QueryParam "alt" AltJSON :> - Get '[JSON] DirectorySiteContact - --- | Gets one directory site contact by ID. --- --- /See:/ 'directorySiteContactsGet' smart constructor. -data DirectorySiteContactsGet = DirectorySiteContactsGet' - { _dscgProFileId :: !(Textual Int64) - , _dscgId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'DirectorySiteContactsGet' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'dscgProFileId' --- --- * 'dscgId' -directorySiteContactsGet - :: Int64 -- ^ 'dscgProFileId' - -> Int64 -- ^ 'dscgId' - -> DirectorySiteContactsGet -directorySiteContactsGet pDscgProFileId_ pDscgId_ = - DirectorySiteContactsGet' - { _dscgProFileId = _Coerce # pDscgProFileId_ - , _dscgId = _Coerce # pDscgId_ - } - --- | User profile ID associated with this request. -dscgProFileId :: Lens' DirectorySiteContactsGet Int64 -dscgProFileId - = lens _dscgProFileId - (\ s a -> s{_dscgProFileId = a}) - . _Coerce - --- | Directory site contact ID. -dscgId :: Lens' DirectorySiteContactsGet Int64 -dscgId - = lens _dscgId (\ s a -> s{_dscgId = a}) . _Coerce - -instance GoogleRequest DirectorySiteContactsGet where - type Rs DirectorySiteContactsGet = - DirectorySiteContact - type Scopes DirectorySiteContactsGet = - '["https://www.googleapis.com/auth/dfatrafficking"] - requestClient DirectorySiteContactsGet'{..} - = go _dscgProFileId _dscgId (Just AltJSON) - dFAReportingService - where go - = buildClient - (Proxy :: Proxy DirectorySiteContactsGetResource) - mempty diff --git a/gen/Network/Google/Resource/DFAReporting/DirectorySiteContacts/List.hs b/gen/Network/Google/Resource/DFAReporting/DirectorySiteContacts/List.hs deleted file mode 100644 --- a/gen/Network/Google/Resource/DFAReporting/DirectorySiteContacts/List.hs +++ /dev/null @@ -1,201 +0,0 @@ -{-# LANGUAGE DataKinds #-} -{-# LANGUAGE DeriveDataTypeable #-} -{-# LANGUAGE DeriveGeneric #-} -{-# LANGUAGE FlexibleInstances #-} -{-# LANGUAGE NoImplicitPrelude #-} -{-# LANGUAGE OverloadedStrings #-} -{-# LANGUAGE RecordWildCards #-} -{-# LANGUAGE TypeFamilies #-} -{-# LANGUAGE TypeOperators #-} - -{-# OPTIONS_GHC -fno-warn-duplicate-exports #-} -{-# OPTIONS_GHC -fno-warn-unused-binds #-} -{-# OPTIONS_GHC -fno-warn-unused-imports #-} - --- | --- Module : Network.Google.Resource.DFAReporting.DirectorySiteContacts.List --- Copyright : (c) 2015-2016 Brendan Hay --- License : Mozilla Public License, v. 2.0. --- Maintainer : Brendan Hay --- Stability : auto-generated --- Portability : non-portable (GHC extensions) --- --- Retrieves a list of directory site contacts, possibly filtered. This --- method supports paging. --- --- /See:/ for @dfareporting.directorySiteContacts.list@. -module Network.Google.Resource.DFAReporting.DirectorySiteContacts.List - ( - -- * REST Resource - DirectorySiteContactsListResource - - -- * Creating a Request - , directorySiteContactsList - , DirectorySiteContactsList - - -- * Request Lenses - , dsclSearchString - , dsclIds - , dsclProFileId - , dsclDirectorySiteIds - , dsclSortOrder - , dsclPageToken - , dsclSortField - , dsclMaxResults - ) where - -import Network.Google.DFAReporting.Types -import Network.Google.Prelude - --- | A resource alias for @dfareporting.directorySiteContacts.list@ method which the --- 'DirectorySiteContactsList' request conforms to. -type DirectorySiteContactsListResource = - "dfareporting" :> - "v3.2" :> - "userprofiles" :> - Capture "profileId" (Textual Int64) :> - "directorySiteContacts" :> - QueryParam "searchString" Text :> - QueryParams "ids" (Textual Int64) :> - QueryParams "directorySiteIds" (Textual Int64) :> - QueryParam "sortOrder" - DirectorySiteContactsListSortOrder - :> - QueryParam "pageToken" Text :> - QueryParam "sortField" - DirectorySiteContactsListSortField - :> - QueryParam "maxResults" (Textual Int32) :> - QueryParam "alt" AltJSON :> - Get '[JSON] DirectorySiteContactsListResponse - --- | Retrieves a list of directory site contacts, possibly filtered. This --- method supports paging. --- --- /See:/ 'directorySiteContactsList' smart constructor. -data DirectorySiteContactsList = DirectorySiteContactsList' - { _dsclSearchString :: !(Maybe Text) - , _dsclIds :: !(Maybe [Textual Int64]) - , _dsclProFileId :: !(Textual Int64) - , _dsclDirectorySiteIds :: !(Maybe [Textual Int64]) - , _dsclSortOrder :: !DirectorySiteContactsListSortOrder - , _dsclPageToken :: !(Maybe Text) - , _dsclSortField :: !DirectorySiteContactsListSortField - , _dsclMaxResults :: !(Textual Int32) - } deriving (Eq,Show,Data,Typeable,Generic) - --- | Creates a value of 'DirectorySiteContactsList' with the minimum fields required to make a request. --- --- Use one of the following lenses to modify other fields as desired: --- --- * 'dsclSearchString' --- --- * 'dsclIds' --- --- * 'dsclProFileId' --- --- * 'dsclDirectorySiteIds' --- --- * 'dsclSortOrder' --- --- * 'dsclPageToken' --- --- * 'dsclSortField' --- --- * 'dsclMaxResults' -directorySiteContactsList - :: Int64 -- ^ 'dsclProFileId' - -> DirectorySiteContactsList -directorySiteContactsList pDsclProFileId_ = - DirectorySiteContactsList' - { _dsclSearchString = Nothing - , _dsclIds = Nothing - , _dsclProFileId = _Coerce # pDsclProFileId_ - , _dsclDirectorySiteIds = Nothing - , _dsclSortOrder = DSCLSOAscending - , _dsclPageToken = Nothing - , _dsclSortField = DSCLSFID - , _dsclMaxResults = 1000 - } - --- | Allows searching for objects by name, ID or email. Wildcards (*) are --- allowed. For example, \"directory site contact*2015\" will return --- objects with names like \"directory site contact June 2015\", --- \"directory site contact April 2015\", or simply \"directory site --- contact 2015\". Most of the searches also add wildcards implicitly at --- the start and the end of the search string. For example, a search string --- of \"directory site contact\" will match objects with name \"my --- directory site contact\", \"directory site contact 2015\", or simply --- \"directory site contact\". -dsclSearchString :: Lens' DirectorySiteContactsList (Maybe Text) -dsclSearchString - = lens _dsclSearchString - (\ s a -> s{_dsclSearchString = a}) - --- | Select only directory site contacts with these IDs. -dsclIds :: Lens' DirectorySiteContactsList [Int64] -dsclIds - = lens _dsclIds (\ s a -> s{_dsclIds = a}) . _Default - . _Coerce - --- | User profile ID associated with this request. -dsclProFileId :: Lens' DirectorySiteContactsList Int64 -dsclProFileId - = lens _dsclProFileId - (\ s a -> s{_dsclProFileId = a}) - . _Coerce - --- | Select only directory site contacts with these directory site IDs. This --- is a required field. -dsclDirectorySiteIds :: Lens' DirectorySiteContactsList [Int64] -dsclDirectorySiteIds - = lens _dsclDirectorySiteIds - (\ s a -> s{_dsclDirectorySiteIds = a}) - . _Default - . _Coerce - --- | Order of sorted results. -dsclSortOrder :: Lens' DirectorySiteContactsList DirectorySiteContactsListSortOrder -dsclSortOrder - = lens _dsclSortOrder - (\ s a -> s{_dsclSortOrder = a}) - --- | Value of the nextPageToken from the previous result page. -dsclPageToken :: Lens' DirectorySiteContactsList (Maybe Text) -dsclPageToken - = lens _dsclPageToken - (\ s a -> s{_dsclPageToken = a}) - --- | Field by which to sort the list. -dsclSortField :: Lens' DirectorySiteContactsList DirectorySiteContactsListSortField -dsclSortField - = lens _dsclSortField - (\ s a -> s{_dsclSortField = a}) - --- | Maximum number of results to return. -dsclMaxResults :: Lens' DirectorySiteContactsList Int32 -dsclMaxResults - = lens _dsclMaxResults - (\ s a -> s{_dsclMaxResults = a}) - . _Coerce - -instance GoogleRequest DirectorySiteContactsList - where - type Rs DirectorySiteContactsList = - DirectorySiteContactsListResponse - type Scopes DirectorySiteContactsList = - '["https://www.googleapis.com/auth/dfatrafficking"] - requestClient DirectorySiteContactsList'{..} - = go _dsclProFileId _dsclSearchString - (_dsclIds ^. _Default) - (_dsclDirectorySiteIds ^. _Default) - (Just _dsclSortOrder) - _dsclPageToken - (Just _dsclSortField) - (Just _dsclMaxResults) - (Just AltJSON) - dFAReportingService - where go - = buildClient - (Proxy :: Proxy DirectorySiteContactsListResource) - mempty diff --git a/gen/Network/Google/Resource/DFAReporting/DirectorySites/Get.hs b/gen/Network/Google/Resource/DFAReporting/DirectorySites/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/DirectorySites/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/DirectorySites/Get.hs @@ -44,7 +44,7 @@ -- 'DirectorySitesGet' request conforms to. type DirectorySitesGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "directorySites" :> @@ -54,11 +54,14 @@ -- | Gets one directory site by ID. -- -- /See:/ 'directorySitesGet' smart constructor. -data DirectorySitesGet = DirectorySitesGet' +data DirectorySitesGet = + DirectorySitesGet' { _dsgProFileId :: !(Textual Int64) , _dsgId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'DirectorySitesGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Int64 -- ^ 'dsgId' -> DirectorySitesGet directorySitesGet pDsgProFileId_ pDsgId_ = - DirectorySitesGet' - { _dsgProFileId = _Coerce # pDsgProFileId_ - , _dsgId = _Coerce # pDsgId_ - } + DirectorySitesGet' + {_dsgProFileId = _Coerce # pDsgProFileId_, _dsgId = _Coerce # pDsgId_} + -- | User profile ID associated with this request. dsgProFileId :: Lens' DirectorySitesGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/DirectorySites/Insert.hs b/gen/Network/Google/Resource/DFAReporting/DirectorySites/Insert.hs --- a/gen/Network/Google/Resource/DFAReporting/DirectorySites/Insert.hs +++ b/gen/Network/Google/Resource/DFAReporting/DirectorySites/Insert.hs @@ -44,7 +44,7 @@ -- 'DirectorySitesInsert' request conforms to. type DirectorySitesInsertResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "directorySites" :> @@ -55,11 +55,14 @@ -- | Inserts a new directory site. -- -- /See:/ 'directorySitesInsert' smart constructor. -data DirectorySitesInsert = DirectorySitesInsert' +data DirectorySitesInsert = + DirectorySitesInsert' { _dsiProFileId :: !(Textual Int64) , _dsiPayload :: !DirectorySite - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'DirectorySitesInsert' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> DirectorySite -- ^ 'dsiPayload' -> DirectorySitesInsert directorySitesInsert pDsiProFileId_ pDsiPayload_ = - DirectorySitesInsert' - { _dsiProFileId = _Coerce # pDsiProFileId_ - , _dsiPayload = pDsiPayload_ - } + DirectorySitesInsert' + {_dsiProFileId = _Coerce # pDsiProFileId_, _dsiPayload = pDsiPayload_} + -- | User profile ID associated with this request. dsiProFileId :: Lens' DirectorySitesInsert Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/DirectorySites/List.hs b/gen/Network/Google/Resource/DFAReporting/DirectorySites/List.hs --- a/gen/Network/Google/Resource/DFAReporting/DirectorySites/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/DirectorySites/List.hs @@ -41,12 +41,10 @@ , dslProFileId , dslSortOrder , dslActive - , dslCountryId , dslPageToken , dslSortField , dslAcceptsInStreamVideoPlacements , dslMaxResults - , dslParentId , dslDfpNetworkCode ) where @@ -57,7 +55,7 @@ -- 'DirectorySitesList' request conforms to. type DirectorySitesListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "directorySites" :> @@ -67,26 +65,22 @@ QueryParams "ids" (Textual Int64) :> QueryParam "sortOrder" DirectorySitesListSortOrder :> QueryParam "active" Bool :> - QueryParam "countryId" (Textual Int64) :> - QueryParam "pageToken" Text :> - QueryParam "sortField" - DirectorySitesListSortField + QueryParam "pageToken" Text :> + QueryParam "sortField" DirectorySitesListSortField + :> + QueryParam "acceptsInStreamVideoPlacements" Bool :> - QueryParam "acceptsInStreamVideoPlacements" - Bool - :> - QueryParam "maxResults" (Textual Int32) :> - QueryParam "parentId" (Textual Int64) :> - QueryParam "dfpNetworkCode" Text :> - QueryParam "alt" AltJSON :> - Get '[JSON] - DirectorySitesListResponse + QueryParam "maxResults" (Textual Int32) :> + QueryParam "dfpNetworkCode" Text :> + QueryParam "alt" AltJSON :> + Get '[JSON] DirectorySitesListResponse -- | Retrieves a list of directory sites, possibly filtered. This method -- supports paging. -- -- /See:/ 'directorySitesList' smart constructor. -data DirectorySitesList = DirectorySitesList' +data DirectorySitesList = + DirectorySitesList' { _dslSearchString :: !(Maybe Text) , _dslAcceptsInterstitialPlacements :: !(Maybe Bool) , _dslAcceptsPublisherPaidPlacements :: !(Maybe Bool) @@ -94,15 +88,15 @@ , _dslProFileId :: !(Textual Int64) , _dslSortOrder :: !DirectorySitesListSortOrder , _dslActive :: !(Maybe Bool) - , _dslCountryId :: !(Maybe (Textual Int64)) , _dslPageToken :: !(Maybe Text) , _dslSortField :: !DirectorySitesListSortField , _dslAcceptsInStreamVideoPlacements :: !(Maybe Bool) , _dslMaxResults :: !(Textual Int32) - , _dslParentId :: !(Maybe (Textual Int64)) , _dslDfpNetworkCode :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'DirectorySitesList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -121,8 +115,6 @@ -- -- * 'dslActive' -- --- * 'dslCountryId' --- -- * 'dslPageToken' -- -- * 'dslSortField' @@ -131,14 +123,12 @@ -- -- * 'dslMaxResults' -- --- * 'dslParentId' --- -- * 'dslDfpNetworkCode' directorySitesList :: Int64 -- ^ 'dslProFileId' -> DirectorySitesList directorySitesList pDslProFileId_ = - DirectorySitesList' + DirectorySitesList' { _dslSearchString = Nothing , _dslAcceptsInterstitialPlacements = Nothing , _dslAcceptsPublisherPaidPlacements = Nothing @@ -146,15 +136,14 @@ , _dslProFileId = _Coerce # pDslProFileId_ , _dslSortOrder = DSLSOAscending , _dslActive = Nothing - , _dslCountryId = Nothing , _dslPageToken = Nothing , _dslSortField = DSLSFID , _dslAcceptsInStreamVideoPlacements = Nothing , _dslMaxResults = 1000 - , _dslParentId = Nothing , _dslDfpNetworkCode = Nothing } + -- | Allows searching for objects by name, ID or URL. Wildcards (*) are -- allowed. For example, \"directory site*2015\" will return objects with -- names like \"directory site June 2015\", \"directory site April 2015\", @@ -205,12 +194,6 @@ dslActive = lens _dslActive (\ s a -> s{_dslActive = a}) --- | Select only directory sites with this country ID. -dslCountryId :: Lens' DirectorySitesList (Maybe Int64) -dslCountryId - = lens _dslCountryId (\ s a -> s{_dslCountryId = a}) - . mapping _Coerce - -- | Value of the nextPageToken from the previous result page. dslPageToken :: Lens' DirectorySitesList (Maybe Text) dslPageToken @@ -235,12 +218,6 @@ (\ s a -> s{_dslMaxResults = a}) . _Coerce --- | Select only directory sites with this parent ID. -dslParentId :: Lens' DirectorySitesList (Maybe Int64) -dslParentId - = lens _dslParentId (\ s a -> s{_dslParentId = a}) . - mapping _Coerce - -- | Select only directory sites with this Ad Manager network code. dslDfpNetworkCode :: Lens' DirectorySitesList (Maybe Text) dslDfpNetworkCode @@ -259,12 +236,10 @@ (_dslIds ^. _Default) (Just _dslSortOrder) _dslActive - _dslCountryId _dslPageToken (Just _dslSortField) _dslAcceptsInStreamVideoPlacements (Just _dslMaxResults) - _dslParentId _dslDfpNetworkCode (Just AltJSON) dFAReportingService diff --git a/gen/Network/Google/Resource/DFAReporting/DynamicTargetingKeys/Delete.hs b/gen/Network/Google/Resource/DFAReporting/DynamicTargetingKeys/Delete.hs --- a/gen/Network/Google/Resource/DFAReporting/DynamicTargetingKeys/Delete.hs +++ b/gen/Network/Google/Resource/DFAReporting/DynamicTargetingKeys/Delete.hs @@ -46,7 +46,7 @@ -- 'DynamicTargetingKeysDelete' request conforms to. type DynamicTargetingKeysDeleteResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "dynamicTargetingKeys" :> @@ -59,13 +59,16 @@ -- | Deletes an existing dynamic targeting key. -- -- /See:/ 'dynamicTargetingKeysDelete' smart constructor. -data DynamicTargetingKeysDelete = DynamicTargetingKeysDelete' +data DynamicTargetingKeysDelete = + DynamicTargetingKeysDelete' { _dtkdObjectType :: !DynamicTargetingKeysDeleteObjectType , _dtkdObjectId :: !(Textual Int64) , _dtkdProFileId :: !(Textual Int64) , _dtkdName :: !Text - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'DynamicTargetingKeysDelete' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -84,12 +87,13 @@ -> Text -- ^ 'dtkdName' -> DynamicTargetingKeysDelete dynamicTargetingKeysDelete pDtkdObjectType_ pDtkdObjectId_ pDtkdProFileId_ pDtkdName_ = - DynamicTargetingKeysDelete' + DynamicTargetingKeysDelete' { _dtkdObjectType = pDtkdObjectType_ , _dtkdObjectId = _Coerce # pDtkdObjectId_ , _dtkdProFileId = _Coerce # pDtkdProFileId_ , _dtkdName = pDtkdName_ } + -- | Type of the object of this dynamic targeting key. This is a required -- field. diff --git a/gen/Network/Google/Resource/DFAReporting/DynamicTargetingKeys/Insert.hs b/gen/Network/Google/Resource/DFAReporting/DynamicTargetingKeys/Insert.hs --- a/gen/Network/Google/Resource/DFAReporting/DynamicTargetingKeys/Insert.hs +++ b/gen/Network/Google/Resource/DFAReporting/DynamicTargetingKeys/Insert.hs @@ -48,7 +48,7 @@ -- 'DynamicTargetingKeysInsert' request conforms to. type DynamicTargetingKeysInsertResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "dynamicTargetingKeys" :> @@ -63,11 +63,14 @@ -- creative, or placement. -- -- /See:/ 'dynamicTargetingKeysInsert' smart constructor. -data DynamicTargetingKeysInsert = DynamicTargetingKeysInsert' +data DynamicTargetingKeysInsert = + DynamicTargetingKeysInsert' { _dtkiProFileId :: !(Textual Int64) , _dtkiPayload :: !DynamicTargetingKey - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'DynamicTargetingKeysInsert' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -80,10 +83,9 @@ -> DynamicTargetingKey -- ^ 'dtkiPayload' -> DynamicTargetingKeysInsert dynamicTargetingKeysInsert pDtkiProFileId_ pDtkiPayload_ = - DynamicTargetingKeysInsert' - { _dtkiProFileId = _Coerce # pDtkiProFileId_ - , _dtkiPayload = pDtkiPayload_ - } + DynamicTargetingKeysInsert' + {_dtkiProFileId = _Coerce # pDtkiProFileId_, _dtkiPayload = pDtkiPayload_} + -- | User profile ID associated with this request. dtkiProFileId :: Lens' DynamicTargetingKeysInsert Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/DynamicTargetingKeys/List.hs b/gen/Network/Google/Resource/DFAReporting/DynamicTargetingKeys/List.hs --- a/gen/Network/Google/Resource/DFAReporting/DynamicTargetingKeys/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/DynamicTargetingKeys/List.hs @@ -47,7 +47,7 @@ -- 'DynamicTargetingKeysList' request conforms to. type DynamicTargetingKeysListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "dynamicTargetingKeys" :> @@ -63,14 +63,17 @@ -- | Retrieves a list of dynamic targeting keys. -- -- /See:/ 'dynamicTargetingKeysList' smart constructor. -data DynamicTargetingKeysList = DynamicTargetingKeysList' +data DynamicTargetingKeysList = + DynamicTargetingKeysList' { _dtklObjectType :: !(Maybe DynamicTargetingKeysListObjectType) , _dtklAdvertiserId :: !(Maybe (Textual Int64)) , _dtklObjectId :: !(Maybe (Textual Int64)) , _dtklProFileId :: !(Textual Int64) , _dtklNames :: !(Maybe [Text]) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'DynamicTargetingKeysList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -88,13 +91,14 @@ :: Int64 -- ^ 'dtklProFileId' -> DynamicTargetingKeysList dynamicTargetingKeysList pDtklProFileId_ = - DynamicTargetingKeysList' + DynamicTargetingKeysList' { _dtklObjectType = Nothing , _dtklAdvertiserId = Nothing , _dtklObjectId = Nothing , _dtklProFileId = _Coerce # pDtklProFileId_ , _dtklNames = Nothing } + -- | Select only dynamic targeting keys with this object type. dtklObjectType :: Lens' DynamicTargetingKeysList (Maybe DynamicTargetingKeysListObjectType) diff --git a/gen/Network/Google/Resource/DFAReporting/EventTags/Delete.hs b/gen/Network/Google/Resource/DFAReporting/EventTags/Delete.hs --- a/gen/Network/Google/Resource/DFAReporting/EventTags/Delete.hs +++ b/gen/Network/Google/Resource/DFAReporting/EventTags/Delete.hs @@ -44,7 +44,7 @@ -- 'EventTagsDelete' request conforms to. type EventTagsDeleteResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "eventTags" :> @@ -54,11 +54,14 @@ -- | Deletes an existing event tag. -- -- /See:/ 'eventTagsDelete' smart constructor. -data EventTagsDelete = EventTagsDelete' +data EventTagsDelete = + EventTagsDelete' { _etdProFileId :: !(Textual Int64) , _etdId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'EventTagsDelete' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Int64 -- ^ 'etdId' -> EventTagsDelete eventTagsDelete pEtdProFileId_ pEtdId_ = - EventTagsDelete' - { _etdProFileId = _Coerce # pEtdProFileId_ - , _etdId = _Coerce # pEtdId_ - } + EventTagsDelete' + {_etdProFileId = _Coerce # pEtdProFileId_, _etdId = _Coerce # pEtdId_} + -- | User profile ID associated with this request. etdProFileId :: Lens' EventTagsDelete Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/EventTags/Get.hs b/gen/Network/Google/Resource/DFAReporting/EventTags/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/EventTags/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/EventTags/Get.hs @@ -44,7 +44,7 @@ -- 'EventTagsGet' request conforms to. type EventTagsGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "eventTags" :> @@ -54,11 +54,14 @@ -- | Gets one event tag by ID. -- -- /See:/ 'eventTagsGet' smart constructor. -data EventTagsGet = EventTagsGet' +data EventTagsGet = + EventTagsGet' { _etgProFileId :: !(Textual Int64) , _etgId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'EventTagsGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Int64 -- ^ 'etgId' -> EventTagsGet eventTagsGet pEtgProFileId_ pEtgId_ = - EventTagsGet' - { _etgProFileId = _Coerce # pEtgProFileId_ - , _etgId = _Coerce # pEtgId_ - } + EventTagsGet' + {_etgProFileId = _Coerce # pEtgProFileId_, _etgId = _Coerce # pEtgId_} + -- | User profile ID associated with this request. etgProFileId :: Lens' EventTagsGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/EventTags/Insert.hs b/gen/Network/Google/Resource/DFAReporting/EventTags/Insert.hs --- a/gen/Network/Google/Resource/DFAReporting/EventTags/Insert.hs +++ b/gen/Network/Google/Resource/DFAReporting/EventTags/Insert.hs @@ -44,7 +44,7 @@ -- 'EventTagsInsert' request conforms to. type EventTagsInsertResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "eventTags" :> @@ -54,11 +54,14 @@ -- | Inserts a new event tag. -- -- /See:/ 'eventTagsInsert' smart constructor. -data EventTagsInsert = EventTagsInsert' +data EventTagsInsert = + EventTagsInsert' { _etiProFileId :: !(Textual Int64) , _etiPayload :: !EventTag - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'EventTagsInsert' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> EventTag -- ^ 'etiPayload' -> EventTagsInsert eventTagsInsert pEtiProFileId_ pEtiPayload_ = - EventTagsInsert' - { _etiProFileId = _Coerce # pEtiProFileId_ - , _etiPayload = pEtiPayload_ - } + EventTagsInsert' + {_etiProFileId = _Coerce # pEtiProFileId_, _etiPayload = pEtiPayload_} + -- | User profile ID associated with this request. etiProFileId :: Lens' EventTagsInsert Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/EventTags/List.hs b/gen/Network/Google/Resource/DFAReporting/EventTags/List.hs --- a/gen/Network/Google/Resource/DFAReporting/EventTags/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/EventTags/List.hs @@ -53,7 +53,7 @@ -- 'EventTagsList' request conforms to. type EventTagsListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "eventTags" :> @@ -76,7 +76,8 @@ -- | Retrieves a list of event tags, possibly filtered. -- -- /See:/ 'eventTagsList' smart constructor. -data EventTagsList = EventTagsList' +data EventTagsList = + EventTagsList' { _etlDefinitionsOnly :: !(Maybe Bool) , _etlEventTagTypes :: !(Maybe [EventTagsListEventTagTypes]) , _etlEnabled :: !(Maybe Bool) @@ -88,8 +89,10 @@ , _etlSortOrder :: !EventTagsListSortOrder , _etlAdId :: !(Maybe (Textual Int64)) , _etlSortField :: !EventTagsListSortField - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'EventTagsList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -119,7 +122,7 @@ :: Int64 -- ^ 'etlProFileId' -> EventTagsList eventTagsList pEtlProFileId_ = - EventTagsList' + EventTagsList' { _etlDefinitionsOnly = Nothing , _etlEventTagTypes = Nothing , _etlEnabled = Nothing @@ -132,6 +135,7 @@ , _etlAdId = Nothing , _etlSortField = ETLSFID } + -- | Examine only the specified campaign or advertiser\'s event tags for -- matching selector criteria. When set to false, the parent advertiser and diff --git a/gen/Network/Google/Resource/DFAReporting/EventTags/Patch.hs b/gen/Network/Google/Resource/DFAReporting/EventTags/Patch.hs --- a/gen/Network/Google/Resource/DFAReporting/EventTags/Patch.hs +++ b/gen/Network/Google/Resource/DFAReporting/EventTags/Patch.hs @@ -45,7 +45,7 @@ -- 'EventTagsPatch' request conforms to. type EventTagsPatchResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "eventTags" :> @@ -56,12 +56,15 @@ -- | Updates an existing event tag. This method supports patch semantics. -- -- /See:/ 'eventTagsPatch' smart constructor. -data EventTagsPatch = EventTagsPatch' +data EventTagsPatch = + EventTagsPatch' { _etpProFileId :: !(Textual Int64) , _etpPayload :: !EventTag , _etpId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'EventTagsPatch' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -77,11 +80,12 @@ -> Int64 -- ^ 'etpId' -> EventTagsPatch eventTagsPatch pEtpProFileId_ pEtpPayload_ pEtpId_ = - EventTagsPatch' + EventTagsPatch' { _etpProFileId = _Coerce # pEtpProFileId_ , _etpPayload = pEtpPayload_ , _etpId = _Coerce # pEtpId_ } + -- | User profile ID associated with this request. etpProFileId :: Lens' EventTagsPatch Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/EventTags/Update.hs b/gen/Network/Google/Resource/DFAReporting/EventTags/Update.hs --- a/gen/Network/Google/Resource/DFAReporting/EventTags/Update.hs +++ b/gen/Network/Google/Resource/DFAReporting/EventTags/Update.hs @@ -44,7 +44,7 @@ -- 'EventTagsUpdate' request conforms to. type EventTagsUpdateResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "eventTags" :> @@ -54,11 +54,14 @@ -- | Updates an existing event tag. -- -- /See:/ 'eventTagsUpdate' smart constructor. -data EventTagsUpdate = EventTagsUpdate' +data EventTagsUpdate = + EventTagsUpdate' { _etuProFileId :: !(Textual Int64) , _etuPayload :: !EventTag - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'EventTagsUpdate' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> EventTag -- ^ 'etuPayload' -> EventTagsUpdate eventTagsUpdate pEtuProFileId_ pEtuPayload_ = - EventTagsUpdate' - { _etuProFileId = _Coerce # pEtuProFileId_ - , _etuPayload = pEtuPayload_ - } + EventTagsUpdate' + {_etuProFileId = _Coerce # pEtuProFileId_, _etuPayload = pEtuPayload_} + -- | User profile ID associated with this request. etuProFileId :: Lens' EventTagsUpdate Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Files/Get.hs b/gen/Network/Google/Resource/DFAReporting/Files/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/Files/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/Files/Get.hs @@ -45,7 +45,7 @@ -- 'FilesGet' request conforms to. type FilesGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "reports" :> Capture "reportId" (Textual Int64) :> "files" :> @@ -53,7 +53,7 @@ QueryParam "alt" AltJSON :> Get '[JSON] File :<|> "dfareporting" :> - "v3.2" :> + "v3.3" :> "reports" :> Capture "reportId" (Textual Int64) :> "files" :> @@ -65,11 +65,14 @@ -- supports media download. -- -- /See:/ 'filesGet' smart constructor. -data FilesGet = FilesGet' +data FilesGet = + FilesGet' { _fgReportId :: !(Textual Int64) , _fgFileId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'FilesGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -82,10 +85,9 @@ -> Int64 -- ^ 'fgFileId' -> FilesGet filesGet pFgReportId_ pFgFileId_ = - FilesGet' - { _fgReportId = _Coerce # pFgReportId_ - , _fgFileId = _Coerce # pFgFileId_ - } + FilesGet' + {_fgReportId = _Coerce # pFgReportId_, _fgFileId = _Coerce # pFgFileId_} + -- | The ID of the report. fgReportId :: Lens' FilesGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Files/List.hs b/gen/Network/Google/Resource/DFAReporting/Files/List.hs --- a/gen/Network/Google/Resource/DFAReporting/Files/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/Files/List.hs @@ -48,7 +48,7 @@ -- 'FilesList' request conforms to. type FilesListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "files" :> @@ -62,15 +62,18 @@ -- | Lists files for a user profile. -- -- /See:/ 'filesList' smart constructor. -data FilesList = FilesList' +data FilesList = + FilesList' { _flProFileId :: !(Textual Int64) , _flSortOrder :: !FilesListSortOrder , _flScope :: !FilesListScope , _flPageToken :: !(Maybe Text) , _flSortField :: !FilesListSortField , _flMaxResults :: !(Textual Int32) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'FilesList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -90,7 +93,7 @@ :: Int64 -- ^ 'flProFileId' -> FilesList filesList pFlProFileId_ = - FilesList' + FilesList' { _flProFileId = _Coerce # pFlProFileId_ , _flSortOrder = FLSODescending , _flScope = FLSMine @@ -98,6 +101,7 @@ , _flSortField = FLSFLastModifiedTime , _flMaxResults = 10 } + -- | The DFA profile ID. flProFileId :: Lens' FilesList Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/FloodlightActivities/Delete.hs b/gen/Network/Google/Resource/DFAReporting/FloodlightActivities/Delete.hs --- a/gen/Network/Google/Resource/DFAReporting/FloodlightActivities/Delete.hs +++ b/gen/Network/Google/Resource/DFAReporting/FloodlightActivities/Delete.hs @@ -44,7 +44,7 @@ -- 'FloodlightActivitiesDelete' request conforms to. type FloodlightActivitiesDeleteResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "floodlightActivities" :> @@ -54,11 +54,14 @@ -- | Deletes an existing floodlight activity. -- -- /See:/ 'floodlightActivitiesDelete' smart constructor. -data FloodlightActivitiesDelete = FloodlightActivitiesDelete' +data FloodlightActivitiesDelete = + FloodlightActivitiesDelete' { _fadProFileId :: !(Textual Int64) , _fadId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'FloodlightActivitiesDelete' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Int64 -- ^ 'fadId' -> FloodlightActivitiesDelete floodlightActivitiesDelete pFadProFileId_ pFadId_ = - FloodlightActivitiesDelete' - { _fadProFileId = _Coerce # pFadProFileId_ - , _fadId = _Coerce # pFadId_ - } + FloodlightActivitiesDelete' + {_fadProFileId = _Coerce # pFadProFileId_, _fadId = _Coerce # pFadId_} + -- | User profile ID associated with this request. fadProFileId :: Lens' FloodlightActivitiesDelete Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/FloodlightActivities/Generatetag.hs b/gen/Network/Google/Resource/DFAReporting/FloodlightActivities/Generatetag.hs --- a/gen/Network/Google/Resource/DFAReporting/FloodlightActivities/Generatetag.hs +++ b/gen/Network/Google/Resource/DFAReporting/FloodlightActivities/Generatetag.hs @@ -44,7 +44,7 @@ -- 'FloodlightActivitiesGeneratetag' request conforms to. type FloodlightActivitiesGeneratetagResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "floodlightActivities" :> @@ -56,11 +56,14 @@ -- | Generates a tag for a floodlight activity. -- -- /See:/ 'floodlightActivitiesGeneratetag' smart constructor. -data FloodlightActivitiesGeneratetag = FloodlightActivitiesGeneratetag' +data FloodlightActivitiesGeneratetag = + FloodlightActivitiesGeneratetag' { _fagFloodlightActivityId :: !(Maybe (Textual Int64)) , _fagProFileId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'FloodlightActivitiesGeneratetag' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,11 +75,12 @@ :: Int64 -- ^ 'fagProFileId' -> FloodlightActivitiesGeneratetag floodlightActivitiesGeneratetag pFagProFileId_ = - FloodlightActivitiesGeneratetag' + FloodlightActivitiesGeneratetag' { _fagFloodlightActivityId = Nothing , _fagProFileId = _Coerce # pFagProFileId_ } + -- | Floodlight activity ID for which we want to generate a tag. fagFloodlightActivityId :: Lens' FloodlightActivitiesGeneratetag (Maybe Int64) fagFloodlightActivityId @@ -91,7 +95,8 @@ . _Coerce instance GoogleRequest - FloodlightActivitiesGeneratetag where + FloodlightActivitiesGeneratetag + where type Rs FloodlightActivitiesGeneratetag = FloodlightActivitiesGenerateTagResponse type Scopes FloodlightActivitiesGeneratetag = diff --git a/gen/Network/Google/Resource/DFAReporting/FloodlightActivities/Get.hs b/gen/Network/Google/Resource/DFAReporting/FloodlightActivities/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/FloodlightActivities/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/FloodlightActivities/Get.hs @@ -44,7 +44,7 @@ -- 'FloodlightActivitiesGet' request conforms to. type FloodlightActivitiesGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "floodlightActivities" :> @@ -55,11 +55,14 @@ -- | Gets one floodlight activity by ID. -- -- /See:/ 'floodlightActivitiesGet' smart constructor. -data FloodlightActivitiesGet = FloodlightActivitiesGet' +data FloodlightActivitiesGet = + FloodlightActivitiesGet' { _fProFileId :: !(Textual Int64) , _fId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'FloodlightActivitiesGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> Int64 -- ^ 'fId' -> FloodlightActivitiesGet floodlightActivitiesGet pFProFileId_ pFId_ = - FloodlightActivitiesGet' - { _fProFileId = _Coerce # pFProFileId_ - , _fId = _Coerce # pFId_ - } + FloodlightActivitiesGet' + {_fProFileId = _Coerce # pFProFileId_, _fId = _Coerce # pFId_} + -- | User profile ID associated with this request. fProFileId :: Lens' FloodlightActivitiesGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/FloodlightActivities/Insert.hs b/gen/Network/Google/Resource/DFAReporting/FloodlightActivities/Insert.hs --- a/gen/Network/Google/Resource/DFAReporting/FloodlightActivities/Insert.hs +++ b/gen/Network/Google/Resource/DFAReporting/FloodlightActivities/Insert.hs @@ -44,7 +44,7 @@ -- 'FloodlightActivitiesInsert' request conforms to. type FloodlightActivitiesInsertResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "floodlightActivities" :> @@ -55,11 +55,14 @@ -- | Inserts a new floodlight activity. -- -- /See:/ 'floodlightActivitiesInsert' smart constructor. -data FloodlightActivitiesInsert = FloodlightActivitiesInsert' +data FloodlightActivitiesInsert = + FloodlightActivitiesInsert' { _faiProFileId :: !(Textual Int64) , _faiPayload :: !FloodlightActivity - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'FloodlightActivitiesInsert' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> FloodlightActivity -- ^ 'faiPayload' -> FloodlightActivitiesInsert floodlightActivitiesInsert pFaiProFileId_ pFaiPayload_ = - FloodlightActivitiesInsert' - { _faiProFileId = _Coerce # pFaiProFileId_ - , _faiPayload = pFaiPayload_ - } + FloodlightActivitiesInsert' + {_faiProFileId = _Coerce # pFaiProFileId_, _faiPayload = pFaiPayload_} + -- | User profile ID associated with this request. faiProFileId :: Lens' FloodlightActivitiesInsert Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/FloodlightActivities/List.hs b/gen/Network/Google/Resource/DFAReporting/FloodlightActivities/List.hs --- a/gen/Network/Google/Resource/DFAReporting/FloodlightActivities/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/FloodlightActivities/List.hs @@ -57,7 +57,7 @@ -- 'FloodlightActivitiesList' request conforms to. type FloodlightActivitiesListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "floodlightActivities" :> @@ -94,7 +94,8 @@ -- method supports paging. -- -- /See:/ 'floodlightActivitiesList' smart constructor. -data FloodlightActivitiesList = FloodlightActivitiesList' +data FloodlightActivitiesList = + FloodlightActivitiesList' { _falTagString :: !(Maybe Text) , _falFloodlightActivityGroupTagString :: !(Maybe Text) , _falFloodlightConfigurationId :: !(Maybe (Textual Int64)) @@ -109,8 +110,10 @@ , _falPageToken :: !(Maybe Text) , _falSortField :: !FloodlightActivitiesListSortField , _falMaxResults :: !(Textual Int32) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'FloodlightActivitiesList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -146,7 +149,7 @@ :: Int64 -- ^ 'falProFileId' -> FloodlightActivitiesList floodlightActivitiesList pFalProFileId_ = - FloodlightActivitiesList' + FloodlightActivitiesList' { _falTagString = Nothing , _falFloodlightActivityGroupTagString = Nothing , _falFloodlightConfigurationId = Nothing @@ -162,6 +165,7 @@ , _falSortField = FALSFID , _falMaxResults = 1000 } + -- | Select only floodlight activities with the specified tag string. falTagString :: Lens' FloodlightActivitiesList (Maybe Text) diff --git a/gen/Network/Google/Resource/DFAReporting/FloodlightActivities/Patch.hs b/gen/Network/Google/Resource/DFAReporting/FloodlightActivities/Patch.hs --- a/gen/Network/Google/Resource/DFAReporting/FloodlightActivities/Patch.hs +++ b/gen/Network/Google/Resource/DFAReporting/FloodlightActivities/Patch.hs @@ -46,7 +46,7 @@ -- 'FloodlightActivitiesPatch' request conforms to. type FloodlightActivitiesPatchResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "floodlightActivities" :> @@ -59,12 +59,15 @@ -- semantics. -- -- /See:/ 'floodlightActivitiesPatch' smart constructor. -data FloodlightActivitiesPatch = FloodlightActivitiesPatch' +data FloodlightActivitiesPatch = + FloodlightActivitiesPatch' { _fapProFileId :: !(Textual Int64) , _fapPayload :: !FloodlightActivity , _fapId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'FloodlightActivitiesPatch' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -80,11 +83,12 @@ -> Int64 -- ^ 'fapId' -> FloodlightActivitiesPatch floodlightActivitiesPatch pFapProFileId_ pFapPayload_ pFapId_ = - FloodlightActivitiesPatch' + FloodlightActivitiesPatch' { _fapProFileId = _Coerce # pFapProFileId_ , _fapPayload = pFapPayload_ , _fapId = _Coerce # pFapId_ } + -- | User profile ID associated with this request. fapProFileId :: Lens' FloodlightActivitiesPatch Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/FloodlightActivities/Update.hs b/gen/Network/Google/Resource/DFAReporting/FloodlightActivities/Update.hs --- a/gen/Network/Google/Resource/DFAReporting/FloodlightActivities/Update.hs +++ b/gen/Network/Google/Resource/DFAReporting/FloodlightActivities/Update.hs @@ -44,7 +44,7 @@ -- 'FloodlightActivitiesUpdate' request conforms to. type FloodlightActivitiesUpdateResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "floodlightActivities" :> @@ -55,11 +55,14 @@ -- | Updates an existing floodlight activity. -- -- /See:/ 'floodlightActivitiesUpdate' smart constructor. -data FloodlightActivitiesUpdate = FloodlightActivitiesUpdate' +data FloodlightActivitiesUpdate = + FloodlightActivitiesUpdate' { _fauProFileId :: !(Textual Int64) , _fauPayload :: !FloodlightActivity - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'FloodlightActivitiesUpdate' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> FloodlightActivity -- ^ 'fauPayload' -> FloodlightActivitiesUpdate floodlightActivitiesUpdate pFauProFileId_ pFauPayload_ = - FloodlightActivitiesUpdate' - { _fauProFileId = _Coerce # pFauProFileId_ - , _fauPayload = pFauPayload_ - } + FloodlightActivitiesUpdate' + {_fauProFileId = _Coerce # pFauProFileId_, _fauPayload = pFauPayload_} + -- | User profile ID associated with this request. fauProFileId :: Lens' FloodlightActivitiesUpdate Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/FloodlightActivityGroups/Get.hs b/gen/Network/Google/Resource/DFAReporting/FloodlightActivityGroups/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/FloodlightActivityGroups/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/FloodlightActivityGroups/Get.hs @@ -44,7 +44,7 @@ -- 'FloodlightActivityGroupsGet' request conforms to. type FloodlightActivityGroupsGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "floodlightActivityGroups" :> @@ -55,11 +55,14 @@ -- | Gets one floodlight activity group by ID. -- -- /See:/ 'floodlightActivityGroupsGet' smart constructor. -data FloodlightActivityGroupsGet = FloodlightActivityGroupsGet' +data FloodlightActivityGroupsGet = + FloodlightActivityGroupsGet' { _faggProFileId :: !(Textual Int64) , _faggId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'FloodlightActivityGroupsGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> Int64 -- ^ 'faggId' -> FloodlightActivityGroupsGet floodlightActivityGroupsGet pFaggProFileId_ pFaggId_ = - FloodlightActivityGroupsGet' - { _faggProFileId = _Coerce # pFaggProFileId_ - , _faggId = _Coerce # pFaggId_ - } + FloodlightActivityGroupsGet' + {_faggProFileId = _Coerce # pFaggProFileId_, _faggId = _Coerce # pFaggId_} + -- | User profile ID associated with this request. faggProFileId :: Lens' FloodlightActivityGroupsGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/FloodlightActivityGroups/Insert.hs b/gen/Network/Google/Resource/DFAReporting/FloodlightActivityGroups/Insert.hs --- a/gen/Network/Google/Resource/DFAReporting/FloodlightActivityGroups/Insert.hs +++ b/gen/Network/Google/Resource/DFAReporting/FloodlightActivityGroups/Insert.hs @@ -44,7 +44,7 @@ -- 'FloodlightActivityGroupsInsert' request conforms to. type FloodlightActivityGroupsInsertResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "floodlightActivityGroups" :> @@ -55,11 +55,14 @@ -- | Inserts a new floodlight activity group. -- -- /See:/ 'floodlightActivityGroupsInsert' smart constructor. -data FloodlightActivityGroupsInsert = FloodlightActivityGroupsInsert' +data FloodlightActivityGroupsInsert = + FloodlightActivityGroupsInsert' { _fagiProFileId :: !(Textual Int64) , _fagiPayload :: !FloodlightActivityGroup - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'FloodlightActivityGroupsInsert' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> FloodlightActivityGroup -- ^ 'fagiPayload' -> FloodlightActivityGroupsInsert floodlightActivityGroupsInsert pFagiProFileId_ pFagiPayload_ = - FloodlightActivityGroupsInsert' - { _fagiProFileId = _Coerce # pFagiProFileId_ - , _fagiPayload = pFagiPayload_ - } + FloodlightActivityGroupsInsert' + {_fagiProFileId = _Coerce # pFagiProFileId_, _fagiPayload = pFagiPayload_} + -- | User profile ID associated with this request. fagiProFileId :: Lens' FloodlightActivityGroupsInsert Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/FloodlightActivityGroups/List.hs b/gen/Network/Google/Resource/DFAReporting/FloodlightActivityGroups/List.hs --- a/gen/Network/Google/Resource/DFAReporting/FloodlightActivityGroups/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/FloodlightActivityGroups/List.hs @@ -53,7 +53,7 @@ -- 'FloodlightActivityGroupsList' request conforms to. type FloodlightActivityGroupsListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "floodlightActivityGroups" :> @@ -81,7 +81,8 @@ -- method supports paging. -- -- /See:/ 'floodlightActivityGroupsList' smart constructor. -data FloodlightActivityGroupsList = FloodlightActivityGroupsList' +data FloodlightActivityGroupsList = + FloodlightActivityGroupsList' { _faglFloodlightConfigurationId :: !(Maybe (Textual Int64)) , _faglAdvertiserId :: !(Maybe (Textual Int64)) , _faglSearchString :: !(Maybe Text) @@ -92,8 +93,10 @@ , _faglSortField :: !FloodlightActivityGroupsListSortField , _faglType :: !(Maybe FloodlightActivityGroupsListType) , _faglMaxResults :: !(Textual Int32) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'FloodlightActivityGroupsList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -121,7 +124,7 @@ :: Int64 -- ^ 'faglProFileId' -> FloodlightActivityGroupsList floodlightActivityGroupsList pFaglProFileId_ = - FloodlightActivityGroupsList' + FloodlightActivityGroupsList' { _faglFloodlightConfigurationId = Nothing , _faglAdvertiserId = Nothing , _faglSearchString = Nothing @@ -133,6 +136,7 @@ , _faglType = Nothing , _faglMaxResults = 1000 } + -- | Select only floodlight activity groups with the specified floodlight -- configuration ID. Must specify either advertiserId, or diff --git a/gen/Network/Google/Resource/DFAReporting/FloodlightActivityGroups/Patch.hs b/gen/Network/Google/Resource/DFAReporting/FloodlightActivityGroups/Patch.hs --- a/gen/Network/Google/Resource/DFAReporting/FloodlightActivityGroups/Patch.hs +++ b/gen/Network/Google/Resource/DFAReporting/FloodlightActivityGroups/Patch.hs @@ -46,7 +46,7 @@ -- 'FloodlightActivityGroupsPatch' request conforms to. type FloodlightActivityGroupsPatchResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "floodlightActivityGroups" :> @@ -59,12 +59,15 @@ -- patch semantics. -- -- /See:/ 'floodlightActivityGroupsPatch' smart constructor. -data FloodlightActivityGroupsPatch = FloodlightActivityGroupsPatch' +data FloodlightActivityGroupsPatch = + FloodlightActivityGroupsPatch' { _fagpProFileId :: !(Textual Int64) , _fagpPayload :: !FloodlightActivityGroup , _fagpId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'FloodlightActivityGroupsPatch' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -80,11 +83,12 @@ -> Int64 -- ^ 'fagpId' -> FloodlightActivityGroupsPatch floodlightActivityGroupsPatch pFagpProFileId_ pFagpPayload_ pFagpId_ = - FloodlightActivityGroupsPatch' + FloodlightActivityGroupsPatch' { _fagpProFileId = _Coerce # pFagpProFileId_ , _fagpPayload = pFagpPayload_ , _fagpId = _Coerce # pFagpId_ } + -- | User profile ID associated with this request. fagpProFileId :: Lens' FloodlightActivityGroupsPatch Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/FloodlightActivityGroups/Update.hs b/gen/Network/Google/Resource/DFAReporting/FloodlightActivityGroups/Update.hs --- a/gen/Network/Google/Resource/DFAReporting/FloodlightActivityGroups/Update.hs +++ b/gen/Network/Google/Resource/DFAReporting/FloodlightActivityGroups/Update.hs @@ -44,7 +44,7 @@ -- 'FloodlightActivityGroupsUpdate' request conforms to. type FloodlightActivityGroupsUpdateResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "floodlightActivityGroups" :> @@ -55,11 +55,14 @@ -- | Updates an existing floodlight activity group. -- -- /See:/ 'floodlightActivityGroupsUpdate' smart constructor. -data FloodlightActivityGroupsUpdate = FloodlightActivityGroupsUpdate' +data FloodlightActivityGroupsUpdate = + FloodlightActivityGroupsUpdate' { _faguProFileId :: !(Textual Int64) , _faguPayload :: !FloodlightActivityGroup - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'FloodlightActivityGroupsUpdate' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> FloodlightActivityGroup -- ^ 'faguPayload' -> FloodlightActivityGroupsUpdate floodlightActivityGroupsUpdate pFaguProFileId_ pFaguPayload_ = - FloodlightActivityGroupsUpdate' - { _faguProFileId = _Coerce # pFaguProFileId_ - , _faguPayload = pFaguPayload_ - } + FloodlightActivityGroupsUpdate' + {_faguProFileId = _Coerce # pFaguProFileId_, _faguPayload = pFaguPayload_} + -- | User profile ID associated with this request. faguProFileId :: Lens' FloodlightActivityGroupsUpdate Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/FloodlightConfigurations/Get.hs b/gen/Network/Google/Resource/DFAReporting/FloodlightConfigurations/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/FloodlightConfigurations/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/FloodlightConfigurations/Get.hs @@ -44,7 +44,7 @@ -- 'FloodlightConfigurationsGet' request conforms to. type FloodlightConfigurationsGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "floodlightConfigurations" :> @@ -55,11 +55,14 @@ -- | Gets one floodlight configuration by ID. -- -- /See:/ 'floodlightConfigurationsGet' smart constructor. -data FloodlightConfigurationsGet = FloodlightConfigurationsGet' +data FloodlightConfigurationsGet = + FloodlightConfigurationsGet' { _fcgProFileId :: !(Textual Int64) , _fcgId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'FloodlightConfigurationsGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> Int64 -- ^ 'fcgId' -> FloodlightConfigurationsGet floodlightConfigurationsGet pFcgProFileId_ pFcgId_ = - FloodlightConfigurationsGet' - { _fcgProFileId = _Coerce # pFcgProFileId_ - , _fcgId = _Coerce # pFcgId_ - } + FloodlightConfigurationsGet' + {_fcgProFileId = _Coerce # pFcgProFileId_, _fcgId = _Coerce # pFcgId_} + -- | User profile ID associated with this request. fcgProFileId :: Lens' FloodlightConfigurationsGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/FloodlightConfigurations/List.hs b/gen/Network/Google/Resource/DFAReporting/FloodlightConfigurations/List.hs --- a/gen/Network/Google/Resource/DFAReporting/FloodlightConfigurations/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/FloodlightConfigurations/List.hs @@ -44,7 +44,7 @@ -- 'FloodlightConfigurationsList' request conforms to. type FloodlightConfigurationsListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "floodlightConfigurations" :> @@ -55,11 +55,14 @@ -- | Retrieves a list of floodlight configurations, possibly filtered. -- -- /See:/ 'floodlightConfigurationsList' smart constructor. -data FloodlightConfigurationsList = FloodlightConfigurationsList' +data FloodlightConfigurationsList = + FloodlightConfigurationsList' { _fclIds :: !(Maybe [Textual Int64]) , _fclProFileId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'FloodlightConfigurationsList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ :: Int64 -- ^ 'fclProFileId' -> FloodlightConfigurationsList floodlightConfigurationsList pFclProFileId_ = - FloodlightConfigurationsList' - { _fclIds = Nothing - , _fclProFileId = _Coerce # pFclProFileId_ - } + FloodlightConfigurationsList' + {_fclIds = Nothing, _fclProFileId = _Coerce # pFclProFileId_} + -- | Set of IDs of floodlight configurations to retrieve. Required field; -- otherwise an empty list will be returned. diff --git a/gen/Network/Google/Resource/DFAReporting/FloodlightConfigurations/Patch.hs b/gen/Network/Google/Resource/DFAReporting/FloodlightConfigurations/Patch.hs --- a/gen/Network/Google/Resource/DFAReporting/FloodlightConfigurations/Patch.hs +++ b/gen/Network/Google/Resource/DFAReporting/FloodlightConfigurations/Patch.hs @@ -46,7 +46,7 @@ -- 'FloodlightConfigurationsPatch' request conforms to. type FloodlightConfigurationsPatchResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "floodlightConfigurations" :> @@ -59,12 +59,15 @@ -- semantics. -- -- /See:/ 'floodlightConfigurationsPatch' smart constructor. -data FloodlightConfigurationsPatch = FloodlightConfigurationsPatch' +data FloodlightConfigurationsPatch = + FloodlightConfigurationsPatch' { _fcpProFileId :: !(Textual Int64) , _fcpPayload :: !FloodlightConfiguration , _fcpId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'FloodlightConfigurationsPatch' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -80,11 +83,12 @@ -> Int64 -- ^ 'fcpId' -> FloodlightConfigurationsPatch floodlightConfigurationsPatch pFcpProFileId_ pFcpPayload_ pFcpId_ = - FloodlightConfigurationsPatch' + FloodlightConfigurationsPatch' { _fcpProFileId = _Coerce # pFcpProFileId_ , _fcpPayload = pFcpPayload_ , _fcpId = _Coerce # pFcpId_ } + -- | User profile ID associated with this request. fcpProFileId :: Lens' FloodlightConfigurationsPatch Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/FloodlightConfigurations/Update.hs b/gen/Network/Google/Resource/DFAReporting/FloodlightConfigurations/Update.hs --- a/gen/Network/Google/Resource/DFAReporting/FloodlightConfigurations/Update.hs +++ b/gen/Network/Google/Resource/DFAReporting/FloodlightConfigurations/Update.hs @@ -44,7 +44,7 @@ -- 'FloodlightConfigurationsUpdate' request conforms to. type FloodlightConfigurationsUpdateResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "floodlightConfigurations" :> @@ -55,11 +55,14 @@ -- | Updates an existing floodlight configuration. -- -- /See:/ 'floodlightConfigurationsUpdate' smart constructor. -data FloodlightConfigurationsUpdate = FloodlightConfigurationsUpdate' +data FloodlightConfigurationsUpdate = + FloodlightConfigurationsUpdate' { _fcuProFileId :: !(Textual Int64) , _fcuPayload :: !FloodlightConfiguration - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'FloodlightConfigurationsUpdate' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> FloodlightConfiguration -- ^ 'fcuPayload' -> FloodlightConfigurationsUpdate floodlightConfigurationsUpdate pFcuProFileId_ pFcuPayload_ = - FloodlightConfigurationsUpdate' - { _fcuProFileId = _Coerce # pFcuProFileId_ - , _fcuPayload = pFcuPayload_ - } + FloodlightConfigurationsUpdate' + {_fcuProFileId = _Coerce # pFcuProFileId_, _fcuPayload = pFcuPayload_} + -- | User profile ID associated with this request. fcuProFileId :: Lens' FloodlightConfigurationsUpdate Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/InventoryItems/Get.hs b/gen/Network/Google/Resource/DFAReporting/InventoryItems/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/InventoryItems/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/InventoryItems/Get.hs @@ -45,7 +45,7 @@ -- 'InventoryItemsGet' request conforms to. type InventoryItemsGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "projects" :> @@ -57,12 +57,15 @@ -- | Gets one inventory item by ID. -- -- /See:/ 'inventoryItemsGet' smart constructor. -data InventoryItemsGet = InventoryItemsGet' +data InventoryItemsGet = + InventoryItemsGet' { _iigProFileId :: !(Textual Int64) , _iigId :: !(Textual Int64) , _iigProjectId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'InventoryItemsGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -78,11 +81,12 @@ -> Int64 -- ^ 'iigProjectId' -> InventoryItemsGet inventoryItemsGet pIigProFileId_ pIigId_ pIigProjectId_ = - InventoryItemsGet' + InventoryItemsGet' { _iigProFileId = _Coerce # pIigProFileId_ , _iigId = _Coerce # pIigId_ , _iigProjectId = _Coerce # pIigProjectId_ } + -- | User profile ID associated with this request. iigProFileId :: Lens' InventoryItemsGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/InventoryItems/List.hs b/gen/Network/Google/Resource/DFAReporting/InventoryItems/List.hs --- a/gen/Network/Google/Resource/DFAReporting/InventoryItems/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/InventoryItems/List.hs @@ -54,7 +54,7 @@ -- 'InventoryItemsList' request conforms to. type InventoryItemsListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "projects" :> @@ -76,7 +76,8 @@ -- supports paging. -- -- /See:/ 'inventoryItemsList' smart constructor. -data InventoryItemsList = InventoryItemsList' +data InventoryItemsList = + InventoryItemsList' { _iilIds :: !(Maybe [Textual Int64]) , _iilProFileId :: !(Textual Int64) , _iilSortOrder :: !InventoryItemsListSortOrder @@ -88,8 +89,10 @@ , _iilOrderId :: !(Maybe [Textual Int64]) , _iilSiteId :: !(Maybe [Textual Int64]) , _iilMaxResults :: !(Textual Int32) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'InventoryItemsList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -120,7 +123,7 @@ -> Int64 -- ^ 'iilProjectId' -> InventoryItemsList inventoryItemsList pIilProFileId_ pIilProjectId_ = - InventoryItemsList' + InventoryItemsList' { _iilIds = Nothing , _iilProFileId = _Coerce # pIilProFileId_ , _iilSortOrder = IILSOAscending @@ -133,6 +136,7 @@ , _iilSiteId = Nothing , _iilMaxResults = 1000 } + -- | Select only inventory items with these IDs. iilIds :: Lens' InventoryItemsList [Int64] diff --git a/gen/Network/Google/Resource/DFAReporting/Languages/List.hs b/gen/Network/Google/Resource/DFAReporting/Languages/List.hs --- a/gen/Network/Google/Resource/DFAReporting/Languages/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/Languages/List.hs @@ -43,7 +43,7 @@ -- 'LanguagesList' request conforms to. type LanguagesListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "languages" :> @@ -53,10 +53,13 @@ -- | Retrieves a list of languages. -- -- /See:/ 'languagesList' smart constructor. -newtype LanguagesList = LanguagesList' +newtype LanguagesList = + LanguagesList' { _llProFileId :: Textual Int64 - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'LanguagesList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -66,9 +69,8 @@ :: Int64 -- ^ 'llProFileId' -> LanguagesList languagesList pLlProFileId_ = - LanguagesList' - { _llProFileId = _Coerce # pLlProFileId_ - } + LanguagesList' {_llProFileId = _Coerce # pLlProFileId_} + -- | User profile ID associated with this request. llProFileId :: Lens' LanguagesList Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Metros/List.hs b/gen/Network/Google/Resource/DFAReporting/Metros/List.hs --- a/gen/Network/Google/Resource/DFAReporting/Metros/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/Metros/List.hs @@ -43,7 +43,7 @@ -- 'MetrosList' request conforms to. type MetrosListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "metros" :> @@ -53,10 +53,13 @@ -- | Retrieves a list of metros. -- -- /See:/ 'metrosList' smart constructor. -newtype MetrosList = MetrosList' +newtype MetrosList = + MetrosList' { _mlProFileId :: Textual Int64 - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'MetrosList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -65,10 +68,8 @@ metrosList :: Int64 -- ^ 'mlProFileId' -> MetrosList -metrosList pMlProFileId_ = - MetrosList' - { _mlProFileId = _Coerce # pMlProFileId_ - } +metrosList pMlProFileId_ = MetrosList' {_mlProFileId = _Coerce # pMlProFileId_} + -- | User profile ID associated with this request. mlProFileId :: Lens' MetrosList Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/MobileApps/Get.hs b/gen/Network/Google/Resource/DFAReporting/MobileApps/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/MobileApps/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/MobileApps/Get.hs @@ -44,7 +44,7 @@ -- 'MobileAppsGet' request conforms to. type MobileAppsGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "mobileApps" :> @@ -54,11 +54,14 @@ -- | Gets one mobile app by ID. -- -- /See:/ 'mobileAppsGet' smart constructor. -data MobileAppsGet = MobileAppsGet' +data MobileAppsGet = + MobileAppsGet' { _magProFileId :: !(Textual Int64) , _magId :: !Text - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'MobileAppsGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,8 @@ -> Text -- ^ 'magId' -> MobileAppsGet mobileAppsGet pMagProFileId_ pMagId_ = - MobileAppsGet' - { _magProFileId = _Coerce # pMagProFileId_ - , _magId = pMagId_ - } + MobileAppsGet' {_magProFileId = _Coerce # pMagProFileId_, _magId = pMagId_} + -- | User profile ID associated with this request. magProFileId :: Lens' MobileAppsGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/MobileApps/List.hs b/gen/Network/Google/Resource/DFAReporting/MobileApps/List.hs --- a/gen/Network/Google/Resource/DFAReporting/MobileApps/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/MobileApps/List.hs @@ -48,7 +48,7 @@ -- 'MobileAppsList' request conforms to. type MobileAppsListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "mobileApps" :> @@ -64,15 +64,18 @@ -- | Retrieves list of available mobile apps. -- -- /See:/ 'mobileAppsList' smart constructor. -data MobileAppsList = MobileAppsList' +data MobileAppsList = + MobileAppsList' { _malDirectories :: !(Maybe [MobileAppsListDirectories]) , _malSearchString :: !(Maybe Text) , _malIds :: !(Maybe [Text]) , _malProFileId :: !(Textual Int64) , _malPageToken :: !(Maybe Text) , _malMaxResults :: !(Textual Int32) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'MobileAppsList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -92,7 +95,7 @@ :: Int64 -- ^ 'malProFileId' -> MobileAppsList mobileAppsList pMalProFileId_ = - MobileAppsList' + MobileAppsList' { _malDirectories = Nothing , _malSearchString = Nothing , _malIds = Nothing @@ -100,6 +103,7 @@ , _malPageToken = Nothing , _malMaxResults = 1000 } + -- | Select only apps from these directories. malDirectories :: Lens' MobileAppsList [MobileAppsListDirectories] diff --git a/gen/Network/Google/Resource/DFAReporting/MobileCarriers/Get.hs b/gen/Network/Google/Resource/DFAReporting/MobileCarriers/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/MobileCarriers/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/MobileCarriers/Get.hs @@ -44,7 +44,7 @@ -- 'MobileCarriersGet' request conforms to. type MobileCarriersGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "mobileCarriers" :> @@ -54,11 +54,14 @@ -- | Gets one mobile carrier by ID. -- -- /See:/ 'mobileCarriersGet' smart constructor. -data MobileCarriersGet = MobileCarriersGet' +data MobileCarriersGet = + MobileCarriersGet' { _mcgProFileId :: !(Textual Int64) , _mcgId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'MobileCarriersGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Int64 -- ^ 'mcgId' -> MobileCarriersGet mobileCarriersGet pMcgProFileId_ pMcgId_ = - MobileCarriersGet' - { _mcgProFileId = _Coerce # pMcgProFileId_ - , _mcgId = _Coerce # pMcgId_ - } + MobileCarriersGet' + {_mcgProFileId = _Coerce # pMcgProFileId_, _mcgId = _Coerce # pMcgId_} + -- | User profile ID associated with this request. mcgProFileId :: Lens' MobileCarriersGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/MobileCarriers/List.hs b/gen/Network/Google/Resource/DFAReporting/MobileCarriers/List.hs --- a/gen/Network/Google/Resource/DFAReporting/MobileCarriers/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/MobileCarriers/List.hs @@ -43,7 +43,7 @@ -- 'MobileCarriersList' request conforms to. type MobileCarriersListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "mobileCarriers" :> @@ -53,10 +53,13 @@ -- | Retrieves a list of mobile carriers. -- -- /See:/ 'mobileCarriersList' smart constructor. -newtype MobileCarriersList = MobileCarriersList' +newtype MobileCarriersList = + MobileCarriersList' { _mclProFileId :: Textual Int64 - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'MobileCarriersList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -66,9 +69,8 @@ :: Int64 -- ^ 'mclProFileId' -> MobileCarriersList mobileCarriersList pMclProFileId_ = - MobileCarriersList' - { _mclProFileId = _Coerce # pMclProFileId_ - } + MobileCarriersList' {_mclProFileId = _Coerce # pMclProFileId_} + -- | User profile ID associated with this request. mclProFileId :: Lens' MobileCarriersList Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/OperatingSystemVersions/Get.hs b/gen/Network/Google/Resource/DFAReporting/OperatingSystemVersions/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/OperatingSystemVersions/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/OperatingSystemVersions/Get.hs @@ -44,7 +44,7 @@ -- 'OperatingSystemVersionsGet' request conforms to. type OperatingSystemVersionsGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "operatingSystemVersions" :> @@ -55,11 +55,14 @@ -- | Gets one operating system version by ID. -- -- /See:/ 'operatingSystemVersionsGet' smart constructor. -data OperatingSystemVersionsGet = OperatingSystemVersionsGet' +data OperatingSystemVersionsGet = + OperatingSystemVersionsGet' { _osvgProFileId :: !(Textual Int64) , _osvgId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'OperatingSystemVersionsGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> Int64 -- ^ 'osvgId' -> OperatingSystemVersionsGet operatingSystemVersionsGet pOsvgProFileId_ pOsvgId_ = - OperatingSystemVersionsGet' - { _osvgProFileId = _Coerce # pOsvgProFileId_ - , _osvgId = _Coerce # pOsvgId_ - } + OperatingSystemVersionsGet' + {_osvgProFileId = _Coerce # pOsvgProFileId_, _osvgId = _Coerce # pOsvgId_} + -- | User profile ID associated with this request. osvgProFileId :: Lens' OperatingSystemVersionsGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/OperatingSystemVersions/List.hs b/gen/Network/Google/Resource/DFAReporting/OperatingSystemVersions/List.hs --- a/gen/Network/Google/Resource/DFAReporting/OperatingSystemVersions/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/OperatingSystemVersions/List.hs @@ -43,7 +43,7 @@ -- 'OperatingSystemVersionsList' request conforms to. type OperatingSystemVersionsListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "operatingSystemVersions" :> @@ -53,10 +53,13 @@ -- | Retrieves a list of operating system versions. -- -- /See:/ 'operatingSystemVersionsList' smart constructor. -newtype OperatingSystemVersionsList = OperatingSystemVersionsList' +newtype OperatingSystemVersionsList = + OperatingSystemVersionsList' { _osvlProFileId :: Textual Int64 - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'OperatingSystemVersionsList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -66,9 +69,8 @@ :: Int64 -- ^ 'osvlProFileId' -> OperatingSystemVersionsList operatingSystemVersionsList pOsvlProFileId_ = - OperatingSystemVersionsList' - { _osvlProFileId = _Coerce # pOsvlProFileId_ - } + OperatingSystemVersionsList' {_osvlProFileId = _Coerce # pOsvlProFileId_} + -- | User profile ID associated with this request. osvlProFileId :: Lens' OperatingSystemVersionsList Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/OperatingSystems/Get.hs b/gen/Network/Google/Resource/DFAReporting/OperatingSystems/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/OperatingSystems/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/OperatingSystems/Get.hs @@ -44,7 +44,7 @@ -- 'OperatingSystemsGet' request conforms to. type OperatingSystemsGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "operatingSystems" :> @@ -55,11 +55,14 @@ -- | Gets one operating system by DART ID. -- -- /See:/ 'operatingSystemsGet' smart constructor. -data OperatingSystemsGet = OperatingSystemsGet' +data OperatingSystemsGet = + OperatingSystemsGet' { _osgProFileId :: !(Textual Int64) , _osgDartId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'OperatingSystemsGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,11 @@ -> Int64 -- ^ 'osgDartId' -> OperatingSystemsGet operatingSystemsGet pOsgProFileId_ pOsgDartId_ = - OperatingSystemsGet' + OperatingSystemsGet' { _osgProFileId = _Coerce # pOsgProFileId_ , _osgDartId = _Coerce # pOsgDartId_ } + -- | User profile ID associated with this request. osgProFileId :: Lens' OperatingSystemsGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/OperatingSystems/List.hs b/gen/Network/Google/Resource/DFAReporting/OperatingSystems/List.hs --- a/gen/Network/Google/Resource/DFAReporting/OperatingSystems/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/OperatingSystems/List.hs @@ -43,7 +43,7 @@ -- 'OperatingSystemsList' request conforms to. type OperatingSystemsListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "operatingSystems" :> @@ -53,10 +53,13 @@ -- | Retrieves a list of operating systems. -- -- /See:/ 'operatingSystemsList' smart constructor. -newtype OperatingSystemsList = OperatingSystemsList' +newtype OperatingSystemsList = + OperatingSystemsList' { _oslProFileId :: Textual Int64 - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'OperatingSystemsList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -66,9 +69,8 @@ :: Int64 -- ^ 'oslProFileId' -> OperatingSystemsList operatingSystemsList pOslProFileId_ = - OperatingSystemsList' - { _oslProFileId = _Coerce # pOslProFileId_ - } + OperatingSystemsList' {_oslProFileId = _Coerce # pOslProFileId_} + -- | User profile ID associated with this request. oslProFileId :: Lens' OperatingSystemsList Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/OrderDocuments/Get.hs b/gen/Network/Google/Resource/DFAReporting/OrderDocuments/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/OrderDocuments/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/OrderDocuments/Get.hs @@ -45,7 +45,7 @@ -- 'OrderDocumentsGet' request conforms to. type OrderDocumentsGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "projects" :> @@ -57,12 +57,15 @@ -- | Gets one order document by ID. -- -- /See:/ 'orderDocumentsGet' smart constructor. -data OrderDocumentsGet = OrderDocumentsGet' +data OrderDocumentsGet = + OrderDocumentsGet' { _odgProFileId :: !(Textual Int64) , _odgId :: !(Textual Int64) , _odgProjectId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'OrderDocumentsGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -78,11 +81,12 @@ -> Int64 -- ^ 'odgProjectId' -> OrderDocumentsGet orderDocumentsGet pOdgProFileId_ pOdgId_ pOdgProjectId_ = - OrderDocumentsGet' + OrderDocumentsGet' { _odgProFileId = _Coerce # pOdgProFileId_ , _odgId = _Coerce # pOdgId_ , _odgProjectId = _Coerce # pOdgProjectId_ } + -- | User profile ID associated with this request. odgProFileId :: Lens' OrderDocumentsGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/OrderDocuments/List.hs b/gen/Network/Google/Resource/DFAReporting/OrderDocuments/List.hs --- a/gen/Network/Google/Resource/DFAReporting/OrderDocuments/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/OrderDocuments/List.hs @@ -54,7 +54,7 @@ -- 'OrderDocumentsList' request conforms to. type OrderDocumentsListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "projects" :> @@ -76,7 +76,8 @@ -- supports paging. -- -- /See:/ 'orderDocumentsList' smart constructor. -data OrderDocumentsList = OrderDocumentsList' +data OrderDocumentsList = + OrderDocumentsList' { _odlSearchString :: !(Maybe Text) , _odlIds :: !(Maybe [Textual Int64]) , _odlProFileId :: !(Textual Int64) @@ -88,8 +89,10 @@ , _odlApproved :: !(Maybe Bool) , _odlSiteId :: !(Maybe [Textual Int64]) , _odlMaxResults :: !(Textual Int32) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'OrderDocumentsList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -120,7 +123,7 @@ -> Int64 -- ^ 'odlProjectId' -> OrderDocumentsList orderDocumentsList pOdlProFileId_ pOdlProjectId_ = - OrderDocumentsList' + OrderDocumentsList' { _odlSearchString = Nothing , _odlIds = Nothing , _odlProFileId = _Coerce # pOdlProFileId_ @@ -133,6 +136,7 @@ , _odlSiteId = Nothing , _odlMaxResults = 1000 } + -- | Allows searching for order documents by name or ID. Wildcards (*) are -- allowed. For example, \"orderdocument*2015\" will return order documents diff --git a/gen/Network/Google/Resource/DFAReporting/Orders/Get.hs b/gen/Network/Google/Resource/DFAReporting/Orders/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/Orders/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/Orders/Get.hs @@ -45,7 +45,7 @@ -- 'OrdersGet' request conforms to. type OrdersGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "projects" :> @@ -57,12 +57,15 @@ -- | Gets one order by ID. -- -- /See:/ 'ordersGet' smart constructor. -data OrdersGet = OrdersGet' +data OrdersGet = + OrdersGet' { _ogProFileId :: !(Textual Int64) , _ogId :: !(Textual Int64) , _ogProjectId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'OrdersGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -78,11 +81,12 @@ -> Int64 -- ^ 'ogProjectId' -> OrdersGet ordersGet pOgProFileId_ pOgId_ pOgProjectId_ = - OrdersGet' + OrdersGet' { _ogProFileId = _Coerce # pOgProFileId_ , _ogId = _Coerce # pOgId_ , _ogProjectId = _Coerce # pOgProjectId_ } + -- | User profile ID associated with this request. ogProFileId :: Lens' OrdersGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Orders/List.hs b/gen/Network/Google/Resource/DFAReporting/Orders/List.hs --- a/gen/Network/Google/Resource/DFAReporting/Orders/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/Orders/List.hs @@ -52,7 +52,7 @@ -- 'OrdersList' request conforms to. type OrdersListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "projects" :> @@ -72,7 +72,8 @@ -- paging. -- -- /See:/ 'ordersList' smart constructor. -data OrdersList = OrdersList' +data OrdersList = + OrdersList' { _olSearchString :: !(Maybe Text) , _olIds :: !(Maybe [Textual Int64]) , _olProFileId :: !(Textual Int64) @@ -82,8 +83,10 @@ , _olSortField :: !OrdersListSortField , _olSiteId :: !(Maybe [Textual Int64]) , _olMaxResults :: !(Textual Int32) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'OrdersList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -110,7 +113,7 @@ -> Int64 -- ^ 'olProjectId' -> OrdersList ordersList pOlProFileId_ pOlProjectId_ = - OrdersList' + OrdersList' { _olSearchString = Nothing , _olIds = Nothing , _olProFileId = _Coerce # pOlProFileId_ @@ -121,6 +124,7 @@ , _olSiteId = Nothing , _olMaxResults = 1000 } + -- | Allows searching for orders by name or ID. Wildcards (*) are allowed. -- For example, \"order*2015\" will return orders with names like \"order diff --git a/gen/Network/Google/Resource/DFAReporting/PlacementGroups/Get.hs b/gen/Network/Google/Resource/DFAReporting/PlacementGroups/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/PlacementGroups/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/PlacementGroups/Get.hs @@ -44,7 +44,7 @@ -- 'PlacementGroupsGet' request conforms to. type PlacementGroupsGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "placementGroups" :> @@ -55,11 +55,14 @@ -- | Gets one placement group by ID. -- -- /See:/ 'placementGroupsGet' smart constructor. -data PlacementGroupsGet = PlacementGroupsGet' +data PlacementGroupsGet = + PlacementGroupsGet' { _pggProFileId :: !(Textual Int64) , _pggId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'PlacementGroupsGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> Int64 -- ^ 'pggId' -> PlacementGroupsGet placementGroupsGet pPggProFileId_ pPggId_ = - PlacementGroupsGet' - { _pggProFileId = _Coerce # pPggProFileId_ - , _pggId = _Coerce # pPggId_ - } + PlacementGroupsGet' + {_pggProFileId = _Coerce # pPggProFileId_, _pggId = _Coerce # pPggId_} + -- | User profile ID associated with this request. pggProFileId :: Lens' PlacementGroupsGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/PlacementGroups/Insert.hs b/gen/Network/Google/Resource/DFAReporting/PlacementGroups/Insert.hs --- a/gen/Network/Google/Resource/DFAReporting/PlacementGroups/Insert.hs +++ b/gen/Network/Google/Resource/DFAReporting/PlacementGroups/Insert.hs @@ -44,7 +44,7 @@ -- 'PlacementGroupsInsert' request conforms to. type PlacementGroupsInsertResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "placementGroups" :> @@ -55,11 +55,14 @@ -- | Inserts a new placement group. -- -- /See:/ 'placementGroupsInsert' smart constructor. -data PlacementGroupsInsert = PlacementGroupsInsert' +data PlacementGroupsInsert = + PlacementGroupsInsert' { _pgiProFileId :: !(Textual Int64) , _pgiPayload :: !PlacementGroup - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'PlacementGroupsInsert' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> PlacementGroup -- ^ 'pgiPayload' -> PlacementGroupsInsert placementGroupsInsert pPgiProFileId_ pPgiPayload_ = - PlacementGroupsInsert' - { _pgiProFileId = _Coerce # pPgiProFileId_ - , _pgiPayload = pPgiPayload_ - } + PlacementGroupsInsert' + {_pgiProFileId = _Coerce # pPgiProFileId_, _pgiPayload = pPgiPayload_} + -- | User profile ID associated with this request. pgiProFileId :: Lens' PlacementGroupsInsert Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/PlacementGroups/List.hs b/gen/Network/Google/Resource/DFAReporting/PlacementGroups/List.hs --- a/gen/Network/Google/Resource/DFAReporting/PlacementGroups/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/PlacementGroups/List.hs @@ -63,7 +63,7 @@ -- 'PlacementGroupsList' request conforms to. type PlacementGroupsListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "placementGroups" :> @@ -107,7 +107,8 @@ -- supports paging. -- -- /See:/ 'placementGroupsList' smart constructor. -data PlacementGroupsList = PlacementGroupsList' +data PlacementGroupsList = + PlacementGroupsList' { _pglPlacementStrategyIds :: !(Maybe [Textual Int64]) , _pglContentCategoryIds :: !(Maybe [Textual Int64]) , _pglMaxEndDate :: !(Maybe Text) @@ -128,8 +129,10 @@ , _pglArchived :: !(Maybe Bool) , _pglMaxResults :: !(Textual Int32) , _pglMinEndDate :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'PlacementGroupsList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -177,7 +180,7 @@ :: Int64 -- ^ 'pglProFileId' -> PlacementGroupsList placementGroupsList pPglProFileId_ = - PlacementGroupsList' + PlacementGroupsList' { _pglPlacementStrategyIds = Nothing , _pglContentCategoryIds = Nothing , _pglMaxEndDate = Nothing @@ -199,6 +202,7 @@ , _pglMaxResults = 800 , _pglMinEndDate = Nothing } + -- | Select only placement groups that are associated with these placement -- strategies. diff --git a/gen/Network/Google/Resource/DFAReporting/PlacementGroups/Patch.hs b/gen/Network/Google/Resource/DFAReporting/PlacementGroups/Patch.hs --- a/gen/Network/Google/Resource/DFAReporting/PlacementGroups/Patch.hs +++ b/gen/Network/Google/Resource/DFAReporting/PlacementGroups/Patch.hs @@ -46,7 +46,7 @@ -- 'PlacementGroupsPatch' request conforms to. type PlacementGroupsPatchResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "placementGroups" :> @@ -59,12 +59,15 @@ -- semantics. -- -- /See:/ 'placementGroupsPatch' smart constructor. -data PlacementGroupsPatch = PlacementGroupsPatch' +data PlacementGroupsPatch = + PlacementGroupsPatch' { _pgpProFileId :: !(Textual Int64) , _pgpPayload :: !PlacementGroup , _pgpId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'PlacementGroupsPatch' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -80,11 +83,12 @@ -> Int64 -- ^ 'pgpId' -> PlacementGroupsPatch placementGroupsPatch pPgpProFileId_ pPgpPayload_ pPgpId_ = - PlacementGroupsPatch' + PlacementGroupsPatch' { _pgpProFileId = _Coerce # pPgpProFileId_ , _pgpPayload = pPgpPayload_ , _pgpId = _Coerce # pPgpId_ } + -- | User profile ID associated with this request. pgpProFileId :: Lens' PlacementGroupsPatch Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/PlacementGroups/Update.hs b/gen/Network/Google/Resource/DFAReporting/PlacementGroups/Update.hs --- a/gen/Network/Google/Resource/DFAReporting/PlacementGroups/Update.hs +++ b/gen/Network/Google/Resource/DFAReporting/PlacementGroups/Update.hs @@ -44,7 +44,7 @@ -- 'PlacementGroupsUpdate' request conforms to. type PlacementGroupsUpdateResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "placementGroups" :> @@ -55,11 +55,14 @@ -- | Updates an existing placement group. -- -- /See:/ 'placementGroupsUpdate' smart constructor. -data PlacementGroupsUpdate = PlacementGroupsUpdate' +data PlacementGroupsUpdate = + PlacementGroupsUpdate' { _pguProFileId :: !(Textual Int64) , _pguPayload :: !PlacementGroup - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'PlacementGroupsUpdate' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> PlacementGroup -- ^ 'pguPayload' -> PlacementGroupsUpdate placementGroupsUpdate pPguProFileId_ pPguPayload_ = - PlacementGroupsUpdate' - { _pguProFileId = _Coerce # pPguProFileId_ - , _pguPayload = pPguPayload_ - } + PlacementGroupsUpdate' + {_pguProFileId = _Coerce # pPguProFileId_, _pguPayload = pPguPayload_} + -- | User profile ID associated with this request. pguProFileId :: Lens' PlacementGroupsUpdate Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/PlacementStrategies/Delete.hs b/gen/Network/Google/Resource/DFAReporting/PlacementStrategies/Delete.hs --- a/gen/Network/Google/Resource/DFAReporting/PlacementStrategies/Delete.hs +++ b/gen/Network/Google/Resource/DFAReporting/PlacementStrategies/Delete.hs @@ -44,7 +44,7 @@ -- 'PlacementStrategiesDelete' request conforms to. type PlacementStrategiesDeleteResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "placementStrategies" :> @@ -54,11 +54,14 @@ -- | Deletes an existing placement strategy. -- -- /See:/ 'placementStrategiesDelete' smart constructor. -data PlacementStrategiesDelete = PlacementStrategiesDelete' +data PlacementStrategiesDelete = + PlacementStrategiesDelete' { _psdProFileId :: !(Textual Int64) , _psdId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'PlacementStrategiesDelete' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Int64 -- ^ 'psdId' -> PlacementStrategiesDelete placementStrategiesDelete pPsdProFileId_ pPsdId_ = - PlacementStrategiesDelete' - { _psdProFileId = _Coerce # pPsdProFileId_ - , _psdId = _Coerce # pPsdId_ - } + PlacementStrategiesDelete' + {_psdProFileId = _Coerce # pPsdProFileId_, _psdId = _Coerce # pPsdId_} + -- | User profile ID associated with this request. psdProFileId :: Lens' PlacementStrategiesDelete Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/PlacementStrategies/Get.hs b/gen/Network/Google/Resource/DFAReporting/PlacementStrategies/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/PlacementStrategies/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/PlacementStrategies/Get.hs @@ -44,7 +44,7 @@ -- 'PlacementStrategiesGet' request conforms to. type PlacementStrategiesGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "placementStrategies" :> @@ -55,11 +55,14 @@ -- | Gets one placement strategy by ID. -- -- /See:/ 'placementStrategiesGet' smart constructor. -data PlacementStrategiesGet = PlacementStrategiesGet' +data PlacementStrategiesGet = + PlacementStrategiesGet' { _psgProFileId :: !(Textual Int64) , _psgId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'PlacementStrategiesGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> Int64 -- ^ 'psgId' -> PlacementStrategiesGet placementStrategiesGet pPsgProFileId_ pPsgId_ = - PlacementStrategiesGet' - { _psgProFileId = _Coerce # pPsgProFileId_ - , _psgId = _Coerce # pPsgId_ - } + PlacementStrategiesGet' + {_psgProFileId = _Coerce # pPsgProFileId_, _psgId = _Coerce # pPsgId_} + -- | User profile ID associated with this request. psgProFileId :: Lens' PlacementStrategiesGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/PlacementStrategies/Insert.hs b/gen/Network/Google/Resource/DFAReporting/PlacementStrategies/Insert.hs --- a/gen/Network/Google/Resource/DFAReporting/PlacementStrategies/Insert.hs +++ b/gen/Network/Google/Resource/DFAReporting/PlacementStrategies/Insert.hs @@ -44,7 +44,7 @@ -- 'PlacementStrategiesInsert' request conforms to. type PlacementStrategiesInsertResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "placementStrategies" :> @@ -55,11 +55,14 @@ -- | Inserts a new placement strategy. -- -- /See:/ 'placementStrategiesInsert' smart constructor. -data PlacementStrategiesInsert = PlacementStrategiesInsert' +data PlacementStrategiesInsert = + PlacementStrategiesInsert' { _psiProFileId :: !(Textual Int64) , _psiPayload :: !PlacementStrategy - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'PlacementStrategiesInsert' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> PlacementStrategy -- ^ 'psiPayload' -> PlacementStrategiesInsert placementStrategiesInsert pPsiProFileId_ pPsiPayload_ = - PlacementStrategiesInsert' - { _psiProFileId = _Coerce # pPsiProFileId_ - , _psiPayload = pPsiPayload_ - } + PlacementStrategiesInsert' + {_psiProFileId = _Coerce # pPsiProFileId_, _psiPayload = pPsiPayload_} + -- | User profile ID associated with this request. psiProFileId :: Lens' PlacementStrategiesInsert Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/PlacementStrategies/List.hs b/gen/Network/Google/Resource/DFAReporting/PlacementStrategies/List.hs --- a/gen/Network/Google/Resource/DFAReporting/PlacementStrategies/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/PlacementStrategies/List.hs @@ -50,7 +50,7 @@ -- 'PlacementStrategiesList' request conforms to. type PlacementStrategiesListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "placementStrategies" :> @@ -71,7 +71,8 @@ -- supports paging. -- -- /See:/ 'placementStrategiesList' smart constructor. -data PlacementStrategiesList = PlacementStrategiesList' +data PlacementStrategiesList = + PlacementStrategiesList' { _pslSearchString :: !(Maybe Text) , _pslIds :: !(Maybe [Textual Int64]) , _pslProFileId :: !(Textual Int64) @@ -79,8 +80,10 @@ , _pslPageToken :: !(Maybe Text) , _pslSortField :: !PlacementStrategiesListSortField , _pslMaxResults :: !(Textual Int32) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'PlacementStrategiesList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -102,7 +105,7 @@ :: Int64 -- ^ 'pslProFileId' -> PlacementStrategiesList placementStrategiesList pPslProFileId_ = - PlacementStrategiesList' + PlacementStrategiesList' { _pslSearchString = Nothing , _pslIds = Nothing , _pslProFileId = _Coerce # pPslProFileId_ @@ -111,6 +114,7 @@ , _pslSortField = PSLSFID , _pslMaxResults = 1000 } + -- | Allows searching for objects by name or ID. Wildcards (*) are allowed. -- For example, \"placementstrategy*2015\" will return objects with names diff --git a/gen/Network/Google/Resource/DFAReporting/PlacementStrategies/Patch.hs b/gen/Network/Google/Resource/DFAReporting/PlacementStrategies/Patch.hs --- a/gen/Network/Google/Resource/DFAReporting/PlacementStrategies/Patch.hs +++ b/gen/Network/Google/Resource/DFAReporting/PlacementStrategies/Patch.hs @@ -46,7 +46,7 @@ -- 'PlacementStrategiesPatch' request conforms to. type PlacementStrategiesPatchResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "placementStrategies" :> @@ -59,12 +59,15 @@ -- semantics. -- -- /See:/ 'placementStrategiesPatch' smart constructor. -data PlacementStrategiesPatch = PlacementStrategiesPatch' +data PlacementStrategiesPatch = + PlacementStrategiesPatch' { _pspProFileId :: !(Textual Int64) , _pspPayload :: !PlacementStrategy , _pspId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'PlacementStrategiesPatch' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -80,11 +83,12 @@ -> Int64 -- ^ 'pspId' -> PlacementStrategiesPatch placementStrategiesPatch pPspProFileId_ pPspPayload_ pPspId_ = - PlacementStrategiesPatch' + PlacementStrategiesPatch' { _pspProFileId = _Coerce # pPspProFileId_ , _pspPayload = pPspPayload_ , _pspId = _Coerce # pPspId_ } + -- | User profile ID associated with this request. pspProFileId :: Lens' PlacementStrategiesPatch Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/PlacementStrategies/Update.hs b/gen/Network/Google/Resource/DFAReporting/PlacementStrategies/Update.hs --- a/gen/Network/Google/Resource/DFAReporting/PlacementStrategies/Update.hs +++ b/gen/Network/Google/Resource/DFAReporting/PlacementStrategies/Update.hs @@ -44,7 +44,7 @@ -- 'PlacementStrategiesUpdate' request conforms to. type PlacementStrategiesUpdateResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "placementStrategies" :> @@ -55,11 +55,14 @@ -- | Updates an existing placement strategy. -- -- /See:/ 'placementStrategiesUpdate' smart constructor. -data PlacementStrategiesUpdate = PlacementStrategiesUpdate' +data PlacementStrategiesUpdate = + PlacementStrategiesUpdate' { _psuProFileId :: !(Textual Int64) , _psuPayload :: !PlacementStrategy - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'PlacementStrategiesUpdate' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> PlacementStrategy -- ^ 'psuPayload' -> PlacementStrategiesUpdate placementStrategiesUpdate pPsuProFileId_ pPsuPayload_ = - PlacementStrategiesUpdate' - { _psuProFileId = _Coerce # pPsuProFileId_ - , _psuPayload = pPsuPayload_ - } + PlacementStrategiesUpdate' + {_psuProFileId = _Coerce # pPsuProFileId_, _psuPayload = pPsuPayload_} + -- | User profile ID associated with this request. psuProFileId :: Lens' PlacementStrategiesUpdate Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Placements/Generatetags.hs b/gen/Network/Google/Resource/DFAReporting/Placements/Generatetags.hs --- a/gen/Network/Google/Resource/DFAReporting/Placements/Generatetags.hs +++ b/gen/Network/Google/Resource/DFAReporting/Placements/Generatetags.hs @@ -46,7 +46,7 @@ -- 'PlacementsGeneratetags' request conforms to. type PlacementsGeneratetagsResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "placements" :> @@ -62,13 +62,16 @@ -- | Generates tags for a placement. -- -- /See:/ 'placementsGeneratetags' smart constructor. -data PlacementsGeneratetags = PlacementsGeneratetags' +data PlacementsGeneratetags = + PlacementsGeneratetags' { _pgsTagFormats :: !(Maybe [PlacementsGeneratetagsTagFormats]) , _pgsCampaignId :: !(Maybe (Textual Int64)) , _pgsProFileId :: !(Textual Int64) , _pgsPlacementIds :: !(Maybe [Textual Int64]) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'PlacementsGeneratetags' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -84,12 +87,13 @@ :: Int64 -- ^ 'pgsProFileId' -> PlacementsGeneratetags placementsGeneratetags pPgsProFileId_ = - PlacementsGeneratetags' + PlacementsGeneratetags' { _pgsTagFormats = Nothing , _pgsCampaignId = Nothing , _pgsProFileId = _Coerce # pPgsProFileId_ , _pgsPlacementIds = Nothing } + -- | Tag formats to generate for these placements. Note: -- PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements. diff --git a/gen/Network/Google/Resource/DFAReporting/Placements/Get.hs b/gen/Network/Google/Resource/DFAReporting/Placements/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/Placements/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/Placements/Get.hs @@ -44,7 +44,7 @@ -- 'PlacementsGet' request conforms to. type PlacementsGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "placements" :> @@ -54,11 +54,14 @@ -- | Gets one placement by ID. -- -- /See:/ 'placementsGet' smart constructor. -data PlacementsGet = PlacementsGet' +data PlacementsGet = + PlacementsGet' { _pgProFileId :: !(Textual Int64) , _pgId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'PlacementsGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Int64 -- ^ 'pgId' -> PlacementsGet placementsGet pPgProFileId_ pPgId_ = - PlacementsGet' - { _pgProFileId = _Coerce # pPgProFileId_ - , _pgId = _Coerce # pPgId_ - } + PlacementsGet' + {_pgProFileId = _Coerce # pPgProFileId_, _pgId = _Coerce # pPgId_} + -- | User profile ID associated with this request. pgProFileId :: Lens' PlacementsGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Placements/Insert.hs b/gen/Network/Google/Resource/DFAReporting/Placements/Insert.hs --- a/gen/Network/Google/Resource/DFAReporting/Placements/Insert.hs +++ b/gen/Network/Google/Resource/DFAReporting/Placements/Insert.hs @@ -44,7 +44,7 @@ -- 'PlacementsInsert' request conforms to. type PlacementsInsertResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "placements" :> @@ -54,11 +54,14 @@ -- | Inserts a new placement. -- -- /See:/ 'placementsInsert' smart constructor. -data PlacementsInsert = PlacementsInsert' +data PlacementsInsert = + PlacementsInsert' { _piProFileId :: !(Textual Int64) , _piPayload :: !Placement - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'PlacementsInsert' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Placement -- ^ 'piPayload' -> PlacementsInsert placementsInsert pPiProFileId_ pPiPayload_ = - PlacementsInsert' - { _piProFileId = _Coerce # pPiProFileId_ - , _piPayload = pPiPayload_ - } + PlacementsInsert' + {_piProFileId = _Coerce # pPiProFileId_, _piPayload = pPiPayload_} + -- | User profile ID associated with this request. piProFileId :: Lens' PlacementsInsert Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Placements/List.hs b/gen/Network/Google/Resource/DFAReporting/Placements/List.hs --- a/gen/Network/Google/Resource/DFAReporting/Placements/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/Placements/List.hs @@ -66,7 +66,7 @@ -- 'PlacementsList' request conforms to. type PlacementsListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "placements" :> @@ -121,7 +121,8 @@ -- paging. -- -- /See:/ 'placementsList' smart constructor. -data PlacementsList = PlacementsList' +data PlacementsList = + PlacementsList' { _pPlacementStrategyIds :: !(Maybe [Textual Int64]) , _pContentCategoryIds :: !(Maybe [Textual Int64]) , _pMaxEndDate :: !(Maybe Text) @@ -145,8 +146,10 @@ , _pArchived :: !(Maybe Bool) , _pMaxResults :: !(Textual Int32) , _pMinEndDate :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'PlacementsList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -200,7 +203,7 @@ :: Int64 -- ^ 'pProFileId' -> PlacementsList placementsList pPProFileId_ = - PlacementsList' + PlacementsList' { _pPlacementStrategyIds = Nothing , _pContentCategoryIds = Nothing , _pMaxEndDate = Nothing @@ -225,6 +228,7 @@ , _pMaxResults = 1000 , _pMinEndDate = Nothing } + -- | Select only placements that are associated with these placement -- strategies. diff --git a/gen/Network/Google/Resource/DFAReporting/Placements/Patch.hs b/gen/Network/Google/Resource/DFAReporting/Placements/Patch.hs --- a/gen/Network/Google/Resource/DFAReporting/Placements/Patch.hs +++ b/gen/Network/Google/Resource/DFAReporting/Placements/Patch.hs @@ -45,7 +45,7 @@ -- 'PlacementsPatch' request conforms to. type PlacementsPatchResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "placements" :> @@ -56,12 +56,15 @@ -- | Updates an existing placement. This method supports patch semantics. -- -- /See:/ 'placementsPatch' smart constructor. -data PlacementsPatch = PlacementsPatch' +data PlacementsPatch = + PlacementsPatch' { _ppProFileId :: !(Textual Int64) , _ppPayload :: !Placement , _ppId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'PlacementsPatch' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -77,11 +80,12 @@ -> Int64 -- ^ 'ppId' -> PlacementsPatch placementsPatch pPpProFileId_ pPpPayload_ pPpId_ = - PlacementsPatch' + PlacementsPatch' { _ppProFileId = _Coerce # pPpProFileId_ , _ppPayload = pPpPayload_ , _ppId = _Coerce # pPpId_ } + -- | User profile ID associated with this request. ppProFileId :: Lens' PlacementsPatch Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Placements/Update.hs b/gen/Network/Google/Resource/DFAReporting/Placements/Update.hs --- a/gen/Network/Google/Resource/DFAReporting/Placements/Update.hs +++ b/gen/Network/Google/Resource/DFAReporting/Placements/Update.hs @@ -44,7 +44,7 @@ -- 'PlacementsUpdate' request conforms to. type PlacementsUpdateResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "placements" :> @@ -54,11 +54,14 @@ -- | Updates an existing placement. -- -- /See:/ 'placementsUpdate' smart constructor. -data PlacementsUpdate = PlacementsUpdate' +data PlacementsUpdate = + PlacementsUpdate' { _puProFileId :: !(Textual Int64) , _puPayload :: !Placement - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'PlacementsUpdate' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Placement -- ^ 'puPayload' -> PlacementsUpdate placementsUpdate pPuProFileId_ pPuPayload_ = - PlacementsUpdate' - { _puProFileId = _Coerce # pPuProFileId_ - , _puPayload = pPuPayload_ - } + PlacementsUpdate' + {_puProFileId = _Coerce # pPuProFileId_, _puPayload = pPuPayload_} + -- | User profile ID associated with this request. puProFileId :: Lens' PlacementsUpdate Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/PlatformTypes/Get.hs b/gen/Network/Google/Resource/DFAReporting/PlatformTypes/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/PlatformTypes/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/PlatformTypes/Get.hs @@ -44,7 +44,7 @@ -- 'PlatformTypesGet' request conforms to. type PlatformTypesGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "platformTypes" :> @@ -54,11 +54,14 @@ -- | Gets one platform type by ID. -- -- /See:/ 'platformTypesGet' smart constructor. -data PlatformTypesGet = PlatformTypesGet' +data PlatformTypesGet = + PlatformTypesGet' { _ptgProFileId :: !(Textual Int64) , _ptgId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'PlatformTypesGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Int64 -- ^ 'ptgId' -> PlatformTypesGet platformTypesGet pPtgProFileId_ pPtgId_ = - PlatformTypesGet' - { _ptgProFileId = _Coerce # pPtgProFileId_ - , _ptgId = _Coerce # pPtgId_ - } + PlatformTypesGet' + {_ptgProFileId = _Coerce # pPtgProFileId_, _ptgId = _Coerce # pPtgId_} + -- | User profile ID associated with this request. ptgProFileId :: Lens' PlatformTypesGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/PlatformTypes/List.hs b/gen/Network/Google/Resource/DFAReporting/PlatformTypes/List.hs --- a/gen/Network/Google/Resource/DFAReporting/PlatformTypes/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/PlatformTypes/List.hs @@ -43,7 +43,7 @@ -- 'PlatformTypesList' request conforms to. type PlatformTypesListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "platformTypes" :> @@ -53,10 +53,13 @@ -- | Retrieves a list of platform types. -- -- /See:/ 'platformTypesList' smart constructor. -newtype PlatformTypesList = PlatformTypesList' +newtype PlatformTypesList = + PlatformTypesList' { _ptlProFileId :: Textual Int64 - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'PlatformTypesList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -66,9 +69,8 @@ :: Int64 -- ^ 'ptlProFileId' -> PlatformTypesList platformTypesList pPtlProFileId_ = - PlatformTypesList' - { _ptlProFileId = _Coerce # pPtlProFileId_ - } + PlatformTypesList' {_ptlProFileId = _Coerce # pPtlProFileId_} + -- | User profile ID associated with this request. ptlProFileId :: Lens' PlatformTypesList Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/PostalCodes/Get.hs b/gen/Network/Google/Resource/DFAReporting/PostalCodes/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/PostalCodes/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/PostalCodes/Get.hs @@ -44,7 +44,7 @@ -- 'PostalCodesGet' request conforms to. type PostalCodesGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "postalCodes" :> @@ -54,11 +54,14 @@ -- | Gets one postal code by ID. -- -- /See:/ 'postalCodesGet' smart constructor. -data PostalCodesGet = PostalCodesGet' +data PostalCodesGet = + PostalCodesGet' { _pcgProFileId :: !(Textual Int64) , _pcgCode :: !Text - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'PostalCodesGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Text -- ^ 'pcgCode' -> PostalCodesGet postalCodesGet pPcgProFileId_ pPcgCode_ = - PostalCodesGet' - { _pcgProFileId = _Coerce # pPcgProFileId_ - , _pcgCode = pPcgCode_ - } + PostalCodesGet' + {_pcgProFileId = _Coerce # pPcgProFileId_, _pcgCode = pPcgCode_} + -- | User profile ID associated with this request. pcgProFileId :: Lens' PostalCodesGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/PostalCodes/List.hs b/gen/Network/Google/Resource/DFAReporting/PostalCodes/List.hs --- a/gen/Network/Google/Resource/DFAReporting/PostalCodes/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/PostalCodes/List.hs @@ -43,7 +43,7 @@ -- 'PostalCodesList' request conforms to. type PostalCodesListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "postalCodes" :> @@ -53,10 +53,13 @@ -- | Retrieves a list of postal codes. -- -- /See:/ 'postalCodesList' smart constructor. -newtype PostalCodesList = PostalCodesList' +newtype PostalCodesList = + PostalCodesList' { _pclProFileId :: Textual Int64 - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'PostalCodesList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -66,9 +69,8 @@ :: Int64 -- ^ 'pclProFileId' -> PostalCodesList postalCodesList pPclProFileId_ = - PostalCodesList' - { _pclProFileId = _Coerce # pPclProFileId_ - } + PostalCodesList' {_pclProFileId = _Coerce # pPclProFileId_} + -- | User profile ID associated with this request. pclProFileId :: Lens' PostalCodesList Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Projects/Get.hs b/gen/Network/Google/Resource/DFAReporting/Projects/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/Projects/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/Projects/Get.hs @@ -44,7 +44,7 @@ -- 'ProjectsGet' request conforms to. type ProjectsGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "projects" :> @@ -54,11 +54,14 @@ -- | Gets one project by ID. -- -- /See:/ 'projectsGet' smart constructor. -data ProjectsGet = ProjectsGet' +data ProjectsGet = + ProjectsGet' { _proProFileId :: !(Textual Int64) , _proId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'ProjectsGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Int64 -- ^ 'proId' -> ProjectsGet projectsGet pProProFileId_ pProId_ = - ProjectsGet' - { _proProFileId = _Coerce # pProProFileId_ - , _proId = _Coerce # pProId_ - } + ProjectsGet' + {_proProFileId = _Coerce # pProProFileId_, _proId = _Coerce # pProId_} + -- | User profile ID associated with this request. proProFileId :: Lens' ProjectsGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Projects/List.hs b/gen/Network/Google/Resource/DFAReporting/Projects/List.hs --- a/gen/Network/Google/Resource/DFAReporting/Projects/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/Projects/List.hs @@ -51,7 +51,7 @@ -- 'ProjectsList' request conforms to. type ProjectsListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "projects" :> @@ -69,7 +69,8 @@ -- paging. -- -- /See:/ 'projectsList' smart constructor. -data ProjectsList = ProjectsList' +data ProjectsList = + ProjectsList' { _plSearchString :: !(Maybe Text) , _plIds :: !(Maybe [Textual Int64]) , _plProFileId :: !(Textual Int64) @@ -78,8 +79,10 @@ , _plSortField :: !ProjectsListSortField , _plAdvertiserIds :: !(Maybe [Textual Int64]) , _plMaxResults :: !(Textual Int32) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'ProjectsList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -103,7 +106,7 @@ :: Int64 -- ^ 'plProFileId' -> ProjectsList projectsList pPlProFileId_ = - ProjectsList' + ProjectsList' { _plSearchString = Nothing , _plIds = Nothing , _plProFileId = _Coerce # pPlProFileId_ @@ -113,6 +116,7 @@ , _plAdvertiserIds = Nothing , _plMaxResults = 1000 } + -- | Allows searching for projects by name or ID. Wildcards (*) are allowed. -- For example, \"project*2015\" will return projects with names like diff --git a/gen/Network/Google/Resource/DFAReporting/Regions/List.hs b/gen/Network/Google/Resource/DFAReporting/Regions/List.hs --- a/gen/Network/Google/Resource/DFAReporting/Regions/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/Regions/List.hs @@ -43,7 +43,7 @@ -- 'RegionsList' request conforms to. type RegionsListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "regions" :> @@ -53,10 +53,13 @@ -- | Retrieves a list of regions. -- -- /See:/ 'regionsList' smart constructor. -newtype RegionsList = RegionsList' +newtype RegionsList = + RegionsList' { _rProFileId :: Textual Int64 - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'RegionsList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -65,10 +68,8 @@ regionsList :: Int64 -- ^ 'rProFileId' -> RegionsList -regionsList pRProFileId_ = - RegionsList' - { _rProFileId = _Coerce # pRProFileId_ - } +regionsList pRProFileId_ = RegionsList' {_rProFileId = _Coerce # pRProFileId_} + -- | User profile ID associated with this request. rProFileId :: Lens' RegionsList Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/RemarketingListShares/Get.hs b/gen/Network/Google/Resource/DFAReporting/RemarketingListShares/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/RemarketingListShares/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/RemarketingListShares/Get.hs @@ -44,7 +44,7 @@ -- 'RemarketingListSharesGet' request conforms to. type RemarketingListSharesGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "remarketingListShares" :> @@ -55,11 +55,14 @@ -- | Gets one remarketing list share by remarketing list ID. -- -- /See:/ 'remarketingListSharesGet' smart constructor. -data RemarketingListSharesGet = RemarketingListSharesGet' +data RemarketingListSharesGet = + RemarketingListSharesGet' { _rlsgProFileId :: !(Textual Int64) , _rlsgRemarketingListId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'RemarketingListSharesGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,11 @@ -> Int64 -- ^ 'rlsgRemarketingListId' -> RemarketingListSharesGet remarketingListSharesGet pRlsgProFileId_ pRlsgRemarketingListId_ = - RemarketingListSharesGet' + RemarketingListSharesGet' { _rlsgProFileId = _Coerce # pRlsgProFileId_ , _rlsgRemarketingListId = _Coerce # pRlsgRemarketingListId_ } + -- | User profile ID associated with this request. rlsgProFileId :: Lens' RemarketingListSharesGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/RemarketingListShares/Patch.hs b/gen/Network/Google/Resource/DFAReporting/RemarketingListShares/Patch.hs --- a/gen/Network/Google/Resource/DFAReporting/RemarketingListShares/Patch.hs +++ b/gen/Network/Google/Resource/DFAReporting/RemarketingListShares/Patch.hs @@ -46,7 +46,7 @@ -- 'RemarketingListSharesPatch' request conforms to. type RemarketingListSharesPatchResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "remarketingListShares" :> @@ -59,12 +59,15 @@ -- semantics. -- -- /See:/ 'remarketingListSharesPatch' smart constructor. -data RemarketingListSharesPatch = RemarketingListSharesPatch' +data RemarketingListSharesPatch = + RemarketingListSharesPatch' { _rlspProFileId :: !(Textual Int64) , _rlspPayload :: !RemarketingListShare , _rlspRemarketingListId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'RemarketingListSharesPatch' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -80,11 +83,12 @@ -> Int64 -- ^ 'rlspRemarketingListId' -> RemarketingListSharesPatch remarketingListSharesPatch pRlspProFileId_ pRlspPayload_ pRlspRemarketingListId_ = - RemarketingListSharesPatch' + RemarketingListSharesPatch' { _rlspProFileId = _Coerce # pRlspProFileId_ , _rlspPayload = pRlspPayload_ , _rlspRemarketingListId = _Coerce # pRlspRemarketingListId_ } + -- | User profile ID associated with this request. rlspProFileId :: Lens' RemarketingListSharesPatch Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/RemarketingListShares/Update.hs b/gen/Network/Google/Resource/DFAReporting/RemarketingListShares/Update.hs --- a/gen/Network/Google/Resource/DFAReporting/RemarketingListShares/Update.hs +++ b/gen/Network/Google/Resource/DFAReporting/RemarketingListShares/Update.hs @@ -44,7 +44,7 @@ -- 'RemarketingListSharesUpdate' request conforms to. type RemarketingListSharesUpdateResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "remarketingListShares" :> @@ -55,11 +55,14 @@ -- | Updates an existing remarketing list share. -- -- /See:/ 'remarketingListSharesUpdate' smart constructor. -data RemarketingListSharesUpdate = RemarketingListSharesUpdate' +data RemarketingListSharesUpdate = + RemarketingListSharesUpdate' { _rlsuProFileId :: !(Textual Int64) , _rlsuPayload :: !RemarketingListShare - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'RemarketingListSharesUpdate' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> RemarketingListShare -- ^ 'rlsuPayload' -> RemarketingListSharesUpdate remarketingListSharesUpdate pRlsuProFileId_ pRlsuPayload_ = - RemarketingListSharesUpdate' - { _rlsuProFileId = _Coerce # pRlsuProFileId_ - , _rlsuPayload = pRlsuPayload_ - } + RemarketingListSharesUpdate' + {_rlsuProFileId = _Coerce # pRlsuProFileId_, _rlsuPayload = pRlsuPayload_} + -- | User profile ID associated with this request. rlsuProFileId :: Lens' RemarketingListSharesUpdate Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/RemarketingLists/Get.hs b/gen/Network/Google/Resource/DFAReporting/RemarketingLists/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/RemarketingLists/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/RemarketingLists/Get.hs @@ -44,7 +44,7 @@ -- 'RemarketingListsGet' request conforms to. type RemarketingListsGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "remarketingLists" :> @@ -55,11 +55,14 @@ -- | Gets one remarketing list by ID. -- -- /See:/ 'remarketingListsGet' smart constructor. -data RemarketingListsGet = RemarketingListsGet' +data RemarketingListsGet = + RemarketingListsGet' { _rlgProFileId :: !(Textual Int64) , _rlgId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'RemarketingListsGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> Int64 -- ^ 'rlgId' -> RemarketingListsGet remarketingListsGet pRlgProFileId_ pRlgId_ = - RemarketingListsGet' - { _rlgProFileId = _Coerce # pRlgProFileId_ - , _rlgId = _Coerce # pRlgId_ - } + RemarketingListsGet' + {_rlgProFileId = _Coerce # pRlgProFileId_, _rlgId = _Coerce # pRlgId_} + -- | User profile ID associated with this request. rlgProFileId :: Lens' RemarketingListsGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/RemarketingLists/Insert.hs b/gen/Network/Google/Resource/DFAReporting/RemarketingLists/Insert.hs --- a/gen/Network/Google/Resource/DFAReporting/RemarketingLists/Insert.hs +++ b/gen/Network/Google/Resource/DFAReporting/RemarketingLists/Insert.hs @@ -44,7 +44,7 @@ -- 'RemarketingListsInsert' request conforms to. type RemarketingListsInsertResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "remarketingLists" :> @@ -55,11 +55,14 @@ -- | Inserts a new remarketing list. -- -- /See:/ 'remarketingListsInsert' smart constructor. -data RemarketingListsInsert = RemarketingListsInsert' +data RemarketingListsInsert = + RemarketingListsInsert' { _rliProFileId :: !(Textual Int64) , _rliPayload :: !RemarketingList - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'RemarketingListsInsert' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> RemarketingList -- ^ 'rliPayload' -> RemarketingListsInsert remarketingListsInsert pRliProFileId_ pRliPayload_ = - RemarketingListsInsert' - { _rliProFileId = _Coerce # pRliProFileId_ - , _rliPayload = pRliPayload_ - } + RemarketingListsInsert' + {_rliProFileId = _Coerce # pRliProFileId_, _rliPayload = pRliPayload_} + -- | User profile ID associated with this request. rliProFileId :: Lens' RemarketingListsInsert Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/RemarketingLists/List.hs b/gen/Network/Google/Resource/DFAReporting/RemarketingLists/List.hs --- a/gen/Network/Google/Resource/DFAReporting/RemarketingLists/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/RemarketingLists/List.hs @@ -52,7 +52,7 @@ -- 'RemarketingListsList' request conforms to. type RemarketingListsListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "remarketingLists" :> @@ -73,7 +73,8 @@ -- supports paging. -- -- /See:/ 'remarketingListsList' smart constructor. -data RemarketingListsList = RemarketingListsList' +data RemarketingListsList = + RemarketingListsList' { _rllFloodlightActivityId :: !(Maybe (Textual Int64)) , _rllAdvertiserId :: !(Textual Int64) , _rllProFileId :: !(Textual Int64) @@ -83,8 +84,10 @@ , _rllPageToken :: !(Maybe Text) , _rllSortField :: !RemarketingListsListSortField , _rllMaxResults :: !(Textual Int32) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'RemarketingListsList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -111,7 +114,7 @@ -> Int64 -- ^ 'rllProFileId' -> RemarketingListsList remarketingListsList pRllAdvertiserId_ pRllProFileId_ = - RemarketingListsList' + RemarketingListsList' { _rllFloodlightActivityId = Nothing , _rllAdvertiserId = _Coerce # pRllAdvertiserId_ , _rllProFileId = _Coerce # pRllProFileId_ @@ -122,6 +125,7 @@ , _rllSortField = RLLSFID , _rllMaxResults = 1000 } + -- | Select only remarketing lists that have this floodlight activity ID. rllFloodlightActivityId :: Lens' RemarketingListsList (Maybe Int64) diff --git a/gen/Network/Google/Resource/DFAReporting/RemarketingLists/Patch.hs b/gen/Network/Google/Resource/DFAReporting/RemarketingLists/Patch.hs --- a/gen/Network/Google/Resource/DFAReporting/RemarketingLists/Patch.hs +++ b/gen/Network/Google/Resource/DFAReporting/RemarketingLists/Patch.hs @@ -46,7 +46,7 @@ -- 'RemarketingListsPatch' request conforms to. type RemarketingListsPatchResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "remarketingLists" :> @@ -59,12 +59,15 @@ -- semantics. -- -- /See:/ 'remarketingListsPatch' smart constructor. -data RemarketingListsPatch = RemarketingListsPatch' +data RemarketingListsPatch = + RemarketingListsPatch' { _rlpProFileId :: !(Textual Int64) , _rlpPayload :: !RemarketingList , _rlpId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'RemarketingListsPatch' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -80,11 +83,12 @@ -> Int64 -- ^ 'rlpId' -> RemarketingListsPatch remarketingListsPatch pRlpProFileId_ pRlpPayload_ pRlpId_ = - RemarketingListsPatch' + RemarketingListsPatch' { _rlpProFileId = _Coerce # pRlpProFileId_ , _rlpPayload = pRlpPayload_ , _rlpId = _Coerce # pRlpId_ } + -- | User profile ID associated with this request. rlpProFileId :: Lens' RemarketingListsPatch Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/RemarketingLists/Update.hs b/gen/Network/Google/Resource/DFAReporting/RemarketingLists/Update.hs --- a/gen/Network/Google/Resource/DFAReporting/RemarketingLists/Update.hs +++ b/gen/Network/Google/Resource/DFAReporting/RemarketingLists/Update.hs @@ -44,7 +44,7 @@ -- 'RemarketingListsUpdate' request conforms to. type RemarketingListsUpdateResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "remarketingLists" :> @@ -55,11 +55,14 @@ -- | Updates an existing remarketing list. -- -- /See:/ 'remarketingListsUpdate' smart constructor. -data RemarketingListsUpdate = RemarketingListsUpdate' +data RemarketingListsUpdate = + RemarketingListsUpdate' { _rluProFileId :: !(Textual Int64) , _rluPayload :: !RemarketingList - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'RemarketingListsUpdate' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> RemarketingList -- ^ 'rluPayload' -> RemarketingListsUpdate remarketingListsUpdate pRluProFileId_ pRluPayload_ = - RemarketingListsUpdate' - { _rluProFileId = _Coerce # pRluProFileId_ - , _rluPayload = pRluPayload_ - } + RemarketingListsUpdate' + {_rluProFileId = _Coerce # pRluProFileId_, _rluPayload = pRluPayload_} + -- | User profile ID associated with this request. rluProFileId :: Lens' RemarketingListsUpdate Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Reports/CompatibleFields/Query.hs b/gen/Network/Google/Resource/DFAReporting/Reports/CompatibleFields/Query.hs --- a/gen/Network/Google/Resource/DFAReporting/Reports/CompatibleFields/Query.hs +++ b/gen/Network/Google/Resource/DFAReporting/Reports/CompatibleFields/Query.hs @@ -46,7 +46,7 @@ -- 'ReportsCompatibleFieldsQuery' request conforms to. type ReportsCompatibleFieldsQueryResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "reports" :> @@ -61,11 +61,14 @@ -- input report and user permissions. -- -- /See:/ 'reportsCompatibleFieldsQuery' smart constructor. -data ReportsCompatibleFieldsQuery = ReportsCompatibleFieldsQuery' +data ReportsCompatibleFieldsQuery = + ReportsCompatibleFieldsQuery' { _rcfqProFileId :: !(Textual Int64) , _rcfqPayload :: !Report - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'ReportsCompatibleFieldsQuery' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -78,10 +81,9 @@ -> Report -- ^ 'rcfqPayload' -> ReportsCompatibleFieldsQuery reportsCompatibleFieldsQuery pRcfqProFileId_ pRcfqPayload_ = - ReportsCompatibleFieldsQuery' - { _rcfqProFileId = _Coerce # pRcfqProFileId_ - , _rcfqPayload = pRcfqPayload_ - } + ReportsCompatibleFieldsQuery' + {_rcfqProFileId = _Coerce # pRcfqProFileId_, _rcfqPayload = pRcfqPayload_} + -- | The DFA user profile ID. rcfqProFileId :: Lens' ReportsCompatibleFieldsQuery Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Reports/Delete.hs b/gen/Network/Google/Resource/DFAReporting/Reports/Delete.hs --- a/gen/Network/Google/Resource/DFAReporting/Reports/Delete.hs +++ b/gen/Network/Google/Resource/DFAReporting/Reports/Delete.hs @@ -44,7 +44,7 @@ -- 'ReportsDelete' request conforms to. type ReportsDeleteResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "reports" :> @@ -54,11 +54,14 @@ -- | Deletes a report by its ID. -- -- /See:/ 'reportsDelete' smart constructor. -data ReportsDelete = ReportsDelete' +data ReportsDelete = + ReportsDelete' { _rdReportId :: !(Textual Int64) , _rdProFileId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'ReportsDelete' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,11 @@ -> Int64 -- ^ 'rdProFileId' -> ReportsDelete reportsDelete pRdReportId_ pRdProFileId_ = - ReportsDelete' + ReportsDelete' { _rdReportId = _Coerce # pRdReportId_ , _rdProFileId = _Coerce # pRdProFileId_ } + -- | The ID of the report. rdReportId :: Lens' ReportsDelete Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Reports/Files/Get.hs b/gen/Network/Google/Resource/DFAReporting/Reports/Files/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/Reports/Files/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/Reports/Files/Get.hs @@ -45,7 +45,7 @@ -- 'ReportsFilesGet' request conforms to. type ReportsFilesGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "reports" :> @@ -55,7 +55,7 @@ QueryParam "alt" AltJSON :> Get '[JSON] File :<|> "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "reports" :> @@ -68,12 +68,15 @@ -- | Retrieves a report file. This method supports media download. -- -- /See:/ 'reportsFilesGet' smart constructor. -data ReportsFilesGet = ReportsFilesGet' +data ReportsFilesGet = + ReportsFilesGet' { _rfgReportId :: !(Textual Int64) , _rfgProFileId :: !(Textual Int64) , _rfgFileId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'ReportsFilesGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -89,12 +92,13 @@ -> Int64 -- ^ 'rfgFileId' -> ReportsFilesGet reportsFilesGet pRfgReportId_ pRfgProFileId_ pRfgFileId_ = - ReportsFilesGet' + ReportsFilesGet' { _rfgReportId = _Coerce # pRfgReportId_ , _rfgProFileId = _Coerce # pRfgProFileId_ , _rfgFileId = _Coerce # pRfgFileId_ } + -- | The ID of the report. rfgReportId :: Lens' ReportsFilesGet Int64 rfgReportId @@ -127,7 +131,8 @@ mempty instance GoogleRequest - (MediaDownload ReportsFilesGet) where + (MediaDownload ReportsFilesGet) + where type Rs (MediaDownload ReportsFilesGet) = Stream type Scopes (MediaDownload ReportsFilesGet) = Scopes ReportsFilesGet diff --git a/gen/Network/Google/Resource/DFAReporting/Reports/Files/List.hs b/gen/Network/Google/Resource/DFAReporting/Reports/Files/List.hs --- a/gen/Network/Google/Resource/DFAReporting/Reports/Files/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/Reports/Files/List.hs @@ -48,7 +48,7 @@ -- 'ReportsFilesList' request conforms to. type ReportsFilesListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "reports" :> @@ -63,15 +63,18 @@ -- | Lists files for a report. -- -- /See:/ 'reportsFilesList' smart constructor. -data ReportsFilesList = ReportsFilesList' +data ReportsFilesList = + ReportsFilesList' { _rflReportId :: !(Textual Int64) , _rflProFileId :: !(Textual Int64) , _rflSortOrder :: !ReportsFilesListSortOrder , _rflPageToken :: !(Maybe Text) , _rflSortField :: !ReportsFilesListSortField , _rflMaxResults :: !(Textual Int32) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'ReportsFilesList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -92,7 +95,7 @@ -> Int64 -- ^ 'rflProFileId' -> ReportsFilesList reportsFilesList pRflReportId_ pRflProFileId_ = - ReportsFilesList' + ReportsFilesList' { _rflReportId = _Coerce # pRflReportId_ , _rflProFileId = _Coerce # pRflProFileId_ , _rflSortOrder = RFLSODescending @@ -100,6 +103,7 @@ , _rflSortField = RFLSFLastModifiedTime , _rflMaxResults = 10 } + -- | The ID of the parent report. rflReportId :: Lens' ReportsFilesList Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Reports/Get.hs b/gen/Network/Google/Resource/DFAReporting/Reports/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/Reports/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/Reports/Get.hs @@ -44,7 +44,7 @@ -- 'ReportsGet' request conforms to. type ReportsGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "reports" :> @@ -54,11 +54,14 @@ -- | Retrieves a report by its ID. -- -- /See:/ 'reportsGet' smart constructor. -data ReportsGet = ReportsGet' +data ReportsGet = + ReportsGet' { _rgReportId :: !(Textual Int64) , _rgProFileId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'ReportsGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,11 @@ -> Int64 -- ^ 'rgProFileId' -> ReportsGet reportsGet pRgReportId_ pRgProFileId_ = - ReportsGet' + ReportsGet' { _rgReportId = _Coerce # pRgReportId_ , _rgProFileId = _Coerce # pRgProFileId_ } + -- | The ID of the report. rgReportId :: Lens' ReportsGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Reports/Insert.hs b/gen/Network/Google/Resource/DFAReporting/Reports/Insert.hs --- a/gen/Network/Google/Resource/DFAReporting/Reports/Insert.hs +++ b/gen/Network/Google/Resource/DFAReporting/Reports/Insert.hs @@ -44,7 +44,7 @@ -- 'ReportsInsert' request conforms to. type ReportsInsertResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "reports" :> @@ -54,11 +54,14 @@ -- | Creates a report. -- -- /See:/ 'reportsInsert' smart constructor. -data ReportsInsert = ReportsInsert' +data ReportsInsert = + ReportsInsert' { _riProFileId :: !(Textual Int64) , _riPayload :: !Report - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'ReportsInsert' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Report -- ^ 'riPayload' -> ReportsInsert reportsInsert pRiProFileId_ pRiPayload_ = - ReportsInsert' - { _riProFileId = _Coerce # pRiProFileId_ - , _riPayload = pRiPayload_ - } + ReportsInsert' + {_riProFileId = _Coerce # pRiProFileId_, _riPayload = pRiPayload_} + -- | The DFA user profile ID. riProFileId :: Lens' ReportsInsert Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Reports/List.hs b/gen/Network/Google/Resource/DFAReporting/Reports/List.hs --- a/gen/Network/Google/Resource/DFAReporting/Reports/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/Reports/List.hs @@ -48,7 +48,7 @@ -- 'ReportsList' request conforms to. type ReportsListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "reports" :> @@ -62,15 +62,18 @@ -- | Retrieves list of reports. -- -- /See:/ 'reportsList' smart constructor. -data ReportsList = ReportsList' +data ReportsList = + ReportsList' { _rlProFileId :: !(Textual Int64) , _rlSortOrder :: !ReportsListSortOrder , _rlScope :: !ReportsListScope , _rlPageToken :: !(Maybe Text) , _rlSortField :: !ReportsListSortField , _rlMaxResults :: !(Textual Int32) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'ReportsList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -90,7 +93,7 @@ :: Int64 -- ^ 'rlProFileId' -> ReportsList reportsList pRlProFileId_ = - ReportsList' + ReportsList' { _rlProFileId = _Coerce # pRlProFileId_ , _rlSortOrder = RLSODescending , _rlScope = Mine @@ -98,6 +101,7 @@ , _rlSortField = RLSFLastModifiedTime , _rlMaxResults = 10 } + -- | The DFA user profile ID. rlProFileId :: Lens' ReportsList Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Reports/Patch.hs b/gen/Network/Google/Resource/DFAReporting/Reports/Patch.hs --- a/gen/Network/Google/Resource/DFAReporting/Reports/Patch.hs +++ b/gen/Network/Google/Resource/DFAReporting/Reports/Patch.hs @@ -45,7 +45,7 @@ -- 'ReportsPatch' request conforms to. type ReportsPatchResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "reports" :> @@ -56,12 +56,15 @@ -- | Updates a report. This method supports patch semantics. -- -- /See:/ 'reportsPatch' smart constructor. -data ReportsPatch = ReportsPatch' +data ReportsPatch = + ReportsPatch' { _rpReportId :: !(Textual Int64) , _rpProFileId :: !(Textual Int64) , _rpPayload :: !Report - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'ReportsPatch' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -77,11 +80,12 @@ -> Report -- ^ 'rpPayload' -> ReportsPatch reportsPatch pRpReportId_ pRpProFileId_ pRpPayload_ = - ReportsPatch' + ReportsPatch' { _rpReportId = _Coerce # pRpReportId_ , _rpProFileId = _Coerce # pRpProFileId_ , _rpPayload = pRpPayload_ } + -- | The ID of the report. rpReportId :: Lens' ReportsPatch Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Reports/Run.hs b/gen/Network/Google/Resource/DFAReporting/Reports/Run.hs --- a/gen/Network/Google/Resource/DFAReporting/Reports/Run.hs +++ b/gen/Network/Google/Resource/DFAReporting/Reports/Run.hs @@ -45,7 +45,7 @@ -- 'ReportsRun' request conforms to. type ReportsRunResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "reports" :> @@ -57,12 +57,15 @@ -- | Runs a report. -- -- /See:/ 'reportsRun' smart constructor. -data ReportsRun = ReportsRun' +data ReportsRun = + ReportsRun' { _rrSynchronous :: !Bool , _rrReportId :: !(Textual Int64) , _rrProFileId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'ReportsRun' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -77,11 +80,12 @@ -> Int64 -- ^ 'rrProFileId' -> ReportsRun reportsRun pRrReportId_ pRrProFileId_ = - ReportsRun' + ReportsRun' { _rrSynchronous = False , _rrReportId = _Coerce # pRrReportId_ , _rrProFileId = _Coerce # pRrProFileId_ } + -- | If set and true, tries to run the report synchronously. rrSynchronous :: Lens' ReportsRun Bool diff --git a/gen/Network/Google/Resource/DFAReporting/Reports/Update.hs b/gen/Network/Google/Resource/DFAReporting/Reports/Update.hs --- a/gen/Network/Google/Resource/DFAReporting/Reports/Update.hs +++ b/gen/Network/Google/Resource/DFAReporting/Reports/Update.hs @@ -45,7 +45,7 @@ -- 'ReportsUpdate' request conforms to. type ReportsUpdateResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "reports" :> @@ -56,12 +56,15 @@ -- | Updates a report. -- -- /See:/ 'reportsUpdate' smart constructor. -data ReportsUpdate = ReportsUpdate' +data ReportsUpdate = + ReportsUpdate' { _ruReportId :: !(Textual Int64) , _ruProFileId :: !(Textual Int64) , _ruPayload :: !Report - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'ReportsUpdate' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -77,11 +80,12 @@ -> Report -- ^ 'ruPayload' -> ReportsUpdate reportsUpdate pRuReportId_ pRuProFileId_ pRuPayload_ = - ReportsUpdate' + ReportsUpdate' { _ruReportId = _Coerce # pRuReportId_ , _ruProFileId = _Coerce # pRuProFileId_ , _ruPayload = pRuPayload_ } + -- | The ID of the report. ruReportId :: Lens' ReportsUpdate Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Sites/Get.hs b/gen/Network/Google/Resource/DFAReporting/Sites/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/Sites/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/Sites/Get.hs @@ -44,7 +44,7 @@ -- 'SitesGet' request conforms to. type SitesGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "sites" :> @@ -54,11 +54,14 @@ -- | Gets one site by ID. -- -- /See:/ 'sitesGet' smart constructor. -data SitesGet = SitesGet' +data SitesGet = + SitesGet' { _sggProFileId :: !(Textual Int64) , _sggId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'SitesGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Int64 -- ^ 'sggId' -> SitesGet sitesGet pSggProFileId_ pSggId_ = - SitesGet' - { _sggProFileId = _Coerce # pSggProFileId_ - , _sggId = _Coerce # pSggId_ - } + SitesGet' + {_sggProFileId = _Coerce # pSggProFileId_, _sggId = _Coerce # pSggId_} + -- | User profile ID associated with this request. sggProFileId :: Lens' SitesGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Sites/Insert.hs b/gen/Network/Google/Resource/DFAReporting/Sites/Insert.hs --- a/gen/Network/Google/Resource/DFAReporting/Sites/Insert.hs +++ b/gen/Network/Google/Resource/DFAReporting/Sites/Insert.hs @@ -44,7 +44,7 @@ -- 'SitesInsert' request conforms to. type SitesInsertResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "sites" :> @@ -54,11 +54,14 @@ -- | Inserts a new site. -- -- /See:/ 'sitesInsert' smart constructor. -data SitesInsert = SitesInsert' +data SitesInsert = + SitesInsert' { _sProFileId :: !(Textual Int64) , _sPayload :: !Site - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'SitesInsert' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,8 @@ -> Site -- ^ 'sPayload' -> SitesInsert sitesInsert pSProFileId_ pSPayload_ = - SitesInsert' - { _sProFileId = _Coerce # pSProFileId_ - , _sPayload = pSPayload_ - } + SitesInsert' {_sProFileId = _Coerce # pSProFileId_, _sPayload = pSPayload_} + -- | User profile ID associated with this request. sProFileId :: Lens' SitesInsert Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Sites/List.hs b/gen/Network/Google/Resource/DFAReporting/Sites/List.hs --- a/gen/Network/Google/Resource/DFAReporting/Sites/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/Sites/List.hs @@ -59,7 +59,7 @@ -- 'SitesList' request conforms to. type SitesListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "sites" :> @@ -89,7 +89,8 @@ -- paging. -- -- /See:/ 'sitesList' smart constructor. -data SitesList = SitesList' +data SitesList = + SitesList' { _sitUnmAppedSite :: !(Maybe Bool) , _sitCampaignIds :: !(Maybe [Textual Int64]) , _sitSearchString :: !(Maybe Text) @@ -106,8 +107,10 @@ , _sitApproved :: !(Maybe Bool) , _sitAdWordsSite :: !(Maybe Bool) , _sitMaxResults :: !(Textual Int32) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'SitesList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -147,7 +150,7 @@ :: Int64 -- ^ 'sitProFileId' -> SitesList sitesList pSitProFileId_ = - SitesList' + SitesList' { _sitUnmAppedSite = Nothing , _sitCampaignIds = Nothing , _sitSearchString = Nothing @@ -165,6 +168,7 @@ , _sitAdWordsSite = Nothing , _sitMaxResults = 1000 } + -- | Select only sites that have not been mapped to a directory site. sitUnmAppedSite :: Lens' SitesList (Maybe Bool) diff --git a/gen/Network/Google/Resource/DFAReporting/Sites/Patch.hs b/gen/Network/Google/Resource/DFAReporting/Sites/Patch.hs --- a/gen/Network/Google/Resource/DFAReporting/Sites/Patch.hs +++ b/gen/Network/Google/Resource/DFAReporting/Sites/Patch.hs @@ -45,7 +45,7 @@ -- 'SitesPatch' request conforms to. type SitesPatchResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "sites" :> @@ -56,12 +56,15 @@ -- | Updates an existing site. This method supports patch semantics. -- -- /See:/ 'sitesPatch' smart constructor. -data SitesPatch = SitesPatch' +data SitesPatch = + SitesPatch' { _spProFileId :: !(Textual Int64) , _spPayload :: !Site , _spId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'SitesPatch' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -77,11 +80,12 @@ -> Int64 -- ^ 'spId' -> SitesPatch sitesPatch pSpProFileId_ pSpPayload_ pSpId_ = - SitesPatch' + SitesPatch' { _spProFileId = _Coerce # pSpProFileId_ , _spPayload = pSpPayload_ , _spId = _Coerce # pSpId_ } + -- | User profile ID associated with this request. spProFileId :: Lens' SitesPatch Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Sites/Update.hs b/gen/Network/Google/Resource/DFAReporting/Sites/Update.hs --- a/gen/Network/Google/Resource/DFAReporting/Sites/Update.hs +++ b/gen/Network/Google/Resource/DFAReporting/Sites/Update.hs @@ -44,7 +44,7 @@ -- 'SitesUpdate' request conforms to. type SitesUpdateResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "sites" :> @@ -54,11 +54,14 @@ -- | Updates an existing site. -- -- /See:/ 'sitesUpdate' smart constructor. -data SitesUpdate = SitesUpdate' +data SitesUpdate = + SitesUpdate' { _suProFileId :: !(Textual Int64) , _suPayload :: !Site - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'SitesUpdate' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Site -- ^ 'suPayload' -> SitesUpdate sitesUpdate pSuProFileId_ pSuPayload_ = - SitesUpdate' - { _suProFileId = _Coerce # pSuProFileId_ - , _suPayload = pSuPayload_ - } + SitesUpdate' + {_suProFileId = _Coerce # pSuProFileId_, _suPayload = pSuPayload_} + -- | User profile ID associated with this request. suProFileId :: Lens' SitesUpdate Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Sizes/Get.hs b/gen/Network/Google/Resource/DFAReporting/Sizes/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/Sizes/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/Sizes/Get.hs @@ -44,7 +44,7 @@ -- 'SizesGet' request conforms to. type SizesGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "sizes" :> @@ -54,11 +54,14 @@ -- | Gets one size by ID. -- -- /See:/ 'sizesGet' smart constructor. -data SizesGet = SizesGet' +data SizesGet = + SizesGet' { _sgProFileId :: !(Textual Int64) , _sgId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'SizesGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,8 @@ -> Int64 -- ^ 'sgId' -> SizesGet sizesGet pSgProFileId_ pSgId_ = - SizesGet' - { _sgProFileId = _Coerce # pSgProFileId_ - , _sgId = _Coerce # pSgId_ - } + SizesGet' {_sgProFileId = _Coerce # pSgProFileId_, _sgId = _Coerce # pSgId_} + -- | User profile ID associated with this request. sgProFileId :: Lens' SizesGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Sizes/Insert.hs b/gen/Network/Google/Resource/DFAReporting/Sizes/Insert.hs --- a/gen/Network/Google/Resource/DFAReporting/Sizes/Insert.hs +++ b/gen/Network/Google/Resource/DFAReporting/Sizes/Insert.hs @@ -44,7 +44,7 @@ -- 'SizesInsert' request conforms to. type SizesInsertResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "sizes" :> @@ -54,11 +54,14 @@ -- | Inserts a new size. -- -- /See:/ 'sizesInsert' smart constructor. -data SizesInsert = SizesInsert' +data SizesInsert = + SizesInsert' { _siProFileId :: !(Textual Int64) , _siPayload :: !Size - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'SizesInsert' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Size -- ^ 'siPayload' -> SizesInsert sizesInsert pSiProFileId_ pSiPayload_ = - SizesInsert' - { _siProFileId = _Coerce # pSiProFileId_ - , _siPayload = pSiPayload_ - } + SizesInsert' + {_siProFileId = _Coerce # pSiProFileId_, _siPayload = pSiPayload_} + -- | User profile ID associated with this request. siProFileId :: Lens' SizesInsert Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/Sizes/List.hs b/gen/Network/Google/Resource/DFAReporting/Sizes/List.hs --- a/gen/Network/Google/Resource/DFAReporting/Sizes/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/Sizes/List.hs @@ -50,7 +50,7 @@ -- 'SizesList' request conforms to. type SizesListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "sizes" :> @@ -67,14 +67,17 @@ -- differ from the list seen in the Trafficking UI. -- -- /See:/ 'sizesList' smart constructor. -data SizesList = SizesList' +data SizesList = + SizesList' { _slHeight :: !(Maybe (Textual Int32)) , _slIds :: !(Maybe [Textual Int64]) , _slWidth :: !(Maybe (Textual Int32)) , _slProFileId :: !(Textual Int64) , _slIabStandard :: !(Maybe Bool) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'SizesList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -92,13 +95,14 @@ :: Int64 -- ^ 'slProFileId' -> SizesList sizesList pSlProFileId_ = - SizesList' + SizesList' { _slHeight = Nothing , _slIds = Nothing , _slWidth = Nothing , _slProFileId = _Coerce # pSlProFileId_ , _slIabStandard = Nothing } + -- | Select only sizes with this height. slHeight :: Lens' SizesList (Maybe Int32) diff --git a/gen/Network/Google/Resource/DFAReporting/SubAccounts/Get.hs b/gen/Network/Google/Resource/DFAReporting/SubAccounts/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/SubAccounts/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/SubAccounts/Get.hs @@ -44,7 +44,7 @@ -- 'SubAccountsGet' request conforms to. type SubAccountsGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "subaccounts" :> @@ -54,11 +54,14 @@ -- | Gets one subaccount by ID. -- -- /See:/ 'subAccountsGet' smart constructor. -data SubAccountsGet = SubAccountsGet' +data SubAccountsGet = + SubAccountsGet' { _sagProFileId :: !(Textual Int64) , _sagId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'SubAccountsGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Int64 -- ^ 'sagId' -> SubAccountsGet subAccountsGet pSagProFileId_ pSagId_ = - SubAccountsGet' - { _sagProFileId = _Coerce # pSagProFileId_ - , _sagId = _Coerce # pSagId_ - } + SubAccountsGet' + {_sagProFileId = _Coerce # pSagProFileId_, _sagId = _Coerce # pSagId_} + -- | User profile ID associated with this request. sagProFileId :: Lens' SubAccountsGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/SubAccounts/Insert.hs b/gen/Network/Google/Resource/DFAReporting/SubAccounts/Insert.hs --- a/gen/Network/Google/Resource/DFAReporting/SubAccounts/Insert.hs +++ b/gen/Network/Google/Resource/DFAReporting/SubAccounts/Insert.hs @@ -44,7 +44,7 @@ -- 'SubAccountsInsert' request conforms to. type SubAccountsInsertResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "subaccounts" :> @@ -54,11 +54,14 @@ -- | Inserts a new subaccount. -- -- /See:/ 'subAccountsInsert' smart constructor. -data SubAccountsInsert = SubAccountsInsert' +data SubAccountsInsert = + SubAccountsInsert' { _saiProFileId :: !(Textual Int64) , _saiPayload :: !SubAccount - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'SubAccountsInsert' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> SubAccount -- ^ 'saiPayload' -> SubAccountsInsert subAccountsInsert pSaiProFileId_ pSaiPayload_ = - SubAccountsInsert' - { _saiProFileId = _Coerce # pSaiProFileId_ - , _saiPayload = pSaiPayload_ - } + SubAccountsInsert' + {_saiProFileId = _Coerce # pSaiProFileId_, _saiPayload = pSaiPayload_} + -- | User profile ID associated with this request. saiProFileId :: Lens' SubAccountsInsert Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/SubAccounts/List.hs b/gen/Network/Google/Resource/DFAReporting/SubAccounts/List.hs --- a/gen/Network/Google/Resource/DFAReporting/SubAccounts/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/SubAccounts/List.hs @@ -50,7 +50,7 @@ -- 'SubAccountsList' request conforms to. type SubAccountsListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "subaccounts" :> @@ -67,7 +67,8 @@ -- paging. -- -- /See:/ 'subAccountsList' smart constructor. -data SubAccountsList = SubAccountsList' +data SubAccountsList = + SubAccountsList' { _salSearchString :: !(Maybe Text) , _salIds :: !(Maybe [Textual Int64]) , _salProFileId :: !(Textual Int64) @@ -75,8 +76,10 @@ , _salPageToken :: !(Maybe Text) , _salSortField :: !SubAccountsListSortField , _salMaxResults :: !(Textual Int32) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'SubAccountsList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -98,7 +101,7 @@ :: Int64 -- ^ 'salProFileId' -> SubAccountsList subAccountsList pSalProFileId_ = - SubAccountsList' + SubAccountsList' { _salSearchString = Nothing , _salIds = Nothing , _salProFileId = _Coerce # pSalProFileId_ @@ -107,6 +110,7 @@ , _salSortField = SALSFID , _salMaxResults = 1000 } + -- | Allows searching for objects by name or ID. Wildcards (*) are allowed. -- For example, \"subaccount*2015\" will return objects with names like diff --git a/gen/Network/Google/Resource/DFAReporting/SubAccounts/Patch.hs b/gen/Network/Google/Resource/DFAReporting/SubAccounts/Patch.hs --- a/gen/Network/Google/Resource/DFAReporting/SubAccounts/Patch.hs +++ b/gen/Network/Google/Resource/DFAReporting/SubAccounts/Patch.hs @@ -45,7 +45,7 @@ -- 'SubAccountsPatch' request conforms to. type SubAccountsPatchResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "subaccounts" :> @@ -57,12 +57,15 @@ -- | Updates an existing subaccount. This method supports patch semantics. -- -- /See:/ 'subAccountsPatch' smart constructor. -data SubAccountsPatch = SubAccountsPatch' +data SubAccountsPatch = + SubAccountsPatch' { _sapProFileId :: !(Textual Int64) , _sapPayload :: !SubAccount , _sapId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'SubAccountsPatch' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -78,11 +81,12 @@ -> Int64 -- ^ 'sapId' -> SubAccountsPatch subAccountsPatch pSapProFileId_ pSapPayload_ pSapId_ = - SubAccountsPatch' + SubAccountsPatch' { _sapProFileId = _Coerce # pSapProFileId_ , _sapPayload = pSapPayload_ , _sapId = _Coerce # pSapId_ } + -- | User profile ID associated with this request. sapProFileId :: Lens' SubAccountsPatch Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/SubAccounts/Update.hs b/gen/Network/Google/Resource/DFAReporting/SubAccounts/Update.hs --- a/gen/Network/Google/Resource/DFAReporting/SubAccounts/Update.hs +++ b/gen/Network/Google/Resource/DFAReporting/SubAccounts/Update.hs @@ -44,7 +44,7 @@ -- 'SubAccountsUpdate' request conforms to. type SubAccountsUpdateResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "subaccounts" :> @@ -54,11 +54,14 @@ -- | Updates an existing subaccount. -- -- /See:/ 'subAccountsUpdate' smart constructor. -data SubAccountsUpdate = SubAccountsUpdate' +data SubAccountsUpdate = + SubAccountsUpdate' { _sauProFileId :: !(Textual Int64) , _sauPayload :: !SubAccount - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'SubAccountsUpdate' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> SubAccount -- ^ 'sauPayload' -> SubAccountsUpdate subAccountsUpdate pSauProFileId_ pSauPayload_ = - SubAccountsUpdate' - { _sauProFileId = _Coerce # pSauProFileId_ - , _sauPayload = pSauPayload_ - } + SubAccountsUpdate' + {_sauProFileId = _Coerce # pSauProFileId_, _sauPayload = pSauPayload_} + -- | User profile ID associated with this request. sauProFileId :: Lens' SubAccountsUpdate Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/TargetableRemarketingLists/Get.hs b/gen/Network/Google/Resource/DFAReporting/TargetableRemarketingLists/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/TargetableRemarketingLists/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/TargetableRemarketingLists/Get.hs @@ -44,7 +44,7 @@ -- 'TargetableRemarketingListsGet' request conforms to. type TargetableRemarketingListsGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "targetableRemarketingLists" :> @@ -55,11 +55,14 @@ -- | Gets one remarketing list by ID. -- -- /See:/ 'targetableRemarketingListsGet' smart constructor. -data TargetableRemarketingListsGet = TargetableRemarketingListsGet' +data TargetableRemarketingListsGet = + TargetableRemarketingListsGet' { _trlgProFileId :: !(Textual Int64) , _trlgId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'TargetableRemarketingListsGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> Int64 -- ^ 'trlgId' -> TargetableRemarketingListsGet targetableRemarketingListsGet pTrlgProFileId_ pTrlgId_ = - TargetableRemarketingListsGet' - { _trlgProFileId = _Coerce # pTrlgProFileId_ - , _trlgId = _Coerce # pTrlgId_ - } + TargetableRemarketingListsGet' + {_trlgProFileId = _Coerce # pTrlgProFileId_, _trlgId = _Coerce # pTrlgId_} + -- | User profile ID associated with this request. trlgProFileId :: Lens' TargetableRemarketingListsGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/TargetableRemarketingLists/List.hs b/gen/Network/Google/Resource/DFAReporting/TargetableRemarketingLists/List.hs --- a/gen/Network/Google/Resource/DFAReporting/TargetableRemarketingLists/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/TargetableRemarketingLists/List.hs @@ -51,7 +51,7 @@ -- 'TargetableRemarketingListsList' request conforms to. type TargetableRemarketingListsListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "targetableRemarketingLists" :> @@ -74,7 +74,8 @@ -- This method supports paging. -- -- /See:/ 'targetableRemarketingListsList' smart constructor. -data TargetableRemarketingListsList = TargetableRemarketingListsList' +data TargetableRemarketingListsList = + TargetableRemarketingListsList' { _trllAdvertiserId :: !(Textual Int64) , _trllProFileId :: !(Textual Int64) , _trllSortOrder :: !TargetableRemarketingListsListSortOrder @@ -83,8 +84,10 @@ , _trllPageToken :: !(Maybe Text) , _trllSortField :: !TargetableRemarketingListsListSortField , _trllMaxResults :: !(Textual Int32) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'TargetableRemarketingListsList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -109,7 +112,7 @@ -> Int64 -- ^ 'trllProFileId' -> TargetableRemarketingListsList targetableRemarketingListsList pTrllAdvertiserId_ pTrllProFileId_ = - TargetableRemarketingListsList' + TargetableRemarketingListsList' { _trllAdvertiserId = _Coerce # pTrllAdvertiserId_ , _trllProFileId = _Coerce # pTrllProFileId_ , _trllSortOrder = TRLLSOAscending @@ -119,6 +122,7 @@ , _trllSortField = TRLLSFID , _trllMaxResults = 1000 } + -- | Select only targetable remarketing lists targetable by these -- advertisers. diff --git a/gen/Network/Google/Resource/DFAReporting/TargetingTemplates/Get.hs b/gen/Network/Google/Resource/DFAReporting/TargetingTemplates/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/TargetingTemplates/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/TargetingTemplates/Get.hs @@ -44,7 +44,7 @@ -- 'TargetingTemplatesGet' request conforms to. type TargetingTemplatesGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "targetingTemplates" :> @@ -55,11 +55,14 @@ -- | Gets one targeting template by ID. -- -- /See:/ 'targetingTemplatesGet' smart constructor. -data TargetingTemplatesGet = TargetingTemplatesGet' +data TargetingTemplatesGet = + TargetingTemplatesGet' { _ttgProFileId :: !(Textual Int64) , _ttgId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'TargetingTemplatesGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> Int64 -- ^ 'ttgId' -> TargetingTemplatesGet targetingTemplatesGet pTtgProFileId_ pTtgId_ = - TargetingTemplatesGet' - { _ttgProFileId = _Coerce # pTtgProFileId_ - , _ttgId = _Coerce # pTtgId_ - } + TargetingTemplatesGet' + {_ttgProFileId = _Coerce # pTtgProFileId_, _ttgId = _Coerce # pTtgId_} + -- | User profile ID associated with this request. ttgProFileId :: Lens' TargetingTemplatesGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/TargetingTemplates/Insert.hs b/gen/Network/Google/Resource/DFAReporting/TargetingTemplates/Insert.hs --- a/gen/Network/Google/Resource/DFAReporting/TargetingTemplates/Insert.hs +++ b/gen/Network/Google/Resource/DFAReporting/TargetingTemplates/Insert.hs @@ -44,7 +44,7 @@ -- 'TargetingTemplatesInsert' request conforms to. type TargetingTemplatesInsertResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "targetingTemplates" :> @@ -55,11 +55,14 @@ -- | Inserts a new targeting template. -- -- /See:/ 'targetingTemplatesInsert' smart constructor. -data TargetingTemplatesInsert = TargetingTemplatesInsert' +data TargetingTemplatesInsert = + TargetingTemplatesInsert' { _ttiProFileId :: !(Textual Int64) , _ttiPayload :: !TargetingTemplate - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'TargetingTemplatesInsert' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> TargetingTemplate -- ^ 'ttiPayload' -> TargetingTemplatesInsert targetingTemplatesInsert pTtiProFileId_ pTtiPayload_ = - TargetingTemplatesInsert' - { _ttiProFileId = _Coerce # pTtiProFileId_ - , _ttiPayload = pTtiPayload_ - } + TargetingTemplatesInsert' + {_ttiProFileId = _Coerce # pTtiProFileId_, _ttiPayload = pTtiPayload_} + -- | User profile ID associated with this request. ttiProFileId :: Lens' TargetingTemplatesInsert Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/TargetingTemplates/List.hs b/gen/Network/Google/Resource/DFAReporting/TargetingTemplates/List.hs --- a/gen/Network/Google/Resource/DFAReporting/TargetingTemplates/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/TargetingTemplates/List.hs @@ -51,7 +51,7 @@ -- 'TargetingTemplatesList' request conforms to. type TargetingTemplatesListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "targetingTemplates" :> @@ -73,7 +73,8 @@ -- method supports paging. -- -- /See:/ 'targetingTemplatesList' smart constructor. -data TargetingTemplatesList = TargetingTemplatesList' +data TargetingTemplatesList = + TargetingTemplatesList' { _ttlAdvertiserId :: !(Maybe (Textual Int64)) , _ttlSearchString :: !(Maybe Text) , _ttlIds :: !(Maybe [Textual Int64]) @@ -82,8 +83,10 @@ , _ttlPageToken :: !(Maybe Text) , _ttlSortField :: !TargetingTemplatesListSortField , _ttlMaxResults :: !(Textual Int32) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'TargetingTemplatesList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -107,7 +110,7 @@ :: Int64 -- ^ 'ttlProFileId' -> TargetingTemplatesList targetingTemplatesList pTtlProFileId_ = - TargetingTemplatesList' + TargetingTemplatesList' { _ttlAdvertiserId = Nothing , _ttlSearchString = Nothing , _ttlIds = Nothing @@ -117,6 +120,7 @@ , _ttlSortField = TTLSFID , _ttlMaxResults = 1000 } + -- | Select only targeting templates with this advertiser ID. ttlAdvertiserId :: Lens' TargetingTemplatesList (Maybe Int64) diff --git a/gen/Network/Google/Resource/DFAReporting/TargetingTemplates/Patch.hs b/gen/Network/Google/Resource/DFAReporting/TargetingTemplates/Patch.hs --- a/gen/Network/Google/Resource/DFAReporting/TargetingTemplates/Patch.hs +++ b/gen/Network/Google/Resource/DFAReporting/TargetingTemplates/Patch.hs @@ -46,7 +46,7 @@ -- 'TargetingTemplatesPatch' request conforms to. type TargetingTemplatesPatchResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "targetingTemplates" :> @@ -59,12 +59,15 @@ -- semantics. -- -- /See:/ 'targetingTemplatesPatch' smart constructor. -data TargetingTemplatesPatch = TargetingTemplatesPatch' +data TargetingTemplatesPatch = + TargetingTemplatesPatch' { _ttpProFileId :: !(Textual Int64) , _ttpPayload :: !TargetingTemplate , _ttpId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'TargetingTemplatesPatch' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -80,11 +83,12 @@ -> Int64 -- ^ 'ttpId' -> TargetingTemplatesPatch targetingTemplatesPatch pTtpProFileId_ pTtpPayload_ pTtpId_ = - TargetingTemplatesPatch' + TargetingTemplatesPatch' { _ttpProFileId = _Coerce # pTtpProFileId_ , _ttpPayload = pTtpPayload_ , _ttpId = _Coerce # pTtpId_ } + -- | User profile ID associated with this request. ttpProFileId :: Lens' TargetingTemplatesPatch Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/TargetingTemplates/Update.hs b/gen/Network/Google/Resource/DFAReporting/TargetingTemplates/Update.hs --- a/gen/Network/Google/Resource/DFAReporting/TargetingTemplates/Update.hs +++ b/gen/Network/Google/Resource/DFAReporting/TargetingTemplates/Update.hs @@ -44,7 +44,7 @@ -- 'TargetingTemplatesUpdate' request conforms to. type TargetingTemplatesUpdateResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "targetingTemplates" :> @@ -55,11 +55,14 @@ -- | Updates an existing targeting template. -- -- /See:/ 'targetingTemplatesUpdate' smart constructor. -data TargetingTemplatesUpdate = TargetingTemplatesUpdate' +data TargetingTemplatesUpdate = + TargetingTemplatesUpdate' { _ttuProFileId :: !(Textual Int64) , _ttuPayload :: !TargetingTemplate - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'TargetingTemplatesUpdate' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> TargetingTemplate -- ^ 'ttuPayload' -> TargetingTemplatesUpdate targetingTemplatesUpdate pTtuProFileId_ pTtuPayload_ = - TargetingTemplatesUpdate' - { _ttuProFileId = _Coerce # pTtuProFileId_ - , _ttuPayload = pTtuPayload_ - } + TargetingTemplatesUpdate' + {_ttuProFileId = _Coerce # pTtuProFileId_, _ttuPayload = pTtuPayload_} + -- | User profile ID associated with this request. ttuProFileId :: Lens' TargetingTemplatesUpdate Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/UserProFiles/Get.hs b/gen/Network/Google/Resource/DFAReporting/UserProFiles/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/UserProFiles/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/UserProFiles/Get.hs @@ -43,7 +43,7 @@ -- 'UserProFilesGet' request conforms to. type UserProFilesGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> QueryParam "alt" AltJSON :> Get '[JSON] UserProFile @@ -51,10 +51,13 @@ -- | Gets one user profile by ID. -- -- /See:/ 'userProFilesGet' smart constructor. -newtype UserProFilesGet = UserProFilesGet' +newtype UserProFilesGet = + UserProFilesGet' { _upfgProFileId :: Textual Int64 - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'UserProFilesGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -64,9 +67,8 @@ :: Int64 -- ^ 'upfgProFileId' -> UserProFilesGet userProFilesGet pUpfgProFileId_ = - UserProFilesGet' - { _upfgProFileId = _Coerce # pUpfgProFileId_ - } + UserProFilesGet' {_upfgProFileId = _Coerce # pUpfgProFileId_} + -- | The user profile ID. upfgProFileId :: Lens' UserProFilesGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/UserProFiles/List.hs b/gen/Network/Google/Resource/DFAReporting/UserProFiles/List.hs --- a/gen/Network/Google/Resource/DFAReporting/UserProFiles/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/UserProFiles/List.hs @@ -41,7 +41,7 @@ -- 'UserProFilesList' request conforms to. type UserProFilesListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> QueryParam "alt" AltJSON :> Get '[JSON] UserProFileList @@ -50,14 +50,16 @@ -- -- /See:/ 'userProFilesList' smart constructor. data UserProFilesList = - UserProFilesList' - deriving (Eq,Show,Data,Typeable,Generic) + UserProFilesList' + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'UserProFilesList' with the minimum fields required to make a request. -- userProFilesList :: UserProFilesList userProFilesList = UserProFilesList' + instance GoogleRequest UserProFilesList where type Rs UserProFilesList = UserProFileList diff --git a/gen/Network/Google/Resource/DFAReporting/UserRolePermissionGroups/Get.hs b/gen/Network/Google/Resource/DFAReporting/UserRolePermissionGroups/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/UserRolePermissionGroups/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/UserRolePermissionGroups/Get.hs @@ -44,7 +44,7 @@ -- 'UserRolePermissionGroupsGet' request conforms to. type UserRolePermissionGroupsGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "userRolePermissionGroups" :> @@ -55,11 +55,14 @@ -- | Gets one user role permission group by ID. -- -- /See:/ 'userRolePermissionGroupsGet' smart constructor. -data UserRolePermissionGroupsGet = UserRolePermissionGroupsGet' +data UserRolePermissionGroupsGet = + UserRolePermissionGroupsGet' { _urpggProFileId :: !(Textual Int64) , _urpggId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'UserRolePermissionGroupsGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,11 @@ -> Int64 -- ^ 'urpggId' -> UserRolePermissionGroupsGet userRolePermissionGroupsGet pUrpggProFileId_ pUrpggId_ = - UserRolePermissionGroupsGet' + UserRolePermissionGroupsGet' { _urpggProFileId = _Coerce # pUrpggProFileId_ , _urpggId = _Coerce # pUrpggId_ } + -- | User profile ID associated with this request. urpggProFileId :: Lens' UserRolePermissionGroupsGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/UserRolePermissionGroups/List.hs b/gen/Network/Google/Resource/DFAReporting/UserRolePermissionGroups/List.hs --- a/gen/Network/Google/Resource/DFAReporting/UserRolePermissionGroups/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/UserRolePermissionGroups/List.hs @@ -43,7 +43,7 @@ -- 'UserRolePermissionGroupsList' request conforms to. type UserRolePermissionGroupsListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "userRolePermissionGroups" :> @@ -53,10 +53,13 @@ -- | Gets a list of all supported user role permission groups. -- -- /See:/ 'userRolePermissionGroupsList' smart constructor. -newtype UserRolePermissionGroupsList = UserRolePermissionGroupsList' +newtype UserRolePermissionGroupsList = + UserRolePermissionGroupsList' { _urpglProFileId :: Textual Int64 - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'UserRolePermissionGroupsList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -66,9 +69,8 @@ :: Int64 -- ^ 'urpglProFileId' -> UserRolePermissionGroupsList userRolePermissionGroupsList pUrpglProFileId_ = - UserRolePermissionGroupsList' - { _urpglProFileId = _Coerce # pUrpglProFileId_ - } + UserRolePermissionGroupsList' {_urpglProFileId = _Coerce # pUrpglProFileId_} + -- | User profile ID associated with this request. urpglProFileId :: Lens' UserRolePermissionGroupsList Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/UserRolePermissions/Get.hs b/gen/Network/Google/Resource/DFAReporting/UserRolePermissions/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/UserRolePermissions/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/UserRolePermissions/Get.hs @@ -44,7 +44,7 @@ -- 'UserRolePermissionsGet' request conforms to. type UserRolePermissionsGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "userRolePermissions" :> @@ -55,11 +55,14 @@ -- | Gets one user role permission by ID. -- -- /See:/ 'userRolePermissionsGet' smart constructor. -data UserRolePermissionsGet = UserRolePermissionsGet' +data UserRolePermissionsGet = + UserRolePermissionsGet' { _uProFileId :: !(Textual Int64) , _uId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'UserRolePermissionsGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -72,10 +75,9 @@ -> Int64 -- ^ 'uId' -> UserRolePermissionsGet userRolePermissionsGet pUProFileId_ pUId_ = - UserRolePermissionsGet' - { _uProFileId = _Coerce # pUProFileId_ - , _uId = _Coerce # pUId_ - } + UserRolePermissionsGet' + {_uProFileId = _Coerce # pUProFileId_, _uId = _Coerce # pUId_} + -- | User profile ID associated with this request. uProFileId :: Lens' UserRolePermissionsGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/UserRolePermissions/List.hs b/gen/Network/Google/Resource/DFAReporting/UserRolePermissions/List.hs --- a/gen/Network/Google/Resource/DFAReporting/UserRolePermissions/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/UserRolePermissions/List.hs @@ -44,7 +44,7 @@ -- 'UserRolePermissionsList' request conforms to. type UserRolePermissionsListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "userRolePermissions" :> @@ -55,11 +55,14 @@ -- | Gets a list of user role permissions, possibly filtered. -- -- /See:/ 'userRolePermissionsList' smart constructor. -data UserRolePermissionsList = UserRolePermissionsList' +data UserRolePermissionsList = + UserRolePermissionsList' { _urplIds :: !(Maybe [Textual Int64]) , _urplProFileId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'UserRolePermissionsList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ :: Int64 -- ^ 'urplProFileId' -> UserRolePermissionsList userRolePermissionsList pUrplProFileId_ = - UserRolePermissionsList' - { _urplIds = Nothing - , _urplProFileId = _Coerce # pUrplProFileId_ - } + UserRolePermissionsList' + {_urplIds = Nothing, _urplProFileId = _Coerce # pUrplProFileId_} + -- | Select only user role permissions with these IDs. urplIds :: Lens' UserRolePermissionsList [Int64] diff --git a/gen/Network/Google/Resource/DFAReporting/UserRoles/Delete.hs b/gen/Network/Google/Resource/DFAReporting/UserRoles/Delete.hs --- a/gen/Network/Google/Resource/DFAReporting/UserRoles/Delete.hs +++ b/gen/Network/Google/Resource/DFAReporting/UserRoles/Delete.hs @@ -44,7 +44,7 @@ -- 'UserRolesDelete' request conforms to. type UserRolesDeleteResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "userRoles" :> @@ -54,11 +54,14 @@ -- | Deletes an existing user role. -- -- /See:/ 'userRolesDelete' smart constructor. -data UserRolesDelete = UserRolesDelete' +data UserRolesDelete = + UserRolesDelete' { _urdProFileId :: !(Textual Int64) , _urdId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'UserRolesDelete' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Int64 -- ^ 'urdId' -> UserRolesDelete userRolesDelete pUrdProFileId_ pUrdId_ = - UserRolesDelete' - { _urdProFileId = _Coerce # pUrdProFileId_ - , _urdId = _Coerce # pUrdId_ - } + UserRolesDelete' + {_urdProFileId = _Coerce # pUrdProFileId_, _urdId = _Coerce # pUrdId_} + -- | User profile ID associated with this request. urdProFileId :: Lens' UserRolesDelete Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/UserRoles/Get.hs b/gen/Network/Google/Resource/DFAReporting/UserRoles/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/UserRoles/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/UserRoles/Get.hs @@ -44,7 +44,7 @@ -- 'UserRolesGet' request conforms to. type UserRolesGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "userRoles" :> @@ -54,11 +54,14 @@ -- | Gets one user role by ID. -- -- /See:/ 'userRolesGet' smart constructor. -data UserRolesGet = UserRolesGet' +data UserRolesGet = + UserRolesGet' { _urgProFileId :: !(Textual Int64) , _urgId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'UserRolesGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Int64 -- ^ 'urgId' -> UserRolesGet userRolesGet pUrgProFileId_ pUrgId_ = - UserRolesGet' - { _urgProFileId = _Coerce # pUrgProFileId_ - , _urgId = _Coerce # pUrgId_ - } + UserRolesGet' + {_urgProFileId = _Coerce # pUrgProFileId_, _urgId = _Coerce # pUrgId_} + -- | User profile ID associated with this request. urgProFileId :: Lens' UserRolesGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/UserRoles/Insert.hs b/gen/Network/Google/Resource/DFAReporting/UserRoles/Insert.hs --- a/gen/Network/Google/Resource/DFAReporting/UserRoles/Insert.hs +++ b/gen/Network/Google/Resource/DFAReporting/UserRoles/Insert.hs @@ -44,7 +44,7 @@ -- 'UserRolesInsert' request conforms to. type UserRolesInsertResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "userRoles" :> @@ -54,11 +54,14 @@ -- | Inserts a new user role. -- -- /See:/ 'userRolesInsert' smart constructor. -data UserRolesInsert = UserRolesInsert' +data UserRolesInsert = + UserRolesInsert' { _uriProFileId :: !(Textual Int64) , _uriPayload :: !UserRole - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'UserRolesInsert' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> UserRole -- ^ 'uriPayload' -> UserRolesInsert userRolesInsert pUriProFileId_ pUriPayload_ = - UserRolesInsert' - { _uriProFileId = _Coerce # pUriProFileId_ - , _uriPayload = pUriPayload_ - } + UserRolesInsert' + {_uriProFileId = _Coerce # pUriProFileId_, _uriPayload = pUriPayload_} + -- | User profile ID associated with this request. uriProFileId :: Lens' UserRolesInsert Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/UserRoles/List.hs b/gen/Network/Google/Resource/DFAReporting/UserRoles/List.hs --- a/gen/Network/Google/Resource/DFAReporting/UserRoles/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/UserRoles/List.hs @@ -52,7 +52,7 @@ -- 'UserRolesList' request conforms to. type UserRolesListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "userRoles" :> @@ -71,7 +71,8 @@ -- paging. -- -- /See:/ 'userRolesList' smart constructor. -data UserRolesList = UserRolesList' +data UserRolesList = + UserRolesList' { _urlSearchString :: !(Maybe Text) , _urlIds :: !(Maybe [Textual Int64]) , _urlProFileId :: !(Textual Int64) @@ -81,8 +82,10 @@ , _urlSortField :: !UserRolesListSortField , _urlSubAccountId :: !(Maybe (Textual Int64)) , _urlMaxResults :: !(Textual Int32) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'UserRolesList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -108,7 +111,7 @@ :: Int64 -- ^ 'urlProFileId' -> UserRolesList userRolesList pUrlProFileId_ = - UserRolesList' + UserRolesList' { _urlSearchString = Nothing , _urlIds = Nothing , _urlProFileId = _Coerce # pUrlProFileId_ @@ -119,6 +122,7 @@ , _urlSubAccountId = Nothing , _urlMaxResults = 1000 } + -- | Allows searching for objects by name or ID. Wildcards (*) are allowed. -- For example, \"userrole*2015\" will return objects with names like diff --git a/gen/Network/Google/Resource/DFAReporting/UserRoles/Patch.hs b/gen/Network/Google/Resource/DFAReporting/UserRoles/Patch.hs --- a/gen/Network/Google/Resource/DFAReporting/UserRoles/Patch.hs +++ b/gen/Network/Google/Resource/DFAReporting/UserRoles/Patch.hs @@ -45,7 +45,7 @@ -- 'UserRolesPatch' request conforms to. type UserRolesPatchResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "userRoles" :> @@ -56,12 +56,15 @@ -- | Updates an existing user role. This method supports patch semantics. -- -- /See:/ 'userRolesPatch' smart constructor. -data UserRolesPatch = UserRolesPatch' +data UserRolesPatch = + UserRolesPatch' { _urpProFileId :: !(Textual Int64) , _urpPayload :: !UserRole , _urpId :: !(Textual Int64) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'UserRolesPatch' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -77,11 +80,12 @@ -> Int64 -- ^ 'urpId' -> UserRolesPatch userRolesPatch pUrpProFileId_ pUrpPayload_ pUrpId_ = - UserRolesPatch' + UserRolesPatch' { _urpProFileId = _Coerce # pUrpProFileId_ , _urpPayload = pUrpPayload_ , _urpId = _Coerce # pUrpId_ } + -- | User profile ID associated with this request. urpProFileId :: Lens' UserRolesPatch Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/UserRoles/Update.hs b/gen/Network/Google/Resource/DFAReporting/UserRoles/Update.hs --- a/gen/Network/Google/Resource/DFAReporting/UserRoles/Update.hs +++ b/gen/Network/Google/Resource/DFAReporting/UserRoles/Update.hs @@ -44,7 +44,7 @@ -- 'UserRolesUpdate' request conforms to. type UserRolesUpdateResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "userRoles" :> @@ -54,11 +54,14 @@ -- | Updates an existing user role. -- -- /See:/ 'userRolesUpdate' smart constructor. -data UserRolesUpdate = UserRolesUpdate' +data UserRolesUpdate = + UserRolesUpdate' { _uruProFileId :: !(Textual Int64) , _uruPayload :: !UserRole - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'UserRolesUpdate' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> UserRole -- ^ 'uruPayload' -> UserRolesUpdate userRolesUpdate pUruProFileId_ pUruPayload_ = - UserRolesUpdate' - { _uruProFileId = _Coerce # pUruProFileId_ - , _uruPayload = pUruPayload_ - } + UserRolesUpdate' + {_uruProFileId = _Coerce # pUruProFileId_, _uruPayload = pUruPayload_} + -- | User profile ID associated with this request. uruProFileId :: Lens' UserRolesUpdate Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/VideoFormats/Get.hs b/gen/Network/Google/Resource/DFAReporting/VideoFormats/Get.hs --- a/gen/Network/Google/Resource/DFAReporting/VideoFormats/Get.hs +++ b/gen/Network/Google/Resource/DFAReporting/VideoFormats/Get.hs @@ -44,7 +44,7 @@ -- 'VideoFormatsGet' request conforms to. type VideoFormatsGetResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "videoFormats" :> @@ -54,11 +54,14 @@ -- | Gets one video format by ID. -- -- /See:/ 'videoFormatsGet' smart constructor. -data VideoFormatsGet = VideoFormatsGet' +data VideoFormatsGet = + VideoFormatsGet' { _vfgProFileId :: !(Textual Int64) , _vfgId :: !(Textual Int32) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'VideoFormatsGet' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -71,10 +74,9 @@ -> Int32 -- ^ 'vfgId' -> VideoFormatsGet videoFormatsGet pVfgProFileId_ pVfgId_ = - VideoFormatsGet' - { _vfgProFileId = _Coerce # pVfgProFileId_ - , _vfgId = _Coerce # pVfgId_ - } + VideoFormatsGet' + {_vfgProFileId = _Coerce # pVfgProFileId_, _vfgId = _Coerce # pVfgId_} + -- | User profile ID associated with this request. vfgProFileId :: Lens' VideoFormatsGet Int64 diff --git a/gen/Network/Google/Resource/DFAReporting/VideoFormats/List.hs b/gen/Network/Google/Resource/DFAReporting/VideoFormats/List.hs --- a/gen/Network/Google/Resource/DFAReporting/VideoFormats/List.hs +++ b/gen/Network/Google/Resource/DFAReporting/VideoFormats/List.hs @@ -43,7 +43,7 @@ -- 'VideoFormatsList' request conforms to. type VideoFormatsListResource = "dfareporting" :> - "v3.2" :> + "v3.3" :> "userprofiles" :> Capture "profileId" (Textual Int64) :> "videoFormats" :> @@ -53,10 +53,13 @@ -- | Lists available video formats. -- -- /See:/ 'videoFormatsList' smart constructor. -newtype VideoFormatsList = VideoFormatsList' +newtype VideoFormatsList = + VideoFormatsList' { _vflProFileId :: Textual Int64 - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'VideoFormatsList' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: @@ -66,9 +69,8 @@ :: Int64 -- ^ 'vflProFileId' -> VideoFormatsList videoFormatsList pVflProFileId_ = - VideoFormatsList' - { _vflProFileId = _Coerce # pVflProFileId_ - } + VideoFormatsList' {_vflProFileId = _Coerce # pVflProFileId_} + -- | User profile ID associated with this request. vflProFileId :: Lens' VideoFormatsList Int64 diff --git a/gogol-dfareporting.cabal b/gogol-dfareporting.cabal --- a/gogol-dfareporting.cabal +++ b/gogol-dfareporting.cabal @@ -1,5 +1,5 @@ name: gogol-dfareporting -version: 0.4.0 +version: 0.5.0 synopsis: Google DCM/DFA Reporting And Trafficking SDK. homepage: https://github.com/brendanhay/gogol bug-reports: https://github.com/brendanhay/gogol/issues @@ -19,7 +19,7 @@ /Warning:/ This is an experimental prototype/preview release which is still under exploratory development and not intended for public use, caveat emptor! . - This library is compatible with version @v3.2@ + This library is compatible with version @v3.3@ of the API. source-repository head @@ -117,8 +117,6 @@ , Network.Google.Resource.DFAReporting.Creatives.Patch , Network.Google.Resource.DFAReporting.Creatives.Update , Network.Google.Resource.DFAReporting.DimensionValues.Query - , Network.Google.Resource.DFAReporting.DirectorySiteContacts.Get - , Network.Google.Resource.DFAReporting.DirectorySiteContacts.List , Network.Google.Resource.DFAReporting.DirectorySites.Get , Network.Google.Resource.DFAReporting.DirectorySites.Insert , Network.Google.Resource.DFAReporting.DirectorySites.List @@ -247,5 +245,5 @@ , Network.Google.DFAReporting.Types.Sum build-depends: - gogol-core == 0.4.0.* + gogol-core == 0.5.0.* , base >= 4.7 && < 5