Package google.shopping.merchant.promotions.v1beta

Indeks

PromotionsService

Usługa do zarządzania promocjami produktów.

GetPromotion

rpc GetPromotion(GetPromotionRequest) returns (Promotion)

Pobiera promocję z konta Merchant Center.

Po wstawieniu lub zaktualizowaniu danych promocji może minąć kilka minut, zanim zaktualizowana promocja będzie dostępna do pobrania.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w OAuth 2.0 Overview.
InsertPromotion

rpc InsertPromotion(InsertPromotionRequest) returns (Promotion)

Wstawia promocję na konto Merchant Center. Jeśli promocja już istnieje, zostanie ona zaktualizowana.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w OAuth 2.0 Overview.
ListPromotions

rpc ListPromotions(ListPromotionsRequest) returns (ListPromotionsResponse)

Wyświetla promocje na koncie Merchant Center. Odpowiedź może zawierać mniej elementów niż określono w parametry pageSize. Aby sprawdzić, czy są jeszcze inne elementy, których dotyczy prośba, użyj funkcji pageToken.

Po wstawieniu lub zaktualizowaniu promocji może minąć kilka minut, zanim będzie można ją pobrać.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w OAuth 2.0 Overview.

Atrybuty

Atrybuty.

Pola
product_applicability

ProductApplicability

Wymagany. Określa, czy promocja dotyczy wszystkich produktów, czy tylko określonych produktów.
offer_type

OfferType

Wymagany. Typ promocji. Ten atrybut wskazuje, czy klienci muszą wykorzystać kod kuponu, aby skorzystać z promocji.
generic_redemption_code

string

Opcjonalnie: Ogólny kod promocyjny dla promocji. Aby można było używać pola offerType, musi ono spełniać minimalne wymagania.
long_title

string

Wymagany. Długi tytuł promocji.
coupon_value_type

CouponValueType

Wymagany. Atrybut typ wartości kuponu, który wskazuje typ promocji, którą prowadzisz. W zależności od typu wybranej wartości kuponu niektóre atrybuty są wymagane.
promotion_destinations[]

DestinationEnum

Wymagany. Lista miejsc docelowych, w których obowiązuje promocja. Jeśli nie określisz miejsca docelowego, dodając do źródła danych obsługiwaną wartość, Twoja promocja wyświetli się domyślnie w reklamach produktowych i bezpłatnych informacjach.

Możliwe, że wcześniej zdarzyło Ci się przesyłać te wartości jako miejsca docelowe dla Twoich produktów: Shopping Actions, Surfaces across Google, Local surfaces across Google. Aby reprezentować te wartości, użyj właściwości FREE_LISTINGS, FREE_LOCAL_LISTINGS i LOCAL_INVENTORY_ADS. Więcej informacji znajdziesz w artykule Miejsce docelowe promocji.
item_id_inclusion[]

string

Opcjonalnie: Filtrowanie produktów według identyfikatora produktu w promocji. Atrybuty umożliwiające filtrowanie produktów mają zastosowanie tylko wtedy, gdy atrybut produkty objęte promocją product_applicability ma wartość specific_products.
brand_inclusion[]

string

Opcjonalnie: Filtrowanie produktów według marki w promocji. Atrybuty umożliwiające filtrowanie produktów mają zastosowanie tylko wtedy, gdy atrybut produkty objęte promocją product_applicability ma wartość specific_products.
item_group_id_inclusion[]

string

Opcjonalnie: Filtrowanie produktów według identyfikatora grupy produktów dla promocji. Atrybuty umożliwiające filtrowanie produktów mają zastosowanie tylko wtedy, gdy atrybut produkty objęte promocją [product_applicability] ma wartość specific_products.
product_type_inclusion[]

string

Opcjonalnie: Filtrowanie produktów według typu produktu w promocji. Atrybuty umożliwiające filtrowanie produktów mają zastosowanie tylko wtedy, gdy atrybut produkty objęte promocją product_applicability ma wartość specific_products.
item_id_exclusion[]

