Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Source Google Ads docs update #28833

Merged
merged 11 commits into from
Aug 1, 2023
Merged

Conversation

ChristoGrab
Copy link
Contributor

What

Updated the main and in-app docs for Google Ads.

How

In-app file

  • Added OSS prerequisites to inapp file
  • Added link to main docs for OSS users to make sure they get their tokens and credentials
  • Updated setup steps and added OSS-specific version

Main file

  • Slight restructure to developer token instructions
  • Added step for obtaining OAuth credentials with link to Google's instructions
  • Reworked/updated setup steps
  • IMPORTANT!!: I updated the note about possible data duplication because of the conversion window. My understanding is that the intent was to warn users that the conversion window adds a larger range of data for incremental syncs to have to read (in case a conversion occurs within said window), which could result in data that has already been appended being duplicated. I added a recommendation to consider using the Deduped History sync, as I believe this would mitigate the issue. That being said, I'm obviously working with a very limited understanding, so let me know if this section needs to be clarified or altered in any way!
  • Removed some duplicate links
  • Re-organized a couple out-of-sequence streams in the list

@octavia-squidington-iii octavia-squidington-iii added the area/documentation Improvements or additions to documentation label Jul 28, 2023
@ChristoGrab ChristoGrab marked this pull request as ready for review July 28, 2023 21:59
@ChristoGrab ChristoGrab requested a review from sherifnada July 28, 2023 22:00
@@ -82,10 +97,11 @@ The Google Ads source connector supports the following [sync modes](https://docs
- [Incremental Sync - Append](https://docs.airbyte.com/understanding-airbyte/connections/incremental-append)
- [Incremental Sync - Deduped History](https://docs.airbyte.com/understanding-airbyte/connections/incremental-deduped-history)

**Important note**:
:::caution
When using the Conversion Window feature, please be aware that it may result in duplicates during Incremental Sync. Due to the possibility of conversions happening within the specified window, the connector will extend the range of the sync, which could potentially result in duplicated data.
Copy link
Contributor

@sherifnada sherifnada Jul 31, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section is a bit vague to the user; "duplicates" isn't exactly right (and makes it sound like we're doing something wrong). This is a feature; it's more that we'd have updated conversion data for the same campaigns/ad_groups/ad_group_ads.

A conversion window is;

In digital advertising, a "conversion" generally refers to when a user who views or interacts with an ad goes on to perform a desired action. This could be anything from clicking through to the advertiser's website, signing up for a newsletter, making a purchase, and so on.
Now, the "conversion window" is the period of time after a user sees or clicks on an ad during which their actions can still be credited to that ad.
For example, imagine an online shoe store runs an ad and sets a conversion window of 30 days. If you click on that ad today, any purchases you make on the shoe store's site within the next 30 days will be considered conversions resulting from that ad.
The length of the conversion window can vary depending on the goals of the advertiser and the nature of the product or service. Some businesses might set a shorter conversion window if they're promoting a limited-time offer, while others might set a longer window if they're advertising a product that consumers typically take a while to think about before buying.
In essence, the conversion window is a tool for measuring the effectiveness of an advertising campaign. By tracking the actions users take after viewing or interacting with an ad, businesses can gain insight into how well their ads are working and adjust their strategies accordingly.

I think we can boil all this down to: every time the connector runs it will output conversion data for every campaign, ad_group, or ad_group_ad which was running less than N days ago where N is the configured conversion window. This will make it look like the same campaigns/ad_groups/ads have different conversion numbers when in reality each record tracks the number of conversions for that resource at the time of extracting the data from the Google Ads API.

The incremental-dedupe thing is actually dependent on primary keys. If the user setup a PK which does not include segment.date then incremental-dedupe would retain only the latest number for a given unique ad/campaign etc.. but if the PK doesn't include that then incremental dedupe doesn't help so I think we shouldn't mention incremental dedupe (or mention that if they want only the latest they need to setup the PK in this way)

Maybe we should also have that blurb to explain conversion windows in the doc

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gotcha, thanks for the clarification! I added a dedicated section to this with the blurb and explanation, and removed the deduped recommendation

docs/integrations/sources/google-ads.md Show resolved Hide resolved
@ChristoGrab ChristoGrab merged commit 4a8e75e into master Aug 1, 2023
@ChristoGrab ChristoGrab deleted the google-ads-docs-update branch August 1, 2023 22:10
bnchrch pushed a commit that referenced this pull request Aug 3, 2023
* update token request step

* add instructions for OAuth credentials

* additional context

* add setup steps from main to inapp

* update duplication comment

* minor changes to inapp setup

* clarify manager account Customer ID field

* update prerequisites

* truncat inapp setup steps

* last couple edits

* update note on conversion windows
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation connectors/source/google-ads
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants