เริ่มต้นใช้งาน API

เอกสารนี้อธิบายวิธีเริ่มต้นเขียนแอปที่ใช้ Google Bid Manager API API ช่วยให้คุณจัดการได้ คำค้นหา และเรียกข้อมูล ข้อมูลเมตารายงาน

Bid Manager API v2 เป็นเวอร์ชันล่าสุดที่พร้อมใช้งานและแนะนํา

1. ก่อนจะเริ่ม

หากไม่คุ้นเคยกับแนวคิดของ Google Display & Video 360 โปรดอ่านศูนย์ช่วยเหลือของ Display & Video 360 และลองใช้ UI

2. เตรียมพร้อมสำหรับการตรวจสอบสิทธิ์

ในการเริ่มต้นใช้งาน Bid Manager API ก่อนอื่นคุณต้องใช้เครื่องมือการตั้งค่า ซึ่งจะนำทางคุณในการสร้างโปรเจ็กต์ในคอนโซล Google API เปิดใช้ API ดังกล่าว และสร้างข้อมูลเข้าสู่ระบบ

หากยังไม่ได้สร้าง ให้สร้างข้อมูลเข้าสู่ระบบ OAuth 2.0 โดยคลิกสร้างข้อมูลเข้าสู่ระบบ > รหัสไคลเอ็นต์ OAuth หลังจากสร้างข้อมูลเข้าสู่ระบบแล้ว คุณจะเห็นรหัสไคลเอ็นต์ในหน้าข้อมูลเข้าสู่ระบบ คลิก รหัสไคลเอ็นต์สำหรับรายละเอียด เช่น รหัสลับไคลเอ็นต์, URI การเปลี่ยนเส้นทาง, JavaScript อีเมลต้นทางและอีเมล

สำหรับข้อมูลเพิ่มเติม โปรดดู ให้สิทธิ์คำขอ

3. เรียกใช้ Bid Manager API

แท็บด้านล่างแสดงการเริ่มต้นใช้งานอย่างรวดเร็วสําหรับการเขียนโค้ดในภาษาต่างๆ นอกจากนี้ คุณยังดูโค้ดตัวอย่างที่คล้ายกันได้ในรีโปตัวอย่าง Bid Manager API

JavaPythonPHP

1. นำเข้าไลบรารีที่จำเป็น

   import static java.nio.charset.StandardCharsets.UTF_8;
   import com.google.api.client.auth.oauth2.Credential;
   import com.google.api.client.extensions.java6.auth.oauth2.AuthorizationCodeInstalledApp;
   import com.google.api.client.extensions.jetty.auth.oauth2.LocalServerReceiver;
   import com.google.api.client.googleapis.auth.oauth2.GoogleAuthorizationCodeFlow;
   import com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets;
   import com.google.api.client.googleapis.util.Utils;
   import com.google.api.services.doubleclickbidmanager.DoubleClickBidManager;
   import com.google.api.services.doubleclickbidmanager.model.ListQueriesResponse;
   import com.google.api.services.doubleclickbidmanager.model.Query;
   import java.io.Reader;
   import java.nio.file.Files;
   import java.nio.file.Paths;

2. โหลดไฟล์รหัสลับไคลเอ็นต์และสร้างข้อมูลเข้าสู่ระบบการให้สิทธิ์

   ครั้งแรกที่ดำเนินการขั้นตอนนี้ ระบบจะขอให้คุณยอมรับการให้สิทธิ์ ในเบราว์เซอร์ ก่อนยอมรับ โปรดตรวจสอบว่าคุณลงชื่อเข้าใช้ด้วยบัญชี Google ที่มีสิทธิ์เข้าถึง Display & Video 360 แอปของคุณจะได้รับสิทธิ์เข้าถึงข้อมูลในนามของบัญชีที่ลงชื่อเข้าใช้อยู่

   // Read client secrets file.
   GoogleClientSecrets clientSecrets;
   try (Reader reader = Files.newBufferedReader(Paths.get(path-to-client-secrets-file), UTF_8)) {
     clientSecrets = GoogleClientSecrets.load(Utils.getDefaultJsonFactory(), reader);
   }
   
   // Generate authorization credentials.
   // Set up the authorization code flow.
   GoogleAuthorizationCodeFlow flow =
       new GoogleAuthorizationCodeFlow.Builder(
           Utils.getDefaultTransport(),
           Utils.getDefaultJsonFactory(),
           clientSecrets,
           oauth-scopes)
       .build();
   
   Credential credential =
       new AuthorizationCodeInstalledApp(flow, new LocalServerReceiver()).authorize("user");

3. สร้างไคลเอ็นต์ API ที่ได้รับอนุญาต

   // Create authorized API client.
   DoubleClickBidManager service =
       new DoubleClickBidManager.Builder(credential.getTransport(), credential.getJsonFactory(), credential)
           .setApplicationName("bidmanager-java-installed-app-sample")
           .build();

4. ดำเนินการ

   // Perform an operation.
   // Call the API, getting a list of 10 queries.
   ListQueriesResponse queriesResponse = service.queries().list().setPageSize(10).execute();
   
   // Print them out.
   System.out.println("Id\t\tName");
   if (queriesResponse.getQueries().size() > 0) {
     for (int i = 0; i < queriesResponse.getQueries().size(); i++) {
       Query currentQuery = queriesResponse.getQueries().get(i);
       System.out.printf(
           "%s\t%s%n",
           currentQuery.getQueryId(),
           currentQuery.getMetadata().getTitle());
     }
   } else {
     System.out.println("No queries exist.");
   }

