Thư viện ứng dụng

Thư viện khách hàng của chúng tôi cung cấp chế độ xem cấp cao và các thành phần cơ bản của chức năng API Google Ads, giúp bạn phát triển ứng dụng một cách nhanh chóng và dễ dàng. Bạn nên bắt đầu bằng 1 thông báo nếu mới sử dụng API.

Thư viện ứng dụng Nguồn Hoạt động phân phối Ví dụ về mã
Java google-ads-java Maven, tar.gz Xem trên GitHub
.NET google-ads-dotnet nuget, tar.gz, zip Xem trên GitHub
PHP google-ads-php tar.gz Xem trên GitHub
Python google-ads-python tar.gz, zip Xem trên GitHub
Ruby google-ads-ruby gem, tar.gz, zip Xem trên GitHub
Perl google-ads-perl tar.gz, zip Xem trên GitHub

Phiên bản API được hỗ trợ

Bảng này cho biết thư viện ứng dụng nào hoạt động với phiên bản API nào.

Java

Thư viện ứng dụng cho Java
v18 Min: 34.0.0
Max: -
v17 Min: 32.0.0
Max: –
v16 Min: 30.0.0
Max: -

C#

Thư viện ứng dụng cho .NET
v18 Min: 21.1.0
Max: -
v17 Min: 20.1.0
Max: -
v16 Min: 18.1.0
Max: -

PHP

Thư viện ứng dụng cho PHP
v18 Min: 25.0.0
Max: –
v17 Min: 23.1.0
Max: –
v16 Min: 22.1.0
Max: -

Python

Thư viện ứng dụng cho Python
v18 Min: 25.1.0
Max: -
v17 Min: 24.1.0
Max: -
v16 Min: 23.1.0
Max: -

Ruby

Thư viện ứng dụng cho Ruby
v18 Min: 31.0.0
Max: -
v17 Min: 29.0.0
Max: –
v16 Min: 27.0.0
Max: -

Perl

Thư viện ứng dụng cho Perl
v18 Min: 25.0.0
Max: -
v17 Min: 23.0.0
Max: -
v16 Min: 21.0.0
Max: –

Cấu hình

Mỗi thư viện Ứng dụng API Google Ads cung cấp nhiều chế độ cài đặt cấu hình và phương thức tải mà bạn có thể sử dụng để tuỳ chỉnh hành vi của thư viện đó.

Dưới đây là những biến môi trường phổ biến với tất cả thư viện ứng dụng và có thể tải được để đặt chế độ cài đặt cấu hình:

  • Thư viện ứng dụng
    • GOOGLE_ADS_CONFIGURATION_FILE_PATH: Đường dẫn đến tệp cấu hình.
  • OAuth2
    • Chế độ ứng dụng
      • GOOGLE_ADS_CLIENT_ID : Đặt giá trị này thành mã ứng dụng OAuth2.
      • GOOGLE_ADS_CLIENT_SECRET : Đặt giá trị này thành mật khẩu ứng dụng khách OAuth2.
      • GOOGLE_ADS_REFRESH_TOKEN : Đặt giá trị này thành mã làm mới OAuth2 được tạo sẵn nếu bạn muốn sử dụng lại mã thông báo OAuth2. Bạn không bắt buộc phải sử dụng chế độ cài đặt này.
    • Chế độ tài khoản dịch vụ
      • GOOGLE_ADS_JSON_KEY_FILE_PATH : Đặt giá trị này thành đường dẫn tệp cấu hình JSON OAuth2.
      • GOOGLE_ADS_IMPERSONATED_EMAIL : Đặt giá trị này thành địa chỉ email của tài khoản bạn đang mạo danh.
  • API Google Ads
    • GOOGLE_ADS_DEVELOPER_TOKEN : Đặt giá trị này thành mã của nhà phát triển.
    • GOOGLE_ADS_LOGIN_CUSTOMER_ID : Đây là mã khách hàng của khách hàng được uỷ quyền để sử dụng trong yêu cầu, không có dấu gạch nối (-).
    • GOOGLE_ADS_LINKED_CUSTOMER_ID : Tiêu đề này chỉ bắt buộc cho các phương thức cập nhật tài nguyên của một thực thể khi được cấp quyền thông qua Tài khoản được liên kết trong giao diện người dùng Google Ads (tài nguyên AccountLink trong API Google Ads). Hãy đặt giá trị này thành mã khách hàng của trình cung cấp dữ liệu sẽ cập nhật tài nguyên của mã khách hàng được chỉ định. Không được đặt dấu gạch nối (-). Để tìm hiểu thêm về Tài khoản được liên kết, hãy truy cập vào Trung tâm trợ giúp.

