इस गाइड में बताया गया है कि Merchant API का इस्तेमाल करके, Merchant Center खाते के लिए गैर-ज़रूरी ईमेल से जुड़ी सूचनाएं पाने की सेटिंग कैसे मैनेज की जाती हैं.
ईमेल पाने की आपकी प्राथमिकताएं, आपके पास मौजूद हर Merchant Center खाते के लिए अलग-अलग होती हैं. अगर आपको एक से ज़्यादा खाते मैनेज करने हैं, तो हर खाते के लिए अलग-अलग प्राथमिकताएं सेट अप की जा सकती हैं. Merchant API की मदद से, मौजूदा सेटिंग वापस पाई जा सकती हैं और उन्हें अपडेट किया जा सकता है. Merchant Center इंटरफ़ेस के ज़रिए ईमेल की सेटिंग मैनेज करने के बारे में ज़्यादा जानने के लिए, Merchant Center में ईमेल की सेटिंग बदलना लेख पढ़ें.
Merchant API की मदद से, सिर्फ़ "खबरें और सलाह" वाले ईमेल पाने की प्राथमिकताओं को मैनेज किया जा सकता है.
ध्यान देने वाली खास बातें
- सिर्फ़ पुष्टि किए गए उपयोगकर्ता के लिए: आपको सिर्फ़ उस उपयोगकर्ता खाते के लिए ईमेल पाने की प्राथमिकताओं को पाने या अपडेट करने का विकल्प मिलता है जिसकी पुष्टि एपीआई कॉल के लिए की गई है. आपको इस उपयोगकर्ता का ईमेल पता, अनुरोध के पाथ में (उदाहरण के लिए,
user@email.com
) देना होगा याme
उपनाम का इस्तेमाल करना होगा. - ऐडवांस खाते: अगर आप ऐडवांस खाते के उपयोगकर्ता हैं, तो ईमेल पाने की आपकी प्राथमिकताएं ऐडवांस खाते के लेवल पर सेट की जाती हैं. ये प्राथमिकताएं, ऐडवांस खाते और उसके सभी उप-खातों पर लागू होती हैं. API का इस्तेमाल करते समय, बेहतर खाते के उपयोगकर्ताओं को अपनी प्राथमिकताओं को मैनेज करने के लिए, बेहतर खाते का आईडी डालना होगा.
- सेवा खाते: सेवा खातों को सूचनाएं नहीं मिलती हैं. भले ही, उनके लिए ईमेल पाने की प्राथमिकताएं सेट की गई हों.
UNCONFIRMED
state: ईमेल पाने की प्राथमिकताओं के लिए,UNCONFIRMED
ऑप्ट-इन की स्थिति सिर्फ़ सर्वर सेट कर सकता है. एपीआई का इस्तेमाल करके,UNCONFIRMED
के लिए कोई प्राथमिकता सेट नहीं की जा सकती. इस प्राथमिकता को सेट करने पर, गड़बड़ी होती है.UNCONFIRMED
स्थिति से पता चलता है कि ऑप्ट-इन करने वाले उपयोगकर्ता को पुष्टि करने वाला ईमेल भेजा गया है. हालांकि, उसने अब तक पुष्टि करने वाले लिंक पर क्लिक नहीं किया है.
Merchant Center से मिलने वाले ईमेल की सेटिंग देखना
किसी Merchant Center खाते के लिए, ईमेल सूचना पाने की मौजूदा सेटिंग देखने के लिए, GetEmailPreferences
तरीके का इस्तेमाल करें. आपको अपना Merchant Center खाता आईडी देना होगा. साथ ही, उपयोगकर्ता के लिए ईमेल पते का इस्तेमाल करना होगा या पुष्टि किए गए उपयोगकर्ता को दिखाने के लिए, me
उपनाम का इस्तेमाल करना होगा.
इस अनुरोध से EmailPreferences
संसाधन वापस मिलता है. इससे सूचना की उपलब्ध कैटगरी के लिए, ऑप्ट-इन करने का आपका स्टेटस दिखता है. जैसे, news_and_tips
.
GET https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/users/{EMAIL_ADDRESS}/emailPreferences
अनुरोध स्वीकार किए जाने पर, EmailPreferences
संसाधन दिखता है. इसमें आपकी मौजूदा सेटिंग दिखती हैं.
जवाब का उदाहरण:
{
"name": "accounts/{ACCOUNT_ID}/users/{EMAIL_ADDRESS}/emailPreferences",
"news_and_tips": "OPTED_IN"
}
इस कोड सैंपल में, Merchant Center खाते के लिए ईमेल पाने की सेटिंग को वापस पाने का तरीका दिखाया गया है.
Java
import com.google.api.gax.core.FixedCredentialsProvider;
import com.google.auth.oauth2.GoogleCredentials;
import com.google.shopping.merchant.accounts.v1.EmailPreferences;
import com.google.shopping.merchant.accounts.v1.EmailPreferencesName;
import com.google.shopping.merchant.accounts.v1.EmailPreferencesServiceClient;
import com.google.shopping.merchant.accounts.v1.EmailPreferencesServiceSettings;
import com.google.shopping.merchant.accounts.v1.GetEmailPreferencesRequest;
import shopping.merchant.samples.utils.Authenticator;
import shopping.merchant.samples.utils.Config;
/** This class demonstrates how to get the email preferences of a Merchant Center account. */
public class GetEmailPreferencesSample {
public static void getEmailPreferences(Config config, String email) throws Exception {
// Obtains OAuth token based on the user's configuration.
GoogleCredentials credential = new Authenticator().authenticate();
// Creates service settings using the credentials retrieved above.
EmailPreferencesServiceSettings emailPreferencesServiceSettings =
EmailPreferencesServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(credential))
.build();
// Creates EmailPreferences name to identify the EmailPreferences.
String name =
EmailPreferencesName.newBuilder()
.setAccount(config.getAccountId().toString())
.setEmail(email)
.build()
.toString();
// Calls the API and catches and prints any network failures/errors.
try (EmailPreferencesServiceClient emailPreferencesServiceClient =
EmailPreferencesServiceClient.create(emailPreferencesServiceSettings)) {
// The name has the format: accounts/{account}/users/{user}/emailPreferences
GetEmailPreferencesRequest request =
GetEmailPreferencesRequest.newBuilder().setName(name).build();
System.out.println("Sending get EmailPreferences request:");
EmailPreferences response = emailPreferencesServiceClient.getEmailPreferences(request);
System.out.println("Retrieved EmailPreferences below");
System.out.println(response);
} catch (Exception e) {
System.out.println(e);
}
}
public static void main(String[] args) throws Exception {
Config config = Config.load();
// The email address of this user. If you want to get the user information
// Of the user making the Content API request, you can also use "me" instead
// Of an email address.
String email = "testUser@gmail.com";
// String email = "me";
getEmailPreferences(config, email);
}
}
PHP
use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Accounts\V1\Client\EmailPreferencesServiceClient;
use Google\Shopping\Merchant\Accounts\V1\GetEmailPreferencesRequest;
/**
* This class demonstrates how to get the email preferences of a Merchant Center account.
*/
class GetEmailPreferences
{
/**
* Gets the email preferences of a Merchant Center account.
*
* @param array $config
* The configuration data used for authentication and getting the acccount ID.
* @param string $email The email address of this user. If you want to get the user information
* of the user making the Merchant API request, you can also use "me" instead
* of an email address.
*
* @return void
*/
public static function getEmailPreferencesSample($config, $email): 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.
$emailPreferencesServiceClient = new EmailPreferencesServiceClient($options);
// Creates EmailPreferences name to identify the EmailPreferences.
// The name has the format: accounts/{account}/users/{user}/emailPreferences
$name = "accounts/" . $config['accountId'] . "/users/" . $email . "/emailPreferences";
// Calls the API and catches and prints any network failures/errors.
try {
$request = (new GetEmailPreferencesRequest())
->setName($name);
print "Sending get EmailPreferences request:\n";
$response = $emailPreferencesServiceClient->getEmailPreferences($request);
print "Retrieved EmailPreferences 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();
// The email address of this user. If you want to get the user information
// Of the user making the Merchant API request, you can also use "me" instead
// Of an email address.
// $email = "testUser@gmail.com";
$email = "me";
self::getEmailPreferencesSample($config, $email);
}
}
// Run the script
$sample = new GetEmailPreferences();
$sample->callSample();
Python
from examples.authentication import configuration
from examples.authentication import generate_user_credentials
from google.shopping.merchant_accounts_v1 import EmailPreferencesServiceClient
from google.shopping.merchant_accounts_v1 import GetEmailPreferencesRequest
_ACCOUNT = configuration.Configuration().read_merchant_info()
def get_email_preferences(email_address):
"""Gets the email preferences of a Merchant Center account."""
# Gets OAuth Credentials.
credentials = generate_user_credentials.main()
# Creates a client.
client = EmailPreferencesServiceClient(credentials=credentials)
# Creates EmailPreferences name to identify the EmailPreferences.
name = (
"accounts/" + _ACCOUNT + "/users/" + email_address + "/emailPreferences"
)
# Creates the request.
request = GetEmailPreferencesRequest(name=name)
# Makes the request and catches and prints any error messages.
try:
response = client.get_email_preferences(request=request)
print("Retrieved EmailPreferences below")
print(response)
except RuntimeError as e:
print(e)
if __name__ == "__main__":
# The email address of this user. If you want to get the user information
# Of the user making the Content API request, you can also use "me" instead
# Of an email address.
# email = "testUser@gmail.com"
email = "me"
get_email_preferences(email)
cURL
curl --location \
'https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/users/{EMAIL_ADDRESS}/emailPreferences' \
--header 'Authorization: Bearer <API_TOKEN>'
Merchant Center से मिलने वाले ईमेल की सेटिंग बदलना
ईमेल से सूचना पाने की सेटिंग बदलने के लिए, UpdateEmailPreferences
तरीके का इस्तेमाल करें. जैसे, "खबरें और सलाह" वाले ईमेल पाने के लिए ऑप्ट-इन या ऑप्ट-आउट करना.
अनुरोध में, आपको Merchant Center खाते का आईडी देना होगा. साथ ही, उपयोगकर्ता के ईमेल के लिए, आपको अपना ईमेल पता या me
उपनाम इस्तेमाल करना होगा. अनुरोध के मुख्य हिस्से में, EmailPreferences
ऑब्जेक्ट होना चाहिए. साथ ही, इसमें news_and_tips
फ़ील्ड के लिए चुना गया opt_in_state
होना चाहिए. आपको news_and_tips
क्वेरी पैरामीटर में news_and_tips
भी तय करना होगा, ताकि यह पता चल सके कि आपको किस सेटिंग में बदलाव करना है.update_mask
इस कार्रवाई से, पुष्टि किए गए उपयोगकर्ता के लिए ईमेल पाने की प्राथमिकताओं को अपडेट किया जाता है. ऐसा, Merchant Center के तय किए गए खाते के लिए किया जाता है. उदाहरण के लिए, news_and_tips
को OPTED_OUT
पर सेट करने से, आपको उस खाते के लिए "समाचार और सलाह" वाले ईमेल नहीं मिलेंगे.
PATCH https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/users/{EMAIL_ADDRESS}/emailPreferences?update_mask=news_and_tips
अनुरोध के पेलोड का उदाहरण ("खबरें और सुझाव" से ऑप्ट आउट करने के लिए):
{
"name": "accounts/{ACCOUNT_ID}/users/{EMAIL_ADDRESS}/emailPreferences",
"news_and_tips": "OPTED_OUT"
}
अनुरोध पूरा होने पर, अपडेट किया गया EmailPreferences
संसाधन दिखता है.
जवाब का उदाहरण:
{
"name": "accounts/{ACCOUNT_ID}/users/{EMAIL_ADDRESS}/emailPreferences",
"news_and_tips": "OPTED_OUT"
}
इस कोड के उदाहरण में, Merchant Center खाते के लिए ईमेल पाने की सेटिंग अपडेट करने का तरीका दिखाया गया है. उदाहरण के लिए, "समाचार और सलाह" वाले ईमेल पाने के लिए ऑप्ट-इन करना.
Java
import com.google.api.gax.core.FixedCredentialsProvider;
import com.google.auth.oauth2.GoogleCredentials;
import com.google.protobuf.FieldMask;
import com.google.shopping.merchant.accounts.v1.EmailPreferences;
import com.google.shopping.merchant.accounts.v1.EmailPreferences.OptInState;
import com.google.shopping.merchant.accounts.v1.EmailPreferencesName;
import com.google.shopping.merchant.accounts.v1.EmailPreferencesServiceClient;
import com.google.shopping.merchant.accounts.v1.EmailPreferencesServiceSettings;
import com.google.shopping.merchant.accounts.v1.UpdateEmailPreferencesRequest;
import shopping.merchant.samples.utils.Authenticator;
import shopping.merchant.samples.utils.Config;
/**
* This class demonstrates how to update a EmailPreferences to OPT_IN to News and Tips. This service
* only permits retrieving and updating email preferences for the authenticated user.
*/
public class UpdateEmailPreferencesSample {
public static void updateEmailPreferences(Config config, String email) throws Exception {
GoogleCredentials credential = new Authenticator().authenticate();
EmailPreferencesServiceSettings emailPreferencesServiceSettings =
EmailPreferencesServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(credential))
.build();
// Creates EmailPreferences name to identify EmailPreferences.
String name =
EmailPreferencesName.newBuilder()
.setAccount(config.getAccountId().toString())
.setEmail(email)
.build()
.toString();
// Create a EmailPreferences with the updated fields.
EmailPreferences emailPreferences =
EmailPreferences.newBuilder().setName(name).setNewsAndTips(OptInState.OPTED_IN).build();
FieldMask fieldMask = FieldMask.newBuilder().addPaths("news_and_tips").build();
try (EmailPreferencesServiceClient emailPreferencesServiceClient =
EmailPreferencesServiceClient.create(emailPreferencesServiceSettings)) {
UpdateEmailPreferencesRequest request =
UpdateEmailPreferencesRequest.newBuilder()
.setEmailPreferences(emailPreferences)
.setUpdateMask(fieldMask)
.build();
System.out.println("Sending Update EmailPreferences request");
EmailPreferences response = emailPreferencesServiceClient.updateEmailPreferences(request);
System.out.println("Updated EmailPreferences Name below");
System.out.println(response.getName());
} catch (Exception e) {
System.out.println(e);
}
}
public static void main(String[] args) throws Exception {
Config config = Config.load();
// The email address of this user. If you want to get the user information
// Of the user making the Content API request, you can also use "me" instead
// Of an email address.
// String email = "testUser@gmail.com";
String email = "me";
updateEmailPreferences(config, email);
}
}
PHP
use Google\ApiCore\ApiException;
use Google\Protobuf\FieldMask;
use Google\Shopping\Merchant\Accounts\V1\Client\EmailPreferencesServiceClient;
use Google\Shopping\Merchant\Accounts\V1\EmailPreferences;
use Google\Shopping\Merchant\Accounts\V1\EmailPreferences\OptInState;
use Google\Shopping\Merchant\Accounts\V1\UpdateEmailPreferencesRequest;
/**
* This class demonstrates how to update a EmailPreferences to OPT_IN to News and Tips. This service
* only permits retrieving and updating email preferences for the authenticated user.
*/
class UpdateEmailPreferences
{
/**
* Updates email preferences to OPT_IN to News and Tips.
*
* @param array $config
* The configuration data used for authentication and getting the acccount ID.
* @param string $email The email address of this user. If you want to get the user information
* of the user making the Merchant API request, you can also use "me" instead
* of an email address.
*
* @return void
*/
public static function updateEmailPreferencesSample($config, $email): 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.
$emailPreferencesServiceClient = new EmailPreferencesServiceClient($options);
// Creates EmailPreferences name to identify the EmailPreferences.
// The name has the format: accounts/{account}/users/{user}/emailPreferences
$name = "accounts/" . $config['accountId'] . "/users/" . $email . "/emailPreferences";
// Create a EmailPreferences with the updated fields.
$emailPreferences = (new EmailPreferences())
->setName($name)
->setNewsAndTips(OptInState::OPTED_OUT);
$fieldMask = (new FieldMask())
->setPaths(['news_and_tips']);
try {
$request = (new UpdateEmailPreferencesRequest())
->setEmailPreferences($emailPreferences)
->setUpdateMask($fieldMask);
print "Sending Update EmailPreferences request\n";
$response = $emailPreferencesServiceClient->updateEmailPreferences($request);
print "Updated EmailPreferences Name below\n";
print $response->getName() . "\n";
} catch (ApiException $e) {
print $e->getMessage();
}
}
/**
* Helper to execute the sample.
*
* @return void
*/
public function callSample(): void
{
$config = Config::generateConfig();
// The email address of this user. If you want to get the user information
// Of the user making the Merchant API request, you can also use "me" instead
// Of an email address.
// $email = "testUser@gmail.com";
$email = "me";
self::updateEmailPreferencesSample($config, $email);
}
}
// Run the script
$sample = new UpdateEmailPreferences();
$sample->callSample();
Python
from examples.authentication import configuration
from examples.authentication import generate_user_credentials
from google.protobuf import field_mask_pb2
from google.shopping.merchant_accounts_v1 import EmailPreferences
from google.shopping.merchant_accounts_v1 import EmailPreferencesServiceClient
from google.shopping.merchant_accounts_v1 import UpdateEmailPreferencesRequest
FieldMask = field_mask_pb2.FieldMask
_ACCOUNT = configuration.Configuration().read_merchant_info()
def update_email_preferences(email_address):
"""Updates a EmailPreferences to OPT_IN to News and Tips."""
# Gets OAuth Credentials.
credentials = generate_user_credentials.main()
# Creates a client.
client = EmailPreferencesServiceClient(credentials=credentials)
# Creates EmailPreferences name to identify EmailPreferences.
name = (
"accounts/" + _ACCOUNT + "/users/" + email_address + "/emailPreferences"
)
# Create a EmailPreferences with the updated fields.
email_preferences = EmailPreferences(
name=name, news_and_tips=EmailPreferences.OptInState.OPTED_IN
)
# Create field mask
field_mask = FieldMask(paths=["news_and_tips"])
# Creates the request.
request = UpdateEmailPreferencesRequest(
email_preferences=email_preferences, update_mask=field_mask
)
# Makes the request and catches and prints any error messages.
try:
response = client.update_email_preferences(request=request)
print("Updated EmailPreferences Name below")
print(response.name)
except RuntimeError as e:
print(e)
if __name__ == "__main__":
# The email address of this user. If you want to get the user information
# of the user making the Content API request, you can also use "me" instead
# of an email address.
# email = "testUser@gmail.com"
email = "me"
update_email_preferences(email)
cURL
curl --location --request PATCH \
'https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/users/{EMAIL_ADDRESS}/emailPreferences?update_mask=news_and_tips' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <API_TOKEN>' \
--data '{
"name": "accounts/{ACCOUNT_ID}/users/{EMAIL_ADDRESS}/emailPreferences",
"news_and_tips": "OPTED_IN"
}'