public static final class AccountService.Builder extends GeneratedMessageV3.Builder<AccountService.Builder> 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > AccountService.BuilderImplements
AccountServiceOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public AccountService.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
|
build()
public AccountService build()| Returns | |
|---|---|
| Type | Description |
AccountService |
|
buildPartial()
public AccountService buildPartial()| Returns | |
|---|---|
| Type | Description |
AccountService |
|
clear()
public AccountService.Builder clear()| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
|
clearAccountAggregation()
public AccountService.Builder clearAccountAggregation()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 |
AccountService.Builder |
|
clearAccountManagement()
public AccountService.Builder clearAccountManagement()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 |
AccountService.Builder |
|
clearCampaignsManagement()
public AccountService.Builder clearCampaignsManagement()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 |
AccountService.Builder |
|
clearExternalAccountId()
public AccountService.Builder clearExternalAccountId()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 |
AccountService.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public AccountService.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
|
clearHandshake()
public AccountService.Builder clearHandshake()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 |
AccountService.Builder |
|
clearLocalListingManagement()
public AccountService.Builder clearLocalListingManagement()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 |
AccountService.Builder |
|
clearMutability()
public AccountService.Builder clearMutability()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.Builder |
This builder for chaining. |
clearName()
public AccountService.Builder clearName() Identifier. The resource name of the account service.
Format: accounts/{account}/services/{service}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public AccountService.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
|
clearProductsManagement()
public AccountService.Builder clearProductsManagement()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 |
AccountService.Builder |
|
clearProvider()
public AccountService.Builder clearProvider() 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 |
AccountService.Builder |
This builder for chaining. |
clearProviderDisplayName()
public AccountService.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 |
AccountService.Builder |
This builder for chaining. |
clearServiceType()
public AccountService.Builder clearServiceType()| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
|
clone()
public AccountService.Builder clone()| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
|
getAccountAggregation()
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;
| Returns | |
|---|---|
| Type | Description |
AccountAggregation |
The accountAggregation. |
getAccountAggregationBuilder()
public AccountAggregation.Builder getAccountAggregationBuilder()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.Builder |
|
getAccountAggregationOrBuilder()
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;
| Returns | |
|---|---|
| Type | Description |
AccountAggregationOrBuilder |
|
getAccountManagement()
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;
| Returns | |
|---|---|
| Type | Description |
AccountManagement |
The accountManagement. |
getAccountManagementBuilder()
public AccountManagement.Builder getAccountManagementBuilder()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.Builder |
|
getAccountManagementOrBuilder()
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;
| Returns | |
|---|---|
| Type | Description |
AccountManagementOrBuilder |
|
getCampaignsManagement()
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;
| Returns | |
|---|---|
| Type | Description |
CampaignsManagement |
The campaignsManagement. |
getCampaignsManagementBuilder()
public CampaignsManagement.Builder getCampaignsManagementBuilder()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.Builder |
|
getCampaignsManagementOrBuilder()
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;
| Returns | |
|---|---|
| Type | Description |
CampaignsManagementOrBuilder |
|
getDefaultInstanceForType()
public AccountService getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
AccountService |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
getHandshake()
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. |
getHandshakeBuilder()
public Handshake.Builder getHandshakeBuilder()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.Builder |
|
getHandshakeOrBuilder()
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];
| Returns | |
|---|---|
| Type | Description |
HandshakeOrBuilder |
|
getLocalListingManagement()
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;
| Returns | |
|---|---|
| Type | Description |
LocalListingManagement |
The localListingManagement. |
getLocalListingManagementBuilder()
public LocalListingManagement.Builder getLocalListingManagementBuilder()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.Builder |
|
getLocalListingManagementOrBuilder()
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;
| Returns | |
|---|---|
| Type | Description |
LocalListingManagementOrBuilder |
|
getMutability()
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];
| Returns | |
|---|---|
| Type | Description |
AccountService.Mutability |
The mutability. |
getMutabilityValue()
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. |
getName()
public 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 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 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. |
getProductsManagementBuilder()
public ProductsManagement.Builder getProductsManagementBuilder()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.Builder |
|
getProductsManagementOrBuilder()
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;
| Returns | |
|---|---|
| Type | Description |
ProductsManagementOrBuilder |
|
getProvider()
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. |
getProviderBytes()
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. |
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. |
getServiceTypeCase()
public AccountService.ServiceTypeCase getServiceTypeCase()| Returns | |
|---|---|
| Type | Description |
AccountService.ServiceTypeCase |
|
hasAccountAggregation()
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. |
hasAccountManagement()
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. |
hasCampaignsManagement()
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. |
hasHandshake()
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. |
hasLocalListingManagement()
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. |
hasProductsManagement()
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. |
hasProvider()
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeAccountAggregation(AccountAggregation value)
public AccountService.Builder mergeAccountAggregation(AccountAggregation value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
AccountAggregation |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
|
mergeAccountManagement(AccountManagement value)
public AccountService.Builder mergeAccountManagement(AccountManagement value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
AccountManagement |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
|
mergeCampaignsManagement(CampaignsManagement value)
public AccountService.Builder mergeCampaignsManagement(CampaignsManagement value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
CampaignsManagement |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public AccountService.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public AccountService.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
|
mergeFrom(AccountService other)
public AccountService.Builder mergeFrom(AccountService other)| Parameter | |
|---|---|
| Name | Description |
other |
AccountService |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
|
mergeHandshake(Handshake value)
public AccountService.Builder mergeHandshake(Handshake value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Handshake |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
|
mergeLocalListingManagement(LocalListingManagement value)
public AccountService.Builder mergeLocalListingManagement(LocalListingManagement value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
LocalListingManagement |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
|
mergeProductsManagement(ProductsManagement value)
public AccountService.Builder mergeProductsManagement(ProductsManagement value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ProductsManagement |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final AccountService.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
|
setAccountAggregation(AccountAggregation value)
public AccountService.Builder setAccountAggregation(AccountAggregation value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
AccountAggregation |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
|
setAccountAggregation(AccountAggregation.Builder builderForValue)
public AccountService.Builder setAccountAggregation(AccountAggregation.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
AccountAggregation.Builder |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
|
setAccountManagement(AccountManagement value)
public AccountService.Builder setAccountManagement(AccountManagement value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
AccountManagement |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
|
setAccountManagement(AccountManagement.Builder builderForValue)
public AccountService.Builder setAccountManagement(AccountManagement.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
AccountManagement.Builder |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
|
setCampaignsManagement(CampaignsManagement value)
public AccountService.Builder setCampaignsManagement(CampaignsManagement value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
CampaignsManagement |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
|
setCampaignsManagement(CampaignsManagement.Builder builderForValue)
public AccountService.Builder setCampaignsManagement(CampaignsManagement.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
CampaignsManagement.Builder |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
|
setExternalAccountId(String value)
public AccountService.Builder setExternalAccountId(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe externalAccountId to set. |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
This builder for chaining. |
setExternalAccountIdBytes(ByteString value)
public AccountService.Builder setExternalAccountIdBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for externalAccountId to set. |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public AccountService.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
|
setHandshake(Handshake value)
public AccountService.Builder setHandshake(Handshake value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
Handshake |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
|
setHandshake(Handshake.Builder builderForValue)
public AccountService.Builder setHandshake(Handshake.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Handshake.Builder |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
|
setLocalListingManagement(LocalListingManagement value)
public AccountService.Builder setLocalListingManagement(LocalListingManagement value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
LocalListingManagement |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
|
setLocalListingManagement(LocalListingManagement.Builder builderForValue)
public AccountService.Builder setLocalListingManagement(LocalListingManagement.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
LocalListingManagement.Builder |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
|
setMutability(AccountService.Mutability value)
public AccountService.Builder setMutability(AccountService.Mutability value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
AccountService.MutabilityThe mutability to set. |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
This builder for chaining. |
setMutabilityValue(int value)
public AccountService.Builder setMutabilityValue(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for mutability to set. |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
This builder for chaining. |
setName(String value)
public AccountService.Builder setName(String value) Identifier. The resource name of the account service.
Format: accounts/{account}/services/{service}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public AccountService.Builder setNameBytes(ByteString value) Identifier. The resource name of the account service.
Format: accounts/{account}/services/{service}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
This builder for chaining. |
setProductsManagement(ProductsManagement value)
public AccountService.Builder setProductsManagement(ProductsManagement value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ProductsManagement |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
|
setProductsManagement(ProductsManagement.Builder builderForValue)
public AccountService.Builder setProductsManagement(ProductsManagement.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ProductsManagement.Builder |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
|
setProvider(String value)
public AccountService.Builder setProvider(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe provider to set. |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
This builder for chaining. |
setProviderBytes(ByteString value)
public AccountService.Builder setProviderBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for provider to set. |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
This builder for chaining. |
setProviderDisplayName(String value)
public AccountService.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 |
StringThe providerDisplayName to set. |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
This builder for chaining. |
setProviderDisplayNameBytes(ByteString value)
public AccountService.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 |
ByteStringThe bytes for providerDisplayName to set. |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public AccountService.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final AccountService.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
AccountService.Builder |
|