Google ads added fields and reports #9310

schlattk · 2022-01-05T11:38:05Z

What

Add fields to several streams and update existing streams

How

Describe the solution

🚨 User Impact 🚨

Are there any breaking changes? What is the end result perceived by the user? If yes, please merge this PR with the 🚨🚨 emoji so changelog authors can further highlight this if needed.

Pre-merge Checklist

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

Create a non-forked branch based on this PR and test the below items on it
Build is successful
Credentials added to Github CI. Instructions.
/test connector=connectors/<name> command is passing.
New Connector version released on Dockerhub by running the /publish command described here
After the connector is published, connector added to connector index as described here
Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described here

Updating a connector

Community member or Airbyter

Grant edit access to maintainers (instructions)
Secrets in the connector's spec are annotated with airbyte_secret
Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
Code reviews completed
Documentation updated
- Connector's README.md
- Connector's bootstrap.md. See description and examples
- Changelog updated in docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
PR name follows PR naming conventions

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

Create a non-forked branch based on this PR and test the below items on it
Build is successful
Credentials added to Github CI. Instructions.
/test connector=connectors/<name> command is passing.
New Connector version released on Dockerhub by running the /publish command described here
After the new connector version is published, connector version bumped in the seed directory as described here
Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described here

Connector Generator

Issue acceptance criteria met
PR name follows PR naming conventions
If adding a new generator, add it to the list of scaffold modules being tested
The generator test modules (all connectors with -scaffold in their name) have been updated with the latest scaffold by running ./gradlew :airbyte-integrations:connector-templates:generator:testScaffoldTemplates then checking in your changes
Documentation which references the generator is updated as needed.

This change is

CLAassistant · 2022-01-05T11:38:11Z

All committers have signed the CLA.

working locally missing fields in click view and keyqord_view add date to campaigns add fields to click_view test

marcosmarxm · 2022-01-06T18:52:52Z

Thanks for the contribution @schlattk I request for the team to review it during the week.

augan-rymkhan · 2022-01-12T15:57:35Z

airbyte-integrations/connectors/source-google-ads/test_catalog_ad_group_ad_report.json

