Looking for a REST API? The Ad Manager API (Beta) is now available.

本頁面由 Cloud Translation API 翻譯而成。

開始使用

您可以使用 Google Ad Manager SOAP API 建構應用程式，用於管理廣告空間、建立訂單、提取報表等。

為協助您開始使用，我們提供 Java、.NET、Python、PHP 和 Ruby 的用戶端程式庫。

如要發出第一個 API 要求，請按照下列步驟操作：

如果您還沒有 Ad Manager 帳戶，請申請一個帳戶。如要在個別環境中測試 API，您也可以建立測試網路。請注意，您不需要 AdSense 帳戶就能進行測試。

記下您的聯播網代碼。您可在登入後看到這個網址傳送至您的網路例如，在網址中 https://admanager.google.com/1234#home，1234 是你的聯播網代碼。

建立驗證憑證

您必須使用 OAuth 2.0 驗證所有 Ad Manager SOAP API 請求。以下步驟說明如何存取自己的 Ad Manager 資料。適用對象驗證：

開啟 Google API 控制台憑證頁面
從專案選單中選擇「Create project」(建立專案)，輸入專案名稱，並視需要編輯提供的專案 ID。點選「Create」(建立)。
在「憑證」頁面中，依序選取「建立憑證」和「服務帳戶金鑰」。
選取「New service account」(新增服務帳戶)，然後選取「JSON」做為金鑰類型。
按一下「建立」，下載內含私密金鑰的檔案。

設定 Ad Manager 聯播網

登入 Google Ads 經理。
按一下側欄中的「管理員」「管理員」>通用設定：
在「一般設定」下 > API 存取權按一下滑桿即可啟用。
按一下頁面底部的「儲存」按鈕。

設定用戶端

下載任一 Ad Manager 用戶端程式庫。這些程式庫提供包裝函式和功能，可讓您更輕鬆快速地開發應用程式。

以下分頁提供使用各種程式語言編寫程式的快速入門導覽課程其中包含用戶端程式庫

Java

以下這個基本範例說明如何使用 Java 用戶端程式庫。如要進一步瞭解使用資訊，請參閱 README 檔案。

設定憑證

在 Shell 中執行下列指令：

curl https://raw.githubusercontent.com/googleads/googleads-java-lib/main/examples/admanager_axis/src/main/resources/ads.properties -o ~/ads.properties

開啟 ~/ads.properties 檔案並填入下列欄位：

[...]
api.admanager.applicationName=INSERT_APPLICATION_NAME_HERE
api.admanager.jsonKeyFilePath=INSERT_PATH_TO_JSON_KEY_FILE_HERE
api.admanager.networkCode=INSERT_NETWORK_CODE_HERE
[...]

指定依附元件

編輯 pom.xml 檔案，並將下列內容新增至 dependencies 標記。您可以在 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>

撰寫程式碼並提出要求！

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.v202505.Network;
import com.google.api.ads.admanager.axis.v202505.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());
  }
}

前往 GitHub 查看

Python

以下為說明如何使用 Python 用戶端程式庫的基本範例。 Python 用戶端程式庫支援 Python v3.6+。如需用量詳細資料請參閱 README 檔案。

安裝程式庫並設定憑證。

在殼層中執行下列指令：

pip install googleads
curl https://raw.githubusercontent.com/googleads/googleads-python-lib/main/googleads.yaml \
     -o ~/googleads.yaml

設定 ~/googleads.yaml 檔案。

填妥以下欄位：

ad_manager:
  application_name: INSERT_APPLICATION_NAME_HERE
  network_code: INSERT_NETWORK_CODE_HERE
  path_to_private_key_file: INSERT_PATH_TO_FILE_HERE

執行程式碼並發出要求。

# 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='v202505')

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

前往 GitHub 查看

PHP

這個基本範例說明如何使用 PHP 用戶端程式庫。

安裝程式庫並設定憑證。

在 Shell 中執行下列指令，安裝用戶端程式庫，並將 adsapi_php.ini 檔案下載至您的主目錄：

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

設定您的 ~/adsapi_php.ini 檔案。

填妥以下欄位：

[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"

執行程式碼並提出要求！

このサンプルコードは、ブラウザではなくコマンドラインから実行してください。包含此程式碼的檔案必須位於專案目錄的根目錄中，也就是執行 composer require 的位置。

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

前往 GitHub 查看

.NET

以下是基本範例，說明如何使用 .NET 用戶端程式庫

建立新專案
開啟 Visual Studio，並建立新專案 (控制台應用程式)。
在專案中加入必要的程式庫參考資料
為 Google.Dfp 新增 NuGet 依附元件。
設定 App.config
將 src\App.config 複製到專案目錄，然後新增至專案。如果您的應用程式有自己的 App.config，您可以將下列節點複製到 App.config 中：
- configuration/AdManagerApi
- configuration/configSections/section[name="AdManagerApi"]
- configuration/system.net

設定憑證

開啟 App.config，然後編輯下列鍵：

<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" />

呼叫程式庫

您可以呼叫程式庫，如以下 C# 程式碼片段所示

前往 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);
            }

如果您不想在 App.config 中設定憑證，請參閱這篇維基百科文章，瞭解使用 AdManagerUser 類別的其他方法。如要進一步瞭解如何使用 .NET 用戶端程式庫，請參閱給 README 。如果您想在 .NET 中開發，但不使用用戶端程式庫，請參閱 NoClientLibrary 維基文章。

小茹

以下是基本範例，說明如何使用 Ruby 用戶端程式庫。Ruby 用戶端程式庫需要 Ruby 2.1 以上版本。

安裝 Ruby gem 並取得設定檔。
在殼層中執行下列指令：
```
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
```
如果發生「cannot load such file -- mkmf (LoadError)」等錯誤安裝寶石時您可能需要安裝額外的 Ruby 開發程式庫，例如 ruby-dev ruby-devel、xcode-select 等特定環境適用的 ID。

設定憑證

填入 ~/ad_manager_api.yml 中的必填欄位檔案。如果您還沒有 OAuth2 金鑰檔案，請按照這篇文章中的步驟建立 OAuth2 憑證。

:authentication:
  :oauth2_keyfile: INSERT_PATH_TO_JSON_KEY_FILE_HERE
  :application_name: INSERT_APPLICATION_NAME_HERE
  :network_code: INSERT_NETWORK_CODE_HERE

撰寫程式碼並提出要求！

# 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, :v202505)

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

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

前往 GitHub 查看

如需詳細的入門步驟，請參閱 README 檔案。另外，您也可以參閱我們的完整 Ruby 適用的範例程式庫

後續步驟

用戶端程式庫啟動並運作後，請修改提供的範例，以便根據需求擴充範例。

請參閱參考資料說明文件，進一步瞭解 API。

如需協助，請前往支援頁面。

開始使用 透過集合功能整理內容 你可以依據偏好儲存及分類內容。

取得 Ad Manager 聯播網的存取權

建立驗證憑證

設定 Ad Manager 聯播網

設定用戶端

Java

Python

PHP

.NET

小茹

後續步驟

開始使用