कॉन्फ़िगरेशन

Google Ads API क्लाइंट लाइब्रेरी में कई कॉन्फ़िगरेशन सेटिंग होती हैं. इनका इस्तेमाल करके, लाइब्रेरी के काम करने के तरीके को पसंद के मुताबिक बनाया जा सकता है.

रनटाइम पर लाइब्रेरी कॉन्फ़िगर करें

क्लाइंट लाइब्रेरी को कॉन्फ़िगर करने का पसंदीदा तरीका यह है कि रनटाइम के दौरान GoogleAdsConfig ऑब्जेक्ट को शुरू करें:

GoogleAdsConfig config = new GoogleAdsConfig()
{
    DeveloperToken = "******",
    OAuth2Mode = OAuth2Flow.APPLICATION,
    OAuth2ClientId = "******.apps.googleusercontent.com",
    OAuth2ClientSecret = "******",
    OAuth2RefreshToken = "******"
};

GoogleAdsClient client = new GoogleAdsClient(config);

कॉन्फ़िगरेशन के दूसरे विकल्प

हम क्लाइंट लाइब्रेरी को कॉन्फ़िगर करने के कुछ और विकल्प भी देते हैं: उन्हें चालू करने के लिए, अपने प्रोजेक्ट के Google.Ads.GoogleAds.Extensions पैकेज में Nuget का रेफ़रंस जोड़ें.

अगर इनमें से किसी एक विकल्प का इस्तेमाल किया जाता है, तो कॉन्फ़िगरेशन सेटिंग अपने-आप नहीं होतीं: आपको उन्हें नीचे बताए गए तरीके से साफ़ तौर पर लोड करना होगा.

App.config का इस्तेमाल करके कॉन्फ़िगर करें

Google Ads API की सभी सेटिंग, App.config फ़ाइल के GoogleAdsApi नोड में सेव की जाती हैं. App.config का सामान्य कॉन्फ़िगरेशन यहां दिया गया है:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <configSections>
    <section name="GoogleAdsApi" type="System.Configuration.DictionarySectionHandler" />
  </configSections>
  <GoogleAdsApi>
    <!-- Set the service timeout in milliseconds. -->
    <add key="Timeout" value="2000" />

    <!-- Proxy settings for library. -->
    <add key="ProxyServer" value="http://localhost:8888"/>
    <add key="ProxyUser" value=""/>
    <add key="ProxyPassword" value=""/>
    <add key="ProxyDomain" value=""/>

    <!-- API-specific settings -->
    <add key="DeveloperToken" value="******"/>

    <!-- OAuth2 settings -->
    <add key = "OAuth2Mode" value="APPLICATION"/>
    <add key = "OAuth2ClientId" value = "******.apps.googleusercontent.com" />
    <add key = "OAuth2ClientSecret" value = "******" />
    <add key = "OAuth2RefreshToken" value = "******" />
  </GoogleAdsApi>
  <startup>
    <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5.2" />
  </startup>
</configuration>

किसी App.config फ़ाइल से कॉन्फ़िगरेशन सेटिंग लोड करने के लिए, GoogleAdsConfig ऑब्जेक्ट पर LoadFromDefaultAppConfigSection तरीके को कॉल करें:

GoogleAdsConfig config = new GoogleAdsConfig();
config.LoadFromDefaultAppConfigSection();
GoogleAdsClient client = new GoogleAdsClient(config);

App.config एक अलग फ़ाइल बनाएं

अगर आपको अपने App.config को व्यवस्थित नहीं करना है, तो configSource प्रॉपर्टी का इस्तेमाल करके, लाइब्रेरी के हिसाब से बने कॉन्फ़िगरेशन को उसकी कॉन्फ़िगरेशन फ़ाइल में ले जाएं.

पहला चरण: अपने App.config में configSource चुनें

अपने App.config में बदलाव करें, ताकि वह इस तरह दिखे:

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <configSections>
    <section name="GoogleAdsApi" type="System.Configuration.DictionarySectionHandler"/>
  </configSections>
  <GoogleAdsApi configSource="GoogleAdsApi.config"/>
...
</configuration>

