ক্লায়েন্ট লাইব্রেরি

Google Ads API ক্লায়েন্ট লাইব্রেরি, Google Ads API ফাংশনের হাই-লেভেল ভিউ ও প্রাথমিক বিল্ডিং ব্লক প্রদান করে, এর ফলে দ্রুত অ্যাপ ডেভেলপ করা সহজ হয়ে যায়। আপনি API-তে নতুন হলে, ক্লায়েন্ট লাইব্রেরি দিয়ে শুরু করুন।

ক্লায়েন্ট লাইব্রেরি সোর্স বিতরণ কোডের উদাহরণ
Java google-ads-java Maven, tar.gz, zip GitHub-এ দেখুন
.NET google-ads-dotnet NuGet, tar.gz, zip GitHub-এ দেখুন
PHP google-ads-php Composer, tar.gz, zip GitHub-এ দেখুন
Python google-ads-python PyPI, tar.gz, zip GitHub-এ দেখুন
Ruby google-ads-ruby RubyGems, tar.gz, zip GitHub-এ দেখুন
Perl google-ads-perl CPAN, tar.gz, zip GitHub-এ দেখুন

কমিউনিটি লাইব্রেরি

আমরা এমন অনেক লাইব্রেরি সম্পর্কে জানি যেগুলি ওপেন সোর্স কমিউনিটি ম্যানেজ করে। আগ্রহী ডেভেলপারদের খুঁজে পেতে সাহায্য করার জন্য আমরা এই তালিকাটি বজায় রাখি। আমরা এইসব লাইব্রেরি পরীক্ষা, কন্ট্রিবিউট বা রক্ষণাবেক্ষণ করি না; নিজের দায়িত্বে ব্যবহার করুন। আপনার কোনও প্রশ্ন থাকলে, তা ওপেন সোর্স প্রোজেক্টের মালিককে জিজ্ঞাসা করতে হবে।

আমরা মিস করেছি এমন কোনও লাইব্রেরি সম্পর্কে আপনি জানলে, পৃষ্ঠার উপরে মতামত জানান বিকল্পে ক্লিক করে আমাদের জানান।

API-এর যেসব ভার্সন কাজ করে

কোন ক্লায়েন্ট লাইব্রেরি কোন API ভার্সনের সাথে কাজ করে তা এই সারণিতে দেখানো হয়েছে।

উল্লেখ করা ন্যূনতম ক্লায়েন্ট লাইব্রেরি ভার্সনটি প্রধান Google Ads API রিলিজের (যেমন v26) জন্য যথেষ্ট। মাইনর রিলিজের জন্য প্রয়োজনীয় ক্লায়েন্ট লাইব্রেরি ভার্সন দেখতে, লিঙ্ক করা চেঞ্জলগ দেখুন।

Java

চেঞ্জলগ

Java-এর জন্য ক্লায়েন্ট লাইব্রেরি
v26 Min: 48.0.0
Max: -
v25 Min: 44.0.0
Max: -
v24 Min: 43.0.0
Max: -
v23 Min: 42.0.0
Max: -

C#

চেঞ্জলগ

.NET-এর জন্য ক্লায়েন্ট লাইব্রেরি
v26 Min: 27.5.0
Max: -
v25 Min: 26.1.0
Max: -
v24 Min: 25.3.0
Max: -
v23 Min: 25.1.0
Max: -

PHP

চেঞ্জলগ

PHP-এর জন্য ক্লায়েন্ট লাইব্রেরি
v26 Min: 35.2.0
Max: -
v25 Min: 33.6.0
Max: -
v24 Min: 33.3.0
Max: -
v23 Min: 32.2.0
Max: -

Python

পরিবর্তনের লগ

Python-এর জন্য ক্লায়েন্ট লাইব্রেরি
v26 Min: 34.0.0
Max: -
v25 Min: 31.2.0
Max: -
v24 Min: 30.1.0
Max: -
v23 Min: 29.2.0
Max: -

Ruby

চেঞ্জলগ

Ruby-এর জন্য ক্লায়েন্ট লাইব্রেরি
v26 Min: 46.0.0
Max: -
v25 Min: 43.0.0
Max: -
v24 Min: 40.0.0
Max: -
v23 Min: 38.0.0
Max: -

Perl

চেঞ্জলগ

Perl-এর জন্য ক্লায়েন্ট লাইব্রেরি
v26 Min: 36.0.0
Max: -
v25 Min: 33.0.0
Max: -
v24 Min: 32.0.0
Max: -
v23 Min: 31.0.0
Max: -

কনফিগারেশন