Biến môi trường thường được xác định trong tệp cấu hình bash, chẳng hạn như tệp .bashrc hoặc .bash_profile nằm trong thư mục $HOME. Bạn cũng có thể xác định các tuỳ chọn này bằng dòng lệnh.

Dưới đây là một số bước cơ bản để xác định một biến môi trường bằng cách sử dụng tệp .bashrc thông qua thiết bị đầu cuối:

# Append the line "export GOOGLE_ADS_CLIENT_ID=1234567890" to
# the bottom of your .bashrc file.
echo "export GOOGLE_ADS_CLIENT_ID=1234567890" >> ~/.bashrc

# Update your bash environment to use the most recently updated
# version of your .bashrc file.
src ~/.bashrc

Bạn cũng có thể thiết lập các biến môi trường trong thực thể thiết bị đầu cuối ngay từ dòng lệnh:

export GOOGLE_ADS_CLIENT_ID=1234567890

Một cách khác là đặt biến môi trường khi gọi lệnh sử dụng các biến đó:

GOOGLE_ADS_CLIENT_ID=1234567890 php /path/to/script/that/uses/envvar.php

Phân trang tìm kiếm

GoogleAdsService.Search thường được dùng trong các ứng dụng tương tác cho thấy các trang kết quả. Kích thước trang cố định ở mức 10.000 kết quả trên mỗi trang.

Thư viện ứng dụng của chúng tôi tự động triển khai phân trang khi bạn lặp lại các kết quả để bạn có thể tải xuống và xử lý tuần tự tất cả kết quả cùng một lúc, ví dụ:

Java

private void runExample(GoogleAdsClient googleAdsClient, long customerId) {
  try (GoogleAdsServiceClient googleAdsServiceClient =
      googleAdsClient.getLatestVersion().createGoogleAdsServiceClient()) {
    String query = "SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id";
    // Constructs the SearchGoogleAdsStreamRequest.
    SearchGoogleAdsStreamRequest request =
        SearchGoogleAdsStreamRequest.newBuilder()
            .setCustomerId(Long.toString(customerId))
            .setQuery(query)
            .build();

    // Creates and issues a search Google Ads stream request that will retrieve all campaigns.
    ServerStream<SearchGoogleAdsStreamResponse> stream =
        googleAdsServiceClient.searchStreamCallable().call(request);

    // Iterates through and prints all of the results in the stream response.
    for (SearchGoogleAdsStreamResponse response : stream) {
      for (GoogleAdsRow googleAdsRow : response.getResultsList()) {
        System.out.printf(
            "Campaign with ID %d and name '%s' was found.%n",
            googleAdsRow.getCampaign().getId(), googleAdsRow.getCampaign().getName());
      }
    }
  }
}
GetCampaigns.java

C#

