Skip to content

feat(sample): use CompositeData with IP for audiences #6

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.

Sign up for GitHub

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

Merged
jradcliff merged 2 commits into from
Jun 25, 2026
Merged

feat(sample): use CompositeData with IP for audiences #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
312e7b6
feat(sample): use CompositeData with IP for audiences
jradcliff Jun 24, 2026
7bf2994
add missing "continue"
jradcliff Jun 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 66 additions & 4 deletions samples/audiences/ingest_audience_members.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,13 @@

use Google\Ads\DataManager\V1\AudienceMember;
use Google\Ads\DataManager\V1\Client\IngestionServiceClient;
use Google\Ads\DataManager\V1\CompositeData;
use Google\Ads\DataManager\V1\Consent;
use Google\Ads\DataManager\V1\ConsentStatus;
use Google\Ads\DataManager\V1\Destination;
use Google\Ads\DataManager\V1\Encoding as DataManagerEncoding;
use Google\Ads\DataManager\V1\IngestAudienceMembersRequest;
use Google\Ads\DataManager\V1\IpData;
use Google\Ads\DataManager\V1\ProductAccount;
use Google\Ads\DataManager\V1\ProductAccount\AccountType;
use Google\Ads\DataManager\V1\TermsOfService;
Expand All @@ -35,6 +37,7 @@
use Google\Ads\DataManagerUtil\Encoding;
use Google\Ads\DataManagerUtil\Formatter;
use Google\ApiCore\ApiException;
use Google\Protobuf\Timestamp;

/**
* Reads the JSON member data file.
Expand Down Expand Up @@ -120,11 +123,70 @@ function main(
}
}

if (!empty($identifiers)) {
$userData = new UserData()->setUserIdentifiers($identifiers);
// Adds IP address information for each valid entry for the member.
$ipDatas = [];
$ipInfos = $memberRow['ipInfos'] ?? [];
foreach ($ipInfos as $ipInfo) {
if ($operatingAccountType !== AccountType::GOOGLE_ADS) {
error_log(sprintf(
'Skipping IP address information for operating account type %s. '
. 'Sending IP address is only supported for operating account type GOOGLE_ADS.',
AccountType::name($operatingAccountType)
));
continue;
}

// Trims leading and trailing whitespace from the IP address.
$ipAddress = trim($ipInfo['ipAddress'] ?? '');
if (empty($ipAddress)) {
// Skips the IP information from the input file since it is missing IP address, which is
// required.
error_log('Skipping IP address information with no IP address');
continue;
}

// Creates an IpData message and sets its IP address.
$ipData = (new IpData())->setIpAddress($ipAddress);

// Adds observe start time to the IpData if present and in the expected timestamp format.
$startTimeStr = trim($ipInfo['observeStartTime'] ?? '');
if (!empty($startTimeStr)) {
try {
$startTime = new Timestamp();
$startTime->fromDateTime(new \DateTime($startTimeStr));
$ipData->setObserveStartTime($startTime);
} catch (\Exception $e) {
error_log(sprintf("Ignoring observe start time '%s' since it can't be parsed", $startTimeStr));
}
}

// Adds observe end time to the IpData if present and in the expected timestamp format.
$endTimeStr = trim($ipInfo['observeEndTime'] ?? '');
if (!empty($endTimeStr)) {
try {
$endTime = new Timestamp();
$endTime->fromDateTime(new \DateTime($endTimeStr));
$ipData->setObserveEndTime($endTime);
} catch (\Exception $e) {
error_log(sprintf("Ignoring observe end time '%s' since it can't be parsed", $endTimeStr));
}
}

$ipDatas[] = $ipData;
}

if (!empty($identifiers) || !empty($ipDatas)) {
$compositeData = new CompositeData();
if (!empty($identifiers)) {
$userData = (new UserData())->setUserIdentifiers($identifiers);
$compositeData->setUserData($userData);
}
if (!empty($ipDatas)) {
$compositeData->setIpData($ipDatas);
}

// Adds an AudienceMember with the formatted and hashed identifiers.
$audienceMember = (new AudienceMember())->setUserData($userData);
// Adds an AudienceMember with the CompositeData.
$audienceMember = (new AudienceMember())->setCompositeData($compositeData);
$audienceMembers[] = $audienceMember;
}
}
Expand Down
2 changes: 1 addition & 1 deletion samples/composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
],
"require": {
"php": ">=8.1",
"googleads/data-manager": "^0.1.0",
"googleads/data-manager": "^0",
"googleads/data-manager-util": "@dev"
},
"require-dev": {
Expand Down
15 changes: 15 additions & 0 deletions samples/sampledata/audience_members_1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,14 @@
"emails": [
"dana@example.com",
"DanaM@example.com"
],
"ipInfos": [
{
"ipAddress": "192.0.2.211"
},
{
"ipAddress": "198.51.100.14"
}
]
},
{
Expand All @@ -21,6 +29,13 @@
"emails": [
"quinn@CYMBALGROUP.com",
"baklavainthebalkans@gmail.com"
],
"ipInfos": [
{
"ipAddress": "203.0.113.98",
"observeStartTime": "2026-06-10T20:17:52.0-04:00",
"observeEndTime": "2026-06-17T04:02:04.123-04:00"
}
]
},
{
Expand Down