Package google.ads.datamanager.v1

색인

• IngestionService(인터페이스)
• AdIdentifiers(메시지)
• AddressInfo(메시지)
• AudienceMember(메시지)
• CartData(메시지)
• Consent(메시지)
• ConsentStatus(열거형)
• CustomVariable(메시지)
• CustomerType(열거형)
• CustomerValueBucket(열거형)
• Destination(메시지)
• DeviceInfo(메시지)
• Encoding(열거형)
• EncryptionInfo(메시지)
• Event(메시지)
• EventSource(열거형)
• ExperimentalField(메시지)
• GcpWrappedKeyInfo(메시지)
• GcpWrappedKeyInfo.KeyType(열거형)
• IngestAudienceMembersRequest(메시지)
• IngestAudienceMembersResponse(메시지)
• IngestEventsRequest(메시지)
• IngestEventsResponse(메시지)
• Item(메시지)
• MobileData(메시지)
• PairData(메시지)
• Product(열거형)
• ProductAccount(메시지)
• RemoveAudienceMembersRequest(메시지)
• RemoveAudienceMembersResponse(메시지)
• TermsOfService(메시지)
• TermsOfServiceStatus(열거형)
• UserData(메시지)
• UserIdentifier(메시지)
• UserProperties(메시지)

IngestionService

지원되는 대상에 잠재고객 데이터를 전송하는 서비스입니다.

IngestAudienceMembers
rpc IngestAudienceMembers(IngestAudienceMembersRequest) returns (IngestAudienceMembersResponse) 제공된 Destination에 AudienceMember 리소스 목록을 업로드합니다. 승인 범위 다음 OAuth 범위가 필요합니다. https://www.googleapis.com/auth/datamanager

IngestEvents
rpc IngestEvents(IngestEventsRequest) returns (IngestEventsResponse) 제공된 Destination에서 Event 리소스 목록을 업로드합니다. 승인 범위 다음 OAuth 범위가 필요합니다. https://www.googleapis.com/auth/datamanager

RemoveAudienceMembers
rpc RemoveAudienceMembers(RemoveAudienceMembersRequest) returns (RemoveAudienceMembersResponse) 제공된 Destination에서 AudienceMember 리소스 목록을 삭제합니다. 승인 범위 다음 OAuth 범위가 필요합니다. https://www.googleapis.com/auth/datamanager

AdIdentifiers

전환 이벤트를 광고 클릭과 같은 다른 온라인 활동과 일치시키는 데 사용되는 식별자 및 기타 정보입니다.

필드
session_attributes	string 선택사항입니다. 이벤트 기여 분석 및 모델링을 위한 세션 속성입니다.
gclid	string 선택사항입니다. 이 이벤트와 연결된 Google 클릭 ID (gclid)입니다.
gbraid	string 선택사항입니다. iOS14부터 iOS 기기에서 발생하고 앱 이벤트와 연결된 클릭의 클릭 식별자입니다.
wbraid	string 선택사항입니다. iOS14부터 웹 이벤트와 연결되고 iOS 기기에서 발생한 클릭의 클릭 식별자입니다.
landing_page_device_info	DeviceInfo 선택사항입니다. 광고와 상호작용한 후 광고주의 사이트에 방문할 때 사용 중인 기기에 관해 수집된 정보입니다 (있는 경우).

AddressInfo

사용자의 주소 정보입니다.

필드
given_name	string 필수입니다. 사용자의 이름 (성 제외)입니다. 모두 소문자이며, 구두점이나 앞뒤 공백이 없고 SHA-256으로 해싱됩니다.
family_name	string 필수입니다. 사용자의 성입니다. 모두 소문자이며, 구두점과 앞뒤 공백이 없고 SHA-256으로 해싱됩니다.
region_code	string 필수입니다. 사용자 주소의 ISO-3166-1 alpha-2 형식의 2자리 지역 코드입니다.
postal_code	string 필수입니다. 사용자 주소의 우편번호입니다.

