Class MerchantCenterLink (2.33.0)

public final class MerchantCenterLink extends GeneratedMessageV3 implements MerchantCenterLinkOrBuilder

Represents a link between a Merchant Center account and a branch. Once a link is established, products from the linked merchant center account will be streamed to the linked branch.

Protobuf type google.cloud.retail.v2beta.MerchantCenterLink

Static Fields

public static final int BRANCH_ID_FIELD_NUMBER
Field Value
TypeDescription
int
public static final int DESTINATIONS_FIELD_NUMBER
Field Value
TypeDescription
int
public static final int FEEDS_FIELD_NUMBER
Field Value
TypeDescription
int
public static final int LANGUAGE_CODE_FIELD_NUMBER
Field Value
TypeDescription
int
public static final int MERCHANT_CENTER_ACCOUNT_ID_FIELD_NUMBER
Field Value
TypeDescription
int
public static final int REGION_CODE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

public static MerchantCenterLink getDefaultInstance()
Returns
TypeDescription
MerchantCenterLink
public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor
public static MerchantCenterLink.Builder newBuilder()
Returns
TypeDescription
MerchantCenterLink.Builder
public static MerchantCenterLink.Builder newBuilder(MerchantCenterLink prototype)
Parameter
NameDescription
prototypeMerchantCenterLink
Returns
TypeDescription
MerchantCenterLink.Builder
public static MerchantCenterLink parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
MerchantCenterLink
Exceptions
TypeDescription
IOException
public static MerchantCenterLink parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MerchantCenterLink
Exceptions
TypeDescription
IOException
public static MerchantCenterLink parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
MerchantCenterLink
Exceptions
TypeDescription
InvalidProtocolBufferException
public static MerchantCenterLink parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MerchantCenterLink
Exceptions
TypeDescription
InvalidProtocolBufferException
public static MerchantCenterLink parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
MerchantCenterLink
Exceptions
TypeDescription
InvalidProtocolBufferException
public static MerchantCenterLink parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MerchantCenterLink
Exceptions
TypeDescription
InvalidProtocolBufferException
public static MerchantCenterLink parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
MerchantCenterLink
Exceptions
TypeDescription
IOException
public static MerchantCenterLink parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MerchantCenterLink
Exceptions
TypeDescription
IOException
public static MerchantCenterLink parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
MerchantCenterLink
Exceptions
TypeDescription
IOException
public static MerchantCenterLink parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MerchantCenterLink
Exceptions
TypeDescription
IOException
public static MerchantCenterLink parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
MerchantCenterLink
Exceptions
TypeDescription
InvalidProtocolBufferException
public static MerchantCenterLink parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MerchantCenterLink
Exceptions
TypeDescription
InvalidProtocolBufferException
public static Parser<MerchantCenterLink> parser()
Returns
TypeDescription
Parser<MerchantCenterLink>

Methods

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides
public String getBranchId()

The branch ID (e.g. 0/1/2) within this catalog that products from merchant_center_account_id are streamed to. When updating this field, an empty value will use the currently configured default branch. However, changing the default branch later on won't change the linked branch here.

A single branch ID can only have one linked merchant center account ID.

string branch_id = 2;

Returns
TypeDescription
String

The branchId.

public ByteString getBranchIdBytes()

The branch ID (e.g. 0/1/2) within this catalog that products from merchant_center_account_id are streamed to. When updating this field, an empty value will use the currently configured default branch. However, changing the default branch later on won't change the linked branch here.

A single branch ID can only have one linked merchant center account ID.

string branch_id = 2;

Returns
TypeDescription
ByteString

The bytes for branchId.

public MerchantCenterLink getDefaultInstanceForType()
Returns
TypeDescription
MerchantCenterLink
public String getDestinations(int index)

String representing the destination to import for, all if left empty. List of possible values is given in Included destination. List of allowed string values: "Shopping_ads", "Buy_on_google_listings", "Display_ads", "Local_inventory _ads", "Free_listings", "Free_local_listings" NOTE: The string values are case sensitive.

repeated string destinations = 3;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The destinations at the given index.

public ByteString getDestinationsBytes(int index)

String representing the destination to import for, all if left empty. List of possible values is given in Included destination. List of allowed string values: "Shopping_ads", "Buy_on_google_listings", "Display_ads", "Local_inventory _ads", "Free_listings", "Free_local_listings" NOTE: The string values are case sensitive.

repeated string destinations = 3;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the destinations at the given index.

public int getDestinationsCount()

String representing the destination to import for, all if left empty. List of possible values is given in Included destination. List of allowed string values: "Shopping_ads", "Buy_on_google_listings", "Display_ads", "Local_inventory _ads", "Free_listings", "Free_local_listings" NOTE: The string values are case sensitive.

