เอกสารนี้อธิบายวิธีเริ่มต้นเขียนแอปที่ใช้ Google Bid Manager API API ช่วยให้คุณจัดการการค้นหาและเรียกข้อมูลเมตาของรายงานได้
Bid Manager API v2 เป็นเวอร์ชันล่าสุดที่เราแนะนำให้ใช้
1. ก่อนจะเริ่ม
หากคุณไม่คุ้นเคยกับแนวคิด Display & Video 360 ของ Google โปรดอ่าน ศูนย์ช่วยเหลือ Display & Video 360 แล้ว ทดลองกับ UI
2. เตรียมพร้อมสำหรับการตรวจสอบสิทธิ์
หากต้องการเริ่มต้นใช้งาน Bid Manager API ก่อนอื่นคุณต้องใช้เครื่องมือการตั้งค่า ซึ่งจะแนะนำขั้นตอนการสร้างโปรเจ็กต์ในคอนโซล Google API การเปิดใช้ API และสร้างข้อมูลเข้าสู่ระบบ
หากยังไม่ได้สร้างข้อมูลเข้าสู่ระบบ ให้สร้างข้อมูลเข้าสู่ระบบ OAuth 2.0 โดยคลิกสร้างข้อมูลเข้าสู่ระบบ > รหัสไคลเอ็นต์ OAuth หลังจากสร้างข้อมูลเข้าสู่ระบบแล้ว คุณจะดูรหัสไคลเอ็นต์ได้ในหน้าข้อมูลเข้าสู่ระบบ คลิกรหัสไคลเอ็นต์เพื่อดูรายละเอียด เช่น รหัสลับไคลเอ็นต์, URI การเปลี่ยนเส้นทาง, ที่อยู่ต้นทาง JavaScript และอีเมลดูข้อมูลเพิ่มเติมได้ที่ให้สิทธิ์คำขอ
3. เรียกใช้ Bid Manager API
แท็บด้านล่างจะแสดงการเริ่มต้นอย่างรวดเร็วสำหรับการเขียนโค้ดในภาษาต่างๆ ดูโค้ดตัวอย่างที่คล้ายกันในที่เก็บตัวอย่าง API ของ Bid Manager ได้ด้วย
Java
นำเข้าไลบรารีที่จำเป็น
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;
โหลดไฟล์รหัสลับไคลเอ็นต์และสร้างข้อมูลเข้าสู่ระบบการให้สิทธิ์
ครั้งแรกที่คุณทำตามขั้นตอนนี้ ระบบจะขอให้คุณยอมรับข้อความแจ้งการให้สิทธิ์ในเบราว์เซอร์ ก่อนที่จะยอมรับ ดูให้แน่ใจว่าคุณลงชื่อเข้าใช้ด้วยบัญชี 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");
สร้างไคลเอ็นต์ API ที่ได้รับอนุญาต
// Create authorized API client. DoubleClickBidManager service = new DoubleClickBidManager.Builder(credential.getTransport(), credential.getJsonFactory(), credential) .setApplicationName("bidmanager-java-installed-app-sample") .build();
ดำเนินการ
// 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
Python
นำเข้าไลบรารีที่จำเป็น
from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient import discovery
โหลดไฟล์รหัสลับไคลเอ็นต์และสร้างข้อมูลเข้าสู่ระบบการให้สิทธิ์
ครั้งแรกที่คุณทำตามขั้นตอนนี้ ระบบจะขอให้คุณยอมรับข้อความแจ้งการให้สิทธิ์ในเบราว์เซอร์ ก่อนที่จะยอมรับ ดูให้แน่ใจว่าคุณลงชื่อเข้าใช้ด้วยบัญชี 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()
สร้างไคลเอ็นต์ 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)
ดำเนินการ
# 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.')
สำหรับข้อมูลโดยละเอียดเพิ่มเติมเกี่ยวกับการใช้ API ของ Bid Manager กับ Python โปรดดูไฟล์ README ในตัวอย่าง Bid Manager API
PHP
ตัวอย่างนี้สมมติว่าคุณกำลังเรียกใช้ PHP กับเว็บเซิร์ฟเวอร์ในตัวและ
ได้กำหนดค่าข้อมูลรับรองของคุณให้เปลี่ยนเส้นทางไปยังหน้าเว็บที่เกี่ยวข้อง ตัวอย่างเช่น โค้ดนี้ในไฟล์ index.php
จะเรียกใช้ได้โดยใช้คำสั่งและข้อมูลเข้าสู่ระบบต่อไปนี้ที่กำหนดค่าให้เปลี่ยนเส้นทางไปยัง http://localhost:8000
หลังการตรวจสอบสิทธิ์
php -S localhost:8000 -t ./
ดาวน์โหลดและติดตั้งไคลเอ็นต์ PHP ของ Google API
วิธีการที่แนะนำคือการใช้ Composer:
composer require google/apiclient:^2.12.1
เมื่อติดตั้งแล้ว อย่าลืมใส่ตัวโหลดอัตโนมัติ
require_once '/path/to/your-project/vendor/autoload.php';
สร้างออบเจ็กต์ Google_Client
$client = new Google_Client();
ตั้งค่าไคลเอ็นต์ เปลี่ยนเส้นทางไปยัง URL การตรวจสอบสิทธิ์หากจำเป็น และเรียกข้อมูลโทเค็นเพื่อการเข้าถึง
ครั้งแรกที่คุณทำตามขั้นตอนนี้ ระบบจะขอให้คุณยอมรับข้อความแจ้งการให้สิทธิ์ในเบราว์เซอร์ ก่อนที่จะยอมรับ ดูให้แน่ใจว่าคุณลงชื่อเข้าใช้ด้วยบัญชี Google ที่มีสิทธิ์เข้าถึง Display & Video 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);
สร้างไคลเอ็นต์สำหรับบริการ Display & Video 360 API
$service = new Google_Service_DoubleClickBidManager($client);
ดำเนินการ
// 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. ขั้นตอนถัดไป
ตอนนี้คุณมีไลบรารีของไคลเอ็นต์ที่พร้อมทำงานแล้ว ลองสำรวจเอกสารอ้างอิงและเริ่มสร้างการใช้งาน
นอกจากนี้ ยังมีคำแนะนำเพิ่มเติมเกี่ยวกับการใช้รายงานที่ตั้งเวลาไว้และทำตามแนวทางปฏิบัติแนะนำในการรายงาน