Bắt đầu

Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.

Nhà phát triển có thể sử dụng API Google Ad Manager để tạo các ứng dụng quản lý khoảng không quảng cáo, tạo đơn đặt hàng, lấy báo cáo và làm nhiều việc khác.

API Ad Manager sử dụng SOAP. Để giúp bạn bắt đầu, chúng tôi cung cấp các thư viện ứng dụng cho Java, .NET, Python, PHP và Ruby. Để tạo yêu cầu API đầu tiên, hãy làm theo các bước dưới đây.

Nhận quyền truy cập vào một mạng Ad Manager

Nếu bạn chưa có tài khoản, hãy đăng ký tài khoản Ad Manager. Bạn cũng có thể tạo một mạng kiểm thử nếu muốn kiểm thử API trong một môi trường riêng. Xin lưu ý rằng bạn không cần tài khoản AdSense cho mục đích thử nghiệm.

Ghi lại mã mạng của bạn. Bạn sẽ thấy URL này trong URL khi đăng nhập vào mạng của mình. Ví dụ: trong URL https://admanager.google.com/1234#home, 1234 là mã mạng của bạn.

Tạo thông tin xác thực

Bạn phải xác thực tất cả yêu cầu API Ad Manager bằng OAuth2. Các bước dưới đây trình bày trường hợp sử dụng đơn giản khi truy cập dữ liệu Ad Manager của riêng bạn. Để biết thêm thông tin chi tiết và các tuỳ chọn khác, hãy xem phần Xác thực.

  1. Mở trang Thông tin xác thực của Bảng điều khiển API của Google.
  2. Trên trình đơn dự án, hãy chọn Create project (Tạo dự án), nhập tên cho dự án và chỉnh sửa mã dự án đã cung cấp (không bắt buộc). Nhấp vào Tạo.
  3. Trên trang Thông tin xác thực, hãy chọn Tạo thông tin xác thực, sau đó chọn Khoá tài khoản dịch vụ.
  4. Chọn Tài khoản dịch vụ mới rồi chọn loại khoá là JSON.
  5. Nhấp vào Tạo để tải tệp chứa khoá riêng tư xuống.

Định cấu hình mạng Ad Manager

  1. Đăng nhập vào Google Ad Manager.
  2. Trong thanh bên, hãy nhấp vào Quản trị > Cài đặt chung.
  3. Trong phần Cài đặt chung > Quyền truy cập Api, nhấp vào thanh trượt để Bật.
  4. Nhấp vào nút Save (Lưu) ở cuối trang.

Thiết lập ứng dụng

Tải một trong những thư viện ứng dụng Ad Manager. Các thư viện này cung cấp chức năng và trình bao bọc giúp bạn dễ dàng và nhanh chóng phát triển ứng dụng hơn.

Các thẻ bên dưới cung cấp khởi động nhanh để mã hoá bằng từng ngôn ngữ có thư viện ứng dụng.

Java

Dưới đây là một ví dụ cơ bản về cách sử dụng thư viện ứng dụng Java. Để biết thêm thông tin sử dụng chi tiết, hãy tham khảo tệp README trong bản phân phối thư viện ứng dụng.

  1. Thiết lập thông tin xác thực của bạn

    Chạy lệnh sau trong shell:

    curl https://raw.githubusercontent.com/googleads/googleads-java-lib/master/examples/admanager_axis/src/main/resources/ads.properties -o ~/ads.properties
    Mở tệp ~/ads.properties và điền vào các trường sau:
    [...]
    api.admanager.applicationName=INSERT_APPLICATION_NAME_HERE
    api.admanager.jsonKeyFilePath=INSERT_PATH_TO_JSON_KEY_FILE_HERE
    api.admanager.networkCode=INSERT_NETWORK_CODE_HERE
    [...]
  2. Chỉ định các phần phụ thuộc

    Chỉnh sửa tệp pom.xml và thêm nội dung sau vào thẻ dependencies. Bạn có thể tìm thấy số phiên bản mới nhất trên GitHub.

    <dependency>
      <groupId>com.google.api-ads</groupId>
      <artifactId>ads-lib</artifactId>
      <version>RELEASE</version>
    </dependency>
    <dependency>
      <groupId>com.google.api-ads</groupId>
      <artifactId>dfp-axis</artifactId>
      <version>RELEASE</version>
    </dependency>

  3. Viết một vài mã rồi gửi yêu cầu!

    import com.google.api.ads.common.lib.auth.OfflineCredentials;
    import com.google.api.ads.common.lib.auth.OfflineCredentials.Api;
    import com.google.api.ads.admanager.axis.factory.AdManagerServices;
    import com.google.api.ads.admanager.axis.v202211.Network;
    import com.google.api.ads.admanager.axis.v202211.NetworkServiceInterface;
    import com.google.api.ads.admanager.lib.client.AdManagerSession;
    import com.google.api.client.auth.oauth2.Credential;
    
    public class App {
      public static void main(String[] args) throws Exception {
        Credential oAuth2Credential = new OfflineCredentials.Builder()
            .forApi(Api.AD_MANAGER)
            .fromFile()
            .build()
            .generateCredential();
    
        // Construct an AdManagerSession.
        AdManagerSession session = new AdManagerSession.Builder()
            .fromFile()
            .withOAuth2Credential(oAuth2Credential)
            .build();
    
        // Construct a Google Ad Manager service factory, which can only be used once per
        // thread, but should be reused as much as possible.
        AdManagerServices adManagerServices = new AdManagerServices();
    
        // Retrieve the appropriate service
        NetworkServiceInterface networkService = adManagerServices.get(session,
            NetworkServiceInterface.class);
    
        // Make a request
        Network network = networkService.getCurrentNetwork();
    
        System.out.printf("Current network has network code '%s' and display" +
            " name '%s'.%n", network.getNetworkCode(), network.getDisplayName());
      }
    }
    

