เรียก API

คู่มือนี้กำหนดให้มีการตั้งค่าเบื้องต้นหลายรายการซึ่งกำหนดค่าไว้ในขั้นตอนก่อนหน้า เริ่มต้นด้วยการแนะนำหากยังไม่ได้ทำ

คู่มือนี้ยังใช้โทเค็นรีเฟรช ซึ่งเป็นเวิร์กโฟลว์ที่ผู้ใช้ที่มีสิทธิ์เข้าถึงบัญชี Google Ads เพียงพอสามารถให้สิทธิ์แอปของคุณในการตั้งค่าแบบครั้งเดียวเพื่อเรียกใช้ API ออฟไลน์กับบัญชีได้โดยไม่ต้องมีการแทรกแซงจากผู้ใช้อีก คุณสามารถใช้โทเค็นรีเฟรชเพื่อสร้างทั้งเวิร์กโฟลว์ออฟไลน์ เช่น งาน Cron หรือไปป์ไลน์ข้อมูล และเวิร์กโฟลว์แบบอินเทอร์แอกทีฟ เช่น เว็บหรือแอปบนอุปกรณ์เคลื่อนที่

ดึงข้อมูลโทเค็นการรีเฟรช

Google Ads API ใช้ OAuth 2.0 เป็นกลไกการให้สิทธิ์ โดยค่าเริ่มต้น การตรวจสอบสิทธิ์ OAuth 2.0 จะออกโทเค็นการเข้าถึงที่หมดอายุหลังจากผ่านไปตามระยะเวลาที่จำกัด หากต้องการต่ออายุโทเค็นการเข้าถึงโดยอัตโนมัติ ให้ออกโทเค็นการรีเฟรชแทน

oauth2l

1. สร้างโทเค็นการรีเฟรชโดยเรียกใช้เครื่องมือ oauth2l

   oauth2l fetch --credentials credentials.json --scope adwords \
       --output_format refresh_token

   ไฟล์ credentials.json มาจากขั้นตอนก่อนหน้า

2. คำสั่ง oauth2l จะเปิดหน้าต่างการเข้าสู่ระบบบัญชี Google ในหน้าต่างเบราว์เซอร์ใหม่และนำคุณไปยังขั้นตอนการตรวจสอบสิทธิ์ OAuth 2.0

   ตรวจสอบว่าคุณลงชื่อเข้าใช้โดยใช้อีเมลจากขั้นตอนที่คุณระบุรหัสลูกค้าสำหรับการเข้าสู่ระบบ

   หากแอปของคุณไม่ได้รับการยืนยัน คุณอาจเห็นหน้าจอคำเตือน ในกรณีเช่นนี้ คุณคลิกลิงก์แสดงขั้นสูงและคลิกตัวเลือกไปที่ PROJECT_NAME (ยังไม่ยืนยัน) ได้

   

3. หลังจากยืนยันขอบเขตแล้ว ให้ให้สิทธิ์โดยคลิกปุ่มดำเนินการต่อ

   ข้อความแจ้งจะปรากฏในเบราว์เซอร์พร้อมข้อความต่อไปนี้

   Authorization code granted. Close this tab.
   

   คำสั่ง oauth2l จะแสดงข้อมูลโค้ด JSON ต่อไปนี้

   {
     "client_id": "******.apps.googleusercontent.com",
     "client_secret": "******",
     "token_uri": "https://oauth2.googleapis.com/token",
     "auth_uri": "https://accounts.google.com/o/oauth2/auth",
     "refresh_token": "******",
     "type": "authorized_user"
   }
   

gcloud CLI

1. สร้างโทเค็นการรีเฟรชโดยเรียกใช้เครื่องมือ gcloud CLI

   gcloud auth application-default \
     login --scopes=https://www.googleapis.com/auth/adwords,https://www.googleapis.com/auth/cloud-platform \
     --client-id-file=<path_to_credentials.json>

   ไฟล์ credentials.json มาจากขั้นตอนก่อนหน้า

2. คำสั่ง gcloud จะเปิดหน้าต่างการเข้าสู่ระบบบัญชี Google ในหน้าต่างเบราว์เซอร์ใหม่และนำคุณไปยังขั้นตอนการตรวจสอบสิทธิ์ OAuth 2.0

   ตรวจสอบว่าคุณลงชื่อเข้าใช้โดยใช้อีเมลจากขั้นตอนที่คุณระบุรหัสลูกค้าสำหรับการเข้าสู่ระบบ

   หากแอปของคุณไม่ได้รับการยืนยัน คุณอาจเห็นหน้าจอคำเตือน ในกรณีเช่นนี้ คุณคลิกลิงก์แสดงขั้นสูงและคลิกตัวเลือกไปที่ PROJECT_NAME (ยังไม่ยืนยัน) ได้

   

