Package google.ads.datamanager.v1

Indeks

IngestionService

Usługa do wysyłania danych o odbiorcach do obsługiwanych miejsc docelowych.

IngestAudienceMembers

rpc IngestAudienceMembers(IngestAudienceMembersRequest) returns (IngestAudienceMembersResponse)

Przesyła listę AudienceMember zasobów do podanego Destination.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/datamanager
IngestEvents

rpc IngestEvents(IngestEventsRequest) returns (IngestEventsResponse)

Przesyła listę zasobów Event z podanego pliku Destination.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/datamanager
RemoveAudienceMembers

rpc RemoveAudienceMembers(RemoveAudienceMembersRequest) returns (RemoveAudienceMembersResponse)

Usuwa listę zasobów AudienceMember z podanego zasobu Destination.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

  • https://www.googleapis.com/auth/datamanager

AdIdentifiers

Identyfikatory i inne informacje używane do dopasowywania zdarzenia konwersji do innej aktywności online (np. kliknięć reklam).

Pola
session_attributes

string

Opcjonalnie. Atrybuty sesji na potrzeby atrybucji i modelowania zdarzeń.
gclid

string

Opcjonalnie. Identyfikator kliknięcia Google (gclid) powiązany z tym zdarzeniem.
gbraid

string

Opcjonalnie. Identyfikator kliknięcia w przypadku kliknięć powiązanych ze zdarzeniami w aplikacji pochodzącymi z urządzeń z systemem iOS od wersji 14.
wbraid

string

Opcjonalnie. Identyfikator kliknięcia w przypadku kliknięć powiązanych ze zdarzeniami w witrynie pochodzącymi z urządzeń z systemem iOS od wersji 14.
landing_page_device_info

DeviceInfo

Opcjonalnie. Informacje zebrane o urządzeniu używanym (jeśli dotyczy) w momencie przejścia do witryny reklamodawcy po interakcji z reklamą.

AddressInfo

Informacje o adresie użytkownika.

Pola
given_name

string

Wymagany. Imię użytkownika (w całości zapisane małymi literami, bez znaków interpunkcyjnych, bez spacji na początku i na końcu, zahaszowane za pomocą SHA-256).
family_name

string

Wymagany. Nazwisko użytkownika (w całości małymi literami, bez znaków interpunkcyjnych, bez spacji na początku i na końcu, zahaszowane za pomocą SHA-256).
region_code

string

Wymagany. Dwuliterowy kod regionu w formacie ISO-3166-1 alpha-2 z adresu użytkownika.
postal_code

string

Wymagany. Kod pocztowy adresu użytkownika.

AudienceMember

Odbiorca, na którym ma być przeprowadzona operacja.

Pola
consent

Consent

Opcjonalnie. Ustawienie zgody użytkownika.
Pole unii data. Typ danych identyfikacyjnych, na których ma zostać wykonane działanie. data może mieć tylko jedną z tych wartości:
user_data

UserData

Dane przekazywane przez użytkowników, które identyfikują użytkownika.
pair_data

PairData

Identyfikatory dopasowywania danych o tożsamości użytkowników (PAIR).
mobile_data

MobileData

Dane identyfikujące urządzenia mobilne użytkownika.

CartData

Dane koszyka powiązane ze zdarzeniem.

Pola
merchant_id

string

Opcjonalnie. Identyfikator Merchant Center powiązany z produktami.
merchant_feed_label

string

Opcjonalnie. Etykieta pliku danych Merchant Center powiązana z plikiem danych produktów.
merchant_feed_language_code

string

Opcjonalnie. Kod języka w formacie ISO 639-1 powiązany z plikiem danych Merchant Center, w którym przesyłane są Twoje produkty.
transaction_discount

double

Opcjonalnie. Suma wszystkich rabatów powiązanych z transakcją.
items[]

Item

Opcjonalnie. Lista produktów powiązanych ze zdarzeniem.

Ustawienia zgody użytkownika wymaganej przez akt o rynkach cyfrowych (DMA).

