Service for program management.
Programs provide a mechanism for adding functionality to merchant accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/topic/9240261?ref_topic=7257954,7259405,&sjid=796648681813264022-EU) program, which enables products from a merchant's store to be shown across Google for free.
This service exposes methods to retrieve a merchant's participation in all available programs, in addition to methods for explicitly enabling or disabling participation in each program. v1beta
Package
@google-shopping/accountsConstructors
(constructor)(opts, gaxInstance)
constructor
(
opts
?:
ClientOptions
,
gaxInstance
?:
typeof
gax
|
typeof
gax
.
fallback
);
Construct an instance of ProgramsServiceClient.
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 ProgramsServiceClient({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.
programsServiceStub
programsServiceStub
?:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
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.
account
string
issue
string
string
{string} Resource name string.
accountPath(account)
accountPath
(
account
:
string
)
:
string
;
Return a fully-qualified account resource name string.
account
string
string
{string} Resource name string.
accountTaxPath(account, tax)
accountTaxPath
(
account
:
string
,
tax
:
string
)
:
string
;
Return a fully-qualified accountTax resource name string.
account
string
tax
string
string
{string} Resource name string.
autofeedSettingsPath(account)
autofeedSettingsPath
(
account
:
string
)
:
string
;
Return a fully-qualified autofeedSettings resource name string.
account
string
string
{string} Resource name string.
automaticImprovementsPath(account)
automaticImprovementsPath
(
account
:
string
)
:
string
;
Return a fully-qualified automaticImprovements resource name string.
account
string
string
{string} Resource name string.
businessIdentityPath(account)
businessIdentityPath
(
account
:
string
)
:
string
;
Return a fully-qualified businessIdentity resource name string.
account
string
string
{string} Resource name string.
businessInfoPath(account)
businessInfoPath
(
account
:
string
)
:
string
;
Return a fully-qualified businessInfo resource name string.
account
string
string
{string} Resource name string.
checkoutSettingsPath(account, program)
checkoutSettingsPath
(
account
:
string
,
program
:
string
)
:
string
;
Return a fully-qualified checkoutSettings resource name string.
account
string
program
string
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.
Promise
<void>
{Promise} A promise that resolves when the client is closed.
disableProgram(request, options)
disableProgram
(
request
?:
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IDisableProgramRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IProgram
,
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IDisableProgramRequest
|
undefined
,
{}
|
undefined
]>;
Disable participation in the specified program for the account. Executing this method requires admin access.
request
options
Promise
<[ protos.google.shopping.merchant.accounts.v1beta.IProgram
, protos.google.shopping.merchant.accounts.v1beta.IDisableProgramRequest
| 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.
/**
* 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 of the program for which to disable participation for
* the given account. Format: `accounts/{account}/programs/{program}`
*/
// const name = 'abc123'
// Imports the Accounts library
const
{
ProgramsServiceClient
}
=
require
(
' @google-shopping/accounts
'
).
v1beta
;
// Instantiates a client
const
accountsClient
=
new
ProgramsServiceClient
();
async
function
callDisableProgram
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
accountsClient
.
disableProgram
(
request
);
console
.
log
(
response
);
}
callDisableProgram
();
disableProgram(request, options, callback)
disableProgram
(
request
:
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IDisableProgramRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IProgram
,
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IDisableProgramRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.shopping.merchant.accounts.v1beta.IProgram
, protos.google.shopping.merchant.accounts.v1beta.IDisableProgramRequest
| null | undefined, {} | null | undefined>
void
disableProgram(request, callback)
disableProgram
(
request
:
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IDisableProgramRequest
,
callback
:
Callback<protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IProgram
,
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IDisableProgramRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.shopping.merchant.accounts.v1beta.IProgram
, protos.google.shopping.merchant.accounts.v1beta.IDisableProgramRequest
| null | undefined, {} | null | undefined>
void
emailPreferencesPath(account, email)
emailPreferencesPath
(
account
:
string
,
email
:
string
)
:
string
;
Return a fully-qualified emailPreferences resource name string.
account
string
email
string
string
{string} Resource name string.
enableProgram(request, options)
enableProgram
(
request
?:
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IEnableProgramRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IProgram
,
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IEnableProgramRequest
|
undefined
,
{}
|
undefined
]>;
Enable participation in the specified program for the account. Executing this method requires admin access.
request
options
Promise
<[ protos.google.shopping.merchant.accounts.v1beta.IProgram
, protos.google.shopping.merchant.accounts.v1beta.IEnableProgramRequest
| 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.
/**
* 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 of the program for which to enable participation for the
* given account. Format: `accounts/{account}/programs/{program}`
*/
// const name = 'abc123'
// Imports the Accounts library
const
{
ProgramsServiceClient
}
=
require
(
' @google-shopping/accounts
'
).
v1beta
;
// Instantiates a client
const
accountsClient
=
new
ProgramsServiceClient
();
async
function
callEnableProgram
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
accountsClient
.
enableProgram
(
request
);
console
.
log
(
response
);
}
callEnableProgram
();
enableProgram(request, options, callback)
enableProgram
(
request
:
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IEnableProgramRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IProgram
,
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IEnableProgramRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.shopping.merchant.accounts.v1beta.IProgram
, protos.google.shopping.merchant.accounts.v1beta.IEnableProgramRequest
| null | undefined, {} | null | undefined>
void
enableProgram(request, callback)
enableProgram
(
request
:
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IEnableProgramRequest
,
callback
:
Callback<protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IProgram
,
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IEnableProgramRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.shopping.merchant.accounts.v1beta.IProgram
, protos.google.shopping.merchant.accounts.v1beta.IEnableProgramRequest
| null | undefined, {} | null | undefined>
void
gbpAccountPath(account, gbpAccount)
gbpAccountPath
(
account
:
string
,
gbpAccount
:
string
)
:
string
;
Return a fully-qualified gbpAccount resource name string.
account
string
gbpAccount
string
string
{string} Resource name string.
getProgram(request, options)
getProgram
(
request
?:
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IGetProgramRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IProgram
,
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IGetProgramRequest
|
undefined
,
{}
|
undefined
]>;
Retrieves the specified program for the account.
request
options
Promise
<[ protos.google.shopping.merchant.accounts.v1beta.IProgram
, protos.google.shopping.merchant.accounts.v1beta.IGetProgramRequest
| 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.
/**
* 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 of the program to retrieve.
* Format: `accounts/{account}/programs/{program}`
*/
// const name = 'abc123'
// Imports the Accounts library
const
{
ProgramsServiceClient
}
=
require
(
' @google-shopping/accounts
'
).
v1beta
;
// Instantiates a client
const
accountsClient
=
new
ProgramsServiceClient
();
async
function
callGetProgram
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
accountsClient
.
getProgram
(
request
);
console
.
log
(
response
);
}
callGetProgram
();
getProgram(request, options, callback)
getProgram
(
request
:
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IGetProgramRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IProgram
,
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IGetProgramRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.shopping.merchant.accounts.v1beta.IProgram
, protos.google.shopping.merchant.accounts.v1beta.IGetProgramRequest
| null | undefined, {} | null | undefined>
void
getProgram(request, callback)
getProgram
(
request
:
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IGetProgramRequest
,
callback
:
Callback<protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IProgram
,
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IGetProgramRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.shopping.merchant.accounts.v1beta.IProgram
, protos.google.shopping.merchant.accounts.v1beta.IGetProgramRequest
| null | undefined, {} | null | undefined>
void
getProjectId()
getProjectId
()
:
Promise<string>
;
Promise
<string>
getProjectId(callback)
getProjectId
(
callback
:
Callback<string
,
undefined
,
undefined
> )
:
void
;
callback
Callback
<string, undefined, undefined>
void
homepagePath(account)
homepagePath
(
account
:
string
)
:
string
;
Return a fully-qualified homepage resource name string.
account
string
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.
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.
account
string
omnichannelSetting
string
lfpProvider
string
string
{string} Resource name string.
listPrograms(request, options)
listPrograms
(
request
?:
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IListProgramsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IProgram
[],
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IListProgramsRequest
|
null
,
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IListProgramsResponse
]>;
Retrieves all programs for the account.
request
options
Promise
<[ protos.google.shopping.merchant.accounts.v1beta.IProgram
[], protos.google.shopping.merchant.accounts.v1beta.IListProgramsRequest
| null, protos.google.shopping.merchant.accounts.v1beta.IListProgramsResponse
]>
{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 listProgramsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listPrograms(request, options, callback)
listPrograms
(
request
:
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IListProgramsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IListProgramsRequest
,
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IListProgramsResponse
|
null
|
undefined
,
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IProgram
> )
:
void
;
request
options
CallOptions
callback
void
listPrograms(request, callback)
listPrograms
(
request
:
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IListProgramsRequest
,
callback
:
PaginationCallback<protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IListProgramsRequest
,
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IListProgramsResponse
|
null
|
undefined
,
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IProgram
> )
:
void
;
request
callback
void
listProgramsAsync(request, options)
listProgramsAsync
(
request
?:
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IListProgramsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IProgram
> ;
Equivalent to listPrograms
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
options
AsyncIterable
< protos.google.shopping.merchant.accounts.v1beta.IProgram
>
{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.
/**
* 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 of the account for which to retrieve all programs.
* Format: `accounts/{account}`
*/
// const parent = 'abc123'
/**
* Optional. The maximum number of programs to return in a single response. If
* unspecified (or 0), a default size of 1000 is used. The maximum value is
* 1000; values above 1000 will be coerced to 1000.
*/
// const pageSize = 1234
/**
* Optional. A continuation token, received from a previous `ListPrograms`
* call. Provide this to retrieve the next page.
*/
// const pageToken = 'abc123'
// Imports the Accounts library
const
{
ProgramsServiceClient
}
=
require
(
' @google-shopping/accounts
'
).
v1beta
;
// Instantiates a client
const
accountsClient
=
new
ProgramsServiceClient
();
async
function
callListPrograms
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
accountsClient
.
listProgramsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListPrograms
();
listProgramsStream(request, options)
listProgramsStream
(
request
?:
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1beta
.
IListProgramsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to listPrograms
, but returns a NodeJS Stream object.
request
options
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 listProgramsAsync()
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.
accountIssueName
string
A fully-qualified path representing AccountIssue resource.
string | number
{string} A string representing the account.
matchAccountFromAccountName(accountName)
matchAccountFromAccountName
(
accountName
:
string
)
:
string
|
number
;
Parse the account from Account resource.
accountName
string
A fully-qualified path representing Account resource.
string | number
{string} A string representing the account.
matchAccountFromAccountTaxName(accountTaxName)
matchAccountFromAccountTaxName
(
accountTaxName
:
string
)
:
string
|
number
;
Parse the account from AccountTax resource.
accountTaxName
string
A fully-qualified path representing AccountTax resource.
string | number
{string} A string representing the account.
matchAccountFromAutofeedSettingsName(autofeedSettingsName)
matchAccountFromAutofeedSettingsName
(
autofeedSettingsName
:
string
)
:
string
|
number
;
Parse the account from AutofeedSettings resource.
autofeedSettingsName
string
A fully-qualified path representing AutofeedSettings resource.
string | number
{string} A string representing the account.
matchAccountFromAutomaticImprovementsName(automaticImprovementsName)
matchAccountFromAutomaticImprovementsName
(
automaticImprovementsName
:
string
)
:
string
|
number
;
Parse the account from AutomaticImprovements resource.
automaticImprovementsName
string
A fully-qualified path representing AutomaticImprovements resource.
string | number
{string} A string representing the account.
matchAccountFromBusinessIdentityName(businessIdentityName)
matchAccountFromBusinessIdentityName
(
businessIdentityName
:
string
)
:
string
|
number
;
Parse the account from BusinessIdentity resource.
businessIdentityName
string
A fully-qualified path representing BusinessIdentity resource.
string | number
{string} A string representing the account.
matchAccountFromBusinessInfoName(businessInfoName)
matchAccountFromBusinessInfoName
(
businessInfoName
:
string
)
:
string
|
number
;
Parse the account from BusinessInfo resource.
businessInfoName
string
A fully-qualified path representing BusinessInfo resource.
string | number
{string} A string representing the account.
matchAccountFromCheckoutSettingsName(checkoutSettingsName)
matchAccountFromCheckoutSettingsName
(
checkoutSettingsName
:
string
)
:
string
|
number
;
Parse the account from CheckoutSettings resource.
checkoutSettingsName
string
A fully-qualified path representing CheckoutSettings resource.
string | number
{string} A string representing the account.
matchAccountFromEmailPreferencesName(emailPreferencesName)
matchAccountFromEmailPreferencesName
(
emailPreferencesName
:
string
)
:
string
|
number
;
Parse the account from EmailPreferences resource.
emailPreferencesName
string
A fully-qualified path representing EmailPreferences resource.
string | number
{string} A string representing the account.
matchAccountFromGbpAccountName(gbpAccountName)
matchAccountFromGbpAccountName
(
gbpAccountName
:
string
)
:
string
|
number
;
Parse the account from GbpAccount resource.
gbpAccountName
string
A fully-qualified path representing GbpAccount resource.
string | number
{string} A string representing the account.
matchAccountFromHomepageName(homepageName)
matchAccountFromHomepageName
(
homepageName
:
string
)
:
string
|
number
;
Parse the account from Homepage resource.
homepageName
string
A fully-qualified path representing Homepage resource.
string | number
{string} A string representing the account.
matchAccountFromLfpProviderName(lfpProviderName)
matchAccountFromLfpProviderName
(
lfpProviderName
:
string
)
:
string
|
number
;
Parse the account from LfpProvider resource.
lfpProviderName
string
A fully-qualified path representing LfpProvider resource.
string | number
{string} A string representing the account.
matchAccountFromOmnichannelSettingName(omnichannelSettingName)
matchAccountFromOmnichannelSettingName
(
omnichannelSettingName
:
string
)
:
string
|
number
;
Parse the account from OmnichannelSetting resource.
omnichannelSettingName
string
A fully-qualified path representing OmnichannelSetting resource.
string | number
{string} A string representing the account.
matchAccountFromOnlineReturnPolicyName(onlineReturnPolicyName)
matchAccountFromOnlineReturnPolicyName
(
onlineReturnPolicyName
:
string
)
:
string
|
number
;
Parse the account from OnlineReturnPolicy resource.
onlineReturnPolicyName
string
A fully-qualified path representing OnlineReturnPolicy resource.
string | number
{string} A string representing the account.
matchAccountFromProgramName(programName)
matchAccountFromProgramName
(
programName
:
string
)
:
string
|
number
;
Parse the account from Program resource.
programName
string
A fully-qualified path representing Program resource.
string | number
{string} A string representing the account.
matchAccountFromRegionName(regionName)
matchAccountFromRegionName
(
regionName
:
string
)
:
string
|
number
;
Parse the account from Region resource.
regionName
string
A fully-qualified path representing Region resource.
string | number
{string} A string representing the account.
matchAccountFromShippingSettingsName(shippingSettingsName)
matchAccountFromShippingSettingsName
(
shippingSettingsName
:
string
)
:
string
|
number
;
Parse the account from ShippingSettings resource.
shippingSettingsName
string
A fully-qualified path representing ShippingSettings resource.
string | number
{string} A string representing the account.
matchAccountFromTermsOfServiceAgreementStateName(termsOfServiceAgreementStateName)
matchAccountFromTermsOfServiceAgreementStateName
(
termsOfServiceAgreementStateName
:
string
)
:
string
|
number
;
Parse the account from TermsOfServiceAgreementState resource.
termsOfServiceAgreementStateName
string
A fully-qualified path representing TermsOfServiceAgreementState resource.
string | number
{string} A string representing the account.
matchAccountFromUserName(userName)
matchAccountFromUserName
(
userName
:
string
)
:
string
|
number
;
Parse the account from User resource.
userName
string
A fully-qualified path representing User resource.
string | number
{string} A string representing the account.
matchEmailFromEmailPreferencesName(emailPreferencesName)
matchEmailFromEmailPreferencesName
(
emailPreferencesName
:
string
)
:
string
|
number
;
Parse the email from EmailPreferences resource.
emailPreferencesName
string
A fully-qualified path representing EmailPreferences resource.
string | number
{string} A string representing the email.
matchEmailFromUserName(userName)
matchEmailFromUserName
(
userName
:
string
)
:
string
|
number
;
Parse the email from User resource.
userName
string
A fully-qualified path representing User resource.
string | number
{string} A string representing the email.
matchGbpAccountFromGbpAccountName(gbpAccountName)
matchGbpAccountFromGbpAccountName
(
gbpAccountName
:
string
)
:
string
|
number
;
Parse the gbp_account from GbpAccount resource.
gbpAccountName
string
A fully-qualified path representing GbpAccount resource.
string | number
{string} A string representing the gbp_account.
matchIdentifierFromTermsOfServiceAgreementStateName(termsOfServiceAgreementStateName)
matchIdentifierFromTermsOfServiceAgreementStateName
(
termsOfServiceAgreementStateName
:
string
)
:
string
|
number
;
Parse the identifier from TermsOfServiceAgreementState resource.
termsOfServiceAgreementStateName
string
A fully-qualified path representing TermsOfServiceAgreementState resource.
string | number
{string} A string representing the identifier.
matchIssueFromAccountIssueName(accountIssueName)
matchIssueFromAccountIssueName
(
accountIssueName
:
string
)
:
string
|
number
;
Parse the issue from AccountIssue resource.
accountIssueName
string
A fully-qualified path representing AccountIssue resource.
string | number
{string} A string representing the issue.
matchLfpProviderFromLfpProviderName(lfpProviderName)
matchLfpProviderFromLfpProviderName
(
lfpProviderName
:
string
)
:
string
|
number
;
Parse the lfp_provider from LfpProvider resource.
lfpProviderName
string
A fully-qualified path representing LfpProvider resource.
string | number
{string} A string representing the lfp_provider.
matchOmnichannelSettingFromLfpProviderName(lfpProviderName)
matchOmnichannelSettingFromLfpProviderName
(
lfpProviderName
:
string
)
:
string
|
number
;
Parse the omnichannel_setting from LfpProvider resource.
lfpProviderName
string
A fully-qualified path representing LfpProvider resource.
string | number
{string} A string representing the omnichannel_setting.
matchOmnichannelSettingFromOmnichannelSettingName(omnichannelSettingName)
matchOmnichannelSettingFromOmnichannelSettingName
(
omnichannelSettingName
:
string
)
:
string
|
number
;
Parse the omnichannel_setting from OmnichannelSetting resource.
omnichannelSettingName
string
A fully-qualified path representing OmnichannelSetting resource.
string | number
{string} A string representing the omnichannel_setting.
matchProgramFromCheckoutSettingsName(checkoutSettingsName)
matchProgramFromCheckoutSettingsName
(
checkoutSettingsName
:
string
)
:
string
|
number
;
Parse the program from CheckoutSettings resource.
checkoutSettingsName
string
A fully-qualified path representing CheckoutSettings resource.
string | number
{string} A string representing the program.
matchProgramFromProgramName(programName)
matchProgramFromProgramName
(
programName
:
string
)
:
string
|
number
;
Parse the program from Program resource.
programName
string
A fully-qualified path representing Program resource.
string | number
{string} A string representing the program.
matchRegionFromRegionName(regionName)
matchRegionFromRegionName
(
regionName
:
string
)
:
string
|
number
;
Parse the region from Region resource.
regionName
string
A fully-qualified path representing Region resource.
string | number
{string} A string representing the region.
matchReturnPolicyFromOnlineReturnPolicyName(onlineReturnPolicyName)
matchReturnPolicyFromOnlineReturnPolicyName
(
onlineReturnPolicyName
:
string
)
:
string
|
number
;
Parse the return_policy from OnlineReturnPolicy resource.
onlineReturnPolicyName
string
A fully-qualified path representing OnlineReturnPolicy resource.
string | number
{string} A string representing the return_policy.
matchTaxFromAccountTaxName(accountTaxName)
matchTaxFromAccountTaxName
(
accountTaxName
:
string
)
:
string
|
number
;
Parse the tax from AccountTax resource.
accountTaxName
string
A fully-qualified path representing AccountTax resource.
string | number
{string} A string representing the tax.
matchVersionFromTermsOfServiceName(termsOfServiceName)
matchVersionFromTermsOfServiceName
(
termsOfServiceName
:
string
)
:
string
|
number
;
Parse the version from TermsOfService resource.
termsOfServiceName
string
A fully-qualified path representing TermsOfService resource.
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.
account
string
omnichannelSetting
string
string
{string} Resource name string.
onlineReturnPolicyPath(account, returnPolicy)
onlineReturnPolicyPath
(
account
:
string
,
returnPolicy
:
string
)
:
string
;
Return a fully-qualified onlineReturnPolicy resource name string.
account
string
returnPolicy
string
string
{string} Resource name string.
programPath(account, program)
programPath
(
account
:
string
,
program
:
string
)
:
string
;
Return a fully-qualified program resource name string.
account
string
program
string
string
{string} Resource name string.
regionPath(account, region)
regionPath
(
account
:
string
,
region
:
string
)
:
string
;
Return a fully-qualified region resource name string.
account
string
region
string
string
{string} Resource name string.
shippingSettingsPath(account)
shippingSettingsPath
(
account
:
string
)
:
string
;
Return a fully-qualified shippingSettings resource name string.
account
string
string
{string} Resource name string.
termsOfServiceAgreementStatePath(account, identifier)
termsOfServiceAgreementStatePath
(
account
:
string
,
identifier
:
string
)
:
string
;
Return a fully-qualified termsOfServiceAgreementState resource name string.
account
string
identifier
string
string
{string} Resource name string.
termsOfServicePath(version)
termsOfServicePath
(
version
:
string
)
:
string
;
Return a fully-qualified termsOfService resource name string.
version
string
string
{string} Resource name string.
userPath(account, email)
userPath
(
account
:
string
,
email
:
string
)
:
string
;
Return a fully-qualified user resource name string.
account
string
email
string
string
{string} Resource name string.
