AdWords और Merchant Center उप-खाते बनाना और उन्हें लिंक करना

1. परिचय

इस कोडलैब में, आपको Shopping के लिए Content API और AdWords API के साथ काम करने की कुछ बुनियादी बातें जानने को मिलेंगी. साथ ही, आपको एक ऐसा ऐप्लिकेशन बनाने का तरीका भी बताया जाएगा जो इन दोनों का इस्तेमाल करता है. खास तौर पर, आपको एक कमांड-लाइन ऐप्लिकेशन बनाना होगा. यह ऐप्लिकेशन, AdWords और Merchant Center खाते बनाएगा और उन्हें लिंक करेगा.

आपको क्या सीखने को मिलेगा

  • मैनेजर खाते से मैनेज किए जाने वाले AdWords खाते बनाने का तरीका.
  • एक से ज़्यादा क्लाइंट वाले खाते से मैनेज किए जाने वाले Merchant Center खाते बनाने का तरीका.
  • Merchant Center खाते को AdWords खाते से लिंक करने का अनुरोध कैसे करें.
  • AdWords खाते में, Merchant Center खाते को लिंक करने के लंबित अनुरोध को स्वीकार करने का तरीका.

आपको इन चीज़ों की ज़रूरत होगी

2. सेट अप करना

code डाउनलोड करें

इस कोडलैब के लिए पूरा कोड डाउनलोड करने के लिए, यहां दिए गए लिंक पर क्लिक करें:

डाउनलोड की गई ज़िप फ़ाइल को अनपैक करें. इससे एक रूट फ़ोल्डर (shopping-account-linking-master) अनपैक होगा. इसमें एक Maven प्रोजेक्ट के साथ-साथ वे सभी संसाधन शामिल होंगे जिनकी आपको ज़रूरत होगी. यहां दी गई सबडायरेक्ट्री पर खास ध्यान दें:

  • src/main/java, Maven प्रोजेक्ट का सोर्स रूट है. इसमें आपके काम करने के लिए कोड का स्ट्रक्चर मौजूद है.
  • src/main/java/solution में पूरा समाधान शामिल है.

ज़रूरी पैकेज इंस्टॉल करना और बनाना

अगर Eclipse या IntelliJ जैसे Maven-aware IDE का इस्तेमाल किया जा रहा है, तो निकाले गए फ़ोल्डर को Maven प्रोजेक्ट के तौर पर इंपोर्ट किया जा सकता है. इसके बाद, प्रोजेक्ट को सामान्य तरीके से कंपाइल किया जा सकता है.

अगर कमांड लाइन से Maven का इस्तेमाल किया जा रहा है, तो ज़रूरी पैकेज पाने और अनपैक किए गए प्रोजेक्ट (shopping-account-linking-master) के रूट फ़ोल्डर से प्रोजेक्ट को कंपाइल करने के लिए, यह कमांड चलाएं:

mvn compile

3. पुष्टि करने की सुविधा सेट अप करना

इस चरण में, हम कोई कोडिंग नहीं करेंगे. हालांकि, हम ऐसी फ़ाइलें सेट अप करेंगे जिनमें AdWords API और Content API for Shopping के लिए सही पुष्टि करने वाले टोकन शामिल हों.

AdWords API के लिए प्रमाणीकरण सेट अप करना

यह कोडलैब, क्लाइंट लाइब्रेरी की तरह ही क्रेडेंशियल लोड करने की सुविधा का इस्तेमाल करता है. इसलिए, अगर आपने अपने मैनेजर खाते के साथ Google Ads API की Java क्लाइंट लाइब्रेरी का इस्तेमाल पहले ही कर लिया है, तो आपको इसे सेट अप करने की ज़रूरत नहीं है. इसके अलावा, Java के लिए Google Ads API की क्लाइंट लाइब्रेरी का इस्तेमाल शुरू करने के लिए, पहले से तीसरे चरण तक दिया गया तरीका अपनाएं.

Content API के लिए पुष्टि करने की सुविधा सेट अप करना