Pola
ad_user_data

ConsentStatus

Opcjonalnie. Określa, czy użytkownik wyraża zgodę na korzystanie z danych użytkowników reklam.
ad_personalization

ConsentStatus

Opcjonalnie. Określa, czy użytkownik wyraża zgodę na personalizację reklam.

ConsentStatus

Wskazuje, czy użytkownik wyraził zgodę, odmówił jej udzielenia czy nie określił swojego stanowiska.

Wartości w polu enum
CONSENT_STATUS_UNSPECIFIED Nie określono.
CONSENT_GRANTED Przyznano.
CONSENT_DENIED Odrzucono.

Zmienna niestandardowa

Zmienna niestandardowa na potrzeby konwersji z reklam.

Pola
variable

string

Opcjonalnie. Nazwa zmiennej niestandardowej do ustawienia. Jeśli zmienna nie zostanie znaleziona w przypadku danego miejsca docelowego, zostanie zignorowana.
value

string

Opcjonalnie. Wartość, która ma być przechowywana w zmiennej niestandardowej.
destination_references[]

string

Opcjonalnie. Ciąg odniesienia używany do określania, do którego z Event.destination_references należy wysłać zmienną niestandardową. Jeśli pole jest puste, używana jest wartość Event.destination_references.

CustomerType

Typ klienta powiązanego ze zdarzeniem.

Wartości w polu enum
CUSTOMER_TYPE_UNSPECIFIED Nieokreślony typ klienta. Nigdy nie należy go używać.
NEW klient jest nowy dla reklamodawcy.
RETURNING Klient wraca do reklamodawcy.
REENGAGED Klient ponownie zaangażował się w interakcję z reklamodawcą.

CustomerValueBucket

Wartość klienta określona przez reklamodawcę.

Wartości w polu enum
CUSTOMER_VALUE_BUCKET_UNSPECIFIED Unspecified CustomerValueBucket. Nigdy nie należy go używać.
LOW Klient ma niską wartość.
MEDIUM Klient ma średnią wartość.
HIGH Klient jest wartościowy.

Miejsce docelowe

usługi Google, do której wysyłasz dane; Na przykład konto Google Ads.

Pola
reference

string

Opcjonalnie. Identyfikator tego zasobu Destination, unikalny w ramach żądania. Służy do odwoływania się do tego elementu Destination w IngestEventsRequest.
login_account

ProductAccount

Opcjonalnie. Konto użyte do wykonania tego wywołania interfejsu API. Aby dodawać lub usuwać dane z operating_account, to login_account musi mieć uprawnienia do zapisu w operating_account. Na przykład konto menedżera operating_account lub konto z ustalonym połączeniem z operating_account.
linked_account

ProductAccount

Opcjonalnie. Konto, do którego użytkownik wywołujący login_account ma dostęp dzięki utworzonemu połączeniu kont. Na przykład login_account partnera danych może mieć dostęp do linked_account klienta. Partner może używać tego pola do wysyłania danych z linked_account do innego operating_account.
operating_account

ProductAccount

Wymagany. Konto, na które mają być wysyłane dane lub z którego mają być usuwane.
product_destination_id

string

Wymagany. Obiekt na koncie usługi, do którego mają być przesyłane dane. Na przykład identyfikator listy odbiorców Google Ads lub identyfikator listy odbiorców Display & Video 360.

DeviceInfo

Informacje o urządzeniu używanym (jeśli dotyczy) w momencie wystąpienia zdarzenia.

Pola
user_agent

string

Opcjonalnie. Ciąg znaków klienta użytkownika urządzenia w danym kontekście.
ip_address

string

Opcjonalnie. Adres IP urządzenia w danym kontekście.

