Sitemap

GoogleApi.ContentWarehouse.V1.Model.Sitemap


Table of Contents ▼

Jump to a specific part of the page:

Description

Note: If you are going to populate any new field in this proto, you probably need to go through the go/dj-new-field and go/index-changes process.

Attributes List

This module has the following attributes (case-insensitive ascending order):

View Attributes

Attributes

  1. DEPRECATEDSourceTitle (type: String.t, default: nil)
    - DEPRECATED DEPRECATED DEPRECATED In case you didn't realize, these fields are (and have been for some time) deprecated. We'll stop pushing their data to production soon (probably Feb/09) and after a few weeks we'll probably remove them.
  2. TargetGroups (type: list(GoogleApi.ContentWarehouse.V1.Model.QualitySitemapTargetGroup), default: nil)
    - One Sitemap can contain multiple TargetGroups, but only one of them will be displayed to the user - this decision will be made at displaying time and can take into account various factors, such as the users' language and country, currently running experiments, etc.
  3. deprecatedTarget (type: list(GoogleApi.ContentWarehouse.V1.Model.SitemapDEPRECATED_Target), default: nil)
    -
  4. pageAnchorsDocInfo (type: GoogleApi.ContentWarehouse.V1.Model.SdrPageAnchorsDocInfo, default: nil)
    - This field is populated in the Sitemap MDU subpopulator from cdoc data. This is used to store page anchors information for TopicTagsScrolltoFlow.
  5. searchInSite (type: boolean(), default: nil)
    - Enable site search.
  6. sitemapType (type: String.t, default: nil)
    -
  7. sourceOrgfp (type: String.t, default: nil)
    - prevents cross-domain forwarding
  8. sourceUrl (type: String.t, default: nil)
    -
  9. subresultList (type: GoogleApi.ContentWarehouse.V1.Model.QualitySitemapSubresultList, default: nil)
    - This field is populated in the Sitemap MDU subpopulator from cdoc data. It's not set in the cdoc Sitemap.

Type

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.Sitemap{
DEPRECATEDSourceTitle: String.t() | nil,
TargetGroups: [GoogleApi.ContentWarehouse.V1.Model.QualitySitemapTargetGroup.t()] | nil,
deprecatedTarget: [GoogleApi.ContentWarehouse.V1.Model.SitemapDEPRECATED_Target.t()] | nil,
pageAnchorsDocInfo: GoogleApi.ContentWarehouse.V1.Model.SdrPageAnchorsDocInfo.t() | nil,
searchInSite: boolean() | nil,
sitemapType: String.t() | nil,
sourceOrgfp: String.t() | nil,
sourceUrl: String.t() | nil,
subresultList: GoogleApi.ContentWarehouse.V1.Model.QualitySitemapSubresultList.t() | nil
}

Function

@spec decode(struct(), keyword()) :: struct()

Data sourced from HexDocs : GoogleApi.ContentWarehouse.V1.Model.Sitemap