public final class AccountRelationship extends GeneratedMessage 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
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
Static Fields
public static final int ACCOUNT_ID_ALIAS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int PROVIDER_DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int PROVIDER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static AccountRelationship getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static AccountRelationship.Builder newBuilder()
public static AccountRelationship.Builder newBuilder(AccountRelationship prototype)
public static AccountRelationship parseDelimitedFrom(InputStream input)
public static AccountRelationship parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static AccountRelationship parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static AccountRelationship parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AccountRelationship parseFrom(ByteString data)
public static AccountRelationship parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AccountRelationship parseFrom(CodedInputStream input)
public static AccountRelationship parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static AccountRelationship parseFrom(InputStream input)
public static AccountRelationship parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static AccountRelationship parseFrom(ByteBuffer data)
public static AccountRelationship parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<AccountRelationship> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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.
|
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.
|
public AccountRelationship getDefaultInstanceForType()
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.
|
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.
|
public Parser<AccountRelationship> getParserForType()
Overrides
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.
|
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.
|
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.
|
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.
|
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public AccountRelationship.Builder newBuilderForType()
protected AccountRelationship.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
public AccountRelationship.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