दूसरा चरण: अपनी कॉन्फ़िगरेशन फ़ाइल के कॉन्टेंट की जानकारी देना

अब configSource पर बताए गए नाम से दूसरी कॉन्फ़िगरेशन फ़ाइल बनाएं और कॉन्फ़िगरेशन नोड को अपने App.config से इस फ़ाइल में ले जाएं:

<?xml version="1.0" encoding="utf-8" ?>
<GoogleAdsApi>
  ... More settings.
</GoogleAdsApi>

तीसरा चरण: अपने csproj में बिल्ड नियमों को ठीक करना

अंत में, अपने प्रोजेक्ट में नई कॉन्फ़िगरेशन फ़ाइल शामिल करें. इस फ़ाइल की प्रॉपर्टी को हमेशा आउटपुट फ़ोल्डर में कॉपी करें में बदलें.

अब अपना प्रोजेक्ट बनाएं और चलाएं. आपका ऐप्लिकेशन नई कॉन्फ़िगरेशन फ़ाइल से वैल्यू इकट्ठा करना शुरू कर देगा.

कस्टम JSON फ़ाइल का इस्तेमाल करके कॉन्फ़िगरेशन करना

क्लाइंट लाइब्रेरी को कॉन्फ़िगर करने के लिए, IConfigurationRoot इंस्टेंस का इस्तेमाल किया जा सकता है.

JSON फ़ाइल बनाना

GoogleAdsApi.json नाम की ऐसी JSON फ़ाइल बनाएं जिसका स्ट्रक्चर App.config फ़ाइल से मिलता-जुलता हो.

{
    "Timeout": "2000",

    "ProxyServer": "http://localhost:8888",
    "ProxyUser": "",
    "ProxyPassword": "",
    "ProxyDomain": "",

    "DeveloperToken": "******",

    "OAuth2Mode": "APPLICATION",
    "OAuth2ClientId": "******.apps.googleusercontent.com",
    "OAuth2ClientSecret": "******",
    "OAuth2RefreshToken": "******",
}

कॉन्फ़िगरेशन लोड करें

इसके बाद, JSON फ़ाइल को IConfigurationRoot में लोड करें.

ConfigurationBuilder builder = new ConfigurationBuilder()
    .SetBasePath(Directory.GetCurrentDirectory())
    .AddJsonFile("GoogleAdsApi.json");
IConfigurationRoot configRoot = builder.Build();

GoogleAdsConfig config = new GoogleAdsConfig();
config.LoadFromConfigurationRoot(configRoot);
GoogleAdsClient client = new GoogleAdsClient(config);

settings.json का इस्तेमाल करके कॉन्फ़िगरेशन करना

यहां बताई गई प्रोसेस, कस्टम JSON का इस्तेमाल करने जैसी है. हालांकि, इसके लिए ज़रूरी है कि पासकोड, GoogleAdsApi नाम के सेक्शन में हों:

{
    "GoogleAdsApi":
    {
        "DeveloperToken": "******",
        "OAuth2Mode": "APPLICATION",
        "OAuth2ClientId": "******.apps.googleusercontent.com",
        "OAuth2ClientSecret": "******",
        "OAuth2RefreshToken": "******",
        ...
    }
    // More settings...
}

इसके बाद, अपने पेज पर IConfiguration इंस्टेंस का इस्तेमाल किया जा सकता है:

IConfigurationSection section = Configuration.GetSection("GoogleAdsApi");
GoogleAdsConfig config = new GoogleAdsConfig();
config.LoadFromConfigurationSection(section);
GoogleAdsClient client = new GoogleAdsClient(config);

एनवायरमेंट वैरिएबल का इस्तेमाल करके कॉन्फ़िगरेशन करना

एनवायरमेंट वैरिएबल का इस्तेमाल करके भी GoogleAdsClient को शुरू किया जा सकता है:

GoogleAdsConfig config = new GoogleAdsConfig();
config.LoadFromEnvironmentVariables();
GoogleAdsClient client = new GoogleAdsClient(config);

इस्तेमाल किए जा सकने वाले एनवायरमेंट वैरिएबल की पूरी सूची देखें.