repeated string destinations = 3;

Returns
TypeDescription
int

The count of destinations.

public ProtocolStringList getDestinationsList()

String representing the destination to import for, all if left empty. List of possible values is given in Included destination. List of allowed string values: "Shopping_ads", "Buy_on_google_listings", "Display_ads", "Local_inventory _ads", "Free_listings", "Free_local_listings" NOTE: The string values are case sensitive.

repeated string destinations = 3;

Returns
TypeDescription
ProtocolStringList

A list containing the destinations.

public MerchantCenterFeedFilter getFeeds(int index)

Criteria for the Merchant Center feeds to be ingested via the link. All offers will be ingested if the list is empty. Otherwise the offers will be ingested from selected feeds.

repeated .google.cloud.retail.v2beta.MerchantCenterFeedFilter feeds = 6;

Parameter
NameDescription
indexint
Returns
TypeDescription
MerchantCenterFeedFilter
public int getFeedsCount()

Criteria for the Merchant Center feeds to be ingested via the link. All offers will be ingested if the list is empty. Otherwise the offers will be ingested from selected feeds.

repeated .google.cloud.retail.v2beta.MerchantCenterFeedFilter feeds = 6;

Returns
TypeDescription
int
public List<MerchantCenterFeedFilter> getFeedsList()

Criteria for the Merchant Center feeds to be ingested via the link. All offers will be ingested if the list is empty. Otherwise the offers will be ingested from selected feeds.

repeated .google.cloud.retail.v2beta.MerchantCenterFeedFilter feeds = 6;

Returns
TypeDescription
List<MerchantCenterFeedFilter>
public MerchantCenterFeedFilterOrBuilder getFeedsOrBuilder(int index)

Criteria for the Merchant Center feeds to be ingested via the link. All offers will be ingested if the list is empty. Otherwise the offers will be ingested from selected feeds.

repeated .google.cloud.retail.v2beta.MerchantCenterFeedFilter feeds = 6;

Parameter
NameDescription
indexint
Returns
TypeDescription
MerchantCenterFeedFilterOrBuilder
public List<? extends MerchantCenterFeedFilterOrBuilder> getFeedsOrBuilderList()

Criteria for the Merchant Center feeds to be ingested via the link. All offers will be ingested if the list is empty. Otherwise the offers will be ingested from selected feeds.

repeated .google.cloud.retail.v2beta.MerchantCenterFeedFilter feeds = 6;

Returns
TypeDescription
List<? extends com.google.cloud.retail.v2beta.MerchantCenterFeedFilterOrBuilder>
public String getLanguageCode()

Language of the title/description and other string attributes. Use language tags defined by BCP 47. ISO 639-1.

This specifies the language of offers in Merchant Center that will be accepted. If empty no language filtering will be performed.

Example value: en.

string language_code = 5;

Returns
TypeDescription
String

The languageCode.

public ByteString getLanguageCodeBytes()

Language of the title/description and other string attributes. Use language tags defined by BCP 47. ISO 639-1.

This specifies the language of offers in Merchant Center that will be accepted. If empty no language filtering will be performed.

Example value: en.

string language_code = 5;

Returns
TypeDescription
ByteString

The bytes for languageCode.

public long getMerchantCenterAccountId()

Required. The linked Merchant center account ID. The account must be a standalone account or a sub-account of a MCA.

int64 merchant_center_account_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
long

The merchantCenterAccountId.

public Parser<MerchantCenterLink> getParserForType()
Returns
TypeDescription
Parser<MerchantCenterLink>
Overrides
public String getRegionCode()

Region code of offers to accept. 2-letter Uppercase ISO 3166-1 alpha-2 code. List of values can be found here under the region tag. If left blank no region filtering will be performed.

Example value: US.

string region_code = 4;

Returns
TypeDescription
String

The regionCode.

public ByteString getRegionCodeBytes()

Region code of offers to accept. 2-letter Uppercase ISO 3166-1 alpha-2 code. List of values can be found here under the region tag. If left blank no region filtering will be performed.

Example value: US.

string region_code = 4;

Returns
TypeDescription
ByteString

The bytes for regionCode.

public int getSerializedSize()
Returns
TypeDescription
int
Overrides
public int hashCode()
Returns
TypeDescription
int
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides
public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides
public MerchantCenterLink.Builder newBuilderForType()
Returns
TypeDescription
MerchantCenterLink.Builder
protected MerchantCenterLink.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
MerchantCenterLink.Builder
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides
public MerchantCenterLink.Builder toBuilder()
Returns
TypeDescription
MerchantCenterLink.Builder
public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException