The service facilitates the management of a merchant's Google Business Profile (GBP) account settings. This API defines the following resource model: - v1
Package
@google-shopping/accountsConstructors
(constructor)(opts, gaxInstance)
constructor
(
opts
?:
ClientOptions
,
gaxInstance
?:
typeof
gax
|
typeof
gax
.
fallback
);
Construct an instance of GbpAccountsServiceClient.
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 GbpAccountsServiceClient({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
;
gbpAccountsServiceStub
gbpAccountsServiceStub
?:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
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.
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.
accountRelationshipPath(account, relationship)
accountRelationshipPath
(
account
:
string
,
relationship
:
string
)
:
string
;
Return a fully-qualified accountRelationship resource name string.
account
string
relationship
string
string
{string} Resource name string.
accountServicePath(account, service)
accountServicePath
(
account
:
string
,
service
:
string
)
:
string
;
Return a fully-qualified accountService resource name string.
account
string
service
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.
developerRegistrationPath(account)
developerRegistrationPath
(
account
:
string
)
:
string
;
Return a fully-qualified developerRegistration resource name string.
account
string
string
{string} Resource name string.
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.
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.
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.
linkGbpAccount(request, options)
linkGbpAccount
(
request
?:
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1
.
ILinkGbpAccountRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1
.
ILinkGbpAccountResponse
,
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1
.
ILinkGbpAccountRequest
|
undefined
,
{}
|
undefined
]>;
Link the specified merchant to a GBP account for all countries.
To run this method, you must have admin access to the Merchant Center account. If you don't have admin access, the request fails with the error message User is not an administrator of account {ACCOUNT_ID}
.
request
options
Promise
<[ protos.google.shopping.merchant.accounts.v1.ILinkGbpAccountResponse
, protos.google.shopping.merchant.accounts.v1.ILinkGbpAccountRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing LinkGbpAccountResponse . 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 parent resource to which the GBP account is
* linked. Format: `accounts/{account}`.
*/
// const parent = 'abc123'
/**
* Required. The email address of the Business Profile account.
*/
// const gbpEmail = 'abc123'
// Imports the Accounts library
const
{
GbpAccountsServiceClient
}
=
require
(
' @google-shopping/accounts
'
).
v1
;
// Instantiates a client
const
accountsClient
=
new
GbpAccountsServiceClient
();
async
function
callLinkGbpAccount
()
{
// Construct request
const
request
=
{
parent
,
gbpEmail
,
};
// Run request
const
response
=
await
accountsClient
.
linkGbpAccount
(
request
);
console
.
log
(
response
);
}
callLinkGbpAccount
();
linkGbpAccount(request, options, callback)
linkGbpAccount
(
request
:
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1
.
ILinkGbpAccountRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
shopping
.
merchant
.
accounts
.
v1
.
ILinkGbpAccountResponse
,
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1
.
ILinkGbpAccountRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.shopping.merchant.accounts.v1.ILinkGbpAccountResponse
, protos.google.shopping.merchant.accounts.v1.ILinkGbpAccountRequest
| null | undefined, {} | null | undefined>
void
linkGbpAccount(request, callback)
linkGbpAccount
(
request
:
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1
.
ILinkGbpAccountRequest
,
callback
:
Callback<protos
.
google
.
shopping
.
merchant
.
accounts
.
v1
.
ILinkGbpAccountResponse
,
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1
.
ILinkGbpAccountRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.shopping.merchant.accounts.v1.ILinkGbpAccountResponse
, protos.google.shopping.merchant.accounts.v1.ILinkGbpAccountRequest
| null | undefined, {} | null | undefined>
void
listGbpAccounts(request, options)
listGbpAccounts
(
request
?:
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1
.
IListGbpAccountsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1
.
IGbpAccount
[],
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1
.
IListGbpAccountsRequest
|
null
,
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1
.
IListGbpAccountsResponse
]>;
List the GBP accounts for a given merchant.
request
options
Promise
<[ protos.google.shopping.merchant.accounts.v1.IGbpAccount
[], protos.google.shopping.merchant.accounts.v1.IListGbpAccountsRequest
| null, protos.google.shopping.merchant.accounts.v1.IListGbpAccountsResponse
]>
{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 listGbpAccountsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listGbpAccounts(request, options, callback)
listGbpAccounts
(
request
:
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1
.
IListGbpAccountsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
shopping
.
merchant
.
accounts
.
v1
.
IListGbpAccountsRequest
,
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1
.
IListGbpAccountsResponse
|
null
|
undefined
,
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1
.
IGbpAccount
> )
:
void
;
request
options
CallOptions
callback
void
listGbpAccounts(request, callback)
listGbpAccounts
(
request
:
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1
.
IListGbpAccountsRequest
,
callback
:
PaginationCallback<protos
.
google
.
shopping
.
merchant
.
accounts
.
v1
.
IListGbpAccountsRequest
,
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1
.
IListGbpAccountsResponse
|
null
|
undefined
,
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1
.
IGbpAccount
> )
:
void
;
request
callback
void
listGbpAccountsAsync(request, options)
listGbpAccountsAsync
(
request
?:
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1
.
IListGbpAccountsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
shopping
.
merchant
.
accounts
.
v1
.
IGbpAccount
> ;
Equivalent to listGbpAccounts
, 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.v1.IGbpAccount
>
{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 parent resource under which the GBP accounts are
* listed. Format: `accounts/{account}`.
*/
// const parent = 'abc123'
/**
* Optional. The maximum number of `GbpAccount` resources to return. The
* service returns fewer than this value if the number of gbp accounts is less
* that than the `pageSize`. The default value is 50. The maximum value is
* 1000; If a value higher than the maximum is specified, then the `pageSize`
* will default to the maximum.
*/
// const pageSize = 1234
/**
* Optional. A page token, received from a previous `ListGbpAccounts` call.
* Provide the page token to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListGbpAccounts` must
* match the call that provided the page token.
*/
// const pageToken = 'abc123'
// Imports the Accounts library
const
{
GbpAccountsServiceClient
}
=
require
(
' @google-shopping/accounts
'
).
v1
;
// Instantiates a client
const
accountsClient
=
new
GbpAccountsServiceClient
();
async
function
callListGbpAccounts
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
accountsClient
.
listGbpAccountsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListGbpAccounts
();
listGbpAccountsStream(request, options)
listGbpAccountsStream
(
request
?:
protos
.
google
.
shopping
.
merchant
.
accounts
.
v1
.
IListGbpAccountsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to listGbpAccounts
, 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 listGbpAccountsAsync()
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.
matchAccountFromAccountRelationshipName(accountRelationshipName)
matchAccountFromAccountRelationshipName
(
accountRelationshipName
:
string
)
:
string
|
number
;
Parse the account from AccountRelationship resource.
accountRelationshipName
string
A fully-qualified path representing AccountRelationship resource.
string | number
{string} A string representing the account.
matchAccountFromAccountServiceName(accountServiceName)
matchAccountFromAccountServiceName
(
accountServiceName
:
string
)
:
string
|
number
;
Parse the account from AccountService resource.
accountServiceName
string
A fully-qualified path representing AccountService 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.
matchAccountFromDeveloperRegistrationName(developerRegistrationName)
matchAccountFromDeveloperRegistrationName
(
developerRegistrationName
:
string
)
:
string
|
number
;
Parse the account from DeveloperRegistration resource.
developerRegistrationName
string
A fully-qualified path representing DeveloperRegistration 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.
matchRelationshipFromAccountRelationshipName(accountRelationshipName)
matchRelationshipFromAccountRelationshipName
(
accountRelationshipName
:
string
)
:
string
|
number
;
Parse the relationship from AccountRelationship resource.
accountRelationshipName
string
A fully-qualified path representing AccountRelationship resource.
string | number
{string} A string representing the relationship.
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.
matchServiceFromAccountServiceName(accountServiceName)
matchServiceFromAccountServiceName
(
accountServiceName
:
string
)
:
string
|
number
;
Parse the service from AccountService resource.
accountServiceName
string
A fully-qualified path representing AccountService resource.
string | number
{string} A string representing the service.
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.
