Bạn đang tìm một API REST? Ad Manager API (Beta) hiện đã có.

Google sử dụng công nghệ AI để dịch nội dung sang ngôn ngữ bạn ưu tiên. Bản dịch bằng AI có thể có lỗi.

Bắt đầu

Bạn có thể sử dụng API SOAP của 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, xuất báo cáo và làm nhiều việc khác.

Để giúp bạn bắt đầu, chúng tôi cung cấp thư viện ứng dụng cho Java, .NET, Python, PHP và Ruby.

Để thực hiện yêu cầu API đầu tiên, hãy làm theo các bước sau:

Nếu 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 thử nghiệm nếu muốn kiểm thử API trong một môi trường riêng biệt. Xin lưu ý rằng bạn không cần tài khoản AdSense cho mục đích kiểm thử.

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 Ad Manager SOAP API bằng OAuth 2.0. Các bước sau đây trình bày 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 và các lựa chọn khác, hãy xem phần Xác thực.

Mở trang Thông tin đăng nhập của Google API Console
Trên trình đơn dự án, hãy chọn Tạo dự án, nhập tên cho dự án và bạn có thể chỉnh sửa Mã dự án được cung cấp. Nhấp vào 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, rồi chọn Khoá tài khoản dịch vụ.
Chọn Tài khoản dịch vụ mới và chọn JSON làm loại khoá.
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

Đă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 để chuyển sang trạng thái Đã 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. Các thư viện này cung cấp các hàm và tính năng trình bao bọc giúp bạn phát triển ứng dụng dễ dàng và nhanh chóng hơn.

Các thẻ sau đây cung cấp hướng dẫn nhanh về cách viết mã bằng từng ngôn ngữ mà có thư viện ứng dụng.

Java

Sau đây là một ví dụ cơ bản minh hoạ 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 bản phân phối thư viện ứng dụng.

Thiết lập thông tin đăng nhập

Chạy lệnh sau trong một giao diện dòng lệnh:

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 rồi điền 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 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 đoạn 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.v202608.Network;
import com.google.api.ads.admanager.axis.v202608.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

Sau đây là một ví dụ cơ bản cho biết cách sử dụng thư viện ứng dụng Python. Thư viện ứng dụng Python hỗ trợ Python phiên bản 3.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.

Cài đặt thư viện và thiết lập thông tin đăng nhập.

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

python3 -m 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='v202608')

# 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

PHP

Sau đây là một ví dụ cơ bản cho biết 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.
Chạy các lệnh sau trong một giao diện dòng lệnh để 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!

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

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

Sau đây là một ví dụ cơ bản cho biết cách sử 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 bảng điều khiển).
Thêm các tham chiếu thư viện bắt buộc vào dự án của bạn
Thêm một 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 rồi thêm thư mục đó vào dự á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:
- configuration/AdManagerApi
- configuration/configSections/section[name="AdManagerApi"]
- configuration/system.net

Thiết lập thông tin đăng nhậ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 cho thư viện

Bạn có thể gọi thư viện như minh hoạ 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 đăng nhập trong App.config, hãy tham khảo bài viết này trên wiki để biết các cách khác để 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 phần README . Nếu bạn muốn phát triển trong .NET mà không cần thư viện ứng dụng, vui lòng tham khảo bài viết NoClientLibrary trên wiki.

Ruby

Sau đây là một 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 Ruby yêu cầu Ruby 2.1 trở lên.

Cài đặt gem Ruby 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/main/ad_manager_api/ad_manager_api.yml -o ~/ad_manager_api.yml
```
Nếu gặp phải lỗi như "cannot load such file -- mkmf (LoadError)" tại bất kỳ thời điểm nào trong khi cài đặt gem, bạn có thể cần cài đặt các thư viện phát triển Ruby bổ sung như ruby-dev, ruby-devel, xcode-select, v.v. cho môi trường cụ thể của mình.
Thiết lập thông tin đăng nhập
Điền thông tin 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
```

Viết một đoạn 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, :v202608)

# 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 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 cho Ruby.

Các bước tiếp theo

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

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

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

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.

Có quyền truy cập vào một 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

PHP

.NET

Ruby

Các bước tiếp theo

Bắt đầu