Python

Sau đây là ví dụ cơ bản về cách sử dụng thư viện ứng dụng Python. Thư viện ứng dụng Python hỗ trợ Python v3.6 trở lên. Để biết thêm thông tin chi tiết về cách sử dụng, hãy tham khảo tệp README trong bản phân phối thư viện ứng dụng.

  1. Cài đặt thư viện và thiết lập thông tin xác thực của bạn.

    Chạy các lệnh sau trong một shell:

    pip install googleads
    curl https://raw.githubusercontent.com/googleads/googleads-python-lib/master/googleads.yaml \
         -o ~/googleads.yaml
    
  2. Thiết lập tệp ~/googleads.yaml.

    Điền vào các trường sau:

    ad_manager:
      application_name: INSERT_APPLICATION_NAME_HERE
      network_code: INSERT_NETWORK_CODE_HERE
      path_to_private_key_file: INSERT_PATH_TO_FILE_HERE
    
  3. Chạy một vài mã rồi gửi yêu cầu.
    # Import the library.
    from googleads import ad_manager
    
    # Initialize a client object, by default uses the credentials in ~/googleads.yaml.
    client = ad_manager.AdManagerClient.LoadFromStorage()
    
    # Initialize a service.
    network_service = client.GetService('NetworkService', version='v202211')
    
    # Make a request.
    current_network = network_service.getCurrentNetwork()
    
    print("Current network has network code '%s' and display name '%s'." %
            (current_network['networkCode'], current_network['displayName']))
    

PHP

Dưới đây là một ví dụ cơ bản về cách sử dụng thư viện ứng dụng PHP.

  1. Cài đặt thư viện và thiết lập thông tin xác thực của bạn.

    Chạy các lệnh sau trong một shell để cài đặt thư viện ứng dụng và tải tệp adsapi_php.ini xuống thư mục gốc của bạn:

    composer require googleads/googleads-php-lib
    curl https://raw.githubusercontent.com/googleads/googleads-php-lib/master/examples/AdManager/adsapi_php.ini -o ~/adsapi_php.ini
  2. Thiết lập tệp ~/adsapi_php.ini.

    Điền vào các trường sau:

    [AD_MANAGER]
    networkCode = "INSERT_NETWORK_CODE_HERE"
    applicationName = "INSERT_APPLICATION_NAME_HERE"
    
    [OAUTH2]
    jsonKeyFilePath = "INSERT_ABSOLUTE_PATH_TO_OAUTH2_JSON_KEY_FILE_HERE"
    scopes = "https://www.googleapis.com/auth/dfp"
    
  3. Chạy mã và gửi yêu cầu!
    <?php
    require 'vendor/autoload.php';
    use Google\AdsApi\AdManager\AdManagerSession;
    use Google\AdsApi\AdManager\AdManagerSessionBuilder;
    use Google\AdsApi\AdManager\v202211\ApiException;
    use Google\AdsApi\AdManager\v202211\ServiceFactory;
    use Google\AdsApi\Common\OAuth2TokenBuilder;
    
    // Generate a refreshable OAuth2 credential for authentication.
    $oAuth2Credential = (new OAuth2TokenBuilder())
        ->fromFile()
        ->build();
    // Construct an API session configured from a properties file and the OAuth2
    // credentials above.
    $session = (new AdManagerSessionBuilder())
        ->fromFile()
        ->withOAuth2Credential($oAuth2Credential)
        ->build();
    
    // Get a service.
    $serviceFactory = new ServiceFactory();
    $networkService = $serviceFactory->createNetworkService($session);
    
    // Make a request
    $network = $networkService->getCurrentNetwork();
    printf(
        "Network with code %d and display name '%s' was found.\n",
        $network->getNetworkCode(),
        $network->getDisplayName()
    );
    

.NET

