একটি API কল করুন

এই নির্দেশিকাটির জন্য বেশ কিছু পূর্বশর্ত সেটিংস প্রয়োজন যা পূর্ববর্তী ধাপে কনফিগার করা হয়েছে। আপনি যদি তা না করে থাকেন তাহলে ভূমিকা দিয়ে শুরু করুন।

এই নির্দেশিকাটি রিফ্রেশ টোকেনগুলিও ব্যবহার করে, একটি ওয়ার্কফ্লো যেখানে Google বিজ্ঞাপন অ্যাকাউন্টে পর্যাপ্ত অ্যাক্সেস সহ একজন ব্যবহারকারী আপনার অ্যাপকে অনুমোদন করতে পারে, এককালীন সেটআপে, ব্যবহারকারীর আর কোনো হস্তক্ষেপ ছাড়াই অ্যাকাউন্টে অফলাইন API কল করার জন্য। আপনি রিফ্রেশ টোকেন ব্যবহার করতে পারেন অফলাইন ওয়ার্কফ্লো, যেমন ক্রন জব বা ডেটা পাইপলাইন এবং ইন্টারেক্টিভ ওয়ার্কফ্লো, যেমন ওয়েব বা মোবাইল অ্যাপস তৈরি করতে।

একটি রিফ্রেশ টোকেন আনুন

Google বিজ্ঞাপন API অনুমোদনের প্রক্রিয়া হিসাবে OAuth 2.0 ব্যবহার করে। ডিফল্টরূপে, OAuth 2.0 প্রমাণীকরণ একটি অ্যাক্সেস টোকেন ইস্যু করে যা সীমিত সময়ের পরে মেয়াদ শেষ হয়ে যায়। স্বয়ংক্রিয়ভাবে অ্যাক্সেস টোকেন পুনর্নবীকরণ করতে, পরিবর্তে একটি রিফ্রেশ টোকেন ইস্যু করুন৷

oauth2l

1. oauth2l টুলটি চালিয়ে রিফ্রেশ টোকেন তৈরি করুন:

   oauth2l fetch --credentials credentials.json --scope adwords \
       --output_format refresh_token

   credentials.json ফাইলটি পূর্ববর্তী ধাপের ।

2. oauth2l কমান্ডটি একটি নতুন ব্রাউজার উইন্ডোতে একটি Google অ্যাকাউন্ট লগইন উইন্ডো খোলে এবং আপনাকে OAuth 2.0 প্রমাণীকরণ পদক্ষেপের মাধ্যমে নিয়ে যায়।

   নিশ্চিত করুন যে আপনি যে ধাপে আপনার লগইন গ্রাহক আইডি শনাক্ত করেছেন সেখান থেকে ইমেল ঠিকানা ব্যবহার করে সাইন ইন করেছেন।

   আপনার অ্যাপ যাচাই করা না হলে, আপনি একটি সতর্কতা স্ক্রীন দেখতে পারেন। এই ধরনের ক্ষেত্রে, অ্যাডভান্সড লিঙ্ক প্রদর্শন করুন এবং PROJECT_NAME (অযাচাই করা) বিকল্পে যান ক্লিক করা নিরাপদ।

   

3. আপনি সুযোগ যাচাই করার পরে, চালিয়ে যান বোতামে ক্লিক করে অনুমতি দিন।

   ব্রাউজারে নিম্নলিখিত পাঠ্য সহ একটি প্রম্পট প্রদর্শিত হয়:

   Authorization code granted. Close this tab.
   

   oauth2l কমান্ড নিম্নলিখিত JSON স্নিপেট আউটপুট:

   {
     "client_id": "******.apps.googleusercontent.com",
     "client_secret": "******",
     "token_uri": "https://oauth2.googleapis.com/token",
     "auth_uri": "https://accounts.google.com/o/oauth2/auth",
     "refresh_token": "******",
     "type": "authorized_user"
   }
   

জিক্লাউড সিএলআই