3. หลังจากยืนยันขอบเขตแล้ว ให้คลิกปุ่มต่อไปเพื่อให้สิทธิ์

   เบราว์เซอร์จะไปยัง https://cloud.google.com/sdk/auth_success ซึ่งบ่งบอกว่าการตรวจสอบสิทธิ์สําเร็จ

   Authorization code granted. Close this tab.
   

   คำสั่ง gcloud จะแสดงผลลัพธ์ดังต่อไปนี้

   Credentials saved to file: [/****/.config/gcloud/application_default_credentials.json]
   

   จากนั้นเปิดไฟล์ application_default_credentials.json เนื้อหาควรมีลักษณะคล้ายกับตัวอย่างต่อไปนี้

   {
     "account": "",
     "client_id": "******.apps.googleusercontent.com",
     "client_secret": "******",
     "refresh_token": "******",
     "type": "authorized_user",
     "universe_domain": "googleapis.com"
   }
   

อื่นๆ

หากต้องการใช้ curl หรือไคลเอ็นต์ HTTP ของคุณเองแทน โปรดดูตัวอย่างในคู่มือ OAuth 2.0 สําหรับแอปบนอุปกรณ์เคลื่อนที่และเดสก์ท็อป

เรียก API

เลือกไคลเอ็นต์ที่ต้องการเพื่อดูวิธีการเรียก API

Java

ระบบจะเผยแพร่อาร์ติแฟกต์ไลบรารีไคลเอ็นต์ไปยังที่เก็บ Maven Central เพิ่ม ไลบรารีของไคลเอ็นต์เป็นทรัพยากร Dependency ลงในโปรเจ็กต์ ดังนี้

ทรัพยากร Dependency ของ Maven มีดังนี้

<dependency>
  <groupId>com.google.api-ads</groupId>
  <artifactId>google-ads</artifactId>
  <version>34.0.0</version>
</dependency>

ทรัพยากร Dependency ของ Gradle มีดังนี้

implementation 'com.google.api-ads:google-ads:34.0.0'

สร้างไฟล์ ~/ads.properties ที่มีเนื้อหาต่อไปนี้

api.googleads.clientId=INSERT_CLIENT_ID_HERE
api.googleads.clientSecret=INSERT_CLIENT_SECRET_HERE
api.googleads.refreshToken=INSERT_REFRESH_TOKEN_HERE
api.googleads.developerToken=INSERT_DEVELOPER_TOKEN_HERE
api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE

สร้างออบเจ็กต์ GoogleAdsClient ดังนี้

GoogleAdsClient googleAdsClient = null;
try {
  googleAdsClient = GoogleAdsClient.newBuilder().fromPropertiesFile().build();
} catch (FileNotFoundException fnfe) {
  System.err.printf(
      "Failed to load GoogleAdsClient configuration from file. Exception: %s%n",
      fnfe);
  System.exit(1);
} catch (IOException ioe) {
  System.err.printf("Failed to create GoogleAdsClient. Exception: %s%n", ioe);
  System.exit(1);
}

ถัดไป ให้เรียกใช้รายงานแคมเปญโดยใช้เมธอด GoogleAdsService.SearchStream เพื่อดึงข้อมูลแคมเปญในบัญชี คู่มือนี้ไม่ครอบคลุมรายละเอียดของการรายงาน

    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#

ระบบจะเผยแพร่แพ็กเกจไลบรารีของไคลเอ็นต์ไปยังที่เก็บ Nuget.org เริ่มต้นด้วยการเพิ่มการอ้างอิง NuGet ไปยังแพ็กเกจ Google.Ads.GoogleAds

dotnet add package Google.Ads.GoogleAds --version 18.1.0

สร้างออบเจ็กต์ GoogleAdsConfig ที่มีการตั้งค่าที่เกี่ยวข้อง และใช้ออบเจ็กต์ดังกล่าวเพื่อสร้างออบเจ็กต์ GoogleAdsClient

