การกำหนดค่าไคลเอ็นต์ทำได้หลายวิธี
การกำหนดค่าโดยใช้ไฟล์ YAML
คุณระบุไฟล์ YAML ที่จะใช้เมื่อเริ่มต้นไคลเอ็นต์ที่มีข้อมูลการตรวจสอบสิทธิ์ที่จำเป็นต่อการส่งคำขอได้ ไฟล์นี้จะเข้าถึงได้เมื่อไคลเอ็นต์เริ่มต้นโดยใช้เมธอด load_from_storage
วิธีที่ง่ายที่สุดในการสร้างไฟล์นี้คือการคัดลอกตัวอย่าง google-ads.yaml
จากที่เก็บ GitHub แล้วแก้ไขให้รวมข้อมูลเข้าสู่ระบบของคุณ ซึ่งรวมถึงโทเค็นของนักพัฒนา, โทเค็นการรีเฟรช, รหัสไคลเอ็นต์ และรหัสลับไคลเอ็นต์
หากต้องการระบุตำแหน่งที่ตั้งของไฟล์ google-ads.yaml
คุณสามารถส่งเส้นทางเป็นสตริงไปยังเมธอดเมื่อเรียกใช้ได้ ดังนี้
from google.ads.googleads.client import GoogleAdsClient
client = GoogleAdsClient.load_from_storage("path/to/google-ads.yaml")
นอกจากนี้ คุณยังสามารถระบุเส้นทางโดยกำหนดตัวแปรสภาพแวดล้อมที่ต้องการได้อีกด้วย ดังนี้
import os
os.environ["GOOGLE_ADS_CONFIGURATION_FILE_PATH"] = "path/to/google-ads.yaml"
from google.ads.googleads.client import GoogleAdsClient
client = GoogleAdsClient.load_from_storage()
หากมีการระบุทั้ง 2 ค่า - มีการส่งเส้นทางไปยังเมธอดและมีตัวแปรสภาพแวดล้อมข้างต้น ไลบรารีจะจัดลำดับความสำคัญให้กับเส้นทางที่ผ่านไปยังเมธอดดังกล่าว
หากไม่ระบุเส้นทาง ไลบรารีจะค้นหาไฟล์ในไดเรกทอรี $HOME
ดังนี้
from google.ads.googleads.client import GoogleAdsClient
client = GoogleAdsClient.load_from_storage()
การกำหนดค่าโดยใช้ตัวแปรสภาพแวดล้อม
คุณจัดเก็บการกำหนดค่าไคลเอ็นต์ทั้งหมดเป็นตัวแปรสภาพแวดล้อมได้ ซึ่งระบบจะอ่านเมื่อใช้เมธอด load_from_env
ของไคลเอ็นต์ ตัวแปรสภาพแวดล้อมควรมีชื่อเหมือนกับที่กําหนดไว้ในไฟล์ google-ads.yaml
แต่ควรเป็นตัวพิมพ์ใหญ่ทั้งหมดและขึ้นต้นด้วยเนมสเปซ GOOGLE_ADS_
ตัวอย่างเช่น ควรจัดเก็บ client_id
เป็น GOOGLE_ADS_CLIENT_ID
ตัวแปรสภาพแวดล้อมมักได้รับการกําหนดไว้ในไฟล์การกำหนดค่า Bash เช่น ไฟล์ .bashrc
หรือ .bash_profile
ที่อยู่ในไดเรกทอรี $HOME
นอกจากนี้ยังกำหนดได้โดยใช้บรรทัดคำสั่ง โปรดทราบว่าวิธีการเหล่านี้ถือว่าคุณใช้ bash
หากใช้ Shell อื่น คุณอาจต้องศึกษาเอกสารเกี่ยวกับวิธีตั้งค่าตัวแปรสภาพแวดล้อมใน Shell ที่ใช้อยู่
ขั้นตอนพื้นฐานบางส่วนในการกำหนดตัวแปรสภาพแวดล้อมโดยใช้ไฟล์ .bashrc
โดยใช้เทอร์มินัลมีดังนี้
# Append the line "export GOOGLE_ADS_CLIENT_ID=1234567890" to
# the bottom of your .bashrc file.
$ echo "export GOOGLE_ADS_CLIENT_ID=1234567890" >> ~/.bashrc
# Update your bash environment to use the most recently updated
# version of your .bashrc file.
$ src ~/.bashrc
คุณยังตั้งค่าตัวแปรสภาพแวดล้อมในอินสแตนซ์เทอร์มินัลได้โดยตรงจากบรรทัดคำสั่งดังนี้
$ export GOOGLE_ADS_CLIENT_ID=1234567890
$ echo $GOOGLE_ADS_CLIENT_ID
1234567890
เมธอด load_from_env
จะโหลดข้อมูลการกำหนดค่าจากแอตทริบิวต์ environ
บนโมดูล os
ในตัวของ Python เช่น os.environ["GOOGLE_ADS_CLIENT_ID"]
ตัวอย่างวิธีเริ่มต้นอินสแตนซ์ไคลเอ็นต์ด้วยการกำหนดค่าจากตัวแปรสภาพแวดล้อมมีดังนี้
from google.ads.googleads.client import GoogleAdsClient
client = GoogleAdsClient.load_from_env()
หากต้องการกำหนดค่า logging
ผ่านตัวแปรสภาพแวดล้อม ค่าการกำหนดค่าต้องเป็นออบเจ็กต์ JSON ที่ตรงกับโครงสร้างของคีย์ YAML ในไฟล์การกำหนดค่า google-ads.yaml
ตัวอย่าง
นี่คือตัวอย่างของวิธีตั้งค่าการใช้ไฟล์ .bashrc
export GOOGLE_ADS_LOGGING='{
"version": 1,
"disable_existing_loggers": false,
"formatters": {
"default_fmt": {
"format": "[%(asctime)s - %(levelname)s] %(message).5000s",
"datefmt": "%Y-%m-%d %H:%M:%S"
}
},
"handlers": {
"default_handler": {
"class": "logging.StreamHandler",
"formatter": "default_fmt"
}
},
"loggers": {
"": {
"handlers": ["default_handler"],
"level": "INFO"
}
}
}'
การกำหนดค่าโดยใช้สตริง YAML
หากอ่านไฟล์ YAML ในหน่วยความจำแล้ว คุณสามารถส่งไฟล์ดังกล่าวไปยังไคลเอ็นต์โดยตรงเมื่อเริ่มต้นได้ ซึ่งทำได้โดยใช้เมธอด load_from_string
from google.ads.googleads.client import GoogleAdsClient
with open("/path/to/yaml", "rb") as handle:
yaml = handle.read()
client = GoogleAdsClient.load_from_string(yaml)
การกำหนดค่าโดยใช้ dict
คุณส่งผ่าน dict
ไปยังเมธอด load_from_dict
ได้โดยตรง เช่น
from google.ads.googleads.client import GoogleAdsClient
credentials = {
"developer_token": "abcdef123456",
"refresh_token": "1//0abcdefghijklABCDEF",
"client_id": "123456-abcdef.apps.googleusercontent.com",
"client_secret": "aBcDeFgHiJkL"}
client = GoogleAdsClient.load_from_dict(credentials)
ช่องการกำหนดค่า
การกำหนดค่าไลบรารีของไคลเอ็นต์รองรับช่องต่อไปนี้
ช่องทั่วไป (ชื่อเหล่านี้จะเหมือนกันไม่ว่าคุณจะใช้การกำหนดค่า YAML หรือสคริปต์)
refresh_token
: โทเค็นการรีเฟรช OAuthclient_id
: รหัสไคลเอ็นต์ OAuthclient_secret
: รหัสลับไคลเอ็นต์ OAuthdeveloper_token
: โทเค็นของนักพัฒนาสำหรับการเข้าถึง APIlogin_customer_id
: ดูเอกสารประกอบเกี่ยวกับรหัสลูกค้าสำหรับเข้าสู่ระบบlinked_customer_id
: ดูเอกสารประกอบlinked-customer-idjson_key_file_path
(เดิมคือpath_to_private_key_file
): เส้นทางไปยังไฟล์คีย์ส่วนตัวในเครื่อง ช่องนี้ใช้สำหรับการตรวจสอบสิทธิ์ด้วยบัญชีบริการ โปรดดูเอกสารประกอบเกี่ยวกับบัญชีบริการ OAuth2impersonated_email
(เดิมคือdelegate_account
): อีเมลบัญชีที่ใช้เป็นผู้รับมอบสิทธิ์ ใช้สำหรับการตรวจสอบสิทธิ์โดยใช้บัญชีบริการ โปรดดูเอกสารประกอบเกี่ยวกับบัญชีบริการ OAuth2logging
: การกำหนดค่าการบันทึก ฟิลด์การบันทึกมีคำอธิบายอยู่ด้านล่างhttp_proxy
: ดูเอกสารประกอบของพร็อกซีuse_proto_plus
: จะใช้ข้อความ Proto-plus หรือไม่ โปรดดูเอกสารประกอบเกี่ยวกับข้อความ Protobuf
ช่องทั่วไปที่เป็นตัวแปรสภาพแวดล้อม
GOOGLE_ADS_CONFIGURATION_FILE_PATH
GOOGLE_ADS_REFRESH_TOKEN
GOOGLE_ADS_CLIENT_ID
GOOGLE_ADS_CLIENT_SECRET
GOOGLE_ADS_DEVELOPER_TOKEN
GOOGLE_ADS_LOGIN_CUSTOMER_ID
GOOGLE_ADS_LINKED_CUSTOMER_ID
GOOGLE_ADS_JSON_KEY_FILE_PATH
(เดิมคือGOOGLE_ADS_PATH_TO_PRIVATE_KEY_FILE
)GOOGLE_ADS_IMPERSONATED_EMAIL
(เดิมคือGOOGLE_ADS_DELEGATE_ACCOUNT
)GOOGLE_ADS_LOGGING
GOOGLE_ADS_HTTP_PROXY
GOOGLE_ADS_USE_PROTO_PLUS
ช่องการบันทึกซึ่งเป็นช่องที่อยู่ใต้ช่องการกำหนดค่า logging
จะดึงมาจากโมดูลในตัวของ logging.config
โดยตรง เนื่องจากไลบรารีจะส่งช่องทั้งหมดภายใต้เนมสเปซ logging
ไปยังเมธอด logging.config.dictConfig
โดยตรง โปรดดูรายละเอียดทั้งหมดในคำแนะนำในการบันทึก
version
: ค่าจำนวนเต็มที่แสดงถึงเวอร์ชันสคีมาdisable_existing_loggers
: ควรปิดใช้ตัวบันทึกที่กำหนดค่าไว้ที่อื่นในแอปพลิเคชันหรือไม่formatters
: พจนานุกรมที่นิยามตัวจัดรูปแบบประเภทต่างๆhandlers
: พจนานุกรมที่นิยามตัวแฮนเดิลที่แตกต่างกัน ซึ่งควบคุมตำแหน่งที่จะเขียนบันทึกและควรใช้ตัวจัดรูปแบบloggers
: พจนานุกรมที่นิยามตัวบันทึกประเภทต่างๆ ซึ่งรวมถึงเครื่องจัดการและระดับการบันทึก