Dưới đây là một ví dụ cơ bản về cách sử dụng thư viện ứng dụng.NET

  1. Tạo dự án mới

    Mở Visual Studio và tạo một dự án mới (ví dụ: Ứng dụng Console).

  2. Thêm tệp tham chiếu thư viện bắt buộc vào dự án của bạn

    Thêm phần phụ thuộc nuget cho Google.Dfp.

  3. Thiết lập tệp App.config

    Sao chép src\App.config vào thư mục dự án và thêm vào dự án của bạn. Nếu ứng dụng có App.config riêng, thì bạn có thể sao chép các nút sau vào App.config:

    • cấu hình/AdManagerApi
    • config/configSection/section[name="AdManagerApi"]
    • cấu hình/hệ thống.net
  4. Thiết lập thông tin xác thực

    Mở App.config và chỉnh sửa các khoá sau:

    <add key="ApplicationName" value="INSERT_YOUR_APPLICATION_NAME_HERE" />
    <add key="NetworkCode" value="INSERT_YOUR_NETWORK_CODE_HERE" />
    <add key="OAuth2Mode" value="SERVICE_ACCOUNT" />
    <add key="OAuth2SecretsJsonPath" value="INSERT_OAUTH2_SECRETS_JSON_FILE_PATH_HERE" />
    

  5. Gọi điện đến thư viện

    Bạn có thể gọi thư viện như minh hoạ trong đoạn mã C# sau đây

    AdManagerUser user = new AdManagerUser();
          using (InventoryService inventoryService = user.GetService<InventoryService>())
                {
                    // Create a statement to select ad units.
                    int pageSize = StatementBuilder.SUGGESTED_PAGE_LIMIT;
                    StatementBuilder statementBuilder =
                        new StatementBuilder().OrderBy("id ASC").Limit(pageSize);
    
                    // Retrieve a small amount of ad units at a time, paging through until all
                    // ad units have been retrieved.
                    int totalResultSetSize = 0;
                    do
                    {
                        AdUnitPage page =
                            inventoryService.getAdUnitsByStatement(statementBuilder.ToStatement());
    
                        // Print out some information for each ad unit.
                        if (page.results != null)
                        {
                            totalResultSetSize = page.totalResultSetSize;
                            int i = page.startIndex;
                            foreach (AdUnit adUnit in page.results)
                            {
                                Console.WriteLine(
                                    "{0}) Ad unit with ID \"{1}\" and name \"{2}\" was found.", i++,
                                    adUnit.id, adUnit.name);
                            }
                        }
    
                        statementBuilder.IncreaseOffsetBy(pageSize);
                    } while (statementBuilder.GetOffset() < totalResultSetSize);
    
                    Console.WriteLine("Number of results found: {0}", totalResultSetSize);
                }
            

Nếu không muốn đặt thông tin xác thực trong App.config, bạn hãy tham khảo bài viết này trên wiki để biết thêm các cách sử dụng lớp AdManagerUser. Để biết thêm thông tin chi tiết về cách sử dụng Thư viện ứng dụng .NET, hãy tham khảo README . Nếu bạn muốn phát triển bằng .NET mà không cần thư viện ứng dụng, vui lòng tham khảo bài viết trên wiki Thư viện.

Ruby

Dưới đây là một ví dụ cơ bản về cách sử dụng thư viện ứng dụng Ruby. Thư viện ứng dụng Ruby yêu cầu phiên bản Ruby 2.1 trở lên.

  1. Cài đặt ngọc quý và nhận tệp cấu hình.

    Chạy các lệnh sau trong một shell:

    gem install google-dfp-api
    curl https://raw.githubusercontent.com/googleads/google-api-ads-ruby/master/ad_manager_api/ad_manager_api.yml -o ~/ad_manager_api.yml
    

  2. Thiết lập thông tin xác thực của bạn

    Điền vào các trường bắt buộc trong tệp ~/ad_manager_api.yml. Nếu chưa có tệp khoá OAuth2, bạn cần làm theo các bước để tạo thông tin xác thực OAuth2.

    :authentication:
      :oauth2_keyfile: INSERT_PATH_TO_JSON_KEY_FILE_HERE
      :application_name: INSERT_APPLICATION_NAME_HERE
      :network_code: INSERT_NETWORK_CODE_HERE
    
  3. Viết một vài mã rồi gửi yêu cầu!
    # Import the library.
    require 'ad_manager_api'
    
    # Initialize an Ad Manager client instance (uses credentials in ~/ad_manager_api.yml by default).
    ad_manager = AdManagerApi::Api.new
    
    # Get a service instance.
    network_service = ad_manager.service(:NetworkService, :v202211)
    
    # Make a request.
    network = network_service.get_current_network()
    
    puts "The current network is %s (%d)." %
            [network[:display_name], network[:network_code]]
    

Bạn có thể xem các bước chi tiết hơn để bắt đầu trong tệp README được phân phối cùng với thư viện ứng dụng Ruby. Ngoài ra, hãy xem thư viện ví dụ đầy đủ của chúng tôi dành cho Ruby.

Các bước tiếp theo

Khi bạn đã thiết lập và chạy thư viện ứng dụng, hãy sửa đổi các ví dụ được cung cấp để mở rộng các thư viện đó cho nhu cầu của bạn.

Hãy xem tài liệu tham khảo để tìm hiểu thêm về API này.

Nếu bạn cần trợ giúp, hãy truy cập trang Hỗ trợ của chúng tôi.