Class v1beta.AccountTaxServiceClient (1.0.0)

Manages account level tax setting data.

This API defines the following resource model:

  • v1beta

Package

@google-shopping/accounts

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of AccountTaxServiceClient.

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 AccountTaxServiceClient({fallback: true}, gax); ```

Properties

accountTaxServiceStub

accountTaxServiceStub?: 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.

accountTaxPath(account, tax)

accountTaxPath(account: string, tax: string): string;

Return a fully-qualified accountTax resource name string.

Parameters
Name Description
account string
tax string
Returns
Type Description
string

{string} Resource name string.

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.

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.

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.

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.

getAccountTax(request, options)

getAccountTax(request?: protos.google.shopping.merchant.accounts.v1beta.IGetAccountTaxRequest, options?: CallOptions): Promise<[
        protos.google.shopping.merchant.accounts.v1beta.IAccountTax,
        (protos.google.shopping.merchant.accounts.v1beta.IGetAccountTaxRequest | undefined),
        {} | undefined
    ]>;

Returns the tax rules that match the conditions of GetAccountTaxRequest

Parameters
Name Description
request IGetAccountTaxRequest

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.v1beta.IAccountTax, (protos.google.shopping.merchant.accounts.v1beta.IGetAccountTaxRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing AccountTax. 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 name from which tax settings will be retrieved
   */
  // const name = 'abc123'

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

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

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

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

  callGetAccountTax();

getAccountTax(request, options, callback)

getAccountTax(request: protos.google.shopping.merchant.accounts.v1beta.IGetAccountTaxRequest, options: CallOptions, callback: Callback<protos.google.shopping.merchant.accounts.v1beta.IAccountTax, protos.google.shopping.merchant.accounts.v1beta.IGetAccountTaxRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetAccountTaxRequest
options CallOptions
callback Callback<protos.google.shopping.merchant.accounts.v1beta.IAccountTax, protos.google.shopping.merchant.accounts.v1beta.IGetAccountTaxRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getAccountTax(request, callback)

getAccountTax(request: protos.google.shopping.merchant.accounts.v1beta.IGetAccountTaxRequest, callback: Callback<protos.google.shopping.merchant.accounts.v1beta.IAccountTax, protos.google.shopping.merchant.accounts.v1beta.IGetAccountTaxRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetAccountTaxRequest
callback Callback<protos.google.shopping.merchant.accounts.v1beta.IAccountTax, protos.google.shopping.merchant.accounts.v1beta.IGetAccountTaxRequest | 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.

listAccountTax(request, options)

listAccountTax(request?: protos.google.shopping.merchant.accounts.v1beta.IListAccountTaxRequest, options?: CallOptions): Promise<[
        protos.google.shopping.merchant.accounts.v1beta.IAccountTax[],
        protos.google.shopping.merchant.accounts.v1beta.IListAccountTaxRequest | null,
        protos.google.shopping.merchant.accounts.v1beta.IListAccountTaxResponse
    ]>;

Lists the tax settings of the sub-accounts only in your Merchant Center account. This method can only be called on a multi-client account, otherwise it'll return an error.

Parameters
Name Description
request IListAccountTaxRequest

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.v1beta.IAccountTax[], protos.google.shopping.merchant.accounts.v1beta.IListAccountTaxRequest | null, protos.google.shopping.merchant.accounts.v1beta.IListAccountTaxResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of AccountTax. 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 listAccountTaxAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listAccountTax(request, options, callback)

listAccountTax(request: protos.google.shopping.merchant.accounts.v1beta.IListAccountTaxRequest, options: CallOptions, callback: PaginationCallback<protos.google.shopping.merchant.accounts.v1beta.IListAccountTaxRequest, protos.google.shopping.merchant.accounts.v1beta.IListAccountTaxResponse | null | undefined, protos.google.shopping.merchant.accounts.v1beta.IAccountTax>): void;
Parameters
Name Description
request IListAccountTaxRequest
options CallOptions
callback PaginationCallback<protos.google.shopping.merchant.accounts.v1beta.IListAccountTaxRequest, protos.google.shopping.merchant.accounts.v1beta.IListAccountTaxResponse | null | undefined, protos.google.shopping.merchant.accounts.v1beta.IAccountTax>
Returns
Type Description
void

listAccountTax(request, callback)

listAccountTax(request: protos.google.shopping.merchant.accounts.v1beta.IListAccountTaxRequest, callback: PaginationCallback<protos.google.shopping.merchant.accounts.v1beta.IListAccountTaxRequest, protos.google.shopping.merchant.accounts.v1beta.IListAccountTaxResponse | null | undefined, protos.google.shopping.merchant.accounts.v1beta.IAccountTax>): void;
Parameters
Name Description
request IListAccountTaxRequest
callback PaginationCallback<protos.google.shopping.merchant.accounts.v1beta.IListAccountTaxRequest, protos.google.shopping.merchant.accounts.v1beta.IListAccountTaxResponse | null | undefined, protos.google.shopping.merchant.accounts.v1beta.IAccountTax>
Returns
Type Description
void

listAccountTaxAsync(request, options)

listAccountTaxAsync(request?: protos.google.shopping.merchant.accounts.v1beta.IListAccountTaxRequest, options?: CallOptions): AsyncIterable<protos.google.shopping.merchant.accounts.v1beta.IAccountTax>;

Equivalent to listAccountTax, but returns an iterable object.

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

Parameters
Name Description
request IListAccountTaxRequest

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.v1beta.IAccountTax>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing AccountTax. 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, which owns this collection of account tax.
   *  Format: accounts/{account}
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of tax settings to return in the response, used for
   *  paging.
   */
  // const pageSize = 1234
  /**
   *  The token returned by the previous request.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListAccountTax();

listAccountTaxStream(request, options)

listAccountTaxStream(request?: protos.google.shopping.merchant.accounts.v1beta.IListAccountTaxRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name Description
request IListAccountTaxRequest

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 AccountTax 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 listAccountTaxAsync() 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.

matchAccountFromAccountTaxName(accountTaxName)

matchAccountFromAccountTaxName(accountTaxName: string): string | number;

Parse the account from AccountTax resource.

Parameter
Name Description
accountTaxName string

A fully-qualified path representing AccountTax 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.

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.

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.

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.

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.

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.

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.

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.

matchTaxFromAccountTaxName(accountTaxName)

matchTaxFromAccountTaxName(accountTaxName: string): string | number;

Parse the tax from AccountTax resource.

Parameter
Name Description
accountTaxName string

A fully-qualified path representing AccountTax resource.

Returns
Type Description
string | number

{string} A string representing the tax.

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.

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.

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.

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.

updateAccountTax(request, options)

updateAccountTax(request?: protos.google.shopping.merchant.accounts.v1beta.IUpdateAccountTaxRequest, options?: CallOptions): Promise<[
        protos.google.shopping.merchant.accounts.v1beta.IAccountTax,
        (protos.google.shopping.merchant.accounts.v1beta.IUpdateAccountTaxRequest | undefined),
        {} | undefined
    ]>;

Updates the tax settings of the account.

Parameters
Name Description
request IUpdateAccountTaxRequest

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.v1beta.IAccountTax, (protos.google.shopping.merchant.accounts.v1beta.IUpdateAccountTaxRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing AccountTax. 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 tax setting that will be updated
   */
  // const accountTax = {}
  /**
   *  The list of fields to be updated
   */
  // const updateMask = {}

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

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

  async function callUpdateAccountTax() {
    // Construct request
    const request = {
      accountTax,
    };

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

  callUpdateAccountTax();

updateAccountTax(request, options, callback)

updateAccountTax(request: protos.google.shopping.merchant.accounts.v1beta.IUpdateAccountTaxRequest, options: CallOptions, callback: Callback<protos.google.shopping.merchant.accounts.v1beta.IAccountTax, protos.google.shopping.merchant.accounts.v1beta.IUpdateAccountTaxRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateAccountTaxRequest
options CallOptions
callback Callback<protos.google.shopping.merchant.accounts.v1beta.IAccountTax, protos.google.shopping.merchant.accounts.v1beta.IUpdateAccountTaxRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateAccountTax(request, callback)

updateAccountTax(request: protos.google.shopping.merchant.accounts.v1beta.IUpdateAccountTaxRequest, callback: Callback<protos.google.shopping.merchant.accounts.v1beta.IAccountTax, protos.google.shopping.merchant.accounts.v1beta.IUpdateAccountTaxRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateAccountTaxRequest
callback Callback<protos.google.shopping.merchant.accounts.v1beta.IAccountTax, protos.google.shopping.merchant.accounts.v1beta.IUpdateAccountTaxRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

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.