1. gcloud CLI টুলটি চালিয়ে রিফ্রেশ টোকেন তৈরি করুন:

   gcloud auth application-default \
     login --scopes=https://www.googleapis.com/auth/adwords,https://www.googleapis.com/auth/cloud-platform \
     --client-id-file=<path_to_credentials.json>

   credentials.json ফাইলটি পূর্ববর্তী ধাপের ।

2. gcloud কমান্ডটি একটি নতুন ব্রাউজার উইন্ডোতে একটি Google অ্যাকাউন্ট লগইন উইন্ডো খোলে এবং আপনাকে OAuth 2.0 প্রমাণীকরণ পদক্ষেপের মাধ্যমে নিয়ে যায়।

   নিশ্চিত করুন যে আপনি যে ধাপে আপনার লগইন গ্রাহক আইডি শনাক্ত করেছেন সেখান থেকে ইমেল ঠিকানা ব্যবহার করে সাইন ইন করেছেন।

   আপনার অ্যাপ যাচাই করা না হলে, আপনি একটি সতর্কতা স্ক্রীন দেখতে পারেন। এই ধরনের ক্ষেত্রে, অ্যাডভান্সড লিঙ্ক প্রদর্শন করুন এবং PROJECT_NAME (অযাচাই করা) বিকল্পে যান ক্লিক করা নিরাপদ।

   

3. আপনি সুযোগ যাচাই করার পরে, অনুমতি দিতে অবিরত বোতামে ক্লিক করুন।

   ব্রাউজারটি https://cloud.google.com/sdk/auth_success-এ নেভিগেট করে, এটি প্রমাণ করে যে প্রমাণীকরণ সফল হয়েছে৷

   Authorization code granted. Close this tab.
   

   gcloud কমান্ড নিম্নরূপ একটি আউটপুট প্রিন্ট করে:

   Credentials saved to file: [/****/.config/gcloud/application_default_credentials.json]
   

   এখন application_default_credentials.json ফাইলটি খুলুন। এর বিষয়বস্তু নিম্নলিখিত অনুরূপ হওয়া উচিত:

   {
     "account": "",
     "client_id": "******.apps.googleusercontent.com",
     "client_secret": "******",
     "refresh_token": "******",
     "type": "authorized_user",
     "universe_domain": "googleapis.com"
   }
   

অন্যরা

আপনি যদি পরিবর্তে curl বা আপনার নিজস্ব HTTP ক্লায়েন্ট ব্যবহার করতে পছন্দ করেন, উদাহরণের জন্য মোবাইল এবং ডেস্কটপ অ্যাপস গাইডের জন্য OAuth 2.0 পড়ুন।

একটি API কল করুন

কিভাবে একটি API কল করতে হয় তার নির্দেশাবলীর জন্য আপনার পছন্দের ক্লায়েন্ট নির্বাচন করুন:

জাভা

ক্লায়েন্ট লাইব্রেরির নিদর্শনগুলি মাভেন কেন্দ্রীয় সংগ্রহস্থলে প্রকাশিত হয়। ক্লায়েন্ট লাইব্রেরিটি আপনার প্রকল্পে নির্ভরতা হিসাবে যুক্ত করুন:

Maven নির্ভরতা হল:

<dependency>
  <groupId>com.google.api-ads</groupId>
  <artifactId>google-ads</artifactId>
  <version>34.0.0</version>
</dependency>

গ্রেডেল নির্ভরতা হল:

implementation 'com.google.api-ads:google-ads:34.0.0'

নিম্নলিখিত সামগ্রী সহ একটি ফাইল ~/ads.properties তৈরি করুন:

api.googleads.clientId=INSERT_CLIENT_ID_HERE
api.googleads.clientSecret=INSERT_CLIENT_SECRET_HERE
api.googleads.refreshToken=INSERT_REFRESH_TOKEN_HERE
api.googleads.developerToken=INSERT_DEVELOPER_TOKEN_HERE
api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE

নিম্নরূপ একটি GoogleAdsClient অবজেক্ট তৈরি করুন:

GoogleAdsClient googleAdsClient = null;
try {
  googleAdsClient = GoogleAdsClient.newBuilder().fromPropertiesFile().build();
} catch (FileNotFoundException fnfe) {
  System.err.printf(
      "Failed to load GoogleAdsClient configuration from file. Exception: %s%n",
      fnfe);
  System.exit(1);
} catch (IOException ioe) {
  System.err.printf("Failed to create GoogleAdsClient. Exception: %s%n", ioe);
  System.exit(1);
}

এরপর, আপনার অ্যাকাউন্টে প্রচারাভিযানগুলি পুনরুদ্ধার করতে GoogleAdsService.SearchStream পদ্ধতি ব্যবহার করে একটি প্রচারাভিযান প্রতিবেদন চালান৷ এই নির্দেশিকা প্রতিবেদনের বিবরণ কভার করে না।

    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());
      }
    }
  }
}
GetCampaigns.java

সি#

ক্লায়েন্ট লাইব্রেরি প্যাকেজ Nuget.org সংগ্রহস্থলে প্রকাশিত হয়। Google.Ads.GoogleAds প্যাকেজে একটি নুগেট রেফারেন্স যোগ করে শুরু করুন।

dotnet add package Google.Ads.GoogleAds --version 18.1.0

প্রাসঙ্গিক সেটিংস সহ একটি GoogleAdsConfig অবজেক্ট তৈরি করুন এবং একটি GoogleAdsClient অবজেক্ট তৈরি করতে এটি ব্যবহার করুন।

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

এরপর, আপনার অ্যাকাউন্টে প্রচারাভিযানগুলি পুনরুদ্ধার করতে GoogleAdsService.SearchStream পদ্ধতি ব্যবহার করে একটি প্রচারাভিযান প্রতিবেদন চালান৷ এই নির্দেশিকা প্রতিবেদনের বিবরণ কভার করে না।

    public void Run(GoogleAdsClient client, long customerId)
{
    // Get the GoogleAdsService.
    GoogleAdsServiceClient googleAdsService = client.GetService(
        Services.V18.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;
    }
}
GetCampaigns.cs

পিএইচপি

ক্লায়েন্ট লাইব্রেরি প্যাকেজ প্যাকেজিস্ট সংগ্রহস্থলে প্রকাশিত হয়। আপনার প্রকল্পের রুট ডিরেক্টরিতে পরিবর্তন করুন এবং আপনার প্রকল্পের রুট ডিরেক্টরির vendor/ ডিরেক্টরিতে লাইব্রেরি এবং এর সমস্ত নির্ভরতা ইনস্টল করতে নিম্নলিখিত কমান্ডটি চালান।

composer require googleads/google-ads-php:25.0.0

GitHub রিপোজিটরি থেকে google_ads_php.ini ফাইলের একটি অনুলিপি তৈরি করুন এবং আপনার শংসাপত্রগুলি অন্তর্ভুক্ত করতে এটি পরিবর্তন করুন।

[GOOGLE_ADS]
developerToken = "INSERT_DEVELOPER_TOKEN_HERE"
loginCustomerId = "INSERT_LOGIN_CUSTOMER_ID_HERE"

[OAUTH2]
clientId = "INSERT_OAUTH2_CLIENT_ID_HERE"
clientSecret = "INSERT_OAUTH2_CLIENT_SECRET_HERE"
refreshToken = "INSERT_OAUTH2_REFRESH_TOKEN_HERE"

GoogleAdsClient অবজেক্টের একটি উদাহরণ তৈরি করুন।

$oAuth2Credential = (new OAuth2TokenBuilder())
    ->fromFile('/path/to/google_ads_php.ini')
    ->build();

$googleAdsClient = (new GoogleAdsClientBuilder())
    ->fromFile('/path/to/google_ads_php.ini')
    ->withOAuth2Credential($oAuth2Credential)
    ->build();

এরপর, আপনার অ্যাকাউন্টে প্রচারাভিযানগুলি পুনরুদ্ধার করতে GoogleAdsService.SearchStream পদ্ধতি ব্যবহার করে একটি প্রচারাভিযান প্রতিবেদন চালান৷ এই নির্দেশিকা প্রতিবেদনের বিবরণ কভার করে না।

    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
        );
    }
}
GetCampaigns.php

পাইথন

ক্লায়েন্ট লাইব্রেরি PyPI তে বিতরণ করা হয় নিম্নরূপ pip কমান্ড ব্যবহার করে ইনস্টল করা যেতে পারে:

python -m pip install google-ads==21.3.0

GitHub রিপোজিটরি থেকে google-ads.yaml ফাইলের একটি কপি তৈরি করুন এবং আপনার শংসাপত্রগুলি অন্তর্ভুক্ত করতে এটি পরিবর্তন করুন।

client_id: INSERT_OAUTH2_CLIENT_ID_HERE
client_secret: INSERT_OAUTH2_CLIENT_SECRET_HERE
refresh_token: INSERT_REFRESH_TOKEN_HERE
developer_token: INSERT_DEVELOPER_TOKEN_HERE
login_customer_id: INSERT_LOGIN_CUSTOMER_ID_HERE

GoogleAdsClient.load_from_storage পদ্ধতিতে কল করে একটি GoogleAdsClient উদাহরণ তৈরি করুন। কল করার সময় আপনার google-ads.yaml এর পাথটিকে একটি স্ট্রিং হিসাবে মেথডটি পাস করুন:

from google.ads.googleads.client import GoogleAdsClient
client = GoogleAdsClient.load_from_storage("path/to/google-ads.yaml")

এরপর, আপনার অ্যাকাউন্টে প্রচারাভিযানগুলি পুনরুদ্ধার করতে GoogleAdsService.SearchStream পদ্ধতি ব্যবহার করে একটি প্রচারাভিযান প্রতিবেদন চালান৷ এই নির্দেশিকা প্রতিবেদনের বিবরণ কভার করে না।

def main(client, customer_id):
    ga_service = client.get_service("GoogleAdsService")

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

    # Issues a search request using streaming.
    stream = ga_service.search_stream(customer_id=customer_id, query=query)

    for batch in stream:
        for row in batch.results:
            print(
                f"Campaign with ID {row.campaign.id} and name "
                f'"{row.campaign.name}" was found.'
            )
get_campaigns.py

রুবি

ক্লায়েন্ট লাইব্রেরির জন্য রুবি রত্নগুলি Rubygems জেম হোস্টিং সাইটে প্রকাশিত হয়। ইনস্টল করার প্রস্তাবিত উপায় হল বান্ডলার ব্যবহার করা। আপনার জেমফাইলে একটি লাইন যোগ করুন:

gem 'google-ads-googleads', '~> 30.0.0'

তারপর চালান:

bundle install

GitHub রিপোজিটরি থেকে google_ads_config.rb ফাইলের একটি অনুলিপি তৈরি করুন এবং আপনার শংসাপত্রগুলি অন্তর্ভুক্ত করতে এটি পরিবর্তন করুন।

Google::Ads::GoogleAds::Config.new do |c|
  c.client_id = 'INSERT_CLIENT_ID_HERE'
  c.client_secret = 'INSERT_CLIENT_SECRET_HERE'
  c.refresh_token = 'INSERT_REFRESH_TOKEN_HERE'
  c.developer_token = 'INSERT_DEVELOPER_TOKEN_HERE'
  c.login_customer_id = 'INSERT_LOGIN_CUSTOMER_ID_HERE'
end

আপনি যেখানে এই ফাইলটি রাখবেন সেই পাথ দিয়ে একটি GoogleAdsClient উদাহরণ তৈরি করুন৷

client = Google::Ads::GoogleAds::GoogleAdsClient.new('path/to/google_ads_config.rb')

এরপর, আপনার অ্যাকাউন্টে প্রচারাভিযানগুলি পুনরুদ্ধার করতে GoogleAdsService.SearchStream পদ্ধতি ব্যবহার করে একটি প্রচারাভিযান প্রতিবেদন চালান৷ এই নির্দেশিকা প্রতিবেদনের বিবরণ কভার করে না।

    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
get_campaigns.rb

পার্ল

লাইব্রেরি CPAN- এ বিতরণ করা হয়। আপনার পছন্দের ডিরেক্টরিতে google-ads-perl সংগ্রহস্থল ক্লোন করে শুরু করুন।

git clone https://github.com/googleads/google-ads-perl.git

google-ads-perl ডিরেক্টরিতে পরিবর্তন করুন এবং লাইব্রেরি ব্যবহার করার জন্য প্রয়োজনীয় সমস্ত নির্ভরতা ইনস্টল করতে কমান্ড প্রম্পটে নিম্নলিখিত কমান্ডটি চালান।

cd google-ads-perl
cpan install Module::Build
perl Build.PL
perl Build installdeps

GitHub সংগ্রহস্থল থেকে googleads.properties ফাইলের একটি অনুলিপি তৈরি করুন এবং আপনার শংসাপত্রগুলি অন্তর্ভুক্ত করতে এটি পরিবর্তন করুন৷

clientId=INSERT_OAUTH2_CLIENT_ID_HERE
clientSecret=INSERT_OAUTH2_CLIENT_SECRET_HERE
refreshToken=INSERT_OAUTH2_REFRESH_TOKEN_HERE
developerToken=INSERT_DEVELOPER_TOKEN_HERE
loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE

আপনি যেখানে এই ফাইলটি রাখবেন সেই পাথটি পাস করে একটি Client উদাহরণ তৈরি করুন৷

my $properties_file = "/path/to/googleads.properties";

my $api_client = Google::Ads::GoogleAds::Client->new({
  properties_file => $properties_file
});

এরপর, আপনার অ্যাকাউন্টে প্রচারাভিযানগুলি পুনরুদ্ধার করতে GoogleAdsService.SearchStream পদ্ধতি ব্যবহার করে একটি প্রচারাভিযান প্রতিবেদন চালান৷ এই নির্দেশিকা প্রতিবেদনের বিবরণ কভার করে না।

    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::V18::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;
}
get_campaigns.pl

বিশ্রাম

একটি OAuth 2.0 অ্যাক্সেস টোকেন আনতে একটি HTTP ক্লায়েন্ট ব্যবহার করে শুরু করুন। এই গাইড curl কমান্ড ব্যবহার করে।

curl \
  --data "grant_type=refresh_token" \
  --data "client_id=CLIENT_ID" \
  --data "client_secret=CLIENT_SECRET" \
  --data "refresh_token=REFRESH_TOKEN" \
  https://www.googleapis.com/oauth2/v3/token

এরপর, আপনার অ্যাকাউন্টে প্রচারাভিযানগুলি পুনরুদ্ধার করতে GoogleAdsService.SearchStream পদ্ধতি ব্যবহার করে একটি প্রচারাভিযান প্রতিবেদন চালান৷ এই নির্দেশিকা প্রতিবেদনের বিবরণ কভার করে না।

curl -i -X POST https://googleads.googleapis.com/v18/customers/CUSTOMER_ID/googleAds:searchStream \
   -H "Content-Type: application/json" \
   -H "Authorization: Bearer ACCESS_TOKEN" \
   -H "developer-token: DEVELOPER_TOKEN" \
   -H "login-customer-id: LOGIN_CUSTOMER_ID" \
   --data-binary "@query.json"

query.json এর বিষয়বস্তু নিম্নরূপ:

{
  "query": "SELECT campaign.id, campaign.name, campaign.network_settings.target_content_network FROM campaign ORDER BY campaign.id"
}