প্রতিটি Google Ads API ক্লায়েন্ট লাইব্রেরি বিভিন্ন কনফিগারেশন সেটিংস এবং লোডিং পদ্ধতি প্রদান করে যা আপনি এর আচরণ কাস্টমাইজ করতে ব্যবহার করতে পারেন।

এখানে স্ট্যান্ডার্ড এনভায়রনমেন্ট ভেরিয়েবল দেওয়া হল যা আপনি ক্লায়েন্ট লাইব্রেরি কনফিগার করতে ব্যবহার করতে পারবেন:

  • ক্লায়েন্ট লাইব্রেরি
    • GOOGLE_ADS_CONFIGURATION_FILE_PATH: কনফিগারেশন ফাইলের পাথ (Java (fromPropertiesFile()), Perl (Client->new()), PHP (fromFile()), Python (load_from_storage(), এবং load_from_env()-এর মাধ্যমেও চেক করা হয়) এবং Ruby (GoogleAdsClient.new)-এ স্পষ্ট পাথ আর্গুমেন্ট না থাকা কনফিগারেশন ফাইল থেকে লোড করার সময় অটোমেটিক রিড করা হয়; .NET-এ, config.TryLoadFromEnvironmentFilePath ব্যবহার করে এই ভেরিয়েবল স্পষ্টভাবে লোড করুন অথবা LoadFromSettingsJson, LoadFromConfigurationSection বা LoadFromConfigurationRoot ব্যবহার করে কনফিগারেশন ফাইল লোড করুন)।
  • OAuth2
    • অ্যাপ্লিকেশন মোড
      • GOOGLE_ADS_CLIENT_ID: আপনার OAuth2 ক্লায়েন্ট আইডিতে এই ভ্যালু সেট করুন।
      • GOOGLE_ADS_CLIENT_SECRET: আপনার OAuth2 ক্লায়েন্ট সিক্রেটে এই ভ্যালু সেট করুন।
      • GOOGLE_ADS_REFRESH_TOKEN: আপনি OAuth2 টোকেন আবার ব্যবহার করতে চাইলে, এই ভ্যালুটিকে আগে থেকে তৈরি করা OAuth2 রিফ্রেশ টোকেনে সেট করুন। এই সেটিংটি ঐচ্ছিক।
    • পরিষেবা অ্যাকাউন্ট মোড
      • GOOGLE_ADS_JSON_KEY_FILE_PATH: এই ভ্যালু আপনার OAuth2 JSON কী ফাইলের পাথে সেট করুন (.NET-এ, GOOGLE_ADS_OAUTH2_MODE-কে SERVICE_ACCOUNT-এ সেট করুন, কারণ OAuth2Mode ডিফল্ট হিসেবে APPLICATION-এ সেট করা থাকে; v32.1.0-এর আগের PHP ভার্সনে অথবা কাস্টম স্কোপ ব্যবহার করার সময়, [OAUTH2] scopes-কে google_ads_php.ini-এ সেট করুন অথবা withScopes()-কে কল করুন, কারণ fromEnvironmentVariables() এনভায়রনমেন্ট ভেরিয়েবল থেকে OAuth2 স্কোপ রিড করে না)।
      • GOOGLE_ADS_IMPERSONATED_EMAIL: Google Workspace ডোমেন-ওয়াইড ডেলিগেশন ব্যবহার করার সময় আপনি যে অ্যাকাউন্টের ছদ্মবেশ ধারণ করছেন সেটির ইমেল আইডিতে এই ভ্যালু সেট করুন। এই সেটিং ঐচ্ছিক।
    • অ্যাপ্লিকেশন ডিফল্ট ক্রেডেনশিয়াল মোড
      • GOOGLE_ADS_USE_APPLICATION_DEFAULT_CREDENTIALS: অ্যাপ্লিকেশন ডিফল্ট ক্রেডেনশিয়াল (ADC) ব্যবহার করে true প্রমাণীকরণ করতে এই মান সেট করুন। Java v41.1.0 ও তার পরবর্তী যেকোনও ভার্সন, Python v28.3.0 ও তার পরবর্তী যেকোনও ভার্সন, এবং Ruby v36.1.0 ও তার পরবর্তী যেকোনও ভার্সনে কাজ করে (এগুলি .NET v24.1.0 ও তার পরবর্তী যেকোনও ভার্সনে, LoadFromEnvironmentVariables() প্রিফিক্স ছাড়া USE_APPLICATION_DEFAULT_CREDENTIALS ভেরিয়েবল পড়ে অথবা GoogleAdsConfig-এ UseApplicationDefaultCredentials = true সেট করে; PHP-তে, OAuth2TokenBuilder কোনও OAuth2 ক্রেডেনশিয়াল স্পষ্টভাবে সেট করা না থাকলে অটোমেটিক ADC-তে ফল ব্যাক করে; Perl-এ ADC কাজ করে না)।
  • Google Ads API
    • GOOGLE_ADS_LOGIN_CUSTOMER_ID: এটি হল অনুরোধে ব্যবহার করার জন্য অনুমোদিত গ্রাহকের গ্রাহক আইডি, এতে কোনও হাইফেন নেই (-)।
    • GOOGLE_ADS_LINKED_CUSTOMER_ID: এই হেডারটি শুধুমাত্র সেইসব পদ্ধতির জন্য প্রয়োজন যা Google Ads UI-তে লিঙ্ক করা অ্যাকাউন্টের মাধ্যমে অনুমতি দেওয়া হলে কোনও এন্টিটির রিসোর্স আপডেট করে (Google Ads API-তে AccountLink রিসোর্স)। এই ভ্যালু ডেটা পরিষেবা প্রদানকারীর কাস্টমার আইডিতে সেট করুন যা নির্দিষ্ট কাস্টমার আইডির রিসোর্স আপডেট করে। এটি হাইফেন (-) ছাড়া সেট করতে হবে। লিঙ্ক করা অ্যাকাউন্ট সম্পর্কে আরও জানতে, সহায়তা কেন্দ্র দেখুন।

