Class v1beta.TermsOfServiceServiceClient (1.0.0)

Service to support TermsOfService API. v1beta

Package

@google-shopping/accounts

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of TermsOfServiceServiceClient.

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

Properties

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.

termsOfServiceServiceStub

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

universeDomain

get universeDomain(): string;

warn

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

Methods

acceptTermsOfService(request, options)

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

Accepts a TermsOfService. Executing this method requires admin access.

Parameters
Name	Description
request	IAcceptTermsOfServiceRequest 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.v1beta.IAcceptTermsOfServiceRequest | 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 terms of service version.
   *  Format: `termsOfService/{version}`
   */
  // const name = 'abc123'
  /**
   *  Required. The account for which to accept the ToS.
   */
  // const account = 'abc123'
  /**
   *  Required. Region code as defined by CLDR (https://cldr.unicode.org/). This
   *  is either a country when the ToS applies specifically to that country or
   *  001 when it applies globally.
   */
  // const regionCode = 'abc123'

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

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

  async function callAcceptTermsOfService() {
    // Construct request
    const request = {
      name,
      account,
      regionCode,
    };

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

  callAcceptTermsOfService();

acceptTermsOfService(request, options, callback)

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

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

Returns
Type	Description
void

acceptTermsOfService(request, callback)

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

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

Returns
Type	Description
void

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.

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

getTermsOfService(request, options)

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

Retrieves the TermsOfService associated with the provided version.

Parameters
Name	Description
request	IGetTermsOfServiceRequest 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.ITermsOfService, (protos.google.shopping.merchant.accounts.v1beta.IGetTermsOfServiceRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing TermsOfService. 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 terms of service version.
   *  Format: `termsOfService/{version}`
   */
  // const name = 'abc123'

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

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

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

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

  callGetTermsOfService();

getTermsOfService(request, options, callback)

getTermsOfService(request: protos.google.shopping.merchant.accounts.v1beta.IGetTermsOfServiceRequest, options: CallOptions, callback: Callback<protos.google.shopping.merchant.accounts.v1beta.ITermsOfService, protos.google.shopping.merchant.accounts.v1beta.IGetTermsOfServiceRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetTermsOfServiceRequest
options	CallOptions
callback	Callback<protos.google.shopping.merchant.accounts.v1beta.ITermsOfService, protos.google.shopping.merchant.accounts.v1beta.IGetTermsOfServiceRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getTermsOfService(request, callback)

getTermsOfService(request: protos.google.shopping.merchant.accounts.v1beta.IGetTermsOfServiceRequest, callback: Callback<protos.google.shopping.merchant.accounts.v1beta.ITermsOfService, protos.google.shopping.merchant.accounts.v1beta.IGetTermsOfServiceRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetTermsOfServiceRequest
callback	Callback<protos.google.shopping.merchant.accounts.v1beta.ITermsOfService, protos.google.shopping.merchant.accounts.v1beta.IGetTermsOfServiceRequest | null | undefined, {} | null | 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.

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.

retrieveLatestTermsOfService(request, options)

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

Retrieves the latest version of the TermsOfService for a given kind and region_code.

Parameters
Name	Description
request	IRetrieveLatestTermsOfServiceRequest 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.ITermsOfService, (protos.google.shopping.merchant.accounts.v1beta.IRetrieveLatestTermsOfServiceRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing TermsOfService. 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. Region code as defined by CLDR (https://cldr.unicode.org/). This
   *  is either a country when the ToS applies specifically to that country or
   *  001 when it applies globally.
   */
  // const regionCode = 'abc123'
  /**
   *  Required. The Kind this terms of service version applies to.
   */
  // const kind = {}

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

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

  async function callRetrieveLatestTermsOfService() {
    // Construct request
    const request = {
      regionCode,
      kind,
    };

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

  callRetrieveLatestTermsOfService();

retrieveLatestTermsOfService(request, options, callback)

retrieveLatestTermsOfService(request: protos.google.shopping.merchant.accounts.v1beta.IRetrieveLatestTermsOfServiceRequest, options: CallOptions, callback: Callback<protos.google.shopping.merchant.accounts.v1beta.ITermsOfService, protos.google.shopping.merchant.accounts.v1beta.IRetrieveLatestTermsOfServiceRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IRetrieveLatestTermsOfServiceRequest
options	CallOptions
callback	Callback<protos.google.shopping.merchant.accounts.v1beta.ITermsOfService, protos.google.shopping.merchant.accounts.v1beta.IRetrieveLatestTermsOfServiceRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

retrieveLatestTermsOfService(request, callback)

retrieveLatestTermsOfService(request: protos.google.shopping.merchant.accounts.v1beta.IRetrieveLatestTermsOfServiceRequest, callback: Callback<protos.google.shopping.merchant.accounts.v1beta.ITermsOfService, protos.google.shopping.merchant.accounts.v1beta.IRetrieveLatestTermsOfServiceRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IRetrieveLatestTermsOfServiceRequest
callback	Callback<protos.google.shopping.merchant.accounts.v1beta.ITermsOfService, protos.google.shopping.merchant.accounts.v1beta.IRetrieveLatestTermsOfServiceRequest | 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.