Uwaga: Google Ads nie obsługuje dopasowywania adresów IP użytkowników z Europejskiego Obszaru Gospodarczego (EOG), Wielkiej Brytanii i Szwajcarii. Dodaj logikę, która warunkowo wyklucza udostępnianie adresów IP użytkowników z tych regionów, i zadbaj o to, aby udostępniać użytkownikom jasne i wyczerpujące informacje na temat danych, które zbierasz w swoich witrynach, aplikacjach i innych usługach, a jeśli jest to wymagane przez prawo lub obowiązujące zasady Google, uzyskać ich zgodę. Więcej informacji znajdziesz na stronie Importowanie konwersji offline.

Kodowanie

Typ kodowania zahaszowanych informacji identyfikacyjnych.

Wartości w polu enum
ENCODING_UNSPECIFIED Nieokreślony typ kodowania. Nigdy nie należy go używać.
HEX Kodowanie szesnastkowe.
BASE64 kodowanie Base64,

EncryptionInfo

Informacje o szyfrowaniu przesyłanych danych.

Pola
Pole unii wrapped_key. Klucz opakowany użyty do zaszyfrowania danych. wrapped_key może mieć tylko jedną z tych wartości:
gcp_wrapped_key_info

GcpWrappedKeyInfo

Informacje o kluczu obudowanym w Google Cloud Platform.

Zdarzenie

Zdarzenie reprezentujące interakcję użytkownika z witryną lub aplikacją reklamodawcy.

Pola
destination_references[]

string

Opcjonalnie. Ciąg znaków referencyjny używany do określania miejsca docelowego. Jeśli to pole jest puste, zdarzenie zostanie wysłane do wszystkich destinations w żądaniu.
transaction_id

string

Wymagany. Unikalny identyfikator tego wydarzenia.
event_timestamp

Timestamp

Wymagany. Czas wystąpienia zdarzenia.
last_updated_timestamp

Timestamp

Opcjonalnie. Ostatnia aktualizacja wydarzenia.
user_data

UserData

Opcjonalnie. Fragmenty danych przekazywanych przez użytkowników, które reprezentują użytkownika powiązanego ze zdarzeniem.
consent

Consent

Opcjonalnie. Informacje o tym, czy powiązany użytkownik wyraził zgodę na różne rodzaje przetwarzania danych.
ad_identifiers

AdIdentifiers

Opcjonalnie. Identyfikatory i inne informacje używane do dopasowywania zdarzenia konwersji do innej aktywności online (np. kliknięć reklam).
currency

string

Opcjonalnie. Kod waluty powiązany ze wszystkimi wartościami pieniężnymi w tym zdarzeniu.
conversion_value

double

Opcjonalnie. Wartość konwersji powiązana ze zdarzeniem w przypadku konwersji opartych na wartości.
event_source

EventSource

Opcjonalnie. Sygnał wskazujący, gdzie wystąpiło zdarzenie (w internecie, w aplikacji, w sklepie stacjonarnym itp.).
event_device_info

DeviceInfo

Opcjonalnie. Informacje zebrane o używanym urządzeniu (jeśli takie było) w momencie wystąpienia zdarzenia.
cart_data

CartData

Opcjonalnie. Informacje o transakcji i produktach powiązanych ze zdarzeniem.
custom_variables[]

CustomVariable

Opcjonalnie. Dodatkowe informacje o parach klucz/wartość do wysłania do kontenerów konwersji (działanie powodujące konwersję lub aktywność FL).
experimental_fields[]

ExperimentalField

Opcjonalnie. Lista par klucz/wartość dla pól eksperymentalnych, które mogą zostać włączone do interfejsu API.
user_properties

UserProperties

Opcjonalnie. Informacje o użytkowniku ocenione przez reklamodawcę w momencie wystąpienia zdarzenia.

EventSource

Źródło zdarzenia.

Wartości w polu enum
EVENT_SOURCE_UNSPECIFIED Nieokreślone źródło zdarzeń. Nigdy nie należy go używać.
WEB Wydarzenie zostało wygenerowane w przeglądarce.
APP Wydarzenie zostało wygenerowane przez aplikację.
IN_STORE Wydarzenie zostało wygenerowane na podstawie transakcji w sklepie stacjonarnym.
PHONE Wydarzenie zostało wygenerowane na podstawie rozmowy telefonicznej.
OTHER Wydarzenie zostało wygenerowane z innych źródeł.