कॉन्फ़िगरेशन फ़ील्ड

Google Ads .NET लाइब्रेरी से जुड़ी सेटिंग की सूची यहां दी गई है.

इंटरनेट कनेक्शन की सेटिंग

  • Timeout: सेवा का टाइम आउट मिलीसेकंड में सेट करने के लिए, इस कुंजी का इस्तेमाल करें. डिफ़ॉल्ट वैल्यू, googleads_grpc_service_config.json में method_config/timeout सेटिंग के हिसाब से सेट की जाती है. अगर आपको एपीआई कॉल के लिए ज़्यादा से ज़्यादा समय की कम समयसीमा लागू करनी है, तो कम वैल्यू सेट करें. टाइम आउट को दो घंटे या उससे ज़्यादा पर सेट किया जा सकता है. हालांकि, एपीआई अब भी लंबे समय से चल रहे अनुरोधों को खत्म कर सकता है और DEADLINE_EXCEEDED गड़बड़ी दिखा सकता है.
  • ProxyServer: अगर इंटरनेट से कनेक्ट करने के लिए प्रॉक्सी सर्वर का इस्तेमाल किया जा रहा है, तो इसे एचटीटीपी प्रॉक्सी सर्वर यूआरएल पर सेट करें.
  • ProxyUser: इसे उस उपयोगकर्ता नाम पर सेट करें जिसकी आपको प्रॉक्सी सर्वर से पुष्टि करने की ज़रूरत है. अगर उपयोगकर्ता नाम की ज़रूरत नहीं है, तो इसे खाली छोड़ दें.
  • ProxyPassword: अगर आपने ProxyUser के लिए कोई वैल्यू सेट की है, तो इसे ProxyUser के पासवर्ड पर सेट करें.
  • ProxyDomain: अगर आपके प्रॉक्सी सर्वर को सेट करना ज़रूरी है, तो इसे ProxyUser के लिए डोमेन पर सेट करें.
  • MaxReceiveMessageLengthInBytes: इस सेटिंग का इस्तेमाल करके, एपीआई रिस्पॉन्स का उस ज़्यादा से ज़्यादा साइज़ बढ़ाया जा सकता है जिसे क्लाइंट लाइब्रेरी मैनेज कर सकती है. डिफ़ॉल्ट वैल्यू 64 एमबी है.
  • MaxMetadataSizeInBytes: इस सेटिंग का इस्तेमाल करके, एपीआई की गड़बड़ी के रिस्पॉन्स का वह ज़्यादा से ज़्यादा साइज़ बढ़ाया जा सकता है जिसे क्लाइंट लाइब्रेरी मैनेज कर सकती है. डिफ़ॉल्ट वैल्यू 16 एमबी है.

