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 wejściowych o promocjach może minąć kilka minut, zanim będzie można pobrać zaktualizowaną promocję.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie protokołu OAuth 2.0.
InsertPromotion

rpc InsertPromotion(InsertPromotionRequest) returns (Promotion)

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

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie protokołu OAuth 2.0.
ListPromotions

rpc ListPromotions(ListPromotionsRequest) returns (ListPromotionsResponse)

Wyświetla listę promocji na koncie Merchant Center. Odpowiedź może zawierać mniej elementów niż określona wartość w polu pageSize. Zdaj się na firmę pageToken, aby określić, czy można zamówić więcej produktów.

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

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie protokołu OAuth 2.0.

Atrybuty

Atrybuty.

Pola
product_applicability

ProductApplicability

Wymagane. Promocja obejmuje wszystkie produkty lub tylko wybrane produkty.
offer_type

OfferType

Wymagane. Typ promocji. Użyj tego atrybutu, aby określić, czy klienci potrzebują kodu kuponu, aby skorzystać z promocji.
generic_redemption_code

string

Opcjonalnie. Ogólny kod promocyjny promocji. Używany z polem offerType musi spełniać wymagania minimalne.
long_title

string

Wymagane. Długi tytuł promocji.
coupon_value_type

CouponValueType

Wymagane. Atrybut „coupon value type” (typ wartości kuponu) informuje o typie Twojej promocji. W zależności od typu wybranej wartości kuponu wymagane są określone atrybuty.
promotion_destinations[]

DestinationEnum

Wymagane. 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 przestrzeni Google. Do przedstawienia tych wartości służą FREE_LISTINGS, FREE_LOCAL_LISTINGS, LOCAL_INVENTORY_ADS. Więcej informacji znajdziesz w sekcji Miejsce docelowe promocji.
item_id_inclusion[]

string

Opcjonalnie. Filtruj produkty dla danej promocji według identyfikatora produktu. Atrybuty umożliwiające filtrowanie produktów mają zastosowanie tylko wtedy, gdy atrybut produkty kwalifikujące się do promocji produktu objętego promocją product_applicability ma wartość specific_products.
brand_inclusion[]

string

Opcjonalnie. Filtruj produkty według marki na potrzeby promocji. Atrybuty umożliwiające filtrowanie produktów mają zastosowanie tylko wtedy, gdy atrybut produkty kwalifikujące się do promocji produktu objętego promocją product_applicability ma wartość specific_products.
item_group_id_inclusion[]

string

Opcjonalnie. Filtruj produkty według identyfikatora grupy produktów objętej promocją. Atrybuty umożliwiające filtrowanie produktów mają zastosowanie tylko wtedy, gdy atrybut produkty kwalifikujące się do promocji produktu objętego promocją [product_applicability] ma wartość specific_products.
product_type_inclusion[]

string

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

string

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

string

Opcjonalnie. Filtr produktów według wykluczenia marki dla promocji. Atrybuty umożliwiające filtrowanie produktów mają zastosowanie tylko wtedy, gdy atrybut produkty kwalifikujące się do promocji produktu objętego promocją product_applicability ma wartość specific_products.
item_group_id_exclusion[]

string

Opcjonalnie. Filtruj produkty według atrybutu identyfikator grupy produktów. Atrybuty umożliwiające filtrowanie produktów mają zastosowanie tylko wtedy, gdy atrybut produkty kwalifikujące się do promocji produkty objęte promocją product_applicability ma wartość specific_products. wykluczenie dla promocji.
product_type_exclusion[]

string

Opcjonalnie. Filtr produktów według wykluczenia typu produktu dla promocji. Atrybuty umożliwiające filtrowanie produktów mają zastosowanie tylko wtedy, gdy atrybut produkty kwalifikujące się do promocji produktu objętego 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 przypadku promocji.
limit_quantity

int64

Opcjonalnie. Maksymalna liczba zakupów w ramach 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 promocją. Atrybut jest ustawiany, gdy couponValueType ma wartość 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 przypadku promocji.
free_gift_item_id

string

Opcjonalnie. Identyfikator produktu prezentu objętego promocją.
promotion_effective_time_period