AudienceMember

작업할 잠재고객 구성원입니다.

필드
consent	Consent 선택사항입니다. 사용자의 동의 설정입니다.
통합 필드 data. 작업할 식별 데이터의 유형입니다. data은 다음 중 하나여야 합니다.
user_data	UserData 사용자를 식별하는 사용자 제공 데이터입니다.
pair_data	PairData 게시자와 광고주의 식별 정보 매칭 솔루션 (PAIR) ID
mobile_data	MobileData 사용자의 휴대기기를 식별하는 데이터입니다.

CartData

이벤트와 연결된 장바구니 데이터입니다.

필드
merchant_id	string 선택사항입니다. 상품과 연결된 판매자 센터 ID입니다.
merchant_feed_label	string 선택사항입니다. 상품 피드와 연결된 판매자 센터 피드 라벨입니다.
merchant_feed_language_code	string 선택사항입니다. 상품이 업로드된 판매자 센터 피드와 연결된 ISO 639-1의 언어 코드입니다.
transaction_discount	double 선택사항입니다. 거래와 관련된 모든 할인 금액의 합계입니다.
items[]	Item 선택사항입니다. 이벤트와 연결된 항목 목록입니다.

동의

사용자의 디지털 시장법 (DMA) 동의 설정입니다.

필드
ad_user_data	ConsentStatus 선택사항입니다. 사용자가 광고 사용자 데이터에 동의하는지 여부를 나타냅니다.
ad_personalization	ConsentStatus 선택사항입니다. 사용자가 광고 개인 최적화에 동의하는지 여부를 나타냅니다.

ConsentStatus

사용자가 동의를 부여했는지, 거부했는지, 지정하지 않았는지를 나타냅니다.

열거형
CONSENT_STATUS_UNSPECIFIED	지정되지 않음
CONSENT_GRANTED	허용됨
CONSENT_DENIED	거부되었습니다.

CustomVariable

광고 전환의 맞춤 변수입니다.

필드
variable	string 선택사항입니다. 설정할 맞춤 변수의 이름입니다. 지정된 대상에 변수가 없으면 무시됩니다.
value	string 선택사항입니다. 맞춤 변수에 저장할 값입니다.
destination_references[]	string 선택사항입니다. 맞춤 변수를 전송할 Event.destination_references를 결정하는 데 사용되는 참조 문자열입니다. 비어 있으면 Event.destination_references가 사용됩니다.

CustomerType

이벤트와 연결된 고객 유형입니다.

열거형
CUSTOMER_TYPE_UNSPECIFIED	지정되지 않은 CustomerType입니다. 절대로 사용하지 마세요.
NEW	고객이 광고주를 처음 이용합니다.
RETURNING	고객이 광고주에게 반품합니다.
REENGAGED	고객이 광고주와 다시 상호작용했습니다.

CustomerValueBucket

광고주가 평가한 고객의 가치입니다.

열거형
CUSTOMER_VALUE_BUCKET_UNSPECIFIED	지정되지 않은 CustomerValueBucket입니다. 절대로 사용하지 마세요.
LOW	고객의 가치가 낮습니다.
MEDIUM	고객이 중간 가치입니다.
HIGH	고객의 가치가 높습니다.

대상

데이터를 전송하는 Google 제품입니다. 예를 들어 Google Ads 계정입니다.