ExperimentalField

Eksperymentalne pole reprezentujące nieoficjalne pola.

Pola
field

string

Opcjonalnie. Nazwa pola do użycia.
value

string

Opcjonalnie. Wartość pola do ustawienia.

GcpWrappedKeyInfo

Informacje o kluczu opakowanym Google Cloud Platform.

Pola
key_type

KeyType

Wymagany. Typ algorytmu użytego do zaszyfrowania danych.
wip_provider

string

Wymagany. Dostawca puli Workload Identity wymagany do używania klucza KEK.
kek_uri

string

Wymagany. Identyfikator zasobu Cloud Key Management Service w Google Cloud Platform.
encrypted_dek

string

Wymagany. Zaszyfrowany klucz szyfrujący dane zakodowany w formacie base64.

KeyType

Typ algorytmu użytego do zaszyfrowania danych.

Wartości w polu enum
KEY_TYPE_UNSPECIFIED Nieokreślony typ klucza. Nigdy nie należy go używać.
XCHACHA20_POLY1305 Algorytm XChaCha20-Poly1305

IngestAudienceMembersRequest

Prośba o przesłanie członków grupy odbiorców do podanych miejsc docelowych. Zwraca wartość IngestAudienceMembersResponse.

Pola
destinations[]

Destination

Wymagany. Lista miejsc docelowych, do których mają być wysyłani członkowie grupy odbiorców.
audience_members[]

AudienceMember

Wymagany. Lista użytkowników, do których mają być wysyłane dane do określonych miejsc docelowych. W jednym żądaniu można wysłać maksymalnie 10 tys. AudienceMember.
consent

Consent

Opcjonalnie. Zgoda na poziomie żądania, która ma być stosowana do wszystkich użytkowników w żądaniu. Zgoda na poziomie użytkownika zastępuje zgodę na poziomie żądania i może być określona w każdym AudienceMember.
validate_only

bool

Opcjonalnie. Do celów testowych. Jeśli true, żądanie jest weryfikowane, ale nie wykonywane. Zwracane są tylko błędy, a nie wyniki.
encoding

Encoding

Opcjonalnie. Wymagane w przypadku przesyłania plików w UserData. Typ kodowania identyfikatorów użytkowników. W przypadku zaszyfrowanych identyfikatorów użytkowników jest to typ kodowania zaszyfrowanego ciągu znaków. W przypadku zaszyfrowanych identyfikatorów użytkowników z wartością hash jest to typ kodowania zewnętrznego zaszyfrowanego ciągu znaków, ale niekoniecznie wewnętrznego ciągu znaków z wartością hash. Oznacza to, że wewnętrzny ciąg znaków z wartością hash może być zakodowany w inny sposób niż zewnętrzny zaszyfrowany ciąg znaków. W przypadku przesyłania plików innych niż UserData to pole jest ignorowane.
encryption_info

EncryptionInfo

Opcjonalnie. Informacje o szyfrowaniu przesyłanych plików UserData. Jeśli nie jest ustawiona, zakłada się, że przesłane informacje umożliwiające identyfikację są zahaszowane, ale nie zaszyfrowane. W przypadku przesyłania plików innych niż UserData to pole jest ignorowane.
terms_of_service

TermsOfService

Opcjonalnie. Warunki korzystania z usługi, które użytkownik zaakceptował lub odrzucił.

IngestAudienceMembersResponse

Odpowiedź z IngestAudienceMembersRequest.

Pola
request_id

string

Automatycznie wygenerowany identyfikator żądania.

IngestEventsRequest

Prośba o przesłanie członków grupy odbiorców do podanych miejsc docelowych. Zwraca wartość IngestEventsResponse.

Pola
destinations[]

Destination

