Google Ads API ใช้โปรโตคอล OAuth 2.0 สำหรับการตรวจสอบสิทธิ์และการให้สิทธิ์เช่นเดียวกับ Google APIs อื่นๆ OAuth 2.0 ช่วยให้แอปไคลเอ็นต์ .NET ของ Google Ads API เข้าถึงบัญชี Google Ads ของผู้ใช้ได้โดยไม่ต้องจัดการหรือจัดเก็บข้อมูลการเข้าสู่ระบบของผู้ใช้
ทำความเข้าใจรูปแบบการเข้าถึง Google Ads
หากต้องการทํางานกับ Google Ads API อย่างมีประสิทธิภาพ โปรดทําความเข้าใจวิธีการทํางานของรูปแบบการเข้าถึง Google Ads ดูคู่มือรูปแบบการเข้าถึง Google Ads
เวิร์กโฟลว์ OAuth
เวิร์กโฟลว์ที่ใช้กันทั่วไปเมื่อทำงานกับ Google Ads API มีอยู่ 3 แบบ
โฟลว์บัญชีบริการ
เราขอแนะนำให้ใช้เวิร์กโฟลว์นี้หากแอปพลิเคชันของคุณไม่จำเป็นต้องมีการโต้ตอบกับมนุษย์ เวิร์กโฟลว์นี้ต้องมีขั้นตอนการกำหนดค่า ซึ่งผู้ใช้จะเพิ่มบัญชีบริการลงในบัญชี Google Ads จากนั้นแอปจะใช้ข้อมูลเข้าสู่ระบบของบัญชีบริการเพื่อจัดการบัญชี Google Ads ของผู้ใช้ได้
กำหนดค่าไลบรารีดังนี้
// Initialize a GoogleAdsConfig instance.
GoogleAdsConfig config = new GoogleAdsConfig()
{
OAuth2Mode = OAuth2Flow.SERVICE_ACCOUNT,
OAuth2SecretsJsonPath = "PATH_TO_CREDENTIALS_JSON",
LoginCustomerId = "INSERT_LOGIN_CUSTOMER_ID_HERE"
};
// Initialize a GoogleAdsClient instance.
GoogleAdsClient client = new GoogleAdsClient(config);
ดูข้อมูลเพิ่มเติมได้ที่คู่มือเวิร์กโฟลว์บัญชีบริการ
ขั้นตอนการตรวจสอบสิทธิ์ผู้ใช้รายเดียว
คุณสามารถใช้เวิร์กโฟลว์นี้ได้หากใช้บัญชีบริการไม่ได้ เวิร์กโฟลว์นี้ต้องมีการกำหนดค่า 2 ขั้นตอนดังนี้
- ให้สิทธิ์ผู้ใช้รายเดียวเข้าถึงบัญชีทั้งหมดที่จะจัดการโดยใช้ Google Ads API แนวทางที่พบบ่อยคือการให้สิทธิ์ผู้ใช้เข้าถึงบัญชีดูแลจัดการ Google Ads API และลิงก์บัญชี Google Ads ทั้งหมดภายใต้บัญชีดูแลจัดการนั้น
- ผู้ใช้เรียกใช้เครื่องมือบรรทัดคำสั่ง เช่น
gcloudหรือตัวอย่างโค้ดGenerateUserCredentialsเพื่อให้สิทธิ์แอปของคุณจัดการบัญชี Google Ads ทั้งหมดในนามของผู้ใช้
เริ่มต้นไลบรารีโดยใช้ข้อมูลเข้าสู่ระบบ OAuth 2.0 ของผู้ใช้ดังนี้
GoogleAdsConfig config = new GoogleAdsConfig()
{
LoginCustomerId = "INSERT_LOGIN_CUSTOMER_ID_HERE",
OAuth2ClientId = "INSERT_OAUTH_CLIENT_ID_HERE",
OAuth2ClientSecret = "INSERT_OAUTH_CLIENT_SECRET_HERE",
OAuth2RefreshToken = "INSERT_REFRESH_TOKEN_HERE"
};
GoogleAdsClient client = new GoogleAdsClient(config);
ดูข้อมูลเพิ่มเติมได้ที่คู่มือเวิร์กโฟลว์การตรวจสอบสิทธิ์ผู้ใช้รายเดียว
ขั้นตอนการตรวจสอบสิทธิ์ผู้ใช้หลายคนหนึ่งเครื่อง
เราขอแนะนำให้ใช้เวิร์กโฟลว์นี้หากแอปของคุณอนุญาตให้ผู้ใช้ลงชื่อเข้าใช้และให้สิทธิ์แอปจัดการบัญชี Google Ads ในนามของผู้ใช้ แอปของคุณจะสร้างและจัดการข้อมูลเข้าสู่ระบบของผู้ใช้ OAuth 2.0 แบบไดนามิกต่อเซสชันหรือคำขอของผู้ใช้ จากนั้นจะเริ่มต้น GoogleAdsClient ด้วยโทเค็นการรีเฟรชของผู้ใช้ที่ใช้งานอยู่ ดังนี้
GoogleAdsConfig config = new GoogleAdsConfig()
{
LoginCustomerId = userSession.LoginCustomerId,
OAuth2ClientId = "INSERT_OAUTH_CLIENT_ID_HERE",
OAuth2ClientSecret = "INSERT_OAUTH_CLIENT_SECRET_HERE",
OAuth2RefreshToken = userSession.RefreshToken
};
GoogleAdsClient client = new GoogleAdsClient(config);
ตั้งแต่ Google.Ads.GoogleAds v27.0.0 เป็นต้นไป คุณยังสามารถแทรกออบเจ็กต์ ICredential หรือ GoogleCredential ที่กำหนดค่าไว้ล่วงหน้าลงใน GoogleAdsConfig โดยตรงได้โดยใช้พร็อพเพอร์ตี้ Credentials
ดูข้อมูลเพิ่มเติมได้ที่คู่มือเวิร์กโฟลว์การตรวจสอบสิทธิ์แบบหลายคนหนึ่งเครื่อง ไลบรารีของไคลเอ็นต์ .NET มีตัวอย่างโค้ด 2 รายการสำหรับการอ้างอิง ดังนี้
- ตัวอย่างโค้ด
AuthenticateInAspNetCoreApplicationแสดงวิธีสร้างเว็บแอปที่ได้รับการตรวจสอบสิทธิ์ผู้ใช้ที่รันไทม์เพื่อจัดการบัญชี Google Ads ในนามของผู้ใช้ แอปใช้ข้อมูลเข้าสู่ระบบ OAuth 2.0 ของผู้ใช้เพื่อดึงข้อมูลแคมเปญในบัญชี Google Ads - ตัวอย่างโค้ดบรรทัดคำสั่ง
GenerateUserCredentialsแสดงวิธีรับการตรวจสอบสิทธิ์ผู้ใช้ที่รันไทม์เพื่อจัดการบัญชี Google Ads ในนามของผู้ใช้ คุณสามารถใช้ตัวอย่างโค้ดนี้เป็นข้อมูลอ้างอิงเพื่อสร้างแอปบนเดสก์ท็อปที่ต้องมีการตรวจสอบสิทธิ์ผู้ใช้
จะเกิดอะไรขึ้นหากผู้ใช้จัดการหลายบัญชี
เป็นเรื่องปกติที่ผู้ใช้จะจัดการบัญชี Google Ads มากกว่า 1 บัญชี ไม่ว่าจะผ่านการเข้าถึงบัญชีโดยตรงหรือผ่านบัญชีดูแลจัดการ Google Ads ไลบรารีของไคลเอ็นต์ .NET มีตัวอย่างโค้ดต่อไปนี้ที่แสดงวิธีจัดการกับกรณีดังกล่าว
- ตัวอย่างโค้ด
GetAccountHierarchyแสดงวิธีดึงข้อมูลรายการบัญชีทั้งหมดภายใต้บัญชีดูแลจัดการ Google Ads - ตัวอย่างโค้ด
ListAccessibleCustomersแสดงวิธีดึงข้อมูลรายการบัญชีทั้งหมดที่ผู้ใช้มีสิทธิ์เข้าถึงโดยตรง จากนั้นจะใช้บัญชีเหล่านี้เป็นค่าที่ถูกต้องสำหรับการตั้งค่าLoginCustomerIdได้
ข้อมูลรับรองเริ่มต้นของแอปพลิเคชัน
ไลบรารีของไคลเอ็นต์ .NET (v24.1.0 ขึ้นไป) ยังรองรับการตรวจสอบสิทธิ์ด้วยข้อมูลรับรองเริ่มต้นของแอปพลิเคชันด้วย
ซึ่งจะเป็นประโยชน์อย่างยิ่งสำหรับการพัฒนาในเครื่องหรือการพัฒนาสำหรับ Google APIs ต่างๆ เนื่องจากคุณสามารถใช้ข้อมูลเข้าสู่ระบบเดียวกันซ้ำได้ หากข้อมูลเข้าสู่ระบบดังกล่าวเข้าถึงขอบเขต OAuth 2.0 ที่จำเป็นได้
สำหรับ Google Ads API โปรดตรวจสอบว่าข้อมูลรับรองเริ่มต้นของแอปพลิเคชันสามารถเข้าถึงขอบเขต OAuth 2.0 https://www.googleapis.com/auth/adwords ได้
หากต้องการใช้ข้อมูลรับรองเริ่มต้นของแอปพลิเคชัน ให้ตั้งค่าตัวเลือก UseApplicationDefaultCredentials เป็น true ใน GoogleAdsConfig (หรือตั้งค่าตัวแปรสภาพแวดล้อม USE_APPLICATION_DEFAULT_CREDENTIALS=true เมื่อโหลดการกำหนดค่าด้วย config.LoadFromEnvironmentVariables()) ดังนี้
GoogleAdsConfig config = new GoogleAdsConfig()
{
UseApplicationDefaultCredentials = true,
LoginCustomerId = "INSERT_LOGIN_CUSTOMER_ID_HERE"
};
GoogleAdsClient client = new GoogleAdsClient(config);
ดูรายละเอียดเพิ่มเติมเกี่ยวกับตัวเลือกที่ใช้ได้ในการกำหนดค่าไลบรารีของไคลเอ็นต์ .NET ได้ที่หน้าการกำหนดค่า