Trang này được dịch bởi Cloud Translation API.

Bắt đầu

Bạn có thể sử dụng API Google Ad Manager để xây dựng ứng dụng quản lý khoảng không quảng cáo, tạo đơn đặt hàng, xuất báo cáo, v.v.

API Ad Manager sử dụng SOAP. Để giúp bạn bắt đầu, chúng tôi cung cấp thư viện ứng dụng dành 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 sau:

Nếu bạn chưa có tài khoản, hãy đăng ký tài khoản Ad Manager. Nếu muốn kiểm thử API trong một môi trường riêng, bạn cũng có thể tạo một mạng kiểm thử. 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 có thể tìm thấy mã 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ả các yêu cầu API Ad Manager bằng OAuth 2.0. Các bước dưới đây đề cập đến trường hợp sử dụng truy cập vào 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 bài viết Xác thực.

Mở trang Thông tin xác thực trong Bảng điều khiển API của Google
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 được cung cấp (không bắt buộc). Nhấp vào Create (Tạo).
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ụ.
Chọn Tài khoản dịch vụ mới rồi chọn JSON làm loại khoá.
Nhấp vào Tạo để tải tệp có chứa khoá riêng tư xuống.

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

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

Thiết lập ứng dụng

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

Các thẻ dưới đây cung cấp hướng dẫn bắt đầu nhanh để lập trình 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 cho thấy cách sử dụng thư viện ứng dụng Java. Để 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 tệp phân phối thư viện ứng dụng.

Thiết lập thông tin xác thực

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

curl https://raw.githubusercontent.com/googleads/googleads-java-lib/main/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
[...]

Chỉ định phần phụ thuộc

Chỉnh sửa tệp pom.xml và thêm nội dung sau đây 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>

Viết một số mã và đưa ra 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.v202402.Network;
import com.google.api.ads.admanager.axis.v202402.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());
  }
}

Xem trên GitHub

Python

Dưới đây là một ví dụ cơ bản cho thấy 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 phần phân phối thư viện ứng dụng.

Cài đặt thư viện và thiết lập thông tin đăng nhập 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/main/googleads.yaml \
     -o ~/googleads.yaml

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

Chạy một số mã và đưa ra 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='v202402')

# 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']))

Xem trên GitHub

1.199

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

Cài đặt thư viện và thiết lập thông tin đăng nhập 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:
```
composer require googleads/googleads-php-lib
curl https://raw.githubusercontent.com/googleads/googleads-php-lib/main/examples/AdManager/adsapi_php.ini -o ~/adsapi_php.ini
```

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"

Chạy một số mã và đưa ra yêu cầu!

Mã ví dụ này phải chạy từ dòng lệnh, không phải từ trình duyệt. Tệp chứa mã này phải nằm trong gốc của thư mục dự án, nơi composer require được chạy.

<?php
require 'vendor/autoload.php';
use Google\AdsApi\AdManager\AdManagerSession;
use Google\AdsApi\AdManager\AdManagerSessionBuilder;
use Google\AdsApi\AdManager\v202402\ApiException;
use Google\AdsApi\AdManager\v202402\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()
);

Xem trên GitHub

.NET

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

Tạo dự án mới
Mở Visual Studio rồi tạo một dự án mới (Ứng dụng cho Play Console).
Thêm tệp tham chiếu thư viện bắt buộc vào dự án
Thêm phần phụ thuộc nuget cho Google.Dfp.
Thiết lập App.config
Sao chép src\App.config vào thư mục dự án và thêm nó vào dự án của bạn. Nếu ứng dụng của bạn 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
- configuration/configSections/section[name="AdManagerApi"]
- cấu hình/system.net

Thông tin xác thực thiết lập

Mở App.config rồi 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" />

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

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

Xem trên GitHub

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 bạn không muốn đặt thông tin xác thực trong App.config, hãy tham khảo bài viết này trên wiki để biết các cách sử dụng thay thế cho 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 tệp 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 về NoClientLibrary.

Ruby

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

Cài đặt viên ngọc Ruby và lấy 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/main/ad_manager_api/ad_manager_api.yml -o ~/ad_manager_api.yml
```
Nếu gặp lỗi "cannot load such file -- mkmf (LoadError)" bất cứ lúc nào trong khi cài đặt ngọc, bạn có thể phải cài đặt thêm các thư viện phát triển Ruby khác, chẳng hạn như hồng ngọc, ruby-devel, xcode-select, v.v. cho môi trường cụ thể của mình.
Thiết lập thông tin xác thực
Điền các trường bắt buộc vào 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
```

Viết một số mã và đưa ra 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, :v202402)

# Make a request.
network = network_service.get_current_network()

puts "The current network is %s (%d)." %
        [network[:display_name], network[:network_code]]

Xem trên GitHub

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 qua thư viện ứng dụng của Ruby. Ngoài ra, hãy xem thư viện mẫu đầ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 ví dụ đó cho phù hợp với nhu cầu của bạn.

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

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

Bắt đầu

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

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

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

Thiết lập ứng dụng

Java

Python

1.199

.NET

Ruby

Các bước tiếp theo