Interface AccountServiceOrBuilder (1.0.0)

public interface AccountServiceOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAccountAggregation()

public abstract 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;

Returns
Type Description
AccountAggregation

The accountAggregation.

getAccountAggregationOrBuilder()

public abstract 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;

Returns
Type Description
AccountAggregationOrBuilder

getAccountManagement()

public abstract 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;

Returns
Type Description
AccountManagement

The accountManagement.

getAccountManagementOrBuilder()

public abstract 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;

Returns
Type Description
AccountManagementOrBuilder

getCampaignsManagement()

public abstract 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;

Returns
Type Description
CampaignsManagement

The campaignsManagement.

getCampaignsManagementOrBuilder()

public abstract 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;

Returns
Type Description
CampaignsManagementOrBuilder

getExternalAccountId()

public abstract 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 abstract 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.

getHandshake()

public abstract 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.

getHandshakeOrBuilder()

public abstract 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];

Returns
Type Description
HandshakeOrBuilder

getLocalListingManagement()

public abstract 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;

Returns
Type Description
LocalListingManagement

The localListingManagement.

getLocalListingManagementOrBuilder()

public abstract 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;

Returns
Type Description
LocalListingManagementOrBuilder

getMutability()

public abstract 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];

Returns
Type Description
AccountService.Mutability

The mutability.

getMutabilityValue()

public abstract 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.

getName()

public abstract String getName()

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.

getNameBytes()

public abstract 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.

getProductsManagement()

public abstract 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;

Returns
Type Description
ProductsManagement

The productsManagement.

getProductsManagementOrBuilder()

public abstract 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;

Returns
Type Description
ProductsManagementOrBuilder

getProvider()

public abstract 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.

getProviderBytes()

public abstract 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.

getProviderDisplayName()

public abstract 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 abstract 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.

getServiceTypeCase()

public abstract AccountService.ServiceTypeCase getServiceTypeCase()
Returns
Type Description
AccountService.ServiceTypeCase

hasAccountAggregation()

public abstract 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.

hasAccountManagement()

public abstract 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.

hasCampaignsManagement()

public abstract 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.

hasHandshake()

public abstract 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.

hasLocalListingManagement()

public abstract 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.

hasProductsManagement()

public abstract 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.

hasProvider()

public abstract 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.