public final class AccountService extends GeneratedMessageV3 implements AccountServiceOrBuilder
The AccountService message represents a specific service that a provider
account offers to a Merchant Center account.
AccountService defines the permissions and capabilities granted to the
provider, allowing for operations such as product management or campaign
management.
The lifecycle of an AccountService involves a proposal phase, where one
party suggests the service, and an approval phase, where the other party
accepts or rejects it. This handshake mechanism ensures mutual consent before
any access is granted. This mechanism safeguards both parties by ensuring
that access rights are granted appropriately and that both the business and
provider are aware of the services enabled. In scenarios where a user is an
admin of both accounts, the approval can happen automatically.
The mutability of a service is also managed through AccountService. Some
services might be immutable, for example, if they were established through
other systems or APIs, and you cannot alter them through this API.
Protobuf type google.shopping.merchant.accounts.v1.AccountService
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int ACCOUNT_AGGREGATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int ACCOUNT_MANAGEMENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int CAMPAIGNS_MANAGEMENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int EXTERNAL_ACCOUNT_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int HANDSHAKE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int LOCAL_LISTING_MANAGEMENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int MUTABILITY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int PRODUCTS_MANAGEMENT_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 AccountService getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static AccountService.Builder newBuilder()
public static AccountService.Builder newBuilder(AccountService prototype)
public static AccountService parseDelimitedFrom(InputStream input)
public static AccountService parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static AccountService parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static AccountService parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AccountService parseFrom(ByteString data)
public static AccountService parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AccountService parseFrom(CodedInputStream input)
public static AccountService parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static AccountService parseFrom(InputStream input)
public static AccountService parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static AccountService parseFrom(ByteBuffer data)
public static AccountService parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<AccountService> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public AccountAggregation getAccountAggregation()
Service type for account aggregation. This enables the provider, which is
an advanced account, to manage multiple sub-accounts (client
accounts). Through this service, the advanced account provider can
perform administrative and operational tasks across all linked
sub-accounts.
This is useful for agencies, aggregators, or large retailers that need
centralized control over many Merchant Center accounts.
.google.shopping.merchant.accounts.v1.AccountAggregation account_aggregation = 103;
public AccountAggregationOrBuilder getAccountAggregationOrBuilder()
Service type for account aggregation. This enables the provider, which is
an advanced account, to manage multiple sub-accounts (client
accounts). Through this service, the advanced account provider can
perform administrative and operational tasks across all linked
sub-accounts.
This is useful for agencies, aggregators, or large retailers that need
centralized control over many Merchant Center accounts.
.google.shopping.merchant.accounts.v1.AccountAggregation account_aggregation = 103;
public AccountManagement getAccountManagement()
Service type for account management. Enables the provider to perform
administrative actions on the business's account, such as
configuring account settings, managing users, or updating business
information.
.google.shopping.merchant.accounts.v1.AccountManagement account_management = 102;
public AccountManagementOrBuilder getAccountManagementOrBuilder()
Service type for account management. Enables the provider to perform
administrative actions on the business's account, such as
configuring account settings, managing users, or updating business
information.
.google.shopping.merchant.accounts.v1.AccountManagement account_management = 102;
public CampaignsManagement getCampaignsManagement()
Service type for managing advertising campaigns. Grants the provider
access to create and manage the business's ad campaigns, including
setting up campaigns, adjusting bids, and optimizing performance.
.google.shopping.merchant.accounts.v1.CampaignsManagement campaigns_management = 101;
public CampaignsManagementOrBuilder getCampaignsManagementOrBuilder()
Service type for managing advertising campaigns. Grants the provider
access to create and manage the business's ad campaigns, including
setting up campaigns, adjusting bids, and optimizing performance.
.google.shopping.merchant.accounts.v1.CampaignsManagement campaigns_management = 101;
public AccountService getDefaultInstanceForType()
getExternalAccountId()
public String getExternalAccountId()
Immutable. An optional, immutable identifier that Google uses to refer to
this account when communicating with the provider. This should be the
unique account ID within the provider's system (for example, your shop ID
in Shopify).
If you have multiple accounts with the same provider - for instance,
different accounts for various regions — the external_account_id
differentiates between them, ensuring accurate linking and integration
between Google and the provider.
string external_account_id = 6 [(.google.api.field_behavior) = IMMUTABLE];
| Returns |
| Type |
Description |
String |
The externalAccountId.
|
getExternalAccountIdBytes()
public ByteString getExternalAccountIdBytes()
Immutable. An optional, immutable identifier that Google uses to refer to
this account when communicating with the provider. This should be the
unique account ID within the provider's system (for example, your shop ID
in Shopify).
If you have multiple accounts with the same provider - for instance,
different accounts for various regions — the external_account_id
differentiates between them, ensuring accurate linking and integration
between Google and the provider.
string external_account_id = 6 [(.google.api.field_behavior) = IMMUTABLE];
| Returns |
| Type |
Description |
ByteString |
The bytes for externalAccountId.
|
public Handshake getHandshake()
Output only. Information about the state of the service in terms of
establishing it (e.g. is it pending approval or approved).
.google.shopping.merchant.accounts.v1.Handshake handshake = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Handshake |
The handshake.
|
public HandshakeOrBuilder getHandshakeOrBuilder()
Output only. Information about the state of the service in terms of
establishing it (e.g. is it pending approval or approved).
.google.shopping.merchant.accounts.v1.Handshake handshake = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
public LocalListingManagement getLocalListingManagement()
Service type for local listings management. The business group associated
with the external account id will be used to provide local inventory to
this Merchant Center account.
.google.shopping.merchant.accounts.v1.LocalListingManagement local_listing_management = 104;
public LocalListingManagementOrBuilder getLocalListingManagementOrBuilder()
Service type for local listings management. The business group associated
with the external account id will be used to provide local inventory to
this Merchant Center account.
.google.shopping.merchant.accounts.v1.LocalListingManagement local_listing_management = 104;
public AccountService.Mutability getMutability()
Output only. Whether the service is mutable (e.g. through Approve / Reject
RPCs). A service that was created through another system or API might be
immutable.
.google.shopping.merchant.accounts.v1.AccountService.Mutability mutability = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
public int getMutabilityValue()
Output only. Whether the service is mutable (e.g. through Approve / Reject
RPCs). A service that was created through another system or API might be
immutable.
.google.shopping.merchant.accounts.v1.AccountService.Mutability mutability = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for mutability.
|
Identifier. The resource name of the account service.
Format: accounts/{account}/services/{service}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns |
| Type |
Description |
String |
The name.
|
public ByteString getNameBytes()
Identifier. The resource name of the account service.
Format: accounts/{account}/services/{service}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
public Parser<AccountService> getParserForType()
Overrides
public ProductsManagement getProductsManagement()
Service type for managing products. This allows the provider to handle
product data on behalf of the business, including reading and writing
product listings. It's commonly used when the provider offers inventory
management or catalog synchronization services to keep the business's
product information up-to-date across platforms.
.google.shopping.merchant.accounts.v1.ProductsManagement products_management = 100;
public ProductsManagementOrBuilder getProductsManagementOrBuilder()
Service type for managing products. This allows the provider to handle
product data on behalf of the business, including reading and writing
product listings. It's commonly used when the provider offers inventory
management or catalog synchronization services to keep the business's
product information up-to-date across platforms.
.google.shopping.merchant.accounts.v1.ProductsManagement products_management = 100;
public String getProvider()
Output only. 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) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
String |
The provider.
|
public ByteString getProviderBytes()
Output only. 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) = OUTPUT_ONLY];
| 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 AccountService.ServiceTypeCase getServiceTypeCase()
public boolean hasAccountAggregation()
Service type for account aggregation. This enables the provider, which is
an advanced account, to manage multiple sub-accounts (client
accounts). Through this service, the advanced account provider can
perform administrative and operational tasks across all linked
sub-accounts.
This is useful for agencies, aggregators, or large retailers that need
centralized control over many Merchant Center accounts.
.google.shopping.merchant.accounts.v1.AccountAggregation account_aggregation = 103;
| Returns |
| Type |
Description |
boolean |
Whether the accountAggregation field is set.
|
public boolean hasAccountManagement()
Service type for account management. Enables the provider to perform
administrative actions on the business's account, such as
configuring account settings, managing users, or updating business
information.
.google.shopping.merchant.accounts.v1.AccountManagement account_management = 102;
| Returns |
| Type |
Description |
boolean |
Whether the accountManagement field is set.
|
public boolean hasCampaignsManagement()
Service type for managing advertising campaigns. Grants the provider
access to create and manage the business's ad campaigns, including
setting up campaigns, adjusting bids, and optimizing performance.
.google.shopping.merchant.accounts.v1.CampaignsManagement campaigns_management = 101;
| Returns |
| Type |
Description |
boolean |
Whether the campaignsManagement field is set.
|
public boolean hasHandshake()
Output only. Information about the state of the service in terms of
establishing it (e.g. is it pending approval or approved).
.google.shopping.merchant.accounts.v1.Handshake handshake = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the handshake field is set.
|
public boolean hasLocalListingManagement()
Service type for local listings management. The business group associated
with the external account id will be used to provide local inventory to
this Merchant Center account.
.google.shopping.merchant.accounts.v1.LocalListingManagement local_listing_management = 104;
| Returns |
| Type |
Description |
boolean |
Whether the localListingManagement field is set.
|
public boolean hasProductsManagement()
Service type for managing products. This allows the provider to handle
product data on behalf of the business, including reading and writing
product listings. It's commonly used when the provider offers inventory
management or catalog synchronization services to keep the business's
product information up-to-date across platforms.
.google.shopping.merchant.accounts.v1.ProductsManagement products_management = 100;
| Returns |
| Type |
Description |
boolean |
Whether the productsManagement field is set.
|
public boolean hasProvider()
Output only. 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) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the provider field is set.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public AccountService.Builder newBuilderForType()
protected AccountService.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public AccountService.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
