Class AccountRelationship.Builder (1.11.0)

Version latest

• 1.11.0 (latest)
• 1.10.0
• 1.8.0
• 1.6.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.26.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public static final class AccountRelationship.Builder extends GeneratedMessage.Builder<AccountRelationship.Builder> implements AccountRelationshipOrBuilder

The AccountRelationship message defines a formal connection between a merchant's account and a service provider's account. This relationship enables the provider to offer specific services to the business, such as product management or campaign management. It specifies the access rights and permissions to the business's data relevant to those services.

Establishing an account relationship involves linking the merchant's account with a provider's account. The provider could be another Google account (like Google Ads or Google My Business) or a third-party platform (such as Shopify or WooCommerce).

Protobuf type google.shopping.merchant.accounts.v1.AccountRelationship

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > AccountRelationship.Builder

Implements

AccountRelationshipOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

build()

public AccountRelationship build()

Returns
Type	Description
AccountRelationship

buildPartial()

public AccountRelationship buildPartial()

Returns
Type	Description
AccountRelationship

clear()

public AccountRelationship.Builder clear()

Returns
Type	Description
AccountRelationship.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearAccountIdAlias()

public AccountRelationship.Builder clearAccountIdAlias()

Optional. An optional alias you can assign to this account relationship. This alias acts as a convenient identifier for your own reference and management. It must be unique among all your account relationships with the same provider.

For example, you might use account_id_alias to assign a friendly name to this relationship for easier identification in your systems.

string account_id_alias = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AccountRelationship.Builder	This builder for chaining.

clearName()

public AccountRelationship.Builder clearName()

Identifier. The resource name of the account relationship. Format: accounts/{account}/relationships/{relationship}. For example, accounts/123456/relationships/567890.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
AccountRelationship.Builder	This builder for chaining.

clearProvider()

public AccountRelationship.Builder clearProvider()

Immutable. The provider of the service. Either the reference to an account such as providers/123 or a well-known service provider (one of providers/GOOGLE_ADS or providers/GOOGLE_BUSINESS_PROFILE).

optional string provider = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
AccountRelationship.Builder	This builder for chaining.

clearProviderDisplayName()

public AccountRelationship.Builder clearProviderDisplayName()

Output only. The human-readable display name of the provider account.

string provider_display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
AccountRelationship.Builder	This builder for chaining.

getAccountIdAlias()

public String getAccountIdAlias()

Optional. An optional alias you can assign to this account relationship. This alias acts as a convenient identifier for your own reference and management. It must be unique among all your account relationships with the same provider.

For example, you might use account_id_alias to assign a friendly name to this relationship for easier identification in your systems.

string account_id_alias = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The accountIdAlias.

getAccountIdAliasBytes()

public ByteString getAccountIdAliasBytes()

Optional. An optional alias you can assign to this account relationship. This alias acts as a convenient identifier for your own reference and management. It must be unique among all your account relationships with the same provider.

For example, you might use account_id_alias to assign a friendly name to this relationship for easier identification in your systems.

string account_id_alias = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for accountIdAlias.

getDefaultInstanceForType()

public AccountRelationship getDefaultInstanceForType()

Returns
Type	Description
AccountRelationship

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getName()

public String getName()

Identifier. The resource name of the account relationship. Format: accounts/{account}/relationships/{relationship}. For example, accounts/123456/relationships/567890.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name of the account relationship. Format: accounts/{account}/relationships/{relationship}. For example, accounts/123456/relationships/567890.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
ByteString	The bytes for name.

getProvider()

public String getProvider()

Immutable. The provider of the service. Either the reference to an account such as providers/123 or a well-known service provider (one of providers/GOOGLE_ADS or providers/GOOGLE_BUSINESS_PROFILE).

optional string provider = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
String	The provider.

getProviderBytes()

public ByteString getProviderBytes()

Immutable. The provider of the service. Either the reference to an account such as providers/123 or a well-known service provider (one of providers/GOOGLE_ADS or providers/GOOGLE_BUSINESS_PROFILE).

optional string provider = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
ByteString	The bytes for provider.