GoogleAdsConfig config = new GoogleAdsConfig()
{
    DeveloperToken = "******",
    OAuth2Mode = "APPLICATION",
    OAuth2ClientId = "******.apps.googleusercontent.com",
    OAuth2ClientSecret = "******",
    OAuth2RefreshToken = "******",
    LoginCustomerId = ******
};
GoogleAdsClient client = new GoogleAdsClient(config);

ถัดไป ให้เรียกใช้รายงานแคมเปญโดยใช้เมธอด GoogleAdsService.SearchStream เพื่อดึงข้อมูลแคมเปญในบัญชี คู่มือนี้ไม่ครอบคลุมรายละเอียดของการรายงาน

    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

ระบบจะเผยแพร่แพ็กเกจไลบรารีของไคลเอ็นต์ไปยังที่เก็บข้อมูลของ Packagist เปลี่ยนเป็นไดเรกทอรีรูทของโปรเจ็กต์ แล้วเรียกใช้คำสั่งต่อไปนี้เพื่อติดตั้งไลบรารีและไลบรารีที่ใช้ร่วมกันทั้งหมดในไดเรกทอรี vendor/ ของไดเรกทอรีรูทของโปรเจ็กต์

composer require googleads/google-ads-php:25.0.0

สร้างสําเนาไฟล์ google_ads_php.ini จากที่เก็บ GitHub และแก้ไขให้รวมข้อมูลเข้าสู่ระบบของคุณ

[GOOGLE_ADS]
developerToken = "INSERT_DEVELOPER_TOKEN_HERE"
loginCustomerId = "INSERT_LOGIN_CUSTOMER_ID_HERE"

[OAUTH2]
clientId = "INSERT_OAUTH2_CLIENT_ID_HERE"
clientSecret = "INSERT_OAUTH2_CLIENT_SECRET_HERE"
refreshToken = "INSERT_OAUTH2_REFRESH_TOKEN_HERE"

สร้างอินสแตนซ์ของออบเจ็กต์ GoogleAdsClient

$oAuth2Credential = (new OAuth2TokenBuilder())
    ->fromFile('/path/to/google_ads_php.ini')
    ->build();

$googleAdsClient = (new GoogleAdsClientBuilder())
    ->fromFile('/path/to/google_ads_php.ini')
    ->withOAuth2Credential($oAuth2Credential)
    ->build();

ถัดไป ให้เรียกใช้รายงานแคมเปญโดยใช้เมธอด GoogleAdsService.SearchStream เพื่อดึงข้อมูลแคมเปญในบัญชี คู่มือนี้ไม่ครอบคลุมรายละเอียดของการรายงาน

    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

ไลบรารีของไคลเอ็นต์จะเผยแพร่ใน PyPI และติดตั้งได้โดยใช้คําสั่ง pip ดังนี้

python -m pip install google-ads==21.3.0

ทำสำเนาไฟล์ google-ads.yaml จากที่เก็บ GitHub และแก้ไขให้รวมข้อมูลเข้าสู่ระบบของคุณ

client_id: INSERT_OAUTH2_CLIENT_ID_HERE
client_secret: INSERT_OAUTH2_CLIENT_SECRET_HERE
refresh_token: INSERT_REFRESH_TOKEN_HERE
developer_token: INSERT_DEVELOPER_TOKEN_HERE
login_customer_id: INSERT_LOGIN_CUSTOMER_ID_HERE

สร้างอินสแตนซ์ GoogleAdsClient โดยการเรียกใช้เมธอด GoogleAdsClient.load_from_storage ส่งเส้นทางไปยัง google-ads.yaml เป็นสตริงไปยังเมธอดเมื่อเรียกใช้

from google.ads.googleads.client import GoogleAdsClient
client = GoogleAdsClient.load_from_storage("path/to/google-ads.yaml")

ถัดไป ให้เรียกใช้รายงานแคมเปญโดยใช้เมธอด GoogleAdsService.SearchStream เพื่อดึงข้อมูลแคมเปญในบัญชี คู่มือนี้ไม่ครอบคลุมรายละเอียดของการรายงาน

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

เผยแพร่ Ruby Gem สําหรับไลบรารีของไคลเอ็นต์ไปยังเว็บไซต์โฮสติ้ง Rubygems Gem วิธีที่เราแนะนำในการติดตั้งคือการใช้เครื่องมือรวม เพิ่มบรรทัดลงใน Gemfile

gem 'google-ads-googleads', '~> 30.0.0'

