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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

โดยทั่วไปแล้วมีขั้นตอน OAuth อยู่ 2 แบบ ได้แก่ แอปหรือเว็บแอปบนเดสก์ท็อป (ติดตั้งแล้ว) ความแตกต่างหลักระหว่าง 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

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

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

ก่อนอื่นให้ไปที่ไดเรกทอรี 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'