# Google Shopping Merchant Accounts V1 Client - Class HomepageServiceClient (1.4.1)

1.4.1 (latest) 1.4.0 1.3.1 1.2.2 1.1.0 1.0.0 0.10.0 0.9.1 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.3 0.2.0 0.1.0 Reference documentation and code samples for the Google Shopping Merchant Accounts V1 Client class HomepageServiceClient.

Service Description: Service to support an API for a store's homepage.

This class provides the ability to make remote calls to the backing service through method
calls that map to API methods.

Many parameters require resource names to be formatted in a particular way. To
assist with these names, this class includes a format method for each type of
name, and additionally a parseName method to extract the individual identifiers
contained within formatted names that are returned by the API.

## Namespace

Google \\ Shopping \\ Merchant \\ Accounts \\ V1 \\ Client

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `options` | `array|https://docs.cloud.google.com/php/docs/reference/gax/latest/Options.ClientOptions.html` Optional. Options for configuring the service API wrapper. |
| `↳ apiEndpoint` | `string` The address of the API remote host. May optionally include the port, formatted as " |
| `↳ credentials` | `https://docs.cloud.google.com/php/docs/reference/auth/latest/FetchAuthTokenInterface.html|https://docs.cloud.google.com/php/docs/reference/gax/latest/CredentialsWrapper.html` This option should only be used with a pre-constructed [Google\\Auth\\FetchAuthTokenInterface](https://docs.cloud.google.com/php/docs/reference/auth/latest/FetchAuthTokenInterface.html) or [Google\\ApiCore\\CredentialsWrapper](https://docs.cloud.google.com/php/docs/reference/gax/latest/CredentialsWrapper.html) object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. **Important** : If you are providing a path to a credentials file, or a decoded credentials file as a PHP array, this usage is now DEPRECATED. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. It is recommended to create the credentials explicitly `use Google\Auth\Credentials\ServiceAccountCredentials; use Google\Shopping\Merchant\Accounts\V1\HomepageServiceClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new HomepageServiceClient(['credentials' => $creds]);` <https://cloud.google.com/docs/authentication/external/externally-sourced-credentials> |
| `↳ credentialsConfig` | `array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see [Google\\ApiCore\\CredentialsWrapper::build()](https://docs.cloud.google.com/php/docs/reference/gax/latest/CredentialsWrapper.html#_Google_ApiCore_CredentialsWrapper__build__) . |
| `↳ disableRetries` | `bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`. |
| `↳ clientConfig` | `string|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
| `↳ transport` | `string|https://docs.cloud.google.com/php/docs/reference/gax/latest/Transport.TransportInterface.html` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. *Advanced usage* : Additionally, it is possible to pass in an already instantiated [Google\\ApiCore\\Transport\\TransportInterface](https://docs.cloud.google.com/php/docs/reference/gax/latest/Transport.TransportInterface.html) object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored. |
| `↳ transportConfig` | `array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = \[ 'grpc' =\> \[...\], 'rest' =\> \[...\], \]; See the [Google\\ApiCore\\Transport\\GrpcTransport::build()](https://docs.cloud.google.com/php/docs/reference/gax/latest/Transport.GrpcTransport.html#_Google_ApiCore_Transport_GrpcTransport__build__) and [Google\\ApiCore\\Transport\\RestTransport::build()](https://docs.cloud.google.com/php/docs/reference/gax/latest/Transport.RestTransport.html#_Google_ApiCore_Transport_RestTransport__build__) methods for the supported options. |
| `↳ clientCertSource` | `callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
| `↳ logger` | `false|Psr\Log\LoggerInterface` A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag |
| `↳ universeDomain` | `string` The service domain for the client. Defaults to 'googleapis.com'. |

### claimHomepage

Claims a store's homepage. Executing this method requires admin access.

If the homepage is already claimed, this will recheck the
verification (unless the business is exempted from claiming, which also
exempts from verification) and return a successful response. If ownership
can no longer be verified, it will return an error, but it won't clear the
claim.

In case of failure, a canonical error message is returned:

- PERMISSION_DENIED: User doesn't have the necessary permissions on this
  Merchant Center account.

- FAILED_PRECONDITION:

- The account is not a Merchant Center account.

- Merchant Center account doesn't have a homepage.

- Claiming failed (in this case the error message contains more
  details).

The async variant is [HomepageServiceClient::claimHomepageAsync()](https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1.Client.HomepageServiceClient#_Google_Shopping_Merchant_Accounts_V1_Client_HomepageServiceClient__claimHomepageAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1.ClaimHomepageRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1.Homepage` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Shopping\Merchant\Accounts\V1\ClaimHomepageRequest;
    use Google\Shopping\Merchant\Accounts\V1\Client\HomepageServiceClient;
    use Google\Shopping\Merchant\Accounts\V1\Homepage;

    /**
     * @param string $formattedName The name of the homepage to claim.
     *                              Format: `accounts/{account}/homepage`
     *                              Please see {@see HomepageServiceClient::homepageName()} for help formatting this field.
     */
    function claim_homepage_sample(string $formattedName): void
    {
        // Create a client.
        $homepageServiceClient = new HomepageServiceClient();

        // Prepare the request message.
        $request = (new ClaimHomepageRequest())
            ->setName($formattedName);

        // Call the API and handle any network failures.
        try {
            /** @var Homepage $response */
            $response = $homepageServiceClient->claimHomepage($request);
            printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
        } catch (ApiException $ex) {
            printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
        }
    }

    /**
     * Helper to execute the sample.
     *
     * This sample 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.
     *  - It may require specifying regional endpoints when creating the service client,
     *    please see the apiEndpoint client configuration option for more details.
     */
    function callSample(): void
    {
        $formattedName = HomepageServiceClient::homepageName('[ACCOUNT]');

        claim_homepage_sample($formattedName);
    }

### getHomepage

Retrieves a store's homepage.

The async variant is [HomepageServiceClient::getHomepageAsync()](https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1.Client.HomepageServiceClient#_Google_Shopping_Merchant_Accounts_V1_Client_HomepageServiceClient__getHomepageAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1.GetHomepageRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1.Homepage` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Shopping\Merchant\Accounts\V1\Client\HomepageServiceClient;
    use Google\Shopping\Merchant\Accounts\V1\GetHomepageRequest;
    use Google\Shopping\Merchant\Accounts\V1\Homepage;

    /**
     * @param string $formattedName The name of the homepage to retrieve.
     *                              Format: `accounts/{account}/homepage`
     *                              Please see {@see HomepageServiceClient::homepageName()} for help formatting this field.
     */
    function get_homepage_sample(string $formattedName): void
    {
        // Create a client.
        $homepageServiceClient = new HomepageServiceClient();

        // Prepare the request message.
        $request = (new GetHomepageRequest())
            ->setName($formattedName);

        // Call the API and handle any network failures.
        try {
            /** @var Homepage $response */
            $response = $homepageServiceClient->getHomepage($request);
            printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
        } catch (ApiException $ex) {
            printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
        }
    }

    /**
     * Helper to execute the sample.
     *
     * This sample 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.
     *  - It may require specifying regional endpoints when creating the service client,
     *    please see the apiEndpoint client configuration option for more details.
     */
    function callSample(): void
    {
        $formattedName = HomepageServiceClient::homepageName('[ACCOUNT]');

        get_homepage_sample($formattedName);
    }

### unclaimHomepage

Unclaims a store's homepage. Executing this method requires admin access.

The async variant is [HomepageServiceClient::unclaimHomepageAsync()](https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1.Client.HomepageServiceClient#_Google_Shopping_Merchant_Accounts_V1_Client_HomepageServiceClient__unclaimHomepageAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1.UnclaimHomepageRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1.Homepage` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Shopping\Merchant\Accounts\V1\Client\HomepageServiceClient;
    use Google\Shopping\Merchant\Accounts\V1\Homepage;
    use Google\Shopping\Merchant\Accounts\V1\UnclaimHomepageRequest;

    /**
     * @param string $formattedName The name of the homepage to unclaim.
     *                              Format: `accounts/{account}/homepage`
     *                              Please see {@see HomepageServiceClient::homepageName()} for help formatting this field.
     */
    function unclaim_homepage_sample(string $formattedName): void
    {
        // Create a client.
        $homepageServiceClient = new HomepageServiceClient();

        // Prepare the request message.
        $request = (new UnclaimHomepageRequest())
            ->setName($formattedName);

        // Call the API and handle any network failures.
        try {
            /** @var Homepage $response */
            $response = $homepageServiceClient->unclaimHomepage($request);
            printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
        } catch (ApiException $ex) {
            printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
        }
    }

    /**
     * Helper to execute the sample.
     *
     * This sample 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.
     *  - It may require specifying regional endpoints when creating the service client,
     *    please see the apiEndpoint client configuration option for more details.
     */
    function callSample(): void
    {
        $formattedName = HomepageServiceClient::homepageName('[ACCOUNT]');

        unclaim_homepage_sample($formattedName);
    }

### updateHomepage

Updates a store's homepage. Executing this method requires admin access.

The async variant is [HomepageServiceClient::updateHomepageAsync()](https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1.Client.HomepageServiceClient#_Google_Shopping_Merchant_Accounts_V1_Client_HomepageServiceClient__updateHomepageAsync__) .

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1.UpdateHomepageRequest` A request to house fields associated with the call. |
| `callOptions` | `array` Optional. |
| `↳ retrySettings` | `https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html|array` Retry settings to use for this call. Can be a [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) object, or an associative array of retry settings parameters. See the documentation on [Google\\ApiCore\\RetrySettings](https://docs.cloud.google.com/php/docs/reference/gax/latest/RetrySettings.html) for example usage. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1.Homepage` |   |

**Example**

    use Google\ApiCore\ApiException;
    use Google\Shopping\Merchant\Accounts\V1\Client\HomepageServiceClient;
    use Google\Shopping\Merchant\Accounts\V1\Homepage;
    use Google\Shopping\Merchant\Accounts\V1\UpdateHomepageRequest;

    /**
     * @param string $homepageUri The URI (typically a URL) of the store's homepage.
     */
    function update_homepage_sample(string $homepageUri): void
    {
        // Create a client.
        $homepageServiceClient = new HomepageServiceClient();

        // Prepare the request message.
        $homepage = (new Homepage())
            ->setUri($homepageUri);
        $request = (new UpdateHomepageRequest())
            ->setHomepage($homepage);

        // Call the API and handle any network failures.
        try {
            /** @var Homepage $response */
            $response = $homepageServiceClient->updateHomepage($request);
            printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
        } catch (ApiException $ex) {
            printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
        }
    }

    /**
     * Helper to execute the sample.
     *
     * This sample 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.
     *  - It may require specifying regional endpoints when creating the service client,
     *    please see the apiEndpoint client configuration option for more details.
     */
    function callSample(): void
    {
        $homepageUri = '[URI]';

        update_homepage_sample($homepageUri);
    }

### claimHomepageAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1.ClaimHomepageRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1.Homepage>` |   |

### getHomepageAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1.GetHomepageRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1.Homepage>` |   |

### unclaimHomepageAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1.UnclaimHomepageRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1.Homepage>` |   |

### updateHomepageAsync

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1.UpdateHomepageRequest` |
| `optionalArgs` | `array` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html<https://docs.cloud.google.com/php/docs/reference/shopping-merchant-accounts/latest/V1.Homepage>` |   |

### static::homepageName

Formats a string containing the fully-qualified path to represent a homepage
resource.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `account` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` | The formatted homepage resource. |

### static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported:
Template: Pattern

- homepage: accounts/{account}/homepage

The optional $template argument can be supplied to specify a particular pattern,
and must match one of the templates listed above. If no $template argument is
provided, or if the $template argument does not match one of the templates
listed, then parseName will check each of the supported templates, and return
the first match.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `formattedName` | `string` The formatted name string |
| `template` | `?string` Optional name of template to match |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `array` | An associative array from name component IDs to component values. |