अगर आपके पास पहले से सेवा खाते की कुंजी नहीं है, तो:

  1. एक से ज़्यादा क्लाइंट वाले खाते के लिए, Merchant Center पर जाएं. इसके बाद, ओवरफ़्लो मेन्यू से Content API को चुनें: 89507d635c51a3dc.png
  2. पुष्टि करें को चुनें. इसके बाद, नीले रंग के + बटन पर क्लिक करें: c465d8dc314ec158.png
  3. Google Cloud Platform और Google APIs की सेवा की शर्तों को स्वीकार करने के बाद, आपका ब्राउज़र अपने-आप एक JSON फ़ाइल डाउनलोड करेगा. इसमें आपके नए सेवा खाते की कुंजी होगी.

अब सेवा खाते की मदद से, शॉपिंग के सैंपल के लिए पुष्टि करने की सुविधा सेट अप करने के निर्देशों का पालन करें. इसका मतलब है कि आपकी होम डायरेक्ट्री में, सेवा खाते की कुंजी की कॉपी इस पाथ पर होनी चाहिए: shopping-samples/content/service-account.json. आपको सैंपल कॉन्फ़िगरेशन सेट अप करने की ज़रूरत नहीं है. हालांकि, अगर आपको इस कोडलैब को पूरा करने के बाद सैंपल आज़माने हैं, तो आपको ऐसा करना होगा!

इसे आज़माएं

अब जब आपके पास सही जगहों पर पुष्टि करने वाले टोकन हैं, तो सैंपल चलाने की कोशिश करें. अगर कमांड लाइन पर Maven का इस्तेमाल किया जा रहा है, तो ये कमांड चलाएं:

mvn compile

mvn exec:java -Dexec.mainClass="SolutionRunner"

अगर आपको सेशन ऑब्जेक्ट उपलब्ध न होने से जुड़ी गड़बड़ी का मैसेज मिलता है, तो इसका मतलब है कि आपके पुष्टि करने वाले टोकन सही जगह पर हैं और ठीक से काम कर रहे हैं! अगर ऐसा नहीं होता है, तो आपको गड़बड़ी का जो मैसेज मिलता है उससे पता चलना चाहिए कि कौनसे क्रेडेंशियल काम नहीं कर रहे हैं और किस फ़ाइल को ठीक करना है.

4. एपीआई से कनेक्ट करना

अब आपके पास उन दो एपीआई के लिए मान्य पुष्टि करने वाले टोकन हैं जिनका हम इस्तेमाल करेंगे. इसलिए, आइए अब कोड लिखना शुरू करें. हम पुष्टि करने वाले टोकन का इस्तेमाल करके, सेशन ऑब्जेक्ट बनाने से शुरुआत करेंगे. बाद के चरणों में, हम इन सेशन ऑब्जेक्ट का इस्तेमाल करके, हर एपीआई की ओर से उपलब्ध कराई गई अलग-अलग सेवाओं और तरीकों को ऐक्सेस करेंगे.

Content API सेशन ऑब्जेक्ट बनाना

Content API सेशन बनाने के लिए, हम एक ShoppingContent.Builder ऑब्जेक्ट बनाएंगे. इसके बाद, इसका इस्तेमाल करके सही ShoppingContent ऑब्जेक्ट बनाएंगे. खुशी की बात यह है कि पहले वाले को बनाने के लिए ज़रूरी सभी चीज़ें, कोड के स्ट्रक्चर में पहले से मौजूद हैं. इसलिए, हमें बस उन्हें इस तरह से एक साथ रखना है:

SolutionRunner.java

// TODO(sessions): Create a ShoppingContent object using ShoppingContent.Builder.
contentApiSession =
    new ShoppingContent.Builder(httpTransport, jsonFactory, contentApiCredential)
        .setApplicationName("Linking AdWords and Merchant Center Accounts Codelab")
        .build();

ऐप्लिकेशन का नाम सेट करना ज़रूरी नहीं है. हालांकि, इससे यह पता चलता है कि build() मेथड को कॉल करने से पहले, ShoppingContent.Builder ऑब्जेक्ट के ज़रिए कोई भी विकल्प कैसे सेट किया जाए.

AdWords API सेशन ऑब्जेक्ट बनाना

इसी तरह, AdWordsSession ऑब्जेक्ट बनाने के लिए, AdWordsSession.Builder क्लास होती है. यहां मुख्य अंतर यह है कि बिल्डर पर सीधे तौर पर कॉन्फ़िगरेशन के विकल्प सेट करने के बजाय, हम fromFile() तरीके का इस्तेमाल करके उन्हें ads.properties फ़ाइल से लोड करेंगे. इस फ़ाइल को हमने पिछले चरण में सेट अप किया था.

