Update in-app docs for select API sources #26781
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
octavia-squidington-iii
added
the
area/documentation
sherifnada
approved these changes
May 30, 2023
| 1. Click `Authenticate your Amazon Ads account`. Log in and authorize access to the Amazon account. | ||
| 2. (Optional) Select **Region** to pull data from **North America (NA)**, **Europe (EU)**, **Far East (FE)**. See [Amazon Ads documentation](https://advertising.amazon.com/API/docs/en-us/info/api-overview#api-endpoints) for more details. | ||
| 3. (Optional) **Start Date** can be used to generate reports starting from the specified start date in the format YYYY-MM-DD. The date should not be more than 60 days in the past. If not specified, today's date is used. The date is treated in the timezone of the processed profile. | ||
| 4. (Optional) **Profile ID(s)** you want to fetch data for. A profile is an advertiser's account in a specific marketplace. See [Amazon Ads docs](https://advertising.amazon.com/API/docs/en-us/concepts/authorization/profiles) for more details. |
There was a problem hiding this comment.
as a user i'd want to know the behavior if I don't specify this optional field. Does it pull everything or nothing?
| 2. (Optional) Select **Region** to pull data from **North America (NA)**, **Europe (EU)**, **Far East (FE)**. See [Amazon Ads documentation](https://advertising.amazon.com/API/docs/en-us/info/api-overview#api-endpoints) for more details. | ||
| 3. (Optional) **Start Date** can be used to generate reports starting from the specified start date in the format YYYY-MM-DD. The date should not be more than 60 days in the past. If not specified, today's date is used. The date is treated in the timezone of the processed profile. | ||
| 4. (Optional) **Profile ID(s)** you want to fetch data for. A profile is an advertiser's account in a specific marketplace. See [Amazon Ads docs](https://advertising.amazon.com/API/docs/en-us/concepts/authorization/profiles) for more details. | ||
| 5. (Optional) **State Filter** Reflects the state of the Display, Product, and Brand Campaign streams as enabled, paused, or archived. If you do not populate this field, it will be ignored completely. |
There was a problem hiding this comment.
I'm not certain I understand this. I think it's saying that if you toggle this option, we'll sync data related to campaigns regardless of their status, otherwise not? I'm not sure honestly
There was a problem hiding this comment.
Updated to clarify.
| 3. (Optional) **Start Date** can be used to generate reports starting from the specified start date in the format YYYY-MM-DD. The date should not be more than 60 days in the past. If not specified, today's date is used. The date is treated in the timezone of the processed profile. | ||
| 4. (Optional) **Profile ID(s)** you want to fetch data for. A profile is an advertiser's account in a specific marketplace. See [Amazon Ads docs](https://advertising.amazon.com/API/docs/en-us/concepts/authorization/profiles) for more details. | ||
| 5. (Optional) **State Filter** Reflects the state of the Display, Product, and Brand Campaign streams as enabled, paused, or archived. If you do not populate this field, it will be ignored completely. | ||
| 6. (Optional) **Look Back Window** The amount of days to go back in time to get the updated data from Amazon Ads |
There was a problem hiding this comment.
as a user I don't know why this is useful vs. start date
There was a problem hiding this comment.
Agreed, reached out to GL for clarification.
Co-authored-by: Sherif A. Nada <snadalive@gmail.com>
|
@sherifnada I accidentally merged the commits from this PR #26870 here as well. LMK if you prefer that I just close #26870 and keep this one, or keep them separate. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
Creates new in-app setup guides for:
Updates existing in-app setup guides for:
Simplifies the existing doc, but does not create any in-app doc, just makes use of the OSS/Cloud tags that already exist.
馃毃 User Impact 馃毃
Are there any breaking changes? What is the end result perceived by the user?
No breaking changes
Tagged you @sherifnada to review, but let me know if I should tag another teammate. I have a few more connectors I'll update in-app guides for, but don't want the PR to become too large