Documentation

Google_Service_ShoppingContent_Resource_Accounts extends Google_Service_Resource
in package

Application

The "accounts" collection of methods.

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

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
authinfo() : Google_Service_ShoppingContent_AccountsAuthInfoResponse: Returns information about the authenticated user. (accounts.authinfo)
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
claimwebsite() : Google_Service_ShoppingContent_AccountsClaimWebsiteResponse: Claims the website of a Merchant Center sub-account. (accounts.claimwebsite)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
custombatch() : Google_Service_ShoppingContent_AccountsCustomBatchResponse: Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request. (accounts.custombatch)
delete() : mixed: Deletes a Merchant Center sub-account. (accounts.delete)
get() : Google_Service_ShoppingContent_Account: Retrieves a Merchant Center account. (accounts.get)
insert() : Google_Service_ShoppingContent_Account: Creates a Merchant Center sub-account. (accounts.insert)
link() : Google_Service_ShoppingContent_AccountsLinkResponse: Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId. (accounts.link)
listAccounts() : Google_Service_ShoppingContent_AccountsListResponse: Lists the sub-accounts in your Merchant Center account.
listlinks() : Google_Service_ShoppingContent_AccountsListLinksResponse: Returns the list of accounts linked to your Merchant Center account.
update() : Google_Service_ShoppingContent_Account: Updates a Merchant Center account. Any fields that are not provided are deleted from the resource. (accounts.update)
updatelabels() : Google_Service_ShoppingContent_AccountsUpdateLabelsResponse: Updates labels that are assigned to the Merchant Center account by CSS user.
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

authinfo()

Returns information about the authenticated user. (accounts.authinfo)


    public
                authinfo([array<string|int, mixed> $optParams = array() ]) : Google_Service_ShoppingContent_AccountsAuthInfoResponse

Parameters

$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ShoppingContent_AccountsAuthInfoResponse —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

claimwebsite()

Claims the website of a Merchant Center sub-account. (accounts.claimwebsite)


    public
                claimwebsite(string $merchantId, string $accountId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ShoppingContent_AccountsClaimWebsiteResponse

Parameters

$merchantId : string: The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.
$accountId : string: The ID of the account whose website is claimed.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ShoppingContent_AccountsClaimWebsiteResponse —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

custombatch()

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


    public
                custombatch(Google_Service_ShoppingContent_AccountsCustomBatchRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ShoppingContent_AccountsCustomBatchResponse

Parameters

$postBody : Google_Service_ShoppingContent_AccountsCustomBatchRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ShoppingContent_AccountsCustomBatchResponse —

delete()

Deletes a Merchant Center sub-account. (accounts.delete)


    public
                delete(string $merchantId, string $accountId[, array<string|int, mixed> $optParams = array() ]) : mixed

Parameters

$merchantId : string: The ID of the managing account. This must be a multi-client account, and accountId must be the ID of a sub-account of this account.
$accountId : string: The ID of the account.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

get()

Retrieves a Merchant Center account. (accounts.get)


    public
                get(string $merchantId, string $accountId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ShoppingContent_Account

Parameters

$merchantId : string: The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.
$accountId : string: The ID of the account.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ShoppingContent_Account —

insert()

Creates a Merchant Center sub-account. (accounts.insert)


    public
                insert(string $merchantId, Google_Service_ShoppingContent_Account $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ShoppingContent_Account

Parameters

$merchantId : string: The ID of the managing account. This must be a multi-client account.
$postBody : Google_Service_ShoppingContent_Account
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ShoppingContent_Account —

link()

Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId. (accounts.link)


    public
                link(string $merchantId, string $accountId, Google_Service_ShoppingContent_AccountsLinkRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ShoppingContent_AccountsLinkResponse

Parameters

$merchantId : string: The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.
$accountId : string: The ID of the account that should be linked.
$postBody : Google_Service_ShoppingContent_AccountsLinkRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ShoppingContent_AccountsLinkResponse —

listAccounts()

Lists the sub-accounts in your Merchant Center account.


    public
                listAccounts(string $merchantId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ShoppingContent_AccountsListResponse

(accounts.listAccounts)

Parameters

$merchantId : string: The ID of the managing account. This must be a multi-client account.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ShoppingContent_AccountsListResponse —

listlinks()

Returns the list of accounts linked to your Merchant Center account.


    public
                listlinks(string $merchantId, string $accountId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ShoppingContent_AccountsListLinksResponse

(accounts.listlinks)

Parameters

$merchantId : string: The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.
$accountId : string: The ID of the account for which to list links.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ShoppingContent_AccountsListLinksResponse —

update()

Updates a Merchant Center account. Any fields that are not provided are deleted from the resource. (accounts.update)


    public
                update(string $merchantId, string $accountId, Google_Service_ShoppingContent_Account $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ShoppingContent_Account

Parameters

$merchantId : string: The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.
$accountId : string: The ID of the account.
$postBody : Google_Service_ShoppingContent_Account
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ShoppingContent_Account —

updatelabels()

Updates labels that are assigned to the Merchant Center account by CSS user.


    public
                updatelabels(string $merchantId, string $accountId, Google_Service_ShoppingContent_AccountsUpdateLabelsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ShoppingContent_AccountsUpdateLabelsResponse

(accounts.updatelabels)

Parameters

$merchantId : string: The ID of the managing account.
$accountId : string: The ID of the account whose labels are updated.
$postBody : Google_Service_ShoppingContent_AccountsUpdateLabelsRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_ShoppingContent_AccountsUpdateLabelsResponse —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —