Class v1.AccountServicesServiceClient (3.2.0)

3.2.0 (latest) 2.2.0 1.0.0

Service to support AccountService API. v1

Package

@google-shopping/accounts

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Construct an instance of AccountServicesServiceClient.

Parameters
Name	Description
opts	ClientOptions
gaxInstance	typeof gax | typeof fallback : loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new AccountServicesServiceClient({fallback: true}, gax); ```

Properties

accountServicesServiceStub

accountServicesServiceStub?: Promise<{
        [name: string]: Function;
    }>;

apiEndpoint

get apiEndpoint(): string;

The DNS address for this API service.

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath.

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

static get servicePath(): string;

The DNS address for this API service.

universeDomain

get universeDomain(): string;

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

accountIssuePath(account, issue)

accountIssuePath(account: string, issue: string): string;

Return a fully-qualified accountIssue resource name string.

Parameters
Name	Description
account	string
issue	string

Returns
Type	Description
string	{string} Resource name string.

accountPath(account)

accountPath(account: string): string;

Return a fully-qualified account resource name string.

Parameter
Name	Description
account	string

Returns
Type	Description
string	{string} Resource name string.

accountRelationshipPath(account, relationship)

accountRelationshipPath(account: string, relationship: string): string;

Return a fully-qualified accountRelationship resource name string.

Parameters
Name	Description
account	string
relationship	string

Returns
Type	Description
string	{string} Resource name string.

accountServicePath(account, service)

accountServicePath(account: string, service: string): string;

Return a fully-qualified accountService resource name string.

Parameters
Name	Description
account	string
service	string

Returns
Type	Description
string	{string} Resource name string.

approveAccountService(request, options)

approveAccountService(request?: protos.google.shopping.merchant.accounts.v1.IApproveAccountServiceRequest, options?: CallOptions): Promise<[
        protos.google.shopping.merchant.accounts.v1.IAccountService,
        protos.google.shopping.merchant.accounts.v1.IApproveAccountServiceRequest | undefined,
        {} | undefined
    ]>;

Approve an account service proposal.

Parameters
Name	Description
request	IApproveAccountServiceRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.shopping.merchant.accounts.v1.IAccountService, protos.google.shopping.merchant.accounts.v1.IApproveAccountServiceRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the account service to approve.
   *  Format: `accounts/{account}/services/{service}`
   */
  // const name = 'abc123'

  // Imports the Accounts library
  const {AccountServicesServiceClient} = require('@google-shopping/accounts').v1;

  // Instantiates a client
  const accountsClient = new AccountServicesServiceClient();

  async function callApproveAccountService() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await accountsClient.approveAccountService(request);
    console.log(response);
  }

  callApproveAccountService();

approveAccountService(request, options, callback)

approveAccountService(request: protos.google.shopping.merchant.accounts.v1.IApproveAccountServiceRequest, options: CallOptions, callback: Callback<protos.google.shopping.merchant.accounts.v1.IAccountService, protos.google.shopping.merchant.accounts.v1.IApproveAccountServiceRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IApproveAccountServiceRequest
options	CallOptions
callback	Callback<protos.google.shopping.merchant.accounts.v1.IAccountService, protos.google.shopping.merchant.accounts.v1.IApproveAccountServiceRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

approveAccountService(request, callback)

approveAccountService(request: protos.google.shopping.merchant.accounts.v1.IApproveAccountServiceRequest, callback: Callback<protos.google.shopping.merchant.accounts.v1.IAccountService, protos.google.shopping.merchant.accounts.v1.IApproveAccountServiceRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IApproveAccountServiceRequest
callback	Callback<protos.google.shopping.merchant.accounts.v1.IAccountService, protos.google.shopping.merchant.accounts.v1.IApproveAccountServiceRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

autofeedSettingsPath(account)

autofeedSettingsPath(account: string): string;

Return a fully-qualified autofeedSettings resource name string.

Parameter
Name	Description
account	string

Returns
Type	Description
string	{string} Resource name string.

automaticImprovementsPath(account)

automaticImprovementsPath(account: string): string;

Return a fully-qualified automaticImprovements resource name string.

Parameter
Name	Description
account	string

Returns
Type	Description
string	{string} Resource name string.

businessIdentityPath(account)

businessIdentityPath(account: string): string;

Return a fully-qualified businessIdentity resource name string.

Parameter
Name	Description
account	string

Returns
Type	Description
string	{string} Resource name string.

businessInfoPath(account)

businessInfoPath(account: string): string;

Return a fully-qualified businessInfo resource name string.

Parameter
Name	Description
account	string

Returns
Type	Description
string	{string} Resource name string.

checkoutSettingsPath(account, program)

checkoutSettingsPath(account: string, program: string): string;

Return a fully-qualified checkoutSettings resource name string.

Parameters
Name	Description
account	string
program	string

Returns
Type	Description
string	{string} Resource name string.

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
Type	Description
Promise<void>	{Promise} A promise that resolves when the client is closed.

developerRegistrationPath(account)

developerRegistrationPath(account: string): string;

Return a fully-qualified developerRegistration resource name string.

Parameter
Name	Description
account	string

Returns
Type	Description
string	{string} Resource name string.

emailPreferencesPath(account, email)

emailPreferencesPath(account: string, email: string): string;

Return a fully-qualified emailPreferences resource name string.

Parameters
Name	Description
account	string
email	string

Returns
Type	Description
string	{string} Resource name string.

gbpAccountPath(account, gbpAccount)

gbpAccountPath(account: string, gbpAccount: string): string;

Return a fully-qualified gbpAccount resource name string.

Parameters
Name	Description
account	string
gbpAccount	string

Returns
Type	Description
string	{string} Resource name string.

getAccountService(request, options)

getAccountService(request?: protos.google.shopping.merchant.accounts.v1.IGetAccountServiceRequest, options?: CallOptions): Promise<[
        protos.google.shopping.merchant.accounts.v1.IAccountService,
        protos.google.shopping.merchant.accounts.v1.IGetAccountServiceRequest | undefined,
        {} | undefined
    ]>;

Retrieve an account service.

Parameters
Name	Description
request	IGetAccountServiceRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.shopping.merchant.accounts.v1.IAccountService, protos.google.shopping.merchant.accounts.v1.IGetAccountServiceRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the account service to get.
   *  Format: `accounts/{account}/services/{service}`
   */
  // const name = 'abc123'

  // Imports the Accounts library
  const {AccountServicesServiceClient} = require('@google-shopping/accounts').v1;

  // Instantiates a client
  const accountsClient = new AccountServicesServiceClient();

  async function callGetAccountService() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await accountsClient.getAccountService(request);
    console.log(response);
  }

  callGetAccountService();

getAccountService(request, options, callback)

getAccountService(request: protos.google.shopping.merchant.accounts.v1.IGetAccountServiceRequest, options: CallOptions, callback: Callback<protos.google.shopping.merchant.accounts.v1.IAccountService, protos.google.shopping.merchant.accounts.v1.IGetAccountServiceRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetAccountServiceRequest
options	CallOptions
callback	Callback<protos.google.shopping.merchant.accounts.v1.IAccountService, protos.google.shopping.merchant.accounts.v1.IGetAccountServiceRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getAccountService(request, callback)

getAccountService(request: protos.google.shopping.merchant.accounts.v1.IGetAccountServiceRequest, callback: Callback<protos.google.shopping.merchant.accounts.v1.IAccountService, protos.google.shopping.merchant.accounts.v1.IGetAccountServiceRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetAccountServiceRequest
callback	Callback<protos.google.shopping.merchant.accounts.v1.IAccountService, protos.google.shopping.merchant.accounts.v1.IGetAccountServiceRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getProjectId()

getProjectId(): Promise<string>;

Returns
Type	Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

Parameter
Name	Description
callback	Callback<string, undefined, undefined>

Returns
Type	Description
void

homepagePath(account)

homepagePath(account: string): string;

Return a fully-qualified homepage resource name string.

Parameter
Name	Description
account	string

Returns
Type	Description
string	{string} Resource name string.

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
Type	Description
Promise<{ [name: string]: Function; }>	{Promise} A promise that resolves to an authenticated service stub.

lfpProviderPath(account, omnichannelSetting, lfpProvider)

lfpProviderPath(account: string, omnichannelSetting: string, lfpProvider: string): string;

Return a fully-qualified lfpProvider resource name string.

Parameters
Name	Description
account	string
omnichannelSetting	string
lfpProvider	string

Returns
Type	Description
string	{string} Resource name string.

listAccountServices(request, options)

listAccountServices(request?: protos.google.shopping.merchant.accounts.v1.IListAccountServicesRequest, options?: CallOptions): Promise<[
        protos.google.shopping.merchant.accounts.v1.IAccountService[],
        protos.google.shopping.merchant.accounts.v1.IListAccountServicesRequest | null,
        protos.google.shopping.merchant.accounts.v1.IListAccountServicesResponse
    ]>;

List account services for the specified accounts. Supports filtering.

Parameters
Name	Description
request	IListAccountServicesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.shopping.merchant.accounts.v1.IAccountService[], protos.google.shopping.merchant.accounts.v1.IListAccountServicesRequest | null, protos.google.shopping.merchant.accounts.v1.IListAccountServicesResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listAccountServicesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listAccountServices(request, options, callback)

listAccountServices(request: protos.google.shopping.merchant.accounts.v1.IListAccountServicesRequest, options: CallOptions, callback: PaginationCallback<protos.google.shopping.merchant.accounts.v1.IListAccountServicesRequest, protos.google.shopping.merchant.accounts.v1.IListAccountServicesResponse | null | undefined, protos.google.shopping.merchant.accounts.v1.IAccountService>): void;

Parameters
Name	Description
request	IListAccountServicesRequest
options	CallOptions
callback	PaginationCallback<protos.google.shopping.merchant.accounts.v1.IListAccountServicesRequest, protos.google.shopping.merchant.accounts.v1.IListAccountServicesResponse | null | undefined, protos.google.shopping.merchant.accounts.v1.IAccountService>

Returns
Type	Description
void

listAccountServices(request, callback)

listAccountServices(request: protos.google.shopping.merchant.accounts.v1.IListAccountServicesRequest, callback: PaginationCallback<protos.google.shopping.merchant.accounts.v1.IListAccountServicesRequest, protos.google.shopping.merchant.accounts.v1.IListAccountServicesResponse | null | undefined, protos.google.shopping.merchant.accounts.v1.IAccountService>): void;

Parameters
Name	Description
request	IListAccountServicesRequest
callback	PaginationCallback<protos.google.shopping.merchant.accounts.v1.IListAccountServicesRequest, protos.google.shopping.merchant.accounts.v1.IListAccountServicesResponse | null | undefined, protos.google.shopping.merchant.accounts.v1.IAccountService>

Returns
Type	Description
void

listAccountServicesAsync(request, options)

listAccountServicesAsync(request?: protos.google.shopping.merchant.accounts.v1.IListAccountServicesRequest, options?: CallOptions): AsyncIterable<protos.google.shopping.merchant.accounts.v1.IAccountService>;

Equivalent to listAccountServices, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
request	IListAccountServicesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.shopping.merchant.accounts.v1.IAccountService>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent account of the account service to filter by.
   *  Format: `accounts/{account}`
   */
  // const parent = 'abc123'
  /**
   *  Optional. The token returned by the previous `list` request.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. The maximum number of elements to return in the response. Use for
   *  paging. If no `page_size` is specified, `100` is used as the default value.
   *  The maximum allowed value is `1000`.
   */
  // const pageSize = 1234

  // Imports the Accounts library
  const {AccountServicesServiceClient} = require('@google-shopping/accounts').v1;

  // Instantiates a client
  const accountsClient = new AccountServicesServiceClient();

  async function callListAccountServices() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = accountsClient.listAccountServicesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListAccountServices();

listAccountServicesStream(request, options)

listAccountServicesStream(request?: protos.google.shopping.merchant.accounts.v1.IListAccountServicesRequest, options?: CallOptions): Transform;

Equivalent to listAccountServices, but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListAccountServicesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Transform	{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listAccountServicesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

matchAccountFromAccountIssueName(accountIssueName)

matchAccountFromAccountIssueName(accountIssueName: string): string | number;

Parse the account from AccountIssue resource.

Parameter
Name	Description
accountIssueName	string A fully-qualified path representing AccountIssue resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromAccountName(accountName)

matchAccountFromAccountName(accountName: string): string | number;

Parse the account from Account resource.

Parameter
Name	Description
accountName	string A fully-qualified path representing Account resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromAccountRelationshipName(accountRelationshipName)

matchAccountFromAccountRelationshipName(accountRelationshipName: string): string | number;

Parse the account from AccountRelationship resource.

Parameter
Name	Description
accountRelationshipName	string A fully-qualified path representing AccountRelationship resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromAccountServiceName(accountServiceName)

matchAccountFromAccountServiceName(accountServiceName: string): string | number;

Parse the account from AccountService resource.

Parameter
Name	Description
accountServiceName	string A fully-qualified path representing AccountService resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromAutofeedSettingsName(autofeedSettingsName)

matchAccountFromAutofeedSettingsName(autofeedSettingsName: string): string | number;

Parse the account from AutofeedSettings resource.

Parameter
Name	Description
autofeedSettingsName	string A fully-qualified path representing AutofeedSettings resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromAutomaticImprovementsName(automaticImprovementsName)

matchAccountFromAutomaticImprovementsName(automaticImprovementsName: string): string | number;

Parse the account from AutomaticImprovements resource.

Parameter
Name	Description
automaticImprovementsName	string A fully-qualified path representing AutomaticImprovements resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromBusinessIdentityName(businessIdentityName)

matchAccountFromBusinessIdentityName(businessIdentityName: string): string | number;

Parse the account from BusinessIdentity resource.

Parameter
Name	Description
businessIdentityName	string A fully-qualified path representing BusinessIdentity resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromBusinessInfoName(businessInfoName)

matchAccountFromBusinessInfoName(businessInfoName: string): string | number;

Parse the account from BusinessInfo resource.

Parameter
Name	Description
businessInfoName	string A fully-qualified path representing BusinessInfo resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromCheckoutSettingsName(checkoutSettingsName)

matchAccountFromCheckoutSettingsName(checkoutSettingsName: string): string | number;

Parse the account from CheckoutSettings resource.

Parameter
Name	Description
checkoutSettingsName	string A fully-qualified path representing CheckoutSettings resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromDeveloperRegistrationName(developerRegistrationName)

matchAccountFromDeveloperRegistrationName(developerRegistrationName: string): string | number;

Parse the account from DeveloperRegistration resource.

Parameter
Name	Description
developerRegistrationName	string A fully-qualified path representing DeveloperRegistration resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromEmailPreferencesName(emailPreferencesName)

matchAccountFromEmailPreferencesName(emailPreferencesName: string): string | number;

Parse the account from EmailPreferences resource.

Parameter
Name	Description
emailPreferencesName	string A fully-qualified path representing EmailPreferences resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromGbpAccountName(gbpAccountName)

matchAccountFromGbpAccountName(gbpAccountName: string): string | number;

Parse the account from GbpAccount resource.

Parameter
Name	Description
gbpAccountName	string A fully-qualified path representing GbpAccount resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromHomepageName(homepageName)

matchAccountFromHomepageName(homepageName: string): string | number;

Parse the account from Homepage resource.

Parameter
Name	Description
homepageName	string A fully-qualified path representing Homepage resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromLfpProviderName(lfpProviderName)

matchAccountFromLfpProviderName(lfpProviderName: string): string | number;

Parse the account from LfpProvider resource.

Parameter
Name	Description
lfpProviderName	string A fully-qualified path representing LfpProvider resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromOmnichannelSettingName(omnichannelSettingName)

matchAccountFromOmnichannelSettingName(omnichannelSettingName: string): string | number;

Parse the account from OmnichannelSetting resource.

Parameter
Name	Description
omnichannelSettingName	string A fully-qualified path representing OmnichannelSetting resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromOnlineReturnPolicyName(onlineReturnPolicyName)

matchAccountFromOnlineReturnPolicyName(onlineReturnPolicyName: string): string | number;

Parse the account from OnlineReturnPolicy resource.

Parameter
Name	Description
onlineReturnPolicyName	string A fully-qualified path representing OnlineReturnPolicy resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromProgramName(programName)

matchAccountFromProgramName(programName: string): string | number;

Parse the account from Program resource.

Parameter
Name	Description
programName	string A fully-qualified path representing Program resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromRegionName(regionName)

matchAccountFromRegionName(regionName: string): string | number;

Parse the account from Region resource.

Parameter
Name	Description
regionName	string A fully-qualified path representing Region resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromShippingSettingsName(shippingSettingsName)

matchAccountFromShippingSettingsName(shippingSettingsName: string): string | number;

Parse the account from ShippingSettings resource.

Parameter
Name	Description
shippingSettingsName	string A fully-qualified path representing ShippingSettings resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromTermsOfServiceAgreementStateName(termsOfServiceAgreementStateName)

matchAccountFromTermsOfServiceAgreementStateName(termsOfServiceAgreementStateName: string): string | number;

Parse the account from TermsOfServiceAgreementState resource.

Parameter
Name	Description
termsOfServiceAgreementStateName	string A fully-qualified path representing TermsOfServiceAgreementState resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromUserName(userName)

matchAccountFromUserName(userName: string): string | number;

Parse the account from User resource.

Parameter
Name	Description
userName	string A fully-qualified path representing User resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchEmailFromEmailPreferencesName(emailPreferencesName)

matchEmailFromEmailPreferencesName(emailPreferencesName: string): string | number;

Parse the email from EmailPreferences resource.

Parameter
Name	Description
emailPreferencesName	string A fully-qualified path representing EmailPreferences resource.

Returns
Type	Description
string | number	{string} A string representing the email.

matchEmailFromUserName(userName)

matchEmailFromUserName(userName: string): string | number;

Parse the email from User resource.

Parameter
Name	Description
userName	string A fully-qualified path representing User resource.

Returns
Type	Description
string | number	{string} A string representing the email.

matchGbpAccountFromGbpAccountName(gbpAccountName)

matchGbpAccountFromGbpAccountName(gbpAccountName: string): string | number;

Parse the gbp_account from GbpAccount resource.

Parameter
Name	Description
gbpAccountName	string A fully-qualified path representing GbpAccount resource.

Returns
Type	Description
string | number	{string} A string representing the gbp_account.

matchIdentifierFromTermsOfServiceAgreementStateName(termsOfServiceAgreementStateName)

matchIdentifierFromTermsOfServiceAgreementStateName(termsOfServiceAgreementStateName: string): string | number;

Parse the identifier from TermsOfServiceAgreementState resource.

Parameter
Name	Description
termsOfServiceAgreementStateName	string A fully-qualified path representing TermsOfServiceAgreementState resource.

Returns
Type	Description
string | number	{string} A string representing the identifier.

matchIssueFromAccountIssueName(accountIssueName)

matchIssueFromAccountIssueName(accountIssueName: string): string | number;

Parse the issue from AccountIssue resource.

Parameter
Name	Description
accountIssueName	string A fully-qualified path representing AccountIssue resource.

Returns
Type	Description
string | number	{string} A string representing the issue.

matchLfpProviderFromLfpProviderName(lfpProviderName)

matchLfpProviderFromLfpProviderName(lfpProviderName: string): string | number;

Parse the lfp_provider from LfpProvider resource.

Parameter
Name	Description
lfpProviderName	string A fully-qualified path representing LfpProvider resource.

Returns
Type	Description
string | number	{string} A string representing the lfp_provider.

matchOmnichannelSettingFromLfpProviderName(lfpProviderName)

matchOmnichannelSettingFromLfpProviderName(lfpProviderName: string): string | number;

Parse the omnichannel_setting from LfpProvider resource.

Parameter
Name	Description
lfpProviderName	string A fully-qualified path representing LfpProvider resource.

Returns
Type	Description
string | number	{string} A string representing the omnichannel_setting.

matchOmnichannelSettingFromOmnichannelSettingName(omnichannelSettingName)

matchOmnichannelSettingFromOmnichannelSettingName(omnichannelSettingName: string): string | number;

Parse the omnichannel_setting from OmnichannelSetting resource.

Parameter
Name	Description
omnichannelSettingName	string A fully-qualified path representing OmnichannelSetting resource.

Returns
Type	Description
string | number	{string} A string representing the omnichannel_setting.

matchProgramFromCheckoutSettingsName(checkoutSettingsName)

matchProgramFromCheckoutSettingsName(checkoutSettingsName: string): string | number;

Parse the program from CheckoutSettings resource.

Parameter
Name	Description
checkoutSettingsName	string A fully-qualified path representing CheckoutSettings resource.

Returns
Type	Description
string | number	{string} A string representing the program.

matchProgramFromProgramName(programName)

matchProgramFromProgramName(programName: string): string | number;

Parse the program from Program resource.

Parameter
Name	Description
programName	string A fully-qualified path representing Program resource.

Returns
Type	Description
string | number	{string} A string representing the program.

matchRegionFromRegionName(regionName)

matchRegionFromRegionName(regionName: string): string | number;

Parse the region from Region resource.

Parameter
Name	Description
regionName	string A fully-qualified path representing Region resource.

Returns
Type	Description
string | number	{string} A string representing the region.

matchRelationshipFromAccountRelationshipName(accountRelationshipName)

matchRelationshipFromAccountRelationshipName(accountRelationshipName: string): string | number;

Parse the relationship from AccountRelationship resource.

Parameter
Name	Description
accountRelationshipName	string A fully-qualified path representing AccountRelationship resource.

Returns
Type	Description
string | number	{string} A string representing the relationship.

matchReturnPolicyFromOnlineReturnPolicyName(onlineReturnPolicyName)

matchReturnPolicyFromOnlineReturnPolicyName(onlineReturnPolicyName: string): string | number;

Parse the return_policy from OnlineReturnPolicy resource.

Parameter
Name	Description
onlineReturnPolicyName	string A fully-qualified path representing OnlineReturnPolicy resource.

Returns
Type	Description
string | number	{string} A string representing the return_policy.

matchServiceFromAccountServiceName(accountServiceName)

matchServiceFromAccountServiceName(accountServiceName: string): string | number;

Parse the service from AccountService resource.

Parameter
Name	Description
accountServiceName	string A fully-qualified path representing AccountService resource.

Returns
Type	Description
string | number	{string} A string representing the service.

matchVersionFromTermsOfServiceName(termsOfServiceName)

matchVersionFromTermsOfServiceName(termsOfServiceName: string): string | number;

Parse the version from TermsOfService resource.

Parameter
Name	Description
termsOfServiceName	string A fully-qualified path representing TermsOfService resource.

Returns
Type	Description
string | number	{string} A string representing the version.

omnichannelSettingPath(account, omnichannelSetting)

omnichannelSettingPath(account: string, omnichannelSetting: string): string;

Return a fully-qualified omnichannelSetting resource name string.

Parameters
Name	Description
account	string
omnichannelSetting	string

Returns
Type	Description
string	{string} Resource name string.

onlineReturnPolicyPath(account, returnPolicy)

onlineReturnPolicyPath(account: string, returnPolicy: string): string;

Return a fully-qualified onlineReturnPolicy resource name string.

Parameters
Name	Description
account	string
returnPolicy	string

Returns
Type	Description
string	{string} Resource name string.

programPath(account, program)

programPath(account: string, program: string): string;

Return a fully-qualified program resource name string.

Parameters
Name	Description
account	string
program	string

Returns
Type	Description
string	{string} Resource name string.

proposeAccountService(request, options)

proposeAccountService(request?: protos.google.shopping.merchant.accounts.v1.IProposeAccountServiceRequest, options?: CallOptions): Promise<[
        protos.google.shopping.merchant.accounts.v1.IAccountService,
        protos.google.shopping.merchant.accounts.v1.IProposeAccountServiceRequest | undefined,
        {} | undefined
    ]>;

Propose an account service.

Parameters
Name	Description
request	IProposeAccountServiceRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.shopping.merchant.accounts.v1.IAccountService, protos.google.shopping.merchant.accounts.v1.IProposeAccountServiceRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the parent account for the service.
   *  Format: `accounts/{account}`
   */
  // const parent = 'abc123'
  /**
   *  Required. 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`).
   */
  // const provider = 'abc123'
  /**
   *  Required. The account service to propose.
   */
  // const accountService = {}

  // Imports the Accounts library
  const {AccountServicesServiceClient} = require('@google-shopping/accounts').v1;

  // Instantiates a client
  const accountsClient = new AccountServicesServiceClient();

  async function callProposeAccountService() {
    // Construct request
    const request = {
      parent,
      provider,
      accountService,
    };

    // Run request
    const response = await accountsClient.proposeAccountService(request);
    console.log(response);
  }

  callProposeAccountService();