getProviderDisplayName()

public String getProviderDisplayName()

Output only. The human-readable display name of the provider account.

string provider_display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The providerDisplayName.

getProviderDisplayNameBytes()

public ByteString getProviderDisplayNameBytes()

Output only. The human-readable display name of the provider account.

string provider_display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for providerDisplayName.

hasProvider()

public boolean hasProvider()

Immutable. The provider of the service. Either the reference to an account such as providers/123 or a well-known service provider (one of providers/GOOGLE_ADS or providers/GOOGLE_BUSINESS_PROFILE).

optional string provider = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
boolean	Whether the provider field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AccountRelationship.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AccountRelationship.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public AccountRelationship.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
AccountRelationship.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeFrom(AccountRelationship other)

public AccountRelationship.Builder mergeFrom(AccountRelationship other)

Parameter
Name	Description
other	AccountRelationship

Returns
Type	Description
AccountRelationship.Builder

setAccountIdAlias(String value)

public AccountRelationship.Builder setAccountIdAlias(String value)

Optional. An optional alias you can assign to this account relationship. This alias acts as a convenient identifier for your own reference and management. It must be unique among all your account relationships with the same provider.

For example, you might use account_id_alias to assign a friendly name to this relationship for easier identification in your systems.

string account_id_alias = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The accountIdAlias to set.

Returns
Type	Description
AccountRelationship.Builder	This builder for chaining.

setAccountIdAliasBytes(ByteString value)

public AccountRelationship.Builder setAccountIdAliasBytes(ByteString value)

Optional. An optional alias you can assign to this account relationship. This alias acts as a convenient identifier for your own reference and management. It must be unique among all your account relationships with the same provider.

For example, you might use account_id_alias to assign a friendly name to this relationship for easier identification in your systems.

string account_id_alias = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ByteString The bytes for accountIdAlias to set.

Returns
Type	Description
AccountRelationship.Builder	This builder for chaining.

setName(String value)

public AccountRelationship.Builder setName(String value)

Identifier. The resource name of the account relationship. Format: accounts/{account}/relationships/{relationship}. For example, accounts/123456/relationships/567890.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name	Description
value	String The name to set.

Returns
Type	Description
AccountRelationship.Builder	This builder for chaining.

setNameBytes(ByteString value)

public AccountRelationship.Builder setNameBytes(ByteString value)

Identifier. The resource name of the account relationship. Format: accounts/{account}/relationships/{relationship}. For example, accounts/123456/relationships/567890.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name	Description
value	ByteString The bytes for name to set.

Returns
Type	Description
AccountRelationship.Builder	This builder for chaining.

setProvider(String value)

public AccountRelationship.Builder setProvider(String value)

Immutable. The provider of the service. Either the reference to an account such as providers/123 or a well-known service provider (one of providers/GOOGLE_ADS or providers/GOOGLE_BUSINESS_PROFILE).

optional string provider = 2 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name	Description
value	String The provider to set.

Returns
Type	Description
AccountRelationship.Builder	This builder for chaining.

setProviderBytes(ByteString value)

public AccountRelationship.Builder setProviderBytes(ByteString value)

Immutable. The provider of the service. Either the reference to an account such as providers/123 or a well-known service provider (one of providers/GOOGLE_ADS or providers/GOOGLE_BUSINESS_PROFILE).

optional string provider = 2 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name	Description
value	ByteString The bytes for provider to set.

Returns
Type	Description
AccountRelationship.Builder	This builder for chaining.

setProviderDisplayName(String value)

public AccountRelationship.Builder setProviderDisplayName(String value)

Output only. The human-readable display name of the provider account.

string provider_display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	String The providerDisplayName to set.

Returns
Type	Description
AccountRelationship.Builder	This builder for chaining.

setProviderDisplayNameBytes(ByteString value)

public AccountRelationship.Builder setProviderDisplayNameBytes(ByteString value)

Output only. The human-readable display name of the provider account.

string provider_display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	ByteString The bytes for providerDisplayName to set.

Returns
Type	Description
AccountRelationship.Builder	This builder for chaining.