এনভায়রনমেন্ট ভেরিয়েবেল সাধারণত bash কনফিগারেশন ফাইলে যেমন $HOME ডিরেক্টরিতে অবস্থিত .bashrc বা .bash_profile ফাইলে ডিফাইন করা হয়। কমান্ড লাইন ব্যবহার করেও এগুলি সংজ্ঞায়িত করা যেতে পারে।

টার্মিনাল ব্যবহার করে .bashrc ফাইল ব্যবহার করে এনভায়রনমেন্ট ভেরিয়েবল নির্ধারণ করার কিছু প্রাথমিক ধাপ এখানে দেওয়া হল:

# Append the line "export GOOGLE_ADS_CLIENT_ID=1234567890" to
# the bottom of your .bashrc file.
echo "export GOOGLE_ADS_CLIENT_ID=1234567890" >> ~/.bashrc

# Update your bash environment to use the most recently updated
# version of your .bashrc file.
source ~/.bashrc

এছাড়াও, কমান্ড লাইন থেকে সরাসরি আপনার টার্মিনাল ইনস্ট্যান্সে এনভায়রনমেন্ট ভেরিয়েবল সেট করা যেতে পারে:

export GOOGLE_ADS_CLIENT_ID=1234567890

অন্য একটি বিকল্প হল, কমান্ড কল করার সময় এনভায়রনমেন্ট ভেরিয়েবল সেট করা যা এগুলি ব্যবহার করে:

GOOGLE_ADS_CLIENT_ID=1234567890 php /path/to/script/that/uses/envvar.php

এন্টিটি ফেচ করা

GoogleAdsService.SearchStream সাধারণত এন্টিটি ফেচ করতে ব্যবহার করা হয় এবং ফলাফল সারির স্ট্রিম হিসেবে ফেরত পাঠানো হয়। বিকল্প হিসেবে, আপনি GoogleAdsService.Search ব্যবহার করে অনির্ভরযোগ্য ইন্টারনেট কানেকশনের মাধ্যমে এন্টিটি ফেচ করতে পারবেন। GoogleAdsService.Search প্রতি পৃষ্ঠায় ১০,০০০ সারি হিসেবে নির্দিষ্ট পৃষ্ঠা সাইজের ফলাফল রিটার্ন করে।

আপনি ফলাফল পুনরাবৃত্তি করলে ক্লায়েন্ট লাইব্রেরি অটোমেটিক পেজিং প্রয়োগ করে যাতে আপনি সেগুলি পরপর ডাউনলোড ও প্রসেস করতে পারেন একই সাথে।

Java

private void runExample(GoogleAdsClient googleAdsClient, long customerId) {
  try (GoogleAdsServiceClient googleAdsServiceClient =
      googleAdsClient.getLatestVersion().createGoogleAdsServiceClient()) {
    String query = "SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id";
    // Constructs the SearchGoogleAdsStreamRequest.
    SearchGoogleAdsStreamRequest request =
        SearchGoogleAdsStreamRequest.newBuilder()
            .setCustomerId(Long.toString(customerId))
            .setQuery(query)
            .build();

    // Creates and issues a search Google Ads stream request that will retrieve all campaigns.
    ServerStream<SearchGoogleAdsStreamResponse> stream =
        googleAdsServiceClient.searchStreamCallable().call(request);

    // Iterates through and prints all of the results in the stream response.
    for (SearchGoogleAdsStreamResponse response : stream) {
      for (GoogleAdsRow googleAdsRow : response.getResultsList()) {
        System.out.printf(
            "Campaign with ID %d and name '%s' was found.%n",
            googleAdsRow.getCampaign().getId(), googleAdsRow.getCampaign().getName());
      }
    }
  }
}