proposeAccountService(request, options, callback)

proposeAccountService(request: protos.google.shopping.merchant.accounts.v1.IProposeAccountServiceRequest, options: CallOptions, callback: Callback<protos.google.shopping.merchant.accounts.v1.IAccountService, protos.google.shopping.merchant.accounts.v1.IProposeAccountServiceRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IProposeAccountServiceRequest
options	CallOptions
callback	Callback<protos.google.shopping.merchant.accounts.v1.IAccountService, protos.google.shopping.merchant.accounts.v1.IProposeAccountServiceRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

proposeAccountService(request, callback)

proposeAccountService(request: protos.google.shopping.merchant.accounts.v1.IProposeAccountServiceRequest, callback: Callback<protos.google.shopping.merchant.accounts.v1.IAccountService, protos.google.shopping.merchant.accounts.v1.IProposeAccountServiceRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IProposeAccountServiceRequest
callback	Callback<protos.google.shopping.merchant.accounts.v1.IAccountService, protos.google.shopping.merchant.accounts.v1.IProposeAccountServiceRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

regionPath(account, region)

regionPath(account: string, region: string): string;

Return a fully-qualified region resource name string.

Parameters
Name	Description
account	string
region	string

Returns
Type	Description
string	{string} Resource name string.

rejectAccountService(request, options)

rejectAccountService(request?: protos.google.shopping.merchant.accounts.v1.IRejectAccountServiceRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.shopping.merchant.accounts.v1.IRejectAccountServiceRequest | undefined,
        {} | undefined
    ]>;

Reject an account service (both proposed and approve services can be rejected).

Parameters
Name	Description
request	IRejectAccountServiceRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.protobuf.IEmpty, protos.google.shopping.merchant.accounts.v1.IRejectAccountServiceRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples.

Example

  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the account service to reject.
   *  Format: `accounts/{account}/services/{service}`
   */
  // const name = 'abc123'

  // Imports the Accounts library
  const {AccountServicesServiceClient} = require('@google-shopping/accounts').v1;

  // Instantiates a client
  const accountsClient = new AccountServicesServiceClient();

  async function callRejectAccountService() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await accountsClient.rejectAccountService(request);
    console.log(response);
  }

  callRejectAccountService();

rejectAccountService(request, options, callback)

rejectAccountService(request: protos.google.shopping.merchant.accounts.v1.IRejectAccountServiceRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.shopping.merchant.accounts.v1.IRejectAccountServiceRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IRejectAccountServiceRequest
options	CallOptions
callback	Callback<protos.google.protobuf.IEmpty, protos.google.shopping.merchant.accounts.v1.IRejectAccountServiceRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

rejectAccountService(request, callback)

rejectAccountService(request: protos.google.shopping.merchant.accounts.v1.IRejectAccountServiceRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.shopping.merchant.accounts.v1.IRejectAccountServiceRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IRejectAccountServiceRequest
callback	Callback<protos.google.protobuf.IEmpty, protos.google.shopping.merchant.accounts.v1.IRejectAccountServiceRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

shippingSettingsPath(account)

shippingSettingsPath(account: string): string;

Return a fully-qualified shippingSettings resource name string.

Parameter
Name	Description
account	string

Returns
Type	Description
string	{string} Resource name string.

termsOfServiceAgreementStatePath(account, identifier)

termsOfServiceAgreementStatePath(account: string, identifier: string): string;

Return a fully-qualified termsOfServiceAgreementState resource name string.

Parameters
Name	Description
account	string
identifier	string

Returns
Type	Description
string	{string} Resource name string.

termsOfServicePath(version)

termsOfServicePath(version: string): string;

Return a fully-qualified termsOfService resource name string.

Parameter
Name	Description
version	string

Returns
Type	Description
string	{string} Resource name string.

userPath(account, email)

userPath(account: string, email: string): string;

Return a fully-qualified user resource name string.

Parameters
Name	Description
account	string
email	string

Returns
Type	Description
string	{string} Resource name string.