@@ -0,0 +1,16 @@
+{


Configured streams provided in json files should not be placed in the root of the connector.
I see they are not used in the code. So, you can put them under secrets/ directory which is in gitignore.

source-google-ads/test_catalog_ad_group_ad_report.json
source-google-ads/ test_catalog_campaigns.json
source-google-ads/test_catalog_click_view.json
source-google-ads/test_catalog_click_view.json
source-google-ads/test_catalog_display_keyword_performance_report.json
source-google-ads/test_catalog_keyword_view.json

augan-rymkhan · 2022-01-12T16:36:18Z

airbyte-integrations/connectors/source-google-ads/source_google_ads/google_ads.py

@@ -23,6 +23,7 @@
    "shopping_performance_report": "shopping_performance_view",
    "user_location_report": "user_location_view",
    "click_view": "click_view",
+    "keyword_view": "keyword_view"


keyword_view stream was already added.
You should update your forked repo from the original repo. And resolve the Merge conflicts.

https://github.com/airbytehq/airbyte/blob/master/airbyte-integrations/connectors/source-google-ads/source_google_ads/google_ads.py#L27

https://github.com/airbytehq/airbyte/blob/master/airbyte-integrations/connectors/source-google-ads/source_google_ads/streams.py#L206

https://github.com/airbytehq/airbyte/blob/master/airbyte-integrations/connectors/source-google-ads/source_google_ads/schemas/keyword_report.json

https://github.com/airbytehq/airbyte/blob/master/airbyte-integrations/connectors/source-google-ads/integration_tests/configured_catalog.json#L53

augan-rymkhan · 2022-01-13T04:55:28Z

airbyte-integrations/connectors/source-google-ads/source_google_ads/streams.py

@@ -129,7 +129,7 @@ class Accounts(GoogleAdsStream):
    primary_key = "customer.id"


-class Campaigns(GoogleAdsStream):
+class Campaigns(IncrementalGoogleAdsStream):


Configured stream "campaigns" should be updated in configured_catalog.json, need to add incremental mode and set sync_mode to it, as below:

{ "stream": { "name": "campaigns", "json_schema": {}, "supported_sync_modes": ["full_refresh", "incremental"], "source_defined_primary_key": [["campaign.id"]], "source_defined_cursor": true, "default_cursor_field": ["segments.date"] }, "sync_mode": "incremental", "destination_sync_mode": "overwrite", "cursor_field": ["segments.date"] }

marcosmarxm · 2022-01-24T20:11:20Z

@schlattk did you have time to look the comments made by @augan-rymkhan ?

schlattk · 2022-02-04T14:43:58Z

@schlattk did you have time to look the comments made by @augan-rymkhan ?

yes sorry for the delay @marcosmarxm @augan-rymkhan

schlattk · 2022-02-23T15:19:32Z

@augan-rymkhan could you have another look?

augan-rymkhan · 2022-02-08T08:31:09Z

...nnectors/source-google-ads/source_google_ads/schemas/display_keyword_performance_report.json

@@ -248,6 +247,9 @@
    },
    "segments.year": {
      "type": ["null", "integer"]
+    },
+    "segments.date": {
+      "type": ["null", "integer"]


@schlattk Why segments.date type is changed from "string" to "integer" and removed "format": "date" ?

@augan-rymkhan ok thanks if you could have another look

augan-rymkhan · 2022-02-08T08:40:19Z

airbyte-integrations/connectors/source-google-ads/source_google_ads/source.py

@@ -24,8 +24,12 @@
    ClickView,
    DisplayKeywordPerformanceReport,
    DisplayTopicsPerformanceReport,
+<<<<<<< HEAD
+    KeywordView,


@schlattk stream KeywordView is not defined anywhere. You should remove all the references to KeywordView (resolving merge conflicts also), because this stream is implemented as KeywordReport.

augan-rymkhan · 2022-02-08T09:42:04Z

airbyte-integrations/connectors/source-google-ads/source_google_ads/schemas/campaigns.json

+      "type": ["null", "number"]
+    },
+    "segments.date": {
+      "type": ["null", "string"]


Better to add "format": "date" here

augan-rymkhan · 2022-02-24T10:17:32Z

airbyte-integrations/connectors/source-google-ads/source_google_ads/source.py

            Campaigns(**incremental_stream_config),
            ClickView(**incremental_stream_config),
+<<<<<<< HEAD
+            KeywordView(**incremental_stream_config)


No need in KeywordView.

airbyte-integrations/connectors/source-google-ads/source_google_ads/source.py

augan-rymkhan · 2022-02-25T08:10:58Z

/test connector=connectors/source-google-ads

Error: No ref found for: google-ads-add-fields

schlattk · 2022-02-25T09:31:22Z

@augan-rymkhan I removed this new conflict

augan-rymkhan · 2022-02-25T09:36:20Z

@schlattk
I have run SAT tests locally in your branch. There are 2 tests failed. Could you test it yourself on your local machine by the following steps:

pip install .[tests]
docker build . -t airbyte/source-google-ads:dev
python -m pytest integration_tests -p integration_tests.acceptance

It seems some added fields are not supported metrics.

E docker.errors.ContainerError: Command 'read --config tap_config.json --catalog catalog.json' in image '<Image:

<_InactiveRpcError of RPC that terminated with:\n\tstatus = StatusCode.INVALID_ARGUMENT\n\tdetails = "Request contains an invalid argument."\n\tdebug_error_string = "{"created":"@1645780794.933768829","description":"Error received from peer ipv4:216.58.207.202:443","file":"src/core/lib/surface/call.cc","file_line":903,"grpc_message":"Request contains an invalid argument.","grpc_status":3}"\n>, errors {\n error_code {\n query_error: PROHIBITED_SEGMENT_WITH_METRIC_IN_SELECT_OR_WHERE_CLAUSE\n }\n message: "Cannot select the following segments because at least one unsupported metric is found in SELECT or WHERE clause: \'segments.ad_network_type\'(unsupported metrics: \'historical_quality_score\')."\n}\nrequest_id: "REm0DyAHjwK4YuSl6iScIA"\n, 'REm0DyAHjwK4YuSl6iScIA')"}}

