AdGeneration: Align segment parameter with OpenRTB spec(id必須, valueは非必須)#3
Closed
ss-toshihide-tajima wants to merge 2 commits into
Closed
AdGeneration: Align segment parameter with OpenRTB spec(id必須, valueは非必須)#3ss-toshihide-tajima wants to merge 2 commits into
ss-toshihide-tajima wants to merge 2 commits into
Conversation
ss-toshihide-tajima
force-pushed
the
updateAdGenerationFirstPartyDataExample
branch
3 times, most recently
from
64a25ea to
9df9871
Compare
This commit updates the AdGeneration bidder documentation to reflect a new specification for processing First Party Data segments (ortb2.site.content.data[].segment).
The updated specification defines two distinct behaviors:
1. If only `segment[].id` is provided (e.g., `{ id: "1001" }`), the 'id' is treated as a pre-arranged classification code.
2. If both `segment[].id` and `segment[].value` are provided (e.g., `{ id: "news", value: "sports" }`), the 'value' is read as the value for the 'id' key.
The documentation example has been updated to demonstrate both use cases.
ss-toshihide-tajima
force-pushed
the
updateAdGenerationFirstPartyDataExample
branch
from
9df9871 to
53251c1
Compare
ss-toshihide-tajima
changed the title
Collaborator
Author
|
採用しないことになった |
Collaborator
Author
|
採用するのはこちら |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
🏷 Type of documentation
📋 Checklist
Background
This commit updates the AdGeneration bidder documentation (adgeneration.md) to address two issues related to First Party Data segments (ortb2.site.content.data[].segment).
Align with OpenRTB Specification (Fix name to id)
The OpenRTB specification requires the id field for objects within data segment arrays (like site.content.data[].segment). The previous documentation example incorrectly used the name field.
This discrepancy caused valid FPD to be filtered out by Prebid's validationFpdModule, which correctly enforces the spec by rejecting segments lacking the required id field.
This commit replaces all instances of name with id in the example code to ensure compliance.
Clarify Segment Handling Logic
The documentation is also updated to detail AdGeneration's specific handling of the segment object fields, reflecting a new publisher requirement:
segment[].id: Required.
segment[].value: Optional.
If only id is provided (e.g., { id: "1001" }): The id is treated as a pre-arranged classification code.
If both id and value are provided (e.g., { id: "news", value: "sports" }): The value is read as the value associated with the id (key).
The example code has been updated to demonstrate both of these use cases clearly. This ensures publishers understand how to send both key-value pairs and classification codes correctly.