com.google.shopping.merchant.promotions.v1beta.PromotionOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-shopping-merchant-promotions-v1beta Show documentation
Show all versions of proto-google-shopping-merchant-promotions-v1beta Show documentation
Proto library for google-shopping-merchant-promotions
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/shopping/merchant/promotions/v1beta/promotions.proto
// Protobuf Java Version: 3.25.3
package com.google.shopping.merchant.promotions.v1beta;
public interface PromotionOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.shopping.merchant.promotions.v1beta.Promotion)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Identifier. The name of the promotion.
* Format: `accounts/{account}/promotions/{promotion}`
*
*
* string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* Identifier. The name of the promotion.
* Format: `accounts/{account}/promotions/{promotion}`
*
*
* string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Required. The user provided promotion ID to uniquely identify the
* promotion. Follow [minimum
* requirements](https://support.google.com/merchants/answer/7050148?ref_topic=7322920&sjid=871860036916537104-NC#minimum_requirements)
* to prevent promotion disapprovals.
*
*
* string promotion_id = 2 [(.google.api.field_behavior) = REQUIRED];
*
* @return The promotionId.
*/
java.lang.String getPromotionId();
/**
*
*
*
* Required. The user provided promotion ID to uniquely identify the
* promotion. Follow [minimum
* requirements](https://support.google.com/merchants/answer/7050148?ref_topic=7322920&sjid=871860036916537104-NC#minimum_requirements)
* to prevent promotion disapprovals.
*
*
* string promotion_id = 2 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for promotionId.
*/
com.google.protobuf.ByteString getPromotionIdBytes();
/**
*
*
*
* Required. The two-letter [ISO
* 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the
* promotion.
*
* Promotions is only for [selected
* languages](https://support.google.com/merchants/answer/4588281?ref_topic=6396150&sjid=18314938579342094533-NC#option3&zippy=).
*
*
* string content_language = 3 [(.google.api.field_behavior) = REQUIRED];
*
* @return The contentLanguage.
*/
java.lang.String getContentLanguage();
/**
*
*
*
* Required. The two-letter [ISO
* 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the
* promotion.
*
* Promotions is only for [selected
* languages](https://support.google.com/merchants/answer/4588281?ref_topic=6396150&sjid=18314938579342094533-NC#option3&zippy=).
*
*
* string content_language = 3 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for contentLanguage.
*/
com.google.protobuf.ByteString getContentLanguageBytes();
/**
*
*
*
* Required. The target country used as part of the unique identifier.
* Represented as a [CLDR territory
* code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml).
*
* Promotions are only available in selected
* countries, [Free Listings and Shopping
* ads](https://support.google.com/merchants/answer/4588460) [Local Inventory
* ads](https://support.google.com/merchants/answer/10146326)
*
*
* string target_country = 4 [(.google.api.field_behavior) = REQUIRED];
*
* @return The targetCountry.
*/
java.lang.String getTargetCountry();
/**
*
*
*
* Required. The target country used as part of the unique identifier.
* Represented as a [CLDR territory
* code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml).
*
* Promotions are only available in selected
* countries, [Free Listings and Shopping
* ads](https://support.google.com/merchants/answer/4588460) [Local Inventory
* ads](https://support.google.com/merchants/answer/10146326)
*
*
* string target_country = 4 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for targetCountry.
*/
com.google.protobuf.ByteString getTargetCountryBytes();
/**
*
*
*
* Required. [Redemption
* channel](https://support.google.com/merchants/answer/13837674?ref_topic=13773355&sjid=17642868584668136159-NC)
* for the promotion. At least one channel is required.
*
*
*
* repeated .google.shopping.merchant.promotions.v1beta.RedemptionChannel redemption_channel = 5 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return A list containing the redemptionChannel.
*/
java.util.List
getRedemptionChannelList();
/**
*
*
*
* Required. [Redemption
* channel](https://support.google.com/merchants/answer/13837674?ref_topic=13773355&sjid=17642868584668136159-NC)
* for the promotion. At least one channel is required.
*
*
*
* repeated .google.shopping.merchant.promotions.v1beta.RedemptionChannel redemption_channel = 5 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return The count of redemptionChannel.
*/
int getRedemptionChannelCount();
/**
*
*
*
* Required. [Redemption
* channel](https://support.google.com/merchants/answer/13837674?ref_topic=13773355&sjid=17642868584668136159-NC)
* for the promotion. At least one channel is required.
*
*
*
* repeated .google.shopping.merchant.promotions.v1beta.RedemptionChannel redemption_channel = 5 [(.google.api.field_behavior) = REQUIRED];
*
*
* @param index The index of the element to return.
* @return The redemptionChannel at the given index.
*/
com.google.shopping.merchant.promotions.v1beta.RedemptionChannel getRedemptionChannel(int index);
/**
*
*
*
* Required. [Redemption
* channel](https://support.google.com/merchants/answer/13837674?ref_topic=13773355&sjid=17642868584668136159-NC)
* for the promotion. At least one channel is required.
*
*
*
* repeated .google.shopping.merchant.promotions.v1beta.RedemptionChannel redemption_channel = 5 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return A list containing the enum numeric values on the wire for redemptionChannel.
*/
java.util.List getRedemptionChannelValueList();
/**
*
*
*
* Required. [Redemption
* channel](https://support.google.com/merchants/answer/13837674?ref_topic=13773355&sjid=17642868584668136159-NC)
* for the promotion. At least one channel is required.
*
*
*
* repeated .google.shopping.merchant.promotions.v1beta.RedemptionChannel redemption_channel = 5 [(.google.api.field_behavior) = REQUIRED];
*
*
* @param index The index of the value to return.
* @return The enum numeric value on the wire of redemptionChannel at the given index.
*/
int getRedemptionChannelValue(int index);
/**
*
*
*
* Output only. The primary data source of the promotion.
*
*
* string data_source = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The dataSource.
*/
java.lang.String getDataSource();
/**
*
*
*
* Output only. The primary data source of the promotion.
*
*
* string data_source = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for dataSource.
*/
com.google.protobuf.ByteString getDataSourceBytes();
/**
*
*
*
* Optional. A list of promotion attributes.
*
*
*
* .google.shopping.merchant.promotions.v1beta.Attributes attributes = 7 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the attributes field is set.
*/
boolean hasAttributes();
/**
*
*
*
* Optional. A list of promotion attributes.
*
*
*
* .google.shopping.merchant.promotions.v1beta.Attributes attributes = 7 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The attributes.
*/
com.google.shopping.merchant.promotions.v1beta.Attributes getAttributes();
/**
*
*
*
* Optional. A list of promotion attributes.
*
*
*
* .google.shopping.merchant.promotions.v1beta.Attributes attributes = 7 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.shopping.merchant.promotions.v1beta.AttributesOrBuilder getAttributesOrBuilder();
/**
*
*
*
* 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.
*
*
*
* repeated .google.shopping.type.CustomAttribute custom_attributes = 8 [(.google.api.field_behavior) = OPTIONAL];
*
*/
java.util.List getCustomAttributesList();
/**
*
*
*
* 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.
*
*
*
* repeated .google.shopping.type.CustomAttribute custom_attributes = 8 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.shopping.type.CustomAttribute getCustomAttributes(int index);
/**
*
*
*
* 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.
*
*
*
* repeated .google.shopping.type.CustomAttribute custom_attributes = 8 [(.google.api.field_behavior) = OPTIONAL];
*
*/
int getCustomAttributesCount();
/**
*
*
*
* 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.
*
*
*
* repeated .google.shopping.type.CustomAttribute custom_attributes = 8 [(.google.api.field_behavior) = OPTIONAL];
*
*/
java.util.List
getCustomAttributesOrBuilderList();
/**
*
*
*
* 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.
*
*
*
* repeated .google.shopping.type.CustomAttribute custom_attributes = 8 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.shopping.type.CustomAttributeOrBuilder getCustomAttributesOrBuilder(int index);
/**
*
*
*
* Output only. The [status of a
* promotion](https://support.google.com/merchants/answer/3398326?ref_topic=7322924&sjid=5155774230887277618-NC),
* data validation issues, that is, information about a promotion computed
* asynchronously.
*
*
*
* .google.shopping.merchant.promotions.v1beta.PromotionStatus promotion_status = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the promotionStatus field is set.
*/
boolean hasPromotionStatus();
/**
*
*
*
* Output only. The [status of a
* promotion](https://support.google.com/merchants/answer/3398326?ref_topic=7322924&sjid=5155774230887277618-NC),
* data validation issues, that is, information about a promotion computed
* asynchronously.
*
*
*
* .google.shopping.merchant.promotions.v1beta.PromotionStatus promotion_status = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The promotionStatus.
*/
com.google.shopping.merchant.promotions.v1beta.PromotionStatus getPromotionStatus();
/**
*
*
*
* Output only. The [status of a
* promotion](https://support.google.com/merchants/answer/3398326?ref_topic=7322924&sjid=5155774230887277618-NC),
* data validation issues, that is, information about a promotion computed
* asynchronously.
*
*
*
* .google.shopping.merchant.promotions.v1beta.PromotionStatus promotion_status = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.shopping.merchant.promotions.v1beta.PromotionStatusOrBuilder
getPromotionStatusOrBuilder();
/**
*
*
*
* 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.
*
*
* optional int64 version_number = 10 [(.google.api.field_behavior) = OPTIONAL];
*
* @return Whether the versionNumber field is set.
*/
boolean hasVersionNumber();
/**
*
*
*
* 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.
*
*
* optional int64 version_number = 10 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The versionNumber.
*/
long getVersionNumber();
}