schlattk · 2022-02-25T13:42:01Z

@augan-rymkhan these tests run forever on my connection but could be an incorrect type on segments.ad_network_type
I corrected it to string from integer

augan-rymkhan · 2022-02-25T14:28:02Z

@schlattk Ok, but this does not fix that errors: message: "Cannot select the following segments because at least one unsupported metric is found in SELECT or WHERE clause:

schlattk · 2022-02-25T14:54:18Z

@augan-rymkhan it appears to be this ? (unsupported metrics: \'historical_quality_score\')
However this metric is not part of this PR
Although it is supported according to docs
https://developers.google.com/google-ads/api/fields/v8/keyword_view

augan-rymkhan · 2022-02-25T15:09:25Z

airbyte-integrations/connectors/source-google-ads/source_google_ads/schemas/keyword_report.json

+    "ad_group_criterion.criterion_id": {
+      "type": ["null", "integer"]
+    },
+    "segments.ad_network_type": {


@schlattk Error happens because this field was added.

message: "Cannot select the following segments because at least one unsupported metric is found in SELECT or WHERE clause: \'segments.ad_network_type\'(unsupported metrics: \'historical_quality_score\')."\n}\nrequest_id: "hBx3G90_bSZ-rVpnBMQlxQ"\n, 'hBx3G90_bSZ-rVpnBMQlxQ')"}}

It works when read command is run without this field.

@augan-rymkhan ok but it is a supported field according to documentation and also it has been running live for a long time without any errors. What do you suggest is the solution?

@schlattk It seems we can not query metrics.historical_quality_score and segments.ad_network_type together in keyword_report stream.

In docs:
A segment in the SELECT clause is incompatible with a metric in the SELECT or WHERE clause.
For more you can read PROHIBITED_SEGMENT_WITH_METRIC_IN_SELECT_OR_WHERE_CLAUSE.

yes @augan-rymkhan that appears to be the problem. Ok, I removed the field I think we can most probably do without it in this report.

augan-rymkhan · 2022-02-28T15:18:42Z

...-integrations/connectors/source-google-ads/source_google_ads/schemas/ad_group_ad_report.json

@@ -5,6 +5,9 @@
    "ad_group_ad.ad.legacy_responsive_display_ad.accent_color": {
      "type": ["null", "string"]
    },