필드
reference	string 선택사항입니다. 이 Destination 리소스의 ID로, 요청 내에서 고유합니다. IngestEventsRequest에서 이 Destination을 참조하는 데 사용됩니다.
login_account	ProductAccount 선택사항입니다. 이 API 호출을 만드는 데 사용된 계정입니다. operating_account에서 데이터를 추가하거나 삭제하려면 이 login_account에 operating_account에 대한 쓰기 액세스 권한이 있어야 합니다. 예를 들어 operating_account의 관리자 계정 또는 operating_account에 연결된 계정입니다.
linked_account	ProductAccount 선택사항입니다. 호출 사용자의 login_account가 설정된 계정 연결을 통해 액세스할 수 있는 계정입니다. 예를 들어 데이터 파트너의 login_account가 클라이언트의 linked_account에 액세스할 수 있습니다. 파트너는 이 필드를 사용하여 linked_account에서 다른 operating_account로 데이터를 전송할 수 있습니다.
operating_account	ProductAccount 필수입니다. 데이터를 전송하거나 데이터를 삭제할 계정입니다.
product_destination_id	string 필수입니다. 제품 계정 내에서 수집할 객체입니다. 예를 들어 Google Ads 잠재고객 ID 또는 Display & Video 360 잠재고객 ID입니다.

DeviceInfo

이벤트가 발생했을 때 사용 중인 기기에 관한 정보입니다 (있는 경우).

필드
user_agent	string 선택사항입니다. 지정된 컨텍스트의 기기 사용자 에이전트 문자열입니다.
ip_address	string 선택사항입니다. 지정된 컨텍스트의 기기 IP 주소입니다.

인코딩

해시된 식별 정보의 인코딩 유형입니다.

열거형
ENCODING_UNSPECIFIED	지정되지 않은 인코딩 유형입니다. 절대로 사용하지 마세요.
HEX	16진수 인코딩입니다.
BASE64	Base 64 인코딩입니다.

EncryptionInfo

수집되는 데이터의 암호화 정보입니다.

필드
통합 필드 wrapped_key. 데이터를 암호화하는 데 사용되는 래핑된 키입니다. wrapped_key은 다음 중 하나일 수 있습니다.
gcp_wrapped_key_info	GcpWrappedKeyInfo Google Cloud Platform 래핑된 키 정보입니다.

이벤트

사용자와 광고주의 웹사이트 또는 앱 간의 상호작용을 나타내는 이벤트입니다.

필드
destination_references[]	string 선택사항입니다. 대상을 결정하는 데 사용되는 참조 문자열입니다. 비어 있으면 이벤트가 요청의 모든 destinations에 전송됩니다.
transaction_id	string 필수입니다. 이 이벤트의 고유 식별자입니다.
event_timestamp	Timestamp 필수입니다. 이벤트가 발생한 시간입니다.
last_updated_timestamp	Timestamp 선택사항입니다. 이벤트가 마지막으로 업데이트된 시간입니다.
user_data	UserData 선택사항입니다. 이벤트와 연결된 사용자를 나타내는 사용자 제공 데이터입니다.
consent	Consent 선택사항입니다. 연결된 사용자가 다양한 유형의 동의를 제공했는지 여부에 관한 정보입니다.
ad_identifiers	AdIdentifiers 선택사항입니다. 전환 이벤트를 광고 클릭과 같은 다른 온라인 활동과 일치시키는 데 사용되는 식별자 및 기타 정보입니다.
currency	string 선택사항입니다. 이 이벤트 내의 모든 금전적 가치와 연결된 통화 코드입니다.
conversion_value	double 선택사항입니다. 가치 기반 전환의 경우 이벤트와 연결된 전환 가치입니다.
event_source	EventSource 선택사항입니다. 이벤트가 발생한 위치 (웹, 앱, 매장 등)를 나타내는 신호입니다.
event_device_info	DeviceInfo 선택사항입니다. 이벤트가 발생했을 때 사용 중인 기기에 관해 수집된 정보입니다 (있는 경우).
cart_data	CartData 선택사항입니다. 거래 및 이벤트와 연결된 상품에 대한 정보입니다.
custom_variables[]	CustomVariable 선택사항입니다. 전환 컨테이너 (전환 액션 또는 FL 활동)로 전송할 추가 키/값 쌍 정보입니다.
experimental_fields[]	ExperimentalField 선택사항입니다. 실험용 필드의 키-값 쌍 목록입니다. 실험용 필드는 결국 API의 일부로 승격될 수 있습니다.
user_properties	UserProperties 선택사항입니다. 이벤트가 발생한 시점에 광고주가 평가한 사용자에 관한 정보입니다.