public void Run(GoogleAdsClient client, long customerId)
{
    // Get the GoogleAdsService.
    GoogleAdsServiceClient googleAdsService = client.GetService(
        Services.V18.GoogleAdsService);

    // Create a query that will retrieve all campaigns.
    string query = @"SELECT
                    campaign.id,
                    campaign.name,
                    campaign.network_settings.target_content_network
                FROM campaign
                ORDER BY campaign.id";

    try
    {
        // Issue a search request.
        googleAdsService.SearchStream(customerId.ToString(), query,
            delegate (SearchGoogleAdsStreamResponse resp)
            {
                foreach (GoogleAdsRow googleAdsRow in resp.Results)
                {
                    Console.WriteLine("Campaign with ID {0} and name '{1}' was found.",
                        googleAdsRow.Campaign.Id, googleAdsRow.Campaign.Name);
                }
            }
        );
    }
    catch (GoogleAdsException e)
    {
        Console.WriteLine("Failure:");
        Console.WriteLine($"Message: {e.Message}");
        Console.WriteLine($"Failure: {e.Failure}");
        Console.WriteLine($"Request ID: {e.RequestId}");
        throw;
    }
}
GetCampaigns.cs

PHP

public static function runExample(GoogleAdsClient $googleAdsClient, int $customerId)
{
    $googleAdsServiceClient = $googleAdsClient->getGoogleAdsServiceClient();
    // Creates a query that retrieves all campaigns.
    $query = 'SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id';
    // Issues a search stream request.
    /** @var GoogleAdsServerStreamDecorator $stream */
    $stream = $googleAdsServiceClient->searchStream(
        SearchGoogleAdsStreamRequest::build($customerId, $query)
    );

    // Iterates over all rows in all messages and prints the requested field values for
    // the campaign in each row.
    foreach ($stream->iterateAllElements() as $googleAdsRow) {
        /** @var GoogleAdsRow $googleAdsRow */
        printf(
            "Campaign with ID %d and name '%s' was found.%s",
            $googleAdsRow->getCampaign()->getId(),
            $googleAdsRow->getCampaign()->getName(),
            PHP_EOL
        );
    }
}
GetCampaigns.php

Python

def main(client, customer_id):
    ga_service = client.get_service("GoogleAdsService")

    query = """
        SELECT
          campaign.id,
          campaign.name
        FROM campaign
        ORDER BY campaign.id"""

    # Issues a search request using streaming.
    stream = ga_service.search_stream(customer_id=customer_id, query=query)

    for batch in stream:
        for row in batch.results:
            print(
                f"Campaign with ID {row.campaign.id} and name "
                f'"{row.campaign.name}" was found.'
            )
get_campaigns.py

Ruby

def get_campaigns(customer_id)
  # GoogleAdsClient will read a config file from
  # ENV['HOME']/google_ads_config.rb when called without parameters
  client = Google::Ads::GoogleAds::GoogleAdsClient.new

  responses = client.service.google_ads.search_stream(
    customer_id: customer_id,
    query: 'SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id',
  )

  responses.each do |response|
    response.results.each do |row|
      puts "Campaign with ID #{row.campaign.id} and name '#{row.campaign.name}' was found."
    end
  end
end
get_campaigns.rb

Perl

sub get_campaigns {
  my ($api_client, $customer_id) = @_;

  # Create a search Google Ads stream request that will retrieve all campaigns.
  my $search_stream_request =
    Google::Ads::GoogleAds::V18::Services::GoogleAdsService::SearchGoogleAdsStreamRequest
    ->new({
      customerId => $customer_id,
      query      =>
        "SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id"
    });

  # Get the GoogleAdsService.
  my $google_ads_service = $api_client->GoogleAdsService();

  my $search_stream_handler =
    Google::Ads::GoogleAds::Utils::SearchStreamHandler->new({
      service => $google_ads_service,
      request => $search_stream_request
    });

  # Issue a search request and process the stream response to print the requested
  # field values for the campaign in each row.
  $search_stream_handler->process_contents(
    sub {
      my $google_ads_row = shift;
      printf "Campaign with ID %d and name '%s' was found.\n",
        $google_ads_row->{campaign}{id}, $google_ads_row->{campaign}{name};
    });

  return 1;
}
get_campaigns.pl

Ví dụ về mã

Xem các đoạn mã ví dụ của chúng tôi về một số hàm phổ biến trong API Google Ads.