เริ่มเลย

Java

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

1. ตั้งค่าข้อมูลเข้าสู่ระบบ

   เรียกใช้คำสั่งต่อไปนี้ในเชลล์

   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
   [...]

2. ระบุทรัพยากร Dependency

   แก้ไขไฟล์ 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>

3. เขียนโค้ดและส่งคำขอ

   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.v202408.Network;
   import com.google.api.ads.admanager.axis.v202408.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 เวอร์ชัน 3.6 ขึ้นไป ดูรายละเอียดการใช้งานเพิ่มเติม โปรดดูข้อมูลเพิ่มเติมที่ README ในการกระจายไลบรารีของไคลเอ็นต์

1. ติดตั้งไลบรารีและตั้งค่าข้อมูลเข้าสู่ระบบ

   เรียกใช้คำสั่งต่อไปนี้ใน Shell

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

2. ตั้งค่าไฟล์ ~/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
   

3. เรียกใช้โค้ดและส่งคำขอ

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

1. ติดตั้งไลบรารีและตั้งค่าข้อมูลเข้าสู่ระบบ

   เรียกใช้คำสั่งต่อไปนี้ใน 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

2. ตั้งค่าไฟล์ ~/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"
   

3. เรียกใช้โค้ดและส่งคำขอ

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

1. สร้างโปรเจ็กต์ใหม่

   เปิด Visual Studio และสร้างโปรเจ็กต์ใหม่ (แอปพลิเคชัน Console)

2. เพิ่มการอ้างอิงไลบรารีที่จำเป็นลงในโปรเจ็กต์

   เพิ่มทรัพยากร Dependency แบบ Nuget สำหรับ Google.Dfp

3. ตั้งค่า App.config

   คัดลอก src\App.config ไปยังไดเรกทอรีโปรเจ็กต์และเพิ่มลงในโปรเจ็กต์ หากแอปพลิเคชันมี App.config ของตนเอง คุณจะคัดลอกโหนดต่อไปนี้ลงใน App.config ได้

   • configuration/AdManagerApi
   • configuration/configSections/section[name="AdManagerApi"]
   • configuration/system.net
4. ตั้งค่าข้อมูลเข้าสู่ระบบ

   เปิด 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" />
   

5. โทรหาคลัง

   คุณสามารถเรียกใช้ไลบรารีดังที่แสดงในข้อมูลโค้ด 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 บทความ wiki

Ruby

ต่อไปนี้เป็นตัวอย่างพื้นฐานที่แสดงวิธีใช้ทับทิม ไลบรารีของไคลเอ็นต์ ไลบรารีของไคลเอ็นต์ Ruby ต้องใช้ Ruby 2.1 ขึ้นไป

1. ติดตั้ง Ruby gem และรับไฟล์การกำหนดค่า

   เรียกใช้คำสั่งต่อไปนี้ใน 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
   

2. ตั้งค่าข้อมูลเข้าสู่ระบบ

   ป้อนข้อมูลในช่องที่ต้องกรอกใน~/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
   

3. เขียนโค้ดและส่งคำขอ

   # 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, :v202408)
   
   # 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 และอย่าลืมดู ไลบรารีตัวอย่างของ Ruby