com.google.shopping.merchant.accounts.v1beta.package-info Maven / Gradle / Ivy
Show all versions of google-shopping-merchant-accounts Show documentation
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* A client to Merchant API
*
* The interfaces provided are listed below, along with usage samples.
*
*
======================= AccountTaxServiceClient =======================
*
*
Service Description: Manages account level tax setting data.
*
*
This API defines the following resource model:
*
*
- [AccountTax][google.shopping.merchant.accounts.v1main.AccountTax]
*
*
Sample for AccountTaxServiceClient:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (AccountTaxServiceClient accountTaxServiceClient = AccountTaxServiceClient.create()) {
* AccountTaxName name = AccountTaxName.of("[ACCOUNT]", "[TAX]");
* AccountTax response = accountTaxServiceClient.getAccountTax(name);
* }
* }
*
* ======================= AccountIssueServiceClient =======================
*
*
Service Description: Service to support `AccountIssueService` API.
*
*
Sample for AccountIssueServiceClient:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (AccountIssueServiceClient accountIssueServiceClient = AccountIssueServiceClient.create()) {
* AccountName parent = AccountName.of("[ACCOUNT]");
* for (AccountIssue element :
* accountIssueServiceClient.listAccountIssues(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* ======================= AccountsServiceClient =======================
*
*
Service Description: Service to support Accounts API.
*
*
Sample for AccountsServiceClient:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (AccountsServiceClient accountsServiceClient = AccountsServiceClient.create()) {
* AccountName name = AccountName.of("[ACCOUNT]");
* Account response = accountsServiceClient.getAccount(name);
* }
* }
*
* ======================= AutofeedSettingsServiceClient =======================
*
*
Service Description: Service to support
* [autofeed](https://support.google.com/merchants/answer/7538732) setting.
*
*
Sample for AutofeedSettingsServiceClient:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (AutofeedSettingsServiceClient autofeedSettingsServiceClient =
* AutofeedSettingsServiceClient.create()) {
* AutofeedSettingsName name = AutofeedSettingsName.of("[ACCOUNT]");
* AutofeedSettings response = autofeedSettingsServiceClient.getAutofeedSettings(name);
* }
* }
*
* ======================= BusinessIdentityServiceClient =======================
*
*
Service Description: Service to support [business
* identity](https://support.google.com/merchants/answer/12564247) API.
*
*
Sample for BusinessIdentityServiceClient:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (BusinessIdentityServiceClient businessIdentityServiceClient =
* BusinessIdentityServiceClient.create()) {
* BusinessIdentityName name = BusinessIdentityName.of("[ACCOUNT]");
* BusinessIdentity response = businessIdentityServiceClient.getBusinessIdentity(name);
* }
* }
*
* ======================= BusinessInfoServiceClient =======================
*
*
Service Description: Service to support business info API.
*
*
Sample for BusinessInfoServiceClient:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (BusinessInfoServiceClient businessInfoServiceClient = BusinessInfoServiceClient.create()) {
* BusinessInfoName name = BusinessInfoName.of("[ACCOUNT]");
* BusinessInfo response = businessInfoServiceClient.getBusinessInfo(name);
* }
* }
*
* ======================= EmailPreferencesServiceClient =======================
*
*
Service Description: Service to support the `EmailPreferences` API.
*
*
This service only permits retrieving and updating email preferences for the authenticated
* user.
*
*
Sample for EmailPreferencesServiceClient:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (EmailPreferencesServiceClient emailPreferencesServiceClient =
* EmailPreferencesServiceClient.create()) {
* EmailPreferencesName name = EmailPreferencesName.of("[ACCOUNT]", "[EMAIL]");
* EmailPreferences response = emailPreferencesServiceClient.getEmailPreferences(name);
* }
* }
*
* ======================= HomepageServiceClient =======================
*
*
Service Description: Service to support an API for a store's homepage.
*
*
Sample for HomepageServiceClient:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (HomepageServiceClient homepageServiceClient = HomepageServiceClient.create()) {
* HomepageName name = HomepageName.of("[ACCOUNT]");
* Homepage response = homepageServiceClient.getHomepage(name);
* }
* }
*
* ======================= OnlineReturnPolicyServiceClient =======================
*
*
Service Description: The service facilitates the management of a merchant's remorse return
* policy configuration, encompassing return policies for both ads and free listings ## programs.
* This API defines the following resource model:
*
*
[OnlineReturnPolicy][google.shopping.merchant.accounts.v1.OnlineReturnPolicy]
*
*
Sample for OnlineReturnPolicyServiceClient:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (OnlineReturnPolicyServiceClient onlineReturnPolicyServiceClient =
* OnlineReturnPolicyServiceClient.create()) {
* OnlineReturnPolicyName name = OnlineReturnPolicyName.of("[ACCOUNT]", "[RETURN_POLICY]");
* OnlineReturnPolicy response = onlineReturnPolicyServiceClient.getOnlineReturnPolicy(name);
* }
* }
*
* ======================= ProgramsServiceClient =======================
*
*
Service Description: Service for program management.
*
*
Programs provide a mechanism for adding functionality to merchant accounts. A typical example
* of this is the [Free product
* listings](https://support.google.com/merchants/topic/9240261?ref_topic=7257954,7259405,&sjid=796648681813264022-EU)
* program, which enables products from a merchant's store to be shown across Google for free.
*
*
This service exposes methods to retrieve a merchant's participation in all available programs,
* in addition to methods for explicitly enabling or disabling participation in each program.
*
*
Sample for ProgramsServiceClient:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (ProgramsServiceClient programsServiceClient = ProgramsServiceClient.create()) {
* ProgramName name = ProgramName.of("[ACCOUNT]", "[PROGRAM]");
* Program response = programsServiceClient.getProgram(name);
* }
* }
*
* ======================= RegionsServiceClient =======================
*
*
Service Description: Manages regions configuration.
*
*
This API defines the following resource model:
*
*
- [Region][google.shopping.merchant.accounts.v1main.Region]
*
*
Sample for RegionsServiceClient:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (RegionsServiceClient regionsServiceClient = RegionsServiceClient.create()) {
* RegionName name = RegionName.of("[ACCOUNT]", "[REGION]");
* Region response = regionsServiceClient.getRegion(name);
* }
* }
*
* ======================= ShippingSettingsServiceClient =======================
*
*
Service Description: Service to get method call shipping setting information per Merchant API
* method.
*
*
Sample for ShippingSettingsServiceClient:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (ShippingSettingsServiceClient shippingSettingsServiceClient =
* ShippingSettingsServiceClient.create()) {
* ShippingSettingsName name = ShippingSettingsName.of("[ACCOUNT]");
* ShippingSettings response = shippingSettingsServiceClient.getShippingSettings(name);
* }
* }
*
* ======================= TermsOfServiceServiceClient =======================
*
*
Service Description: Service to support `TermsOfService` API.
*
*
Sample for TermsOfServiceServiceClient:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (TermsOfServiceServiceClient termsOfServiceServiceClient =
* TermsOfServiceServiceClient.create()) {
* TermsOfServiceName name = TermsOfServiceName.of("[VERSION]");
* TermsOfService response = termsOfServiceServiceClient.getTermsOfService(name);
* }
* }
*
* ======================= TermsOfServiceAgreementStateServiceClient =======================
*
*
Service Description: Service to support `TermsOfServiceAgreementState` API.
*
*
Sample for TermsOfServiceAgreementStateServiceClient:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (TermsOfServiceAgreementStateServiceClient termsOfServiceAgreementStateServiceClient =
* TermsOfServiceAgreementStateServiceClient.create()) {
* TermsOfServiceAgreementStateName name =
* TermsOfServiceAgreementStateName.of("[ACCOUNT]", "[IDENTIFIER]");
* TermsOfServiceAgreementState response =
* termsOfServiceAgreementStateServiceClient.getTermsOfServiceAgreementState(name);
* }
* }
*
* ======================= UserServiceClient =======================
*
*
Service Description: Service to support user API.
*
*
Sample for UserServiceClient:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (UserServiceClient userServiceClient = UserServiceClient.create()) {
* UserName name = UserName.of("[ACCOUNT]", "[EMAIL]");
* User response = userServiceClient.getUser(name);
* }
* }
*/
@Generated("by gapic-generator-java")
package com.google.shopping.merchant.accounts.v1beta;
import javax.annotation.Generated;