string

Opcjonalnie: Filtrowanie produktów według wykluczenia identyfikatora produktu w promocji. Atrybuty umożliwiające filtrowanie produktów mają zastosowanie tylko wtedy, gdy atrybut produkty objęte promocją product_applicability ma wartość specific_products.
brand_exclusion[]

string

Opcjonalnie: Filtrowanie produktów według wykluczenia marki w promocji. Atrybuty umożliwiające filtrowanie produktów mają zastosowanie tylko wtedy, gdy atrybut produkty objęte promocją product_applicability ma wartość specific_products.
item_group_id_exclusion[]

string

Opcjonalnie: Filtrowanie produktów według identyfikatora grupy produktów. Atrybuty umożliwiające filtrowanie produktów mają zastosowanie tylko wtedy, gdy atrybut produkty objęte promocją product_applicability ma wartość specific_products.
product_type_exclusion[]

string

Opcjonalnie: Filtr produktów według wykluczenia typu produktu w promocji. Atrybuty umożliwiające filtrowanie produktów mają zastosowanie tylko wtedy, gdy atrybut produkty objęte promocją product_applicability ma wartość specific_products.
minimum_purchase_amount

Price

Opcjonalnie: Minimalna kwota do zapłaty w ramach promocji.
minimum_purchase_quantity

int64

Opcjonalnie: Minimalna wielkość zakupu w ramach promocji.
limit_quantity

int64

Opcjonalnie: Maksymalna wielkość zakupu w promocji.
limit_value

Price

Opcjonalnie: Maksymalna cena produktu w promocji.
percent_off

int64

Opcjonalnie: Rabat procentowy oferowany w ramach promocji.
money_off_amount

Price

Opcjonalnie: Kwota rabatu oferowana w ramach promocji.
get_this_quantity_discounted

int64

Opcjonalnie: Liczba produktów objętych rabatem w promocji. Atrybut jest ustawiany, gdy wartość couponValueType jest równa buy_m_get_n_money_off lub buy_m_get_n_percent_off.
free_gift_value

Price

Opcjonalnie: Wartość prezentu w ramach promocji.
free_gift_description

string

Opcjonalnie: Opis prezentu w ramach promocji.
free_gift_item_id

string

Opcjonalnie: Identyfikator produktu prezentu w ramach promocji.
promotion_effective_time_period

Interval

Wymagany. TimePeriod reprezentacja dat obowiązywania promocji. Ten atrybut określa, że w tym okresie promocja może być testowana w Twoim sklepie internetowym.
promotion_display_time_period

Interval

Opcjonalnie: TimePeriod wyświetlanie dat promocji. Ten atrybut określa datę i okres, kiedy promocja będzie widoczna na Google.com i w reklamach produktowych. Jeśli atrybut okres wyświetlania promocji promotion_display_time_period nie został określony, okres obowiązywania promocji promotion_effective_time_period określa datę i okres, kiedy promocja będzie widoczna na Google.com i w reklamach produktowych.
store_applicability

StoreApplicability

Opcjonalnie: Określ, czy promocja ma dotyczyć wszystkich sklepów czy tylko wybranych. Promocje reklam lokalnego asortymentu produktów powodują błąd, jeśli nie uwzględniono w nich możliwości zastosowania w sklepie. Jeśli opcja store_applicability ma wartość ALL_STORES, a opcja store_codes_inclusion lub score_code_exclusion ma wartość, zgłaszany jest błąd INVALID_ARGUMENT.
store_codes_inclusion[]

string

Opcjonalnie: Kody sklepów do uwzględnienia w promocji. Atrybuty umożliwiające filtrowanie sklepów mają zastosowanie tylko wtedy, gdy atrybut store_applicability ma wartość specific_stores.

Kod sklepu (identyfikator sklepu z profilu firmy) sklepu fizycznego, w którym sprzedawany jest produkt. Więcej informacji znajdziesz w specyfikacji danych o asortymencie produktów dostępnych lokalnie.
store_codes_exclusion[]

string

Opcjonalnie: Kody sklepów do wykluczenia w promocji. Atrybuty umożliwiające filtrowanie sklepów mają zastosowanie tylko wtedy, gdy atrybut store_applicability ma wartość specific_stores.
promotion_url

string

Opcjonalnie: Adres URL strony w witrynie sprzedawcy, na której wyświetla się promocja. Promocje reklam lokalnego asortymentu produktów powodują błąd, jeśli nie ma elementu promotion_url. Adres URL służy do potwierdzenia, że promocja jest prawidłowa i można z niej skorzystać.

CouponValueType

Typ wartości kuponu promocji.

Wartości w polu enum
COUPON_VALUE_TYPE_UNSPECIFIED Wskazuje, że typ wartości kuponu jest nieokreślony.
MONEY_OFF Typ wartości kuponu na kwotę rabatu.
PERCENT_OFF Typ wartości kuponu rabatu procentowego.
BUY_M_GET_N_MONEY_OFF Kup większą ilość i zyskaj zniżkę o wartość N. Pole minimum_purchase_quantity i get_this_quantity_discounted musi być obecne. Musisz też podać money_off_amount.
BUY_M_GET_N_PERCENT_OFF Kup większą ilość i zyskaj zniżkę procentową N na podstawie typu wartości kuponu. Pole minimum_purchase_quantity i get_this_quantity_discounted musi być obecne. Musisz też podać percent_off_percentage.
BUY_M_GET_MONEY_OFF Kup większą ilość i oszczędź pieniądze. Pole „minimum_purchase_quantity” i „money_off_amount” są wymagane.
BUY_M_GET_PERCENT_OFF Kup większą ilość i oszczędź pieniądze. Pole „minimum_purchase_quantity” i „percent_off_percentage” są wymagane.
FREE_GIFT Prezent (tylko opis).
FREE_GIFT_WITH_VALUE Prezent o wartości pieniężnej.
FREE_GIFT_WITH_ITEM_ID Prezent z identyfikatorem produktu.
FREE_SHIPPING_STANDARD Typ wartości kuponu standardowej bezpłatnej dostawy. Dostępne tylko w przypadku promocji online.
FREE_SHIPPING_OVERNIGHT Typ wartości kuponu na bezpłatną dostawę przez noc. Dostępne tylko w przypadku promocji online.
FREE_SHIPPING_TWO_DAY Typ wartości kuponu na bezpłatną dostawę w ciągu 2 dni. Dostępne tylko w przypadku promocji online.

GetPromotionRequest

Żądanie wiadomości dla metody GetPromotion.

Pola
name

string

Wymagany. Nazwa promocji do pobrania. Format: accounts/{account}/promotions/{promotions}

InsertPromotionRequest

Żądanie wiadomości dla metody InsertPromotion.

Pola
parent

string

Wymagany. Konto, na którym zostanie wstawiona promocja. Format: accounts/{account}
promotion

Promotion

Wymagany. Promocja do wstawienia.
data_source

string

Wymagany. Źródło danych o promocji. Format: accounts/{account}/dataSources/{datasource}.

ListPromotionsRequest

Żądanie wiadomości dla metody ListPromotions.

Pola
parent

string

Wymagany. Konto, na którym mają być wyświetlane przetworzone promocje. Format: accounts/{account}
page_size

int32

Tylko dane wyjściowe. Maksymalna liczba promocji do zwrócenia. Usługa może zwrócić mniej niż ta wartość. Maksymalna wartość to 250; wartości powyżej 250 zostaną skonwertowane na 250. Jeśli nie podasz tej wartości, zwrócona zostanie maksymalna liczba promocji.
page_token

string

Tylko dane wyjściowe. Token strony otrzymany z poprzedniego wywołania funkcji ListPromotions. Podaj ten parametr, aby pobrać kolejną stronę.

