Claim an homepage

  // Copyright 2024 Google LLC 
 // 
 // Licensed under the Apache License, Version 2.0 (the "License"); 
 // you may not use this file except in compliance with the License. 
 // You may obtain a copy of the License at 
 // 
 //     https://www.apache.org/licenses/LICENSE-2.0 
 // 
 // Unless required by applicable law or agreed to in writing, software 
 // distributed under the License is distributed on an "AS IS" BASIS, 
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
 // See the License for the specific language governing permissions and 
 // limitations under the License. 
 package 
  
 shopping.merchant.samples.accounts.homepages.v1 
 ; 
 import 
  
 com.google.api.gax.core.FixedCredentialsProvider 
 ; 
 import 
  
 com.google.auth.oauth2.GoogleCredentials 
 ; 
 import 
  
 com.google.shopping.merchant.accounts.v1.ClaimHomepageRequest 
 ; 
 import 
  
 com.google.shopping.merchant.accounts.v1.Homepage 
 ; 
 import 
  
 com.google.shopping.merchant.accounts.v1.HomepageName 
 ; 
 import 
  
 com.google.shopping.merchant.accounts.v1.HomepageServiceClient 
 ; 
 import 
  
 com.google.shopping.merchant.accounts.v1.HomepageServiceSettings 
 ; 
 import 
  
 shopping.merchant.samples.utils.Authenticator 
 ; 
 import 
  
 shopping.merchant.samples.utils.Config 
 ; 
 /** This class demonstrates how to claim the homepage for a given Merchant Center account. */ 
 public 
  
 class 
 ClaimHomepageSample 
  
 { 
  
 // Executing this method requires admin access. 
  
 public 
  
 static 
  
 void 
  
 claimHomepage 
 ( 
 Config 
  
 config 
 ) 
  
 throws 
  
 Exception 
  
 { 
  
 // Obtains OAuth token based on the user's configuration. 
  
 GoogleCredentials 
  
 credential 
  
 = 
  
 new 
  
 Authenticator 
 (). 
 authenticate 
 (); 
  
 // Creates service settings using the credentials retrieved above. 
  
 HomepageServiceSettings 
  
 homepageServiceSettings 
  
 = 
  
 HomepageServiceSettings 
 . 
 newBuilder 
 () 
  
 . 
 setCredentialsProvider 
 ( 
 FixedCredentialsProvider 
 . 
 create 
 ( 
 credential 
 )) 
  
 . 
 build 
 (); 
  
 // Creates Homepage name to identify Homepage. 
  
 // The name has the format: accounts/{account}/homepage 
  
 String 
  
 name 
  
 = 
  
 HomepageName 
 . 
 newBuilder 
 (). 
 setAccount 
 ( 
 config 
 . 
 getAccountId 
 (). 
 toString 
 ()). 
 build 
 (). 
 toString 
 (); 
  
 // Calls the API and catches and prints any network failures/errors. 
  
 try 
  
 ( 
 HomepageServiceClient 
  
 homepageServiceClient 
  
 = 
  
 HomepageServiceClient 
 . 
 create 
 ( 
 homepageServiceSettings 
 )) 
  
 { 
  
 ClaimHomepageRequest 
  
 request 
  
 = 
  
 ClaimHomepageRequest 
 . 
 newBuilder 
 (). 
 setName 
 ( 
 name 
 ). 
 build 
 (); 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "Sending Claim Homepage request:" 
 ); 
  
 // If the homepage is already claimed, this will recheck the 
  
 // verification (unless the merchant is exempt 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 lose an existing 
  
 // claim. In case of failure, a canonical error message will be returned: 
  
 //    * PERMISSION_DENIED: user doesn't have the necessary permissions on this 
  
 //    MC account; 
  
 //    * FAILED_PRECONDITION: 
  
 //      - The account is not a Merchant Center account; 
  
 //      - MC account doesn't have a homepage; 
  
 //      - claiming failed (in this case the error message will contain more 
  
 //      details). 
  
 Homepage 
  
 response 
  
 = 
  
 homepageServiceClient 
 . 
 claimHomepage 
 ( 
 request 
 ); 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "Retrieved Homepage below" 
 ); 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 response 
 ); 
  
 } 
  
 catch 
  
 ( 
 Exception 
  
 e 
 ) 
  
 { 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 e 
 ); 
  
 } 
  
 } 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
 String 
 [] 
  
 args 
 ) 
  
 throws 
  
 Exception 
  
 { 
  
 Config 
  
 config 
  
 = 
  
 Config 
 . 
 load 
 (); 
  
 claimHomepage 
 ( 
 config 
 ); 
  
 } 
 } 
 
  ClaimHomepageSample 
 . 
 java 
 
 
 

 < ?php 
 /** 
 * Copyright 2025 Google LLC 
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); 
 * you may not use this file except in compliance with the License. 
 * You may obtain a copy of the License at 
 * 
 *     https://www.apache.org/licenses/LICENSE-2.0 
 * 
 * Unless required by applicable law or agreed to in writing, software 
 * distributed under the License is distributed on an "AS IS" BASIS, 
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
 * See the License for the specific language governing permissions and 
 * limitations under the License. 
 */ 
 require_once __DIR__ . '/../../../../vendor/autoload.php'; 
 require_once __DIR__ . '/../../../Authentication/Authentication.php'; 
 require_once __DIR__ . '/../../../Authentication/Config.php'; 
 use Google\ApiCore\ApiException; 
 use Google\Shopping\Merchant\Accounts\V1\ClaimHomepageRequest; 
 use Google\Shopping\Merchant\Accounts\V1\Client\HomepageServiceClient; 
 /** 
 * This class demonstrates how to claim the homepage for a given Merchant Center account. 
 */ 
 class ClaimHomepage 
 { 
 /** 
 * Claims the homepage for a given Merchant Center account. 
 * 
 * @param array $config The configuration data for authentication and account ID. 
 * @return void 
 * @throws ApiException if the API call fails. 
 */ 
 public static function claimHomepageSample(array $config): void 
 { 
 // Gets the OAuth credentials to make the request. 
 $credentials = Authentication::useServiceAccountOrTokenFile(); 
 // Creates options config containing credentials for the client to use. 
 $options = ['credentials' => $credentials]; 
 // Creates a client. 
 $homepageServiceClient = new HomepageServiceClient($options); 
 // Creates Homepage name to identify Homepage. 
 // The name has the format: accounts/{account}/homepage 
 $name = "accounts/" . $config['accountId'] . "/homepage"; 
 // Calls the API and catches and prints any network failures/errors. 
 try { 
 $request = new ClaimHomepageRequest(['name' => $name]); 
 print "Sending Claim Homepage request:\n"; 
 $response = $homepageServiceClient->claimHomepage($request); 
 print "Retrieved Homepage below\n"; 
 print_r($response); 
 } catch (ApiException $e) { 
 print $e->getMessage(); 
 } 
 } 
 /** 
 * Helper to execute the sample. 
 * 
 * @return void 
 */ 
 public function callSample(): void 
 { 
 $config = Config::generateConfig(); 
 // Makes the call to claim the homepage. 
 self::claimHomepageSample($config); 
 } 
 } 
 // Run the script 
 $sample = new ClaimHomepage(); 
 $sample->callSample(); 
 
  ClaimHomepageSample.php 
 
 
 

  # -*- coding: utf-8 -*- 
 # Copyright 2024 Google LLC 
 # 
 # Licensed under the Apache License, Version 2.0 (the "License"); 
 # you may not use this file except in compliance with the License. 
 # You may obtain a copy of the License at 
 # 
 #     http://www.apache.org/licenses/LICENSE-2.0 
 # 
 # Unless required by applicable law or agreed to in writing, software 
 # distributed under the License is distributed on an "AS IS" BASIS, 
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
 # See the License for the specific language governing permissions and 
 # limitations under the License. 
 """A module to claim a Homepage.""" 
 from 
  
 examples.authentication 
  
 import 
 configuration 
 from 
  
 examples.authentication 
  
 import 
 generate_user_credentials 
 from 
  
 google.shopping.merchant_accounts_v1 
  
 import 
 ClaimHomepageRequest 
 from 
  
 google.shopping.merchant_accounts_v1 
  
 import 
 HomepageServiceClient 
 _ACCOUNT 
 = 
 configuration 
 . 
 Configuration 
 () 
 . 
 read_merchant_info 
 () 
 def 
  
 claim_homepage 
 (): 
  
 """Claims the homepage for a given Merchant Center account.""" 
 # Gets OAuth Credentials. 
 credentials 
 = 
 generate_user_credentials 
 . 
 main 
 () 
 # Creates a client. 
 client 
 = 
 HomepageServiceClient 
 ( 
 credentials 
 = 
 credentials 
 ) 
 # Creates Homepage name to identify Homepage. 
 name 
 = 
 "accounts/" 
 + 
 _ACCOUNT 
 + 
 "/homepage" 
 # Creates the request. 
 request 
 = 
 ClaimHomepageRequest 
 ( 
 name 
 = 
 name 
 ) 
 # Makes the request and catches and prints any error messages. 
 try 
 : 
 response 
 = 
 client 
 . 
 claim_homepage 
 ( 
 request 
 = 
 request 
 ) 
 print 
 ( 
 "Retrieved Homepage below" 
 ) 
 print 
 ( 
 response 
 ) 
 except 
 RuntimeError 
 as 
 e 
 : 
 print 
 ( 
 e 
 ) 
 if 
 __name__ 
 == 
 "__main__" 
 : 
 claim_homepage 
 () 
 
  claim_homepage_sample 
 . 
 py