Documentation

Google_Service_ShoppingContent_Resource_Products extends Google_Service_Resource
in package

The "products" collection of methods.

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

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
custombatch()  : Google_Service_ShoppingContent_ProductsCustomBatchResponse
Retrieves, inserts, and deletes multiple products in a single request.
delete()  : mixed
Deletes a product from your Merchant Center account. (products.delete)
get()  : Google_Service_ShoppingContent_Product
Retrieves a product from your Merchant Center account. (products.get)
insert()  : Google_Service_ShoppingContent_Product
Uploads a product to your Merchant Center account. If an item with the same channel, contentLanguage, offerId, and targetCountry already exists, this method updates that entry. (products.insert)
listProducts()  : Google_Service_ShoppingContent_ProductsListResponse
Lists the products in your Merchant Center account. The response might contain fewer items than specified by maxResults. Rely on nextPageToken to determine if there are more items to be requested. (products.listProducts)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$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'))

Methods

__construct()

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

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
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass

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>
Tags
static
Return values
string

$requestUrl

custombatch()

Retrieves, inserts, and deletes multiple products in a single request.

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

(products.custombatch)

Parameters
$postBody : Google_Service_ShoppingContent_ProductsCustomBatchRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_ShoppingContent_ProductsCustomBatchResponse

delete()

Deletes a product from your Merchant Center account. (products.delete)

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

The ID of the account that contains the product. This account cannot be a multi-client account.

$productId : string

The REST ID of the product.

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

Optional parameters.

Tags
opt_param

string feedId The Content API Supplemental Feed ID.

Return values
mixed

get()

Retrieves a product from your Merchant Center account. (products.get)

public get(string $merchantId, string $productId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ShoppingContent_Product
Parameters
$merchantId : string

The ID of the account that contains the product. This account cannot be a multi-client account.

$productId : string

The REST ID of the product.

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

Optional parameters.

Return values
Google_Service_ShoppingContent_Product

insert()

Uploads a product to your Merchant Center account. If an item with the same channel, contentLanguage, offerId, and targetCountry already exists, this method updates that entry. (products.insert)

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

The ID of the account that contains the product. This account cannot be a multi-client account.

$postBody : Google_Service_ShoppingContent_Product
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string feedId The Content API Supplemental Feed ID.

Return values
Google_Service_ShoppingContent_Product

listProducts()

Lists the products in your Merchant Center account. The response might contain fewer items than specified by maxResults. Rely on nextPageToken to determine if there are more items to be requested. (products.listProducts)

public listProducts(string $merchantId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ShoppingContent_ProductsListResponse
Parameters
$merchantId : string

The ID of the account that contains the products. This account cannot be a multi-client account.

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

Optional parameters.

Tags
opt_param

string maxResults The maximum number of products to return in the response, used for paging.

opt_param

string pageToken The token returned by the previous request.

Return values
Google_Service_ShoppingContent_ProductsListResponse

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed

Search results