Search Ads 360 Reporting API का नया वर्शन अब उपलब्ध है. आने वाले समय में किए जाने वाले बदलावों और रिलीज़ के बारे में अप-टू-डेट रहने के लिए, searchads-api-announcements Google ग्रुप में शामिल हों.

इस पेज का अनुवाद Cloud Translation API से किया गया है.

Search Ads 360 Reporting API का इस्तेमाल शुरू करना

नीचे दिए गए सेक्शन में, Search Ads 360 Reporting API का इस्तेमाल शुरू करने का तरीका बताया गया है.

Google Cloud पर अपना प्रोजेक्ट सेट अप करना

Search Ads 360 Reporting API का इस्तेमाल करने के लिए, आपको Google Cloud पर अपने ऐप्लिकेशन के लिए एक प्रोजेक्ट बनाना होगा.

Google प्रोजेक्ट बनाना

Google प्रोजेक्ट, आपके Google Cloud संसाधनों के लिए संसाधन कंटेनर के तौर पर काम करता है.

OAuth2 क्रेडेंशियल बनाना

Search Ads 360 Reporting API, पुष्टि और अनुमति के लिए OAuth 2.0 का इस्तेमाल करता है. OAuth क्रेडेंशियल, Google को आपके ऐप्लिकेशन की पहचान करते हैं. साथ ही, Search Ads 360 के उपयोगकर्ताओं को मैनेज करने के लिए, OAuth टोकन जनरेट करने की अनुमति देते हैं.

Search Ads 360 Reporting API को चालू करना

एपीआई का इस्तेमाल करने के लिए, आपको Google API Console में अपने प्रोजेक्ट के लिए Search Ads 360 Reporting API चालू करना होगा.

आपके पास अपने प्रोजेक्ट के लिए बिलिंग की सुविधा चालू करने का विकल्प है

Google Cloud में Search Ads 360 Reporting API का इस्तेमाल करने के लिए कोई शुल्क नहीं लिया जाता. हालांकि, हर खाते के लिए मुफ़्त Cloud प्रोजेक्ट की कुल संख्या का कोटा तय होता है. अगर आपने प्रोजेक्ट की तय सीमा पूरी कर ली है, तो नए Google खाते के लिए साइन अप करें. इसमें आपको मुफ़्त में प्रोजेक्ट बनाने की तय सीमा मिलेगी.

अपने प्रोजेक्ट की सहमति वाली स्क्रीन चालू करना

रीडायरेक्ट यूआरआई बनाना, उनमें बदलाव करना या उन्हें देखना

क्लाइंट लाइब्रेरी डाउनलोड करना

Search Ads 360 Reporting API से कनेक्ट करने के लिए, Search Ads 360 Reporting API क्लाइंट लाइब्रेरी का इस्तेमाल करने का सुझाव दिया जाता है.

अपने डेवलपमेंट एनवायरमेंट के लिए, Search Ads 360 Reporting API क्लाइंट लाइब्रेरी डाउनलोड करें. क्लाइंट लाइब्रेरी कॉन्फ़िगरेशन फ़ाइल को सेट अप करने का तरीका जानने के लिए, भाषा के हिसाब से दिए गए निर्देशों का पालन करें. ज़्यादातर मामलों में, Search Ads 360 Reporting API की नई क्लाइंट लाइब्रेरी पर माइग्रेट करते समय, अपने मौजूदा कॉन्फ़िगरेशन का फिर से इस्तेमाल किया जा सकता है.

एक अहम बदलाव यह है कि अब login-customer-id हेडर नया है. आपको इसे अपने कॉन्फ़िगरेशन में कब जोड़ना है, इस बारे में जानने के लिए लॉगिन ग्राहक आईडी हेडर देखें.

अपना पहला कॉल करना

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

कैंपेन पाना

अपने आईडीई में, यह कोड लागू करें:

Java

// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package sample;

import com.beust.jcommander.Parameter;
import com.google.ads.searchads360.v0.lib.SearchAds360Client;
import com.google.ads.searchads360.v0.services.SearchAds360Row;
import com.google.ads.searchads360.v0.services.SearchAds360ServiceClient;
import com.google.ads.searchads360.v0.services.SearchAds360ServiceClient.SearchPagedResponse;
import com.google.ads.searchads360.v0.services.SearchSearchAds360Request;

/** Get campaign details. */
public class GetCampaigns {
  private static final int PAGE_SIZE = 200;

  private static class GetCampaignsParams extends CodeSampleParams {

    @Parameter(names = "--customerId", required = true)
    private String customerId;

    @Parameter(names = "--loginCustomerId")
    private String loginCustomerId;
  }