Podczas podziału na strony wszystkie inne parametry przekazane do funkcji ListPromotions muszą być zgodne z wywołaniem, które dostarczyło token strony.

ListPromotionsResponse

wiadomość z odpowiedzią dla metody ListPromotions,

Pola
promotions[]

Promotion

Przetworzone promocje z określonego konta.
next_page_token

string

token, który może być wysyłany jako page_token w celu pobrania następnej strony. Jeśli pominiesz to pole, nie będzie kolejnych stron.

OfferType

Typ oferty w ramach promocji.

Wartości w polu enum
OFFER_TYPE_UNSPECIFIED Nieznany typ oferty.
NO_CODE Typ oferty bez kodu.
GENERIC_CODE Typ oferty z kodem. Ogólny kod promocyjny dla promocji jest wymagany, gdy offerType = GENERIC_CODE.

ProductApplicability

Produkt lub lista produktów, których dotyczy promocja.

Wartości w polu enum
PRODUCT_APPLICABILITY_UNSPECIFIED Nie wiadomo, do których produktów ma zastosowanie promocja.
ALL_PRODUCTS Dotyczy wszystkich produktów.
SPECIFIC_PRODUCTS Dotyczy tylko jednego produktu lub listy produktów.

Promocja

Oznacza promocję. Więcej informacji znajdziesz w tych artykułach:

Wymagane atrybuty danych promocji, które muszą przejść weryfikację danych, są zdefiniowane poniżej:

Po wstawieniu i zaktualizowaniu danych promocji może minąć kilka minut, zanim będzie można pobrać ostateczną promocję.

Pola
name

string

Identyfikator. Nazwa promocji. Format: accounts/{account}/promotions/{promotion}
promotion_id

string

Wymagany. Użytkownik podał identyfikator promocji, aby jednoznacznie ją zidentyfikować. Aby zapobiec odrzuceniu promocji, pamiętaj o wymaganiach minimalnych.
content_language

string

Wymagany. Dwuliterowy kod języka ISO 639-1 promocji.

Promocje są dostępne tylko w wybranych językach.
target_country

string

Wymagany. Kraj docelowy używany jako część unikalnego identyfikatora. Wyrażony jako kod regionu CLDR.

Promocje są dostępne tylko w wybranych krajach: Bezpłatne informacje i reklamy produktowe Reklamy lokalnego asortymentu produktów
redemption_channel[]

RedemptionChannel

Wymagany. Kanał wykorzystania promocji. Wymagany jest co najmniej 1 kanał.
data_source

string

Tylko dane wyjściowe. Podstawowe źródło danych promocji.
attributes

Attributes

Opcjonalnie: Lista atrybutów promocji.
custom_attributes[]

CustomAttribute

Opcjonalnie: Lista atrybutów niestandardowych (podanych przez sprzedawcę). Można go też używać do przesyłania dowolnego atrybutu specyfikacji danych w formie ogólnej (np. { "name": "size type", "value": "regular" }). Jest to przydatne w przypadku atrybutów, których interfejs API nie udostępnia w prosty sposób.
promotion_status

PromotionStatus

Tylko dane wyjściowe. stan promocji, problemy z weryfikacją danych, czyli informacje o promocji obliczonej asynchronicznie.
version_number

int64

Opcjonalnie: Reprezentuje bieżącą wersję (aktualność) promocji, która może służyć do zachowania prawidłowej kolejności, gdy wprowadzane są jednocześnie liczne aktualizacje.

Jeśli jest ustawiona, zapobiega wstawianiu, gdy numer wersji jest niższy niż bieżący numer wersji istniejącej promocji. Ponowna wstawka (np. odświeżenie promocji po 30 dniach) może być wykonana za pomocą bieżącego version_number.

Jeśli operacja zostanie zablokowana, zostanie wywołany wyjątek przerwania.

PromotionStatus

Stan promocji.

Pola
destination_statuses[]