EventSource

이벤트의 소스입니다.

열거형
EVENT_SOURCE_UNSPECIFIED	지정되지 않은 EventSource입니다. 절대로 사용하지 마세요.
WEB	이 이벤트는 웹브라우저에서 생성되었습니다.
APP	앱에서 생성된 이벤트입니다.
IN_STORE	이 이벤트는 오프라인 거래에서 생성되었습니다.
PHONE	이 이벤트는 전화 통화에서 생성되었습니다.
OTHER	이 이벤트는 다른 소스에서 생성되었습니다.

ExperimentalField

비공식 필드를 나타내는 실험용 필드입니다.

필드
field	string 선택사항입니다. 사용할 필드의 이름입니다.
value	string 선택사항입니다. 설정할 필드의 값입니다.

GcpWrappedKeyInfo

Google Cloud Platform 래핑된 키에 관한 정보입니다.

필드
key_type	KeyType 필수입니다. 데이터를 암호화하는 데 사용된 알고리즘의 유형입니다.
wip_provider	string 필수입니다. KEK를 사용하는 데 필요한 워크로드 아이덴티티 풀 제공업체입니다.
kek_uri	string 필수입니다. Google Cloud Platform Cloud Key Management Service 리소스 ID.
encrypted_dek	string 필수입니다. base64로 인코딩된 암호화된 데이터 암호화 키입니다.

KeyType

데이터를 암호화하는 데 사용된 알고리즘의 유형입니다.

열거형
KEY_TYPE_UNSPECIFIED	지정되지 않은 키 유형입니다. 절대로 사용하지 마세요.
XCHACHA20_POLY1305	알고리즘 XChaCha20-Poly1305

IngestAudienceMembersRequest

제공된 대상에 잠재고객 구성원을 업로드하도록 요청합니다. IngestAudienceMembersResponse을 반환합니다.

필드
destinations[]	Destination 필수입니다. 잠재고객 구성원을 보낼 도착 페이지 목록입니다.
audience_members[]	AudienceMember 필수입니다. 지정된 도착 페이지로 보낼 사용자 목록입니다. 단일 요청에서 최대 10,000개의 AudienceMember 리소스를 전송할 수 있습니다.
consent	Consent 선택사항입니다. 요청의 모든 사용자에게 적용되는 요청 수준 동의입니다. 사용자 수준 동의는 요청 수준 동의보다 우선하며 각 AudienceMember에서 지정할 수 있습니다.
validate_only	bool 선택사항입니다. 테스트 목적으로 사용됩니다. true인 경우 요청이 검증되지만 실행되지는 않습니다. 결과가 아닌 오류만 반환됩니다.
encoding	Encoding 선택사항입니다. UserData 업로드에 필요합니다. 사용자 식별자의 인코딩 유형입니다. 해싱된 사용자 식별자의 경우 해싱된 문자열의 인코딩 유형입니다. 암호화된 해시 사용자 식별자의 경우 이는 외부 암호화된 문자열의 인코딩 유형이지만 내부 해시 문자열은 아닐 수 있습니다. 즉, 내부 해시 문자열은 외부 암호화된 문자열과 다른 방식으로 인코딩될 수 있습니다. UserData이 아닌 업로드의 경우 이 필드는 무시됩니다.
encryption_info	EncryptionInfo 선택사항입니다. UserData 업로드의 암호화 정보입니다. 설정되지 않은 경우 업로드된 식별 정보가 해싱되었지만 암호화되지 않은 것으로 간주됩니다. UserData이 아닌 업로드의 경우 이 필드는 무시됩니다.
terms_of_service	TermsOfService 선택사항입니다. 사용자가 수락/거부한 서비스 약관입니다.