SolutionRunner.java

// TODO(sessions): Create a AdWordsSession object using AdWordsSession.Builder.
adWordsSession =
    new AdWordsSession.Builder()
        .fromFile()
        .withOAuth2Credential(adwordsOAuth2Credential)
        .build();

इसे आज़माएं

अगर आपको Maven प्रोजेक्ट को कमांड लाइन से चलाना है, तो हम उसे फिर से बनाने और चलाने के लिए, पिछले सेक्शन में इस्तेमाल की गई कमांड का ही इस्तेमाल करेंगे:

mvn compile

mvn exec:java -Dexec.mainClass="SolutionRunner"

इस बार, आपको कोई गड़बड़ी नहीं मिलेगी. हालांकि, आपको कोई दिलचस्प आउटपुट भी नहीं मिलेगा. नए खाते बनाने और उन्हें लिंक करने के लिए, एपीआई कॉल करते समय हम इस जानकारी को जोड़ देंगे.

5. मैनेज किया जाने वाला नया AdWords खाता बनाना

अब हमने अपने एपीआई सेशन ऑब्जेक्ट बना लिए हैं. इसके बाद, हम उन खातों को बनाएंगे जिन्हें हमें लिंक करना है. हम AdWords से शुरुआत करेंगे और अपने मैनेजर खाते में एक टेस्ट खाता बनाएंगे.

ManagedCustomerService को ऐक्सेस करना

AdWords API में, उपलब्ध अलग-अलग सेवाओं को ऐक्सेस करने के लिए, हम सबसे पहले स्टैटिक getInstance() तरीके का इस्तेमाल करके, AdWordsServices क्लास का इंस्टेंस वापस पाते हैं. इसके बाद, इस इंस्टेंस का इस्तेमाल करके, उन सेवाओं के लिए क्लाइंट बनाए जा सकते हैं. इसके लिए, get() तरीके का इस्तेमाल किया जाता है. इसमें दो आर्ग्युमेंट होते हैं: वह सेशन जिसके लिए क्लाइंट बनाना है और वह इंटरफ़ेस जिसके लिए सेवा चाहिए.

SolutionRunner.java

// TODO(newAWaccount): Using the ManagedCustomerService, create a new testing AdWords account
// under the given manager account.

AdWordsServicesInterface adWordsServices = AdWordsServices.getInstance();

ManagedCustomerServiceInterface managedCustomerService =
    adWordsServices.get(adWordsSession, ManagedCustomerServiceInterface.class);

यहां हम ManagedCustomerService को ऐक्सेस करते हैं. इससे हमें किसी मैनेजर खाते से AdWords "ग्राहकों" (खातों) को मैनेज करने की अनुमति मिलती है.

खाते की नई सेटिंग तय करना

सबसे पहले, हम एक ManagedCustomer ऑब्जेक्ट बनाएंगे. इसमें हमारे नए खाते की सेटिंग शामिल होंगी. हम इस कोडलैब के लिए एक टेस्ट खाता बनाएंगे. इसमें मुद्रा के तौर पर डॉलर और टाइम ज़ोन के तौर पर अमेरिका के पश्चिमी तट का टाइम ज़ोन सेट किया जाएगा.

SolutionRunner.java

Random rand = new Random();
long run = rand.nextLong();

ManagedCustomer newAdWordsAccount = new ManagedCustomer();
newAdWordsAccount.setName(String.format("AdWords Account Created by Run %d", run));
newAdWordsAccount.setTestAccount(true);
newAdWordsAccount.setCurrencyCode("USD");
newAdWordsAccount.setDateTimeZone("America/Los_Angeles");

हम एक रैंडम नंबर भी बनाते हैं, जिसे हम खाते के नाम में शामिल करते हैं. ऐसा इसलिए किया जा रहा है, ताकि हम यहां बनाए गए AdWords खाते को बाद में बनाए जाने वाले Merchant Center खाते से मैच कर सकें. इससे, हमारा समाधान पूरा होने के बाद हम उनकी जांच कर पाएंगे और यह पक्का कर पाएंगे कि दोनों खाते लिंक हो गए हैं.

