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

เราขอแนะนําให้ใช้คลังไลบรารีไคลเอ็นต์กับ Apache Maven (หรือ Gradle)

สร้างโปรเจ็กต์ Maven/Gradle ใหม่

สร้างโปรเจ็กต์ Maven/Gradle ใหม่ใน IDE ที่คุณเลือก อาร์ติแฟกต์ของเราได้รับการเผยแพร่ไปยังที่เก็บ Maven Central

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

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

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

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

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

รับข้อมูลเข้าสู่ระบบเพื่อตรวจสอบสิทธิ์กับ API

สิทธิ์เข้าถึง Google Ads API ต้องใช้ข้อมูลเข้าสู่ระบบ OAuth และโทเค็นนักพัฒนา Google Ads API ส่วนนี้จะอธิบายความหมาย วิธีใช้ และวิธีรับข้อมูล

โทเค็นของนักพัฒนา (สำหรับการเข้าถึง API)

โทเค็นของนักพัฒนาแอปจะลิงก์กับบัญชีดูแลจัดการและดูได้ในเว็บอินเทอร์เฟซของ Google Ads

แม้ว่าโทเค็นของนักพัฒนาแอปจะลิงก์กับบัญชีดูแลจัดการ แต่ก็ไม่ได้ให้สิทธิ์เข้าถึงบัญชีดังกล่าว แต่โทเค็นนักพัฒนาแอปจะให้สิทธิ์เข้าถึง API โดยทั่วไป และการเข้าถึงระดับบัญชีจะกําหนดค่าผ่าน OAuth

ข้อมูลเข้าสู่ระบบ OAuth (สําหรับการเข้าถึงบัญชี Google Ads)

หากต้องการให้สิทธิ์ในฐานะผู้ใช้บัญชี Google ที่มีสิทธิ์เข้าถึงบัญชี Google Ads คุณต้องระบุชุดข้อมูลเข้าสู่ระบบ OAuth

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

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

ดูขั้นตอนการให้สิทธิ์ OAuth ในแอปบนเดสก์ท็อป ซึ่งรวมถึงรายละเอียดทั้งหมดที่จําเป็นสําหรับการให้สิทธิ์ด้วยข้อมูลเข้าสู่ระบบของคุณเอง

หากคุณให้สิทธิ์ในฐานะผู้ใช้ Google บุคคลที่สาม (เวิร์กโฟลว์บนเว็บ)

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

หากคุณให้สิทธิ์ในฐานะผู้ใช้โดเมน Google Apps (ขั้นตอนการให้สิทธิ์บัญชีบริการ)

ดูขั้นตอนการดำเนินการกับบัญชีบริการ OAuth ตัวอย่างนี้แสดงวิธีตั้งค่าการให้สิทธิ์ OAuth สําหรับผู้ใช้โดเมน Google Apps

หากการเข้าถึงบัญชีลูกค้า Google Ads ของคุณผ่านบัญชีดูแลจัดการ Google Ads คุณต้องระบุรหัสลูกค้าสำหรับการเข้าสู่ระบบด้วยตามที่อธิบายไว้ด้านล่าง

รหัสลูกค้าสำหรับเข้าสู่ระบบ (สําหรับการเข้าถึงบัญชี Google Ads ผ่านบัญชีดูแลจัดการ)

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

กำหนดค่าไลบรารีของไคลเอ็นต์ด้วยข้อมูลเข้าสู่ระบบ

คุณสามารถกําหนดค่าคลังไคลเอ็นต์ด้วยไฟล์การกําหนดค่า ตัวแปรสภาพแวดล้อม หรือแบบเป็นโปรแกรม ในคู่มือนี้ เราจะใช้แนวทางไฟล์การกําหนดค่าและมุ่งเน้นที่ขั้นตอนในเดสก์ท็อปและเว็บ โดยทั่วไปแล้ว การใช้ไฟล์การกําหนดค่าเป็นแนวทางที่ดีหากคุณมีข้อมูลเข้าสู่ระบบเพียงชุดเดียว (เช่น คุณจัดการบัญชีภายใต้บัญชีดูแลจัดการเดียว)

สร้างไฟล์ ~/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

ตรวจสอบข้อมูลเข้าสู่ระบบ

เราจะเรียกใช้ GetCampaigns example เพื่อให้แน่ใจว่าทุกอย่างได้รับการตั้งค่าอย่างถูกต้อง

ก่อนอื่น ให้ไปที่ไดเรกทอรี google-ads-examples

$ cd google-ads-examples

ตัวอย่างนี้ต้องใช้พารามิเตอร์ --customerId โดยค่าคือรหัสลูกค้าของบัญชี Google Ads ที่ไม่มีขีดกลาง

วิธีเรียกใช้กับ Gradle

$ ./gradlew -q runExample --example="basicoperations.GetCampaigns --customerId INSERT_CUSTOMER_ID_HERE"

ดูตัวอย่างอื่นๆ

แพ็กเกจ examples ใน google-ads-examples มีตัวอย่างที่เป็นประโยชน์หลายรายการ ตัวอย่างส่วนใหญ่ต้องใช้พารามิเตอร์ คุณสามารถส่งพารามิเตอร์เป็นอาร์กิวเมนต์ (แนะนำ) หรือแก้ไขค่า INSERT_XXXXX_HERE ในซอร์สโค้ดก็ได้ หากต้องการดูคำสั่งการใช้งาน ให้ลองส่ง --help เป็นอาร์กิวเมนต์เพียงรายการเดียว

เมื่อใช้ Gradle ให้ทำดังนี้

$ ./gradlew -q runExample --example="basicoperations.GetCampaigns --help"

นอกจากนี้ คุณยังใช้งาน listExamples ใน Gradle เพื่อแสดงตัวอย่างทั้งหมด ตัวอย่างในไดเรกทอรีย่อย หรือตัวอย่างที่คำอธิบายมีคำค้นหาได้ด้วย

# List all examples:
$ ./gradlew -q listExamples
# List examples in the 'basicoperations' subdirectory:
$ ./gradlew -q listExamples --subdirectory='basicoperations'
# Search for examples where the description includes 'Performance Max':
$ ./gradlew -q listExamples --searchTerm='Performance Max'