Wymagany. Lista miejsc docelowych, do których mają być wysyłane zdarzenia.
events[]

Event

Wymagany. Lista zdarzeń do wysłania do określonych miejsc docelowych. W jednym żądaniu można wysłać maksymalnie 2000 zasobów Event.
consent

Consent

Opcjonalnie. Zgoda na poziomie żądania, która ma być stosowana do wszystkich użytkowników w żądaniu. Zgoda na poziomie użytkownika zastępuje zgodę na poziomie żądania i może być określona w każdym Event.
validate_only

bool

Opcjonalnie. Do celów testowych. Jeśli true, żądanie jest weryfikowane, ale nie wykonywane. Zwracane są tylko błędy, a nie wyniki.
encoding

Encoding

Opcjonalnie. Wymagane w przypadku przesyłania plików w UserData. Typ kodowania identyfikatorów użytkowników. W przypadku zaszyfrowanych identyfikatorów użytkowników jest to typ kodowania zaszyfrowanego ciągu znaków. W przypadku zaszyfrowanych identyfikatorów użytkowników z wartością hash jest to typ kodowania zewnętrznego zaszyfrowanego ciągu znaków, ale niekoniecznie wewnętrznego ciągu znaków z wartością hash. Oznacza to, że wewnętrzny ciąg znaków z wartością hash może być zakodowany w inny sposób niż zewnętrzny zaszyfrowany ciąg znaków. W przypadku przesyłania plików innych niż UserData to pole jest ignorowane.
encryption_info

EncryptionInfo

Opcjonalnie. Informacje o szyfrowaniu przesyłanych plików UserData. Jeśli nie jest ustawiona, zakłada się, że przesłane informacje umożliwiające identyfikację są zahaszowane, ale nie zaszyfrowane. W przypadku przesyłania plików innych niż UserData to pole jest ignorowane.

IngestEventsResponse

Odpowiedź z IngestEventsRequest.

Pola
request_id

string

Automatycznie wygenerowany identyfikator żądania.

Element

Reprezentuje element w koszyku powiązany ze zdarzeniem.

Pola
merchant_product_id

string

Opcjonalnie. Identyfikator produktu na koncie Merchant Center.
quantity

int64

Opcjonalnie. Liczba tego produktu powiązanego ze zdarzeniem.
unit_price

double

Opcjonalnie. Cena jednostkowa bez podatku, dostawy i wszelkich rabatów na poziomie transakcji.

MobileData

Identyfikatory mobilne odbiorców. Wymagany jest co najmniej 1 identyfikator urządzenia mobilnego.

Pola
mobile_ids[]

string

Wymagany. Lista identyfikatorów urządzeń mobilnych (identyfikatorów wyświetlania reklam lub IDFA). W jednym elemencie AudienceMember można podać maksymalnie 10 elementów mobileIds.

PairData

Identyfikatory PAIR dla odbiorców. Wymagany jest co najmniej 1 identyfikator PAIR.

Pola
pair_ids[]

string

Wymagany. Dane umożliwiające identyfikację użytkownika dostarczone przez usługę data clean room, zaszyfrowane algorytmem SHA256 i szyfrem przemiennym EC przy użyciu klucza wydawcy na potrzeby listy użytkowników PAIR. W jednym elemencie AudienceMember można podać maksymalnie 10 elementów pairIds.

Produkt

Reprezentuje konkretną usługę Google. Służy do lokalizowania kont i miejsc docelowych.

Wartości w polu enum
PRODUCT_UNSPECIFIED Nieokreślony produkt. Nigdy nie należy go używać.
GOOGLE_ADS Google Ads,
DISPLAY_VIDEO_PARTNER partnera Display & Video 360.
DISPLAY_VIDEO_ADVERTISER reklamodawcą Display & Video 360;
DATA_PARTNER Dostawca danych.

ProductAccount

Reprezentuje konkretne konto.

Pola
product

Product