मैनेज किया जाने वाला नया खाता बनाना

नया खाता बनाने के लिए, हम ManagedCustomerOperation का इस्तेमाल करके, ADD ऑपरेशन के बारे में बताएंगे:

SolutionRunner.java

ManagedCustomerOperation operation = new ManagedCustomerOperation();
operation.setOperand(newAdWordsAccount);
operation.setOperator(Operator.ADD);

इसके बाद, हम mutate() ऑब्जेक्ट के mutate() तरीके का इस्तेमाल करके कार्रवाई करेंगे.ManagedCustomerService इस तरीके में, कई कार्रवाइयों को एक साथ किया जा सकता है. हालांकि, हमें यहां सिर्फ़ एक कार्रवाई करनी है. mutate() तरीके का नतीजा, ManagedCustomer की सूची वाली वैल्यू होती है. यहां, यह सूची एक ग्राहक की होगी, जो हमने नया खाता बनाया है. हम उस नए खाते का आईडी, आने वाले समय में इस्तेमाल करने के लिए वापस पा लेंगे. साथ ही, हम उसे प्रिंट भी करेंगे, ताकि हम उसे अपने समाधान के आउटपुट के तौर पर देख सकें.

SolutionRunner.java

ManagedCustomerReturnValue result =
    managedCustomerService.mutate(new ManagedCustomerOperation[] {operation});
Long adWordsId = result.getValue()[0].getCustomerId();
System.out.printf("Created new AdWords account %d%n", adWordsId);

इसे आज़माएं

पहले की तरह, समाधान को चलाने की कोशिश करें. अगर कमांड लाइन से Maven का इस्तेमाल किया जा रहा है, तो:

mvn compile

mvn exec:java -Dexec.mainClass="SolutionRunner"

अगर सब कुछ ठीक रहा, तो आपको अब भी कोई गड़बड़ी नहीं दिखेगी. इस बार, हमें बनाए गए नए AdWords खाते का आईडी दिखेगा. अपने मैनेजर खाते के लिए AdWords साइट देखें. आपको वहां नया खाता भी दिखेगा!

6. नया Merchant Center उप-खाता बनाना

इस चरण में, हम Merchant Center का वह उप-खाता बनाएंगे जिसे हम पिछले चरण में बनाए गए AdWords खाते से लिंक करेंगे. उप-खाता बनाने के बाद, लिंक करने का अनुरोध अलग से करने के बजाय, हम खाता बनाते समय ही लिंक करने का अनुरोध कर सकते हैं. ऐसा इसलिए, क्योंकि हमारे पास संबंधित AdWords खाते का आईडी पहले से मौजूद होता है.

नए उप-खाते के लिए सेटिंग तय करना

AdWords API के उलट, Account मॉडल क्लास के सेटर ऑब्जेक्ट दिखाते हैं. इसलिए, हम नए Account ऑब्जेक्ट पर अपने कॉल को उनसे जोड़ सकते हैं. हम AdWords खाता बनाते समय जनरेट किए गए रैंडम नंबर का इस्तेमाल, नए Merchant Center खाते के नाम के तौर पर भी करेंगे.

SolutionRunner.java

Account newMcAccount = new Account()
    .setName(String.format("Merchant Center Account Created by Run %d", run))
    .setAdwordsLinks(
        ImmutableList.of(
            new AccountAdwordsLink()
                .setAdwordsId(BigInteger.valueOf(adWordsId))
                .setStatus("active")));

इस चरण की जानकारी में बताया गया है कि हमारे पास पहले से ही नए मैनेज किए जा रहे खाते का AdWords आईडी है. इसलिए, अब हम उस आईडी को नए उप-खाते के लिए AdwordsLinks की सूची में जोड़ सकते हैं. नया उप-खाता बनने पर, इस लिंक का अनुरोध अपने-आप हो जाएगा. साथ ही, यह AdWords API में उपलब्ध होगा.

नया उप-खाता बनाना

