Update sample YAML file to clarify steps for service accounts. (googleads#451)

BenRKarl · web-flow · commit 7c61e0705063 · 2021-06-16T12:58:18.000-04:00
diff --git a/google-ads.yaml b/google-ads.yaml
@@ -1,14 +1,35 @@
+# Developer token
+###############################################################################
+# A developer token is required when making requests to the Google Ads API    #
+# regardless of whether you're using the OAuth2 or Service Account            #
+# configurations. To obtain a developer token see:                            #
+# https://developers.google.com/google-ads/api/docs/first-call/dev-token      #
+###############################################################################
+developer_token: INSERT_DEVELOPER_TOKEN_HERE
+
 # OAuth2 configuration
 ###############################################################################
 # The below configuration parameters are used to authenticate using the       #
 # recommended OAuth2 flow. For more information on authenticating with OAuth2 #
 # see: https://developers.google.com/google-ads/api/docs/oauth/overview       #
 ###############################################################################
-developer_token: INSERT_DEVELOPER_TOKEN_HERE
 client_id: INSERT_OAUTH2_CLIENT_ID_HERE
 client_secret: INSERT_OAUTH2_CLIENT_SECRET_HERE
 refresh_token: INSERT_REFRESH_TOKEN_HERE
 
+# Service Account configuration
+###############################################################################
+# To authenticate with a service account add the appropriate values to the    #
+# below configuration parameters and remove the three OAuth2 credentials      #
+# above. The "json_key_file_path" value should be a path to your local        #
+# private key json file, and "impersonated_email" should be the email address #
+# that is being used to impersonate the credentials making requests. for more #
+# information on service accounts, see:                                       #
+# https://developers.google.com/google-ads/api/docs/oauth/service-accounts    #
+###############################################################################
+# json_key_file_path: INSERT_PATH_TO_JSON_KEY_FILE_HERE
+# impersonated_email: INSERT_DOMAIN_WIDE_DELEGATION_ACCOUNT
+
 # Login customer ID configuration
 ###############################################################################
 # Required for manager accounts only: Specify the login customer ID used to   #
@@ -19,19 +40,6 @@ refresh_token: INSERT_REFRESH_TOKEN_HERE
 ###############################################################################
 login_customer_id: INSERT_LOGIN_CUSTOMER_ID_HERE
 
-# Service Account configuration
-###############################################################################
-# To authenticate with a service account add the appropriate values to the    #
-# below configuration parameters and remove the four OAuth credentials above. #
-# The "json_key_file_path" value should be a path to your local private       #
-# key json file, and "impersonated_email" should be the email address that is #
-# being used to impersonate the credentials making requests. for more         #
-# information on service accounts, see:                                       #
-# https://developers.google.com/google-ads/api/docs/oauth/service-accounts    #
-###############################################################################
-# json_key_file_path: INSERT_PATH_TO_JSON_KEY_FILE_HERE
-# impersonated_email: INSERT_DOMAIN_WIDE_DELEGATION_ACCOUNT
-
 # Logging configuration
 ###############################################################################
 # Below you may specify the logging configuration. This will be provided as   #
