Data Manager API Audience Ingestion
GoogleOfficialPublished by Google
- Skill
- Tool integration
- Automation and integrations
- Apache-2.0
- No issues found
AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
This skill provides a comprehensive guide for developers to manage audience members—including adding, removing, and clearing lists—within Google products like Google Ads and Display & Video 360 using the Data Manager API. It covers the end-to-end process from identifying the correct destination account and formatting user data to executing API requests and performing asynchronous diagnostics to verify ingestion success.
What it does
- Guides the implementation of audience ingestion, removal, and replacement workflows.
- Provides instructions for configuring destination accounts and headers.
- Details the normalization and hashing of user identifiers using utility libraries.
- Explains how to validate API request schemas without applying changes.
- Outlines the process for polling and interpreting asynchronous request status and diagnostics.
- Highlights critical implementation gotchas regarding field naming, consent, and encoding.
When to use it
- When you need to upload, remove, or clear audience members for Customer Match or mobile device ID lists.
- When integrating the Data Manager API into your application for audience management.
- When troubleshooting ingestion failures or verifying the status of an asynchronous request.
- When refactoring existing code from older Google APIs to the Data Manager API.
Advantages
- Standardizes the approach for managing audience data across different Google destinations.
- Reduces errors by providing clear guidance on required fields and data formatting.
- Ensures robust error handling through diagnostic polling and status inspection.
- Provides direct access to language-specific code samples and migration field mappings.
Usage examples
- “How do I upload a list of hashed emails to a Google Ads Customer Match audience?”
- The agent will guide you through initializing the IngestionServiceClient, formatting the emails using the utility library, constructing an IngestAudienceMembersRequest, and checking the request status.
- “I need to remove all members from an existing DV360 audience. What is the process?”
- The agent will provide the steps to construct a RemoveAllAudienceMembersRequest, specify the correct destination, and execute the removal via the Data Manager API.
- “How can I check if my audience ingestion request was successful?”
- The agent will explain how to use the returned request_id to poll the retrieve_request_status endpoint and interpret the resulting status and diagnostic fields.
Install
Download the skill as a ZIP:
https://autogineer.com/agent-skills/google/data-manager-api-audience-ingestion/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip data-manager-api-audience-ingestion.zip -d .agents/skills
Documentation by Google
Data Manager API Audience Ingestion
Implementation Workflow
Prerequisites
Authentication & Library Installation: If you need to set up access to the Data Manager API or install the client and utility libraries, refer to the
data-manager-api-setupskill.Audience Creation (if needed): If the user does not have an existing audience or needs to create a new one, use the Create an Audience reference. This step provides the
product_destination_idneeded for the ingestion or removal requests.
Step 1: Identify Use Case & Read Documentation
Determine Destination Account Type: [CRITICAL] If it's not clear where the data is being sent (e.g., Google Ads, Display & Video 360, etc.), STOP and CLARIFY with the user BEFORE generating any code. Do not assume Google Ads by default. This maps to the
account_typefield of theoperating_accountin theDestination.Read the implementation guide: Read the relevant guide for your destination and use case. Do this before answering questions or writing code because each destination has unique payload structures, consent rules, and required fields.
| Destination | Audience Type | Accepted Data Types | Upload Guide | Remove All/Replace All Guide |
|---|---|---|---|---|
| Google Ads | Customer Match | composite_data.user_data (contact info), mobile_data (device IDs), user_id_data (user IDs) | Upload Data | Remove All/Replace All |
| Display & Video 360 (DV360) | Customer Match | composite_data.user_data (contact info), mobile_data (device IDs) | Upload Data | Remove All/Replace All |
Step 2: Retrieve Code Sample
[!IMPORTANT] If writing or updating an ingestion script, ALWAYS retrieve the relevant code sample to use as a reference:
| Language | Sample |
|---|---|
| Python | ingest_audience_members.py |
| Java | IngestAudienceMembers.java |
| PHP | ingest_audience_members.php |
| Node | ingest_audience_members.ts |
| .NET | IngestAudienceMembers.cs |
Step 3: Retrieve Migration Guides
[!IMPORTANT] If refactoring code to upgrade from another Google API, ALWAYS extract the full contents of the relevant field mapping guide.
Google Ads
Google Ads API Customer Match: Google Ads API to Customer Match Migration Field Mappings
Display & Video 360
Display & Video 360 API Customer Match: Display & Video 360 API to Customer Match Migration Field Mappings
Step 4: Implementation
Implement the ingestion logic using the following checkpoints:
[ ] Initialize Client: Instantiate the Data Manager client (
IngestionServiceClient).[ ] Define Destinations: Build the
Destinationobject using theproduct_destination_idand the appropriate account configurations:operating_account(target account receiving data),login_account(if authenticating using a manager account or a data partner account), andlinked_account(if you're a data partner accessing the account via a partner link to a manager account). STRONGLY RECOMMENDED: Refer to the Configure destinations and headers guide for more details on configuring destinations.[ ] Format User Data: If sending an
IngestAudienceMembersRequestorRemoveAudienceMembersRequest, refer to Formatting User Data to properly normalize and hash user identifiers using the utility library.[ ] Construct Payload: Build the appropriate request payload based on the operation:
Add:
IngestAudienceMembersRequestRemove:
RemoveAudienceMembersRequestRemove All:
RemoveAllAudienceMembersRequest
[ ] Support Validation: Support sending the
validate_onlyboolean option on the payload to allow developers to validate schemas without actually applying changes.[ ] Send Request: Execute the appropriate method and record the returned
request_idfor later diagnostics:Add:
ingest_audience_membersRemove:
remove_audience_membersRemove All:
remove_all_audience_members
[ ] Check for Ingestion Warnings: If any non-required field had a validation failure, the response from
ingest_audience_memberswill also includefield_warnings, a list ofFieldWarningobjects detailing the issues.[ ] Retrieve Request Status: Check the status of the ingestion request using diagnostics. Since request processing is asynchronous, a successful response (HTTP 200 OK returning a
request_id) only indicates the payload was received. To check if the records actually succeeded, partially succeeded, or failed to process, queryclient.retrieve_request_statususing therequest_id. Skipping this step is a common user mistake.
Critical Gotchas
If sending hashed user identifiers in
user_dataforingest_audience_membersorremove_audience_members, you must set theencodingfield on theIngestAudienceMembersRequesttoHEXorBASE64.If uploading to a Customer Match audience, the
terms_of_servicefield is required on theIngestAudienceMembersRequestto indicate the user has accepted the policies.Only set the
addressfield onUserIdentifierif all required fields (postal_code,family_name,given_name,region_code) are present; incompleteaddressfields will cause the API request to fail.product_destination_idmust be a numeric string. It is NOT a resource name.The enum values for
ConsentStatusareCONSENT_GRANTEDandCONSENT_DENIED. Do not use the valuesGRANTEDandDENIED.Field names on
UserIdentifierareemail_addressandphone_number. Do not use the Google Ads API field nameshashed_emailandhashed_phone_number.Do not call the diagnostics endpoint (
retrieve_request_status) ifvalidate_onlyis set totrue.
Error Handling & Troubleshooting
Inspecting Error Payloads & Ingestion Warnings
[!IMPORTANT] Refer to Understand API Errors for a detailed guide on how to understand the structure of errors and warnings returned by the API.
Retrieving Request Status (Diagnostics)
Periodically poll for status using exponential backoff, starting at least 30 minutes after sending the request.
Call
client.retrieve_request_statususingRetrieveRequestStatusRequest(request_id=...).Loop through
request_status_per_destinationin the response to inspect each target'srequest_status.If processing is complete and
request_statusisSUCCESS,PARTIAL_SUCCESS, orFAILED, inspect diagnostic values:Audience Status: Check the status specific to your request:
Ingest: Check the data-type-specific status nested under
audience_members_ingestion_status(e.g.,composite_data_ingestion_status).Remove Individual Members: Check the data-type-specific status nested under
audience_members_removal_status(e.g.,composite_data_removal_status).Remove All Members: There are no nested status fields or record counts available to check for this request type.
Record Count: If applicable (ingest or remove individual members), check
record_count(nested inside the data-type-specific status object) which includes both success and failure.Identifier Counts: If applicable (ingest or remove individual members), check the data-type-specific count field nested inside the status object (e.g.,
data_type_countsif uploading or removing composite data, ormobile_id_countif uploading or removing mobile IDs). Refer to the Diagnostics Guide for other count fields.Match Rate Range: For uploads of
user_dataandcomposite_data, checkupload_match_rate_rangenested inside the status object.
Error Details: If status is
FAILEDorPARTIAL_SUCCESS, inspect each error'sreasonandrecord_countundererror_info.error_counts.Warning Details: Inspect each warning's
reasonandrecord_countunderwarning_info.warning_counts(even if the destination status isSUCCESS).
API Reference
Files
- ATTRIBUTION.mdAdded by AutoGineer886 B
- LICENSELicence file added by AutoGineer11.1 KiB
- SKILL.md11.1 KiB
- references/create-audience.md2.1 KiB
- references/formatting.md633 B
LICENSE
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Requirements and compatibility
Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta
“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.
Needs: Needs Python, Needs Node.js
Security
No issues found by our static scan· No issues found
A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.
Attribution and licence
- Published by
- Publisher
- Google (Official)
- Source
- google/skills · skills/ads/data-manager-api-audience-ingestion · commit 2194d3b
- Licence
- Apache License 2.0 (redistribution allowed)
- LICENSE (added by AutoGineer from LICENSE)
- ATTRIBUTION.md (written by AutoGineer)
- Synced
AutoGineer is not affiliated with or endorsed by Google or Google.
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download data-manager-api-audience-ingestion.zip