Wymagany. Usługa, do której należy konto. Na przykład: GOOGLE_ADS.
account_id

string

Wymagany. Identyfikator konta. Na przykład identyfikator konta Google Ads.

RemoveAudienceMembersRequest

Prośba o usunięcie użytkowników z grupy odbiorców w podanych miejscach docelowych. Zwraca wartość RemoveAudienceMembersResponse.

Pola
destinations[]

Destination

Wymagany. Lista miejsc docelowych, z których chcesz usunąć użytkowników.
audience_members[]

AudienceMember

Wymagany. Lista użytkowników do usunięcia.
validate_only

bool

Opcjonalnie. Do celów testowych. Jeśli true, żądanie jest weryfikowane, ale nie wykonywane. Zwracane są tylko błędy, a nie wyniki.
encoding

Encoding

Opcjonalnie. Wymagane w przypadku przesyłania plików w UserData. Typ kodowania identyfikatorów użytkowników. Dotyczy tylko zewnętrznego kodowania zaszyfrowanych identyfikatorów użytkowników. W przypadku przesyłania plików innych niż UserData to pole jest ignorowane.
encryption_info

EncryptionInfo

Opcjonalnie. Informacje o szyfrowaniu przesyłanych plików UserData. Jeśli nie jest ustawiona, zakłada się, że przesłane informacje umożliwiające identyfikację są zahaszowane, ale nie zaszyfrowane. W przypadku przesyłania plików innych niż UserData to pole jest ignorowane.

RemoveAudienceMembersResponse

Odpowiedź z RemoveAudienceMembersRequest.

Pola
request_id

string

Automatycznie wygenerowany identyfikator żądania.

TermsOfService

Warunki korzystania z usługi, które użytkownik zaakceptował lub odrzucił.

Pola
customer_match_terms_of_service_status

TermsOfServiceStatus

Opcjonalnie. Warunki korzystania z usługi kierowania na listę klientów: https://support.google.com/adspolicy/answer/6299717. Musisz zaakceptować te warunki w przypadku wszystkich przesyłanych list użytkowników kierowania na listę klientów.

TermsOfServiceStatus

Określa, czy rozmówca zaakceptował warunki usługi.

Wartości w polu enum
TERMS_OF_SERVICE_STATUS_UNSPECIFIED Nie określono.
ACCEPTED Stan wskazujący, że dzwoniący zaakceptował warunki usługi.
REJECTED Stan wskazujący, że dzwoniący odrzucił warunki usługi.

UserData

Dane identyfikujące użytkownika. Wymagany jest co najmniej 1 identyfikator.

Pola
user_identifiers[]

UserIdentifier

Wymagany. Identyfikatory użytkownika. Możesz podać wiele wystąpień tego samego typu danych (np. wiele adresów e-mail). Aby zwiększyć prawdopodobieństwo dopasowania, podaj jak najwięcej identyfikatorów. W jednym pliku AudienceMember lub Event można podać maksymalnie 10 wartości userIdentifiers.

UserIdentifier

Pojedynczy identyfikator użytkownika.

Pola
Pole unii identifier. Musisz podać dokładnie jedną wartość. identifier może mieć tylko jedną z tych wartości:
email_address

string

Zahaszowany adres e-mail za pomocą funkcji SHA-256 po normalizacji.
phone_number

string

Zahaszowany numer telefonu z użyciem funkcji SHA-256 po normalizacji (standard E164).
address

AddressInfo

Znane elementy adresu użytkownika. Zawiera grupę identyfikatorów, które są dopasowywane jednocześnie.

UserProperties

Informacje o użytkowniku ocenione przez reklamodawcę w momencie wystąpienia zdarzenia. Więcej informacji znajdziesz na stronie https://support.google.com/google-ads/answer/14007601.

Pola
customer_type

CustomerType

Opcjonalnie. Typ klienta powiązanego ze zdarzeniem.
customer_value_bucket

CustomerValueBucket

Opcjonalnie. Wartość klienta określona przez reklamodawcę.