DestinationStatus

Tylko dane wyjściowe. Miejsca docelowe promocji.
item_level_issues[]

ItemLevelIssue

Tylko dane wyjściowe. Lista problemów związanych z promocją.
creation_date

Timestamp

Tylko dane wyjściowe. Data utworzenia promocji w formacie ISO 8601: data, godzina i przesunięcie, np. 2020-01-02T09:00:00+01:00 lub 2020-01-02T09:00:00Z
last_update_date

Timestamp

Tylko dane wyjściowe. Data ostatniej aktualizacji stanu promocji w formacie ISO 8601: data, godzina i przesunięcie, np. 2020-01-02T09:00:00+01:00 lub 2020-01-02T09:00:00Z

DestinationStatus

Stan określonego miejsca docelowego.

Pola
reporting_context

ReportingContextEnum

Tylko dane wyjściowe. Nazwa miejsca docelowego promocji.
status

State

Tylko dane wyjściowe. Stan określonego miejsca docelowego.

Stan

bieżący stan promocji.

Wartości w polu enum
STATE_UNSPECIFIED Nieznany stan promocji.
IN_REVIEW Promocja jest w trakcie sprawdzania.
REJECTED Promocja została odrzucona.
LIVE Promocja jest zatwierdzona i aktywna.
STOPPED Promocja została wstrzymana przez sprzedawcę.
EXPIRED Promocja nie jest już aktywna.
PENDING Promocja nie została zatrzymana, a wszystkie opinie zostały zatwierdzone, ale data jej obowiązywania przypada w przyszłości.

ItemLevelIssue

Problem związany z promocją.

Pola
code

string

Tylko dane wyjściowe. Kod błędu.
severity

Severity

Tylko dane wyjściowe. Wpływ tego problemu na wyświetlanie promocji.
resolution

string

Tylko dane wyjściowe. Czy problem może zostać rozwiązany przez sprzedawcę.
attribute

string

Tylko dane wyjściowe. nazwę atrybutu, jeśli problem jest spowodowany przez pojedynczy atrybut.
reporting_context

ReportingContextEnum

Tylko dane wyjściowe. Miejsce docelowe, którego dotyczy problem.
description

string

Tylko dane wyjściowe. Krótki opis problemu w języku angielskim.
detail

string

Tylko dane wyjściowe. szczegółowy opis problemu w języku angielskim.
documentation

string

Tylko dane wyjściowe. adres URL strony internetowej, która pomoże nam rozwiązać ten problem.
applicable_countries[]

string

Tylko dane wyjściowe. Lista kodów krajów (ISO 3166-1 alfa-2), w przypadku których problem dotyczy oferty.

Poziom ważności

Waga problemu.

Wartości w polu enum
SEVERITY_UNSPECIFIED Nie określono.
NOT_IMPACTED Ten problem jest ostrzeżeniem i nie ma bezpośredniego wpływu na promocję.
DEMOTED Promocja jest zdegradowana i najprawdopodobniej ma ograniczoną skuteczność w wynikach wyszukiwania.
DISAPPROVED Problem powoduje odrzucenie promocji.

RedemptionChannel

Kanał promocji.

Wartości w polu enum
REDEMPTION_CHANNEL_UNSPECIFIED Wskazuje, że kanał jest nieokreślony.
IN_STORE Wskazuje, że kanał jest w sklepie. Jest to ten sam kanał local, który jest używany do products.
ONLINE Wskazuje, że kanał jest online.

StoreApplicability

Kody sklepów lub lista kodów sklepów, do których ma zastosowanie promocja. Tylko do promocji reklam lokalnego asortymentu produktów.

Wartości w polu enum
STORE_APPLICABILITY_UNSPECIFIED Nie wiadomo, do których kodów sklepów ma zastosowanie promocja.
ALL_STORES Promocja dotyczy wszystkich sklepów.
SPECIFIC_STORES Promocja dotyczy tylko określonych sklepów.