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

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

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

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

ทรัพยากร Dependency ของ Maven คือ

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

Dependency ของ Gradle คือ

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

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

หากคุณสร้างจากแหล่งที่มา โปรดตรวจสอบว่าได้เปิดใช้การประมวลผลคำอธิบายประกอบใน IDE

รับข้อมูลเข้าสู่ระบบเพื่อตรวจสอบสิทธิ์ด้วย 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

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

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

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