Content API में, Accounts सेवा को ऐक्सेस करने के लिए, हम सेशन ऑब्जेक्ट के accounts() तरीके को कॉल करते हैं. इसके बाद, ऑपरेशन ऑब्जेक्ट सेट अप करने के बजाय, सीधे insert() तरीके को कॉल करते हैं. इस तरीके में दो आर्ग्युमेंट होते हैं: एक से ज़्यादा क्लाइंट वाले उस खाते का आईडी जिसके तहत नया उप-खाता बनाना है. दूसरा, Account ऑब्जेक्ट, जिसमें ज़रूरी सेटिंग होती हैं:

SolutionRunner.java

newMcAccount = contentApiSession.accounts().insert(mcaId, newMcAccount).execute();

System.out.printf("Created new Merchant Center account %s%n", newMcAccount.getId());

insert() तरीका, एक Account ऑब्जेक्ट दिखाता है. इस ऑब्जेक्ट में, नए उप-खाते की सेटिंग होती हैं. हम अपने ओरिजनल Account ऑब्जेक्ट को बदल देते हैं, क्योंकि जवाब में मिली जानकारी में एक अहम जानकारी शामिल होती है: नए उप-खाते का आईडी. हम इसे अपने समाधान के आउटपुट में प्रिंट करते हैं, ताकि हम अपने समाधान को चला सकें. इसके बाद, यह पुष्टि कर सकें कि Merchant Center में नया उप-खाता मौजूद है.

इसे आज़माएं

पहले की तरह, समाधान को चलाने की कोशिश करें. अगर कमांड लाइन से Maven का इस्तेमाल किया जा रहा है, तो:

mvn compile

mvn exec:java -Dexec.mainClass="SolutionRunner"

अगर सब कुछ ठीक रहा, तो आपको अब भी कोई गड़बड़ी नहीं दिखेगी. हालांकि, इस बार हमें नए AdWords खाते और नए Merchant Center खाते, दोनों के आईडी दिखेंगे. अपने एक से ज़्यादा क्लाइंट वाले खाते के Merchant Center में जाकर देखें कि नया उप-खाता वहां दिख रहा है या नहीं.

7. AdWords खाते से मिले लिंक को स्वीकार करना

पिछले चरण में, हमने एक नया Merchant Center उप-खाता बनाया था. साथ ही, हमने अपने नए AdWords खाते से लिंक करने का अनुरोध किया था. इस चरण में, हम AdWords API का इस्तेमाल करके, लिंक करने के अनुरोध को स्वीकार करेंगे.

CustomerService को ऐक्सेस करना

पहले की तरह, हम AdWordsServices क्लास का इस्तेमाल करके CustomerService के लिए क्लाइंट पाएंगे. हालांकि, क्लाइंट खाता बनाने से पहले, हम अपने AdWords सेशन ऑब्जेक्ट को बदल देते हैं, ताकि आने वाले समय में मैनेजर खाते के बजाय नए मैनेज किए जा रहे खाते का इस्तेमाल किया जा सके. ऐसा इसलिए, क्योंकि Merchant Center खाते ने मैनेज किए जा रहे खाते से लिंक करने का अनुरोध किया था, न कि मैनेजर खाते से.

SolutionRunner.java

// TODO(acceptLink): Using the mutateServiceLinks method in CustomerService, accept the
// proposed link between the new AdWords account and the new Merchant Center account.

adWordsSession.setClientCustomerId(adWordsId.toString());

CustomerServiceInterface customerService =
    adWordsServices.get(adWordsSession, CustomerServiceInterface.class);

जैसे, जब हमने नया AdWords खाता बनाया था, तब हम एक ServiceLink ऑब्जेक्ट बनाएंगे. इसमें लिंक करने की सेटिंग शामिल होंगी. इसके बाद, हम एक ServiceLinkOperation ऑब्जेक्ट बनाएंगे. इसमें ज़रूरी कार्रवाई के बारे में जानकारी होगी. यहां हमें MERCHANT_CENTER खाते से सेवा लिंक करने का अनुरोध स्वीकार करना है और SET को ACTIVE पर सेट करना है. serviceLinkId सेटिंग के लिए, हम अभी बनाए गए Merchant Center खाते के आईडी का इस्तेमाल करेंगे. ऐसा इसलिए, क्योंकि इसका इस्तेमाल AdWords में सेवा लिंक के आईडी के लिए किया जाता है.

SolutionRunner.java