Interval

Wymagane. Wartość TimePeriod reprezentująca okres obowiązywania promocji. Ten atrybut określa, że promocję można przetestować w Twoim sklepie internetowym w tym okresie.
promotion_display_time_period

Interval

Opcjonalnie. Wartość TimePeriod reprezentuje okres wyświetlania promocji. Ten atrybut określa datę i okres, kiedy promocja będzie widoczna w Google.com i reklamach produktowych. Jeśli atrybut okres wyświetlania promocji promotion_display_time_period nie zostanie określony, datę i okres rozpoczęcia promocji na stronie Google.com i w reklamach produktowych określa okres obowiązywania promocji promotion_effective_time_period.
store_applicability

StoreApplicability

Opcjonalnie. Określa, czy promocja dotyczy wszystkich czy tylko wybranych sklepów. Jeśli nie uwzględnisz promocji w reklamach lokalnego asortymentu produktów, pojawi się błąd. Jeśli ustawienie store_applicability ma wartość ALL_STORES, a 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 filtrowania sklepów mają zastosowanie tylko wtedy, gdy atrybut store_applicability ma wartość specific_stores.

Kod sklepu (identyfikator z profilu Twojej firmy) sklepu stacjonarnego, w którym sprzedawany jest produkt. Więcej informacji znajdziesz w specyfikacji danych lokalnego asortymentu produktów.
store_codes_exclusion[]

string

Opcjonalnie. Kody sklepów do wykluczenia z promocji. Atrybuty filtrowania 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. Jeśli nie podasz wartości promotion_url, promocje w reklamach lokalnego asortymentu produktów będą generować błąd. Adres URL służy do potwierdzenia, że promocja jest ważna 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.
PERCENT_OFF Typ wartości kuponu rabatowego.
BUY_M_GET_N_MONEY_OFF Kup większą liczbę sztuk w M, a otrzymasz N rabatu typu wartość kuponu. Wymagane są pola minimum_purchase_quantity i get_this_quantity_discounted. Pole money_off_amount też musi być obecne.
BUY_M_GET_N_PERCENT_OFF Kup większą liczbę sztuk w M, a otrzymasz N procent zniżki typu wartość kuponu. Wymagane są pola minimum_purchase_quantity i get_this_quantity_discounted. Pole percent_off_percentage też musi być obecne.
BUY_M_GET_MONEY_OFF Kup w M, aby otrzymać rabat. Muszą być obecne minimum_purchase_quantity i money_off_amount.
BUY_M_GET_PERCENT_OFF Kup w M, aby otrzymać rabat. Muszą być obecne minimum_purchase_quantity i percent_off_percentage.
FREE_GIFT Prezent tylko z opisem.
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 dostawy.
FREE_SHIPPING_OVERNIGHT Typ wartości kuponu z bezpłatnej dostawy przez noc.
FREE_SHIPPING_TWO_DAY Typ wartości kuponu z bezpłatną dostawą w ciągu 2 dni.

GetPromotionRequest

Komunikat żądania dla metody GetPromotion.

Pola
name

string

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

InsertPromotionRequest

Komunikat żądania dla metody InsertPromotion.

Pola
parent

string

Wymagane. Konto, na którym zostanie wstawiona promocja. Format: konta/{konto}
promotion

Promotion

Wymagane. Promocja do wstawienia.
data_source

string

Wymagane. Źródło danych promocji w formacie accounts/{account}/dataSources/{datasource}.

ListPromotionsRequest

Komunikat żądania dla metody ListPromotions.

Pola
parent

string

Wymagane. Konto, dla którego chcesz wyświetlić listę przetworzonych promocji. 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 1000. Wartości powyżej 1000 zostaną zmienione na 1000. Jeśli nie określono inaczej, zostanie zwrócona maksymalna liczba promocji.
page_token

string

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

Podczas dzielenia na strony wszystkie pozostałe parametry podane w narzędziu ListPromotions muszą być zgodne z wywołaniem, które dostarczyło token strony.

ListPromotionsResponse

Komunikat odpowiedzi dla metody ListPromotions.