ResourceExhausted की कुछ गड़बड़ियों को ठीक करने के लिए, MaxReceiveMessageLengthInBytes और MaxMetadataSizeInBytes की सेटिंग में बदलाव करें. ये सेटिंग फ़ॉर्म Status(StatusCode="ResourceExhausted",Detail="Received message larger than max (423184132 versus 67108864)" की गड़बड़ियों को ठीक करती हैं.

इस उदाहरण में, मैसेज का साइज़ (423184132 bytes), लाइब्रेरी में मौजूद मैसेज (67108864 bytes) से ज़्यादा होने की वजह से यह गड़बड़ी हुई है. इस गड़बड़ी से बचने के लिए, मैसेज का साइज़ MaxReceiveMessageLengthInBytes से 500000000 तक बढ़ाएं.

ध्यान दें कि गड़बड़ी से यह भी पता चलता है कि आपके कोड ने काफ़ी बड़े रिस्पॉन्स ऑब्जेक्ट (जैसे, बड़ा SearchGoogleAdsResponse) को हैंडल किया है. .NET के बड़े ऑब्जेक्ट हीप की वजह से, आपके कोड की परफ़ॉर्मेंस पर असर पड़ सकता है. अगर इससे परफ़ॉर्मेंस पर असर पड़ता है, तो आपको एपीआई कॉल को फिर से व्यवस्थित करने या अपने ऐप्लिकेशन के कुछ हिस्सों को फिर से डिज़ाइन करने का तरीका जानना होगा.

OAuth2 सेटिंग

Google Ads API सर्वर के ख़िलाफ़ अपने कॉल को अनुमति देने के लिए OAuth2 का इस्तेमाल करते समय, आपको ये कॉन्फ़िगरेशन कुंजियां सेट करनी चाहिए:

  • AuthorizationMethod: OAuth2 पर सेट करें.
  • OAuth2Mode: APPLICATION या SERVICE_ACCOUNT पर सेट करें.
  • OAuth2ClientId: यह वैल्यू अपने OAuth2 क्लाइंट आईडी पर सेट करें.
  • OAuth2ClientSecret: इस वैल्यू को अपने OAuth2 क्लाइंट सीक्रेट पर सेट करें.
  • OAuth2Scope: अगर आपको एक से ज़्यादा एपीआई के लिए OAuth2 टोकन की अनुमति देनी है, तो इस वैल्यू को अलग-अलग दायरों पर सेट करें. इस सेटिंग का इस्तेमाल करना ज़रूरी नहीं है.

अगर आप OAuth2Mode == APPLICATION का इस्तेमाल कर रहे हैं, तो आपको नीचे दी गई दूसरी कॉन्फ़िगरेशन कुंजियां सेट करनी होंगी.

  • OAuth2RefreshToken: अगर आपको OAuth2 टोकन फिर से इस्तेमाल करना है, तो इस वैल्यू को पहले से जनरेट किए गए OAuth2 रीफ़्रेश टोकन पर सेट करें. इस सेटिंग का इस्तेमाल करना ज़रूरी नहीं है.
  • OAuth2RedirectUri: इस वैल्यू को OAuth2 के दूसरे वेबलिंक पर सेट करें. इस सेटिंग का इस्तेमाल करना ज़रूरी नहीं है.

ज़्यादा जानकारी के लिए, यहां दी गई गाइड देखें:

अगर OAuth2Mode == SERVICE_ACCOUNT का इस्तेमाल किया जा रहा है, तो आपको नीचे दी गई अतिरिक्त कॉन्फ़िगरेशन कुंजियां सेट करनी होंगी.

  • OAuth2PrnEmail: इस वैल्यू को उस खाते के ईमेल पते पर सेट करें जिसके नाम पर आपको काम करना है.
  • OAuth2SecretsJsonPath: इस वैल्यू को OAuth2 JSON कॉन्फ़िगरेशन फ़ाइल पाथ पर सेट करें.

ज़्यादा जानकारी के लिए, OAuth सेवा खाते के फ़्लो से जुड़ी गाइड देखें.

परिवहन सेटिंग

  • UseGrpcCore: Grpc.Core लाइब्रेरी का इस्तेमाल, ट्रांसपोर्ट लेयर के तौर पर करने के लिए, इस सेटिंग को true पर सेट करें. ज़्यादा जानकारी के लिए gRPC सहायता गाइड देखें.

Google Ads API की सेटिंग

नीचे दी गई सेटिंग, खास तौर पर Google Ads API के लिए हैं.

  • DeveloperToken: इसे अपने डेवलपर टोकन पर सेट करें.
  • LoginCustomerId: यह उस आधिकारिक ग्राहक का ग्राहक आईडी है जिसे अनुरोध में इस्तेमाल करने के लिए, हाइफ़न (-) के बिना इस्तेमाल करना होता है.
  • LinkedCustomerId: यह हेडर सिर्फ़ उन तरीकों के लिए ज़रूरी है जो Google Ads के यूज़र इंटरफ़ेस (यूआई) में लिंक किए गए खातों (Google Ads API में AccountLink संसाधन) से अनुमति मिलने पर, किसी इकाई के रिसॉर्स को अपडेट करते हैं. इस वैल्यू को डेटा उपलब्ध कराने वाली उस कंपनी के ग्राहक आईडी पर सेट करें जो दिए गए ग्राहक आईडी के संसाधनों को अपडेट करता है. इसे हाइफ़न (-) के बिना सेट किया जाना चाहिए. लिंक किए गए खातों के बारे में ज़्यादा जानें.