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

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

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

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

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

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

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

implementation 'com.google.api-ads:google-ads:33.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 ขั้นตอน ได้แก่ แอปบนเดสก์ท็อป (ติดตั้ง) หรือเว็บแอป ความแตกต่างที่สำคัญระหว่างเครื่องมือทั้งสองนี้ก็คือแอปบนเดสก์ท็อปจะต้อง เปิดเบราว์เซอร์ระบบและระบุ 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"

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

แพ็กเกจตัวอย่างใน 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'