C#

public void Run(GoogleAdsClient client, long customerId)
{
    // Get the GoogleAdsService.
    GoogleAdsServiceClient googleAdsService = client.GetService(
        Services.V25.GoogleAdsService);

    // Create a query that will retrieve all campaigns.
    string query = @"SELECT
                    campaign.id,
                    campaign.name,
                    campaign.network_settings.target_content_network
                FROM campaign
                ORDER BY campaign.id";

    try
    {
        // Issue a search request.
        googleAdsService.SearchStream(customerId.ToString(), query,
            delegate (SearchGoogleAdsStreamResponse resp)
            {
                foreach (GoogleAdsRow googleAdsRow in resp.Results)
                {
                    Console.WriteLine("Campaign with ID {0} and name '{1}' was found.",
                        googleAdsRow.Campaign.Id, googleAdsRow.Campaign.Name);
                }
            }
        );
    }
    catch (GoogleAdsException e)
    {
        Console.WriteLine("Failure:");
        Console.WriteLine($"Message: {e.Message}");
        Console.WriteLine($"Failure: {e.Failure}");
        Console.WriteLine($"Request ID: {e.RequestId}");
        throw;
    }
}

PHP

public static function runExample(GoogleAdsClient $googleAdsClient, int $customerId)
{
    $googleAdsServiceClient = $googleAdsClient->getGoogleAdsServiceClient();
    // Creates a query that retrieves all campaigns.
    $query = 'SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id';
    // Issues a search stream request.
    /** @var GoogleAdsServerStreamDecorator $stream */
    $stream = $googleAdsServiceClient->searchStream(
        SearchGoogleAdsStreamRequest::build($customerId, $query)
    );

    // Iterates over all rows in all messages and prints the requested field values for
    // the campaign in each row.
    foreach ($stream->iterateAllElements() as $googleAdsRow) {
        /** @var GoogleAdsRow $googleAdsRow */
        printf(
            "Campaign with ID %d and name '%s' was found.%s",
            $googleAdsRow->getCampaign()->getId(),
            $googleAdsRow->getCampaign()->getName(),
            PHP_EOL
        );
    }
}

Python

def main(client: GoogleAdsClient, customer_id: str) -> None:
    ga_service: GoogleAdsServiceClient = client.get_service("GoogleAdsService")

    query: str = """
        SELECT
          campaign.id,
          campaign.name
        FROM campaign
        ORDER BY campaign.id"""

    # Issues a search request using streaming.
    stream: Iterator[SearchGoogleAdsStreamResponse] = ga_service.search_stream(
        customer_id=customer_id, query=query
    )

    for batch in stream:
        rows: List[GoogleAdsRow] = batch.results
        for row in rows:
            print(
                f"Campaign with ID {row.campaign.id} and name "
                f'"{row.campaign.name}" was found.'
            )

Ruby

def get_campaigns(customer_id)
  # GoogleAdsClient will read a config file from
  # ENV['HOME']/google_ads_config.rb when called without parameters
  client = Google::Ads::GoogleAds::GoogleAdsClient.new

  responses = client.service.google_ads.search_stream(
    customer_id: customer_id,
    query: 'SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id',
  )

  responses.each do |response|
    response.results.each do |row|
      puts "Campaign with ID #{row.campaign.id} and name '#{row.campaign.name}' was found."
    end
  end
end

Perl

sub get_campaigns {
  my ($api_client, $customer_id) = @_;

  # Create a search Google Ads stream request that will retrieve all campaigns.
  my $search_stream_request =
    Google::Ads::GoogleAds::V25::Services::GoogleAdsService::SearchGoogleAdsStreamRequest
    ->new({
      customerId => $customer_id,
      query      =>
        "SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id"
    });

  # Get the GoogleAdsService.
  my $google_ads_service = $api_client->GoogleAdsService();

  my $search_stream_handler =
    Google::Ads::GoogleAds::Utils::SearchStreamHandler->new({
      service => $google_ads_service,
      request => $search_stream_request
    });

  # Issue a search request and process the stream response to print the requested
  # field values for the campaign in each row.
  $search_stream_handler->process_contents(
    sub {
      my $google_ads_row = shift;
      printf "Campaign with ID %d and name '%s' was found.\n",
        $google_ads_row->{campaign}{id}, $google_ads_row->{campaign}{name};
    });

  return 1;
}

কার্ল

কোডের উদাহরণ

Google Ads API-তে কিছু সাধারণ ফাংশনের আমাদের কোডের উদাহরণ দেখুন।