IngestAudienceMembersResponse

IngestAudienceMembersRequest의 응답입니다.

필드
request_id	string 요청의 자동 생성 ID입니다.

IngestEventsRequest

제공된 대상에 잠재고객 구성원을 업로드하도록 요청합니다. IngestEventsResponse을 반환합니다.

필드
destinations[]	Destination 필수입니다. 이벤트를 보낼 대상 목록입니다.
events[]	Event 필수입니다. 지정된 대상에 전송할 이벤트 목록입니다. 단일 요청에서 최대 2,000개의 Event 리소스를 전송할 수 있습니다.
consent	Consent 선택사항입니다. 요청의 모든 사용자에게 적용되는 요청 수준 동의입니다. 사용자 수준 동의는 요청 수준 동의보다 우선하며 각 Event에서 지정할 수 있습니다.
validate_only	bool 선택사항입니다. 테스트 목적으로 사용됩니다. true인 경우 요청이 검증되지만 실행되지는 않습니다. 결과가 아닌 오류만 반환됩니다.
encoding	Encoding 선택사항입니다. UserData 업로드에 필요합니다. 사용자 식별자의 인코딩 유형입니다. 해싱된 사용자 식별자의 경우 해싱된 문자열의 인코딩 유형입니다. 암호화된 해시 사용자 식별자의 경우 이는 외부 암호화된 문자열의 인코딩 유형이지만 내부 해시 문자열은 아닐 수 있습니다. 즉, 내부 해시 문자열은 외부 암호화된 문자열과 다른 방식으로 인코딩될 수 있습니다. UserData이 아닌 업로드의 경우 이 필드는 무시됩니다.
encryption_info	EncryptionInfo 선택사항입니다. UserData 업로드의 암호화 정보입니다. 설정되지 않은 경우 업로드된 식별 정보가 해싱되었지만 암호화되지 않은 것으로 간주됩니다. UserData이 아닌 업로드의 경우 이 필드는 무시됩니다.

IngestEventsResponse

IngestEventsRequest의 응답입니다.

필드
request_id	string 요청의 자동 생성 ID입니다.

항목

이벤트와 연결된 장바구니의 상품을 나타냅니다.

필드
merchant_product_id	string 선택사항입니다. 판매자 센터 계정 내 제품 ID입니다.
quantity	int64 선택사항입니다. 이 이벤트와 연결된 상품의 수입니다.
unit_price	double 선택사항입니다. 세금, 배송비, 거래별 할인 금액을 제외한 단위 가격입니다.

MobileData

잠재고객의 모바일 ID입니다. 모바일 ID가 하나 이상 필요합니다.

필드
mobile_ids[]	string 필수입니다. 휴대기기 ID (광고 ID/IDFA) 목록입니다. 단일 AudienceMember에서 최대 10개의 mobileIds을 제공할 수 있습니다.

PairData

잠재고객의 PAIR ID입니다. 하나 이상의 페어링 ID가 필요합니다.

필드
pair_ids[]	string 필수입니다. 클린룸에서 제공한 PII 데이터로, SHA256으로 해싱되고 PAIR 사용자 목록에 게시자 키를 사용하여 EC 교환 암호로 암호화됩니다. 단일 AudienceMember에서 최대 10개의 pairIds을 제공할 수 있습니다.

제품

특정 Google 제품을 나타냅니다. 계정 및 대상을 찾는 데 사용됩니다.

열거형
PRODUCT_UNSPECIFIED	지정되지 않은 제품입니다. 절대로 사용하지 마세요.
GOOGLE_ADS	Google Ads
DISPLAY_VIDEO_PARTNER	Display & Video 360 파트너입니다.
DISPLAY_VIDEO_ADVERTISER	Display & Video 360 광고주
DATA_PARTNER	데이터 파트너

ProductAccount

특정 계정을 나타냅니다.

