ก่อนที่จะเริ่มเขียนโค้ดแอปพลิเคชันแรกของไคลเอ็นต์ คุณต้องดําเนินการบางอย่างดังต่อไปนี้หากยังไม่ได้ทํา
สร้างบัญชี Google แล้วรับสิทธิ์ใน Search Ads 360
หากต้องการใช้ Search Ads 360 API คุณต้องมีบัญชี Google และมีสิทธิ์ที่เหมาะสมในบัญชีดังกล่าวจาก Search Ads 360 ดังนี้
หากคุณยังไม่มีบัญชี Google โปรดสร้างบัญชี
ขอให้ผู้จัดการเอเจนซี Search Ads 360 ช่วยสร้างผู้ใช้ Search Ads 360 สําหรับบัญชี Google ของคุณ
หากต้องการดาวน์โหลดรายงาน คุณต้องมีสิทธิ์ดูสําหรับผู้ลงโฆษณาที่จะร่วมงานด้วย
หากต้องการเพิ่มหรือแก้ไข Conversion คุณจะต้องมีสิทธิ์แก้ไขสําหรับผู้ลงโฆษณาที่จะร่วมงานด้วย ในการกําหนดค่า Floodlight ที่แชร์ คุณต้องมีสิทธิ์แก้ไขสําหรับผู้ลงโฆษณารายย่อยแต่ละรายที่ต้องการอัปโหลด Conversion ให้ คุณไม่จําเป็นต้องเข้าถึงผู้ลงโฆษณาหลัก และไม่จําเป็นต้องเข้าถึงผู้ลงโฆษณาย่อยที่ไม่ได้อัปโหลด Conversion ไว้ หากใช้รหัสการคลิกเพื่อระบุแหล่งที่มาของ Conversion เป็นการเข้าชม ให้ตรวจสอบว่าคุณมีสิทธิ์แก้ไขผู้ลงโฆษณาที่สร้างรหัสคลิก หากระบุรหัสคลิกจากผู้ลงโฆษณาที่คุณไม่มีสิทธิ์แก้ไข คําขอจะไม่สําเร็จ
ผู้จัดการเอเจนซีจะตั้งค่าบัญชีเป็นผู้ใช้ผู้ลงโฆษณาที่มีสิทธิ์เข้าถึงผู้ลงโฆษณาที่เจาะจง หรือตั้งค่าบัญชีด้วยระดับการเข้าถึงที่สูงขึ้น เช่น ผู้ใช้เอเจนซีที่มีสิทธิ์เข้าถึงผู้ลงโฆษณาทั้งหมดในเอเจนซีได้
เปิดใช้บริการ Conversion API
หากต้องการอัปโหลดข้อมูลเกี่ยวกับ Conversion ผู้ใช้ Search Ads 360 ที่มีสิทธิ์ผู้จัดการเอเจนซีจะต้องลงชื่อเข้าใช้ UI ของ Search Ads 360 และเปิดใช้บริการ Conversion ของ API ดูวิธีการได้ที่ศูนย์ช่วยเหลือของ Search Ads 360
สร้างโปรเจ็กต์คอนโซล Google API และข้อมูลเข้าสู่ระบบ OAuth สําหรับไคลเอ็นต์
- เริ่มเครื่องมือตั้งค่าของคอนโซล Google API
เครื่องมือการตั้งค่าจะแนะนําการสร้างโปรเจ็กต์ (หรือใช้โปรเจ็กต์ที่มีอยู่) การเปิดใช้ Search Ads 360 API และสร้างข้อมูลเข้าสู่ระบบ OAuth 2.0 - ในหน้าลงทะเบียนแอปพลิเคชัน ให้เลือกโปรเจ็กต์ที่มีอยู่หรือเลือกสร้างโปรเจ็กต์ แล้วคลิกดำเนินการต่อ
- หลังจากคอนโซล Google API เปิดใช้ Search Ads 360 API แล้ว ให้คลิกปุ่มไปที่ข้อมูลเข้าสู่ระบบ
- ในหน้าสร้างข้อมูลเข้าสู่ระบบ ให้ป้อนข้อมูลต่อไปนี้
- คุณกําลังใช้ API ใด Search Ads 360 API
- คุณจะเข้าถึงข้อมูลใด: ข้อมูลผู้ใช้
- คลิกปุ่มถัดไป
คุณสามารถใช้เครื่องมือตั้งค่าเพื่อสร้างรหัสไคลเอ็นต์ OAuth 2.0 ได้แล้ว
- ทําตามขั้นตอนที่เหลือในเครื่องมือตั้งค่า
ติดตั้ง sa360Api.py
Search Ads 360 มีสคริปต์ยูทิลิตีเพื่ออํานวยความสะดวกในขั้นตอนการตั้งค่าการให้สิทธิ์ คุณยังใช้สคริปต์นี้เพื่อรับและส่งข้อมูลในรูปแบบ JSON ได้ด้วย หากต้องการลองส่งและส่งข้อมูลก่อนที่จะออกแบบและเขียนแอปพลิเคชันแบบเต็ม คุณคัดลอกตัวอย่าง JSON จํานวนมากในเว็บไซต์เอกสารประกอบนี้และป้อนข้อมูลลงในสคริปต์ได้โดยตรง
หากต้องการติดตั้งสคริปต์ ให้ทําดังนี้
- ติดตั้ง Python 2.7
สคริปต์ใช้กับ Python 3.x ไม่ได้ - ติดตั้ง cURL
- ดาวน์โหลด sa360Api.zip
- แตก
sa360Api.py
จากsa360Api.zip
- ทําให้ไฟล์ปฏิบัติการ
sa360Api.py
ดูข้อมูลเบื้องต้นเกี่ยวกับ REST
การเรียก API ทําได้ 2 วิธี ดังนี้
- ใช้ไลบรารีของไคลเอ็นต์
- การส่งคําขอ HTTP และแยกวิเคราะห์การตอบกลับ
หากตัดสินใจไม่ใช้ไลบรารีของไคลเอ็นต์ คุณต้องเข้าใจพื้นฐานของ REST
REST เป็นสถาปัตยกรรมซอฟต์แวร์แบบหนึ่งซึ่งเป็นวิธีที่สะดวกและสอดคล้องกันในการขอและแก้ไขข้อมูล
คําว่า REST ย่อมาจาก "Agentational Transfer" (การโอนสถานะตัวแทน) ในบริบทของ Google APIs หมายถึงการใช้คํากริยา HTTP เพื่อเรียกและแก้ไขข้อมูลที่แสดงโดย Google
ในระบบ RESTful ระบบจะจัดเก็บทรัพยากรไว้ในที่เก็บข้อมูล ไคลเอ็นต์ส่งคําขอที่เซิร์ฟเวอร์ดําเนินการบางอย่าง (เช่น สร้าง ดึง อัปเดต หรือลบทรัพยากร) แล้วเซิร์ฟเวอร์จะดําเนินการตามนั้นและส่งการตอบกลับ โดยมักอยู่ในรูปแบบของการแสดงทรัพยากรที่ระบุ
ใน RESTful API ของ Google ไคลเอ็นต์จะระบุการดําเนินการโดยใช้คํากริยา HTTP เช่น POST
, GET
, PUT
หรือ DELETE
ซึ่งระบุทรัพยากรตาม URI ที่ไม่ซ้ําทั่วโลกในรูปแบบต่อไปนี้
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
เนื่องจากทรัพยากร API ทั้งหมดมี URI ที่เข้าถึงได้ด้วย HTTP ที่ไม่ซ้ํากัน REST จะเปิดใช้การแคชข้อมูลและได้รับการเพิ่มประสิทธิภาพให้ทํางานร่วมกับโครงสร้างพื้นฐานที่จัดจําหน่ายในเว็บ
ดูคําจํากัดความเมธอดในเอกสารประกอบของมาตรฐาน HTTP 1.1 ที่เป็นประโยชน์ ซึ่งมีข้อกําหนดของ GET
, POST
, PUT
และ DELETE
REST ใน Search Ads 360 API
การดําเนินการของ Search Ads 360 API จะแมปกับคํากริยา HTTP ของ REST โดยตรง
รูปแบบที่เฉพาะเจาะจงสําหรับ URI ของ Search Ads 360 มีดังนี้
https://www.googleapis.com/doubleclicksearch/v2/resourcePath?parameters
ชุด URI ทั้งหมดที่ใช้สําหรับการดําเนินการที่รองรับแต่ละรายการใน API จะสรุปไว้ในเอกสารอ้างอิง API
ดูข้อมูลเบื้องต้นเกี่ยวกับ JSON
หากคุณใช้ REST คุณจะต้องใช้รูปแบบ JSON สําหรับเนื้อหาของคําขอ คุณระบุได้ว่าการตอบสนองจะอยู่ในรูปแบบ JSON หรือ CSV
JSON (JavaScript Object Notation) เป็นรูปแบบข้อมูลทั่วไปที่ใช้ภาษาทั่วไป ซึ่งแสดงถึงโครงสร้างข้อความที่เรียบง่ายในรูปแบบข้อความ ดูข้อมูลเพิ่มเติมได้ที่ json.org