google_api_content v0.13.0 GoogleApi.Content.V2.Model.Product View Source

Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect.

Attributes

  • source (type: String.t, default: nil) - The source of the offer, i.e., how the offer was created.
  • targetCountry (type: String.t, default: nil) - The CLDR territory code for the item.
  • promotionIds (type: list(String.t), default: nil) - The unique ID of a promotion.
  • energyEfficiencyClass (type: String.t, default: nil) - The energy efficiency class as defined in EU directive 2010/30/EU.
  • customLabel3 (type: String.t, default: nil) - Custom label 3 for custom grouping of items in a Shopping campaign.
  • maxEnergyEfficiencyClass (type: String.t, default: nil) - The energy efficiency class as defined in EU directive 2010/30/EU.
  • title (type: String.t, default: nil) - Title of the item.
  • availabilityDate (type: String.t, default: nil) - The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
  • availability (type: String.t, default: nil) - Availability status of the item.
  • contentLanguage (type: String.t, default: nil) - The two-letter ISO 639-1 language code for the item.
  • sellOnGoogleQuantity (type: String.t, default: nil) - The quantity of the product that is available for selling on Google. Supported only for online products.
  • customLabel2 (type: String.t, default: nil) - Custom label 2 for custom grouping of items in a Shopping campaign.
  • displayAdsSimilarIds (type: list(String.t), default: nil) - Advertiser-specified recommendations.
  • shippingWeight (type: GoogleApi.Content.V2.Model.ProductShippingWeight.t, default: nil) - Weight of the item for shipping.
  • shippingLength (type: GoogleApi.Content.V2.Model.ProductShippingDimension.t, default: nil) - Length of the item for shipping.
  • id (type: String.t, default: nil) - The REST ID of the product. Content API methods that operate on products take this as their productId parameter. The REST ID for a product is of the form channel:contentLanguage:targetCountry:offerId.
  • customLabel0 (type: String.t, default: nil) - Custom label 0 for custom grouping of items in a Shopping campaign.
  • ageGroup (type: String.t, default: nil) - Target age group of the item.
  • imageLink (type: String.t, default: nil) - URL of an image of the item.
  • warnings (type: list(GoogleApi.Content.V2.Model.Error.t), default: nil) - Read-only warnings.
  • minEnergyEfficiencyClass (type: String.t, default: nil) - The energy efficiency class as defined in EU directive 2010/30/EU.
  • price (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Price of the item.
  • channel (type: String.t, default: nil) - The item's channel (online or local).
  • minHandlingTime (type: String.t, default: nil) - Minimal product handling time (in business days).
  • customLabel4 (type: String.t, default: nil) - Custom label 4 for custom grouping of items in a Shopping campaign.
  • brand (type: String.t, default: nil) - Brand of the item.
  • salePriceEffectiveDate (type: String.t, default: nil) - Date range during which the item is on sale (see products data specification).
  • expirationDate (type: String.t, default: nil) - Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in productstatuses as googleExpirationDate and might be earlier if expirationDate is too far in the future.
  • condition (type: String.t, default: nil) - Condition or state of the item.
  • material (type: String.t, default: nil) - The material of which the item is made.
  • googleProductCategory (type: String.t, default: nil) - Google's category of the item (see Google product taxonomy).
  • isBundle (type: boolean(), default: nil) - Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.
  • mobileLink (type: String.t, default: nil) - Link to a mobile-optimized version of the landing page.
  • sizeType (type: String.t, default: nil) - The cut of the item. Recommended for apparel items.
  • additionalImageLinks (type: list(String.t), default: nil) - Additional URLs of images of the item.
  • shipping (type: list(GoogleApi.Content.V2.Model.ProductShipping.t), default: nil) - Shipping rules.
  • validatedDestinations (type: list(String.t), default: nil) - Deprecated. The read-only list of intended destinations which passed validation.
  • destinations (type: list(GoogleApi.Content.V2.Model.ProductDestination.t), default: nil) - Specifies the intended destinations for the product.
  • costOfGoodsSold (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Cost of goods sold. Used for gross profit reporting.
  • additionalProductTypes (type: list(String.t), default: nil) - Additional categories of the item (formatted as in products data specification).
  • installment (type: GoogleApi.Content.V2.Model.Installment.t, default: nil) - Number and amount of installments to pay for an item. Brazil only.
  • onlineOnly (type: boolean(), default: nil) - Deprecated. Whether an item is available for purchase only online.
  • multipack (type: String.t, default: nil) - The number of identical products in a merchant-defined multipack.
  • salePrice (type: GoogleApi.Content.V2.Model.Price.t, default: nil) - Advertised sale price of the item.
  • sizeSystem (type: String.t, default: nil) - System in which the size is specified. Recommended for apparel items.
  • shippingLabel (type: String.t, default: nil) - The shipping label of the product, used to group product in account-level shipping rules.
  • displayAdsValue (type: float(), default: nil) - Offer margin for dynamic remarketing campaigns.
  • kind (type: String.t, default: content#product) - Identifies what kind of resource this is. Value: the fixed string "content#product".
  • loyaltyPoints (type: GoogleApi.Content.V2.Model.LoyaltyPoints.t, default: nil) - Loyalty points that users receive after purchasing the item. Japan only.
  • displayAdsLink (type: String.t, default: nil) - URL directly to your item's landing page for dynamic remarketing campaigns.
  • displayAdsId (type: String.t, default: nil) - An identifier for an item for dynamic remarketing campaigns.
  • customGroups (type: list(GoogleApi.Content.V2.Model.CustomGroup.t), default: nil) - A list of custom (merchant-provided) custom attribute groups.
  • gtin (type: String.t, default: nil) - Global Trade Item Number (GTIN) of the item.
  • description (type: String.t, default: nil) - Description of the item.
  • shippingWidth (type: GoogleApi.Content.V2.Model.ProductShippingDimension.t, default: nil) - Width of the item for shipping.
  • displayAdsTitle (type: String.t, default: nil) - Title of an item for dynamic remarketing campaigns.
  • unitPricingMeasure (type: GoogleApi.Content.V2.Model.ProductUnitPricingMeasure.t, default: nil) - The measure and dimension of an item.
  • gender (type: String.t, default: nil) - Target gender of the item.
  • customAttributes (type: list(GoogleApi.Content.V2.Model.CustomAttribute.t), default: nil) - A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (e.g., { "name": "size type", "value": "regular" }). This is useful for submitting attributes not explicitly exposed by the API.
  • taxes (type: list(GoogleApi.Content.V2.Model.ProductTax.t), default: nil) - Tax information.
  • adwordsRedirect (type: String.t, default: nil) - Allows advertisers to override the item URL when the product is shown within the context of Product Ads.
  • shippingHeight (type: GoogleApi.Content.V2.Model.ProductShippingDimension.t, default: nil) - Height of the item for shipping.
  • mpn (type: String.t, default: nil) - Manufacturer Part Number (MPN) of the item.
  • pattern (type: String.t, default: nil) - The item's pattern (e.g. polka dots).
  • customLabel1 (type: String.t, default: nil) - Custom label 1 for custom grouping of items in a Shopping campaign.
  • adwordsGrouping (type: String.t, default: nil) - Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.
  • aspects (type: list(GoogleApi.Content.V2.Model.ProductAspect.t), default: nil) - Deprecated. Do not use.
  • offerId (type: String.t, default: nil) - A unique identifier for the item. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. Only valid unicode characters are accepted. See the products feed specification for details. Note: Content API methods that operate on products take the REST ID of the product, not this identifier.
  • maxHandlingTime (type: String.t, default: nil) - Maximal product handling time (in business days).
  • itemGroupId (type: String.t, default: nil) - Shared identifier for all variants of the same product.
  • color (type: String.t, default: nil) - Color of the item.
  • link (type: String.t, default: nil) - URL directly linking to your item's page on your website.
  • adwordsLabels (type: list(String.t), default: nil) - Similar to adwords_grouping, but only works on CPC.
  • productType (type: String.t, default: nil) - Your category of the item (formatted as in products data specification).
  • unitPricingBaseMeasure (type: GoogleApi.Content.V2.Model.ProductUnitPricingBaseMeasure.t, default: nil) - The preference of the denominator of the unit price.
  • adult (type: boolean(), default: nil) - Set to true if the item is targeted towards adults.
  • identifierExists (type: boolean(), default: nil) - False when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Required according to the Unique Product Identifier Rules for all target countries except for Canada.
  • sizes (type: list(String.t), default: nil) - Size of the item.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

t() View Source
t() :: %GoogleApi.Content.V2.Model.Product{
  shippingWidth: GoogleApi.Content.V2.Model.ProductShippingDimension.t(),
  title: String.t(),
  minEnergyEfficiencyClass: String.t(),
  additionalProductTypes: [String.t()],
  description: String.t(),
  expirationDate: String.t(),
  sizeType: String.t(),
  additionalImageLinks: [String.t()],
  warnings: [GoogleApi.Content.V2.Model.Error.t()],
  productType: String.t(),
  contentLanguage: String.t(),
  unitPricingMeasure: GoogleApi.Content.V2.Model.ProductUnitPricingMeasure.t(),
  shippingWeight: GoogleApi.Content.V2.Model.ProductShippingWeight.t(),
  availability: String.t(),
  adwordsLabels: [String.t()],
  color: String.t(),
  promotionIds: [String.t()],
  source: String.t(),
  displayAdsTitle: String.t(),
  customLabel3: String.t(),
  itemGroupId: String.t(),
  identifierExists: boolean(),
  sizeSystem: String.t(),
  displayAdsLink: String.t(),
  shippingLabel: String.t(),
  displayAdsId: String.t(),
  condition: String.t(),
  shippingHeight: GoogleApi.Content.V2.Model.ProductShippingDimension.t(),
  installment: GoogleApi.Content.V2.Model.Installment.t(),
  imageLink: String.t(),
  loyaltyPoints: GoogleApi.Content.V2.Model.LoyaltyPoints.t(),
  displayAdsSimilarIds: [String.t()],
  customGroups: [GoogleApi.Content.V2.Model.CustomGroup.t()],
  displayAdsValue: float(),
  availabilityDate: String.t(),
  isBundle: boolean(),
  customLabel2: String.t(),
  material: String.t(),
  taxes: [GoogleApi.Content.V2.Model.ProductTax.t()],
  id: String.t(),
  sellOnGoogleQuantity: String.t(),
  energyEfficiencyClass: String.t(),
  pattern: String.t(),
  customLabel1: String.t(),
  mobileLink: String.t(),
  shippingLength: GoogleApi.Content.V2.Model.ProductShippingDimension.t(),
  ageGroup: String.t(),
  salePrice: GoogleApi.Content.V2.Model.Price.t(),
  salePriceEffectiveDate: String.t(),
  mpn: String.t(),
  costOfGoodsSold: GoogleApi.Content.V2.Model.Price.t(),
  adwordsRedirect: String.t(),
  channel: String.t(),
  maxEnergyEfficiencyClass: String.t(),
  adwordsGrouping: String.t(),
  customLabel0: String.t(),
  adult: boolean(),
  unitPricingBaseMeasure:
    GoogleApi.Content.V2.Model.ProductUnitPricingBaseMeasure.t(),
  targetCountry: String.t(),
  customAttributes: [GoogleApi.Content.V2.Model.CustomAttribute.t()],
  aspects: [GoogleApi.Content.V2.Model.ProductAspect.t()],
  onlineOnly: boolean(),
  destinations: [GoogleApi.Content.V2.Model.ProductDestination.t()],
  offerId: String.t(),
  gtin: String.t(),
  gender: String.t(),
  kind: String.t(),
  price: GoogleApi.Content.V2.Model.Price.t(),
  customLabel4: String.t(),
  validatedDestinations: [String.t()],
  minHandlingTime: String.t(),
  multipack: String.t(),
  link: String.t(),
  brand: String.t(),
  maxHandlingTime: String.t(),
  shipping: [GoogleApi.Content.V2.Model.ProductShipping.t()],
  googleProductCategory: String.t(),
  sizes: [String.t()]
}

Link to this section Functions

Link to this function

decode(value, options) View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.