Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
Google_Service_ShoppingContent_Accounts_Resource Class Reference

The "accounts" collection of methods. More...

Inheritance diagram for Google_Service_ShoppingContent_Accounts_Resource:
Google_Service_Resource

Public Member Functions

 authinfo ($optParams=array())
 Returns information about the authenticated user.
 
 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 custombatch (Google_Service_ShoppingContent_AccountsCustomBatchRequest $postBody, $optParams=array())
 Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.
 
 delete ($merchantId, $accountId, $optParams=array())
 Deletes a Merchant Center sub-account.
 
 get ($merchantId, $accountId, $optParams=array())
 Retrieves a Merchant Center account.
 
 insert ($merchantId, Google_Service_ShoppingContent_Account $postBody, $optParams=array())
 Creates a Merchant Center sub-account.
 
 listAccounts ($merchantId, $optParams=array())
 Lists the sub-accounts in your Merchant Center account.
 
 patch ($merchantId, $accountId, Google_Service_ShoppingContent_Account $postBody, $optParams=array())
 Updates a Merchant Center account.
 
 update ($merchantId, $accountId, Google_Service_ShoppingContent_Account $postBody, $optParams=array())
 Updates a Merchant Center account.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "accounts" collection of methods.

Typical usage is: $contentService = new Google_Service_ShoppingContent(...); $accounts = $contentService->accounts;

Member Function Documentation

◆ authinfo()

Google_Service_ShoppingContent_Accounts_Resource::authinfo ( $optParams = array())

Returns information about the authenticated user.

(accounts.authinfo)

Parameters
array$optParamsOptional parameters.
Return values
Google_Service_ShoppingContent_AccountsAuthInfoResponse

◆ call()

Google_Service_Resource::call ( $name,
$arguments,
$expected_class = null )
inherited

TODO: This function needs simplifying.

Parameters
$name
$arguments
$expected_class- optional, the expected class name
Return values
Google_Http_Request|expected_class
Exceptions
Google_Exception

◆ custombatch()

Google_Service_ShoppingContent_Accounts_Resource::custombatch ( Google_Service_ShoppingContent_AccountsCustomBatchRequest $postBody,
$optParams = array() )

Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.

(accounts.custombatch)

Parameters
Google_AccountsCustomBatchRequest$postBody
array$optParamsOptional parameters.

@opt_param bool dryRun Flag to run the request in dry-run mode.

Return values
Google_Service_ShoppingContent_AccountsCustomBatchResponse

◆ delete()

Google_Service_ShoppingContent_Accounts_Resource::delete ( $merchantId,
$accountId,
$optParams = array() )

Deletes a Merchant Center sub-account.

(accounts.delete)

Parameters
string$merchantIdThe ID of the managing account.
string$accountIdThe ID of the account.
array$optParamsOptional parameters.

@opt_param bool dryRun Flag to run the request in dry-run mode.

◆ get()

Google_Service_ShoppingContent_Accounts_Resource::get ( $merchantId,
$accountId,
$optParams = array() )

Retrieves a Merchant Center account.

(accounts.get)

Parameters
string$merchantIdThe ID of the managing account.
string$accountIdThe ID of the account.
array$optParamsOptional parameters.
Return values
Google_Service_ShoppingContent_Account

◆ insert()

Google_Service_ShoppingContent_Accounts_Resource::insert ( $merchantId,
Google_Service_ShoppingContent_Account $postBody,
$optParams = array() )

Creates a Merchant Center sub-account.

(accounts.insert)

Parameters
string$merchantIdThe ID of the managing account.
Google_Account$postBody
array$optParamsOptional parameters.

@opt_param bool dryRun Flag to run the request in dry-run mode.

Return values
Google_Service_ShoppingContent_Account

◆ listAccounts()

Google_Service_ShoppingContent_Accounts_Resource::listAccounts ( $merchantId,
$optParams = array() )

Lists the sub-accounts in your Merchant Center account.

(accounts.listAccounts)

Parameters
string$merchantIdThe ID of the managing account.
array$optParamsOptional parameters.

@opt_param string pageToken The token returned by the previous request. @opt_param string maxResults The maximum number of accounts to return in the response, used for paging.

Return values
Google_Service_ShoppingContent_AccountsListResponse

◆ patch()

Google_Service_ShoppingContent_Accounts_Resource::patch ( $merchantId,
$accountId,
Google_Service_ShoppingContent_Account $postBody,
$optParams = array() )

Updates a Merchant Center account.

This method supports patch semantics. (accounts.patch)

Parameters
string$merchantIdThe ID of the managing account.
string$accountIdThe ID of the account.
Google_Account$postBody
array$optParamsOptional parameters.

@opt_param bool dryRun Flag to run the request in dry-run mode.

Return values
Google_Service_ShoppingContent_Account

◆ update()

Google_Service_ShoppingContent_Accounts_Resource::update ( $merchantId,
$accountId,
Google_Service_ShoppingContent_Account $postBody,
$optParams = array() )

Updates a Merchant Center account.

(accounts.update)

Parameters
string$merchantIdThe ID of the managing account.
string$accountIdThe ID of the account.
Google_Account$postBody
array$optParamsOptional parameters.

@opt_param bool dryRun Flag to run the request in dry-run mode.

Return values
Google_Service_ShoppingContent_Account

The documentation for this class was generated from the following file: