इस गाइड के लिए कई ज़रूरी सेटिंग की ज़रूरत है, जिन्हें इसमें कॉन्फ़िगर किया गया था पिछले चरण देखें. परिचय से शुरू करें, अगर आपने ऐसा नहीं किया है.
यह गाइड रीफ़्रेश टोकन का भी इस्तेमाल करती है. यह एक ऐसा वर्कफ़्लो है जिसमें उपयोगकर्ता Google Ads खाते के ऐक्सेस से आपके ऐप्लिकेशन को, एक बार के सेटअप में यह अनुमति दी जा सकती है: उपयोगकर्ता की किसी अन्य अनुमति के बिना, खाते में ऑफ़लाइन एपीआई कॉल कर सकते हैं. क्रॉन जॉब जैसे ऑफ़लाइन वर्कफ़्लो बनाने के लिए, रीफ़्रेश टोकन का इस्तेमाल किया जा सकता है और इंटरैक्टिव वर्कफ़्लो, जैसे कि वेब या मोबाइल ऐप्लिकेशन.
रीफ़्रेश टोकन फ़ेच करना
पुष्टि करने के तरीके के तौर पर, Google Ads API, OAuth 2.0 का इस्तेमाल करता है. डिफ़ॉल्ट रूप से, OAuth 2.0 पुष्टि करने से, ऐक्सेस टोकन की समस्या मिलती है. यह टोकन सीमित समय के बाद खत्म हो जाता है समय. ऐक्सेस टोकन को अपने-आप रिन्यू करने के लिए, आपको रीफ़्रेश टोकन का उपयोग करें.
यह चलाकर रीफ़्रेश टोकन जनरेट करें oauth2l टूल:
oauth2l fetch --credentials credentials.json --scope adwords \ --output_format refresh_token
credentials.json
फ़ाइल पिछले वर्शन की है चरण पूरा करें.oauth2l
निर्देश, नए ब्राउज़र में Google खाते की लॉगिन विंडो खोलता है यह आपको OAuth 2.0 पुष्टि करने के चरणों पर ले जाता है.पक्का करें कि आपने उस चरण में ईमेल पते का इस्तेमाल करके साइन इन किया है जहां ने आपके लॉगिन ग्राहक आईडी की पहचान की.
अगर आपके ऐप्लिकेशन की पुष्टि नहीं हुई है, तो आपको चेतावनी वाली स्क्रीन दिख सकती है. ऐसे मामलों में, तो बेहतर दिखाएँ लिंक पर क्लिक करना और PROJECT_NAME (पुष्टि नहीं हुई है) पर जाएं विकल्प को चुनें.
दायरों की पुष्टि करने के बाद, इस बटन पर क्लिक करके अनुमति दें जारी रखें बटन.
ब्राउज़र में इस टेक्स्ट के साथ एक प्रॉम्प्ट दिखता है:
Authorization code granted. Please 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" }
एपीआई कॉल करें
एपीआई कॉल करने का तरीका जानने के लिए, अपनी पसंद का क्लाइंट चुनें:
Java
क्लाइंट लाइब्रेरी के आर्टफ़ैक्ट, Maven सेंट्रल में पब्लिश किए गए हैं डेटा स्टोर करने की जगह के लिए. जोड़ें क्लाइंट लाइब्रेरी को आपके प्रोजेक्ट के हिसाब से डिपेंडेंसी के तौर पर इस तरह सेट किया गया है:
Maven डिपेंडेंसी:
<dependency>
<groupId>com.google.api-ads</groupId>
<artifactId>google-ads</artifactId>
<version>33.0.0</version>
</dependency>
Gradle डिपेंडेंसी:
implementation 'com.google.api-ads:google-ads:33.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());
}
}
}
}
C#
क्लाइंट लाइब्रेरी पैकेज, Nuget.org पर पब्लिश किए जाते हैं
डेटा स्टोर करने की जगह के लिए. सबसे पहले
Google.Ads.GoogleAds
पैकेज के लिए Nuget संदर्भ.
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.V17.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
क्लाइंट लाइब्रेरी पैकेज, Packagist पर पब्लिश किए गए हैं
डेटा स्टोर करने की जगह के लिए. इसमें बदलें
अपने प्रोजेक्ट की रूट डायरेक्ट्री को इंस्टॉल करें और इंस्टॉल करने के लिए, नीचे दिया गया कमांड चलाएं
लाइब्रेरी और इसकी सभी डिपेंडेंसी, vendor/
डायरेक्ट्री में
प्रोजेक्ट की रूट डायरेक्ट्री में मौजूद होगी.
composer require googleads/google-ads-php:22.0.0
इसकी एक कॉपी बनाएं
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
);
}
}
Python
क्लाइंट लाइब्रेरी PyPI पर वितरित की जाती है
pip
कमांड का इस्तेमाल करके इंस्टॉल किया जा सकता है
इस तरह से:
python -m pip install google-ads==21.3.0
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
इंस्टेंस बनाएं
GoogleAdsClient.load_from_storage
तरीका. अपना रास्ता
इस तरीके को कॉल करते समय, स्ट्रिंग के तौर पर 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.'
)
Ruby
क्लाइंट लाइब्रेरी के लिए Ruby जेम Rubygems gem” में पब्लिश किए गए हैं होस्ट करने वाली साइट पर जाएं. सुझाया गया तरीका इंस्टॉल करने के लिए बंडलर का इस्तेमाल किया जा रहा है. अपनी Gemफ़ाइल में कोई लाइन जोड़ें:
gem 'google-ads-googleads', '~> 30.0.0'
फिर चलाएं:
bundle install
इसकी एक कॉपी बनाएं
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
Perl
लाइब्रेरी यहां पर उपलब्ध है
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
इसकी एक कॉपी बनाएं
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::V17::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;
}
आराम
सबसे पहले, OAuth 2.0 ऐक्सेस टोकन को फ़ेच करने के लिए, एचटीटीपी क्लाइंट का इस्तेमाल करें. यह गाइड
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/v17/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"
}