การกำหนดค่าไคลเอ็นต์ทำได้หลายวิธี
การกำหนดค่าโดยใช้ไฟล์ 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 หรือ dict )
refresh_token
: โทเค็นการรีเฟรช OAuthclient_id
: รหัสไคลเอ็นต์ OAuthclient_secret
: รหัสลับไคลเอ็นต์ OAuthdeveloper_token
: โทเค็นของนักพัฒนาสำหรับการเข้าถึง APIlogin_customer_id
: ดูเอกสารประกอบเกี่ยวกับlogin-customer-idlinked_customer_id
: ดูเอกสารประกอบเกี่ยวกับรหัสลูกค้าที่ลิงก์json_key_file_path
(ก่อนหน้านี้เรียกว่าpath_to_private_key_file
): เส้นทางไปยังไฟล์คีย์ส่วนตัวในเครื่อง ซึ่งใช้ในการตรวจสอบสิทธิ์โดยใช้บัญชีบริการ โปรดดูเอกสารประกอบของบัญชีบริการ OAuth2impersonated_email
(เดิมคือdelegate_account
): อีเมลของบัญชีที่ใช้เป็นผู้รับมอบสิทธิ์ หมายเลขนี้จะใช้ในการตรวจสอบสิทธิ์โดยใช้บัญชีบริการ โปรดดูเอกสารประกอบของบัญชีบริการ OAuth2logging
: การกำหนดค่าการบันทึก ข้อมูลด้านล่างนี้จะอธิบายช่องการบันทึกhttp_proxy
: ดูเอกสารประกอบเกี่ยวกับพร็อกซีuse_proto_plus
: จะใช้ข้อความ Proto+ หรือไม่ ดูเอกสารประกอบข้อความ 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
: พจนานุกรมที่กำหนดเครื่องมือบันทึกประเภทต่างๆ ซึ่งรวมถึงเครื่องจัดการและระดับการบันทึก