จากนั้นเรียกใช้

bundle install

สร้างสําเนาไฟล์ google_ads_config.rb จากที่เก็บ GitHub และแก้ไขให้รวมข้อมูลเข้าสู่ระบบของคุณ

Google::Ads::GoogleAds::Config.new do |c|
  c.client_id = 'INSERT_CLIENT_ID_HERE'
  c.client_secret = 'INSERT_CLIENT_SECRET_HERE'
  c.refresh_token = 'INSERT_REFRESH_TOKEN_HERE'
  c.developer_token = 'INSERT_DEVELOPER_TOKEN_HERE'
  c.login_customer_id = 'INSERT_LOGIN_CUSTOMER_ID_HERE'
end

สร้างอินสแตนซ์ GoogleAdsClient โดยส่งเส้นทางไปยังตำแหน่งที่คุณเก็บไฟล์นี้ไว้

client = Google::Ads::GoogleAds::GoogleAdsClient.new('path/to/google_ads_config.rb')

ถัดไป ให้เรียกใช้รายงานแคมเปญโดยใช้เมธอด GoogleAdsService.SearchStream เพื่อดึงข้อมูลแคมเปญในบัญชี คู่มือนี้ไม่ครอบคลุมรายละเอียดของการรายงาน

    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

โดยเผยแพร่ไลบรารีใน CPAN เริ่มต้นด้วยการโคลนที่เก็บ google-ads-perl ในไดเรกทอรีที่ต้องการ

git clone https://github.com/googleads/google-ads-perl.git

เปลี่ยนเป็นไดเรกทอรี google-ads-perl แล้วเรียกใช้คำสั่งต่อไปนี้ที่คอมมานด์พรอมต์เพื่อติดตั้งไลบรารีทั้งหมดที่จำเป็นต่อการใช้งาน

cd google-ads-perl
cpan install Module::Build
perl Build.PL
perl Build installdeps

สร้างสําเนาไฟล์ googleads.properties จากที่เก็บ GitHub และแก้ไขให้รวมข้อมูลเข้าสู่ระบบของคุณ

clientId=INSERT_OAUTH2_CLIENT_ID_HERE
clientSecret=INSERT_OAUTH2_CLIENT_SECRET_HERE
refreshToken=INSERT_OAUTH2_REFRESH_TOKEN_HERE
developerToken=INSERT_DEVELOPER_TOKEN_HERE
loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE

สร้างอินสแตนซ์ Client โดยส่งเส้นทางไปยังตำแหน่งที่คุณเก็บไฟล์นี้

my $properties_file = "/path/to/googleads.properties";

my $api_client = Google::Ads::GoogleAds::Client->new({
  properties_file => $properties_file
});

ถัดไป ให้เรียกใช้รายงานแคมเปญโดยใช้เมธอด GoogleAdsService.SearchStream เพื่อดึงข้อมูลแคมเปญในบัญชี คู่มือนี้ไม่ครอบคลุมรายละเอียดของการรายงาน

    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

REST

เริ่มต้นด้วยการใช้ไคลเอ็นต์ HTTP เพื่อดึงข้อมูลโทเค็นการเข้าถึง OAuth 2.0 คู่มือนี้ใช้คำสั่ง curl

curl \
  --data "grant_type=refresh_token" \
  --data "client_id=CLIENT_ID" \
  --data "client_secret=CLIENT_SECRET" \
  --data "refresh_token=REFRESH_TOKEN" \
  https://www.googleapis.com/oauth2/v3/token

ถัดไป ให้เรียกใช้รายงานแคมเปญโดยใช้เมธอด GoogleAdsService.SearchStream เพื่อดึงข้อมูลแคมเปญในบัญชี คู่มือนี้ไม่ครอบคลุมรายละเอียดของการรายงาน

curl -i -X POST https://googleads.googleapis.com/v18/customers/CUSTOMER_ID/googleAds:searchStream \
   -H "Content-Type: application/json" \
   -H "Authorization: Bearer ACCESS_TOKEN" \
   -H "developer-token: DEVELOPER_TOKEN" \
   -H "login-customer-id: LOGIN_CUSTOMER_ID" \
   --data-binary "@query.json"

เนื้อหาของ query.json มีดังนี้

{
  "query": "SELECT campaign.id, campaign.name, campaign.network_settings.target_content_network FROM campaign ORDER BY campaign.id"
}