Documentation

Google_Service_ManufacturerCenter_Resource_AccountsProducts extends Google_Service_Resource
in package

The "products" collection of methods.

Typical usage is: $manufacturersService = new Google_Service_ManufacturerCenter(...); $products = $manufacturersService->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.
delete()  : Google_Service_ManufacturerCenter_ManufacturersEmpty
Deletes the product from a Manufacturer Center account. (products.delete)
get()  : Google_Service_ManufacturerCenter_Product
Gets the product from a Manufacturer Center account, including product issues. A recently updated product takes around 15 minutes to process.
listAccountsProducts()  : Google_Service_ManufacturerCenter_ListProductsResponse
Lists all the products in a Manufacturer Center account.
update()  : Google_Service_ManufacturerCenter_ManufacturersEmpty
Inserts or updates the attributes of the product in a Manufacturer Center account. Creates a product with the provided attributes. If the product already exists, then all attributes are replaced with the new ones. The checks at upload time are minimal. All required attributes need to be present for a product to be valid. Issues may show up later after the API has accepted a new upload for a product and it is possible to overwrite an existing valid product with an invalid product. To detect this, you should retrieve the product and check it for issues once the new version is available. Uploaded attributes first need to be processed before they can be retrieved. Until then, new products will be unavailable, and retrieval of previously uploaded products will return the original state of the product.
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

delete()

Deletes the product from a Manufacturer Center account. (products.delete)

public delete(string $parent, string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ManufacturerCenter_ManufacturersEmpty
Parameters
$parent : string

Parent ID in the format accounts/{account_id}. account_id - The ID of the Manufacturer Center account.

$name : string

Name in the format {target_country}:{content_language}:{product_id}. target_country - The target country of the product as a CLDR territory code (for example, US). content_language - The content language of the product as a two-letter ISO 639-1 language code (for example, en). product_id - The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id.

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

Optional parameters.

Return values
Google_Service_ManufacturerCenter_ManufacturersEmpty

get()

Gets the product from a Manufacturer Center account, including product issues. A recently updated product takes around 15 minutes to process.

public get(string $parent, string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ManufacturerCenter_Product

Changes are only visible after it has been processed. While some issues may be available once the product has been processed, other issues may take days to appear. (products.get)

Parameters
$parent : string

Parent ID in the format accounts/{account_id}. account_id - The ID of the Manufacturer Center account.

$name : string

Name in the format {target_country}:{content_language}:{product_id}. target_country - The target country of the product as a CLDR territory code (for example, US). content_language - The content language of the product as a two-letter ISO 639-1 language code (for example, en). product_id - The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id.

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

Optional parameters.

Tags
opt_param

string include The information to be included in the response. Only sections listed here will be returned.

Return values
Google_Service_ManufacturerCenter_Product

listAccountsProducts()

Lists all the products in a Manufacturer Center account.

public listAccountsProducts(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ManufacturerCenter_ListProductsResponse

(products.listAccountsProducts)

Parameters
$parent : string

Parent ID in the format accounts/{account_id}. account_id - The ID of the Manufacturer Center account.

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

Optional parameters.

Tags
opt_param

int pageSize Maximum number of product statuses to return in the response, used for paging.

opt_param

string pageToken The token returned by the previous request.

opt_param

string include The information to be included in the response. Only sections listed here will be returned.

Return values
Google_Service_ManufacturerCenter_ListProductsResponse

update()

Inserts or updates the attributes of the product in a Manufacturer Center account. Creates a product with the provided attributes. If the product already exists, then all attributes are replaced with the new ones. The checks at upload time are minimal. All required attributes need to be present for a product to be valid. Issues may show up later after the API has accepted a new upload for a product and it is possible to overwrite an existing valid product with an invalid product. To detect this, you should retrieve the product and check it for issues once the new version is available. Uploaded attributes first need to be processed before they can be retrieved. Until then, new products will be unavailable, and retrieval of previously uploaded products will return the original state of the product.

public update(string $parent, string $name, Google_Service_ManufacturerCenter_Attributes $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_ManufacturerCenter_ManufacturersEmpty

(products.update)

Parameters
$parent : string

Parent ID in the format accounts/{account_id}. account_id - The ID of the Manufacturer Center account.

$name : string

Name in the format {target_country}:{content_language}:{product_id}. target_country - The target country of the product as a CLDR territory code (for example, US). content_language - The content language of the product as a two-letter ISO 639-1 language code (for example, en). product_id - The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id.

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

Optional parameters.

Return values
Google_Service_ManufacturerCenter_ManufacturersEmpty

convertToArrayAndStripNulls()

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

Search results