ServiceLink serviceLink = new ServiceLink();
serviceLink.setServiceLinkId(newMcAccount.getId().longValue());
serviceLink.setLinkStatus(ServiceLinkLinkStatus.ACTIVE);
serviceLink.setServiceType(ServiceType.MERCHANT_CENTER);

ServiceLinkOperation op = new ServiceLinkOperation();
op.setOperator(Operator.SET);
op.setOperand(serviceLink);

आखिर में, हम कार्रवाई करने के लिए CustomerService ऑब्जेक्ट के mutateServiceLinks() तरीके को कॉल करेंगे. पहले की तरह, यह सेवा लिंक करने की कार्रवाइयों की एक सरणी लेता है. इस बार, यह तरीका सीधे तौर पर सेवा के लिंक की सूची दिखाता है. इसमें बदलाव भी हो सकता है. इसलिए, हम उस सूची पर लूप करके, अपने समाधान का नतीजा प्रिंट करेंगे. ज़ाहिर है, हमने सिर्फ़ एक ऑपरेशन तय किया है. इसलिए, आपको आउटपुट में सिर्फ़ एक लिंक मिलने की उम्मीद है.

SolutionRunner.java

ServiceLink[] mutatedServiceLinks =
    customerService.mutateServiceLinks(new ServiceLinkOperation[] {op});
for (ServiceLink mutatedServiceLink : mutatedServiceLinks) {
  System.out.printf(
      "Service link with service link ID %d, type '%s' updated to status: %s.%n",
      mutatedServiceLink.getServiceLinkId(),
      mutatedServiceLink.getServiceType(),
      mutatedServiceLink.getLinkStatus());
}

इसे आज़माएं

पहले की तरह, समाधान को चलाने की कोशिश करें. अगर कमांड लाइन से Maven का इस्तेमाल किया जा रहा है, तो:

mvn compile

mvn exec:java -Dexec.mainClass="SolutionRunner"

अगर सब कुछ ठीक रहा, तो आपको अब भी कोई गड़बड़ी नहीं दिखेगी. साथ ही, इस बार हमें यह सूचना भी दिखेगी कि सेवा के लिंक को चालू करने के लिए अपडेट किया गया है. AdWords और Merchant Center में जाकर देखें कि खाते लिंक हो गए हैं या नहीं.

8. किसी थीम के वैरिएशन

कोडलैब पूरा करने के लिए बधाई! अब आपके पास पूरी तरह से काम करने वाला समाधान है. आइए, कुछ ऐसे उदाहरण देखें जिनसे आपको यह पता चलेगा कि इस कोडलैब में बताए गए ज़्यादा से ज़्यादा एपीआई का इस्तेमाल करने के लिए, आपको समाधान में क्या बदलाव करने चाहिए या उसे कैसे बढ़ाना चाहिए.

कोड लैब में, हमने सबसे पहले AdWords खाता बनाया था, ताकि Merchant Center खाता बनाते समय हम इसकी जानकारी का इस्तेमाल करके लिंक करने का अनुरोध कर सकें. हालांकि, अगर Merchant Center खाता पहले से मौजूद है, तो आपको इसके कॉन्फ़िगरेशन को अपडेट करना होगा. Merchant Center खाता बनाने के लिए, अपने कोड में बदलाव करें. इसके बाद, AdWords खाता बनाने के बाद वापस जाएं और लिंक करने का अनुरोध करने के लिए, इसके कॉन्फ़िगरेशन को अपडेट करें.

फ़िलहाल, ऐप्लिकेशन सिर्फ़ एपीआई कॉल में गड़बड़ियों के न होने को सफलता का संकेत मानता है. उदाहरण को बढ़ाकर, नए Merchant Center और AdWords खातों के लिए लिंक की जानकारी देखें. साथ ही, यह देखें कि लिंक चालू है या नहीं.

आपके लिए कुछ भी नामुमकिन नहीं है

अगर आपको लगता है कि कुछ और बदलाव किए जा सकते हैं, तो उन्हें आज़माएं! अगर आपको अपने आइडिया के लिए रेफ़रंस कोड चाहिए, तो Google Shopping के सैंपल और Google Ads Java क्लाइंट लाइब्रेरी सोर्स में मौजूद examples डायरेक्ट्री देखें.