ดูข้อมูลโดยละเอียดเพิ่มเติมเกี่ยวกับการใช้ Bid Manager API กับ Java ได้จากไฟล์ README ในตัวอย่าง Bid Manager API

1. นําเข้าไลบรารีที่จําเป็น

   from google_auth_oauthlib.flow import InstalledAppFlow
   from googleapiclient import discovery

2. โหลดไฟล์รหัสลับไคลเอ็นต์และสร้างข้อมูลเข้าสู่ระบบการให้สิทธิ์

   ครั้งแรกที่ดำเนินการขั้นตอนนี้ ระบบจะขอให้คุณยอมรับการให้สิทธิ์ ในเบราว์เซอร์ ก่อนยอมรับ โปรดตรวจสอบว่าคุณลงชื่อเข้าใช้ด้วยบัญชี Google ที่มีสิทธิ์เข้าถึง Display & Video 360 แอปของคุณจะได้รับสิทธิ์เข้าถึงข้อมูลในนามของบัญชีที่ลงชื่อเข้าใช้อยู่

   # Set up a flow object to create the credentials using the
   # client secrets file and OAuth scopes.
   credentials = InstalledAppFlow.from_client_secrets_file(
       path-to-client-secrets-file, oauth-scopes).run_local_server()

3. สร้างไคลเอ็นต์ API ที่ได้รับอนุญาต

   # Build the discovery document URL.
   discovery_url = f'https://doubleclickbidmanager.googleapis.com/$discovery/rest?version=v2'
   
   # Build the API service.
   service = discovery.build(
       'doubleclickbidmanager',
       'v2',
       discoveryServiceUrl=discovery_url,
       credentials=credentials)

4. ดําเนินการ

   # Build and execute queries.listqueries request.
   response = service.queries().list(pageSize='10').execute()
   
   # Print queries out.
   if 'queries' in response:
     print('Id\t\tName')
     for query in response['queries']:
       print('%s\t%s' % (query['queryId'], query['metadata']['title']))
   else:
     print('No queries exist.')

ดูข้อมูลโดยละเอียดเพิ่มเติมเกี่ยวกับการใช้ Bid Manager API กับ Python ได้จากไฟล์ README ในตัวอย่าง Bid Manager API

ตัวอย่างนี้สมมติว่าคุณกำลังเรียกใช้ PHP กับเว็บเซิร์ฟเวอร์ภายในและ ได้กำหนดค่าข้อมูลเข้าสู่ระบบของคุณให้เปลี่ยนเส้นทางไปยังหน้าเว็บที่เกี่ยวข้อง ตัวอย่างเช่น โค้ดนี้ในไฟล์ index.php สามารถเรียกใช้ได้โดยใช้คําสั่งและข้อมูลเข้าสู่ระบบต่อไปนี้ที่กําหนดค่าให้เปลี่ยนเส้นทางไปยัง http://localhost:8000 หลังการตรวจสอบสิทธิ์

php -S localhost:8000 -t ./

1. ดาวน์โหลดและติดตั้งไคลเอ็นต์ Google API PHP

   วิธีที่แนะนำคือผ่าน Composer

   composer require google/apiclient:^2.12.1

   เมื่อติดตั้งแล้ว โปรดตรวจสอบว่าได้รวมตัวโหลดอัตโนมัติแล้ว

   require_once '/path/to/your-project/vendor/autoload.php';

2. สร้างออบเจ็กต์ Google_Client

   $client = new Google_Client();

3. ตั้งค่าไคลเอ็นต์ เปลี่ยนเส้นทางไปยัง URL การตรวจสอบสิทธิ์หากจำเป็น แล้วเรียกโทเค็นเพื่อการเข้าถึง

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

   // Set up the client.
   $client->setApplicationName('DBM API PHP Samples');
   $client->addScope(oauth-scope);
   $client->setAccessType('offline');
   $client->setAuthConfigFile(path-to-client-secrets-file);
   
   // If the code is passed, authenticate. If not, redirect to authentication page.
   if (isset($_GET['code'])) {
     $client->authenticate($_GET['code']);
   } else {
     $authUrl = $client->createAuthUrl();
     header('Location: ' . $authUrl);
   }
   
   // Exchange authorization code for an access token.
   $accessToken = $client->getAccessToken();
   $client->setAccessToken($accessToken);

4. สร้างไคลเอ็นต์สําหรับบริการ Display & Video 360 API

   $service = new Google_Service_DoubleClickBidManager($client);

5. ดําเนินการ

   // Configure params for the Queries.listqueries request.
   $optParams = array('pageSize' => 10);
   
   // Execute the request.
   $result = $service->queries->listQueries($optParams);
   
   // Print the retrieved queries.
   if (!empty($result->getQueries())) {
     print('<pre><p>Id Name</p>');
     foreach ($result->getQueries() as $query) {
       printf('<p>%s %s</p>', $query->queryId, $query->metadata->title);
     }
     print('</pre>');
   } else {
     print '<p>No queries exist.</p>';
   }

ดูข้อมูลโดยละเอียดเพิ่มเติมเกี่ยวกับการใช้ Bid Manager API กับ PHP ได้จากไฟล์ README ในตัวอย่าง Bid Manager API

4. ขั้นตอนถัดไป

เมื่อติดตั้งใช้งานไลบรารีไคลเอ็นต์แล้ว ให้ดูเอกสารอ้างอิงและเริ่มใช้งาน

นอกจากนี้ ยังมีคู่มือเพิ่มเติมเกี่ยวกับการใช้รายงานที่ตั้งเวลาไว้ และการทําตามแนวทางปฏิบัติแนะนําในการรายงาน