필드
product	Product 필수입니다. 계정이 속한 제품입니다. 예를 들면 GOOGLE_ADS입니다.
account_id	string 필수입니다. 계정의 ID입니다. 예를 들어 Google Ads 계정 ID입니다.

RemoveAudienceMembersRequest

제공된 대상에서 사용자를 타겟층에서 삭제하도록 요청합니다. RemoveAudienceMembersResponse를 반환합니다.

필드
destinations[]	Destination 필수입니다. 사용자를 삭제할 도착 페이지 목록입니다.
audience_members[]	AudienceMember 필수입니다. 삭제할 사용자의 목록입니다.
validate_only	bool 선택사항입니다. 테스트 목적으로 사용됩니다. true인 경우 요청이 검증되지만 실행되지는 않습니다. 결과가 아닌 오류만 반환됩니다.
encoding	Encoding 선택사항입니다. UserData 업로드에 필요합니다. 사용자 식별자의 인코딩 유형입니다. 암호화된 사용자 식별자의 외부 인코딩에만 적용됩니다. UserData이 아닌 업로드의 경우 이 필드는 무시됩니다.
encryption_info	EncryptionInfo 선택사항입니다. UserData 업로드의 암호화 정보입니다. 설정되지 않은 경우 업로드된 식별 정보가 해싱되었지만 암호화되지 않은 것으로 간주됩니다. UserData이 아닌 업로드의 경우 이 필드는 무시됩니다.

RemoveAudienceMembersResponse

RemoveAudienceMembersRequest의 응답입니다.

필드
request_id	string 요청의 자동 생성 ID입니다.

TermsOfService

사용자가 수락/거부한 서비스 약관입니다.

필드
customer_match_terms_of_service_status	TermsOfServiceStatus 선택사항입니다. 고객 일치 타겟팅 서비스 약관: https://support.google.com/adspolicy/answer/6299717 고객 일치 타겟팅 사용자 목록에 업로드하려면 이 약관에 동의해야 합니다.

TermsOfServiceStatus

서비스 약관을 수락하거나 거부하는 호출자의 결정을 나타냅니다.

열거형
TERMS_OF_SERVICE_STATUS_UNSPECIFIED	지정되지 않음
ACCEPTED	호출자가 서비스 약관에 동의하기로 선택했음을 나타내는 상태입니다.
REJECTED	호출자가 서비스 약관을 거부하기로 선택했음을 나타내는 상태입니다.

UserData

사용자를 식별하는 데이터입니다. 식별자가 하나 이상 필요합니다.

필드
user_identifiers[]	UserIdentifier 필수입니다. 사용자의 식별자입니다. 동일한 유형의 데이터 (예: 여러 이메일 주소)를 여러 개 제공할 수 있습니다. 일치 가능성을 높이려면 식별자를 최대한 많이 제공하세요. AudienceMember 또는 Event 하나에 최대 10개의 userIdentifiers을 제공할 수 있습니다.

UserIdentifier

사용자의 단일 식별자입니다.

필드
통합 필드 identifier. 정확히 하나를 지정해야 합니다. identifier은 다음 중 하나여야 합니다.
email_address	string 정규화 후 SHA-256 해시 함수를 사용하여 해싱된 이메일 주소입니다.
phone_number	string 정규화 (E164 표준) 후 SHA-256 해시 함수를 사용하여 해싱된 전화번호입니다.
address	AddressInfo 사용자 주소의 알려진 구성요소입니다. 한 번에 모두 일치하는 식별자의 그룹화를 보유합니다.

UserProperties

이벤트가 발생한 시점에 광고주가 평가한 사용자에 관한 정보입니다. 자세한 내용은 https://support.google.com/google-ads/answer/14007601을 참고하세요.

필드
customer_type	CustomerType 선택사항입니다. 이벤트와 연결된 고객 유형입니다.
customer_value_bucket	CustomerValueBucket 선택사항입니다. 광고주가 평가한 고객의 가치입니다.