Pola
promotions[]

Promotion

Przetworzone promocje z określonego konta.
next_page_token

string

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

OfferType

Typ oferty promocyjnej.

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 jest wymagany, gdy offerType = GENERIC_CODE.

ProductApplicability

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

Wartości w polu enum
PRODUCT_APPLICABILITY_UNSPECIFIED Produkty, których dotyczy promocja, są nieznane.
ALL_PRODUCTS Dotyczy wszystkich produktów.
SPECIFIC_PRODUCTS Dotyczy tylko jednego produktu lub jednej listy produktów.

Promocja

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

Poniżej znajdziesz najważniejsze atrybuty wejściowe promocji, które umożliwiają przejście weryfikacji danych:

Po wstawieniu i zaktualizowaniu danych wejściowych 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

Wymagane. Podany przez użytkownika identyfikator promocji pozwala jednoznacznie zidentyfikować promocję. Aby uniknąć odrzucenia promocji, przestrzegaj minimalnych wymagań.
content_language

string

Wymagane. Dwuliterowy kod języka ISO 639-1 używany w promocji.

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

string

Wymagane. Kraj docelowy używany jako część unikalnego identyfikatora. Przedstawiany jako kod regionu CLDR.

Promocje są dostępne tylko w wybranych krajach i w bezpłatnych informacjach i reklamach produktowych reklamach lokalnego asortymentu produktów
redemption_channel[]

RedemptionChannel

Wymagane. 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 niestandardowych atrybutów (dostarczonych przez sprzedawcę). W ten sposób można też przesyłać dowolne atrybuty specyfikacji danych w ogólnej postaci (np. { "name": "size type", "value": "regular" }). Jest to przydatne w przypadku przesyłania atrybutów, które nie są wyraźnie widoczne przez interfejs API.
promotion_status

PromotionStatus

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

int64

Opcjonalnie. Reprezentuje istniejącą wersję (aktualność) promocji, która pozwala zachować właściwą kolejność w przypadku przeprowadzania wielu aktualizacji jednocześnie.

Jeśli jest ustawiony, wstawianie jest blokowane, gdy numer wersji jest niższy niż bieżący numer wersji istniejącej promocji. Ponowne wstawienie (np. odświeżenie promocji po 30 dniach) można wykonać przy użyciu bieżącej wartości version_number.

Jeśli ta operacja jest blokowana, zgłaszany jest przerwany wyjątek.

PromotionStatus

Stan promocji.

Pola
destination_statuses[]

DestinationStatus

Tylko dane wyjściowe. Zamierzone 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

Obecny 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 została zatwierdzona i aktywna.
STOPPED Promocja została zatrzymana przez sprzedawcę.
EXPIRED Promocja nie jest już aktywna.
PENDING Promocja nie zostaje przerwana, a wszystkie opinie są zatwierdzone, ale data aktywności przypada w przyszłości.

ItemLevelIssue

Problem związany z promocją.

Pola
code

string

Tylko dane wyjściowe. Kod błędu, którego dotyczy problem.
severity

Severity

Tylko dane wyjściowe. Jak ten problem wpływa 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. Nazwa atrybutu, jeśli problem jest spowodowany przez jeden 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 ma pomóc w rozwiązaniu tego problemu.
applicable_countries[]

string

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

Poziom ważności

Waga problemu.

Wartości w polu enum
SEVERITY_UNSPECIFIED Nie określono.
NOT_IMPACTED Ten problem stanowi ostrzeżenie i nie ma bezpośredniego wpływu na promocję.
DEMOTED Promocja jest w dół 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 taki sam jak kanał local używany w przypadku products.
ONLINE Oznacza, że kanał jest online.

StoreApplicability

Kody sklepów lub lista kodów sklepów, których dotyczy promocja. Tylko w przypadku promocji w ramach reklam lokalnego asortymentu produktów.

Wartości w polu enum
STORE_APPLICABILITY_UNSPECIFIED Kody sklepów, których dotyczy promocja, są nieznane.
ALL_STORES Promocja dotyczy wszystkich sklepów.
SPECIFIC_STORES Promocja dotyczy tylko określonych sklepów.