Show / Hide Table of Contents

Class Promotion

Represents a promotion. See the following articles for more details. Required promotion input attributes to pass data validation checks are primarily defined below: * Promotions data specification * Local promotions data specification After inserting, updating a promotion input, it may take several minutes before the final promotion can be retrieved.

Inheritance
object
Promotion
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Merchant.promotions_v1beta.Data
Assembly: Google.Apis.Merchant.promotions_v1beta.dll
Syntax
public class Promotion : IDirectResponseSchema

Properties

Attributes

Optional. A list of promotion attributes.

Declaration
[JsonProperty("attributes")]
public virtual Attributes Attributes { get; set; }
Property Value
Type Description
Attributes

ContentLanguage

Required. The two-letter ISO 639-1 language code for the promotion. Promotions is only for selected languages.

Declaration
[JsonProperty("contentLanguage")]
public virtual string ContentLanguage { get; set; }
Property Value
Type Description
string

CustomAttributes

Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, { "name": "size type", "value": "regular" }). This is useful for submitting attributes not explicitly exposed by the API.

Declaration
[JsonProperty("customAttributes")]
public virtual IList<CustomAttribute> CustomAttributes { get; set; }
Property Value
Type Description
IList<CustomAttribute>

DataSource

Output only. The primary data source of the promotion.

Declaration
[JsonProperty("dataSource")]
public virtual string DataSource { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Name

Identifier. The name of the promotion. Format: accounts/{account}/promotions/{promotion}

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

PromotionId

Required. The user provided promotion ID to uniquely identify the promotion. Follow minimum requirements to prevent promotion disapprovals.

Declaration
[JsonProperty("promotionId")]
public virtual string PromotionId { get; set; }
Property Value
Type Description
string

PromotionStatus

Output only. The status of a promotion, data validation issues, that is, information about a promotion computed asynchronously.

Declaration
[JsonProperty("promotionStatus")]
public virtual PromotionStatus PromotionStatus { get; set; }
Property Value
Type Description
PromotionStatus

RedemptionChannel

Required. Redemption channel for the promotion. At least one channel is required.

Declaration
[JsonProperty("redemptionChannel")]
public virtual IList<string> RedemptionChannel { get; set; }
Property Value
Type Description
IList<string>

TargetCountry

Required. The target country used as part of the unique identifier. Represented as a CLDR territory code. Promotions are only available in selected countries, Free Listings and Shopping ads Local Inventory ads

Declaration
[JsonProperty("targetCountry")]
public virtual string TargetCountry { get; set; }
Property Value
Type Description
string

VersionNumber

Optional. Represents the existing version (freshness) of the promotion, which can be used to preserve the right order when multiple updates are done at the same time. If set, the insertion is prevented when version number is lower than the current version number of the existing promotion. Re-insertion (for example, promotion refresh after 30 days) can be performed with the current version_number. If the operation is prevented, the aborted exception will be thrown.

Declaration
[JsonProperty("versionNumber")]
public virtual long? VersionNumber { get; set; }
Property Value
Type Description
long?

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX