Getting campaign optimization data from the API

[Ahmed Rslan]

Hi there,

I'm a new user of the Google Ads API and was wondering if it was possible to get 

the campaigns optimization data (cost, conversions, actual target CPA, ..etc) for multiple campaigns from the API, I can see the data on the dashboard but I can't tell if it is present on the API, the docs aren't clear.

Attached is an image showing a sample campaign and the needed data on the dashboard.

[Google Ads API Forum Advisor]

Hi Ahmed, 

Thanks for reaching out to the Google Ads API Team. I hope you are doing well today.

Moving forward to your concern, you may see the Google Ads API: Optimization score and recommendations full documentation and guidelines.

In line with this, for us to further check the provided information, can you please provide us with a complete or uncropped screenshot of the data that you are retrieving in Google Ads UI?

Furthermore, you can try to use a campaign report to use an API for pulling your data in campaign fields. If you encounter an issue or error, you may also send us your complete API logs (request and response with request-id) for further investigation.

We do this so that we can provide accurate recommendations. 

If you haven't enabled logging yet, it can be enabled by navigating to the Client libraries > Your client library (ex. Java) > Logging documentation, which you can access from this link. For REST interface requests, you can enable logging via the curl command by using the -i flag. This will cause the tool to include the HTTP response headers in the output.

You can provide the information via Reply privately to the author option. If this option is not available, then send it instead on this email address googleadsa...@google.com.

Reference links:

• Google Ads API: Optimization score and recommendations - https://developers.google.com/google-ads/api/docs/recommendations
• campaign report or builder - https://developers.google.com/google-ads/api/fields/v13/campaign_query_builder
• Logging documentation - https://developers.google.com/google-ads/api/docs/best-practices/logging#client_library_logging
• Request - https://developers.google.com/google-ads/api/docs/concepts/field-service#request
• Response - https://developers.google.com/google-ads/api/docs/concepts/field-service#response
• Request-id - https://developers.google.com/google-ads/api/docs/concepts/call-structure#request-id

Have a great day.

Regards,

Google Ads API Team

ref:_00D1U1174p._5004Q2koT1n:ref

[Ahmed Rslan]

Hi there, 

Attached is the screenshot you requested, I was wondering if I could get these data points showing in the UI through the API.

And If it were possible I had some follow-ups:

1. What would be an easy way to experiment with getting the data, do I need to use my main accounts or can I experiment with test accounts?

2. Can I get historical data?

3. What is the best way to handle authentication?

4. What if I had multiple accounts?

Thanks in advance  

[Google Ads API Forum Advisor]

Hello Ahmed,

Thank you for responding back to us.

Would you be able to confirm if the screenshot was referring to bid simulations? If so, you may refer to this documentation on how to Retrieve bid simulations (https://developers.google.com/google-ads/api/docs/bid-simulations/retrieve-bid-simulations). Should you need further assistance from us, would you be able to share to us also the entire screenshot of the UI before you click the campaign in question? Asking this so we can accurately investigate your concern with precise details such as customer ID in used.

With regards to your specific queries

1. What would be an easy way to experiment with getting the data, do I need to use my main accounts or can I experiment with test accounts?

• This will depend where the data is associated, whether in your main account or test account.

2. Can I get historical data?

• For most report, you may try segmentation (https://developers.google.com/google-ads/api/docs/reporting/segmentation#rules_for_core_date_segment_fields) by dates that would fit to narrow down your data

3. What is the best way to handle authentication?

• If you are referring to enabling API access, you must obtain the required OAuth2 credentials. Here is the quickstart you can follow https://developers.google.com/google-ads/api/docs/first-call/overview

4. What if I had multiple accounts?

• Can you elaborate more on this scenario? What would be your use case?

[Ahmed Rslan]

Hi there,

Attached is the document showing the UI before the simulation (by clicking the underlined button).

Can you confirm that the Retrieve bid simulations (https://developers.google.com/google-ads/api/docs/bid-simulations/retrieve-bid-simulations) link you shared would contain all the 

did data show on the UI as the naming is different?

What would be the best way to start experimenting an retrieving the data through the API?

I also had some clarifications/follow-ups:

1. I don't mean the exact data I meant getting this type of data to test if I can get it in the first place, I was viewing the docs on test accounts and it mentioned having 

some limitations on reports data?

4. For example if the Google Gmail account is associated with multiple ads accounts, can I access all accounts through the API?

[Google Ads API Forum Advisor]

Hi Ahmed,

Thank you for your reply. Please refer to the answers below:

1. Can you confirm that the Retrieve bid simulations (https://developers.google.com/google-ads/api/docs/bid-simulations/retrieve-bid-simulations) link you shared would contain all the did data show on the UI as the naming is different?

• If this contains the same fields to the said columns or sections then it will get the same results. However, if you encounter any issues let us know.

2. What would be the best way to start experimenting an retrieving the data through the API?

• We can suggest checking our Quickstart guide as it explains the workflow process of the Google Ads API. Since the Google Ads API is more on retrieving data from Google Ads UI, you can check this reporting of performance data is an integral part of Google Ads API applications. With the API's flexible reporting options, you can obtain performance data for all resources. Please refer to the links below:

Quickstart guide - https://developers.google.com/google-ads/api/docs/start?hl=en
reporting - https://developers.google.com/google-ads/api/docs/reporting/overview
resources that can be queried in the Google Ads API - https://developers.google.com/google-ads/api/fields/v13/overview

3. I don't mean the exact data I meant getting this type of data to test if I can get it in the first place, I was viewing the docs on test accounts and it mentioned having some limitations on reports data?

• Yes, we can confirm that there is a limitation in using a test account. For more information please see the "Testing Best Practices" page for guidance on working around these limitations via this link: https://developers.google.com/google-ads/api/docs/best-practices/testing#production-accounts-for-development

4. For example if the Google Gmail account is associated with multiple ads accounts, can I access all accounts through the API?

• Could you please confirm if you are referring to the access levels in your Google Ads Account? If yes, then the said Google Gmail account has access to the multiple Ads account. The grant access to the Google Ads Account, will be able to select which features the user can impact by assigning an access level. For more information please visit this link: https://support.google.com/google-ads/answer/9978556

Best regards,

[Ahmed Rslan]

Hey,

Thanks, I will be testing that and reaching out if I needed further help.

4. What I was asking for is that what if I had a gmail that's invited to multiple ads accounts, in this case, would I be able to query 

the data from all the accounts that this gmail is invited to, assuming I give the app permission of course?

[Google Ads API Forum Advisor]

Hi Ahmed,

Thank you for the reply.

It will depend on the access provided to you. You may check this article for more information on access levels in Google Ads account.

• article: https://support.google.com/google-ads/answer/9978556?visit_id=637387732568592312-2245497873&rd=1 

Note that the OAuth2 credentials generated by the users should inherit the access level provided.

• OAuth2 credentials : https://developers.google.com/google-ads/api/docs/oauth/cloud-project