+    "ad_group.id": {
+      "type": ["null", "string"]


@schlattk type must be "integer", not "string".

@augan-rymkhan

@augan-rymkhan let me know if any further changes are needed

marcosmarxm

thanks @schlattk

* combine all working locally missing fields in click view and keyqord_view add date to campaigns add fields to click_view test * configured_catalog campaigns * rem keywordview * conflicts * string type * remove network type * change ad group id to integer Co-authored-by: Konrad <konrad@PB-Mac8.local>

github-actions bot added the area/connectors Connector related issues label Jan 5, 2022

octavia-squidington-iii added the community label Jan 5, 2022

combine all

0ee1ad1

working locally missing fields in click view and keyqord_view add date to campaigns add fields to click_view test

marcosmarxm added the zzm label Jan 6, 2022

VasylLazebnyk added this to the Connectors Jan 14 2022 milestone Jan 6, 2022

VasylLazebnyk requested review from yevhenii-ldv, Zirochkaa and htrueman January 6, 2022 09:51

marcosmarxm self-assigned this Jan 6, 2022

VasylLazebnyk requested review from augan-rymkhan and removed request for htrueman, Zirochkaa and yevhenii-ldv January 12, 2022 13:09

augan-rymkhan suggested changes Jan 13, 2022

View reviewed changes

VasylLazebnyk modified the milestones: Connectors Jan 14 2022, Connectors Jan 28 2022 Jan 17, 2022

schlattk added 2 commits February 4, 2022 14:33

merge master

fe5e4ba

configured_catalog campaigns

5a0808f

resolve merge conflicts

eeabecf

schlattk requested a review from augan-rymkhan February 21, 2022 11:23

augan-rymkhan reviewed Feb 24, 2022

View reviewed changes

rem keywordview

75bed83

schlattk added 2 commits February 25, 2022 09:27

merge master

5494b20

conflicts

3f5c981

string type

ea95e02

augan-rymkhan reviewed Feb 25, 2022

View reviewed changes

augan-rymkhan reviewed Feb 28, 2022

View reviewed changes

schlattk added 2 commits February 28, 2022 15:23

remove network type

f5ce674

change ad group id to integer

9702a94

marcosmarxm approved these changes Apr 19, 2022

View reviewed changes

marcosmarxm merged commit f8011f7 into airbytehq:master Apr 19, 2022

octavia-squidington-iii mentioned this pull request Apr 19, 2022

Bump Airbyte version from 0.36.0-alpha to 0.36.1-alpha #12148

Merged

tinomerl mentioned this pull request May 23, 2022

Data missing in Google Ads latest vrsion for ad_group_ad_report #12999

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Google ads added fields and reports #9310

Google ads added fields and reports #9310

schlattk commented Jan 5, 2022 •

edited

Loading

CLAassistant commented Jan 5, 2022 •

edited

Loading

marcosmarxm commented Jan 6, 2022

augan-rymkhan Jan 12, 2022

augan-rymkhan Jan 12, 2022

augan-rymkhan Jan 13, 2022

marcosmarxm commented Jan 24, 2022

schlattk commented Feb 4, 2022 •

edited

Loading

schlattk commented Feb 23, 2022

augan-rymkhan Feb 8, 2022

schlattk Feb 24, 2022

augan-rymkhan Feb 8, 2022

augan-rymkhan Feb 8, 2022

augan-rymkhan Feb 24, 2022

augan-rymkhan commented Feb 25, 2022 •

edited by github-actions bot

Loading

schlattk commented Feb 25, 2022

augan-rymkhan commented Feb 25, 2022 •

edited

Loading

schlattk commented Feb 25, 2022

augan-rymkhan commented Feb 25, 2022

schlattk commented Feb 25, 2022

augan-rymkhan Feb 25, 2022

augan-rymkhan Feb 25, 2022

schlattk Feb 25, 2022

augan-rymkhan Feb 28, 2022 •

edited

Loading

schlattk Feb 28, 2022

augan-rymkhan Feb 28, 2022

schlattk Mar 1, 2022

schlattk Mar 2, 2022

marcosmarxm left a comment

Google ads added fields and reports #9310

Google ads added fields and reports #9310

Conversation

schlattk commented Jan 5, 2022 • edited Loading

What

How

Recommended reading order

🚨 User Impact 🚨

Pre-merge Checklist

Community member or Airbyter

Airbyter

Community member or Airbyter

Airbyter

CLAassistant commented Jan 5, 2022 • edited Loading

marcosmarxm commented Jan 6, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marcosmarxm commented Jan 24, 2022

schlattk commented Feb 4, 2022 • edited Loading

schlattk commented Feb 23, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

augan-rymkhan commented Feb 25, 2022 • edited by github-actions bot Loading

schlattk commented Feb 25, 2022

augan-rymkhan commented Feb 25, 2022 • edited Loading

schlattk commented Feb 25, 2022

augan-rymkhan commented Feb 25, 2022

schlattk commented Feb 25, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

augan-rymkhan Feb 28, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marcosmarxm left a comment

Choose a reason for hiding this comment

schlattk commented Jan 5, 2022 •

edited

Loading

CLAassistant commented Jan 5, 2022 •

edited

Loading

schlattk commented Feb 4, 2022 •

edited

Loading

augan-rymkhan commented Feb 25, 2022 •

edited by github-actions bot

Loading

augan-rymkhan commented Feb 25, 2022 •

edited

Loading

augan-rymkhan Feb 28, 2022 •

edited

Loading