Skip to content

Commit 25f6d1c

Browse files
facebook-github-botfacebook-github-bot
committed
Initial commit
fbshipit-source-id: 0b0fdfa76679932146c8537b56b0b650a3efa0aa
0 parents  commit 25f6d1c

File tree

7 files changed

+1686
-0
lines changed

7 files changed

+1686
-0
lines changed

‎CHANGELOG.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
## Unreleased
2+
3+
## Released
4+
5+
0.0.9 (Sept 5, 2023)
6+
* Add secure, HTTP only, 1st party `_gtmeec` cookie to enhance event data. This new cookie can be enabled using 'Enable Event Enhancement' option from the tag.
7+
8+
Toggling this feature “on” will help maximize the performance benefits of the events you currently share with Meta. Using this feature may improve your server events’ Event Match Quality (EMQ) by enabling first party http only secure cookie `_gtmeec` to cache hashed PII that you share using the Meta Pixel through Advanced Matching.
9+
10+
* Add [Data Processing Options](https://developers.facebook.com/docs/marketing-apis/data-processing-options/)
11+
* Fix null value set parameters.
12+
* Correct phone normalisation was also fixed in these changes.
13+
* Invalid template correction and test fixes.
14+
15+
0.0.8 (May 22, 2023)
16+
* Update Conversions API Graph version to v16.0
17+
* Fix syntax error in GTM template for extending meta cookies (fbp/fbc).
18+
* Fix contents array parsing.
19+
* Fix contents array received as [object Object].
20+
* Enable custom parameters.
21+
* Added fb_login_id support.
22+
* Added Meta Logo.
23+
24+
0.0.7 (Feb 27, 2022)
25+
* Update Conversions API Graph version to v14.0
26+
27+
0.0.6 (Jan 24, 2022)
28+
* Upgrading Facebook references to Meta.
29+
30+
0.0.5 (Aug 5, 2021)
31+
* Map gtm.dom event_names to PageView
32+
33+
0.0.4 (Jun 15, 2021)
34+
* Update Conversions API Graph version to v11.0
35+
36+
0.0.3 (Feb 24, 2021)
37+
* Update Conversions API Graph version to v10.0
38+
* Published in [Google Tag Manager Template Gallery](https://tagmanager.google.com/gallery/#/owners/facebookincubator/templates/ConversionsAPI-Tag-for-GoogleTagManager)
39+
40+
0.0.2 (Dec 22, 2020)
41+
* Update Conversions API Graph version to v9.0
42+
43+
0.0.1 (Oct 2, 2020)
44+
* Tag for deploying on Google Tag Manager's server-side to send Conversions API events.

‎CODE_OF_CONDUCT.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Code of Conduct
2+
3+
Facebook has adopted a Code of Conduct that we expect project participants to adhere to.
4+
Please read the [full text](https://code.fb.com/codeofconduct/)
5+
so that you can understand what actions will and will not be tolerated.

‎CONTRIBUTING.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Contributing to ConversionsAPI-Tag-for-GoogleTagManager
2+
We want to make contributing to this project as easy and transparent as possible.
3+
4+
## Our Development Process
5+
Clone this repo with the following command:
6+
Run `$ git clone https://github.com/facebookincubator/ConversionsAPI-Tag-for-GoogleTagManager.git`.
7+
8+
## Initiate the development environment:
9+
1. Follow Google Tag Manager's guidance for [updating templates](https://developers.google.com/tag-manager/templates/gallery#build_your_template).
10+
2. Make your changes to the `template.tpl` file and verify by deploying your template to your Google Tag Manager's server container.
11+
3. Include any test plan/screenshot that is relevant to your pull request.
12+
13+
## Pull Requests
14+
We actively welcome your pull requests.
15+
16+
1. Fork the repo and create your branch from `master`.
17+
2. If you've added code that should be tested, add tests.
18+
3. If you've changed APIs, update the documentation.
19+
4. Make sure your code lints.
20+
5. If you haven't already, complete the Contributor License Agreement ("CLA").
21+
22+
## Contributor License Agreement ("CLA")
23+
In order to accept your pull request, we need you to submit a CLA. You only need
24+
to do this once to work on any of Facebook's open source projects.
25+
26+
Complete your CLA here: <https://code.facebook.com/cla>.
27+
28+
## Issues
29+
We use GitHub issues to track public bugs. Please ensure your description is
30+
clear and has sufficient instructions to be able to reproduce the issue.
31+
32+
Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe
33+
disclosure of security bugs. In those cases, please go through the process
34+
outlined on that page and do not file a public issue.
35+
36+
## License
37+
By contributing to ConversionsAPI-Tag-for-GoogleTagManager, you agree that your contributions
38+
will be licensed under the LICENSE file in the root directory of
39+
this source tree.

‎LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [2020] Facebook, Inc.
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Conversions API Tag for Google Tag Manager(server-side)
2+
3+
The Conversions API allows advertisers to send web events from their servers directly to Conversions API. Server events are linked to a pixel and are processed like browser pixel events. This means that server events are used in measurement, reporting, and optimization in the same way as browser pixel events. [Learn More](https://developers.facebook.com/docs/marketing-api/conversions-api).
4+
5+
Google Tag Manager(GTM) have released support for their [Server-side](https://developers.google.com/tag-manager/serverside/) support for sharing customer actions with analytics partners directly from Advertisers' servers.
6+
7+
This template is a tag that reads the standard event schema that’s sent from the client running on a tagging server. It then converts events to the appropriate schema and sends them through Conversions API. The Tag supports the below clients,
8+
9+
* [GA4 Client](https://developers.google.com/tag-manager/serverside/send-data#server-side_client_configuration)
10+
* [Conversions API Client](https://github.com/facebookincubator/ConversionsAPI-Client-for-GoogleTagManager) (In Beta.This feature may not be available to you. Contact your Conversions API representative for more details.)
11+
12+
# Installation
13+
14+
Please follow the instructions [here](https://www.facebook.com/business/help/702509907046774).
15+
16+
# Reporting Bugs/Feedback
17+
Please raise any issue on GitHub
18+
19+
# License
20+
Conversions API for Google Tag Manager is licensed under LICENSE file in the root directory of this source tree.

‎metadata.yaml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
homepage: "https://developers.facebook.com/docs/marketing-api/conversions-api"
2+
documentation: "https://developers.facebook.com/docs/marketing-api/conversions-api/guides/gtm-server-side"
3+
versions:
4+
# Latest version
5+
- sha: a495e1bb54b3b1fe6e7a9f10fc64aa12e8731428
6+
changeNotes: Minor bug fix.
7+
# Older versions
8+
- sha: 54def96730fc5f25bcf469c0bfe14b90e302c855
9+
changeNotes: Invalid template correction to fetch new features, updates and test fixes. See CHANGELOG.md
10+
- sha: 57ed834ad33607799a72eefc6dfdf5c25b395f7a
11+
changeNotes: Version update with new features and bug fixes. See CHANGELOG.md
12+
- sha: f261eb2d0858b455618569cdfa8c752f2d543568
13+
changeNotes: Fix test setup
14+
- sha: 60e6504b1bff94f57a22abd9c7bc7c4043de44d7
15+
changeNotes: API version bump to v16.0 for GTM Plugin
16+
1. Fixing syntax error in GTM template for extending meta cookies (fbp/fbc).
17+
2. Fix contents array parsing.
18+
3. Fix contents array received as [object Object].
19+
4. Enable custom parameters.
20+
5. Added fb_login_id support.
21+
6. Added Meta Logo.
22+
- sha: b0c8f9608085738725806125aa849b8b959ed70c
23+
changeNotes: API version bump for GTM Plugin
24+
- sha: e6da8b1053e39c03fec77c455e6aae839344da43
25+
changeNotes: Updating Facebook references to Meta
26+
- sha: 1c8df2efbf77f0913863399ada05ae5c6895636d
27+
changeNotes: Map gtm.dom event_names to PageView
28+
- sha: 6ea79a611f497daabc37cce5d0ed1447685cc930
29+
changeNotes: Updated to latest Graph API v11.0
30+
- sha: f344a4c9e09aa135ecdb5aa7c945e698efce12c4
31+
changeNotes: Bug fixes for issues reported on GitHub.
32+
# Initial "Public" Version for Conversions API Tag
33+
- sha: 47daf13d1de21fbf2de68d4a2926581ee39d79a3
34+
changeNotes: Added support for GA4 Web Tag and Client to post event to Conversions API.
35+
- sha: 329d13128703af9bad62090dc7ff6b19e57ed4cc
36+
changeNotes: Adding support for converting common event model with Meta Pixel specific parameters to Conversions API.

0 commit comments

Comments
 (0)