  public static void main(String[] args) {
    GetCampaignsParams params = new GetCampaignsParams();
    if (!params.parseArguments(args)) {
      // Optional: You may pass the loginCustomerId on the command line or specify a loginCustomerId
      // here (10 digits, no dashes). If neither are set, customerId will be used as
      // loginCustomerId.
      // params.loginCustomerId = Long.parseLong("INSERT_LOGIN_CUSTOMER_ID_HERE");
    }
    final String loginCustomerId = params.loginCustomerId;
    final String customerId = params.customerId;

    try {
      // Creates a SearchAds360Client with the specified loginCustomerId. If there's
      // no loginCustomerId, customerId will be used instead.
      final SearchAds360Client searchAds360Client =
          SearchAds360Client.newBuilder()
              .setLoginCustomerId(loginCustomerId == null ? customerId : loginCustomerId)
              .fromPropertiesFile()
              .build();
      // Creates the Search Ads 360 Service client.
      SearchAds360ServiceClient client = searchAds360Client.create();
      new GetCampaigns().runExample(client, customerId);
    } catch (Exception exception) {
      System.err.printf("Failed with exception: %s%n", exception);
      exception.printStackTrace();
      System.exit(1);
    }
  }

  private void runExample(SearchAds360ServiceClient searchAds360ServiceClient, String customerId) {
    // Creates a query that retrieves all campaigns under the customerId.
    String query = "SELECT campaign.name, campaign.id, campaign.status FROM campaign";
    SearchSearchAds360Request request =
        SearchSearchAds360Request.newBuilder()
            .setCustomerId(customerId)
            .setQuery(query)
            .setPageSize(PAGE_SIZE)
            .build();

    // Issues a search request.
    final SearchPagedResponse searchPagedResponse = searchAds360ServiceClient.search(request);
    for (SearchAds360Row element : searchPagedResponse.iterateAll()) {
      System.out.printf(
          "Campaign found with name '%s', ID %d, and status: %s.%n",
          element.getCampaign().getName(),
          element.getCampaign().getId(),
          element.getCampaign().getStatus());
    }
  }
}

GetCampaigns.java डाउनलोड करें

Python

#!/usr/bin/env python
# Copyright 2022 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Retrieves campaigns for a customer using a pagination search request."""

import argparse
import traceback
from google.ads.searchads360.v0.services.types.search_ads360_service import SearchSearchAds360Request
from util_searchads360 import SearchAds360Client

_DEFAULT_PAGE_SIZE = 10000


def main(client, customer_id, page_size) -> None:
  search_ads_360_service = client.get_service()

  query = """
      SELECT
        campaign.name,
        campaign.id,
        campaign.status
      FROM campaign"""

  request = SearchSearchAds360Request()
  request.customer_id = customer_id
  request.query = query
  request.page_size = page_size

  # Issues a search request.
  results = search_ads_360_service.search(request=request)

  for row in results:
    campaign = row.campaign
    print(
        f'campaign "{campaign.name}" has id {campaign.id} and status {campaign.status.name}'
    )


if __name__ == "__main__":
  # SearchAds360Client will read the search-ads-360.yaml configuration file in
  # the home directory if none is specified.
  search_ads_360_client = SearchAds360Client.load_from_file()

  parser = argparse.ArgumentParser(
      description=("Retrieves campaigns for a customer."))
  # Arguments to provide to run the example.
  parser.add_argument(
      "-c",
      "--customer_id",
      type=str,
      required=True,
      help="The Search Ads 360 customer ID (10 digits, no dashes).",
  )

  parser.add_argument(
      "-l",
      "--login_customer_id",
      type=str,
      required=False,
      help="The Search Ads 360 login customer ID (10 digits, no dashes).",
  )

  args = parser.parse_args()

  search_ads_360_client.set_ids(args.customer_id, args.login_customer_id)

  try:
    main(search_ads_360_client, args.customer_id, _DEFAULT_PAGE_SIZE)
  except Exception:  # pylint: disable=broad-except
    traceback.print_exc()

get_campaigns.py डाउनलोड करें

कंसोल में, आपके खाते के कैंपेन की लिस्टिंग दिखनी चाहिए.

REST का इस्तेमाल करना

अगर आपको क्लाइंट लाइब्रेरी का इस्तेमाल नहीं करना है, तो आपको REST का इस्तेमाल करने का तरीका समझना होगा.

अगर आपने Search Ads 360 के पुराने एपीआई के साथ REST का इस्तेमाल किया है, तो आपके क्रेडेंशियल अब भी Search Ads 360 Reporting API के नए वर्शन के साथ काम करेंगे. REST रेफ़रंस सेक्शन में, नया एंडपॉइंट और अन्य जानकारी देखें.

ज़्यादा जानें

Search Ads 360 Reporting API के बारे में ज़्यादा जानें