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

เราขอแนะนำให้ใช้ไลบรารีของไคลเอ็นต์ร่วมกับ 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"

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

แพ็กเกจ example ใน 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'