-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/
-- | Google Search Console SDK.
--
-- View Google Search Console data for your verified sites.
--
-- 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 of the API.
@package gogol-webmaster-tools
@version 0.5.0
module Network.Google.WebmasterTools.Types
-- | Default request referring to version v3 of the Search Console
-- API. This contains the host and root path used as a starting point for
-- constructing service requests.
webmasterToolsService :: ServiceConfig
-- | View and manage Search Console data for your verified sites
webmastersScope :: Proxy '["https://www.googleapis.com/auth/webmasters"]
-- | View Search Console data for your verified sites
webmastersReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/webmasters.readonly"]
-- | Information about the various content types in the sitemap.
--
-- See: wmxSitemapContent smart constructor.
data WmxSitemapContent
-- | Creates a value of WmxSitemapContent with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
wmxSitemapContent :: WmxSitemapContent
-- | The number of URLs from the sitemap that were indexed (of the content
-- type).
wscIndexed :: Lens' WmxSitemapContent (Maybe Int64)
-- | The specific type of content in this sitemap. For example: web.
wscType :: Lens' WmxSitemapContent (Maybe Text)
-- | The number of URLs in the sitemap (of the content type).
wscSubmitted :: Lens' WmxSitemapContent (Maybe Int64)
data APIdimensionFilterGroup
-- | Creates a value of APIdimensionFilterGroup with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
apidimensionFilterGroup :: APIdimensionFilterGroup
afgFilters :: Lens' APIdimensionFilterGroup [APIdimensionFilter]
afgGroupType :: Lens' APIdimensionFilterGroup (Maybe Text)
-- | Additional details about the URL, set only when calling get().
--
-- See: urlSampleDetails smart constructor.
data URLSampleDetails
-- | Creates a value of URLSampleDetails with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
urlSampleDetails :: URLSampleDetails
-- | A sample set of URLs linking to this URL.
usdLinkedFromURLs :: Lens' URLSampleDetails [Text]
-- | List of sitemaps pointing at this URL.
usdContainingSitemaps :: Lens' URLSampleDetails [Text]
-- | The crawl error category. For example: authPermissions
data URLCrawlErrorsSamplesMarkAsFixedCategory
-- |
-- authPermissions
--
AuthPermissions :: URLCrawlErrorsSamplesMarkAsFixedCategory
-- |
-- flashContent
--
FlashContent :: URLCrawlErrorsSamplesMarkAsFixedCategory
-- |
-- manyToOneRedirect
--
ManyToOneRedirect :: URLCrawlErrorsSamplesMarkAsFixedCategory
-- |
-- notFollowed
--
NotFollowed :: URLCrawlErrorsSamplesMarkAsFixedCategory
-- |
-- notFound
--
NotFound :: URLCrawlErrorsSamplesMarkAsFixedCategory
-- |
-- other
--
Other :: URLCrawlErrorsSamplesMarkAsFixedCategory
-- |
-- roboted
--
Roboted :: URLCrawlErrorsSamplesMarkAsFixedCategory
-- |
-- serverError
--
ServerError :: URLCrawlErrorsSamplesMarkAsFixedCategory
-- |
-- soft404
--
SOFT404 :: URLCrawlErrorsSamplesMarkAsFixedCategory
-- | Number of errors per day for a specific error type (defined by
-- platform and category).
--
-- See: urlCrawlErrorCountsPerType smart constructor.
data URLCrawlErrorCountsPerType
-- | Creates a value of URLCrawlErrorCountsPerType with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
urlCrawlErrorCountsPerType :: URLCrawlErrorCountsPerType
-- | The general type of Googlebot that made the request (see list of
-- Googlebot user-agents for the user-agents used).
ucecptPlatform :: Lens' URLCrawlErrorCountsPerType (Maybe Text)
-- | The error count entries time series.
ucecptEntries :: Lens' URLCrawlErrorCountsPerType [URLCrawlErrorCount]
-- | The crawl error type.
ucecptCategory :: Lens' URLCrawlErrorCountsPerType (Maybe Text)
-- | The user agent type (platform) that made the request. For example: web
data URLCrawlErrorsSamplesGetPlatform
-- |
-- mobile
--
Mobile :: URLCrawlErrorsSamplesGetPlatform
-- |
-- smartphoneOnly
--
SmartphoneOnly :: URLCrawlErrorsSamplesGetPlatform
-- |
-- web
--
Web :: URLCrawlErrorsSamplesGetPlatform
data APIDataRow
-- | Creates a value of APIDataRow with the minimum fields required
-- to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
apiDataRow :: APIDataRow
adrImpressions :: Lens' APIDataRow (Maybe Double)
adrKeys :: Lens' APIDataRow [Text]
adrCtr :: Lens' APIDataRow (Maybe Double)
adrClicks :: Lens' APIDataRow (Maybe Double)
adrPosition :: Lens' APIDataRow (Maybe Double)
data APIdimensionFilter
-- | Creates a value of APIdimensionFilter with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
apidimensionFilter :: APIdimensionFilter
afOperator :: Lens' APIdimensionFilter (Maybe Text)
afDimension :: Lens' APIdimensionFilter (Maybe Text)
afExpression :: Lens' APIdimensionFilter (Maybe Text)
-- | The user agent type (platform) that made the request. For example: web
data URLCrawlErrorsSamplesMarkAsFixedPlatform
-- |
-- mobile
--
UCESMAFPMobile :: URLCrawlErrorsSamplesMarkAsFixedPlatform
-- |
-- smartphoneOnly
--
UCESMAFPSmartphoneOnly :: URLCrawlErrorsSamplesMarkAsFixedPlatform
-- |
-- web
--
UCESMAFPWeb :: URLCrawlErrorsSamplesMarkAsFixedPlatform
-- | The crawl error category. For example: authPermissions
data URLCrawlErrorsSamplesGetCategory
-- |
-- authPermissions
--
UCESGCAuthPermissions :: URLCrawlErrorsSamplesGetCategory
-- |
-- flashContent
--
UCESGCFlashContent :: URLCrawlErrorsSamplesGetCategory
-- |
-- manyToOneRedirect
--
UCESGCManyToOneRedirect :: URLCrawlErrorsSamplesGetCategory
-- |
-- notFollowed
--
UCESGCNotFollowed :: URLCrawlErrorsSamplesGetCategory
-- |
-- notFound
--
UCESGCNotFound :: URLCrawlErrorsSamplesGetCategory
-- |
-- other
--
UCESGCOther :: URLCrawlErrorsSamplesGetCategory
-- |
-- roboted
--
UCESGCRoboted :: URLCrawlErrorsSamplesGetCategory
-- |
-- serverError
--
UCESGCServerError :: URLCrawlErrorsSamplesGetCategory
-- |
-- soft404
--
UCESGCSOFT404 :: URLCrawlErrorsSamplesGetCategory
-- | An entry in a URL crawl errors time series.
--
-- See: urlCrawlErrorCount smart constructor.
data URLCrawlErrorCount
-- | Creates a value of URLCrawlErrorCount with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
urlCrawlErrorCount :: URLCrawlErrorCount
-- | The error count at the given timestamp.
ucecCount :: Lens' URLCrawlErrorCount (Maybe Int64)
-- | The date and time when the crawl attempt took place, in RFC 3339
-- format.
ucecTimestamp :: Lens' URLCrawlErrorCount (Maybe UTCTime)
-- | The user agent type (platform) that made the request. For example:
-- web. If not specified, returns results for all platforms.
data URLCrawlErrorscountsQueryPlatform
-- |
-- mobile
--
UCEQPMobile :: URLCrawlErrorscountsQueryPlatform
-- |
-- smartphoneOnly
--
UCEQPSmartphoneOnly :: URLCrawlErrorscountsQueryPlatform
-- |
-- web
--
UCEQPWeb :: URLCrawlErrorscountsQueryPlatform
-- | A list of rows, one per result, grouped by key. Metrics in each row
-- are aggregated for all data grouped by that key either by page or
-- property, as specified by the aggregation type parameter.
--
-- See: searchAnalyticsQueryResponse smart constructor.
data SearchAnalyticsQueryResponse
-- | Creates a value of SearchAnalyticsQueryResponse with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
searchAnalyticsQueryResponse :: SearchAnalyticsQueryResponse
-- | A list of rows grouped by the key values in the order given in the
-- query.
saqrRows :: Lens' SearchAnalyticsQueryResponse [APIDataRow]
-- | How the results were aggregated.
saqrResponseAggregationType :: Lens' SearchAnalyticsQueryResponse (Maybe Text)
-- | The crawl error category. For example: authPermissions
data URLCrawlErrorsSamplesListCategory
-- |
-- authPermissions
--
UCESLCAuthPermissions :: URLCrawlErrorsSamplesListCategory
-- |
-- flashContent
--
UCESLCFlashContent :: URLCrawlErrorsSamplesListCategory
-- |
-- manyToOneRedirect
--
UCESLCManyToOneRedirect :: URLCrawlErrorsSamplesListCategory
-- |
-- notFollowed
--
UCESLCNotFollowed :: URLCrawlErrorsSamplesListCategory
-- |
-- notFound
--
UCESLCNotFound :: URLCrawlErrorsSamplesListCategory
-- |
-- other
--
UCESLCOther :: URLCrawlErrorsSamplesListCategory
-- |
-- roboted
--
UCESLCRoboted :: URLCrawlErrorsSamplesListCategory
-- |
-- serverError
--
UCESLCServerError :: URLCrawlErrorsSamplesListCategory
-- |
-- soft404
--
UCESLCSOFT404 :: URLCrawlErrorsSamplesListCategory
-- | List of crawl error samples.
--
-- See: urlCrawlErrorsSamplesListResponse smart
-- constructor.
data URLCrawlErrorsSamplesListResponse
-- | Creates a value of URLCrawlErrorsSamplesListResponse with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
urlCrawlErrorsSamplesListResponse :: URLCrawlErrorsSamplesListResponse
-- | Information about the sample URL and its crawl error.
uceslrURLCrawlErrorSample :: Lens' URLCrawlErrorsSamplesListResponse [URLCrawlErrorsSample]
-- | A time series of the number of URL crawl errors per error category and
-- platform.
--
-- See: urlCrawlErrorsCountsQueryResponse smart
-- constructor.
data URLCrawlErrorsCountsQueryResponse
-- | Creates a value of URLCrawlErrorsCountsQueryResponse with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
urlCrawlErrorsCountsQueryResponse :: URLCrawlErrorsCountsQueryResponse
-- | The time series of the number of URL crawl errors per error category
-- and platform.
ucecqrCountPerTypes :: Lens' URLCrawlErrorsCountsQueryResponse [URLCrawlErrorCountsPerType]
-- | Contains information about specific crawl errors.
--
-- See: urlCrawlErrorsSample smart constructor.
data URLCrawlErrorsSample
-- | Creates a value of URLCrawlErrorsSample with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
urlCrawlErrorsSample :: URLCrawlErrorsSample
-- | The HTTP response code, if any.
ucesResponseCode :: Lens' URLCrawlErrorsSample (Maybe Int32)
-- | Additional details about the URL, set only when calling get().
ucesURLDetails :: Lens' URLCrawlErrorsSample (Maybe URLSampleDetails)
-- | The time when the URL was last crawled, in RFC 3339 format.
ucesLastCrawled :: Lens' URLCrawlErrorsSample (Maybe UTCTime)
-- | The URL of an error, relative to the site.
ucesPageURL :: Lens' URLCrawlErrorsSample (Maybe Text)
-- | The time the error was first detected, in RFC 3339 format.
ucesFirstDetected :: Lens' URLCrawlErrorsSample (Maybe UTCTime)
-- | Contains detailed information about a specific URL submitted as a
-- sitemap.
--
-- See: wmxSitemap smart constructor.
data WmxSitemap
-- | Creates a value of WmxSitemap with the minimum fields required
-- to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
wmxSitemap :: WmxSitemap
-- | The various content types in the sitemap.
wsContents :: Lens' WmxSitemap [WmxSitemapContent]
-- | The url of the sitemap.
wsPath :: Lens' WmxSitemap (Maybe Text)
-- | If true, the sitemap is a collection of sitemaps.
wsIsSitemapsIndex :: Lens' WmxSitemap (Maybe Bool)
-- | Date & time in which this sitemap was submitted. Date format is in
-- RFC 3339 format (yyyy-mm-dd).
wsLastSubmitted :: Lens' WmxSitemap (Maybe UTCTime)
-- | Number of warnings for the sitemap. These are generally non-critical
-- issues with URLs in the sitemaps.
wsWarnings :: Lens' WmxSitemap (Maybe Int64)
-- | Date & time in which this sitemap was last downloaded. Date format
-- is in RFC 3339 format (yyyy-mm-dd).
wsLastDownloaded :: Lens' WmxSitemap (Maybe UTCTime)
-- | If true, the sitemap has not been processed.
wsIsPending :: Lens' WmxSitemap (Maybe Bool)
-- | The type of the sitemap. For example: rssFeed.
wsType :: Lens' WmxSitemap (Maybe Text)
-- | Number of errors in the sitemap. These are issues with the sitemap
-- itself that need to be fixed before it can be processed correctly.
wsErrors :: Lens' WmxSitemap (Maybe Int64)
-- | List of sitemaps.
--
-- See: sitemapsListResponse smart constructor.
data SitemapsListResponse
-- | Creates a value of SitemapsListResponse with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
sitemapsListResponse :: SitemapsListResponse
-- | Contains detailed information about a specific URL submitted as a
-- sitemap.
slrSitemap :: Lens' SitemapsListResponse [WmxSitemap]
data SearchAnalyticsQueryRequest
-- | Creates a value of SearchAnalyticsQueryRequest with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
searchAnalyticsQueryRequest :: SearchAnalyticsQueryRequest
-- |
-- - Optional; Default is "auto" How data is aggregated. If
-- aggregated by property, all data for the same property is aggregated;
-- if aggregated by page, all data is aggregated by canonical URI. If you
-- filter or group by page, choose AUTO; otherwise you can aggregate
-- either by property or by page, depending on how you want your data
-- calculated; see the help documentation to learn how data is calculated
-- differently by site versus by page. Note: If you group or filter by
-- page, you cannot aggregate by property. If you specify any value other
-- than AUTO, the aggregation type in the result will match the requested
-- type, or if you request an invalid type, you will get an error. The
-- API will never change your aggregation type if the requested type is
-- invalid.
--
saqrAggregationType :: Lens' SearchAnalyticsQueryRequest (Maybe Text)
-- |
-- - Optional; Default is 1000 The maximum number of rows to
-- return. Must be a number from 1 to 5,000 (inclusive).
--
saqrRowLimit :: Lens' SearchAnalyticsQueryRequest (Maybe Int32)
-- |
-- - Required End date of the requested date range, in
-- YYYY-MM-DD format, in PST (UTC - 8:00). Must be greater than or equal
-- to the start date. This value is included in the range.
--
saqrEndDate :: Lens' SearchAnalyticsQueryRequest (Maybe Text)
-- |
-- - Optional; Default is "web" The search type to filter
-- for.
--
saqrSearchType :: Lens' SearchAnalyticsQueryRequest (Maybe Text)
-- |
-- - Optional Zero or more filters to apply to the dimension
-- grouping values; for example, 'query contains "buy"' to see only data
-- where the query string contains the substring "buy" (not
-- case-sensitive). You can filter by a dimension without grouping by
-- it.
--
saqrDimensionFilterGroups :: Lens' SearchAnalyticsQueryRequest [APIdimensionFilterGroup]
-- |
-- - Required Start date of the requested date range, in
-- YYYY-MM-DD format, in PST time (UTC - 8:00). Must be less than or
-- equal to the end date. This value is included in the range.
--
saqrStartDate :: Lens' SearchAnalyticsQueryRequest (Maybe Text)
-- |
-- - Optional; Default is 0 Zero-based index of the first row in
-- the response. Must be a non-negative number.
--
saqrStartRow :: Lens' SearchAnalyticsQueryRequest (Maybe Int32)
-- |
-- - Optional Zero or more dimensions to group results by.
-- Dimensions are the group-by values in the Search Analytics page.
-- Dimensions are combined to create a unique row key for each row.
-- Results are grouped in the order that you supply these
-- dimensions.
--
saqrDimensions :: Lens' SearchAnalyticsQueryRequest [Text]
-- | The user agent type (platform) that made the request. For example: web
data URLCrawlErrorsSamplesListPlatform
-- |
-- mobile
--
UCESLPMobile :: URLCrawlErrorsSamplesListPlatform
-- |
-- smartphoneOnly
--
UCESLPSmartphoneOnly :: URLCrawlErrorsSamplesListPlatform
-- |
-- web
--
UCESLPWeb :: URLCrawlErrorsSamplesListPlatform
-- | List of sites with access level information.
--
-- See: sitesListResponse smart constructor.
data SitesListResponse
-- | 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:
--
--
sitesListResponse :: SitesListResponse
-- | Contains permission level information about a Search Console site. For
-- more information, see Permissions in Search Console.
slrSiteEntry :: Lens' SitesListResponse [WmxSite]
-- | Contains permission level information about a Search Console site. For
-- more information, see Permissions in Search Console.
--
-- See: wmxSite smart constructor.
data WmxSite
-- | Creates a value of WmxSite with the minimum fields required to
-- make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
wmxSite :: WmxSite
-- | The user's permission level for the site.
wsPermissionLevel :: Lens' WmxSite (Maybe Text)
-- | The URL of the site.
wsSiteURL :: Lens' WmxSite (Maybe Text)
-- | The crawl error category. For example: serverError. If not specified,
-- returns results for all categories.
data URLCrawlErrorscountsQueryCategory
-- |
-- authPermissions
--
UCEQCAuthPermissions :: URLCrawlErrorscountsQueryCategory
-- |
-- flashContent
--
UCEQCFlashContent :: URLCrawlErrorscountsQueryCategory
-- |
-- manyToOneRedirect
--
UCEQCManyToOneRedirect :: URLCrawlErrorscountsQueryCategory
-- |
-- notFollowed
--
UCEQCNotFollowed :: URLCrawlErrorscountsQueryCategory
-- |
-- notFound
--
UCEQCNotFound :: URLCrawlErrorscountsQueryCategory
-- |
-- other
--
UCEQCOther :: URLCrawlErrorscountsQueryCategory
-- |
-- roboted
--
UCEQCRoboted :: URLCrawlErrorscountsQueryCategory
-- |
-- serverError
--
UCEQCServerError :: URLCrawlErrorscountsQueryCategory
-- |
-- soft404
--
UCEQCSOFT404 :: URLCrawlErrorscountsQueryCategory
-- | Retrieves a time series of the number of URL crawl errors per error
-- category and platform.
--
-- See: Search Console API Reference for
-- webmasters.urlcrawlerrorscounts.query.
module Network.Google.Resource.Webmasters.URLCrawlErrorscounts.Query
-- | A resource alias for webmasters.urlcrawlerrorscounts.query
-- method which the URLCrawlErrorscountsQuery request conforms to.
type URLCrawlErrorscountsQueryResource = "webmasters" :> "v3" :> "sites" :> Capture "siteUrl" Text :> "urlCrawlErrorsCounts" :> "query" :> QueryParam "platform" URLCrawlErrorscountsQueryPlatform :> QueryParam "category" URLCrawlErrorscountsQueryCategory :> QueryParam "latestCountsOnly" Bool :> QueryParam "alt" AltJSON :> Get '[JSON] URLCrawlErrorsCountsQueryResponse
-- | Creates a value of URLCrawlErrorscountsQuery with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
urlCrawlErrorscountsQuery :: Text -> URLCrawlErrorscountsQuery
-- | Retrieves a time series of the number of URL crawl errors per error
-- category and platform.
--
-- See: urlCrawlErrorscountsQuery smart constructor.
data URLCrawlErrorscountsQuery
-- | The user agent type (platform) that made the request. For example:
-- web. If not specified, returns results for all platforms.
uceqPlatform :: Lens' URLCrawlErrorscountsQuery (Maybe URLCrawlErrorscountsQueryPlatform)
-- | The crawl error category. For example: serverError. If not specified,
-- returns results for all categories.
uceqCategory :: Lens' URLCrawlErrorscountsQuery (Maybe URLCrawlErrorscountsQueryCategory)
-- | The site's URL, including protocol. For example:
-- http://www.example.com/
uceqSiteURL :: Lens' URLCrawlErrorscountsQuery Text
-- | If true, returns only the latest crawl error counts.
uceqLatestCountsOnly :: Lens' URLCrawlErrorscountsQuery Bool
instance GHC.Generics.Generic Network.Google.Resource.Webmasters.URLCrawlErrorscounts.Query.URLCrawlErrorscountsQuery
instance Data.Data.Data Network.Google.Resource.Webmasters.URLCrawlErrorscounts.Query.URLCrawlErrorscountsQuery
instance GHC.Show.Show Network.Google.Resource.Webmasters.URLCrawlErrorscounts.Query.URLCrawlErrorscountsQuery
instance GHC.Classes.Eq Network.Google.Resource.Webmasters.URLCrawlErrorscounts.Query.URLCrawlErrorscountsQuery
instance Network.Google.Types.GoogleRequest Network.Google.Resource.Webmasters.URLCrawlErrorscounts.Query.URLCrawlErrorscountsQuery
-- | Marks the provided site's sample URL as fixed, and removes it from the
-- samples list.
--
-- See: Search Console API Reference for
-- webmasters.urlcrawlerrorssamples.markAsFixed.
module Network.Google.Resource.Webmasters.URLCrawlErrorsSamples.MarkAsFixed
-- | A resource alias for
-- webmasters.urlcrawlerrorssamples.markAsFixed method which the
-- URLCrawlErrorsSamplesMarkAsFixed request conforms to.
type URLCrawlErrorsSamplesMarkAsFixedResource = "webmasters" :> "v3" :> "sites" :> Capture "siteUrl" Text :> "urlCrawlErrorsSamples" :> Capture "url" Text :> QueryParam "category" URLCrawlErrorsSamplesMarkAsFixedCategory :> QueryParam "platform" URLCrawlErrorsSamplesMarkAsFixedPlatform :> QueryParam "alt" AltJSON :> Delete '[JSON] ()
-- | Creates a value of URLCrawlErrorsSamplesMarkAsFixed with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
urlCrawlErrorsSamplesMarkAsFixed :: URLCrawlErrorsSamplesMarkAsFixedPlatform -> URLCrawlErrorsSamplesMarkAsFixedCategory -> Text -> Text -> URLCrawlErrorsSamplesMarkAsFixed
-- | Marks the provided site's sample URL as fixed, and removes it from the
-- samples list.
--
-- See: urlCrawlErrorsSamplesMarkAsFixed smart constructor.
data URLCrawlErrorsSamplesMarkAsFixed
-- | The user agent type (platform) that made the request. For example: web
ucesmafPlatform :: Lens' URLCrawlErrorsSamplesMarkAsFixed URLCrawlErrorsSamplesMarkAsFixedPlatform
-- | The crawl error category. For example: authPermissions
ucesmafCategory :: Lens' URLCrawlErrorsSamplesMarkAsFixed URLCrawlErrorsSamplesMarkAsFixedCategory
-- | The site's URL, including protocol. For example:
-- http://www.example.com/
ucesmafSiteURL :: Lens' URLCrawlErrorsSamplesMarkAsFixed Text
-- | The relative path (without the site) of the sample URL. It must be one
-- of the URLs returned by list(). For example, for the URL
-- https://www.example.com/pagename on the site https://www.example.com/,
-- the url value is pagename
ucesmafURL :: Lens' URLCrawlErrorsSamplesMarkAsFixed Text
instance GHC.Generics.Generic Network.Google.Resource.Webmasters.URLCrawlErrorsSamples.MarkAsFixed.URLCrawlErrorsSamplesMarkAsFixed
instance Data.Data.Data Network.Google.Resource.Webmasters.URLCrawlErrorsSamples.MarkAsFixed.URLCrawlErrorsSamplesMarkAsFixed
instance GHC.Show.Show Network.Google.Resource.Webmasters.URLCrawlErrorsSamples.MarkAsFixed.URLCrawlErrorsSamplesMarkAsFixed
instance GHC.Classes.Eq Network.Google.Resource.Webmasters.URLCrawlErrorsSamples.MarkAsFixed.URLCrawlErrorsSamplesMarkAsFixed
instance Network.Google.Types.GoogleRequest Network.Google.Resource.Webmasters.URLCrawlErrorsSamples.MarkAsFixed.URLCrawlErrorsSamplesMarkAsFixed
-- | Lists a site's sample URLs for the specified crawl error category and
-- platform.
--
-- See: Search Console API Reference for
-- webmasters.urlcrawlerrorssamples.list.
module Network.Google.Resource.Webmasters.URLCrawlErrorsSamples.List
-- | A resource alias for webmasters.urlcrawlerrorssamples.list
-- method which the URLCrawlErrorsSamplesList request conforms to.
type URLCrawlErrorsSamplesListResource = "webmasters" :> "v3" :> "sites" :> Capture "siteUrl" Text :> "urlCrawlErrorsSamples" :> QueryParam "category" URLCrawlErrorsSamplesListCategory :> QueryParam "platform" URLCrawlErrorsSamplesListPlatform :> QueryParam "alt" AltJSON :> Get '[JSON] URLCrawlErrorsSamplesListResponse
-- | Creates a value of URLCrawlErrorsSamplesList with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
urlCrawlErrorsSamplesList :: URLCrawlErrorsSamplesListPlatform -> URLCrawlErrorsSamplesListCategory -> Text -> URLCrawlErrorsSamplesList
-- | Lists a site's sample URLs for the specified crawl error category and
-- platform.
--
-- See: urlCrawlErrorsSamplesList smart constructor.
data URLCrawlErrorsSamplesList
-- | The user agent type (platform) that made the request. For example: web
uceslPlatform :: Lens' URLCrawlErrorsSamplesList URLCrawlErrorsSamplesListPlatform
-- | The crawl error category. For example: authPermissions
uceslCategory :: Lens' URLCrawlErrorsSamplesList URLCrawlErrorsSamplesListCategory
-- | The site's URL, including protocol. For example:
-- http://www.example.com/
uceslSiteURL :: Lens' URLCrawlErrorsSamplesList Text
instance GHC.Generics.Generic Network.Google.Resource.Webmasters.URLCrawlErrorsSamples.List.URLCrawlErrorsSamplesList
instance Data.Data.Data Network.Google.Resource.Webmasters.URLCrawlErrorsSamples.List.URLCrawlErrorsSamplesList
instance GHC.Show.Show Network.Google.Resource.Webmasters.URLCrawlErrorsSamples.List.URLCrawlErrorsSamplesList
instance GHC.Classes.Eq Network.Google.Resource.Webmasters.URLCrawlErrorsSamples.List.URLCrawlErrorsSamplesList
instance Network.Google.Types.GoogleRequest Network.Google.Resource.Webmasters.URLCrawlErrorsSamples.List.URLCrawlErrorsSamplesList
-- | Retrieves details about crawl errors for a site's sample URL.
--
-- See: Search Console API Reference for
-- webmasters.urlcrawlerrorssamples.get.
module Network.Google.Resource.Webmasters.URLCrawlErrorsSamples.Get
-- | A resource alias for webmasters.urlcrawlerrorssamples.get
-- method which the URLCrawlErrorsSamplesGet request conforms to.
type URLCrawlErrorsSamplesGetResource = "webmasters" :> "v3" :> "sites" :> Capture "siteUrl" Text :> "urlCrawlErrorsSamples" :> Capture "url" Text :> QueryParam "category" URLCrawlErrorsSamplesGetCategory :> QueryParam "platform" URLCrawlErrorsSamplesGetPlatform :> QueryParam "alt" AltJSON :> Get '[JSON] URLCrawlErrorsSample
-- | Creates a value of URLCrawlErrorsSamplesGet with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
urlCrawlErrorsSamplesGet :: URLCrawlErrorsSamplesGetPlatform -> URLCrawlErrorsSamplesGetCategory -> Text -> Text -> URLCrawlErrorsSamplesGet
-- | Retrieves details about crawl errors for a site's sample URL.
--
-- See: urlCrawlErrorsSamplesGet smart constructor.
data URLCrawlErrorsSamplesGet
-- | The user agent type (platform) that made the request. For example: web
ucesgPlatform :: Lens' URLCrawlErrorsSamplesGet URLCrawlErrorsSamplesGetPlatform
-- | The crawl error category. For example: authPermissions
ucesgCategory :: Lens' URLCrawlErrorsSamplesGet URLCrawlErrorsSamplesGetCategory
-- | The site's URL, including protocol. For example:
-- http://www.example.com/
ucesgSiteURL :: Lens' URLCrawlErrorsSamplesGet Text
-- | The relative path (without the site) of the sample URL. It must be one
-- of the URLs returned by list(). For example, for the URL
-- https://www.example.com/pagename on the site https://www.example.com/,
-- the url value is pagename
ucesgURL :: Lens' URLCrawlErrorsSamplesGet Text
instance GHC.Generics.Generic Network.Google.Resource.Webmasters.URLCrawlErrorsSamples.Get.URLCrawlErrorsSamplesGet
instance Data.Data.Data Network.Google.Resource.Webmasters.URLCrawlErrorsSamples.Get.URLCrawlErrorsSamplesGet
instance GHC.Show.Show Network.Google.Resource.Webmasters.URLCrawlErrorsSamples.Get.URLCrawlErrorsSamplesGet
instance GHC.Classes.Eq Network.Google.Resource.Webmasters.URLCrawlErrorsSamples.Get.URLCrawlErrorsSamplesGet
instance Network.Google.Types.GoogleRequest Network.Google.Resource.Webmasters.URLCrawlErrorsSamples.Get.URLCrawlErrorsSamplesGet
-- | Lists the user's Search Console sites.
--
-- See: Search Console API Reference for
-- webmasters.sites.list.
module Network.Google.Resource.Webmasters.Sites.List
-- | A resource alias for webmasters.sites.list method which the
-- SitesList request conforms to.
type SitesListResource = "webmasters" :> "v3" :> "sites" :> QueryParam "alt" AltJSON :> Get '[JSON] SitesListResponse
-- | Creates a value of SitesList with the minimum fields required
-- to make a request.
sitesList :: SitesList
-- | Lists the user's Search Console sites.
--
-- See: sitesList smart constructor.
data SitesList
instance GHC.Generics.Generic Network.Google.Resource.Webmasters.Sites.List.SitesList
instance Data.Data.Data Network.Google.Resource.Webmasters.Sites.List.SitesList
instance GHC.Show.Show Network.Google.Resource.Webmasters.Sites.List.SitesList
instance GHC.Classes.Eq Network.Google.Resource.Webmasters.Sites.List.SitesList
instance Network.Google.Types.GoogleRequest Network.Google.Resource.Webmasters.Sites.List.SitesList
-- | Retrieves information about specific site.
--
-- See: Search Console API Reference for
-- webmasters.sites.get.
module Network.Google.Resource.Webmasters.Sites.Get
-- | A resource alias for webmasters.sites.get method which the
-- SitesGet request conforms to.
type SitesGetResource = "webmasters" :> "v3" :> "sites" :> Capture "siteUrl" Text :> QueryParam "alt" AltJSON :> Get '[JSON] WmxSite
-- | 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:
--
--
sitesGet :: Text -> SitesGet
-- | Retrieves information about specific site.
--
-- See: sitesGet smart constructor.
data SitesGet
-- | The URI of the property as defined in Search Console. Examples:
-- http://www.example.com/ or android-app://com.example/ Note: for
-- property-sets, use the URI that starts with sc-set: which is used in
-- Search Console URLs.
sitSiteURL :: Lens' SitesGet Text
instance GHC.Generics.Generic Network.Google.Resource.Webmasters.Sites.Get.SitesGet
instance Data.Data.Data Network.Google.Resource.Webmasters.Sites.Get.SitesGet
instance GHC.Show.Show Network.Google.Resource.Webmasters.Sites.Get.SitesGet
instance GHC.Classes.Eq Network.Google.Resource.Webmasters.Sites.Get.SitesGet
instance Network.Google.Types.GoogleRequest Network.Google.Resource.Webmasters.Sites.Get.SitesGet
-- | Removes a site from the set of the user's Search Console sites.
--
-- See: Search Console API Reference for
-- webmasters.sites.delete.
module Network.Google.Resource.Webmasters.Sites.Delete
-- | A resource alias for webmasters.sites.delete method which the
-- SitesDelete request conforms to.
type SitesDeleteResource = "webmasters" :> "v3" :> "sites" :> Capture "siteUrl" Text :> QueryParam "alt" AltJSON :> Delete '[JSON] ()
-- | Creates a value of SitesDelete with the minimum fields required
-- to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
sitesDelete :: Text -> SitesDelete
-- | Removes a site from the set of the user's Search Console sites.
--
-- See: sitesDelete smart constructor.
data SitesDelete
-- | The URI of the property as defined in Search Console. Examples:
-- http://www.example.com/ or android-app://com.example/ Note: for
-- property-sets, use the URI that starts with sc-set: which is used in
-- Search Console URLs.
sSiteURL :: Lens' SitesDelete Text
instance GHC.Generics.Generic Network.Google.Resource.Webmasters.Sites.Delete.SitesDelete
instance Data.Data.Data Network.Google.Resource.Webmasters.Sites.Delete.SitesDelete
instance GHC.Show.Show Network.Google.Resource.Webmasters.Sites.Delete.SitesDelete
instance GHC.Classes.Eq Network.Google.Resource.Webmasters.Sites.Delete.SitesDelete
instance Network.Google.Types.GoogleRequest Network.Google.Resource.Webmasters.Sites.Delete.SitesDelete
-- | Adds a site to the set of the user's sites in Search Console.
--
-- See: Search Console API Reference for
-- webmasters.sites.add.
module Network.Google.Resource.Webmasters.Sites.Add
-- | A resource alias for webmasters.sites.add method which the
-- SitesAdd request conforms to.
type SitesAddResource = "webmasters" :> "v3" :> "sites" :> Capture "siteUrl" Text :> QueryParam "alt" AltJSON :> Put '[JSON] ()
-- | Creates a value of SitesAdd with the minimum fields required to
-- make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
sitesAdd :: Text -> SitesAdd
-- | Adds a site to the set of the user's sites in Search Console.
--
-- See: sitesAdd smart constructor.
data SitesAdd
-- | The URL of the site to add.
saSiteURL :: Lens' SitesAdd Text
instance GHC.Generics.Generic Network.Google.Resource.Webmasters.Sites.Add.SitesAdd
instance Data.Data.Data Network.Google.Resource.Webmasters.Sites.Add.SitesAdd
instance GHC.Show.Show Network.Google.Resource.Webmasters.Sites.Add.SitesAdd
instance GHC.Classes.Eq Network.Google.Resource.Webmasters.Sites.Add.SitesAdd
instance Network.Google.Types.GoogleRequest Network.Google.Resource.Webmasters.Sites.Add.SitesAdd
-- | Submits a sitemap for a site.
--
-- See: Search Console API Reference for
-- webmasters.sitemaps.submit.
module Network.Google.Resource.Webmasters.Sitemaps.Submit
-- | A resource alias for webmasters.sitemaps.submit method which
-- the SitemapsSubmit request conforms to.
type SitemapsSubmitResource = "webmasters" :> "v3" :> "sites" :> Capture "siteUrl" Text :> "sitemaps" :> Capture "feedpath" Text :> QueryParam "alt" AltJSON :> Put '[JSON] ()
-- | Creates a value of SitemapsSubmit with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
sitemapsSubmit :: Text -> Text -> SitemapsSubmit
-- | Submits a sitemap for a site.
--
-- See: sitemapsSubmit smart constructor.
data SitemapsSubmit
-- | The URL of the sitemap to add. For example:
-- http://www.example.com/sitemap.xml
ssFeedpath :: Lens' SitemapsSubmit Text
-- | The site's URL, including protocol. For example:
-- http://www.example.com/
ssSiteURL :: Lens' SitemapsSubmit Text
instance GHC.Generics.Generic Network.Google.Resource.Webmasters.Sitemaps.Submit.SitemapsSubmit
instance Data.Data.Data Network.Google.Resource.Webmasters.Sitemaps.Submit.SitemapsSubmit
instance GHC.Show.Show Network.Google.Resource.Webmasters.Sitemaps.Submit.SitemapsSubmit
instance GHC.Classes.Eq Network.Google.Resource.Webmasters.Sitemaps.Submit.SitemapsSubmit
instance Network.Google.Types.GoogleRequest Network.Google.Resource.Webmasters.Sitemaps.Submit.SitemapsSubmit
-- | Lists the sitemaps-entries submitted for this site, or included in the
-- sitemap index file (if sitemapIndex is specified in the request).
--
-- See: Search Console API Reference for
-- webmasters.sitemaps.list.
module Network.Google.Resource.Webmasters.Sitemaps.List
-- | A resource alias for webmasters.sitemaps.list method which
-- the SitemapsList request conforms to.
type SitemapsListResource = "webmasters" :> "v3" :> "sites" :> Capture "siteUrl" Text :> "sitemaps" :> QueryParam "sitemapIndex" Text :> QueryParam "alt" AltJSON :> Get '[JSON] SitemapsListResponse
-- | Creates a value of SitemapsList with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
sitemapsList :: Text -> SitemapsList
-- | Lists the sitemaps-entries submitted for this site, or included in the
-- sitemap index file (if sitemapIndex is specified in the request).
--
-- See: sitemapsList smart constructor.
data SitemapsList
-- | The site's URL, including protocol. For example:
-- http://www.example.com/
slSiteURL :: Lens' SitemapsList Text
-- | A URL of a site's sitemap index. For example:
-- http://www.example.com/sitemapindex.xml
slSitemapIndex :: Lens' SitemapsList (Maybe Text)
instance GHC.Generics.Generic Network.Google.Resource.Webmasters.Sitemaps.List.SitemapsList
instance Data.Data.Data Network.Google.Resource.Webmasters.Sitemaps.List.SitemapsList
instance GHC.Show.Show Network.Google.Resource.Webmasters.Sitemaps.List.SitemapsList
instance GHC.Classes.Eq Network.Google.Resource.Webmasters.Sitemaps.List.SitemapsList
instance Network.Google.Types.GoogleRequest Network.Google.Resource.Webmasters.Sitemaps.List.SitemapsList
-- | Retrieves information about a specific sitemap.
--
-- See: Search Console API Reference for
-- webmasters.sitemaps.get.
module Network.Google.Resource.Webmasters.Sitemaps.Get
-- | A resource alias for webmasters.sitemaps.get method which the
-- SitemapsGet request conforms to.
type SitemapsGetResource = "webmasters" :> "v3" :> "sites" :> Capture "siteUrl" Text :> "sitemaps" :> Capture "feedpath" Text :> QueryParam "alt" AltJSON :> Get '[JSON] WmxSitemap
-- | Creates a value of SitemapsGet with the minimum fields required
-- to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
sitemapsGet :: Text -> Text -> SitemapsGet
-- | Retrieves information about a specific sitemap.
--
-- See: sitemapsGet smart constructor.
data SitemapsGet
-- | The URL of the actual sitemap. For example:
-- http://www.example.com/sitemap.xml
sgFeedpath :: Lens' SitemapsGet Text
-- | The site's URL, including protocol. For example:
-- http://www.example.com/
sgSiteURL :: Lens' SitemapsGet Text
instance GHC.Generics.Generic Network.Google.Resource.Webmasters.Sitemaps.Get.SitemapsGet
instance Data.Data.Data Network.Google.Resource.Webmasters.Sitemaps.Get.SitemapsGet
instance GHC.Show.Show Network.Google.Resource.Webmasters.Sitemaps.Get.SitemapsGet
instance GHC.Classes.Eq Network.Google.Resource.Webmasters.Sitemaps.Get.SitemapsGet
instance Network.Google.Types.GoogleRequest Network.Google.Resource.Webmasters.Sitemaps.Get.SitemapsGet
-- | Deletes a sitemap from this site.
--
-- See: Search Console API Reference for
-- webmasters.sitemaps.delete.
module Network.Google.Resource.Webmasters.Sitemaps.Delete
-- | A resource alias for webmasters.sitemaps.delete method which
-- the SitemapsDelete request conforms to.
type SitemapsDeleteResource = "webmasters" :> "v3" :> "sites" :> Capture "siteUrl" Text :> "sitemaps" :> Capture "feedpath" Text :> QueryParam "alt" AltJSON :> Delete '[JSON] ()
-- | Creates a value of SitemapsDelete with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
sitemapsDelete :: Text -> Text -> SitemapsDelete
-- | Deletes a sitemap from this site.
--
-- See: sitemapsDelete smart constructor.
data SitemapsDelete
-- | The URL of the actual sitemap. For example:
-- http://www.example.com/sitemap.xml
sdFeedpath :: Lens' SitemapsDelete Text
-- | The site's URL, including protocol. For example:
-- http://www.example.com/
sdSiteURL :: Lens' SitemapsDelete Text
instance GHC.Generics.Generic Network.Google.Resource.Webmasters.Sitemaps.Delete.SitemapsDelete
instance Data.Data.Data Network.Google.Resource.Webmasters.Sitemaps.Delete.SitemapsDelete
instance GHC.Show.Show Network.Google.Resource.Webmasters.Sitemaps.Delete.SitemapsDelete
instance GHC.Classes.Eq Network.Google.Resource.Webmasters.Sitemaps.Delete.SitemapsDelete
instance Network.Google.Types.GoogleRequest Network.Google.Resource.Webmasters.Sitemaps.Delete.SitemapsDelete
-- | Query your data with filters and parameters that you define. Returns
-- zero or more rows grouped by the row keys that you define. You must
-- define a date range of one or more days. When date is one of the group
-- by values, any days without data are omitted from the result list. If
-- you need to know which days have data, issue a broad date range query
-- grouped by date for any metric, and see which day rows are returned.
--
-- See: Search Console API Reference for
-- webmasters.searchanalytics.query.
module Network.Google.Resource.Webmasters.Searchanalytics.Query
-- | A resource alias for webmasters.searchanalytics.query method
-- which the SearchanalyticsQuery request conforms to.
type SearchanalyticsQueryResource = "webmasters" :> "v3" :> "sites" :> Capture "siteUrl" Text :> "searchAnalytics" :> "query" :> QueryParam "alt" AltJSON :> ReqBody '[JSON] SearchAnalyticsQueryRequest :> Post '[JSON] SearchAnalyticsQueryResponse
-- | Creates a value of SearchanalyticsQuery with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
searchanalyticsQuery :: Text -> SearchAnalyticsQueryRequest -> SearchanalyticsQuery
-- | Query your data with filters and parameters that you define. Returns
-- zero or more rows grouped by the row keys that you define. You must
-- define a date range of one or more days. When date is one of the group
-- by values, any days without data are omitted from the result list. If
-- you need to know which days have data, issue a broad date range query
-- grouped by date for any metric, and see which day rows are returned.
--
-- See: searchanalyticsQuery smart constructor.
data SearchanalyticsQuery
-- | The site's URL, including protocol. For example:
-- http://www.example.com/
sqSiteURL :: Lens' SearchanalyticsQuery Text
-- | Multipart request metadata.
sqPayload :: Lens' SearchanalyticsQuery SearchAnalyticsQueryRequest
instance GHC.Generics.Generic Network.Google.Resource.Webmasters.Searchanalytics.Query.SearchanalyticsQuery
instance Data.Data.Data Network.Google.Resource.Webmasters.Searchanalytics.Query.SearchanalyticsQuery
instance GHC.Show.Show Network.Google.Resource.Webmasters.Searchanalytics.Query.SearchanalyticsQuery
instance GHC.Classes.Eq Network.Google.Resource.Webmasters.Searchanalytics.Query.SearchanalyticsQuery
instance Network.Google.Types.GoogleRequest Network.Google.Resource.Webmasters.Searchanalytics.Query.SearchanalyticsQuery
-- | View Google Search Console data for your verified sites.
--
-- See: Search Console API Reference
module Network.Google.WebmasterTools
-- | Default request referring to version v3 of the Search Console
-- API. This contains the host and root path used as a starting point for
-- constructing service requests.
webmasterToolsService :: ServiceConfig
-- | View and manage Search Console data for your verified sites
webmastersScope :: Proxy '["https://www.googleapis.com/auth/webmasters"]
-- | View Search Console data for your verified sites
webmastersReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/webmasters.readonly"]
-- | Represents the entirety of the methods and resources available for the
-- Search Console API service.
type WebmasterToolsAPI = URLCrawlErrorsSamplesListResource :<|> URLCrawlErrorsSamplesGetResource :<|> URLCrawlErrorsSamplesMarkAsFixedResource :<|> SitemapsListResource :<|> SitemapsGetResource :<|> SitemapsSubmitResource :<|> SitemapsDeleteResource :<|> SearchanalyticsQueryResource :<|> SitesListResource :<|> SitesGetResource :<|> SitesAddResource :<|> SitesDeleteResource :<|> URLCrawlErrorscountsQueryResource
-- | Information about the various content types in the sitemap.
--
-- See: wmxSitemapContent smart constructor.
data WmxSitemapContent
-- | Creates a value of WmxSitemapContent with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
wmxSitemapContent :: WmxSitemapContent
-- | The number of URLs from the sitemap that were indexed (of the content
-- type).
wscIndexed :: Lens' WmxSitemapContent (Maybe Int64)
-- | The specific type of content in this sitemap. For example: web.
wscType :: Lens' WmxSitemapContent (Maybe Text)
-- | The number of URLs in the sitemap (of the content type).
wscSubmitted :: Lens' WmxSitemapContent (Maybe Int64)
data APIdimensionFilterGroup
-- | Creates a value of APIdimensionFilterGroup with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
apidimensionFilterGroup :: APIdimensionFilterGroup
afgFilters :: Lens' APIdimensionFilterGroup [APIdimensionFilter]
afgGroupType :: Lens' APIdimensionFilterGroup (Maybe Text)
-- | Additional details about the URL, set only when calling get().
--
-- See: urlSampleDetails smart constructor.
data URLSampleDetails
-- | Creates a value of URLSampleDetails with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
urlSampleDetails :: URLSampleDetails
-- | A sample set of URLs linking to this URL.
usdLinkedFromURLs :: Lens' URLSampleDetails [Text]
-- | List of sitemaps pointing at this URL.
usdContainingSitemaps :: Lens' URLSampleDetails [Text]
-- | The crawl error category. For example: authPermissions
data URLCrawlErrorsSamplesMarkAsFixedCategory
-- |
-- authPermissions
--
AuthPermissions :: URLCrawlErrorsSamplesMarkAsFixedCategory
-- |
-- flashContent
--
FlashContent :: URLCrawlErrorsSamplesMarkAsFixedCategory
-- |
-- manyToOneRedirect
--
ManyToOneRedirect :: URLCrawlErrorsSamplesMarkAsFixedCategory
-- |
-- notFollowed
--
NotFollowed :: URLCrawlErrorsSamplesMarkAsFixedCategory
-- |
-- notFound
--
NotFound :: URLCrawlErrorsSamplesMarkAsFixedCategory
-- |
-- other
--
Other :: URLCrawlErrorsSamplesMarkAsFixedCategory
-- |
-- roboted
--
Roboted :: URLCrawlErrorsSamplesMarkAsFixedCategory
-- |
-- serverError
--
ServerError :: URLCrawlErrorsSamplesMarkAsFixedCategory
-- |
-- soft404
--
SOFT404 :: URLCrawlErrorsSamplesMarkAsFixedCategory
-- | Number of errors per day for a specific error type (defined by
-- platform and category).
--
-- See: urlCrawlErrorCountsPerType smart constructor.
data URLCrawlErrorCountsPerType
-- | Creates a value of URLCrawlErrorCountsPerType with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
urlCrawlErrorCountsPerType :: URLCrawlErrorCountsPerType
-- | The general type of Googlebot that made the request (see list of
-- Googlebot user-agents for the user-agents used).
ucecptPlatform :: Lens' URLCrawlErrorCountsPerType (Maybe Text)
-- | The error count entries time series.
ucecptEntries :: Lens' URLCrawlErrorCountsPerType [URLCrawlErrorCount]
-- | The crawl error type.
ucecptCategory :: Lens' URLCrawlErrorCountsPerType (Maybe Text)
-- | The user agent type (platform) that made the request. For example: web
data URLCrawlErrorsSamplesGetPlatform
-- |
-- mobile
--
Mobile :: URLCrawlErrorsSamplesGetPlatform
-- |
-- smartphoneOnly
--
SmartphoneOnly :: URLCrawlErrorsSamplesGetPlatform
-- |
-- web
--
Web :: URLCrawlErrorsSamplesGetPlatform
data APIDataRow
-- | Creates a value of APIDataRow with the minimum fields required
-- to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
apiDataRow :: APIDataRow
adrImpressions :: Lens' APIDataRow (Maybe Double)
adrKeys :: Lens' APIDataRow [Text]
adrCtr :: Lens' APIDataRow (Maybe Double)
adrClicks :: Lens' APIDataRow (Maybe Double)
adrPosition :: Lens' APIDataRow (Maybe Double)
data APIdimensionFilter
-- | Creates a value of APIdimensionFilter with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
apidimensionFilter :: APIdimensionFilter
afOperator :: Lens' APIdimensionFilter (Maybe Text)
afDimension :: Lens' APIdimensionFilter (Maybe Text)
afExpression :: Lens' APIdimensionFilter (Maybe Text)
-- | The user agent type (platform) that made the request. For example: web
data URLCrawlErrorsSamplesMarkAsFixedPlatform
-- |
-- mobile
--
UCESMAFPMobile :: URLCrawlErrorsSamplesMarkAsFixedPlatform
-- |
-- smartphoneOnly
--
UCESMAFPSmartphoneOnly :: URLCrawlErrorsSamplesMarkAsFixedPlatform
-- |
-- web
--
UCESMAFPWeb :: URLCrawlErrorsSamplesMarkAsFixedPlatform
-- | The crawl error category. For example: authPermissions
data URLCrawlErrorsSamplesGetCategory
-- |
-- authPermissions
--
UCESGCAuthPermissions :: URLCrawlErrorsSamplesGetCategory
-- |
-- flashContent
--
UCESGCFlashContent :: URLCrawlErrorsSamplesGetCategory
-- |
-- manyToOneRedirect
--
UCESGCManyToOneRedirect :: URLCrawlErrorsSamplesGetCategory
-- |
-- notFollowed
--
UCESGCNotFollowed :: URLCrawlErrorsSamplesGetCategory
-- |
-- notFound
--
UCESGCNotFound :: URLCrawlErrorsSamplesGetCategory
-- |
-- other
--
UCESGCOther :: URLCrawlErrorsSamplesGetCategory
-- |
-- roboted
--
UCESGCRoboted :: URLCrawlErrorsSamplesGetCategory
-- |
-- serverError
--
UCESGCServerError :: URLCrawlErrorsSamplesGetCategory
-- |
-- soft404
--
UCESGCSOFT404 :: URLCrawlErrorsSamplesGetCategory
-- | An entry in a URL crawl errors time series.
--
-- See: urlCrawlErrorCount smart constructor.
data URLCrawlErrorCount
-- | Creates a value of URLCrawlErrorCount with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
urlCrawlErrorCount :: URLCrawlErrorCount
-- | The error count at the given timestamp.
ucecCount :: Lens' URLCrawlErrorCount (Maybe Int64)
-- | The date and time when the crawl attempt took place, in RFC 3339
-- format.
ucecTimestamp :: Lens' URLCrawlErrorCount (Maybe UTCTime)
-- | The user agent type (platform) that made the request. For example:
-- web. If not specified, returns results for all platforms.
data URLCrawlErrorscountsQueryPlatform
-- |
-- mobile
--
UCEQPMobile :: URLCrawlErrorscountsQueryPlatform
-- |
-- smartphoneOnly
--
UCEQPSmartphoneOnly :: URLCrawlErrorscountsQueryPlatform
-- |
-- web
--
UCEQPWeb :: URLCrawlErrorscountsQueryPlatform
-- | A list of rows, one per result, grouped by key. Metrics in each row
-- are aggregated for all data grouped by that key either by page or
-- property, as specified by the aggregation type parameter.
--
-- See: searchAnalyticsQueryResponse smart constructor.
data SearchAnalyticsQueryResponse
-- | Creates a value of SearchAnalyticsQueryResponse with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
searchAnalyticsQueryResponse :: SearchAnalyticsQueryResponse
-- | A list of rows grouped by the key values in the order given in the
-- query.
saqrRows :: Lens' SearchAnalyticsQueryResponse [APIDataRow]
-- | How the results were aggregated.
saqrResponseAggregationType :: Lens' SearchAnalyticsQueryResponse (Maybe Text)
-- | The crawl error category. For example: authPermissions
data URLCrawlErrorsSamplesListCategory
-- |
-- authPermissions
--
UCESLCAuthPermissions :: URLCrawlErrorsSamplesListCategory
-- |
-- flashContent
--
UCESLCFlashContent :: URLCrawlErrorsSamplesListCategory
-- |
-- manyToOneRedirect
--
UCESLCManyToOneRedirect :: URLCrawlErrorsSamplesListCategory
-- |
-- notFollowed
--
UCESLCNotFollowed :: URLCrawlErrorsSamplesListCategory
-- |
-- notFound
--
UCESLCNotFound :: URLCrawlErrorsSamplesListCategory
-- |
-- other
--
UCESLCOther :: URLCrawlErrorsSamplesListCategory
-- |
-- roboted
--
UCESLCRoboted :: URLCrawlErrorsSamplesListCategory
-- |
-- serverError
--
UCESLCServerError :: URLCrawlErrorsSamplesListCategory
-- |
-- soft404
--
UCESLCSOFT404 :: URLCrawlErrorsSamplesListCategory
-- | List of crawl error samples.
--
-- See: urlCrawlErrorsSamplesListResponse smart
-- constructor.
data URLCrawlErrorsSamplesListResponse
-- | Creates a value of URLCrawlErrorsSamplesListResponse with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
urlCrawlErrorsSamplesListResponse :: URLCrawlErrorsSamplesListResponse
-- | Information about the sample URL and its crawl error.
uceslrURLCrawlErrorSample :: Lens' URLCrawlErrorsSamplesListResponse [URLCrawlErrorsSample]
-- | A time series of the number of URL crawl errors per error category and
-- platform.
--
-- See: urlCrawlErrorsCountsQueryResponse smart
-- constructor.
data URLCrawlErrorsCountsQueryResponse
-- | Creates a value of URLCrawlErrorsCountsQueryResponse with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
urlCrawlErrorsCountsQueryResponse :: URLCrawlErrorsCountsQueryResponse
-- | The time series of the number of URL crawl errors per error category
-- and platform.
ucecqrCountPerTypes :: Lens' URLCrawlErrorsCountsQueryResponse [URLCrawlErrorCountsPerType]
-- | Contains information about specific crawl errors.
--
-- See: urlCrawlErrorsSample smart constructor.
data URLCrawlErrorsSample
-- | Creates a value of URLCrawlErrorsSample with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
urlCrawlErrorsSample :: URLCrawlErrorsSample
-- | The HTTP response code, if any.
ucesResponseCode :: Lens' URLCrawlErrorsSample (Maybe Int32)
-- | Additional details about the URL, set only when calling get().
ucesURLDetails :: Lens' URLCrawlErrorsSample (Maybe URLSampleDetails)
-- | The time when the URL was last crawled, in RFC 3339 format.
ucesLastCrawled :: Lens' URLCrawlErrorsSample (Maybe UTCTime)
-- | The URL of an error, relative to the site.
ucesPageURL :: Lens' URLCrawlErrorsSample (Maybe Text)
-- | The time the error was first detected, in RFC 3339 format.
ucesFirstDetected :: Lens' URLCrawlErrorsSample (Maybe UTCTime)
-- | Contains detailed information about a specific URL submitted as a
-- sitemap.
--
-- See: wmxSitemap smart constructor.
data WmxSitemap
-- | Creates a value of WmxSitemap with the minimum fields required
-- to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
wmxSitemap :: WmxSitemap
-- | The various content types in the sitemap.
wsContents :: Lens' WmxSitemap [WmxSitemapContent]
-- | The url of the sitemap.
wsPath :: Lens' WmxSitemap (Maybe Text)
-- | If true, the sitemap is a collection of sitemaps.
wsIsSitemapsIndex :: Lens' WmxSitemap (Maybe Bool)
-- | Date & time in which this sitemap was submitted. Date format is in
-- RFC 3339 format (yyyy-mm-dd).
wsLastSubmitted :: Lens' WmxSitemap (Maybe UTCTime)
-- | Number of warnings for the sitemap. These are generally non-critical
-- issues with URLs in the sitemaps.
wsWarnings :: Lens' WmxSitemap (Maybe Int64)
-- | Date & time in which this sitemap was last downloaded. Date format
-- is in RFC 3339 format (yyyy-mm-dd).
wsLastDownloaded :: Lens' WmxSitemap (Maybe UTCTime)
-- | If true, the sitemap has not been processed.
wsIsPending :: Lens' WmxSitemap (Maybe Bool)
-- | The type of the sitemap. For example: rssFeed.
wsType :: Lens' WmxSitemap (Maybe Text)
-- | Number of errors in the sitemap. These are issues with the sitemap
-- itself that need to be fixed before it can be processed correctly.
wsErrors :: Lens' WmxSitemap (Maybe Int64)
-- | List of sitemaps.
--
-- See: sitemapsListResponse smart constructor.
data SitemapsListResponse
-- | Creates a value of SitemapsListResponse with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
sitemapsListResponse :: SitemapsListResponse
-- | Contains detailed information about a specific URL submitted as a
-- sitemap.
slrSitemap :: Lens' SitemapsListResponse [WmxSitemap]
data SearchAnalyticsQueryRequest
-- | Creates a value of SearchAnalyticsQueryRequest with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
searchAnalyticsQueryRequest :: SearchAnalyticsQueryRequest
-- |
-- - Optional; Default is "auto" How data is aggregated. If
-- aggregated by property, all data for the same property is aggregated;
-- if aggregated by page, all data is aggregated by canonical URI. If you
-- filter or group by page, choose AUTO; otherwise you can aggregate
-- either by property or by page, depending on how you want your data
-- calculated; see the help documentation to learn how data is calculated
-- differently by site versus by page. Note: If you group or filter by
-- page, you cannot aggregate by property. If you specify any value other
-- than AUTO, the aggregation type in the result will match the requested
-- type, or if you request an invalid type, you will get an error. The
-- API will never change your aggregation type if the requested type is
-- invalid.
--
saqrAggregationType :: Lens' SearchAnalyticsQueryRequest (Maybe Text)
-- |
-- - Optional; Default is 1000 The maximum number of rows to
-- return. Must be a number from 1 to 5,000 (inclusive).
--
saqrRowLimit :: Lens' SearchAnalyticsQueryRequest (Maybe Int32)
-- |
-- - Required End date of the requested date range, in
-- YYYY-MM-DD format, in PST (UTC - 8:00). Must be greater than or equal
-- to the start date. This value is included in the range.
--
saqrEndDate :: Lens' SearchAnalyticsQueryRequest (Maybe Text)
-- |
-- - Optional; Default is "web" The search type to filter
-- for.
--
saqrSearchType :: Lens' SearchAnalyticsQueryRequest (Maybe Text)
-- |
-- - Optional Zero or more filters to apply to the dimension
-- grouping values; for example, 'query contains "buy"' to see only data
-- where the query string contains the substring "buy" (not
-- case-sensitive). You can filter by a dimension without grouping by
-- it.
--
saqrDimensionFilterGroups :: Lens' SearchAnalyticsQueryRequest [APIdimensionFilterGroup]
-- |
-- - Required Start date of the requested date range, in
-- YYYY-MM-DD format, in PST time (UTC - 8:00). Must be less than or
-- equal to the end date. This value is included in the range.
--
saqrStartDate :: Lens' SearchAnalyticsQueryRequest (Maybe Text)
-- |
-- - Optional; Default is 0 Zero-based index of the first row in
-- the response. Must be a non-negative number.
--
saqrStartRow :: Lens' SearchAnalyticsQueryRequest (Maybe Int32)
-- |
-- - Optional Zero or more dimensions to group results by.
-- Dimensions are the group-by values in the Search Analytics page.
-- Dimensions are combined to create a unique row key for each row.
-- Results are grouped in the order that you supply these
-- dimensions.
--
saqrDimensions :: Lens' SearchAnalyticsQueryRequest [Text]
-- | The user agent type (platform) that made the request. For example: web
data URLCrawlErrorsSamplesListPlatform
-- |
-- mobile
--
UCESLPMobile :: URLCrawlErrorsSamplesListPlatform
-- |
-- smartphoneOnly
--
UCESLPSmartphoneOnly :: URLCrawlErrorsSamplesListPlatform
-- |
-- web
--
UCESLPWeb :: URLCrawlErrorsSamplesListPlatform
-- | List of sites with access level information.
--
-- See: sitesListResponse smart constructor.
data SitesListResponse
-- | 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:
--
--
sitesListResponse :: SitesListResponse
-- | Contains permission level information about a Search Console site. For
-- more information, see Permissions in Search Console.
slrSiteEntry :: Lens' SitesListResponse [WmxSite]
-- | Contains permission level information about a Search Console site. For
-- more information, see Permissions in Search Console.
--
-- See: wmxSite smart constructor.
data WmxSite
-- | Creates a value of WmxSite with the minimum fields required to
-- make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
wmxSite :: WmxSite
-- | The user's permission level for the site.
wsPermissionLevel :: Lens' WmxSite (Maybe Text)
-- | The URL of the site.
wsSiteURL :: Lens' WmxSite (Maybe Text)
-- | The crawl error category. For example: serverError. If not specified,
-- returns results for all categories.
data URLCrawlErrorscountsQueryCategory
-- |
-- authPermissions
--
UCEQCAuthPermissions :: URLCrawlErrorscountsQueryCategory
-- |
-- flashContent
--
UCEQCFlashContent :: URLCrawlErrorscountsQueryCategory
-- |
-- manyToOneRedirect
--
UCEQCManyToOneRedirect :: URLCrawlErrorscountsQueryCategory
-- |
-- notFollowed
--
UCEQCNotFollowed :: URLCrawlErrorscountsQueryCategory
-- |
-- notFound
--
UCEQCNotFound :: URLCrawlErrorscountsQueryCategory
-- |
-- other
--
UCEQCOther :: URLCrawlErrorscountsQueryCategory
-- |
-- roboted
--
UCEQCRoboted :: URLCrawlErrorscountsQueryCategory
-- |
-- serverError
--
UCEQCServerError :: URLCrawlErrorscountsQueryCategory
-- |
-- soft404
--
UCEQCSOFT404 :: URLCrawlErrorscountsQueryCategory